Why Gemfury? Push, build, and install  RubyGems npm packages Python packages Maven artifacts PHP packages Go Modules Debian packages RPM packages NuGet packages

Repository URL to install this package:

Details    
ffmpeg-doc / usr / share / doc / ffmpeg-doc / api / structAVClass.html
Size: Mime:
<!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"/>
<title>FFmpeg: AVClass Struct Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">FFmpeg
   &#160;<span id="projectnumber">2.7.1</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
<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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;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&#160;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div>
<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">
<!-- doxytag: class="AVClass" -->
<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">log.h</a>&gt;</code></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr><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><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"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAVClass.html#abdb9b352e115fc158835afd56ef8b78b">item_name</a> )(void *ctx)</td></tr>
<tr><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="#abdb9b352e115fc158835afd56ef8b78b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structAVOption.html">AVOption</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAVClass.html#a8f5d64df6aeeecce08ab33d0afb07f92">option</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">a pointer to the first option specified in the class if any or NULL  <a href="#a8f5d64df6aeeecce08ab33d0afb07f92"></a><br/></td></tr>
<tr><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><td class="mdescLeft">&#160;</td><td class="mdescRight">LIBAVUTIL_VERSION with which this structure was created.  <a href="#a7859d861c0924aa74d848f93253c263a"></a><br/></td></tr>
<tr><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><td class="mdescLeft">&#160;</td><td class="mdescRight">Offset in the structure where log_level_offset is stored.  <a href="#afbde6320c22278fac43732f7410b66e7"></a><br/></td></tr>
<tr><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><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"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAVClass.html#af13472aa40bca9eaad0d5b4ee4c00cab">child_next</a> )(void *obj, void *prev)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return next AVOptions-enabled child or NULL.  <a href="#af13472aa40bca9eaad0d5b4ee4c00cab"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structAVClass.html">AVClass</a> *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAVClass.html#a015e0495e24b397b331e984d3b99d582">child_class_next</a> )(const struct <a class="el" href="structAVClass.html">AVClass</a> *prev)</td></tr>
<tr><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="#a015e0495e24b397b331e984d3b99d582"></a><br/></td></tr>
<tr><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><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"></a><br/></td></tr>
<tr><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#a7a5708eb9185fbc45741612028f40976">get_category</a> )(void *ctx)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback to return the category.  <a href="#a7a5708eb9185fbc45741612028f40976"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int(*&#160;</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><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback to return the supported/allowed ranges.  <a href="#a2e3cca1bb1e7c441087eaad810b4384b"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>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><hr/><h2>Field Documentation</h2>
<a class="anchor" id="aa8883e113a3f2965abd008f7667db7eb"></a><!-- doxytag: member="AVClass::class_name" ref="aa8883e113a3f2965abd008f7667db7eb" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* <a class="el" href="structAVClass.html#aa8883e113a3f2965abd008f7667db7eb">AVClass::class_name</a></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><!-- doxytag: member="AVClass::item_name" ref="abdb9b352e115fc158835afd56ef8b78b" args=")(void *ctx)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char*(* <a class="el" href="structAVClass.html#abdb9b352e115fc158835afd56ef8b78b">AVClass::item_name</a>)(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="a8f5d64df6aeeecce08ab33d0afb07f92"></a><!-- doxytag: member="AVClass::option" ref="a8f5d64df6aeeecce08ab33d0afb07f92" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structAVOption.html">AVOption</a>* <a class="el" href="structAVClass.html#a8f5d64df6aeeecce08ab33d0afb07f92">AVClass::option</a></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="see"><dt><b>See also:</b></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><!-- doxytag: member="AVClass::version" ref="a7859d861c0924aa74d848f93253c263a" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="structAVClass.html#a7859d861c0924aa74d848f93253c263a">AVClass::version</a></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><!-- doxytag: member="AVClass::log_level_offset_offset" ref="afbde6320c22278fac43732f7410b66e7" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="structAVClass.html#afbde6320c22278fac43732f7410b66e7">AVClass::log_level_offset_offset</a></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><!-- doxytag: member="AVClass::parent_log_context_offset" ref="a88948c8a7c6515181771615a54a808bf" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="structAVClass.html#a88948c8a7c6515181771615a54a808bf">AVClass::parent_log_context_offset</a></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><!-- doxytag: member="AVClass::child_next" ref="af13472aa40bca9eaad0d5b4ee4c00cab" args=")(void *obj, void *prev)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void*(* <a class="el" href="structAVClass.html#af13472aa40bca9eaad0d5b4ee4c00cab">AVClass::child_next</a>)(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="a015e0495e24b397b331e984d3b99d582"></a><!-- doxytag: member="AVClass::child_class_next" ref="a015e0495e24b397b331e984d3b99d582" args=")(const struct AVClass *prev)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structAVClass.html">AVClass</a>*(* <a class="el" href="structAVClass.html#a015e0495e24b397b331e984d3b99d582">AVClass::child_class_next</a>)(const struct <a class="el" href="structAVClass.html">AVClass</a> *prev)<code> [read]</code></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 _already existing_ objects, while child_class_next iterates over _all possible_ 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><!-- doxytag: member="AVClass::category" ref="a5fc161d93a0d65a608819da20b7203ba" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="log_8h.html#aeb1c06cc3e47a029ca6afeac782ac8f9">AVClassCategory</a> <a class="el" href="structAVClass.html#a5fc161d93a0d65a608819da20b7203ba">AVClass::category</a></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>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><!-- doxytag: member="AVClass::get_category" ref="a7a5708eb9185fbc45741612028f40976" args=")(void *ctx)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="log_8h.html#aeb1c06cc3e47a029ca6afeac782ac8f9">AVClassCategory</a>(* <a class="el" href="structAVClass.html#a7a5708eb9185fbc45741612028f40976">AVClass::get_category</a>)(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>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><!-- doxytag: member="AVClass::query_ranges" ref="a2e3cca1bb1e7c441087eaad810b4384b" args=")(struct AVOptionRanges **, void *obj, const char *key, int flags)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int(* <a class="el" href="structAVClass.html#a2e3cca1bb1e7c441087eaad810b4384b">AVClass::query_ranges</a>)(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 -->
<!-- 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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Defines</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>



<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.7.6.1
</small></address>

</body>
</html>