shaka-packager/docs/dc/d56/audio__header_8h_source.html

148 lines
19 KiB
HTML
Raw Normal View 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.9.1"/>
2018-02-10 23:37:42 +00:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Shaka Packager SDK: packager/media/formats/mp2t/audio_header.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"/>
2018-02-10 23:37:42 +00:00
<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;">
2018-02-10 23:37:42 +00:00
<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>
2018-02-10 23:37:42 +00:00
<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 */
2018-02-10 23:37:42 +00:00
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
2018-02-10 23:37:42 +00:00
<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)">
2018-02-10 23:37:42 +00:00
</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_375ba2cfd8fd5b05c50b92d996b9d386.html">formats</a></li><li class="navelem"><a class="el" href="../../dir_35c1fdffcdd4ade6d7f948073ab165de.html">mp2t</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">audio_header.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 2017 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_FORMATS_MP2T_AUDIO_HEADER_H_</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#define PACKAGER_MEDIA_FORMATS_MP2T_AUDIO_HEADER_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;stddef.h&gt;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; </div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="keyword">namespace </span><a class="code" href="../../d8/daf/namespaceshaka.html">shaka</a> {</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="keyword">namespace </span>media {</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="keyword">namespace </span>mp2t {</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html"> 19</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html">AudioHeader</a> {</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</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="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html">AudioHeader</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html">AudioHeader</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#a1e5c41162d4a4ff75dc9760a4d12e496"> 27</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#a1e5c41162d4a4ff75dc9760a4d12e496">IsSyncWord</a>(<span class="keyword">const</span> uint8_t* buf) <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#a95018a4488867e584338126922bf128a"> 30</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#a95018a4488867e584338126922bf128a">GetMinFrameSize</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#abe0df0b59f89036c9c39a2070875a6a7"> 33</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#abe0df0b59f89036c9c39a2070875a6a7">GetSamplesPerFrame</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#a334c1ceea413b309a5950cc06619853f"> 43</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#a334c1ceea413b309a5950cc06619853f">Parse</a>(<span class="keyword">const</span> uint8_t* audio_frame, <span class="keywordtype">size_t</span> audio_frame_size) = 0;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#a60fce7a6810efa2fc0f40a8038805116"> 47</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#a60fce7a6810efa2fc0f40a8038805116">GetHeaderSize</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#af8acf05003d2c0dbd062a9f12a2140b3"> 51</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#af8acf05003d2c0dbd062a9f12a2140b3">GetFrameSize</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; </div>
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#ab2cc02601e113e34b99023ae55c033d1"> 56</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#ab2cc02601e113e34b99023ae55c033d1">GetFrameSizeWithoutParsing</a>(<span class="keyword">const</span> uint8_t* data,</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordtype">size_t</span> num_bytes) <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#a80da92426102c52da09690a7587d4272"> 65</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#a80da92426102c52da09690a7587d4272">GetAudioSpecificConfig</a>(std::vector&lt;uint8_t&gt;* buffer) <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; </div>
<div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#a9959124b369045fce424f845c50b9c02"> 69</a></span>&#160; <span class="keyword">virtual</span> uint8_t <a class="code" href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#a9959124b369045fce424f845c50b9c02">GetObjectType</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; </div>
<div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#aeb3121ddde96b3e6ca456586c8efdd8c"> 73</a></span>&#160; <span class="keyword">virtual</span> uint32_t <a class="code" href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#aeb3121ddde96b3e6ca456586c8efdd8c">GetSamplingFrequency</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; </div>
<div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#a47b7cff7bfced3a5e5d02a848627a0c8"> 77</a></span>&#160; <span class="keyword">virtual</span> uint8_t <a class="code" href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#a47b7cff7bfced3a5e5d02a848627a0c8">GetNumChannels</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <a class="code" href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html">AudioHeader</a>(<span class="keyword">const</span> <a class="code" href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html">AudioHeader</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <a class="code" href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html">AudioHeader</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html">AudioHeader</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;};</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;} <span class="comment">// namespace mp2t</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;} <span class="comment">// namespace media</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;} <span class="comment">// namespace shaka</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; </div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// PACKAGER_MEDIA_FORMATS_MP2T_AUDIO_HEADER_H_</span></div>
<div class="ttc" id="aclassshaka_1_1media_1_1mp2t_1_1AudioHeader_html"><div class="ttname"><a href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html">shaka::media::mp2t::AudioHeader</a></div><div class="ttdef"><b>Definition:</b> <a href="../../dc/d56/audio__header_8h_source.html#l00019">audio_header.h:19</a></div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1mp2t_1_1AudioHeader_html_a1e5c41162d4a4ff75dc9760a4d12e496"><div class="ttname"><a href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#a1e5c41162d4a4ff75dc9760a4d12e496">shaka::media::mp2t::AudioHeader::IsSyncWord</a></div><div class="ttdeci">virtual bool IsSyncWord(const uint8_t *buf) const =0</div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1mp2t_1_1AudioHeader_html_a334c1ceea413b309a5950cc06619853f"><div class="ttname"><a href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#a334c1ceea413b309a5950cc06619853f">shaka::media::mp2t::AudioHeader::Parse</a></div><div class="ttdeci">virtual bool Parse(const uint8_t *audio_frame, size_t audio_frame_size)=0</div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1mp2t_1_1AudioHeader_html_a47b7cff7bfced3a5e5d02a848627a0c8"><div class="ttname"><a href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#a47b7cff7bfced3a5e5d02a848627a0c8">shaka::media::mp2t::AudioHeader::GetNumChannels</a></div><div class="ttdeci">virtual uint8_t GetNumChannels() const =0</div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1mp2t_1_1AudioHeader_html_a60fce7a6810efa2fc0f40a8038805116"><div class="ttname"><a href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#a60fce7a6810efa2fc0f40a8038805116">shaka::media::mp2t::AudioHeader::GetHeaderSize</a></div><div class="ttdeci">virtual size_t GetHeaderSize() const =0</div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1mp2t_1_1AudioHeader_html_a80da92426102c52da09690a7587d4272"><div class="ttname"><a href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#a80da92426102c52da09690a7587d4272">shaka::media::mp2t::AudioHeader::GetAudioSpecificConfig</a></div><div class="ttdeci">virtual void GetAudioSpecificConfig(std::vector&lt; uint8_t &gt; *buffer) const =0</div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1mp2t_1_1AudioHeader_html_a95018a4488867e584338126922bf128a"><div class="ttname"><a href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#a95018a4488867e584338126922bf128a">shaka::media::mp2t::AudioHeader::GetMinFrameSize</a></div><div class="ttdeci">virtual size_t GetMinFrameSize() const =0</div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1mp2t_1_1AudioHeader_html_a9959124b369045fce424f845c50b9c02"><div class="ttname"><a href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#a9959124b369045fce424f845c50b9c02">shaka::media::mp2t::AudioHeader::GetObjectType</a></div><div class="ttdeci">virtual uint8_t GetObjectType() const =0</div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1mp2t_1_1AudioHeader_html_ab2cc02601e113e34b99023ae55c033d1"><div class="ttname"><a href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#ab2cc02601e113e34b99023ae55c033d1">shaka::media::mp2t::AudioHeader::GetFrameSizeWithoutParsing</a></div><div class="ttdeci">virtual size_t GetFrameSizeWithoutParsing(const uint8_t *data, size_t num_bytes) const =0</div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1mp2t_1_1AudioHeader_html_abe0df0b59f89036c9c39a2070875a6a7"><div class="ttname"><a href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#abe0df0b59f89036c9c39a2070875a6a7">shaka::media::mp2t::AudioHeader::GetSamplesPerFrame</a></div><div class="ttdeci">virtual size_t GetSamplesPerFrame() const =0</div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1mp2t_1_1AudioHeader_html_aeb3121ddde96b3e6ca456586c8efdd8c"><div class="ttname"><a href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#aeb3121ddde96b3e6ca456586c8efdd8c">shaka::media::mp2t::AudioHeader::GetSamplingFrequency</a></div><div class="ttdeci">virtual uint32_t GetSamplingFrequency() const =0</div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1mp2t_1_1AudioHeader_html_af8acf05003d2c0dbd062a9f12a2140b3"><div class="ttname"><a href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html#af8acf05003d2c0dbd062a9f12a2140b3">shaka::media::mp2t::AudioHeader::GetFrameSize</a></div><div class="ttdeci">virtual size_t GetFrameSize() const =0</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>