2021-04-10 04:00:37 +00:00
<!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" / >
2021-06-22 00:16:40 +00:00
< meta name = "generator" content = "Doxygen 1.8.17" / >
2021-04-10 04:00:37 +00:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< title > Shaka Packager SDK: packager/media/formats/webvtt/webvtt_muxer.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 -->
2021-06-22 00:16:40 +00:00
<!-- Generated by Doxygen 1.8.17 -->
2021-04-10 04:00:37 +00:00
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
2021-06-22 00:16:40 +00:00
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
2021-04-10 04:00:37 +00:00
/* @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_muxer.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 2020 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_muxer.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/file/file.h" < / span > < / div >
< div class = "line" > < a name = "l00010" > < / a > < span class = "lineno" > 10< / span >   < span class = "preprocessor" > #include " packager/file/file_closer.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 >   < span class = "preprocessor" > #include " packager/status_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 >   < span class = "keyword" > namespace < / span > webvtt {< / div >
< div class = "line" > < a name = "l00017" > < / a > < span class = "lineno" > 17< / span >   < / div >
< div class = "line" > < a name = "l00018" > < / a > < span class = "lineno" > < a class = "line" href = "../../da/d33/classshaka_1_1media_1_1webvtt_1_1WebVttMuxer.html#afee98006c3a5f19548c494f251785fc9" > 18< / a > < / span >   < a class = "code" href = "../../da/d33/classshaka_1_1media_1_1webvtt_1_1WebVttMuxer.html#afee98006c3a5f19548c494f251785fc9" > WebVttMuxer::WebVttMuxer< / a > (< span class = "keyword" > const< / span > < a class = "code" href = "../../d0/d27/structshaka_1_1media_1_1MuxerOptions.html" > MuxerOptions< / a > & options) : < a class = "code" href = "../../d1/d4e/classshaka_1_1media_1_1TextMuxer.html" > TextMuxer< / a > (options) {}< / div >
< div class = "line" > < a name = "l00019" > < / a > < span class = "lineno" > 19< / span >   WebVttMuxer::~WebVttMuxer() {}< / div >
< div class = "line" > < a name = "l00020" > < / a > < span class = "lineno" > 20< / span >   < / div >
< div class = "line" > < a name = "l00021" > < / a > < span class = "lineno" > 21< / span >   < a class = "code" href = "../../d2/d20/classshaka_1_1Status.html" > Status< / a > WebVttMuxer::InitializeStream(< a class = "code" href = "../../db/dab/classshaka_1_1media_1_1TextStreamInfo.html" > TextStreamInfo< / a > * stream) {< / div >
< div class = "line" > < a name = "l00022" > < / a > < span class = "lineno" > 22< / span >   stream-> set_codec(kCodecWebVtt);< / div >
< div class = "line" > < a name = "l00023" > < / a > < span class = "lineno" > 23< / span >   stream-> set_codec_string(< span class = "stringliteral" > " wvtt" < / span > );< / div >
< div class = "line" > < a name = "l00024" > < / a > < span class = "lineno" > 24< / span >   < / div >
< div class = "line" > < a name = "l00025" > < / a > < span class = "lineno" > 25< / span >   < span class = "keyword" > const< / span > std::string preamble = WebVttGetPreamble(*stream);< / div >
< div class = "line" > < a name = "l00026" > < / a > < span class = "lineno" > 26< / span >   buffer_.reset(< span class = "keyword" > new< / span > < a class = "code" href = "../../d6/dda/classshaka_1_1media_1_1WebVttFileBuffer.html" > WebVttFileBuffer< / a > (< / div >
< div class = "line" > < a name = "l00027" > < / a > < span class = "lineno" > 27< / span >   options().transport_stream_timestamp_offset_ms, preamble));< / div >
< div class = "line" > < a name = "l00028" > < / a > < span class = "lineno" > 28< / span >   < span class = "keywordflow" > return< / span > Status::OK;< / 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 >   < a class = "code" href = "../../d2/d20/classshaka_1_1Status.html" > Status< / a > WebVttMuxer::AddTextSampleInternal(< span class = "keyword" > const< / span > TextSample& sample) {< / div >
< div class = "line" > < a name = "l00032" > < / a > < span class = "lineno" > 32< / span >   < span class = "keywordflow" > if< / span > (sample.id().find(< span class = "charliteral" > ' \n' < / span > ) != std::string::npos) {< / div >
< div class = "line" > < a name = "l00033" > < / a > < span class = "lineno" > 33< / span >   < span class = "keywordflow" > return< / span > < a class = "code" href = "../../d2/d20/classshaka_1_1Status.html" > Status< / a > (error::MUXER_FAILURE, < span class = "stringliteral" > " Text id cannot contain newlines" < / span > );< / div >
< div class = "line" > < a name = "l00034" > < / a > < span class = "lineno" > 34< / span >   }< / div >
< div class = "line" > < a name = "l00035" > < / a > < span class = "lineno" > 35< / span >   < / div >
< div class = "line" > < a name = "l00036" > < / a > < span class = "lineno" > 36< / span >   buffer_-> Append(sample);< / div >
< div class = "line" > < a name = "l00037" > < / a > < span class = "lineno" > 37< / span >   < span class = "keywordflow" > return< / span > Status::OK;< / div >
< div class = "line" > < a name = "l00038" > < / a > < span class = "lineno" > 38< / span >   }< / 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 >   Status WebVttMuxer::WriteToFile(< span class = "keyword" > const< / span > std::string& filename, uint64_t* size) {< / div >
< div class = "line" > < a name = "l00041" > < / a > < span class = "lineno" > 41< / span >   < span class = "comment" > // Write everything to the file before telling the manifest so that the< / span > < / div >
< div class = "line" > < a name = "l00042" > < / a > < span class = "lineno" > 42< / span >   < span class = "comment" > // file will exist on disk.< / span > < / div >
< div class = "line" > < a name = "l00043" > < / a > < span class = "lineno" > 43< / span >   std::unique_ptr< File, FileCloser> file(< a class = "code" href = "../../d3/d73/classshaka_1_1File.html#a68a15f623c2a1601879f291f93a1f464" > File::Open< / a > (filename.c_str(), < span class = "stringliteral" > " w" < / span > ));< / div >
< div class = "line" > < a name = "l00044" > < / a > < span class = "lineno" > 44< / span >   < span class = "keywordflow" > if< / span > (!file) {< / div >
< div class = "line" > < a name = "l00045" > < / a > < span class = "lineno" > 45< / span >   < span class = "keywordflow" > return< / span > Status(error::FILE_FAILURE, < span class = "stringliteral" > " Failed to open " < / span > + filename);< / 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 >   buffer_-> WriteTo(file.get(), size);< / div >
< div class = "line" > < a name = "l00049" > < / a > < span class = "lineno" > 49< / span >   buffer_-> Reset();< / div >
< div class = "line" > < a name = "l00050" > < / a > < span class = "lineno" > 50< / span >   < span class = "keywordflow" > if< / span > (!file.release()-> Close()) {< / div >
< div class = "line" > < a name = "l00051" > < / a > < span class = "lineno" > 51< / span >   < span class = "keywordflow" > return< / span > Status(error::FILE_FAILURE, < span class = "stringliteral" > " Failed to close " < / span > + filename);< / 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 >   < / div >
< div class = "line" > < a name = "l00054" > < / a > < span class = "lineno" > 54< / span >   < span class = "keywordflow" > return< / span > Status::OK;< / 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 webvtt< / span > < / div >
< div class = "line" > < a name = "l00058" > < / a > < span class = "lineno" > 58< / span >   } < span class = "comment" > // namespace media< / span > < / div >
< div class = "line" > < a name = "l00059" > < / a > < span class = "lineno" > 59< / span >   } < span class = "comment" > // namespace shaka< / span > < / div >
2021-06-22 00:16:40 +00:00
< / div > <!-- fragment --> < / div > <!-- contents -->
2021-04-10 04:00:37 +00:00
< div class = "ttc" id = "aclassshaka_1_1media_1_1WebVttFileBuffer_html" > < div class = "ttname" > < a href = "../../d6/dda/classshaka_1_1media_1_1WebVttFileBuffer.html" > shaka::media::WebVttFileBuffer< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "../../db/dff/webvtt__file__buffer_8h_source.html#l00021" > webvtt_file_buffer.h:21< / 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 >
2021-06-22 00:16:40 +00:00
< div class = "ttc" id = "aclassshaka_1_1media_1_1TextStreamInfo_html" > < div class = "ttname" > < a href = "../../db/dab/classshaka_1_1media_1_1TextStreamInfo.html" > shaka::media::TextStreamInfo< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "../../da/d2a/text__stream__info_8h_source.html#l00049" > text_stream_info.h:49< / a > < / div > < / div >
< div class = "ttc" id = "aclassshaka_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 >
2021-04-10 04:00:37 +00:00
< div class = "ttc" id = "astructshaka_1_1media_1_1MuxerOptions_html" > < div class = "ttname" > < a href = "../../d0/d27/structshaka_1_1media_1_1MuxerOptions.html" > shaka::media::MuxerOptions< / a > < / div > < div class = "ttdoc" > This structure contains the list of configuration options for Muxer.< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "../../d0/d0e/muxer__options_8h_source.html#l00020" > muxer_options.h:20< / a > < / div > < / div >
2021-06-22 00:16:40 +00:00
< div class = "ttc" id = "aclassshaka_1_1media_1_1TextMuxer_html" > < div class = "ttname" > < a href = "../../d1/d4e/classshaka_1_1media_1_1TextMuxer.html" > shaka::media::TextMuxer< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "../../d9/dae/text__muxer_8h_source.html#l00020" > text_muxer.h:20< / a > < / div > < / div >
< div class = "ttc" id = "aclassshaka_1_1media_1_1webvtt_1_1WebVttMuxer_html_afee98006c3a5f19548c494f251785fc9" > < div class = "ttname" > < a href = "../../da/d33/classshaka_1_1media_1_1webvtt_1_1WebVttMuxer.html#afee98006c3a5f19548c494f251785fc9" > shaka::media::webvtt::WebVttMuxer::WebVttMuxer< / a > < / div > < div class = "ttdeci" > WebVttMuxer(const MuxerOptions & options)< / div > < div class = "ttdoc" > Create a WebMMuxer object from MuxerOptions.< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "../../d2/def/webvtt__muxer_8cc_source.html#l00018" > webvtt_muxer.cc:18< / a > < / div > < / div >
< div class = "ttc" id = "aclassshaka_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 >
2021-04-10 04:00:37 +00:00
<!-- start footer part -->
< hr class = "footer" / > < address class = "footer" > < small >
2021-06-22 00:16:40 +00:00
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
2021-04-10 04:00:37 +00:00
< / small > < / address >
< / body >
< / html >
