shaka-packager/docs/d8/d14/classshaka_1_1media_1_1VP8P...

222 lines
12 KiB
HTML
Raw Normal View History

<!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"/>
2018-02-10 23:37:42 +00:00
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Shaka Packager SDK: shaka::media::VP8Parser Class Reference</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="../../search/search.css" rel="stylesheet" type="text/css"/>
2018-02-10 23:37:42 +00:00
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.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;">
2018-02-10 23:37:42 +00:00
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Shaka Packager SDK
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
2018-02-10 23:37:42 +00:00
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
2018-02-10 23:37:42 +00:00
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
2018-02-10 23:37:42 +00:00
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="../../d8/daf/namespaceshaka.html">shaka</a></li><li class="navelem"><b>media</b></li><li class="navelem"><a class="el" href="../../d8/d14/classshaka_1_1media_1_1VP8Parser.html">VP8Parser</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="../../de/d93/classshaka_1_1media_1_1VP8Parser-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::media::VP8Parser Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="../../dd/d65/vp8__parser_8h_source.html">vp8_parser.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for shaka::media::VP8Parser:</div>
<div class="dyncontent">
<div class="center">
<img src="../../d8/d14/classshaka_1_1media_1_1VP8Parser.png" usemap="#shaka::media::VP8Parser_map" alt=""/>
<map id="shaka::media::VP8Parser_map" name="shaka::media::VP8Parser_map">
<area href="../../db/dcb/classshaka_1_1media_1_1VPxParser.html" alt="shaka::media::VPxParser" shape="rect" coords="0,0,152,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a8baec0e4c74b0b220b777426d0c463e1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d14/classshaka_1_1media_1_1VP8Parser.html#a8baec0e4c74b0b220b777426d0c463e1">Parse</a> (const uint8_t *data, size_t data_size, std::vector&lt; <a class="el" href="../../d0/d11/structshaka_1_1media_1_1VPxFrameInfo.html">VPxFrameInfo</a> &gt; *vpx_frames) override</td></tr>
<tr class="separator:a8baec0e4c74b0b220b777426d0c463e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classshaka_1_1media_1_1VPxParser"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classshaka_1_1media_1_1VPxParser')"><img src="../../closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="../../db/dcb/classshaka_1_1media_1_1VPxParser.html">shaka::media::VPxParser</a></td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:a56513f4759d34201c9a5f86840811910 inherit pub_methods_classshaka_1_1media_1_1VPxParser"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="../../d1/da5/classshaka_1_1media_1_1VPCodecConfigurationRecord.html">VPCodecConfigurationRecord</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/dcb/classshaka_1_1media_1_1VPxParser.html#a56513f4759d34201c9a5f86840811910">codec_config</a> () const</td></tr>
<tr class="separator:a56513f4759d34201c9a5f86840811910 inherit pub_methods_classshaka_1_1media_1_1VPxParser"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:afae2dcb0c2652d53f2e23c9d3c07db37"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d14/classshaka_1_1media_1_1VP8Parser.html#afae2dcb0c2652d53f2e23c9d3c07db37">IsKeyframe</a> (const uint8_t *data, size_t data_size)</td></tr>
<tr class="separator:afae2dcb0c2652d53f2e23c9d3c07db37"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classshaka_1_1media_1_1VPxParser"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classshaka_1_1media_1_1VPxParser')"><img src="../../closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="../../db/dcb/classshaka_1_1media_1_1VPxParser.html">shaka::media::VPxParser</a></td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:ac7041e8837dc34e8bb5179804b2f2622 inherit pro_methods_classshaka_1_1media_1_1VPxParser"><td class="memItemLeft" align="right" valign="top"><a id="ac7041e8837dc34e8bb5179804b2f2622"></a>
<a class="el" href="../../d1/da5/classshaka_1_1media_1_1VPCodecConfigurationRecord.html">VPCodecConfigurationRecord</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>writable_codec_config</b> ()</td></tr>
<tr class="separator:ac7041e8837dc34e8bb5179804b2f2622 inherit pro_methods_classshaka_1_1media_1_1VPxParser"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class to parse a vp8 bit stream. Implemented according to <a href="https://tools.ietf.org/html/rfc6386">https://tools.ietf.org/html/rfc6386</a>. </p>
2018-02-10 23:37:42 +00:00
<p class="definition">Definition at line <a class="el" href="../../dd/d65/vp8__parser_8h_source.html#l00021">21</a> of file <a class="el" href="../../dd/d65/vp8__parser_8h_source.html">vp8_parser.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
2018-02-10 23:37:42 +00:00
<a id="afae2dcb0c2652d53f2e23c9d3c07db37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afae2dcb0c2652d53f2e23c9d3c07db37">&#9670;&nbsp;</a></span>IsKeyframe()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool shaka::media::VP8Parser::IsKeyframe </td>
<td>(</td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>data_size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
2018-02-10 23:37:42 +00:00
<p>A convenient utility function to check whether the frame is a keyframe. Note that this function does not do a full parse of the frame header, so should be more efficient than <a class="el" href="../../d8/d14/classshaka_1_1media_1_1VP8Parser.html#a8baec0e4c74b0b220b777426d0c463e1">Parse()</a>. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data_size</td><td>Size of the sample in bytes. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if it is, false if it is not or if there is parsing error. </dd></dl>
2018-02-10 23:37:42 +00:00
<p class="definition">Definition at line <a class="el" href="../../d1/d70/vp8__parser_8cc_source.html#l00179">179</a> of file <a class="el" href="../../d1/d70/vp8__parser_8cc_source.html">vp8_parser.cc</a>.</p>
</div>
</div>
2018-02-10 23:37:42 +00:00
<a id="a8baec0e4c74b0b220b777426d0c463e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8baec0e4c74b0b220b777426d0c463e1">&#9670;&nbsp;</a></span>Parse()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool shaka::media::VP8Parser::Parse </td>
<td>(</td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>data_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector&lt; <a class="el" href="../../d0/d11/structshaka_1_1media_1_1VPxFrameInfo.html">VPxFrameInfo</a> &gt; *&#160;</td>
<td class="paramname"><em>vpx_frames</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
2018-02-10 23:37:42 +00:00
<p>Parse <em>data</em> with size <em>data_size</em>. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">data_size</td><td>Size of the sample in bytes. Note that it should be a full sample. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">vpx_frames</td><td>points to the list of VPx frames for the current sample on success. Cannot be NULL. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true on success, false otherwise. </dd></dl>
<p>Implements <a class="el" href="../../db/dcb/classshaka_1_1media_1_1VPxParser.html#abb83c8c74d304e83efb8fa60bd7bb722">shaka::media::VPxParser</a>.</p>
2018-02-10 23:37:42 +00:00
<p class="definition">Definition at line <a class="el" href="../../d1/d70/vp8__parser_8cc_source.html#l00100">100</a> of file <a class="el" href="../../d1/d70/vp8__parser_8cc_source.html">vp8_parser.cc</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>packager/media/codecs/<a class="el" href="../../dd/d65/vp8__parser_8h_source.html">vp8_parser.h</a></li>
<li>packager/media/codecs/<a class="el" href="../../d1/d70/vp8__parser_8cc_source.html">vp8_parser.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Dec 20 2018 14:37:49 for Shaka Packager SDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
2018-02-10 23:37:42 +00:00
</a> 1.8.13
</small></address>
</body>
</html>