2.5.2 post: fix full changelog
[openjpeg.git] / doxygen / boxheader__manager_8c.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>OpenJPEG: boxheader_manager.c 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.5.0</span>
23    </div>
24   </td>
25  </tr>
26  </tbody>
27 </table>
28 </div>
29 <!-- end header part -->
30 <!-- Generated by Doxygen 1.8.17 -->
31 <script type="text/javascript" src="menudata.js"></script>
32 <script type="text/javascript" src="menu.js"></script>
33 <script type="text/javascript">
34 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
35 $(function() {
36   initMenu('',false,false,'search.php','Search');
37 });
38 /* @license-end */</script>
39 <div id="main-nav"></div>
40 <div id="nav-path" class="navpath">
41   <ul>
42 <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>
43 </div>
44 </div><!-- top -->
45 <div class="header">
46   <div class="summary">
47 <a href="#define-members">Macros</a> &#124;
48 <a href="#func-members">Functions</a>  </div>
49   <div class="headertitle">
50 <div class="title">boxheader_manager.c File Reference</div>  </div>
51 </div><!--header-->
52 <div class="contents">
53 <div class="textblock"><code>#include &lt;stdio.h&gt;</code><br />
54 <code>#include &lt;stdlib.h&gt;</code><br />
55 <code>#include &lt;string.h&gt;</code><br />
56 <code>#include &quot;<a class="el" href="boxheader__manager_8h_source.html">boxheader_manager.h</a>&quot;</code><br />
57 <code>#include &quot;<a class="el" href="opj__inttypes_8h_source.html">opj_inttypes.h</a>&quot;</code><br />
58 </div><table class="memberdecls">
59 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
60 Macros</h2></td></tr>
61 <tr class="memitem:ac322e421aefb8ec9ccc10bef953e3d82"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="boxheader__manager_8c.html#ac322e421aefb8ec9ccc10bef953e3d82">FCGI_stdout</a>&#160;&#160;&#160;stdout</td></tr>
62 <tr class="separator:ac322e421aefb8ec9ccc10bef953e3d82"><td class="memSeparator" colspan="2">&#160;</td></tr>
63 <tr class="memitem:a77b5d5af2adb2cfa7ec785b592fc4074"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="boxheader__manager_8c.html#a77b5d5af2adb2cfa7ec785b592fc4074">FCGI_stderr</a>&#160;&#160;&#160;stderr</td></tr>
64 <tr class="separator:a77b5d5af2adb2cfa7ec785b592fc4074"><td class="memSeparator" colspan="2">&#160;</td></tr>
65 <tr class="memitem:a31c99676da88bb0bcdb350710f00fa96"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="boxheader__manager_8c.html#a31c99676da88bb0bcdb350710f00fa96">logstream</a>&#160;&#160;&#160;stderr</td></tr>
66 <tr class="separator:a31c99676da88bb0bcdb350710f00fa96"><td class="memSeparator" colspan="2">&#160;</td></tr>
67 </table><table class="memberdecls">
68 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
69 Functions</h2></td></tr>
70 <tr class="memitem:ad67b5454e29ddcd711d07eaddbe29f67"><td class="memItemLeft" align="right" valign="top"><a class="el" href="boxheader__manager_8h.html#a0df836b5592c4918f1d826a98508a514">boxheader_param_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="boxheader__manager_8c.html#ad67b5454e29ddcd711d07eaddbe29f67">gene_boxheader</a> (int fd, <a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset)</td></tr>
71 <tr class="memdesc:ad67b5454e29ddcd711d07eaddbe29f67"><td class="mdescLeft">&#160;</td><td class="mdescRight">generate a box header at the given offset  <a href="boxheader__manager_8c.html#ad67b5454e29ddcd711d07eaddbe29f67">More...</a><br /></td></tr>
72 <tr class="separator:ad67b5454e29ddcd711d07eaddbe29f67"><td class="memSeparator" colspan="2">&#160;</td></tr>
73 <tr class="memitem:acef0f9dedbcfe391a86a87b5693fda5a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="boxheader__manager_8h.html#a0df836b5592c4918f1d826a98508a514">boxheader_param_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="boxheader__manager_8c.html#acef0f9dedbcfe391a86a87b5693fda5a">gene_childboxheader</a> (<a class="el" href="box__manager_8h.html#a595fedb372a3046632dab041d6b9577c">box_param_t</a> *superbox, <a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset)</td></tr>
74 <tr class="memdesc:acef0f9dedbcfe391a86a87b5693fda5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">generate a child box header at the given offset  <a href="boxheader__manager_8c.html#acef0f9dedbcfe391a86a87b5693fda5a">More...</a><br /></td></tr>
75 <tr class="separator:acef0f9dedbcfe391a86a87b5693fda5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
76 <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_8c.html#a366e577597bfcd3e2d8c6db97f802a26">print_boxheader</a> (<a class="el" href="boxheader__manager_8h.html#a0df836b5592c4918f1d826a98508a514">boxheader_param_t</a> *boxheader)</td></tr>
77 <tr class="memdesc:a366e577597bfcd3e2d8c6db97f802a26"><td class="mdescLeft">&#160;</td><td class="mdescRight">print box header parameters  <a href="boxheader__manager_8c.html#a366e577597bfcd3e2d8c6db97f802a26">More...</a><br /></td></tr>
78 <tr class="separator:a366e577597bfcd3e2d8c6db97f802a26"><td class="memSeparator" colspan="2">&#160;</td></tr>
79 </table>
80 <h2 class="groupheader">Macro Definition Documentation</h2>
81 <a id="a77b5d5af2adb2cfa7ec785b592fc4074"></a>
82 <h2 class="memtitle"><span class="permalink"><a href="#a77b5d5af2adb2cfa7ec785b592fc4074">&#9670;&nbsp;</a></span>FCGI_stderr</h2>
83
84 <div class="memitem">
85 <div class="memproto">
86       <table class="memname">
87         <tr>
88           <td class="memname">#define FCGI_stderr&#160;&#160;&#160;stderr</td>
89         </tr>
90       </table>
91 </div><div class="memdoc">
92
93 </div>
94 </div>
95 <a id="ac322e421aefb8ec9ccc10bef953e3d82"></a>
96 <h2 class="memtitle"><span class="permalink"><a href="#ac322e421aefb8ec9ccc10bef953e3d82">&#9670;&nbsp;</a></span>FCGI_stdout</h2>
97
98 <div class="memitem">
99 <div class="memproto">
100       <table class="memname">
101         <tr>
102           <td class="memname">#define FCGI_stdout&#160;&#160;&#160;stdout</td>
103         </tr>
104       </table>
105 </div><div class="memdoc">
106
107 </div>
108 </div>
109 <a id="a31c99676da88bb0bcdb350710f00fa96"></a>
110 <h2 class="memtitle"><span class="permalink"><a href="#a31c99676da88bb0bcdb350710f00fa96">&#9670;&nbsp;</a></span>logstream</h2>
111
112 <div class="memitem">
113 <div class="memproto">
114       <table class="memname">
115         <tr>
116           <td class="memname">#define logstream&#160;&#160;&#160;stderr</td>
117         </tr>
118       </table>
119 </div><div class="memdoc">
120
121 </div>
122 </div>
123 <h2 class="groupheader">Function Documentation</h2>
124 <a id="ad67b5454e29ddcd711d07eaddbe29f67"></a>
125 <h2 class="memtitle"><span class="permalink"><a href="#ad67b5454e29ddcd711d07eaddbe29f67">&#9670;&nbsp;</a></span>gene_boxheader()</h2>
126
127 <div class="memitem">
128 <div class="memproto">
129       <table class="memname">
130         <tr>
131           <td class="memname"><a class="el" href="boxheader__manager_8h.html#a0df836b5592c4918f1d826a98508a514">boxheader_param_t</a>* gene_boxheader </td>
132           <td>(</td>
133           <td class="paramtype">int&#160;</td>
134           <td class="paramname"><em>fd</em>, </td>
135         </tr>
136         <tr>
137           <td class="paramkey"></td>
138           <td></td>
139           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>&#160;</td>
140           <td class="paramname"><em>offset</em>&#160;</td>
141         </tr>
142         <tr>
143           <td></td>
144           <td>)</td>
145           <td></td><td></td>
146         </tr>
147       </table>
148 </div><div class="memdoc">
149
150 <p>generate a box header at the given offset </p>
151 <dl class="params"><dt>Parameters</dt><dd>
152   <table class="params">
153     <tr><td class="paramdir">[in]</td><td class="paramname">fd</td><td>file discriptor of the JP2 file </td></tr>
154     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>Box offset </td></tr>
155   </table>
156   </dd>
157 </dl>
158 <dl class="section return"><dt>Returns</dt><dd>pointer to the structure of generate box header parameters </dd></dl>
159
160 <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>
161
162 <p class="reference">Referenced by <a class="el" href="boxheader__manager_8h.html#acef0f9dedbcfe391a86a87b5693fda5a">gene_childboxheader()</a>.</p>
163
164 </div>
165 </div>
166 <a id="acef0f9dedbcfe391a86a87b5693fda5a"></a>
167 <h2 class="memtitle"><span class="permalink"><a href="#acef0f9dedbcfe391a86a87b5693fda5a">&#9670;&nbsp;</a></span>gene_childboxheader()</h2>
168
169 <div class="memitem">
170 <div class="memproto">
171       <table class="memname">
172         <tr>
173           <td class="memname"><a class="el" href="boxheader__manager_8h.html#a0df836b5592c4918f1d826a98508a514">boxheader_param_t</a>* gene_childboxheader </td>
174           <td>(</td>
175           <td class="paramtype"><a class="el" href="box__manager_8h.html#a595fedb372a3046632dab041d6b9577c">box_param_t</a> *&#160;</td>
176           <td class="paramname"><em>superbox</em>, </td>
177         </tr>
178         <tr>
179           <td class="paramkey"></td>
180           <td></td>
181           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>&#160;</td>
182           <td class="paramname"><em>offset</em>&#160;</td>
183         </tr>
184         <tr>
185           <td></td>
186           <td>)</td>
187           <td></td><td></td>
188         </tr>
189       </table>
190 </div><div class="memdoc">
191
192 <p>generate a child box header at the given offset </p>
193 <dl class="params"><dt>Parameters</dt><dd>
194   <table class="params">
195     <tr><td class="paramdir">[in]</td><td class="paramname">superbox</td><td>super box pointer </td></tr>
196     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>offset from DBox first byte of superbox </td></tr>
197   </table>
198   </dd>
199 </dl>
200 <dl class="section return"><dt>Returns</dt><dd>pointer to the structure of generate box header parameters </dd></dl>
201
202 <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>
203
204 <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>
205
206 </div>
207 </div>
208 <a id="a366e577597bfcd3e2d8c6db97f802a26"></a>
209 <h2 class="memtitle"><span class="permalink"><a href="#a366e577597bfcd3e2d8c6db97f802a26">&#9670;&nbsp;</a></span>print_boxheader()</h2>
210
211 <div class="memitem">
212 <div class="memproto">
213       <table class="memname">
214         <tr>
215           <td class="memname">void print_boxheader </td>
216           <td>(</td>
217           <td class="paramtype"><a class="el" href="boxheader__manager_8h.html#a0df836b5592c4918f1d826a98508a514">boxheader_param_t</a> *&#160;</td>
218           <td class="paramname"><em>boxheader</em></td><td>)</td>
219           <td></td>
220         </tr>
221       </table>
222 </div><div class="memdoc">
223
224 <p>print box header parameters </p>
225 <dl class="params"><dt>Parameters</dt><dd>
226   <table class="params">
227     <tr><td class="paramdir">[in]</td><td class="paramname">boxheader</td><td>boxheader pointer </td></tr>
228   </table>
229   </dd>
230 </dl>
231
232 <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>
233
234 <p class="reference">Referenced by <a class="el" href="manfbox__manager_8h.html#afffa66277d7b16d789f1c78683f7fc53">print_manfbox()</a>.</p>
235
236 </div>
237 </div>
238 </div><!-- contents -->
239 <!-- start footer part -->
240 <hr class="footer"/><address class="footer"><small>
241 Generated by &#160;<a href="http://www.doxygen.org/index.html">
242 <img class="footer" src="doxygen.png" alt="doxygen"/>
243 </a> 1.8.17
244 </small></address>
245 </body>
246 </html>