openjpeg/doxygen/boxheader__manager_8h.html

222 lines
13 KiB
HTML
Raw Normal View History

2015-07-10 18:06:19 +02:00
<!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"/>
2020-12-28 22:12:25 +01:00
<meta name="generator" content="Doxygen 1.8.11"/>
2015-07-10 18:06:19 +02:00
<title>OpenJPEG: boxheader_manager.h File 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="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;">
2016-09-29 22:38:29 +02:00
<td id="projectalign" style="padding-left: 0.5em;">
2015-07-10 18:06:19 +02:00
<div id="projectname">OpenJPEG
2020-12-28 22:12:25 +01:00
&#160;<span id="projectnumber">2.4.0</span>
2015-07-10 18:06:19 +02:00
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
2020-12-28 22:12:25 +01:00
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
2015-07-10 18:06:19 +02:00
<div id="nav-path" class="navpath">
<ul>
2020-12-28 22:12:25 +01:00
<li class="navelem"><a class="el" href="dir_43e0a1f539e00dcfa1a6bc4d4fee4fc2.html">home</a></li><li class="navelem"><a class="el" href="dir_cb9b2b419d92b64f7cee83d8faf7a4ab.html">even</a></li><li class="navelem"><a class="el" href="dir_f75d9a0165d6564a1e04793ef847d41d.html">openjpeg</a></li><li class="navelem"><a class="el" href="dir_5f588d7ea139c1aae751d03c13a16064.html">openjpeg</a></li><li class="navelem"><a class="el" href="dir_378f732e812ef6cbaaae22e96a4fa79f.html">src</a></li><li class="navelem"><a class="el" href="dir_19dcb5713315405a27e1bde75a489a4c.html">lib</a></li><li class="navelem"><a class="el" href="dir_54d80c9412497e935deb5677b5fae801.html">openjpip</a></li> </ul>
2015-07-10 18:06:19 +02:00
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">boxheader_manager.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="openjpeg_8h_source.html">openjpeg.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="byte__manager_8h_source.html">byte_manager.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="box__manager_8h_source.html">box_manager.h</a>&quot;</code><br />
</div>
<p><a href="boxheader__manager_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboxheader__param.html">boxheader_param</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">box header parameters <a href="structboxheader__param.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a52219183b1007413e580aa9ba6504669"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structboxheader__param.html">boxheader_param</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="boxheader__manager_8h.html#a52219183b1007413e580aa9ba6504669">boxheader_param_t</a></td></tr>
<tr class="memdesc:a52219183b1007413e580aa9ba6504669"><td class="mdescLeft">&#160;</td><td class="mdescRight">box header parameters <a href="#a52219183b1007413e580aa9ba6504669">More...</a><br /></td></tr>
<tr class="separator:a52219183b1007413e580aa9ba6504669"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ad67b5454e29ddcd711d07eaddbe29f67"><td class="memItemLeft" align="right" valign="top"><a class="el" href="boxheader__manager_8h.html#a52219183b1007413e580aa9ba6504669">boxheader_param_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="boxheader__manager_8h.html#ad67b5454e29ddcd711d07eaddbe29f67">gene_boxheader</a> (int fd, <a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset)</td></tr>
<tr class="memdesc:ad67b5454e29ddcd711d07eaddbe29f67"><td class="mdescLeft">&#160;</td><td class="mdescRight">generate a box header at the given offset <a href="#ad67b5454e29ddcd711d07eaddbe29f67">More...</a><br /></td></tr>
<tr class="separator:ad67b5454e29ddcd711d07eaddbe29f67"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acef0f9dedbcfe391a86a87b5693fda5a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="boxheader__manager_8h.html#a52219183b1007413e580aa9ba6504669">boxheader_param_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="boxheader__manager_8h.html#acef0f9dedbcfe391a86a87b5693fda5a">gene_childboxheader</a> (<a class="el" href="box__manager_8h.html#aabc1b43d57961c0e224a518c8b8ca09b">box_param_t</a> *superbox, <a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset)</td></tr>
<tr class="memdesc:acef0f9dedbcfe391a86a87b5693fda5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">generate a child box header at the given offset <a href="#acef0f9dedbcfe391a86a87b5693fda5a">More...</a><br /></td></tr>
<tr class="separator:acef0f9dedbcfe391a86a87b5693fda5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a366e577597bfcd3e2d8c6db97f802a26"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="boxheader__manager_8h.html#a366e577597bfcd3e2d8c6db97f802a26">print_boxheader</a> (<a class="el" href="boxheader__manager_8h.html#a52219183b1007413e580aa9ba6504669">boxheader_param_t</a> *boxheader)</td></tr>
<tr class="memdesc:a366e577597bfcd3e2d8c6db97f802a26"><td class="mdescLeft">&#160;</td><td class="mdescRight">print box header parameters <a href="#a366e577597bfcd3e2d8c6db97f802a26">More...</a><br /></td></tr>
<tr class="separator:a366e577597bfcd3e2d8c6db97f802a26"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
2020-12-28 22:12:25 +01:00
<a class="anchor" id="a52219183b1007413e580aa9ba6504669"></a>
2015-07-10 18:06:19 +02:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structboxheader__param.html">boxheader_param</a> <a class="el" href="boxheader__manager_8h.html#a52219183b1007413e580aa9ba6504669">boxheader_param_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>box header parameters </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
2020-12-28 22:12:25 +01:00
<a class="anchor" id="ad67b5454e29ddcd711d07eaddbe29f67"></a>
2015-07-10 18:06:19 +02:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="boxheader__manager_8h.html#a52219183b1007413e580aa9ba6504669">boxheader_param_t</a>* gene_boxheader </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>&#160;</td>
<td class="paramname"><em>offset</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>generate a box header at the given offset </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">fd</td><td>file discriptor of the JP2 file </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>Box offset </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pointer to the structure of generate box header parameters </dd></dl>
2020-12-28 22:12:25 +01:00
<p>References <a class="el" href="byte__manager_8c.html#a72b441947e1fab5e8dd83fdc985bf29c">fetch_4bytebigendian()</a>, <a class="el" href="byte__manager_8c.html#ae4d6ed0e45814368ab976a1530b8c780">fetch_8bytebigendian()</a>, <a class="el" href="byte__manager_8c.html#a62851758f9c2af1b12995190a1e4e909">fetch_bytes()</a>, <a class="el" href="structboxheader__param.html#aabf782e3d43e158e4477308c11670ac4">boxheader_param::headlen</a>, <a class="el" href="structboxheader__param.html#a2a90e59fdad1a3ff2c0f40b4dfff7ed1">boxheader_param::length</a>, <a class="el" href="structboxheader__param.html#a24a521b8c32b65e2354e67191c14f232">boxheader_param::next</a>, and <a class="el" href="structboxheader__param.html#ad64aefab7bef517b0bfe152352f89d99">boxheader_param::type</a>.</p>
2015-07-10 18:06:19 +02:00
2020-12-28 22:12:25 +01:00
<p>Referenced by <a class="el" href="boxheader__manager_8h.html#acef0f9dedbcfe391a86a87b5693fda5a">gene_childboxheader()</a>.</p>
2015-07-10 18:06:19 +02:00
</div>
</div>
2020-12-28 22:12:25 +01:00
<a class="anchor" id="acef0f9dedbcfe391a86a87b5693fda5a"></a>
2015-07-10 18:06:19 +02:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="boxheader__manager_8h.html#a52219183b1007413e580aa9ba6504669">boxheader_param_t</a>* gene_childboxheader </td>
<td>(</td>
<td class="paramtype"><a class="el" href="box__manager_8h.html#aabc1b43d57961c0e224a518c8b8ca09b">box_param_t</a> *&#160;</td>
<td class="paramname"><em>superbox</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>&#160;</td>
<td class="paramname"><em>offset</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>generate a child box header at the given offset </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">superbox</td><td>super box pointer </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>offset from DBox first byte of superbox </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pointer to the structure of generate box header parameters </dd></dl>
2020-12-28 22:12:25 +01:00
<p>References <a class="el" href="structbox__param.html#ab6a91091b8afeb3d5cea812a3c6b19a3">box_param::fd</a>, <a class="el" href="boxheader__manager_8c.html#ad67b5454e29ddcd711d07eaddbe29f67">gene_boxheader()</a>, and <a class="el" href="box__manager_8c.html#aa6d6dd0304ffedcb0c67ef23cf62e38a">get_DBoxoff()</a>.</p>
2015-07-10 18:06:19 +02:00
2020-12-28 22:12:25 +01:00
<p>Referenced by <a class="el" href="index__manager_8c.html#aef72d99e5b07983bcf9b7ba3b76f0c61">check_JP2boxidx()</a>, and <a class="el" href="manfbox__manager_8h.html#a7c8a7b0c84e1ad9d858c16ed4888b7f1">gene_manfbox()</a>.</p>
2015-07-10 18:06:19 +02:00
</div>
</div>
2020-12-28 22:12:25 +01:00
<a class="anchor" id="a366e577597bfcd3e2d8c6db97f802a26"></a>
2015-07-10 18:06:19 +02:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void print_boxheader </td>
<td>(</td>
<td class="paramtype"><a class="el" href="boxheader__manager_8h.html#a52219183b1007413e580aa9ba6504669">boxheader_param_t</a> *&#160;</td>
<td class="paramname"><em>boxheader</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>print box header parameters </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">boxheader</td><td>boxheader pointer </td></tr>
</table>
</dd>
</dl>
2020-12-28 22:12:25 +01:00
<p>References <a class="el" href="structboxheader__param.html#a2a90e59fdad1a3ff2c0f40b4dfff7ed1">boxheader_param::length</a>, <a class="el" href="boxheader__manager_8c.html#a31c99676da88bb0bcdb350710f00fa96">logstream</a>, and <a class="el" href="structboxheader__param.html#ad64aefab7bef517b0bfe152352f89d99">boxheader_param::type</a>.</p>
2015-07-10 18:06:19 +02:00
2020-12-28 22:12:25 +01:00
<p>Referenced by <a class="el" href="manfbox__manager_8h.html#afffa66277d7b16d789f1c78683f7fc53">print_manfbox()</a>.</p>
2015-07-10 18:06:19 +02:00
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
2020-12-28 22:12:25 +01:00
</a> 1.8.11
2015-07-10 18:06:19 +02:00
</small></address>
</body>
</html>