170 lines
16 KiB
HTML
170 lines
16 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.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Shaka Packager SDK: packager/media/formats/webvtt/webvtt_file_buffer.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.9.1 -->
|
|
<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','.html');
|
|
/* @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_file_buffer.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 2018 Google LLC 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/webvtt_file_buffer.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/strings/stringprintf.h"</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "packager/media/base/text_sample.h"</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "packager/media/formats/webvtt/webvtt_utils.h"</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  </div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">namespace </span><a class="code" href="../../d8/daf/namespaceshaka.html">shaka</a> {</div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="keyword">namespace </span>media {</div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="keyword">namespace </span>{</div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* kHeader = <span class="stringliteral">"WEBVTT\n"</span>;</div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">const</span> <span class="keywordtype">int</span> kTsTimescale = 90000;</div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> } <span class="comment">// namespace</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> WebVttFileBuffer::WebVttFileBuffer(</div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  uint32_t transport_stream_timestamp_offset_ms,</div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keyword">const</span> std::string& style_region_config)</div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  : transport_stream_timestamp_offset_(transport_stream_timestamp_offset_ms *</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  kTsTimescale / 1000),</div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  style_region_config_(style_region_config) {</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="comment">// Make sure we start with the same state that we would end up with if</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="comment">// the caller reset our state.</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  Reset();</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> }</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="keywordtype">void</span> WebVttFileBuffer::Reset() {</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  sample_count_ = 0;</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>  buffer_.clear();</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  buffer_.append(kHeader);</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordflow">if</span> (transport_stream_timestamp_offset_ > 0) {</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="comment">// https://tools.ietf.org/html/rfc8216#section-3.5 WebVTT.</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  base::StringAppendF(&buffer_,</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="stringliteral">"X-TIMESTAMP-MAP=LOCAL:00:00:00.000,MPEGTS:%d\n"</span>,</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  transport_stream_timestamp_offset_);</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>  buffer_.append(<span class="stringliteral">"\n"</span>); <span class="comment">// end of header.</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">if</span> (!style_region_config_.empty()) {</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  buffer_.append(style_region_config_);</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  buffer_.append(<span class="stringliteral">"\n\n"</span>);</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> }</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> <span class="keywordtype">void</span> WebVttFileBuffer::Append(<span class="keyword">const</span> TextSample& sample) {</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  DCHECK_GT(buffer_.size(), 0u) << <span class="stringliteral">"The buffer should at least have a header"</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>  sample_count_++;</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">// Ids are optional</span></div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordflow">if</span> (sample.id().length()) {</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  buffer_.append(sample.id());</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  buffer_.append(<span class="stringliteral">"\n"</span>); <span class="comment">// end of id</span></div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</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="comment">// Write the times that the sample elapses.</span></div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  buffer_.append(MsToWebVttTimestamp(sample.start_time()));</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  buffer_.append(<span class="stringliteral">" --> "</span>);</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  buffer_.append(MsToWebVttTimestamp(sample.EndTime()));</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">const</span> std::string settings = WebVttSettingsToString(sample.settings());</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordflow">if</span> (!settings.empty()) {</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  buffer_.append(<span class="stringliteral">" "</span>);</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  buffer_.append(settings);</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  }</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  buffer_.append(<span class="stringliteral">"\n"</span>); <span class="comment">// end of time & settings</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>  buffer_.append(WebVttFragmentToString(sample.body()));</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  buffer_.append(<span class="stringliteral">"\n"</span>); <span class="comment">// end of payload</span></div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  buffer_.append(<span class="stringliteral">"\n"</span>); <span class="comment">// end of sample</span></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>  </div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="keywordtype">bool</span> WebVttFileBuffer::WriteTo(File* file, uint64_t* size) {</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  DCHECK(file);</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  DCHECK_GT(buffer_.size(), 0u) << <span class="stringliteral">"The buffer should at least have a header"</span>;</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordflow">if</span> (size)</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  *size = buffer_.size();</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">const</span> <span class="keywordtype">int</span> written = file->Write(buffer_.c_str(), buffer_.size());</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordflow">if</span> (written < 0) {</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordflow">return</span> <span class="keyword">false</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>  </div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordflow">return</span> <span class="keyword">static_cast<</span><span class="keywordtype">size_t</span><span class="keyword">></span>(written) == buffer_.size();</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> }</div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> } <span class="comment">// namespace media</span></div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> } <span class="comment">// namespace shaka</span></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><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Thu Jun 10 2021 21:44:26 for Shaka Packager SDK by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|