81 lines
12 KiB
HTML
81 lines
12 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/webm/webm_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.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_b23f8e22c8c095d1c8c0cb8f88104a00.html">webm</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">webm_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 2014 The Chromium Authors. All rights reserved.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Use of this source code is governed by a BSD-style license that can be</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// found in the LICENSE file.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> </div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#ifndef PACKAGER_MEDIA_FORMATS_WEBM_WEBM_WEBVTT_PARSER_H_</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#define PACKAGER_MEDIA_FORMATS_WEBM_WEBM_WEBVTT_PARSER_H_</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include <stdint.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 <string></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 "packager/base/macros.h"</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="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> <span class="keyword">namespace </span>media {</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="../../d4/d59/classshaka_1_1media_1_1WebMWebVTTParser.html"> 17</a></span> <span class="keyword">class </span><a class="code" href="../../d4/d59/classshaka_1_1media_1_1WebMWebVTTParser.html">WebMWebVTTParser</a> {</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="../../d4/d59/classshaka_1_1media_1_1WebMWebVTTParser.html#a4e6f754e4fba24f7ea77fd0db959908b">Parse</a>(<span class="keyword">const</span> uint8_t* payload,</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="keywordtype">int</span> payload_size,</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  std::string* <span class="keywordtype">id</span>,</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  std::string* settings,</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  std::string* content);</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="comment">// The payload is the embedded WebVTT cue, stored in a WebM block.</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="comment">// The parser treats this as a UTF-8 byte stream.</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <a class="code" href="../../d4/d59/classshaka_1_1media_1_1WebMWebVTTParser.html">WebMWebVTTParser</a>(<span class="keyword">const</span> uint8_t* payload, <span class="keywordtype">int</span> payload_size);</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="comment">// Parse the cue identifier, settings, and content from the stream.</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordtype">void</span> <a class="code" href="../../d4/d59/classshaka_1_1media_1_1WebMWebVTTParser.html#a4e6f754e4fba24f7ea77fd0db959908b">Parse</a>(std::string* <span class="keywordtype">id</span>, std::string* settings, std::string* content);</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="comment">// Remove a byte from the stream, advancing the stream pointer.</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="comment">// Returns true if a character was returned; false means "end of stream".</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordtype">bool</span> GetByte(uint8_t* byte);</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="comment">// Backup the stream pointer.</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">void</span> UngetByte();</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="comment">// Parse a line of text from the stream.</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordtype">void</span> ParseLine(std::string* line);</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="comment">// Represents the portion of the stream that has not been consumed yet.</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">const</span> uint8_t* ptr_;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">const</span> uint8_t* <span class="keyword">const</span> ptr_end_;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  DISALLOW_COPY_AND_ASSIGN(<a class="code" href="../../d4/d59/classshaka_1_1media_1_1WebMWebVTTParser.html">WebMWebVTTParser</a>);</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> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> } <span class="comment">// namespace media</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> } <span class="comment">// namespace shaka</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor">#endif // PACKAGER_MEDIA_FORMATS_WEBM_WEBM_WEBVTT_PARSER_H_</span></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_1WebMWebVTTParser_html_a4e6f754e4fba24f7ea77fd0db959908b"><div class="ttname"><a href="../../d4/d59/classshaka_1_1media_1_1WebMWebVTTParser.html#a4e6f754e4fba24f7ea77fd0db959908b">shaka::media::WebMWebVTTParser::Parse</a></div><div class="ttdeci">static void Parse(const uint8_t *payload, int payload_size, std::string *id, std::string *settings, std::string *content)</div><div class="ttdoc">Utility function to parse the WebVTT cue from a byte stream. </div><div class="ttdef"><b>Definition:</b> <a href="../../d5/dc1/webm__webvtt__parser_8cc_source.html#l00010">webm_webvtt_parser.cc:10</a></div></div>
|
|
<div class="ttc" id="classshaka_1_1media_1_1WebMWebVTTParser_html"><div class="ttname"><a href="../../d4/d59/classshaka_1_1media_1_1WebMWebVTTParser.html">shaka::media::WebMWebVTTParser</a></div><div class="ttdef"><b>Definition:</b> <a href="../../dd/dbf/webm__webvtt__parser_8h_source.html#l00017">webm_webvtt_parser.h:17</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Thu Jun 28 2018 17:32:56 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>
|