<!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: WebM VP8 Encoder</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> </div>
<div class="headertitle">
<div class="title">WebM VP8 Encoder</div> </div>
<div class="ingroups"><a class="el" href="group__vp8.html">VP8</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__roi__map.html">vpx_roi_map</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">vpx region of interest map <a href="structvpx__roi__map.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__active__map.html">vpx_active_map</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">vpx active region map <a href="structvpx__active__map.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__scaling__mode.html">vpx_scaling_mode</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">vpx image scaling mode <a href="structvpx__scaling__mode.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="vp8cx_8h.html">vp8cx.h</a></td></tr>
<p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Provides definitions for using the VP8 encoder algorithm within the vpx Codec Interface. </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="gae0ac779c2d78f39ad22df9f9f246d1fa"></a><!-- doxytag: member="vp8_encoder::VP8CX_H" ref="gae0ac779c2d78f39ad22df9f9f246d1fa" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>VP8CX_H</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vp8__encoder.html#gafb51c67e5743275146bc1fc425727da3">VP8_EFLAG_NO_REF_LAST</a>   (1<<16)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Don't reference the last frame. <a href="#gafb51c67e5743275146bc1fc425727da3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vp8__encoder.html#gabb5e95343a2738abef44eca13059da33">VP8_EFLAG_NO_REF_GF</a>   (1<<17)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Don't reference the golden frame. <a href="#gabb5e95343a2738abef44eca13059da33"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vp8__encoder.html#ga650ab0baea12be91082226a5cc18776a">VP8_EFLAG_NO_REF_ARF</a>   (1<<21)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Don't reference the alternate reference frame. <a href="#ga650ab0baea12be91082226a5cc18776a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vp8__encoder.html#ga602edb6b02a89cb2db7a16d6dffba583">VP8_EFLAG_NO_UPD_LAST</a>   (1<<18)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Don't update the last frame. <a href="#ga602edb6b02a89cb2db7a16d6dffba583"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vp8__encoder.html#gab01d066c5236457d345ce1cab4c41d6b">VP8_EFLAG_NO_UPD_GF</a>   (1<<22)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Don't update the golden frame. <a href="#gab01d066c5236457d345ce1cab4c41d6b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vp8__encoder.html#ga1cff46a5287e73a620660030d40b9e6c">VP8_EFLAG_NO_UPD_ARF</a>   (1<<23)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Don't update the alternate reference frame. <a href="#ga1cff46a5287e73a620660030d40b9e6c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vp8__encoder.html#gacb64c00adcb361f72a9a3028eb12f5ff">VP8_EFLAG_FORCE_GF</a>   (1<<19)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Force golden frame update. <a href="#gacb64c00adcb361f72a9a3028eb12f5ff"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vp8__encoder.html#ga50584fe4bdb62ff935347576539650b7">VP8_EFLAG_FORCE_ARF</a>   (1<<24)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Force alternate reference frame update. <a href="#ga50584fe4bdb62ff935347576539650b7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vp8__encoder.html#ga5b91ad179910d4efc23aef66c7b2148b">VP8_EFLAG_NO_UPD_ENTROPY</a>   (1<<20)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disable entropy update. <a href="#ga5b91ad179910d4efc23aef66c7b2148b"></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 enum <a class="el" href="group__vp8__encoder.html#ga70071b1bb6cac9a1ef0ea3d8362ff94f">vpx_scaling_mode_1d</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vp8__encoder.html#ga100ca891ad96995e61780ae777bf8663">VPX_SCALING_MODE</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">vpx 1-D scaling mode <a href="#ga100ca891ad96995e61780ae777bf8663"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structvpx__roi__map.html">vpx_roi_map</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vp8__encoder.html#ga5be1a94d436a5e9296f5be06f57ccbd1">vpx_roi_map_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">vpx region of interest map <a href="#ga5be1a94d436a5e9296f5be06f57ccbd1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structvpx__active__map.html">vpx_active_map</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vp8__encoder.html#ga7b48f7962f5061979f0f8ece6fb1cba8">vpx_active_map_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">vpx active region map <a href="#ga7b48f7962f5061979f0f8ece6fb1cba8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structvpx__scaling__mode.html">vpx_scaling_mode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vp8__encoder.html#ga9600359ed9096cd96c621d9cf6c8df38">vpx_scaling_mode_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">vpx image scaling mode <a href="#ga9600359ed9096cd96c621d9cf6c8df38"></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__vp8__encoder.html#ga6deae3d561c838952552c3d3756322ec">vp8e_enc_control_id</a> { <br/>
  <a class="el" href="group__vp8__encoder.html#gga6deae3d561c838952552c3d3756322eca79463ec67bb7c282ffd090622f2a46e4">VP8E_UPD_ENTROPY</a> = 5,
