shaka-packager/docs/d3/d5f/sync__point__queue_8h_sourc...

87 lines
16 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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Shaka Packager SDK: packager/media/chunking/sync_point_queue.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.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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_1338cd99faf71b6cb1609e99e3340e45.html">chunking</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">sync_point_queue.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 2018 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">#include &lt;map&gt;</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</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 &quot;packager/base/synchronization/condition_variable.h&quot;</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &quot;packager/base/synchronization/lock.h&quot;</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &quot;packager/media/public/ad_cue_generator_params.h&quot;</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="keyword">namespace </span><a class="code" href="../../d8/daf/namespaceshaka.html">shaka</a> {</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="keyword">namespace </span>media {</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">struct </span>CueEvent;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html"> 20</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html">SyncPointQueue</a> {</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keyword">explicit</span> <a class="code" href="../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html">SyncPointQueue</a>(<span class="keyword">const</span> <a class="code" href="../../dd/dfd/structshaka_1_1AdCueGeneratorParams.html">AdCueGeneratorParams</a>&amp; params);</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; ~<a class="code" href="../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html">SyncPointQueue</a>() = <span class="keywordflow">default</span>;</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">void</span> <a class="code" href="../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html#a84f1c4ad047ffa4bd75d5d1426bf9cd2">AddThread</a>();</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keywordtype">void</span> <a class="code" href="../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html#a77ec615ca1fa21d347bf03c537af9ed8">Cancel</a>();</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordtype">double</span> <a class="code" href="../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html#aef18f6547ff76cb8c6a5e14270950a59">GetHint</a>(<span class="keywordtype">double</span> time_in_seconds);</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; std::shared_ptr&lt;const CueEvent&gt; <a class="code" href="../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html#a49bdaa61608fe2229eaff4032dd804b1">GetNext</a>(<span class="keywordtype">double</span> hint_in_seconds);</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; std::shared_ptr&lt;const CueEvent&gt; <a class="code" href="../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html#a17af2cb9949f40ee8aa06cfdd55b2c16">PromoteAt</a>(<span class="keywordtype">double</span> time_in_seconds);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html#a5d27bfb8e8c3209222352f721f9b5236">HasMore</a>(<span class="keywordtype">double</span> hint_in_seconds) <span class="keyword">const</span>;</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; <span class="keyword">private</span>:</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <a class="code" href="../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html">SyncPointQueue</a>(<span class="keyword">const</span> <a class="code" href="../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html">SyncPointQueue</a>&amp;) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <a class="code" href="../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html">SyncPointQueue</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html">SyncPointQueue</a>&amp;) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="comment">// PromoteAt() without locking. It is called by PromoteAt() and other</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="comment">// functions that have locks.</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; std::shared_ptr&lt;const CueEvent&gt; PromoteAtNoLocking(<span class="keywordtype">double</span> time_in_seconds);</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; base::Lock lock_;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; base::ConditionVariable sync_condition_;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keywordtype">size_t</span> thread_count_ = 0;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keywordtype">size_t</span> waiting_thread_count_ = 0;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordtype">bool</span> cancelled_ = <span class="keyword">false</span>;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; std::map&lt;double, std::shared_ptr&lt;CueEvent&gt;&gt; unpromoted_;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; std::map&lt;double, std::shared_ptr&lt;CueEvent&gt;&gt; promoted_;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;};</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;} <span class="comment">// namespace media</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;} <span class="comment">// namespace shaka</span></div><div class="ttc" id="classshaka_1_1media_1_1SyncPointQueue_html_a84f1c4ad047ffa4bd75d5d1426bf9cd2"><div class="ttname"><a href="../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html#a84f1c4ad047ffa4bd75d5d1426bf9cd2">shaka::media::SyncPointQueue::AddThread</a></div><div class="ttdeci">void AddThread()</div><div class="ttdef"><b>Definition:</b> <a href="../../dc/d52/sync__point__queue_8cc_source.html#l00025">sync_point_queue.cc:25</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1SyncPointQueue_html_a5d27bfb8e8c3209222352f721f9b5236"><div class="ttname"><a href="../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html#a5d27bfb8e8c3209222352f721f9b5236">shaka::media::SyncPointQueue::HasMore</a></div><div class="ttdeci">bool HasMore(double hint_in_seconds) const</div><div class="ttdef"><b>Definition:</b> <a href="../../dc/d52/sync__point__queue_8cc_source.html#l00090">sync_point_queue.cc:90</a></div></div>
<div class="ttc" id="namespaceshaka_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="classshaka_1_1media_1_1SyncPointQueue_html_a49bdaa61608fe2229eaff4032dd804b1"><div class="ttname"><a href="../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html#a49bdaa61608fe2229eaff4032dd804b1">shaka::media::SyncPointQueue::GetNext</a></div><div class="ttdeci">std::shared_ptr&lt; const CueEvent &gt; GetNext(double hint_in_seconds)</div><div class="ttdef"><b>Definition:</b> <a href="../../dc/d52/sync__point__queue_8cc_source.html#l00054">sync_point_queue.cc:54</a></div></div>
<div class="ttc" id="structshaka_1_1AdCueGeneratorParams_html"><div class="ttname"><a href="../../dd/dfd/structshaka_1_1AdCueGeneratorParams.html">shaka::AdCueGeneratorParams</a></div><div class="ttdoc">Cuepoint generator related parameters. </div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d6f/ad__cue__generator__params_8h_source.html#l00023">ad_cue_generator_params.h:23</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1SyncPointQueue_html"><div class="ttname"><a href="../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html">shaka::media::SyncPointQueue</a></div><div class="ttdoc">A synchronized queue for cue points. </div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d5f/sync__point__queue_8h_source.html#l00020">sync_point_queue.h:20</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1SyncPointQueue_html_a17af2cb9949f40ee8aa06cfdd55b2c16"><div class="ttname"><a href="../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html#a17af2cb9949f40ee8aa06cfdd55b2c16">shaka::media::SyncPointQueue::PromoteAt</a></div><div class="ttdeci">std::shared_ptr&lt; const CueEvent &gt; PromoteAt(double time_in_seconds)</div><div class="ttdef"><b>Definition:</b> <a href="../../dc/d52/sync__point__queue_8cc_source.html#l00084">sync_point_queue.cc:84</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1SyncPointQueue_html_a77ec615ca1fa21d347bf03c537af9ed8"><div class="ttname"><a href="../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html#a77ec615ca1fa21d347bf03c537af9ed8">shaka::media::SyncPointQueue::Cancel</a></div><div class="ttdeci">void Cancel()</div><div class="ttdoc">Cancel the queue and unblock all threads. </div><div class="ttdef"><b>Definition:</b> <a href="../../dc/d52/sync__point__queue_8cc_source.html#l00030">sync_point_queue.cc:30</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1SyncPointQueue_html_aef18f6547ff76cb8c6a5e14270950a59"><div class="ttname"><a href="../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html#aef18f6547ff76cb8c6a5e14270950a59">shaka::media::SyncPointQueue::GetHint</a></div><div class="ttdeci">double GetHint(double time_in_seconds)</div><div class="ttdef"><b>Definition:</b> <a href="../../dc/d52/sync__point__queue_8cc_source.html#l00038">sync_point_queue.cc:38</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jun 7 2018 16:03:49 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.13
</small></address>
</body>
</html>