<!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.3"/>
<title>WebM VP8 Codec SDK: vpx/vpx_codec.h Source File</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 style="padding-left: 0.5em;">
<div id="projectname">WebM VP8 Codec SDK
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
<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 class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</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="headertitle">
<div class="title">vpx_codec.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="vpx__codec_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (c) 2010 The WebM project authors. All Rights Reserved.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Use of this source code is governed by a BSD-style license</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * that can be found in the LICENSE file in the root of the source</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * tree. An additional intellectual property rights grant can be found</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * in the file PATENTS. All contributing project authors may</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * be found in the AUTHORS file in the root of the source tree.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#ifndef VPX_CODEC_H</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor"></span><span class="preprocessor">#define VPX_CODEC_H</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor"></span><span class="preprocessor">#include "vpx_integer.h"</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#include "<a class="code" href="vpx__image_8h.html" title="Describes the vpx image descriptor and associated operations.">vpx_image.h</a>"</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#ifndef DEPRECATED</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor"></span><span class="preprocessor">#if defined(__GNUC__) && __GNUC__</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor"></span><span class="preprocessor">#define DEPRECATED __attribute__ ((deprecated))</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor"></span><span class="preprocessor">#elif defined(_MSC_VER)</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor"></span><span class="preprocessor">#define DEPRECATED</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor"></span><span class="preprocessor">#else</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="code" href="group__codec.html#gac1e8a42306d8e67cb94ca31c3956ee78"> 55</a></span> <span class="preprocessor"></span><span class="preprocessor">#define DEPRECATED</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* DEPRECATED */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor">#ifndef DECLSPEC_DEPRECATED</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="preprocessor"></span><span class="preprocessor">#if defined(__GNUC__) && __GNUC__</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor"></span><span class="preprocessor">#define DECLSPEC_DEPRECATED </span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor">#elif defined(_MSC_VER)</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor"></span><span class="preprocessor">#define DECLSPEC_DEPRECATED __declspec(deprecated) </span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor">#else</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"><a class="code" href="group__codec.html#gab61b56b074706ee8423d864b511212ad"> 65</a></span> <span class="preprocessor"></span><span class="preprocessor">#define DECLSPEC_DEPRECATED </span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* DECLSPEC_DEPRECATED */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="preprocessor">#ifdef UNUSED</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor"></span><span class="preprocessor">#elif __GNUC__</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor"></span><span class="preprocessor">#define UNUSED __attribute__ ((unused))</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor"></span><span class="preprocessor">#else</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"><a class="code" href="group__codec.html#gaddf5ec070e9499d36b7f2009ce736076"> 74</a></span> <span class="preprocessor"></span><span class="preprocessor">#define UNUSED</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00085"></a><span class="lineno"><a class="code" href="group__codec.html#gaf7e9cad2df0f81679b881f46740ad097"> 85</a></span> <span class="preprocessor">#define VPX_CODEC_ABI_VERSION (2 + VPX_IMAGE_ABI_VERSION) </span></div>
<div class="line"><a name="l00088"></a><span class="lineno"><a class="code" href="group__codec.html#gada1084710837ad363b92f2379dd2b8d2"> 88</a></span> <span class="preprocessor"> typedef enum {</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00090"></a><span class="lineno"><a class="code" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2af1dcde74b1c5ff7b29f31246dfd90986"> 90</a></span>  <a class="code" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2af1dcde74b1c5ff7b29f31246dfd90986" title="Operation completed without error.">VPX_CODEC_OK</a>,</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a name="l00093"></a><span class="lineno"><a class="code" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2abd8a8f9c2588adab5d764d957e265135"> 93</a></span>  <a class="code" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2abd8a8f9c2588adab5d764d957e265135" title="Unspecified error.">VPX_CODEC_ERROR</a>,</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a name="l00096"></a><span class="lineno"><a class="code" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2a96c6d2600dc0ec25c2cb798e8d2f4760"> 96</a></span>  <a class="code" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2a96c6d2600dc0ec25c2cb798e8d2f4760" title="Memory operation failed.">VPX_CODEC_MEM_ERROR</a>,</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a name="l00099"></a><span class="lineno"><a class="code" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2afe8f723512f728bc518bbfba3b96d324"> 99</a></span>  <a class="code" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2afe8f723512f728bc518bbfba3b96d324" title="ABI version mismatch.">VPX_CODEC_ABI_MISMATCH</a>,</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a name="l00102"></a><span class="lineno"><a class="code" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2a4470784ba5a3ef84dc0697d5489dd292"> 102</a></span>  <a class="code" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2a4470784ba5a3ef84dc0697d5489dd292" title="Algorithm does not have required capability.">VPX_CODEC_INCAPABLE</a>,</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div>
<div class="line"><a name="l00109"></a><span class="lineno"><a class="code" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2afff886e57782098a3df13d4e349ca973"> 109</a></span>  <a class="code" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2afff886e57782098a3df13d4e349ca973" title="The given bitstream is not supported.">VPX_CODEC_UNSUP_BITSTREAM</a>,</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div>
<div class="line"><a name="l00118"></a><span class="lineno"><a class="code" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2a8a86701e65d826d82651537aadd6c539"> 118</a></span>  <a class="code" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2a8a86701e65d826d82651537aadd6c539" title="Encoded bitstream uses an unsupported feature.">VPX_CODEC_UNSUP_FEATURE</a>,</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div>
<div class="line"><a name="l00128"></a><span class="lineno"><a class="code" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2a29d03c009e0479dbf4ecbd8db1011b85"> 128</a></span>  <a class="code" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2a29d03c009e0479dbf4ecbd8db1011b85" title="The coded data for this stream is corrupt or incomplete.">VPX_CODEC_CORRUPT_FRAME</a>,</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div>
<div class="line"><a name="l00133"></a><span class="lineno"><a class="code" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2ab5857f7b5f03f8ca164fab8843a979df"> 133</a></span>  <a class="code" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2ab5857f7b5f03f8ca164fab8843a979df" title="An application-supplied parameter is not valid.">VPX_CODEC_INVALID_PARAM</a>,</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div>
<div class="line"><a name="l00138"></a><span class="lineno"><a class="code" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2a452450a5adfcc14ef8a0ac12611dae21"> 138</a></span>  <a class="code" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2a452450a5adfcc14ef8a0ac12611dae21" title="An iterator reached the end of list.">VPX_CODEC_LIST_END</a></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  }</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <a class="code" href="group__codec.html#gada1084710837ad363b92f2379dd2b8d2" title="Algorithm return codes.">vpx_codec_err_t</a>;</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> </div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div>
<div class="line"><a name="l00152"></a><span class="lineno"><a class="code" href="group__codec.html#gad2b690c0ef83cbd83a7234078791913f"> 152</a></span>  <span class="keyword">typedef</span> <span class="keywordtype">long</span> <a class="code" href="group__codec.html#gad2b690c0ef83cbd83a7234078791913f" title="Codec capabilities bitfield.">vpx_codec_caps_t</a>;</div>
<div class="line"><a name="l00153"></a><span class="lineno"><a class="code" href="group__codec.html#gae10ad7f9548170aef77df09d48ad108a"> 153</a></span> <span class="preprocessor">#define VPX_CODEC_CAP_DECODER 0x1 </span></div>
<div class="line"><a name="l00154"></a><span class="lineno"><a class="code" href="group__codec.html#gab2e8b76fff95ebd573a17bdc11f8a441"> 154</a></span> <span class="preprocessor">#define VPX_CODEC_CAP_ENCODER 0x2 </span></div>
<div class="line"><a name="l00155"></a><span class="lineno"><a class="code" href="group__codec.html#gadbaf864317eb8294fd518862a1e6f9d4"> 155</a></span> <span class="preprocessor">#define VPX_CODEC_CAP_XMA 0x4 </span></div>
<div class="line"><a name="l00165"></a><span class="lineno"><a class="code" href="group__codec.html#ga3b36d5af89ddc463489fe5bde0a57877"> 165</a></span> <span class="preprocessor"> typedef long vpx_codec_flags_t;</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"><a class="code" href="group__codec.html#gab363c255f13717f693762c3dcf0b93d6"> 166</a></span> <span class="preprocessor"></span><span class="preprocessor">#define VPX_CODEC_USE_XMA 0x00000001 </span></div>
<div class="line"><a name="l00174"></a><span class="lineno"><a class="code" href="group__codec.html#gad654f3da60151f5dfef70aca00ef1e9e"> 174</a></span> <span class="preprocessor"> typedef const struct vpx_codec_iface vpx_codec_iface_t;</span></div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> </div>
<div class="line"><a name="l00182"></a><span class="lineno"><a class="code" href="group__codec.html#ga1e262f91be9141a7176335fd409397ab"> 182</a></span>  <span class="keyword">typedef</span> <span class="keyword">struct </span>vpx_codec_priv <a class="code" href="group__codec.html#ga1e262f91be9141a7176335fd409397ab" title="Codec private data structure.">vpx_codec_priv_t</a>;</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> </div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> </div>
<div class="line"><a name="l00189"></a><span class="lineno"><a class="code" href="group__codec.html#ga6ea348f76b1f8a1fe50e14db684146c6"> 189</a></span>  <span class="keyword">typedef</span> <span class="keyword">const</span> <span class="keywordtype">void</span> *<a class="code" href="group__codec.html#ga6ea348f76b1f8a1fe50e14db684146c6" title="Iterator.">vpx_codec_iter_t</a>;</div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> </div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> </div>
<div class="line"><a name="l00200"></a><span class="lineno"><a class="code" href="structvpx__codec__ctx.html"> 200</a></span>  <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structvpx__codec__ctx.html" title="Codec context structure.">vpx_codec_ctx</a></div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  {</div>
<div class="line"><a name="l00202"></a><span class="lineno"><a class="code" href="structvpx__codec__ctx.html#a7ed1bf8f6434ea2df01da8011849c6cb"> 202</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structvpx__codec__ctx.html#a7ed1bf8f6434ea2df01da8011849c6cb">name</a>; </div>
<div class="line"><a name="l00203"></a><span class="lineno"><a class="code" href="structvpx__codec__ctx.html#af5986790e3420beda77f3a9b64f6b953"> 203</a></span>  <a class="code" href="group__codec.html#gad654f3da60151f5dfef70aca00ef1e9e" title="Codec interface structure.">vpx_codec_iface_t</a> *<a class="code" href="structvpx__codec__ctx.html#af5986790e3420beda77f3a9b64f6b953">iface</a>; </div>
<div class="line"><a name="l00204"></a><span class="lineno"><a class="code" href="structvpx__codec__ctx.html#a6f448802b0675013fd8c5179675c30de"> 204</a></span>  <a class="code" href="group__codec.html#gada1084710837ad363b92f2379dd2b8d2" title="Algorithm return codes.">vpx_codec_err_t</a> <a class="code" href="structvpx__codec__ctx.html#a6f448802b0675013fd8c5179675c30de">err</a>; </div>
<div class="line"><a name="l00205"></a><span class="lineno"><a class="code" href="structvpx__codec__ctx.html#ad785c88ae862dd9129965c72723260bd"> 205</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structvpx__codec__ctx.html#ad785c88ae862dd9129965c72723260bd">err_detail</a>; </div>
<div class="line"><a name="l00206"></a><span class="lineno"><a class="code" href="structvpx__codec__ctx.html#a76546548086c060a6bd21cb55037fb2b"> 206</a></span>  <a class="code" href="group__codec.html#ga3b36d5af89ddc463489fe5bde0a57877" title="Initialization-time Feature Enabling.">vpx_codec_flags_t</a> <a class="code" href="structvpx__codec__ctx.html#a76546548086c060a6bd21cb55037fb2b">init_flags</a>; </div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <span class="keyword">union</span></div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  {</div>
<div class="line"><a name="l00209"></a><span class="lineno"><a class="code" href="structvpx__codec__ctx.html#abb82988485a036fb80e36ed22ec1e984"> 209</a></span>  <span class="keyword">struct </span><a class="code" href="structvpx__codec__dec__cfg.html" title="Initialization Configurations.">vpx_codec_dec_cfg</a> *<a class="code" href="structvpx__codec__ctx.html#abb82988485a036fb80e36ed22ec1e984">dec</a>; </div>
<div class="line"><a name="l00210"></a><span class="lineno"><a class="code" href="structvpx__codec__ctx.html#a3755f3c166d9aacd8a262a81ac18fa8f"> 210</a></span>  <span class="keyword">struct </span><a class="code" href="structvpx__codec__enc__cfg.html" title="Encoder configuration structure.">vpx_codec_enc_cfg</a> *<a class="code" href="structvpx__codec__ctx.html#a3755f3c166d9aacd8a262a81ac18fa8f">enc</a>; </div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  <span class="keywordtype">void</span> *raw;</div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  } <a class="code" href="structvpx__codec__ctx.html#aaa15a858376e55269a0a7ba5bff09f04">config</a>; </div>
<div class="line"><a name="l00213"></a><span class="lineno"><a class="code" href="structvpx__codec__ctx.html#acee775fd5b7580e112e245ce39733f92"> 213</a></span>  <a class="code" href="group__codec.html#ga1e262f91be9141a7176335fd409397ab" title="Codec private data structure.">vpx_codec_priv_t</a> *<a class="code" href="structvpx__codec__ctx.html#acee775fd5b7580e112e245ce39733f92">priv</a>; </div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  } <a class="code" href="group__codec.html#gad03e2dfa6ae511db7d25be6bbb336233" title="Codec context structure.">vpx_codec_ctx_t</a>;</div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span> </div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> </div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  <span class="comment">/*</span></div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment"> * Library Version Number Interface</span></div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment"> * For example, see the following sample return values:</span></div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment"> * vpx_codec_version() (1<<16 | 2<<8 | 3)</span></div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment"> * vpx_codec_version_str() "v1.2.3-rc1-16-gec6a1ba"</span></div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment"> * vpx_codec_version_extra_str() "rc1-16-gec6a1ba"</span></div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span> </div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span>  <span class="keywordtype">int</span> <a class="code" href="group__codec.html#ga163037ae037ac760da65e4130c7d4767" title="Return the version information (as an integer)">vpx_codec_version</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00235"></a><span class="lineno"><a class="code" href="group__codec.html#gadebddd67347fe47c0772b1e06b6173ba"> 235</a></span> <span class="preprocessor">#define VPX_VERSION_MAJOR(v) ((v>>16)&0xff) </span></div>
<div class="line"><a name="l00236"></a><span class="lineno"><a class="code" href="group__codec.html#ga4a5ce4588576306dee0d95e8f8706f86"> 236</a></span> <span class="preprocessor">#define VPX_VERSION_MINOR(v) ((v>>8)&0xff) </span></div>
<div class="line"><a name="l00237"></a><span class="lineno"><a class="code" href="group__codec.html#ga4acf2cf4c35ff123d17cd67c069fdbaa"> 237</a></span> <span class="preprocessor">#define VPX_VERSION_PATCH(v) ((v>>0)&0xff) </span></div>
<div class="line"><a name="l00240"></a><span class="lineno"><a class="code" href="group__codec.html#gaf314b746e4e202045e85ac073c29a495"> 240</a></span> <span class="preprocessor">#define vpx_codec_version_major() ((vpx_codec_version()>>16)&0xff)</span></div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00243"></a><span class="lineno"><a class="code" href="group__codec.html#ga2b668688a7d1551ea89bcda8f2587f93"> 243</a></span> <span class="preprocessor">#define vpx_codec_version_minor() ((vpx_codec_version()>>8)&0xff)</span></div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00246"></a><span class="lineno"><a class="code" href="group__codec.html#ga8ed64bded0d763fa2158312ac8fbcf26"> 246</a></span> <span class="preprocessor">#define vpx_codec_version_patch() ((vpx_codec_version()>>0)&0xff)</span></div>
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span> </div>
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__codec.html#ga163fbcc6dd33827b28b9829a0a86cf59" title="Return the version information (as a string)">vpx_codec_version_str</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span> </div>
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span> </div>
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__codec.html#ga286c0d4271fea4c488d791154d8f9098" title="Return the version information (as a string)">vpx_codec_version_extra_str</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span> </div>
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span> </div>
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__codec.html#ga20922bad85472e76d5f61c21cb423af7" title="Return the build configuration.">vpx_codec_build_config</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span> </div>
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span> </div>
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__codec.html#ga9eee39f450d8cdcf5aba0e2bda6e5aa8" title="Return the name for a given interface.">vpx_codec_iface_name</a>(<a class="code" href="group__codec.html#gad654f3da60151f5dfef70aca00ef1e9e" title="Codec interface structure.">vpx_codec_iface_t</a> *iface);</div>
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span> </div>
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span> </div>
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__codec.html#gaaddf5c1f609ef18c7c8800d102fcefa6" title="Convert error number to printable string.">vpx_codec_err_to_string</a>(<a class="code" href="group__codec.html#gada1084710837ad363b92f2379dd2b8d2" title="Algorithm return codes.">vpx_codec_err_t</a> err);</div>
<div class="line"><a name="l00298"></a><span class="lineno"> 298</span> </div>
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span> </div>
<div class="line"><a name="l00310"></a><span class="lineno"> 310</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__codec.html#ga4d265df00d42b36a4f0e3eb83fc22c5e" title="Retrieve error synopsis for codec context.">vpx_codec_error</a>(<a class="code" href="structvpx__codec__ctx.html" title="Codec context structure.">vpx_codec_ctx_t</a> *ctx);</div>
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span> </div>
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span> </div>
<div class="line"><a name="l00323"></a><span class="lineno"> 323</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__codec.html#ga29273cb552ed1a437fe263c4a0a54300" title="Retrieve detailed error information for codec context.">vpx_codec_error_detail</a>(<a class="code" href="structvpx__codec__ctx.html" title="Codec context structure.">vpx_codec_ctx_t</a> *ctx);</div>
<div class="line"><a name="l00324"></a><span class="lineno"> 324</span> </div>
<div class="line"><a name="l00325"></a><span class="lineno"> 325</span> </div>
<div class="line"><a name="l00326"></a><span class="lineno"> 326</span>  <span class="comment">/* REQUIRED FUNCTIONS</span></div>
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00328"></a><span class="lineno"> 328</span> <span class="comment"> * The following functions are required to be implemented for all codecs.</span></div>
<div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="comment"> * They represent the base case functionality expected of all codecs.</span></div>
<div class="line"><a name="l00330"></a><span class="lineno"> 330</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00331"></a><span class="lineno"> 331</span> </div>
<div class="line"><a name="l00343"></a><span class="lineno"> 343</span>  <a class="code" href="group__codec.html#gada1084710837ad363b92f2379dd2b8d2" title="Algorithm return codes.">vpx_codec_err_t</a> <a class="code" href="group__codec.html#ga6ae21d96909660d0ac978b59a863f53b" title="Destroy a codec instance.">vpx_codec_destroy</a>(<a class="code" href="structvpx__codec__ctx.html" title="Codec context structure.">vpx_codec_ctx_t</a> *ctx);</div>
<div class="line"><a name="l00344"></a><span class="lineno"> 344</span> </div>
<div class="line"><a name="l00345"></a><span class="lineno"> 345</span> </div>
<div class="line"><a name="l00353"></a><span class="lineno"> 353</span>  <a class="code" href="group__codec.html#gad2b690c0ef83cbd83a7234078791913f" title="Codec capabilities bitfield.">vpx_codec_caps_t</a> <a class="code" href="group__codec.html#ga43adff58759093401235fb99247c82b8" title="Get the capabilities of an algorithm.">vpx_codec_get_caps</a>(<a class="code" href="group__codec.html#gad654f3da60151f5dfef70aca00ef1e9e" title="Codec interface structure.">vpx_codec_iface_t</a> *iface);</div>
<div class="line"><a name="l00354"></a><span class="lineno"> 354</span> </div>
<div class="line"><a name="l00355"></a><span class="lineno"> 355</span> </div>
<div class="line"><a name="l00380"></a><span class="lineno"> 380</span>  <a class="code" href="group__codec.html#gada1084710837ad363b92f2379dd2b8d2" title="Algorithm return codes.">vpx_codec_err_t</a> <a class="code" href="group__codec.html#gaf7849b69cc390b21d889c8c71f69ec14" title="Control algorithm.">vpx_codec_control_</a>(<a class="code" href="structvpx__codec__ctx.html" title="Codec context structure.">vpx_codec_ctx_t</a> *ctx,</div>
<div class="line"><a name="l00381"></a><span class="lineno"> 381</span>  <span class="keywordtype">int</span> ctrl_id,</div>
<div class="line"><a name="l00382"></a><span class="lineno"> 382</span>  ...);</div>
<div class="line"><a name="l00383"></a><span class="lineno"> 383</span> <span class="preprocessor">#if defined(VPX_DISABLE_CTRL_TYPECHECKS) && VPX_DISABLE_CTRL_TYPECHECKS</span></div>
<div class="line"><a name="l00384"></a><span class="lineno"> 384</span> <span class="preprocessor"></span><span class="preprocessor"># define vpx_codec_control(ctx,id,data) vpx_codec_control_(ctx,id,data)</span></div>
<div class="line"><a name="l00385"></a><span class="lineno"> 385</span> <span class="preprocessor"></span><span class="preprocessor"># define VPX_CTRL_USE_TYPE(id, typ)</span></div>
<div class="line"><a name="l00386"></a><span class="lineno"> 386</span> <span class="preprocessor"></span><span class="preprocessor"># define VPX_CTRL_USE_TYPE_DEPRECATED(id, typ)</span></div>
<div class="line"><a name="l00387"></a><span class="lineno"> 387</span> <span class="preprocessor"></span><span class="preprocessor"># define VPX_CTRL_VOID(id, typ)</span></div>
<div class="line"><a name="l00388"></a><span class="lineno"> 388</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00389"></a><span class="lineno"> 389</span> <span class="preprocessor">#else</span></div>
<div class="line"><a name="l00390"></a><span class="lineno"> 390</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00399"></a><span class="lineno"><a class="code" href="group__codec.html#gac1b91e04698c1bd4c0a2b8aa85b08cd2"> 399</a></span> <span class="preprocessor"># define vpx_codec_control(ctx,id,data) vpx_codec_control_##id(ctx,id,data)\</span></div>
<div class="line"><a name="l00400"></a><span class="lineno"> 400</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00414"></a><span class="lineno"> 414</span> <span class="preprocessor"># define VPX_CTRL_USE_TYPE(id, typ) \</span></div>
<div class="line"><a name="l00415"></a><span class="lineno"><a class="code" href="group__codec.html#gaa7409a4cb58b155912f41a4d39d81a8a"> 415</a></span> <span class="preprocessor"> static vpx_codec_err_t \</span></div>
<div class="line"><a name="l00416"></a><span class="lineno"> 416</span> <span class="preprocessor"> vpx_codec_control_##id(vpx_codec_ctx_t*, int, typ) UNUSED;\</span></div>
<div class="line"><a name="l00417"></a><span class="lineno"> 417</span> <span class="preprocessor"> \</span></div>
<div class="line"><a name="l00418"></a><span class="lineno"> 418</span> <span class="preprocessor"> static vpx_codec_err_t \</span></div>
<div class="line"><a name="l00419"></a><span class="lineno"> 419</span> <span class="preprocessor"> vpx_codec_control_##id(vpx_codec_ctx_t *ctx, int ctrl_id, typ data) {\</span></div>
<div class="line"><a name="l00420"></a><span class="lineno"> 420</span> <span class="preprocessor"> return vpx_codec_control_(ctx, ctrl_id, data);\</span></div>
<div class="line"><a name="l00421"></a><span class="lineno"> 421</span> <span class="preprocessor"> } </span></div>
<div class="line"><a name="l00434"></a><span class="lineno"> 434</span> <span class="preprocessor"># define VPX_CTRL_USE_TYPE_DEPRECATED(id, typ) \</span></div>
<div class="line"><a name="l00435"></a><span class="lineno"> 435</span> <span class="preprocessor"> DECLSPEC_DEPRECATED static vpx_codec_err_t \</span></div>
<div class="line"><a name="l00436"></a><span class="lineno"> 436</span> <span class="preprocessor"> vpx_codec_control_##id(vpx_codec_ctx_t*, int, typ) DEPRECATED UNUSED;\</span></div>
<div class="line"><a name="l00437"></a><span class="lineno"> 437</span> <span class="preprocessor"> \</span></div>
<div class="line"><a name="l00438"></a><span class="lineno"> 438</span> <span class="preprocessor"> DECLSPEC_DEPRECATED static vpx_codec_err_t \</span></div>
<div class="line"><a name="l00439"></a><span class="lineno"> 439</span> <span class="preprocessor"> vpx_codec_control_##id(vpx_codec_ctx_t *ctx, int ctrl_id, typ data) {\</span></div>
<div class="line"><a name="l00440"></a><span class="lineno"> 440</span> <span class="preprocessor"> return vpx_codec_control_(ctx, ctrl_id, data);\</span></div>
<div class="line"><a name="l00441"></a><span class="lineno"> 441</span> <span class="preprocessor"> } </span></div>
<div class="line"><a name="l00454"></a><span class="lineno"> 454</span> <span class="preprocessor"># define VPX_CTRL_VOID(id) \</span></div>
<div class="line"><a name="l00455"></a><span class="lineno"> 455</span> <span class="preprocessor"> static vpx_codec_err_t \</span></div>
<div class="line"><a name="l00456"></a><span class="lineno"> 456</span> <span class="preprocessor"> vpx_codec_control_##id(vpx_codec_ctx_t*, int) UNUSED;\</span></div>
<div class="line"><a name="l00457"></a><span class="lineno"> 457</span> <span class="preprocessor"> \</span></div>
<div class="line"><a name="l00458"></a><span class="lineno"> 458</span> <span class="preprocessor"> static vpx_codec_err_t \</span></div>
<div class="line"><a name="l00459"></a><span class="lineno"> 459</span> <span class="preprocessor"> vpx_codec_control_##id(vpx_codec_ctx_t *ctx, int ctrl_id) {\</span></div>
<div class="line"><a name="l00460"></a><span class="lineno"> 460</span> <span class="preprocessor"> return vpx_codec_control_(ctx, ctrl_id);\</span></div>
<div class="line"><a name="l00461"></a><span class="lineno"> 461</span> <span class="preprocessor"> } </span></div>
<div class="line"><a name="l00464"></a><span class="lineno"> 464</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00465"></a><span class="lineno"> 465</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00466"></a><span class="lineno"> 466</span> </div>
<div class="line"><a name="l00483"></a><span class="lineno"> 483</span>  <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structvpx__codec__mmap.html" title="Memory Map Entry.">vpx_codec_mmap</a></div>
<div class="line"><a name="l00484"></a><span class="lineno"> 484</span>  {</div>
<div class="line"><a name="l00485"></a><span class="lineno"> 485</span>  <span class="comment">/*</span></div>
<div class="line"><a name="l00486"></a><span class="lineno"> 486</span> <span class="comment"> * The following members are set by the codec when requesting a segment</span></div>
<div class="line"><a name="l00487"></a><span class="lineno"> 487</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00488"></a><span class="lineno"> 488</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structvpx__codec__mmap.html#a83f482a223678a60c22362f44e36e8c8">id</a>; </div>
<div class="line"><a name="l00489"></a><span class="lineno"> 489</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="structvpx__codec__mmap.html#ae6822e6985cef61d2341a8d429bea079">sz</a>; </div>
<div class="line"><a name="l00490"></a><span class="lineno"> 490</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structvpx__codec__mmap.html#a7875d3878f1d58c205f396c1f696987b">align</a>; </div>
<div class="line"><a name="l00491"></a><span class="lineno"> 491</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structvpx__codec__mmap.html#afd7f8fed412b7bb524bed8e6ed14400d">flags</a>; </div>
<div class="line"><a name="l00492"></a><span class="lineno"> 492</span> <span class="preprocessor">#define VPX_CODEC_MEM_ZERO 0x1 </span></div>
<div class="line"><a name="l00493"></a><span class="lineno"> 493</span> <span class="preprocessor">#define VPX_CODEC_MEM_WRONLY 0x2 </span></div>
<div class="line"><a name="l00494"></a><span class="lineno"> 494</span> <span class="preprocessor">#define VPX_CODEC_MEM_FAST 0x4 </span></div>
<div class="line"><a name="l00496"></a><span class="lineno"> 496</span> <span class="preprocessor"> </span><span class="comment">/* The following members are to be filled in by the allocation function */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00497"></a><span class="lineno"> 497</span> <span class="preprocessor"></span> <span class="keywordtype">void</span> *<a class="code" href="structvpx__codec__mmap.html#a0f7580ef4f5680df53c1ef3bd5f66d01">base</a>; </div>
<div class="line"><a name="l00498"></a><span class="lineno"> 498</span>  void (*<a class="code" href="structvpx__codec__mmap.html#a39476b4d60e41d0867e0966f09dc1e45">dtor</a>)(<span class="keyword">struct </span><a class="code" href="structvpx__codec__mmap.html" title="Memory Map Entry.">vpx_codec_mmap</a> *map); </div>
<div class="line"><a name="l00499"></a><span class="lineno"> 499</span>  <span class="keywordtype">void</span> *<a class="code" href="structvpx__codec__mmap.html#ac2be21bb5e6d94332fff9c5f1263224f">priv</a>; </div>
<div class="line"><a name="l00500"></a><span class="lineno"> 500</span>  } <a class="code" href="group__cap__xma.html#gaca7501932c5ec8a876729f661b752f07" title="Memory Map Entry.">vpx_codec_mmap_t</a>; </div>
<div class="line"><a name="l00524"></a><span class="lineno"> 524</span>  <a class="code" href="group__codec.html#gada1084710837ad363b92f2379dd2b8d2" title="Algorithm return codes.">vpx_codec_err_t</a> <a class="code" href="group__cap__xma.html#ga802003c8ed203def368a361fe0e92f13" title="Iterate over the list of segments to allocate.">vpx_codec_get_mem_map</a>(<a class="code" href="structvpx__codec__ctx.html" title="Codec context structure.">vpx_codec_ctx_t</a> *ctx,</div>
<div class="line"><a name="l00525"></a><span class="lineno"> 525</span>  <a class="code" href="structvpx__codec__mmap.html" title="Memory Map Entry.">vpx_codec_mmap_t</a> *mmap,</div>
<div class="line"><a name="l00526"></a><span class="lineno"> 526</span>  <a class="code" href="group__codec.html#ga6ea348f76b1f8a1fe50e14db684146c6" title="Iterator.">vpx_codec_iter_t</a> *iter);</div>
<div class="line"><a name="l00527"></a><span class="lineno"> 527</span> </div>
<div class="line"><a name="l00528"></a><span class="lineno"> 528</span> </div>
<div class="line"><a name="l00550"></a><span class="lineno"> 550</span>  <a class="code" href="group__codec.html#gada1084710837ad363b92f2379dd2b8d2" title="Algorithm return codes.">vpx_codec_err_t</a> <a class="code" href="group__cap__xma.html#gac2df376a4d76282a5c117313182dcf53" title="Identify allocated segments to codec instance.">vpx_codec_set_mem_map</a>(<a class="code" href="structvpx__codec__ctx.html" title="Codec context structure.">vpx_codec_ctx_t</a> *ctx,</div>
<div class="line"><a name="l00551"></a><span class="lineno"> 551</span>  <a class="code" href="structvpx__codec__mmap.html" title="Memory Map Entry.">vpx_codec_mmap_t</a> *mmaps,</div>
<div class="line"><a name="l00552"></a><span class="lineno"> 552</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> num_maps);</div>
<div class="line"><a name="l00553"></a><span class="lineno"> 553</span> </div>
<div class="line"><a name="l00558"></a><span class="lineno"> 558</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00559"></a><span class="lineno"> 559</span> <span class="preprocessor"></span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00560"></a><span class="lineno"> 560</span> <span class="preprocessor"></span>}</div>
<div class="line"><a name="l00561"></a><span class="lineno"> 561</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></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.3
</small></address>
</body>
</html>
