<!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_decoder.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_decoder.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="vpx__decoder_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="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#ifndef VPX_DECODER_H</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor"></span><span class="preprocessor">#define VPX_DECODER_H</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor"></span><span class="preprocessor">#include "<a class="code" href="vpx__codec_8h.html" title="Describes the codec algorithm interface to applications.">vpx_codec.h</a>"</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="code" href="group__decoder.html#ga462b459e7ae13937e1eae1776245db12"> 43</a></span> <span class="preprocessor">#define VPX_DECODER_ABI_VERSION (2 + VPX_CODEC_ABI_VERSION) </span></div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="code" href="group__decoder.html#ga9e33b8ee81025d5fc3d01b0975ad5f96"> 53</a></span> <span class="preprocessor">#define VPX_CODEC_CAP_PUT_SLICE 0x10000 </span></div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="code" href="group__decoder.html#ga0ef59ca8067ac1dc8c8378042277ccc8"> 54</a></span> <span class="preprocessor">#define VPX_CODEC_CAP_PUT_FRAME 0x20000 </span></div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="code" href="group__decoder.html#ga7825ade982ab85a5583d3d8a669baa3b"> 55</a></span> <span class="preprocessor">#define VPX_CODEC_CAP_POSTPROC 0x40000 </span></div>
<div class="line"><a name="l00056"></a><span class="lineno"><a class="code" href="group__decoder.html#gac44cd9e4722e1eb32a37c3eaec8d97b9"> 56</a></span> <span class="preprocessor">#define VPX_CODEC_CAP_ERROR_CONCEALMENT 0x80000 </span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor">#define VPX_CODEC_CAP_INPUT_FRAGMENTS 0x100000 </span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor">#define VPX_CODEC_USE_POSTPROC 0x10000 </span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor">#define VPX_CODEC_USE_ERROR_CONCEALMENT 0x20000 </span></div>
<div class="line"><a name="l00071"></a><span class="lineno"><a class="code" href="group__decoder.html#ga520d7005e360202f5844982fa2392581"> 71</a></span> <span class="preprocessor">#define VPX_CODEC_USE_INPUT_FRAGMENTS 0x40000 </span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor"> typedef struct vpx_codec_stream_info</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor"></span> {</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structvpx__codec__mmap.html#ae6822e6985cef61d2341a8d429bea079">sz</a>; </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> w; </div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> h; </div>
<div class="line"><a name="l00086"></a><span class="lineno"><a class="code" href="structvpx__codec__stream__info.html"> 86</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> is_kf; </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  } <a class="code" href="group__decoder.html#ga900420e8f7cb9c1b3070b2ba7d636974" title="Stream properties.">vpx_codec_stream_info_t</a>;</div>
<div class="line"><a name="l00088"></a><span class="lineno"><a class="code" href="structvpx__codec__stream__info.html#a8e5eb38a9042da54a20607f71591ddbf"> 88</a></span> </div>
<div class="line"><a name="l00089"></a><span class="lineno"><a class="code" href="structvpx__codec__stream__info.html#a957dbfa83c93d9b3dc08498a6b97c77d"> 89</a></span>  <span class="comment">/* REQUIRED FUNCTIONS</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"><a class="code" href="structvpx__codec__stream__info.html#af7a8b114547e434d182c722bdace63a0"> 90</a></span> <span class="comment"> *</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"><a class="code" href="structvpx__codec__stream__info.html#a8c9060997f16d43219462554c882dbd3"> 91</a></span> <span class="comment"> * The following functions are required to be implemented for all decoders.</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> * They represent the base case functionality expected of all decoders.</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structvpx__codec__dec__cfg.html" title="Initialization Configurations.">vpx_codec_dec_cfg</a></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  {</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structvpx__codec__dec__cfg.html#afca69d81e99ee15e1d641a639aefb7eb">threads</a>; </div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structvpx__codec__dec__cfg.html#acf188f8a7e6c8e1d1a7f488a76f9da42">w</a>; </div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structvpx__codec__dec__cfg.html#a45311c284e8371d58eb403437db5f2f9">h</a>; </div>
<div class="line"><a name="l00106"></a><span class="lineno"><a class="code" href="structvpx__codec__dec__cfg.html"> 106</a></span>  } <a class="code" href="group__decoder.html#ga4a2e808eb43f1e798024b5a409c484f9" title="Initialization Configurations.">vpx_codec_dec_cfg_t</a>; </div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <a class="code" href="group__codec.html#gada1084710837ad363b92f2379dd2b8d2" title="Algorithm return codes.">vpx_codec_err_t</a> <a class="code" href="group__decoder.html#ga26fe82cf8fd697f885935cea53be964f" title="Initialize a decoder instance.">vpx_codec_dec_init_ver</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="l00136"></a><span class="lineno"> 136</span>  <a class="code" href="group__codec.html#gad654f3da60151f5dfef70aca00ef1e9e" title="Codec interface structure.">vpx_codec_iface_t</a> *iface,</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <a class="code" href="structvpx__codec__dec__cfg.html" title="Initialization Configurations.">vpx_codec_dec_cfg_t</a> *cfg,</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <a class="code" href="group__codec.html#ga3b36d5af89ddc463489fe5bde0a57877" title="Initialization-time Feature Enabling.">vpx_codec_flags_t</a> flags,</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="keywordtype">int</span> ver);</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="preprocessor">#define vpx_codec_dec_init(ctx, iface, cfg, flags) \</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="preprocessor"> vpx_codec_dec_init_ver(ctx, iface, cfg, flags, VPX_DECODER_ABI_VERSION)</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> </div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <a class="code" href="group__codec.html#gada1084710837ad363b92f2379dd2b8d2" title="Algorithm return codes.">vpx_codec_err_t</a> <a class="code" href="group__decoder.html#gadfee4664d644175d5aac1465ef11c4b0" title="Parse stream info from a buffer.">vpx_codec_peek_stream_info</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="l00167"></a><span class="lineno"> 167</span>  <span class="keyword">const</span> uint8_t *data,</div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> data_sz,</div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <a class="code" href="structvpx__codec__stream__info.html" title="Stream properties.">vpx_codec_stream_info_t</a> *si);</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> </div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> </div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  <a class="code" href="group__codec.html#gada1084710837ad363b92f2379dd2b8d2" title="Algorithm return codes.">vpx_codec_err_t</a> <a class="code" href="group__decoder.html#ga552f1044d36a84e8b05ce6902e9ae8c9" title="Return information about the current stream.">vpx_codec_get_stream_info</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="l00186"></a><span class="lineno"> 186</span>  <a class="code" href="structvpx__codec__stream__info.html" title="Stream properties.">vpx_codec_stream_info_t</a> *si);</div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> </div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> </div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  <a class="code" href="group__codec.html#gada1084710837ad363b92f2379dd2b8d2" title="Algorithm return codes.">vpx_codec_err_t</a> <a class="code" href="group__decoder.html#ga3441e157a7a69108bca9a069f2ee8e0d" title="Decode data.">vpx_codec_decode</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="l00220"></a><span class="lineno"> 220</span>  <span class="keyword">const</span> uint8_t *data,</div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> data_sz,</div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  <span class="keywordtype">void</span> *user_priv,</div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  <span class="keywordtype">long</span> deadline);</div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span> </div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span> </div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  <a class="code" href="structvpx__image.html" title="Image Descriptor.">vpx_image_t</a> *<a class="code" href="group__decoder.html#ga0e231c3a5ce445fdb2268d741da97500" title="Decoded frames iterator.">vpx_codec_get_frame</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="l00242"></a><span class="lineno"> 242</span>  <a class="code" href="group__codec.html#ga6ea348f76b1f8a1fe50e14db684146c6" title="Iterator.">vpx_codec_iter_t</a> *iter);</div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span> </div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span> </div>
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  <span class="keyword">typedef</span> void (*<a class="code" href="group__cap__put__frame.html#ga1c3d3d07ec4f907dc426bbd6d70862ec" title="put frame callback prototype">vpx_codec_put_frame_cb_fn_t</a>)(<span class="keywordtype">void</span> *user_priv,</div>
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  <span class="keyword">const</span> <a class="code" href="structvpx__image.html" title="Image Descriptor.">vpx_image_t</a> *img);</div>
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span> </div>
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span> </div>
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span>  <a class="code" href="group__codec.html#gada1084710837ad363b92f2379dd2b8d2" title="Algorithm return codes.">vpx_codec_err_t</a> <a class="code" href="group__cap__put__frame.html#ga299c2d1b265a22a680f117dd686e31ce" title="Register for notification of frame completion.">vpx_codec_register_put_frame_cb</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="l00279"></a><span class="lineno"> 279</span>  <a class="code" href="group__cap__put__frame.html#ga1c3d3d07ec4f907dc426bbd6d70862ec" title="put frame callback prototype">vpx_codec_put_frame_cb_fn_t</a> cb,</div>
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span>  <span class="keywordtype">void</span> *user_priv);</div>
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span> </div>
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span> </div>
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span>  <span class="keyword">typedef</span> void (*<a class="code" href="group__cap__put__slice.html#ga344dbbf130aa9632aee94cee1f3cef44" title="put slice callback prototype">vpx_codec_put_slice_cb_fn_t</a>)(<span class="keywordtype">void</span> *user_priv,</div>
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span>  <span class="keyword">const</span> <a class="code" href="structvpx__image.html" title="Image Descriptor.">vpx_image_t</a> *img,</div>
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span>  <span class="keyword">const</span> <a class="code" href="structvpx__image__rect.html" title="Representation of a rectangle on a surface.">vpx_image_rect_t</a> *valid,</div>
<div class="line"><a name="l00302"></a><span class="lineno"> 302</span>  <span class="keyword">const</span> <a class="code" href="structvpx__image__rect.html" title="Representation of a rectangle on a surface.">vpx_image_rect_t</a> *update);</div>
<div class="line"><a name="l00303"></a><span class="lineno"> 303</span> </div>
<div class="line"><a name="l00304"></a><span class="lineno"><a class="code" href="group__cap__put__slice.html#ga344dbbf130aa9632aee94cee1f3cef44"> 304</a></span> </div>
<div class="line"><a name="l00320"></a><span class="lineno"> 320</span>  <a class="code" href="group__codec.html#gada1084710837ad363b92f2379dd2b8d2" title="Algorithm return codes.">vpx_codec_err_t</a> <a class="code" href="group__cap__put__slice.html#gaffcc69a8134406fc653500759b696b8e" title="Register for notification of slice completion.">vpx_codec_register_put_slice_cb</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="l00321"></a><span class="lineno"> 321</span>  <a class="code" href="group__cap__put__slice.html#ga344dbbf130aa9632aee94cee1f3cef44" title="put slice callback prototype">vpx_codec_put_slice_cb_fn_t</a> cb,</div>
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span>  <span class="keywordtype">void</span> *user_priv);</div>
<div class="line"><a name="l00323"></a><span class="lineno"> 323</span> </div>
<div class="line"><a name="l00324"></a><span class="lineno"> 324</span> </div>
<div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00330"></a><span class="lineno"> 330</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <span class="preprocessor"></span>}</div>
<div class="line"><a name="l00333"></a><span class="lineno"> 333</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>
