shaka-packager/docs/d2/d92/box__reader_8h_source.html

92 lines
31 KiB
HTML
Raw Normal View History

<!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"/>
2018-02-10 23:37:42 +00:00
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Shaka Packager SDK: packager/media/formats/mp4/box_reader.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 -->
2018-02-10 23:37:42 +00:00
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</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">
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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)">
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_ae142483ff91a68c468a97c037f98d4d.html">mp4</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">box_reader.h</div> </div>
</div><!--header-->
<div class="contents">
2018-02-10 23:37:42 +00:00
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// Copyright (c) 2012 The Chromium Authors. All rights reserved.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Use of this source code is governed by a BSD-style license that can be</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// found in the LICENSE file.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#ifndef PACKAGER_MEDIA_FORMATS_MP4_BOX_READER_H_</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#define PACKAGER_MEDIA_FORMATS_MP4_BOX_READER_H_</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 &lt;map&gt;</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</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/base/compiler_specific.h&quot;</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &quot;packager/base/logging.h&quot;</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &quot;packager/media/base/buffer_reader.h&quot;</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &quot;packager/media/base/fourccs.h&quot;</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &quot;packager/media/base/rcheck.h&quot;</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="keyword">namespace </span><a class="code" href="../../d8/daf/namespaceshaka.html">shaka</a> {</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="keyword">namespace </span>media {</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="keyword">namespace </span>mp4 {</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="keyword">struct </span>Box;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="../../d1/dee/classshaka_1_1media_1_1mp4_1_1BoxReader.html"> 25</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../d1/dee/classshaka_1_1media_1_1mp4_1_1BoxReader.html">BoxReader</a> : <span class="keyword">public</span> <a class="code" href="../../d9/d13/classshaka_1_1media_1_1BufferReader.html">BufferReader</a> {</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; ~<a class="code" href="../../d1/dee/classshaka_1_1media_1_1mp4_1_1BoxReader.html">BoxReader</a>();</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#16
<div class="ttc" id="classshaka_1_1media_1_1mp4_1_1BoxReader_html_a8b5c7d5a487fb3063eae1495aa3a7566"><div class="ttname"><a href="../../d1/dee/classshaka_1_1media_1_1mp4_1_1BoxReader.html#a8b5c7d5a487fb3063eae1495aa3a7566">shaka::media::mp4::BoxReader::ReadAllChildren</a></div><div class="ttdeci">bool ReadAllChildren(std::vector&lt; T &gt; *children) WARN_UNUSED_RESULT</div><div class="ttdef"><b>Definition:</b> <a href="../../d2/d92/box__reader_8h_source.html#l00157">box_reader.h:157</a></div></div>
2018-02-10 23:37:42 +00:00
<div class="ttc" id="namespaceshaka_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="classshaka_1_1media_1_1mp4_1_1BoxReader_html_acc5a55985f95b73ac64c9eab7bd09242"><div class="ttname"><a href="../../d1/dee/classshaka_1_1media_1_1mp4_1_1BoxReader.html#acc5a55985f95b73ac64c9eab7bd09242">shaka::media::mp4::BoxReader::ScanChildren</a></div><div class="ttdeci">bool ScanChildren() WARN_UNUSED_RESULT</div><div class="ttdef"><b>Definition:</b> <a href="../../d3/df1/box__reader_8cc_source.html#l00067">box_reader.cc:67</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1mp4_1_1BoxReader_html_aedb3a49da398833cda1caa1ad01a364a"><div class="ttname"><a href="../../d1/dee/classshaka_1_1media_1_1mp4_1_1BoxReader.html#aedb3a49da398833cda1caa1ad01a364a">shaka::media::mp4::BoxReader::ReadChildren</a></div><div class="ttdeci">bool ReadChildren(std::vector&lt; T &gt; *children) WARN_UNUSED_RESULT</div><div class="ttdef"><b>Definition:</b> <a href="../../d2/d92/box__reader_8h_source.html#l00128">box_reader.h:128</a></div></div>
<div class="ttc" id="structshaka_1_1media_1_1mp4_1_1Box_html"><div class="ttname"><a href="../../d1/d2d/structshaka_1_1media_1_1mp4_1_1Box.html">shaka::media::mp4::Box</a></div><div class="ttdef"><b>Definition:</b> <a href="../../dc/d19/box_8h_source.html#l00027">box.h:27</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1BufferReader_html_a2b15dfcd6ff891a9cb7b76f48d91d15d"><div class="ttname"><a href="../../d9/d13/classshaka_1_1media_1_1BufferReader.html#a2b15dfcd6ff891a9cb7b76f48d91d15d">shaka::media::BufferReader::SkipBytes</a></div><div class="ttdeci">bool SkipBytes(size_t num_bytes) WARN_UNUSED_RESULT</div><div class="ttdef"><b>Definition:</b> <a href="../../dd/dbc/buffer__reader_8cc_source.html#l00065">buffer_reader.cc:65</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1mp4_1_1BoxReader_html"><div class="ttname"><a href="../../d1/dee/classshaka_1_1media_1_1mp4_1_1BoxReader.html">shaka::media::mp4::BoxReader</a></div><div class="ttdoc">Class for reading MP4 boxes. </div><div class="ttdef"><b>Definition:</b> <a href="../../d2/d92/box__reader_8h_source.html#l00025">box_reader.h:25</a></div></div>
2018-05-23 23:12:00 +00:00
<div class="ttc" id="classshaka_1_1media_1_1mp4_1_1BoxReader_html_a68defcd9be85bbd5cbded3bee86aa03a"><div class="ttname"><a href="../../d1/dee/classshaka_1_1media_1_1mp4_1_1BoxReader.html#a68defcd9be85bbd5cbded3bee86aa03a">shaka::media::mp4::BoxReader::ReadChild</a></div><div class="ttdeci">bool ReadChild(Box *child) WARN_UNUSED_RESULT</div><div class="ttdef"><b>Definition:</b> <a href="../../d3/df1/box__reader_8cc_source.html#l00090">box_reader.cc:90</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1BufferReader_html"><div class="ttname"><a href="../../d9/d13/classshaka_1_1media_1_1BufferReader.html">shaka::media::BufferReader</a></div><div class="ttdef"><b>Definition:</b> <a href="../../de/d3e/buffer__reader_8h_source.html#l00023">buffer_reader.h:23</a></div></div>
2018-05-23 23:12:00 +00:00
<div class="ttc" id="classshaka_1_1media_1_1mp4_1_1BoxReader_html_a1a4457e9638e8cf3fb30b0031b513cec"><div class="ttname"><a href="../../d1/dee/classshaka_1_1media_1_1mp4_1_1BoxReader.html#a1a4457e9638e8cf3fb30b0031b513cec">shaka::media::mp4::BoxReader::TryReadChild</a></div><div class="ttdeci">bool TryReadChild(Box *child) WARN_UNUSED_RESULT</div><div class="ttdef"><b>Definition:</b> <a href="../../d3/df1/box__reader_8cc_source.html#l00106">box_reader.cc:106</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1mp4_1_1BoxReader_html_a6bafd9cd95a97c4c1475d1806d602ae2"><div class="ttname"><a href="../../d1/dee/classshaka_1_1media_1_1mp4_1_1BoxReader.html#a6bafd9cd95a97c4c1475d1806d602ae2">shaka::media::mp4::BoxReader::StartBox</a></div><div class="ttdeci">static bool StartBox(const uint8_t *buf, const size_t buf_size, FourCC *type, uint64_t *box_size, bool *err) WARN_UNUSED_RESULT</div><div class="ttdef"><b>Definition:</b> <a href="../../d3/df1/box__reader_8cc_source.html#l00054">box_reader.cc:54</a></div></div>
2018-05-23 23:12:00 +00:00
<div class="ttc" id="classshaka_1_1media_1_1mp4_1_1BoxReader_html_aa65236a6b94ac59d5da409412992211c"><div class="ttname"><a href="../../d1/dee/classshaka_1_1media_1_1mp4_1_1BoxReader.html#aa65236a6b94ac59d5da409412992211c">shaka::media::mp4::BoxReader::ChildExist</a></div><div class="ttdeci">bool ChildExist(Box *child) WARN_UNUSED_RESULT</div><div class="ttdef"><b>Definition:</b> <a href="../../d3/df1/box__reader_8cc_source.html#l00102">box_reader.cc:102</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1mp4_1_1BoxReader_html_ae348922875d67128d2af6d88b692e205"><div class="ttname"><a href="../../d1/dee/classshaka_1_1media_1_1mp4_1_1BoxReader.html#ae348922875d67128d2af6d88b692e205">shaka::media::mp4::BoxReader::ReadBox</a></div><div class="ttdeci">static BoxReader * ReadBox(const uint8_t *buf, const size_t buf_size, bool *err)</div><div class="ttdef"><b>Definition:</b> <a href="../../d3/df1/box__reader_8cc_source.html#l00036">box_reader.cc:36</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jun 7 2018 16:03:49 for Shaka Packager SDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
2018-02-10 23:37:42 +00:00
</a> 1.8.13
</small></address>
</body>
</html>