Update Doxygen doc
[openjpeg.git] / doxygen / jp2k__encoder_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: jp2k_encoder.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">jp2k_encoder.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="msgqueue__manager_8h_source.html">msgqueue_manager.h</a>&quot;</code><br />
59 </div>
60 <p><a href="jp2k__encoder_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:ae4142d75ff68c5e6e239baa617aac74d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="jp2k__encoder_8h.html#ae4142d75ff68c5e6e239baa617aac74d">recons_j2k</a> (<a class="el" href="msgqueue__manager_8h.html#a48165c91ebacfac47c1b5aca2f82869f">msgqueue_param_t</a> *msgqueue, <a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> *jpipstream, <a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a> csn, int fw, int fh, <a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a> *j2klen)</td></tr>
65 <tr class="memdesc:ae4142d75ff68c5e6e239baa617aac74d"><td class="mdescLeft">&#160;</td><td class="mdescRight">reconstruct j2k codestream from message queue  <a href="#ae4142d75ff68c5e6e239baa617aac74d">More...</a><br /></td></tr>
66 <tr class="separator:ae4142d75ff68c5e6e239baa617aac74d"><td class="memSeparator" colspan="2">&#160;</td></tr>
67 <tr class="memitem:a8689276a4011c848be0ac10496bf3809"><td class="memItemLeft" align="right" valign="top"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="jp2k__encoder_8h.html#a8689276a4011c848be0ac10496bf3809">recons_jp2</a> (<a class="el" href="msgqueue__manager_8h.html#a48165c91ebacfac47c1b5aca2f82869f">msgqueue_param_t</a> *msgqueue, <a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> *jpipstream, <a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a> csn, <a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a> *jp2len)</td></tr>
68 <tr class="memdesc:a8689276a4011c848be0ac10496bf3809"><td class="mdescLeft">&#160;</td><td class="mdescRight">reconstruct jp2 file codestream from message queue  <a href="#a8689276a4011c848be0ac10496bf3809">More...</a><br /></td></tr>
69 <tr class="separator:a8689276a4011c848be0ac10496bf3809"><td class="memSeparator" colspan="2">&#160;</td></tr>
70 <tr class="memitem:aae208fb0cb201969e96cda2e7df3c7cc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="jp2k__encoder_8h.html#aae208fb0cb201969e96cda2e7df3c7cc">recons_j2kmainhead</a> (<a class="el" href="msgqueue__manager_8h.html#a48165c91ebacfac47c1b5aca2f82869f">msgqueue_param_t</a> *msgqueue, <a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> *jpipstream, <a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a> csn, <a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a> *j2klen)</td></tr>
71 <tr class="memdesc:aae208fb0cb201969e96cda2e7df3c7cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">reconstruct j2k codestream of mainheader from message queue  <a href="#aae208fb0cb201969e96cda2e7df3c7cc">More...</a><br /></td></tr>
72 <tr class="separator:aae208fb0cb201969e96cda2e7df3c7cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
73 </table>
74 <h2 class="groupheader">Function Documentation</h2>
75 <a class="anchor" id="ae4142d75ff68c5e6e239baa617aac74d"></a>
76 <div class="memitem">
77 <div class="memproto">
78       <table class="memname">
79         <tr>
80           <td class="memname"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a>* recons_j2k </td>
81           <td>(</td>
82           <td class="paramtype"><a class="el" href="msgqueue__manager_8h.html#a48165c91ebacfac47c1b5aca2f82869f">msgqueue_param_t</a> *&#160;</td>
83           <td class="paramname"><em>msgqueue</em>, </td>
84         </tr>
85         <tr>
86           <td class="paramkey"></td>
87           <td></td>
88           <td class="paramtype"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> *&#160;</td>
89           <td class="paramname"><em>jpipstream</em>, </td>
90         </tr>
91         <tr>
92           <td class="paramkey"></td>
93           <td></td>
94           <td class="paramtype"><a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a>&#160;</td>
95           <td class="paramname"><em>csn</em>, </td>
96         </tr>
97         <tr>
98           <td class="paramkey"></td>
99           <td></td>
100           <td class="paramtype">int&#160;</td>
101           <td class="paramname"><em>fw</em>, </td>
102         </tr>
103         <tr>
104           <td class="paramkey"></td>
105           <td></td>
106           <td class="paramtype">int&#160;</td>
107           <td class="paramname"><em>fh</em>, </td>
108         </tr>
109         <tr>
110           <td class="paramkey"></td>
111           <td></td>
112           <td class="paramtype"><a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a> *&#160;</td>
113           <td class="paramname"><em>j2klen</em>&#160;</td>
114         </tr>
115         <tr>
116           <td></td>
117           <td>)</td>
118           <td></td><td></td>
119         </tr>
120       </table>
121 </div><div class="memdoc">
122
123 <p>reconstruct j2k codestream from message queue </p>
124 <dl class="params"><dt>Parameters</dt><dd>
125   <table class="params">
126     <tr><td class="paramdir">[in]</td><td class="paramname">msgqueue</td><td>message queue pointer </td></tr>
127     <tr><td class="paramdir">[in]</td><td class="paramname">jpipstream</td><td>original jpt- jpp- stream </td></tr>
128     <tr><td class="paramdir">[in]</td><td class="paramname">csn</td><td>codestream number </td></tr>
129     <tr><td class="paramdir">[in]</td><td class="paramname">fw</td><td>reconstructing image frame width </td></tr>
130     <tr><td class="paramdir">[in]</td><td class="paramname">fh</td><td>reconstructing image frame height </td></tr>
131     <tr><td class="paramdir">[out]</td><td class="paramname">j2klen</td><td>pointer to the j2k codestream length </td></tr>
132   </table>
133   </dd>
134 </dl>
135 <dl class="section return"><dt>Returns</dt><dd>generated reconstructed j2k codestream </dd></dl>
136
137 <p>References <a class="el" href="jp2k__encoder_8c.html#a550ca6a746bd47124122bc2790d914d0">recons_codestream()</a>.</p>
138
139 <p>Referenced by <a class="el" href="openjpip_8h.html#ac5f5f8d1b581e02b6f1afb417a7dbef8">decode_jpip()</a>, and <a class="el" href="jpipstream__manager_8h.html#a6a3ef3a0ef8ec42a1f90dd6f2776ec37">jpipstream_to_pnm()</a>.</p>
140
141 </div>
142 </div>
143 <a class="anchor" id="aae208fb0cb201969e96cda2e7df3c7cc"></a>
144 <div class="memitem">
145 <div class="memproto">
146       <table class="memname">
147         <tr>
148           <td class="memname"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a>* recons_j2kmainhead </td>
149           <td>(</td>
150           <td class="paramtype"><a class="el" href="msgqueue__manager_8h.html#a48165c91ebacfac47c1b5aca2f82869f">msgqueue_param_t</a> *&#160;</td>
151           <td class="paramname"><em>msgqueue</em>, </td>
152         </tr>
153         <tr>
154           <td class="paramkey"></td>
155           <td></td>
156           <td class="paramtype"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> *&#160;</td>
157           <td class="paramname"><em>jpipstream</em>, </td>
158         </tr>
159         <tr>
160           <td class="paramkey"></td>
161           <td></td>
162           <td class="paramtype"><a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a>&#160;</td>
163           <td class="paramname"><em>csn</em>, </td>
164         </tr>
165         <tr>
166           <td class="paramkey"></td>
167           <td></td>
168           <td class="paramtype"><a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a> *&#160;</td>
169           <td class="paramname"><em>j2klen</em>&#160;</td>
170         </tr>
171         <tr>
172           <td></td>
173           <td>)</td>
174           <td></td><td></td>
175         </tr>
176       </table>
177 </div><div class="memdoc">
178
179 <p>reconstruct j2k codestream of mainheader from message queue </p>
180 <dl class="params"><dt>Parameters</dt><dd>
181   <table class="params">
182     <tr><td class="paramdir">[in]</td><td class="paramname">msgqueue</td><td>message queue pointer </td></tr>
183     <tr><td class="paramdir">[in]</td><td class="paramname">jpipstream</td><td>original jpt- jpp- stream </td></tr>
184     <tr><td class="paramdir">[in]</td><td class="paramname">csn</td><td>codestream number </td></tr>
185     <tr><td class="paramdir">[out]</td><td class="paramname">j2klen</td><td>pointer to the j2k codestream length </td></tr>
186   </table>
187   </dd>
188 </dl>
189 <dl class="section return"><dt>Returns</dt><dd>generated reconstructed j2k codestream </dd></dl>
190
191 <p>References <a class="el" href="jp2k__encoder_8c.html#a59c3e28892eb7f1b2bfec422ef933aba">add_mainhead_msgstream()</a>.</p>
192
193 <p>Referenced by <a class="el" href="jpipstream__manager_8h.html#a38dc84677da3c6c449d00254f62624e7">get_SIZ_from_jpipstream()</a>.</p>
194
195 </div>
196 </div>
197 <a class="anchor" id="a8689276a4011c848be0ac10496bf3809"></a>
198 <div class="memitem">
199 <div class="memproto">
200       <table class="memname">
201         <tr>
202           <td class="memname"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a>* recons_jp2 </td>
203           <td>(</td>
204           <td class="paramtype"><a class="el" href="msgqueue__manager_8h.html#a48165c91ebacfac47c1b5aca2f82869f">msgqueue_param_t</a> *&#160;</td>
205           <td class="paramname"><em>msgqueue</em>, </td>
206         </tr>
207         <tr>
208           <td class="paramkey"></td>
209           <td></td>
210           <td class="paramtype"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> *&#160;</td>
211           <td class="paramname"><em>jpipstream</em>, </td>
212         </tr>
213         <tr>
214           <td class="paramkey"></td>
215           <td></td>
216           <td class="paramtype"><a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a>&#160;</td>
217           <td class="paramname"><em>csn</em>, </td>
218         </tr>
219         <tr>
220           <td class="paramkey"></td>
221           <td></td>
222           <td class="paramtype"><a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a> *&#160;</td>
223           <td class="paramname"><em>jp2len</em>&#160;</td>
224         </tr>
225         <tr>
226           <td></td>
227           <td>)</td>
228           <td></td><td></td>
229         </tr>
230       </table>
231 </div><div class="memdoc">
232
233 <p>reconstruct jp2 file codestream from message queue </p>
234 <dl class="params"><dt>Parameters</dt><dd>
235   <table class="params">
236     <tr><td class="paramdir">[in]</td><td class="paramname">msgqueue</td><td>message queue pointer </td></tr>
237     <tr><td class="paramdir">[in]</td><td class="paramname">jpipstream</td><td>original jpt- jpp- stream </td></tr>
238     <tr><td class="paramdir">[in]</td><td class="paramname">csn</td><td>codestream number </td></tr>
239     <tr><td class="paramdir">[out]</td><td class="paramname">jp2len</td><td>pointer to the jp2 codestream length </td></tr>
240   </table>
241   </dd>
242 </dl>
243 <dl class="section return"><dt>Returns</dt><dd>generated reconstructed jp2 codestream </dd></dl>
244
245 <p>References <a class="el" href="jp2k__encoder_8c.html#acb31f818ceb9ea74dccfe83f60d6efe9">add_emptyboxstream()</a>, <a class="el" href="jp2k__encoder_8c.html#a7cbcd4b8d0f130426d34bdc3571463fc">add_msgstream()</a>, <a class="el" href="structmsgqueue__param.html#a7e14c8f89c279bc703cc76070ef2316e">msgqueue_param::first</a>, <a class="el" href="msgqueue__manager_8h.html#a939962e031be51df7f09de3cf05f83e4">METADATA_MSG</a>, <a class="el" href="structmessage__param.html#af349d721c012c38dc1626ee162c767b2">message_param::next</a>, <a class="el" href="group___m_i_s_c.html#ga2bd00e2482ae36197631bde0665cfdfe">opj_free()</a>, <a class="el" href="structplaceholder__param.html#ab93cef245c48fc559277a34ce7693787">placeholder_param::OrigBH</a>, <a class="el" href="structplaceholder__param.html#a8986cbfa09947528724c1f152270cb9a">placeholder_param::OrigBHlen</a>, <a class="el" href="structmessage__param.html#a690bbcfbf5400ae15b68a17495ca5640">message_param::phld</a>, <a class="el" href="jp2k__encoder_8c.html#a550ca6a746bd47124122bc2790d914d0">recons_codestream()</a>, and <a class="el" href="jp2k__encoder_8c.html#a8a32427c8bfa4c356ed9cd130808bbbd">search_message()</a>.</p>
246
247 <p>Referenced by <a class="el" href="openjpip_8h.html#ac5f5f8d1b581e02b6f1afb417a7dbef8">decode_jpip()</a>, and <a class="el" href="dec__clientmsg__handler_8h.html#a163197f925cd8d6f60da5b6151e01c3b">handle_JP2saveMSG()</a>.</p>
248
249 </div>
250 </div>
251 </div><!-- contents -->
252 <!-- start footer part -->
253 <hr class="footer"/><address class="footer"><small>
254 Generated by &#160;<a href="http://www.doxygen.org/index.html">
255 <img class="footer" src="doxygen.png" alt="doxygen"/>
256 </a> 1.8.10
257 </small></address>
258 </body>
259 </html>