156 lines
18 KiB
HTML
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/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/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&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&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">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> <span class="comment">// Copyright 2014 Google Inc. All rights reserved.</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <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> <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> <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>  </div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#ifndef PACKAGER_MEDIA_BASE_BUFFER_READER_H_</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#define PACKAGER_MEDIA_BASE_BUFFER_READER_H_</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <stdint.h></span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  </div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <vector></span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  </div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include "packager/base/compiler_specific.h"</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include "packager/base/macros.h"</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  </div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <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> <span class="keyword">namespace </span>media {</div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="../../d9/d13/classshaka_1_1media_1_1BufferReader.html"> 23</a></span> <span class="keyword">class </span><a class="code" href="../../d9/d13/classshaka_1_1media_1_1BufferReader.html">BufferReader</a> {</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="../../d9/d13/classshaka_1_1media_1_1BufferReader.html#a94771befc54d444630ade726689b7bf7"> 26</a></span>  <a class="code" href="../../d9/d13/classshaka_1_1media_1_1BufferReader.html#a94771befc54d444630ade726689b7bf7">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>  : buf_(buf), size_(size), pos_(0) {}</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  ~<a class="code" href="../../d9/d13/classshaka_1_1media_1_1BufferReader.html">BufferReader</a>() {}</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="../../d9/d13/classshaka_1_1media_1_1BufferReader.html#a208f2fda9ea3e79583284c951642c356"> 32</a></span>  <span class="keywordtype">bool</span> <a class="code" href="../../d9/d13/classshaka_1_1media_1_1BufferReader.html#a208f2fda9ea3e79583284c951642c356">HasBytes</a>(<span class="keywordtype">size_t</span> count) { <span class="keywordflow">return</span> pos() + count <= size(); }</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">bool</span> <a class="code" href="../../d9/d13/classshaka_1_1media_1_1BufferReader.html#a65b65ad5a5ebc9d66182c38ec9876c05">Read1</a>(uint8_t* v) WARN_UNUSED_RESULT;</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <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>  <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>  <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>  <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>  <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>  <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>  </div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">bool</span> <a class="code" href="../../d9/d13/classshaka_1_1media_1_1BufferReader.html#ac98c6631c07300a6b78ec58bfd4ced30">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>  <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>  </div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordtype">bool</span> ReadToVector(std::vector<uint8_t>* t, <span class="keywordtype">size_t</span> count) WARN_UNUSED_RESULT;</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <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>  </div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">bool</span> <a class="code" href="../../d9/d13/classshaka_1_1media_1_1BufferReader.html#ae2e74844020e15fb3c2d2a7b5bfb31f5">ReadCString</a>(std::string* str) WARN_UNUSED_RESULT;</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  </div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordtype">bool</span> <a class="code" href="../../d9/d13/classshaka_1_1media_1_1BufferReader.html#a2b15dfcd6ff891a9cb7b76f48d91d15d">SkipBytes</a>(<span class="keywordtype">size_t</span> num_bytes) WARN_UNUSED_RESULT;</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  </div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <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="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">size_t</span> size()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> size_; }</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">void</span> set_size(<span class="keywordtype">size_t</span> size) { size_ = size; }</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordtype">size_t</span> pos()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> pos_; }</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  </div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="comment">// Internal implementation of multi-byte reads.</span></div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> T></div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordtype">bool</span> Read(T* t) WARN_UNUSED_RESULT;</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> T></div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <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="l00077"></a><span class="lineno"> 77</span>  </div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">const</span> uint8_t* buf_;</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordtype">size_t</span> size_;</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordtype">size_t</span> pos_;</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  </div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  DISALLOW_COPY_AND_ASSIGN(<a class="code" href="../../d9/d13/classshaka_1_1media_1_1BufferReader.html#a94771befc54d444630ade726689b7bf7">BufferReader</a>);</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> };</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  </div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> } <span class="comment">// namespace media</span></div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> } <span class="comment">// namespace shaka</span></div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  </div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="preprocessor">#endif </span><span class="comment">// PACKAGER_MEDIA_BASE_BUFFER_READER_H_</span></div>
|
|
<div class="ttc" id="aclassshaka_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>
|
|
<div class="ttc" id="aclassshaka_1_1media_1_1BufferReader_html_a208f2fda9ea3e79583284c951642c356"><div class="ttname"><a href="../../d9/d13/classshaka_1_1media_1_1BufferReader.html#a208f2fda9ea3e79583284c951642c356">shaka::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 class="ttc" id="aclassshaka_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#l00077">buffer_reader.cc:77</a></div></div>
|
|
<div class="ttc" id="aclassshaka_1_1media_1_1BufferReader_html_a65b65ad5a5ebc9d66182c38ec9876c05"><div class="ttname"><a href="../../d9/d13/classshaka_1_1media_1_1BufferReader.html#a65b65ad5a5ebc9d66182c38ec9876c05">shaka::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="aclassshaka_1_1media_1_1BufferReader_html_a94771befc54d444630ade726689b7bf7"><div class="ttname"><a href="../../d9/d13/classshaka_1_1media_1_1BufferReader.html#a94771befc54d444630ade726689b7bf7">shaka::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="aclassshaka_1_1media_1_1BufferReader_html_ac98c6631c07300a6b78ec58bfd4ced30"><div class="ttname"><a href="../../d9/d13/classshaka_1_1media_1_1BufferReader.html#ac98c6631c07300a6b78ec58bfd4ced30">shaka::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="aclassshaka_1_1media_1_1BufferReader_html_ae2e74844020e15fb3c2d2a7b5bfb31f5"><div class="ttname"><a href="../../d9/d13/classshaka_1_1media_1_1BufferReader.html#ae2e74844020e15fb3c2d2a7b5bfb31f5">shaka::media::BufferReader::ReadCString</a></div><div class="ttdeci">bool ReadCString(std::string *str) WARN_UNUSED_RESULT</div><div class="ttdoc">Reads a null-terminated string.</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="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 <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>
|