<!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"/>
<title>WebM VP8 Codec SDK: vpx/vpx_decoder.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<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>
<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>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Defines</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">vpx/vpx_decoder.h File Reference<div class="ingroups"><a class="el" href="group__decoder.html">Decoder Algorithm Interface</a></div></div> </div>
</div>
<div class="contents">
<p>Describes the decoder algorithm interface to applications.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="vpx__codec_8h_source.html">vpx_codec.h</a>"</code><br/>
</div>
<p><a href="vpx__decoder_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structvpx__codec__stream__info.html">vpx_codec_stream_info</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stream properties. <a href="structvpx__codec__stream__info.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structvpx__codec__dec__cfg.html">vpx_codec_dec_cfg</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialization Configurations. <a href="structvpx__codec__dec__cfg.html#details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae9d9e73841dd64cb26053738963e7e69"></a><!-- doxytag: member="vpx_decoder.h::VPX_DECODER_H" ref="gae9d9e73841dd64cb26053738963e7e69" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>VPX_DECODER_H</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga462b459e7ae13937e1eae1776245db12"></a><!-- doxytag: member="vpx_decoder.h::VPX_DECODER_ABI_VERSION" ref="ga462b459e7ae13937e1eae1776245db12" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__decoder.html#ga462b459e7ae13937e1eae1776245db12">VPX_DECODER_ABI_VERSION</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Current ABI version number. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__decoder.html#ga9e33b8ee81025d5fc3d01b0975ad5f96">VPX_CODEC_CAP_PUT_SLICE</a>   0x10000</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decoder capabilities bitfield. <a href="group__decoder.html#ga9e33b8ee81025d5fc3d01b0975ad5f96"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__decoder.html#ga0ef59ca8067ac1dc8c8378042277ccc8">VPX_CODEC_CAP_PUT_FRAME</a>   0x20000</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__decoder.html#ga7825ade982ab85a5583d3d8a669baa3b">VPX_CODEC_CAP_POSTPROC</a>   0x40000</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__decoder.html#gac44cd9e4722e1eb32a37c3eaec8d97b9">VPX_CODEC_CAP_ERROR_CONCEALMENT</a>   0x80000</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__decoder.html#ga7830b3b528a9c1b2dddd4c72076b8f60">VPX_CODEC_CAP_INPUT_PARTITION</a>   0x100000</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__decoder.html#ga6fe14f30254aff769412b128b29664cc">VPX_CODEC_USE_POSTPROC</a>   0x10000</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialization-time Feature Enabling. <a href="group__decoder.html#ga6fe14f30254aff769412b128b29664cc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__decoder.html#ga520d7005e360202f5844982fa2392581">VPX_CODEC_USE_ERROR_CONCEALMENT</a>   0x20000</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__decoder.html#gae0d9ce0b24127d10b5b554fb61e3a7ca">VPX_CODEC_USE_INPUT_PARTITION</a>   0x40000</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__decoder.html#ga8c2f0b12f1bd4927eb3c68b01eab19d3">vpx_codec_dec_init</a>(ctx, iface, cfg, flags)   vpx_codec_dec_init_ver(ctx, iface, cfg, flags, VPX_DECODER_ABI_VERSION)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience macro for <a class="el" href="group__decoder.html#ga26fe82cf8fd697f885935cea53be964f" title="Initialize a decoder instance.">vpx_codec_dec_init_ver()</a> <a href="group__decoder.html#ga8c2f0b12f1bd4927eb3c68b01eab19d3"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="structvpx__codec__stream__info.html">vpx_codec_stream_info</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__decoder.html#ga900420e8f7cb9c1b3070b2ba7d636974">vpx_codec_stream_info_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stream properties. <a href="group__decoder.html#ga900420e8f7cb9c1b3070b2ba7d636974"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structvpx__codec__dec__cfg.html">vpx_codec_dec_cfg</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__decoder.html#ga4a2e808eb43f1e798024b5a409c484f9">vpx_codec_dec_cfg_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialization Configurations. <a href="group__decoder.html#ga4a2e808eb43f1e798024b5a409c484f9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cap__put__frame.html#ga1c3d3d07ec4f907dc426bbd6d70862ec">vpx_codec_put_frame_cb_fn_t</a> )(void *user_priv, const <a class="el" href="structvpx__image.html">vpx_image_t</a> *img)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">put frame callback prototype <a href="group__cap__put__frame.html#ga1c3d3d07ec4f907dc426bbd6d70862ec"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cap__put__slice.html#ga344dbbf130aa9632aee94cee1f3cef44">vpx_codec_put_slice_cb_fn_t</a> )(void *user_priv, const <a class="el" href="structvpx__image.html">vpx_image_t</a> *img, const <a class="el" href="structvpx__image__rect.html">vpx_image_rect_t</a> *valid, const <a class="el" href="structvpx__image__rect.html">vpx_image_rect_t</a> *update)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">put slice callback prototype <a href="group__cap__put__slice.html#ga344dbbf130aa9632aee94cee1f3cef44"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><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__decoder.html#ga26fe82cf8fd697f885935cea53be964f">vpx_codec_dec_init_ver</a> (<a class="el" href="structvpx__codec__ctx.html">vpx_codec_ctx_t</a> *ctx, <a class="el" href="group__codec.html#gad654f3da60151f5dfef70aca00ef1e9e">vpx_codec_iface_t</a> *iface, <a class="el" href="structvpx__codec__dec__cfg.html">vpx_codec_dec_cfg_t</a> *cfg, <a class="el" href="group__codec.html#ga3b36d5af89ddc463489fe5bde0a57877">vpx_codec_flags_t</a> flags, int ver)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize a decoder instance. <a href="group__decoder.html#ga26fe82cf8fd697f885935cea53be964f"></a><br/></td></tr>
<tr><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__decoder.html#gadfee4664d644175d5aac1465ef11c4b0">vpx_codec_peek_stream_info</a> (<a class="el" href="group__codec.html#gad654f3da60151f5dfef70aca00ef1e9e">vpx_codec_iface_t</a> *iface, const uint8_t *data, unsigned int data_sz, <a class="el" href="structvpx__codec__stream__info.html">vpx_codec_stream_info_t</a> *si)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse stream info from a buffer. <a href="group__decoder.html#gadfee4664d644175d5aac1465ef11c4b0"></a><br/></td></tr>
<tr><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__decoder.html#ga552f1044d36a84e8b05ce6902e9ae8c9">vpx_codec_get_stream_info</a> (<a class="el" href="structvpx__codec__ctx.html">vpx_codec_ctx_t</a> *ctx, <a class="el" href="structvpx__codec__stream__info.html">vpx_codec_stream_info_t</a> *si)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return information about the current stream. <a href="group__decoder.html#ga552f1044d36a84e8b05ce6902e9ae8c9"></a><br/></td></tr>
<tr><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__decoder.html#ga3441e157a7a69108bca9a069f2ee8e0d">vpx_codec_decode</a> (<a class="el" href="structvpx__codec__ctx.html">vpx_codec_ctx_t</a> *ctx, const uint8_t *data, unsigned int data_sz, void *user_priv, long deadline)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decode data. <a href="group__decoder.html#ga3441e157a7a69108bca9a069f2ee8e0d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structvpx__image.html">vpx_image_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__decoder.html#ga0e231c3a5ce445fdb2268d741da97500">vpx_codec_get_frame</a> (<a class="el" href="structvpx__codec__ctx.html">vpx_codec_ctx_t</a> *ctx, <a class="el" href="group__codec.html#ga6ea348f76b1f8a1fe50e14db684146c6">vpx_codec_iter_t</a> *iter)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decoded frames iterator. <a href="group__decoder.html#ga0e231c3a5ce445fdb2268d741da97500"></a><br/></td></tr>
<tr><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__cap__put__frame.html#ga299c2d1b265a22a680f117dd686e31ce">vpx_codec_register_put_frame_cb</a> (<a class="el" href="structvpx__codec__ctx.html">vpx_codec_ctx_t</a> *ctx, <a class="el" href="group__cap__put__frame.html#ga1c3d3d07ec4f907dc426bbd6d70862ec">vpx_codec_put_frame_cb_fn_t</a> cb, void *user_priv)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register for notification of frame completion. <a href="group__cap__put__frame.html#ga299c2d1b265a22a680f117dd686e31ce"></a><br/></td></tr>
<tr><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__cap__put__slice.html#gaffcc69a8134406fc653500759b696b8e">vpx_codec_register_put_slice_cb</a> (<a class="el" href="structvpx__codec__ctx.html">vpx_codec_ctx_t</a> *ctx, <a class="el" href="group__cap__put__slice.html#ga344dbbf130aa9632aee94cee1f3cef44">vpx_codec_put_slice_cb_fn_t</a> cb, void *user_priv)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register for notification of slice completion. <a href="group__cap__put__slice.html#gaffcc69a8134406fc653500759b696b8e"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Describes the decoder algorithm interface to applications. </p>
<p>This file describes the interface between an application and a video decoder algorithm. </p>
</div></div>
<hr class="footer"/><address class="footer"><small>Generated on Tue Aug 16 2011 for WebM VP8 Codec SDK by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
