shaka-packager/docs/d7/d87/video__stream__info_8h_sour...

83 lines
22 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/media/base/video_stream_info.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_f99dae54fe7170f791f339b952d5067a.html">media</a></li><li class="navelem"><a class="el" href="../../dir_e3bda0bde998a4d5063328245b9909be.html">base</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">video_stream_info.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 PACKAGER_MEDIA_BASE_VIDEO_STREAM_INFO_H_</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#define PACKAGER_MEDIA_BASE_VIDEO_STREAM_INFO_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 &quot;packager/media/base/stream_info.h&quot;</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;<span class="keyword">namespace </span>media {</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="keyword">enum class</span> H26xStreamFormat {</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; kUnSpecified,</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; kAnnexbByteStream,</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; kNalUnitStreamWithParameterSetNalus,</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; kNalUnitStreamWithoutParameterSetNalus,</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;};</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html"> 23</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html">VideoStreamInfo</a> : <span class="keyword">public</span> <a class="code" href="../../d5/db1/classshaka_1_1media_1_1StreamInfo.html">StreamInfo</a> {</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <a class="code" href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html">VideoStreamInfo</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <a class="code" href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html">VideoStreamInfo</a>(<span class="keywordtype">int</span> track_id,</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; uint32_t time_scale,</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; uint64_t duration,</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; Codec codec,</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; H26xStreamFormat h26x_stream_format,</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keyword">const</span> std::string&amp; codec_string,</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">const</span> uint8_t* codec_config,</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordtype">size_t</span> codec_config_size,</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; uint16_t width,</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; uint16_t height,</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; uint32_t pixel_width,</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; uint32_t pixel_height,</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; uint32_t trick_play_factor,</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; uint8_t nalu_length_size,</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keyword">const</span> std::string&amp; language,</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordtype">bool</span> is_encrypted);</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; ~<a class="code" href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html">VideoStreamInfo</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordtype">bool</span> IsValidConfig() <span class="keyword">const override</span>;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; std::string ToString() <span class="keyword">const override</span>;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; std::unique_ptr&lt;StreamInfo&gt; Clone() <span class="keyword">const override</span>;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; H26xStreamFormat h26x_stream_format()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> h26x_stream_format_; }</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; uint16_t width()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> width_; }</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; uint16_t height()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> height_; }</div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html#ac0356f4786e3cc2699c13a253c5f3cb5"> 61</a></span>&#160; uint32_t <a class="code" href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html#ac0356f4786e3cc2699c13a253c5f3cb5">pixel_width</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> pixel_width_; }</div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html#a40b2e26c533904ff890f4ea8086d7f71"> 64</a></span>&#160; uint32_t <a class="code" href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html#a40b2e26c533904ff890f4ea8086d7f71">pixel_height</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> pixel_height_; }</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; uint8_t nalu_length_size()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> nalu_length_size_; }</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; uint32_t trick_play_factor()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> trick_play_factor_; }</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; uint32_t playback_rate()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> playback_rate_; }</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keyword">const</span> std::vector&lt;uint8_t&gt;&amp; eme_init_data()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> eme_init_data_; }</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keywordtype">void</span> set_width(uint32_t width) { width_ = width; }</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keywordtype">void</span> set_height(uint32_t height) { height_ = height; }</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keywordtype">void</span> set_pixel_width(uint32_t pixel_width) { pixel_width_ = pixel_width; }</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keywordtype">void</span> set_pixel_height(uint32_t pixel_height) { pixel_height_ = pixel_height; }</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordtype">void</span> set_trick_play_factor(uint32_t trick_play_factor) {</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; trick_play_factor_ = trick_play_factor;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; }</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keywordtype">void</span> set_playback_rate(uint32_t playback_rate) {</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; playback_rate_ = playback_rate;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; }</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keywordtype">void</span> set_eme_init_data(<span class="keyword">const</span> uint8_t* eme_init_data,</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keywordtype">size_t</span> eme_init_data_size) {</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; eme_init_data_.assign(eme_init_data, eme_init_data + eme_init_data_size);</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; }</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; H26xStreamFormat h26x_stream_format_;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; uint16_t width_;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; uint16_t height_;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="comment">// pixel_width_:pixel_height_ is the sample aspect ratio.</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="comment">// 0 means unknown.</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; uint32_t pixel_width_;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; uint32_t pixel_height_;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; uint32_t trick_play_factor_ = 0; <span class="comment">// Non-zero for trick-play streams.</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="comment">// Playback rate is the attribute for trick play stream, which signals the</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="comment">// playout capabilities</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <span class="comment">// (http://dashif.org/wp-content/uploads/2016/12/DASH-IF-IOP-v4.0-clean.pdf,</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="comment">// page 18, line 1). It is the ratio of main frame rate to the trick play</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="comment">// frame rate. If the time scale and frame duration are not modified after</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="comment">// trick play handler processing, the playback_rate equals to the number of</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="comment">// frames between consecutive key frames selected for trick play stream. For</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="comment">// example, if the video stream has GOP size of 10 and the trick play factor</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <span class="comment">// is 3, the key frames are in this trick play stream are [frame_0, frame_30,</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="comment">// frame_60, ...]. Then the playback_rate is 30.</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <span class="comment">// Non-zero for trick-play streams.</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; uint32_t playback_rate_ = 0;</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="comment">// Specifies the size of the NAL unit length field. Can be 1, 2 or 4 bytes, or</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <span class="comment">// 0 if the stream is not a NAL structured video stream or if it is an AnnexB</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <span class="comment">// byte stream.</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; uint8_t nalu_length_size_;</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; <span class="comment">// Container-specific data used by CDM to generate a license request:</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <span class="comment">// https://w3c.github.io/encrypted-media/#initialization-data.</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; std::vector&lt;uint8_t&gt; eme_init_data_;</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <span class="comment">// Not using DISALLOW_COPY_AND_ASSIGN here intentionally to allow the compiler</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <span class="comment">// generated copy constructor and assignment operator. Since the extra data is</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <span class="comment">// typically small, the performance impact is minimal.</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;};</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;} <span class="comment">// namespace media</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160;} <span class="comment">// namespace shaka</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;<span class="preprocessor">#endif // PACKAGER_MEDIA_BASE_VIDEO_STREAM_INFO_H_</span></div><div class="ttc" id="classshaka_1_1media_1_1StreamInfo_html"><div class="ttname"><a href="../../d5/db1/classshaka_1_1media_1_1StreamInfo.html">shaka::media::StreamInfo</a></div><div class="ttdoc">Abstract class holds stream information. </div><div class="ttdef"><b>Definition:</b> <a href="../../d8/daa/stream__info_8h_source.html#l00059">stream_info.h:59</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_1media_1_1VideoStreamInfo_html_a40b2e26c533904ff890f4ea8086d7f71"><div class="ttname"><a href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html#a40b2e26c533904ff890f4ea8086d7f71">shaka::media::VideoStreamInfo::pixel_height</a></div><div class="ttdeci">uint32_t pixel_height() const</div><div class="ttdef"><b>Definition:</b> <a href="../../d7/d87/video__stream__info_8h_source.html#l00064">video_stream_info.h:64</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1VideoStreamInfo_html_ac0356f4786e3cc2699c13a253c5f3cb5"><div class="ttname"><a href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html#ac0356f4786e3cc2699c13a253c5f3cb5">shaka::media::VideoStreamInfo::pixel_width</a></div><div class="ttdeci">uint32_t pixel_width() const</div><div class="ttdef"><b>Definition:</b> <a href="../../d7/d87/video__stream__info_8h_source.html#l00061">video_stream_info.h:61</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1VideoStreamInfo_html"><div class="ttname"><a href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html">shaka::media::VideoStreamInfo</a></div><div class="ttdoc">Holds video stream information. </div><div class="ttdef"><b>Definition:</b> <a href="../../d7/d87/video__stream__info_8h_source.html#l00023">video_stream_info.h:23</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jun 7 2018 16:03:49 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>