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.13"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>OpenJPEG: boxheader_manager.h File Reference</title>
   9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13 </head>
  14 <body>
  15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16 <div id="titlearea">
  17 <table cellspacing="0" cellpadding="0">
  18  <tbody>
  19  <tr style="height: 56px;">
  20   <td id="projectalign" style="padding-left: 0.5em;">
  21    <div id="projectname">OpenJPEG
  22    &#160;<span id="projectnumber">2.3.1</span>
  23    </div>
  24   </td>
  25  </tr>
  26  </tbody>
  27 </table>
  28 </div>
  29 <!-- end header part -->
  30 <!-- Generated by Doxygen 1.8.13 -->
  31 <script type="text/javascript" src="menudata.js"></script>
  32 <script type="text/javascript" src="menu.js"></script>
  33 <script type="text/javascript">
  34 $(function() {
  35   initMenu('',false,false,'search.php','Search');
  36 });
  37 </script>
  38 <div id="main-nav"></div>
  39 <div id="nav-path" class="navpath">
  40   <ul>
  41 <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>
  42 </div>
  43 </div><!-- top -->
  44 <div class="header">
  45   <div class="summary">
  46 <a href="#nested-classes">Data Structures</a> &#124;
  47 <a href="#typedef-members">Typedefs</a> &#124;
  48 <a href="#func-members">Functions</a>  </div>
  49   <div class="headertitle">
  50 <div class="title">boxheader_manager.h File Reference</div>  </div>
  51 </div><!--header-->
  52 <div class="contents">
  53 <div class="textblock"><code>#include &quot;<a class="el" href="openjpeg_8h_source.html">openjpeg.h</a>&quot;</code><br />
  54 <code>#include &quot;<a class="el" href="byte__manager_8h_source.html">byte_manager.h</a>&quot;</code><br />
  55 <code>#include &quot;<a class="el" href="box__manager_8h_source.html">box_manager.h</a>&quot;</code><br />
  56 </div>
  57 <p><a href="boxheader__manager_8h_source.html">Go to the source code of this file.</a></p>
  58 <table class="memberdecls">
  59 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  60 Data Structures</h2></td></tr>
  61 <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>
  62 <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>
  63 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64 </table><table class="memberdecls">
  65 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  66 Typedefs</h2></td></tr>
  67 <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>
  68 <tr class="memdesc:a52219183b1007413e580aa9ba6504669"><td class="mdescLeft">&#160;</td><td class="mdescRight">box header parameters  <a href="#a52219183b1007413e580aa9ba6504669">More...</a><br /></td></tr>
  69 <tr class="separator:a52219183b1007413e580aa9ba6504669"><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="func-members"></a>
  72 Functions</h2></td></tr>
  73 <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>
  74 <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>
  75 <tr class="separator:ad67b5454e29ddcd711d07eaddbe29f67"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76 <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>
  77 <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>
  78 <tr class="separator:acef0f9dedbcfe391a86a87b5693fda5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79 <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>
  80 <tr class="memdesc:a366e577597bfcd3e2d8c6db97f802a26"><td class="mdescLeft">&#160;</td><td class="mdescRight">print box header parameters  <a href="#a366e577597bfcd3e2d8c6db97f802a26">More...</a><br /></td></tr>
  81 <tr class="separator:a366e577597bfcd3e2d8c6db97f802a26"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82 </table>
  83 <h2 class="groupheader">Typedef Documentation</h2>
  84 <a id="a52219183b1007413e580aa9ba6504669"></a>
  85 <h2 class="memtitle"><span class="permalink"><a href="#a52219183b1007413e580aa9ba6504669">&#9670;&nbsp;</a></span>boxheader_param_t</h2>
  86
  87 <div class="memitem">
  88 <div class="memproto">
  89       <table class="memname">
  90         <tr>
  91           <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>
  92         </tr>
  93       </table>
  94 </div><div class="memdoc">
  95
  96 <p>box header parameters </p>
  97
  98 </div>
  99 </div>
 100 <h2 class="groupheader">Function Documentation</h2>
 101 <a id="ad67b5454e29ddcd711d07eaddbe29f67"></a>
 102 <h2 class="memtitle"><span class="permalink"><a href="#ad67b5454e29ddcd711d07eaddbe29f67">&#9670;&nbsp;</a></span>gene_boxheader()</h2>
 103
 104 <div class="memitem">
 105 <div class="memproto">
 106       <table class="memname">
 107         <tr>
 108           <td class="memname"><a class="el" href="boxheader__manager_8h.html#a52219183b1007413e580aa9ba6504669">boxheader_param_t</a>* gene_boxheader </td>
 109           <td>(</td>
 110           <td class="paramtype">int&#160;</td>
 111           <td class="paramname"><em>fd</em>, </td>
 112         </tr>
 113         <tr>
 114           <td class="paramkey"></td>
 115           <td></td>
 116           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>&#160;</td>
 117           <td class="paramname"><em>offset</em>&#160;</td>
 118         </tr>
 119         <tr>
 120           <td></td>
 121           <td>)</td>
 122           <td></td><td></td>
 123         </tr>
 124       </table>
 125 </div><div class="memdoc">
 126
 127 <p>generate a box header at the given offset </p>
 128 <dl class="params"><dt>Parameters</dt><dd>
 129   <table class="params">
 130     <tr><td class="paramdir">[in]</td><td class="paramname">fd</td><td>file discriptor of the JP2 file </td></tr>
 131     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>Box offset </td></tr>
 132   </table>
 133   </dd>
 134 </dl>
 135 <dl class="section return"><dt>Returns</dt><dd>pointer to the structure of generate box header parameters </dd></dl>
 136
 137 <p class="reference">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>
 138
 139 <p class="reference">Referenced by <a class="el" href="boxheader__manager_8h.html#acef0f9dedbcfe391a86a87b5693fda5a">gene_childboxheader()</a>.</p>
 140
 141 </div>
 142 </div>
 143 <a id="acef0f9dedbcfe391a86a87b5693fda5a"></a>
 144 <h2 class="memtitle"><span class="permalink"><a href="#acef0f9dedbcfe391a86a87b5693fda5a">&#9670;&nbsp;</a></span>gene_childboxheader()</h2>
 145
 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 class="reference">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 class="reference">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 id="a366e577597bfcd3e2d8c6db97f802a26"></a>
 186 <h2 class="memtitle"><span class="permalink"><a href="#a366e577597bfcd3e2d8c6db97f802a26">&#9670;&nbsp;</a></span>print_boxheader()</h2>
 187
 188 <div class="memitem">
 189 <div class="memproto">
 190       <table class="memname">
 191         <tr>
 192           <td class="memname">void print_boxheader </td>
 193           <td>(</td>
 194           <td class="paramtype"><a class="el" href="boxheader__manager_8h.html#a52219183b1007413e580aa9ba6504669">boxheader_param_t</a> *&#160;</td>
 195           <td class="paramname"><em>boxheader</em></td><td>)</td>
 196           <td></td>
 197         </tr>
 198       </table>
 199 </div><div class="memdoc">
 200
 201 <p>print box header parameters </p>
 202 <dl class="params"><dt>Parameters</dt><dd>
 203   <table class="params">
 204     <tr><td class="paramdir">[in]</td><td class="paramname">boxheader</td><td>boxheader pointer </td></tr>
 205   </table>
 206   </dd>
 207 </dl>
 208
 209 <p class="reference">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>
 210
 211 <p class="reference">Referenced by <a class="el" href="manfbox__manager_8h.html#afffa66277d7b16d789f1c78683f7fc53">print_manfbox()</a>.</p>
 212
 213 </div>
 214 </div>
 215 </div><!-- contents -->
 216 <!-- start footer part -->
 217 <hr class="footer"/><address class="footer"><small>
 218 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 219 <img class="footer" src="doxygen.png" alt="doxygen"/>
 220 </a> 1.8.13
 221 </small></address>
 222 </body>
 223 </html>