<a class="el" href="group__vp8__encoder.html#gga6deae3d561c838952552c3d3756322eca140d031294fb8c36252c802e8328c1f4">VP8E_UPD_REFERENCE</a>,
<a class="el" href="group__vp8__encoder.html#gga6deae3d561c838952552c3d3756322eca5bb579ead6122fafbf4a8838aa5c221e">VP8E_USE_REFERENCE</a>,
<a class="el" href="group__vp8__encoder.html#gga6deae3d561c838952552c3d3756322eca25a828dbab350f80db769a8f53e3940f">VP8E_SET_ROI_MAP</a>,
<br/>
  <a class="el" href="group__vp8__encoder.html#gga6deae3d561c838952552c3d3756322eca6c904eb7e9e4aa58052742b56f1b4497">VP8E_SET_ACTIVEMAP</a>,
<a class="el" href="group__vp8__encoder.html#gga6deae3d561c838952552c3d3756322eca7a6db9fd1c434d2e4d91b3935777ab9f">VP8E_SET_SCALEMODE</a> = 11,
<a class="el" href="group__vp8__encoder.html#gga6deae3d561c838952552c3d3756322eca953ff0eaa2fcdc2ecd627e449b026853">VP8E_SET_CPUUSED</a> = 13,
<a class="el" href="group__vp8__encoder.html#gga6deae3d561c838952552c3d3756322eca24a5530efabb8b4949d01622b1d72cb0">VP8E_SET_ENABLEAUTOALTREF</a>,
<br/>
  <a class="el" href="group__vp8__encoder.html#gga6deae3d561c838952552c3d3756322eca3fa90cb70bade72af3c2d8d91471a36c">VP8E_SET_NOISE_SENSITIVITY</a>,
<a class="el" href="group__vp8__encoder.html#gga6deae3d561c838952552c3d3756322eca815930923fff388825ee3cc4ef69bb28">VP8E_SET_SHARPNESS</a>,
<a class="el" href="group__vp8__encoder.html#gga6deae3d561c838952552c3d3756322ecab34559df04d3d662616300ed0682dcfd">VP8E_SET_STATIC_THRESHOLD</a>,
<a class="el" href="group__vp8__encoder.html#gga6deae3d561c838952552c3d3756322eca462a4f14f39a6eb5c4a4004fc8d0ad75">VP8E_SET_TOKEN_PARTITIONS</a>,
<br/>
  <a class="el" href="group__vp8__encoder.html#gga6deae3d561c838952552c3d3756322eca5bb0569b813853e981a61c97697cbecd">VP8E_GET_LAST_QUANTIZER</a>,
