File: //usr/share/doc/libvpx-devel/html/vpx__codec_8h.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>WebM Codec SDK: vpx/vpx_codec.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">WebM Codec SDK
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_ce0ab26228883e873492c15423e35021.html">vpx</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">vpx_codec.h File Reference<div class="ingroups"><a class="el" href="group__codec.html">Common Algorithm Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Describes the codec algorithm interface to applications.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="vpx__image_8h_source.html">./vpx_image.h</a>"</code><br />
<code>#include "./vpx_integer.h"</code><br />
</div>
<p><a href="vpx__codec_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structvpx__codec__ctx.html">vpx_codec_ctx</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Codec context structure. <a href="structvpx__codec__ctx.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gae3469452735ce633173b00024c97d556"><td class="memItemLeft" align="right" valign="top">
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#gae3469452735ce633173b00024c97d556">VPX_DEPRECATED</a></td></tr>
<tr class="memdesc:gae3469452735ce633173b00024c97d556"><td class="mdescLeft"> </td><td class="mdescRight">Decorator indicating a function is deprecated. <br /></td></tr>
<tr class="separator:gae3469452735ce633173b00024c97d556"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga725e874689726a0df88873b93c50254e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#ga725e874689726a0df88873b93c50254e">VPX_DECLSPEC_DEPRECATED</a></td></tr>
<tr class="memdesc:ga725e874689726a0df88873b93c50254e"><td class="mdescLeft"> </td><td class="mdescRight">Decorator indicating a function is deprecated. <br />
<a href="group__codec.html#ga725e874689726a0df88873b93c50254e">More...</a><br /></td></tr>
<tr class="separator:ga725e874689726a0df88873b93c50254e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga21537a8053ca3eb8f1b9f12c47f2883f"><td class="memItemLeft" align="right" valign="top">
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#ga21537a8053ca3eb8f1b9f12c47f2883f">VPX_UNUSED</a></td></tr>
<tr class="memdesc:ga21537a8053ca3eb8f1b9f12c47f2883f"><td class="mdescLeft"> </td><td class="mdescRight">Decorator indicating a function is potentially unused. <br /></td></tr>
<tr class="separator:ga21537a8053ca3eb8f1b9f12c47f2883f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf7e9cad2df0f81679b881f46740ad097"><td class="memItemLeft" align="right" valign="top">
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#gaf7e9cad2df0f81679b881f46740ad097">VPX_CODEC_ABI_VERSION</a></td></tr>
<tr class="memdesc:gaf7e9cad2df0f81679b881f46740ad097"><td class="mdescLeft"> </td><td class="mdescRight">Current ABI version number. <br /></td></tr>
<tr class="separator:gaf7e9cad2df0f81679b881f46740ad097"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae10ad7f9548170aef77df09d48ad108a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#gae10ad7f9548170aef77df09d48ad108a">VPX_CODEC_CAP_DECODER</a>   0x1</td></tr>
<tr class="separator:gae10ad7f9548170aef77df09d48ad108a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab2e8b76fff95ebd573a17bdc11f8a441"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#gab2e8b76fff95ebd573a17bdc11f8a441">VPX_CODEC_CAP_ENCODER</a>   0x2</td></tr>
<tr class="separator:gab2e8b76fff95ebd573a17bdc11f8a441"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8edce93a29457f2de6c0f92e3b3c192d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#ga8edce93a29457f2de6c0f92e3b3c192d">VPX_CODEC_CAP_HIGHBITDEPTH</a>   0x4</td></tr>
<tr class="separator:ga8edce93a29457f2de6c0f92e3b3c192d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadebddd67347fe47c0772b1e06b6173ba"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#gadebddd67347fe47c0772b1e06b6173ba">VPX_VERSION_MAJOR</a>(v)   ((v >> 16) & 0xff)</td></tr>
<tr class="separator:gadebddd67347fe47c0772b1e06b6173ba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4a5ce4588576306dee0d95e8f8706f86"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#ga4a5ce4588576306dee0d95e8f8706f86">VPX_VERSION_MINOR</a>(v)   ((v >> 8) & 0xff)</td></tr>
<tr class="separator:ga4a5ce4588576306dee0d95e8f8706f86"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4acf2cf4c35ff123d17cd67c069fdbaa"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#ga4acf2cf4c35ff123d17cd67c069fdbaa">VPX_VERSION_PATCH</a>(v)   ((v >> 0) & 0xff)</td></tr>
<tr class="separator:ga4acf2cf4c35ff123d17cd67c069fdbaa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf314b746e4e202045e85ac073c29a495"><td class="memItemLeft" align="right" valign="top">
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#gaf314b746e4e202045e85ac073c29a495">vpx_codec_version_major</a>()   ((<a class="el" href="group__codec.html#ga163037ae037ac760da65e4130c7d4767">vpx_codec_version</a>() >> 16) & 0xff)</td></tr>
<tr class="memdesc:gaf314b746e4e202045e85ac073c29a495"><td class="mdescLeft"> </td><td class="mdescRight">Return the version major number. <br /></td></tr>
<tr class="separator:gaf314b746e4e202045e85ac073c29a495"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2b668688a7d1551ea89bcda8f2587f93"><td class="memItemLeft" align="right" valign="top">
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#ga2b668688a7d1551ea89bcda8f2587f93">vpx_codec_version_minor</a>()   ((<a class="el" href="group__codec.html#ga163037ae037ac760da65e4130c7d4767">vpx_codec_version</a>() >> 8) & 0xff)</td></tr>
<tr class="memdesc:ga2b668688a7d1551ea89bcda8f2587f93"><td class="mdescLeft"> </td><td class="mdescRight">Return the version minor number. <br /></td></tr>
<tr class="separator:ga2b668688a7d1551ea89bcda8f2587f93"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8ed64bded0d763fa2158312ac8fbcf26"><td class="memItemLeft" align="right" valign="top">
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#ga8ed64bded0d763fa2158312ac8fbcf26">vpx_codec_version_patch</a>()   ((<a class="el" href="group__codec.html#ga163037ae037ac760da65e4130c7d4767">vpx_codec_version</a>() >> 0) & 0xff)</td></tr>
<tr class="memdesc:ga8ed64bded0d763fa2158312ac8fbcf26"><td class="mdescLeft"> </td><td class="mdescRight">Return the version patch number. <br /></td></tr>
<tr class="separator:ga8ed64bded0d763fa2158312ac8fbcf26"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac1b91e04698c1bd4c0a2b8aa85b08cd2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#gac1b91e04698c1bd4c0a2b8aa85b08cd2">vpx_codec_control</a>(ctx, id, data)</td></tr>
<tr class="memdesc:gac1b91e04698c1bd4c0a2b8aa85b08cd2"><td class="mdescLeft"> </td><td class="mdescRight">vpx_codec_control wrapper macro <a href="group__codec.html#gac1b91e04698c1bd4c0a2b8aa85b08cd2">More...</a><br /></td></tr>
<tr class="separator:gac1b91e04698c1bd4c0a2b8aa85b08cd2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa7409a4cb58b155912f41a4d39d81a8a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#gaa7409a4cb58b155912f41a4d39d81a8a">VPX_CTRL_USE_TYPE</a>(id, typ)</td></tr>
<tr class="memdesc:gaa7409a4cb58b155912f41a4d39d81a8a"><td class="mdescLeft"> </td><td class="mdescRight">vpx_codec_control type definition macro <a href="group__codec.html#gaa7409a4cb58b155912f41a4d39d81a8a">More...</a><br /></td></tr>
<tr class="separator:gaa7409a4cb58b155912f41a4d39d81a8a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga147463efbdbe3b9823e054fe2d56851b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#ga147463efbdbe3b9823e054fe2d56851b">VPX_CTRL_USE_TYPE_DEPRECATED</a>(id, typ)</td></tr>
<tr class="memdesc:ga147463efbdbe3b9823e054fe2d56851b"><td class="mdescLeft"> </td><td class="mdescRight">vpx_codec_control deprecated type definition macro <a href="group__codec.html#ga147463efbdbe3b9823e054fe2d56851b">More...</a><br /></td></tr>
<tr class="separator:ga147463efbdbe3b9823e054fe2d56851b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2610354d13efd9ca04fb95823aeda773"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#ga2610354d13efd9ca04fb95823aeda773">VPX_CTRL_VOID</a>(id)</td></tr>
<tr class="memdesc:ga2610354d13efd9ca04fb95823aeda773"><td class="mdescLeft"> </td><td class="mdescRight">vpx_codec_control void type definition macro <a href="group__codec.html#ga2610354d13efd9ca04fb95823aeda773">More...</a><br /></td></tr>
<tr class="separator:ga2610354d13efd9ca04fb95823aeda773"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gad2b690c0ef83cbd83a7234078791913f"><td class="memItemLeft" align="right" valign="top">typedef long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#gad2b690c0ef83cbd83a7234078791913f">vpx_codec_caps_t</a></td></tr>
<tr class="memdesc:gad2b690c0ef83cbd83a7234078791913f"><td class="mdescLeft"> </td><td class="mdescRight">Codec capabilities bitfield. <a href="group__codec.html#gad2b690c0ef83cbd83a7234078791913f">More...</a><br /></td></tr>
<tr class="separator:gad2b690c0ef83cbd83a7234078791913f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3b36d5af89ddc463489fe5bde0a57877"><td class="memItemLeft" align="right" valign="top">typedef long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#ga3b36d5af89ddc463489fe5bde0a57877">vpx_codec_flags_t</a></td></tr>
<tr class="memdesc:ga3b36d5af89ddc463489fe5bde0a57877"><td class="mdescLeft"> </td><td class="mdescRight">Initialization-time Feature Enabling. <a href="group__codec.html#ga3b36d5af89ddc463489fe5bde0a57877">More...</a><br /></td></tr>
<tr class="separator:ga3b36d5af89ddc463489fe5bde0a57877"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae99c3b04f4a567a311211cce3ae6b83b"><td class="memItemLeft" align="right" valign="top">typedef const struct vpx_codec_iface </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#gae99c3b04f4a567a311211cce3ae6b83b">vpx_codec_iface_t</a></td></tr>
<tr class="memdesc:gae99c3b04f4a567a311211cce3ae6b83b"><td class="mdescLeft"> </td><td class="mdescRight">Codec interface structure. <a href="group__codec.html#gae99c3b04f4a567a311211cce3ae6b83b">More...</a><br /></td></tr>
<tr class="separator:gae99c3b04f4a567a311211cce3ae6b83b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1e262f91be9141a7176335fd409397ab"><td class="memItemLeft" align="right" valign="top">typedef struct vpx_codec_priv </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#ga1e262f91be9141a7176335fd409397ab">vpx_codec_priv_t</a></td></tr>
<tr class="memdesc:ga1e262f91be9141a7176335fd409397ab"><td class="mdescLeft"> </td><td class="mdescRight">Codec private data structure. <a href="group__codec.html#ga1e262f91be9141a7176335fd409397ab">More...</a><br /></td></tr>
<tr class="separator:ga1e262f91be9141a7176335fd409397ab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6ea348f76b1f8a1fe50e14db684146c6"><td class="memItemLeft" align="right" valign="top">typedef const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#ga6ea348f76b1f8a1fe50e14db684146c6">vpx_codec_iter_t</a></td></tr>
<tr class="memdesc:ga6ea348f76b1f8a1fe50e14db684146c6"><td class="mdescLeft"> </td><td class="mdescRight">Iterator. <a href="group__codec.html#ga6ea348f76b1f8a1fe50e14db684146c6">More...</a><br /></td></tr>
<tr class="separator:ga6ea348f76b1f8a1fe50e14db684146c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad03e2dfa6ae511db7d25be6bbb336233"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structvpx__codec__ctx.html">vpx_codec_ctx</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#gad03e2dfa6ae511db7d25be6bbb336233">vpx_codec_ctx_t</a></td></tr>
<tr class="memdesc:gad03e2dfa6ae511db7d25be6bbb336233"><td class="mdescLeft"> </td><td class="mdescRight">Codec context structure. <a href="group__codec.html#gad03e2dfa6ae511db7d25be6bbb336233">More...</a><br /></td></tr>
<tr class="separator:gad03e2dfa6ae511db7d25be6bbb336233"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6272c4d226fe40a57855e4e34737a51b"><td class="memItemLeft" align="right" valign="top">
typedef enum <a class="el" href="group__codec.html#gaeb4bba376f987595b3ad11253adf86d9">vpx_bit_depth</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#ga6272c4d226fe40a57855e4e34737a51b">vpx_bit_depth_t</a></td></tr>
<tr class="memdesc:ga6272c4d226fe40a57855e4e34737a51b"><td class="mdescLeft"> </td><td class="mdescRight">Bit depth for codec</p><ul>
<li>This enumeration determines the bit depth of the codec. </li>
</ul>
<br /></td></tr>
<tr class="separator:ga6272c4d226fe40a57855e4e34737a51b"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gada1084710837ad363b92f2379dd2b8d2"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#gada1084710837ad363b92f2379dd2b8d2">vpx_codec_err_t</a> { <br />
  <a class="el" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2af1dcde74b1c5ff7b29f31246dfd90986">VPX_CODEC_OK</a>,
<a class="el" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2abd8a8f9c2588adab5d764d957e265135">VPX_CODEC_ERROR</a>,
<a class="el" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2a96c6d2600dc0ec25c2cb798e8d2f4760">VPX_CODEC_MEM_ERROR</a>,
<a class="el" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2afe8f723512f728bc518bbfba3b96d324">VPX_CODEC_ABI_MISMATCH</a>,
<br />
  <a class="el" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2a4470784ba5a3ef84dc0697d5489dd292">VPX_CODEC_INCAPABLE</a>,
<a class="el" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2afff886e57782098a3df13d4e349ca973">VPX_CODEC_UNSUP_BITSTREAM</a>,
<a class="el" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2a8a86701e65d826d82651537aadd6c539">VPX_CODEC_UNSUP_FEATURE</a>,
<a class="el" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2a29d03c009e0479dbf4ecbd8db1011b85">VPX_CODEC_CORRUPT_FRAME</a>,
<br />
  <a class="el" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2ab5857f7b5f03f8ca164fab8843a979df">VPX_CODEC_INVALID_PARAM</a>,
<a class="el" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2a452450a5adfcc14ef8a0ac12611dae21">VPX_CODEC_LIST_END</a>
<br />
}</td></tr>
<tr class="memdesc:gada1084710837ad363b92f2379dd2b8d2"><td class="mdescLeft"> </td><td class="mdescRight">Algorithm return codes. <a href="group__codec.html#gada1084710837ad363b92f2379dd2b8d2">More...</a><br /></td></tr>
<tr class="separator:gada1084710837ad363b92f2379dd2b8d2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaeb4bba376f987595b3ad11253adf86d9"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#gaeb4bba376f987595b3ad11253adf86d9">vpx_bit_depth</a> { <a class="el" href="group__codec.html#ggaeb4bba376f987595b3ad11253adf86d9a664e60a9d8c84563836073d88ae1cfe8">VPX_BITS_8</a> = 8,
<a class="el" href="group__codec.html#ggaeb4bba376f987595b3ad11253adf86d9aaecd7245969d06b539de89cf580401e1">VPX_BITS_10</a> = 10,
<a class="el" href="group__codec.html#ggaeb4bba376f987595b3ad11253adf86d9a7d053a31e269b4d3746e88b0ff424862">VPX_BITS_12</a> = 12
}</td></tr>
<tr class="memdesc:gaeb4bba376f987595b3ad11253adf86d9"><td class="mdescLeft"> </td><td class="mdescRight">Bit depth for codec</p><ul>
<li>This enumeration determines the bit depth of the codec. </li>
</ul>
<a href="group__codec.html#gaeb4bba376f987595b3ad11253adf86d9">More...</a><br /></td></tr>
<tr class="separator:gaeb4bba376f987595b3ad11253adf86d9"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga163037ae037ac760da65e4130c7d4767"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#ga163037ae037ac760da65e4130c7d4767">vpx_codec_version</a> (void)</td></tr>
<tr class="memdesc:ga163037ae037ac760da65e4130c7d4767"><td class="mdescLeft"> </td><td class="mdescRight">Return the version information (as an integer) <a href="group__codec.html#ga163037ae037ac760da65e4130c7d4767">More...</a><br /></td></tr>
<tr class="separator:ga163037ae037ac760da65e4130c7d4767"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga163fbcc6dd33827b28b9829a0a86cf59"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#ga163fbcc6dd33827b28b9829a0a86cf59">vpx_codec_version_str</a> (void)</td></tr>
<tr class="memdesc:ga163fbcc6dd33827b28b9829a0a86cf59"><td class="mdescLeft"> </td><td class="mdescRight">Return the version information (as a string) <a href="group__codec.html#ga163fbcc6dd33827b28b9829a0a86cf59">More...</a><br /></td></tr>
<tr class="separator:ga163fbcc6dd33827b28b9829a0a86cf59"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga286c0d4271fea4c488d791154d8f9098"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#ga286c0d4271fea4c488d791154d8f9098">vpx_codec_version_extra_str</a> (void)</td></tr>
<tr class="memdesc:ga286c0d4271fea4c488d791154d8f9098"><td class="mdescLeft"> </td><td class="mdescRight">Return the version information (as a string) <a href="group__codec.html#ga286c0d4271fea4c488d791154d8f9098">More...</a><br /></td></tr>
<tr class="separator:ga286c0d4271fea4c488d791154d8f9098"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga20922bad85472e76d5f61c21cb423af7"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#ga20922bad85472e76d5f61c21cb423af7">vpx_codec_build_config</a> (void)</td></tr>
<tr class="memdesc:ga20922bad85472e76d5f61c21cb423af7"><td class="mdescLeft"> </td><td class="mdescRight">Return the build configuration. <a href="group__codec.html#ga20922bad85472e76d5f61c21cb423af7">More...</a><br /></td></tr>
<tr class="separator:ga20922bad85472e76d5f61c21cb423af7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9eee39f450d8cdcf5aba0e2bda6e5aa8"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#ga9eee39f450d8cdcf5aba0e2bda6e5aa8">vpx_codec_iface_name</a> (<a class="el" href="group__codec.html#gae99c3b04f4a567a311211cce3ae6b83b">vpx_codec_iface_t</a> *iface)</td></tr>
<tr class="memdesc:ga9eee39f450d8cdcf5aba0e2bda6e5aa8"><td class="mdescLeft"> </td><td class="mdescRight">Return the name for a given interface. <a href="group__codec.html#ga9eee39f450d8cdcf5aba0e2bda6e5aa8">More...</a><br /></td></tr>
<tr class="separator:ga9eee39f450d8cdcf5aba0e2bda6e5aa8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaaddf5c1f609ef18c7c8800d102fcefa6"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#gaaddf5c1f609ef18c7c8800d102fcefa6">vpx_codec_err_to_string</a> (<a class="el" href="group__codec.html#gada1084710837ad363b92f2379dd2b8d2">vpx_codec_err_t</a> err)</td></tr>
<tr class="memdesc:gaaddf5c1f609ef18c7c8800d102fcefa6"><td class="mdescLeft"> </td><td class="mdescRight">Convert error number to printable string. <a href="group__codec.html#gaaddf5c1f609ef18c7c8800d102fcefa6">More...</a><br /></td></tr>
<tr class="separator:gaaddf5c1f609ef18c7c8800d102fcefa6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4d265df00d42b36a4f0e3eb83fc22c5e"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#ga4d265df00d42b36a4f0e3eb83fc22c5e">vpx_codec_error</a> (<a class="el" href="group__codec.html#gad03e2dfa6ae511db7d25be6bbb336233">vpx_codec_ctx_t</a> *ctx)</td></tr>
<tr class="memdesc:ga4d265df00d42b36a4f0e3eb83fc22c5e"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve error synopsis for codec context. <a href="group__codec.html#ga4d265df00d42b36a4f0e3eb83fc22c5e">More...</a><br /></td></tr>
<tr class="separator:ga4d265df00d42b36a4f0e3eb83fc22c5e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga29273cb552ed1a437fe263c4a0a54300"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#ga29273cb552ed1a437fe263c4a0a54300">vpx_codec_error_detail</a> (<a class="el" href="group__codec.html#gad03e2dfa6ae511db7d25be6bbb336233">vpx_codec_ctx_t</a> *ctx)</td></tr>
<tr class="memdesc:ga29273cb552ed1a437fe263c4a0a54300"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve detailed error information for codec context. <a href="group__codec.html#ga29273cb552ed1a437fe263c4a0a54300">More...</a><br /></td></tr>
<tr class="separator:ga29273cb552ed1a437fe263c4a0a54300"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6ae21d96909660d0ac978b59a863f53b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__codec.html#gada1084710837ad363b92f2379dd2b8d2">vpx_codec_err_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#ga6ae21d96909660d0ac978b59a863f53b">vpx_codec_destroy</a> (<a class="el" href="group__codec.html#gad03e2dfa6ae511db7d25be6bbb336233">vpx_codec_ctx_t</a> *ctx)</td></tr>
<tr class="memdesc:ga6ae21d96909660d0ac978b59a863f53b"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a codec instance. <a href="group__codec.html#ga6ae21d96909660d0ac978b59a863f53b">More...</a><br /></td></tr>
<tr class="separator:ga6ae21d96909660d0ac978b59a863f53b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga43adff58759093401235fb99247c82b8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__codec.html#gad2b690c0ef83cbd83a7234078791913f">vpx_codec_caps_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#ga43adff58759093401235fb99247c82b8">vpx_codec_get_caps</a> (<a class="el" href="group__codec.html#gae99c3b04f4a567a311211cce3ae6b83b">vpx_codec_iface_t</a> *iface)</td></tr>
<tr class="memdesc:ga43adff58759093401235fb99247c82b8"><td class="mdescLeft"> </td><td class="mdescRight">Get the capabilities of an algorithm. <a href="group__codec.html#ga43adff58759093401235fb99247c82b8">More...</a><br /></td></tr>
<tr class="separator:ga43adff58759093401235fb99247c82b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf7849b69cc390b21d889c8c71f69ec14"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__codec.html#gada1084710837ad363b92f2379dd2b8d2">vpx_codec_err_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__codec.html#gaf7849b69cc390b21d889c8c71f69ec14">vpx_codec_control_</a> (<a class="el" href="group__codec.html#gad03e2dfa6ae511db7d25be6bbb336233">vpx_codec_ctx_t</a> *ctx, int ctrl_id,...)</td></tr>
<tr class="memdesc:gaf7849b69cc390b21d889c8c71f69ec14"><td class="mdescLeft"> </td><td class="mdescRight">Control algorithm. <a href="group__codec.html#gaf7849b69cc390b21d889c8c71f69ec14">More...</a><br /></td></tr>
<tr class="separator:gaf7849b69cc390b21d889c8c71f69ec14"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Describes the codec algorithm interface to applications. </p>
<p>This file describes the interface between an application and a video codec algorithm.</p>
<p>An application instantiates a specific codec instance by using vpx_codec_init() and a pointer to the algorithm's interface structure: </p><pre>
my_app.c:
extern vpx_codec_iface_t my_codec;
{
vpx_codec_ctx_t algo;
res = vpx_codec_init(&algo, &my_codec);
}
</pre><p>Once initialized, the instance is manged using other functions from the vpx_codec_* family. </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>