87 lines
21 KiB
HTML
87 lines
21 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/formats/webvtt/webvtt_output_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/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_375ba2cfd8fd5b05c50b92d996b9d386.html">formats</a></li><li class="navelem"><a class="el" href="../../dir_7fa7c3de4a91b9652697b9f1c2d38e70.html">webvtt</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">webvtt_output_handler.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 2017 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_MEDIA_FORMATS_WEBVTT_WEBVTT_TEXT_HANDLER_H_</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#define PACKAGER_MEDIA_FORMATS_WEBVTT_WEBVTT_TEXT_HANDLER_H_</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</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> </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "packager/media/base/media_handler.h"</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include "packager/media/base/muxer_options.h"</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include "packager/media/event/muxer_listener.h"</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <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> <span class="keyword">namespace </span>media {</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">// WebVttOutputHandler is the base class for all WebVtt text output handlers.</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// It handles taking in the samples and writing the text out, but relies on</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// sub classes to handle the logic of when and where to write the information.</span></div><div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="../../d6/d3f/classshaka_1_1media_1_1WebVttOutputHandler.html"> 24</a></span> <span class="keyword">class </span><a class="code" href="../../d6/d3f/classshaka_1_1media_1_1WebVttOutputHandler.html">WebVttOutputHandler</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="l00025"></a><span class="lineno"> 25</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <a class="code" href="../../d6/d3f/classshaka_1_1media_1_1WebVttOutputHandler.html">WebVttOutputHandler</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keyword">virtual</span> ~<a class="code" href="../../d6/d3f/classshaka_1_1media_1_1WebVttOutputHandler.html">WebVttOutputHandler</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">virtual</span> <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> OnStreamInfo(<span class="keyword">const</span> <a class="code" href="../../d5/db1/classshaka_1_1media_1_1StreamInfo.html">StreamInfo</a>& info) = 0;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keyword">virtual</span> <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> OnSegmentInfo(<span class="keyword">const</span> <a class="code" href="../../d0/dc0/structshaka_1_1media_1_1SegmentInfo.html">SegmentInfo</a>& info) = 0;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keyword">virtual</span> <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> OnTextSample(<span class="keyword">const</span> <a class="code" href="../../db/d1f/classshaka_1_1media_1_1TextSample.html">TextSample</a>& sample) = 0;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keyword">virtual</span> <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> OnStreamEnd() = 0;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="comment">// Top level functions for output. These functions should be used by</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="comment">// subclasses to write to files.</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordtype">void</span> WriteCue(<span class="keyword">const</span> std::string& <span class="keywordtype">id</span>,</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  uint64_t start,</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  uint64_t end,</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">const</span> std::string& settings,</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">const</span> std::string& payload);</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="comment">// Writes the current state of the current segment to disk. This will</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="comment">// reset the internal state and set it up for the next segment.</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> WriteSegmentToFile(<span class="keyword">const</span> std::string& filename);</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="../../d6/d3f/classshaka_1_1media_1_1WebVttOutputHandler.html">WebVttOutputHandler</a>(<span class="keyword">const</span> <a class="code" href="../../d6/d3f/classshaka_1_1media_1_1WebVttOutputHandler.html">WebVttOutputHandler</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="../../d6/d3f/classshaka_1_1media_1_1WebVttOutputHandler.html">WebVttOutputHandler</a>& operator=(<span class="keyword">const</span> <a class="code" href="../../d6/d3f/classshaka_1_1media_1_1WebVttOutputHandler.html">WebVttOutputHandler</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> InitializeInternal() <span class="keyword">override</span>;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> Process(std::unique_ptr<StreamData> stream_data) <span class="keyword">override</span>;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> OnFlushRequest(<span class="keywordtype">size_t</span> input_stream_index) <span class="keyword">override</span>;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="comment">// A buffer of characters waiting to be written to a file.</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  std::string buffer_;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> };</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">// This WebVttt output handler should only be used when the source WebVTT</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">// content needs to be segmented across multiple files.</span></div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="../../d6/dc1/classshaka_1_1media_1_1WebVttSegmentedOutputHandler.html"> 60</a></span> <span class="keyword">class </span><a class="code" href="../../d6/dc1/classshaka_1_1media_1_1WebVttSegmentedOutputHandler.html">WebVttSegmentedOutputHandler</a> : <span class="keyword">public</span> <a class="code" href="../../d6/d3f/classshaka_1_1media_1_1WebVttOutputHandler.html">WebVttOutputHandler</a> {</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <a class="code" href="../../d6/dc1/classshaka_1_1media_1_1WebVttSegmentedOutputHandler.html">WebVttSegmentedOutputHandler</a>(<span class="keyword">const</span> <a class="code" href="../../d0/d27/structshaka_1_1media_1_1MuxerOptions.html">MuxerOptions</a>& muxer_options,</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  std::unique_ptr<MuxerListener> muxer_listener);</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> OnStreamInfo(<span class="keyword">const</span> <a class="code" href="../../d5/db1/classshaka_1_1media_1_1StreamInfo.html">StreamInfo</a>& info) <span class="keyword">override</span>;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> OnSegmentInfo(<span class="keyword">const</span> <a class="code" href="../../d0/dc0/structshaka_1_1media_1_1SegmentInfo.html">SegmentInfo</a>& info) <span class="keyword">override</span>;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> OnTextSample(<span class="keyword">const</span> <a class="code" href="../../db/d1f/classshaka_1_1media_1_1TextSample.html">TextSample</a>& sample) <span class="keyword">override</span>;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> OnStreamEnd() <span class="keyword">override</span>;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> OnSegmentEnded();</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordtype">void</span> GoToNextSegment(uint64_t start_time_ms);</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">const</span> <a class="code" href="../../d0/d27/structshaka_1_1media_1_1MuxerOptions.html">MuxerOptions</a> muxer_options_;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  std::unique_ptr<MuxerListener> muxer_listener_;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="comment">// Sum together all segment durations so we know how long the stream is.</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  uint64_t total_duration_ms_ = 0;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  uint32_t segment_index_ = 0;</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_MEDIA_FORMATS_WEBVTT_WEBVTT_TEXT_HANDLER_H_</span></div><div class="ttc" id="classshaka_1_1media_1_1WebVttOutputHandler_html"><div class="ttname"><a href="../../d6/d3f/classshaka_1_1media_1_1WebVttOutputHandler.html">shaka::media::WebVttOutputHandler</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d6/d56/webvtt__output__handler_8h_source.html#l00024">webvtt_output_handler.h:24</a></div></div>
|
|
<div class="ttc" id="classshaka_1_1media_1_1StreamInfo_html"><div class="ttname"><a href="../../d5/db1/classshaka_1_1media_1_1StreamInfo.html">shaka::media::StreamInfo</a></div><div class="ttdoc">Abstract class holds stream information. </div><div class="ttdef"><b>Definition:</b> <a href="../../d8/daa/stream__info_8h_source.html#l00058">stream_info.h:58</a></div></div>
|
|
<div class="ttc" id="structshaka_1_1media_1_1SegmentInfo_html"><div class="ttname"><a href="../../d0/dc0/structshaka_1_1media_1_1SegmentInfo.html">shaka::media::SegmentInfo</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d93/media__handler_8h_source.html#l00053">media_handler.h:53</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#l00148">media_handler.h:148</a></div></div>
|
|
<div class="ttc" id="classshaka_1_1media_1_1WebVttSegmentedOutputHandler_html"><div class="ttname"><a href="../../d6/dc1/classshaka_1_1media_1_1WebVttSegmentedOutputHandler.html">shaka::media::WebVttSegmentedOutputHandler</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d6/d56/webvtt__output__handler_8h_source.html#l00060">webvtt_output_handler.h:60</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="structshaka_1_1media_1_1MuxerOptions_html"><div class="ttname"><a href="../../d0/d27/structshaka_1_1media_1_1MuxerOptions.html">shaka::media::MuxerOptions</a></div><div class="ttdoc">This structure contains the list of configuration options for Muxer. </div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d0e/muxer__options_8h_source.html#l00020">muxer_options.h:20</a></div></div>
|
|
<div class="ttc" id="classshaka_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="classshaka_1_1media_1_1TextSample_html"><div class="ttname"><a href="../../db/d1f/classshaka_1_1media_1_1TextSample.html">shaka::media::TextSample</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d1a/text__sample_8h_source.html#l00017">text_sample.h:17</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Sat Feb 10 2018 15:36:44 for Shaka Packager SDK by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|