shaka-packager/docs/d8/d19/bandwidth__estimator_8h_sou...

83 lines
11 KiB
HTML

<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Shaka Packager SDK: packager/mpd/base/bandwidth_estimator.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 -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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_b885194e7131202a9b4650a8967e838c.html">mpd</a></li><li class="navelem"><a class="el" href="../../dir_6fe4b0529cd3ec97045d3314254a0cce.html">base</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">bandwidth_estimator.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// Copyright 2014 Google Inc. All rights reserved.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<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>&#160;<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>&#160;<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>&#160;</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#ifndef MPD_BASE_BANDWIDTH_ESTIMATOR_H_</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#define MPD_BASE_BANDWIDTH_ESTIMATOR_H_</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &lt;stdint.h&gt;</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="keyword">namespace </span><a class="code" href="../../d8/daf/namespaceshaka.html">shaka</a> {</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div><div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="../../da/d2c/classshaka_1_1BandwidthEstimator.html"> 14</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../da/d2c/classshaka_1_1BandwidthEstimator.html">BandwidthEstimator</a> {</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <span class="keyword">explicit</span> <a class="code" href="../../da/d2c/classshaka_1_1BandwidthEstimator.html">BandwidthEstimator</a>(<span class="keywordtype">double</span> target_segment_duration);</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; ~<a class="code" href="../../da/d2c/classshaka_1_1BandwidthEstimator.html">BandwidthEstimator</a>();</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <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="l00022"></a><span class="lineno"> 22</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; 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="l00028"></a><span class="lineno"> 28</span>&#160;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; 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="l00033"></a><span class="lineno"> 33</span>&#160;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <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>&amp;) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <a class="code" href="../../da/d2c/classshaka_1_1BandwidthEstimator.html">BandwidthEstimator</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="../../da/d2c/classshaka_1_1BandwidthEstimator.html">BandwidthEstimator</a>&amp;) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">const</span> <span class="keywordtype">double</span> target_segment_duration_ = 0;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; uint64_t total_size_in_bits_ = 0;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordtype">double</span> total_duration_ = 0;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; uint64_t max_bitrate_ = 0;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;};</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;} <span class="comment">// namespace shaka</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#endif // MPD_BASE_BANDWIDTH_ESTIMATOR_H_</span></div><div class="ttc" id="namespaceshaka_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="classshaka_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="classshaka_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#l00014">bandwidth_estimator.h:14</a></div></div>
<div class="ttc" id="classshaka_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#l00062">bandwidth_estimator.cc:62</a></div></div>
<div class="ttc" id="classshaka_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#l00068">bandwidth_estimator.cc:68</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Dec 20 2018 14:37:38 for Shaka Packager SDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>