shaka-packager/docs/d4/d1a/classshaka_1_1media_1_1VPCo...

264 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.6"/>
<title>DASH Media Packaging SDK: shaka::media::VPCodecConfiguration Class Reference</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 class="current"><a href="../../annotated.html"><span>Classes</span></a></li>
<li><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="../../annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="../../classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="../../hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="../../functions.html"><span>Class&#160;Members</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="../../d8/daf/namespaceshaka.html">shaka</a></li><li class="navelem"><b>media</b></li><li class="navelem"><a class="el" href="../../d4/d1a/classshaka_1_1media_1_1VPCodecConfiguration.html">VPCodecConfiguration</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="../../db/d63/classshaka_1_1media_1_1VPCodecConfiguration-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::media::VPCodecConfiguration Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Class for parsing or writing VP codec configuration data.
<a href="../../d4/d1a/classshaka_1_1media_1_1VPCodecConfiguration.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="../../d5/d73/vp__codec__configuration_8h_source.html">vp_codec_configuration.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ac4a3e90c26b8fe9f040c3d84f80b8e1c"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><b>ColorSpace</b> { <br/>
&#160;&#160;<b>COLOR_SPACE_UNSPECIFIED</b> = 0,
<b>COLOR_SPACE_BT_601</b> = 1,
<b>COLOR_SPACE_BT_709</b> = 2,
<b>COLOR_SPACE_SMPTE_170</b> = 3,
<br/>
&#160;&#160;<b>COLOR_SPACE_SMPTE_240</b> = 4,
<b>COLOR_SPACE_BT_2020_NON_CONSTANT_LUMINANCE</b> = 5,
<b>COLOR_SPACE_BT_2020_CONSTANT_LUMINANCE</b> = 6,
<b>COLOR_SPACE_SRGB</b> = 7
<br/>
}</td></tr>
<tr class="separator:ac4a3e90c26b8fe9f040c3d84f80b8e1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a7de87bdfcf7736f919d247c183af3e"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><b>ChromaSubsampling</b> { <br/>
&#160;&#160;<b>CHROMA_420_VERTICAL</b> = 0,
<b>CHROMA_420_COLLOCATED_WITH_LUMA</b> = 1,
<b>CHROMA_422</b> = 2,
<b>CHROMA_444</b> = 3,
<br/>
&#160;&#160;<b>CHROMA_440</b> = 4
<br/>
}</td></tr>
<tr class="separator:a9a7de87bdfcf7736f919d247c183af3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a728109cc43158f8acb37670ac5de4e03"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a728109cc43158f8acb37670ac5de4e03"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>VPCodecConfiguration</b> (uint8_t profile, uint8_t level, uint8_t bit_depth, uint8_t color_space, uint8_t chroma_subsampling, uint8_t transfer_function, bool video_full_range_flag, const std::vector&lt; uint8_t &gt; &amp;codec_initialization_data)</td></tr>
<tr class="separator:a728109cc43158f8acb37670ac5de4e03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a32db600eb1722347b6a7906648834f34"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d1a/classshaka_1_1media_1_1VPCodecConfiguration.html#a32db600eb1722347b6a7906648834f34">Parse</a> (const std::vector&lt; uint8_t &gt; &amp;data)</td></tr>
<tr class="separator:a32db600eb1722347b6a7906648834f34"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43beb7b6487b1c8b11b0e76e23fcbd97"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d1a/classshaka_1_1media_1_1VPCodecConfiguration.html#a43beb7b6487b1c8b11b0e76e23fcbd97">Write</a> (std::vector&lt; uint8_t &gt; *data) const </td></tr>
<tr class="separator:a43beb7b6487b1c8b11b0e76e23fcbd97"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0076419081b402929de03d352f20c88"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d1a/classshaka_1_1media_1_1VPCodecConfiguration.html#ab0076419081b402929de03d352f20c88">GetCodecString</a> (VideoCodec codec) const </td></tr>
<tr class="separator:ab0076419081b402929de03d352f20c88"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4d1ce8a3f44fa6b700b9339e94ed9cd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae4d1ce8a3f44fa6b700b9339e94ed9cd"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_profile</b> (uint8_t profile)</td></tr>
<tr class="separator:ae4d1ce8a3f44fa6b700b9339e94ed9cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa70a0dedb19a89d2ab2f96d83f39046d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa70a0dedb19a89d2ab2f96d83f39046d"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_level</b> (uint8_t level)</td></tr>
<tr class="separator:aa70a0dedb19a89d2ab2f96d83f39046d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5ab0d7094752277099bf15e4c82d7f0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af5ab0d7094752277099bf15e4c82d7f0"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_bit_depth</b> (uint8_t bit_depth)</td></tr>
<tr class="separator:af5ab0d7094752277099bf15e4c82d7f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8613534d1dd25f74ca119be8d197eb82"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8613534d1dd25f74ca119be8d197eb82"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_color_space</b> (uint8_t color_space)</td></tr>
<tr class="separator:a8613534d1dd25f74ca119be8d197eb82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a128b0e177581c12daa18f22cc3f375d7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a128b0e177581c12daa18f22cc3f375d7"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_chroma_subsampling</b> (uint8_t chroma_subsampling)</td></tr>
<tr class="separator:a128b0e177581c12daa18f22cc3f375d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a186f58022bffc626e704f76fb0791291"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a186f58022bffc626e704f76fb0791291"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_transfer_function</b> (uint8_t transfer_function)</td></tr>
<tr class="separator:a186f58022bffc626e704f76fb0791291"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a431091d5c7cda0f6e7a27a5bd522f6e2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a431091d5c7cda0f6e7a27a5bd522f6e2"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_video_full_range_flag</b> (bool video_full_range_flag)</td></tr>
<tr class="separator:a431091d5c7cda0f6e7a27a5bd522f6e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71771461fafd6eab78130673481fc0a0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a71771461fafd6eab78130673481fc0a0"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>profile</b> () const </td></tr>
<tr class="separator:a71771461fafd6eab78130673481fc0a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeaee34e1a32adac30e8400f2dd3fbf37"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeaee34e1a32adac30e8400f2dd3fbf37"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>level</b> () const </td></tr>
<tr class="separator:aeaee34e1a32adac30e8400f2dd3fbf37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae766ba4a2c65ad783815e570d8aec545"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae766ba4a2c65ad783815e570d8aec545"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>bit_depth</b> () const </td></tr>
<tr class="separator:ae766ba4a2c65ad783815e570d8aec545"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a655c4c9a86385e08ce7601af6d33c340"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a655c4c9a86385e08ce7601af6d33c340"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>color_space</b> () const </td></tr>
<tr class="separator:a655c4c9a86385e08ce7601af6d33c340"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab85e5634e53d771a194b14173ae555d8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab85e5634e53d771a194b14173ae555d8"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>chroma_subsampling</b> () const </td></tr>
<tr class="separator:ab85e5634e53d771a194b14173ae555d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25300f8c8a79bccc3463753e86f9040c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a25300f8c8a79bccc3463753e86f9040c"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>transfer_function</b> () const </td></tr>
<tr class="separator:a25300f8c8a79bccc3463753e86f9040c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad54807a2e126a66e11ce2ba1e5c7b1cb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad54807a2e126a66e11ce2ba1e5c7b1cb"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>video_full_range_flag</b> () const </td></tr>
<tr class="separator:ad54807a2e126a66e11ce2ba1e5c7b1cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class for parsing or writing VP codec configuration data. </p>
<p>Definition at line <a class="el" href="../../d5/d73/vp__codec__configuration_8h_source.html#l00021">21</a> of file <a class="el" href="../../d5/d73/vp__codec__configuration_8h_source.html">vp_codec_configuration.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ab0076419081b402929de03d352f20c88"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string shaka::media::VPCodecConfiguration::GetCodecString </td>
<td>(</td>
<td class="paramtype">VideoCodec&#160;</td>
<td class="paramname"><em>codec</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>The codec string. </dd></dl>
<p>Definition at line <a class="el" href="../../d2/dda/vp__codec__configuration_8cc_source.html#l00099">99</a> of file <a class="el" href="../../d2/dda/vp__codec__configuration_8cc_source.html">vp_codec_configuration.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a32db600eb1722347b6a7906648834f34"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool shaka::media::VPCodecConfiguration::Parse </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; uint8_t &gt; &amp;&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Parses input to extract VP codec configuration data. </p>
<dl class="section return"><dt>Returns</dt><dd>false if there is parsing errors. </dd></dl>
<p>Definition at line <a class="el" href="../../d2/dda/vp__codec__configuration_8cc_source.html#l00065">65</a> of file <a class="el" href="../../d2/dda/vp__codec__configuration_8cc_source.html">vp_codec_configuration.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a43beb7b6487b1c8b11b0e76e23fcbd97"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void shaka::media::VPCodecConfiguration::Write </td>
<td>(</td>
<td class="paramtype">std::vector&lt; uint8_t &gt; *&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>should not be null. Writes VP codec configuration data to buffer. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="../../d2/dda/vp__codec__configuration_8cc_source.html#l00084">84</a> of file <a class="el" href="../../d2/dda/vp__codec__configuration_8cc_source.html">vp_codec_configuration.cc</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>media/filters/<a class="el" href="../../d5/d73/vp__codec__configuration_8h_source.html">vp_codec_configuration.h</a></li>
<li>media/filters/<a class="el" href="../../d2/dda/vp__codec__configuration_8cc_source.html">vp_codec_configuration.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu May 26 2016 00:03:11 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>