<!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_encoder.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.3 --> <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="#enum-members">Enumerations</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <h1>vpx/vpx_encoder.h File Reference<div class="ingroups"><a class="el" href="group__encoder.html">Encoder Algorithm Interface</a></div></h1> </div> </div> <div class="contents"> <p>Describes the encoder 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__encoder_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__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="define-members"></a> Defines</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad1f3154e8dfc7058a43a4a8d3c94b8fd"></a><!-- doxytag: member="vpx_encoder.h::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="vpx_encoder.h::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="group__encoder.html#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#ga57bb9eb1881c7e4bf86580660a5e40a0">VPX_CODEC_USE_PSNR</a>   0x10000</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialization-time Feature Enabling. <a href="group__encoder.html#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#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#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="group__encoder.html#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="group__encoder.html#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="group__encoder.html#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="group__encoder.html#gaac8ee319b9a6175f6946f59437c7ae4b"></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="group__encoder.html#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="group__encoder.html#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="group__encoder.html#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="group__encoder.html#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"><p>Encoder output packet variants. </p> <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"><p>Multi-pass Encoding Pass. </p> <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"><p>Rate control mode. </p> <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"><p>Keyframe placement mode. </p> <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="group__encoder.html#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="group__encoder.html#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="group__encoder.html#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="group__encoder.html#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="group__encoder.html#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="group__encoder.html#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="group__encoder.html#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="group__encoder.html#ga250aee4536aa2475e85cf61c9710c963"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Describes the encoder algorithm interface to applications. </p> <p>This file describes the interface between an application and a video encoder algorithm. </p> </div></div> <hr class="footer"/><address class="footer"><small>Generated on Thu Mar 10 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.3 </small></address> </body> </html>