shaka-packager/docs/d8/d4a/mpeg1__header_8h_source.html

144 lines
19 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.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Shaka Packager SDK: packager/media/formats/mp2t/mpeg1_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"/>
<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="../../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">mpeg1_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="preprocessor">#ifndef PACKAGER_MEDIA_FORMATS_MP2T_MPEG1_HEADER_H_</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define PACKAGER_MEDIA_FORMATS_MP2T_MPEG1_HEADER_H_</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160; </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160; </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; </div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &quot;packager/media/formats/mp2t/audio_header.h&quot;</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="keyword">namespace </span><a class="code" href="../../d8/daf/namespaceshaka.html">shaka</a> {</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="keyword">namespace </span>media {</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="keyword">namespace </span>mp2t {</div>
<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html"> 17</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html">Mpeg1Header</a> : <span class="keyword">public</span> <a class="code" href="../../d1/dba/classshaka_1_1media_1_1mp2t_1_1AudioHeader.html">AudioHeader</a> {</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <a class="code" href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html">Mpeg1Header</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; ~<a class="code" href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html">Mpeg1Header</a>() <span class="keyword">override</span> = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html#a878cf2eb2643d7bca7a823e82c01ff26">IsSyncWord</a>(<span class="keyword">const</span> uint8_t* buf) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html#a258a401815c7c6268da2717da829103d">GetMinFrameSize</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html#ab0290813a0e04d3a84f85598455f261d">GetSamplesPerFrame</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html#ad1bab37253425b1b7dd40182cbfc382d">Parse</a>(<span class="keyword">const</span> uint8_t* mpeg1_frame, <span class="keywordtype">size_t</span> mpeg1_frame_size) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html#ae0affa07b94967c15d964c6d8e765281">GetHeaderSize</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html#a5729b3abb8dc68d52041854638fc36c8">GetFrameSize</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html#a81caa6dafd34688f2ef5a4c9e076b5f5">GetFrameSizeWithoutParsing</a>(<span class="keyword">const</span> uint8_t* data,</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keywordtype">size_t</span> num_bytes) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keywordtype">void</span> <a class="code" href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html#a6cb1a3e117dbca962b4b970885d79808">GetAudioSpecificConfig</a>(std::vector&lt;uint8_t&gt;* buffer) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; uint8_t <a class="code" href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html#a9415d54734d3e6ca017455239504e4fe">GetObjectType</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; uint32_t <a class="code" href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html#ab6ceb2d6d3f820f56f2ecbdb93e9f81a">GetSamplingFrequency</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; uint8_t <a class="code" href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html#a97407fbb7c10535233b6005cf06d3c95">GetNumChannels</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <a class="code" href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html">Mpeg1Header</a>(<span class="keyword">const</span> <a class="code" href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html">Mpeg1Header</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <a class="code" href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html">Mpeg1Header</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html">Mpeg1Header</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; uint8_t version_ = 0;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; uint8_t layer_ = 0;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; uint8_t protection_absent_ = 0;</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; uint32_t bitrate_ = 0;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; uint32_t sample_rate_ = 0; <span class="comment">/* in hz */</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; uint8_t padded_ = 0;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; uint8_t channel_mode_ = 0;</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; </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;} <span class="comment">// namespace mp2t</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;} <span class="comment">// namespace media</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;} <span class="comment">// namespace shaka</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="preprocessor">#endif // PACKAGER_MEDIA_FORMATS_MP2T_MPEG1_HEADER_H_</span></div>
</div><!-- fragment --></div><!-- contents -->
<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 class="ttc" id="aclassshaka_1_1media_1_1mp2t_1_1Mpeg1Header_html_a9415d54734d3e6ca017455239504e4fe"><div class="ttname"><a href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html#a9415d54734d3e6ca017455239504e4fe">shaka::media::mp2t::Mpeg1Header::GetObjectType</a></div><div class="ttdeci">uint8_t GetObjectType() const override</div><div class="ttdef"><b>Definition:</b> <a href="../../de/d75/mpeg1__header_8cc_source.html#l00218">mpeg1_header.cc:218</a></div></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_1Mpeg1Header_html_a258a401815c7c6268da2717da829103d"><div class="ttname"><a href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html#a258a401815c7c6268da2717da829103d">shaka::media::mp2t::Mpeg1Header::GetMinFrameSize</a></div><div class="ttdeci">size_t GetMinFrameSize() const override</div><div class="ttdef"><b>Definition:</b> <a href="../../de/d75/mpeg1__header_8cc_source.html#l00103">mpeg1_header.cc:103</a></div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1mp2t_1_1Mpeg1Header_html_a6cb1a3e117dbca962b4b970885d79808"><div class="ttname"><a href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html#a6cb1a3e117dbca962b4b970885d79808">shaka::media::mp2t::Mpeg1Header::GetAudioSpecificConfig</a></div><div class="ttdeci">void GetAudioSpecificConfig(std::vector&lt; uint8_t &gt; *buffer) const override</div><div class="ttdef"><b>Definition:</b> <a href="../../de/d75/mpeg1__header_8cc_source.html#l00182">mpeg1_header.cc:182</a></div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1mp2t_1_1Mpeg1Header_html_a97407fbb7c10535233b6005cf06d3c95"><div class="ttname"><a href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html#a97407fbb7c10535233b6005cf06d3c95">shaka::media::mp2t::Mpeg1Header::GetNumChannels</a></div><div class="ttdeci">uint8_t GetNumChannels() const override</div><div class="ttdef"><b>Definition:</b> <a href="../../de/d75/mpeg1__header_8cc_source.html#l00235">mpeg1_header.cc:235</a></div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1mp2t_1_1Mpeg1Header_html_ab0290813a0e04d3a84f85598455f261d"><div class="ttname"><a href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html#ab0290813a0e04d3a84f85598455f261d">shaka::media::mp2t::Mpeg1Header::GetSamplesPerFrame</a></div><div class="ttdeci">size_t GetSamplesPerFrame() const override</div><div class="ttdef"><b>Definition:</b> <a href="../../de/d75/mpeg1__header_8cc_source.html#l00107">mpeg1_header.cc:107</a></div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1mp2t_1_1Mpeg1Header_html_a81caa6dafd34688f2ef5a4c9e076b5f5"><div class="ttname"><a href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html#a81caa6dafd34688f2ef5a4c9e076b5f5">shaka::media::mp2t::Mpeg1Header::GetFrameSizeWithoutParsing</a></div><div class="ttdeci">size_t GetFrameSizeWithoutParsing(const uint8_t *data, size_t num_bytes) const override</div><div class="ttdef"><b>Definition:</b> <a href="../../de/d75/mpeg1__header_8cc_source.html#l00164">mpeg1_header.cc:164</a></div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1mp2t_1_1Mpeg1Header_html_a878cf2eb2643d7bca7a823e82c01ff26"><div class="ttname"><a href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html#a878cf2eb2643d7bca7a823e82c01ff26">shaka::media::mp2t::Mpeg1Header::IsSyncWord</a></div><div class="ttdeci">bool IsSyncWord(const uint8_t *buf) const override</div><div class="ttdef"><b>Definition:</b> <a href="../../de/d75/mpeg1__header_8cc_source.html#l00094">mpeg1_header.cc:94</a></div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1mp2t_1_1Mpeg1Header_html_a5729b3abb8dc68d52041854638fc36c8"><div class="ttname"><a href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html#a5729b3abb8dc68d52041854638fc36c8">shaka::media::mp2t::Mpeg1Header::GetFrameSize</a></div><div class="ttdeci">size_t GetFrameSize() const override</div><div class="ttdef"><b>Definition:</b> <a href="../../de/d75/mpeg1__header_8cc_source.html#l00160">mpeg1_header.cc:160</a></div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1mp2t_1_1Mpeg1Header_html_ad1bab37253425b1b7dd40182cbfc382d"><div class="ttname"><a href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html#ad1bab37253425b1b7dd40182cbfc382d">shaka::media::mp2t::Mpeg1Header::Parse</a></div><div class="ttdeci">bool Parse(const uint8_t *mpeg1_frame, size_t mpeg1_frame_size) override</div><div class="ttdef"><b>Definition:</b> <a href="../../de/d75/mpeg1__header_8cc_source.html#l00113">mpeg1_header.cc:113</a></div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1mp2t_1_1Mpeg1Header_html"><div class="ttname"><a href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html">shaka::media::mp2t::Mpeg1Header</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d8/d4a/mpeg1__header_8h_source.html#l00017">mpeg1_header.h:17</a></div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1mp2t_1_1Mpeg1Header_html_ab6ceb2d6d3f820f56f2ecbdb93e9f81a"><div class="ttname"><a href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html#ab6ceb2d6d3f820f56f2ecbdb93e9f81a">shaka::media::mp2t::Mpeg1Header::GetSamplingFrequency</a></div><div class="ttdeci">uint32_t GetSamplingFrequency() const override</div><div class="ttdef"><b>Definition:</b> <a href="../../de/d75/mpeg1__header_8cc_source.html#l00231">mpeg1_header.cc:231</a></div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1mp2t_1_1Mpeg1Header_html_ae0affa07b94967c15d964c6d8e765281"><div class="ttname"><a href="../../dd/d79/classshaka_1_1media_1_1mp2t_1_1Mpeg1Header.html#ae0affa07b94967c15d964c6d8e765281">shaka::media::mp2t::Mpeg1Header::GetHeaderSize</a></div><div class="ttdeci">size_t GetHeaderSize() const override</div><div class="ttdef"><b>Definition:</b> <a href="../../de/d75/mpeg1__header_8cc_source.html#l00154">mpeg1_header.cc:154</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jun 22 2021 00:16:04 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>