Update Doxygen doc
[openjpeg.git] / doxygen / j2kheader__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: j2kheader_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="#func-members">Functions</a>  </div>
53   <div class="headertitle">
54 <div class="title">j2kheader_manager.h File Reference</div>  </div>
55 </div><!--header-->
56 <div class="contents">
57 <div class="textblock"><code>#include &quot;<a class="el" href="byte__manager_8h_source.html">byte_manager.h</a>&quot;</code><br />
58 <code>#include &quot;<a class="el" href="index__manager_8h_source.html">index_manager.h</a>&quot;</code><br />
59 </div>
60 <p><a href="j2kheader__manager_8h_source.html">Go to the source code of this file.</a></p>
61 <table class="memberdecls">
62 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
63 Functions</h2></td></tr>
64 <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#aad063c864473ce7ae7a16d9955594f3a">SIZmarker_param_t</a> *SIZ, <a class="el" href="index__manager_8h.html#a4b304973391a206d69d52931370350c3">CODmarker_param_t</a> *COD)</td></tr>
65 <tr class="memdesc:a6e85dbe0255e26a6027b19afde275b60"><td class="mdescLeft">&#160;</td><td class="mdescRight">get main header information from j2k codestream  <a href="#a6e85dbe0255e26a6027b19afde275b60">More...</a><br /></td></tr>
66 <tr class="separator:a6e85dbe0255e26a6027b19afde275b60"><td class="memSeparator" colspan="2">&#160;</td></tr>
67 <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#aad063c864473ce7ae7a16d9955594f3a">SIZmarker_param_t</a> SIZ, <a class="el" href="index__manager_8h.html#a4b304973391a206d69d52931370350c3">CODmarker_param_t</a> COD, <a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a> *j2klen)</td></tr>
68 <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="#acaadd27484f5ed74d421b53a8712ece9">More...</a><br /></td></tr>
69 <tr class="separator:acaadd27484f5ed74d421b53a8712ece9"><td class="memSeparator" colspan="2">&#160;</td></tr>
70 <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>
71 <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="#aaf155590fb82d18a01ddef20353cf076">More...</a><br /></td></tr>
72 <tr class="separator:aaf155590fb82d18a01ddef20353cf076"><td class="memSeparator" colspan="2">&#160;</td></tr>
73 </table>
74 <h2 class="groupheader">Function Documentation</h2>
75 <a class="anchor" id="a6e85dbe0255e26a6027b19afde275b60"></a>
76 <div class="memitem">
77 <div class="memproto">
78       <table class="memname">
79         <tr>
80           <td class="memname"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> get_mainheader_from_j2kstream </td>
81           <td>(</td>
82           <td class="paramtype"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> *&#160;</td>
83           <td class="paramname"><em>j2kstream</em>, </td>
84         </tr>
85         <tr>
86           <td class="paramkey"></td>
87           <td></td>
88           <td class="paramtype"><a class="el" href="index__manager_8h.html#aad063c864473ce7ae7a16d9955594f3a">SIZmarker_param_t</a> *&#160;</td>
89           <td class="paramname"><em>SIZ</em>, </td>
90         </tr>
91         <tr>
92           <td class="paramkey"></td>
93           <td></td>
94           <td class="paramtype"><a class="el" href="index__manager_8h.html#a4b304973391a206d69d52931370350c3">CODmarker_param_t</a> *&#160;</td>
95           <td class="paramname"><em>COD</em>&#160;</td>
96         </tr>
97         <tr>
98           <td></td>
99           <td>)</td>
100           <td></td><td></td>
101         </tr>
102       </table>
103 </div><div class="memdoc">
104
105 <p>get main header information from j2k codestream </p>
106 <dl class="params"><dt>Parameters</dt><dd>
107   <table class="params">
108     <tr><td class="paramdir">[in]</td><td class="paramname">j2kstream</td><td>j2k codestream </td></tr>
109     <tr><td class="paramdir">[out]</td><td class="paramname">SIZ</td><td>SIZ marker pointer </td></tr>
110     <tr><td class="paramdir">[out]</td><td class="paramname">COD</td><td>COD marker pointer </td></tr>
111   </table>
112   </dd>
113 </dl>
114 <dl class="section return"><dt>Returns</dt><dd>if succeeded (true) or failed (false) </dd></dl>
115
116 <p>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>
117
118 <p>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>
119
120 </div>
121 </div>
122 <a class="anchor" id="acaadd27484f5ed74d421b53a8712ece9"></a>
123 <div class="memitem">
124 <div class="memproto">
125       <table class="memname">
126         <tr>
127           <td class="memname"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> modify_mainheader </td>
128           <td>(</td>
129           <td class="paramtype"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> *&#160;</td>
130           <td class="paramname"><em>j2kstream</em>, </td>
131         </tr>
132         <tr>
133           <td class="paramkey"></td>
134           <td></td>
135           <td class="paramtype">int&#160;</td>
136           <td class="paramname"><em>numOfdecomp</em>, </td>
137         </tr>
138         <tr>
139           <td class="paramkey"></td>
140           <td></td>
141           <td class="paramtype"><a class="el" href="index__manager_8h.html#aad063c864473ce7ae7a16d9955594f3a">SIZmarker_param_t</a>&#160;</td>
142           <td class="paramname"><em>SIZ</em>, </td>
143         </tr>
144         <tr>
145           <td class="paramkey"></td>
146           <td></td>
147           <td class="paramtype"><a class="el" href="index__manager_8h.html#a4b304973391a206d69d52931370350c3">CODmarker_param_t</a>&#160;</td>
148           <td class="paramname"><em>COD</em>, </td>
149         </tr>
150         <tr>
151           <td class="paramkey"></td>
152           <td></td>
153           <td class="paramtype"><a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a> *&#160;</td>
154           <td class="paramname"><em>j2klen</em>&#160;</td>
155         </tr>
156         <tr>
157           <td></td>
158           <td>)</td>
159           <td></td><td></td>
160         </tr>
161       </table>
162 </div><div class="memdoc">
163
164 <p>modify main header in j2k codestream to fit with the new number of decompositions </p>
165 <dl class="params"><dt>Parameters</dt><dd>
166   <table class="params">
167     <tr><td class="paramdir">[in]</td><td class="paramname">j2kstream</td><td>j2k codestream </td></tr>
168     <tr><td class="paramdir">[in]</td><td class="paramname">numOfdecomp</td><td>the New number of decompositions </td></tr>
169     <tr><td class="paramdir">[in]</td><td class="paramname">SIZ</td><td>original SIZ marker information </td></tr>
170     <tr><td class="paramdir">[in]</td><td class="paramname">COD</td><td>original COD marker information </td></tr>
171     <tr><td class="paramdir">[out]</td><td class="paramname">j2klen</td><td>pointer to the length of j2k code stream </td></tr>
172   </table>
173   </dd>
174 </dl>
175 <dl class="section return"><dt>Returns</dt><dd>if succeeded (true) or failed (false) </dd></dl>
176
177 <p>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>
178
179 <p>Referenced by <a class="el" href="jp2k__encoder_8c.html#a5aafbf746124f238d36a0eeeb442ac7a">recons_codestream_from_JPPstream()</a>.</p>
180
181 </div>
182 </div>
183 <a class="anchor" id="aaf155590fb82d18a01ddef20353cf076"></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#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> modify_tileheader </td>
189           <td>(</td>
190           <td class="paramtype"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> *&#160;</td>
191           <td class="paramname"><em>j2kstream</em>, </td>
192         </tr>
193         <tr>
194           <td class="paramkey"></td>
195           <td></td>
196           <td class="paramtype"><a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a>&#160;</td>
197           <td class="paramname"><em>SOToffset</em>, </td>
198         </tr>
199         <tr>
200           <td class="paramkey"></td>
201           <td></td>
202           <td class="paramtype">int&#160;</td>
203           <td class="paramname"><em>numOfdecomp</em>, </td>
204         </tr>
205         <tr>
206           <td class="paramkey"></td>
207           <td></td>
208           <td class="paramtype"><a class="el" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a>&#160;</td>
209           <td class="paramname"><em>Csiz</em>, </td>
210         </tr>
211         <tr>
212           <td class="paramkey"></td>
213           <td></td>
214           <td class="paramtype"><a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a> *&#160;</td>
215           <td class="paramname"><em>j2klen</em>&#160;</td>
216         </tr>
217         <tr>
218           <td></td>
219           <td>)</td>
220           <td></td><td></td>
221         </tr>
222       </table>
223 </div><div class="memdoc">
224
225 <p>modify tile header in j2k codestream to fit with the tile part length, and new number of decompositions for multi-componet images </p>
226 <dl class="params"><dt>Parameters</dt><dd>
227   <table class="params">
228     <tr><td class="paramdir">[in]</td><td class="paramname">j2kstream</td><td>j2k codestream </td></tr>
229     <tr><td class="paramdir">[in]</td><td class="paramname">SOToffset</td><td>offset of SOT marker from the beginning of j2kstream </td></tr>
230     <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>
231     <tr><td class="paramdir">[in]</td><td class="paramname">Csiz</td><td>number of components </td></tr>
232     <tr><td class="paramdir">[out]</td><td class="paramname">j2klen</td><td>pointer to the length of j2k code stream </td></tr>
233   </table>
234   </dd>
235 </dl>
236 <dl class="section return"><dt>Returns</dt><dd>if succeeded (true) or failed (false) </dd></dl>
237
238 <p>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>
239
240 <p>Referenced by <a class="el" href="jp2k__encoder_8c.html#a5aafbf746124f238d36a0eeeb442ac7a">recons_codestream_from_JPPstream()</a>.</p>
241
242 </div>
243 </div>
244 </div><!-- contents -->
245 <!-- start footer part -->
246 <hr class="footer"/><address class="footer"><small>
247 Generated by &#160;<a href="http://www.doxygen.org/index.html">
248 <img class="footer" src="doxygen.png" alt="doxygen"/>
249 </a> 1.8.10
250 </small></address>
251 </body>
252 </html>