This file is indexed.

/usr/share/doc/ffmpeg/api/structAVQSVContext.html is in ffmpeg-doc 7:3.4.2-2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FFmpeg: AVQSVContext Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">FFmpeg
   &#160;<span id="projectnumber">3.4.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">AVQSVContext Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>This struct is used for communicating QSV parameters between libavcodec and the caller.  
 <a href="structAVQSVContext.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="qsv_8h_source.html">libavcodec/qsv.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:aa88e55219891596ee8205ae78cbca275"><td class="memItemLeft" align="right" valign="top">mfxSession&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAVQSVContext.html#aa88e55219891596ee8205ae78cbca275">session</a></td></tr>
<tr class="memdesc:aa88e55219891596ee8205ae78cbca275"><td class="mdescLeft">&#160;</td><td class="mdescRight">If non-NULL, the session to use for encoding or decoding.  <a href="#aa88e55219891596ee8205ae78cbca275">More...</a><br /></td></tr>
<tr class="separator:aa88e55219891596ee8205ae78cbca275"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6190ff613bf400fa6d7e5c78bacb4c00"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAVQSVContext.html#a6190ff613bf400fa6d7e5c78bacb4c00">iopattern</a></td></tr>
<tr class="memdesc:a6190ff613bf400fa6d7e5c78bacb4c00"><td class="mdescLeft">&#160;</td><td class="mdescRight">The IO pattern to use.  <a href="#a6190ff613bf400fa6d7e5c78bacb4c00">More...</a><br /></td></tr>
<tr class="separator:a6190ff613bf400fa6d7e5c78bacb4c00"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c92105313bccdc0b7f63170ed9f992f"><td class="memItemLeft" align="right" valign="top">mfxExtBuffer **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAVQSVContext.html#a3c92105313bccdc0b7f63170ed9f992f">ext_buffers</a></td></tr>
<tr class="memdesc:a3c92105313bccdc0b7f63170ed9f992f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extra buffers to pass to encoder or decoder initialization.  <a href="#a3c92105313bccdc0b7f63170ed9f992f">More...</a><br /></td></tr>
<tr class="separator:a3c92105313bccdc0b7f63170ed9f992f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19ca280b4a280676abbb5a018f619282"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAVQSVContext.html#a19ca280b4a280676abbb5a018f619282">nb_ext_buffers</a></td></tr>
<tr class="separator:a19ca280b4a280676abbb5a018f619282"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00b4f91c36429e719743c5a080856e33"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAVQSVContext.html#a00b4f91c36429e719743c5a080856e33">opaque_alloc</a></td></tr>
<tr class="memdesc:a00b4f91c36429e719743c5a080856e33"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encoding only.  <a href="#a00b4f91c36429e719743c5a080856e33">More...</a><br /></td></tr>
<tr class="separator:a00b4f91c36429e719743c5a080856e33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31ff5ab3cbbde801fdc264a6660e55e9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAVQSVContext.html#a31ff5ab3cbbde801fdc264a6660e55e9">nb_opaque_surfaces</a></td></tr>
<tr class="memdesc:a31ff5ab3cbbde801fdc264a6660e55e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encoding only, and only if opaque_alloc is set to non-zero.  <a href="#a31ff5ab3cbbde801fdc264a6660e55e9">More...</a><br /></td></tr>
<tr class="separator:a31ff5ab3cbbde801fdc264a6660e55e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9a2a1e951ebdfc2640ea33077f0c67e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structAVBufferRef.html">AVBufferRef</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAVQSVContext.html#ae9a2a1e951ebdfc2640ea33077f0c67e">opaque_surfaces</a></td></tr>
<tr class="memdesc:ae9a2a1e951ebdfc2640ea33077f0c67e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encoding only, and only if opaque_alloc is set to non-zero.  <a href="#ae9a2a1e951ebdfc2640ea33077f0c67e">More...</a><br /></td></tr>
<tr class="separator:ae9a2a1e951ebdfc2640ea33077f0c67e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a06f2493cfd72f41162e788e5247f5b90"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAVQSVContext.html#a06f2493cfd72f41162e788e5247f5b90">opaque_alloc_type</a></td></tr>
<tr class="memdesc:a06f2493cfd72f41162e788e5247f5b90"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encoding only, and only if opaque_alloc is set to non-zero.  <a href="#a06f2493cfd72f41162e788e5247f5b90">More...</a><br /></td></tr>
<tr class="separator:a06f2493cfd72f41162e788e5247f5b90"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This struct is used for communicating QSV parameters between libavcodec and the caller. </p>
<p>It is managed by the caller and must be assigned to <a class="el" href="structAVCodecContext.html#ab222f7d747dfdceff0a76999e09648c0" title="Hardware accelerator context. ">AVCodecContext.hwaccel_context</a>.</p><ul>
<li>decoding: hwaccel_context must be set on return from the get_format() callback</li>
<li>encoding: hwaccel_context must be set before <a class="el" href="group__lavc__core.html#ga11f785a188d7d9df71621001465b0f1d" title="Initialize the AVCodecContext to use the given AVCodec. ">avcodec_open2()</a> </li>
</ul>

