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">
2018-05-23 23:12:00 +00:00
< 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" / >
2018-05-23 23:12:00 +00:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< title > Shaka Packager SDK: packager/media/chunking/cue_alignment_handler.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 -->
2021-06-22 00:16:40 +00:00
<!-- Generated by Doxygen 1.8.17 -->
2018-05-23 23:12:00 +00:00
< script type = "text/javascript" >
2021-04-10 04:00:37 +00:00
/* @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 */
2018-05-23 23:12:00 +00:00
< / script >
< script type = "text/javascript" src = "../../menudata.js" > < / script >
< script type = "text/javascript" src = "../../menu.js" > < / script >
< script type = "text/javascript" >
2021-04-10 04:00:37 +00:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
2018-05-23 23:12:00 +00:00
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
2021-04-10 04:00:37 +00:00
/* @license-end */< / script >
2018-05-23 23:12:00 +00:00
< 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_1338cd99faf71b6cb1609e99e3340e45.html" > chunking< / a > < / li > < / ul >
< / div >
< / div > <!-- top -->
< div class = "header" >
< div class = "headertitle" >
< div class = "title" > cue_alignment_handler.h< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
2021-04-10 04:00:37 +00:00
< div class = "fragment" > < div class = "line" > < a name = "l00001" > < / a > < span class = "lineno" > 1< / span >   < span class = "comment" > // Copyright 2018 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" > #ifndef PACKAGER_MEDIA_CHUNKING_CUE_ALIGNMENT_HANDLER_< / span > < / div >
< div class = "line" > < a name = "l00008" > < / a > < span class = "lineno" > 8< / span >   < span class = "preprocessor" > #define PACKAGER_MEDIA_CHUNKING_CUE_ALIGNMENT_HANDLER_< / span > < / div >
< div class = "line" > < a name = "l00009" > < / a > < span class = "lineno" > 9< / span >   < / div >
2021-06-22 00:16:40 +00:00
< div class = "line" > < a name = "l00010" > < / a > < span class = "lineno" > 10< / span >   < span class = "preprocessor" > #include < deque> < / 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/media_handler.h" < / span > < / div >
< div class = "line" > < a name = "l00014" > < / a > < span class = "lineno" > 14< / span >   < span class = "preprocessor" > #include " packager/media/chunking/sync_point_queue.h" < / span > < / div >
< div class = "line" > < a name = "l00015" > < / a > < span class = "lineno" > 15< / span >   < / div >
< div class = "line" > < a name = "l00016" > < / a > < span class = "lineno" > 16< / span >   < span class = "keyword" > namespace < / span > < a class = "code" href = "../../d8/daf/namespaceshaka.html" > shaka< / a > {< / div >
< div class = "line" > < a name = "l00017" > < / a > < span class = "lineno" > 17< / span >   < span class = "keyword" > namespace < / span > media {< / div >
< div class = "line" > < a name = "l00018" > < / a > < span class = "lineno" > 18< / span >   < / div >
< div class = "line" > < a name = "l00026" > < / a > < span class = "lineno" > < a class = "line" href = "../../da/dab/classshaka_1_1media_1_1CueAlignmentHandler.html" > 26< / a > < / span >   < span class = "keyword" > class < / span > < a class = "code" href = "../../da/dab/classshaka_1_1media_1_1CueAlignmentHandler.html" > CueAlignmentHandler< / a > : < span class = "keyword" > public< / span > < a class = "code" href = "../../da/dfd/classshaka_1_1media_1_1MediaHandler.html" > MediaHandler< / a > {< / div >
< div class = "line" > < a name = "l00027" > < / a > < span class = "lineno" > 27< / span >   < span class = "keyword" > public< / span > :< / div >
< div class = "line" > < a name = "l00028" > < / a > < span class = "lineno" > 28< / span >   < span class = "keyword" > explicit< / span > < a class = "code" href = "../../da/dab/classshaka_1_1media_1_1CueAlignmentHandler.html" > CueAlignmentHandler< / a > (< a class = "code" href = "../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html" > SyncPointQueue< / a > * sync_points);< / div >
< div class = "line" > < a name = "l00029" > < / a > < span class = "lineno" > 29< / span >   ~< a class = "code" href = "../../da/dab/classshaka_1_1media_1_1CueAlignmentHandler.html" > CueAlignmentHandler< / a > () = < span class = "keywordflow" > default< / 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 = "keyword" > private< / span > :< / div >
< div class = "line" > < a name = "l00032" > < / a > < span class = "lineno" > 32< / span >   < a class = "code" href = "../../da/dab/classshaka_1_1media_1_1CueAlignmentHandler.html" > CueAlignmentHandler< / a > (< span class = "keyword" > const< / span > < a class = "code" href = "../../da/dab/classshaka_1_1media_1_1CueAlignmentHandler.html" > CueAlignmentHandler< / a > & ) = < span class = "keyword" > delete< / span > ;< / div >
< div class = "line" > < a name = "l00033" > < / a > < span class = "lineno" > 33< / span >   < a class = "code" href = "../../da/dab/classshaka_1_1media_1_1CueAlignmentHandler.html" > CueAlignmentHandler< / a > & operator=(< span class = "keyword" > const< / span > < a class = "code" href = "../../da/dab/classshaka_1_1media_1_1CueAlignmentHandler.html" > CueAlignmentHandler< / a > & ) = < span class = "keyword" > delete< / 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 >   < span class = "keyword" > struct < / span > StreamState {< / div >
< div class = "line" > < a name = "l00036" > < / a > < span class = "lineno" > 36< / span >   < span class = "comment" > // Information for the stream.< / span > < / div >
< div class = "line" > < a name = "l00037" > < / a > < span class = "lineno" > 37< / span >   std::shared_ptr< const StreamInfo> info;< / div >
< div class = "line" > < a name = "l00038" > < / a > < span class = "lineno" > 38< / span >   < span class = "comment" > // Cached samples that cannot be dispatched. All the samples should be at or< / span > < / div >
< div class = "line" > < a name = "l00039" > < / a > < span class = "lineno" > 39< / span >   < span class = "comment" > // after |hint|.< / span > < / div >
< div class = "line" > < a name = "l00040" > < / a > < span class = "lineno" > 40< / span >   std::list< std::unique_ptr< StreamData> > samples;< / div >
< div class = "line" > < a name = "l00041" > < / a > < span class = "lineno" > 41< / span >   < span class = "comment" > // If set, the stream is pending to be flushed.< / span > < / div >
< div class = "line" > < a name = "l00042" > < / a > < span class = "lineno" > 42< / span >   < span class = "keywordtype" > bool< / span > to_be_flushed = < span class = "keyword" > false< / span > ;< / div >
< div class = "line" > < a name = "l00043" > < / a > < span class = "lineno" > 43< / span >   < span class = "comment" > // Only set for text stream.< / span > < / div >
< div class = "line" > < a name = "l00044" > < / a > < span class = "lineno" > 44< / span >   < span class = "keywordtype" > double< / span > max_text_sample_end_time_seconds = 0;< / 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 = "comment" > // A list of cues that the stream should inject between media samples. When< / span > < / div >
< div class = "line" > < a name = "l00047" > < / a > < span class = "lineno" > 47< / span >   < span class = "comment" > // there are no cues, the stream should run up to the hint.< / span > < / div >
< div class = "line" > < a name = "l00048" > < / a > < span class = "lineno" > 48< / span >   std::list< std::unique_ptr< StreamData> > cues;< / div >
< div class = "line" > < a name = "l00049" > < / a > < span class = "lineno" > 49< / span >   };< / div >
< div class = "line" > < a name = "l00050" > < / a > < span class = "lineno" > 50< / span >   < / div >
< div class = "line" > < a name = "l00051" > < / a > < span class = "lineno" > 51< / span >   < span class = "comment" > // MediaHandler overrides.< / span > < / div >
< div class = "line" > < a name = "l00052" > < / a > < span class = "lineno" > 52< / span >   < a class = "code" href = "../../d2/d20/classshaka_1_1Status.html" > Status< / a > InitializeInternal() < span class = "keyword" > override< / span > ;< / div >
< div class = "line" > < a name = "l00053" > < / a > < span class = "lineno" > 53< / span >   < a class = "code" href = "../../d2/d20/classshaka_1_1Status.html" > Status< / a > Process(std::unique_ptr< StreamData> data) < span class = "keyword" > override< / span > ;< / div >
< div class = "line" > < a name = "l00054" > < / a > < span class = "lineno" > 54< / span >   < a class = "code" href = "../../d2/d20/classshaka_1_1Status.html" > Status< / a > OnFlushRequest(< span class = "keywordtype" > size_t< / span > stream_index) < span class = "keyword" > override< / span > ;< / 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 >   < span class = "comment" > // Internal handling functions for different stream data.< / span > < / div >
< div class = "line" > < a name = "l00057" > < / a > < span class = "lineno" > 57< / span >   < a class = "code" href = "../../d2/d20/classshaka_1_1Status.html" > Status< / a > OnStreamInfo(std::unique_ptr< StreamData> data);< / 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 >   < a class = "code" href = "../../d2/d20/classshaka_1_1Status.html" > Status< / a > OnVideoSample(std::unique_ptr< StreamData> sample);< / div >
< div class = "line" > < a name = "l00060" > < / a > < span class = "lineno" > 60< / span >   < a class = "code" href = "../../d2/d20/classshaka_1_1Status.html" > Status< / a > OnNonVideoSample(std::unique_ptr< StreamData> sample);< / div >
< div class = "line" > < a name = "l00061" > < / a > < span class = "lineno" > 61< / span >   < a class = "code" href = "../../d2/d20/classshaka_1_1Status.html" > Status< / a > OnSample(std::unique_ptr< StreamData> sample);< / div >
< div class = "line" > < a name = "l00062" > < / a > < span class = "lineno" > 62< / span >   < / div >
< div class = "line" > < a name = "l00063" > < / a > < span class = "lineno" > 63< / span >   < span class = "comment" > // Update stream states with new sync point.< / span > < / div >
< div class = "line" > < a name = "l00064" > < / a > < span class = "lineno" > 64< / span >   < a class = "code" href = "../../d2/d20/classshaka_1_1Status.html" > Status< / a > UseNewSyncPoint(std::shared_ptr< const CueEvent> new_sync);< / 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 >   < span class = "comment" > // Check if everyone is waiting for new hint points.< / span > < / div >
< div class = "line" > < a name = "l00067" > < / a > < span class = "lineno" > 67< / span >   < span class = "keywordtype" > bool< / span > EveryoneWaitingAtHint() < span class = "keyword" > const< / span > ;< / 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 >   < span class = "comment" > // Dispatch or save incoming sample.< / span > < / div >
< div class = "line" > < a name = "l00070" > < / a > < span class = "lineno" > 70< / span >   < a class = "code" href = "../../d2/d20/classshaka_1_1Status.html" > Status< / a > AcceptSample(std::unique_ptr< StreamData> sample,< / div >
< div class = "line" > < a name = "l00071" > < / a > < span class = "lineno" > 71< / span >   StreamState* stream_state);< / div >
< div class = "line" > < a name = "l00072" > < / a > < span class = "lineno" > 72< / span >   < / div >
< div class = "line" > < a name = "l00073" > < / a > < span class = "lineno" > 73< / span >   < span class = "comment" > // Dispatch all samples and cues (in the correct order) for the given stream.< / span > < / div >
< div class = "line" > < a name = "l00074" > < / a > < span class = "lineno" > 74< / span >   < a class = "code" href = "../../d2/d20/classshaka_1_1Status.html" > Status< / a > RunThroughSamples(StreamState* stream);< / 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 >   < a class = "code" href = "../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html" > SyncPointQueue< / a > * < span class = "keyword" > const< / span > sync_points_ = < span class = "keyword" > nullptr< / span > ;< / div >
< div class = "line" > < a name = "l00077" > < / a > < span class = "lineno" > 77< / span >   std::deque< StreamState> stream_states_;< / div >
< div class = "line" > < a name = "l00078" > < / a > < span class = "lineno" > 78< / span >   < / div >
< div class = "line" > < a name = "l00079" > < / a > < span class = "lineno" > 79< / span >   < span class = "comment" > // A common hint used by all streams. When a new cue is given to all streams,< / span > < / div >
< div class = "line" > < a name = "l00080" > < / a > < span class = "lineno" > 80< / span >   < span class = "comment" > // the hint will be updated. The hint will always be larger than any cue. The< / span > < / div >
< div class = "line" > < a name = "l00081" > < / a > < span class = "lineno" > 81< / span >   < span class = "comment" > // hint represents the min time in seconds for the next cue appear. The hints< / span > < / div >
< div class = "line" > < a name = "l00082" > < / a > < span class = "lineno" > 82< / span >   < span class = "comment" > // are based off the un-promoted cue event times in |sync_points_|.< / span > < / div >
< div class = "line" > < a name = "l00083" > < / a > < span class = "lineno" > 83< / span >   < span class = "comment" > //< / span > < / div >
< div class = "line" > < a name = "l00084" > < / a > < span class = "lineno" > 84< / span >   < span class = "comment" > // When a video stream passes the hint, it will promote the corresponding cue< / span > < / div >
< div class = "line" > < a name = "l00085" > < / a > < span class = "lineno" > 85< / span >   < span class = "comment" > // event. If all streams get to the hint and there are no video streams, the< / span > < / div >
< div class = "line" > < a name = "l00086" > < / a > < span class = "lineno" > 86< / span >   < span class = "comment" > // thread will block until |sync_points_| gives back a promoted cue event.< / span > < / div >
< div class = "line" > < a name = "l00087" > < / a > < span class = "lineno" > 87< / span >   < span class = "keywordtype" > double< / span > hint_;< / 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 >   < / div >
< div class = "line" > < a name = "l00090" > < / a > < span class = "lineno" > 90< / span >   } < span class = "comment" > // namespace media< / span > < / div >
< div class = "line" > < a name = "l00091" > < / a > < span class = "lineno" > 91< / span >   } < span class = "comment" > // namespace shaka< / span > < / div >
< div class = "line" > < a name = "l00092" > < / a > < span class = "lineno" > 92< / span >   < / div >
< div class = "line" > < a name = "l00093" > < / a > < span class = "lineno" > 93< / span >   < span class = "preprocessor" > #endif // PACKAGER_MEDIA_CHUNKING_CUE_ALIGNMENT_HANDLER_< / span > < / div >
< / div > <!-- fragment --> < / div > <!-- contents -->
< div class = "ttc" id = "aclassshaka_1_1media_1_1CueAlignmentHandler_html" > < div class = "ttname" > < a href = "../../da/dab/classshaka_1_1media_1_1CueAlignmentHandler.html" > shaka::media::CueAlignmentHandler< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "../../dd/d20/cue__alignment__handler_8h_source.html#l00026" > cue_alignment_handler.h:26< / 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 >
< div class = "ttc" id = "aclassshaka_1_1media_1_1SyncPointQueue_html" > < div class = "ttname" > < a href = "../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html" > shaka::media::SyncPointQueue< / a > < / div > < div class = "ttdoc" > A synchronized queue for cue points.< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "../../d3/d5f/sync__point__queue_8h_source.html#l00020" > sync_point_queue.h:20< / a > < / div > < / div >
2021-04-10 04:00:37 +00:00
< 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 >
< div class = "ttc" id = "aclassshaka_1_1media_1_1MediaHandler_html" > < div class = "ttname" > < a href = "../../da/dfd/classshaka_1_1media_1_1MediaHandler.html" > shaka::media::MediaHandler< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "../../d3/d93/media__handler_8h_source.html#l00154" > media_handler.h:154< / a > < / div > < / div >
2018-05-23 23:12:00 +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
2018-05-23 23:12:00 +00:00
< / small > < / address >
< / body >
< / html >
