shaka-packager/docs/d9/df9/classshaka_1_1media_1_1Offs...

<!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: shaka::media::OffsetByteQueue Class Reference</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="../../d8/daf/namespaceshaka.html">shaka</a></li><li class="navelem"><b>media</b></li><li class="navelem"><a class="el" href="../../d9/df9/classshaka_1_1media_1_1OffsetByteQueue.html">OffsetByteQueue</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="../../d1/d4f/classshaka_1_1media_1_1OffsetByteQueue-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">shaka::media::OffsetByteQueue Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="../../de/d34/offset__byte__queue_8h_source.html">offset_byte_queue.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a68832e85b25a9b543e54033bb70c4df6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/df9/classshaka_1_1media_1_1OffsetByteQueue.html#a68832e85b25a9b543e54033bb70c4df6">PeekAt</a> (int64_t offset, const uint8_t **buf, int *size)</td></tr>
<tr class="separator:a68832e85b25a9b543e54033bb70c4df6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77b9a12145dad80df95845bd2b66b6a8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/df9/classshaka_1_1media_1_1OffsetByteQueue.html#a77b9a12145dad80df95845bd2b66b6a8">Trim</a> (int64_t max_offset)</td></tr>
<tr class="separator:a77b9a12145dad80df95845bd2b66b6a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1dfd11c891dd3b3171002cbc484eacdd"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/df9/classshaka_1_1media_1_1OffsetByteQueue.html#a1dfd11c891dd3b3171002cbc484eacdd">head</a> ()</td></tr>
<tr class="separator:a1dfd11c891dd3b3171002cbc484eacdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1aa8f95daa784e4dc1ce34566cea164"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/df9/classshaka_1_1media_1_1OffsetByteQueue.html#ab1aa8f95daa784e4dc1ce34566cea164">tail</a> ()</td></tr>
<tr class="separator:ab1aa8f95daa784e4dc1ce34566cea164"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">These work like their underlying ByteQueue counterparts.</div></td></tr>
<tr class="memitem:aeba9d73927d141729fe5d743f679b631"><td class="memItemLeft" align="right" valign="top"><a id="aeba9d73927d141729fe5d743f679b631"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Reset</b> ()</td></tr>
<tr class="separator:aeba9d73927d141729fe5d743f679b631"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada47e4998cbad83bdaa058a1cfbc6ef9"><td class="memItemLeft" align="right" valign="top"><a id="ada47e4998cbad83bdaa058a1cfbc6ef9"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Push</b> (const uint8_t *buf, int size)</td></tr>
<tr class="separator:ada47e4998cbad83bdaa058a1cfbc6ef9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad72a137b44fd86eda54d3e06b1793f5a"><td class="memItemLeft" align="right" valign="top"><a id="ad72a137b44fd86eda54d3e06b1793f5a"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Peek</b> (const uint8_t **buf, int *size)</td></tr>
<tr class="separator:ad72a137b44fd86eda54d3e06b1793f5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0338401ee845918697d3b9884deab3a1"><td class="memItemLeft" align="right" valign="top"><a id="a0338401ee845918697d3b9884deab3a1"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Pop</b> (int count)</td></tr>
<tr class="separator:a0338401ee845918697d3b9884deab3a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Wrapper around <a class="el" href="../../d7/dda/classshaka_1_1media_1_1ByteQueue.html">ByteQueue</a>, which encapsulates the notion of a monotonically-increasing byte offset. All buffer access is done by passing these offsets into this class, reducing the proliferation of many different meanings of "offset", "head", etc. </p>

<p class="definition">Definition at line <a class="el" href="../../de/d34/offset__byte__queue_8h_source.html#l00019">19</a> of file <a class="el" href="../../de/d34/offset__byte__queue_8h_source.html">offset_byte_queue.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a1dfd11c891dd3b3171002cbc484eacdd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1dfd11c891dd3b3171002cbc484eacdd">&#9670;&nbsp;</a></span>head()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int64_t shaka::media::OffsetByteQueue::head </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>The head position, in terms of the file's absolute offset. </dd></dl>