<a class="el" href="group__vp8__encoder.html#gga6deae3d561c838952552c3d3756322ecad2cfc9712d2eab30b5a59a60d0daaade">VP8E_GET_LAST_QUANTIZER_64</a>,
<a class="el" href="group__vp8__encoder.html#gga6deae3d561c838952552c3d3756322eca628d73f1a69fadd8aa57e0dfef578da8">VP8E_SET_ARNR_MAXFRAMES</a>,
<a class="el" href="group__vp8__encoder.html#gga6deae3d561c838952552c3d3756322eca0a8c40a768af935ae73faa53355c3244">VP8E_SET_ARNR_STRENGTH</a>,
<br/>
  <a class="el" href="group__vp8__encoder.html#gga6deae3d561c838952552c3d3756322eca4e0a0af58670012026c213083cd48f3a">VP8E_SET_ARNR_TYPE</a>,
<a class="el" href="group__vp8__encoder.html#gga6deae3d561c838952552c3d3756322eca126ccbe7bde63b59cec5ea68a82dd498">VP8E_SET_TUNING</a>,
<a class="el" href="group__vp8__encoder.html#gga6deae3d561c838952552c3d3756322ecacd4f5b730bddb9788c3d0b82218ec503">VP8E_SET_CQ_LEVEL</a>,
<a class="el" href="group__vp8__encoder.html#gga6deae3d561c838952552c3d3756322eca09c69ff4a3aabdb307d4f24027dfc4c1">VP8E_SET_MAX_INTRA_BITRATE_PCT</a>
<br/>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">VP8 encoder control functions. <a href="group__vp8__encoder.html#ga6deae3d561c838952552c3d3756322ec">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__vp8__encoder.html#ga70071b1bb6cac9a1ef0ea3d8362ff94f">vpx_scaling_mode_1d</a> { <b>VP8E_NORMAL</b> = 0,
<b>VP8E_FOURFIVE</b> = 1,
<b>VP8E_THREEFIVE</b> = 2,
<b>VP8E_ONETWO</b> = 3
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">vpx 1-D scaling mode <a href="group__vp8__encoder.html#ga70071b1bb6cac9a1ef0ea3d8362ff94f">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__vp8__encoder.html#ga57a092f46c3afa879c237f775d4f51dd">vp8e_encoding_mode</a> { <b>VP8_BEST_QUALITY_ENCODING</b>,
<b>VP8_GOOD_QUALITY_ENCODING</b>,
<b>VP8_REAL_TIME_ENCODING</b>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">VP8 encoding mode. <a href="group__vp8__encoder.html#ga57a092f46c3afa879c237f775d4f51dd">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__vp8__encoder.html#ga5f7508ba3fb453b47f62313ed0b864d2">vp8e_token_partitions</a> { <b>VP8_ONE_TOKENPARTITION</b> = 0,
<b>VP8_TWO_TOKENPARTITION</b> = 1,
<b>VP8_FOUR_TOKENPARTITION</b> = 2,
<b>VP8_EIGHT_TOKENPARTITION</b> = 3
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">VP8 token partition mode. <a href="group__vp8__encoder.html#ga5f7508ba3fb453b47f62313ed0b864d2">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__vp8__encoder.html#ga371dbc29054b3d46364af996ad42ab94">vp8e_tuning</a> { <b>VP8_TUNE_PSNR</b>,
<b>VP8_TUNE_SSIM</b>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">VP8 model tuning parameters. <a href="group__vp8__encoder.html#ga371dbc29054b3d46364af996ad42ab94">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="member-group"></a>
Algorithm interface for VP8</h2></td></tr>
<tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrp0b829b38ff2e659173b35cd78e0735bd"></a> This interface provides the capability to encode raw VP8 streams, as would be found in AVI files. </p>
</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga689ede372ab835c8e1c9631f17b47eb5"></a><!-- doxytag: member="vp8_encoder::vpx_codec_vp8_cx_algo" ref="ga689ede372ab835c8e1c9631f17b47eb5" args="" -->
<a class="el" href="group__codec.html#gad654f3da60151f5dfef70aca00ef1e9e">vpx_codec_iface_t</a> </td><td class="memItemRight" valign="bottom"><b>vpx_codec_vp8_cx_algo</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1b5362d0d5b5a2d50f173f9c160fad9f"></a><!-- doxytag: member="vp8_encoder::vpx_codec_vp8_cx" ref="ga1b5362d0d5b5a2d50f173f9c160fad9f" args="(void)" -->
<a class="el" href="group__codec.html#gad654f3da60151f5dfef70aca00ef1e9e">vpx_codec_iface_t</a> * </td><td class="memItemRight" valign="bottom"><b>vpx_codec_vp8_cx</b> (void)</td></tr>
</table>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="gafb51c67e5743275146bc1fc425727da3"></a><!-- doxytag: member="vp8cx.h::VP8_EFLAG_NO_REF_LAST" ref="gafb51c67e5743275146bc1fc425727da3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define VP8_EFLAG_NO_REF_LAST   (1<<16)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Don't reference the last frame. </p>
<p>When this flag is set, the encoder will not use the last frame as a predictor. When not set, the encoder will choose whether to use the last frame or not automatically. </p>
</div>
</div>
<a class="anchor" id="gabb5e95343a2738abef44eca13059da33"></a><!-- doxytag: member="vp8cx.h::VP8_EFLAG_NO_REF_GF" ref="gabb5e95343a2738abef44eca13059da33" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define VP8_EFLAG_NO_REF_GF   (1<<17)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Don't reference the golden frame. </p>
<p>When this flag is set, the encoder will not use the golden frame as a predictor. When not set, the encoder will choose whether to use the golden frame or not automatically. </p>
</div>
</div>
<a class="anchor" id="ga650ab0baea12be91082226a5cc18776a"></a><!-- doxytag: member="vp8cx.h::VP8_EFLAG_NO_REF_ARF" ref="ga650ab0baea12be91082226a5cc18776a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define VP8_EFLAG_NO_REF_ARF   (1<<21)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Don't reference the alternate reference frame. </p>
<p>When this flag is set, the encoder will not use the alt ref frame as a predictor. When not set, the encoder will choose whether to use the alt ref frame or not automatically. </p>
</div>
</div>
<a class="anchor" id="ga602edb6b02a89cb2db7a16d6dffba583"></a><!-- doxytag: member="vp8cx.h::VP8_EFLAG_NO_UPD_LAST" ref="ga602edb6b02a89cb2db7a16d6dffba583" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define VP8_EFLAG_NO_UPD_LAST   (1<<18)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Don't update the last frame. </p>
<p>When this flag is set, the encoder will not update the last frame with the contents of the current frame. </p>
</div>
</div>
<a class="anchor" id="gab01d066c5236457d345ce1cab4c41d6b"></a><!-- doxytag: member="vp8cx.h::VP8_EFLAG_NO_UPD_GF" ref="gab01d066c5236457d345ce1cab4c41d6b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define VP8_EFLAG_NO_UPD_GF   (1<<22)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Don't update the golden frame. </p>
<p>When this flag is set, the encoder will not update the golden frame with the contents of the current frame. </p>
</div>
</div>
<a class="anchor" id="ga1cff46a5287e73a620660030d40b9e6c"></a><!-- doxytag: member="vp8cx.h::VP8_EFLAG_NO_UPD_ARF" ref="ga1cff46a5287e73a620660030d40b9e6c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define VP8_EFLAG_NO_UPD_ARF   (1<<23)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Don't update the alternate reference frame. </p>
<p>When this flag is set, the encoder will not update the alt ref frame with the contents of the current frame. </p>
</div>
</div>
<a class="anchor" id="gacb64c00adcb361f72a9a3028eb12f5ff"></a><!-- doxytag: member="vp8cx.h::VP8_EFLAG_FORCE_GF" ref="gacb64c00adcb361f72a9a3028eb12f5ff" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define VP8_EFLAG_FORCE_GF   (1<<19)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Force golden frame update. </p>
<p>When this flag is set, the encoder copy the contents of the current frame to the golden frame buffer. </p>
</div>
</div>
<a class="anchor" id="ga50584fe4bdb62ff935347576539650b7"></a><!-- doxytag: member="vp8cx.h::VP8_EFLAG_FORCE_ARF" ref="ga50584fe4bdb62ff935347576539650b7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define VP8_EFLAG_FORCE_ARF   (1<<24)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Force alternate reference frame update. </p>
<p>When this flag is set, the encoder copy the contents of the current frame to the alternate reference frame buffer. </p>
</div>
</div>
<a class="anchor" id="ga5b91ad179910d4efc23aef66c7b2148b"></a><!-- doxytag: member="vp8cx.h::VP8_EFLAG_NO_UPD_ENTROPY" ref="ga5b91ad179910d4efc23aef66c7b2148b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define VP8_EFLAG_NO_UPD_ENTROPY   (1<<20)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Disable entropy update. </p>
<p>When this flag is set, the encoder will not update its internal entropy model based on the entropy of this frame. </p>
</div>
</div>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="ga100ca891ad96995e61780ae777bf8663"></a><!-- doxytag: member="vp8cx.h::VPX_SCALING_MODE" ref="ga100ca891ad96995e61780ae777bf8663" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="group__vp8__encoder.html#ga70071b1bb6cac9a1ef0ea3d8362ff94f">vpx_scaling_mode_1d</a> <a class="el" href="group__vp8__encoder.html#ga100ca891ad96995e61780ae777bf8663">VPX_SCALING_MODE</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>vpx 1-D scaling mode </p>
<p>This set of constants define 1-D vpx scaling modes </p>
</div>
</div>
<a class="anchor" id="ga5be1a94d436a5e9296f5be06f57ccbd1"></a><!-- doxytag: member="vp8cx.h::vpx_roi_map_t" ref="ga5be1a94d436a5e9296f5be06f57ccbd1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structvpx__roi__map.html">vpx_roi_map</a> <a class="el" href="structvpx__roi__map.html">vpx_roi_map_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>vpx region of interest map </p>
<p>These defines the data structures for the region of interest map </p>
</div>
</div>
<a class="anchor" id="ga7b48f7962f5061979f0f8ece6fb1cba8"></a><!-- doxytag: member="vp8cx.h::vpx_active_map_t" ref="ga7b48f7962f5061979f0f8ece6fb1cba8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structvpx__active__map.html">vpx_active_map</a> <a class="el" href="structvpx__active__map.html">vpx_active_map_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>vpx active region map </p>
<p>These defines the data structures for active region map </p>
</div>
</div>
<a class="anchor" id="ga9600359ed9096cd96c621d9cf6c8df38"></a><!-- doxytag: member="vp8cx.h::vpx_scaling_mode_t" ref="ga9600359ed9096cd96c621d9cf6c8df38" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structvpx__scaling__mode.html">vpx_scaling_mode</a> <a class="el" href="structvpx__scaling__mode.html">vpx_scaling_mode_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>vpx image scaling mode </p>
<p>This defines the data structure for image scaling mode </p>
</div>
</div>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="ga6deae3d561c838952552c3d3756322ec"></a><!-- doxytag: member="vp8cx.h::vp8e_enc_control_id" ref="ga6deae3d561c838952552c3d3756322ec" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__vp8__encoder.html#ga6deae3d561c838952552c3d3756322ec">vp8e_enc_control_id</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>VP8 encoder control functions. </p>
<p>This set of macros define the control functions available for the VP8 encoder interface.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__codec.html#gac1b91e04698c1bd4c0a2b8aa85b08cd2" title="vpx_codec_control wrapper macro">vpx_codec_control</a> </dd></dl>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="gga6deae3d561c838952552c3d3756322eca79463ec67bb7c282ffd090622f2a46e4"></a><!-- doxytag: member="VP8E_UPD_ENTROPY" ref="gga6deae3d561c838952552c3d3756322eca79463ec67bb7c282ffd090622f2a46e4" args="" -->VP8E_UPD_ENTROPY</em> </td><td>
<p>control function to set mode of entropy update in encoder </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga6deae3d561c838952552c3d3756322eca140d031294fb8c36252c802e8328c1f4"></a><!-- doxytag: member="VP8E_UPD_REFERENCE" ref="gga6deae3d561c838952552c3d3756322eca140d031294fb8c36252c802e8328c1f4" args="" -->VP8E_UPD_REFERENCE</em> </td><td>
<p>control function to set reference update mode in encoder </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga6deae3d561c838952552c3d3756322eca5bb579ead6122fafbf4a8838aa5c221e"></a><!-- doxytag: member="VP8E_USE_REFERENCE" ref="gga6deae3d561c838952552c3d3756322eca5bb579ead6122fafbf4a8838aa5c221e" args="" -->VP8E_USE_REFERENCE</em> </td><td>
<p>control function to set which reference frame encoder can use </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga6deae3d561c838952552c3d3756322eca25a828dbab350f80db769a8f53e3940f"></a><!-- doxytag: member="VP8E_SET_ROI_MAP" ref="gga6deae3d561c838952552c3d3756322eca25a828dbab350f80db769a8f53e3940f" args="" -->VP8E_SET_ROI_MAP</em> </td><td>
<p>control function to pass an ROI map to encoder </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga6deae3d561c838952552c3d3756322eca6c904eb7e9e4aa58052742b56f1b4497"></a><!-- doxytag: member="VP8E_SET_ACTIVEMAP" ref="gga6deae3d561c838952552c3d3756322eca6c904eb7e9e4aa58052742b56f1b4497" args="" -->VP8E_SET_ACTIVEMAP</em> </td><td>
<p>control function to pass an Active map to encoder </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga6deae3d561c838952552c3d3756322eca7a6db9fd1c434d2e4d91b3935777ab9f"></a><!-- doxytag: member="VP8E_SET_SCALEMODE" ref="gga6deae3d561c838952552c3d3756322eca7a6db9fd1c434d2e4d91b3935777ab9f" args="" -->VP8E_SET_SCALEMODE</em> </td><td>
<p>control function to set encoder scaling mode </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga6deae3d561c838952552c3d3756322eca953ff0eaa2fcdc2ecd627e449b026853"></a><!-- doxytag: member="VP8E_SET_CPUUSED" ref="gga6deae3d561c838952552c3d3756322eca953ff0eaa2fcdc2ecd627e449b026853" args="" -->VP8E_SET_CPUUSED</em> </td><td>
<p>control function to set vp8 encoder cpuused </p>
<p>Changes in this value influences, among others, the encoder's selection of motion estimation methods. Values greater than 0 will increase encoder speed at the expense of quality. The full set of adjustments can be found in onyx_if.c:vp8_set_speed_features(). </p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>List highlights of the changes at various levels.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Valid range: -16..16 </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga6deae3d561c838952552c3d3756322eca24a5530efabb8b4949d01622b1d72cb0"></a><!-- doxytag: member="VP8E_SET_ENABLEAUTOALTREF" ref="gga6deae3d561c838952552c3d3756322eca24a5530efabb8b4949d01622b1d72cb0" args="" -->VP8E_SET_ENABLEAUTOALTREF</em> </td><td>
<p>control function to enable vp8 to automatic set and use altref frame </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga6deae3d561c838952552c3d3756322eca3fa90cb70bade72af3c2d8d91471a36c"></a><!-- doxytag: member="VP8E_SET_NOISE_SENSITIVITY" ref="gga6deae3d561c838952552c3d3756322eca3fa90cb70bade72af3c2d8d91471a36c" args="" -->VP8E_SET_NOISE_SENSITIVITY</em> </td><td>
<p>control function to set noise sensitivity </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga6deae3d561c838952552c3d3756322eca815930923fff388825ee3cc4ef69bb28"></a><!-- doxytag: member="VP8E_SET_SHARPNESS" ref="gga6deae3d561c838952552c3d3756322eca815930923fff388825ee3cc4ef69bb28" args="" -->VP8E_SET_SHARPNESS</em> </td><td>
<p>control function to set sharpness </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga6deae3d561c838952552c3d3756322ecab34559df04d3d662616300ed0682dcfd"></a><!-- doxytag: member="VP8E_SET_STATIC_THRESHOLD" ref="gga6deae3d561c838952552c3d3756322ecab34559df04d3d662616300ed0682dcfd" args="" -->VP8E_SET_STATIC_THRESHOLD</em> </td><td>
<p>control function to set the threshold for macroblocks treated static </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga6deae3d561c838952552c3d3756322eca462a4f14f39a6eb5c4a4004fc8d0ad75"></a><!-- doxytag: member="VP8E_SET_TOKEN_PARTITIONS" ref="gga6deae3d561c838952552c3d3756322eca462a4f14f39a6eb5c4a4004fc8d0ad75" args="" -->VP8E_SET_TOKEN_PARTITIONS</em> </td><td>
<p>control function to set the number of token partitions </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga6deae3d561c838952552c3d3756322eca5bb0569b813853e981a61c97697cbecd"></a><!-- doxytag: member="VP8E_GET_LAST_QUANTIZER" ref="gga6deae3d561c838952552c3d3756322eca5bb0569b813853e981a61c97697cbecd" args="" -->VP8E_GET_LAST_QUANTIZER</em> </td><td>
<p>return the quantizer chosen by the encoder for the last frame using the internal scale </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga6deae3d561c838952552c3d3756322ecad2cfc9712d2eab30b5a59a60d0daaade"></a><!-- doxytag: member="VP8E_GET_LAST_QUANTIZER_64" ref="gga6deae3d561c838952552c3d3756322ecad2cfc9712d2eab30b5a59a60d0daaade" args="" -->VP8E_GET_LAST_QUANTIZER_64</em> </td><td>
<p>return the quantizer chosen by the encoder for the last frame, using the 0..63 scale as used by the rc_*_quantizer config parameters </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga6deae3d561c838952552c3d3756322eca628d73f1a69fadd8aa57e0dfef578da8"></a><!-- doxytag: member="VP8E_SET_ARNR_MAXFRAMES" ref="gga6deae3d561c838952552c3d3756322eca628d73f1a69fadd8aa57e0dfef578da8" args="" -->VP8E_SET_ARNR_MAXFRAMES</em> </td><td>
<p>control function to set the max number of frames blurred creating arf </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga6deae3d561c838952552c3d3756322eca0a8c40a768af935ae73faa53355c3244"></a><!-- doxytag: member="VP8E_SET_ARNR_STRENGTH" ref="gga6deae3d561c838952552c3d3756322eca0a8c40a768af935ae73faa53355c3244" args="" -->VP8E_SET_ARNR_STRENGTH</em> </td><td>
<p>control function to set the filter strength for the arf </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga6deae3d561c838952552c3d3756322eca4e0a0af58670012026c213083cd48f3a"></a><!-- doxytag: member="VP8E_SET_ARNR_TYPE" ref="gga6deae3d561c838952552c3d3756322eca4e0a0af58670012026c213083cd48f3a" args="" -->VP8E_SET_ARNR_TYPE</em> </td><td>
<p>control function to set the type of filter to use for the arf </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga6deae3d561c838952552c3d3756322eca126ccbe7bde63b59cec5ea68a82dd498"></a><!-- doxytag: member="VP8E_SET_TUNING" ref="gga6deae3d561c838952552c3d3756322eca126ccbe7bde63b59cec5ea68a82dd498" args="" -->VP8E_SET_TUNING</em> </td><td>
<p>control function to set visual tuning </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga6deae3d561c838952552c3d3756322ecacd4f5b730bddb9788c3d0b82218ec503"></a><!-- doxytag: member="VP8E_SET_CQ_LEVEL" ref="gga6deae3d561c838952552c3d3756322ecacd4f5b730bddb9788c3d0b82218ec503" args="" -->VP8E_SET_CQ_LEVEL</em> </td><td>
<p>control function to set constrained quality level </p>
<dl class="attention"><dt><b>Attention:</b></dt><dd>For this value to be used <a class="el" href="structvpx__codec__enc__cfg.html#a5bcf7fc1efc4890de351e3c6fe252355" title="Algorithm specific "usage" value.">vpx_codec_enc_cfg_t::g_usage</a> must be set to <a class="el" href="group__encoder.html#ggaf50e74d91be4cae6f70dfeba5b7410d2a5f2fd02b55c67d62bfd79380bcb03f63">VPX_CQ</a>. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Valid range: 0..63 </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga6deae3d561c838952552c3d3756322eca09c69ff4a3aabdb307d4f24027dfc4c1"></a><!-- doxytag: member="VP8E_SET_MAX_INTRA_BITRATE_PCT" ref="gga6deae3d561c838952552c3d3756322eca09c69ff4a3aabdb307d4f24027dfc4c1" args="" -->VP8E_SET_MAX_INTRA_BITRATE_PCT</em> </td><td>
<p>Max data rate for Intra frames. </p>
<p>This value controls additional clamping on the maximum size of a keyframe. It is expressed as a percentage of the average per-frame bitrate, with the special (and default) value 0 meaning unlimited, or no additional clamping beyond the codec's built-in algorithm.</p>
<p>For example, to allocate no more than 4.5 frames worth of bitrate to a keyframe, set this to 450. </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga70071b1bb6cac9a1ef0ea3d8362ff94f"></a><!-- doxytag: member="vp8cx.h::vpx_scaling_mode_1d" ref="ga70071b1bb6cac9a1ef0ea3d8362ff94f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__vp8__encoder.html#ga70071b1bb6cac9a1ef0ea3d8362ff94f">vpx_scaling_mode_1d</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>vpx 1-D scaling mode </p>
<p>This set of constants define 1-D vpx scaling modes </p>
</div>
</div>
<a class="anchor" id="ga57a092f46c3afa879c237f775d4f51dd"></a><!-- doxytag: member="vp8cx.h::vp8e_encoding_mode" ref="ga57a092f46c3afa879c237f775d4f51dd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__vp8__encoder.html#ga57a092f46c3afa879c237f775d4f51dd">vp8e_encoding_mode</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>VP8 encoding mode. </p>
<p>This defines VP8 encoding mode </p>
</div>
</div>
<a class="anchor" id="ga5f7508ba3fb453b47f62313ed0b864d2"></a><!-- doxytag: member="vp8cx.h::vp8e_token_partitions" ref="ga5f7508ba3fb453b47f62313ed0b864d2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__vp8__encoder.html#ga5f7508ba3fb453b47f62313ed0b864d2">vp8e_token_partitions</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>VP8 token partition mode. </p>
<p>This defines VP8 partitioning mode for compressed data, i.e., the number of sub-streams in the bitstream. Used for parallelized decoding. </p>
</div>
</div>
<a class="anchor" id="ga371dbc29054b3d46364af996ad42ab94"></a><!-- doxytag: member="vp8cx.h::vp8e_tuning" ref="ga371dbc29054b3d46364af996ad42ab94" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__vp8__encoder.html#ga371dbc29054b3d46364af996ad42ab94">vp8e_tuning</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>VP8 model tuning parameters. </p>
<p>Changes the encoder to tune for certain types of input material. </p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon Jan 30 2012 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>
