Update Doxygen doc
[openjpeg.git] / doxygen / manfbox__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: manfbox_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">manfbox_manager.c File Reference</div>  </div>
56 </div><!--header-->
57 <div class="contents">
58 <div class="textblock"><code>#include &lt;stdlib.h&gt;</code><br />
59 <code>#include &lt;stdio.h&gt;</code><br />
60 <code>#include &lt;string.h&gt;</code><br />
61 <code>#include &quot;<a class="el" href="manfbox__manager_8h_source.html">manfbox_manager.h</a>&quot;</code><br />
62 </div><table class="memberdecls">
63 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
64 Macros</h2></td></tr>
65 <tr class="memitem:ac322e421aefb8ec9ccc10bef953e3d82"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="manfbox__manager_8c.html#ac322e421aefb8ec9ccc10bef953e3d82">FCGI_stdout</a>&#160;&#160;&#160;stdout</td></tr>
66 <tr class="separator:ac322e421aefb8ec9ccc10bef953e3d82"><td class="memSeparator" colspan="2">&#160;</td></tr>
67 <tr class="memitem:a77b5d5af2adb2cfa7ec785b592fc4074"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="manfbox__manager_8c.html#a77b5d5af2adb2cfa7ec785b592fc4074">FCGI_stderr</a>&#160;&#160;&#160;stderr</td></tr>
68 <tr class="separator:a77b5d5af2adb2cfa7ec785b592fc4074"><td class="memSeparator" colspan="2">&#160;</td></tr>
69 <tr class="memitem:a31c99676da88bb0bcdb350710f00fa96"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="manfbox__manager_8c.html#a31c99676da88bb0bcdb350710f00fa96">logstream</a>&#160;&#160;&#160;stderr</td></tr>
70 <tr class="separator:a31c99676da88bb0bcdb350710f00fa96"><td class="memSeparator" colspan="2">&#160;</td></tr>
71 </table><table class="memberdecls">
72 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
73 Functions</h2></td></tr>
74 <tr class="memitem:a7c8a7b0c84e1ad9d858c16ed4888b7f1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="manfbox__manager_8h.html#aeee69ac5ac0899069b9a8fa454d64f6b">manfbox_param_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="manfbox__manager_8c.html#a7c8a7b0c84e1ad9d858c16ed4888b7f1">gene_manfbox</a> (<a class="el" href="box__manager_8h.html#aabc1b43d57961c0e224a518c8b8ca09b">box_param_t</a> *box)</td></tr>
75 <tr class="memdesc:a7c8a7b0c84e1ad9d858c16ed4888b7f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">generate manifest box  <a href="#a7c8a7b0c84e1ad9d858c16ed4888b7f1">More...</a><br /></td></tr>
76 <tr class="separator:a7c8a7b0c84e1ad9d858c16ed4888b7f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
77 <tr class="memitem:a79f039f4170fa5673abd188e4649b717"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="manfbox__manager_8c.html#a79f039f4170fa5673abd188e4649b717">delete_manfbox</a> (<a class="el" href="manfbox__manager_8h.html#aeee69ac5ac0899069b9a8fa454d64f6b">manfbox_param_t</a> **manf)</td></tr>
78 <tr class="memdesc:a79f039f4170fa5673abd188e4649b717"><td class="mdescLeft">&#160;</td><td class="mdescRight">delete manifest box  <a href="#a79f039f4170fa5673abd188e4649b717">More...</a><br /></td></tr>
79 <tr class="separator:a79f039f4170fa5673abd188e4649b717"><td class="memSeparator" colspan="2">&#160;</td></tr>
80 <tr class="memitem:afffa66277d7b16d789f1c78683f7fc53"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="manfbox__manager_8c.html#afffa66277d7b16d789f1c78683f7fc53">print_manfbox</a> (<a class="el" href="manfbox__manager_8h.html#aeee69ac5ac0899069b9a8fa454d64f6b">manfbox_param_t</a> *manf)</td></tr>
81 <tr class="memdesc:afffa66277d7b16d789f1c78683f7fc53"><td class="mdescLeft">&#160;</td><td class="mdescRight">print manf box parameters  <a href="#afffa66277d7b16d789f1c78683f7fc53">More...</a><br /></td></tr>
82 <tr class="separator:afffa66277d7b16d789f1c78683f7fc53"><td class="memSeparator" colspan="2">&#160;</td></tr>
83 <tr class="memitem:a6574f4f07559e5bffc3fafc4a8689249"><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="manfbox__manager_8c.html#a6574f4f07559e5bffc3fafc4a8689249">search_boxheader</a> (const char type[], <a class="el" href="manfbox__manager_8h.html#aeee69ac5ac0899069b9a8fa454d64f6b">manfbox_param_t</a> *manf)</td></tr>
84 <tr class="memdesc:a6574f4f07559e5bffc3fafc4a8689249"><td class="mdescLeft">&#160;</td><td class="mdescRight">search a boxheader by box type from manifest box  <a href="#a6574f4f07559e5bffc3fafc4a8689249">More...</a><br /></td></tr>
85 <tr class="separator:a6574f4f07559e5bffc3fafc4a8689249"><td class="memSeparator" colspan="2">&#160;</td></tr>
86 </table>
87 <h2 class="groupheader">Macro Definition Documentation</h2>
88 <a class="anchor" id="a77b5d5af2adb2cfa7ec785b592fc4074"></a>
89 <div class="memitem">
90 <div class="memproto">
91       <table class="memname">
92         <tr>
93           <td class="memname">#define FCGI_stderr&#160;&#160;&#160;stderr</td>
94         </tr>
95       </table>
96 </div><div class="memdoc">
97
98 <p>Referenced by <a class="el" href="manfbox__manager_8h.html#a6574f4f07559e5bffc3fafc4a8689249">search_boxheader()</a>.</p>
99
100 </div>
101 </div>
102 <a class="anchor" id="ac322e421aefb8ec9ccc10bef953e3d82"></a>
103 <div class="memitem">
104 <div class="memproto">
105       <table class="memname">
106         <tr>
107           <td class="memname">#define FCGI_stdout&#160;&#160;&#160;stdout</td>
108         </tr>
109       </table>
110 </div><div class="memdoc">
111
112 </div>
113 </div>
114 <a class="anchor" id="a31c99676da88bb0bcdb350710f00fa96"></a>
115 <div class="memitem">
116 <div class="memproto">
117       <table class="memname">
118         <tr>
119           <td class="memname">#define logstream&#160;&#160;&#160;stderr</td>
120         </tr>
121       </table>
122 </div><div class="memdoc">
123
124 </div>
125 </div>
126 <h2 class="groupheader">Function Documentation</h2>
127 <a class="anchor" id="a79f039f4170fa5673abd188e4649b717"></a>
128 <div class="memitem">
129 <div class="memproto">
130       <table class="memname">
131         <tr>
132           <td class="memname">void delete_manfbox </td>
133           <td>(</td>
134           <td class="paramtype"><a class="el" href="manfbox__manager_8h.html#aeee69ac5ac0899069b9a8fa454d64f6b">manfbox_param_t</a> **&#160;</td>
135           <td class="paramname"><em>manf</em></td><td>)</td>
136           <td></td>
137         </tr>
138       </table>
139 </div><div class="memdoc">
140
141 <p>delete manifest box </p>
142 <dl class="params"><dt>Parameters</dt><dd>
143   <table class="params">
144     <tr><td class="paramdir">[in,out]</td><td class="paramname">manf</td><td>addressof the manfbox pointer </td></tr>
145   </table>
146   </dd>
147 </dl>
148
149 <p>References <a class="el" href="structboxheader__param.html#a24a521b8c32b65e2354e67191c14f232">boxheader_param::next</a>.</p>
150
151 <p>Referenced by <a class="el" href="index__manager_8c.html#a1bca84a98c266c9da610ebbb5d17e83c">set_cidxdata()</a>, <a class="el" href="index__manager_8c.html#a781af2c59898ceecdffb70004cfaf018">set_ppixdata()</a>, and <a class="el" href="index__manager_8c.html#a5d8213c96df9c2e64b42bfc0f3003141">set_thixdata()</a>.</p>
152
153 </div>
154 </div>
155 <a class="anchor" id="a7c8a7b0c84e1ad9d858c16ed4888b7f1"></a>
156 <div class="memitem">
157 <div class="memproto">
158       <table class="memname">
159         <tr>
160           <td class="memname"><a class="el" href="manfbox__manager_8h.html#aeee69ac5ac0899069b9a8fa454d64f6b">manfbox_param_t</a>* gene_manfbox </td>
161           <td>(</td>
162           <td class="paramtype"><a class="el" href="box__manager_8h.html#aabc1b43d57961c0e224a518c8b8ca09b">box_param_t</a> *&#160;</td>
163           <td class="paramname"><em>box</em></td><td>)</td>
164           <td></td>
165         </tr>
166       </table>
167 </div><div class="memdoc">
168
169 <p>generate manifest box </p>
170 <dl class="params"><dt>Parameters</dt><dd>
171   <table class="params">
172     <tr><td class="paramdir">[in]</td><td class="paramname">box</td><td>pointer to the reference manf box </td></tr>
173   </table>
174   </dd>
175 </dl>
176 <dl class="section return"><dt>Returns</dt><dd>generated manfbox </dd></dl>
177
178 <p>References <a class="el" href="structmanfbox__param.html#a84984a1b9a534a0c88d0667ffe6db3df">manfbox_param::first</a>, <a class="el" href="boxheader__manager_8c.html#acef0f9dedbcfe391a86a87b5693fda5a">gene_childboxheader()</a>, <a class="el" href="box__manager_8c.html#a177899ef17695f68a34abaff3795175c">get_DBoxlen()</a>, <a class="el" href="structboxheader__param.html#aabf782e3d43e158e4477308c11670ac4">boxheader_param::headlen</a>, and <a class="el" href="structboxheader__param.html#a24a521b8c32b65e2354e67191c14f232">boxheader_param::next</a>.</p>
179
180 <p>Referenced by <a class="el" href="index__manager_8c.html#a1bca84a98c266c9da610ebbb5d17e83c">set_cidxdata()</a>, <a class="el" href="index__manager_8c.html#a781af2c59898ceecdffb70004cfaf018">set_ppixdata()</a>, and <a class="el" href="index__manager_8c.html#a5d8213c96df9c2e64b42bfc0f3003141">set_thixdata()</a>.</p>
181
182 </div>
183 </div>
184 <a class="anchor" id="afffa66277d7b16d789f1c78683f7fc53"></a>
185 <div class="memitem">
186 <div class="memproto">
187       <table class="memname">
188         <tr>
189           <td class="memname">void print_manfbox </td>
190           <td>(</td>
191           <td class="paramtype"><a class="el" href="manfbox__manager_8h.html#aeee69ac5ac0899069b9a8fa454d64f6b">manfbox_param_t</a> *&#160;</td>
192           <td class="paramname"><em>manf</em></td><td>)</td>
193           <td></td>
194         </tr>
195       </table>
196 </div><div class="memdoc">
197
198 <p>print manf box parameters </p>
199 <dl class="params"><dt>Parameters</dt><dd>
200   <table class="params">
201     <tr><td class="paramdir">[in]</td><td class="paramname">manf</td><td>manf box pointer </td></tr>
202   </table>
203   </dd>
204 </dl>
205
206 <p>References <a class="el" href="structmanfbox__param.html#a84984a1b9a534a0c88d0667ffe6db3df">manfbox_param::first</a>, <a class="el" href="structboxheader__param.html#a24a521b8c32b65e2354e67191c14f232">boxheader_param::next</a>, and <a class="el" href="boxheader__manager_8c.html#a366e577597bfcd3e2d8c6db97f802a26">print_boxheader()</a>.</p>
207
208 </div>
209 </div>
210 <a class="anchor" id="a6574f4f07559e5bffc3fafc4a8689249"></a>
211 <div class="memitem">
212 <div class="memproto">
213       <table class="memname">
214         <tr>
215           <td class="memname"><a class="el" href="boxheader__manager_8h.html#a52219183b1007413e580aa9ba6504669">boxheader_param_t</a>* search_boxheader </td>
216           <td>(</td>
217           <td class="paramtype">const char&#160;</td>
218           <td class="paramname"><em>type</em>[], </td>
219         </tr>
220         <tr>
221           <td class="paramkey"></td>
222           <td></td>
223           <td class="paramtype"><a class="el" href="manfbox__manager_8h.html#aeee69ac5ac0899069b9a8fa454d64f6b">manfbox_param_t</a> *&#160;</td>
224           <td class="paramname"><em>manf</em>&#160;</td>
225         </tr>
226         <tr>
227           <td></td>
228           <td>)</td>
229           <td></td><td></td>
230         </tr>
231       </table>
232 </div><div class="memdoc">
233
234 <p>search a boxheader by box type from manifest box </p>
235 <dl class="params"><dt>Parameters</dt><dd>
236   <table class="params">
237     <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>box type </td></tr>
238     <tr><td class="paramdir">[in]</td><td class="paramname">manf</td><td>manf box pointer </td></tr>
239   </table>
240   </dd>
241 </dl>
242 <dl class="section return"><dt>Returns</dt><dd>found box pointer </dd></dl>
243
244 <p>References <a class="el" href="manfbox__manager_8c.html#a77b5d5af2adb2cfa7ec785b592fc4074">FCGI_stderr</a>, <a class="el" href="structmanfbox__param.html#a84984a1b9a534a0c88d0667ffe6db3df">manfbox_param::first</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>
245
246 <p>Referenced by <a class="el" href="index__manager_8c.html#a1bca84a98c266c9da610ebbb5d17e83c">set_cidxdata()</a>, and <a class="el" href="index__manager_8c.html#a781af2c59898ceecdffb70004cfaf018">set_ppixdata()</a>.</p>
247
248 </div>
249 </div>
250 </div><!-- contents -->
251 <!-- start footer part -->
252 <hr class="footer"/><address class="footer"><small>
253 Generated by &#160;<a href="http://www.doxygen.org/index.html">
254 <img class="footer" src="doxygen.png" alt="doxygen"/>
255 </a> 1.8.10
256 </small></address>
257 </body>
258 </html>