<p class="definition">Definition at line <a class="el" href="../../de/d34/offset__byte__queue_8h_source.html#l00052">52</a> of file <a class="el" href="../../de/d34/offset__byte__queue_8h_source.html">offset_byte_queue.h</a>.</p>

</div>
</div>
<a id="a68832e85b25a9b543e54033bb70c4df6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68832e85b25a9b543e54033bb70c4df6">&#9670;&nbsp;</a></span>PeekAt()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void shaka::media::OffsetByteQueue::PeekAt </td>
          <td>(</td>
          <td class="paramtype">int64_t&#160;</td>
          <td class="paramname"><em>offset</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint8_t **&#160;</td>
          <td class="paramname"><em>buf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int *&#160;</td>
          <td class="paramname"><em>size</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set <em>buf</em> to point at the first buffered byte corresponding to <em>offset</em>, and <em>size</em> to the number of bytes available starting from that offset.</p>
<p>It is an error if the offset is before the current head. It's not an error if the current offset is beyond <a class="el" href="../../d9/df9/classshaka_1_1media_1_1OffsetByteQueue.html#ab1aa8f95daa784e4dc1ce34566cea164">tail()</a>, but you will of course get back a null <em>buf</em> and a <em>size</em> of zero. </p>

<p class="definition">Definition at line <a class="el" href="../../df/d1a/offset__byte__queue_8cc_source.html#l00041">41</a> of file <a class="el" href="../../df/d1a/offset__byte__queue_8cc_source.html">offset_byte_queue.cc</a>.</p>

</div>
</div>
<a id="ab1aa8f95daa784e4dc1ce34566cea164"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab1aa8f95daa784e4dc1ce34566cea164">&#9670;&nbsp;</a></span>tail()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int64_t shaka::media::OffsetByteQueue::tail </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>The tail position (exclusive), in terms of the file's absolute offset. </dd></dl>

<p class="definition">Definition at line <a class="el" href="../../de/d34/offset__byte__queue_8h_source.html#l00055">55</a> of file <a class="el" href="../../de/d34/offset__byte__queue_8h_source.html">offset_byte_queue.h</a>.</p>

</div>
</div>
<a id="a77b9a12145dad80df95845bd2b66b6a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a77b9a12145dad80df95845bd2b66b6a8">&#9670;&nbsp;</a></span>Trim()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool shaka::media::OffsetByteQueue::Trim </td>
          <td>(</td>
          <td class="paramtype">int64_t&#160;</td>
          <td class="paramname"><em>max_offset</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Mark the bytes up to (but not including) <em>max_offset</em> as ready for deletion. This is relatively inexpensive, but will not necessarily reduce the resident buffer size right away (or ever).</p>
<dl class="section return"><dt>Returns</dt><dd>true if the full range of bytes were successfully trimmed, including the case where <em>max_offset</em> is less than the current head. </dd>
<dd>
false if <em>max_offset</em> &gt; <a class="el" href="../../d9/df9/classshaka_1_1media_1_1OffsetByteQueue.html#ab1aa8f95daa784e4dc1ce34566cea164">tail()</a> (although all bytes currently buffered are still cleared). </dd></dl>

<p class="definition">Definition at line <a class="el" href="../../df/d1a/offset__byte__queue_8cc_source.html#l00051">51</a> of file <a class="el" href="../../df/d1a/offset__byte__queue_8cc_source.html">offset_byte_queue.cc</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>packager/media/base/<a class="el" href="../../de/d34/offset__byte__queue_8h_source.html">offset_byte_queue.h</a></li>
<li>packager/media/base/<a class="el" href="../../df/d1a/offset__byte__queue_8cc_source.html">offset_byte_queue.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jun 22 2021 00:16:05 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>