OpenJPEG  2.3.1
jp2.h
Go to the documentation of this file.
1 /*
2  * The copyright in this software is being made available under the 2-clauses
3  * BSD License, included below. This software may be subject to other third
4  * party and contributor rights, including patent rights, and no such rights
5  * are granted under this license.
6  *
7  * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
8  * Copyright (c) 2002-2014, Professor Benoit Macq
9  * Copyright (c) 2002-2003, Yannick Verschueren
10  * Copyright (c) 2005, Herve Drolon, FreeImage Team
11  * Copyright (c) 2008, 2011-2012, Centre National d'Etudes Spatiales (CNES), FR
12  * Copyright (c) 2012, CS Systemes d'Information, France
13  * All rights reserved.
14  *
15  * Redistribution and use in source and binary forms, with or without
16  * modification, are permitted provided that the following conditions
17  * are met:
18  * 1. Redistributions of source code must retain the above copyright
19  * notice, this list of conditions and the following disclaimer.
20  * 2. Redistributions in binary form must reproduce the above copyright
21  * notice, this list of conditions and the following disclaimer in the
22  * documentation and/or other materials provided with the distribution.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
25  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
28  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34  * POSSIBILITY OF SUCH DAMAGE.
35  */
36 #ifndef OPJ_JP2_H
37 #define OPJ_JP2_H
38 
46 
47 /*#define JPIP_JPIP 0x6a706970*/
48 
49 #define JP2_JP 0x6a502020
50 #define JP2_FTYP 0x66747970
51 #define JP2_JP2H 0x6a703268
52 #define JP2_IHDR 0x69686472
53 #define JP2_COLR 0x636f6c72
54 #define JP2_JP2C 0x6a703263
55 #define JP2_URL 0x75726c20
56 #define JP2_PCLR 0x70636c72
57 #define JP2_CMAP 0x636d6170
58 #define JP2_CDEF 0x63646566
59 #define JP2_DTBL 0x6474626c
60 #define JP2_BPCC 0x62706363
61 #define JP2_JP2 0x6a703220
63 /* For the future */
64 /* #define JP2_RES 0x72657320 */
65 /* #define JP2_JP2I 0x6a703269 */
66 /* #define JP2_XML 0x786d6c20 */
67 /* #define JP2_UUID 0x75756994 */
68 /* #define JP2_UINF 0x75696e66 */
69 /* #define JP2_ULST 0x756c7374 */
71 /* ----------------------------------------------------------------------- */
72 
73 typedef enum {
74  JP2_STATE_NONE = 0x0,
75  JP2_STATE_SIGNATURE = 0x1,
76  JP2_STATE_FILE_TYPE = 0x2,
77  JP2_STATE_HEADER = 0x4,
78  JP2_STATE_CODESTREAM = 0x8,
79  JP2_STATE_END_CODESTREAM = 0x10,
80  JP2_STATE_UNKNOWN = 0x7fffffff /* ISO C restricts enumerator values to range of 'int' */
81 }
82 JP2_STATE;
83 
84 typedef enum {
85  JP2_IMG_STATE_NONE = 0x0,
86  JP2_IMG_STATE_UNKNOWN = 0x7fffffff
87 }
88 JP2_IMG_STATE;
89 
93 typedef struct opj_jp2_cdef_info {
94  OPJ_UINT16 cn, typ, asoc;
95 } opj_jp2_cdef_info_t;
96 
100 typedef struct opj_jp2_cdef {
101  opj_jp2_cdef_info_t *info;
102  OPJ_UINT16 n;
103 } opj_jp2_cdef_t;
104 
108 typedef struct opj_jp2_cmap_comp {
109  OPJ_UINT16 cmp;
110  OPJ_BYTE mtyp, pcol;
111 } opj_jp2_cmap_comp_t;
112 
116 typedef struct opj_jp2_pclr {
117  OPJ_UINT32 *entries;
118  OPJ_BYTE *channel_sign;
119  OPJ_BYTE *channel_size;
120  opj_jp2_cmap_comp_t *cmap;
121  OPJ_UINT16 nr_entries;
122  OPJ_BYTE nr_channels;
123 } opj_jp2_pclr_t;
124 
128 typedef struct opj_jp2_color {
129  OPJ_BYTE *icc_profile_buf;
130  OPJ_UINT32 icc_profile_len;
131 
132  opj_jp2_cdef_t *jp2_cdef;
133  opj_jp2_pclr_t *jp2_pclr;
134  OPJ_BYTE jp2_has_colr;
135 } opj_jp2_color_t;
136 
140 typedef struct opj_jp2_comps {
141  OPJ_UINT32 depth;
142  OPJ_UINT32 sgnd;
143  OPJ_UINT32 bpcc;
144 } opj_jp2_comps_t;
145 
149 typedef struct opj_jp2 {
151  opj_j2k_t *j2k;
153  struct opj_procedure_list * m_validation_list;
155  struct opj_procedure_list * m_procedure_list;
156 
157  /* width of image */
158  OPJ_UINT32 w;
159  /* height of image */
160  OPJ_UINT32 h;
161  /* number of components in the image */
162  OPJ_UINT32 numcomps;
163  OPJ_UINT32 bpc;
164  OPJ_UINT32 C;
165  OPJ_UINT32 UnkC;
166  OPJ_UINT32 IPR;
167  OPJ_UINT32 meth;
168  OPJ_UINT32 approx;
169  OPJ_UINT32 enumcs;
170  OPJ_UINT32 precedence;
171  OPJ_UINT32 brand;
172  OPJ_UINT32 minversion;
173  OPJ_UINT32 numcl;
174  OPJ_UINT32 *cl;
175  opj_jp2_comps_t *comps;
176  /* FIXME: The following two variables are used to save offset
177  as we write out a JP2 file to disk. This mechanism is not flexible
178  as codec writers will need to extand those fields as new part
179  of the standard are implemented.
180  */
181  OPJ_OFF_T j2k_codestream_offset;
182  OPJ_OFF_T jpip_iptr_offset;
183  OPJ_BOOL jpip_on;
184  OPJ_UINT32 jp2_state;
185  OPJ_UINT32 jp2_img_state;
186 
187  opj_jp2_color_t color;
188 
189  OPJ_BOOL ignore_pclr_cmap_cdef;
190  OPJ_BYTE has_jp2h;
191  OPJ_BYTE has_ihdr;
192 }
193 opj_jp2_t;
194 
198 typedef struct opj_jp2_box {
199  OPJ_UINT32 length;
200  OPJ_UINT32 type;
201  OPJ_INT32 init_pos;
202 } opj_jp2_box_t;
203 
204 typedef struct opj_jp2_header_handler {
205  /* marker value */
206  OPJ_UINT32 id;
207  /* action linked to the marker */
208  OPJ_BOOL(*handler)(opj_jp2_t *jp2,
209  OPJ_BYTE *p_header_data,
210  OPJ_UINT32 p_header_size,
211  opj_event_mgr_t * p_manager);
212 }
213 opj_jp2_header_handler_t;
214 
215 
216 typedef struct opj_jp2_img_header_writer_handler {
217  /* action to perform */
218  OPJ_BYTE* (*handler)(opj_jp2_t *jp2, OPJ_UINT32 * p_data_size);
219  /* result of the action : data */
220  OPJ_BYTE* m_data;
221  /* size of data */
222  OPJ_UINT32 m_size;
223 }
224 opj_jp2_img_header_writer_handler_t;
225 
228 /* ----------------------------------------------------------------------- */
229 
236 void opj_jp2_setup_decoder(opj_jp2_t *jp2, opj_dparameters_t *parameters);
237 
244 OPJ_BOOL opj_jp2_set_threads(opj_jp2_t *jp2, OPJ_UINT32 num_threads);
245 
255 OPJ_BOOL opj_jp2_decode(opj_jp2_t *jp2,
256  opj_stream_private_t *p_stream,
257  opj_image_t* p_image,
258  opj_event_mgr_t * p_manager);
259 
270 OPJ_BOOL opj_jp2_setup_encoder(opj_jp2_t *jp2,
271  opj_cparameters_t *parameters,
272  opj_image_t *image,
273  opj_event_mgr_t * p_manager);
274 
282 OPJ_BOOL opj_jp2_encode(opj_jp2_t *jp2,
283  opj_stream_private_t *stream,
284  opj_event_mgr_t * p_manager);
285 
286 
297 OPJ_BOOL opj_jp2_start_compress(opj_jp2_t *jp2,
298  opj_stream_private_t *stream,
299  opj_image_t * p_image,
300  opj_event_mgr_t * p_manager);
301 
302 
307 OPJ_BOOL opj_jp2_end_compress(opj_jp2_t *jp2,
308  opj_stream_private_t *cio,
309  opj_event_mgr_t * p_manager);
310 
311 /* ----------------------------------------------------------------------- */
312 
317 OPJ_BOOL opj_jp2_end_decompress(opj_jp2_t *jp2,
318  opj_stream_private_t *cio,
319  opj_event_mgr_t * p_manager);
320 
331 OPJ_BOOL opj_jp2_read_header(opj_stream_private_t *p_stream,
332  opj_jp2_t *jp2,
333  opj_image_t ** p_image,
334  opj_event_mgr_t * p_manager);
335 
346 OPJ_BOOL opj_jp2_set_decoded_components(opj_jp2_t *jp2,
347  OPJ_UINT32 numcomps,
348  const OPJ_UINT32* comps_indices,
349  opj_event_mgr_t * p_manager);
350 
365 OPJ_BOOL opj_jp2_read_tile_header(opj_jp2_t * p_jp2,
366  OPJ_UINT32 * p_tile_index,
367  OPJ_UINT32 * p_data_size,
368  OPJ_INT32 * p_tile_x0,
369  OPJ_INT32 * p_tile_y0,
370  OPJ_INT32 * p_tile_x1,
371  OPJ_INT32 * p_tile_y1,
372  OPJ_UINT32 * p_nb_comps,
373  OPJ_BOOL * p_go_on,
374  opj_stream_private_t *p_stream,
375  opj_event_mgr_t * p_manager);
376 
387 OPJ_BOOL opj_jp2_write_tile(opj_jp2_t *p_jp2,
388  OPJ_UINT32 p_tile_index,
389  OPJ_BYTE * p_data,
390  OPJ_UINT32 p_data_size,
391  opj_stream_private_t *p_stream,
392  opj_event_mgr_t * p_manager);
393 
405 OPJ_BOOL opj_jp2_decode_tile(opj_jp2_t * p_jp2,
406  OPJ_UINT32 p_tile_index,
407  OPJ_BYTE * p_data,
408  OPJ_UINT32 p_data_size,
409  opj_stream_private_t *p_stream,
410  opj_event_mgr_t * p_manager);
411 
417 opj_jp2_t* opj_jp2_create(OPJ_BOOL p_is_decoder);
418 
423 void opj_jp2_destroy(opj_jp2_t *jp2);
424 
425 
439 OPJ_BOOL opj_jp2_set_decode_area(opj_jp2_t *p_jp2,
440  opj_image_t* p_image,
441  OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,
442  OPJ_INT32 p_end_x, OPJ_INT32 p_end_y,
443  opj_event_mgr_t * p_manager);
444 
448 OPJ_BOOL opj_jp2_get_tile(opj_jp2_t *p_jp2,
449  opj_stream_private_t *p_stream,
450  opj_image_t* p_image,
451  opj_event_mgr_t * p_manager,
452  OPJ_UINT32 tile_index);
453 
454 
458 OPJ_BOOL opj_jp2_set_decoded_resolution_factor(opj_jp2_t *p_jp2,
459  OPJ_UINT32 res_factor,
460  opj_event_mgr_t * p_manager);
461 
462 
463 /* TODO MSD: clean these 3 functions */
472 void jp2_dump(opj_jp2_t* p_jp2, OPJ_INT32 flag, FILE* out_stream);
473 
481 opj_codestream_info_v2_t* jp2_get_cstr_info(opj_jp2_t* p_jp2);
482 
490 opj_codestream_index_t* jp2_get_cstr_index(opj_jp2_t* p_jp2);
491 
492 
496 
497 #endif /* OPJ_JP2_H */
498 
Generated by   doxygen 1.8.1