This file is indexed.

/usr/share/doc/ffmpeg/api/structAVClass.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
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
<!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: AVClass 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">AVClass Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Describe the class of an <a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure. ">AVClass</a> context structure.  
 <a href="structAVClass.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="log_8h_source.html">libavutil/log.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:aa8883e113a3f2965abd008f7667db7eb"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAVClass.html#aa8883e113a3f2965abd008f7667db7eb">class_name</a></td></tr>
<tr class="memdesc:aa8883e113a3f2965abd008f7667db7eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">The name of the class; usually it is the same name as the context structure type to which the <a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure. ">AVClass</a> is associated.  <a href="#aa8883e113a3f2965abd008f7667db7eb">More...</a><br /></td></tr>
<tr class="separator:aa8883e113a3f2965abd008f7667db7eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad763b2e6a0846234a165e74574a550bd"><td class="memItemLeft" align="right" valign="top">const char *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAVClass.html#ad763b2e6a0846234a165e74574a550bd">item_name</a> )(void *ctx)</td></tr>
<tr class="memdesc:ad763b2e6a0846234a165e74574a550bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">A pointer to a function which returns the name of a context instance ctx associated with the class.  <a href="#ad763b2e6a0846234a165e74574a550bd">More...</a><br /></td></tr>
<tr class="separator:ad763b2e6a0846234a165e74574a550bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a75207076350fd2342191bc2091699f00"><td class="memItemLeft" align="right" valign="top">const struct <a class="el" href="structAVOption.html">AVOption</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAVClass.html#a75207076350fd2342191bc2091699f00">option</a></td></tr>
<tr class="memdesc:a75207076350fd2342191bc2091699f00"><td class="mdescLeft">&#160;</td><td class="mdescRight">a pointer to the first option specified in the class if any or NULL  <a href="#a75207076350fd2342191bc2091699f00">More...</a><br /></td></tr>
<tr class="separator:a75207076350fd2342191bc2091699f00"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7859d861c0924aa74d848f93253c263a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAVClass.html#a7859d861c0924aa74d848f93253c263a">version</a></td></tr>
<tr class="memdesc:a7859d861c0924aa74d848f93253c263a"><td class="mdescLeft">&#160;</td><td class="mdescRight">LIBAVUTIL_VERSION with which this structure was created.  <a href="#a7859d861c0924aa74d848f93253c263a">More...</a><br /></td></tr>
<tr class="separator:a7859d861c0924aa74d848f93253c263a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afbde6320c22278fac43732f7410b66e7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAVClass.html#afbde6320c22278fac43732f7410b66e7">log_level_offset_offset</a></td></tr>
<tr class="memdesc:afbde6320c22278fac43732f7410b66e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Offset in the structure where log_level_offset is stored.  <a href="#afbde6320c22278fac43732f7410b66e7">More...</a><br /></td></tr>
<tr class="separator:afbde6320c22278fac43732f7410b66e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88948c8a7c6515181771615a54a808bf"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAVClass.html#a88948c8a7c6515181771615a54a808bf">parent_log_context_offset</a></td></tr>
<tr class="memdesc:a88948c8a7c6515181771615a54a808bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Offset in the structure where a pointer to the parent context for logging is stored.  <a href="#a88948c8a7c6515181771615a54a808bf">More...</a><br /></td></tr>
<tr class="separator:a88948c8a7c6515181771615a54a808bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e996ee57c93f5513281c04f68440cff"><td class="memItemLeft" align="right" valign="top">void *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAVClass.html#a1e996ee57c93f5513281c04f68440cff">child_next</a> )(void *obj, void *prev)</td></tr>
<tr class="memdesc:a1e996ee57c93f5513281c04f68440cff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return next AVOptions-enabled child or NULL.  <a href="#a1e996ee57c93f5513281c04f68440cff">More...</a><br /></td></tr>
<tr class="separator:a1e996ee57c93f5513281c04f68440cff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1446f94b0cfc1de453319e972eed61d"><td class="memItemLeft" align="right" valign="top">const struct <a class="el" href="structAVClass.html">AVClass</a> *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAVClass.html#af1446f94b0cfc1de453319e972eed61d">child_class_next</a> )(const struct <a class="el" href="structAVClass.html">AVClass</a> *prev)</td></tr>
<tr class="memdesc:af1446f94b0cfc1de453319e972eed61d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return an <a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure. ">AVClass</a> corresponding to the next potential AVOptions-enabled child.  <a href="#af1446f94b0cfc1de453319e972eed61d">More...</a><br /></td></tr>
<tr class="separator:af1446f94b0cfc1de453319e972eed61d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5fc161d93a0d65a608819da20b7203ba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="log_8h.html#aeb1c06cc3e47a029ca6afeac782ac8f9">AVClassCategory</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAVClass.html#a5fc161d93a0d65a608819da20b7203ba">category</a></td></tr>
<tr class="memdesc:a5fc161d93a0d65a608819da20b7203ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Category used for visualization (like color) This is only set if the category is equal for all objects using this class.  <a href="#a5fc161d93a0d65a608819da20b7203ba">More...</a><br /></td></tr>
<tr class="separator:a5fc161d93a0d65a608819da20b7203ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a511382185d3206043d5d37c1007f199c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="log_8h.html#aeb1c06cc3e47a029ca6afeac782ac8f9">AVClassCategory</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAVClass.html#a511382185d3206043d5d37c1007f199c">get_category</a> )(void *ctx)</td></tr>
<tr class="memdesc:a511382185d3206043d5d37c1007f199c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback to return the category.  <a href="#a511382185d3206043d5d37c1007f199c">More...</a><br /></td></tr>
<tr class="separator:a511382185d3206043d5d37c1007f199c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f25d6b76f5a8b474cc1cb16aa5ed5df"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAVClass.html#a1f25d6b76f5a8b474cc1cb16aa5ed5df">query_ranges</a> )(struct <a class="el" href="structAVOptionRanges.html">AVOptionRanges</a> **, void *obj, const char *key, int flags)</td></tr>
<tr class="memdesc:a1f25d6b76f5a8b474cc1cb16aa5ed5df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback to return the supported/allowed ranges.  <a href="#a1f25d6b76f5a8b474cc1cb16aa5ed5df">More...</a><br /></td></tr>
<tr class="separator:a1f25d6b76f5a8b474cc1cb16aa5ed5df"><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>Describe the class of an <a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure. ">AVClass</a> context structure. </p>
<p>That is an arbitrary struct of which the first field is a pointer to an <a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure. ">AVClass</a> struct (e.g. <a class="el" href="structAVCodecContext.html" title="main external API structure. ">AVCodecContext</a>, <a class="el" href="structAVFormatContext.html" title="Format I/O context. ">AVFormatContext</a> etc.). </p>

