shaka-packager/docs/de/d3e/buffer__reader_8h_source.html

172 lines
18 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"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>DASH Media Packaging SDK: media/base/buffer_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"/>
<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">buffer_reader.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_BUFFER_READER_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_BUFFER_READER_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;stdint.h&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 &lt;string&gt;</span></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="preprocessor">#include &quot;packager/base/compiler_specific.h&quot;</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &quot;packager/base/macros.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>edash_packager {</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;</div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="../../d9/d46/classedash__packager_1_1media_1_1BufferReader.html"> 23</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../d9/d46/classedash__packager_1_1media_1_1BufferReader.html">BufferReader</a> {</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="../../d9/d46/classedash__packager_1_1media_1_1BufferReader.html#a7354b7da262fd2cd4680346d4ae871d8"> 26</a></span>&#160; <a class="code" href="../../d9/d46/classedash__packager_1_1media_1_1BufferReader.html#a7354b7da262fd2cd4680346d4ae871d8">BufferReader</a>(<span class="keyword">const</span> uint8_t* buf, <span class="keywordtype">size_t</span> size)</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; : buf_(buf), size_(size), pos_(0) {}</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; ~<a class="code" href="../../d9/d46/classedash__packager_1_1media_1_1BufferReader.html">BufferReader</a>() {}</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="../../d9/d46/classedash__packager_1_1media_1_1BufferReader.html#a61ac255662b847f0ef25a8228c4ba009"> 32</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../d9/d46/classedash__packager_1_1media_1_1BufferReader.html#a61ac255662b847f0ef25a8228c4ba009">HasBytes</a>(<span class="keywordtype">size_t</span> count) { <span class="keywordflow">return</span> pos() + count &lt;= size(); }</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../d9/d46/classedash__packager_1_1media_1_1BufferReader.html#a0375f4997e9c934783f51203c4d1434f">Read1</a>(uint8_t* v) WARN_UNUSED_RESULT;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keywordtype">bool</span> Read2(uint16_t* v) WARN_UNUSED_RESULT;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordtype">bool</span> Read2s(int16_t* v) WARN_UNUSED_RESULT;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordtype">bool</span> Read4(uint32_t* v) WARN_UNUSED_RESULT;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordtype">bool</span> Read4s(int32_t* v) WARN_UNUSED_RESULT;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordtype">bool</span> Read8(uint64_t* v) WARN_UNUSED_RESULT;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordtype">bool</span> Read8s(int64_t* v) WARN_UNUSED_RESULT;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../d9/d46/classedash__packager_1_1media_1_1BufferReader.html#ac21a2b3a9ed6b2ad20247b6f653d8a02">ReadNBytesInto8</a>(uint64_t* v, <span class="keywordtype">size_t</span> num_bytes) WARN_UNUSED_RESULT;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keywordtype">bool</span> ReadNBytesInto8s(int64_t* v, <span class="keywordtype">size_t</span> num_bytes) WARN_UNUSED_RESULT;</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="keywordtype">bool</span> ReadToVector(std::vector&lt;uint8_t&gt;* t, <span class="keywordtype">size_t</span> count) WARN_UNUSED_RESULT;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordtype">bool</span> ReadToString(std::string* str, <span class="keywordtype">size_t</span> size) WARN_UNUSED_RESULT;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../d9/d46/classedash__packager_1_1media_1_1BufferReader.html#a2b7075e5a47a823b9f66c0ba702f26bf">SkipBytes</a>(<span class="keywordtype">size_t</span> num_bytes) WARN_UNUSED_RESULT;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keyword">const</span> uint8_t* data()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> buf_; }</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keywordtype">size_t</span> size()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> size_; }</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keywordtype">void</span> set_size(<span class="keywordtype">size_t</span> size) { size_ = size; }</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keywordtype">size_t</span> pos()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> pos_; }</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="keyword">private</span>:</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="comment">// Internal implementation of multi-byte reads.</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keywordtype">bool</span> Read(T* t) WARN_UNUSED_RESULT;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keywordtype">bool</span> ReadNBytes(T* t, <span class="keywordtype">size_t</span> num_bytes) WARN_UNUSED_RESULT;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keyword">const</span> uint8_t* buf_;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keywordtype">size_t</span> size_;</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keywordtype">size_t</span> pos_;</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; DISALLOW_COPY_AND_ASSIGN(<a class="code" href="../../d9/d46/classedash__packager_1_1media_1_1BufferReader.html#a7354b7da262fd2cd4680346d4ae871d8">BufferReader</a>);</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;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;} <span class="comment">// namespace media</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;} <span class="comment">// namespace edash_packager</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;<span class="preprocessor">#endif // MEDIA_BASE_BUFFER_READER_H_</span></div>
<div class="ttc" id="classedash__packager_1_1media_1_1BufferReader_html_a0375f4997e9c934783f51203c4d1434f"><div class="ttname"><a href="../../d9/d46/classedash__packager_1_1media_1_1BufferReader.html#a0375f4997e9c934783f51203c4d1434f">edash_packager::media::BufferReader::Read1</a></div><div class="ttdeci">bool Read1(uint8_t *v) WARN_UNUSED_RESULT</div><div class="ttdef"><b>Definition:</b> <a href="../../dd/dbc/buffer__reader_8cc_source.html#l00014">buffer_reader.cc:14</a></div></div>
<div class="ttc" id="classedash__packager_1_1media_1_1BufferReader_html_a2b7075e5a47a823b9f66c0ba702f26bf"><div class="ttname"><a href="../../d9/d46/classedash__packager_1_1media_1_1BufferReader.html#a2b7075e5a47a823b9f66c0ba702f26bf">edash_packager::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="classedash__packager_1_1media_1_1BufferReader_html_ac21a2b3a9ed6b2ad20247b6f653d8a02"><div class="ttname"><a href="../../d9/d46/classedash__packager_1_1media_1_1BufferReader.html#ac21a2b3a9ed6b2ad20247b6f653d8a02">edash_packager::media::BufferReader::ReadNBytesInto8</a></div><div class="ttdeci">bool ReadNBytesInto8(uint64_t *v, size_t num_bytes) WARN_UNUSED_RESULT</div><div class="ttdef"><b>Definition:</b> <a href="../../dd/dbc/buffer__reader_8cc_source.html#l00040">buffer_reader.cc:40</a></div></div>
<div class="ttc" id="classedash__packager_1_1media_1_1BufferReader_html"><div class="ttname"><a href="../../d9/d46/classedash__packager_1_1media_1_1BufferReader.html">edash_packager::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>
<div class="ttc" id="classedash__packager_1_1media_1_1BufferReader_html_a7354b7da262fd2cd4680346d4ae871d8"><div class="ttname"><a href="../../d9/d46/classedash__packager_1_1media_1_1BufferReader.html#a7354b7da262fd2cd4680346d4ae871d8">edash_packager::media::BufferReader::BufferReader</a></div><div class="ttdeci">BufferReader(const uint8_t *buf, size_t size)</div><div class="ttdoc">Create a BufferReader from a raw buffer. </div><div class="ttdef"><b>Definition:</b> <a href="../../de/d3e/buffer__reader_8h_source.html#l00026">buffer_reader.h:26</a></div></div>
<div class="ttc" id="classedash__packager_1_1media_1_1BufferReader_html_a61ac255662b847f0ef25a8228c4ba009"><div class="ttname"><a href="../../d9/d46/classedash__packager_1_1media_1_1BufferReader.html#a61ac255662b847f0ef25a8228c4ba009">edash_packager::media::BufferReader::HasBytes</a></div><div class="ttdeci">bool HasBytes(size_t count)</div><div class="ttdef"><b>Definition:</b> <a href="../../de/d3e/buffer__reader_8h_source.html#l00032">buffer_reader.h:32</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Mar 24 2016 21:23:32 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>