shaka-packager/docs/d9/d28/classshaka_1_1media_1_1DvbI...

174 lines
11 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::DvbImageBuilder 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="../../d9/d28/classshaka_1_1media_1_1DvbImageBuilder.html">DvbImageBuilder</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="../../db/d13/classshaka_1_1media_1_1DvbImageBuilder-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::media::DvbImageBuilder Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="../../d2/de1/dvb__image_8h_source.html">dvb_image.h</a>&gt;</code></p>
<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:a84e4baf0bd388687a558fb4adbcb9544"><td class="memItemLeft" align="right" valign="top"><a id="a84e4baf0bd388687a558fb4adbcb9544"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>DvbImageBuilder</b> (const <a class="el" href="../../d8/db4/classshaka_1_1media_1_1DvbImageColorSpace.html">DvbImageColorSpace</a> *color_space, const <a class="el" href="../../d4/dfa/structshaka_1_1media_1_1RgbaColor.html">RgbaColor</a> &amp;default_color, uint16_t max_width, uint16_t max_height)</td></tr>
<tr class="separator:a84e4baf0bd388687a558fb4adbcb9544"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af813f82e9f2d3de75ca999190ea52398"><td class="memItemLeft" align="right" valign="top"><a id="af813f82e9f2d3de75ca999190ea52398"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>DvbImageBuilder</b> (const <a class="el" href="../../d9/d28/classshaka_1_1media_1_1DvbImageBuilder.html">DvbImageBuilder</a> &amp;)=delete</td></tr>
<tr class="separator:af813f82e9f2d3de75ca999190ea52398"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e51e9de60ff5be27c2e2a8b6f18c9d9"><td class="memItemLeft" align="right" valign="top"><a id="a8e51e9de60ff5be27c2e2a8b6f18c9d9"></a>
<a class="el" href="../../d9/d28/classshaka_1_1media_1_1DvbImageBuilder.html">DvbImageBuilder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="../../d9/d28/classshaka_1_1media_1_1DvbImageBuilder.html">DvbImageBuilder</a> &amp;)=delete</td></tr>
<tr class="separator:a8e51e9de60ff5be27c2e2a8b6f18c9d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6e033147d10886907537897a843b0c9"><td class="memItemLeft" align="right" valign="top"><a id="af6e033147d10886907537897a843b0c9"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><b>max_width</b> () const</td></tr>
<tr class="separator:af6e033147d10886907537897a843b0c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa73f08db927b0caabe0e8ed2fa4ec193"><td class="memItemLeft" align="right" valign="top"><a id="aa73f08db927b0caabe0e8ed2fa4ec193"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><b>max_height</b> () const</td></tr>
<tr class="separator:aa73f08db927b0caabe0e8ed2fa4ec193"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1233a24dd7b9bc3e3c65e56c5a7951a"><td class="memItemLeft" align="right" valign="top"><a id="af1233a24dd7b9bc3e3c65e56c5a7951a"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>AddPixel</b> (BitDepth bit_depth, uint8_t byte_code, bool is_top_rows)</td></tr>
<tr class="separator:af1233a24dd7b9bc3e3c65e56c5a7951a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a014b2797e4a0c7c5c6420d1e74e2724b"><td class="memItemLeft" align="right" valign="top"><a id="a014b2797e4a0c7c5c6420d1e74e2724b"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>NewRow</b> (bool is_top_rows)</td></tr>
<tr class="separator:a014b2797e4a0c7c5c6420d1e74e2724b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54dd37c2291b7b988f636527330b0d53"><td class="memItemLeft" align="right" valign="top"><a id="a54dd37c2291b7b988f636527330b0d53"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d28/classshaka_1_1media_1_1DvbImageBuilder.html#a54dd37c2291b7b988f636527330b0d53">MirrorToBottomRows</a> ()</td></tr>
<tr class="memdesc:a54dd37c2291b7b988f636527330b0d53"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copies the top-rows to the bottom rows. <br /></td></tr>
<tr class="separator:a54dd37c2291b7b988f636527330b0d53"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e952ceca8ca59c293936039df49c1ef"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d28/classshaka_1_1media_1_1DvbImageBuilder.html#a4e952ceca8ca59c293936039df49c1ef">GetPixels</a> (const <a class="el" href="../../d4/dfa/structshaka_1_1media_1_1RgbaColor.html">RgbaColor</a> **pixels, uint16_t *width, uint16_t *height) const</td></tr>
<tr class="separator:a4e952ceca8ca59c293936039df49c1ef"><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>Defines a builder that generates an image from a DVB-sub byte stream. This allocates a single buffer big enough to hold the max-sized image and fills it in series. The NewRow() method must be called to start a new line of the image.</p>
<p>This adds pixels in an interlaced format. Adding pixels and new rows on top-rows doesn't affect the bottom-rows. Top-rows refers to even-indexed lines (e.g. 0,2,4). </p>
<p class="definition">Definition at line <a class="el" href="../../d2/de1/dvb__image_8h_source.html#l00089">89</a> of file <a class="el" href="../../d2/de1/dvb__image_8h_source.html">dvb_image.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a4e952ceca8ca59c293936039df49c1ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e952ceca8ca59c293936039df49c1ef">&#9670;&nbsp;</a></span>GetPixels()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool shaka::media::DvbImageBuilder::GetPixels </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="../../d4/dfa/structshaka_1_1media_1_1RgbaColor.html">RgbaColor</a> **&#160;</td>
<td class="paramname"><em>pixels</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t *&#160;</td>
<td class="paramname"><em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t *&#160;</td>
<td class="paramname"><em>height</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the pixel buffer. Each row is based on the max_width field, but the max filled row with will be given in <code>width</code>. This assumes that NewRow was called recently and we are at the beginning of the rows.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pixels</td><td>A pointer to a RgbaColor* variable that will be set to the pixel data pointer. </td></tr>
<tr><td class="paramname">width</td><td>Will be filled with the max width of all rows. </td></tr>
<tr><td class="paramname">height</td><td>Will be filled with the number of rows set. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True on success, false on error. </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d8/dcb/dvb__image_8cc_source.html#l00244">244</a> of file <a class="el" href="../../d8/dcb/dvb__image_8cc_source.html">dvb_image.cc</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>packager/media/formats/dvb/<a class="el" href="../../d2/de1/dvb__image_8h_source.html">dvb_image.h</a></li>
<li>packager/media/formats/dvb/<a class="el" href="../../d8/dcb/dvb__image_8cc_source.html">dvb_image.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>