2017-02-13 22:34:30 +00:00
<!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.6" / >
2017-02-22 19:44:07 +00:00
< title > DASH Media Packaging SDK: media/formats/webvtt/webvtt_sample_converter.h Source File< / title >
2017-02-13 22:34:30 +00:00
< 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/search.js" > < / script >
< script type = "text/javascript" >
$(document).ready(function() { searchBox.OnSelectItem(0); });
< / 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 style = "padding-left: 0.5em;" >
< div id = "projectname" > DASH Media Packaging SDK
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
< script type = "text/javascript" >
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
< / script >
< div id = "navrow1" class = "tabs" >
< ul class = "tablist" >
< li > < a href = "../../index.html" > < span > Main  Page< / span > < / a > < / li >
< li > < a href = "../../namespaces.html" > < span > Namespaces< / span > < / a > < / li >
< li > < a href = "../../annotated.html" > < span > Classes< / span > < / a > < / li >
< li class = "current" > < a href = "../../files.html" > < span > Files< / span > < / a > < / li >
< li >
< div id = "MSearchBox" class = "MSearchBoxInactive" >
< span class = "left" >
< img id = "MSearchSelect" src = "../../search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
< input type = "text" id = "MSearchField" value = "Search" accesskey = "S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
< / span > < span class = "right" >
< a id = "MSearchClose" href = "javascript:searchBox.CloseResultsWindow()" > < img id = "MSearchCloseImg" border = "0" src = "../../search/close.png" alt = "" / > < / a >
< / span >
< / div >
< / li >
< / ul >
< / div >
< div id = "navrow2" class = "tabs2" >
< ul class = "tablist" >
< li > < a href = "../../files.html" > < span > File  List< / span > < / a > < / li >
< / ul >
< / div >
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
< a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(0)" > < span class = "SelectionMark" >   < / span > All< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(1)" > < span class = "SelectionMark" >   < / span > Classes< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(2)" > < span class = "SelectionMark" >   < / span > Namespaces< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(3)" > < span class = "SelectionMark" >   < / span > Functions< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(4)" > < span class = "SelectionMark" >   < / span > Variables< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(5)" > < span class = "SelectionMark" >   < / span > Typedefs< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(6)" > < span class = "SelectionMark" >   < / span > Enumerations< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(7)" > < span class = "SelectionMark" >   < / span > Enumerator< / a > < / 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 >
2017-02-22 19:44:07 +00:00
< li class = "navelem" > < a class = "el" href = "../../dir_39dc0668bd5a501998f94e8b4e546c71.html" > media< / a > < / li > < li class = "navelem" > < a class = "el" href = "../../dir_65f7acfa8cf3a5f1edc11faa2428b914.html" > formats< / a > < / li > < li class = "navelem" > < a class = "el" href = "../../dir_2eceb70145328c029a5f43350007537a.html" > webvtt< / a > < / li > < / ul >
2017-02-13 22:34:30 +00:00
< / div >
< / div > <!-- top -->
< div class = "header" >
< div class = "headertitle" >
2017-02-22 19:44:07 +00:00
< div class = "title" > webvtt_sample_converter.h< / div > < / div >
2017-02-13 22:34:30 +00:00
< / div > <!-- header -->
< div class = "contents" >
< div class = "fragment" > < div class = "line" > < a name = "l00001" > < / a > < span class = "lineno" > 1< / span >   < span class = "comment" > // Copyright 2015 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 >
2017-02-22 19:44:07 +00:00
< div class = "line" > < a name = "l00007" > < / a > < span class = "lineno" > 7< / span >   < span class = "preprocessor" > #ifndef PACKAGER_MEDIA_FORMATS_WEBVTT_WEBVTT_SAMPLE_CONVERTER_H_< / span > < / div >
< div class = "line" > < a name = "l00008" > < / a > < span class = "lineno" > 8< / span >   < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define PACKAGER_MEDIA_FORMATS_WEBVTT_WEBVTT_SAMPLE_CONVERTER_H_< / span > < / div >
2017-02-13 22:34:30 +00:00
< div class = "line" > < a name = "l00009" > < / a > < span class = "lineno" > 9< / span >   < span class = "preprocessor" > < / span > < / div >
< div class = "line" > < a name = "l00010" > < / a > < span class = "lineno" > 10< / span >   < span class = "preprocessor" > #include < stdint.h> < / span > < / div >
< div class = "line" > < a name = "l00011" > < / a > < span class = "lineno" > 11< / span >   < span class = "preprocessor" > #include < list> < / 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 = "preprocessor" > #include " packager/media/base/status.h" < / span > < / div >
2017-02-22 19:44:07 +00:00
< div class = "line" > < a name = "l00014" > < / a > < span class = "lineno" > 14< / span >   < span class = "preprocessor" > #include " packager/media/formats/mp4/box.h" < / span > < / div >
< div class = "line" > < a name = "l00015" > < / a > < span class = "lineno" > 15< / span >   < span class = "preprocessor" > #include " packager/media/formats/mp4/box_definitions.h" < / span > < / div >
< div class = "line" > < a name = "l00016" > < / a > < span class = "lineno" > 16< / span >   < span class = "preprocessor" > #include " packager/media/formats/webvtt/cue.h" < / span > < / div >
< div class = "line" > < a name = "l00017" > < / a > < span class = "lineno" > 17< / span >   < / div >
< div class = "line" > < a name = "l00018" > < / a > < span class = "lineno" > 18< / span >   < span class = "keyword" > namespace < / span > shaka {< / div >
< div class = "line" > < a name = "l00019" > < / a > < span class = "lineno" > 19< / span >   < span class = "keyword" > namespace < / span > media {< / div >
2017-02-13 22:34:30 +00:00
< div class = "line" > < a name = "l00020" > < / a > < span class = "lineno" > 20< / span >   < / div >
2017-02-22 19:44:07 +00:00
< div class = "line" > < a name = "l00024" > < / a > < span class = "lineno" > 24< / span >   < span class = "keywordtype" > void< / span > AppendBoxToVector(mp4::Box* box, std::vector< uint8_t> * output_vector);< / div >
2017-02-13 22:34:30 +00:00
< div class = "line" > < a name = "l00025" > < / a > < span class = "lineno" > 25< / span >   < / div >
2017-03-15 20:49:01 +00:00
< div class = "line" > < a name = "l00055" > < / a > < span class = "lineno" > < a class = "line" href = "../../de/ddd/classshaka_1_1media_1_1WebVttSampleConverter.html" > 55< / a > < / span >   < span class = "keyword" > class < / span > < a class = "code" href = "../../de/ddd/classshaka_1_1media_1_1WebVttSampleConverter.html" > WebVttSampleConverter< / a > {< / div >
< div class = "line" > < a name = "l00056" > < / a > < span class = "lineno" > 56< / span >   < span class = "keyword" > public< / span > :< / div >
< div class = "line" > < a name = "l00057" > < / a > < span class = "lineno" > 57< / span >   < a class = "code" href = "../../de/ddd/classshaka_1_1media_1_1WebVttSampleConverter.html" > WebVttSampleConverter< / a > ();< / div >
< div class = "line" > < a name = "l00058" > < / a > < span class = "lineno" > 58< / span >   < span class = "keyword" > virtual< / span > ~< a class = "code" href = "../../de/ddd/classshaka_1_1media_1_1WebVttSampleConverter.html" > WebVttSampleConverter< / a > ();< / div >
< div class = "line" > < a name = "l00059" > < / a > < span class = "lineno" > 59< / span >   < / div >
< div class = "line" > < a name = "l00062" > < / a > < span class = "lineno" > 62< / span >   < span class = "keyword" > virtual< / span > < span class = "keywordtype" > void< / span > < a class = "code" href = "../../de/ddd/classshaka_1_1media_1_1WebVttSampleConverter.html#a651f604362b1dd2660a6fbcdacb75331" > PushCue< / a > (< span class = "keyword" > const< / span > < a class = "code" href = "../../dd/dce/structshaka_1_1media_1_1Cue.html" > Cue< / a > & cue);< / div >
< div class = "line" > < a name = "l00063" > < / a > < span class = "lineno" > 63< / span >   < / div >
< div class = "line" > < a name = "l00067" > < / a > < span class = "lineno" > 67< / span >   < span class = "keyword" > virtual< / span > < span class = "keywordtype" > void< / span > < a class = "code" href = "../../de/ddd/classshaka_1_1media_1_1WebVttSampleConverter.html#aa02d5ce7d9609b3841835fbab74b8c81" > Flush< / a > ();< / div >
< div class = "line" > < a name = "l00068" > < / a > < span class = "lineno" > 68< / span >   < / div >
< div class = "line" > < a name = "l00070" > < / a > < span class = "lineno" > 70< / span >   < span class = "keyword" > virtual< / span > < span class = "keywordtype" > size_t< / span > < a class = "code" href = "../../de/ddd/classshaka_1_1media_1_1WebVttSampleConverter.html#a3b0e60f307c5ea57d232216eced6af76" > ReadySamplesSize< / a > ();< / div >
< div class = "line" > < a name = "l00071" > < / a > < span class = "lineno" > 71< / span >   < / div >
< div class = "line" > < a name = "l00076" > < / a > < span class = "lineno" > 76< / span >   < span class = "keyword" > virtual< / span > std::shared_ptr< MediaSample> < a class = "code" href = "../../de/ddd/classshaka_1_1media_1_1WebVttSampleConverter.html#a43fa59b53f847b638cf32c6f03f87dcd" > PopSample< / a > ();< / div >
< div class = "line" > < a name = "l00077" > < / a > < span class = "lineno" > 77< / span >   < / div >
< div class = "line" > < a name = "l00078" > < / a > < span class = "lineno" > 78< / span >   < span class = "keyword" > private< / span > :< / div >
< div class = "line" > < a name = "l00079" > < / a > < span class = "lineno" > 79< / span >   < span class = "comment" > // Handle |cues_| except the last item, and create samples from them.< / span > < / div >
< div class = "line" > < a name = "l00080" > < / a > < span class = "lineno" > 80< / span >   < span class = "comment" > // All cues that overlap with the latest cue are not processed.< / span > < / div >
< div class = "line" > < a name = "l00081" > < / a > < span class = "lineno" > 81< / span >   < span class = "comment" > // Usually the last cue (and cues that overlap with it) should not be< / span > < / div >
< div class = "line" > < a name = "l00082" > < / a > < span class = "lineno" > 82< / span >   < span class = "comment" > // processed right away because the following cues may overlap with the latest< / span > < / div >
< div class = "line" > < a name = "l00083" > < / a > < span class = "lineno" > 83< / span >   < span class = "comment" > // cue or the existing cues.< / span > < / div >
< div class = "line" > < a name = "l00084" > < / a > < span class = "lineno" > 84< / span >   < span class = "comment" > // If a cue has been proceessed, then this returns true.< / span > < / div >
< div class = "line" > < a name = "l00085" > < / a > < span class = "lineno" > 85< / span >   < span class = "keywordtype" > bool< / span > HandleAllCuesButLatest();< / 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 = "comment" > // Same as HandleAllCuesButLatest() but it also includes the latest cue.< / span > < / div >
< div class = "line" > < a name = "l00088" > < / a > < span class = "lineno" > 88< / span >   < span class = "comment" > // If a cue has been processed, then this returns true.< / span > < / div >
< div class = "line" > < a name = "l00089" > < / a > < span class = "lineno" > 89< / span >   < span class = "keywordtype" > bool< / span > HandleAllCues();< / div >
< div class = "line" > < a name = "l00090" > < / a > < span class = "lineno" > 90< / span >   < / div >
< div class = "line" > < a name = "l00091" > < / a > < span class = "lineno" > 91< / span >   < span class = "comment" > // Sweep line algorithm that handles the cues in |cues_|.< / span > < / div >
< div class = "line" > < a name = "l00092" > < / a > < span class = "lineno" > 92< / span >   < span class = "comment" > // This does not erase |cues_|.< / span > < / div >
< div class = "line" > < a name = "l00093" > < / a > < span class = "lineno" > 93< / span >   < span class = "comment" > // If a cue has been processed, this returns true.< / span > < / div >
< div class = "line" > < a name = "l00094" > < / a > < span class = "lineno" > 94< / span >   < span class = "comment" > // |sweep_line| is the start time and |sweep_stop_time| is when the sweep< / span > < / div >
< div class = "line" > < a name = "l00095" > < / a > < span class = "lineno" > 95< / span >   < span class = "comment" > // should stop.< / span > < / div >
< div class = "line" > < a name = "l00096" > < / a > < span class = "lineno" > 96< / span >   < span class = "keywordtype" > bool< / span > SweepCues(uint64_t sweep_line, uint64_t sweep_stop_time);< / 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 = "comment" > // This is going to be in ' mdat' box. Keep this around until a sample is< / span > < / div >
< div class = "line" > < a name = "l00099" > < / a > < span class = "lineno" > 99< / span >   < span class = "comment" > // ready.< / span > < / div >
< div class = "line" > < a name = "l00100" > < / a > < span class = "lineno" > 100< / span >   std::list< Cue> cues_;< / div >
< div class = "line" > < a name = "l00101" > < / a > < span class = "lineno" > 101< / span >   < / div >
< div class = "line" > < a name = "l00102" > < / a > < span class = "lineno" > 102< / span >   < span class = "comment" > // For comment samples.< / span > < / div >
< div class = "line" > < a name = "l00103" > < / a > < span class = "lineno" > 103< / span >   std::list< mp4::VTTAdditionalTextBox> additional_texts_;< / 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" > // Samples that are ready to be processed.< / span > < / div >
< div class = "line" > < a name = "l00106" > < / a > < span class = "lineno" > 106< / span >   std::list< std::shared_ptr< MediaSample> > ready_samples_;< / div >
< div class = "line" > < a name = "l00107" > < / a > < span class = "lineno" > 107< / span >   < / div >
< div class = "line" > < a name = "l00108" > < / a > < span class = "lineno" > 108< / span >   < span class = "comment" > // This keeps track of the max end time of the processed cues which is the< / span > < / div >
< div class = "line" > < a name = "l00109" > < / a > < span class = "lineno" > 109< / span >   < span class = "comment" > // start time of the next cue. Used to check if cue_current_time has to be set< / span > < / div >
< div class = "line" > < a name = "l00110" > < / a > < span class = "lineno" > 110< / span >   < span class = "comment" > // or an empty cue (gap) has to be added.< / span > < / div >
< div class = "line" > < a name = "l00111" > < / a > < span class = "lineno" > 111< / span >   uint64_t next_cue_start_time_;< / 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 >   DISALLOW_COPY_AND_ASSIGN(< a class = "code" href = "../../de/ddd/classshaka_1_1media_1_1WebVttSampleConverter.html" > WebVttSampleConverter< / a > );< / div >
< div class = "line" > < a name = "l00114" > < / a > < span class = "lineno" > 114< / span >   };< / div >
< div class = "line" > < a name = "l00115" > < / a > < span class = "lineno" > 115< / span >   < / div >
< div class = "line" > < a name = "l00116" > < / a > < span class = "lineno" > 116< / span >   } < span class = "comment" > // namespace media< / span > < / div >
< div class = "line" > < a name = "l00117" > < / a > < span class = "lineno" > 117< / span >   } < span class = "comment" > // namespace shaka< / 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 = "preprocessor" > #endif // PACKAGER_MEDIA_FORMATS_WEBVTT_WEBVTT_SAMPLE_CONVERTER_H_< / span > < / div >
< div class = "ttc" id = "classshaka_1_1media_1_1WebVttSampleConverter_html_aa02d5ce7d9609b3841835fbab74b8c81" > < div class = "ttname" > < a href = "../../de/ddd/classshaka_1_1media_1_1WebVttSampleConverter.html#aa02d5ce7d9609b3841835fbab74b8c81" > shaka::media::WebVttSampleConverter::Flush< / a > < / div > < div class = "ttdeci" > virtual void Flush()< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "../../d4/df5/webvtt__sample__converter_8cc_source.html#l00174" > webvtt_sample_converter.cc:174< / a > < / div > < / div >
< div class = "ttc" id = "classshaka_1_1media_1_1WebVttSampleConverter_html" > < div class = "ttname" > < a href = "../../de/ddd/classshaka_1_1media_1_1WebVttSampleConverter.html" > shaka::media::WebVttSampleConverter< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "../../db/d0b/webvtt__sample__converter_8h_source.html#l00055" > webvtt_sample_converter.h:55< / a > < / div > < / div >
< div class = "ttc" id = "classshaka_1_1media_1_1WebVttSampleConverter_html_a3b0e60f307c5ea57d232216eced6af76" > < div class = "ttname" > < a href = "../../de/ddd/classshaka_1_1media_1_1WebVttSampleConverter.html#a3b0e60f307c5ea57d232216eced6af76" > shaka::media::WebVttSampleConverter::ReadySamplesSize< / a > < / div > < div class = "ttdeci" > virtual size_t ReadySamplesSize()< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "../../d4/df5/webvtt__sample__converter_8cc_source.html#l00195" > webvtt_sample_converter.cc:195< / a > < / div > < / div >
< div class = "ttc" id = "classshaka_1_1media_1_1WebVttSampleConverter_html_a651f604362b1dd2660a6fbcdacb75331" > < div class = "ttname" > < a href = "../../de/ddd/classshaka_1_1media_1_1WebVttSampleConverter.html#a651f604362b1dd2660a6fbcdacb75331" > shaka::media::WebVttSampleConverter::PushCue< / a > < / div > < div class = "ttdeci" > virtual void PushCue(const Cue & cue)< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "../../d4/df5/webvtt__sample__converter_8cc_source.html#l00139" > webvtt_sample_converter.cc:139< / a > < / div > < / div >
< div class = "ttc" id = "classshaka_1_1media_1_1WebVttSampleConverter_html_a43fa59b53f847b638cf32c6f03f87dcd" > < div class = "ttname" > < a href = "../../de/ddd/classshaka_1_1media_1_1WebVttSampleConverter.html#a43fa59b53f847b638cf32c6f03f87dcd" > shaka::media::WebVttSampleConverter::PopSample< / a > < / div > < div class = "ttdeci" > virtual std::shared_ptr< MediaSample > PopSample()< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "../../d4/df5/webvtt__sample__converter_8cc_source.html#l00199" > webvtt_sample_converter.cc:199< / a > < / div > < / div >
< div class = "ttc" id = "structshaka_1_1media_1_1Cue_html" > < div class = "ttname" > < a href = "../../dd/dce/structshaka_1_1media_1_1Cue.html" > shaka::media::Cue< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "../../d6/d6a/cue_8h_source.html#l00018" > cue.h:18< / a > < / div > < / div >
2017-02-13 22:34:30 +00:00
< / div > <!-- fragment --> < / div > <!-- contents -->
<!-- start footer part -->
< hr class = "footer" / > < address class = "footer" > < small >
2017-03-23 18:24:11 +00:00
Generated on Thu Mar 23 2017 18:24:05 for DASH Media Packaging SDK by   < a href = "http://www.doxygen.org/index.html" >
2017-02-13 22:34:30 +00:00
< img class = "footer" src = "../../doxygen.png" alt = "doxygen" / >
< / a > 1.8.6
< / small > < / address >
< / body >
< / html >
