Update Doxygen doc
[openjpeg.git] / doxygen / mhixbox__manager_8h.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: mhixbox_manager.h 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="#nested-classes">Data Structures</a> &#124;
53 <a href="#typedef-members">Typedefs</a> &#124;
54 <a href="#func-members">Functions</a>  </div>
55   <div class="headertitle">
56 <div class="title">mhixbox_manager.h File Reference</div>  </div>
57 </div><!--header-->
58 <div class="contents">
59 <div class="textblock"><code>#include &quot;<a class="el" href="byte__manager_8h_source.html">byte_manager.h</a>&quot;</code><br />
60 <code>#include &quot;<a class="el" href="box__manager_8h_source.html">box_manager.h</a>&quot;</code><br />
61 </div>
62 <p><a href="mhixbox__manager_8h_source.html">Go to the source code of this file.</a></p>
63 <table class="memberdecls">
64 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
65 Data Structures</h2></td></tr>
66 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmarkeridx__param.html">markeridx_param</a></td></tr>
67 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Marker index parameters.  <a href="structmarkeridx__param.html#details">More...</a><br /></td></tr>
68 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
69 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmhixbox__param.html">mhixbox_param</a></td></tr>
70 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">header index table box parameters  <a href="structmhixbox__param.html#details">More...</a><br /></td></tr>
71 <tr class="separator:"><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="typedef-members"></a>
74 Typedefs</h2></td></tr>
75 <tr class="memitem:a84577a8a4efa8188c74fb2c90f5e3c4b"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structmarkeridx__param.html">markeridx_param</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mhixbox__manager_8h.html#a84577a8a4efa8188c74fb2c90f5e3c4b">markeridx_param_t</a></td></tr>
76 <tr class="memdesc:a84577a8a4efa8188c74fb2c90f5e3c4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Marker index parameters.  <a href="#a84577a8a4efa8188c74fb2c90f5e3c4b">More...</a><br /></td></tr>
77 <tr class="separator:a84577a8a4efa8188c74fb2c90f5e3c4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
78 <tr class="memitem:affa3bc2302f0306a416f721b6c29f296"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structmhixbox__param.html">mhixbox_param</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mhixbox__manager_8h.html#affa3bc2302f0306a416f721b6c29f296">mhixbox_param_t</a></td></tr>
79 <tr class="memdesc:affa3bc2302f0306a416f721b6c29f296"><td class="mdescLeft">&#160;</td><td class="mdescRight">header index table box parameters  <a href="#affa3bc2302f0306a416f721b6c29f296">More...</a><br /></td></tr>
80 <tr class="separator:affa3bc2302f0306a416f721b6c29f296"><td class="memSeparator" colspan="2">&#160;</td></tr>
81 </table><table class="memberdecls">
82 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
83 Functions</h2></td></tr>
84 <tr class="memitem:ab3cc1c5943e32e078257f5b386f6b32b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mhixbox__manager_8h.html#affa3bc2302f0306a416f721b6c29f296">mhixbox_param_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mhixbox__manager_8h.html#ab3cc1c5943e32e078257f5b386f6b32b">gene_mhixbox</a> (<a class="el" href="box__manager_8h.html#aabc1b43d57961c0e224a518c8b8ca09b">box_param_t</a> *box)</td></tr>
85 <tr class="memdesc:ab3cc1c5943e32e078257f5b386f6b32b"><td class="mdescLeft">&#160;</td><td class="mdescRight">generate mhix box  <a href="#ab3cc1c5943e32e078257f5b386f6b32b">More...</a><br /></td></tr>
86 <tr class="separator:ab3cc1c5943e32e078257f5b386f6b32b"><td class="memSeparator" colspan="2">&#160;</td></tr>
87 <tr class="memitem:a694ec5436b961330f721653a4b3927cd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mhixbox__manager_8h.html#a84577a8a4efa8188c74fb2c90f5e3c4b">markeridx_param_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mhixbox__manager_8h.html#a694ec5436b961330f721653a4b3927cd">search_markeridx</a> (<a class="el" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> code, <a class="el" href="mhixbox__manager_8h.html#affa3bc2302f0306a416f721b6c29f296">mhixbox_param_t</a> *mhix)</td></tr>
88 <tr class="memdesc:a694ec5436b961330f721653a4b3927cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">search a marker index by marker code from mhix box  <a href="#a694ec5436b961330f721653a4b3927cd">More...</a><br /></td></tr>
89 <tr class="separator:a694ec5436b961330f721653a4b3927cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
90 <tr class="memitem:a2639dde4d8531a6c04887b46cded28c5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mhixbox__manager_8h.html#a2639dde4d8531a6c04887b46cded28c5">print_mhixbox</a> (<a class="el" href="mhixbox__manager_8h.html#affa3bc2302f0306a416f721b6c29f296">mhixbox_param_t</a> *mhix)</td></tr>
91 <tr class="memdesc:a2639dde4d8531a6c04887b46cded28c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">print mhix box parameters  <a href="#a2639dde4d8531a6c04887b46cded28c5">More...</a><br /></td></tr>
92 <tr class="separator:a2639dde4d8531a6c04887b46cded28c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
93 <tr class="memitem:a34a0d2a8641d9069cfc200df0fa55632"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mhixbox__manager_8h.html#a34a0d2a8641d9069cfc200df0fa55632">print_markeridx</a> (<a class="el" href="mhixbox__manager_8h.html#a84577a8a4efa8188c74fb2c90f5e3c4b">markeridx_param_t</a> *markeridx)</td></tr>
94 <tr class="memdesc:a34a0d2a8641d9069cfc200df0fa55632"><td class="mdescLeft">&#160;</td><td class="mdescRight">print marker index parameters  <a href="#a34a0d2a8641d9069cfc200df0fa55632">More...</a><br /></td></tr>
95 <tr class="separator:a34a0d2a8641d9069cfc200df0fa55632"><td class="memSeparator" colspan="2">&#160;</td></tr>
96 <tr class="memitem:a93e96cdf2beb6d3a4d5f30e462e2c079"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mhixbox__manager_8h.html#a93e96cdf2beb6d3a4d5f30e462e2c079">delete_mhixbox</a> (<a class="el" href="mhixbox__manager_8h.html#affa3bc2302f0306a416f721b6c29f296">mhixbox_param_t</a> **mhix)</td></tr>
97 <tr class="memdesc:a93e96cdf2beb6d3a4d5f30e462e2c079"><td class="mdescLeft">&#160;</td><td class="mdescRight">delete mhix box  <a href="#a93e96cdf2beb6d3a4d5f30e462e2c079">More...</a><br /></td></tr>
98 <tr class="separator:a93e96cdf2beb6d3a4d5f30e462e2c079"><td class="memSeparator" colspan="2">&#160;</td></tr>
99 </table>
100 <h2 class="groupheader">Typedef Documentation</h2>
101 <a class="anchor" id="a84577a8a4efa8188c74fb2c90f5e3c4b"></a>
102 <div class="memitem">
103 <div class="memproto">
104       <table class="memname">
105         <tr>
106           <td class="memname">typedef struct <a class="el" href="structmarkeridx__param.html">markeridx_param</a>  <a class="el" href="mhixbox__manager_8h.html#a84577a8a4efa8188c74fb2c90f5e3c4b">markeridx_param_t</a></td>
107         </tr>
108       </table>
109 </div><div class="memdoc">
110
111 <p>Marker index parameters. </p>
112
113 </div>
114 </div>
115 <a class="anchor" id="affa3bc2302f0306a416f721b6c29f296"></a>
116 <div class="memitem">
117 <div class="memproto">
118       <table class="memname">
119         <tr>
120           <td class="memname">typedef struct <a class="el" href="structmhixbox__param.html">mhixbox_param</a>  <a class="el" href="mhixbox__manager_8h.html#affa3bc2302f0306a416f721b6c29f296">mhixbox_param_t</a></td>
121         </tr>
122       </table>
123 </div><div class="memdoc">
124
125 <p>header index table box parameters </p>
126 <p>I.3.2.4.3 Header Index Table box </p>
127
128 </div>
129 </div>
130 <h2 class="groupheader">Function Documentation</h2>
131 <a class="anchor" id="a93e96cdf2beb6d3a4d5f30e462e2c079"></a>
132 <div class="memitem">
133 <div class="memproto">
134       <table class="memname">
135         <tr>
136           <td class="memname">void delete_mhixbox </td>
137           <td>(</td>
138           <td class="paramtype"><a class="el" href="mhixbox__manager_8h.html#affa3bc2302f0306a416f721b6c29f296">mhixbox_param_t</a> **&#160;</td>
139           <td class="paramname"><em>mhix</em></td><td>)</td>
140           <td></td>
141         </tr>
142       </table>
143 </div><div class="memdoc">
144
145 <p>delete mhix box </p>
146 <dl class="params"><dt>Parameters</dt><dd>
147   <table class="params">
148     <tr><td class="paramdir">[in,out]</td><td class="paramname">mhix</td><td>address of the mhix box pointer </td></tr>
149   </table>
150   </dd>
151 </dl>
152
153 <p>References <a class="el" href="structmarkeridx__param.html#a96fec3389030014de88eeedc0ec41bf9">markeridx_param::next</a>.</p>
154
155 <p>Referenced by <a class="el" href="index__manager_8h.html#a8547a6683f5846c256ed1a0b5a55ad29">delete_index()</a>, and <a class="el" href="index__manager_8c.html#a73ddf4f40d7da955735a4fdb9b2c1d80">set_mainmhixdata()</a>.</p>
156
157 </div>
158 </div>
159 <a class="anchor" id="ab3cc1c5943e32e078257f5b386f6b32b"></a>
160 <div class="memitem">
161 <div class="memproto">
162       <table class="memname">
163         <tr>
164           <td class="memname"><a class="el" href="mhixbox__manager_8h.html#affa3bc2302f0306a416f721b6c29f296">mhixbox_param_t</a>* gene_mhixbox </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 mhix 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 mhix box </td></tr>
177   </table>
178   </dd>
179 </dl>
180 <dl class="section return"><dt>Returns</dt><dd>generated mhixbox pointer </dd></dl>
181
182 <p>References <a class="el" href="structmarkeridx__param.html#a67f2cbaad816454e3137ad669289f4f0">markeridx_param::code</a>, <a class="el" href="box__manager_8c.html#a28a029e965842146cac12fcf05757c66">fetch_DBox2bytebigendian()</a>, <a class="el" href="box__manager_8c.html#a46342c34b100e9174966f70bf36936ef">fetch_DBox8bytebigendian()</a>, <a class="el" href="structmhixbox__param.html#a51b8cd55ab497445287933e5be101584">mhixbox_param::first</a>, <a class="el" href="box__manager_8c.html#a177899ef17695f68a34abaff3795175c">get_DBoxlen()</a>, <a class="el" href="structmarkeridx__param.html#ab8f8d7d018e9a8030a231cbfad67ca92">markeridx_param::length</a>, <a class="el" href="structmarkeridx__param.html#a96fec3389030014de88eeedc0ec41bf9">markeridx_param::next</a>, <a class="el" href="structmarkeridx__param.html#af25341650e6cb6e073ca9ed12fcd86ae">markeridx_param::num_remain</a>, <a class="el" href="structmarkeridx__param.html#af6076115fd1d74ad8ff0faaa12c35913">markeridx_param::offset</a>, and <a class="el" href="structmhixbox__param.html#ab48436449e3e05c4e44a246b095afdd9">mhixbox_param::tlen</a>.</p>
183
184 <p>Referenced by <a class="el" href="index__manager_8c.html#a73ddf4f40d7da955735a4fdb9b2c1d80">set_mainmhixdata()</a>, and <a class="el" href="index__manager_8c.html#a5d8213c96df9c2e64b42bfc0f3003141">set_thixdata()</a>.</p>
185
186 </div>
187 </div>
188 <a class="anchor" id="a34a0d2a8641d9069cfc200df0fa55632"></a>
189 <div class="memitem">
190 <div class="memproto">
191       <table class="memname">
192         <tr>
193           <td class="memname">void print_markeridx </td>
194           <td>(</td>
195           <td class="paramtype"><a class="el" href="mhixbox__manager_8h.html#a84577a8a4efa8188c74fb2c90f5e3c4b">markeridx_param_t</a> *&#160;</td>
196           <td class="paramname"><em>markeridx</em></td><td>)</td>
197           <td></td>
198         </tr>
199       </table>
200 </div><div class="memdoc">
201
202 <p>print marker index parameters </p>
203 <dl class="params"><dt>Parameters</dt><dd>
204   <table class="params">
205     <tr><td class="paramdir">[in]</td><td class="paramname">markeridx</td><td>marker index pointer </td></tr>
206   </table>
207   </dd>
208 </dl>
209
210 <p>References <a class="el" href="structmarkeridx__param.html#a67f2cbaad816454e3137ad669289f4f0">markeridx_param::code</a>, <a class="el" href="structmarkeridx__param.html#ab8f8d7d018e9a8030a231cbfad67ca92">markeridx_param::length</a>, <a class="el" href="mhixbox__manager_8c.html#a31c99676da88bb0bcdb350710f00fa96">logstream</a>, <a class="el" href="structmarkeridx__param.html#af25341650e6cb6e073ca9ed12fcd86ae">markeridx_param::num_remain</a>, and <a class="el" href="structmarkeridx__param.html#af6076115fd1d74ad8ff0faaa12c35913">markeridx_param::offset</a>.</p>
211
212 </div>
213 </div>
214 <a class="anchor" id="a2639dde4d8531a6c04887b46cded28c5"></a>
215 <div class="memitem">
216 <div class="memproto">
217       <table class="memname">
218         <tr>
219           <td class="memname">void print_mhixbox </td>
220           <td>(</td>
221           <td class="paramtype"><a class="el" href="mhixbox__manager_8h.html#affa3bc2302f0306a416f721b6c29f296">mhixbox_param_t</a> *&#160;</td>
222           <td class="paramname"><em>mhix</em></td><td>)</td>
223           <td></td>
224         </tr>
225       </table>
226 </div><div class="memdoc">
227
228 <p>print mhix box parameters </p>
229 <dl class="params"><dt>Parameters</dt><dd>
230   <table class="params">
231     <tr><td class="paramdir">[in]</td><td class="paramname">mhix</td><td>mhix box pointer </td></tr>
232   </table>
233   </dd>
234 </dl>
235
236 <p>References <a class="el" href="structmarkeridx__param.html#a67f2cbaad816454e3137ad669289f4f0">markeridx_param::code</a>, <a class="el" href="structmhixbox__param.html#a51b8cd55ab497445287933e5be101584">mhixbox_param::first</a>, <a class="el" href="structmarkeridx__param.html#ab8f8d7d018e9a8030a231cbfad67ca92">markeridx_param::length</a>, <a class="el" href="mhixbox__manager_8c.html#a31c99676da88bb0bcdb350710f00fa96">logstream</a>, <a class="el" href="structmarkeridx__param.html#a96fec3389030014de88eeedc0ec41bf9">markeridx_param::next</a>, <a class="el" href="structmarkeridx__param.html#af25341650e6cb6e073ca9ed12fcd86ae">markeridx_param::num_remain</a>, <a class="el" href="structmarkeridx__param.html#af6076115fd1d74ad8ff0faaa12c35913">markeridx_param::offset</a>, and <a class="el" href="structmhixbox__param.html#ab48436449e3e05c4e44a246b095afdd9">mhixbox_param::tlen</a>.</p>
237
238 <p>Referenced by <a class="el" href="index__manager_8h.html#acba4fd559491e3b10a80e0d14839c8bf">print_index()</a>.</p>
239
240 </div>
241 </div>
242 <a class="anchor" id="a694ec5436b961330f721653a4b3927cd"></a>
243 <div class="memitem">
244 <div class="memproto">
245       <table class="memname">
246         <tr>
247           <td class="memname"><a class="el" href="mhixbox__manager_8h.html#a84577a8a4efa8188c74fb2c90f5e3c4b">markeridx_param_t</a>* search_markeridx </td>
248           <td>(</td>
249           <td class="paramtype"><a class="el" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a>&#160;</td>
250           <td class="paramname"><em>code</em>, </td>
251         </tr>
252         <tr>
253           <td class="paramkey"></td>
254           <td></td>
255           <td class="paramtype"><a class="el" href="mhixbox__manager_8h.html#affa3bc2302f0306a416f721b6c29f296">mhixbox_param_t</a> *&#160;</td>
256           <td class="paramname"><em>mhix</em>&#160;</td>
257         </tr>
258         <tr>
259           <td></td>
260           <td>)</td>
261           <td></td><td></td>
262         </tr>
263       </table>
264 </div><div class="memdoc">
265
266 <p>search a marker index by marker code from mhix box </p>
267 <dl class="params"><dt>Parameters</dt><dd>
268   <table class="params">
269     <tr><td class="paramdir">[in]</td><td class="paramname">code</td><td>marker code </td></tr>
270     <tr><td class="paramdir">[in]</td><td class="paramname">mhix</td><td>mhix box pointer </td></tr>
271   </table>
272   </dd>
273 </dl>
274 <dl class="section return"><dt>Returns</dt><dd>found marker index pointer </dd></dl>
275
276 <p>References <a class="el" href="structmarkeridx__param.html#a67f2cbaad816454e3137ad669289f4f0">markeridx_param::code</a>, <a class="el" href="mhixbox__manager_8c.html#a77b5d5af2adb2cfa7ec785b592fc4074">FCGI_stderr</a>, <a class="el" href="structmhixbox__param.html#a51b8cd55ab497445287933e5be101584">mhixbox_param::first</a>, and <a class="el" href="structmarkeridx__param.html#a96fec3389030014de88eeedc0ec41bf9">markeridx_param::next</a>.</p>
277
278 <p>Referenced by <a class="el" href="index__manager_8c.html#a73ddf4f40d7da955735a4fdb9b2c1d80">set_mainmhixdata()</a>.</p>
279
280 </div>
281 </div>
282 </div><!-- contents -->
283 <!-- start footer part -->
284 <hr class="footer"/><address class="footer"><small>
285 Generated by &#160;<a href="http://www.doxygen.org/index.html">
286 <img class="footer" src="doxygen.png" alt="doxygen"/>
287 </a> 1.8.10
288 </small></address>
289 </body>
290 </html>