shaka-packager/docs/db/dcb/classshaka_1_1media_1_1VPxP...

196 lines
9.9 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Shaka Packager SDK: shaka::media::VPxParser 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"/>
<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;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Shaka Packager SDK
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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)">
</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="../../db/dcb/classshaka_1_1media_1_1VPxParser.html">VPxParser</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="../../d8/dee/classshaka_1_1media_1_1VPxParser-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::media::VPxParser Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for shaka::media::VPxParser:</div>
<div class="dyncontent">
<div class="center">
<img src="../../db/dcb/classshaka_1_1media_1_1VPxParser.png" usemap="#shaka::media::VPxParser_map" alt=""/>
<map id="shaka::media::VPxParser_map" name="shaka::media::VPxParser_map">
<area href="../../d8/d14/classshaka_1_1media_1_1VP8Parser.html" alt="shaka::media::VP8Parser" shape="rect" coords="0,56,152,80"/>
<area href="../../db/d5a/classshaka_1_1media_1_1VP9Parser.html" title="Class to parse a vp9 bit stream." alt="shaka::media::VP9Parser" shape="rect" coords="162,56,314,80"/>
</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:abb83c8c74d304e83efb8fa60bd7bb722"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/dcb/classshaka_1_1media_1_1VPxParser.html#abb83c8c74d304e83efb8fa60bd7bb722">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)=0</td></tr>
<tr class="separator:abb83c8c74d304e83efb8fa60bd7bb722"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56513f4759d34201c9a5f86840811910"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:ac7041e8837dc34e8bb5179804b2f2622"><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"><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="definition">Definition at line <a class="el" href="../../df/d8a/vpx__parser_8h_source.html#l00027">27</a> of file <a class="el" href="../../df/d8a/vpx__parser_8h_source.html">vpx_parser.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a56513f4759d34201c9a5f86840811910"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56513f4759d34201c9a5f86840811910">&#9670;&nbsp;</a></span>codec_config()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="../../d1/da5/classshaka_1_1media_1_1VPCodecConfigurationRecord.html">VPCodecConfigurationRecord</a>&amp; shaka::media::VPxParser::codec_config </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>VPx codec configuration extracted. Note that it is only valid after parsing a keyframe or intra frame successfully. </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../df/d8a/vpx__parser_8h_source.html#l00044">44</a> of file <a class="el" href="../../df/d8a/vpx__parser_8h_source.html">vpx_parser.h</a>.</p>
</div>
</div>
<a id="abb83c8c74d304e83efb8fa60bd7bb722"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb83c8c74d304e83efb8fa60bd7bb722">&#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">virtual bool shaka::media::VPxParser::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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<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>Implemented in <a class="el" href="../../d8/d14/classshaka_1_1media_1_1VP8Parser.html#a8baec0e4c74b0b220b777426d0c463e1">shaka::media::VP8Parser</a>, and <a class="el" href="../../db/d5a/classshaka_1_1media_1_1VP9Parser.html#ae915c36aa472d70b55e3d65b24612e57">shaka::media::VP9Parser</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>packager/media/codecs/<a class="el" href="../../df/d8a/vpx__parser_8h_source.html">vpx_parser.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jun 22 2021 00:16:06 for Shaka Packager SDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>