shaka-packager/docs/de/dea/classshaka_1_1media_1_1H26x...

281 lines
16 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::H26xByteToUnitStreamConverter 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="../../de/dea/classshaka_1_1media_1_1H26xByteToUnitStreamConverter.html">H26xByteToUnitStreamConverter</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="../../d7/d54/classshaka_1_1media_1_1H26xByteToUnitStreamConverter-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::media::H26xByteToUnitStreamConverter Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>A base class that is used to convert H.26x byte streams to NAL unit streams.
<a href="../../de/dea/classshaka_1_1media_1_1H26xByteToUnitStreamConverter.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="../../db/d31/h26x__byte__to__unit__stream__converter_8h_source.html">h26x_byte_to_unit_stream_converter.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for shaka::media::H26xByteToUnitStreamConverter:</div>
<div class="dyncontent">
<div class="center">
<img src="../../de/dea/classshaka_1_1media_1_1H26xByteToUnitStreamConverter.png" usemap="#shaka::media::H26xByteToUnitStreamConverter_map" alt=""/>
<map id="shaka::media::H26xByteToUnitStreamConverter_map" name="shaka::media::H26xByteToUnitStreamConverter_map">
<area href="../../d8/d08/classshaka_1_1media_1_1H264ByteToUnitStreamConverter.html" alt="shaka::media::H264ByteToUnitStreamConverter" shape="rect" coords="0,56,276,80"/>
<area href="../../db/df8/classshaka_1_1media_1_1H265ByteToUnitStreamConverter.html" alt="shaka::media::H265ByteToUnitStreamConverter" shape="rect" coords="286,56,562,80"/>
</map>
</div></div>
<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:ac57b1509f83fa8a3e508fee61bb2eaf7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dea/classshaka_1_1media_1_1H26xByteToUnitStreamConverter.html#ac57b1509f83fa8a3e508fee61bb2eaf7">H26xByteToUnitStreamConverter</a> (Nalu::CodecType type)</td></tr>
<tr class="separator:ac57b1509f83fa8a3e508fee61bb2eaf7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43fd12a6ac3c9749e2cf0c29b2262cd1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dea/classshaka_1_1media_1_1H26xByteToUnitStreamConverter.html#a43fd12a6ac3c9749e2cf0c29b2262cd1">H26xByteToUnitStreamConverter</a> (Nalu::CodecType type, H26xStreamFormat stream_format)</td></tr>
<tr class="separator:a43fd12a6ac3c9749e2cf0c29b2262cd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f85f99c1cc939382c4eecd6580ecd17"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dea/classshaka_1_1media_1_1H26xByteToUnitStreamConverter.html#a8f85f99c1cc939382c4eecd6580ecd17">ConvertByteStreamToNalUnitStream</a> (const uint8_t *input_frame, size_t input_frame_size, std::vector&lt; uint8_t &gt; *output_frame)</td></tr>
<tr class="separator:a8f85f99c1cc939382c4eecd6580ecd17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57f8a71d948f27303ba41dd5aafb5445"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dea/classshaka_1_1media_1_1H26xByteToUnitStreamConverter.html#a57f8a71d948f27303ba41dd5aafb5445">GetDecoderConfigurationRecord</a> (std::vector&lt; uint8_t &gt; *decoder_config) const =0</td></tr>
<tr class="separator:a57f8a71d948f27303ba41dd5aafb5445"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b9e09423304077f868aad7bfb3bb274"><td class="memItemLeft" align="right" valign="top"><a id="a0b9e09423304077f868aad7bfb3bb274"></a>
H26xStreamFormat&#160;</td><td class="memItemRight" valign="bottom"><b>stream_format</b> () const</td></tr>
<tr class="separator:a0b9e09423304077f868aad7bfb3bb274"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:af19cec5d586d8a28973c4e4923b99131"><td class="memItemLeft" align="right" valign="top"><a id="af19cec5d586d8a28973c4e4923b99131"></a>
static constexpr size_t&#160;</td><td class="memItemRight" valign="bottom"><b>kUnitStreamNaluLengthSize</b> = 4</td></tr>
<tr class="separator:af19cec5d586d8a28973c4e4923b99131"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:af4bffedc90e0013075071fc9365dc197"><td class="memItemLeft" align="right" valign="top"><a id="af4bffedc90e0013075071fc9365dc197"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>strip_parameter_set_nalus</b> () const</td></tr>
<tr class="separator:af4bffedc90e0013075071fc9365dc197"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a952108007bb3d9101eb6666efc6829f0"><td class="memItemLeft" align="right" valign="top"><a id="a952108007bb3d9101eb6666efc6829f0"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>WarnIfNotMatch</b> (int nalu_type, const uint8_t *nalu_ptr, size_t nalu_size, const std::vector&lt; uint8_t &gt; &amp;vector)</td></tr>
<tr class="separator:a952108007bb3d9101eb6666efc6829f0"><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>A base class that is used to convert H.26x byte streams to NAL unit streams. </p>
<p class="definition">Definition at line <a class="el" href="../../db/d31/h26x__byte__to__unit__stream__converter_8h_source.html#l00023">23</a> of file <a class="el" href="../../db/d31/h26x__byte__to__unit__stream__converter_8h_source.html">h26x_byte_to_unit_stream_converter.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ac57b1509f83fa8a3e508fee61bb2eaf7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac57b1509f83fa8a3e508fee61bb2eaf7">&#9670;&nbsp;</a></span>H26xByteToUnitStreamConverter() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">shaka::media::H26xByteToUnitStreamConverter::H26xByteToUnitStreamConverter </td>
<td>(</td>
<td class="paramtype">Nalu::CodecType&#160;</td>
<td class="paramname"><em>type</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a byte to unit stream converter with specified codec type. The setting of <em>KeepParameterSetNalus</em> is defined by a gflag. </p>
<p class="definition">Definition at line <a class="el" href="../../de/d3c/h26x__byte__to__unit__stream__converter_8cc_source.html#l00035">35</a> of file <a class="el" href="../../de/d3c/h26x__byte__to__unit__stream__converter_8cc_source.html">h26x_byte_to_unit_stream_converter.cc</a>.</p>
</div>
</div>
<a id="a43fd12a6ac3c9749e2cf0c29b2262cd1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43fd12a6ac3c9749e2cf0c29b2262cd1">&#9670;&nbsp;</a></span>H26xByteToUnitStreamConverter() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">shaka::media::H26xByteToUnitStreamConverter::H26xByteToUnitStreamConverter </td>
<td>(</td>
<td class="paramtype">Nalu::CodecType&#160;</td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">H26xStreamFormat&#160;</td>
<td class="paramname"><em>stream_format</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a byte to unit stream converter with specified codec type and desired output stream format (whether to include parameter set nal units). </p>
<p class="definition">Definition at line <a class="el" href="../../de/d3c/h26x__byte__to__unit__stream__converter_8cc_source.html#l00043">43</a> of file <a class="el" href="../../de/d3c/h26x__byte__to__unit__stream__converter_8cc_source.html">h26x_byte_to_unit_stream_converter.cc</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a8f85f99c1cc939382c4eecd6580ecd17"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f85f99c1cc939382c4eecd6580ecd17">&#9670;&nbsp;</a></span>ConvertByteStreamToNalUnitStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool shaka::media::H26xByteToUnitStreamConverter::ConvertByteStreamToNalUnitStream </td>
<td>(</td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>input_frame</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>input_frame_size</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_frame</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts a whole byte stream encoded video frame to NAL unit stream format. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">input_frame</td><td>is a buffer containing a whole H.26x frame in byte stream format. </td></tr>
<tr><td class="paramname">input_frame_size</td><td>is the size of the H.26x frame, in bytes. </td></tr>
<tr><td class="paramname">output_frame</td><td>is a pointer to a vector which will receive the converted frame. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successful, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../de/d3c/h26x__byte__to__unit__stream__converter_8cc_source.html#l00050">50</a> of file <a class="el" href="../../de/d3c/h26x__byte__to__unit__stream__converter_8cc_source.html">h26x_byte_to_unit_stream_converter.cc</a>.</p>
</div>
</div>
<a id="a57f8a71d948f27303ba41dd5aafb5445"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a57f8a71d948f27303ba41dd5aafb5445">&#9670;&nbsp;</a></span>GetDecoderConfigurationRecord()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool shaka::media::H26xByteToUnitStreamConverter::GetDecoderConfigurationRecord </td>
<td>(</td>
<td class="paramtype">std::vector&lt; uint8_t &gt; *&#160;</td>
<td class="paramname"><em>decoder_config</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates either an <a class="el" href="../../d6/d57/classshaka_1_1media_1_1AVCDecoderConfigurationRecord.html" title="Class for parsing AVC decoder configuration record.">AVCDecoderConfigurationRecord</a> or a <a class="el" href="../../d4/d8a/classshaka_1_1media_1_1HEVCDecoderConfigurationRecord.html" title="Class for parsing HEVC decoder configuration record.">HEVCDecoderConfigurationRecord</a> from the units extracted from the byte stream. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder_config</td><td>is a pointer to a vector, which on successful return will contain the computed record. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successful, or false otherwise. </dd></dl>
<p>Implemented in <a class="el" href="../../d8/d08/classshaka_1_1media_1_1H264ByteToUnitStreamConverter.html#a6a7a73841ded1942364f88aad90dcbc9">shaka::media::H264ByteToUnitStreamConverter</a>, and <a class="el" href="../../db/df8/classshaka_1_1media_1_1H265ByteToUnitStreamConverter.html#a9a866e255a2b267f2b44d0156c479de9">shaka::media::H265ByteToUnitStreamConverter</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="../../db/d31/h26x__byte__to__unit__stream__converter_8h_source.html">h26x_byte_to_unit_stream_converter.h</a></li>
<li>packager/media/codecs/<a class="el" href="../../de/d3c/h26x__byte__to__unit__stream__converter_8cc_source.html">h26x_byte_to_unit_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>