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">
2015-10-16 00:33:37 +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-04-10 04:00:37 +00:00
< meta name = "generator" content = "Doxygen 1.9.1" / >
2018-02-10 23:37:42 +00:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
2017-09-20 02:35:05 +00:00
< title > Shaka Packager SDK: packager/mpd/base/bandwidth_estimator.h Source File< / title >
2015-10-16 00:33:37 +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" / >
2018-02-10 23:37:42 +00:00
< script type = "text/javascript" src = "../../search/searchdata.js" > < / script >
2015-10-16 00:33:37 +00:00
< 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;" >
2018-02-10 23:37:42 +00:00
< td id = "projectalign" style = "padding-left: 0.5em;" >
2017-09-20 02:35:05 +00:00
< div id = "projectname" > Shaka Packager SDK
2015-10-16 00:33:37 +00:00
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
2021-04-10 04:00:37 +00:00
<!-- Generated by Doxygen 1.9.1 -->
2015-10-16 00:33:37 +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 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search','.html');
/* @license-end */
2015-10-16 00:33:37 +00:00
< / script >
2018-02-10 23:37:42 +00:00
< 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-02-10 23:37:42 +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-02-10 23:37:42 +00:00
< div id = "main-nav" > < / div >
2015-10-16 00:33:37 +00:00
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
2018-02-10 23:37:42 +00:00
< / div >
2015-10-16 00:33:37 +00:00
<!-- 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-09-20 02:35:05 +00:00
< li class = "navelem" > < a class = "el" href = "../../dir_3f8eec2fc361645de4b1ec14c19fffc7.html" > packager< / a > < / li > < li class = "navelem" > < a class = "el" href = "../../dir_b885194e7131202a9b4650a8967e838c.html" > mpd< / a > < / li > < li class = "navelem" > < a class = "el" href = "../../dir_6fe4b0529cd3ec97045d3314254a0cce.html" > base< / a > < / li > < / ul >
2015-10-16 00:33:37 +00:00
< / div >
< / div > <!-- top -->
< div class = "header" >
< div class = "headertitle" >
< div class = "title" > bandwidth_estimator.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 2014 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 MPD_BASE_BANDWIDTH_ESTIMATOR_H_< / span > < / div >
< div class = "line" > < a name = "l00008" > < / a > < span class = "lineno" > 8< / span >   < span class = "preprocessor" > #define MPD_BASE_BANDWIDTH_ESTIMATOR_H_< / span > < / div >
< div class = "line" > < a name = "l00009" > < / a > < span class = "lineno" > 9< / 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 >   < / div >
< div class = "line" > < a name = "l00012" > < / a > < span class = "lineno" > 12< / span >   < span class = "preprocessor" > #include < vector> < / 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 >   < / div >
< div class = "line" > < a name = "l00016" > < / a > < span class = "lineno" > < a class = "line" href = "../../da/d2c/classshaka_1_1BandwidthEstimator.html" > 16< / a > < / span >   < span class = "keyword" > class < / span > < a class = "code" href = "../../da/d2c/classshaka_1_1BandwidthEstimator.html" > BandwidthEstimator< / a > {< / div >
< div class = "line" > < a name = "l00017" > < / a > < span class = "lineno" > 17< / span >   < span class = "keyword" > public< / span > :< / div >
< div class = "line" > < a name = "l00018" > < / a > < span class = "lineno" > 18< / span >   < a class = "code" href = "../../da/d2c/classshaka_1_1BandwidthEstimator.html" > BandwidthEstimator< / a > ();< / div >
< div class = "line" > < a name = "l00019" > < / a > < span class = "lineno" > 19< / span >   ~< a class = "code" href = "../../da/d2c/classshaka_1_1BandwidthEstimator.html" > BandwidthEstimator< / a > ();< / div >
< div class = "line" > < a name = "l00020" > < / a > < span class = "lineno" > 20< / span >   < / div >
< div class = "line" > < a name = "l00023" > < / a > < span class = "lineno" > 23< / span >   < span class = "keywordtype" > void< / span > < a class = "code" href = "../../da/d2c/classshaka_1_1BandwidthEstimator.html#a53c67d33f000489d1ebb31a2bdd766a4" > AddBlock< / a > (uint64_t size_in_bytes, < span class = "keywordtype" > double< / span > duration);< / div >
< div class = "line" > < a name = "l00024" > < / a > < span class = "lineno" > 24< / span >   < / div >
< div class = "line" > < a name = "l00029" > < / a > < span class = "lineno" > 29< / span >   uint64_t < a class = "code" href = "../../da/d2c/classshaka_1_1BandwidthEstimator.html#a9414560e16c46e7e2da3683a4dfb86cc" > Estimate< / a > () < span class = "keyword" > const< / span > ;< / div >
< div class = "line" > < a name = "l00030" > < / a > < span class = "lineno" > 30< / span >   < / div >
< div class = "line" > < a name = "l00035" > < / a > < span class = "lineno" > 35< / span >   uint64_t < a class = "code" href = "../../da/d2c/classshaka_1_1BandwidthEstimator.html#a0df6c40f43a89d3d481392ac0298e37c" > Max< / a > () < span class = "keyword" > const< / span > ;< / 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 >   < span class = "keyword" > private< / span > :< / div >
< div class = "line" > < a name = "l00038" > < / a > < span class = "lineno" > 38< / span >   < a class = "code" href = "../../da/d2c/classshaka_1_1BandwidthEstimator.html" > BandwidthEstimator< / a > (< span class = "keyword" > const< / span > < a class = "code" href = "../../da/d2c/classshaka_1_1BandwidthEstimator.html" > BandwidthEstimator< / a > & ) = < span class = "keyword" > delete< / span > ;< / div >
< div class = "line" > < a name = "l00039" > < / a > < span class = "lineno" > 39< / span >   < a class = "code" href = "../../da/d2c/classshaka_1_1BandwidthEstimator.html" > BandwidthEstimator< / a > & operator=(< span class = "keyword" > const< / span > < a class = "code" href = "../../da/d2c/classshaka_1_1BandwidthEstimator.html" > BandwidthEstimator< / a > & ) = < span class = "keyword" > delete< / span > ;< / div >
< div class = "line" > < a name = "l00040" > < / a > < span class = "lineno" > 40< / span >   < / div >
< div class = "line" > < a name = "l00041" > < / a > < span class = "lineno" > 41< / span >   < span class = "keyword" > struct < / span > Block {< / div >
< div class = "line" > < a name = "l00042" > < / a > < span class = "lineno" > 42< / span >   uint64_t size_in_bits;< / div >
< div class = "line" > < a name = "l00043" > < / a > < span class = "lineno" > 43< / span >   < span class = "keywordtype" > double< / span > duration;< / div >
< div class = "line" > < a name = "l00044" > < / a > < span class = "lineno" > 44< / span >   };< / div >
< div class = "line" > < a name = "l00045" > < / a > < span class = "lineno" > 45< / span >   < span class = "comment" > // Return the average block duration of the blocks in |initial_blocks_|.< / span > < / div >
< div class = "line" > < a name = "l00046" > < / a > < span class = "lineno" > 46< / span >   < span class = "keywordtype" > double< / span > GetAverageBlockDuration() < span class = "keyword" > const< / span > ;< / div >
< div class = "line" > < a name = "l00047" > < / a > < span class = "lineno" > 47< / span >   < span class = "comment" > // Return the bitrate of the block. Note that a bitrate of 0 is returned if< / span > < / div >
< div class = "line" > < a name = "l00048" > < / a > < span class = "lineno" > 48< / span >   < span class = "comment" > // the block duration is less than 50% of target block duration.< / span > < / div >
< div class = "line" > < a name = "l00049" > < / a > < span class = "lineno" > 49< / span >   uint64_t GetBitrate(< span class = "keyword" > const< / span > Block& block, < span class = "keywordtype" > double< / span > target_block_duration) < span class = "keyword" > const< / 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 >   std::vector< Block> initial_blocks_;< / div >
< div class = "line" > < a name = "l00052" > < / a > < span class = "lineno" > 52< / span >   < span class = "comment" > // Target block duration will be estimated from the average duration of the< / span > < / div >
< div class = "line" > < a name = "l00053" > < / a > < span class = "lineno" > 53< / span >   < span class = "comment" > // initial blocks.< / span > < / div >
< div class = "line" > < a name = "l00054" > < / a > < span class = "lineno" > 54< / span >   < span class = "keywordtype" > double< / span > target_block_duration_ = 0;< / 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 >   uint64_t total_size_in_bits_ = 0;< / div >
< div class = "line" > < a name = "l00057" > < / a > < span class = "lineno" > 57< / span >   < span class = "keywordtype" > double< / span > total_duration_ = 0;< / div >
< div class = "line" > < a name = "l00058" > < / a > < span class = "lineno" > 58< / span >   uint64_t max_bitrate_ = 0;< / 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 >   < / div >
< div class = "line" > < a name = "l00061" > < / a > < span class = "lineno" > 61< / span >   } < span class = "comment" > // namespace shaka< / span > < / 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 = "preprocessor" > #endif < / span > < span class = "comment" > // MPD_BASE_BANDWIDTH_ESTIMATOR_H_< / span > < / div >
< div class = "ttc" id = "aclassshaka_1_1BandwidthEstimator_html" > < div class = "ttname" > < a href = "../../da/d2c/classshaka_1_1BandwidthEstimator.html" > shaka::BandwidthEstimator< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "../../d8/d19/bandwidth__estimator_8h_source.html#l00016" > bandwidth_estimator.h:16< / a > < / div > < / div >
< div class = "ttc" id = "aclassshaka_1_1BandwidthEstimator_html_a0df6c40f43a89d3d481392ac0298e37c" > < div class = "ttname" > < a href = "../../da/d2c/classshaka_1_1BandwidthEstimator.html#a0df6c40f43a89d3d481392ac0298e37c" > shaka::BandwidthEstimator::Max< / a > < / div > < div class = "ttdeci" > uint64_t Max() const< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "../../d6/d86/bandwidth__estimator_8cc_source.html#l00059" > bandwidth_estimator.cc:59< / a > < / div > < / div >
< div class = "ttc" id = "aclassshaka_1_1BandwidthEstimator_html_a53c67d33f000489d1ebb31a2bdd766a4" > < div class = "ttname" > < a href = "../../da/d2c/classshaka_1_1BandwidthEstimator.html#a53c67d33f000489d1ebb31a2bdd766a4" > shaka::BandwidthEstimator::AddBlock< / a > < / div > < div class = "ttdeci" > void AddBlock(uint64_t size_in_bytes, double duration)< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "../../d6/d86/bandwidth__estimator_8cc_source.html#l00021" > bandwidth_estimator.cc:21< / a > < / div > < / div >
< div class = "ttc" id = "aclassshaka_1_1BandwidthEstimator_html_a9414560e16c46e7e2da3683a4dfb86cc" > < div class = "ttname" > < a href = "../../da/d2c/classshaka_1_1BandwidthEstimator.html#a9414560e16c46e7e2da3683a4dfb86cc" > shaka::BandwidthEstimator::Estimate< / a > < / div > < div class = "ttdeci" > uint64_t Estimate() const< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "../../d6/d86/bandwidth__estimator_8cc_source.html#l00053" > bandwidth_estimator.cc:53< / 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 >
2015-10-16 00:33:37 +00:00
< / div > <!-- fragment --> < / div > <!-- contents -->
<!-- start footer part -->
< hr class = "footer" / > < address class = "footer" > < small >
2021-06-11 04:44:53 +00:00
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
2015-10-16 00:33:37 +00:00
< / small > < / address >
< / body >
< / html >