Update ABI/API compatibility reports after commit 4e5501b3c72a98b3117e68263afb922092c...
[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.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>OpenJPEG: manfbox_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">manfbox_manager.c File Reference</div>  </div>
50 </div><!--header-->
51 <div class="contents">
52 <div class="textblock"><code>#include &lt;stdlib.h&gt;</code><br />
53 <code>#include &lt;stdio.h&gt;</code><br />
54 <code>#include &lt;string.h&gt;</code><br />
55 <code>#include &quot;<a class="el" href="manfbox__manager_8h_source.html">manfbox_manager.h</a>&quot;</code><br />
56 </div><table class="memberdecls">
57 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
58 Macros</h2></td></tr>
59 <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>
60 <tr class="separator:ac322e421aefb8ec9ccc10bef953e3d82"><td class="memSeparator" colspan="2">&#160;</td></tr>
61 <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>
62 <tr class="separator:a77b5d5af2adb2cfa7ec785b592fc4074"><td class="memSeparator" colspan="2">&#160;</td></tr>
63 <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>
64 <tr class="separator:a31c99676da88bb0bcdb350710f00fa96"><td class="memSeparator" colspan="2">&#160;</td></tr>
65 </table><table class="memberdecls">
66 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
67 Functions</h2></td></tr>
68 <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>
69 <tr class="memdesc:a7c8a7b0c84e1ad9d858c16ed4888b7f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">generate manifest box  <a href="#a7c8a7b0c84e1ad9d858c16ed4888b7f1">More...</a><br /></td></tr>
70 <tr class="separator:a7c8a7b0c84e1ad9d858c16ed4888b7f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
71 <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>
72 <tr class="memdesc:a79f039f4170fa5673abd188e4649b717"><td class="mdescLeft">&#160;</td><td class="mdescRight">delete manifest box  <a href="#a79f039f4170fa5673abd188e4649b717">More...</a><br /></td></tr>
73 <tr class="separator:a79f039f4170fa5673abd188e4649b717"><td class="memSeparator" colspan="2">&#160;</td></tr>
74 <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>
75 <tr class="memdesc:afffa66277d7b16d789f1c78683f7fc53"><td class="mdescLeft">&#160;</td><td class="mdescRight">print manf box parameters  <a href="#afffa66277d7b16d789f1c78683f7fc53">More...</a><br /></td></tr>
76 <tr class="separator:afffa66277d7b16d789f1c78683f7fc53"><td class="memSeparator" colspan="2">&#160;</td></tr>
77 <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>
78 <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>
79 <tr class="separator:a6574f4f07559e5bffc3fafc4a8689249"><td class="memSeparator" colspan="2">&#160;</td></tr>
80 </table>
81 <h2 class="groupheader">Macro Definition Documentation</h2>
82 <a id="a77b5d5af2adb2cfa7ec785b592fc4074"></a>
83 <h2 class="memtitle"><span class="permalink"><a href="#a77b5d5af2adb2cfa7ec785b592fc4074">&#9670;&nbsp;</a></span>FCGI_stderr</h2>
84
85 <div class="memitem">
86 <div class="memproto">
87       <table class="memname">
88         <tr>
89           <td class="memname">#define FCGI_stderr&#160;&#160;&#160;stderr</td>
90         </tr>
91       </table>
92 </div><div class="memdoc">
93
94 <p class="reference">Referenced by <a class="el" href="manfbox__manager_8h.html#a6574f4f07559e5bffc3fafc4a8689249">search_boxheader()</a>.</p>
95
96 </div>
97 </div>
98 <a id="ac322e421aefb8ec9ccc10bef953e3d82"></a>
99 <h2 class="memtitle"><span class="permalink"><a href="#ac322e421aefb8ec9ccc10bef953e3d82">&#9670;&nbsp;</a></span>FCGI_stdout</h2>
100
101 <div class="memitem">
102 <div class="memproto">
103       <table class="memname">
104         <tr>
105           <td class="memname">#define FCGI_stdout&#160;&#160;&#160;stdout</td>
106         </tr>
107       </table>
108 </div><div class="memdoc">
109
110 </div>
111 </div>
112 <a id="a31c99676da88bb0bcdb350710f00fa96"></a>
113 <h2 class="memtitle"><span class="permalink"><a href="#a31c99676da88bb0bcdb350710f00fa96">&#9670;&nbsp;</a></span>logstream</h2>
114
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 id="a79f039f4170fa5673abd188e4649b717"></a>
128 <h2 class="memtitle"><span class="permalink"><a href="#a79f039f4170fa5673abd188e4649b717">&#9670;&nbsp;</a></span>delete_manfbox()</h2>
129
130 <div class="memitem">
131 <div class="memproto">
132       <table class="memname">
133         <tr>
134           <td class="memname">void delete_manfbox </td>
135           <td>(</td>
136           <td class="paramtype"><a class="el" href="manfbox__manager_8h.html#aeee69ac5ac0899069b9a8fa454d64f6b">manfbox_param_t</a> **&#160;</td>
137           <td class="paramname"><em>manf</em></td><td>)</td>
138           <td></td>
139         </tr>
140       </table>
141 </div><div class="memdoc">
142
143 <p>delete manifest box </p>
144 <dl class="params"><dt>Parameters</dt><dd>
145   <table class="params">
146     <tr><td class="paramdir">[in,out]</td><td class="paramname">manf</td><td>addressof the manfbox pointer </td></tr>
147   </table>
148   </dd>
149 </dl>
150
151 <p class="reference">References <a class="el" href="structboxheader__param.html#a24a521b8c32b65e2354e67191c14f232">boxheader_param::next</a>.</p>
152
153 <p class="reference">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>
154
155 </div>
156 </div>
157 <a id="a7c8a7b0c84e1ad9d858c16ed4888b7f1"></a>
158 <h2 class="memtitle"><span class="permalink"><a href="#a7c8a7b0c84e1ad9d858c16ed4888b7f1">&#9670;&nbsp;</a></span>gene_manfbox()</h2>
159
160 <div class="memitem">
161 <div class="memproto">
162       <table class="memname">
163         <tr>
164           <td class="memname"><a class="el" href="manfbox__manager_8h.html#aeee69ac5ac0899069b9a8fa454d64f6b">manfbox_param_t</a>* gene_manfbox </td>
165           <td>(</td>
166           <td class="paramtype"><a class="el" href="box__manager_8h.html#aabc1b43d57961c0e224a518c8b8ca09b">box_param_t</a> *&#160;</td>
167           <td class="paramname"><em>box</em></td><td>)</td>
168           <td></td>
169         </tr>
170       </table>
171 </div><div class="memdoc">
172
173 <p>generate manifest box </p>
174 <dl class="params"><dt>Parameters</dt><dd>
175   <table class="params">
176     <tr><td class="paramdir">[in]</td><td class="paramname">box</td><td>pointer to the reference manf box </td></tr>
177   </table>
178   </dd>
179 </dl>
180 <dl class="section return"><dt>Returns</dt><dd>generated manfbox </dd></dl>
181
182 <p class="reference">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>
183
184 <p class="reference">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>
185
186 </div>
187 </div>
188 <a id="afffa66277d7b16d789f1c78683f7fc53"></a>
189 <h2 class="memtitle"><span class="permalink"><a href="#afffa66277d7b16d789f1c78683f7fc53">&#9670;&nbsp;</a></span>print_manfbox()</h2>
190
191 <div class="memitem">
192 <div class="memproto">
193       <table class="memname">
194         <tr>
195           <td class="memname">void print_manfbox </td>
196           <td>(</td>
197           <td class="paramtype"><a class="el" href="manfbox__manager_8h.html#aeee69ac5ac0899069b9a8fa454d64f6b">manfbox_param_t</a> *&#160;</td>
198           <td class="paramname"><em>manf</em></td><td>)</td>
199           <td></td>
200         </tr>
201       </table>
202 </div><div class="memdoc">
203
204 <p>print manf box parameters </p>
205 <dl class="params"><dt>Parameters</dt><dd>
206   <table class="params">
207     <tr><td class="paramdir">[in]</td><td class="paramname">manf</td><td>manf box pointer </td></tr>
208   </table>
209   </dd>
210 </dl>
211
212 <p class="reference">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>
213
214 </div>
215 </div>
216 <a id="a6574f4f07559e5bffc3fafc4a8689249"></a>
217 <h2 class="memtitle"><span class="permalink"><a href="#a6574f4f07559e5bffc3fafc4a8689249">&#9670;&nbsp;</a></span>search_boxheader()</h2>
218
219 <div class="memitem">
220 <div class="memproto">
221       <table class="memname">
222         <tr>
223           <td class="memname"><a class="el" href="boxheader__manager_8h.html#a52219183b1007413e580aa9ba6504669">boxheader_param_t</a>* search_boxheader </td>
224           <td>(</td>
225           <td class="paramtype">const char&#160;</td>
226           <td class="paramname"><em>type</em>[], </td>
227         </tr>
228         <tr>
229           <td class="paramkey"></td>
230           <td></td>
231           <td class="paramtype"><a class="el" href="manfbox__manager_8h.html#aeee69ac5ac0899069b9a8fa454d64f6b">manfbox_param_t</a> *&#160;</td>
232           <td class="paramname"><em>manf</em>&#160;</td>
233         </tr>
234         <tr>
235           <td></td>
236           <td>)</td>
237           <td></td><td></td>
238         </tr>
239       </table>
240 </div><div class="memdoc">
241
242 <p>search a boxheader by box type from manifest box </p>
243 <dl class="params"><dt>Parameters</dt><dd>
244   <table class="params">
245     <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>box type </td></tr>
246     <tr><td class="paramdir">[in]</td><td class="paramname">manf</td><td>manf box pointer </td></tr>
247   </table>
248   </dd>
249 </dl>
250 <dl class="section return"><dt>Returns</dt><dd>found box pointer </dd></dl>
251
252 <p class="reference">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>
253
254 <p class="reference">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>
255
256 </div>
257 </div>
258 </div><!-- contents -->
259 <!-- start footer part -->
260 <hr class="footer"/><address class="footer"><small>
261 Generated by &#160;<a href="http://www.doxygen.org/index.html">
262 <img class="footer" src="doxygen.png" alt="doxygen"/>
263 </a> 1.8.13
264 </small></address>
265 </body>
266 </html>