84 lines
18 KiB
HTML
84 lines
18 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> <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 <stddef.h></span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include <stdint.h></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 <deque></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="keyword">namespace </span><a class="code" href="../../d8/daf/namespaceshaka.html">shaka</a> {</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="../../da/d2c/classshaka_1_1BandwidthEstimator.html"> 17</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="l00018"></a><span class="lineno"> 18</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="../../da/d2c/classshaka_1_1BandwidthEstimator.html#a418205a0cbb9f742f7f14730e4d628ed"> 20</a></span>  <span class="keyword">static</span> constexpr <span class="keywordtype">size_t</span> <a class="code" href="../../da/d2c/classshaka_1_1BandwidthEstimator.html#a418205a0cbb9f742f7f14730e4d628ed">kUseAllBlocks</a> = 0;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="keyword">explicit</span> <a class="code" href="../../da/d2c/classshaka_1_1BandwidthEstimator.html">BandwidthEstimator</a>(<span class="keywordtype">size_t</span> num_blocks);</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  ~<a class="code" href="../../da/d2c/classshaka_1_1BandwidthEstimator.html">BandwidthEstimator</a>();</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keywordtype">void</span> <a class="code" href="../../da/d2c/classshaka_1_1BandwidthEstimator.html#a7c73789c7c3f9b70dd2c23e49640fcc6">AddBlock</a>(uint64_t size, <span class="keywordtype">double</span> duration);</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</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="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</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="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">private</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>(<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>  <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="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="comment">// A sliding queue that provide convenient functions to get the minimum value</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="comment">// and the sum when window slides.</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">class </span>SlidingQueue {</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="comment">// |window_size| defines the size of the sliding window. 0 uses all.</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">explicit</span> SlidingQueue(<span class="keywordtype">size_t</span> window_size);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="comment">// Add a new value. Old values may be moved out.</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordtype">void</span> Add(<span class="keywordtype">double</span> value);</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="comment">// Return the sum of the values in the sliding window.</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">double</span> sum()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> sum_; }</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="comment">// Return the number of values in the sliding window.</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">double</span> size()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> size_; }</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="comment">// Return the minimum value of the values in the sliding window.</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">double</span> min()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> min_.front(); }</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>  <span class="keyword">private</span>:</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  SlidingQueue(<span class="keyword">const</span> SlidingQueue&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  SlidingQueue& operator=(<span class="keyword">const</span> SlidingQueue&) = <span class="keyword">delete</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="keyword">const</span> <span class="keywordtype">size_t</span> window_size_;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordtype">size_t</span> size_ = 0;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">double</span> sum_ = 0;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="comment">// Keeps track of the values in the sliding window. Not needed if</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="comment">// |window_size| is kUseAllBlocks.</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  std::deque<double> window_;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="comment">// Keeps track of a monotonic non-decreasing sequence of values, i.e.</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// local minimum values in the sliding window. The front() is always the</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="comment">// global minimum, i.e. the minimum value in the sliding window.</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="comment">// This is achieved through:</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="comment">// (1) New value is added to the back with the original values before it</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="comment">// that are larger removed as they are no longer useful.</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="comment">// (2) When a value is removed from |window_|, if it is the minimum value,</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="comment">// it is also removed from |min_|; if it is not, it means the value is not</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="comment">// present in |min_|.</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  std::deque<double> min_;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  };</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  SlidingQueue sliding_queue_;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> };</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> } <span class="comment">// namespace shaka</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="preprocessor">#endif // MPD_BASE_BANDWIDTH_ESTIMATOR_H_</span></div><div class="ttc" id="classshaka_1_1BandwidthEstimator_html_a418205a0cbb9f742f7f14730e4d628ed"><div class="ttname"><a href="../../da/d2c/classshaka_1_1BandwidthEstimator.html#a418205a0cbb9f742f7f14730e4d628ed">shaka::BandwidthEstimator::kUseAllBlocks</a></div><div class="ttdeci">static constexpr size_t kUseAllBlocks</div><div class="ttdef"><b>Definition:</b> <a href="../../d8/d19/bandwidth__estimator_8h_source.html#l00020">bandwidth_estimator.h:20</a></div></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_a7c73789c7c3f9b70dd2c23e49640fcc6"><div class="ttname"><a href="../../da/d2c/classshaka_1_1BandwidthEstimator.html#a7c73789c7c3f9b70dd2c23e49640fcc6">shaka::BandwidthEstimator::AddBlock</a></div><div class="ttdeci">void AddBlock(uint64_t size, double duration)</div><div class="ttdef"><b>Definition:</b> <a href="../../d6/d86/bandwidth__estimator_8cc_source.html#l00019">bandwidth_estimator.cc:19</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#l00017">bandwidth_estimator.h:17</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#l00028">bandwidth_estimator.cc:28</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#l00035">bandwidth_estimator.cc:35</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Wed May 23 2018 16:10:49 for Shaka Packager SDK by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|