<p class="definition">Definition at line <a class="el" href="qsv_8h_source.html#l00036">36</a> of file <a class="el" href="qsv_8h_source.html">qsv.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="aa88e55219891596ee8205ae78cbca275"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa88e55219891596ee8205ae78cbca275">&#9670;&nbsp;</a></span>session</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">mfxSession AVQSVContext::session</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>If non-NULL, the session to use for encoding or decoding. </p>
<p>Otherwise, libavcodec will try to create an internal session. </p>

<p class="definition">Definition at line <a class="el" href="qsv_8h_source.html#l00041">41</a> of file <a class="el" href="qsv_8h_source.html">qsv.h</a>.</p>

</div>
</div>
<a id="a6190ff613bf400fa6d7e5c78bacb4c00"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6190ff613bf400fa6d7e5c78bacb4c00">&#9670;&nbsp;</a></span>iopattern</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int AVQSVContext::iopattern</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The IO pattern to use. </p>

<p class="definition">Definition at line <a class="el" href="qsv_8h_source.html#l00046">46</a> of file <a class="el" href="qsv_8h_source.html">qsv.h</a>.</p>

</div>
</div>
<a id="a3c92105313bccdc0b7f63170ed9f992f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c92105313bccdc0b7f63170ed9f992f">&#9670;&nbsp;</a></span>ext_buffers</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">mfxExtBuffer** AVQSVContext::ext_buffers</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Extra buffers to pass to encoder or decoder initialization. </p>

<p class="definition">Definition at line <a class="el" href="qsv_8h_source.html#l00051">51</a> of file <a class="el" href="qsv_8h_source.html">qsv.h</a>.</p>

</div>
</div>
<a id="a19ca280b4a280676abbb5a018f619282"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19ca280b4a280676abbb5a018f619282">&#9670;&nbsp;</a></span>nb_ext_buffers</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int AVQSVContext::nb_ext_buffers</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="qsv_8h_source.html#l00052">52</a> of file <a class="el" href="qsv_8h_source.html">qsv.h</a>.</p>

</div>
</div>
<a id="a00b4f91c36429e719743c5a080856e33"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a00b4f91c36429e719743c5a080856e33">&#9670;&nbsp;</a></span>opaque_alloc</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int AVQSVContext::opaque_alloc</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Encoding only. </p>
<p>If this field is set to non-zero by the caller, libavcodec will create an mfxExtOpaqueSurfaceAlloc extended buffer and pass it to the encoder initialization. This only makes sense if iopattern is also set to MFX_IOPATTERN_IN_OPAQUE_MEMORY.</p>
<p>The number of allocated opaque surfaces will be the sum of the number required by the encoder and the user-provided value nb_opaque_surfaces. The array of the opaque surfaces will be exported to the caller through the opaque_surfaces field. </p>

