Update doxygen for release 2.3.1
[openjpeg.git] / doxygen / boxheader__manager_8c.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.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.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="#define-members">Macros</a> &#124;
47 <a href="#func-members">Functions</a>  </div>
48   <div class="headertitle">
49 <div class="title">boxheader_manager.c File Reference</div>  </div>
50 </div><!--header-->
51 <div class="contents">
52 <div class="textblock"><code>#include &lt;stdio.h&gt;</code><br />
53 <code>#include &lt;stdlib.h&gt;</code><br />
54 <code>#include &lt;string.h&gt;</code><br />
55 <code>#include &quot;<a class="el" href="boxheader__manager_8h_source.html">boxheader_manager.h</a>&quot;</code><br />
56 <code>#include &quot;<a class="el" href="opj__inttypes_8h_source.html">opj_inttypes.h</a>&quot;</code><br />
57 </div><table class="memberdecls">
58 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
59 Macros</h2></td></tr>
60 <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>
61 <tr class="separator:ac322e421aefb8ec9ccc10bef953e3d82"><td class="memSeparator" colspan="2">&#160;</td></tr>
62 <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>
63 <tr class="separator:a77b5d5af2adb2cfa7ec785b592fc4074"><td class="memSeparator" colspan="2">&#160;</td></tr>
64 <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>
65 <tr class="separator:a31c99676da88bb0bcdb350710f00fa96"><td class="memSeparator" colspan="2">&#160;</td></tr>
66 </table><table class="memberdecls">
67 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
68 Functions</h2></td></tr>
69 <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_8c.html#ad67b5454e29ddcd711d07eaddbe29f67">gene_boxheader</a> (int fd, <a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset)</td></tr>
70 <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>
71 <tr class="separator:ad67b5454e29ddcd711d07eaddbe29f67"><td class="memSeparator" colspan="2">&#160;</td></tr>
72 <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_8c.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>
73 <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>
74 <tr class="separator:acef0f9dedbcfe391a86a87b5693fda5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
75 <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#a52219183b1007413e580aa9ba6504669">boxheader_param_t</a> *boxheader)</td></tr>
76 <tr class="memdesc:a366e577597bfcd3e2d8c6db97f802a26"><td class="mdescLeft">&#160;</td><td class="mdescRight">print box header parameters  <a href="#a366e577597bfcd3e2d8c6db97f802a26">More...</a><br /></td></tr>
77 <tr class="separator:a366e577597bfcd3e2d8c6db97f802a26"><td class="memSeparator" colspan="2">&#160;</td></tr>
78 </table>
79 <h2 class="groupheader">Macro Definition Documentation</h2>
80 <a id="a77b5d5af2adb2cfa7ec785b592fc4074"></a>
81 <h2 class="memtitle"><span class="permalink"><a href="#a77b5d5af2adb2cfa7ec785b592fc4074">&#9670;&nbsp;</a></span>FCGI_stderr</h2>
82
83 <div class="memitem">
84 <div class="memproto">
85       <table class="memname">
86         <tr>
87           <td class="memname">#define FCGI_stderr&#160;&#160;&#160;stderr</td>
88         </tr>
89       </table>
90 </div><div class="memdoc">
91
92 </div>
93 </div>
94 <a id="ac322e421aefb8ec9ccc10bef953e3d82"></a>
95 <h2 class="memtitle"><span class="permalink"><a href="#ac322e421aefb8ec9ccc10bef953e3d82">&#9670;&nbsp;</a></span>FCGI_stdout</h2>
96
97 <div class="memitem">
98 <div class="memproto">
99       <table class="memname">
100         <tr>
101           <td class="memname">#define FCGI_stdout&#160;&#160;&#160;stdout</td>
102         </tr>
103       </table>
104 </div><div class="memdoc">
105
106 </div>
107 </div>
108 <a id="a31c99676da88bb0bcdb350710f00fa96"></a>
109 <h2 class="memtitle"><span class="permalink"><a href="#a31c99676da88bb0bcdb350710f00fa96">&#9670;&nbsp;</a></span>logstream</h2>
110
111 <div class="memitem">
112 <div class="memproto">
113       <table class="memname">
114         <tr>
115           <td class="memname">#define logstream&#160;&#160;&#160;stderr</td>
116         </tr>
117       </table>
118 </div><div class="memdoc">
119
120 <p class="reference">Referenced by <a class="el" href="boxheader__manager_8h.html#a366e577597bfcd3e2d8c6db97f802a26">print_boxheader()</a>.</p>
121
122 </div>
123 </div>
124 <h2 class="groupheader">Function Documentation</h2>
125 <a id="ad67b5454e29ddcd711d07eaddbe29f67"></a>
126 <h2 class="memtitle"><span class="permalink"><a href="#ad67b5454e29ddcd711d07eaddbe29f67">&#9670;&nbsp;</a></span>gene_boxheader()</h2>
127
128 <div class="memitem">
129 <div class="memproto">
130       <table class="memname">
131         <tr>
132           <td class="memname"><a class="el" href="boxheader__manager_8h.html#a52219183b1007413e580aa9ba6504669">boxheader_param_t</a>* gene_boxheader </td>
133           <td>(</td>
134           <td class="paramtype">int&#160;</td>
135           <td class="paramname"><em>fd</em>, </td>
136         </tr>
137         <tr>
138           <td class="paramkey"></td>
139           <td></td>
140           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>&#160;</td>
141           <td class="paramname"><em>offset</em>&#160;</td>
142         </tr>
143         <tr>
144           <td></td>
145           <td>)</td>
146           <td></td><td></td>
147         </tr>
148       </table>
149 </div><div class="memdoc">
150
151 <p>generate a box header at the given offset </p>
152 <dl class="params"><dt>Parameters</dt><dd>
153   <table class="params">
154     <tr><td class="paramdir">[in]</td><td class="paramname">fd</td><td>file discriptor of the JP2 file </td></tr>
155     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>Box offset </td></tr>
156   </table>
157   </dd>
158 </dl>
159 <dl class="section return"><dt>Returns</dt><dd>pointer to the structure of generate box header parameters </dd></dl>
160
161 <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>
162
163 <p class="reference">Referenced by <a class="el" href="boxheader__manager_8h.html#acef0f9dedbcfe391a86a87b5693fda5a">gene_childboxheader()</a>.</p>
164
165 </div>
166 </div>
167 <a id="acef0f9dedbcfe391a86a87b5693fda5a"></a>
168 <h2 class="memtitle"><span class="permalink"><a href="#acef0f9dedbcfe391a86a87b5693fda5a">&#9670;&nbsp;</a></span>gene_childboxheader()</h2>
169
170 <div class="memitem">
171 <div class="memproto">
172       <table class="memname">
173         <tr>
174           <td class="memname"><a class="el" href="boxheader__manager_8h.html#a52219183b1007413e580aa9ba6504669">boxheader_param_t</a>* gene_childboxheader </td>
175           <td>(</td>
176           <td class="paramtype"><a class="el" href="box__manager_8h.html#aabc1b43d57961c0e224a518c8b8ca09b">box_param_t</a> *&#160;</td>
177           <td class="paramname"><em>superbox</em>, </td>
178         </tr>
179         <tr>
180           <td class="paramkey"></td>
181           <td></td>
182           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>&#160;</td>
183           <td class="paramname"><em>offset</em>&#160;</td>
184         </tr>
185         <tr>
186           <td></td>
187           <td>)</td>
188           <td></td><td></td>
189         </tr>
190       </table>
191 </div><div class="memdoc">
192
193 <p>generate a child box header at the given offset </p>
194 <dl class="params"><dt>Parameters</dt><dd>
195   <table class="params">
196     <tr><td class="paramdir">[in]</td><td class="paramname">superbox</td><td>super box pointer </td></tr>
197     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>offset from DBox first byte of superbox </td></tr>
198   </table>
199   </dd>
200 </dl>
201 <dl class="section return"><dt>Returns</dt><dd>pointer to the structure of generate box header parameters </dd></dl>
202
203 <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>
204
205 <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>
206
207 </div>
208 </div>
209 <a id="a366e577597bfcd3e2d8c6db97f802a26"></a>
210 <h2 class="memtitle"><span class="permalink"><a href="#a366e577597bfcd3e2d8c6db97f802a26">&#9670;&nbsp;</a></span>print_boxheader()</h2>
211
212 <div class="memitem">
213 <div class="memproto">
214       <table class="memname">
215         <tr>
216           <td class="memname">void print_boxheader </td>
217           <td>(</td>
218           <td class="paramtype"><a class="el" href="boxheader__manager_8h.html#a52219183b1007413e580aa9ba6504669">boxheader_param_t</a> *&#160;</td>
219           <td class="paramname"><em>boxheader</em></td><td>)</td>
220           <td></td>
221         </tr>
222       </table>
223 </div><div class="memdoc">
224
225 <p>print box header parameters </p>
226 <dl class="params"><dt>Parameters</dt><dd>
227   <table class="params">
228     <tr><td class="paramdir">[in]</td><td class="paramname">boxheader</td><td>boxheader pointer </td></tr>
229   </table>
230   </dd>
231 </dl>
232
233 <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>
234
235 <p class="reference">Referenced by <a class="el" href="manfbox__manager_8h.html#afffa66277d7b16d789f1c78683f7fc53">print_manfbox()</a>.</p>
236
237 </div>
238 </div>
239 </div><!-- contents -->
240 <!-- start footer part -->
241 <hr class="footer"/><address class="footer"><small>
242 Generated by &#160;<a href="http://www.doxygen.org/index.html">
243 <img class="footer" src="doxygen.png" alt="doxygen"/>
244 </a> 1.8.13
245 </small></address>
246 </body>
247 </html>