Repository URL to install this package:
|
Version:
8:3.0.2-1ubuntu3 ▾
|
<!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.6"/>
<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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">FFmpeg
 <span id="projectnumber">3.0.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></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 <<a class="el" href="log_8h_source.html">log.h</a>></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 * </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"> </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"> </td></tr>
<tr class="memitem:abdb9b352e115fc158835afd56ef8b78b"><td class="memItemLeft" align="right" valign="top">const char *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structAVClass.html#abdb9b352e115fc158835afd56ef8b78b">item_name</a> )(void *ctx)</td></tr>
<tr class="memdesc:abdb9b352e115fc158835afd56ef8b78b"><td class="mdescLeft"> </td><td class="mdescRight">A pointer to a function which returns the name of a context instance ctx associated with the class. <a href="#abdb9b352e115fc158835afd56ef8b78b">More...</a><br/></td></tr>
<tr class="separator:abdb9b352e115fc158835afd56ef8b78b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a75207076350fd2342191bc2091699f00"><td class="memItemLeft" align="right" valign="top">const struct <a class="el" href="structAVOption.html">AVOption</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structAVClass.html#a75207076350fd2342191bc2091699f00">option</a></td></tr>
<tr class="memdesc:a75207076350fd2342191bc2091699f00"><td class="mdescLeft"> </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"> </td></tr>
<tr class="memitem:a7859d861c0924aa74d848f93253c263a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structAVClass.html#a7859d861c0924aa74d848f93253c263a">version</a></td></tr>
<tr class="memdesc:a7859d861c0924aa74d848f93253c263a"><td class="mdescLeft"> </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"> </td></tr>
<tr class="memitem:afbde6320c22278fac43732f7410b66e7"><td class="memItemLeft" align="right" valign="top">int </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"> </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"> </td></tr>
<tr class="memitem:a88948c8a7c6515181771615a54a808bf"><td class="memItemLeft" align="right" valign="top">int </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"> </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"> </td></tr>
<tr class="memitem:af13472aa40bca9eaad0d5b4ee4c00cab"><td class="memItemLeft" align="right" valign="top">void *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structAVClass.html#af13472aa40bca9eaad0d5b4ee4c00cab">child_next</a> )(void *obj, void *prev)</td></tr>
<tr class="memdesc:af13472aa40bca9eaad0d5b4ee4c00cab"><td class="mdescLeft"> </td><td class="mdescRight">Return next AVOptions-enabled child or NULL. <a href="#af13472aa40bca9eaad0d5b4ee4c00cab">More...</a><br/></td></tr>
<tr class="separator:af13472aa40bca9eaad0d5b4ee4c00cab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0f4a274042064e70970f1be345c43343"><td class="memItemLeft" align="right" valign="top">const struct <a class="el" href="structAVClass.html">AVClass</a> *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structAVClass.html#a0f4a274042064e70970f1be345c43343">child_class_next</a> )(const struct <a class="el" href="structAVClass.html">AVClass</a> *prev)</td></tr>
<tr class="memdesc:a0f4a274042064e70970f1be345c43343"><td class="mdescLeft"> </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="#a0f4a274042064e70970f1be345c43343">More...</a><br/></td></tr>
<tr class="separator:a0f4a274042064e70970f1be345c43343"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5fc161d93a0d65a608819da20b7203ba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="log_8h.html#aeb1c06cc3e47a029ca6afeac782ac8f9">AVClassCategory</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structAVClass.html#a5fc161d93a0d65a608819da20b7203ba">category</a></td></tr>
<tr class="memdesc:a5fc161d93a0d65a608819da20b7203ba"><td class="mdescLeft"> </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"> </td></tr>
<tr class="memitem:a7a5708eb9185fbc45741612028f40976"><td class="memItemLeft" align="right" valign="top"><a class="el" href="log_8h.html#aeb1c06cc3e47a029ca6afeac782ac8f9">AVClassCategory</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structAVClass.html#a7a5708eb9185fbc45741612028f40976">get_category</a> )(void *ctx)</td></tr>
<tr class="memdesc:a7a5708eb9185fbc45741612028f40976"><td class="mdescLeft"> </td><td class="mdescRight">Callback to return the category. <a href="#a7a5708eb9185fbc45741612028f40976">More...</a><br/></td></tr>
<tr class="separator:a7a5708eb9185fbc45741612028f40976"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2e3cca1bb1e7c441087eaad810b4384b"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structAVClass.html#a2e3cca1bb1e7c441087eaad810b4384b">query_ranges</a> )(struct <a class="el" href="structAVOptionRanges.html">AVOptionRanges</a> **, void *obj, const char *key, int flags)</td></tr>
<tr class="memdesc:a2e3cca1bb1e7c441087eaad810b4384b"><td class="mdescLeft"> </td><td class="mdescRight">Callback to return the supported/allowed ranges. <a href="#a2e3cca1bb1e7c441087eaad810b4384b">More...</a><br/></td></tr>
<tr class="separator:a2e3cca1bb1e7c441087eaad810b4384b"><td class="memSeparator" colspan="2"> </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>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 class="anchor" id="aa8883e113a3f2965abd008f7667db7eb"></a>
<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>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 class="anchor" id="abdb9b352e115fc158835afd56ef8b78b"></a>
<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>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 class="anchor" id="a75207076350fd2342191bc2091699f00"></a>
<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>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 class="anchor" id="a7859d861c0924aa74d848f93253c263a"></a>
<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>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 class="anchor" id="afbde6320c22278fac43732f7410b66e7"></a>
<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>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 class="anchor" id="a88948c8a7c6515181771615a54a808bf"></a>
<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>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 class="anchor" id="af13472aa40bca9eaad0d5b4ee4c00cab"></a>
<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>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 class="anchor" id="a0f4a274042064e70970f1be345c43343"></a>
<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>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 class="anchor" id="a5fc161d93a0d65a608819da20b7203ba"></a>
<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 << 16 | 56 << 8 | 100) </p>
<p>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 class="anchor" id="a7a5708eb9185fbc45741612028f40976"></a>
<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 << 16 | 59 << 8 | 100) </p>
<p>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 class="anchor" id="a2e3cca1bb1e7c441087eaad810b4384b"></a>
<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>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  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>