Create CNAME
[openjpeg.git] / doxygen / structopj__codestream__index.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>OpenJPEG: opj_codestream_index Struct 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.5.0</span>
23    </div>
24   </td>
25  </tr>
26  </tbody>
27 </table>
28 </div>
29 <!-- end header part -->
30 <!-- Generated by Doxygen 1.8.17 -->
31 <script type="text/javascript" src="menudata.js"></script>
32 <script type="text/javascript" src="menu.js"></script>
33 <script type="text/javascript">
34 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
35 $(function() {
36   initMenu('',false,false,'search.php','Search');
37 });
38 /* @license-end */</script>
39 <div id="main-nav"></div>
40 </div><!-- top -->
41 <div class="header">
42   <div class="summary">
43 <a href="#pub-attribs">Data Fields</a>  </div>
44   <div class="headertitle">
45 <div class="title">opj_codestream_index Struct Reference</div>  </div>
46 </div><!--header-->
47 <div class="contents">
48
49 <p>Index structure of the codestream (FIXME should be expand and enhance)  
50  <a href="structopj__codestream__index.html#details">More...</a></p>
51
52 <p><code>#include &lt;<a class="el" href="openjpeg_8h_source.html">openjpeg.h</a>&gt;</code></p>
53 <table class="memberdecls">
54 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
55 Data Fields</h2></td></tr>
56 <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>
57 <tr class="memdesc:a812db107386fa6513a3b0d00670c2e6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">main header start position (SOC position)  <a href="structopj__codestream__index.html#a812db107386fa6513a3b0d00670c2e6a">More...</a><br /></td></tr>
58 <tr class="separator:a812db107386fa6513a3b0d00670c2e6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
59 <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>
60 <tr class="memdesc:ad1cbf83b73e96560352d824700c7b74d"><td class="mdescLeft">&#160;</td><td class="mdescRight">main header end position (first SOT position)  <a href="structopj__codestream__index.html#ad1cbf83b73e96560352d824700c7b74d">More...</a><br /></td></tr>
61 <tr class="separator:ad1cbf83b73e96560352d824700c7b74d"><td class="memSeparator" colspan="2">&#160;</td></tr>
62 <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>
63 <tr class="memdesc:ab4e62867bbd858edcdb1aee2ae20bdda"><td class="mdescLeft">&#160;</td><td class="mdescRight">codestream's size  <a href="structopj__codestream__index.html#ab4e62867bbd858edcdb1aee2ae20bdda">More...</a><br /></td></tr>
64 <tr class="separator:ab4e62867bbd858edcdb1aee2ae20bdda"><td class="memSeparator" colspan="2">&#160;</td></tr>
65 <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>
66 <tr class="memdesc:af9a9dd18972fbe7265821c06cbfee3ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">number of markers  <a href="structopj__codestream__index.html#af9a9dd18972fbe7265821c06cbfee3ac">More...</a><br /></td></tr>
67 <tr class="separator:af9a9dd18972fbe7265821c06cbfee3ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
68 <tr class="memitem:a0a3dfedef12123df206434b4421da5e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#ab79e2e41a75ee69ae551cacb766f74de">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>
69 <tr class="memdesc:a0a3dfedef12123df206434b4421da5e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">list of markers  <a href="structopj__codestream__index.html#a0a3dfedef12123df206434b4421da5e3">More...</a><br /></td></tr>
70 <tr class="separator:a0a3dfedef12123df206434b4421da5e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
71 <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>
72 <tr class="memdesc:a94043c6b0020bf1e0ad46d25a18248d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">actual size of markers array  <a href="structopj__codestream__index.html#a94043c6b0020bf1e0ad46d25a18248d9">More...</a><br /></td></tr>
73 <tr class="separator:a94043c6b0020bf1e0ad46d25a18248d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
74 <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>
75 <tr class="separator:ac623647a3c3d88b83db82acfd90f80d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
76 <tr class="memitem:ab7ce4372a9717a7f6c1ef21553738cd1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#aec540840f4f2669536bc6290dc9651cf">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>
77 <tr class="separator:ab7ce4372a9717a7f6c1ef21553738cd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
78 </table>
79 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
80 <div class="textblock"><p>Index structure of the codestream (FIXME should be expand and enhance) </p>
81 </div><h2 class="groupheader">Field Documentation</h2>
82 <a id="ab4e62867bbd858edcdb1aee2ae20bdda"></a>
83 <h2 class="memtitle"><span class="permalink"><a href="#ab4e62867bbd858edcdb1aee2ae20bdda">&#9670;&nbsp;</a></span>codestream_size</h2>
84
85 <div class="memitem">
86 <div class="memproto">
87       <table class="memname">
88         <tr>
89           <td class="memname"><a class="el" href="openjpeg_8h.html#ad915cf26c4c9cc10a75b2d9287dbbb5e">OPJ_UINT64</a> opj_codestream_index::codestream_size</td>
90         </tr>
91       </table>
92 </div><div class="memdoc">
93
94 <p>codestream's size </p>
95
96 <p class="reference">Referenced by <a class="el" href="j2k_8h.html#aab1aefcf177ba3726b29afec69993f6b">j2k_get_cstr_index()</a>, and <a class="el" href="j2k_8c.html#a69036131823e6cddc1313df546d178be">opj_j2k_write_epc()</a>.</p>
97
98 </div>
99 </div>
100 <a id="ad1cbf83b73e96560352d824700c7b74d"></a>
101 <h2 class="memtitle"><span class="permalink"><a href="#ad1cbf83b73e96560352d824700c7b74d">&#9670;&nbsp;</a></span>main_head_end</h2>
102
103 <div class="memitem">
104 <div class="memproto">
105       <table class="memname">
106         <tr>
107           <td class="memname"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> opj_codestream_index::main_head_end</td>
108         </tr>
109       </table>
110 </div><div class="memdoc">
111
112 <p>main header end position (first SOT position) </p>
113
114 <p class="reference">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="j2k_8c.html#a2b7e7cbaaffd2361ade9b2c79b6627f2">opj_j2k_dump_MH_index()</a>, <a class="el" href="j2k_8c.html#a06bfef520a515d5b8c8eb2b7fa8f555e">opj_j2k_get_end_header()</a>, and <a class="el" href="j2k_8c.html#a445c467bde1da70f07c2cdcd3ffbc25c">opj_j2k_read_header_procedure()</a>.</p>
115
116 </div>
117 </div>
118 <a id="a812db107386fa6513a3b0d00670c2e6a"></a>
119 <h2 class="memtitle"><span class="permalink"><a href="#a812db107386fa6513a3b0d00670c2e6a">&#9670;&nbsp;</a></span>main_head_start</h2>
120
121 <div class="memitem">
122 <div class="memproto">
123       <table class="memname">
124         <tr>
125           <td class="memname"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> opj_codestream_index::main_head_start</td>
126         </tr>
127       </table>
128 </div><div class="memdoc">
129
130 <p>main header start position (SOC position) </p>
131
132 <p class="reference">Referenced by <a class="el" href="j2k_8h.html#aab1aefcf177ba3726b29afec69993f6b">j2k_get_cstr_index()</a>, <a class="el" href="j2k_8c.html#a2b7e7cbaaffd2361ade9b2c79b6627f2">opj_j2k_dump_MH_index()</a>, <a class="el" href="j2k_8c.html#a4a8ad30a3df7afe15c5377a6f673f911">opj_j2k_read_soc()</a>, and <a class="el" href="j2k_8c.html#a69036131823e6cddc1313df546d178be">opj_j2k_write_epc()</a>.</p>
133
134 </div>
135 </div>
136 <a id="a0a3dfedef12123df206434b4421da5e3"></a>
137 <h2 class="memtitle"><span class="permalink"><a href="#a0a3dfedef12123df206434b4421da5e3">&#9670;&nbsp;</a></span>marker</h2>
138
139 <div class="memitem">
140 <div class="memproto">
141       <table class="memname">
142         <tr>
143           <td class="memname"><a class="el" href="openjpeg_8h.html#ab79e2e41a75ee69ae551cacb766f74de">opj_marker_info_t</a>* opj_codestream_index::marker</td>
144         </tr>
145       </table>
146 </div><div class="memdoc">
147
148 <p>list of markers </p>
149
150 <p class="reference">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="j2k_8c.html#a1d489122afdca01a88af3e7fe4fbc264">opj_j2k_add_mhmarker()</a>, <a class="el" href="j2k_8c.html#a4b2125fe4dc06298bcac21013768d13b">opj_j2k_create_cstr_index()</a>, and <a class="el" href="j2k_8c.html#a2b7e7cbaaffd2361ade9b2c79b6627f2">opj_j2k_dump_MH_index()</a>.</p>
151
152 </div>
153 </div>
154 <a id="af9a9dd18972fbe7265821c06cbfee3ac"></a>
155 <h2 class="memtitle"><span class="permalink"><a href="#af9a9dd18972fbe7265821c06cbfee3ac">&#9670;&nbsp;</a></span>marknum</h2>
156
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#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_codestream_index::marknum</td>
162         </tr>
163       </table>
164 </div><div class="memdoc">
165
166 <p>number of markers </p>
167
168 <p class="reference">Referenced by <a class="el" href="j2k_8h.html#aab1aefcf177ba3726b29afec69993f6b">j2k_get_cstr_index()</a>, <a class="el" href="j2k_8c.html#a1d489122afdca01a88af3e7fe4fbc264">opj_j2k_add_mhmarker()</a>, <a class="el" href="j2k_8c.html#a4b2125fe4dc06298bcac21013768d13b">opj_j2k_create_cstr_index()</a>, and <a class="el" href="j2k_8c.html#a2b7e7cbaaffd2361ade9b2c79b6627f2">opj_j2k_dump_MH_index()</a>.</p>
169
170 </div>
171 </div>
172 <a id="a94043c6b0020bf1e0ad46d25a18248d9"></a>
173 <h2 class="memtitle"><span class="permalink"><a href="#a94043c6b0020bf1e0ad46d25a18248d9">&#9670;&nbsp;</a></span>maxmarknum</h2>
174
175 <div class="memitem">
176 <div class="memproto">
177       <table class="memname">
178         <tr>
179           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_codestream_index::maxmarknum</td>
180         </tr>
181       </table>
182 </div><div class="memdoc">
183
184 <p>actual size of markers array </p>
185
186 <p class="reference">Referenced by <a class="el" href="j2k_8c.html#a1d489122afdca01a88af3e7fe4fbc264">opj_j2k_add_mhmarker()</a>, and <a class="el" href="j2k_8c.html#a4b2125fe4dc06298bcac21013768d13b">opj_j2k_create_cstr_index()</a>.</p>
187
188 </div>
189 </div>
190 <a id="ac623647a3c3d88b83db82acfd90f80d0"></a>
191 <h2 class="memtitle"><span class="permalink"><a href="#ac623647a3c3d88b83db82acfd90f80d0">&#9670;&nbsp;</a></span>nb_of_tiles</h2>
192
193 <div class="memitem">
194 <div class="memproto">
195       <table class="memname">
196         <tr>
197           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_codestream_index::nb_of_tiles</td>
198         </tr>
199       </table>
200 </div><div class="memdoc">
201
202 <p class="reference">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="j2k_8c.html#a555b0066bf125eea39ab1cb7fdec2e5b">opj_j2k_allocate_tile_element_cstr_index()</a>, and <a class="el" href="j2k_8c.html#a2b7e7cbaaffd2361ade9b2c79b6627f2">opj_j2k_dump_MH_index()</a>.</p>
203
204 </div>
205 </div>
206 <a id="ab7ce4372a9717a7f6c1ef21553738cd1"></a>
207 <h2 class="memtitle"><span class="permalink"><a href="#ab7ce4372a9717a7f6c1ef21553738cd1">&#9670;&nbsp;</a></span>tile_index</h2>
208
209 <div class="memitem">
210 <div class="memproto">
211       <table class="memname">
212         <tr>
213           <td class="memname"><a class="el" href="openjpeg_8h.html#aec540840f4f2669536bc6290dc9651cf">opj_tile_index_t</a>* opj_codestream_index::tile_index</td>
214         </tr>
215       </table>
216 </div><div class="memdoc">
217
218 <p class="reference">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="j2k_8c.html#ac5cf290f62c510f4896ad41f872336a7">opj_j2k_add_tlmarker()</a>, <a class="el" href="j2k_8c.html#a555b0066bf125eea39ab1cb7fdec2e5b">opj_j2k_allocate_tile_element_cstr_index()</a>, <a class="el" href="j2k_8c.html#a4b2125fe4dc06298bcac21013768d13b">opj_j2k_create_cstr_index()</a>, <a class="el" href="j2k_8c.html#ae310be1158fc90d77b9f4bd2711069d2">opj_j2k_decode_one_tile()</a>, <a class="el" href="j2k_8c.html#a2b7e7cbaaffd2361ade9b2c79b6627f2">opj_j2k_dump_MH_index()</a>, <a class="el" href="j2k_8c.html#af1ac6b62e18b03816163369ec3a81eff">opj_j2k_read_sod()</a>, <a class="el" href="j2k_8c.html#a935e4014c63e07bf19ad99584f6de430">opj_j2k_read_sot()</a>, and <a class="el" href="t2_8h.html#a08fffa34be41f4811d8bd99e9364de2e">opj_t2_decode_packets()</a>.</p>
219
220 </div>
221 </div>
222 <hr/>The documentation for this struct was generated from the following file:<ul>
223 <li><a class="el" href="openjpeg_8h_source.html">openjpeg.h</a></li>
224 </ul>
225 </div><!-- contents -->
226 <!-- start footer part -->
227 <hr class="footer"/><address class="footer"><small>
228 Generated by &#160;<a href="http://www.doxygen.org/index.html">
229 <img class="footer" src="doxygen.png" alt="doxygen"/>
230 </a> 1.8.17
231 </small></address>
232 </body>
233 </html>