shaka-packager/docs/d6/dff/classshaka_1_1media_1_1Nalu...

234 lines
14 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: shaka::media::Nalu 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/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="../../d8/daf/namespaceshaka.html">shaka</a></li><li class="navelem"><b>media</b></li><li class="navelem"><a class="el" href="../../d6/dff/classshaka_1_1media_1_1Nalu.html">Nalu</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="../../d4/d58/classshaka_1_1media_1_1Nalu-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::media::Nalu Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="../../d4/d87/nalu__reader_8h_source.html">nalu_reader.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:a555313353e2e23743ad7a70a3e65574a"><td class="memItemLeft" align="right" valign="top"><a id="a555313353e2e23743ad7a70a3e65574a"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>H264NaluType</b> { <br />
&#160;&#160;<b>H264_Unspecified</b> = 0,
<b>H264_NonIDRSlice</b> = 1,
<b>H264_IDRSlice</b> = 5,
<b>H264_SEIMessage</b> = 6,
<br />
&#160;&#160;<b>H264_SPS</b> = 7,
<b>H264_PPS</b> = 8,
<b>H264_AUD</b> = 9,
<b>H264_EOSeq</b> = 10,
<br />
&#160;&#160;<b>H264_FillerData</b> = 12,
<b>H264_SPSExtension</b> = 13,
<b>H264_PrefixNALUnit</b> = 14,
<b>H264_SubsetSPS</b> = 15,
<br />
&#160;&#160;<b>H264_DepthParameterSet</b> = 16,
<b>H264_Reserved17</b> = 17,
<b>H264_Reserved18</b> = 18,
<b>H264_CodedSliceExtension</b> = 20,
<br />
&#160;&#160;<b>H264_Reserved22</b> = 22
<br />
}</td></tr>
<tr class="separator:a555313353e2e23743ad7a70a3e65574a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58c5204869bb765b965162a152ce071e"><td class="memItemLeft" align="right" valign="top"><a id="a58c5204869bb765b965162a152ce071e"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>H265NaluType</b> { <br />
&#160;&#160;<b>H265_TRAIL_N</b> = 0,
<b>H265_TRAIL_R</b> = 1,
<b>H265_TSA_N</b> = 2,
<b>H265_TSA_R</b> = 3,
<br />
&#160;&#160;<b>H265_STSA_N</b> = 4,
<b>H265_STSA_R</b> = 5,
<b>H265_RASL_R</b> = 9,
<b>H265_RSV_VCL_N10</b> = 10,
<br />
&#160;&#160;<b>H265_RSV_VCL_R15</b> = 15,
<b>H265_BLA_W_LP</b> = 16,
<b>H265_IDR_W_RADL</b> = 19,
<b>H265_IDR_N_LP</b> = 20,
<br />
&#160;&#160;<b>H265_CRA_NUT</b> = 21,
<b>H265_RSV_IRAP_VCL22</b> = 22,
<b>H265_RSV_IRAP_VCL23</b> = 23,
<b>H265_RSV_VCL31</b> = 31,
<br />
&#160;&#160;<b>H265_VPS</b> = 32,
<b>H265_SPS</b> = 33,
<b>H265_PPS</b> = 34,
<b>H265_AUD</b> = 35,
<br />
&#160;&#160;<b>H265_EOS</b> = 36,
<b>H265_EOB</b> = 37,
<b>H265_FD</b> = 38,
<b>H265_PREFIX_SEI</b> = 39,
<br />
&#160;&#160;<b>H265_RSV_NVCL41</b> = 41,
<b>H265_RSV_NVCL44</b> = 44,
<b>H265_UNSPEC48</b> = 48,
<b>H265_UNSPEC55</b> = 55
<br />
}</td></tr>
<tr class="separator:a58c5204869bb765b965162a152ce071e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4e0927dbdd7c4700e56b4d1a91ce61d"><td class="memItemLeft" align="right" valign="top"><a id="ad4e0927dbdd7c4700e56b4d1a91ce61d"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>CodecType</b> { <b>kH264</b>,
<b>kH265</b>
}</td></tr>
<tr class="separator:ad4e0927dbdd7c4700e56b4d1a91ce61d"><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:aad17891432eafa58e6afd9b5d93fbdd4"><td class="memItemLeft" align="right" valign="top"><a id="aad17891432eafa58e6afd9b5d93fbdd4"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>Initialize</b> (CodecType <a class="el" href="../../d6/dff/classshaka_1_1media_1_1Nalu.html#a7a3b4358f56619fc63fe74525f4eb92b">type</a>, const uint8_t *<a class="el" href="../../d6/dff/classshaka_1_1media_1_1Nalu.html#a52dc6f445a09c36a64c634ccc2891489">data</a>, uint64_t size) WARN_UNUSED_RESULT</td></tr>
<tr class="separator:aad17891432eafa58e6afd9b5d93fbdd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52dc6f445a09c36a64c634ccc2891489"><td class="memItemLeft" align="right" valign="top"><a id="a52dc6f445a09c36a64c634ccc2891489"></a>
const uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/dff/classshaka_1_1media_1_1Nalu.html#a52dc6f445a09c36a64c634ccc2891489">data</a> () const</td></tr>
<tr class="memdesc:a52dc6f445a09c36a64c634ccc2891489"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is the pointer to the <a class="el" href="../../d6/dff/classshaka_1_1media_1_1Nalu.html">Nalu</a> data, pointing to the header. <br /></td></tr>
<tr class="separator:a52dc6f445a09c36a64c634ccc2891489"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a835d8f01a8ab94887ee3dce3b5d3721e"><td class="memItemLeft" align="right" valign="top"><a id="a835d8f01a8ab94887ee3dce3b5d3721e"></a>
uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/dff/classshaka_1_1media_1_1Nalu.html#a835d8f01a8ab94887ee3dce3b5d3721e">header_size</a> () const</td></tr>
<tr class="memdesc:a835d8f01a8ab94887ee3dce3b5d3721e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The size of the header, e.g. 1 for H.264. <br /></td></tr>
<tr class="separator:a835d8f01a8ab94887ee3dce3b5d3721e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe782e4298e7add8ce0a1c33e66cfcdb"><td class="memItemLeft" align="right" valign="top"><a id="abe782e4298e7add8ce0a1c33e66cfcdb"></a>
uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/dff/classshaka_1_1media_1_1Nalu.html#abe782e4298e7add8ce0a1c33e66cfcdb">payload_size</a> () const</td></tr>
<tr class="memdesc:abe782e4298e7add8ce0a1c33e66cfcdb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of this <a class="el" href="../../d6/dff/classshaka_1_1media_1_1Nalu.html">Nalu</a> minus <a class="el" href="../../d6/dff/classshaka_1_1media_1_1Nalu.html#a835d8f01a8ab94887ee3dce3b5d3721e" title="The size of the header, e.g. 1 for H.264. ">header_size()</a>. <br /></td></tr>
<tr class="separator:abe782e4298e7add8ce0a1c33e66cfcdb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb42221584298b18d8a2504fab46f9b5"><td class="memItemLeft" align="right" valign="top"><a id="adb42221584298b18d8a2504fab46f9b5"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>ref_idc</b> () const</td></tr>
<tr class="separator:adb42221584298b18d8a2504fab46f9b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f1fdb799c239855587b08895df497e4"><td class="memItemLeft" align="right" valign="top"><a id="a3f1fdb799c239855587b08895df497e4"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>nuh_layer_id</b> () const</td></tr>
<tr class="separator:a3f1fdb799c239855587b08895df497e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad49cdbddc7ccf9b6dfd7f78ce6262d84"><td class="memItemLeft" align="right" valign="top"><a id="ad49cdbddc7ccf9b6dfd7f78ce6262d84"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>nuh_temporal_id</b> () const</td></tr>
<tr class="separator:ad49cdbddc7ccf9b6dfd7f78ce6262d84"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a3b4358f56619fc63fe74525f4eb92b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/dff/classshaka_1_1media_1_1Nalu.html#a7a3b4358f56619fc63fe74525f4eb92b">type</a> () const</td></tr>
<tr class="separator:a7a3b4358f56619fc63fe74525f4eb92b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6690e18638365057d92e159bad398593"><td class="memItemLeft" align="right" valign="top"><a id="a6690e18638365057d92e159bad398593"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>is_aud</b> () const</td></tr>
<tr class="separator:a6690e18638365057d92e159bad398593"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad922d5f6740740acbec8fe1d290461ba"><td class="memItemLeft" align="right" valign="top"><a id="ad922d5f6740740acbec8fe1d290461ba"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>is_vcl</b> () const</td></tr>
<tr class="separator:ad922d5f6740740acbec8fe1d290461ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63f091b3dbe862fd4519c1b374dfc937"><td class="memItemLeft" align="right" valign="top"><a id="a63f091b3dbe862fd4519c1b374dfc937"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/dff/classshaka_1_1media_1_1Nalu.html#a63f091b3dbe862fd4519c1b374dfc937">is_video_slice</a> () const</td></tr>
<tr class="memdesc:a63f091b3dbe862fd4519c1b374dfc937"><td class="mdescLeft">&#160;</td><td class="mdescRight">Slice data partition NALs are not considered as slice NALs. <br /></td></tr>
<tr class="separator:a63f091b3dbe862fd4519c1b374dfc937"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9dfd0614489c99f93807387f359cc004"><td class="memItemLeft" align="right" valign="top"><a id="a9dfd0614489c99f93807387f359cc004"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>can_start_access_unit</b> () const</td></tr>
<tr class="separator:a9dfd0614489c99f93807387f359cc004"><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>For explanations of each struct and its members, see H.264 specification at <a href="http://www.itu.int/rec/T-REC-H.264">http://www.itu.int/rec/T-REC-H.264</a>. </p>
<p class="definition">Definition at line <a class="el" href="../../d4/d87/nalu__reader_8h_source.html#l00027">27</a> of file <a class="el" href="../../d4/d87/nalu__reader_8h_source.html">nalu_reader.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a7a3b4358f56619fc63fe74525f4eb92b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a3b4358f56619fc63fe74525f4eb92b">&#9670;&nbsp;</a></span>type()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int shaka::media::Nalu::type </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>H264NaluType and H265NaluType enums may be used to compare against the return value. </p>
<p class="definition">Definition at line <a class="el" href="../../d4/d87/nalu__reader_8h_source.html#l00113">113</a> of file <a class="el" href="../../d4/d87/nalu__reader_8h_source.html">nalu_reader.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>packager/media/codecs/<a class="el" href="../../d4/d87/nalu__reader_8h_source.html">nalu_reader.h</a></li>
<li>packager/media/codecs/<a class="el" href="../../d1/df5/nalu__reader_8cc_source.html">nalu_reader.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jun 7 2018 16:04:01 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>