shaka-packager/docs/d7/d79/chunking__handler_8h_source...

162 lines
18 KiB
HTML
Raw Normal View History

<!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"/>
2021-06-22 00:16:40 +00:00
<meta name="generator" content="Doxygen 1.8.17"/>
2018-02-10 23:37:42 +00:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Shaka Packager SDK: packager/media/chunking/chunking_handler.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"/>
2018-02-10 23:37:42 +00:00
<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;">
2018-02-10 23:37:42 +00:00
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Shaka Packager SDK
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
2021-06-22 00:16:40 +00:00
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2021-06-22 00:16:40 +00:00
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
/* @license-end */
</script>
2018-02-10 23:37:42 +00:00
<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 */
2018-02-10 23:37:42 +00:00
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
2018-02-10 23:37:42 +00:00
<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)">
2018-02-10 23:37:42 +00:00
</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">chunking_handler.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 2017 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 PACKAGER_MEDIA_CHUNKING_CHUNKING_HANDLER_</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#define PACKAGER_MEDIA_CHUNKING_CHUNKING_HANDLER_</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;atomic&gt;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &lt;queue&gt;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; </div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &quot;packager/base/logging.h&quot;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &quot;packager/base/optional.h&quot;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &quot;packager/media/base/media_handler.h&quot;</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &quot;packager/media/public/chunking_params.h&quot;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="keyword">namespace </span><a class="code" href="../../d8/daf/namespaceshaka.html">shaka</a> {</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="keyword">namespace </span>media {</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="../../d4/d43/classshaka_1_1media_1_1ChunkingHandler.html"> 39</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../d4/d43/classshaka_1_1media_1_1ChunkingHandler.html">ChunkingHandler</a> : <span class="keyword">public</span> <a class="code" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html">MediaHandler</a> {</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">explicit</span> <a class="code" href="../../d4/d43/classshaka_1_1media_1_1ChunkingHandler.html">ChunkingHandler</a>(<span class="keyword">const</span> <a class="code" href="../../d2/d1f/structshaka_1_1ChunkingParams.html">ChunkingParams</a>&amp; chunking_params);</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; ~<a class="code" href="../../d4/d43/classshaka_1_1media_1_1ChunkingHandler.html">ChunkingHandler</a>() <span class="keyword">override</span> = <span class="keywordflow">default</span>;</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="l00047"></a><span class="lineno"> 47</span>&#160; <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> <a class="code" href="../../d4/d43/classshaka_1_1media_1_1ChunkingHandler.html#a76a5f4b74da3876cc72f44301c389ebd">InitializeInternal</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> <a class="code" href="../../d4/d43/classshaka_1_1media_1_1ChunkingHandler.html#a44c30ffd7c283be2ba4347bda7848633">Process</a>(std::unique_ptr&lt;StreamData&gt; stream_data) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> <a class="code" href="../../d4/d43/classshaka_1_1media_1_1ChunkingHandler.html#ab526bd53e4d49d7209f01d9b10b9ab52">OnFlushRequest</a>(<span class="keywordtype">size_t</span> input_stream_index) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span>ChunkingHandlerTest;</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; <a class="code" href="../../d4/d43/classshaka_1_1media_1_1ChunkingHandler.html">ChunkingHandler</a>(<span class="keyword">const</span> <a class="code" href="../../d4/d43/classshaka_1_1media_1_1ChunkingHandler.html">ChunkingHandler</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <a class="code" href="../../d4/d43/classshaka_1_1media_1_1ChunkingHandler.html">ChunkingHandler</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="../../d4/d43/classshaka_1_1media_1_1ChunkingHandler.html">ChunkingHandler</a>&amp;) = <span class="keyword">delete</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; <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> OnStreamInfo(std::shared_ptr&lt;const StreamInfo&gt; info);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> OnCueEvent(std::shared_ptr&lt;const CueEvent&gt; event);</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> OnMediaSample(std::shared_ptr&lt;const MediaSample&gt; sample);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> EndSegmentIfStarted() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> EndSubsegmentIfStarted() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keywordtype">bool</span> IsSubsegmentEnabled() {</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keywordflow">return</span> subsegment_duration_ &gt; 0 &amp;&amp;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; subsegment_duration_ != segment_duration_;</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; </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keyword">const</span> <a class="code" href="../../d2/d1f/structshaka_1_1ChunkingParams.html">ChunkingParams</a> chunking_params_;</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; <span class="comment">// Segment and subsegment duration in stream&#39;s time scale.</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; int64_t segment_duration_ = 0;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; int64_t subsegment_duration_ = 0;</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="comment">// Current segment index, useful to determine where to do chunking.</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; int64_t current_segment_index_ = -1;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="comment">// Current subsegment index, useful to determine where to do chunking.</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; int64_t current_subsegment_index_ = -1;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; base::Optional&lt;int64_t&gt; segment_start_time_;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; base::Optional&lt;int64_t&gt; subsegment_start_time_;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; int64_t max_segment_time_ = 0;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; uint32_t time_scale_ = 0;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="comment">// The offset is applied to sample timestamps so a full segment is generated</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="comment">// after cue points.</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; int64_t cue_offset_ = 0;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;};</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;} <span class="comment">// namespace media</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;} <span class="comment">// namespace shaka</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; </div>
2021-06-22 00:16:40 +00:00
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;<span class="preprocessor">#endif // PACKAGER_MEDIA_CHUNKING_CHUNKING_HANDLER_</span></div>
</div><!-- fragment --></div><!-- contents -->
<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_1media_1_1ChunkingHandler_html_a44c30ffd7c283be2ba4347bda7848633"><div class="ttname"><a href="../../d4/d43/classshaka_1_1media_1_1ChunkingHandler.html#a44c30ffd7c283be2ba4347bda7848633">shaka::media::ChunkingHandler::Process</a></div><div class="ttdeci">Status Process(std::unique_ptr&lt; StreamData &gt; stream_data) override</div><div class="ttdef"><b>Definition:</b> <a href="../../d9/d12/chunking__handler_8cc_source.html#l00044">chunking_handler.cc:44</a></div></div>
2021-06-22 00:16:40 +00:00
<div class="ttc" id="aclassshaka_1_1Status_html"><div class="ttname"><a href="../../d2/d20/classshaka_1_1Status.html">shaka::Status</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d1/d13/status_8h_source.html#l00110">status.h:110</a></div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1ChunkingHandler_html_a76a5f4b74da3876cc72f44301c389ebd"><div class="ttname"><a href="../../d4/d43/classshaka_1_1media_1_1ChunkingHandler.html#a76a5f4b74da3876cc72f44301c389ebd">shaka::media::ChunkingHandler::InitializeInternal</a></div><div class="ttdeci">Status InitializeInternal() override</div><div class="ttdef"><b>Definition:</b> <a href="../../d9/d12/chunking__handler_8cc_source.html#l00036">chunking_handler.cc:36</a></div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1MediaHandler_html"><div class="ttname"><a href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html">shaka::media::MediaHandler</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d93/media__handler_8h_source.html#l00154">media_handler.h:154</a></div></div>
<div class="ttc" id="astructshaka_1_1ChunkingParams_html"><div class="ttname"><a href="../../d2/d1f/structshaka_1_1ChunkingParams.html">shaka::ChunkingParams</a></div><div class="ttdoc">Chunking (segmentation) related parameters.</div><div class="ttdef"><b>Definition:</b> <a href="../../db/d79/chunking__params_8h_source.html#l00013">chunking_params.h:13</a></div></div>
2021-06-22 00:16:40 +00:00
<div class="ttc" id="aclassshaka_1_1media_1_1ChunkingHandler_html_ab526bd53e4d49d7209f01d9b10b9ab52"><div class="ttname"><a href="../../d4/d43/classshaka_1_1media_1_1ChunkingHandler.html#ab526bd53e4d49d7209f01d9b10b9ab52">shaka::media::ChunkingHandler::OnFlushRequest</a></div><div class="ttdeci">Status OnFlushRequest(size_t input_stream_index) override</div><div class="ttdoc">Event handler for flush request at the specific input stream index.</div><div class="ttdef"><b>Definition:</b> <a href="../../d9/d12/chunking__handler_8cc_source.html#l00062">chunking_handler.cc:62</a></div></div>
<div class="ttc" id="aclassshaka_1_1media_1_1ChunkingHandler_html"><div class="ttname"><a href="../../d4/d43/classshaka_1_1media_1_1ChunkingHandler.html">shaka::media::ChunkingHandler</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d7/d79/chunking__handler_8h_source.html#l00039">chunking_handler.h:39</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
2021-06-22 00:16:40 +00:00
Generated on Tue Jun 22 2021 00:16:04 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>