Why Gemfury?
Push, build, and install
RubyGems
npm packages
Python packages
Maven artifacts
PHP packages
Go Modules
Debian packages
RPM packages
NuGet packages
showbox-public / ffmpeg-doc deb
Repository URL to install this package:
|
Version:
7:2.7.1-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"/>
<title>FFmpeg: AVOptions</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
 <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 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><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>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#groups">Modules</a> |
<a href="#define-members">Defines</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">AVOptions</div> </div>
<div class="ingroups"><a class="el" href="group__lavu__data.html">Data Structures</a></div></div><!--header-->
<div class="contents">
<p>AVOptions provide a generic system to declare options on arbitrary structs ("objects").
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structAVOption.html">AVOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structAVOption.html" title="AVOption.">AVOption</a>. <a href="structAVOption.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structAVOptionRange.html">AVOptionRange</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A single allowed range of values, or a single allowed value. <a href="structAVOptionRange.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structAVOptionRanges.html">AVOptionRanges</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">List of <a class="el" href="structAVOptionRange.html" title="A single allowed range of values, or a single allowed value.">AVOptionRange</a> structs. <a href="structAVOptionRanges.html#details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="groups"></a>
Modules</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__opt__eval__funcs.html">Evaluating option strings</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>This group of functions can be used to evaluate option strings and get numbers out of them. </p>
<br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__opt__set__funcs.html">Option setting functions</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Those functions set the field of obj with the given name to value. </p>
<br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__opt__get__funcs.html">Option getting functions</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Those functions get a value of the option with the given name from an object. </p>
<br/></td></tr>
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avoptions.html#ga25801ba4fc9b5313eb33ec84e082dd72">AV_OPT_SEARCH_CHILDREN</a>   0x0001</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Search in possible children of the given object first. <a href="#ga25801ba4fc9b5313eb33ec84e082dd72"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avoptions.html#gaa764998552a6f6f66a47ecd52b345caa">AV_OPT_SEARCH_FAKE_OBJ</a>   0x0002</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The obj passed to <a class="el" href="group__avoptions.html#gae31ae7fb20113b00108d0ecf53f25664" title="Look for an option in an object.">av_opt_find()</a> is fake -- only a double pointer to <a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a> instead of a required pointer to a struct containing <a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a>. <a href="#gaa764998552a6f6f66a47ecd52b345caa"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avoptions.html#ga1f10d07c79eec8bd1a8e1b91817e1b1a">AV_OPT_MULTI_COMPONENT_RANGE</a>   0x1000</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allows av_opt_query_ranges and av_opt_query_ranges_default to return more than one component for certain option types. <a href="#ga1f10d07c79eec8bd1a8e1b91817e1b1a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avoptions.html#ga844ea4db9927936ea0cfc98e0113750f">AV_OPT_SERIALIZE_SKIP_DEFAULTS</a>   0x00000001</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Serialize options that are not set to default values only. <a href="#ga844ea4db9927936ea0cfc98e0113750f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avoptions.html#ga49bfd169f5bcde70fb38fc036a524d3a">AV_OPT_SERIALIZE_OPT_FLAGS_EXACT</a>   0x00000002</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Serialize options that exactly match opt_flags only. <a href="#ga49bfd169f5bcde70fb38fc036a524d3a"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avoptions.html#gabd75aa30eb8ad6387672df9a1fa79444">AVOptionType</a> { <br/>
  <a class="el" href="group__avoptions.html#ggabd75aa30eb8ad6387672df9a1fa79444a7aaeee142b88a3078ddc57c644b49a7e">AV_OPT_TYPE_FLAGS</a>,
<a class="el" href="group__avoptions.html#ggabd75aa30eb8ad6387672df9a1fa79444ac068b8f6afeeb293a13aeabb5d702411">AV_OPT_TYPE_INT</a>,
<a class="el" href="group__avoptions.html#ggabd75aa30eb8ad6387672df9a1fa79444a94d540a5b928da813ff94d9367a1078a">AV_OPT_TYPE_INT64</a>,
<a class="el" href="group__avoptions.html#ggabd75aa30eb8ad6387672df9a1fa79444ae0b49ec51847a758ceb46976083da2e5">AV_OPT_TYPE_DOUBLE</a>,
<br/>
  <a class="el" href="group__avoptions.html#ggabd75aa30eb8ad6387672df9a1fa79444ae91d3f6cbac4a4de2a6e880ac2a52d1a">AV_OPT_TYPE_FLOAT</a>,
<a class="el" href="group__avoptions.html#ggabd75aa30eb8ad6387672df9a1fa79444afadddce95ad3b690dd38644b458b96c4">AV_OPT_TYPE_STRING</a>,
<a class="el" href="group__avoptions.html#ggabd75aa30eb8ad6387672df9a1fa79444a74ba464440564230a72b95b39593cbfc">AV_OPT_TYPE_RATIONAL</a>,
<a class="el" href="group__avoptions.html#ggabd75aa30eb8ad6387672df9a1fa79444a2689966edbe494482dfdfaa4efdf95d3">AV_OPT_TYPE_BINARY</a>,
<br/>
  <a class="el" href="group__avoptions.html#ggabd75aa30eb8ad6387672df9a1fa79444aed6f0d8e5b8f3edcaea01c15ab43aefd">AV_OPT_TYPE_DICT</a>,
<a class="el" href="group__avoptions.html#ggabd75aa30eb8ad6387672df9a1fa79444a0fa9f07d428bdc32495fe55c365c5329">AV_OPT_TYPE_CONST</a> = 128,
<a class="el" href="group__avoptions.html#ggabd75aa30eb8ad6387672df9a1fa79444a078f280b98b49a9f585c5d479b711d9a">AV_OPT_TYPE_IMAGE_SIZE</a> = MKBETAG('S','I','Z','E'),
<a class="el" href="group__avoptions.html#ggabd75aa30eb8ad6387672df9a1fa79444a114085ba9877df34de060124877d8274">AV_OPT_TYPE_PIXEL_FMT</a> = MKBETAG('P','F','M','T'),
<br/>
  <a class="el" href="group__avoptions.html#ggabd75aa30eb8ad6387672df9a1fa79444a711661923db91bbbd4abdec0efa5ff0a">AV_OPT_TYPE_SAMPLE_FMT</a> = MKBETAG('S','F','M','T'),
<a class="el" href="group__avoptions.html#ggabd75aa30eb8ad6387672df9a1fa79444a9429811abc62d4a564ec56938df0a572">AV_OPT_TYPE_VIDEO_RATE</a> = MKBETAG('V','R','A','T'),
<a class="el" href="group__avoptions.html#ggabd75aa30eb8ad6387672df9a1fa79444a2e3a2fc47ae688f28cc4abe59452a032">AV_OPT_TYPE_DURATION</a> = MKBETAG('D','U','R',' '),
<a class="el" href="group__avoptions.html#ggabd75aa30eb8ad6387672df9a1fa79444afdcd13cbd184901b05e27595e647fadc">AV_OPT_TYPE_COLOR</a> = MKBETAG('C','O','L','R'),
<br/>
  <a class="el" href="group__avoptions.html#ggabd75aa30eb8ad6387672df9a1fa79444a5628c270688d2ec28643dfff825dbe26">AV_OPT_TYPE_CHANNEL_LAYOUT</a> = MKBETAG('C','H','L','A')