<p class="definition">Definition at line <a class="el" href="log_8h_source.html#l00067">67</a> of file <a class="el" href="log_8h_source.html">log.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="aa8883e113a3f2965abd008f7667db7eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8883e113a3f2965abd008f7667db7eb">&#9670;&nbsp;</a></span>class_name</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* AVClass::class_name</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The name of the class; usually it is the same name as the context structure type to which the <a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure. ">AVClass</a> is associated. </p>

<p class="definition">Definition at line <a class="el" href="log_8h_source.html#l00072">72</a> of file <a class="el" href="log_8h_source.html">log.h</a>.</p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char*(* AVClass::item_name) (void *ctx)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>A pointer to a function which returns the name of a context instance ctx associated with the class. </p>

<p class="definition">Definition at line <a class="el" href="log_8h_source.html#l00078">78</a> of file <a class="el" href="log_8h_source.html">log.h</a>.</p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const struct <a class="el" href="structAVOption.html">AVOption</a>* AVClass::option</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>a pointer to the first option specified in the class if any or NULL </p>
<dl class="section see"><dt>See also</dt><dd>av_set_default_options() </dd></dl>

<p class="definition">Definition at line <a class="el" href="log_8h_source.html#l00085">85</a> of file <a class="el" href="log_8h_source.html">log.h</a>.</p>

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

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