<p class="definition">Definition at line <a class="el" href="qsv_8h_source.html#l00065">65</a> of file <a class="el" href="qsv_8h_source.html">qsv.h</a>.</p>

</div>
</div>
<a id="a31ff5ab3cbbde801fdc264a6660e55e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31ff5ab3cbbde801fdc264a6660e55e9">&#9670;&nbsp;</a></span>nb_opaque_surfaces</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int AVQSVContext::nb_opaque_surfaces</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Encoding only, and only if opaque_alloc is set to non-zero. </p>
<p>Before calling <a class="el" href="group__lavc__core.html#ga11f785a188d7d9df71621001465b0f1d" title="Initialize the AVCodecContext to use the given AVCodec. ">avcodec_open2()</a>, the caller should set this field to the number of extra opaque surfaces to allocate beyond what is required by the encoder.</p>
<p>On return from <a class="el" href="group__lavc__core.html#ga11f785a188d7d9df71621001465b0f1d" title="Initialize the AVCodecContext to use the given AVCodec. ">avcodec_open2()</a>, this field will be set by libavcodec to the total number of allocated opaque surfaces. </p>

<p class="definition">Definition at line <a class="el" href="qsv_8h_source.html#l00076">76</a> of file <a class="el" href="qsv_8h_source.html">qsv.h</a>.</p>

</div>
</div>
<a id="ae9a2a1e951ebdfc2640ea33077f0c67e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9a2a1e951ebdfc2640ea33077f0c67e">&#9670;&nbsp;</a></span>opaque_surfaces</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structAVBufferRef.html">AVBufferRef</a>* AVQSVContext::opaque_surfaces</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Encoding only, and only if opaque_alloc is set to non-zero. </p>
<p>On return from <a class="el" href="group__lavc__core.html#ga11f785a188d7d9df71621001465b0f1d" title="Initialize the AVCodecContext to use the given AVCodec. ">avcodec_open2()</a>, this field will be used by libavcodec to export the array of the allocated opaque surfaces to the caller, so they can be passed to other parts of the pipeline.</p>
<p>The buffer reference exported here is owned and managed by libavcodec, the callers should make their own reference with <a class="el" href="group__lavu__buffer.html#gaa40ce7d3ede946a89d03323bbd7268c1" title="Create a new reference to an AVBuffer. ">av_buffer_ref()</a> and free it with <a class="el" href="group__lavu__buffer.html#ga135e9e929b5033bb8f68322497b2effc" title="Free a given reference and automatically free the buffer if there are no more references to it...">av_buffer_unref()</a> when it is no longer needed.</p>
<p>The buffer data is an nb_opaque_surfaces-sized array of mfxFrameSurface1. </p>

<p class="definition">Definition at line <a class="el" href="qsv_8h_source.html#l00090">90</a> of file <a class="el" href="qsv_8h_source.html">qsv.h</a>.</p>

</div>
</div>
<a id="a06f2493cfd72f41162e788e5247f5b90"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a06f2493cfd72f41162e788e5247f5b90">&#9670;&nbsp;</a></span>opaque_alloc_type</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int AVQSVContext::opaque_alloc_type</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Encoding only, and only if opaque_alloc is set to non-zero. </p>
<p>On return from <a class="el" href="group__lavc__core.html#ga11f785a188d7d9df71621001465b0f1d" title="Initialize the AVCodecContext to use the given AVCodec. ">avcodec_open2()</a>, this field will be set to the surface type used in the opaque allocation request. </p>

<p class="definition">Definition at line <a class="el" href="qsv_8h_source.html#l00097">97</a> of file <a class="el" href="qsv_8h_source.html">qsv.h</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>libavcodec/<a class="el" href="qsv_8h_source.html">qsv.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>