84 lines
21 KiB
HTML
84 lines
21 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/mpd_builder.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">mpd_builder.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> <span class="comment">//</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"></span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#ifndef MPD_BASE_MPD_BUILDER_H_</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#define MPD_BASE_MPD_BUILDER_H_</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="preprocessor">#include <libxml/tree.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="preprocessor">#include <list></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "packager/base/time/clock.h"</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "packager/mpd/base/mpd_options.h"</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// TODO(rkuroiwa): For classes with |id_|, consider removing the field and let</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">// the MPD (XML) generation functions take care of assigning an ID to each</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">// element.</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">namespace </span><a class="code" href="../../d8/daf/namespaceshaka.html">shaka</a> {</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">class </span>AdaptationSet;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">class </span>MediaInfo;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">class </span>Period;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">namespace </span>xml {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span>XmlNode;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> } <span class="comment">// namespace xml</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="../../dc/da1/classshaka_1_1MpdBuilder.html"> 37</a></span> <span class="keyword">class </span><a class="code" href="../../dc/da1/classshaka_1_1MpdBuilder.html">MpdBuilder</a> {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">explicit</span> <a class="code" href="../../dc/da1/classshaka_1_1MpdBuilder.html">MpdBuilder</a>(<span class="keyword">const</span> <a class="code" href="../../d1/df3/structshaka_1_1MpdOptions.html">MpdOptions</a>& mpd_options);</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">virtual</span> ~<a class="code" href="../../dc/da1/classshaka_1_1MpdBuilder.html">MpdBuilder</a>();</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordtype">void</span> AddBaseUrl(<span class="keyword">const</span> std::string& base_url);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">virtual</span> <a class="code" href="../../d8/de1/classshaka_1_1Period.html">Period</a>* GetOrCreatePeriod(<span class="keywordtype">double</span> start_time_in_seconds);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="comment">// TODO(kqyang): Handle file IO in this class as in HLS media_playlist?</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> ToString(std::string* output);</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> MakePathsRelativeToMpd(<span class="keyword">const</span> std::string& mpd_path,</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  MediaInfo* media_info);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// Inject a |clock| that returns the current time.</span></div><div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="../../dc/da1/classshaka_1_1MpdBuilder.html#a7a4f96f12b589cfc4b5c2f44532eec53"> 72</a></span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="../../dc/da1/classshaka_1_1MpdBuilder.html#a7a4f96f12b589cfc4b5c2f44532eec53">InjectClockForTesting</a>(std::unique_ptr<base::Clock> clock) {</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  clock_ = std::move(clock);</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  }</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>  <span class="keyword">private</span>:</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <a class="code" href="../../dc/da1/classshaka_1_1MpdBuilder.html">MpdBuilder</a>(<span class="keyword">const</span> <a class="code" href="../../dc/da1/classshaka_1_1MpdBuilder.html">MpdBuilder</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <a class="code" href="../../dc/da1/classshaka_1_1MpdBuilder.html">MpdBuilder</a>& operator=(<span class="keyword">const</span> <a class="code" href="../../dc/da1/classshaka_1_1MpdBuilder.html">MpdBuilder</a>&) = <span class="keyword">delete</span>;</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>  <span class="comment">// LiveMpdBuilderTest needs to set availabilityStartTime so that the test</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="comment">// doesn't need to depend on current time.</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">friend</span> <span class="keyword">class </span>LiveMpdBuilderTest;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keyword">template</span> <DashProfile profile></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keyword">friend</span> <span class="keyword">class </span>MpdBuilderTest;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="comment">// Returns the document pointer to the MPD. This must be freed by the caller</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="comment">// using appropriate xmlDocPtr freeing function.</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="comment">// On failure, this returns NULL.</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  xmlDocPtr GenerateMpd();</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">// Set MPD attributes common to all profiles. Uses non-zero |mpd_options_| to</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="comment">// set attributes for the MPD.</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordtype">void</span> AddCommonMpdInfo(<a class="code" href="../../d1/d31/classshaka_1_1xml_1_1XmlNode.html">xml::XmlNode</a>* mpd_node);</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="comment">// Adds 'static' MPD attributes and elements to |mpd_node|. This assumes that</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="comment">// the first child element is a Period element.</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordtype">void</span> AddStaticMpdInfo(<a class="code" href="../../d1/d31/classshaka_1_1xml_1_1XmlNode.html">xml::XmlNode</a>* mpd_node);</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="comment">// Same as AddStaticMpdInfo() but for 'dynamic' MPDs.</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keywordtype">void</span> AddDynamicMpdInfo(<a class="code" href="../../d1/d31/classshaka_1_1xml_1_1XmlNode.html">xml::XmlNode</a>* mpd_node);</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">// Add UTCTiming element if utc timing is provided.</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordtype">void</span> AddUtcTiming(<a class="code" href="../../d1/d31/classshaka_1_1xml_1_1XmlNode.html">xml::XmlNode</a>* mpd_node);</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="keywordtype">float</span> GetStaticMpdDuration();</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="comment">// Set MPD attributes for dynamic profile MPD. Uses non-zero |mpd_options_| as</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="comment">// well as various calculations to set attributes for the MPD.</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keywordtype">void</span> SetDynamicMpdAttributes(<a class="code" href="../../d1/d31/classshaka_1_1xml_1_1XmlNode.html">xml::XmlNode</a>* mpd_node);</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="comment">// Gets the earliest, normalized segment timestamp. Returns true if</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="comment">// successful, false otherwise.</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keywordtype">bool</span> GetEarliestTimestamp(<span class="keywordtype">double</span>* timestamp_seconds);</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>  <span class="comment">// Update Period durations and presentation timestamps.</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keywordtype">void</span> UpdatePeriodDurationAndPresentationTimestamp();</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <a class="code" href="../../d1/df3/structshaka_1_1MpdOptions.html">MpdOptions</a> mpd_options_;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  std::list<std::unique_ptr<Period>> periods_;</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  std::list<std::string> base_urls_;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  std::string availability_start_time_;</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  uint32_t period_counter_ = 0;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  uint32_t representation_counter_ = 0;</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> </div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="comment">// By default, this returns the current time. This can be injected for</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="comment">// testing.</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  std::unique_ptr<base::Clock> clock_;</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> };</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> } <span class="comment">// namespace shaka</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="preprocessor">#endif // MPD_BASE_MPD_BUILDER_H_</span></div><div class="ttc" id="classshaka_1_1MpdBuilder_html"><div class="ttname"><a href="../../dc/da1/classshaka_1_1MpdBuilder.html">shaka::MpdBuilder</a></div><div class="ttdoc">This class generates DASH MPDs (Media Presentation Descriptions). </div><div class="ttdef"><b>Definition:</b> <a href="../../d6/da3/mpd__builder_8h_source.html#l00037">mpd_builder.h:37</a></div></div>
|
|
<div class="ttc" id="classshaka_1_1xml_1_1XmlNode_html"><div class="ttname"><a href="../../d1/d31/classshaka_1_1xml_1_1XmlNode.html">shaka::xml::XmlNode</a></div><div class="ttdef"><b>Definition:</b> <a href="../../dd/de7/xml__node_8h_source.html#l00032">xml_node.h:32</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="structshaka_1_1MpdOptions_html"><div class="ttname"><a href="../../d1/df3/structshaka_1_1MpdOptions.html">shaka::MpdOptions</a></div><div class="ttdoc">Defines Mpd Options. </div><div class="ttdef"><b>Definition:</b> <a href="../../db/d60/mpd__options_8h_source.html#l00025">mpd_options.h:25</a></div></div>
|
|
<div class="ttc" id="classshaka_1_1MpdBuilder_html_a7a4f96f12b589cfc4b5c2f44532eec53"><div class="ttname"><a href="../../dc/da1/classshaka_1_1MpdBuilder.html#a7a4f96f12b589cfc4b5c2f44532eec53">shaka::MpdBuilder::InjectClockForTesting</a></div><div class="ttdeci">void InjectClockForTesting(std::unique_ptr< base::Clock > clock)</div><div class="ttdoc">This is for testing. </div><div class="ttdef"><b>Definition:</b> <a href="../../d6/da3/mpd__builder_8h_source.html#l00072">mpd_builder.h:72</a></div></div>
|
|
<div class="ttc" id="classshaka_1_1Period_html"><div class="ttname"><a href="../../d8/de1/classshaka_1_1Period.html">shaka::Period</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d7/d20/period_8h_source.html#l00030">period.h:30</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Wed Aug 15 2018 17:34:14 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>
|