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

180 lines
21 KiB
HTML
Raw Normal View History

<!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.6"/>
<title>DASH Media Packaging SDK: 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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">DASH Media Packaging SDK
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="../../index.html"><span>Main&#160;Page</span></a></li>
<li><a href="../../namespaces.html"><span>Namespaces</span></a></li>
<li><a href="../../annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="../../files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="../../search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="../../search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="../../files.html"><span>File&#160;List</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a></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_39dc0668bd5a501998f94e8b4e546c71.html">media</a></li><li class="navelem"><a class="el" href="../../dir_c6ada2450b25ab5438a4dba6c9b890af.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 MEDIA_BASE_VIDEO_STREAM_INFO_H_</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define MEDIA_BASE_VIDEO_STREAM_INFO_H_</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor"></span></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>shaka {</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="l00016"></a><span class="lineno"><a class="line" href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html"> 16</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="l00017"></a><span class="lineno"> 17</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <a class="code" href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html#a3de6a7d65ddd877c513f3047a86db59e">VideoStreamInfo</a>(<span class="keywordtype">int</span> track_id, uint32_t time_scale, uint64_t duration,</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; Codec codec, <span class="keyword">const</span> std::string&amp; codec_string,</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keyword">const</span> uint8_t* codec_config, <span class="keywordtype">size_t</span> codec_config_size,</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; uint16_t width, uint16_t height, uint32_t <a class="code" href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html#af5f655f36865a3af28bd0c7328e9a91e">pixel_width</a>,</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; uint32_t <a class="code" href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html#ae420a97a606ef54be16beb49e42cd135">pixel_height</a>, int16_t trick_play_rate,</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; uint8_t nalu_length_size, <span class="keyword">const</span> std::string&amp; language,</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordtype">bool</span> is_encrypted);</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html#a8978ca2bc2dd63c2e25e77cdcf676162">IsValidConfig</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; std::string <a class="code" href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html#a9cac8e75d76f1192a48d1dcf61435537">ToString</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; uint16_t width()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> width_; }</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; uint16_t height()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> height_; }</div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html#af5f655f36865a3af28bd0c7328e9a91e"> 39</a></span>&#160; uint32_t <a class="code" href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html#af5f655f36865a3af28bd0c7328e9a91e">pixel_width</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> pixel_width_; }</div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html#ae420a97a606ef54be16beb49e42cd135"> 42</a></span>&#160; uint32_t <a class="code" href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html#ae420a97a606ef54be16beb49e42cd135">pixel_height</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> pixel_height_; }</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</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="l00044"></a><span class="lineno"> 44</span>&#160; int16_t trick_play_rate()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> trick_play_rate_; }</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</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="l00046"></a><span class="lineno"> 46</span>&#160;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordtype">void</span> set_width(uint32_t width) { width_ = width; }</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordtype">void</span> set_height(uint32_t height) { height_ = height; }</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordtype">void</span> set_pixel_width(uint32_t pixel_width) { pixel_width_ = <a class="code" href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html#af5f655f36865a3af28bd0c7328e9a91e">pixel_width</a>; }</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordtype">void</span> set_pixel_height(uint32_t pixel_height) { pixel_height_ = <a class="code" href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html#ae420a97a606ef54be16beb49e42cd135">pixel_height</a>; }</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</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="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordtype">size_t</span> eme_init_data_size) {</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; eme_init_data_.assign(eme_init_data, eme_init_data + eme_init_data_size);</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; }</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; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; ~<a class="code" href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html#a3de6a7d65ddd877c513f3047a86db59e">VideoStreamInfo</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; uint16_t width_;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; uint16_t height_;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="comment">// pixel_width_:pixel_height_ is the sample aspect ratio.</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="comment">// 0 means unknown.</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; uint32_t pixel_width_;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; uint32_t pixel_height_;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; int16_t trick_play_rate_; <span class="comment">// Non-zero for trick-play streams.</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="comment">// Specifies the normalized size of the NAL unit length field. Can be 1, 2 or</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="comment">// 4 bytes, or 0 if the size if unknown or the stream is not a AVC stream</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="comment">// (H.264).</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; uint8_t nalu_length_size_;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="comment">// Container-specific data used by CDM to generate a license request:</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="comment">// https://w3c.github.io/encrypted-media/#initialization-data.</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; std::vector&lt;uint8_t&gt; eme_init_data_;</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="comment">// Not using DISALLOW_COPY_AND_ASSIGN here intentionally to allow the compiler</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="comment">// generated copy constructor and assignment operator. Since the extra data is</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="comment">// typically small, the performance impact is minimal.</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;};</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;} <span class="comment">// namespace media</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;} <span class="comment">// namespace shaka</span></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="preprocessor">#endif // 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#l00053">stream_info.h:53</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1VideoStreamInfo_html_a8978ca2bc2dd63c2e25e77cdcf676162"><div class="ttname"><a href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html#a8978ca2bc2dd63c2e25e77cdcf676162">shaka::media::VideoStreamInfo::IsValidConfig</a></div><div class="ttdeci">bool IsValidConfig() const override</div><div class="ttdef"><b>Definition:</b> <a href="../../dd/d19/video__stream__info_8cc_source.html#l00067">video_stream_info.cc:67</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1VideoStreamInfo_html_ae420a97a606ef54be16beb49e42cd135"><div class="ttname"><a href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html#ae420a97a606ef54be16beb49e42cd135">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#l00042">video_stream_info.h:42</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1VideoStreamInfo_html_af5f655f36865a3af28bd0c7328e9a91e"><div class="ttname"><a href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html#af5f655f36865a3af28bd0c7328e9a91e">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#l00039">video_stream_info.h:39</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#l00016">video_stream_info.h:16</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1VideoStreamInfo_html_a9cac8e75d76f1192a48d1dcf61435537"><div class="ttname"><a href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html#a9cac8e75d76f1192a48d1dcf61435537">shaka::media::VideoStreamInfo::ToString</a></div><div class="ttdeci">std::string ToString() const override</div><div class="ttdef"><b>Definition:</b> <a href="../../dd/d19/video__stream__info_8cc_source.html#l00074">video_stream_info.cc:74</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1VideoStreamInfo_html_a3de6a7d65ddd877c513f3047a86db59e"><div class="ttname"><a href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html#a3de6a7d65ddd877c513f3047a86db59e">shaka::media::VideoStreamInfo::VideoStreamInfo</a></div><div class="ttdeci">VideoStreamInfo(int track_id, uint32_t time_scale, uint64_t duration, Codec codec, const std::string &amp;codec_string, const uint8_t *codec_config, size_t codec_config_size, uint16_t width, uint16_t height, uint32_t pixel_width, uint32_t pixel_height, int16_t trick_play_rate, uint8_t nalu_length_size, const std::string &amp;language, bool is_encrypted)</div><div class="ttdef"><b>Definition:</b> <a href="../../dd/d19/video__stream__info_8cc_source.html#l00049">video_stream_info.cc:49</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Dec 19 2016 19:13:52 for DASH Media Packaging SDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>