Update Doxygen doc
[openjpeg.git] / doxygen / structopj__codestream__index.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: opj_codestream_index 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">opj_codestream_index Struct Reference</div>  </div>
51 </div><!--header-->
52 <div class="contents">
53
54 <p>Index structure of the codestream (FIXME should be expand and enhance)  
55  <a href="structopj__codestream__index.html#details">More...</a></p>
56
57 <p><code>#include &lt;<a class="el" href="openjpeg_8h_source.html">openjpeg.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:a812db107386fa6513a3b0d00670c2e6a"><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="structopj__codestream__index.html#a812db107386fa6513a3b0d00670c2e6a">main_head_start</a></td></tr>
62 <tr class="memdesc:a812db107386fa6513a3b0d00670c2e6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">main header start position (SOC position)  <a href="#a812db107386fa6513a3b0d00670c2e6a">More...</a><br /></td></tr>
63 <tr class="separator:a812db107386fa6513a3b0d00670c2e6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
64 <tr class="memitem:ad1cbf83b73e96560352d824700c7b74d"><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="structopj__codestream__index.html#ad1cbf83b73e96560352d824700c7b74d">main_head_end</a></td></tr>
65 <tr class="memdesc:ad1cbf83b73e96560352d824700c7b74d"><td class="mdescLeft">&#160;</td><td class="mdescRight">main header end position (first SOT position)  <a href="#ad1cbf83b73e96560352d824700c7b74d">More...</a><br /></td></tr>
66 <tr class="separator:ad1cbf83b73e96560352d824700c7b74d"><td class="memSeparator" colspan="2">&#160;</td></tr>
67 <tr class="memitem:ab4e62867bbd858edcdb1aee2ae20bdda"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#ad915cf26c4c9cc10a75b2d9287dbbb5e">OPJ_UINT64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__codestream__index.html#ab4e62867bbd858edcdb1aee2ae20bdda">codestream_size</a></td></tr>
68 <tr class="memdesc:ab4e62867bbd858edcdb1aee2ae20bdda"><td class="mdescLeft">&#160;</td><td class="mdescRight">codestream's size  <a href="#ab4e62867bbd858edcdb1aee2ae20bdda">More...</a><br /></td></tr>
69 <tr class="separator:ab4e62867bbd858edcdb1aee2ae20bdda"><td class="memSeparator" colspan="2">&#160;</td></tr>
70 <tr class="memitem:af9a9dd18972fbe7265821c06cbfee3ac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__codestream__index.html#af9a9dd18972fbe7265821c06cbfee3ac">marknum</a></td></tr>
71 <tr class="memdesc:af9a9dd18972fbe7265821c06cbfee3ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">number of markers  <a href="#af9a9dd18972fbe7265821c06cbfee3ac">More...</a><br /></td></tr>
72 <tr class="separator:af9a9dd18972fbe7265821c06cbfee3ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
73 <tr class="memitem:a0a3dfedef12123df206434b4421da5e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a8d13df85ea14a6a64ad403e168b0be37">opj_marker_info_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__codestream__index.html#a0a3dfedef12123df206434b4421da5e3">marker</a></td></tr>
74 <tr class="memdesc:a0a3dfedef12123df206434b4421da5e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">list of markers  <a href="#a0a3dfedef12123df206434b4421da5e3">More...</a><br /></td></tr>
75 <tr class="separator:a0a3dfedef12123df206434b4421da5e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
76 <tr class="memitem:a94043c6b0020bf1e0ad46d25a18248d9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__codestream__index.html#a94043c6b0020bf1e0ad46d25a18248d9">maxmarknum</a></td></tr>
77 <tr class="memdesc:a94043c6b0020bf1e0ad46d25a18248d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">actual size of markers array  <a href="#a94043c6b0020bf1e0ad46d25a18248d9">More...</a><br /></td></tr>
78 <tr class="separator:a94043c6b0020bf1e0ad46d25a18248d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
79 <tr class="memitem:ac623647a3c3d88b83db82acfd90f80d0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__codestream__index.html#ac623647a3c3d88b83db82acfd90f80d0">nb_of_tiles</a></td></tr>
80 <tr class="separator:ac623647a3c3d88b83db82acfd90f80d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
81 <tr class="memitem:ab7ce4372a9717a7f6c1ef21553738cd1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#ab230c306bbf1cfbf48e1a1f8a3b438af">opj_tile_index_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__codestream__index.html#ab7ce4372a9717a7f6c1ef21553738cd1">tile_index</a></td></tr>
82 <tr class="separator:ab7ce4372a9717a7f6c1ef21553738cd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
83 </table>
84 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
85 <div class="textblock"><p>Index structure of the codestream (FIXME should be expand and enhance) </p>
86 </div><h2 class="groupheader">Field Documentation</h2>
87 <a class="anchor" id="ab4e62867bbd858edcdb1aee2ae20bdda"></a>
88 <div class="memitem">
89 <div class="memproto">
90       <table class="memname">
91         <tr>
92           <td class="memname"><a class="el" href="openjpeg_8h.html#ad915cf26c4c9cc10a75b2d9287dbbb5e">OPJ_UINT64</a> opj_codestream_index::codestream_size</td>
93         </tr>
94       </table>
95 </div><div class="memdoc">
96
97 <p>codestream's size </p>
98
99 <p>Referenced by <a class="el" href="j2k_8h.html#aab1aefcf177ba3726b29afec69993f6b">j2k_get_cstr_index()</a>, and <a class="el" href="group___j2_k.html#ga69036131823e6cddc1313df546d178be">opj_j2k_write_epc()</a>.</p>
100
101 </div>
102 </div>
103 <a class="anchor" id="ad1cbf83b73e96560352d824700c7b74d"></a>
104 <div class="memitem">
105 <div class="memproto">
106       <table class="memname">
107         <tr>
108           <td class="memname"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> opj_codestream_index::main_head_end</td>
109         </tr>
110       </table>
111 </div><div class="memdoc">
112
113 <p>main header end position (first SOT position) </p>
114
115 <p>Referenced by <a class="el" href="j2k_8h.html#aab1aefcf177ba3726b29afec69993f6b">j2k_get_cstr_index()</a>, <a class="el" href="j2k_8c.html#ae310be1158fc90d77b9f4bd2711069d2">opj_j2k_decode_one_tile()</a>, <a class="el" href="group___j2_k.html#ga2b7e7cbaaffd2361ade9b2c79b6627f2">opj_j2k_dump_MH_index()</a>, <a class="el" href="group___j2_k.html#ga06bfef520a515d5b8c8eb2b7fa8f555e">opj_j2k_get_end_header()</a>, and <a class="el" href="group___j2_k.html#ga445c467bde1da70f07c2cdcd3ffbc25c">opj_j2k_read_header_procedure()</a>.</p>
116
117 </div>
118 </div>
119 <a class="anchor" id="a812db107386fa6513a3b0d00670c2e6a"></a>
120 <div class="memitem">
121 <div class="memproto">
122       <table class="memname">
123         <tr>
124           <td class="memname"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> opj_codestream_index::main_head_start</td>
125         </tr>
126       </table>
127 </div><div class="memdoc">
128
129 <p>main header start position (SOC position) </p>
130
131 <p>Referenced by <a class="el" href="j2k_8h.html#aab1aefcf177ba3726b29afec69993f6b">j2k_get_cstr_index()</a>, <a class="el" href="group___j2_k.html#ga2b7e7cbaaffd2361ade9b2c79b6627f2">opj_j2k_dump_MH_index()</a>, <a class="el" href="group___j2_k.html#ga4a8ad30a3df7afe15c5377a6f673f911">opj_j2k_read_soc()</a>, and <a class="el" href="group___j2_k.html#ga69036131823e6cddc1313df546d178be">opj_j2k_write_epc()</a>.</p>
132
133 </div>
134 </div>
135 <a class="anchor" id="a0a3dfedef12123df206434b4421da5e3"></a>
136 <div class="memitem">
137 <div class="memproto">
138       <table class="memname">
139         <tr>
140           <td class="memname"><a class="el" href="openjpeg_8h.html#a8d13df85ea14a6a64ad403e168b0be37">opj_marker_info_t</a>* opj_codestream_index::marker</td>
141         </tr>
142       </table>
143 </div><div class="memdoc">
144
145 <p>list of markers </p>
146
147 <p>Referenced by <a class="el" href="j2k_8h.html#a5836409e5b74b5a9b356e6f24cb9ade8">j2k_destroy_cstr_index()</a>, <a class="el" href="j2k_8h.html#aab1aefcf177ba3726b29afec69993f6b">j2k_get_cstr_index()</a>, <a class="el" href="group___j2_k.html#ga1d489122afdca01a88af3e7fe4fbc264">opj_j2k_add_mhmarker()</a>, <a class="el" href="group___j2_k.html#ga4b2125fe4dc06298bcac21013768d13b">opj_j2k_create_cstr_index()</a>, and <a class="el" href="group___j2_k.html#ga2b7e7cbaaffd2361ade9b2c79b6627f2">opj_j2k_dump_MH_index()</a>.</p>
148
149 </div>
150 </div>
151 <a class="anchor" id="af9a9dd18972fbe7265821c06cbfee3ac"></a>
152 <div class="memitem">
153 <div class="memproto">
154       <table class="memname">
155         <tr>
156           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_codestream_index::marknum</td>
157         </tr>
158       </table>
159 </div><div class="memdoc">
160
161 <p>number of markers </p>
162
163 <p>Referenced by <a class="el" href="j2k_8h.html#aab1aefcf177ba3726b29afec69993f6b">j2k_get_cstr_index()</a>, <a class="el" href="group___j2_k.html#ga1d489122afdca01a88af3e7fe4fbc264">opj_j2k_add_mhmarker()</a>, <a class="el" href="group___j2_k.html#ga4b2125fe4dc06298bcac21013768d13b">opj_j2k_create_cstr_index()</a>, and <a class="el" href="group___j2_k.html#ga2b7e7cbaaffd2361ade9b2c79b6627f2">opj_j2k_dump_MH_index()</a>.</p>
164
165 </div>
166 </div>
167 <a class="anchor" id="a94043c6b0020bf1e0ad46d25a18248d9"></a>
168 <div class="memitem">
169 <div class="memproto">
170       <table class="memname">
171         <tr>
172           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_codestream_index::maxmarknum</td>
173         </tr>
174       </table>
175 </div><div class="memdoc">
176
177 <p>actual size of markers array </p>
178
179 <p>Referenced by <a class="el" href="group___j2_k.html#ga1d489122afdca01a88af3e7fe4fbc264">opj_j2k_add_mhmarker()</a>, and <a class="el" href="group___j2_k.html#ga4b2125fe4dc06298bcac21013768d13b">opj_j2k_create_cstr_index()</a>.</p>
180
181 </div>
182 </div>
183 <a class="anchor" id="ac623647a3c3d88b83db82acfd90f80d0"></a>
184 <div class="memitem">
185 <div class="memproto">
186       <table class="memname">
187         <tr>
188           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_codestream_index::nb_of_tiles</td>
189         </tr>
190       </table>
191 </div><div class="memdoc">
192
193 <p>Referenced by <a class="el" href="j2k_8h.html#a5836409e5b74b5a9b356e6f24cb9ade8">j2k_destroy_cstr_index()</a>, <a class="el" href="j2k_8h.html#aab1aefcf177ba3726b29afec69993f6b">j2k_get_cstr_index()</a>, <a class="el" href="group___j2_k.html#ga555b0066bf125eea39ab1cb7fdec2e5b">opj_j2k_allocate_tile_element_cstr_index()</a>, and <a class="el" href="group___j2_k.html#ga2b7e7cbaaffd2361ade9b2c79b6627f2">opj_j2k_dump_MH_index()</a>.</p>
194
195 </div>
196 </div>
197 <a class="anchor" id="ab7ce4372a9717a7f6c1ef21553738cd1"></a>
198 <div class="memitem">
199 <div class="memproto">
200       <table class="memname">
201         <tr>
202           <td class="memname"><a class="el" href="openjpeg_8h.html#ab230c306bbf1cfbf48e1a1f8a3b438af">opj_tile_index_t</a>* opj_codestream_index::tile_index</td>
203         </tr>
204       </table>
205 </div><div class="memdoc">
206
207 <p>Referenced by <a class="el" href="j2k_8h.html#a5836409e5b74b5a9b356e6f24cb9ade8">j2k_destroy_cstr_index()</a>, <a class="el" href="j2k_8h.html#aab1aefcf177ba3726b29afec69993f6b">j2k_get_cstr_index()</a>, <a class="el" href="group___j2_k.html#gac5cf290f62c510f4896ad41f872336a7">opj_j2k_add_tlmarker()</a>, <a class="el" href="group___j2_k.html#ga555b0066bf125eea39ab1cb7fdec2e5b">opj_j2k_allocate_tile_element_cstr_index()</a>, <a class="el" href="group___j2_k.html#ga4b2125fe4dc06298bcac21013768d13b">opj_j2k_create_cstr_index()</a>, <a class="el" href="j2k_8c.html#ae310be1158fc90d77b9f4bd2711069d2">opj_j2k_decode_one_tile()</a>, <a class="el" href="group___j2_k.html#ga2b7e7cbaaffd2361ade9b2c79b6627f2">opj_j2k_dump_MH_index()</a>, <a class="el" href="group___j2_k.html#gaf1ac6b62e18b03816163369ec3a81eff">opj_j2k_read_sod()</a>, <a class="el" href="group___j2_k.html#ga935e4014c63e07bf19ad99584f6de430">opj_j2k_read_sot()</a>, and <a class="el" href="group___t2.html#ga6de6ce65e2c8b2ae26fb17a8b318cee4">opj_t2_decode_packets()</a>.</p>
208
209 </div>
210 </div>
211 <hr/>The documentation for this struct was generated from the following file:<ul>
212 <li><a class="el" href="openjpeg_8h_source.html">openjpeg.h</a></li>
213 </ul>
214 </div><!-- contents -->
215 <!-- start footer part -->
216 <hr class="footer"/><address class="footer"><small>
217 Generated by &#160;<a href="http://www.doxygen.org/index.html">
218 <img class="footer" src="doxygen.png" alt="doxygen"/>
219 </a> 1.8.10
220 </small></address>
221 </body>
222 </html>