83 lines
17 KiB
HTML
83 lines
17 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/util/mpd_writer.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_c41da90e13af52a77978e497cf9cac63.html">util</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">mpd_writer.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="l00007"></a><span class="lineno"> 7</span> <span class="comment">// Class for reading in MediaInfo from files and writing out an MPD.</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#ifndef MPD_UTIL_MPD_WRITER_H_</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#define MPD_UTIL_MPD_WRITER_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 <list></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include "packager/base/macros.h"</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "packager/mpd/base/mpd_notifier.h"</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "packager/mpd/base/mpd_options.h"</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">namespace </span><a class="code" href="../../d8/daf/namespaceshaka.html">shaka</a> {</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="keyword">namespace </span>media {</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">class </span>File;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> } <span class="comment">// namespace media</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">class </span>MediaInfo;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="../../d4/db4/classshaka_1_1MpdNotifierFactory.html"> 32</a></span> <span class="keyword">class </span><a class="code" href="../../d4/db4/classshaka_1_1MpdNotifierFactory.html">MpdNotifierFactory</a> {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <a class="code" href="../../d4/db4/classshaka_1_1MpdNotifierFactory.html">MpdNotifierFactory</a>() {}</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">virtual</span> ~<a class="code" href="../../d4/db4/classshaka_1_1MpdNotifierFactory.html">MpdNotifierFactory</a>() {}</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">virtual</span> std::unique_ptr<MpdNotifier> Create(</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">const</span> <a class="code" href="../../d1/df3/structshaka_1_1MpdOptions.html">MpdOptions</a>& mpd_options) = 0;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</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="comment">// An instance of this class takes a set of MediaInfo files and generates an</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">// MPD when one of WriteMpd* methods are called. This generates an MPD with one</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">// <Period> element and at most three <AdaptationSet> elements, each for video,</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">// audio, and text. Information in MediaInfo will be put into one of the</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">// AdaptationSets by checking the video_info, audio_info, and text_info fields.</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">// Therefore, this cannot handle an instance of MediaInfo with video, audio, and</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">// text combination.</span></div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="../../db/dcd/classshaka_1_1MpdWriter.html"> 48</a></span> <span class="keyword">class </span><a class="code" href="../../db/dcd/classshaka_1_1MpdWriter.html">MpdWriter</a> {</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <a class="code" href="../../db/dcd/classshaka_1_1MpdWriter.html">MpdWriter</a>();</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  ~<a class="code" href="../../db/dcd/classshaka_1_1MpdWriter.html">MpdWriter</a>();</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="comment">// Add |media_info_path| for MPD generation.</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="comment">// The content of |media_info_path| should be a string representation of</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment">// MediaInfo, i.e. the content should be a result of using</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="comment">// google::protobuf::TestFormat::Print*() methods.</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// If necessary, this method can be called after WriteMpd*() methods.</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">bool</span> AddFile(<span class="keyword">const</span> std::string& media_info_path);</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>  <span class="comment">// |base_url| will be used for <BaseURL> element for the MPD. The BaseURL</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="comment">// element will be a direct child element of the <MPD> element.</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">void</span> AddBaseUrl(<span class="keyword">const</span> std::string& base_url);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">// Write the MPD to |file_name|. |file_name| should not be NULL.</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="comment">// This opens the file in write mode, IOW if the</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="comment">// file exists this will over write whatever is in the file.</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="comment">// AddFile() should be called before calling this function to generate an MPD.</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="comment">// On success, the MPD gets written to |file| and returns true, otherwise</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="comment">// returns false.</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// This method can be called multiple times, if necessary.</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordtype">bool</span> <a class="code" href="../../d8/daf/namespaceshaka.html#a7e940cda37fa0dbefef3b3cc9c802ab8">WriteMpdToFile</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* file_name);</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="keyword">private</span>:</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">friend</span> <span class="keyword">class </span>MpdWriterTest;</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="keywordtype">void</span> SetMpdNotifierFactoryForTest(</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  std::unique_ptr<MpdNotifierFactory> factory);</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>  std::list<MediaInfo> media_infos_;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  std::vector<std::string> base_urls_;</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>  std::unique_ptr<MpdNotifierFactory> notifier_factory_;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  DISALLOW_COPY_AND_ASSIGN(<a class="code" href="../../db/dcd/classshaka_1_1MpdWriter.html">MpdWriter</a>);</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> </div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> } <span class="comment">// namespace shaka</span></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> <span class="preprocessor">#endif // MPD_UTIL_MPD_WRITER_H_</span></div><div class="ttc" id="classshaka_1_1MpdWriter_html"><div class="ttname"><a href="../../db/dcd/classshaka_1_1MpdWriter.html">shaka::MpdWriter</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d7/db0/mpd__writer_8h_source.html#l00048">mpd_writer.h:48</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_1MpdNotifierFactory_html"><div class="ttname"><a href="../../d4/db4/classshaka_1_1MpdNotifierFactory.html">shaka::MpdNotifierFactory</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d7/db0/mpd__writer_8h_source.html#l00032">mpd_writer.h:32</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="namespaceshaka_html_a7e940cda37fa0dbefef3b3cc9c802ab8"><div class="ttname"><a href="../../d8/daf/namespaceshaka.html#a7e940cda37fa0dbefef3b3cc9c802ab8">shaka::WriteMpdToFile</a></div><div class="ttdeci">bool WriteMpdToFile(const std::string &output_path, MpdBuilder *mpd_builder)</div><div class="ttdef"><b>Definition:</b> <a href="../../d6/d2e/mpd__notifier__util_8cc_source.html#l00016">mpd_notifier_util.cc:16</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Mon Aug 20 2018 10:46:50 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>
|