shaka-packager/docs/dd/ddc/trick__play__handler_8h_sou...

200 lines
23 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/trick_play/trick_play_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"/>
<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_ebd49ab0652c2e9158bbb57c55382729.html">trick_play</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">trick_play_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_BASE_TRICK_PLAY_HANDLER_H_</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define PACKAGER_MEDIA_BASE_TRICK_PLAY_HANDLER_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 &quot;packager/media/base/media_handler.h&quot;</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="keyword">namespace </span>shaka {</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="keyword">namespace </span>media {</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">// The stream data in trick play stream is not a simple duplicate. Some</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">// information need to be updated, including trick_play_factor in</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment">// VideoStreamInfo, the duration in MediaSample (which makes sure there is no</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment">// gap between the media sample dts). Since the duration information can be</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment">// determined after getting the next media sample, a queue is used to cache the</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment">// input stream data before the next key frame.</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="../../db/dea/classshaka_1_1media_1_1TrickPlayHandler.html"> 23</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../db/dea/classshaka_1_1media_1_1TrickPlayHandler.html">TrickPlayHandler</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="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <a class="code" href="../../db/dea/classshaka_1_1media_1_1TrickPlayHandler.html">TrickPlayHandler</a>();</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; ~<a class="code" href="../../db/dea/classshaka_1_1media_1_1TrickPlayHandler.html">TrickPlayHandler</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keywordtype">void</span> SetHandlerForMainStream(std::shared_ptr&lt;MediaHandler&gt; handler);</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keywordtype">void</span> SetHandlerForTrickPlay(uint32_t trick_play_factor,</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; std::shared_ptr&lt;MediaHandler&gt; handler);</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; Status <a class="code" href="../../db/dea/classshaka_1_1media_1_1TrickPlayHandler.html#a3fd2fae199e0a9607e83e02724896c10">InitializeInternal</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; Status <a class="code" href="../../db/dea/classshaka_1_1media_1_1TrickPlayHandler.html#afdd13bb4e762c4b904ed75b268359757">Process</a>(std::unique_ptr&lt;StreamData&gt; stream_data) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../db/dea/classshaka_1_1media_1_1TrickPlayHandler.html#addbe1be8281bceb8e84df865424dded3">ValidateOutputStreamIndex</a>(<span class="keywordtype">size_t</span> stream_index) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; Status <a class="code" href="../../db/dea/classshaka_1_1media_1_1TrickPlayHandler.html#a9a6c29c88fdeb667d5592142d6815bfa">OnFlushRequest</a>(<span class="keywordtype">size_t</span> input_stream_index) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span>TrickPlayHandlerTest;</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="comment">// Returns true if the trick play handler has main stream output handler</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="comment">// connected, otherwise returns false.</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordtype">bool</span> HasMainStream();</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="comment">// Process the cached stream data for one trick play stream.</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="comment">// The cached data is dispatched to the |output_stream_index|.</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; Status ProcessCachedStreamData(</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordtype">size_t</span> output_stream_index,</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; std::deque&lt;std::shared_ptr&lt;StreamData&gt;&gt;* cached_stream_data);</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; <span class="comment">// Process a single stream data. Depending on the stream data type, some</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="comment">// information needs to be updated.</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="comment">// Decoding timestamp for current key media sample. It is used for calculating</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="comment">// the duration of previous key media sample, to make sure there is no gap</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="comment">// between two key media samples.</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; Status ProcessOneStreamData(<span class="keywordtype">size_t</span> output_stream_index,</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keyword">const</span> std::shared_ptr&lt;StreamData&gt;&amp; stream_data);</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; <span class="comment">// Trick play factors. Note that there can be multiple trick play factors,</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="comment">// e.g., 2, 4 and 8. That means, one input video stream will generate 3</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="comment">// output trick play streams and original stream. Three trick play streams</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="comment">// are:</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="comment">// [key_frame_0, key_frame_2, key_frame_4, ...]</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="comment">// [key_frame_0, key_frame_4, key_frame_8,...]</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="comment">// [key_frame_0, key_frame_8, key_frame_16, ...].</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; std::vector&lt;uint32_t&gt; trick_play_factors_;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <a class="code" href="../../db/dea/classshaka_1_1media_1_1TrickPlayHandler.html">TrickPlayHandler</a>(<span class="keyword">const</span> <a class="code" href="../../db/dea/classshaka_1_1media_1_1TrickPlayHandler.html">TrickPlayHandler</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <a class="code" href="../../db/dea/classshaka_1_1media_1_1TrickPlayHandler.html">TrickPlayHandler</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="../../db/dea/classshaka_1_1media_1_1TrickPlayHandler.html">TrickPlayHandler</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; uint32_t total_key_frames_ = 0;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="comment">// Num of frames received.</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; uint32_t total_frames_ = 0;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="comment">// End timestamp of the previous processed media_sample, which is |dts| +</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="comment">// |duration|. The duration of key frame in trick play stream is updated based</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="comment">// on this timestamp.</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; int64_t prev_sample_end_timestamp_ = 0;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="comment">// Record playback_rate for each trick play stream.</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; std::vector&lt;uint32_t&gt; playback_rates_;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="comment">// The data in output streams should be in the same order as in the input</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="comment">// stream. Cache the stream data before next key frame so that we can</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="comment">// determine the duration for the current key frame. Since one key frame may</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="comment">// be dispatched to different trick play stream, each trick play stream need</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="comment">// its own queue to handle the synchronization.</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="comment">// TODO(hmchen): Use one queue and multiple iterators, instead of multiple</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="comment">// queues.</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; std::vector&lt;std::deque&lt;std::shared_ptr&lt;StreamData&gt;&gt;&gt; cached_stream_data_;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;};</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;} <span class="comment">// namespace media</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;} <span class="comment">// namespace shaka</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;<span class="preprocessor">#endif // PACKAGER_MEDIA_BASE_TRICK_PLAY_HANDLER_H_</span></div>
<div class="ttc" id="classshaka_1_1media_1_1TrickPlayHandler_html"><div class="ttname"><a href="../../db/dea/classshaka_1_1media_1_1TrickPlayHandler.html">shaka::media::TrickPlayHandler</a></div><div class="ttdef"><b>Definition:</b> <a href="../../dd/ddc/trick__play__handler_8h_source.html#l00023">trick_play_handler.h:23</a></div></div>
<div class="ttc" id="classshaka_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#l00074">media_handler.h:74</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1TrickPlayHandler_html_addbe1be8281bceb8e84df865424dded3"><div class="ttname"><a href="../../db/dea/classshaka_1_1media_1_1TrickPlayHandler.html#addbe1be8281bceb8e84df865424dded3">shaka::media::TrickPlayHandler::ValidateOutputStreamIndex</a></div><div class="ttdeci">bool ValidateOutputStreamIndex(size_t stream_index) const override</div><div class="ttdoc">Validate if the stream at the specified index actually exists. </div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d87/trick__play__handler_8cc_source.html#l00135">trick_play_handler.cc:135</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1TrickPlayHandler_html_a9a6c29c88fdeb667d5592142d6815bfa"><div class="ttname"><a href="../../db/dea/classshaka_1_1media_1_1TrickPlayHandler.html#a9a6c29c88fdeb667d5592142d6815bfa">shaka::media::TrickPlayHandler::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="../../d3/d87/trick__play__handler_8cc_source.html#l00141">trick_play_handler.cc:141</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1TrickPlayHandler_html_a3fd2fae199e0a9607e83e02724896c10"><div class="ttname"><a href="../../db/dea/classshaka_1_1media_1_1TrickPlayHandler.html#a3fd2fae199e0a9607e83e02724896c10">shaka::media::TrickPlayHandler::InitializeInternal</a></div><div class="ttdeci">Status InitializeInternal() override</div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d87/trick__play__handler_8cc_source.html#l00036">trick_play_handler.cc:36</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1TrickPlayHandler_html_afdd13bb4e762c4b904ed75b268359757"><div class="ttname"><a href="../../db/dea/classshaka_1_1media_1_1TrickPlayHandler.html#afdd13bb4e762c4b904ed75b268359757">shaka::media::TrickPlayHandler::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="../../d3/d87/trick__play__handler_8cc_source.html#l00052">trick_play_handler.cc:52</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Aug 18 2017 17:10:18 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>