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