doxygen/boxheader__manager_8h.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.10"/>
   7 <title>OpenJPEG: boxheader_manager.h File Reference</title>
   8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   9 <script type="text/javascript" src="jquery.js"></script>
  10 <script type="text/javascript" src="dynsections.js"></script>
  11 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12 </head>
  13 <body>
  14 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15 <div id="titlearea">
  16 <table cellspacing="0" cellpadding="0">
  17  <tbody>
  18  <tr style="height: 56px;">
  19   <td id="projectalign" style="padding-left: 0.5em;">
  20    <div id="projectname">OpenJPEG
  21    &#160;<span id="projectnumber">2.2.0</span>
  22    </div>
  23   </td>
  24  </tr>
  25  </tbody>
  26 </table>
  27 </div>
  28 <!-- end header part -->
  29 <!-- Generated by Doxygen 1.8.10 -->
  30   <div id="navrow1" class="tabs">
  31     <ul class="tablist">
  32       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  34       <li><a href="modules.html"><span>Modules</span></a></li>
  35       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  36       <li class="current"><a href="files.html"><span>Files</span></a></li>
  37     </ul>
  38   </div>
  39   <div id="navrow2" class="tabs2">
  40     <ul class="tablist">
  41       <li><a href="files.html"><span>File&#160;List</span></a></li>
  42       <li><a href="globals.html"><span>Globals</span></a></li>
  43     </ul>
  44   </div>
  45 <div id="nav-path" class="navpath">
  46   <ul>
  47 <li class="navelem"><a class="el" href="dir_d522931ffa1371640980b621734a4381.html">Users</a></li><li class="navelem"><a class="el" href="dir_694e20c96f4fc1be4aed4f026eadce94.html">antonin</a></li><li class="navelem"><a class="el" href="dir_3ca1ad36e65e03f9e8d67ddc2553765b.html">dev</a></li><li class="navelem"><a class="el" href="dir_181a881edfcb8646dab693a228fa6bde.html">opj</a></li><li class="navelem"><a class="el" href="dir_5064bb5511811c3176850b7e47443f14.html">github</a></li><li class="navelem"><a class="el" href="dir_0b20524d8f8835ca75acc430451c8412.html">openjpeg</a></li><li class="navelem"><a class="el" href="dir_e3f8a8e294f8271ee71cbcf3c2acacc1.html">src</a></li><li class="navelem"><a class="el" href="dir_da83fe5fdfb6c4554d36abffc03790ad.html">lib</a></li><li class="navelem"><a class="el" href="dir_6ec2d9a1b37a1187cc46aeaf3b19e1b3.html">openjpip</a></li>  </ul>
  48 </div>
  49 </div><!-- top -->
  50 <div class="header">
  51   <div class="summary">
  52 <a href="#nested-classes">Data Structures</a> &#124;
  53 <a href="#typedef-members">Typedefs</a> &#124;
  54 <a href="#func-members">Functions</a>  </div>
  55   <div class="headertitle">
  56 <div class="title">boxheader_manager.h File Reference</div>  </div>
  57 </div><!--header-->
  58 <div class="contents">
  59 <div class="textblock"><code>#include &quot;<a class="el" href="openjpeg_8h_source.html">openjpeg.h</a>&quot;</code><br />
  60 <code>#include &quot;<a class="el" href="byte__manager_8h_source.html">byte_manager.h</a>&quot;</code><br />
  61 <code>#include &quot;<a class="el" href="box__manager_8h_source.html">box_manager.h</a>&quot;</code><br />
  62 </div>
  63 <p><a href="boxheader__manager_8h_source.html">Go to the source code of this file.</a></p>
  64 <table class="memberdecls">
  65 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  66 Data Structures</h2></td></tr>
  67 <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>
  68 <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>
  69 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70 </table><table class="memberdecls">
  71 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  72 Typedefs</h2></td></tr>
  73 <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>
  74 <tr class="memdesc:a52219183b1007413e580aa9ba6504669"><td class="mdescLeft">&#160;</td><td class="mdescRight">box header parameters  <a href="#a52219183b1007413e580aa9ba6504669">More...</a><br /></td></tr>
  75 <tr class="separator:a52219183b1007413e580aa9ba6504669"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76 </table><table class="memberdecls">
  77 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  78 Functions</h2></td></tr>
  79 <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>
  80 <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>
  81 <tr class="separator:ad67b5454e29ddcd711d07eaddbe29f67"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82 <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>
  83 <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>
  84 <tr class="separator:acef0f9dedbcfe391a86a87b5693fda5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85 <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>
  86 <tr class="memdesc:a366e577597bfcd3e2d8c6db97f802a26"><td class="mdescLeft">&#160;</td><td class="mdescRight">print box header parameters  <a href="#a366e577597bfcd3e2d8c6db97f802a26">More...</a><br /></td></tr>
  87 <tr class="separator:a366e577597bfcd3e2d8c6db97f802a26"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88 </table>
  89 <h2 class="groupheader">Typedef Documentation</h2>
  90 <a class="anchor" id="a52219183b1007413e580aa9ba6504669"></a>
  91 <div class="memitem">
  92 <div class="memproto">
  93       <table class="memname">
  94         <tr>
  95           <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>
  96         </tr>
  97       </table>
  98 </div><div class="memdoc">
  99
 100 <p>box header parameters </p>
 101
 102 </div>
 103 </div>
 104 <h2 class="groupheader">Function Documentation</h2>
 105 <a class="anchor" id="ad67b5454e29ddcd711d07eaddbe29f67"></a>
 106 <div class="memitem">
 107 <div class="memproto">
 108       <table class="memname">
 109         <tr>
 110           <td class="memname"><a class="el" href="boxheader__manager_8h.html#a52219183b1007413e580aa9ba6504669">boxheader_param_t</a>* gene_boxheader </td>
 111           <td>(</td>
 112           <td class="paramtype">int&#160;</td>
 113           <td class="paramname"><em>fd</em>, </td>
 114         </tr>
 115         <tr>
 116           <td class="paramkey"></td>
 117           <td></td>
 118           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>&#160;</td>
 119           <td class="paramname"><em>offset</em>&#160;</td>
 120         </tr>
 121         <tr>
 122           <td></td>
 123           <td>)</td>
 124           <td></td><td></td>
 125         </tr>
 126       </table>
 127 </div><div class="memdoc">
 128
 129 <p>generate a box header at the given offset </p>
 130 <dl class="params"><dt>Parameters</dt><dd>
 131   <table class="params">
 132     <tr><td class="paramdir">[in]</td><td class="paramname">fd</td><td>file discriptor of the JP2 file </td></tr>
 133     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>Box offset </td></tr>
 134   </table>
 135   </dd>
 136 </dl>
 137 <dl class="section return"><dt>Returns</dt><dd>pointer to the structure of generate box header parameters </dd></dl>
 138
 139 <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>
 140
 141 <p>Referenced by <a class="el" href="boxheader__manager_8h.html#acef0f9dedbcfe391a86a87b5693fda5a">gene_childboxheader()</a>.</p>
 142
 143 </div>
 144 </div>
 145 <a class="anchor" id="acef0f9dedbcfe391a86a87b5693fda5a"></a>
 146 <div class="memitem">
 147 <div class="memproto">
 148       <table class="memname">
 149         <tr>
 150           <td class="memname"><a class="el" href="boxheader__manager_8h.html#a52219183b1007413e580aa9ba6504669">boxheader_param_t</a>* gene_childboxheader </td>
 151           <td>(</td>
 152           <td class="paramtype"><a class="el" href="box__manager_8h.html#aabc1b43d57961c0e224a518c8b8ca09b">box_param_t</a> *&#160;</td>
 153           <td class="paramname"><em>superbox</em>, </td>
 154         </tr>
 155         <tr>
 156           <td class="paramkey"></td>
 157           <td></td>
 158           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>&#160;</td>
 159           <td class="paramname"><em>offset</em>&#160;</td>
 160         </tr>
 161         <tr>
 162           <td></td>
 163           <td>)</td>
 164           <td></td><td></td>
 165         </tr>
 166       </table>
 167 </div><div class="memdoc">
 168
 169 <p>generate a child box header at the given offset </p>
 170 <dl class="params"><dt>Parameters</dt><dd>
 171   <table class="params">
 172     <tr><td class="paramdir">[in]</td><td class="paramname">superbox</td><td>super box pointer </td></tr>
 173     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>offset from DBox first byte of superbox </td></tr>
 174   </table>
 175   </dd>
 176 </dl>
 177 <dl class="section return"><dt>Returns</dt><dd>pointer to the structure of generate box header parameters </dd></dl>
 178
 179 <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>
 180
 181 <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>
 182
 183 </div>
 184 </div>
 185 <a class="anchor" id="a366e577597bfcd3e2d8c6db97f802a26"></a>
 186 <div class="memitem">
 187 <div class="memproto">
 188       <table class="memname">
 189         <tr>
 190           <td class="memname">void print_boxheader </td>
 191           <td>(</td>
 192           <td class="paramtype"><a class="el" href="boxheader__manager_8h.html#a52219183b1007413e580aa9ba6504669">boxheader_param_t</a> *&#160;</td>
 193           <td class="paramname"><em>boxheader</em></td><td>)</td>
 194           <td></td>
 195         </tr>
 196       </table>
 197 </div><div class="memdoc">
 198
 199 <p>print box header parameters </p>
 200 <dl class="params"><dt>Parameters</dt><dd>
 201   <table class="params">
 202     <tr><td class="paramdir">[in]</td><td class="paramname">boxheader</td><td>boxheader pointer </td></tr>
 203   </table>
 204   </dd>
 205 </dl>
 206
 207 <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>
 208
 209 <p>Referenced by <a class="el" href="manfbox__manager_8h.html#afffa66277d7b16d789f1c78683f7fc53">print_manfbox()</a>.</p>
 210
 211 </div>
 212 </div>
 213 </div><!-- contents -->
 214 <!-- start footer part -->
 215 <hr class="footer"/><address class="footer"><small>
 216 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 217 <img class="footer" src="doxygen.png" alt="doxygen"/>
 218 </a> 1.8.10
 219 </small></address>
 220 </body>
 221 </html>