shaka-packager/docs/df/d32/audio__stream__info_8h_sour...

192 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: media/base/audio_stream_info.h Source File</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><a href="../../annotated.html"><span>Classes</span></a></li>
<li class="current"><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="../../files.html"><span>File&#160;List</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>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="../../dir_39dc0668bd5a501998f94e8b4e546c71.html">media</a></li><li class="navelem"><a class="el" href="../../dir_c6ada2450b25ab5438a4dba6c9b890af.html">base</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">audio_stream_info.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// Copyright 2014 Google Inc. All rights reserved.</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// Use of this source code is governed by a BSD-style</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// license that can be found in the LICENSE file or at</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// https://developers.google.com/open-source/licenses/bsd</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;</div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#ifndef MEDIA_BASE_AUDIO_STREAM_INFO_H_</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define MEDIA_BASE_AUDIO_STREAM_INFO_H_</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &quot;packager/media/base/stream_info.h&quot;</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="keyword">namespace </span>edash_packager {</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="keyword">namespace </span>media {</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="keyword">enum</span> AudioCodec {</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; kUnknownAudioCodec = 0,</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; kCodecAAC,</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; kCodecMP3,</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; kCodecPCM,</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; kCodecVorbis,</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; kCodecFLAC,</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; kCodecAMR_NB,</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; kCodecAMR_WB,</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; kCodecPCM_MULAW,</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; kCodecGSM_MS,</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; kCodecPCM_S16BE,</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; kCodecPCM_S24BE,</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; kCodecOpus,</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; kCodecEAC3,</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; kNumAudioCodec</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;};</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="../../da/d27/classedash__packager_1_1media_1_1AudioStreamInfo.html"> 37</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../da/d27/classedash__packager_1_1media_1_1AudioStreamInfo.html">AudioStreamInfo</a> : <span class="keyword">public</span> <a class="code" href="../../d6/d06/classedash__packager_1_1media_1_1StreamInfo.html">StreamInfo</a> {</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <a class="code" href="../../da/d27/classedash__packager_1_1media_1_1AudioStreamInfo.html#a014cdf015863a200c10cb72c3ec042ab">AudioStreamInfo</a>(<span class="keywordtype">int</span> track_id,</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; uint32_t time_scale,</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; uint64_t duration,</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; AudioCodec codec,</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keyword">const</span> std::string&amp; codec_string,</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keyword">const</span> std::string&amp; language,</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; uint8_t sample_bits,</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; uint8_t num_channels,</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; uint32_t sampling_frequency,</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keyword">const</span> uint8_t* extra_data,</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordtype">size_t</span> extra_data_size,</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordtype">bool</span> is_encrypted);</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../da/d27/classedash__packager_1_1media_1_1AudioStreamInfo.html#a98bbb5085d1dee09bd79b72d1efe590c">IsValidConfig</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; std::string <a class="code" href="../../da/d27/classedash__packager_1_1media_1_1AudioStreamInfo.html#a614479ac0820d6491845aa1a4bb85ba4">ToString</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; AudioCodec codec()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> codec_; }</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; uint8_t sample_bits()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> sample_bits_; }</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; uint8_t sample_bytes()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> sample_bits_ / 8; }</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; uint8_t num_channels()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> num_channels_; }</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; uint32_t sampling_frequency()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> sampling_frequency_; }</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; uint32_t bytes_per_frame()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span>uint32_t<span class="keyword">&gt;</span>(num_channels_) * sample_bits_ / 8;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; }</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordtype">void</span> set_sampling_frequency(<span class="keyword">const</span> uint32_t sampling_frequency) {</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; sampling_frequency_ = sampling_frequency;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; }</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keyword">static</span> std::string <a class="code" href="../../da/d27/classedash__packager_1_1media_1_1AudioStreamInfo.html#aa62e486f463c867b8e2f41ebb4ecea34">GetCodecString</a>(AudioCodec codec,</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; uint8_t audio_object_type);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; ~<a class="code" href="../../da/d27/classedash__packager_1_1media_1_1AudioStreamInfo.html">AudioStreamInfo</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; AudioCodec codec_;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; uint8_t sample_bits_;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; uint8_t num_channels_;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; uint32_t sampling_frequency_;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="comment">// Not using DISALLOW_COPY_AND_ASSIGN here intentionally to allow the compiler</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="comment">// generated copy constructor and assignment operator. Since the extra data is</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="comment">// typically small, the performance impact is minimal.</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;};</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;} <span class="comment">// namespace media</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;} <span class="comment">// namespace edash_packager</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;<span class="preprocessor">#endif // MEDIA_BASE_AUDIO_STREAM_INFO_H_</span></div>
<div class="ttc" id="classedash__packager_1_1media_1_1AudioStreamInfo_html"><div class="ttname"><a href="../../da/d27/classedash__packager_1_1media_1_1AudioStreamInfo.html">edash_packager::media::AudioStreamInfo</a></div><div class="ttdoc">Holds audio stream information. </div><div class="ttdef"><b>Definition:</b> <a href="../../df/d32/audio__stream__info_8h_source.html#l00037">audio_stream_info.h:37</a></div></div>
<div class="ttc" id="classedash__packager_1_1media_1_1AudioStreamInfo_html_a614479ac0820d6491845aa1a4bb85ba4"><div class="ttname"><a href="../../da/d27/classedash__packager_1_1media_1_1AudioStreamInfo.html#a614479ac0820d6491845aa1a4bb85ba4">edash_packager::media::AudioStreamInfo::ToString</a></div><div class="ttdeci">std::string ToString() const override</div><div class="ttdef"><b>Definition:</b> <a href="../../da/d04/audio__stream__info_8cc_source.html#l00090">audio_stream_info.cc:90</a></div></div>
<div class="ttc" id="classedash__packager_1_1media_1_1StreamInfo_html"><div class="ttname"><a href="../../d6/d06/classedash__packager_1_1media_1_1StreamInfo.html">edash_packager::media::StreamInfo</a></div><div class="ttdoc">Abstract class holds stream information. </div><div class="ttdef"><b>Definition:</b> <a href="../../d8/daa/stream__info_8h_source.html#l00026">stream_info.h:26</a></div></div>
<div class="ttc" id="classedash__packager_1_1media_1_1AudioStreamInfo_html_a014cdf015863a200c10cb72c3ec042ab"><div class="ttname"><a href="../../da/d27/classedash__packager_1_1media_1_1AudioStreamInfo.html#a014cdf015863a200c10cb72c3ec042ab">edash_packager::media::AudioStreamInfo::AudioStreamInfo</a></div><div class="ttdeci">AudioStreamInfo(int track_id, uint32_t time_scale, uint64_t duration, AudioCodec codec, const std::string &amp;codec_string, const std::string &amp;language, uint8_t sample_bits, uint8_t num_channels, uint32_t sampling_frequency, const uint8_t *extra_data, size_t extra_data_size, bool is_encrypted)</div><div class="ttdoc">Construct an initialized audio stream info object. </div><div class="ttdef"><b>Definition:</b> <a href="../../da/d04/audio__stream__info_8cc_source.html#l00053">audio_stream_info.cc:53</a></div></div>
<div class="ttc" id="classedash__packager_1_1media_1_1AudioStreamInfo_html_a98bbb5085d1dee09bd79b72d1efe590c"><div class="ttname"><a href="../../da/d27/classedash__packager_1_1media_1_1AudioStreamInfo.html#a98bbb5085d1dee09bd79b72d1efe590c">edash_packager::media::AudioStreamInfo::IsValidConfig</a></div><div class="ttdeci">bool IsValidConfig() const override</div><div class="ttdef"><b>Definition:</b> <a href="../../da/d04/audio__stream__info_8cc_source.html#l00082">audio_stream_info.cc:82</a></div></div>
<div class="ttc" id="classedash__packager_1_1media_1_1AudioStreamInfo_html_aa62e486f463c867b8e2f41ebb4ecea34"><div class="ttname"><a href="../../da/d27/classedash__packager_1_1media_1_1AudioStreamInfo.html#aa62e486f463c867b8e2f41ebb4ecea34">edash_packager::media::AudioStreamInfo::GetCodecString</a></div><div class="ttdeci">static std::string GetCodecString(AudioCodec codec, uint8_t audio_object_type)</div><div class="ttdef"><b>Definition:</b> <a href="../../da/d04/audio__stream__info_8cc_source.html#l00098">audio_stream_info.cc:98</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Nov 18 2015 19:07:29 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>