Update Doxygen doc
[openjpeg.git] / doxygen / jp2k__decoder_8c.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_decoder.c 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_decoder.c File Reference</div>  </div>
55 </div><!--header-->
56 <div class="contents">
57 <div class="textblock"><code>#include &lt;stdio.h&gt;</code><br />
58 <code>#include &lt;string.h&gt;</code><br />
59 <code>#include &lt;stdlib.h&gt;</code><br />
60 <code>#include &lt;assert.h&gt;</code><br />
61 <code>#include &lt;limits.h&gt;</code><br />
62 <code>#include &quot;<a class="el" href="jp2k__decoder_8h_source.html">jp2k_decoder.h</a>&quot;</code><br />
63 <code>#include &quot;<a class="el" href="openjpeg_8h_source.html">openjpeg.h</a>&quot;</code><br />
64 </div><table class="memberdecls">
65 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
66 Functions</h2></td></tr>
67 <tr class="memitem:ac13f43a496730fa9f5e1c7027d12cf5c"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="jp2k__decoder_8c.html#ac13f43a496730fa9f5e1c7027d12cf5c">error_callback</a> (const char *msg, void *client_data)</td></tr>
68 <tr class="memdesc:ac13f43a496730fa9f5e1c7027d12cf5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">sample error callback expecting a FILE* client object  <a href="#ac13f43a496730fa9f5e1c7027d12cf5c">More...</a><br /></td></tr>
69 <tr class="separator:ac13f43a496730fa9f5e1c7027d12cf5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
70 <tr class="memitem:a7155c221d3437696eb0ee9d3fe47f72a"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="jp2k__decoder_8c.html#a7155c221d3437696eb0ee9d3fe47f72a">warning_callback</a> (const char *msg, void *client_data)</td></tr>
71 <tr class="memdesc:a7155c221d3437696eb0ee9d3fe47f72a"><td class="mdescLeft">&#160;</td><td class="mdescRight">sample warning callback expecting a FILE* client object  <a href="#a7155c221d3437696eb0ee9d3fe47f72a">More...</a><br /></td></tr>
72 <tr class="separator:a7155c221d3437696eb0ee9d3fe47f72a"><td class="memSeparator" colspan="2">&#160;</td></tr>
73 <tr class="memitem:af5fad34d4ded181954f44540e94c2c9b"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="jp2k__decoder_8c.html#af5fad34d4ded181954f44540e94c2c9b">info_callback</a> (const char *msg, void *client_data)</td></tr>
74 <tr class="memdesc:af5fad34d4ded181954f44540e94c2c9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">sample debug callback expecting no client object  <a href="#af5fad34d4ded181954f44540e94c2c9b">More...</a><br /></td></tr>
75 <tr class="separator:af5fad34d4ded181954f44540e94c2c9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
76 <tr class="memitem:a1f99d031f0df16b1d45b0ea488bacc19"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="jp2k__decoder_8c.html#a1f99d031f0df16b1d45b0ea488bacc19">imagetopnm</a> (<a class="el" href="openjpeg_8h.html#a5c557180c59d54a2f1d29e8639687aa4">opj_image_t</a> *image, <a class="el" href="ihdrbox__manager_8h.html#ae88b004f80ae7e57d50cdbee20e25199">ihdrbox_param_t</a> **ihdrbox)</td></tr>
77 <tr class="separator:a1f99d031f0df16b1d45b0ea488bacc19"><td class="memSeparator" colspan="2">&#160;</td></tr>
78 <tr class="memitem:a261799e8487d1b77fc04948abe701e5f"><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__decoder_8c.html#a261799e8487d1b77fc04948abe701e5f">j2k_to_pnm</a> (const char *fn, <a class="el" href="ihdrbox__manager_8h.html#ae88b004f80ae7e57d50cdbee20e25199">ihdrbox_param_t</a> **ihdrbox)</td></tr>
79 <tr class="separator:a261799e8487d1b77fc04948abe701e5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
80 </table>
81 <h2 class="groupheader">Function Documentation</h2>
82 <a class="anchor" id="ac13f43a496730fa9f5e1c7027d12cf5c"></a>
83 <div class="memitem">
84 <div class="memproto">
85 <table class="mlabels">
86   <tr>
87   <td class="mlabels-left">
88       <table class="memname">
89         <tr>
90           <td class="memname">static void error_callback </td>
91           <td>(</td>
92           <td class="paramtype">const char *&#160;</td>
93           <td class="paramname"><em>msg</em>, </td>
94         </tr>
95         <tr>
96           <td class="paramkey"></td>
97           <td></td>
98           <td class="paramtype">void *&#160;</td>
99           <td class="paramname"><em>client_data</em>&#160;</td>
100         </tr>
101         <tr>
102           <td></td>
103           <td>)</td>
104           <td></td><td></td>
105         </tr>
106       </table>
107   </td>
108   <td class="mlabels-right">
109 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
110   </tr>
111 </table>
112 </div><div class="memdoc">
113
114 <p>sample error callback expecting a FILE* client object </p>
115
116 <p>Referenced by <a class="el" href="jp2k__decoder_8h.html#a261799e8487d1b77fc04948abe701e5f">j2k_to_pnm()</a>.</p>
117
118 </div>
119 </div>
120 <a class="anchor" id="a1f99d031f0df16b1d45b0ea488bacc19"></a>
121 <div class="memitem">
122 <div class="memproto">
123 <table class="mlabels">
124   <tr>
125   <td class="mlabels-left">
126       <table class="memname">
127         <tr>
128           <td class="memname">static <a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> * imagetopnm </td>
129           <td>(</td>
130           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a5c557180c59d54a2f1d29e8639687aa4">opj_image_t</a> *&#160;</td>
131           <td class="paramname"><em>image</em>, </td>
132         </tr>
133         <tr>
134           <td class="paramkey"></td>
135           <td></td>
136           <td class="paramtype"><a class="el" href="ihdrbox__manager_8h.html#ae88b004f80ae7e57d50cdbee20e25199">ihdrbox_param_t</a> **&#160;</td>
137           <td class="paramname"><em>ihdrbox</em>&#160;</td>
138         </tr>
139         <tr>
140           <td></td>
141           <td>)</td>
142           <td></td><td></td>
143         </tr>
144       </table>
145   </td>
146   <td class="mlabels-right">
147 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
148   </tr>
149 </table>
150 </div><div class="memdoc">
151
152 <p>References <a class="el" href="structopj__image.html#a6b52b100c934697a29446af5c3e0fa00">opj_image::comps</a>, <a class="el" href="structopj__image__comp.html#ad676bf364b0c8fc889e97cc684ce95d0">opj_image_comp::data</a>, <a class="el" href="structopj__image__comp.html#a11ecb361a0c49b482c90573a868cc8dc">opj_image_comp::h</a>, <a class="el" href="structopj__image.html#ac63093741ed0c70b9c0a8ee3070cbce6">opj_image::numcomps</a>, <a class="el" href="structopj__image__comp.html#ab7210ddbf12e6d9998d24034a579cea1">opj_image_comp::prec</a>, <a class="el" href="structopj__image__comp.html#a2d2337d15fd837252fe250386bac7fb9">opj_image_comp::sgnd</a>, <a class="el" href="structopj__image__comp.html#a59225121158d5bc911838e5b05779cdb">opj_image_comp::w</a>, and <a class="el" href="structihdrbox__param.html#ad3760ecc26048cde5501e8eb646539fd">ihdrbox_param::width</a>.</p>
153
154 <p>Referenced by <a class="el" href="jp2k__decoder_8h.html#a261799e8487d1b77fc04948abe701e5f">j2k_to_pnm()</a>.</p>
155
156 </div>
157 </div>
158 <a class="anchor" id="af5fad34d4ded181954f44540e94c2c9b"></a>
159 <div class="memitem">
160 <div class="memproto">
161 <table class="mlabels">
162   <tr>
163   <td class="mlabels-left">
164       <table class="memname">
165         <tr>
166           <td class="memname">static void info_callback </td>
167           <td>(</td>
168           <td class="paramtype">const char *&#160;</td>
169           <td class="paramname"><em>msg</em>, </td>
170         </tr>
171         <tr>
172           <td class="paramkey"></td>
173           <td></td>
174           <td class="paramtype">void *&#160;</td>
175           <td class="paramname"><em>client_data</em>&#160;</td>
176         </tr>
177         <tr>
178           <td></td>
179           <td>)</td>
180           <td></td><td></td>
181         </tr>
182       </table>
183   </td>
184   <td class="mlabels-right">
185 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
186   </tr>
187 </table>
188 </div><div class="memdoc">
189
190 <p>sample debug callback expecting no client object </p>
191
192 <p>Referenced by <a class="el" href="jp2k__decoder_8h.html#a261799e8487d1b77fc04948abe701e5f">j2k_to_pnm()</a>.</p>
193
194 </div>
195 </div>
196 <a class="anchor" id="a261799e8487d1b77fc04948abe701e5f"></a>
197 <div class="memitem">
198 <div class="memproto">
199       <table class="memname">
200         <tr>
201           <td class="memname"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a>* j2k_to_pnm </td>
202           <td>(</td>
203           <td class="paramtype">const char *&#160;</td>
204           <td class="paramname"><em>fn</em>, </td>
205         </tr>
206         <tr>
207           <td class="paramkey"></td>
208           <td></td>
209           <td class="paramtype"><a class="el" href="ihdrbox__manager_8h.html#ae88b004f80ae7e57d50cdbee20e25199">ihdrbox_param_t</a> **&#160;</td>
210           <td class="paramname"><em>ihdrbox</em>&#160;</td>
211         </tr>
212         <tr>
213           <td></td>
214           <td>)</td>
215           <td></td><td></td>
216         </tr>
217       </table>
218 </div><div class="memdoc">
219
220 <p>References <a class="el" href="structopj__dparameters.html#a440bb7c355913b2dade15a4b811f3f23">opj_dparameters::DA_x0</a>, <a class="el" href="structopj__dparameters.html#a98e9ceaf5c68dcc39019ec707961e24d">opj_dparameters::DA_x1</a>, <a class="el" href="structopj__dparameters.html#a3349a1210e55ae91e8eb9446fb6f979f">opj_dparameters::DA_y0</a>, <a class="el" href="structopj__dparameters.html#a52c99d552c89a73a85710fb313de6995">opj_dparameters::DA_y1</a>, <a class="el" href="jp2k__decoder_8c.html#ac13f43a496730fa9f5e1c7027d12cf5c">error_callback()</a>, <a class="el" href="jp2k__decoder_8c.html#a1f99d031f0df16b1d45b0ea488bacc19">imagetopnm()</a>, <a class="el" href="jp2k__decoder_8c.html#af5fad34d4ded181954f44540e94c2c9b">info_callback()</a>, <a class="el" href="openjpeg_8h.html#a1d857738cef754699ffb79ddff48efbfa8600e6e00112f983e5bb7d4daad836ab">OPJ_CODEC_J2K</a>, <a class="el" href="openjpeg_8c.html#ab9b3cca67f964a3099a64729744084c8">opj_create_decompress()</a>, <a class="el" href="openjpeg_8c.html#af5b94be0890f895a5527eb3ca9abe2f1">opj_decode()</a>, <a class="el" href="openjpeg_8c.html#ab801406c7e356d798777e0052943e348">opj_destroy_codec()</a>, <a class="el" href="openjpeg_8c.html#a2a9a4836a18cc832d8683508235c900d">opj_end_decompress()</a>, <a class="el" href="image_8c.html#a193f6a609b0a3c4aa4912be9c987cd14">opj_image_destroy()</a>, <a class="el" href="openjpeg_8c.html#aad24422789c9a57e5a62cae7892db4be">opj_read_header()</a>, <a class="el" href="openjpeg_8c.html#aea476bddc65f8bf5b5b2bbbe41af7389">opj_set_decode_area()</a>, <a class="el" href="openjpeg_8c.html#a4404982cd554e2251772043ea12e5164">opj_set_default_decoder_parameters()</a>, <a class="el" href="openjpeg_8c.html#a0b847b8776315c6f654a6ad7c2d8af67">opj_set_error_handler()</a>, <a class="el" href="openjpeg_8c.html#a6b7606d660444e8f414aa6e2c148fa44">opj_set_info_handler()</a>, <a class="el" href="openjpeg_8c.html#ab460c38323da1140f66763aa419c404b">opj_set_warning_handler()</a>, <a class="el" href="openjpeg_8c.html#ad8473386b576be935efe653b9773ba06">opj_setup_decoder()</a>, <a class="el" href="openjpeg_8c.html#acb36a77efa64f8332c27fc4ea6be066c">opj_stream_create_default_file_stream()</a>, <a class="el" href="cio_8c.html#ac0686c0048dfa2d2fcffaf649891ea58">opj_stream_destroy()</a>, <a class="el" href="openjpeg_8h.html#a04830036d767cba56cbf5ae5bdc481d3">OPJ_TRUE</a>, and <a class="el" href="jp2k__decoder_8c.html#a7155c221d3437696eb0ee9d3fe47f72a">warning_callback()</a>.</p>
221
222 <p>Referenced by <a class="el" href="jpipstream__manager_8h.html#a6a3ef3a0ef8ec42a1f90dd6f2776ec37">jpipstream_to_pnm()</a>.</p>
223
224 </div>
225 </div>
226 <a class="anchor" id="a7155c221d3437696eb0ee9d3fe47f72a"></a>
227 <div class="memitem">
228 <div class="memproto">
229 <table class="mlabels">
230   <tr>
231   <td class="mlabels-left">
232       <table class="memname">
233         <tr>
234           <td class="memname">static void warning_callback </td>
235           <td>(</td>
236           <td class="paramtype">const char *&#160;</td>
237           <td class="paramname"><em>msg</em>, </td>
238         </tr>
239         <tr>
240           <td class="paramkey"></td>
241           <td></td>
242           <td class="paramtype">void *&#160;</td>
243           <td class="paramname"><em>client_data</em>&#160;</td>
244         </tr>
245         <tr>
246           <td></td>
247           <td>)</td>
248           <td></td><td></td>
249         </tr>
250       </table>
251   </td>
252   <td class="mlabels-right">
253 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
254   </tr>
255 </table>
256 </div><div class="memdoc">
257
258 <p>sample warning callback expecting a FILE* client object </p>
259
260 <p>Referenced by <a class="el" href="jp2k__decoder_8h.html#a261799e8487d1b77fc04948abe701e5f">j2k_to_pnm()</a>.</p>
261
262 </div>
263 </div>
264 </div><!-- contents -->
265 <!-- start footer part -->
266 <hr class="footer"/><address class="footer"><small>
267 Generated by &#160;<a href="http://www.doxygen.org/index.html">
268 <img class="footer" src="doxygen.png" alt="doxygen"/>
269 </a> 1.8.10
270 </small></address>
271 </body>
272 </html>