Update Doxygen doc
[openjpeg.git] / doxygen / structindex__param.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: index_param Struct 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 class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
36       <li><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="annotated.html"><span>Data&#160;Structures</span></a></li>
42       <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
43     </ul>
44   </div>
45 </div><!-- top -->
46 <div class="header">
47   <div class="summary">
48 <a href="#pub-attribs">Data Fields</a>  </div>
49   <div class="headertitle">
50 <div class="title">index_param Struct Reference</div>  </div>
51 </div><!--header-->
52 <div class="contents">
53
54 <p>index parameters  
55  <a href="structindex__param.html#details">More...</a></p>
56
57 <p><code>#include &lt;<a class="el" href="index__manager_8h_source.html">index_manager.h</a>&gt;</code></p>
58 <table class="memberdecls">
59 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
60 Data Fields</h2></td></tr>
61 <tr class="memitem:aff731fe41300090d3dce7fb28d6cb245"><td class="memItemLeft" align="right" valign="top"><a class="el" href="metadata__manager_8h.html#aaa78ced398f149ca92b47e0acddf05e5">metadatalist_param_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structindex__param.html#aff731fe41300090d3dce7fb28d6cb245">metadatalist</a></td></tr>
62 <tr class="memdesc:aff731fe41300090d3dce7fb28d6cb245"><td class="mdescLeft">&#160;</td><td class="mdescRight">metadata-bin list  <a href="#aff731fe41300090d3dce7fb28d6cb245">More...</a><br /></td></tr>
63 <tr class="separator:aff731fe41300090d3dce7fb28d6cb245"><td class="memSeparator" colspan="2">&#160;</td></tr>
64 <tr class="memitem:a923a5652592c70120e7e85e865063dae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structindex__param.html#a923a5652592c70120e7e85e865063dae">offset</a></td></tr>
65 <tr class="memdesc:a923a5652592c70120e7e85e865063dae"><td class="mdescLeft">&#160;</td><td class="mdescRight">codestream offset  <a href="#a923a5652592c70120e7e85e865063dae">More...</a><br /></td></tr>
66 <tr class="separator:a923a5652592c70120e7e85e865063dae"><td class="memSeparator" colspan="2">&#160;</td></tr>
67 <tr class="memitem:af732c1871097cef89530934204d4823b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structindex__param.html#af732c1871097cef89530934204d4823b">length</a></td></tr>
68 <tr class="memdesc:af732c1871097cef89530934204d4823b"><td class="mdescLeft">&#160;</td><td class="mdescRight">codestream length  <a href="#af732c1871097cef89530934204d4823b">More...</a><br /></td></tr>
69 <tr class="separator:af732c1871097cef89530934204d4823b"><td class="memSeparator" colspan="2">&#160;</td></tr>
70 <tr class="memitem:a43ec7f75fe5fc903531e69de5737658d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structindex__param.html#a43ec7f75fe5fc903531e69de5737658d">mhead_length</a></td></tr>
71 <tr class="memdesc:a43ec7f75fe5fc903531e69de5737658d"><td class="mdescLeft">&#160;</td><td class="mdescRight">main header length  <a href="#a43ec7f75fe5fc903531e69de5737658d">More...</a><br /></td></tr>
72 <tr class="separator:a43ec7f75fe5fc903531e69de5737658d"><td class="memSeparator" colspan="2">&#160;</td></tr>
73 <tr class="memitem:ac0cfeb5e5e37084dbf91cd4df98948be"><td class="memItemLeft" align="right" valign="top"><a class="el" href="index__manager_8h.html#aad063c864473ce7ae7a16d9955594f3a">SIZmarker_param_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structindex__param.html#ac0cfeb5e5e37084dbf91cd4df98948be">SIZ</a></td></tr>
74 <tr class="memdesc:ac0cfeb5e5e37084dbf91cd4df98948be"><td class="mdescLeft">&#160;</td><td class="mdescRight">SIZ marker information.  <a href="#ac0cfeb5e5e37084dbf91cd4df98948be">More...</a><br /></td></tr>
75 <tr class="separator:ac0cfeb5e5e37084dbf91cd4df98948be"><td class="memSeparator" colspan="2">&#160;</td></tr>
76 <tr class="memitem:afa72b843bc8f565df4952f6c32c719c9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="index__manager_8h.html#a4b304973391a206d69d52931370350c3">CODmarker_param_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structindex__param.html#afa72b843bc8f565df4952f6c32c719c9">COD</a></td></tr>
77 <tr class="memdesc:afa72b843bc8f565df4952f6c32c719c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">COD marker information.  <a href="#afa72b843bc8f565df4952f6c32c719c9">More...</a><br /></td></tr>
78 <tr class="separator:afa72b843bc8f565df4952f6c32c719c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
79 <tr class="memitem:abbf2b7d27ed7e860fd67ba9a58af1514"><td class="memItemLeft" align="right" valign="top"><a class="el" href="faixbox__manager_8h.html#a9f95011aacbf1a72e52592bc7856fb33">faixbox_param_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structindex__param.html#abbf2b7d27ed7e860fd67ba9a58af1514">tilepart</a></td></tr>
80 <tr class="memdesc:abbf2b7d27ed7e860fd67ba9a58af1514"><td class="mdescLeft">&#160;</td><td class="mdescRight">tile part information from tpix box  <a href="#abbf2b7d27ed7e860fd67ba9a58af1514">More...</a><br /></td></tr>
81 <tr class="separator:abbf2b7d27ed7e860fd67ba9a58af1514"><td class="memSeparator" colspan="2">&#160;</td></tr>
82 <tr class="memitem:a91e41933bf853c2a6cab52b41aa807a1"><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="structindex__param.html#a91e41933bf853c2a6cab52b41aa807a1">tileheader</a></td></tr>
83 <tr class="memdesc:a91e41933bf853c2a6cab52b41aa807a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">dynamic array of tile header information from thix box  <a href="#a91e41933bf853c2a6cab52b41aa807a1">More...</a><br /></td></tr>
84 <tr class="separator:a91e41933bf853c2a6cab52b41aa807a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
85 <tr class="memitem:a7400fd13418cd272c8049388721688aa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="faixbox__manager_8h.html#a9f95011aacbf1a72e52592bc7856fb33">faixbox_param_t</a> **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structindex__param.html#a7400fd13418cd272c8049388721688aa">precpacket</a></td></tr>
86 <tr class="memdesc:a7400fd13418cd272c8049388721688aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">dynamic array of precint packet information from ppix box  <a href="#a7400fd13418cd272c8049388721688aa">More...</a><br /></td></tr>
87 <tr class="separator:a7400fd13418cd272c8049388721688aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
88 </table>
89 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
90 <div class="textblock"><p>index parameters </p>
91 </div><h2 class="groupheader">Field Documentation</h2>
92 <a class="anchor" id="afa72b843bc8f565df4952f6c32c719c9"></a>
93 <div class="memitem">
94 <div class="memproto">
95       <table class="memname">
96         <tr>
97           <td class="memname"><a class="el" href="index__manager_8h.html#a4b304973391a206d69d52931370350c3">CODmarker_param_t</a> index_param::COD</td>
98         </tr>
99       </table>
100 </div><div class="memdoc">
101
102 <p>COD marker information. </p>
103
104 <p>Referenced by <a class="el" href="jpip__parser_8c.html#aca2006bf1afcda0f917aa7794bb6f287">enqueue_allprecincts()</a>, <a class="el" href="jpip__parser_8c.html#a72490e3e8ccd2d8d102a15affea987ec">enqueue_imagedata()</a>, <a class="el" href="msgqueue__manager_8h.html#afd5f028cafe553d84aa7545ee5837d66">enqueue_precinct()</a>, <a class="el" href="jpip__parser_8c.html#aebe387634751d8d7d253ec5b9273f093">enqueue_precincts()</a>, <a class="el" href="jpip__parser_8h.html#a81aa485be8deb8d4878b30486c0006cd">gene_JPIPstream()</a>, <a class="el" href="index__manager_8h.html#acba4fd559491e3b10a80e0d14839c8bf">print_index()</a>, and <a class="el" href="index__manager_8c.html#a73ddf4f40d7da955735a4fdb9b2c1d80">set_mainmhixdata()</a>.</p>
105
106 </div>
107 </div>
108 <a class="anchor" id="af732c1871097cef89530934204d4823b"></a>
109 <div class="memitem">
110 <div class="memproto">
111       <table class="memname">
112         <tr>
113           <td class="memname"><a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a> index_param::length</td>
114         </tr>
115       </table>
116 </div><div class="memdoc">
117
118 <p>codestream length </p>
119
120 <p>Referenced by <a class="el" href="index__manager_8h.html#acba4fd559491e3b10a80e0d14839c8bf">print_index()</a>, <a class="el" href="index__manager_8c.html#a1bca84a98c266c9da610ebbb5d17e83c">set_cidxdata()</a>, and <a class="el" href="index__manager_8c.html#a1050f654e8e86c3b4a72fb30dc8b034a">set_cptrdata()</a>.</p>
121
122 </div>
123 </div>
124 <a class="anchor" id="aff731fe41300090d3dce7fb28d6cb245"></a>
125 <div class="memitem">
126 <div class="memproto">
127       <table class="memname">
128         <tr>
129           <td class="memname"><a class="el" href="metadata__manager_8h.html#aaa78ced398f149ca92b47e0acddf05e5">metadatalist_param_t</a>* index_param::metadatalist</td>
130         </tr>
131       </table>
132 </div><div class="memdoc">
133
134 <p>metadata-bin list </p>
135
136 <p>Referenced by <a class="el" href="msgqueue__manager_8h.html#a8b6b00d2ba2bad2a483aed202cf25610">enqueue_metadata()</a>, <a class="el" href="jpip__parser_8h.html#a81aa485be8deb8d4878b30486c0006cd">gene_JPIPstream()</a>, <a class="el" href="index__manager_8h.html#aeda761f27ce8cb0ed202d0ea2aa64c7e">parse_jp2file()</a>, and <a class="el" href="index__manager_8h.html#acba4fd559491e3b10a80e0d14839c8bf">print_index()</a>.</p>
137
138 </div>
139 </div>
140 <a class="anchor" id="a43ec7f75fe5fc903531e69de5737658d"></a>
141 <div class="memitem">
142 <div class="memproto">
143       <table class="memname">
144         <tr>
145           <td class="memname"><a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a> index_param::mhead_length</td>
146         </tr>
147       </table>
148 </div><div class="memdoc">
149
150 <p>main header length </p>
151
152 <p>Referenced by <a class="el" href="msgqueue__manager_8h.html#a0a6f0ae1b724d1ccb7852f3e4ef1fd32">enqueue_mainheader()</a>, <a class="el" href="index__manager_8h.html#acba4fd559491e3b10a80e0d14839c8bf">print_index()</a>, and <a class="el" href="index__manager_8c.html#a73ddf4f40d7da955735a4fdb9b2c1d80">set_mainmhixdata()</a>.</p>
153
154 </div>
155 </div>
156 <a class="anchor" id="a923a5652592c70120e7e85e865063dae"></a>
157 <div class="memitem">
158 <div class="memproto">
159       <table class="memname">
160         <tr>
161           <td class="memname"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> index_param::offset</td>
162         </tr>
163       </table>
164 </div><div class="memdoc">
165
166 <p>codestream offset </p>
167
168 <p>Referenced by <a class="el" href="msgqueue__manager_8h.html#a0a6f0ae1b724d1ccb7852f3e4ef1fd32">enqueue_mainheader()</a>, <a class="el" href="msgqueue__manager_8h.html#afd5f028cafe553d84aa7545ee5837d66">enqueue_precinct()</a>, <a class="el" href="msgqueue__manager_8h.html#a4982e5cda507b39bfc074b4c4b60e3ae">enqueue_tile()</a>, <a class="el" href="msgqueue__manager_8h.html#a3280c3cd4e26ac1e3bdd27d6f5bbf999">enqueue_tileheader()</a>, <a class="el" href="index__manager_8h.html#acba4fd559491e3b10a80e0d14839c8bf">print_index()</a>, <a class="el" href="index__manager_8c.html#a1bca84a98c266c9da610ebbb5d17e83c">set_cidxdata()</a>, and <a class="el" href="index__manager_8c.html#a1050f654e8e86c3b4a72fb30dc8b034a">set_cptrdata()</a>.</p>
169
170 </div>
171 </div>
172 <a class="anchor" id="a7400fd13418cd272c8049388721688aa"></a>
173 <div class="memitem">
174 <div class="memproto">
175       <table class="memname">
176         <tr>
177           <td class="memname"><a class="el" href="faixbox__manager_8h.html#a9f95011aacbf1a72e52592bc7856fb33">faixbox_param_t</a>** index_param::precpacket</td>
178         </tr>
179       </table>
180 </div><div class="memdoc">
181
182 <p>dynamic array of precint packet information from ppix box </p>
183
184 <p>Referenced by <a class="el" href="msgqueue__manager_8h.html#afd5f028cafe553d84aa7545ee5837d66">enqueue_precinct()</a>, <a class="el" href="cachemodel__manager_8h.html#a8536ce465d342e4cd99e618c4c20e6d7">gene_cachemodel()</a>, <a class="el" href="cachemodel__manager_8h.html#a100d5835680e609531af22213616ce97">is_allsent()</a>, <a class="el" href="cachemodel__manager_8h.html#a269ce98f85275b2b6348aae150108c5b">print_cachemodel()</a>, <a class="el" href="index__manager_8h.html#acba4fd559491e3b10a80e0d14839c8bf">print_index()</a>, and <a class="el" href="index__manager_8c.html#a781af2c59898ceecdffb70004cfaf018">set_ppixdata()</a>.</p>
185
186 </div>
187 </div>
188 <a class="anchor" id="ac0cfeb5e5e37084dbf91cd4df98948be"></a>
189 <div class="memitem">
190 <div class="memproto">
191       <table class="memname">
192         <tr>
193           <td class="memname"><a class="el" href="index__manager_8h.html#aad063c864473ce7ae7a16d9955594f3a">SIZmarker_param_t</a> index_param::SIZ</td>
194         </tr>
195       </table>
196 </div><div class="memdoc">
197
198 <p>SIZ marker information. </p>
199
200 <p>Referenced by <a class="el" href="jpip__parser_8c.html#aca2006bf1afcda0f917aa7794bb6f287">enqueue_allprecincts()</a>, <a class="el" href="jpip__parser_8c.html#a72490e3e8ccd2d8d102a15affea987ec">enqueue_imagedata()</a>, <a class="el" href="msgqueue__manager_8h.html#afd5f028cafe553d84aa7545ee5837d66">enqueue_precinct()</a>, <a class="el" href="jpip__parser_8c.html#aebe387634751d8d7d253ec5b9273f093">enqueue_precincts()</a>, <a class="el" href="cachemodel__manager_8h.html#a8536ce465d342e4cd99e618c4c20e6d7">gene_cachemodel()</a>, <a class="el" href="cachemodel__manager_8h.html#a100d5835680e609531af22213616ce97">is_allsent()</a>, <a class="el" href="cachemodel__manager_8h.html#a269ce98f85275b2b6348aae150108c5b">print_cachemodel()</a>, <a class="el" href="index__manager_8h.html#acba4fd559491e3b10a80e0d14839c8bf">print_index()</a>, <a class="el" href="index__manager_8c.html#a73ddf4f40d7da955735a4fdb9b2c1d80">set_mainmhixdata()</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>
201
202 </div>
203 </div>
204 <a class="anchor" id="a91e41933bf853c2a6cab52b41aa807a1"></a>
205 <div class="memitem">
206 <div class="memproto">
207       <table class="memname">
208         <tr>
209           <td class="memname"><a class="el" href="mhixbox__manager_8h.html#affa3bc2302f0306a416f721b6c29f296">mhixbox_param_t</a>** index_param::tileheader</td>
210         </tr>
211       </table>
212 </div><div class="memdoc">
213
214 <p>dynamic array of tile header information from thix box </p>
215
216 <p>Referenced by <a class="el" href="msgqueue__manager_8h.html#a3280c3cd4e26ac1e3bdd27d6f5bbf999">enqueue_tileheader()</a>, <a class="el" href="index__manager_8h.html#acba4fd559491e3b10a80e0d14839c8bf">print_index()</a>, and <a class="el" href="index__manager_8c.html#a5d8213c96df9c2e64b42bfc0f3003141">set_thixdata()</a>.</p>
217
218 </div>
219 </div>
220 <a class="anchor" id="abbf2b7d27ed7e860fd67ba9a58af1514"></a>
221 <div class="memitem">
222 <div class="memproto">
223       <table class="memname">
224         <tr>
225           <td class="memname"><a class="el" href="faixbox__manager_8h.html#a9f95011aacbf1a72e52592bc7856fb33">faixbox_param_t</a>* index_param::tilepart</td>
226         </tr>
227       </table>
228 </div><div class="memdoc">
229
230 <p>tile part information from tpix box </p>
231
232 <p>Referenced by <a class="el" href="jpip__parser_8c.html#a72490e3e8ccd2d8d102a15affea987ec">enqueue_imagedata()</a>, <a class="el" href="msgqueue__manager_8h.html#a4982e5cda507b39bfc074b4c4b60e3ae">enqueue_tile()</a>, <a class="el" href="msgqueue__manager_8h.html#a3280c3cd4e26ac1e3bdd27d6f5bbf999">enqueue_tileheader()</a>, <a class="el" href="cachemodel__manager_8h.html#a8536ce465d342e4cd99e618c4c20e6d7">gene_cachemodel()</a>, <a class="el" href="cachemodel__manager_8h.html#a100d5835680e609531af22213616ce97">is_allsent()</a>, <a class="el" href="index__manager_8h.html#ae9e9b509e0078e503da1c0564644a193">isJPTfeasible()</a>, <a class="el" href="cachemodel__manager_8h.html#a269ce98f85275b2b6348aae150108c5b">print_cachemodel()</a>, <a class="el" href="index__manager_8h.html#acba4fd559491e3b10a80e0d14839c8bf">print_index()</a>, and <a class="el" href="index__manager_8c.html#ab16c783f41458fea838b5a8ebd892798">set_tpixdata()</a>.</p>
233
234 </div>
235 </div>
236 <hr/>The documentation for this struct was generated from the following file:<ul>
237 <li><a class="el" href="index__manager_8h_source.html">index_manager.h</a></li>
238 </ul>
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.10
245 </small></address>
246 </body>
247 </html>