Mirror-Tools
/
shaka-packager
mirror of https://github.com/shaka-project/shaka-packager.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
shaka-packager/docs/d0/da2/classshaka_1_1media_1_1AACA...

360 lines
18 KiB
HTML
Raw Permalink Blame History

<!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::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/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="../../d0/da2/classshaka_1_1media_1_1AACAudioSpecificConfig.html">AACAudioSpecificConfig</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<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-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a95aa01cb20735ed47ffb4dbc730fc1f5"><td class="memItemLeft" align="right" valign="top"><a id="a95aa01cb20735ed47ffb4dbc730fc1f5"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>AudioObjectType</b> { <br />
&#160;&#160;<b>AOT_NULL</b> = 0,
<b>AOT_AAC_MAIN</b> = 1,
<b>AOT_AAC_LC</b> = 2,
<b>AOT_AAC_SSR</b> = 3,
<br />
&#160;&#160;<b>AOT_AAC_LTP</b> = 4,
<b>AOT_SBR</b> = 5,
<b>AOT_AAC_SCALABLE</b> = 6,
<b>AOT_TWINVQ</b> = 7,
<br />
&#160;&#160;<b>AOT_CELP</b> = 8,
<b>AOT_HVXC</b> = 9,
<b>AOT_TTSI</b> = 12,
<b>AOT_MAINSYNTH</b> = 13,
<br />
&#160;&#160;<b>AOT_WAVESYNTH</b> = 14,
<b>AOT_MIDI</b> = 15,
<b>AOT_SAFX</b> = 16,
<b>AOT_ER_AAC_LC</b> = 17,
<br />
&#160;&#160;<b>AOT_ER_AAC_LTP</b> = 19,
<b>AOT_ER_AAC_SCALABLE</b> = 20,
<b>AOT_ER_TWINVQ</b> = 21,
<b>AOT_ER_BSAC</b> = 22,
<br />
&#160;&#160;<b>AOT_ER_AAC_LD</b> = 23,
<b>AOT_ER_CELP</b> = 24,
<b>AOT_ER_HVXC</b> = 25,
<b>AOT_ER_HILN</b> = 26,
<br />
&#160;&#160;<b>AOT_ER_PARAM</b> = 27,
<b>AOT_SSC</b> = 28,
<b>AOT_PS</b> = 29,
<b>AOT_SURROUND</b> = 30,
<br />
&#160;&#160;<b>AOT_ESCAPE</b> = 31,
<b>AOT_L1</b> = 32,
<b>AOT_L2</b> = 33,
<b>AOT_L3</b> = 34,
<br />
&#160;&#160;<b>AOT_DST</b> = 35,
<b>AOT_ALS</b> = 36,
<b>AOT_SLS</b> = 37,
<b>AOT_SLS_NON_CORE</b> = 38,
<br />
&#160;&#160;<b>AOT_ER_AAC_ELD</b> = 39,
<b>AOT_SMR_SIMPLE</b> = 40,
<b>AOT_SMR_MAIN</b> = 41,
<b>AOT_USAC_NOSBR</b> = 42,
<br />
&#160;&#160;<b>AOT_SAOC</b> = 43,
<b>AOT_LD_SURROUND</b> = 44,
<b>AOT_USAC</b> = 45
<br />
}</td></tr>
<tr class="separator:a95aa01cb20735ed47ffb4dbc730fc1f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a5cde95e7125bcee23be34a00a92f4097"><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#a5cde95e7125bcee23be34a00a92f4097">ConvertToADTS</a> (const uint8_t *data, size_t data_size, std::vector&lt; uint8_t &gt; *audio_frame) const</td></tr>
<tr class="separator:a5cde95e7125bcee23be34a00a92f4097"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7936da4be5297ea78e0cbbb0f167941"><td class="memItemLeft" align="right" valign="top">AudioObjectType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/da2/classshaka_1_1media_1_1AACAudioSpecificConfig.html#ae7936da4be5297ea78e0cbbb0f167941">GetAudioObjectType</a> () const</td></tr>
<tr class="separator:ae7936da4be5297ea78e0cbbb0f167941"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a784e2b9e2371c8757c9a5cae62935c68"><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#a784e2b9e2371c8757c9a5cae62935c68">GetSamplesPerSecond</a> () const</td></tr>
<tr class="separator:a784e2b9e2371c8757c9a5cae62935c68"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92165f6d17f688cbf39693686b2c0feb"><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#a92165f6d17f688cbf39693686b2c0feb">GetNumChannels</a> () const</td></tr>
<tr class="separator:a92165f6d17f688cbf39693686b2c0feb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa32c2ae4bc59f5ced62cfb0acf283850"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/da2/classshaka_1_1media_1_1AACAudioSpecificConfig.html#aa32c2ae4bc59f5ced62cfb0acf283850">sbr_present</a> () const</td></tr>
<tr class="separator:aa32c2ae4bc59f5ced62cfb0acf283850"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9271c9f0d8ef8029da8bd48baa7a757b"><td class="memItemLeft" align="right" valign="top"><a id="a9271c9f0d8ef8029da8bd48baa7a757b"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/da2/classshaka_1_1media_1_1AACAudioSpecificConfig.html#a9271c9f0d8ef8029da8bd48baa7a757b">set_sbr_present</a> (bool <a class="el" href="../../d0/da2/classshaka_1_1media_1_1AACAudioSpecificConfig.html#aa32c2ae4bc59f5ced62cfb0acf283850">sbr_present</a>)</td></tr>
<tr class="memdesc:a9271c9f0d8ef8029da8bd48baa7a757b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicate whether SBR is present in the stream. <br /></td></tr>
<tr class="separator:a9271c9f0d8ef8029da8bd48baa7a757b"><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 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 class="definition">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 id="a5cde95e7125bcee23be34a00a92f4097"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5cde95e7125bcee23be34a00a92f4097">&#9670;&nbsp;</a></span>ConvertToADTS()</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::AACAudioSpecificConfig::ConvertToADTS </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; uint8_t &gt; *&#160;</td>
<td class="paramname"><em>audio_frame</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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"></td><td class="paramname">data</td><td>points to the raw AAC frame to be converted. </td></tr>
<tr><td class="paramdir"></td><td class="paramname">data_size</td><td>the size of a raw AAC frame. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">audio_frame</td><td>contains the converted frame 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 class="definition">Definition at line <a class="el" href="../../d9/ded/aac__audio__specific__config_8cc_source.html#l00140">140</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 id="ae7936da4be5297ea78e0cbbb0f167941"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7936da4be5297ea78e0cbbb0f167941">&#9670;&nbsp;</a></span>GetAudioObjectType()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AACAudioSpecificConfig::AudioObjectType shaka::media::AACAudioSpecificConfig::GetAudioObjectType </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>The audio object type for this AAC config, with possible extension considered. </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d9/ded/aac__audio__specific__config_8cc_source.html#l00172">172</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 id="a92165f6d17f688cbf39693686b2c0feb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a92165f6d17f688cbf39693686b2c0feb">&#9670;&nbsp;</a></span>GetNumChannels()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t shaka::media::AACAudioSpecificConfig::GetNumChannels </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>Number of channels for the AAC stream, with possible extensions considered. </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d9/ded/aac__audio__specific__config_8cc_source.html#l00194">194</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 id="a784e2b9e2371c8757c9a5cae62935c68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a784e2b9e2371c8757c9a5cae62935c68">&#9670;&nbsp;</a></span>GetSamplesPerSecond()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t shaka::media::AACAudioSpecificConfig::GetSamplesPerSecond </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>Sample rate for the AAC stream, with possible extensions considered. </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d9/ded/aac__audio__specific__config_8cc_source.html#l00180">180</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 id="a6b3deca725a42113bf7303387ab74f0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b3deca725a42113bf7303387ab74f0f">&#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::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 class="definition">Definition at line <a class="el" href="../../d9/ded/aac__audio__specific__config_8cc_source.html#l00048">48</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 id="aa32c2ae4bc59f5ced62cfb0acf283850"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa32c2ae4bc59f5ced62cfb0acf283850">&#9670;&nbsp;</a></span>sbr_present()</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::AACAudioSpecificConfig::sbr_present </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>whether Spectral Band Repliation (SBR) is present in the stream. </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d2/d7e/aac__audio__specific__config_8h_source.html#l00112">112</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>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>packager/media/codecs/<a class="el" href="../../d2/d7e/aac__audio__specific__config_8h_source.html">aac_audio_specific_config.h</a></li>
<li>packager/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 Tue Jun 22 2021 00:16:05 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>
Reference in New Issue View Git Blame Copy Permalink