84 lines
22 KiB
HTML
84 lines
22 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.cc 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.cc</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">#include "packager/media/formats/webvtt/text_readers.h"</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "packager/base/logging.h"</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "packager/file/file.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="keyword">namespace </span><a class="code" href="../../d8/daf/namespaceshaka.html">shaka</a> {</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">namespace </span>media {</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="../../d6/db8/classshaka_1_1media_1_1FileReader.html#a7b8d9ee944b8f2816e6d717bd01c6eab"> 15</a></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">FileReader::Open</a>(<span class="keyword">const</span> std::string& filename,</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  std::unique_ptr<FileReader>* out) {</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* kReadOnly = <span class="stringliteral">"r"</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>  std::unique_ptr<File, FileCloser> file(</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <a class="code" href="../../d3/d73/classshaka_1_1File.html#a68a15f623c2a1601879f291f93a1f464">File::Open</a>(filename.c_str(), kReadOnly));</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="keywordflow">if</span> (!file) {</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="keywordflow">return</span> <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a>(error::INVALID_ARGUMENT,</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="stringliteral">"Could not open input file "</span> + filename);</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> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  *out = std::unique_ptr<FileReader>(<span class="keyword">new</span> <a class="code" href="../../d6/db8/classshaka_1_1media_1_1FileReader.html">FileReader</a>(std::move(file)));</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="keywordflow">return</span> Status::OK;</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> </div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="../../d6/db8/classshaka_1_1media_1_1FileReader.html#a0ac0fbdee01fe6cc71fdea9fdd8ceabd"> 32</a></span> <span class="keywordtype">bool</span> <a class="code" href="../../d6/db8/classshaka_1_1media_1_1FileReader.html#a0ac0fbdee01fe6cc71fdea9fdd8ceabd">FileReader::Next</a>(<span class="keywordtype">char</span>* out) {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="comment">// TODO(vaage): If file reading performance is poor, change this to buffer</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="comment">// data and read from the buffer.</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordflow">return</span> file_->Read(out, 1) == 1;</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> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> FileReader::FileReader(std::unique_ptr<File, FileCloser> file)</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  : file_(std::move(file)) {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  DCHECK(file_);</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> }</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> PeekingReader::PeekingReader(std::unique_ptr<FileReader> source)</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  : source_(std::move(source)) {}</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="keywordtype">bool</span> PeekingReader::Next(<span class="keywordtype">char</span>* out) {</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  DCHECK(out);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordflow">if</span> (Peek(out)) {</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  has_cached_next_ = <span class="keyword">false</span>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  }</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordflow">return</span> <span class="keyword">false</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> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="keywordtype">bool</span> PeekingReader::Peek(<span class="keywordtype">char</span>* out) {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  DCHECK(out);</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordflow">if</span> (!has_cached_next_ && source_->Next(&cached_next_)) {</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  has_cached_next_ = <span class="keyword">true</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="keywordflow">if</span> (has_cached_next_) {</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  *out = cached_next_;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  }</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> }</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> LineReader::LineReader(std::unique_ptr<FileReader> source)</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  : source_(std::move(source)) {}</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment">// Split lines based on https://w3c.github.io/webvtt/#webvtt-line-terminator</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="keywordtype">bool</span> LineReader::Next(std::string* out) {</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  DCHECK(out);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  out->clear();</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordtype">bool</span> read_something = <span class="keyword">false</span>;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">char</span> now;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordflow">while</span> (source_.Next(&now)) {</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  read_something = <span class="keyword">true</span>;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="comment">// handle \n</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordflow">if</span> (now == <span class="charliteral">'\n'</span>) {</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordflow">break</span>;</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>  <span class="comment">// handle \r and \r\n</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordflow">if</span> (now == <span class="charliteral">'\r'</span>) {</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">char</span> next;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordflow">if</span> (source_.Peek(&next) && next == <span class="charliteral">'\n'</span>) {</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  source_.Next(&next); <span class="comment">// Read in the '\n' that was just seen via |Peek|</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  }</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  }</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  out->push_back(now);</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  }</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordflow">return</span> read_something;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> }</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> BlockReader::BlockReader(std::unique_ptr<FileReader> source)</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  : source_(std::move(source)) {}</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="keywordtype">bool</span> BlockReader::Next(std::vector<std::string>* out) {</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  DCHECK(out);</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  out->clear();</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordtype">bool</span> in_block = <span class="keyword">false</span>;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="comment">// Read through lines until a non-empty line is found. With a non-empty</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="comment">// line is found, start adding the lines to the output and once an empty</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="comment">// line if found again, stop adding lines and exit.</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  std::string line;</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keywordflow">while</span> (source_.Next(&line)) {</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordflow">if</span> (in_block && line.empty()) {</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  }</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keywordflow">if</span> (in_block || !line.empty()) {</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  out->push_back(line);</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  in_block = <span class="keyword">true</span>;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  }</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  }</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordflow">return</span> in_block;</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> }</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> } <span class="comment">// namespace media</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> } <span class="comment">// namespace shaka</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_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_1File_html_a68a15f623c2a1601879f291f93a1f464"><div class="ttname"><a href="../../d3/d73/classshaka_1_1File.html#a68a15f623c2a1601879f291f93a1f464">shaka::File::Open</a></div><div class="ttdeci">virtual bool Open()=0</div><div class="ttdoc">Internal open. Should not be used directly. </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 &filename, std::unique_ptr< FileReader > *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 Wed Aug 15 2018 17:34:14 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>
|