shaka-packager/docs/d4/d0c/text__readers_8h_source.html

86 lines
20 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/text_readers.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">text_readers.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_FORMATS_WEBVTT_TEXT_READERS_H_</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#define PACKAGER_MEDIA_FORMATS_WEBVTT_TEXT_READERS_H_</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;memory&gt;</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &quot;packager/file/file_closer.h&quot;</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &quot;packager/status.h&quot;</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="keyword">namespace </span><a class="code" href="../../d8/daf/namespaceshaka.html">shaka</a> {</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="keyword">class </span>File;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="keyword">namespace </span>media {</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="../../d6/db8/classshaka_1_1media_1_1FileReader.html"> 23</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../d6/db8/classshaka_1_1media_1_1FileReader.html">FileReader</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="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keyword">static</span> <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> <a class="code" href="../../d6/db8/classshaka_1_1media_1_1FileReader.html#a7b8d9ee944b8f2816e6d717bd01c6eab">Open</a>(<span class="keyword">const</span> std::string&amp; filename,</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; std::unique_ptr&lt;FileReader&gt;* out);</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../d6/db8/classshaka_1_1media_1_1FileReader.html#a0ac0fbdee01fe6cc71fdea9fdd8ceabd">Next</a>(<span class="keywordtype">char</span>* out);</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">explicit</span> <a class="code" href="../../d6/db8/classshaka_1_1media_1_1FileReader.html">FileReader</a>(std::unique_ptr&lt;File, FileCloser&gt; file);</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <a class="code" href="../../d6/db8/classshaka_1_1media_1_1FileReader.html">FileReader</a>(<span class="keyword">const</span> <a class="code" href="../../d6/db8/classshaka_1_1media_1_1FileReader.html">FileReader</a>&amp; reader) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <a class="code" href="../../d6/db8/classshaka_1_1media_1_1FileReader.html">FileReader</a> operator=(<span class="keyword">const</span> <a class="code" href="../../d6/db8/classshaka_1_1media_1_1FileReader.html">FileReader</a>&amp; reader) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; std::unique_ptr&lt;File, FileCloser&gt; file_;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;};</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="../../d8/dc6/classshaka_1_1media_1_1PeekingReader.html"> 46</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../d8/dc6/classshaka_1_1media_1_1PeekingReader.html">PeekingReader</a> {</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">explicit</span> <a class="code" href="../../d8/dc6/classshaka_1_1media_1_1PeekingReader.html">PeekingReader</a>(std::unique_ptr&lt;FileReader&gt; source);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordtype">bool</span> Peek(<span class="keywordtype">char</span>* out);</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../d6/db8/classshaka_1_1media_1_1FileReader.html#a0ac0fbdee01fe6cc71fdea9fdd8ceabd">Next</a>(<span class="keywordtype">char</span>* out);</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <a class="code" href="../../d8/dc6/classshaka_1_1media_1_1PeekingReader.html">PeekingReader</a>(<span class="keyword">const</span> <a class="code" href="../../d8/dc6/classshaka_1_1media_1_1PeekingReader.html">PeekingReader</a>&amp;) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <a class="code" href="../../d8/dc6/classshaka_1_1media_1_1PeekingReader.html">PeekingReader</a> operator=(<span class="keyword">const</span> <a class="code" href="../../d8/dc6/classshaka_1_1media_1_1PeekingReader.html">PeekingReader</a>&amp;) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; std::unique_ptr&lt;FileReader&gt; source_;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordtype">char</span> cached_next_ = 0;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordtype">bool</span> has_cached_next_ = <span class="keyword">false</span>;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;};</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"><a class="line" href="../../db/de2/classshaka_1_1media_1_1LineReader.html"> 62</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../db/de2/classshaka_1_1media_1_1LineReader.html">LineReader</a> {</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keyword">explicit</span> <a class="code" href="../../db/de2/classshaka_1_1media_1_1LineReader.html">LineReader</a>(std::unique_ptr&lt;FileReader&gt; source);</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../d6/db8/classshaka_1_1media_1_1FileReader.html#a0ac0fbdee01fe6cc71fdea9fdd8ceabd">Next</a>(std::string* out);</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <a class="code" href="../../db/de2/classshaka_1_1media_1_1LineReader.html">LineReader</a>(<span class="keyword">const</span> <a class="code" href="../../db/de2/classshaka_1_1media_1_1LineReader.html">LineReader</a>&amp;) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <a class="code" href="../../db/de2/classshaka_1_1media_1_1LineReader.html">LineReader</a> operator=(<span class="keyword">const</span> <a class="code" href="../../db/de2/classshaka_1_1media_1_1LineReader.html">LineReader</a>&amp;) = <span class="keyword">delete</span>;</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; <a class="code" href="../../d8/dc6/classshaka_1_1media_1_1PeekingReader.html">PeekingReader</a> source_;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;};</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;</div><div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="../../df/d0d/classshaka_1_1media_1_1BlockReader.html"> 75</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../df/d0d/classshaka_1_1media_1_1BlockReader.html">BlockReader</a> {</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keyword">explicit</span> <a class="code" href="../../df/d0d/classshaka_1_1media_1_1BlockReader.html">BlockReader</a>(std::unique_ptr&lt;FileReader&gt; source);</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../d6/db8/classshaka_1_1media_1_1FileReader.html#a0ac0fbdee01fe6cc71fdea9fdd8ceabd">Next</a>(std::vector&lt;std::string&gt;* out);</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; <span class="keyword">private</span>:</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <a class="code" href="../../df/d0d/classshaka_1_1media_1_1BlockReader.html">BlockReader</a>(<span class="keyword">const</span> <a class="code" href="../../df/d0d/classshaka_1_1media_1_1BlockReader.html">BlockReader</a>&amp;) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <a class="code" href="../../df/d0d/classshaka_1_1media_1_1BlockReader.html">BlockReader</a> operator=(<span class="keyword">const</span> <a class="code" href="../../df/d0d/classshaka_1_1media_1_1BlockReader.html">BlockReader</a>&amp;) = <span class="keyword">delete</span>;</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; <a class="code" href="../../db/de2/classshaka_1_1media_1_1LineReader.html">LineReader</a> source_;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;};</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">// namespace media</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;} <span class="comment">// namespace shaka</span></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="preprocessor">#endif // MEDIA_FORMATS_WEBVTT_TEXT_READERS_H_</span></div><div class="ttc" id="classshaka_1_1media_1_1LineReader_html"><div class="ttname"><a href="../../db/de2/classshaka_1_1media_1_1LineReader.html">shaka::media::LineReader</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d4/d0c/text__readers_8h_source.html#l00062">text_readers.h:62</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="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_1FileReader_html_a0ac0fbdee01fe6cc71fdea9fdd8ceabd"><div class="ttname"><a href="../../d6/db8/classshaka_1_1media_1_1FileReader.html#a0ac0fbdee01fe6cc71fdea9fdd8ceabd">shaka::media::FileReader::Next</a></div><div class="ttdeci">bool Next(char *out)</div><div class="ttdef"><b>Definition:</b> <a href="../../d8/d51/text__readers_8cc_source.html#l00032">text_readers.cc:32</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1FileReader_html"><div class="ttname"><a href="../../d6/db8/classshaka_1_1media_1_1FileReader.html">shaka::media::FileReader</a></div><div class="ttdoc">Class to read character-by-character from a file. </div><div class="ttdef"><b>Definition:</b> <a href="../../d4/d0c/text__readers_8h_source.html#l00023">text_readers.h:23</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1PeekingReader_html"><div class="ttname"><a href="../../d8/dc6/classshaka_1_1media_1_1PeekingReader.html">shaka::media::PeekingReader</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d4/d0c/text__readers_8h_source.html#l00046">text_readers.h:46</a></div></div>
<div class="ttc" id="classshaka_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#l00075">text_readers.h:75</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1FileReader_html_a7b8d9ee944b8f2816e6d717bd01c6eab"><div class="ttname"><a href="../../d6/db8/classshaka_1_1media_1_1FileReader.html#a7b8d9ee944b8f2816e6d717bd01c6eab">shaka::media::FileReader::Open</a></div><div class="ttdeci">static Status Open(const std::string &amp;filename, std::unique_ptr&lt; FileReader &gt; *out)</div><div class="ttdef"><b>Definition:</b> <a href="../../d8/d51/text__readers_8cc_source.html#l00015">text_readers.cc:15</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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>