shaka-packager/docs/d0/da2/classshaka_1_1media_1_1AACA...

338 lines
18 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::AACAudioSpecificConfig 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="../../d0/da2/classshaka_1_1media_1_1AACAudioSpecificConfig.html">AACAudioSpecificConfig</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-attribs">Static Public Attributes</a> &#124;
<a href="../../db/d84/classshaka_1_1media_1_1AACAudioSpecificConfig-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::media::AACAudioSpecificConfig Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="../../d2/d7e/aac__audio__specific__config_8h_source.html">aac_audio_specific_config.h</a>&gt;</code></p>
<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:a6b3deca725a42113bf7303387ab74f0f"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/da2/classshaka_1_1media_1_1AACAudioSpecificConfig.html#a6b3deca725a42113bf7303387ab74f0f">Parse</a> (const std::vector&lt; uint8_t &gt; &amp;data)</td></tr>
<tr class="separator:a6b3deca725a42113bf7303387ab74f0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af0ab71e8365a6a93c63badc3150fdacd"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/da2/classshaka_1_1media_1_1AACAudioSpecificConfig.html#af0ab71e8365a6a93c63badc3150fdacd">ConvertToADTS</a> (std::vector&lt; uint8_t &gt; *buffer) const </td></tr>
<tr class="separator:af0ab71e8365a6a93c63badc3150fdacd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e34ba8152e2c09452edcdd7e5eb1bcd"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/da2/classshaka_1_1media_1_1AACAudioSpecificConfig.html#a1e34ba8152e2c09452edcdd7e5eb1bcd">GetOutputSamplesPerSecond</a> (bool sbr_in_mimetype) const </td></tr>
<tr class="separator:a1e34ba8152e2c09452edcdd7e5eb1bcd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2bacb4e7337248bca9e678268e3db491"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/da2/classshaka_1_1media_1_1AACAudioSpecificConfig.html#a2bacb4e7337248bca9e678268e3db491">GetNumChannels</a> (bool sbr_in_mimetype) const </td></tr>
<tr class="separator:a2bacb4e7337248bca9e678268e3db491"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c89c8845d90d292fad38f8caf378a63"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/da2/classshaka_1_1media_1_1AACAudioSpecificConfig.html#a8c89c8845d90d292fad38f8caf378a63">audio_object_type</a> () const </td></tr>
<tr class="separator:a8c89c8845d90d292fad38f8caf378a63"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10f2acc7fcf3ec9de2fe3598c255786d"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/da2/classshaka_1_1media_1_1AACAudioSpecificConfig.html#a10f2acc7fcf3ec9de2fe3598c255786d">frequency</a> () const </td></tr>
<tr class="separator:a10f2acc7fcf3ec9de2fe3598c255786d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95cff00eb36af9b9932a80fd64e24eae"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/da2/classshaka_1_1media_1_1AACAudioSpecificConfig.html#a95cff00eb36af9b9932a80fd64e24eae">num_channels</a> () const </td></tr>
<tr class="separator:a95cff00eb36af9b9932a80fd64e24eae"><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-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a233ffcb063079b9ca34863c48d4a19e1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a233ffcb063079b9ca34863c48d4a19e1"></a>
static const size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/da2/classshaka_1_1media_1_1AACAudioSpecificConfig.html#a233ffcb063079b9ca34863c48d4a19e1">kADTSHeaderSize</a> = 7</td></tr>
<tr class="memdesc:a233ffcb063079b9ca34863c48d4a19e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size in bytes of the ADTS header added by ConvertEsdsToADTS(). <br/></td></tr>
<tr class="separator:a233ffcb063079b9ca34863c48d4a19e1"><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>This class parses the AAC information from decoder specific information embedded in the <b>esds</b> box in an ISO BMFF file. Please refer to ISO 14496 Part 3 Table 1.13 - Syntax of AudioSpecificConfig for more details. </p>
<p>Definition at line <a class="el" href="../../d2/d7e/aac__audio__specific__config_8h_source.html#l00023">23</a> of file <a class="el" href="../../d2/d7e/aac__audio__specific__config_8h_source.html">aac_audio_specific_config.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a8c89c8845d90d292fad38f8caf378a63"></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::AACAudioSpecificConfig::audio_object_type </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 audio object type for this AAC config. </dd></dl>
<p>Definition at line <a class="el" href="../../d2/d7e/aac__audio__specific__config_8h_source.html#l00054">54</a> of file <a class="el" href="../../d2/d7e/aac__audio__specific__config_8h_source.html">aac_audio_specific_config.h</a>.</p>
</div>
</div>
<a class="anchor" id="af0ab71e8365a6a93c63badc3150fdacd"></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::AACAudioSpecificConfig::ConvertToADTS </td>
<td>(</td>
<td class="paramtype">std::vector&lt; uint8_t &gt; *&#160;</td>
<td class="paramname"><em>buffer</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert a raw AAC frame into an AAC frame with an ADTS header. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">buffer</td><td>contains the raw AAC frame on input, and the converted frame on output if successful; it is untouched on failure. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true on success, false otherwise. </dd></dl>
<p>Definition at line <a class="el" href="../../d9/ded/aac__audio__specific__config_8cc_source.html#l00128">128</a> of file <a class="el" href="../../d9/ded/aac__audio__specific__config_8cc_source.html">aac_audio_specific_config.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a10f2acc7fcf3ec9de2fe3598c255786d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint32_t shaka::media::AACAudioSpecificConfig::frequency </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 sampling frequency for this AAC config. </dd></dl>
<p>Definition at line <a class="el" href="../../d2/d7e/aac__audio__specific__config_8h_source.html#l00057">57</a> of file <a class="el" href="../../d2/d7e/aac__audio__specific__config_8h_source.html">aac_audio_specific_config.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2bacb4e7337248bca9e678268e3db491"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t shaka::media::AACAudioSpecificConfig::GetNumChannels </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>sbr_in_mimetype</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sbr_in_mimetype</td><td>indicates whether SBR mode is specified in the mimetype, i.e. codecs parameter contains mp4a.40.5. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of channels for the AAC stream. </dd></dl>
<p>Definition at line <a class="el" href="../../d9/ded/aac__audio__specific__config_8cc_source.html#l00168">168</a> of file <a class="el" href="../../d9/ded/aac__audio__specific__config_8cc_source.html">aac_audio_specific_config.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a1e34ba8152e2c09452edcdd7e5eb1bcd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t shaka::media::AACAudioSpecificConfig::GetOutputSamplesPerSecond </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>sbr_in_mimetype</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sbr_in_mimetype</td><td>indicates whether SBR mode is specified in the mimetype, i.e. codecs parameter contains mp4a.40.5. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Output sample rate for the AAC stream. </dd></dl>
<p>Definition at line <a class="el" href="../../d9/ded/aac__audio__specific__config_8cc_source.html#l00153">153</a> of file <a class="el" href="../../d9/ded/aac__audio__specific__config_8cc_source.html">aac_audio_specific_config.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a95cff00eb36af9b9932a80fd64e24eae"></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::AACAudioSpecificConfig::num_channels </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>Number of channels for this AAC config. </dd></dl>
<p>Definition at line <a class="el" href="../../d2/d7e/aac__audio__specific__config_8h_source.html#l00060">60</a> of file <a class="el" href="../../d2/d7e/aac__audio__specific__config_8h_source.html">aac_audio_specific_config.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6b3deca725a42113bf7303387ab74f0f"></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::AACAudioSpecificConfig::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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Parse the AAC config from decoder specific information embedded in an <b>esds</b> box. The function will parse the data and get the ElementaryStreamDescriptor, then it will parse the ElementaryStreamDescriptor to get audio stream configurations. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>contains decoder specific information from an <b>esds</b> box. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successful, false otherwise. </dd></dl>
<p>Definition at line <a class="el" href="../../d9/ded/aac__audio__specific__config_8cc_source.html#l00039">39</a> of file <a class="el" href="../../d9/ded/aac__audio__specific__config_8cc_source.html">aac_audio_specific_config.cc</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>media/codecs/<a class="el" href="../../d2/d7e/aac__audio__specific__config_8h_source.html">aac_audio_specific_config.h</a></li>
<li>media/codecs/<a class="el" href="../../d9/ded/aac__audio__specific__config_8cc_source.html">aac_audio_specific_config.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Sep 29 2016 16:43:21 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>