<p>LIBAVUTIL_VERSION with which this structure was created. </p>
<p>This is used to allow fields to be added without requiring major version bumps everywhere. </p>

<p class="definition">Definition at line <a class="el" href="log_8h_source.html#l00093">93</a> of file <a class="el" href="log_8h_source.html">log.h</a>.</p>

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

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

<p>Offset in the structure where log_level_offset is stored. </p>
<p>0 means there is no such variable </p>

<p class="definition">Definition at line <a class="el" href="log_8h_source.html#l00099">99</a> of file <a class="el" href="log_8h_source.html">log.h</a>.</p>

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

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

<p>Offset in the structure where a pointer to the parent context for logging is stored. </p>
<p>For example a decoder could pass its <a class="el" href="structAVCodecContext.html" title="main external API structure. ">AVCodecContext</a> to eval as such a parent context, which an <a class="el" href="group__lavu__log.html#gabd386ffd4b27637cf34e98d5d1a6e8ae" title="Send the specified message to the log if the level is less than or equal to the current av_log_level...">av_log()</a> implementation could then leverage to display the parent context. The offset can be NULL. </p>

<p class="definition">Definition at line <a class="el" href="log_8h_source.html#l00108">108</a> of file <a class="el" href="log_8h_source.html">log.h</a>.</p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void*(* AVClass::child_next) (void *obj, void *prev)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Return next AVOptions-enabled child or NULL. </p>

<p class="definition">Definition at line <a class="el" href="log_8h_source.html#l00113">113</a> of file <a class="el" href="log_8h_source.html">log.h</a>.</p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const struct <a class="el" href="structAVClass.html">AVClass</a>*(* AVClass::child_class_next) (const struct <a class="el" href="structAVClass.html">AVClass</a> *prev)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Return an <a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure. ">AVClass</a> corresponding to the next potential AVOptions-enabled child. </p>
<p>The difference between child_next and this is that child_next iterates over <em>already existing</em> objects, while child_class_next iterates over <em>all possible</em> children. </p>

<p class="definition">Definition at line <a class="el" href="log_8h_source.html#l00123">123</a> of file <a class="el" href="log_8h_source.html">log.h</a>.</p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="log_8h.html#aeb1c06cc3e47a029ca6afeac782ac8f9">AVClassCategory</a> AVClass::category</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Category used for visualization (like color) This is only set if the category is equal for all objects using this class. </p>
<p>available since version (51 &lt;&lt; 16 | 56 &lt;&lt; 8 | 100) </p>

<p class="definition">Definition at line <a class="el" href="log_8h_source.html#l00130">130</a> of file <a class="el" href="log_8h_source.html">log.h</a>.</p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="log_8h.html#aeb1c06cc3e47a029ca6afeac782ac8f9">AVClassCategory</a>(* AVClass::get_category) (void *ctx)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Callback to return the category. </p>
<p>available since version (51 &lt;&lt; 16 | 59 &lt;&lt; 8 | 100) </p>

<p class="definition">Definition at line <a class="el" href="log_8h_source.html#l00136">136</a> of file <a class="el" href="log_8h_source.html">log.h</a>.</p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int(* AVClass::query_ranges) (struct <a class="el" href="structAVOptionRanges.html">AVOptionRanges</a> **, void *obj, const char *key, int flags)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Callback to return the supported/allowed ranges. </p>
<p>available since version (52.12) </p>

<p class="definition">Definition at line <a class="el" href="log_8h_source.html#l00142">142</a> of file <a class="el" href="log_8h_source.html">log.h</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>libavutil/<a class="el" href="log_8h_source.html">log.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>