<br/>
}</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <a class="el" href="group__avoptions.html#gga61dadd085c1777f559549e05962b2c9eaa836a939d74606db85ce1f09470d1605">AV_OPT_FLAG_IMPLICIT_KEY</a> = 1
}</td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avoptions.html#gaf7394e27d34208b24af8bb4b4a11741b">av_opt_show2</a> (void *obj, void *av_log_obj, int req_flags, int rej_flags)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Show the obj options. <a href="#gaf7394e27d34208b24af8bb4b4a11741b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avoptions.html#gad4ca968e9058b39b2da630ad0a091bdb">av_opt_set_defaults</a> (void *s)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the values of all <a class="el" href="structAVOption.html" title="AVOption.">AVOption</a> fields to their default values. <a href="#gad4ca968e9058b39b2da630ad0a091bdb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avoptions.html#gab48669d1326f7d47ef39e5702e34abd2">av_set_options_string</a> (void *ctx, const char *opts, const char *key_val_sep, const char *pairs_sep)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse the key/value pairs list in opts. <a href="#gab48669d1326f7d47ef39e5702e34abd2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avoptions.html#gaa936b1aa7caca67b21cd50819c2b9fb1">av_opt_set_from_string</a> (void *ctx, const char *opts, const char *const *shorthand, const char *key_val_sep, const char *pairs_sep)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse the key-value pairs list in opts. <a href="#gaa936b1aa7caca67b21cd50819c2b9fb1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avoptions.html#gac14db824af52baf8181406e98d116097">av_opt_free</a> (void *obj)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Free all allocated objects in obj. <a href="#gac14db824af52baf8181406e98d116097"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avoptions.html#ga1436a3afc8dbc70ed9e70c8287dcc766">av_opt_flag_is_set</a> (void *obj, const char *field_name, const char *flag_name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check whether a particular flag is set in a flags field. <a href="#ga1436a3afc8dbc70ed9e70c8287dcc766"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avoptions.html#gaf1a88e8f152d7835f111b1ef8813fb2e">av_opt_set_dict</a> (void *obj, struct <a class="el" href="group__lavu__dict.html#ga1d7cc0833bee918994a600556410315f">AVDictionary</a> **options)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set all the options from a given dictionary on an object. <a href="#gaf1a88e8f152d7835f111b1ef8813fb2e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avoptions.html#ga1824a600b215f1807e77b5f6cfa58586">av_opt_set_dict2</a> (void *obj, struct <a class="el" href="group__lavu__dict.html#ga1d7cc0833bee918994a600556410315f">AVDictionary</a> **options, int search_flags)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set all the options from a given dictionary on an object. <a href="#ga1824a600b215f1807e77b5f6cfa58586"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avoptions.html#ga1e459af4e23415b8eb9b05aee81c933c">av_opt_get_key_value</a> (const char **ropts, const char *key_val_sep, const char *pairs_sep, unsigned flags, char **rkey, char **rval)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extract a key-value pair from the beginning of a string. <a href="#ga1e459af4e23415b8eb9b05aee81c933c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structAVOption.html">AVOption</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avoptions.html#gae31ae7fb20113b00108d0ecf53f25664">av_opt_find</a> (void *obj, const char *name, const char *unit, int opt_flags, int search_flags)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Look for an option in an object. <a href="#gae31ae7fb20113b00108d0ecf53f25664"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structAVOption.html">AVOption</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avoptions.html#ga3e121fd0b44b34e31756f4fe848d29a7">av_opt_find2</a> (void *obj, const char *name, const char *unit, int opt_flags, int search_flags, void **target_obj)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Look for an option in an object. <a href="#ga3e121fd0b44b34e31756f4fe848d29a7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structAVOption.html">AVOption</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avoptions.html#ga33723e44fd2f22f42fe7145a08ea8e60">av_opt_next</a> (<a class="el" href="group__depr__guards.html#ga782e553655937c70755555d8503652b8">FF_CONST_AVUTIL55</a> void *obj, const <a class="el" href="structAVOption.html">AVOption</a> *prev)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate over all AVOptions belonging to obj. <a href="#ga33723e44fd2f22f42fe7145a08ea8e60"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avoptions.html#gaacce30022d2e99c7b9309d3ad3345f69">av_opt_child_next</a> (void *obj, void *prev)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate over AVOptions-enabled children of obj. <a href="#gaacce30022d2e99c7b9309d3ad3345f69"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structAVClass.html">AVClass</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avoptions.html#gadee1f425013a0f861a40a72d80f189b1">av_opt_child_class_next</a> (const <a class="el" href="structAVClass.html">AVClass</a> *parent, const <a class="el" href="structAVClass.html">AVClass</a> *prev)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate over potential AVOptions-enabled children of parent. <a href="#gadee1f425013a0f861a40a72d80f189b1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avoptions.html#gab1d208d09e487741a28016919225bef6">av_opt_ptr</a> (const <a class="el" href="structAVClass.html">AVClass</a> *avclass, void *obj, const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets a pointer to the requested field in a struct. <a href="#gab1d208d09e487741a28016919225bef6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avoptions.html#ga880756f24644ff66c806ed2d9ab3d790">av_opt_freep_ranges</a> (<a class="el" href="structAVOptionRanges.html">AVOptionRanges</a> **ranges)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Free an <a class="el" href="structAVOptionRanges.html" title="List of AVOptionRange structs.">AVOptionRanges</a> struct and set it to NULL. <a href="#ga880756f24644ff66c806ed2d9ab3d790"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avoptions.html#ga9751db4da3e0facd522f5b345f4001ef">av_opt_query_ranges</a> (<a class="el" href="structAVOptionRanges.html">AVOptionRanges</a> **, void *obj, const char *key, int flags)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a list of allowed ranges for the given option. <a href="#ga9751db4da3e0facd522f5b345f4001ef"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avoptions.html#ga846d90231d6d8ac78f9d33703268dc29">av_opt_copy</a> (void *dest, <a class="el" href="group__depr__guards.html#ga782e553655937c70755555d8503652b8">FF_CONST_AVUTIL55</a> void *src)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy options from src object into dest object. <a href="#ga846d90231d6d8ac78f9d33703268dc29"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avoptions.html#ga4e50bee09b6a374cc54237314892c001">av_opt_query_ranges_default</a> (<a class="el" href="structAVOptionRanges.html">AVOptionRanges</a> **, void *obj, const char *key, int flags)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a default list of allowed ranges for the given option. <a href="#ga4e50bee09b6a374cc54237314892c001"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avoptions.html#ga3ca54258a4c5ac18999dd19b4444c15a">av_opt_is_set_to_default</a> (void *obj, const <a class="el" href="structAVOption.html">AVOption</a> *o)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if given option is set to its default value. <a href="#ga3ca54258a4c5ac18999dd19b4444c15a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avoptions.html#gaa37a02c9d3e6d9f049f2e7174811f5fb">av_opt_is_set_to_default_by_name</a> (void *obj, const char *name, int search_flags)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if given option is set to its default value. <a href="#gaa37a02c9d3e6d9f049f2e7174811f5fb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__avoptions.html#ga523122ff19a79f2867a9da29bbafa33b">av_opt_serialize</a> (void *obj, int opt_flags, int flags, char **buffer, const char key_val_sep, const char pairs_sep)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Serialize object's options. <a href="#ga523122ff19a79f2867a9da29bbafa33b"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>AVOptions provide a generic system to declare options on arbitrary structs ("objects"). </p>
<p>An option can have a help text, a type and a range of possible values. Options may then be enumerated, read and written to.</p>
<h2><a class="anchor" id="avoptions_implement"></a>
Implementing AVOptions</h2>
<p>This section describes how to add AVOptions capabilities to a struct.</p>
<p>All AVOptions-related information is stored in an <a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a>. Therefore the first member of the struct should be a pointer to an <a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a> describing it. The option field of the <a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a> must be set to a NULL-terminated static array of AVOptions. Each <a class="el" href="structAVOption.html" title="AVOption.">AVOption</a> must have a non-empty name, a type, a default value and for number-type AVOptions also a range of allowed values. It must also declare an offset in bytes from the start of the struct, where the field associated with this <a class="el" href="structAVOption.html" title="AVOption.">AVOption</a> is located. Other fields in the <a class="el" href="structAVOption.html" title="AVOption.">AVOption</a> struct should also be set when applicable, but are not required.</p>
<p>The following example illustrates an AVOptions-enabled struct: </p>
<div class="fragment"><pre class="fragment"> <span class="keyword">typedef</span> <span class="keyword">struct </span>test_struct {
<a class="code" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a> *<span class="keyword">class</span>;
<span class="keywordtype">int</span> int_opt;
<span class="keywordtype">char</span> *str_opt;
uint8_t *bin_opt;
<span class="keywordtype">int</span> bin_len;
} test_struct;
<span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="structAVOption.html" title="AVOption.">AVOption</a> test_options[] = {
{ <span class="stringliteral">"test_int"</span>, <span class="stringliteral">"This is a test option of int type."</span>, offsetof(test_struct, int_opt),
<a class="code" href="group__avoptions.html#ggabd75aa30eb8ad6387672df9a1fa79444ac068b8f6afeeb293a13aeabb5d702411">AV_OPT_TYPE_INT</a>, { .i64 = -1 }, INT_MIN, INT_MAX },
{ <span class="stringliteral">"test_str"</span>, <span class="stringliteral">"This is a test option of string type."</span>, offsetof(test_struct, str_opt),
<a class="code" href="group__avoptions.html#ggabd75aa30eb8ad6387672df9a1fa79444afadddce95ad3b690dd38644b458b96c4">AV_OPT_TYPE_STRING</a> },
{ <span class="stringliteral">"test_bin"</span>, <span class="stringliteral">"This is a test option of binary type."</span>, offsetof(test_struct, bin_opt),
<a class="code" href="group__avoptions.html#ggabd75aa30eb8ad6387672df9a1fa79444a2689966edbe494482dfdfaa4efdf95d3" title="offset must point to a pointer immediately followed by an int for the length">AV_OPT_TYPE_BINARY</a> },
{ NULL },
};
<span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a> test_class = {
.<a class="code" href="structAVClass.html#aa8883e113a3f2965abd008f7667db7eb" title="The name of the class; usually it is the same name as the context structure type to which the AVClass...">class_name</a> = <span class="stringliteral">"test class"</span>,
.item_name = <a class="code" href="group__lavu__log.html#ga791fcd0dba1d19fe0c3677509344328e" title="Return the context name.">av_default_item_name</a>,
.option = test_options,
.version = <a class="code" href="group__lavu__ver.html#ga36e17e3fc9bcbe5c55820a8ac8b47e3c">LIBAVUTIL_VERSION_INT</a>,
};
</pre></div><p>Next, when allocating your struct, you must ensure that the <a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a> pointer is set to the correct value. Then, <a class="el" href="group__avoptions.html#gad4ca968e9058b39b2da630ad0a091bdb" title="Set the values of all AVOption fields to their default values.">av_opt_set_defaults()</a> can be called to initialize defaults. After that the struct is ready to be used with the AVOptions API.</p>
<p>When cleaning up, you may use the <a class="el" href="group__avoptions.html#gac14db824af52baf8181406e98d116097" title="Free all allocated objects in obj.">av_opt_free()</a> function to automatically free all the allocated string and binary options.</p>
<p>Continuing with the above example:</p>
<div class="fragment"><pre class="fragment"> test_struct *alloc_test_struct(<span class="keywordtype">void</span>)
{
test_struct *ret = <a class="code" href="group__lavu__mem.html#ga9722446c5e310ffedfaac9489864796d" title="Allocate a block of size bytes with alignment suitable for all memory accesses (including vectors if ...">av_malloc</a>(<span class="keyword">sizeof</span>(*ret));
ret->class = &test_class;
<a class="code" href="group__avoptions.html#gad4ca968e9058b39b2da630ad0a091bdb" title="Set the values of all AVOption fields to their default values.">av_opt_set_defaults</a>(ret);
<span class="keywordflow">return</span> ret;
}
<span class="keywordtype">void</span> free_test_struct(test_struct **foo)
{
<a class="code" href="group__avoptions.html#gac14db824af52baf8181406e98d116097" title="Free all allocated objects in obj.">av_opt_free</a>(*foo);
<a class="code" href="group__lavu__mem.html#ga0cc84043ea2167ad005c86e11d0bcdba" title="Free a memory block which has been allocated with av_malloc(z)() or av_realloc() and set the pointer ...">av_freep</a>(foo);
}
</pre></div><h3><a class="anchor" id="avoptions_implement_nesting"></a>
Nesting</h3>
<p>It may happen that an AVOptions-enabled struct contains another AVOptions-enabled struct as a member (e.g. <a class="el" href="structAVCodecContext.html" title="main external API structure.">AVCodecContext</a> in libavcodec exports generic options, while its priv_data field exports codec-specific options). In such a case, it is possible to set up the parent struct to export a child's options. To do that, simply implement <a class="el" href="structAVClass.html#af13472aa40bca9eaad0d5b4ee4c00cab" title="Return next AVOptions-enabled child or NULL.">AVClass.child_next()</a> and <a class="el" href="structAVClass.html#a015e0495e24b397b331e984d3b99d582" title="Return an AVClass corresponding to the next potential AVOptions-enabled child.">AVClass.child_class_next()</a> in the parent struct's <a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a>. Assuming that the test_struct from above now also contains a child_struct field:</p>
<div class="fragment"><pre class="fragment"> <span class="keyword">typedef</span> <span class="keyword">struct </span>child_struct {
<a class="code" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a> *<span class="keyword">class</span>;
<span class="keywordtype">int</span> flags_opt;
} child_struct;
<span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="structAVOption.html" title="AVOption.">AVOption</a> child_opts[] = {
{ <span class="stringliteral">"test_flags"</span>, <span class="stringliteral">"This is a test option of flags type."</span>,
offsetof(child_struct, flags_opt), <a class="code" href="group__avoptions.html#ggabd75aa30eb8ad6387672df9a1fa79444a7aaeee142b88a3078ddc57c644b49a7e">AV_OPT_TYPE_FLAGS</a>, { .i64 = 0 }, INT_MIN, INT_MAX },
{ NULL },
};
<span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a> child_class = {
.<a class="code" href="structAVClass.html#aa8883e113a3f2965abd008f7667db7eb" title="The name of the class; usually it is the same name as the context structure type to which the AVClass...">class_name</a> = <span class="stringliteral">"child class"</span>,
.item_name = <a class="code" href="group__lavu__log.html#ga791fcd0dba1d19fe0c3677509344328e" title="Return the context name.">av_default_item_name</a>,
.option = child_opts,
.version = <a class="code" href="group__lavu__ver.html#ga36e17e3fc9bcbe5c55820a8ac8b47e3c">LIBAVUTIL_VERSION_INT</a>,
};
<span class="keywordtype">void</span> *child_next(<span class="keywordtype">void</span> *obj, <span class="keywordtype">void</span> *prev)
{
test_struct *t = obj;
<span class="keywordflow">if</span> (!prev && t->child_struct)
<span class="keywordflow">return</span> t->child_struct;
<span class="keywordflow">return</span> NULL
}
<span class="keyword">const</span> <a class="code" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a> child_class_next(<span class="keyword">const</span> <a class="code" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a> *prev)
{
<span class="keywordflow">return</span> prev ? NULL : &child_class;
}
</pre></div><p> Putting child_next() and child_class_next() as defined above into test_class will now make child_struct's options accessible through test_struct (again, proper setup as described above needs to be done on child_struct right after it is created).</p>
<p>From the above example it might not be clear why both child_next() and child_class_next() are needed. The distinction is that child_next() iterates over actually existing objects, while child_class_next() iterates over all possible child classes. E.g. if an <a class="el" href="structAVCodecContext.html" title="main external API structure.">AVCodecContext</a> was initialized to use a codec which has private options, then its child_next() will return <a class="el" href="structAVCodecContext.html#af3379123060ad8cc9c321c29af4f8360">AVCodecContext.priv_data</a> and finish iterating. OTOH child_class_next() on <a class="el" href="structAVCodecContext.html#a90622d3af2a9abba986a1c9f7ca21b16" title="information on struct for av_log">AVCodecContext.av_class</a> will iterate over all available codecs with private options.</p>
<h3><a class="anchor" id="avoptions_implement_named_constants"></a>
Named constants</h3>
<p>It is possible to create named constants for options. Simply set the unit field of the option the constants should apply to a string and create the constants themselves as options of type AV_OPT_TYPE_CONST with their unit field set to the same string. Their default_val field should contain the value of the named constant. For example, to add some named constants for the test_flags option above, put the following into the child_opts array: </p>
<div class="fragment"><pre class="fragment"> { <span class="stringliteral">"test_flags"</span>, <span class="stringliteral">"This is a test option of flags type."</span>,
offsetof(child_struct, flags_opt), <a class="code" href="group__avoptions.html#ggabd75aa30eb8ad6387672df9a1fa79444a7aaeee142b88a3078ddc57c644b49a7e">AV_OPT_TYPE_FLAGS</a>, { .i64 = 0 }, INT_MIN, INT_MAX, <span class="stringliteral">"test_unit"</span> },
{ <span class="stringliteral">"flag1"</span>, <span class="stringliteral">"This is a flag with value 16"</span>, 0, <a class="code" href="group__avoptions.html#ggabd75aa30eb8ad6387672df9a1fa79444a0fa9f07d428bdc32495fe55c365c5329">AV_OPT_TYPE_CONST</a>, { .i64 = 16 }, 0, 0, <span class="stringliteral">"test_unit"</span> },
</pre></div><h2><a class="anchor" id="avoptions_use"></a>
Using AVOptions</h2>
<p>This section deals with accessing options in an AVOptions-enabled struct. Such structs in FFmpeg are e.g. <a class="el" href="structAVCodecContext.html" title="main external API structure.">AVCodecContext</a> in libavcodec or <a class="el" href="structAVFormatContext.html" title="Format I/O context.">AVFormatContext</a> in libavformat.</p>
<h3><a class="anchor" id="avoptions_use_examine"></a>
Examining AVOptions</h3>
<p>The basic functions for examining options are <a class="el" href="group__avoptions.html#ga33723e44fd2f22f42fe7145a08ea8e60" title="Iterate over all AVOptions belonging to obj.">av_opt_next()</a>, which iterates over all options defined for one object, and <a class="el" href="group__avoptions.html#gae31ae7fb20113b00108d0ecf53f25664" title="Look for an option in an object.">av_opt_find()</a>, which searches for an option with the given name.</p>
<p>The situation is more complicated with nesting. An AVOptions-enabled struct may have AVOptions-enabled children. Passing the AV_OPT_SEARCH_CHILDREN flag to <a class="el" href="group__avoptions.html#gae31ae7fb20113b00108d0ecf53f25664" title="Look for an option in an object.">av_opt_find()</a> will make the function search children recursively.</p>
<p>For enumerating there are basically two cases. The first is when you want to get all options that may potentially exist on the struct and its children (e.g. when constructing documentation). In that case you should call <a class="el" href="group__avoptions.html#gadee1f425013a0f861a40a72d80f189b1" title="Iterate over potential AVOptions-enabled children of parent.">av_opt_child_class_next()</a> recursively on the parent struct's <a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a>. The second case is when you have an already initialized struct with all its children and you want to get all options that can be actually written or read from it. In that case you should call <a class="el" href="group__avoptions.html#gaacce30022d2e99c7b9309d3ad3345f69" title="Iterate over AVOptions-enabled children of obj.">av_opt_child_next()</a> recursively (and <a class="el" href="group__avoptions.html#ga33723e44fd2f22f42fe7145a08ea8e60" title="Iterate over all AVOptions belonging to obj.">av_opt_next()</a> on each result).</p>
<h3><a class="anchor" id="avoptions_use_get_set"></a>
Reading and writing AVOptions</h3>
<p>When setting options, you often have a string read directly from the user. In such a case, simply passing it to <a class="el" href="group__opt__set__funcs.html#ga5fd4b92bdf4f392a2847f711676a7537">av_opt_set()</a> is enough. For non-string type options, <a class="el" href="group__opt__set__funcs.html#ga5fd4b92bdf4f392a2847f711676a7537">av_opt_set()</a> will parse the string according to the option type.</p>
<p>Similarly <a class="el" href="group__opt__get__funcs.html#gaf31144e60f9ce89dbe8cbea57a0b232c">av_opt_get()</a> will read any option type and convert it to a string which will be returned. Do not forget that the string is allocated, so you have to free it with <a class="el" href="group__lavu__mem.html#ga0c9096f498624c525aa2315b8a20c411" title="Free a memory block which has been allocated with av_malloc(z)() or av_realloc().">av_free()</a>.</p>
<p>In some cases it may be more convenient to put all options into an AVDictionary and call <a class="el" href="group__avoptions.html#gaf1a88e8f152d7835f111b1ef8813fb2e" title="Set all the options from a given dictionary on an object.">av_opt_set_dict()</a> on it. A specific case of this are the format/codec open functions in lavf/lavc which take a dictionary filled with option as a parameter. This makes it possible to set some options that cannot be set otherwise, since e.g. the input file format is not known before the file is actually opened. </p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ga25801ba4fc9b5313eb33ec84e082dd72"></a><!-- doxytag: member="opt.h::AV_OPT_SEARCH_CHILDREN" ref="ga25801ba4fc9b5313eb33ec84e082dd72" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define <a class="el" href="group__avoptions.html#ga25801ba4fc9b5313eb33ec84e082dd72">AV_OPT_SEARCH_CHILDREN</a>   0x0001</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Search in possible children of the given object first. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="filter_audio_8c-example.html#a13">filter_audio.c</a>, <a class="el" href="filtering_audio_8c-example.html#a46">filtering_audio.c</a>, <a class="el" href="filtering_video_8c-example.html#a44">filtering_video.c</a>, and <a class="el" href="transcoding_8c-example.html#a75">transcoding.c</a>.</dd>
</dl>
<p>Definition at line <a class="el" href="opt_8h_source.html#l00602">602</a> of file <a class="el" href="opt_8h_source.html">opt.h</a>.</p>
<p>Referenced by <a class="el" href="transcoding_8c_source.html#l00187">init_filter()</a>, <a class="el" href="filter__audio_8c_source.html#l00062">init_filter_graph()</a>, and <a class="el" href="filtering__audio_8c_source.html#l00085">init_filters()</a>.</p>
</div>
</div>
<a class="anchor" id="gaa764998552a6f6f66a47ecd52b345caa"></a><!-- doxytag: member="opt.h::AV_OPT_SEARCH_FAKE_OBJ" ref="gaa764998552a6f6f66a47ecd52b345caa" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define <a class="el" href="group__avoptions.html#gaa764998552a6f6f66a47ecd52b345caa">AV_OPT_SEARCH_FAKE_OBJ</a>   0x0002</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The obj passed to <a class="el" href="group__avoptions.html#gae31ae7fb20113b00108d0ecf53f25664" title="Look for an option in an object.">av_opt_find()</a> is fake -- only a double pointer to <a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a> instead of a required pointer to a struct containing <a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a>. </p>
<p>This is useful for searching for options without needing to allocate the corresponding object. </p>
<p>Definition at line <a class="el" href="opt_8h_source.html#l00610">610</a> of file <a class="el" href="opt_8h_source.html">opt.h</a>.</p>
</div>
</div>
<a class="anchor" id="ga1f10d07c79eec8bd1a8e1b91817e1b1a"></a><!-- doxytag: member="opt.h::AV_OPT_MULTI_COMPONENT_RANGE" ref="ga1f10d07c79eec8bd1a8e1b91817e1b1a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define <a class="el" href="group__avoptions.html#ga1f10d07c79eec8bd1a8e1b91817e1b1a">AV_OPT_MULTI_COMPONENT_RANGE</a>   0x1000</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Allows av_opt_query_ranges and av_opt_query_ranges_default to return more than one component for certain option types. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="structAVOptionRanges.html" title="List of AVOptionRange structs.">AVOptionRanges</a> for details. </dd></dl>
<p>Definition at line <a class="el" href="opt_8h_source.html#l00617">617</a> of file <a class="el" href="opt_8h_source.html">opt.h</a>.</p>
</div>
</div>
<a class="anchor" id="ga844ea4db9927936ea0cfc98e0113750f"></a><!-- doxytag: member="opt.h::AV_OPT_SERIALIZE_SKIP_DEFAULTS" ref="ga844ea4db9927936ea0cfc98e0113750f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define <a class="el" href="group__avoptions.html#ga844ea4db9927936ea0cfc98e0113750f">AV_OPT_SERIALIZE_SKIP_DEFAULTS</a>   0x00000001</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Serialize options that are not set to default values only. </p>
<p>Definition at line <a class="el" href="opt_8h_source.html#l00874">874</a> of file <a class="el" href="opt_8h_source.html">opt.h</a>.</p>
</div>
</div>
<a class="anchor" id="ga49bfd169f5bcde70fb38fc036a524d3a"></a><!-- doxytag: member="opt.h::AV_OPT_SERIALIZE_OPT_FLAGS_EXACT" ref="ga49bfd169f5bcde70fb38fc036a524d3a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define <a class="el" href="group__avoptions.html#ga49bfd169f5bcde70fb38fc036a524d3a">AV_OPT_SERIALIZE_OPT_FLAGS_EXACT</a>   0x00000002</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Serialize options that exactly match opt_flags only. </p>
<p>Definition at line <a class="el" href="opt_8h_source.html#l00875">875</a> of file <a class="el" href="opt_8h_source.html">opt.h</a>.</p>
</div>
</div>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="gabd75aa30eb8ad6387672df9a1fa79444"></a><!-- doxytag: member="opt.h::AVOptionType" ref="gabd75aa30eb8ad6387672df9a1fa79444" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__avoptions.html#gabd75aa30eb8ad6387672df9a1fa79444">AVOptionType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ggabd75aa30eb8ad6387672df9a1fa79444a7aaeee142b88a3078ddc57c644b49a7e"></a><!-- doxytag: member="AV_OPT_TYPE_FLAGS" ref="ggabd75aa30eb8ad6387672df9a1fa79444a7aaeee142b88a3078ddc57c644b49a7e" args="" -->AV_OPT_TYPE_FLAGS</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabd75aa30eb8ad6387672df9a1fa79444ac068b8f6afeeb293a13aeabb5d702411"></a><!-- doxytag: member="AV_OPT_TYPE_INT" ref="ggabd75aa30eb8ad6387672df9a1fa79444ac068b8f6afeeb293a13aeabb5d702411" args="" -->AV_OPT_TYPE_INT</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabd75aa30eb8ad6387672df9a1fa79444a94d540a5b928da813ff94d9367a1078a"></a><!-- doxytag: member="AV_OPT_TYPE_INT64" ref="ggabd75aa30eb8ad6387672df9a1fa79444a94d540a5b928da813ff94d9367a1078a" args="" -->AV_OPT_TYPE_INT64</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabd75aa30eb8ad6387672df9a1fa79444ae0b49ec51847a758ceb46976083da2e5"></a><!-- doxytag: member="AV_OPT_TYPE_DOUBLE" ref="ggabd75aa30eb8ad6387672df9a1fa79444ae0b49ec51847a758ceb46976083da2e5" args="" -->AV_OPT_TYPE_DOUBLE</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabd75aa30eb8ad6387672df9a1fa79444ae91d3f6cbac4a4de2a6e880ac2a52d1a"></a><!-- doxytag: member="AV_OPT_TYPE_FLOAT" ref="ggabd75aa30eb8ad6387672df9a1fa79444ae91d3f6cbac4a4de2a6e880ac2a52d1a" args="" -->AV_OPT_TYPE_FLOAT</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabd75aa30eb8ad6387672df9a1fa79444afadddce95ad3b690dd38644b458b96c4"></a><!-- doxytag: member="AV_OPT_TYPE_STRING" ref="ggabd75aa30eb8ad6387672df9a1fa79444afadddce95ad3b690dd38644b458b96c4" args="" -->AV_OPT_TYPE_STRING</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabd75aa30eb8ad6387672df9a1fa79444a74ba464440564230a72b95b39593cbfc"></a><!-- doxytag: member="AV_OPT_TYPE_RATIONAL" ref="ggabd75aa30eb8ad6387672df9a1fa79444a74ba464440564230a72b95b39593cbfc" args="" -->AV_OPT_TYPE_RATIONAL</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabd75aa30eb8ad6387672df9a1fa79444a2689966edbe494482dfdfaa4efdf95d3"></a><!-- doxytag: member="AV_OPT_TYPE_BINARY" ref="ggabd75aa30eb8ad6387672df9a1fa79444a2689966edbe494482dfdfaa4efdf95d3" args="" -->AV_OPT_TYPE_BINARY</em> </td><td>
<p>offset must point to a pointer immediately followed by an int for the length </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabd75aa30eb8ad6387672df9a1fa79444aed6f0d8e5b8f3edcaea01c15ab43aefd"></a><!-- doxytag: member="AV_OPT_TYPE_DICT" ref="ggabd75aa30eb8ad6387672df9a1fa79444aed6f0d8e5b8f3edcaea01c15ab43aefd" args="" -->AV_OPT_TYPE_DICT</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabd75aa30eb8ad6387672df9a1fa79444a0fa9f07d428bdc32495fe55c365c5329"></a><!-- doxytag: member="AV_OPT_TYPE_CONST" ref="ggabd75aa30eb8ad6387672df9a1fa79444a0fa9f07d428bdc32495fe55c365c5329" args="" -->AV_OPT_TYPE_CONST</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabd75aa30eb8ad6387672df9a1fa79444a078f280b98b49a9f585c5d479b711d9a"></a><!-- doxytag: member="AV_OPT_TYPE_IMAGE_SIZE" ref="ggabd75aa30eb8ad6387672df9a1fa79444a078f280b98b49a9f585c5d479b711d9a" args="" -->AV_OPT_TYPE_IMAGE_SIZE</em> </td><td>
<p>offset must point to two consecutive integers </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabd75aa30eb8ad6387672df9a1fa79444a114085ba9877df34de060124877d8274"></a><!-- doxytag: member="AV_OPT_TYPE_PIXEL_FMT" ref="ggabd75aa30eb8ad6387672df9a1fa79444a114085ba9877df34de060124877d8274" args="" -->AV_OPT_TYPE_PIXEL_FMT</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabd75aa30eb8ad6387672df9a1fa79444a711661923db91bbbd4abdec0efa5ff0a"></a><!-- doxytag: member="AV_OPT_TYPE_SAMPLE_FMT" ref="ggabd75aa30eb8ad6387672df9a1fa79444a711661923db91bbbd4abdec0efa5ff0a" args="" -->AV_OPT_TYPE_SAMPLE_FMT</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabd75aa30eb8ad6387672df9a1fa79444a9429811abc62d4a564ec56938df0a572"></a><!-- doxytag: member="AV_OPT_TYPE_VIDEO_RATE" ref="ggabd75aa30eb8ad6387672df9a1fa79444a9429811abc62d4a564ec56938df0a572" args="" -->AV_OPT_TYPE_VIDEO_RATE</em> </td><td>
<p>offset must point to <a class="el" href="structAVRational.html" title="rational number numerator/denominator">AVRational</a> </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabd75aa30eb8ad6387672df9a1fa79444a2e3a2fc47ae688f28cc4abe59452a032"></a><!-- doxytag: member="AV_OPT_TYPE_DURATION" ref="ggabd75aa30eb8ad6387672df9a1fa79444a2e3a2fc47ae688f28cc4abe59452a032" args="" -->AV_OPT_TYPE_DURATION</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabd75aa30eb8ad6387672df9a1fa79444afdcd13cbd184901b05e27595e647fadc"></a><!-- doxytag: member="AV_OPT_TYPE_COLOR" ref="ggabd75aa30eb8ad6387672df9a1fa79444afdcd13cbd184901b05e27595e647fadc" args="" -->AV_OPT_TYPE_COLOR</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggabd75aa30eb8ad6387672df9a1fa79444a5628c270688d2ec28643dfff825dbe26"></a><!-- doxytag: member="AV_OPT_TYPE_CHANNEL_LAYOUT" ref="ggabd75aa30eb8ad6387672df9a1fa79444a5628c270688d2ec28643dfff825dbe26" args="" -->AV_OPT_TYPE_CHANNEL_LAYOUT</em> </td><td>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="opt_8h_source.html#l00221">221</a> of file <a class="el" href="opt_8h_source.html">opt.h</a>.</p>
</div>
</div>
<a class="anchor" id="ga61dadd085c1777f559549e05962b2c9e"></a><!-- doxytag: member="opt.h::@5" ref="ga61dadd085c1777f559549e05962b2c9e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum</td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="gga61dadd085c1777f559549e05962b2c9eaa836a939d74606db85ce1f09470d1605"></a><!-- doxytag: member="AV_OPT_FLAG_IMPLICIT_KEY" ref="gga61dadd085c1777f559549e05962b2c9eaa836a939d74606db85ce1f09470d1605" args="" -->AV_OPT_FLAG_IMPLICIT_KEY</em> </td><td>
<p>Accept to parse a value without a key; the key will then be returned as NULL. </p>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="opt_8h_source.html#l00569">569</a> of file <a class="el" href="opt_8h_source.html">opt.h</a>.</p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gaf7394e27d34208b24af8bb4b4a11741b"></a><!-- doxytag: member="opt.h::av_opt_show2" ref="gaf7394e27d34208b24af8bb4b4a11741b" args="(void *obj, void *av_log_obj, int req_flags, int rej_flags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__avoptions.html#gaf7394e27d34208b24af8bb4b4a11741b">av_opt_show2</a> </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>av_log_obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>req_flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>rej_flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Show the obj options. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">req_flags</td><td>requested flags for the options to show. Show only the options for which it is opt->flags & req_flags. </td></tr>
<tr><td class="paramname">rej_flags</td><td>rejected flags for the options to show. Show only the options for which it is !(opt->flags & req_flags). </td></tr>
<tr><td class="paramname">av_log_obj</td><td>log context to use for showing the options </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gad4ca968e9058b39b2da630ad0a091bdb"></a><!-- doxytag: member="opt.h::av_opt_set_defaults" ref="gad4ca968e9058b39b2da630ad0a091bdb" args="(void *s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="group__avoptions.html#gad4ca968e9058b39b2da630ad0a091bdb">av_opt_set_defaults</a> </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the values of all <a class="el" href="structAVOption.html" title="AVOption.">AVOption</a> fields to their default values. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>an AVOption-enabled struct (its first member must be a pointer to <a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a>) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gab48669d1326f7d47ef39e5702e34abd2"></a><!-- doxytag: member="opt.h::av_set_options_string" ref="gab48669d1326f7d47ef39e5702e34abd2" args="(void *ctx, const char *opts, const char *key_val_sep, const char *pairs_sep)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__avoptions.html#gab48669d1326f7d47ef39e5702e34abd2">av_set_options_string</a> </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>opts</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key_val_sep</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>pairs_sep</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parse the key/value pairs list in opts. </p>
<p>For each key/value pair found, stores the value in the field in ctx that is named like the key. ctx must be an <a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a> context, storing is done using AVOptions.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">opts</td><td>options string to parse, may be NULL </td></tr>
<tr><td class="paramname">key_val_sep</td><td>a 0-terminated list of characters used to separate key from value </td></tr>
<tr><td class="paramname">pairs_sep</td><td>a 0-terminated list of characters used to separate two pairs from each other </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the number of successfully set key/value pairs, or a negative value corresponding to an AVERROR code in case of error: <a class="el" href="group__lavu__error.html#gae4bb6f165973d09584e0ec0f335f69ca">AVERROR(EINVAL)</a> if opts cannot be parsed, the error code issued by <a class="el" href="group__opt__set__funcs.html#ga5fd4b92bdf4f392a2847f711676a7537">av_opt_set()</a> if a key/value pair cannot be set </dd></dl>
</div>
</div>
<a class="anchor" id="gaa936b1aa7caca67b21cd50819c2b9fb1"></a><!-- doxytag: member="opt.h::av_opt_set_from_string" ref="gaa936b1aa7caca67b21cd50819c2b9fb1" args="(void *ctx, const char *opts, const char *const *shorthand, const char *key_val_sep, const char *pairs_sep)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__avoptions.html#gaa936b1aa7caca67b21cd50819c2b9fb1">av_opt_set_from_string</a> </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>opts</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *const * </td>
<td class="paramname"><em>shorthand</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key_val_sep</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>pairs_sep</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parse the key-value pairs list in opts. </p>
<p>For each key=value pair found, set the value of the corresponding option in ctx.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>the <a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a> object to set options on </td></tr>
<tr><td class="paramname">opts</td><td>the options string, key-value pairs separated by a delimiter </td></tr>
<tr><td class="paramname">shorthand</td><td>a NULL-terminated array of options names for shorthand notation: if the first field in opts has no key part, the key is taken from the first element of shorthand; then again for the second, etc., until either opts is finished, shorthand is finished or a named option is found; after that, all options must be named </td></tr>
<tr><td class="paramname">key_val_sep</td><td>a 0-terminated list of characters used to separate key from value, for example '=' </td></tr>
<tr><td class="paramname">pairs_sep</td><td>a 0-terminated list of characters used to separate two pairs from each other, for example ':' or ',' </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the number of successfully set key=value pairs, or a negative value corresponding to an AVERROR code in case of error: <a class="el" href="group__lavu__error.html#gae4bb6f165973d09584e0ec0f335f69ca">AVERROR(EINVAL)</a> if opts cannot be parsed, the error code issued by av_set_string3() if a key/value pair cannot be set</dd></dl>
<p>Options names must use only the following characters: a-z A-Z 0-9 - . / _ Separators must use characters distinct from option names and from each other. </p>
</div>
</div>
<a class="anchor" id="gac14db824af52baf8181406e98d116097"></a><!-- doxytag: member="opt.h::av_opt_free" ref="gac14db824af52baf8181406e98d116097" args="(void *obj)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="group__avoptions.html#gac14db824af52baf8181406e98d116097">av_opt_free</a> </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Free all allocated objects in obj. </p>
</div>
</div>
<a class="anchor" id="ga1436a3afc8dbc70ed9e70c8287dcc766"></a><!-- doxytag: member="opt.h::av_opt_flag_is_set" ref="ga1436a3afc8dbc70ed9e70c8287dcc766" args="(void *obj, const char *field_name, const char *flag_name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__avoptions.html#ga1436a3afc8dbc70ed9e70c8287dcc766">av_opt_flag_is_set</a> </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>field_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>flag_name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check whether a particular flag is set in a flags field. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">field_name</td><td>the name of the flag field option </td></tr>
<tr><td class="paramname">flag_name</td><td>the name of the flag to check </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>non-zero if the flag is set, zero if the flag isn't set, isn't of the right type, or the flags field doesn't exist. </dd></dl>
</div>
</div>
<a class="anchor" id="gaf1a88e8f152d7835f111b1ef8813fb2e"></a><!-- doxytag: member="opt.h::av_opt_set_dict" ref="gaf1a88e8f152d7835f111b1ef8813fb2e" args="(void *obj, struct AVDictionary **options)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__avoptions.html#gaf1a88e8f152d7835f111b1ef8813fb2e">av_opt_set_dict</a> </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="group__lavu__dict.html#ga1d7cc0833bee918994a600556410315f">AVDictionary</a> ** </td>
<td class="paramname"><em>options</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set all the options from a given dictionary on an object. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">obj</td><td>a struct whose first element is a pointer to <a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a> </td></tr>
<tr><td class="paramname">options</td><td>options to process. This dictionary will be freed and replaced by a new one containing all options not found in obj. Of course this new dictionary needs to be freed by caller with <a class="el" href="group__lavu__dict.html#ga1bafd682b1fbb90e48a4cc3814b820f7" title="Free all the memory allocated for an AVDictionary struct and all keys and values.">av_dict_free()</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success, a negative AVERROR if some option was found in obj, but could not be set.</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__lavu__dict.html#ga6dabaab2d8a53674db6ffd5ac8de3d9f" title="Copy entries from one AVDictionary struct into another.">av_dict_copy()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga1824a600b215f1807e77b5f6cfa58586"></a><!-- doxytag: member="opt.h::av_opt_set_dict2" ref="ga1824a600b215f1807e77b5f6cfa58586" args="(void *obj, struct AVDictionary **options, int search_flags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__avoptions.html#ga1824a600b215f1807e77b5f6cfa58586">av_opt_set_dict2</a> </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="group__lavu__dict.html#ga1d7cc0833bee918994a600556410315f">AVDictionary</a> ** </td>
<td class="paramname"><em>options</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>search_flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set all the options from a given dictionary on an object. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">obj</td><td>a struct whose first element is a pointer to <a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a> </td></tr>
<tr><td class="paramname">options</td><td>options to process. This dictionary will be freed and replaced by a new one containing all options not found in obj. Of course this new dictionary needs to be freed by caller with <a class="el" href="group__lavu__dict.html#ga1bafd682b1fbb90e48a4cc3814b820f7" title="Free all the memory allocated for an AVDictionary struct and all keys and values.">av_dict_free()</a>. </td></tr>
<tr><td class="paramname">search_flags</td><td>A combination of AV_OPT_SEARCH_*.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success, a negative AVERROR if some option was found in obj, but could not be set.</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__lavu__dict.html#ga6dabaab2d8a53674db6ffd5ac8de3d9f" title="Copy entries from one AVDictionary struct into another.">av_dict_copy()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga1e459af4e23415b8eb9b05aee81c933c"></a><!-- doxytag: member="opt.h::av_opt_get_key_value" ref="ga1e459af4e23415b8eb9b05aee81c933c" args="(const char **ropts, const char *key_val_sep, const char *pairs_sep, unsigned flags, char **rkey, char **rval)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__avoptions.html#ga1e459af4e23415b8eb9b05aee81c933c">av_opt_get_key_value</a> </td>
<td>(</td>
<td class="paramtype">const char ** </td>
<td class="paramname"><em>ropts</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key_val_sep</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>pairs_sep</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>rkey</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>rval</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Extract a key-value pair from the beginning of a string. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ropts</td><td>pointer to the options string, will be updated to point to the rest of the string (one of the pairs_sep or the final NUL) </td></tr>
<tr><td class="paramname">key_val_sep</td><td>a 0-terminated list of characters used to separate key from value, for example '=' </td></tr>
<tr><td class="paramname">pairs_sep</td><td>a 0-terminated list of characters used to separate two pairs from each other, for example ':' or ',' </td></tr>
<tr><td class="paramname">flags</td><td>flags; see the AV_OPT_FLAG_* values below </td></tr>
<tr><td class="paramname">rkey</td><td>parsed key; must be freed using <a class="el" href="group__lavu__mem.html#ga0c9096f498624c525aa2315b8a20c411" title="Free a memory block which has been allocated with av_malloc(z)() or av_realloc().">av_free()</a> </td></tr>
<tr><td class="paramname">rval</td><td>parsed value; must be freed using <a class="el" href="group__lavu__mem.html#ga0c9096f498624c525aa2315b8a20c411" title="Free a memory block which has been allocated with av_malloc(z)() or av_realloc().">av_free()</a></td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>>=0 for success, or a negative value corresponding to an AVERROR code in case of error; in particular: <a class="el" href="group__lavu__error.html#gae4bb6f165973d09584e0ec0f335f69ca">AVERROR(EINVAL)</a> if no key is present </dd></dl>
</div>
</div>
<a class="anchor" id="gae31ae7fb20113b00108d0ecf53f25664"></a><!-- doxytag: member="opt.h::av_opt_find" ref="gae31ae7fb20113b00108d0ecf53f25664" args="(void *obj, const char *name, const char *unit, int opt_flags, int search_flags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structAVOption.html">AVOption</a>* <a class="el" href="group__avoptions.html#gae31ae7fb20113b00108d0ecf53f25664">av_opt_find</a> </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>unit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>opt_flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>search_flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Look for an option in an object. </p>
<p>Consider only options which have all the specified flags set.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">obj</td><td>A pointer to a struct whose first element is a pointer to an <a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a>. Alternatively a double pointer to an <a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a>, if AV_OPT_SEARCH_FAKE_OBJ search flag is set. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>The name of the option to look for. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">unit</td><td>When searching for named constants, name of the unit it belongs to. </td></tr>
<tr><td class="paramdir"></td><td class="paramname">opt_flags</td><td>Find only options with all the specified flags set (AV_OPT_FLAG). </td></tr>
<tr><td class="paramdir"></td><td class="paramname">search_flags</td><td>A combination of AV_OPT_SEARCH_*.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the option found, or NULL if no option was found.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Options found with AV_OPT_SEARCH_CHILDREN flag may not be settable directly with <a class="el" href="group__opt__set__funcs.html#ga5fd4b92bdf4f392a2847f711676a7537">av_opt_set()</a>. Use special calls which take an options AVDictionary (e.g. <a class="el" href="group__lavf__decoding.html#ga10a404346c646e4ab58f4ed798baca32" title="Open an input stream and read the header.">avformat_open_input()</a>) to set options found with this flag. </dd></dl>
</div>
</div>
<a class="anchor" id="ga3e121fd0b44b34e31756f4fe848d29a7"></a><!-- doxytag: member="opt.h::av_opt_find2" ref="ga3e121fd0b44b34e31756f4fe848d29a7" args="(void *obj, const char *name, const char *unit, int opt_flags, int search_flags, void **target_obj)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structAVOption.html">AVOption</a>* <a class="el" href="group__avoptions.html#ga3e121fd0b44b34e31756f4fe848d29a7">av_opt_find2</a> </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>unit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>opt_flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>search_flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void ** </td>
<td class="paramname"><em>target_obj</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Look for an option in an object. </p>
<p>Consider only options which have all the specified flags set.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">obj</td><td>A pointer to a struct whose first element is a pointer to an <a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a>. Alternatively a double pointer to an <a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a>, if AV_OPT_SEARCH_FAKE_OBJ search flag is set. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>The name of the option to look for. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">unit</td><td>When searching for named constants, name of the unit it belongs to. </td></tr>
<tr><td class="paramdir"></td><td class="paramname">opt_flags</td><td>Find only options with all the specified flags set (AV_OPT_FLAG). </td></tr>
<tr><td class="paramdir"></td><td class="paramname">search_flags</td><td>A combination of AV_OPT_SEARCH_*. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">target_obj</td><td>if non-NULL, an object to which the option belongs will be written here. It may be different from obj if AV_OPT_SEARCH_CHILDREN is present in search_flags. This parameter is ignored if search_flags contain AV_OPT_SEARCH_FAKE_OBJ.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the option found, or NULL if no option was found. </dd></dl>
</div>
</div>
<a class="anchor" id="ga33723e44fd2f22f42fe7145a08ea8e60"></a><!-- doxytag: member="opt.h::av_opt_next" ref="ga33723e44fd2f22f42fe7145a08ea8e60" args="(FF_CONST_AVUTIL55 void *obj, const AVOption *prev)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structAVOption.html">AVOption</a>* <a class="el" href="group__avoptions.html#ga33723e44fd2f22f42fe7145a08ea8e60">av_opt_next</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__depr__guards.html#ga782e553655937c70755555d8503652b8">FF_CONST_AVUTIL55</a> void * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structAVOption.html">AVOption</a> * </td>
<td class="paramname"><em>prev</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Iterate over all AVOptions belonging to obj. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">obj</td><td>an AVOptions-enabled struct or a double pointer to an <a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a> describing it. </td></tr>
<tr><td class="paramname">prev</td><td>result of the previous call to <a class="el" href="group__avoptions.html#ga33723e44fd2f22f42fe7145a08ea8e60" title="Iterate over all AVOptions belonging to obj.">av_opt_next()</a> on this object or NULL </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>next <a class="el" href="structAVOption.html" title="AVOption.">AVOption</a> or NULL </dd></dl>
</div>
</div>
<a class="anchor" id="gaacce30022d2e99c7b9309d3ad3345f69"></a><!-- doxytag: member="opt.h::av_opt_child_next" ref="gaacce30022d2e99c7b9309d3ad3345f69" args="(void *obj, void *prev)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* <a class="el" href="group__avoptions.html#gaacce30022d2e99c7b9309d3ad3345f69">av_opt_child_next</a> </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>prev</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Iterate over AVOptions-enabled children of obj. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">prev</td><td>result of a previous call to this function or NULL </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>next AVOptions-enabled child or NULL </dd></dl>
</div>
</div>
<a class="anchor" id="gadee1f425013a0f861a40a72d80f189b1"></a><!-- doxytag: member="opt.h::av_opt_child_class_next" ref="gadee1f425013a0f861a40a72d80f189b1" args="(const AVClass *parent, const AVClass *prev)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structAVClass.html">AVClass</a>* <a class="el" href="group__avoptions.html#gadee1f425013a0f861a40a72d80f189b1">av_opt_child_class_next</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structAVClass.html">AVClass</a> * </td>
<td class="paramname"><em>parent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structAVClass.html">AVClass</a> * </td>
<td class="paramname"><em>prev</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Iterate over potential AVOptions-enabled children of parent. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">prev</td><td>result of a previous call to this function or NULL </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a> corresponding to next potential child or NULL </dd></dl>
</div>
</div>
<a class="anchor" id="gab1d208d09e487741a28016919225bef6"></a><!-- doxytag: member="opt.h::av_opt_ptr" ref="gab1d208d09e487741a28016919225bef6" args="(const AVClass *avclass, void *obj, const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* <a class="el" href="group__avoptions.html#gab1d208d09e487741a28016919225bef6">av_opt_ptr</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structAVClass.html">AVClass</a> * </td>
<td class="paramname"><em>avclass</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets a pointer to the requested field in a struct. </p>
<p>This function allows accessing a struct even when its fields are moved or renamed since the application making the access has been compiled,</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the field, it can be cast to the correct type and read or written to. </dd></dl>
</div>
</div>
<a class="anchor" id="ga880756f24644ff66c806ed2d9ab3d790"></a><!-- doxytag: member="opt.h::av_opt_freep_ranges" ref="ga880756f24644ff66c806ed2d9ab3d790" args="(AVOptionRanges **ranges)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="group__avoptions.html#ga880756f24644ff66c806ed2d9ab3d790">av_opt_freep_ranges</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structAVOptionRanges.html">AVOptionRanges</a> ** </td>
<td class="paramname"><em>ranges</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Free an <a class="el" href="structAVOptionRanges.html" title="List of AVOptionRange structs.">AVOptionRanges</a> struct and set it to NULL. </p>
</div>
</div>
<a class="anchor" id="ga9751db4da3e0facd522f5b345f4001ef"></a><!-- doxytag: member="opt.h::av_opt_query_ranges" ref="ga9751db4da3e0facd522f5b345f4001ef" args="(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="group__avoptions.html#ga9751db4da3e0facd522f5b345f4001ef">av_opt_query_ranges</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structAVOptionRanges.html">AVOptionRanges</a> ** </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a list of allowed ranges for the given option. </p>
<p>The returned list may depend on other fields in obj like for example profile.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">flags</td><td>is a bitmask of flags, undefined flags should not be set and should be ignored AV_OPT_SEARCH_FAKE_OBJ indicates that the obj is a double pointer to a <a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a> instead of a full instance AV_OPT_MULTI_COMPONENT_RANGE indicates that function may return more than one component, </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="structAVOptionRanges.html" title="List of AVOptionRange structs.">AVOptionRanges</a></dd></dl>
<p>The result must be freed with av_opt_freep_ranges.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of compontents returned on success, a negative errro code otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="ga846d90231d6d8ac78f9d33703268dc29"></a><!-- doxytag: member="opt.h::av_opt_copy" ref="ga846d90231d6d8ac78f9d33703268dc29" args="(void *dest, FF_CONST_AVUTIL55 void *src)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__avoptions.html#ga846d90231d6d8ac78f9d33703268dc29">av_opt_copy</a> </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__depr__guards.html#ga782e553655937c70755555d8503652b8">FF_CONST_AVUTIL55</a> void * </td>
<td class="paramname"><em>src</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copy options from src object into dest object. </p>
<p>Options that require memory allocation (e.g. string or binary) are malloc'ed in dest object. Original memory allocated for such options is freed unless both src and dest options points to the same memory.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">dest</td><td>Object to copy from </td></tr>
<tr><td class="paramname">src</td><td>Object to copy into </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success, negative on error </dd></dl>
</div>
</div>
<a class="anchor" id="ga4e50bee09b6a374cc54237314892c001"></a><!-- doxytag: member="opt.h::av_opt_query_ranges_default" ref="ga4e50bee09b6a374cc54237314892c001" args="(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="group__avoptions.html#ga4e50bee09b6a374cc54237314892c001">av_opt_query_ranges_default</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structAVOptionRanges.html">AVOptionRanges</a> ** </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a default list of allowed ranges for the given option. </p>
<p>This list is constructed without using the <a class="el" href="structAVClass.html#a2e3cca1bb1e7c441087eaad810b4384b" title="Callback to return the supported/allowed ranges.">AVClass.query_ranges()</a> callback and can be used as fallback from within the callback.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">flags</td><td>is a bitmask of flags, undefined flags should not be set and should be ignored AV_OPT_SEARCH_FAKE_OBJ indicates that the obj is a double pointer to a <a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a> instead of a full instance AV_OPT_MULTI_COMPONENT_RANGE indicates that function may return more than one component, </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="structAVOptionRanges.html" title="List of AVOptionRange structs.">AVOptionRanges</a></dd></dl>
<p>The result must be freed with av_opt_free_ranges.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of compontents returned on success, a negative errro code otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="ga3ca54258a4c5ac18999dd19b4444c15a"></a><!-- doxytag: member="opt.h::av_opt_is_set_to_default" ref="ga3ca54258a4c5ac18999dd19b4444c15a" args="(void *obj, const AVOption *o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__avoptions.html#ga3ca54258a4c5ac18999dd19b4444c15a">av_opt_is_set_to_default</a> </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structAVOption.html">AVOption</a> * </td>
<td class="paramname"><em>o</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if given option is set to its default value. </p>
<p>Options o must belong to the obj. This function must not be called to check child's options state. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__avoptions.html#gaa37a02c9d3e6d9f049f2e7174811f5fb" title="Check if given option is set to its default value.">av_opt_is_set_to_default_by_name()</a>.</dd></dl>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">obj</td><td><a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a> object to check option on </td></tr>
<tr><td class="paramname">o</td><td>option to be checked </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>>0 when option is set to its default, 0 when option is not set its default, <0 on error </dd></dl>
</div>
</div>
<a class="anchor" id="gaa37a02c9d3e6d9f049f2e7174811f5fb"></a><!-- doxytag: member="opt.h::av_opt_is_set_to_default_by_name" ref="gaa37a02c9d3e6d9f049f2e7174811f5fb" args="(void *obj, const char *name, int search_flags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__avoptions.html#gaa37a02c9d3e6d9f049f2e7174811f5fb">av_opt_is_set_to_default_by_name</a> </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>search_flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if given option is set to its default value. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">obj</td><td><a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a> object to check option on </td></tr>
<tr><td class="paramname">name</td><td>option name </td></tr>
<tr><td class="paramname">search_flags</td><td>combination of AV_OPT_SEARCH_* </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>>0 when option is set to its default, 0 when option is not set its default, <0 on error </dd></dl>
</div>
</div>
<a class="anchor" id="ga523122ff19a79f2867a9da29bbafa33b"></a><!-- doxytag: member="opt.h::av_opt_serialize" ref="ga523122ff19a79f2867a9da29bbafa33b" args="(void *obj, int opt_flags, int flags, char **buffer, const char key_val_sep, const char pairs_sep)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__avoptions.html#ga523122ff19a79f2867a9da29bbafa33b">av_opt_serialize</a> </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>opt_flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char </td>
<td class="paramname"><em>key_val_sep</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char </td>
<td class="paramname"><em>pairs_sep</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Serialize object's options. </p>
<p>Create a string containing object's serialized options. Such string may be passed back to <a class="el" href="group__avoptions.html#gaa936b1aa7caca67b21cd50819c2b9fb1" title="Parse the key-value pairs list in opts.">av_opt_set_from_string()</a> in order to restore option values. A key/value or pairs separator occurring in the serialized value or name string are escaped through the <a class="el" href="group__lavu__string.html#ga3781b9212ada2863274cf1def2743d25" title="Escape string in src, and put the escaped string in an allocated string in *dst, which must be freed ...">av_escape()</a> function.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">obj</td><td><a class="el" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a> object to serialize </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">opt_flags</td><td>serialize options with all the specified flags set (AV_OPT_FLAG) </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>combination of AV_OPT_SERIALIZE_* flags </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">buffer</td><td>Pointer to buffer that will be allocated with string containg serialized options. Buffer must be freed by the caller when is no longer needed. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">key_val_sep</td><td>character used to separate key from value </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">pairs_sep</td><td>character used to separate two pairs from each other </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>>= 0 on success, negative on error </dd></dl>
<dl class="warning"><dt><b>Warning:</b></dt><dd>Separators cannot be neither '\' nor '\0'. They also cannot be the same. </dd></dl>
</div>
</div>
</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"> </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>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  <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>