171 lines
18 KiB
HTML
171 lines
18 KiB
HTML
<!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/io_cache.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 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 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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </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">io_cache.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 2015 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_FILE_IO_CACHE_H_</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor"></span><span class="preprocessor">#define PACKAGER_FILE_IO_CACHE_H_</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor"></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> <span class="preprocessor">#include <vector></span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include "packager/base/macros.h"</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "packager/base/synchronization/lock.h"</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "packager/base/synchronization/waitable_event.h"</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">namespace </span>shaka {</div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">namespace </span>media {</div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="../../dd/d7c/classshaka_1_1media_1_1IoCache.html"> 20</a></span> <span class="keyword">class </span><a class="code" href="../../dd/d7c/classshaka_1_1media_1_1IoCache.html">IoCache</a> {</div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keyword">explicit</span> <a class="code" href="../../dd/d7c/classshaka_1_1media_1_1IoCache.html">IoCache</a>(uint64_t cache_size);</div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  ~<a class="code" href="../../dd/d7c/classshaka_1_1media_1_1IoCache.html">IoCache</a>();</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  uint64_t <a class="code" href="../../dd/d7c/classshaka_1_1media_1_1IoCache.html#a3cb864f866af25f0ff92c367946b0945">Read</a>(<span class="keywordtype">void</span>* buffer, uint64_t size);</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  uint64_t <a class="code" href="../../dd/d7c/classshaka_1_1media_1_1IoCache.html#a0349796209c24a99bfe3c1bfdafb1d28">Write</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* buffer, uint64_t size);</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordtype">void</span> <a class="code" href="../../dd/d7c/classshaka_1_1media_1_1IoCache.html#a29080034b90671628ea681e10ea92a48">Clear</a>();</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">void</span> <a class="code" href="../../dd/d7c/classshaka_1_1media_1_1IoCache.html#a23dfcb4d031d76e980e41d1b1bec7112">Close</a>();</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="../../dd/d7c/classshaka_1_1media_1_1IoCache.html#adc8aa1afaa3d4ef689e7f2b9ab0e5135"> 50</a></span>  <span class="keywordtype">bool</span> <a class="code" href="../../dd/d7c/classshaka_1_1media_1_1IoCache.html#adc8aa1afaa3d4ef689e7f2b9ab0e5135">closed</a>() { <span class="keywordflow">return</span> closed_; }</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">void</span> <a class="code" href="../../dd/d7c/classshaka_1_1media_1_1IoCache.html#ae751faea047196ba2770f5bf90649185">Reopen</a>();</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  uint64_t <a class="code" href="../../dd/d7c/classshaka_1_1media_1_1IoCache.html#a385baed04dd0cc0d3dca20d78f61559f">BytesCached</a>();</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  uint64_t <a class="code" href="../../dd/d7c/classshaka_1_1media_1_1IoCache.html#a74e1d7369afe4f03c551b6e67ec82ee9">BytesFree</a>();</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordtype">void</span> <a class="code" href="../../dd/d7c/classshaka_1_1media_1_1IoCache.html#a841a082bfd88280a4ea00ac1a9e64dac">WaitUntilEmptyOrClosed</a>();</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">private</span>:</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  uint64_t BytesCachedInternal();</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  uint64_t BytesFreeInternal();</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">const</span> uint64_t cache_size_;</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  base::Lock lock_;</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  base::WaitableEvent read_event_;</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  base::WaitableEvent write_event_;</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  std::vector<uint8_t> circular_buffer_;</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">const</span> uint8_t* end_ptr_;</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  uint8_t* r_ptr_;</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  uint8_t* w_ptr_;</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordtype">bool</span> closed_;</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  DISALLOW_COPY_AND_ASSIGN(<a class="code" href="../../dd/d7c/classshaka_1_1media_1_1IoCache.html">IoCache</a>);</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> </div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> } <span class="comment">// namespace media</span></div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> } <span class="comment">// namespace shaka</span></div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor">#endif // PACKAGER_FILE_IO_CACHE_H</span></div>
|
|
<div class="ttc" id="classshaka_1_1media_1_1IoCache_html_adc8aa1afaa3d4ef689e7f2b9ab0e5135"><div class="ttname"><a href="../../dd/d7c/classshaka_1_1media_1_1IoCache.html#adc8aa1afaa3d4ef689e7f2b9ab0e5135">shaka::media::IoCache::closed</a></div><div class="ttdeci">bool closed()</div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d19/io__cache_8h_source.html#l00050">io_cache.h:50</a></div></div>
|
|
<div class="ttc" id="classshaka_1_1media_1_1IoCache_html_a29080034b90671628ea681e10ea92a48"><div class="ttname"><a href="../../dd/d7c/classshaka_1_1media_1_1IoCache.html#a29080034b90671628ea681e10ea92a48">shaka::media::IoCache::Clear</a></div><div class="ttdeci">void Clear()</div><div class="ttdoc">Empties the cache. </div><div class="ttdef"><b>Definition:</b> <a href="../../d4/d37/io__cache_8cc_source.html#l00104">io_cache.cc:104</a></div></div>
|
|
<div class="ttc" id="classshaka_1_1media_1_1IoCache_html_a23dfcb4d031d76e980e41d1b1bec7112"><div class="ttname"><a href="../../dd/d7c/classshaka_1_1media_1_1IoCache.html#a23dfcb4d031d76e980e41d1b1bec7112">shaka::media::IoCache::Close</a></div><div class="ttdeci">void Close()</div><div class="ttdef"><b>Definition:</b> <a href="../../d4/d37/io__cache_8cc_source.html#l00111">io_cache.cc:111</a></div></div>
|
|
<div class="ttc" id="classshaka_1_1media_1_1IoCache_html_a841a082bfd88280a4ea00ac1a9e64dac"><div class="ttname"><a href="../../dd/d7c/classshaka_1_1media_1_1IoCache.html#a841a082bfd88280a4ea00ac1a9e64dac">shaka::media::IoCache::WaitUntilEmptyOrClosed</a></div><div class="ttdeci">void WaitUntilEmptyOrClosed()</div><div class="ttdoc">Waits until the cache is empty or has been closed. </div><div class="ttdef"><b>Definition:</b> <a href="../../d4/d37/io__cache_8cc_source.html#l00147">io_cache.cc:147</a></div></div>
|
|
<div class="ttc" id="classshaka_1_1media_1_1IoCache_html_a74e1d7369afe4f03c551b6e67ec82ee9"><div class="ttname"><a href="../../dd/d7c/classshaka_1_1media_1_1IoCache.html#a74e1d7369afe4f03c551b6e67ec82ee9">shaka::media::IoCache::BytesFree</a></div><div class="ttdeci">uint64_t BytesFree()</div><div class="ttdef"><b>Definition:</b> <a href="../../d4/d37/io__cache_8cc_source.html#l00132">io_cache.cc:132</a></div></div>
|
|
<div class="ttc" id="classshaka_1_1media_1_1IoCache_html_ae751faea047196ba2770f5bf90649185"><div class="ttname"><a href="../../dd/d7c/classshaka_1_1media_1_1IoCache.html#ae751faea047196ba2770f5bf90649185">shaka::media::IoCache::Reopen</a></div><div class="ttdeci">void Reopen()</div><div class="ttdoc">Reopens the cache. Any data still in the cache will be lost. </div><div class="ttdef"><b>Definition:</b> <a href="../../d4/d37/io__cache_8cc_source.html#l00118">io_cache.cc:118</a></div></div>
|
|
<div class="ttc" id="classshaka_1_1media_1_1IoCache_html_a3cb864f866af25f0ff92c367946b0945"><div class="ttname"><a href="../../dd/d7c/classshaka_1_1media_1_1IoCache.html#a3cb864f866af25f0ff92c367946b0945">shaka::media::IoCache::Read</a></div><div class="ttdeci">uint64_t Read(void *buffer, uint64_t size)</div><div class="ttdef"><b>Definition:</b> <a href="../../d4/d37/io__cache_8cc_source.html#l00040">io_cache.cc:40</a></div></div>
|
|
<div class="ttc" id="classshaka_1_1media_1_1IoCache_html_a385baed04dd0cc0d3dca20d78f61559f"><div class="ttname"><a href="../../dd/d7c/classshaka_1_1media_1_1IoCache.html#a385baed04dd0cc0d3dca20d78f61559f">shaka::media::IoCache::BytesCached</a></div><div class="ttdeci">uint64_t BytesCached()</div><div class="ttdef"><b>Definition:</b> <a href="../../d4/d37/io__cache_8cc_source.html#l00127">io_cache.cc:127</a></div></div>
|
|
<div class="ttc" id="classshaka_1_1media_1_1IoCache_html_a0349796209c24a99bfe3c1bfdafb1d28"><div class="ttname"><a href="../../dd/d7c/classshaka_1_1media_1_1IoCache.html#a0349796209c24a99bfe3c1bfdafb1d28">shaka::media::IoCache::Write</a></div><div class="ttdeci">uint64_t Write(const void *buffer, uint64_t size)</div><div class="ttdef"><b>Definition:</b> <a href="../../d4/d37/io__cache_8cc_source.html#l00068">io_cache.cc:68</a></div></div>
|
|
<div class="ttc" id="classshaka_1_1media_1_1IoCache_html"><div class="ttname"><a href="../../dd/d7c/classshaka_1_1media_1_1IoCache.html">shaka::media::IoCache</a></div><div class="ttdoc">Declaration of class which implements a thread-safe circular buffer. </div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d19/io__cache_8h_source.html#l00020">io_cache.h:20</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Mon Feb 13 2017 22:34:18 for DASH Media Packaging SDK by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.6
|
|
</small></address>
|
|
</body>
|
|
</html>
|