shaka-packager/docs/d5/d66/classshaka_1_1media_1_1NalU...

289 lines
15 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Shaka Packager SDK: shaka::media::NalUnitToByteStreamConverter 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.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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="../../d5/d66/classshaka_1_1media_1_1NalUnitToByteStreamConverter.html">NalUnitToByteStreamConverter</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="../../d1/da2/classshaka_1_1media_1_1NalUnitToByteStreamConverter-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::media::NalUnitToByteStreamConverter Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<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:a27986db8a2e62669fe1983a39383c546"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d66/classshaka_1_1media_1_1NalUnitToByteStreamConverter.html#a27986db8a2e62669fe1983a39383c546">Initialize</a> (const uint8_t *decoder_configuration_data, size_t decoder_configuration_data_size)</td></tr>
<tr class="separator:a27986db8a2e62669fe1983a39383c546"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acde0ff823ed23fd3d8b8704cf243f3d5"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d66/classshaka_1_1media_1_1NalUnitToByteStreamConverter.html#acde0ff823ed23fd3d8b8704cf243f3d5">ConvertUnitToByteStream</a> (const uint8_t *sample, size_t sample_size, bool is_key_frame, std::vector&lt; uint8_t &gt; *output)</td></tr>
<tr class="separator:acde0ff823ed23fd3d8b8704cf243f3d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae727e801c989d3ede17f1d1bd86a4ab4"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d66/classshaka_1_1media_1_1NalUnitToByteStreamConverter.html#ae727e801c989d3ede17f1d1bd86a4ab4">ConvertUnitToByteStreamWithSubsamples</a> (const uint8_t *sample, size_t sample_size, bool is_key_frame, bool escape_encrypted_nalu, std::vector&lt; uint8_t &gt; *output, std::vector&lt; <a class="el" href="../../d1/d34/structshaka_1_1media_1_1SubsampleEntry.html">SubsampleEntry</a> &gt; *subsamples)</td></tr>
<tr class="separator:ae727e801c989d3ede17f1d1bd86a4ab4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a20c3a87572914dfffcb19f35a14cf3fd"><td class="memItemLeft" align="right" valign="top"><a id="a20c3a87572914dfffcb19f35a14cf3fd"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>NalUnitToByteStreamConverterTest</b></td></tr>
<tr class="separator:a20c3a87572914dfffcb19f35a14cf3fd"><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="definition">Definition at line <a class="el" href="../../d8/dfa/nal__unit__to__byte__stream__converter_8h_source.html#l00035">35</a> of file <a class="el" href="../../d8/dfa/nal__unit__to__byte__stream__converter_8h_source.html">nal_unit_to_byte_stream_converter.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="acde0ff823ed23fd3d8b8704cf243f3d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acde0ff823ed23fd3d8b8704cf243f3d5">&#9670;&nbsp;</a></span>ConvertUnitToByteStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool shaka::media::NalUnitToByteStreamConverter::ConvertUnitToByteStream </td>
<td>(</td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>sample</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>sample_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>is_key_frame</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector&lt; uint8_t &gt; *&#160;</td>
<td class="paramname"><em>output</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts unit stream to byte stream using the data passed to <a class="el" href="../../d5/d66/classshaka_1_1media_1_1NalUnitToByteStreamConverter.html#a27986db8a2e62669fe1983a39383c546">Initialize()</a>. The method will function correctly even if <em>sample</em> is encrypted using SAMPLE-AES encryption. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">sample</td><td>is the sample to be converted. </td></tr>
<tr><td class="paramdir"></td><td class="paramname">sample_size</td><td>is the size of <em>sample</em>. </td></tr>
<tr><td class="paramdir"></td><td class="paramname">is_key_frame</td><td>indicates if the sample is a key frame. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>is set to the the converted sample, on success. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true on success, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d2/d4c/nal__unit__to__byte__stream__converter_8cc_source.html#l00259">259</a> of file <a class="el" href="../../d2/d4c/nal__unit__to__byte__stream__converter_8cc_source.html">nal_unit_to_byte_stream_converter.cc</a>.</p>
</div>
</div>
<a id="ae727e801c989d3ede17f1d1bd86a4ab4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae727e801c989d3ede17f1d1bd86a4ab4">&#9670;&nbsp;</a></span>ConvertUnitToByteStreamWithSubsamples()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool shaka::media::NalUnitToByteStreamConverter::ConvertUnitToByteStreamWithSubsamples </td>
<td>(</td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>sample</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>sample_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>is_key_frame</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>escape_encrypted_nalu</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector&lt; uint8_t &gt; *&#160;</td>
<td class="paramname"><em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector&lt; <a class="el" href="../../d1/d34/structshaka_1_1media_1_1SubsampleEntry.html">SubsampleEntry</a> &gt; *&#160;</td>
<td class="paramname"><em>subsamples</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts unit stream to byte stream using the data passed to <a class="el" href="../../d5/d66/classshaka_1_1media_1_1NalUnitToByteStreamConverter.html#a27986db8a2e62669fe1983a39383c546">Initialize()</a> and update the corresponding subsamples of the media sample. The method will function correctly even if <em>sample</em> is encrypted using SAMPLE-AES encryption. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">sample</td><td>is the sample to be converted. </td></tr>
<tr><td class="paramdir"></td><td class="paramname">sample_size</td><td>is the size of <em>sample</em>. </td></tr>
<tr><td class="paramdir"></td><td class="paramname">is_key_frame</td><td>indicates if the sample is a key frame. </td></tr>
<tr><td class="paramdir"></td><td class="paramname">escape_encrypted_nalu</td><td>indicates whether an encrypted nalu should be escaped. This is needed for Apple Sample AES. Note that |subsamples| on return contains the sizes before escaping. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>is set to the the converted sample, on success. </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">subsamples</td><td>has the input subsamples and output updated subsamples, on success. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true on success, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d2/d4c/nal__unit__to__byte__stream__converter_8cc_source.html#l00272">272</a> of file <a class="el" href="../../d2/d4c/nal__unit__to__byte__stream__converter_8cc_source.html">nal_unit_to_byte_stream_converter.cc</a>.</p>
</div>
</div>
<a id="a27986db8a2e62669fe1983a39383c546"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a27986db8a2e62669fe1983a39383c546">&#9670;&nbsp;</a></span>Initialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool shaka::media::NalUnitToByteStreamConverter::Initialize </td>
<td>(</td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>decoder_configuration_data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>decoder_configuration_data_size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This must be called before calling other methods. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder_configuration_data</td><td>is the pointer to a decoder config data. </td></tr>
<tr><td class="paramname">decoder_configuration_data_size</td><td>is the size of <em>decoder_configuration_data</em>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true on success, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d2/d4c/nal__unit__to__byte__stream__converter_8cc_source.html#l00211">211</a> of file <a class="el" href="../../d2/d4c/nal__unit__to__byte__stream__converter_8cc_source.html">nal_unit_to_byte_stream_converter.cc</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="../../d8/dfa/nal__unit__to__byte__stream__converter_8h_source.html">nal_unit_to_byte_stream_converter.h</a></li>
<li>packager/media/codecs/<a class="el" href="../../d2/d4c/nal__unit__to__byte__stream__converter_8cc_source.html">nal_unit_to_byte_stream_converter.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jun 22 2021 00:16:05 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.17
</small></address>
</body>
</html>