<!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: Frame-Based Decoding Functions</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><a href="files.html"><span>Files</span></a></li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#typedef-members">Typedefs</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">Frame-Based Decoding Functions</div> </div> <div class="ingroups"><a class="el" href="group__decoder.html">Decoder Algorithm Interface</a></div></div> <div class="contents"> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="typedef-members"></a> Typedefs</h2></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="#ga1c3d3d07ec4f907dc426bbd6d70862ec"></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__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="#ga299c2d1b265a22a680f117dd686e31ce"></a><br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <p>The following functions are required to be implemented for all decoders that advertise the VPX_CODEC_CAP_PUT_FRAME capability. Calling these functions for codecs that don't advertise this capability will result in an error code being returned, usually VPX_CODEC_ERROR </p> <hr/><h2>Typedef Documentation</h2> <a class="anchor" id="ga1c3d3d07ec4f907dc426bbd6d70862ec"></a><!-- doxytag: member="vpx_decoder.h::vpx_codec_put_frame_cb_fn_t" ref="ga1c3d3d07ec4f907dc426bbd6d70862ec" args=")(void *user_priv, const vpx_image_t *img)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef void(* <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> </table> </div> <div class="memdoc"> <p>put frame callback prototype </p> <p>This callback is invoked by the decoder to notify the application of the availability of decoded image data. </p> </div> </div> <hr/><h2>Function Documentation</h2> <a class="anchor" id="ga299c2d1b265a22a680f117dd686e31ce"></a><!-- doxytag: member="vpx_decoder.h::vpx_codec_register_put_frame_cb" ref="ga299c2d1b265a22a680f117dd686e31ce" args="(vpx_codec_ctx_t *ctx, vpx_codec_put_frame_cb_fn_t cb, void *user_priv)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__codec.html#gada1084710837ad363b92f2379dd2b8d2">vpx_codec_err_t</a> vpx_codec_register_put_frame_cb </td> <td>(</td> <td class="paramtype"><a class="el" href="structvpx__codec__ctx.html">vpx_codec_ctx_t</a> * </td> <td class="paramname"><em>ctx</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group__cap__put__frame.html#ga1c3d3d07ec4f907dc426bbd6d70862ec">vpx_codec_put_frame_cb_fn_t</a> </td> <td class="paramname"><em>cb</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">void * </td> <td class="paramname"><em>user_priv</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Register for notification of frame completion. </p> <p>Registers a given function to be called when a decoded frame is available.</p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">ctx</td><td>Pointer to this instance's context </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">cb</td><td>Pointer to the callback function </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">user_priv</td><td>User's private data</td></tr> </table> </dd> </dl> <dl><dt><b>Return values:</b></dt><dd> <table class="retval"> <tr><td class="paramname"><a class="el" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2af1dcde74b1c5ff7b29f31246dfd90986" title="Operation completed without error.">VPX_CODEC_OK</a></td><td>Callback successfully registered. </td></tr> <tr><td class="paramname"><a class="el" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2abd8a8f9c2588adab5d764d957e265135" title="Unspecified error.">VPX_CODEC_ERROR</a></td><td>Decoder context not initialized, or algorithm not capable of posting slice completion. </td></tr> </table> </dd> </dl> </div> </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>