OpenJPEG  2.0.0
jp2.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2002-2007, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
3  * Copyright (c) 2002-2007, Professor Benoit Macq
4  * Copyright (c) 2002-2003, Yannick Verschueren
5  * Copyright (c) 2005, Herve Drolon, FreeImage Team
6  * Copyright (c) 2008;2011-2012, Centre National d'Etudes Spatiales (CNES), France
7  * Copyright (c) 2012, CS Systemes d'Information, France
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in the
17  * documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 #ifndef __JP2_H
32 #define __JP2_H
33 
41 
42 /*#define JPIP_JPIP 0x6a706970*/
43 
44 #define JP2_JP 0x6a502020
45 #define JP2_FTYP 0x66747970
46 #define JP2_JP2H 0x6a703268
47 #define JP2_IHDR 0x69686472
48 #define JP2_COLR 0x636f6c72
49 #define JP2_JP2C 0x6a703263
50 #define JP2_URL 0x75726c20
51 #define JP2_PCLR 0x70636c72
52 #define JP2_CMAP 0x636d6170
53 #define JP2_CDEF 0x63646566
54 #define JP2_DTBL 0x6474626c
55 #define JP2_BPCC 0x62706363
56 #define JP2_JP2 0x6a703220
58 /* For the future */
59 /* #define JP2_RES 0x72657320 */
60 /* #define JP2_JP2I 0x6a703269 */
61 /* #define JP2_XML 0x786d6c20 */
62 /* #define JP2_UUID 0x75756994 */
63 /* #define JP2_UINF 0x75696e66 */
64 /* #define JP2_ULST 0x756c7374 */
66 /* ----------------------------------------------------------------------- */
67 
68 typedef enum
69 {
70  JP2_STATE_NONE = 0x0,
71  JP2_STATE_SIGNATURE = 0x1,
72  JP2_STATE_FILE_TYPE = 0x2,
73  JP2_STATE_HEADER = 0x4,
74  JP2_STATE_CODESTREAM = 0x8,
75  JP2_STATE_END_CODESTREAM = 0x10,
76  JP2_STATE_UNKNOWN = 0x7fffffff /* ISO C restricts enumerator values to range of 'int' */
77 }
78 JP2_STATE;
79 
80 typedef enum
81 {
82  JP2_IMG_STATE_NONE = 0x0,
83  JP2_IMG_STATE_UNKNOWN = 0x7fffffff
84 }
85 JP2_IMG_STATE;
86 
90 typedef struct opj_jp2_cdef_info
91 {
92  OPJ_UINT16 cn, typ, asoc;
93 } opj_jp2_cdef_info_t;
94 
98 typedef struct opj_jp2_cdef
99 {
100  opj_jp2_cdef_info_t *info;
101  OPJ_UINT16 n;
102 } opj_jp2_cdef_t;
103 
107 typedef struct opj_jp2_cmap_comp
108 {
109  OPJ_UINT16 cmp;
110  OPJ_BYTE mtyp, pcol;
111 } opj_jp2_cmap_comp_t;
112 
116 typedef struct opj_jp2_pclr
117 {
118  OPJ_UINT32 *entries;
119  OPJ_BYTE *channel_sign;
120  OPJ_BYTE *channel_size;
121  opj_jp2_cmap_comp_t *cmap;
122  OPJ_UINT16 nr_entries;
123  OPJ_BYTE nr_channels;
124 } opj_jp2_pclr_t;
125 
129 typedef struct opj_jp2_color
130 {
131  OPJ_BYTE *icc_profile_buf;
132  OPJ_UINT32 icc_profile_len;
133 
134  opj_jp2_cdef_t *jp2_cdef;
135  opj_jp2_pclr_t *jp2_pclr;
136  OPJ_BYTE jp2_has_colr;
137 } opj_jp2_color_t;
138 
142 typedef struct opj_jp2_comps {
143  OPJ_UINT32 depth;
144  OPJ_UINT32 sgnd;
145  OPJ_UINT32 bpcc;
146 } opj_jp2_comps_t;
147 
151 typedef struct opj_jp2
152 {
154  opj_j2k_t *j2k;
156  struct opj_procedure_list * m_validation_list;
158  struct opj_procedure_list * m_procedure_list;
159 
160  /* width of image */
161  OPJ_UINT32 w;
162  /* height of image */
163  OPJ_UINT32 h;
164  /* number of components in the image */
165  OPJ_UINT32 numcomps;
166  OPJ_UINT32 bpc;
167  OPJ_UINT32 C;
168  OPJ_UINT32 UnkC;
169  OPJ_UINT32 IPR;
170  OPJ_UINT32 meth;
171  OPJ_UINT32 approx;
172  OPJ_UINT32 enumcs;
173  OPJ_UINT32 precedence;
174  OPJ_UINT32 brand;
175  OPJ_UINT32 minversion;
176  OPJ_UINT32 numcl;
177  OPJ_UINT32 *cl;
178  opj_jp2_comps_t *comps;
179  /* FIXME: The following two variables are used to save offset
180  as we write out a JP2 file to disk. This mecanism is not flexible
181  as codec writers will need to extand those fields as new part
182  of the standard are implemented.
183  */
184  OPJ_OFF_T j2k_codestream_offset;
185  OPJ_OFF_T jpip_iptr_offset;
186  OPJ_BOOL jpip_on;
187  OPJ_UINT32 jp2_state;
188  OPJ_UINT32 jp2_img_state;
189 
190  opj_jp2_color_t color;
191 
192  OPJ_BOOL ignore_pclr_cmap_cdef;
193 }
194 opj_jp2_t;
195 
199 typedef struct opj_jp2_box {
200  OPJ_UINT32 length;
201  OPJ_UINT32 type;
202  OPJ_INT32 init_pos;
203 } opj_jp2_box_t;
204 
205 typedef struct opj_jp2_header_handler
206 {
207  /* marker value */
208  OPJ_UINT32 id;
209  /* action linked to the marker */
210  OPJ_BOOL (*handler) ( opj_jp2_t *jp2,
211  OPJ_BYTE *p_header_data,
212  OPJ_UINT32 p_header_size,
213  opj_event_mgr_t * p_manager);
214 }
215 opj_jp2_header_handler_t;
216 
217 
218 typedef struct opj_jp2_img_header_writer_handler
219 {
220  /* action to perform */
221  OPJ_BYTE* (*handler) (opj_jp2_t *jp2, OPJ_UINT32 * p_data_size);
222  /* result of the action : data */
223  OPJ_BYTE* m_data;
224  /* size of data */
225  OPJ_UINT32 m_size;
226 }
227 opj_jp2_img_header_writer_handler_t;
228 
231 /* ----------------------------------------------------------------------- */
232 
242 OPJ_BOOL opj_jp2_write_jp2h(opj_jp2_t *jp2,
243  opj_stream_private_t *stream,
244  opj_event_mgr_t * p_manager );
245 
252 void opj_jp2_setup_decoder(opj_jp2_t *jp2, opj_dparameters_t *parameters);
253 
263 OPJ_BOOL opj_jp2_decode(opj_jp2_t *jp2,
264  opj_stream_private_t *p_stream,
265  opj_image_t* p_image,
266  opj_event_mgr_t * p_manager);
267 
277 void opj_jp2_setup_encoder( opj_jp2_t *jp2,
278  opj_cparameters_t *parameters,
279  opj_image_t *image,
280  opj_event_mgr_t * p_manager);
281 
289 OPJ_BOOL opj_jp2_encode( opj_jp2_t *jp2,
290  opj_stream_private_t *stream,
291  opj_event_mgr_t * p_manager);
292 
293 
304 OPJ_BOOL opj_jp2_start_compress(opj_jp2_t *jp2,
305  opj_stream_private_t *stream,
306  opj_image_t * p_image,
307  opj_event_mgr_t * p_manager);
308 
309 
314 OPJ_BOOL opj_jp2_end_compress( opj_jp2_t *jp2,
315  opj_stream_private_t *cio,
316  opj_event_mgr_t * p_manager);
317 
318 /* ----------------------------------------------------------------------- */
319 
324 OPJ_BOOL opj_jp2_end_decompress(opj_jp2_t *jp2,
325  opj_stream_private_t *cio,
326  opj_event_mgr_t * p_manager);
327 
338 OPJ_BOOL opj_jp2_read_header( opj_stream_private_t *p_stream,
339  opj_jp2_t *jp2,
340  opj_image_t ** p_image,
341  opj_event_mgr_t * p_manager );
342 
357 OPJ_BOOL opj_jp2_read_tile_header ( opj_jp2_t * p_jp2,
358  OPJ_UINT32 * p_tile_index,
359  OPJ_UINT32 * p_data_size,
360  OPJ_INT32 * p_tile_x0,
361  OPJ_INT32 * p_tile_y0,
362  OPJ_INT32 * p_tile_x1,
363  OPJ_INT32 * p_tile_y1,
364  OPJ_UINT32 * p_nb_comps,
365  OPJ_BOOL * p_go_on,
366  opj_stream_private_t *p_stream,
367  opj_event_mgr_t * p_manager );
368 
379 OPJ_BOOL opj_jp2_write_tile ( opj_jp2_t *p_jp2,
380  OPJ_UINT32 p_tile_index,
381  OPJ_BYTE * p_data,
382  OPJ_UINT32 p_data_size,
383  opj_stream_private_t *p_stream,
384  opj_event_mgr_t * p_manager );
385 
397 OPJ_BOOL opj_jp2_decode_tile ( opj_jp2_t * p_jp2,
398  OPJ_UINT32 p_tile_index,
399  OPJ_BYTE * p_data,
400  OPJ_UINT32 p_data_size,
401  opj_stream_private_t *p_stream,
402  opj_event_mgr_t * p_manager );
403 
409 opj_jp2_t* opj_jp2_create (OPJ_BOOL p_is_decoder);
410 
415 void opj_jp2_destroy(opj_jp2_t *jp2);
416 
417 
431 OPJ_BOOL opj_jp2_set_decode_area( opj_jp2_t *p_jp2,
432  opj_image_t* p_image,
433  OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,
434  OPJ_INT32 p_end_x, OPJ_INT32 p_end_y,
435  opj_event_mgr_t * p_manager );
436 
440 OPJ_BOOL opj_jp2_get_tile( opj_jp2_t *p_jp2,
441  opj_stream_private_t *p_stream,
442  opj_image_t* p_image,
443  opj_event_mgr_t * p_manager,
444  OPJ_UINT32 tile_index );
445 
446 
450 OPJ_BOOL opj_jp2_set_decoded_resolution_factor(opj_jp2_t *p_jp2,
451  OPJ_UINT32 res_factor,
452  opj_event_mgr_t * p_manager);
453 
454 
455 /* TODO MSD: clean these 3 functions */
464 void jp2_dump (opj_jp2_t* p_jp2, OPJ_INT32 flag, FILE* out_stream);
465 
473 opj_codestream_info_v2_t* jp2_get_cstr_info(opj_jp2_t* p_jp2);
474 
482 opj_codestream_index_t* jp2_get_cstr_index(opj_jp2_t* p_jp2);
483 
484 
488 
489 #endif /* __JP2_H */
490 
Generated by   doxygen 1.8.3.1