shaka-packager/docs/d1/dc2/classshaka_1_1media_1_1Deco...

342 lines
20 KiB
HTML

<!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.6"/>
<title>DASH Media Packaging SDK: shaka::media::DecoderConfiguration 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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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">DASH Media Packaging SDK
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="../../index.html"><span>Main&#160;Page</span></a></li>
<li><a href="../../namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="../../annotated.html"><span>Classes</span></a></li>
<li><a href="../../files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="../../search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="../../search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="../../annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="../../classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="../../hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="../../functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a></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="../../d1/dc2/classshaka_1_1media_1_1DecoderConfiguration.html">DecoderConfiguration</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="../../d9/d64/classshaka_1_1media_1_1DecoderConfiguration-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::media::DecoderConfiguration 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::DecoderConfiguration:</div>
<div class="dyncontent">
<div class="center">
<img src="../../d1/dc2/classshaka_1_1media_1_1DecoderConfiguration.png" usemap="#shaka::media::DecoderConfiguration_map" alt=""/>
<map id="shaka::media::DecoderConfiguration_map" name="shaka::media::DecoderConfiguration_map">
<area href="../../da/db1/classshaka_1_1media_1_1AVCDecoderConfiguration.html" title="Class for parsing AVC decoder configuration. " alt="shaka::media::AVCDecoderConfiguration" shape="rect" coords="0,56,250,80"/>
<area href="../../d8/d37/classshaka_1_1media_1_1HEVCDecoderConfiguration.html" title="Class for parsing HEVC decoder configuration. " alt="shaka::media::HEVCDecoderConfiguration" shape="rect" coords="260,56,510,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:a2d4f7d479e1aeaaec9b06b77649bf79f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc2/classshaka_1_1media_1_1DecoderConfiguration.html#a2d4f7d479e1aeaaec9b06b77649bf79f">Parse</a> (const std::vector&lt; uint8_t &gt; &amp;<a class="el" href="../../d1/dc2/classshaka_1_1media_1_1DecoderConfiguration.html#a3f60385e6d110c99f7ab2cd9deb4c405">data</a>)</td></tr>
<tr class="separator:a2d4f7d479e1aeaaec9b06b77649bf79f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9cc08b0b45ae8a52f0879a99ba0aad54"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc2/classshaka_1_1media_1_1DecoderConfiguration.html#a9cc08b0b45ae8a52f0879a99ba0aad54">Parse</a> (const uint8_t *<a class="el" href="../../d1/dc2/classshaka_1_1media_1_1DecoderConfiguration.html#a3f60385e6d110c99f7ab2cd9deb4c405">data</a>, size_t <a class="el" href="../../d1/dc2/classshaka_1_1media_1_1DecoderConfiguration.html#a77abdcb6303cdad9bf7556cbfbf59439">data_size</a>)</td></tr>
<tr class="separator:a9cc08b0b45ae8a52f0879a99ba0aad54"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3922486da206ad27f3a1086f833fc6a3"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc2/classshaka_1_1media_1_1DecoderConfiguration.html#a3922486da206ad27f3a1086f833fc6a3">nalu_length_size</a> () const </td></tr>
<tr class="separator:a3922486da206ad27f3a1086f833fc6a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9dc63eb017f63951a678e5ea3bd56450"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc2/classshaka_1_1media_1_1DecoderConfiguration.html#a9dc63eb017f63951a678e5ea3bd56450">nalu_count</a> () const </td></tr>
<tr class="separator:a9dc63eb017f63951a678e5ea3bd56450"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a887454519c30f1e4f744282497fd89ba"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="../../d6/dff/classshaka_1_1media_1_1Nalu.html">Nalu</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc2/classshaka_1_1media_1_1DecoderConfiguration.html#a887454519c30f1e4f744282497fd89ba">nalu</a> (size_t i) const </td></tr>
<tr class="separator:a887454519c30f1e4f744282497fd89ba"><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:a1ecb735e902238adf654d8fb71ab232a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1ecb735e902238adf654d8fb71ab232a"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc2/classshaka_1_1media_1_1DecoderConfiguration.html#a1ecb735e902238adf654d8fb71ab232a">AddNalu</a> (const <a class="el" href="../../d6/dff/classshaka_1_1media_1_1Nalu.html">Nalu</a> &amp;<a class="el" href="../../d1/dc2/classshaka_1_1media_1_1DecoderConfiguration.html#a887454519c30f1e4f744282497fd89ba">nalu</a>)</td></tr>
<tr class="memdesc:a1ecb735e902238adf654d8fb71ab232a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds the given <a class="el" href="../../d6/dff/classshaka_1_1media_1_1Nalu.html">Nalu</a> to the configuration. <br/></td></tr>
<tr class="separator:a1ecb735e902238adf654d8fb71ab232a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f60385e6d110c99f7ab2cd9deb4c405"><td class="memItemLeft" align="right" valign="top">const uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc2/classshaka_1_1media_1_1DecoderConfiguration.html#a3f60385e6d110c99f7ab2cd9deb4c405">data</a> () const </td></tr>
<tr class="separator:a3f60385e6d110c99f7ab2cd9deb4c405"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77abdcb6303cdad9bf7556cbfbf59439"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc2/classshaka_1_1media_1_1DecoderConfiguration.html#a77abdcb6303cdad9bf7556cbfbf59439">data_size</a> () const </td></tr>
<tr class="separator:a77abdcb6303cdad9bf7556cbfbf59439"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d6d390999983c7d335c22ecbe6bff9b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0d6d390999983c7d335c22ecbe6bff9b"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc2/classshaka_1_1media_1_1DecoderConfiguration.html#a0d6d390999983c7d335c22ecbe6bff9b">set_nalu_length_size</a> (uint8_t <a class="el" href="../../d1/dc2/classshaka_1_1media_1_1DecoderConfiguration.html#a3922486da206ad27f3a1086f833fc6a3">nalu_length_size</a>)</td></tr>
<tr class="memdesc:a0d6d390999983c7d335c22ecbe6bff9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the size of the NAL unit length field. <br/></td></tr>
<tr class="separator:a0d6d390999983c7d335c22ecbe6bff9b"><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>Definition at line <a class="el" href="../../d2/d09/decoder__configuration_8h_source.html#l00020">20</a> of file <a class="el" href="../../d2/d09/decoder__configuration_8h_source.html">decoder_configuration.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a3f60385e6d110c99f7ab2cd9deb4c405"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const uint8_t* shaka::media::DecoderConfiguration::data </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 class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>a pointer to the copy of the data. </dd></dl>
<p>Definition at line <a class="el" href="../../d2/d09/decoder__configuration_8h_source.html#l00053">53</a> of file <a class="el" href="../../d2/d09/decoder__configuration_8h_source.html">decoder_configuration.h</a>.</p>
</div>
</div>
<a class="anchor" id="a77abdcb6303cdad9bf7556cbfbf59439"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t shaka::media::DecoderConfiguration::data_size </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 class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the size of the copy of the data. </dd></dl>
<p>Definition at line <a class="el" href="../../d2/d09/decoder__configuration_8h_source.html#l00056">56</a> of file <a class="el" href="../../d2/d09/decoder__configuration_8h_source.html">decoder_configuration.h</a>.</p>
</div>
</div>
<a class="anchor" id="a887454519c30f1e4f744282497fd89ba"></a>
<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="../../d6/dff/classshaka_1_1media_1_1Nalu.html">Nalu</a>&amp; shaka::media::DecoderConfiguration::nalu </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>i</em></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>The nalu at the given index. The <a class="el" href="../../d6/dff/classshaka_1_1media_1_1Nalu.html">Nalu</a> is only valid for the lifetime of this object, even if copied. </dd></dl>
<p>Definition at line <a class="el" href="../../d2/d09/decoder__configuration_8h_source.html#l00044">44</a> of file <a class="el" href="../../d2/d09/decoder__configuration_8h_source.html">decoder_configuration.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9dc63eb017f63951a678e5ea3bd56450"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t shaka::media::DecoderConfiguration::nalu_count </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>The number of <a class="el" href="../../d6/dff/classshaka_1_1media_1_1Nalu.html">Nalu</a> in the configuration. </dd></dl>
<p>Definition at line <a class="el" href="../../d2/d09/decoder__configuration_8h_source.html#l00040">40</a> of file <a class="el" href="../../d2/d09/decoder__configuration_8h_source.html">decoder_configuration.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3922486da206ad27f3a1086f833fc6a3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t shaka::media::DecoderConfiguration::nalu_length_size </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>The size of the NAL unit length field. </dd></dl>
<p>Definition at line <a class="el" href="../../d2/d09/decoder__configuration_8h_source.html#l00037">37</a> of file <a class="el" href="../../d2/d09/decoder__configuration_8h_source.html">decoder_configuration.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2d4f7d479e1aeaaec9b06b77649bf79f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool shaka::media::DecoderConfiguration::Parse </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; uint8_t &gt; &amp;&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Parses input to extract decoder configuration data. This will make and store a copy of the data for <a class="el" href="../../d6/dff/classshaka_1_1media_1_1Nalu.html">Nalu</a> access. </p>
<dl class="section return"><dt>Returns</dt><dd>false if there are parsing errors. </dd></dl>
<p>Definition at line <a class="el" href="../../d2/d09/decoder__configuration_8h_source.html#l00027">27</a> of file <a class="el" href="../../d2/d09/decoder__configuration_8h_source.html">decoder_configuration.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9cc08b0b45ae8a52f0879a99ba0aad54"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool shaka::media::DecoderConfiguration::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>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Parses input to extract decoder configuration data. This will make and store a copy of the data for <a class="el" href="../../d6/dff/classshaka_1_1media_1_1Nalu.html">Nalu</a> access. </p>
<dl class="section return"><dt>Returns</dt><dd>false if there are parsing errors. </dd></dl>
<p>Definition at line <a class="el" href="../../da/d2c/decoder__configuration_8cc_source.html#l00015">15</a> of file <a class="el" href="../../da/d2c/decoder__configuration_8cc_source.html">decoder_configuration.cc</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>media/filters/<a class="el" href="../../d2/d09/decoder__configuration_8h_source.html">decoder_configuration.h</a></li>
<li>media/filters/<a class="el" href="../../da/d2c/decoder__configuration_8cc_source.html">decoder_configuration.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed May 25 2016 17:42:57 for DASH Media Packaging SDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>