<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>WebM VP8 Codec SDK: VP8</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<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>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
<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><!-- top -->
<div class="header">
<div class="summary">
<a href="#groups">Modules</a> |
<a href="#files">Files</a> |
<a href="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">VP8<div class="ingroups"><a class="el" href="group__codecs.html">Supported Codecs</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group__vp8__encoder"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vp8__encoder.html">WebM VP8 Encoder</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__vp8__decoder"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vp8__decoder.html">WebM VP8 Decoder</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a>
Files</h2></td></tr>
<tr class="memitem:vp8_8h"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="vp8_8h.html">vp8.h</a></td></tr>
<tr class="memdesc:vp8_8h"><td class="mdescLeft"> </td><td class="mdescRight">Provides controls common to both the VP8 encoder and decoder. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structvp8__postproc__cfg.html">vp8_postproc_cfg</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">post process flags <a href="structvp8__postproc__cfg.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structvpx__ref__frame.html">vpx_ref_frame</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">reference frame data struct <a href="structvpx__ref__frame.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga7e9e955211711b2f915bc59640cc0ef0"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structvp8__postproc__cfg.html">vp8_postproc_cfg</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vp8.html#ga7e9e955211711b2f915bc59640cc0ef0">vp8_postproc_cfg_t</a></td></tr>
<tr class="memdesc:ga7e9e955211711b2f915bc59640cc0ef0"><td class="mdescLeft"> </td><td class="mdescRight">post process flags <a href="#ga7e9e955211711b2f915bc59640cc0ef0"></a><br/></td></tr>
<tr class="separator:ga7e9e955211711b2f915bc59640cc0ef0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga75ac0689a81bf7202382a225c5b451b4"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__vp8.html#gad8ab72d8a178a68339dad2987358c331">vpx_ref_frame_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vp8.html#ga75ac0689a81bf7202382a225c5b451b4">vpx_ref_frame_type_t</a></td></tr>
<tr class="memdesc:ga75ac0689a81bf7202382a225c5b451b4"><td class="mdescLeft"> </td><td class="mdescRight">reference frame type <a href="#ga75ac0689a81bf7202382a225c5b451b4"></a><br/></td></tr>
<tr class="separator:ga75ac0689a81bf7202382a225c5b451b4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9157c53799cdafd12ebee65d04e16825"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structvpx__ref__frame.html">vpx_ref_frame</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vp8.html#ga9157c53799cdafd12ebee65d04e16825">vpx_ref_frame_t</a></td></tr>
<tr class="memdesc:ga9157c53799cdafd12ebee65d04e16825"><td class="mdescLeft"> </td><td class="mdescRight">reference frame data struct <a href="#ga9157c53799cdafd12ebee65d04e16825"></a><br/></td></tr>
<tr class="separator:ga9157c53799cdafd12ebee65d04e16825"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga8cadbc8e0af3da96ef7a2dbd4ed06599"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vp8.html#ga8cadbc8e0af3da96ef7a2dbd4ed06599">vp8_com_control_id</a> { <br/>
  <a class="el" href="group__vp8.html#gga8cadbc8e0af3da96ef7a2dbd4ed06599a7abc38d739a5ef49c36d9b2cd88e64a6">VP8_SET_REFERENCE</a> = 1,
<a class="el" href="group__vp8.html#gga8cadbc8e0af3da96ef7a2dbd4ed06599a5375b3ea3a4867d50daee6f5971c7470">VP8_COPY_REFERENCE</a> = 2,
<a class="el" href="group__vp8.html#gga8cadbc8e0af3da96ef7a2dbd4ed06599a43e85c68bc1c1473f4a94b005a59482c">VP8_SET_POSTPROC</a> = 3,
<a class="el" href="group__vp8.html#gga8cadbc8e0af3da96ef7a2dbd4ed06599ab52ea7a97668b603812dfc205b0fd783">VP8_SET_DBG_COLOR_REF_FRAME</a> = 4,
<br/>
  <a class="el" href="group__vp8.html#gga8cadbc8e0af3da96ef7a2dbd4ed06599aa0d5c3eaa7cbecaf64403edc8450b060">VP8_SET_DBG_COLOR_MB_MODES</a> = 5,
<a class="el" href="group__vp8.html#gga8cadbc8e0af3da96ef7a2dbd4ed06599ae0052b9dd3c64a4bb822abafb4755a87">VP8_SET_DBG_COLOR_B_MODES</a> = 6,
<a class="el" href="group__vp8.html#gga8cadbc8e0af3da96ef7a2dbd4ed06599abc6aef0d7e0486d25348de217ad8441d">VP8_SET_DBG_DISPLAY_MV</a> = 7,
<b>VP8_COMMON_CTRL_ID_MAX</b>,
<br/>
  <b>VP8_DECODER_CTRL_ID_START</b> = 256
<br/>
}</td></tr>
<tr class="memdesc:ga8cadbc8e0af3da96ef7a2dbd4ed06599"><td class="mdescLeft"> </td><td class="mdescRight">Control functions. <a href="group__vp8.html#ga8cadbc8e0af3da96ef7a2dbd4ed06599">More...</a><br/></td></tr>
<tr class="separator:ga8cadbc8e0af3da96ef7a2dbd4ed06599"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga99557e20eb37826e6792cd8819121770"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vp8.html#ga99557e20eb37826e6792cd8819121770">vp8_postproc_level</a> { <br/>
  <b>VP8_NOFILTERING</b> = 0,
<b>VP8_DEBLOCK</b> = 1<<0,
<b>VP8_DEMACROBLOCK</b> = 1<<1,
<b>VP8_ADDNOISE</b> = 1<<2,
<br/>
  <a class="el" href="group__vp8.html#gga99557e20eb37826e6792cd8819121770ab52568f51e409f219744e06b446102bb">VP8_DEBUG_TXT_FRAME_INFO</a> = 1<<3,
<a class="el" href="group__vp8.html#gga99557e20eb37826e6792cd8819121770a9e3fd9032d2556918d0f6d0d1ef46d14">VP8_DEBUG_TXT_MBLK_MODES</a> = 1<<4,
<a class="el" href="group__vp8.html#gga99557e20eb37826e6792cd8819121770acc0405eaa19b1ed01fb40945cfce4d12">VP8_DEBUG_TXT_DC_DIFF</a> = 1<<5,
<a class="el" href="group__vp8.html#gga99557e20eb37826e6792cd8819121770aff0413e7978a7cf8915b8341373751b5">VP8_DEBUG_TXT_RATE_INFO</a> = 1<<6,
<br/>
  <b>VP8_MFQE</b> = 1<<10
<br/>
}</td></tr>
<tr class="memdesc:ga99557e20eb37826e6792cd8819121770"><td class="mdescLeft"> </td><td class="mdescRight">post process flags <a href="group__vp8.html#ga99557e20eb37826e6792cd8819121770">More...</a><br/></td></tr>
<tr class="separator:ga99557e20eb37826e6792cd8819121770"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad8ab72d8a178a68339dad2987358c331"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vp8.html#gad8ab72d8a178a68339dad2987358c331">vpx_ref_frame_type</a> { <b>VP8_LAST_FRAME</b> = 1,
<b>VP8_GOLD_FRAME</b> = 2,
<b>VP8_ALTR_FRAME</b> = 4
}</td></tr>
<tr class="memdesc:gad8ab72d8a178a68339dad2987358c331"><td class="mdescLeft"> </td><td class="mdescRight">reference frame type <a href="group__vp8.html#gad8ab72d8a178a68339dad2987358c331">More...</a><br/></td></tr>
<tr class="separator:gad8ab72d8a178a68339dad2987358c331"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>VP8 is vpx's newest video compression algorithm that uses motion compensated prediction, Discrete Cosine Transform (DCT) coding of the prediction error signal and context dependent entropy coding techniques based on arithmetic principles. It features:</p>
<ul>
<li>YUV 4:2:0 image format</li>
<li>Macro-block based coding (16x16 luma plus two 8x8 chroma)</li>
<li>1/4 (1/8) pixel accuracy motion compensated prediction</li>
<li>4x4 DCT transform</li>
<li>128 level linear quantizer</li>
<li>In loop deblocking filter</li>
<li>Context-based entropy coding </li>
</ul>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga7e9e955211711b2f915bc59640cc0ef0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structvp8__postproc__cfg.html">vp8_postproc_cfg</a> <a class="el" href="group__vp8.html#ga7e9e955211711b2f915bc59640cc0ef0">vp8_postproc_cfg_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>post process flags </p>
<p>This define a structure that describe the post processing settings. For the best objective measure (using the PSNR metric) set post_proc_flag to VP8_DEBLOCK and deblocking_level to 1. </p>
</div>
</div>
<a class="anchor" id="ga75ac0689a81bf7202382a225c5b451b4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="group__vp8.html#gad8ab72d8a178a68339dad2987358c331">vpx_ref_frame_type</a> <a class="el" href="group__vp8.html#ga75ac0689a81bf7202382a225c5b451b4">vpx_ref_frame_type_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>reference frame type </p>
<p>The set of macros define the type of VP8 reference frames </p>
</div>
</div>
<a class="anchor" id="ga9157c53799cdafd12ebee65d04e16825"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structvpx__ref__frame.html">vpx_ref_frame</a> <a class="el" href="group__vp8.html#ga9157c53799cdafd12ebee65d04e16825">vpx_ref_frame_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>reference frame data struct </p>
<p>define the data struct to access vp8 reference frames </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga8cadbc8e0af3da96ef7a2dbd4ed06599"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__vp8.html#ga8cadbc8e0af3da96ef7a2dbd4ed06599">vp8_com_control_id</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Control functions. </p>
<p>The set of macros define the control functions of VP8 interface </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga8cadbc8e0af3da96ef7a2dbd4ed06599a7abc38d739a5ef49c36d9b2cd88e64a6"></a>VP8_SET_REFERENCE</em> </td><td class="fielddoc">
<p>pass in an external frame into decoder to be used as reference frame </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga8cadbc8e0af3da96ef7a2dbd4ed06599a5375b3ea3a4867d50daee6f5971c7470"></a>VP8_COPY_REFERENCE</em> </td><td class="fielddoc">
<p>get a copy of reference frame from the decoder </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga8cadbc8e0af3da96ef7a2dbd4ed06599a43e85c68bc1c1473f4a94b005a59482c"></a>VP8_SET_POSTPROC</em> </td><td class="fielddoc">
<p>set the decoder's post processing settings </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga8cadbc8e0af3da96ef7a2dbd4ed06599ab52ea7a97668b603812dfc205b0fd783"></a>VP8_SET_DBG_COLOR_REF_FRAME</em> </td><td class="fielddoc">
<p>set the reference frames to color for each macroblock </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga8cadbc8e0af3da96ef7a2dbd4ed06599aa0d5c3eaa7cbecaf64403edc8450b060"></a>VP8_SET_DBG_COLOR_MB_MODES</em> </td><td class="fielddoc">
<p>set which macro block modes to color </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga8cadbc8e0af3da96ef7a2dbd4ed06599ae0052b9dd3c64a4bb822abafb4755a87"></a>VP8_SET_DBG_COLOR_B_MODES</em> </td><td class="fielddoc">
<p>set which blocks modes to color </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga8cadbc8e0af3da96ef7a2dbd4ed06599abc6aef0d7e0486d25348de217ad8441d"></a>VP8_SET_DBG_DISPLAY_MV</em> </td><td class="fielddoc">
<p>set which motion vector modes to draw </p>
</td></tr>
</table>
</div>
</div>
<a class="anchor" id="ga99557e20eb37826e6792cd8819121770"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__vp8.html#ga99557e20eb37826e6792cd8819121770">vp8_postproc_level</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>post process flags </p>
<p>The set of macros define VP8 decoder post processing flags </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga99557e20eb37826e6792cd8819121770ab52568f51e409f219744e06b446102bb"></a>VP8_DEBUG_TXT_FRAME_INFO</em> </td><td class="fielddoc">
<p>print frame information </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga99557e20eb37826e6792cd8819121770a9e3fd9032d2556918d0f6d0d1ef46d14"></a>VP8_DEBUG_TXT_MBLK_MODES</em> </td><td class="fielddoc">
<p>print macro block modes over each macro block </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga99557e20eb37826e6792cd8819121770acc0405eaa19b1ed01fb40945cfce4d12"></a>VP8_DEBUG_TXT_DC_DIFF</em> </td><td class="fielddoc">
<p>print dc diff for each macro block </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga99557e20eb37826e6792cd8819121770aff0413e7978a7cf8915b8341373751b5"></a>VP8_DEBUG_TXT_RATE_INFO</em> </td><td class="fielddoc">
<p>print video rate info (encoder only) </p>
</td></tr>
</table>
</div>
</div>
<a class="anchor" id="gad8ab72d8a178a68339dad2987358c331"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__vp8.html#gad8ab72d8a178a68339dad2987358c331">vpx_ref_frame_type</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>reference frame type </p>
<p>The set of macros define the type of VP8 reference frames </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3
</small></address>
</body>
</html>
