152 lines
18 KiB
HTML
152 lines
18 KiB
HTML
<!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: packager/media/formats/webvtt/webvtt_parser.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.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&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&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="../../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_parser.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_PARSER_H_</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#define PACKAGER_MEDIA_FORMATS_WEBVTT_WEBVTT_PARSER_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 <map></span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include <string></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_parser.h"</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include "packager/media/base/text_sample.h"</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include "packager/media/base/text_stream_info.h"</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include "packager/media/formats/webvtt/text_readers.h"</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  </div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">namespace </span><a class="code" href="../../d8/daf/namespaceshaka.html">shaka</a> {</div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">namespace </span>media {</div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// Used to parse a WebVTT source into Cues that will be sent downstream.</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="../../d9/d40/classshaka_1_1media_1_1WebVttParser.html"> 23</a></span> <span class="keyword">class </span><a class="code" href="../../d9/d40/classshaka_1_1media_1_1WebVttParser.html">WebVttParser</a> : <span class="keyword">public</span> <a class="code" href="../../d3/d0a/classshaka_1_1media_1_1MediaParser.html">MediaParser</a> {</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <a class="code" href="../../d9/d40/classshaka_1_1media_1_1WebVttParser.html">WebVttParser</a>();</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keywordtype">void</span> <a class="code" href="../../d9/d40/classshaka_1_1media_1_1WebVttParser.html#a748578474cffb5e3a817a2eeeca50abb">Init</a>(<span class="keyword">const</span> <a class="code" href="../../d3/d0a/classshaka_1_1media_1_1MediaParser.html#aef5795d2b3df2526c6e8afe1e4d072bf">InitCB</a>& init_cb,</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keyword">const</span> <a class="code" href="../../d3/d0a/classshaka_1_1media_1_1MediaParser.html#ad86528c837c0a773f7e853c38a4a3af2">NewMediaSampleCB</a>& new_media_sample_cb,</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keyword">const</span> <a class="code" href="../../d3/d0a/classshaka_1_1media_1_1MediaParser.html#a1df661cd2b63498a87d6a253f6f7c195">NewTextSampleCB</a>& new_text_sample_cb,</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <a class="code" href="../../d1/d1f/classshaka_1_1media_1_1KeySource.html">KeySource</a>* decryption_key_source) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordtype">bool</span> <a class="code" href="../../d9/d40/classshaka_1_1media_1_1WebVttParser.html#a521d223f2fe3c80f66cdc3bda8c07e91">Flush</a>() <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordtype">bool</span> <a class="code" href="../../d9/d40/classshaka_1_1media_1_1WebVttParser.html#aa38d64a81319d43a1194d26e9a39ac1d">Parse</a>(<span class="keyword">const</span> uint8_t* buf, <span class="keywordtype">int</span> size) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordtype">bool</span> Parse();</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordtype">bool</span> ParseBlock(<span class="keyword">const</span> std::vector<std::string>& block);</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordtype">bool</span> ParseRegion(<span class="keyword">const</span> std::vector<std::string>& block);</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">bool</span> ParseCueWithNoId(<span class="keyword">const</span> std::vector<std::string>& block);</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">bool</span> ParseCueWithId(<span class="keyword">const</span> std::vector<std::string>& block);</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordtype">bool</span> ParseCue(<span class="keyword">const</span> std::string& <span class="keywordtype">id</span>,</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">const</span> std::string* block,</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordtype">size_t</span> block_size);</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordtype">void</span> DispatchTextStreamInfo();</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>  <a class="code" href="../../d3/d0a/classshaka_1_1media_1_1MediaParser.html#aef5795d2b3df2526c6e8afe1e4d072bf">InitCB</a> init_cb_;</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="../../d3/d0a/classshaka_1_1media_1_1MediaParser.html#a1df661cd2b63498a87d6a253f6f7c195">NewTextSampleCB</a> new_text_sample_cb_;</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  </div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="../../df/d0d/classshaka_1_1media_1_1BlockReader.html">BlockReader</a> reader_;</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  std::map<std::string, TextRegion> regions_;</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  std::string css_styles_;</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">bool</span> saw_cue_ = <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">bool</span> stream_info_dispatched_ = <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">bool</span> initialized_ = <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> };</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> } <span class="comment">// namespace media</span></div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> } <span class="comment">// namespace shaka</span></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  </div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="preprocessor">#endif // MEDIA_FORMATS_WEBVTT_WEBVTT_PARSER_H_</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aclassshaka_1_1media_1_1MediaParser_html"><div class="ttname"><a href="../../d3/d0a/classshaka_1_1media_1_1MediaParser.html">shaka::media::MediaParser</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d7/d12/media__parser_8h_source.html#l00025">media_parser.h:25</a></div></div>
|
|
<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_1MediaParser_html_ad86528c837c0a773f7e853c38a4a3af2"><div class="ttname"><a href="../../d3/d0a/classshaka_1_1media_1_1MediaParser.html#ad86528c837c0a773f7e853c38a4a3af2">shaka::media::MediaParser::NewMediaSampleCB</a></div><div class="ttdeci">base::Callback< bool(uint32_t track_id, std::shared_ptr< MediaSample > media_sample)> NewMediaSampleCB</div><div class="ttdef"><b>Definition:</b> <a href="../../d7/d12/media__parser_8h_source.html#l00044">media_parser.h:44</a></div></div>
|
|
<div class="ttc" id="aclassshaka_1_1media_1_1MediaParser_html_aef5795d2b3df2526c6e8afe1e4d072bf"><div class="ttname"><a href="../../d3/d0a/classshaka_1_1media_1_1MediaParser.html#aef5795d2b3df2526c6e8afe1e4d072bf">shaka::media::MediaParser::InitCB</a></div><div class="ttdeci">base::Callback< void(const std::vector< std::shared_ptr< StreamInfo > > &stream_info)> InitCB</div><div class="ttdef"><b>Definition:</b> <a href="../../d7/d12/media__parser_8h_source.html#l00035">media_parser.h:35</a></div></div>
|
|
<div class="ttc" id="aclassshaka_1_1media_1_1WebVttParser_html_aa38d64a81319d43a1194d26e9a39ac1d"><div class="ttname"><a href="../../d9/d40/classshaka_1_1media_1_1WebVttParser.html#aa38d64a81319d43a1194d26e9a39ac1d">shaka::media::WebVttParser::Parse</a></div><div class="ttdeci">bool Parse(const uint8_t *buf, int size) override</div><div class="ttdef"><b>Definition:</b> <a href="../../db/d04/webvtt__parser_8cc_source.html#l00211">webvtt_parser.cc:211</a></div></div>
|
|
<div class="ttc" id="aclassshaka_1_1media_1_1BlockReader_html"><div class="ttname"><a href="../../df/d0d/classshaka_1_1media_1_1BlockReader.html">shaka::media::BlockReader</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d4/d0c/text__readers_8h_source.html#l00043">text_readers.h:43</a></div></div>
|
|
<div class="ttc" id="aclassshaka_1_1media_1_1KeySource_html"><div class="ttname"><a href="../../d1/d1f/classshaka_1_1media_1_1KeySource.html">shaka::media::KeySource</a></div><div class="ttdoc">KeySource is responsible for encryption key acquisition.</div><div class="ttdef"><b>Definition:</b> <a href="../../dc/d3f/key__source_8h_source.html#l00051">key_source.h:51</a></div></div>
|
|
<div class="ttc" id="aclassshaka_1_1media_1_1MediaParser_html_a1df661cd2b63498a87d6a253f6f7c195"><div class="ttname"><a href="../../d3/d0a/classshaka_1_1media_1_1MediaParser.html#a1df661cd2b63498a87d6a253f6f7c195">shaka::media::MediaParser::NewTextSampleCB</a></div><div class="ttdeci">base::Callback< bool(uint32_t track_id, std::shared_ptr< TextSample > text_sample)> NewTextSampleCB</div><div class="ttdef"><b>Definition:</b> <a href="../../d7/d12/media__parser_8h_source.html#l00053">media_parser.h:53</a></div></div>
|
|
<div class="ttc" id="aclassshaka_1_1media_1_1WebVttParser_html_a748578474cffb5e3a817a2eeeca50abb"><div class="ttname"><a href="../../d9/d40/classshaka_1_1media_1_1WebVttParser.html#a748578474cffb5e3a817a2eeeca50abb">shaka::media::WebVttParser::Init</a></div><div class="ttdeci">void Init(const InitCB &init_cb, const NewMediaSampleCB &new_media_sample_cb, const NewTextSampleCB &new_text_sample_cb, KeySource *decryption_key_source) override</div><div class="ttdef"><b>Definition:</b> <a href="../../db/d04/webvtt__parser_8cc_source.html#l00193">webvtt_parser.cc:193</a></div></div>
|
|
<div class="ttc" id="aclassshaka_1_1media_1_1WebVttParser_html"><div class="ttname"><a href="../../d9/d40/classshaka_1_1media_1_1WebVttParser.html">shaka::media::WebVttParser</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d0/dbc/webvtt__parser_8h_source.html#l00023">webvtt_parser.h:23</a></div></div>
|
|
<div class="ttc" id="aclassshaka_1_1media_1_1WebVttParser_html_a521d223f2fe3c80f66cdc3bda8c07e91"><div class="ttname"><a href="../../d9/d40/classshaka_1_1media_1_1WebVttParser.html#a521d223f2fe3c80f66cdc3bda8c07e91">shaka::media::WebVttParser::Flush</a></div><div class="ttdeci">bool Flush() override</div><div class="ttdef"><b>Definition:</b> <a href="../../db/d04/webvtt__parser_8cc_source.html#l00206">webvtt_parser.cc:206</a></div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Tue Jun 22 2021 00:16:04 for Shaka Packager SDK by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|