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

163 lines
19 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/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/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>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><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_279fd47bebb21302c25cfb685e84c359.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"></span><span class="preprocessor">#define MEDIA_FILE_MEDIA_FILE_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/media/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>shaka {</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="keyword">namespace </span>media {</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html"> 22</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html">MemoryFile</a> : <span class="keyword">public</span> <a class="code" href="../../d3/d61/classshaka_1_1media_1_1File.html">File</a> {</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <a class="code" href="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html">MemoryFile</a>(<span class="keyword">const</span> std::string&amp; <a class="code" href="../../d3/d61/classshaka_1_1media_1_1File.html#abe158b9e7b1e073956a16c55a8fcf5f4">file_name</a>, <span class="keyword">const</span> std::string&amp; mode);</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html#ae6008d3d8401bd9eb561165e142afc6b">Close</a>() <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="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html#aac5f63ba0bb136eac2260a034edc10cf">Read</a>(<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="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html#a429e316e7bf529acb3586df1cd02be64">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="l00031"></a><span class="lineno"> 31</span>&#160; int64_t <a class="code" href="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html#ad52955a976c16b910dde372fe33b7b0d">Size</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="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html#abc1d0dc10b8ad719b92959c72c394b64">Flush</a>() <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="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html#af99f8c96589175e9a2f386e6a2ed4f35">Seek</a>(uint64_t position) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html#a0346e0c4f961c06041efeaf43aee8f03">Tell</a>(uint64_t* position) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html#a79f4eedb79cd2251bca60c861eccf3ba">DeleteAll</a>();</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html#a1079b0a5e919c79cbc97e28f11ac8a81">Delete</a>(<span class="keyword">const</span> std::string&amp; file_name);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; ~<a class="code" href="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html">MemoryFile</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html#a3b376ae2d03aac9c950c608b55af1f91">Open</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; std::string mode_;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; std::vector&lt;uint8_t&gt;* file_;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; uint64_t position_;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; DISALLOW_COPY_AND_ASSIGN(<a class="code" href="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html">MemoryFile</a>);</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;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;} <span class="comment">// namespace media</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;} <span class="comment">// namespace shaka</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="preprocessor">#endif // MEDIA_FILE_MEDIA_FILE_H_</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="preprocessor"></span></div>
<div class="ttc" id="classshaka_1_1media_1_1MemoryFile_html_a79f4eedb79cd2251bca60c861eccf3ba"><div class="ttname"><a href="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html#a79f4eedb79cd2251bca60c861eccf3ba">shaka::media::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#l00130">memory_file.cc:130</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1MemoryFile_html_ad52955a976c16b910dde372fe33b7b0d"><div class="ttname"><a href="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html#ad52955a976c16b910dde372fe33b7b0d">shaka::media::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#l00090">memory_file.cc:90</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1MemoryFile_html_aac5f63ba0bb136eac2260a034edc10cf"><div class="ttname"><a href="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html#aac5f63ba0bb136eac2260a034edc10cf">shaka::media::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#l00067">memory_file.cc:67</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1MemoryFile_html_a429e316e7bf529acb3586df1cd02be64"><div class="ttname"><a href="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html#a429e316e7bf529acb3586df1cd02be64">shaka::media::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#l00079">memory_file.cc:79</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1File_html"><div class="ttname"><a href="../../d3/d61/classshaka_1_1media_1_1File.html">shaka::media::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#l00024">file.h:24</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1MemoryFile_html"><div class="ttname"><a href="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html">shaka::media::MemoryFile</a></div><div class="ttdef"><b>Definition:</b> <a href="../../db/da6/memory__file_8h_source.html#l00022">memory_file.h:22</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1MemoryFile_html_a0346e0c4f961c06041efeaf43aee8f03"><div class="ttname"><a href="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html#a0346e0c4f961c06041efeaf43aee8f03">shaka::media::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#l00107">memory_file.cc:107</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1MemoryFile_html_a1079b0a5e919c79cbc97e28f11ac8a81"><div class="ttname"><a href="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html#a1079b0a5e919c79cbc97e28f11ac8a81">shaka::media::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#l00134">memory_file.cc:134</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1MemoryFile_html_a3b376ae2d03aac9c950c608b55af1f91"><div class="ttname"><a href="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html#a3b376ae2d03aac9c950c608b55af1f91">shaka::media::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#l00112">memory_file.cc:112</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1MemoryFile_html_af99f8c96589175e9a2f386e6a2ed4f35"><div class="ttname"><a href="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html#af99f8c96589175e9a2f386e6a2ed4f35">shaka::media::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#l00099">memory_file.cc:99</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1File_html_abe158b9e7b1e073956a16c55a8fcf5f4"><div class="ttname"><a href="../../d3/d61/classshaka_1_1media_1_1File.html#abe158b9e7b1e073956a16c55a8fcf5f4">shaka::media::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#l00091">file.h:91</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1MemoryFile_html_abc1d0dc10b8ad719b92959c72c394b64"><div class="ttname"><a href="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html#abc1d0dc10b8ad719b92959c72c394b64">shaka::media::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#l00095">memory_file.cc:95</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1MemoryFile_html_ae6008d3d8401bd9eb561165e142afc6b"><div class="ttname"><a href="../../d9/dbd/classshaka_1_1media_1_1MemoryFile.html#ae6008d3d8401bd9eb561165e142afc6b">shaka::media::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#l00062">memory_file.cc:62</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Jul 11 2016 18:03:03 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>