shaka-packager/docs/de/dc2/classshaka_1_1media_1_1H265...

251 lines
13 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::H265Parser 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="../../de/dc2/classshaka_1_1media_1_1H265Parser.html">H265Parser</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/d14/classshaka_1_1media_1_1H265Parser-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::media::H265Parser Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="../../da/d24/h265__parser_8h_source.html">h265_parser.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:a08b4d1c2bcc866d30be8d02f0aaaf37f"><td class="memItemLeft" align="right" valign="top"><a id="a08b4d1c2bcc866d30be8d02f0aaaf37f"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>Result</b> { <b>kOk</b>,
<b>kInvalidStream</b>,
<b>kUnsupportedStream</b>,
<b>kEOStream</b>
}</td></tr>
<tr class="separator:a08b4d1c2bcc866d30be8d02f0aaaf37f"><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:ae94e80774a60cc7b9cfdb7503f5047fe"><td class="memItemLeft" align="right" valign="top">Result&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dc2/classshaka_1_1media_1_1H265Parser.html#ae94e80774a60cc7b9cfdb7503f5047fe">ParseSliceHeader</a> (const <a class="el" href="../../d6/dff/classshaka_1_1media_1_1Nalu.html">Nalu</a> &amp;nalu, <a class="el" href="../../db/d05/structshaka_1_1media_1_1H265SliceHeader.html">H265SliceHeader</a> *slice_header)</td></tr>
<tr class="separator:ae94e80774a60cc7b9cfdb7503f5047fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a222c85ac46e908c8478304f2be769d6d"><td class="memItemLeft" align="right" valign="top">Result&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dc2/classshaka_1_1media_1_1H265Parser.html#a222c85ac46e908c8478304f2be769d6d">ParsePps</a> (const <a class="el" href="../../d6/dff/classshaka_1_1media_1_1Nalu.html">Nalu</a> &amp;nalu, int *pps_id)</td></tr>
<tr class="separator:a222c85ac46e908c8478304f2be769d6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a142cb83465f0fed7dba0da8e165b68fc"><td class="memItemLeft" align="right" valign="top">Result&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dc2/classshaka_1_1media_1_1H265Parser.html#a142cb83465f0fed7dba0da8e165b68fc">ParseSps</a> (const <a class="el" href="../../d6/dff/classshaka_1_1media_1_1Nalu.html">Nalu</a> &amp;nalu, int *sps_id)</td></tr>
<tr class="separator:a142cb83465f0fed7dba0da8e165b68fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4a103a131c849bf54018b747dbdd80c"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="../../de/d33/structshaka_1_1media_1_1H265Pps.html">H265Pps</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dc2/classshaka_1_1media_1_1H265Parser.html#af4a103a131c849bf54018b747dbdd80c">GetPps</a> (int pps_id)</td></tr>
<tr class="separator:af4a103a131c849bf54018b747dbdd80c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab917855df00b9003c6be4612e2fe0211"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="../../d4/dfd/structshaka_1_1media_1_1H265Sps.html">H265Sps</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dc2/classshaka_1_1media_1_1H265Parser.html#ab917855df00b9003c6be4612e2fe0211">GetSps</a> (int sps_id)</td></tr>
<tr class="separator:ab917855df00b9003c6be4612e2fe0211"><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 class to parse H.265 streams. This is incomplete and skips many pieces. This will mostly parse PPS and SPS elements as well as fully parse a slice header. </p>
<p class="definition">Definition at line <a class="el" href="../../da/d24/h265__parser_8h_source.html#l00285">285</a> of file <a class="el" href="../../da/d24/h265__parser_8h_source.html">h265_parser.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="af4a103a131c849bf54018b747dbdd80c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af4a103a131c849bf54018b747dbdd80c">&#9670;&nbsp;</a></span>GetPps()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="../../de/d33/structshaka_1_1media_1_1H265Pps.html">H265Pps</a> * shaka::media::H265Parser::GetPps </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>pps_id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>a pointer to the PPS with the given ID, or NULL if none exists. </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../db/dde/h265__parser_8cc_source.html#l00622">622</a> of file <a class="el" href="../../db/dde/h265__parser_8cc_source.html">h265_parser.cc</a>.</p>
</div>
</div>
<a id="ab917855df00b9003c6be4612e2fe0211"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab917855df00b9003c6be4612e2fe0211">&#9670;&nbsp;</a></span>GetSps()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="../../d4/dfd/structshaka_1_1media_1_1H265Sps.html">H265Sps</a> * shaka::media::H265Parser::GetSps </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>sps_id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>a pointer to the SPS with the given ID, or NULL if none exists. </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../db/dde/h265__parser_8cc_source.html#l00626">626</a> of file <a class="el" href="../../db/dde/h265__parser_8cc_source.html">h265_parser.cc</a>.</p>
</div>
</div>
<a id="a222c85ac46e908c8478304f2be769d6d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a222c85ac46e908c8478304f2be769d6d">&#9670;&nbsp;</a></span>ParsePps()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H265Parser::Result shaka::media::H265Parser::ParsePps </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="../../d6/dff/classshaka_1_1media_1_1Nalu.html">Nalu</a> &amp;&#160;</td>
<td class="paramname"><em>nalu</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int *&#160;</td>
<td class="paramname"><em>pps_id</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Parses a PPS element. This object is owned and managed by this class. The unique ID of the parsed PPS is stored in |*pps_id| if kOk is returned. </p>
<p class="definition">Definition at line <a class="el" href="../../db/dde/h265__parser_8cc_source.html#l00397">397</a> of file <a class="el" href="../../db/dde/h265__parser_8cc_source.html">h265_parser.cc</a>.</p>
</div>
</div>
<a id="ae94e80774a60cc7b9cfdb7503f5047fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae94e80774a60cc7b9cfdb7503f5047fe">&#9670;&nbsp;</a></span>ParseSliceHeader()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H265Parser::Result shaka::media::H265Parser::ParseSliceHeader </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="../../d6/dff/classshaka_1_1media_1_1Nalu.html">Nalu</a> &amp;&#160;</td>
<td class="paramname"><em>nalu</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../db/d05/structshaka_1_1media_1_1H265SliceHeader.html">H265SliceHeader</a> *&#160;</td>
<td class="paramname"><em>slice_header</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Parses a video slice header. If this returns kOk, then |*slice_header| will contain the parsed header; if it returns something else, the contents of |*slice_header| are undefined. </p>
<p class="definition">Definition at line <a class="el" href="../../db/dde/h265__parser_8cc_source.html#l00183">183</a> of file <a class="el" href="../../db/dde/h265__parser_8cc_source.html">h265_parser.cc</a>.</p>
</div>
</div>
<a id="a142cb83465f0fed7dba0da8e165b68fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a142cb83465f0fed7dba0da8e165b68fc">&#9670;&nbsp;</a></span>ParseSps()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H265Parser::Result shaka::media::H265Parser::ParseSps </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="../../d6/dff/classshaka_1_1media_1_1Nalu.html">Nalu</a> &amp;&#160;</td>
<td class="paramname"><em>nalu</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int *&#160;</td>
<td class="paramname"><em>sps_id</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Parses a SPS element. This object is owned and managed by this class. The unique ID of the parsed SPS is stored in |*sps_id| if kOk is returned. </p>
<p class="definition">Definition at line <a class="el" href="../../db/dde/h265__parser_8cc_source.html#l00505">505</a> of file <a class="el" href="../../db/dde/h265__parser_8cc_source.html">h265_parser.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="../../da/d24/h265__parser_8h_source.html">h265_parser.h</a></li>
<li>packager/media/codecs/<a class="el" href="../../db/dde/h265__parser_8cc_source.html">h265_parser.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Feb 10 2018 15:36:49 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>