2.5.2 post: fix full changelog
[openjpeg.git] / doxygen / j2kheader__manager_8h.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: j2kheader_manager.h 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.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 id="nav-path" class="navpath">
41   <ul>
42 <li class="navelem"><a class="el" href="dir_43e0a1f539e00dcfa1a6bc4d4fee4fc2.html">home</a></li><li class="navelem"><a class="el" href="dir_cb9b2b419d92b64f7cee83d8faf7a4ab.html">even</a></li><li class="navelem"><a class="el" href="dir_f75d9a0165d6564a1e04793ef847d41d.html">openjpeg</a></li><li class="navelem"><a class="el" href="dir_5f588d7ea139c1aae751d03c13a16064.html">openjpeg</a></li><li class="navelem"><a class="el" href="dir_378f732e812ef6cbaaae22e96a4fa79f.html">src</a></li><li class="navelem"><a class="el" href="dir_19dcb5713315405a27e1bde75a489a4c.html">lib</a></li><li class="navelem"><a class="el" href="dir_54d80c9412497e935deb5677b5fae801.html">openjpip</a></li>  </ul>
43 </div>
44 </div><!-- top -->
45 <div class="header">
46   <div class="summary">
47 <a href="#func-members">Functions</a>  </div>
48   <div class="headertitle">
49 <div class="title">j2kheader_manager.h File Reference</div>  </div>
50 </div><!--header-->
51 <div class="contents">
52 <div class="textblock"><code>#include &quot;<a class="el" href="byte__manager_8h_source.html">byte_manager.h</a>&quot;</code><br />
53 <code>#include &quot;<a class="el" href="index__manager_8h_source.html">index_manager.h</a>&quot;</code><br />
54 </div>
55 <p><a href="j2kheader__manager_8h_source.html">Go to the source code of this file.</a></p>
56 <table class="memberdecls">
57 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
58 Functions</h2></td></tr>
59 <tr class="memitem:a6e85dbe0255e26a6027b19afde275b60"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="j2kheader__manager_8h.html#a6e85dbe0255e26a6027b19afde275b60">get_mainheader_from_j2kstream</a> (<a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> *j2kstream, <a class="el" href="index__manager_8h.html#af66177e48b163395ef5cf7eb949119e6">SIZmarker_param_t</a> *SIZ, <a class="el" href="index__manager_8h.html#afb0da6bf3d374d1e4b66b9ee77cf3a84">CODmarker_param_t</a> *COD)</td></tr>
60 <tr class="memdesc:a6e85dbe0255e26a6027b19afde275b60"><td class="mdescLeft">&#160;</td><td class="mdescRight">get main header information from j2k codestream  <a href="j2kheader__manager_8h.html#a6e85dbe0255e26a6027b19afde275b60">More...</a><br /></td></tr>
61 <tr class="separator:a6e85dbe0255e26a6027b19afde275b60"><td class="memSeparator" colspan="2">&#160;</td></tr>
62 <tr class="memitem:acaadd27484f5ed74d421b53a8712ece9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="j2kheader__manager_8h.html#acaadd27484f5ed74d421b53a8712ece9">modify_mainheader</a> (<a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> *j2kstream, int numOfdecomp, <a class="el" href="index__manager_8h.html#af66177e48b163395ef5cf7eb949119e6">SIZmarker_param_t</a> SIZ, <a class="el" href="index__manager_8h.html#afb0da6bf3d374d1e4b66b9ee77cf3a84">CODmarker_param_t</a> COD, <a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a> *j2klen)</td></tr>
63 <tr class="memdesc:acaadd27484f5ed74d421b53a8712ece9"><td class="mdescLeft">&#160;</td><td class="mdescRight">modify main header in j2k codestream to fit with the new number of decompositions  <a href="j2kheader__manager_8h.html#acaadd27484f5ed74d421b53a8712ece9">More...</a><br /></td></tr>
64 <tr class="separator:acaadd27484f5ed74d421b53a8712ece9"><td class="memSeparator" colspan="2">&#160;</td></tr>
65 <tr class="memitem:aaf155590fb82d18a01ddef20353cf076"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="j2kheader__manager_8h.html#aaf155590fb82d18a01ddef20353cf076">modify_tileheader</a> (<a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> *j2kstream, <a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a> SOToffset, int numOfdecomp, <a class="el" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> Csiz, <a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a> *j2klen)</td></tr>
66 <tr class="memdesc:aaf155590fb82d18a01ddef20353cf076"><td class="mdescLeft">&#160;</td><td class="mdescRight">modify tile header in j2k codestream to fit with the tile part length, and new number of decompositions for multi-componet images  <a href="j2kheader__manager_8h.html#aaf155590fb82d18a01ddef20353cf076">More...</a><br /></td></tr>
67 <tr class="separator:aaf155590fb82d18a01ddef20353cf076"><td class="memSeparator" colspan="2">&#160;</td></tr>
68 </table>
69 <h2 class="groupheader">Function Documentation</h2>
70 <a id="a6e85dbe0255e26a6027b19afde275b60"></a>
71 <h2 class="memtitle"><span class="permalink"><a href="#a6e85dbe0255e26a6027b19afde275b60">&#9670;&nbsp;</a></span>get_mainheader_from_j2kstream()</h2>
72
73 <div class="memitem">
74 <div class="memproto">
75       <table class="memname">
76         <tr>
77           <td class="memname"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> get_mainheader_from_j2kstream </td>
78           <td>(</td>
79           <td class="paramtype"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> *&#160;</td>
80           <td class="paramname"><em>j2kstream</em>, </td>
81         </tr>
82         <tr>
83           <td class="paramkey"></td>
84           <td></td>
85           <td class="paramtype"><a class="el" href="index__manager_8h.html#af66177e48b163395ef5cf7eb949119e6">SIZmarker_param_t</a> *&#160;</td>
86           <td class="paramname"><em>SIZ</em>, </td>
87         </tr>
88         <tr>
89           <td class="paramkey"></td>
90           <td></td>
91           <td class="paramtype"><a class="el" href="index__manager_8h.html#afb0da6bf3d374d1e4b66b9ee77cf3a84">CODmarker_param_t</a> *&#160;</td>
92           <td class="paramname"><em>COD</em>&#160;</td>
93         </tr>
94         <tr>
95           <td></td>
96           <td>)</td>
97           <td></td><td></td>
98         </tr>
99       </table>
100 </div><div class="memdoc">
101
102 <p>get main header information from j2k codestream </p>
103 <dl class="params"><dt>Parameters</dt><dd>
104   <table class="params">
105     <tr><td class="paramdir">[in]</td><td class="paramname">j2kstream</td><td>j2k codestream </td></tr>
106     <tr><td class="paramdir">[out]</td><td class="paramname">SIZ</td><td>SIZ marker pointer </td></tr>
107     <tr><td class="paramdir">[out]</td><td class="paramname">COD</td><td>COD marker pointer </td></tr>
108   </table>
109   </dd>
110 </dl>
111 <dl class="section return"><dt>Returns</dt><dd>if succeeded (true) or failed (false) </dd></dl>
112
113 <p class="reference">References <a class="el" href="byte__manager_8c.html#a0c20ded21352121723f9df94c7568356">big2()</a>, <a class="el" href="j2kheader__manager_8c.html#a77b5d5af2adb2cfa7ec785b592fc4074">FCGI_stderr</a>, <a class="el" href="j2kheader__manager_8c.html#ae1684855661e9a592d1071caab77ccd6">get_CODmkrdata_from_j2kstream()</a>, <a class="el" href="j2kheader__manager_8c.html#a5aea84c4ed6285aee37fa2357c13f995">get_SIZmkrdata_from_j2kstream()</a>, <a class="el" href="struct_c_o_dmarker__param.html#aaa174b456bfeb15a6bf45e0b775df2c7">CODmarker_param::Lcod</a>, <a class="el" href="struct_s_i_zmarker__param.html#a04d37f31c54e9ff34a328532e83ff059">SIZmarker_param::Lsiz</a>, <a class="el" href="openjpeg_8h.html#ac672bfd7db39c609e828acb07a321964">OPJ_FALSE</a>, and <a class="el" href="openjpeg_8h.html#a04830036d767cba56cbf5ae5bdc481d3">OPJ_TRUE</a>.</p>
114
115 <p class="reference">Referenced by <a class="el" href="jpipstream__manager_8h.html#a38dc84677da3c6c449d00254f62624e7">get_SIZ_from_jpipstream()</a>, <a class="el" href="jp2k__encoder_8c.html#a5aafbf746124f238d36a0eeeb442ac7a">recons_codestream_from_JPPstream()</a>, and <a class="el" href="jp2k__encoder_8c.html#a722b5ca0c9026f39cd6523ee19c34b91">recons_codestream_from_JPTstream()</a>.</p>
116
117 </div>
118 </div>
119 <a id="acaadd27484f5ed74d421b53a8712ece9"></a>
120 <h2 class="memtitle"><span class="permalink"><a href="#acaadd27484f5ed74d421b53a8712ece9">&#9670;&nbsp;</a></span>modify_mainheader()</h2>
121
122 <div class="memitem">
123 <div class="memproto">
124       <table class="memname">
125         <tr>
126           <td class="memname"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> modify_mainheader </td>
127           <td>(</td>
128           <td class="paramtype"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> *&#160;</td>
129           <td class="paramname"><em>j2kstream</em>, </td>
130         </tr>
131         <tr>
132           <td class="paramkey"></td>
133           <td></td>
134           <td class="paramtype">int&#160;</td>
135           <td class="paramname"><em>numOfdecomp</em>, </td>
136         </tr>
137         <tr>
138           <td class="paramkey"></td>
139           <td></td>
140           <td class="paramtype"><a class="el" href="index__manager_8h.html#af66177e48b163395ef5cf7eb949119e6">SIZmarker_param_t</a>&#160;</td>
141           <td class="paramname"><em>SIZ</em>, </td>
142         </tr>
143         <tr>
144           <td class="paramkey"></td>
145           <td></td>
146           <td class="paramtype"><a class="el" href="index__manager_8h.html#afb0da6bf3d374d1e4b66b9ee77cf3a84">CODmarker_param_t</a>&#160;</td>
147           <td class="paramname"><em>COD</em>, </td>
148         </tr>
149         <tr>
150           <td class="paramkey"></td>
151           <td></td>
152           <td class="paramtype"><a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a> *&#160;</td>
153           <td class="paramname"><em>j2klen</em>&#160;</td>
154         </tr>
155         <tr>
156           <td></td>
157           <td>)</td>
158           <td></td><td></td>
159         </tr>
160       </table>
161 </div><div class="memdoc">
162
163 <p>modify main header in j2k codestream to fit with the new number of decompositions </p>
164 <dl class="params"><dt>Parameters</dt><dd>
165   <table class="params">
166     <tr><td class="paramdir">[in]</td><td class="paramname">j2kstream</td><td>j2k codestream </td></tr>
167     <tr><td class="paramdir">[in]</td><td class="paramname">numOfdecomp</td><td>the New number of decompositions </td></tr>
168     <tr><td class="paramdir">[in]</td><td class="paramname">SIZ</td><td>original SIZ marker information </td></tr>
169     <tr><td class="paramdir">[in]</td><td class="paramname">COD</td><td>original COD marker information </td></tr>
170     <tr><td class="paramdir">[out]</td><td class="paramname">j2klen</td><td>pointer to the length of j2k code stream </td></tr>
171   </table>
172   </dd>
173 </dl>
174 <dl class="section return"><dt>Returns</dt><dd>if succeeded (true) or failed (false) </dd></dl>
175
176 <p class="reference">References <a class="el" href="j2kheader__manager_8c.html#a77b5d5af2adb2cfa7ec785b592fc4074">FCGI_stderr</a>, <a class="el" href="struct_c_o_dmarker__param.html#aaa174b456bfeb15a6bf45e0b775df2c7">CODmarker_param::Lcod</a>, <a class="el" href="struct_s_i_zmarker__param.html#a04d37f31c54e9ff34a328532e83ff059">SIZmarker_param::Lsiz</a>, <a class="el" href="j2kheader__manager_8c.html#accc10e3cbf88aa90806a93e853556b92">modify_CODmkrstream()</a>, <a class="el" href="j2kheader__manager_8c.html#a166021779c499bd144656e1ce352bc90">modify_SIZmkrstream()</a>, <a class="el" href="struct_c_o_dmarker__param.html#a8b5a7ec3922783dbb050dd2c6ee729a3">CODmarker_param::numOfdecomp</a>, <a class="el" href="openjpeg_8h.html#ac672bfd7db39c609e828acb07a321964">OPJ_FALSE</a>, and <a class="el" href="openjpeg_8h.html#a04830036d767cba56cbf5ae5bdc481d3">OPJ_TRUE</a>.</p>
177
178 <p class="reference">Referenced by <a class="el" href="jp2k__encoder_8c.html#a5aafbf746124f238d36a0eeeb442ac7a">recons_codestream_from_JPPstream()</a>.</p>
179
180 </div>
181 </div>
182 <a id="aaf155590fb82d18a01ddef20353cf076"></a>
183 <h2 class="memtitle"><span class="permalink"><a href="#aaf155590fb82d18a01ddef20353cf076">&#9670;&nbsp;</a></span>modify_tileheader()</h2>
184
185 <div class="memitem">
186 <div class="memproto">
187       <table class="memname">
188         <tr>
189           <td class="memname"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> modify_tileheader </td>
190           <td>(</td>
191           <td class="paramtype"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> *&#160;</td>
192           <td class="paramname"><em>j2kstream</em>, </td>
193         </tr>
194         <tr>
195           <td class="paramkey"></td>
196           <td></td>
197           <td class="paramtype"><a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a>&#160;</td>
198           <td class="paramname"><em>SOToffset</em>, </td>
199         </tr>
200         <tr>
201           <td class="paramkey"></td>
202           <td></td>
203           <td class="paramtype">int&#160;</td>
204           <td class="paramname"><em>numOfdecomp</em>, </td>
205         </tr>
206         <tr>
207           <td class="paramkey"></td>
208           <td></td>
209           <td class="paramtype"><a class="el" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a>&#160;</td>
210           <td class="paramname"><em>Csiz</em>, </td>
211         </tr>
212         <tr>
213           <td class="paramkey"></td>
214           <td></td>
215           <td class="paramtype"><a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a> *&#160;</td>
216           <td class="paramname"><em>j2klen</em>&#160;</td>
217         </tr>
218         <tr>
219           <td></td>
220           <td>)</td>
221           <td></td><td></td>
222         </tr>
223       </table>
224 </div><div class="memdoc">
225
226 <p>modify tile header in j2k codestream to fit with the tile part length, and new number of decompositions for multi-componet images </p>
227 <dl class="params"><dt>Parameters</dt><dd>
228   <table class="params">
229     <tr><td class="paramdir">[in]</td><td class="paramname">j2kstream</td><td>j2k codestream </td></tr>
230     <tr><td class="paramdir">[in]</td><td class="paramname">SOToffset</td><td>offset of SOT marker from the beginning of j2kstream </td></tr>
231     <tr><td class="paramdir">[in]</td><td class="paramname">numOfdecomp</td><td>the New number of decompositions, -1 if the same as original </td></tr>
232     <tr><td class="paramdir">[in]</td><td class="paramname">Csiz</td><td>number of components </td></tr>
233     <tr><td class="paramdir">[out]</td><td class="paramname">j2klen</td><td>pointer to the length of j2k code stream </td></tr>
234   </table>
235   </dd>
236 </dl>
237 <dl class="section return"><dt>Returns</dt><dd>if succeeded (true) or failed (false) </dd></dl>
238
239 <p class="reference">References <a class="el" href="j2kheader__manager_8c.html#a77b5d5af2adb2cfa7ec785b592fc4074">FCGI_stderr</a>, <a class="el" href="byte__manager_8c.html#a48c7dad6f593aa718712b9451317fae3">modify_4Bytecode()</a>, <a class="el" href="j2kheader__manager_8c.html#ac8e4b9d3953006fee572449180342385">modify_COCmkrstream()</a>, <a class="el" href="openjpeg_8h.html#ac672bfd7db39c609e828acb07a321964">OPJ_FALSE</a>, and <a class="el" href="openjpeg_8h.html#a04830036d767cba56cbf5ae5bdc481d3">OPJ_TRUE</a>.</p>
240
241 <p class="reference">Referenced by <a class="el" href="jp2k__encoder_8c.html#a5aafbf746124f238d36a0eeeb442ac7a">recons_codestream_from_JPPstream()</a>.</p>
242
243 </div>
244 </div>
245 </div><!-- contents -->
246 <!-- start footer part -->
247 <hr class="footer"/><address class="footer"><small>
248 Generated by &#160;<a href="http://www.doxygen.org/index.html">
249 <img class="footer" src="doxygen.png" alt="doxygen"/>
250 </a> 1.8.17
251 </small></address>
252 </body>
253 </html>