shaka-packager/docs/db/da6/memory__file_8h_source.html

143 lines
17 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/file/memory_file.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_d258fb6e36cbaad69b44b6c9489b2bbb.html">file</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">memory_file.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 2015 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_FILE_MEDIA_FILE_H_</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#define MEDIA_FILE_MEDIA_FILE_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;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/file/file.h&quot;</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="keyword">namespace </span><a class="code" href="../../d8/daf/namespaceshaka.html">shaka</a> {</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="../../de/dad/classshaka_1_1MemoryFile.html"> 21</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../de/dad/classshaka_1_1MemoryFile.html">MemoryFile</a> : <span class="keyword">public</span> <a class="code" href="../../d3/d73/classshaka_1_1File.html">File</a> {</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <a class="code" href="../../de/dad/classshaka_1_1MemoryFile.html">MemoryFile</a>(<span class="keyword">const</span> std::string&amp; <a class="code" href="../../d3/d73/classshaka_1_1File.html#a4b06e08bb0295cb89fca45f9356ecbae">file_name</a>, <span class="keyword">const</span> std::string&amp; mode);</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../de/dad/classshaka_1_1MemoryFile.html#a4cfe38684f4fdde650a2ed7fdc780f05">Close</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; int64_t <a class="code" href="../../de/dad/classshaka_1_1MemoryFile.html#aeacb3b7f72e0c412bd0cba8a6f1ed62f">Read</a>(<span class="keywordtype">void</span>* buffer, uint64_t length) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; int64_t <a class="code" href="../../de/dad/classshaka_1_1MemoryFile.html#aa3d9455b7bc9d1c44d58ab39bd8bd27c">Write</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* buffer, uint64_t length) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; int64_t <a class="code" href="../../de/dad/classshaka_1_1MemoryFile.html#a151634866be009cf0eb10e783432d5cb">Size</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../de/dad/classshaka_1_1MemoryFile.html#aecf76d1658ea5f088ef1e42f04b9b64d">Flush</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../de/dad/classshaka_1_1MemoryFile.html#a0e3bffa9859fdcb7c28c20a15e2d3e98">Seek</a>(uint64_t position) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../de/dad/classshaka_1_1MemoryFile.html#a4dfdba703861d211e7111612f5ac029c">Tell</a>(uint64_t* position) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="../../de/dad/classshaka_1_1MemoryFile.html#acd947572c2bbe3595b403a483c82e899">DeleteAll</a>();</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="../../de/dad/classshaka_1_1MemoryFile.html#a3ac9c9e8e3a31ef8f70a904384f89bed">Delete</a>(<span class="keyword">const</span> std::string&amp; <a class="code" href="../../d3/d73/classshaka_1_1File.html#a4b06e08bb0295cb89fca45f9356ecbae">file_name</a>);</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; ~<a class="code" href="../../de/dad/classshaka_1_1MemoryFile.html">MemoryFile</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../de/dad/classshaka_1_1MemoryFile.html#adcfb56e702dcee156b4b103180134241">Open</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; std::string mode_;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; std::vector&lt;uint8_t&gt;* file_;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; uint64_t position_;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; DISALLOW_COPY_AND_ASSIGN(<a class="code" href="../../de/dad/classshaka_1_1MemoryFile.html">MemoryFile</a>);</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;};</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="comment">// namespace shaka</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="preprocessor">#endif // MEDIA_FILE_MEDIA_FILE_H_</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassshaka_1_1MemoryFile_html_aecf76d1658ea5f088ef1e42f04b9b64d"><div class="ttname"><a href="../../de/dad/classshaka_1_1MemoryFile.html#aecf76d1658ea5f088ef1e42f04b9b64d">shaka::MemoryFile::Flush</a></div><div class="ttdeci">bool Flush() override</div><div class="ttdef"><b>Definition:</b> <a href="../../dd/d87/memory__file_8cc_source.html#l00160">memory_file.cc:160</a></div></div>
<div class="ttc" id="aclassshaka_1_1MemoryFile_html_aa3d9455b7bc9d1c44d58ab39bd8bd27c"><div class="ttname"><a href="../../de/dad/classshaka_1_1MemoryFile.html#aa3d9455b7bc9d1c44d58ab39bd8bd27c">shaka::MemoryFile::Write</a></div><div class="ttdeci">int64_t Write(const void *buffer, uint64_t length) override</div><div class="ttdef"><b>Definition:</b> <a href="../../dd/d87/memory__file_8cc_source.html#l00137">memory_file.cc:137</a></div></div>
<div class="ttc" id="aclassshaka_1_1MemoryFile_html_aeacb3b7f72e0c412bd0cba8a6f1ed62f"><div class="ttname"><a href="../../de/dad/classshaka_1_1MemoryFile.html#aeacb3b7f72e0c412bd0cba8a6f1ed62f">shaka::MemoryFile::Read</a></div><div class="ttdeci">int64_t Read(void *buffer, uint64_t length) override</div><div class="ttdef"><b>Definition:</b> <a href="../../dd/d87/memory__file_8cc_source.html#l00125">memory_file.cc:125</a></div></div>
<div class="ttc" id="aclassshaka_1_1File_html_a4b06e08bb0295cb89fca45f9356ecbae"><div class="ttname"><a href="../../d3/d73/classshaka_1_1File.html#a4b06e08bb0295cb89fca45f9356ecbae">shaka::File::file_name</a></div><div class="ttdeci">const std::string &amp; file_name() const</div><div class="ttdef"><b>Definition:</b> <a href="../../d2/d4d/file_8h_source.html#l00096">file.h:96</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 class="ttc" id="aclassshaka_1_1MemoryFile_html_a0e3bffa9859fdcb7c28c20a15e2d3e98"><div class="ttname"><a href="../../de/dad/classshaka_1_1MemoryFile.html#a0e3bffa9859fdcb7c28c20a15e2d3e98">shaka::MemoryFile::Seek</a></div><div class="ttdeci">bool Seek(uint64_t position) override</div><div class="ttdef"><b>Definition:</b> <a href="../../dd/d87/memory__file_8cc_source.html#l00164">memory_file.cc:164</a></div></div>
<div class="ttc" id="aclassshaka_1_1MemoryFile_html_a3ac9c9e8e3a31ef8f70a904384f89bed"><div class="ttname"><a href="../../de/dad/classshaka_1_1MemoryFile.html#a3ac9c9e8e3a31ef8f70a904384f89bed">shaka::MemoryFile::Delete</a></div><div class="ttdeci">static void Delete(const std::string &amp;file_name)</div><div class="ttdef"><b>Definition:</b> <a href="../../dd/d87/memory__file_8cc_source.html#l00190">memory_file.cc:190</a></div></div>
<div class="ttc" id="aclassshaka_1_1MemoryFile_html"><div class="ttname"><a href="../../de/dad/classshaka_1_1MemoryFile.html">shaka::MemoryFile</a></div><div class="ttdef"><b>Definition:</b> <a href="../../db/da6/memory__file_8h_source.html#l00021">memory_file.h:21</a></div></div>
<div class="ttc" id="aclassshaka_1_1MemoryFile_html_a151634866be009cf0eb10e783432d5cb"><div class="ttname"><a href="../../de/dad/classshaka_1_1MemoryFile.html#a151634866be009cf0eb10e783432d5cb">shaka::MemoryFile::Size</a></div><div class="ttdeci">int64_t Size() override</div><div class="ttdef"><b>Definition:</b> <a href="../../dd/d87/memory__file_8cc_source.html#l00155">memory_file.cc:155</a></div></div>
<div class="ttc" id="aclassshaka_1_1File_html"><div class="ttname"><a href="../../d3/d73/classshaka_1_1File.html">shaka::File</a></div><div class="ttdoc">Define an abstract file interface.</div><div class="ttdef"><b>Definition:</b> <a href="../../d2/d4d/file_8h_source.html#l00028">file.h:28</a></div></div>
<div class="ttc" id="aclassshaka_1_1MemoryFile_html_a4dfdba703861d211e7111612f5ac029c"><div class="ttname"><a href="../../de/dad/classshaka_1_1MemoryFile.html#a4dfdba703861d211e7111612f5ac029c">shaka::MemoryFile::Tell</a></div><div class="ttdeci">bool Tell(uint64_t *position) override</div><div class="ttdef"><b>Definition:</b> <a href="../../dd/d87/memory__file_8cc_source.html#l00172">memory_file.cc:172</a></div></div>
<div class="ttc" id="aclassshaka_1_1MemoryFile_html_a4cfe38684f4fdde650a2ed7fdc780f05"><div class="ttname"><a href="../../de/dad/classshaka_1_1MemoryFile.html#a4cfe38684f4fdde650a2ed7fdc780f05">shaka::MemoryFile::Close</a></div><div class="ttdeci">bool Close() override</div><div class="ttdef"><b>Definition:</b> <a href="../../dd/d87/memory__file_8cc_source.html#l00118">memory_file.cc:118</a></div></div>
<div class="ttc" id="aclassshaka_1_1MemoryFile_html_adcfb56e702dcee156b4b103180134241"><div class="ttname"><a href="../../de/dad/classshaka_1_1MemoryFile.html#adcfb56e702dcee156b4b103180134241">shaka::MemoryFile::Open</a></div><div class="ttdeci">bool Open() override</div><div class="ttdoc">Internal open. Should not be used directly.</div><div class="ttdef"><b>Definition:</b> <a href="../../dd/d87/memory__file_8cc_source.html#l00177">memory_file.cc:177</a></div></div>
<div class="ttc" id="aclassshaka_1_1MemoryFile_html_acd947572c2bbe3595b403a483c82e899"><div class="ttname"><a href="../../de/dad/classshaka_1_1MemoryFile.html#acd947572c2bbe3595b403a483c82e899">shaka::MemoryFile::DeleteAll</a></div><div class="ttdeci">static void DeleteAll()</div><div class="ttdef"><b>Definition:</b> <a href="../../dd/d87/memory__file_8cc_source.html#l00186">memory_file.cc:186</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jun 22 2021 00:16:03 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>