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

156 lines
18 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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Shaka Packager SDK: packager/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/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.9.1 -->
<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','.html');
/* @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="../../dir_3f8eec2fc361645de4b1ec14c19fffc7.html">packager</a></li><li class="navelem"><a class="el" href="../../dir_f99dae54fe7170f791f339b952d5067a.html">media</a></li><li class="navelem"><a class="el" href="../../dir_e3bda0bde998a4d5063328245b9909be.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 PACKAGER_MEDIA_BASE_AUDIO_STREAM_INFO_H_</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#define PACKAGER_MEDIA_BASE_AUDIO_STREAM_INFO_H_</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; </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><a class="code" href="../../d8/daf/namespaceshaka.html">shaka</a> {</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="l00018"></a><span class="lineno"><a class="line" href="../../da/d4e/classshaka_1_1media_1_1AudioStreamInfo.html"> 18</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../da/d4e/classshaka_1_1media_1_1AudioStreamInfo.html">AudioStreamInfo</a> : <span class="keyword">public</span> <a class="code" href="../../d5/db1/classshaka_1_1media_1_1StreamInfo.html">StreamInfo</a> {</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <a class="code" href="../../da/d4e/classshaka_1_1media_1_1AudioStreamInfo.html#a1333ea7b15790da37addb60ba49131b4">AudioStreamInfo</a>(<span class="keywordtype">int</span> track_id, uint32_t time_scale, uint64_t duration,</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; Codec codec, <span class="keyword">const</span> std::string&amp; codec_string,</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keyword">const</span> uint8_t* codec_config, <span class="keywordtype">size_t</span> codec_config_size,</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; uint8_t sample_bits, uint8_t num_channels,</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; uint32_t sampling_frequency, uint64_t seek_preroll_ns,</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; uint64_t codec_delay_ns, uint32_t max_bitrate,</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; uint32_t avg_bitrate, <span class="keyword">const</span> std::string&amp; language,</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keywordtype">bool</span> is_encrypted);</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; ~<a class="code" href="../../da/d4e/classshaka_1_1media_1_1AudioStreamInfo.html">AudioStreamInfo</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../da/d4e/classshaka_1_1media_1_1AudioStreamInfo.html#a3c50d026e8deadac46741143d4b5ddb9">IsValidConfig</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; std::string <a class="code" href="../../da/d4e/classshaka_1_1media_1_1AudioStreamInfo.html#a7f94e51abcf522ff70e2456a8c8595df">ToString</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; std::unique_ptr&lt;StreamInfo&gt; <a class="code" href="../../da/d4e/classshaka_1_1media_1_1AudioStreamInfo.html#a306c5ebb4a42eced7d1a3deaad23c17b">Clone</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; uint8_t sample_bits()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> sample_bits_; }</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</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="l00041"></a><span class="lineno"> 41</span>&#160; uint8_t num_channels()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> num_channels_; }</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; uint32_t sampling_frequency()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> sampling_frequency_; }</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; uint32_t bytes_per_frame()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</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="l00045"></a><span class="lineno"> 45</span>&#160; }</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; uint64_t seek_preroll_ns()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> seek_preroll_ns_; }</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; uint64_t codec_delay_ns()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> codec_delay_ns_; }</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; uint32_t max_bitrate()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> max_bitrate_; }</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; uint32_t avg_bitrate()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> avg_bitrate_; }</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</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="l00052"></a><span class="lineno"> 52</span>&#160; sampling_frequency_ = sampling_frequency;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; }</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keyword">static</span> std::string <a class="code" href="../../da/d4e/classshaka_1_1media_1_1AudioStreamInfo.html#aee79e7aa61b741bb96f451c6de1c9d42">GetCodecString</a>(Codec codec, uint8_t audio_object_type);</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; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; uint8_t sample_bits_;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; uint8_t num_channels_;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; uint32_t sampling_frequency_;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; uint64_t seek_preroll_ns_;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; uint64_t codec_delay_ns_;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; uint32_t max_bitrate_;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; uint32_t avg_bitrate_;</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="comment">// Not using DISALLOW_COPY_AND_ASSIGN here intentionally to allow the compiler</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="comment">// generated copy constructor and assignment operator. Since the extra data is</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="comment">// typically small, the performance impact is minimal.</span></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="l00073"></a><span class="lineno"> 73</span>&#160;} <span class="comment">// namespace media</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;} <span class="comment">// namespace shaka</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// PACKAGER_MEDIA_BASE_AUDIO_STREAM_INFO_H_</span></div>
<div class="ttc" id="aclassshaka_1_1media_1_1AudioStreamInfo_html"><div class="ttname"><a href="../../da/d4e/classshaka_1_1media_1_1AudioStreamInfo.html">shaka::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#l00018">audio_stream_info.h:18</a></div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1AudioStreamInfo_html_a1333ea7b15790da37addb60ba49131b4"><div class="ttname"><a href="../../da/d4e/classshaka_1_1media_1_1AudioStreamInfo.html#a1333ea7b15790da37addb60ba49131b4">shaka::media::AudioStreamInfo::AudioStreamInfo</a></div><div class="ttdeci">AudioStreamInfo(int track_id, uint32_t time_scale, uint64_t duration, Codec codec, const std::string &amp;codec_string, const uint8_t *codec_config, size_t codec_config_size, uint8_t sample_bits, uint8_t num_channels, uint32_t sampling_frequency, uint64_t seek_preroll_ns, uint64_t codec_delay_ns, uint32_t max_bitrate, uint32_t avg_bitrate, const std::string &amp;language, 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#l00057">audio_stream_info.cc:57</a></div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1AudioStreamInfo_html_a306c5ebb4a42eced7d1a3deaad23c17b"><div class="ttname"><a href="../../da/d4e/classshaka_1_1media_1_1AudioStreamInfo.html#a306c5ebb4a42eced7d1a3deaad23c17b">shaka::media::AudioStreamInfo::Clone</a></div><div class="ttdeci">std::unique_ptr&lt; StreamInfo &gt; Clone() const override</div><div class="ttdef"><b>Definition:</b> <a href="../../da/d04/audio__stream__info_8cc_source.html#l00101">audio_stream_info.cc:101</a></div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1AudioStreamInfo_html_a3c50d026e8deadac46741143d4b5ddb9"><div class="ttname"><a href="../../da/d4e/classshaka_1_1media_1_1AudioStreamInfo.html#a3c50d026e8deadac46741143d4b5ddb9">shaka::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#l00077">audio_stream_info.cc:77</a></div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1AudioStreamInfo_html_a7f94e51abcf522ff70e2456a8c8595df"><div class="ttname"><a href="../../da/d4e/classshaka_1_1media_1_1AudioStreamInfo.html#a7f94e51abcf522ff70e2456a8c8595df">shaka::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#l00084">audio_stream_info.cc:84</a></div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1AudioStreamInfo_html_aee79e7aa61b741bb96f451c6de1c9d42"><div class="ttname"><a href="../../da/d4e/classshaka_1_1media_1_1AudioStreamInfo.html#aee79e7aa61b741bb96f451c6de1c9d42">shaka::media::AudioStreamInfo::GetCodecString</a></div><div class="ttdeci">static std::string GetCodecString(Codec codec, uint8_t audio_object_type)</div><div class="ttdef"><b>Definition:</b> <a href="../../da/d04/audio__stream__info_8cc_source.html#l00105">audio_stream_info.cc:105</a></div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1StreamInfo_html"><div class="ttname"><a href="../../d5/db1/classshaka_1_1media_1_1StreamInfo.html">shaka::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#l00065">stream_info.h:65</a></div></div>
<div class="ttc" id="anamespaceshaka_html"><div class="ttname"><a href="../../d8/daf/namespaceshaka.html">shaka</a></div><div class="ttdoc">All the methods that are virtual are virtual for mocking.</div><div class="ttdef"><b>Definition:</b> <a href="../../d4/d15/gflags__hex__bytes_8cc_source.html#l00011">gflags_hex_bytes.cc:11</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jun 10 2021 21:44:25 for Shaka Packager SDK by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>