<!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: Encoder Algorithm Interface</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="#nested-classes">Data Structures</a> |
<a href="#files">Files</a> |
<a href="#define-members">Defines</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">Encoder Algorithm Interface</div> </div>
<div class="ingroups"><a class="el" href="group__codec.html">Common Algorithm Interface</a></div></div>
<div class="contents">
<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__fixed__buf.html">vpx_fixed_buf</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Generic fixed size buffer structure. <a href="structvpx__fixed__buf.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__cx__pkt.html">vpx_codec_cx_pkt</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Encoder output packet. <a href="structvpx__codec__cx__pkt.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__rational.html">vpx_rational</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Rational Number. <a href="structvpx__rational.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__enc__cfg.html">vpx_codec_enc_cfg</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Encoder configuration structure. <a href="structvpx__codec__enc__cfg.html#details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="files"></a>
Files</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="vpx__encoder_8h.html">vpx_encoder.h</a></td></tr>
<p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Describes the encoder algorithm interface to applications. </p>
<br/></td></tr>
</p>
<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="gad1f3154e8dfc7058a43a4a8d3c94b8fd"></a><!-- doxytag: member="encoder::VPX_ENCODER_H" ref="gad1f3154e8dfc7058a43a4a8d3c94b8fd" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>VPX_ENCODER_H</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa4f0b52293c08ba672429c3a03648b9d"></a><!-- doxytag: member="encoder::VPX_ENCODER_ABI_VERSION" ref="gaa4f0b52293c08ba672429c3a03648b9d" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoder.html#gaa4f0b52293c08ba672429c3a03648b9d">VPX_ENCODER_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__encoder.html#ga398803f408d6f71aae730b5ee7793e1c">VPX_CODEC_CAP_PSNR</a>   0x10000</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Encoder capabilities bitfield. <a href="#ga398803f408d6f71aae730b5ee7793e1c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoder.html#ga69768adb51faa28d98870cbc77e9ea93">VPX_CODEC_CAP_OUTPUT_PARTITION</a>   0x20000</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoder.html#ga57bb9eb1881c7e4bf86580660a5e40a0">VPX_CODEC_USE_PSNR</a>   0x10000</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialization-time Feature Enabling. <a href="#ga57bb9eb1881c7e4bf86580660a5e40a0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoder.html#gac26cd92b3719953aa0fbb0ff8c1d9c8d">VPX_CODEC_USE_OUTPUT_PARTITION</a>   0x20000</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoder.html#ga7a896eb3bc74f33419e6a9812c60e4c9">VPX_FRAME_IS_KEY</a>   0x1</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoder.html#gab899503032065a30ac6864b4c89626a9">VPX_FRAME_IS_DROPPABLE</a>   0x2</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoder.html#ga060d7e881d249bdb6e1a29b42e559685">VPX_FRAME_IS_INVISIBLE</a>   0x4</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoder.html#gafb9f7dbf9b8a764c521d8b12c0e6959d">VPX_FRAME_IS_FRAGMENT</a>   0x8</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoder.html#ga651e80c00662995ac9151bb7433db3e5">VPX_ERROR_RESILIENT_DEFAULT</a>   0x1</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoder.html#gac9b4ca99f12504d951589fac6854fc09">VPX_ERROR_RESILIENT_PARTITIONS</a>   0x2</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoder.html#ga4c4f4e3cbb5225d2c6c050e2d1e948fa">VPX_EFLAG_FORCE_KF</a>   (1<<0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoder.html#ga3d490a2a9a6acd7c9ef82a603155f3cf">vpx_codec_enc_init</a>(ctx, iface, cfg, flags)   vpx_codec_enc_init_ver(ctx, iface, cfg, flags, VPX_ENCODER_ABI_VERSION)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience macro for <a class="el" href="group__encoder.html#ga6ed21b96c481c0b6e1b543ef958a57a4" title="Initialize an encoder instance.">vpx_codec_enc_init_ver()</a> <a href="#ga3d490a2a9a6acd7c9ef82a603155f3cf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoder.html#ga04253cc9ec1146d72fa8bb86bcf32144">VPX_DL_REALTIME</a>   (1)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoder.html#ga5d00a9f9e10b9f49ca91e72c1f01c9fd">VPX_DL_GOOD_QUALITY</a>   (1000000)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoder.html#gab350573bea112f2fdf8e5677db3ac0da">VPX_DL_BEST_QUALITY</a>   (0)</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 <a class="el" href="structvpx__fixed__buf.html">vpx_fixed_buf</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoder.html#ga21fab7dd28065f349c97165501223764">vpx_fixed_buf_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Generic fixed size buffer structure. <a href="#ga21fab7dd28065f349c97165501223764"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoder.html#ga7e711b0a71c65aef8f0faea8bd57b05f">vpx_codec_pts_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Time Stamp Type. <a href="#ga7e711b0a71c65aef8f0faea8bd57b05f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoder.html#gaac8ee319b9a6175f6946f59437c7ae4b">vpx_codec_frame_flags_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compressed Frame Flags. <a href="#gaac8ee319b9a6175f6946f59437c7ae4b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoder.html#ga77e0e1fff62556a4f4d54c84467a41f3">vpx_codec_er_flags_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Error Resilient flags. <a href="#ga77e0e1fff62556a4f4d54c84467a41f3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structvpx__codec__cx__pkt.html">vpx_codec_cx_pkt</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoder.html#ga3f711e17fbefac545e8959ef5a023556">vpx_codec_cx_pkt_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Encoder output packet. <a href="#ga3f711e17fbefac545e8959ef5a023556"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structvpx__rational.html">vpx_rational</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoder.html#ga2c08c6d71202024f17a5aef71a3d13e5">vpx_rational_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Rational Number. <a href="#ga2c08c6d71202024f17a5aef71a3d13e5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoder.html#ga99e4a3c966f0de19fe1aa626bd860366">vpx_enc_frame_flags_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Encoded Frame Flags. <a href="#ga99e4a3c966f0de19fe1aa626bd860366"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structvpx__codec__enc__cfg.html">vpx_codec_enc_cfg</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoder.html#ga946236c809e493b31a815d82db1e59db">vpx_codec_enc_cfg_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Encoder configuration structure. <a href="#ga946236c809e493b31a815d82db1e59db"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoder.html#ga28a79375279536526552af3a83d2ed72">vpx_codec_cx_pkt_kind</a> { <a class="el" href="group__encoder.html#gga28a79375279536526552af3a83d2ed72a2261aae5594289400e812fb1e6b6b0cc">VPX_CODEC_CX_FRAME_PKT</a>,
<a class="el" href="group__encoder.html#gga28a79375279536526552af3a83d2ed72a77cd8b95d9891bcce36117f5f31994fd">VPX_CODEC_STATS_PKT</a>,
<a class="el" href="group__encoder.html#gga28a79375279536526552af3a83d2ed72a11eefa1328e6d22eb7c844645a260628">VPX_CODEC_PSNR_PKT</a>,
<a class="el" href="group__encoder.html#gga28a79375279536526552af3a83d2ed72a7b54c122969397b1926de853d28b3c80">VPX_CODEC_CUSTOM_PKT</a> = 256
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Encoder output packet variants. <a href="group__encoder.html#ga28a79375279536526552af3a83d2ed72">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoder.html#ga476c5417f9c15a1dc5d3f68fa44c493f">vpx_enc_pass</a> { <a class="el" href="group__encoder.html#gga476c5417f9c15a1dc5d3f68fa44c493fa7b6943a41868e8e26a77e9500f139ca1">VPX_RC_ONE_PASS</a>,
<a class="el" href="group__encoder.html#gga476c5417f9c15a1dc5d3f68fa44c493faa0765945345b160905f3b762986dae3b">VPX_RC_FIRST_PASS</a>,
<a class="el" href="group__encoder.html#gga476c5417f9c15a1dc5d3f68fa44c493fa65da543b956d6a9b1f301ab8cc90d3a7">VPX_RC_LAST_PASS</a>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Multi-pass Encoding Pass. <a href="group__encoder.html#ga476c5417f9c15a1dc5d3f68fa44c493f">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoder.html#gaf50e74d91be4cae6f70dfeba5b7410d2">vpx_rc_mode</a> { <a class="el" href="group__encoder.html#ggaf50e74d91be4cae6f70dfeba5b7410d2ab8fbe4441ed3f31a167c8194e8a64f87">VPX_VBR</a>,
<a class="el" href="group__encoder.html#ggaf50e74d91be4cae6f70dfeba5b7410d2a8b02853cb35790d60cc171a11f6c268a">VPX_CBR</a>,
<a class="el" href="group__encoder.html#ggaf50e74d91be4cae6f70dfeba5b7410d2a5f2fd02b55c67d62bfd79380bcb03f63">VPX_CQ</a>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Rate control mode. <a href="group__encoder.html#gaf50e74d91be4cae6f70dfeba5b7410d2">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoder.html#ga9f461802aa4db35c04a8b23837987f40">vpx_kf_mode</a> { <a class="el" href="group__encoder.html#gga9f461802aa4db35c04a8b23837987f40a6bd87eea515c65661a5241a0f01e44a6">VPX_KF_FIXED</a>,
<a class="el" href="group__encoder.html#gga9f461802aa4db35c04a8b23837987f40ab1b423e78f72e77d2dce755d6c9652f8">VPX_KF_AUTO</a>,
<a class="el" href="group__encoder.html#gga9f461802aa4db35c04a8b23837987f40a56513f60cbf3434ca0092173005d0ab2">VPX_KF_DISABLED</a> = 0
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Keyframe placement mode. <a href="group__encoder.html#ga9f461802aa4db35c04a8b23837987f40">More...</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__encoder.html#ga6ed21b96c481c0b6e1b543ef958a57a4">vpx_codec_enc_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__enc__cfg.html">vpx_codec_enc_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 an encoder instance. <a href="#ga6ed21b96c481c0b6e1b543ef958a57a4"></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__encoder.html#ga9ab8c79623312e9c5d5405d66a788f59">vpx_codec_enc_config_default</a> (<a class="el" href="group__codec.html#gad654f3da60151f5dfef70aca00ef1e9e">vpx_codec_iface_t</a> *iface, <a class="el" href="structvpx__codec__enc__cfg.html">vpx_codec_enc_cfg_t</a> *cfg, unsigned int usage)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a default configuration. <a href="#ga9ab8c79623312e9c5d5405d66a788f59"></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__encoder.html#gabbc036b1fbc1288485df5562a989da9b">vpx_codec_enc_config_set</a> (<a class="el" href="structvpx__codec__ctx.html">vpx_codec_ctx_t</a> *ctx, const <a class="el" href="structvpx__codec__enc__cfg.html">vpx_codec_enc_cfg_t</a> *cfg)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set or change configuration. <a href="#gabbc036b1fbc1288485df5562a989da9b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structvpx__fixed__buf.html">vpx_fixed_buf_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoder.html#ga512eb105fef18bebb02e134e4cbc82ff">vpx_codec_get_global_headers</a> (<a class="el" href="structvpx__codec__ctx.html">vpx_codec_ctx_t</a> *ctx)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get global stream headers. <a href="#ga512eb105fef18bebb02e134e4cbc82ff"></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__encoder.html#gaf990542e2aeb389f05fae3e9c7803639">vpx_codec_encode</a> (<a class="el" href="structvpx__codec__ctx.html">vpx_codec_ctx_t</a> *ctx, const <a class="el" href="structvpx__image.html">vpx_image_t</a> *img, <a class="el" href="group__encoder.html#ga7e711b0a71c65aef8f0faea8bd57b05f">vpx_codec_pts_t</a> pts, unsigned long duration, <a class="el" href="group__encoder.html#ga99e4a3c966f0de19fe1aa626bd860366">vpx_enc_frame_flags_t</a> flags, unsigned long deadline)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Encode a frame. <a href="#gaf990542e2aeb389f05fae3e9c7803639"></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__encoder.html#gae9f8f75978a1ebcf1f358964b55ecb9e">vpx_codec_set_cx_data_buf</a> (<a class="el" href="structvpx__codec__ctx.html">vpx_codec_ctx_t</a> *ctx, const <a class="el" href="structvpx__fixed__buf.html">vpx_fixed_buf_t</a> *buf, unsigned int pad_before, unsigned int pad_after)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set compressed data output buffer. <a href="#gae9f8f75978a1ebcf1f358964b55ecb9e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structvpx__codec__cx__pkt.html">vpx_codec_cx_pkt_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoder.html#gae81cab25d66cf3bc59f1f75f8a5af720">vpx_codec_get_cx_data</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">Encoded data iterator. <a href="#gae81cab25d66cf3bc59f1f75f8a5af720"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structvpx__image.html">vpx_image_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoder.html#ga250aee4536aa2475e85cf61c9710c963">vpx_codec_get_preview_frame</a> (<a class="el" href="structvpx__codec__ctx.html">vpx_codec_ctx_t</a> *ctx)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get Preview Frame. <a href="#ga250aee4536aa2475e85cf61c9710c963"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>This abstraction allows applications using this encoder to easily support multiple video formats with minimal code duplication. This section describes the interface common to all encoders. </p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ga398803f408d6f71aae730b5ee7793e1c"></a><!-- doxytag: member="vpx_encoder.h::VPX_CODEC_CAP_PSNR" ref="ga398803f408d6f71aae730b5ee7793e1c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define VPX_CODEC_CAP_PSNR   0x10000</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encoder capabilities bitfield. </p>
<p>Each encoder advertises the capabilities it supports as part of its <a class="el" href="group__codec.html#gad654f3da60151f5dfef70aca00ef1e9e" title="Codec interface structure.">vpx_codec_iface_t</a> interface structure. Capabilities are extra interfaces or functionality, and are not required to be supported by an encoder.</p>
<p>The available flags are specified by VPX_CODEC_CAP_* defines. Can issue PSNR packets </p>
</div>
</div>
<a class="anchor" id="ga69768adb51faa28d98870cbc77e9ea93"></a><!-- doxytag: member="vpx_encoder.h::VPX_CODEC_CAP_OUTPUT_PARTITION" ref="ga69768adb51faa28d98870cbc77e9ea93" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define VPX_CODEC_CAP_OUTPUT_PARTITION   0x20000</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Can output one partition at a time. Each partition is returned in its own VPX_CODEC_CX_FRAME_PKT, with the FRAME_IS_FRAGMENT flag set for every partition but the last. In this mode all frames are always returned partition by partition. </p>
</div>
</div>
<a class="anchor" id="ga57bb9eb1881c7e4bf86580660a5e40a0"></a><!-- doxytag: member="vpx_encoder.h::VPX_CODEC_USE_PSNR" ref="ga57bb9eb1881c7e4bf86580660a5e40a0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define VPX_CODEC_USE_PSNR   0x10000</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initialization-time Feature Enabling. </p>
<p>Certain codec features must be known at initialization time, to allow for proper memory allocation.</p>
<p>The available flags are specified by VPX_CODEC_USE_* defines. Calculate PSNR on each frame </p>
</div>
</div>
<a class="anchor" id="gac26cd92b3719953aa0fbb0ff8c1d9c8d"></a><!-- doxytag: member="vpx_encoder.h::VPX_CODEC_USE_OUTPUT_PARTITION" ref="gac26cd92b3719953aa0fbb0ff8c1d9c8d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define VPX_CODEC_USE_OUTPUT_PARTITION   0x20000</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Make the encoder output one partition at a time. </p>
</div>
</div>
<a class="anchor" id="ga7a896eb3bc74f33419e6a9812c60e4c9"></a><!-- doxytag: member="vpx_encoder.h::VPX_FRAME_IS_KEY" ref="ga7a896eb3bc74f33419e6a9812c60e4c9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define VPX_FRAME_IS_KEY   0x1</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>frame is the start of a GOP </p>
</div>
</div>
<a class="anchor" id="gab899503032065a30ac6864b4c89626a9"></a><!-- doxytag: member="vpx_encoder.h::VPX_FRAME_IS_DROPPABLE" ref="gab899503032065a30ac6864b4c89626a9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define VPX_FRAME_IS_DROPPABLE   0x2</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>frame can be dropped without affecting the stream (no future frame depends on this one) </p>
</div>
</div>
<a class="anchor" id="ga060d7e881d249bdb6e1a29b42e559685"></a><!-- doxytag: member="vpx_encoder.h::VPX_FRAME_IS_INVISIBLE" ref="ga060d7e881d249bdb6e1a29b42e559685" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define VPX_FRAME_IS_INVISIBLE   0x4</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>frame should be decoded but will not be shown </p>
</div>
</div>
<a class="anchor" id="gafb9f7dbf9b8a764c521d8b12c0e6959d"></a><!-- doxytag: member="vpx_encoder.h::VPX_FRAME_IS_FRAGMENT" ref="gafb9f7dbf9b8a764c521d8b12c0e6959d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define VPX_FRAME_IS_FRAGMENT   0x8</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>this is a fragment of the encoded frame </p>
</div>
</div>
<a class="anchor" id="ga651e80c00662995ac9151bb7433db3e5"></a><!-- doxytag: member="vpx_encoder.h::VPX_ERROR_RESILIENT_DEFAULT" ref="ga651e80c00662995ac9151bb7433db3e5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define VPX_ERROR_RESILIENT_DEFAULT   0x1</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Improve resiliency against losses of whole frames </p>
</div>
</div>
<a class="anchor" id="gac9b4ca99f12504d951589fac6854fc09"></a><!-- doxytag: member="vpx_encoder.h::VPX_ERROR_RESILIENT_PARTITIONS" ref="gac9b4ca99f12504d951589fac6854fc09" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define VPX_ERROR_RESILIENT_PARTITIONS   0x2</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The frame partitions are independently decodable by the bool decoder, meaning that partitions can be decoded even though earlier partitions have been lost. Note that intra predicition is still done over the partition boundary. </p>
</div>
</div>
<a class="anchor" id="ga4c4f4e3cbb5225d2c6c050e2d1e948fa"></a><!-- doxytag: member="vpx_encoder.h::VPX_EFLAG_FORCE_KF" ref="ga4c4f4e3cbb5225d2c6c050e2d1e948fa" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define VPX_EFLAG_FORCE_KF   (1<<0)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Force this frame to be a keyframe </p>
</div>
</div>
<a class="anchor" id="ga3d490a2a9a6acd7c9ef82a603155f3cf"></a><!-- doxytag: member="vpx_encoder.h::vpx_codec_enc_init" ref="ga3d490a2a9a6acd7c9ef82a603155f3cf" args="(ctx, iface, cfg, flags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define vpx_codec_enc_init</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">ctx, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">iface, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">cfg, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">flags </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   vpx_codec_enc_init_ver(ctx, iface, cfg, flags, VPX_ENCODER_ABI_VERSION)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convenience macro for <a class="el" href="group__encoder.html#ga6ed21b96c481c0b6e1b543ef958a57a4" title="Initialize an encoder instance.">vpx_codec_enc_init_ver()</a> </p>
<p>Ensures the ABI version parameter is properly set. </p>
</div>
</div>
<a class="anchor" id="ga04253cc9ec1146d72fa8bb86bcf32144"></a><!-- doxytag: member="vpx_encoder.h::VPX_DL_REALTIME" ref="ga04253cc9ec1146d72fa8bb86bcf32144" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define VPX_DL_REALTIME   (1)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>deadline parameter analogous to VPx REALTIME mode. </p>
</div>
</div>
<a class="anchor" id="ga5d00a9f9e10b9f49ca91e72c1f01c9fd"></a><!-- doxytag: member="vpx_encoder.h::VPX_DL_GOOD_QUALITY" ref="ga5d00a9f9e10b9f49ca91e72c1f01c9fd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define VPX_DL_GOOD_QUALITY   (1000000)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>deadline parameter analogous to VPx GOOD QUALITY mode. </p>
</div>
</div>
<a class="anchor" id="gab350573bea112f2fdf8e5677db3ac0da"></a><!-- doxytag: member="vpx_encoder.h::VPX_DL_BEST_QUALITY" ref="gab350573bea112f2fdf8e5677db3ac0da" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define VPX_DL_BEST_QUALITY   (0)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>deadline parameter analogous to VPx BEST QUALITY mode. </p>
</div>
</div>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="ga21fab7dd28065f349c97165501223764"></a><!-- doxytag: member="vpx_encoder.h::vpx_fixed_buf_t" ref="ga21fab7dd28065f349c97165501223764" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structvpx__fixed__buf.html">vpx_fixed_buf</a> <a class="el" href="structvpx__fixed__buf.html">vpx_fixed_buf_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Generic fixed size buffer structure. </p>
<p>This structure is able to hold a reference to any fixed size buffer. alias for struct <a class="el" href="structvpx__fixed__buf.html" title="Generic fixed size buffer structure.">vpx_fixed_buf</a> </p>
</div>
</div>
<a class="anchor" id="ga7e711b0a71c65aef8f0faea8bd57b05f"></a><!-- doxytag: member="vpx_encoder.h::vpx_codec_pts_t" ref="ga7e711b0a71c65aef8f0faea8bd57b05f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int64_t <a class="el" href="group__encoder.html#ga7e711b0a71c65aef8f0faea8bd57b05f">vpx_codec_pts_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Time Stamp Type. </p>
<p>An integer, which when multiplied by the stream's time base, provides the absolute time of a sample. </p>
</div>
</div>
<a class="anchor" id="gaac8ee319b9a6175f6946f59437c7ae4b"></a><!-- doxytag: member="vpx_encoder.h::vpx_codec_frame_flags_t" ref="gaac8ee319b9a6175f6946f59437c7ae4b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef uint32_t <a class="el" href="group__encoder.html#gaac8ee319b9a6175f6946f59437c7ae4b">vpx_codec_frame_flags_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Compressed Frame Flags. </p>
<p>This type represents a bitfield containing information about a compressed frame that may be useful to an application. The most significant 16 bits can be used by an algorithm to provide additional detail, for example to support frame types that are codec specific (MPEG-1 D-frames for example) </p>
</div>
</div>
<a class="anchor" id="ga77e0e1fff62556a4f4d54c84467a41f3"></a><!-- doxytag: member="vpx_encoder.h::vpx_codec_er_flags_t" ref="ga77e0e1fff62556a4f4d54c84467a41f3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef uint32_t <a class="el" href="group__encoder.html#ga77e0e1fff62556a4f4d54c84467a41f3">vpx_codec_er_flags_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Error Resilient flags. </p>
<p>These flags define which error resilient features to enable in the encoder. The flags are specified through the <a class="el" href="structvpx__codec__enc__cfg.html#a4e17173b66ca0d7dfba9978625d7ba76" title="Enable error resilient modes.">vpx_codec_enc_cfg::g_error_resilient</a> variable. </p>
</div>
</div>
<a class="anchor" id="ga3f711e17fbefac545e8959ef5a023556"></a><!-- doxytag: member="vpx_encoder.h::vpx_codec_cx_pkt_t" ref="ga3f711e17fbefac545e8959ef5a023556" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structvpx__codec__cx__pkt.html">vpx_codec_cx_pkt</a> <a class="el" href="structvpx__codec__cx__pkt.html">vpx_codec_cx_pkt_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encoder output packet. </p>
<p>This structure contains the different kinds of output data the encoder may produce while compressing a frame. alias for struct <a class="el" href="structvpx__codec__cx__pkt.html" title="Encoder output packet.">vpx_codec_cx_pkt</a> </p>
</div>
</div>
<a class="anchor" id="ga2c08c6d71202024f17a5aef71a3d13e5"></a><!-- doxytag: member="vpx_encoder.h::vpx_rational_t" ref="ga2c08c6d71202024f17a5aef71a3d13e5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structvpx__rational.html">vpx_rational</a> <a class="el" href="structvpx__rational.html">vpx_rational_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Rational Number. </p>
<p>This structure holds a fractional value. alias for struct <a class="el" href="structvpx__rational.html" title="Rational Number.">vpx_rational</a> </p>
</div>
</div>
<a class="anchor" id="ga99e4a3c966f0de19fe1aa626bd860366"></a><!-- doxytag: member="vpx_encoder.h::vpx_enc_frame_flags_t" ref="ga99e4a3c966f0de19fe1aa626bd860366" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef long <a class="el" href="group__encoder.html#ga99e4a3c966f0de19fe1aa626bd860366">vpx_enc_frame_flags_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encoded Frame Flags. </p>
<p>This type indicates a bitfield to be passed to <a class="el" href="group__encoder.html#gaf990542e2aeb389f05fae3e9c7803639" title="Encode a frame.">vpx_codec_encode()</a>, defining per-frame boolean values. By convention, bits common to all codecs will be named VPX_EFLAG_*, and bits specific to an algorithm will be named /algo/_eflag_*. The lower order 16 bits are reserved for common use. </p>
</div>
</div>
<a class="anchor" id="ga946236c809e493b31a815d82db1e59db"></a><!-- doxytag: member="vpx_encoder.h::vpx_codec_enc_cfg_t" ref="ga946236c809e493b31a815d82db1e59db" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structvpx__codec__enc__cfg.html">vpx_codec_enc_cfg</a> <a class="el" href="structvpx__codec__enc__cfg.html">vpx_codec_enc_cfg_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encoder configuration structure. </p>
<p>This structure contains the encoder settings that have common representations across all codecs. This doesn't imply that all codecs support all features, however. alias for struct <a class="el" href="structvpx__codec__enc__cfg.html" title="Encoder configuration structure.">vpx_codec_enc_cfg</a> </p>
</div>
</div>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="ga28a79375279536526552af3a83d2ed72"></a><!-- doxytag: member="vpx_encoder.h::vpx_codec_cx_pkt_kind" ref="ga28a79375279536526552af3a83d2ed72" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__encoder.html#ga28a79375279536526552af3a83d2ed72">vpx_codec_cx_pkt_kind</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encoder output packet variants. </p>
<p>This enumeration lists the different kinds of data packets that can be returned by calls to <a class="el" href="group__encoder.html#gae81cab25d66cf3bc59f1f75f8a5af720" title="Encoded data iterator.">vpx_codec_get_cx_data()</a>. Algorithms <a class="el" href="rfc2119.html#MAY">MAY</a> extend this list to provide additional functionality. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="gga28a79375279536526552af3a83d2ed72a2261aae5594289400e812fb1e6b6b0cc"></a><!-- doxytag: member="VPX_CODEC_CX_FRAME_PKT" ref="gga28a79375279536526552af3a83d2ed72a2261aae5594289400e812fb1e6b6b0cc" args="" -->VPX_CODEC_CX_FRAME_PKT</em> </td><td>
<p>Compressed video frame </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga28a79375279536526552af3a83d2ed72a77cd8b95d9891bcce36117f5f31994fd"></a><!-- doxytag: member="VPX_CODEC_STATS_PKT" ref="gga28a79375279536526552af3a83d2ed72a77cd8b95d9891bcce36117f5f31994fd" args="" -->VPX_CODEC_STATS_PKT</em> </td><td>
<p>Two-pass statistics for this frame </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga28a79375279536526552af3a83d2ed72a11eefa1328e6d22eb7c844645a260628"></a><!-- doxytag: member="VPX_CODEC_PSNR_PKT" ref="gga28a79375279536526552af3a83d2ed72a11eefa1328e6d22eb7c844645a260628" args="" -->VPX_CODEC_PSNR_PKT</em> </td><td>
<p>PSNR statistics for this frame </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga28a79375279536526552af3a83d2ed72a7b54c122969397b1926de853d28b3c80"></a><!-- doxytag: member="VPX_CODEC_CUSTOM_PKT" ref="gga28a79375279536526552af3a83d2ed72a7b54c122969397b1926de853d28b3c80" args="" -->VPX_CODEC_CUSTOM_PKT</em> </td><td>
<p>Algorithm extensions </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga476c5417f9c15a1dc5d3f68fa44c493f"></a><!-- doxytag: member="vpx_encoder.h::vpx_enc_pass" ref="ga476c5417f9c15a1dc5d3f68fa44c493f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__encoder.html#ga476c5417f9c15a1dc5d3f68fa44c493f">vpx_enc_pass</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Multi-pass Encoding Pass. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="gga476c5417f9c15a1dc5d3f68fa44c493fa7b6943a41868e8e26a77e9500f139ca1"></a><!-- doxytag: member="VPX_RC_ONE_PASS" ref="gga476c5417f9c15a1dc5d3f68fa44c493fa7b6943a41868e8e26a77e9500f139ca1" args="" -->VPX_RC_ONE_PASS</em> </td><td>
<p>Single pass mode </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga476c5417f9c15a1dc5d3f68fa44c493faa0765945345b160905f3b762986dae3b"></a><!-- doxytag: member="VPX_RC_FIRST_PASS" ref="gga476c5417f9c15a1dc5d3f68fa44c493faa0765945345b160905f3b762986dae3b" args="" -->VPX_RC_FIRST_PASS</em> </td><td>
<p>First pass of multi-pass mode </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga476c5417f9c15a1dc5d3f68fa44c493fa65da543b956d6a9b1f301ab8cc90d3a7"></a><!-- doxytag: member="VPX_RC_LAST_PASS" ref="gga476c5417f9c15a1dc5d3f68fa44c493fa65da543b956d6a9b1f301ab8cc90d3a7" args="" -->VPX_RC_LAST_PASS</em> </td><td>
<p>Final pass of multi-pass mode </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaf50e74d91be4cae6f70dfeba5b7410d2"></a><!-- doxytag: member="vpx_encoder.h::vpx_rc_mode" ref="gaf50e74d91be4cae6f70dfeba5b7410d2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__encoder.html#gaf50e74d91be4cae6f70dfeba5b7410d2">vpx_rc_mode</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Rate control mode. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ggaf50e74d91be4cae6f70dfeba5b7410d2ab8fbe4441ed3f31a167c8194e8a64f87"></a><!-- doxytag: member="VPX_VBR" ref="ggaf50e74d91be4cae6f70dfeba5b7410d2ab8fbe4441ed3f31a167c8194e8a64f87" args="" -->VPX_VBR</em> </td><td>
<p>Variable Bit Rate (VBR) mode </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaf50e74d91be4cae6f70dfeba5b7410d2a8b02853cb35790d60cc171a11f6c268a"></a><!-- doxytag: member="VPX_CBR" ref="ggaf50e74d91be4cae6f70dfeba5b7410d2a8b02853cb35790d60cc171a11f6c268a" args="" -->VPX_CBR</em> </td><td>
<p>Constant Bit Rate (CBR) mode </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaf50e74d91be4cae6f70dfeba5b7410d2a5f2fd02b55c67d62bfd79380bcb03f63"></a><!-- doxytag: member="VPX_CQ" ref="ggaf50e74d91be4cae6f70dfeba5b7410d2a5f2fd02b55c67d62bfd79380bcb03f63" args="" -->VPX_CQ</em> </td><td>
<p>Constant Quality (CQ) mode </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga9f461802aa4db35c04a8b23837987f40"></a><!-- doxytag: member="vpx_encoder.h::vpx_kf_mode" ref="ga9f461802aa4db35c04a8b23837987f40" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__encoder.html#ga9f461802aa4db35c04a8b23837987f40">vpx_kf_mode</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Keyframe placement mode. </p>
<p>This enumeration determines whether keyframes are placed automatically by the encoder or whether this behavior is disabled. Older releases of this SDK were implemented such that VPX_KF_FIXED meant keyframes were disabled. This name is confusing for this behavior, so the new symbols to be used are VPX_KF_AUTO and VPX_KF_DISABLED. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="gga9f461802aa4db35c04a8b23837987f40a6bd87eea515c65661a5241a0f01e44a6"></a><!-- doxytag: member="VPX_KF_FIXED" ref="gga9f461802aa4db35c04a8b23837987f40a6bd87eea515c65661a5241a0f01e44a6" args="" -->VPX_KF_FIXED</em> </td><td>
<p>deprecated, implies VPX_KF_DISABLED </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga9f461802aa4db35c04a8b23837987f40ab1b423e78f72e77d2dce755d6c9652f8"></a><!-- doxytag: member="VPX_KF_AUTO" ref="gga9f461802aa4db35c04a8b23837987f40ab1b423e78f72e77d2dce755d6c9652f8" args="" -->VPX_KF_AUTO</em> </td><td>
<p>Encoder determines optimal placement automatically </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga9f461802aa4db35c04a8b23837987f40a56513f60cbf3434ca0092173005d0ab2"></a><!-- doxytag: member="VPX_KF_DISABLED" ref="gga9f461802aa4db35c04a8b23837987f40a56513f60cbf3434ca0092173005d0ab2" args="" -->VPX_KF_DISABLED</em> </td><td>
<p>Encoder does not place keyframes. </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga6ed21b96c481c0b6e1b543ef958a57a4"></a><!-- doxytag: member="vpx_encoder.h::vpx_codec_enc_init_ver" ref="ga6ed21b96c481c0b6e1b543ef958a57a4" args="(vpx_codec_ctx_t *ctx, vpx_codec_iface_t *iface, vpx_codec_enc_cfg_t *cfg, vpx_codec_flags_t flags, int ver)" -->
<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_enc_init_ver </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__codec.html#gad654f3da60151f5dfef70aca00ef1e9e">vpx_codec_iface_t</a> * </td>
<td class="paramname"><em>iface</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structvpx__codec__enc__cfg.html">vpx_codec_enc_cfg_t</a> * </td>
<td class="paramname"><em>cfg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__codec.html#ga3b36d5af89ddc463489fe5bde0a57877">vpx_codec_flags_t</a> </td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>ver</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initialize an encoder instance. </p>
<p>Initializes a encoder context using the given interface. Applications should call the vpx_codec_enc_init convenience macro instead of this function directly, to ensure that the ABI version number parameter is properly initialized.</p>
<p>In XMA mode (activated by setting VPX_CODEC_USE_XMA in the flags parameter), the storage pointed to by the cfg parameter must be kept readable and stable until all memory maps have been set.</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">iface</td><td>Pointer to the algorithm interface to use. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cfg</td><td>Configuration to use, if known. May be NULL. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>Bitfield of VPX_CODEC_USE_* flags </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ver</td><td>ABI version number. Must be set to VPX_ENCODER_ABI_VERSION </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>The decoder algorithm initialized. </td></tr>
<tr><td class="paramname"><a class="el" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2a96c6d2600dc0ec25c2cb798e8d2f4760" title="Memory operation failed.">VPX_CODEC_MEM_ERROR</a></td><td>Memory allocation failed. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga9ab8c79623312e9c5d5405d66a788f59"></a><!-- doxytag: member="vpx_encoder.h::vpx_codec_enc_config_default" ref="ga9ab8c79623312e9c5d5405d66a788f59" args="(vpx_codec_iface_t *iface, vpx_codec_enc_cfg_t *cfg, unsigned int usage)" -->
<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_enc_config_default </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__codec.html#gad654f3da60151f5dfef70aca00ef1e9e">vpx_codec_iface_t</a> * </td>
<td class="paramname"><em>iface</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structvpx__codec__enc__cfg.html">vpx_codec_enc_cfg_t</a> * </td>
<td class="paramname"><em>cfg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>usage</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a default configuration. </p>
<p>Initializes a encoder configuration structure with default values. Supports the notion of "usages" so that an algorithm may offer different default settings depending on the user's intended goal. This function <a class="el" href="rfc2119.html#SHOULD">SHOULD</a> be called by all applications to initialize the configuration structure before specializing the configuration with application specific values.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">iface</td><td>Pointer to the algorithm interface to use. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">cfg</td><td>Configuration buffer to populate </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">usage</td><td>End usage. Set to 0 or use codec specific values.</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>The configuration was populated. </td></tr>
<tr><td class="paramname"><a class="el" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2a4470784ba5a3ef84dc0697d5489dd292" title="Algorithm does not have required capability.">VPX_CODEC_INCAPABLE</a></td><td>Interface is not an encoder interface. </td></tr>
<tr><td class="paramname"><a class="el" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2ab5857f7b5f03f8ca164fab8843a979df" title="An application-supplied parameter is not valid.">VPX_CODEC_INVALID_PARAM</a></td><td>A parameter was NULL, or the usage value was not recognized. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gabbc036b1fbc1288485df5562a989da9b"></a><!-- doxytag: member="vpx_encoder.h::vpx_codec_enc_config_set" ref="gabbc036b1fbc1288485df5562a989da9b" args="(vpx_codec_ctx_t *ctx, const vpx_codec_enc_cfg_t *cfg)" -->
<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_enc_config_set </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">const <a class="el" href="structvpx__codec__enc__cfg.html">vpx_codec_enc_cfg_t</a> * </td>
<td class="paramname"><em>cfg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set or change configuration. </p>
<p>Reconfigures an encoder instance according to the given configuration.</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">cfg</td><td>Configuration buffer to use</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>The configuration was populated. </td></tr>
<tr><td class="paramname"><a class="el" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2a4470784ba5a3ef84dc0697d5489dd292" title="Algorithm does not have required capability.">VPX_CODEC_INCAPABLE</a></td><td>Interface is not an encoder interface. </td></tr>
<tr><td class="paramname"><a class="el" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2ab5857f7b5f03f8ca164fab8843a979df" title="An application-supplied parameter is not valid.">VPX_CODEC_INVALID_PARAM</a></td><td>A parameter was NULL, or the usage value was not recognized. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga512eb105fef18bebb02e134e4cbc82ff"></a><!-- doxytag: member="vpx_encoder.h::vpx_codec_get_global_headers" ref="ga512eb105fef18bebb02e134e4cbc82ff" args="(vpx_codec_ctx_t *ctx)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structvpx__fixed__buf.html">vpx_fixed_buf_t</a>* vpx_codec_get_global_headers </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><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get global stream headers. </p>
<p>Retrieves a stream level global header packet, if supported by the codec.</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>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table class="retval">
<tr><td class="paramname">NULL</td><td>Encoder does not support global header </td></tr>
<tr><td class="paramname">Non-NULL</td><td>Pointer to buffer containing global header packet </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaf990542e2aeb389f05fae3e9c7803639"></a><!-- doxytag: member="vpx_encoder.h::vpx_codec_encode" ref="gaf990542e2aeb389f05fae3e9c7803639" args="(vpx_codec_ctx_t *ctx, const vpx_image_t *img, vpx_codec_pts_t pts, unsigned long duration, vpx_enc_frame_flags_t flags, unsigned long deadline)" -->
<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_encode </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">const <a class="el" href="structvpx__image.html">vpx_image_t</a> * </td>
<td class="paramname"><em>img</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__encoder.html#ga7e711b0a71c65aef8f0faea8bd57b05f">vpx_codec_pts_t</a> </td>
<td class="paramname"><em>pts</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>duration</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__encoder.html#ga99e4a3c966f0de19fe1aa626bd860366">vpx_enc_frame_flags_t</a> </td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>deadline</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encode a frame. </p>
<p>Encodes a video frame at the given "presentation time." The presentation time stamp (PTS) <a class="el" href="rfc2119.html#MUST">MUST</a> be strictly increasing.</p>
<p>The encoder supports the notion of a soft real-time deadline. Given a non-zero value to the deadline parameter, the encoder will make a "best
effort" guarantee to return before the given time slice expires. It is implicit that limiting the available time to encode will degrade the output quality. The encoder can be given an unlimited time to produce the best possible frame by specifying a deadline of '0'. This deadline supercedes the VPx notion of "best quality, good quality, realtime". Applications that wish to map these former settings to the new deadline based system can use the symbols <a class="el" href="group__encoder.html#ga04253cc9ec1146d72fa8bb86bcf32144">VPX_DL_REALTIME</a>, <a class="el" href="group__encoder.html#ga5d00a9f9e10b9f49ca91e72c1f01c9fd">VPX_DL_GOOD_QUALITY</a>, and <a class="el" href="group__encoder.html#gab350573bea112f2fdf8e5677db3ac0da">VPX_DL_BEST_QUALITY</a>.</p>
<p>When the last frame has been passed to the encoder, this function should continue to be called, with the img parameter set to NULL. This will signal the end-of-stream condition to the encoder and allow it to encode any held buffers. Encoding is complete when <a class="el" href="group__encoder.html#gaf990542e2aeb389f05fae3e9c7803639" title="Encode a frame.">vpx_codec_encode()</a> is called and <a class="el" href="group__encoder.html#gae81cab25d66cf3bc59f1f75f8a5af720" title="Encoded data iterator.">vpx_codec_get_cx_data()</a> returns no data.</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">img</td><td>Image data to encode, NULL to flush. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">pts</td><td>Presentation time stamp, in timebase units. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">duration</td><td>Duration to show frame, in timebase units. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>Flags to use for encoding this frame. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">deadline</td><td>Time to spend encoding, in microseconds. (0=infinite)</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>The configuration was populated. </td></tr>
<tr><td class="paramname"><a class="el" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2a4470784ba5a3ef84dc0697d5489dd292" title="Algorithm does not have required capability.">VPX_CODEC_INCAPABLE</a></td><td>Interface is not an encoder interface. </td></tr>
<tr><td class="paramname"><a class="el" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2ab5857f7b5f03f8ca164fab8843a979df" title="An application-supplied parameter is not valid.">VPX_CODEC_INVALID_PARAM</a></td><td>A parameter was NULL, the image format is unsupported, etc. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gae9f8f75978a1ebcf1f358964b55ecb9e"></a><!-- doxytag: member="vpx_encoder.h::vpx_codec_set_cx_data_buf" ref="gae9f8f75978a1ebcf1f358964b55ecb9e" args="(vpx_codec_ctx_t *ctx, const vpx_fixed_buf_t *buf, unsigned int pad_before, unsigned int pad_after)" -->
<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_set_cx_data_buf </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">const <a class="el" href="structvpx__fixed__buf.html">vpx_fixed_buf_t</a> * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>pad_before</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>pad_after</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set compressed data output buffer. </p>
<p>Sets the buffer that the codec should output the compressed data into. This call effectively sets the buffer pointer returned in the next VPX_CODEC_CX_FRAME_PKT packet. Subsequent packets will be appended into this buffer. The buffer is preserved across frames, so applications must periodically call this function after flushing the accumulated compressed data to disk or to the network to reset the pointer to the buffer's head.</p>
<p>`pad_before` bytes will be skipped before writing the compressed data, and `pad_after` bytes will be appended to the packet. The size of the packet will be the sum of the size of the actual compressed data, pad_before, and pad_after. The padding bytes will be preserved (not overwritten).</p>
<p>Note that calling this function does not guarantee that the returned compressed data will be placed into the specified buffer. In the event that the encoded data will not fit into the buffer provided, the returned packet <a class="el" href="rfc2119.html#MAY">MAY</a> point to an internal buffer, as it would if this call were never used. In this event, the output packet will NOT have any padding, and the application must free space and copy it to the proper place. This is of particular note in configurations that may output multiple packets for a single encoded frame (e.g., lagged encoding) or if the application does not reset the buffer periodically.</p>
<p>Applications may restore the default behavior of the codec providing the compressed data buffer by calling this function with a NULL buffer.</p>
<p>Applications <a class="el" href="rfc2119.html#MUSTNOT">MUST NOT</a> call this function during iteration of <a class="el" href="group__encoder.html#gae81cab25d66cf3bc59f1f75f8a5af720" title="Encoded data iterator.">vpx_codec_get_cx_data()</a>.</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">buf</td><td>Buffer to store compressed data into </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">pad_before</td><td>Bytes to skip before writing compressed data </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">pad_after</td><td>Bytes to skip after writing compressed 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>The buffer was set successfully. </td></tr>
<tr><td class="paramname"><a class="el" href="group__codec.html#ggada1084710837ad363b92f2379dd2b8d2ab5857f7b5f03f8ca164fab8843a979df" title="An application-supplied parameter is not valid.">VPX_CODEC_INVALID_PARAM</a></td><td>A parameter was NULL, the image format is unsupported, etc. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gae81cab25d66cf3bc59f1f75f8a5af720"></a><!-- doxytag: member="vpx_encoder.h::vpx_codec_get_cx_data" ref="gae81cab25d66cf3bc59f1f75f8a5af720" args="(vpx_codec_ctx_t *ctx, vpx_codec_iter_t *iter)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structvpx__codec__cx__pkt.html">vpx_codec_cx_pkt_t</a>* vpx_codec_get_cx_data </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__codec.html#ga6ea348f76b1f8a1fe50e14db684146c6">vpx_codec_iter_t</a> * </td>
<td class="paramname"><em>iter</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encoded data iterator. </p>
<p>Iterates over a list of data packets to be passed from the encoder to the application. The different kinds of packets available are enumerated in <a class="el" href="group__encoder.html#ga28a79375279536526552af3a83d2ed72" title="Encoder output packet variants.">vpx_codec_cx_pkt_kind</a>.</p>
<p><a class="el" href="group__encoder.html#gga28a79375279536526552af3a83d2ed72a2261aae5594289400e812fb1e6b6b0cc">VPX_CODEC_CX_FRAME_PKT</a> packets should be passed to the application's muxer. Multiple compressed frames may be in the list. <a class="el" href="group__encoder.html#gga28a79375279536526552af3a83d2ed72a77cd8b95d9891bcce36117f5f31994fd">VPX_CODEC_STATS_PKT</a> packets should be appended to a global buffer.</p>
<p>The application <a class="el" href="rfc2119.html#MUST">MUST</a> silently ignore any packet kinds that it does not recognize or support.</p>
<p>The data buffers returned from this function are only guaranteed to be valid until the application makes another call to any vpx_codec_* function.</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,out]</td><td class="paramname">iter</td><td>Iterator storage, initialized to NULL</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns a pointer to an output data packet (compressed frame data, two-pass statistics, etc.) or NULL to signal end-of-list. </dd></dl>
</div>
</div>
<a class="anchor" id="ga250aee4536aa2475e85cf61c9710c963"></a><!-- doxytag: member="vpx_encoder.h::vpx_codec_get_preview_frame" ref="ga250aee4536aa2475e85cf61c9710c963" args="(vpx_codec_ctx_t *ctx)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structvpx__image.html">vpx_image_t</a>* vpx_codec_get_preview_frame </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><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get Preview Frame. </p>
<p>Returns an image that can be used as a preview. Shows the image as it would exist at the decompressor. The application <a class="el" href="rfc2119.html#MUST">MUST</a> NOT write into this image buffer.</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>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns a pointer to a preview image, or NULL if no image is available. </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>
