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) 2001-2003, David Janssens
5 * Copyright (c) 2002-2003, Yannick Verschueren
6 * Copyright (c) 2003-2007, Francois-Olivier Devaux and Antonin Descampe
7 * Copyright (c) 2005, Herve Drolon, FreeImage Team
8 * Copyright (c) 2006-2007, Parvatha Elangovan
9 * Copyright (c) 2008, Jerome Fimes, Communications & Systemes <jerome.fimes@c-s.fr>
10 * Copyright (c) 2011, Mickael Savinaud, Communications & Systemes <mickael.savinaud@c-s.fr>
12 * All rights reserved.
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 * 2. Redistributions in binary form must reproduce the above copyright
20 * notice, this list of conditions and the following disclaimer in the
21 * documentation and/or other materials provided with the distribution.
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
24 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
27 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 * POSSIBILITY OF SUCH DAMAGE.
39 @brief The JPEG-2000 Codestream Reader/Writer (J2K)
41 The functions in J2K.C have for goal to read/write the several parts of the codestream: markers and data.
44 /** @defgroup J2K J2K - JPEG-2000 codestream reader/writer */
47 #define J2K_CP_CSTY_PRT 0x01
48 #define J2K_CP_CSTY_SOP 0x02
49 #define J2K_CP_CSTY_EPH 0x04
50 #define J2K_CCP_CSTY_PRT 0x01
51 #define J2K_CCP_CBLKSTY_LAZY 0x01 /**< Selective arithmetic coding bypass */
52 #define J2K_CCP_CBLKSTY_RESET 0x02 /**< Reset context probabilities on coding pass boundaries */
53 #define J2K_CCP_CBLKSTY_TERMALL 0x04 /**< Termination on each coding pass */
54 #define J2K_CCP_CBLKSTY_VSC 0x08 /**< Vertically stripe causal context */
55 #define J2K_CCP_CBLKSTY_PTERM 0x10 /**< Predictable termination */
56 #define J2K_CCP_CBLKSTY_SEGSYM 0x20 /**< Segmentation symbols are used */
57 #define J2K_CCP_QNTSTY_NOQNT 0
58 #define J2K_CCP_QNTSTY_SIQNT 1
59 #define J2K_CCP_QNTSTY_SEQNT 2
61 /* ----------------------------------------------------------------------- */
63 #define J2K_MS_SOC 0xff4f /**< SOC marker value */
64 #define J2K_MS_SOT 0xff90 /**< SOT marker value */
65 #define J2K_MS_SOD 0xff93 /**< SOD marker value */
66 #define J2K_MS_EOC 0xffd9 /**< EOC marker value */
67 #define J2K_MS_SIZ 0xff51 /**< SIZ marker value */
68 #define J2K_MS_COD 0xff52 /**< COD marker value */
69 #define J2K_MS_COC 0xff53 /**< COC marker value */
70 #define J2K_MS_RGN 0xff5e /**< RGN marker value */
71 #define J2K_MS_QCD 0xff5c /**< QCD marker value */
72 #define J2K_MS_QCC 0xff5d /**< QCC marker value */
73 #define J2K_MS_POC 0xff5f /**< POC marker value */
74 #define J2K_MS_TLM 0xff55 /**< TLM marker value */
75 #define J2K_MS_PLM 0xff57 /**< PLM marker value */
76 #define J2K_MS_PLT 0xff58 /**< PLT marker value */
77 #define J2K_MS_PPM 0xff60 /**< PPM marker value */
78 #define J2K_MS_PPT 0xff61 /**< PPT marker value */
79 #define J2K_MS_SOP 0xff91 /**< SOP marker value */
80 #define J2K_MS_EPH 0xff92 /**< EPH marker value */
81 #define J2K_MS_CRG 0xff63 /**< CRG marker value */
82 #define J2K_MS_COM 0xff64 /**< COM marker value */
83 #define J2K_MS_CBD 0xff78 /**< CBD marker value */
84 #define J2K_MS_MCC 0xff75 /**< MCC marker value */
85 #define J2K_MS_MCT 0xff74 /**< MCT marker value */
86 #define J2K_MS_MCO 0xff77 /**< MCO marker value */
88 #define J2K_MS_UNK 0 /**< UNKNOWN marker value */
92 #define J2K_MS_EPC 0xff68 /**< EPC marker value (Part 11: JPEG 2000 for Wireless) */
93 #define J2K_MS_EPB 0xff66 /**< EPB marker value (Part 11: JPEG 2000 for Wireless) */
94 #define J2K_MS_ESD 0xff67 /**< ESD marker value (Part 11: JPEG 2000 for Wireless) */
95 #define J2K_MS_RED 0xff69 /**< RED marker value (Part 11: JPEG 2000 for Wireless) */
98 #define J2K_MS_SEC 0xff65 /**< SEC marker value (Part 8: Secure JPEG 2000) */
99 #define J2K_MS_INSEC 0xff94 /**< INSEC marker value (Part 8: Secure JPEG 2000) */
100 #endif /* USE_JPSEC */
103 /* ----------------------------------------------------------------------- */
106 * Values that specify the status of the decoding process when decoding the main header.
107 * These values may be combined with a | operator.
109 typedef enum J2K_STATUS {
110 J2K_STATE_NONE = 0x0000, /**< a SOC marker is expected */
111 J2K_STATE_MHSOC = 0x0001, /**< a SOC marker is expected */
112 J2K_STATE_MHSIZ = 0x0002, /**< a SIZ marker is expected */
113 J2K_STATE_MH = 0x0004, /**< the decoding process is in the main header */
114 J2K_STATE_TPHSOT = 0x0008, /**< the decoding process is in a tile part header and expects a SOT marker */
115 J2K_STATE_TPH = 0x0010, /**< the decoding process is in a tile part header */
116 J2K_STATE_MT = 0x0020, /**< the EOC marker has just been read */
117 J2K_STATE_NEOC = 0x0040, /**< the decoding process must not expect a EOC marker because the codestream is truncated */
119 J2K_STATE_EOC = 0x0100, /**< the decoding process has encountered the EOC marker */
120 J2K_STATE_ERR = 0x8000 /**< the decoding process has encountered an error (FIXME warning V1 = 0x0080)*/
124 * Type of elements storing in the MCT data
126 typedef enum MCT_ELEMENT_TYPE
128 MCT_TYPE_INT16 = 0, /** MCT data is stored as signed shorts*/
129 MCT_TYPE_INT32 = 1, /** MCT data is stored as signed integers*/
130 MCT_TYPE_FLOAT = 2, /** MCT data is stored as floats*/
131 MCT_TYPE_DOUBLE = 3 /** MCT data is stored as doubles*/
132 } J2K_MCT_ELEMENT_TYPE;
137 typedef enum MCT_ARRAY_TYPE
139 MCT_TYPE_DEPENDENCY = 0,
140 MCT_TYPE_DECORRELATION = 1,
142 } J2K_MCT_ARRAY_TYPE;
144 /* ----------------------------------------------------------------------- */
149 typedef enum T2_MODE {
150 THRESH_CALC = 0, /** Function called in Rate allocation process*/
151 FINAL_PASS = 1 /** Function called in Tier 2 process*/
155 * Quantization stepsize
157 typedef struct opj_stepsize {
165 Tile-component coding parameters
167 typedef struct opj_tccp
171 /** number of resolutions */
172 OPJ_UINT32 numresolutions;
173 /** code-blocks width */
175 /** code-blocks height */
177 /** code-block coding style */
179 /** discrete wavelet transform identifier */
181 /** quantisation style */
183 /** stepsizes used for quantization */
184 opj_stepsize_t stepsizes[J2K_MAXBANDS];
185 /** number of guard bits */
187 /** Region Of Interest shift */
189 /** precinct width */
190 OPJ_UINT32 prcw[J2K_MAXRLVLS];
191 /** precinct height */
192 OPJ_UINT32 prch[J2K_MAXRLVLS];
193 /** the dc_level_shift **/
194 OPJ_INT32 m_dc_level_shift;
200 Tile coding parameters :
201 this structure is used to store coding/decoding parameters common to all
202 tiles (information like COD, COC in main header)
204 typedef struct opj_tcp {
205 /** 1 : first part-tile of a tile */
209 /** progression order */
211 /** number of layers */
213 /** multi-component transform identifier */
215 /** rates of layers */
217 /** number of progression order changes */
219 /** indicates if a POC marker has been used O:NO, 1:YES */
221 /** progression order changes */
223 /** packet header store there for futur use in t2_decode_packet */
224 unsigned char *ppt_data;
225 /** pointer remaining on the first byte of the first header if ppt is used */
226 unsigned char *ppt_data_first;
227 /** If ppt == 1 --> there was a PPT marker for the present tile */
229 /** used in case of multiple marker PPT (number of info already stored) */
233 /** add fixed_quality */
234 float distoratio[100];
235 /** tile-component coding parameters */
242 typedef struct opj_mct_data
244 J2K_MCT_ELEMENT_TYPE m_element_type;
245 J2K_MCT_ARRAY_TYPE m_array_type;
248 OPJ_UINT32 m_data_size;
255 typedef struct opj_simple_mcc_decorrelation_data
258 OPJ_UINT32 m_nb_comps;
259 opj_mct_data_t * m_decorrelation_array;
260 opj_mct_data_t * m_offset_array;
261 OPJ_UINT32 m_is_irreversible : 1;
263 opj_simple_mcc_decorrelation_data_t;
266 Tile coding parameters :
267 this structure is used to store coding/decoding parameters common to all
268 tiles (information like COD, COC in main header)
270 typedef struct opj_tcp_v2
274 /** progression order */
276 /** number of layers */
277 OPJ_UINT32 numlayers;
278 OPJ_UINT32 num_layers_to_decode;
279 /** multi-component transform identifier */
281 /** rates of layers */
282 OPJ_FLOAT32 rates[100];
283 /** number of progression order changes */
285 /** progression order changes */
287 /** packet header store there for futur use in t2_decode_packet */
289 /** used to keep a track of the allocated memory */
290 OPJ_BYTE *ppt_buffer;
291 /** Number of bytes stored inside ppt_data*/
292 OPJ_UINT32 ppt_data_size;
293 /** size of ppt_data*/
295 /** add fixed_quality */
296 OPJ_FLOAT32 distoratio[100];
297 /** tile-component coding parameters */
299 /** number of tile parts for the tile. */
300 OPJ_UINT32 m_nb_tile_parts;
301 /** data for the tile */
304 OPJ_UINT32 m_data_size;
305 /** encoding norms */
306 OPJ_FLOAT64 * mct_norms;
307 /** the mct decoding matrix */
308 OPJ_FLOAT32 * m_mct_decoding_matrix;
309 /** the mct coding matrix */
310 OPJ_FLOAT32 * m_mct_coding_matrix;
312 opj_mct_data_t * m_mct_records;
313 /** the number of mct records. */
314 OPJ_UINT32 m_nb_mct_records;
315 /** the max number of mct records. */
316 OPJ_UINT32 m_nb_max_mct_records;
318 opj_simple_mcc_decorrelation_data_t * m_mcc_records;
319 /** the number of mct records. */
320 OPJ_UINT32 m_nb_mcc_records;
321 /** the max number of mct records. */
322 OPJ_UINT32 m_nb_max_mcc_records;
325 /***** FLAGS *******/
326 /** If ppt == 1 --> there was a PPT marker for the present tile */
328 /** indicates if a POC marker has been used O:NO, 1:YES */
339 typedef struct opj_cp {
340 /** Digital cinema profile*/
341 OPJ_CINEMA_MODE cinema;
342 /** Maximum rate for each component. If == 0, component size limitation is not considered */
344 /** Size of the image in bits*/
347 OPJ_RSIZ_CAPABILITIES rsiz;
348 /** Enabling Tile part generation*/
350 /** Flag determining tile part generation*/
352 /** Position of tile part flag in progression order*/
354 /** allocation by rate/distortion */
356 /** allocation by fixed layer */
358 /** add fixed_quality */
360 /** if != 0, then original dimension divided by 2^(reduce); if == 0 or not used, image is decoded to the full resolution */
362 /** if != 0, then only the first "layer" layers are decoded; if == 0 or not used, all the quality layers are decoded */
364 /** if == NO_LIMITATION, decode entire codestream; if == LIMIT_TO_MAIN_HEADER then only decode the main header */
365 OPJ_LIMIT_DECODING limit_decoding;
374 /** comment for coding */
376 /** number of tiles in width */
378 /** number of tiles in heigth */
380 /** ID number of the tiles present in the codestream */
382 /** size of the vector tileno */
384 /** packet header store there for futur use in t2_decode_packet */
385 unsigned char *ppm_data;
386 /** pointer remaining on the first byte of the first header if ppm is used */
387 unsigned char *ppm_data_first;
388 /** if ppm == 1 --> there was a PPM marker for the present tile */
390 /** use in case of multiple marker PPM (number of info already store) */
392 /** use in case of multiple marker PPM (case on non-finished previous info) */
396 /** tile coding parameters */
402 /** enables writing of EPC in MH, thus activating JPWL */
404 /** enables writing of EPB, in case of activated JPWL */
406 /** enables writing of ESD, in case of activated JPWL */
408 /** enables writing of informative techniques of ESD, in case of activated JPWL */
410 /** enables writing of RED, in case of activated JPWL */
412 /** error protection method for MH (0,1,16,32,37-128) */
414 /** tile number of header protection specification (>=0) */
415 int hprot_TPH_tileno[JPWL_MAX_NO_TILESPECS];
416 /** error protection methods for TPHs (0,1,16,32,37-128) */
417 int hprot_TPH[JPWL_MAX_NO_TILESPECS];
418 /** tile number of packet protection specification (>=0) */
419 int pprot_tileno[JPWL_MAX_NO_PACKSPECS];
420 /** packet number of packet protection specification (>=0) */
421 int pprot_packno[JPWL_MAX_NO_PACKSPECS];
422 /** error protection methods for packets (0,1,16,32,37-128) */
423 int pprot[JPWL_MAX_NO_PACKSPECS];
424 /** enables writing of ESD, (0/2/4 bytes) */
426 /** sensitivity addressing size (0=auto/2/4 bytes) */
428 /** sensitivity range (0-3) */
430 /** sensitivity method for MH (-1,0-7) */
432 /** tile number of sensitivity specification (>=0) */
433 int sens_TPH_tileno[JPWL_MAX_NO_TILESPECS];
434 /** sensitivity methods for TPHs (-1,0-7) */
435 int sens_TPH[JPWL_MAX_NO_TILESPECS];
436 /** enables JPWL correction at the decoder */
438 /** expected number of components at the decoder */
440 /** maximum number of tiles at the decoder */
442 #endif /* USE_JPWL */
446 typedef struct opj_encoding_param
448 /** Digital cinema profile*/
449 OPJ_CINEMA_MODE m_cinema;
450 /** Maximum rate for each component. If == 0, component size limitation is not considered */
451 OPJ_UINT32 m_max_comp_size;
452 /** Position of tile part flag in progression order*/
455 OPJ_INT32 *m_matrice;
456 /** Flag determining tile part generation*/
458 /** allocation by rate/distortion */
459 OPJ_UINT32 m_disto_alloc : 1;
460 /** allocation by fixed layer */
461 OPJ_UINT32 m_fixed_alloc : 1;
462 /** add fixed_quality */
463 OPJ_UINT32 m_fixed_quality : 1;
464 /** Enabling Tile part generation*/
465 OPJ_UINT32 m_tp_on : 1;
467 opj_encoding_param_t;
469 typedef struct opj_decoding_param
471 /** if != 0, then original dimension divided by 2^(reduce); if == 0 or not used, image is decoded to the full resolution */
473 /** if != 0, then only the first "layer" layers are decoded; if == 0 or not used, all the quality layers are decoded */
476 opj_decoding_param_t;
482 typedef struct opj_cp_v2
484 /** Size of the image in bits*/
487 OPJ_RSIZ_CAPABILITIES rsiz;
489 OPJ_UINT32 tx0; /* MSD see norm */
491 OPJ_UINT32 ty0; /* MSD see norm */
498 /** number of tiles in width */
500 /** number of tiles in heigth */
503 /** packet header store there for futur use in t2_decode_packet */
505 /** size of the ppm_data*/
507 /** size of the ppm_data*/
508 OPJ_UINT32 ppm_data_read;
510 OPJ_BYTE *ppm_data_current;
512 /** packet header storage original buffer */
513 OPJ_BYTE *ppm_buffer;
514 /** pointer remaining on the first byte of the first header if ppm is used */
515 OPJ_BYTE *ppm_data_first;
516 /** Number of bytes actually stored inside the ppm_data */
517 OPJ_UINT32 ppm_data_size;
518 /** use in case of multiple marker PPM (number of info already store) */
520 /** use in case of multiple marker PPM (case on non-finished previous info) */
521 OPJ_INT32 ppm_previous;
523 /** tile coding parameters */
528 opj_decoding_param_t m_dec;
529 opj_encoding_param_t m_enc;
536 /** enables writing of EPC in MH, thus activating JPWL */
538 /** enables writing of EPB, in case of activated JPWL */
540 /** enables writing of ESD, in case of activated JPWL */
542 /** enables writing of informative techniques of ESD, in case of activated JPWL */
544 /** enables writing of RED, in case of activated JPWL */
546 /** error protection method for MH (0,1,16,32,37-128) */
548 /** tile number of header protection specification (>=0) */
549 int hprot_TPH_tileno[JPWL_MAX_NO_TILESPECS];
550 /** error protection methods for TPHs (0,1,16,32,37-128) */
551 int hprot_TPH[JPWL_MAX_NO_TILESPECS];
552 /** tile number of packet protection specification (>=0) */
553 int pprot_tileno[JPWL_MAX_NO_PACKSPECS];
554 /** packet number of packet protection specification (>=0) */
555 int pprot_packno[JPWL_MAX_NO_PACKSPECS];
556 /** error protection methods for packets (0,1,16,32,37-128) */
557 int pprot[JPWL_MAX_NO_PACKSPECS];
558 /** enables writing of ESD, (0/2/4 bytes) */
560 /** sensitivity addressing size (0=auto/2/4 bytes) */
562 /** sensitivity range (0-3) */
564 /** sensitivity method for MH (-1,0-7) */
566 /** tile number of sensitivity specification (>=0) */
567 int sens_TPH_tileno[JPWL_MAX_NO_TILESPECS];
568 /** sensitivity methods for TPHs (-1,0-7) */
569 int sens_TPH[JPWL_MAX_NO_TILESPECS];
570 /** enables JPWL correction at the decoder */
572 /** expected number of components at the decoder */
574 /** maximum number of tiles at the decoder */
576 #endif /* USE_JPWL */
578 /******** FLAGS *********/
579 /** if ppm == 1 --> there was a PPM marker*/
581 /** tells if the parameter is a coding or decoding one */
582 OPJ_UINT32 m_is_decoder : 1;
587 typedef struct opj_j2k_dec
589 /** locate in which part of the codestream the decoder is (main header, tile header, end) */
592 * store decoding parameters common to all tiles (information like COD, COC in main header)
594 opj_tcp_v2_t *m_default_tcp;
595 OPJ_BYTE *m_header_data;
596 OPJ_UINT32 m_header_data_size;
597 /** to tell the tile part length */
598 OPJ_UINT32 m_sot_length;
599 /** Only tiles index in the correct range will be decoded.*/
600 OPJ_UINT32 m_start_tile_x;
601 OPJ_UINT32 m_start_tile_y;
602 OPJ_UINT32 m_end_tile_x;
603 OPJ_UINT32 m_end_tile_y;
605 * Decoded area set by the user
612 /** Index of the tile to decode (used in get_tile) */
613 OPJ_INT32 m_tile_ind_to_dec;
614 /** Position of the last SOT marker read */
615 OPJ_OFF_T m_last_sot_read_pos;
618 * Indicate that the current tile-part is assume as the last tile part of the codestream.
619 * It is useful in the case of PSot is equal to zero. The sot length will be compute in the
620 * SOD reader function. FIXME NOT USED for the moment
622 opj_bool m_last_tile_part;
623 /** to tell that a tile can be decoded. */
624 OPJ_UINT32 m_can_decode : 1;
625 OPJ_UINT32 m_discard_tiles : 1;
626 OPJ_UINT32 m_skip_data : 1;
630 typedef struct opj_j2k_enc
632 /** Tile part number, regardless of poc, for each new poc, tp is reset to 1*/
633 OPJ_UINT32 m_current_poc_tile_part_number; /* tp_num */
635 /** Tile part number currently coding, taking into account POC. m_current_tile_part_number holds the total number of tile parts while encoding the last tile part.*/
636 OPJ_UINT32 m_current_tile_part_number; /*cur_tp_num */
639 locate the start position of the TLM marker
640 after encoding the tilepart, a jump (in j2k_write_sod) is done to the TLM marker to store the value of its length.
642 OPJ_SIZE_T m_tlm_start;
644 * Stores the sizes of the tlm.
646 OPJ_BYTE * m_tlm_sot_offsets_buffer;
648 * The current offset of the tlm buffer.
650 OPJ_BYTE * m_tlm_sot_offsets_current;
652 /** Total num of tile parts in whole image = num tiles* num tileparts in each tile*/
653 /** used in TLMmarker*/
654 OPJ_UINT32 m_total_tile_parts; /* totnum_tp */
656 /* encoded data for a tile */
657 OPJ_BYTE * m_encoded_tile_data;
659 /* size of the encoded_data */
660 OPJ_UINT32 m_encoded_tile_size;
662 /* encoded data for a tile */
663 OPJ_BYTE * m_header_tile_data;
665 /* size of the encoded_data */
666 OPJ_UINT32 m_header_tile_data_size;
672 JPEG-2000 codestream reader/writer
674 typedef struct opj_j2k {
676 opj_common_ptr cinfo;
678 /** locate in which part of the codestream the decoder is (main header, tile header, end) */
680 /** number of the tile curently concern by coding/decoding */
682 /** Tile part number*/
684 /** Tilepart number currently coding*/
686 /** Total number of tileparts of the current tile*/
689 locate the start position of the TLM marker
690 after encoding the tilepart, a jump (in j2k_write_sod) is done to the TLM marker to store the value of its length.
693 /** Total num of tile parts in whole image = num tiles* num tileparts in each tile*/
694 /** used in TLMmarker*/
697 locate the position of the end of the tile in the codestream,
698 used to detect a truncated codestream (in j2k_read_sod)
702 locate the start position of the SOT marker of the current coded tile:
703 after encoding the tile, a jump (in j2k_write_sod) is done to the SOT marker to store the value of its length.
708 as the J2K-file is written in several parts during encoding,
709 it enables to make the right correction in position return by cio_tell
712 /** array used to store the data of each tile */
713 unsigned char **tile_data;
714 /** array used to store the length of each tile */
718 store decoding parameters common to all tiles (information like COD, COC in main header)
720 opj_tcp_t *default_tcp;
721 /** pointer to the encoded / decoded image */
723 /** pointer to the coding parameters */
725 /** helper used to write the index file */
726 opj_codestream_info_t *cstr_info;
727 /** pointer to the byte i/o stream */
733 JPEG-2000 codestream reader/writer
735 typedef struct opj_j2k_v2
737 /* J2K codestream is decoded*/
738 opj_bool m_is_decoder;
743 opj_j2k_dec_t m_decoder;
744 opj_j2k_enc_t m_encoder;
748 /** pointer to the internal/private encoded / decoded image */
749 opj_image_t* m_private_image;
751 /* pointer to the output image (decoded)*/
752 opj_image_t* m_output_image;
754 /** Coding parameters */
757 /** the list of procedures to exec **/
758 struct opj_procedure_list * m_procedure_list;
760 /** the list of validation procedures to follow to make sure the code is valid **/
761 struct opj_procedure_list * m_validation_list;
763 /** helper used to write the index file */
764 opj_codestream_index_t *cstr_index;
766 /** number of the tile curently concern by coding/decoding */
767 OPJ_UINT32 m_current_tile_number;
769 /** the current tile coder/decoder **/
770 struct opj_tcd_v2 * m_tcd;
778 /** @name Exported functions */
780 /* ----------------------------------------------------------------------- */
782 Creates a J2K decompression structure
783 @param cinfo Codec context info
784 @return Returns a handle to a J2K decompressor if successful, returns NULL otherwise
786 opj_j2k_t* j2k_create_decompress(opj_common_ptr cinfo);
788 Destroy a J2K decompressor handle
789 @param j2k J2K decompressor handle to destroy
791 void j2k_destroy_decompress(opj_j2k_t *j2k);
793 Setup the decoder decoding parameters using user parameters.
794 Decoding parameters are returned in j2k->cp.
795 @param j2k J2K decompressor handle
796 @param parameters decompression parameters
798 void j2k_setup_decoder(opj_j2k_t *j2k, opj_dparameters_t *parameters);
800 void j2k_setup_decoder_v2(opj_j2k_v2_t *j2k, opj_dparameters_t *parameters);
803 Decode an image from a JPEG-2000 codestream
804 @param j2k J2K decompressor handle
805 @param cio Input buffer stream
806 @param cstr_info Codestream information structure if required, NULL otherwise
807 @return Returns a decoded image if successful, returns NULL otherwise
809 opj_image_t* j2k_decode(opj_j2k_t *j2k, opj_cio_t *cio, opj_codestream_info_t *cstr_info);
811 Decode an image form a JPT-stream (JPEG 2000, JPIP)
812 @param j2k J2K decompressor handle
813 @param cio Input buffer stream
814 @param cstr_info Codestream information structure if required, NULL otherwise
815 @return Returns a decoded image if successful, returns NULL otherwise
817 opj_image_t* j2k_decode_jpt_stream(opj_j2k_t *j2k, opj_cio_t *cio, opj_codestream_info_t *cstr_info);
819 Creates a J2K compression structure
820 @param cinfo Codec context info
821 @return Returns a handle to a J2K compressor if successful, returns NULL otherwise
823 opj_j2k_t* j2k_create_compress(opj_common_ptr cinfo);
826 Creates a J2K compression structure
827 @param cinfo Codec context info
828 @return Returns a handle to a J2K compressor if successful, returns NULL otherwise
830 opj_j2k_v2_t* j2k_create_compress_v2(void);
833 Destroy a J2K compressor handle
834 @param j2k J2K compressor handle to destroy
836 void j2k_destroy_compress(opj_j2k_t *j2k);
838 Setup the encoder parameters using the current image and using user parameters.
839 Coding parameters are returned in j2k->cp.
840 @param j2k J2K compressor handle
841 @param parameters compression parameters
842 @param image input filled image
844 void j2k_setup_encoder(opj_j2k_t *j2k, opj_cparameters_t *parameters, opj_image_t *image);
846 void j2k_setup_encoder_v2( opj_j2k_v2_t *p_j2k,
847 opj_cparameters_t *parameters,
849 struct opj_event_mgr * p_manager);
852 Converts an enum type progression order to string type
854 char *j2k_convert_progression_order(OPJ_PROG_ORDER prg_order);
856 Encode an image into a JPEG-2000 codestream
857 @param j2k J2K compressor handle
858 @param cio Output buffer stream
859 @param image Image to encode
860 @param cstr_info Codestream information structure if required, NULL otherwise
861 @return Returns true if successful, returns false otherwise
863 opj_bool j2k_encode(opj_j2k_t *j2k, opj_cio_t *cio, opj_image_t *image, opj_codestream_info_t *cstr_info);
865 /* ----------------------------------------------------------------------- */
871 * Ends the decompression procedures and possibiliy add data to be read after the
874 opj_bool j2k_end_decompress(opj_j2k_v2_t *j2k, struct opj_stream_private *cio, struct opj_event_mgr * p_manager);
877 * Reads a jpeg2000 codestream header structure.
879 * @param cio the stream to read data from.
880 * @param p_j2k the jpeg2000 codec.
881 * @param p_manager the user event manager.
883 * @return true if the box is valid.
885 opj_bool j2k_read_header( struct opj_stream_private *p_stream,
887 opj_image_t** p_image,
888 struct opj_event_mgr* p_manager );
892 * Destroys a jpeg2000 codec.
894 * @param p_j2k the jpeg20000 structure to destroy.
896 void j2k_destroy (opj_j2k_v2_t *p_j2k);
899 * Destroys a codestream index structure.
901 * @param p_cstr_ind the codestream index parameter to destroy.
903 void j2k_destroy_cstr_index (opj_codestream_index_t *p_cstr_ind);
907 * @param p_j2k the jpeg2000 codec.
908 * @param p_stream the stream to write data to.
909 * @param p_manager the user event manager.
911 opj_bool j2k_decode_tile (
912 opj_j2k_v2_t * p_j2k,
913 OPJ_UINT32 p_tile_index,
915 OPJ_UINT32 p_data_size,
916 struct opj_stream_private *p_stream,
917 struct opj_event_mgr * p_manager
921 * Reads a tile header.
922 * @param p_j2k the jpeg2000 codec.
923 * @param p_stream the stream to write data to.
924 * @param p_manager the user event manager.
926 opj_bool j2k_read_tile_header (
927 opj_j2k_v2_t * p_j2k,
928 OPJ_UINT32 * p_tile_index,
929 OPJ_UINT32 * p_data_size,
930 OPJ_INT32 * p_tile_x0,
931 OPJ_INT32 * p_tile_y0,
932 OPJ_INT32 * p_tile_x1,
933 OPJ_INT32 * p_tile_y1,
934 OPJ_UINT32 * p_nb_comps,
936 struct opj_stream_private *p_stream,
937 struct opj_event_mgr * p_manager
942 * Sets the given area to be decoded. This function should be called right after opj_read_header and before any tile header reading.
944 * @param p_j2k the jpeg2000 codec.
945 * @param p_start_x the left position of the rectangle to decode (in image coordinates).
946 * @param p_end_x the right position of the rectangle to decode (in image coordinates).
947 * @param p_start_y the up position of the rectangle to decode (in image coordinates).
948 * @param p_end_y the bottom position of the rectangle to decode (in image coordinates).
949 * @param p_manager the user event manager
951 * @return true if the area could be set.
953 opj_bool j2k_set_decode_area( opj_j2k_v2_t *p_j2k,
954 opj_image_t* p_image,
955 OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,
956 OPJ_INT32 p_end_x, OPJ_INT32 p_end_y,
957 struct opj_event_mgr * p_manager );
960 * Creates a J2K decompression structure.
962 * @return a handle to a J2K decompressor if successful, NULL otherwise.
964 opj_j2k_v2_t* j2k_create_decompress_v2(void);
968 * Dump some elements from the J2K decompression structure .
970 *@param p_j2k the jpeg2000 codec.
971 *@param flag flag to describe what elments are dump.
972 *@param out_stream output stream where dump the elements.
975 void j2k_dump (opj_j2k_v2_t* p_j2k, OPJ_INT32 flag, FILE* out_stream);
980 * Dump an image header structure.
982 *@param img_header the image header to dump.
983 *@param dev_dump_flag flag to describe if we are in the case of this function is use outside j2k_dump function
984 *@param out_stream output stream where dump the elements.
986 void j2k_dump_image_header(opj_image_t* image, opj_bool dev_dump_flag, FILE* out_stream);
989 * Dump a component image header structure.
991 *@param comp_header the component image header to dump.
992 *@param dev_dump_flag flag to describe if we are in the case of this function is use outside j2k_dump function
993 *@param out_stream output stream where dump the elements.
995 void j2k_dump_image_comp_header(opj_image_comp_t* comp, opj_bool dev_dump_flag, FILE* out_stream);
998 * Get the codestream info from a JPEG2000 codec.
1000 *@param p_j2k the component image header to dump.
1002 *@return the codestream information extract from the jpg2000 codec
1004 opj_codestream_info_v2_t* j2k_get_cstr_info(opj_j2k_v2_t* p_j2k);
1007 * Get the codestream index from a JPEG2000 codec.
1009 *@param p_j2k the component image header to dump.
1011 *@return the codestream index extract from the jpg2000 codec
1013 opj_codestream_index_t* j2k_get_cstr_index(opj_j2k_v2_t* p_j2k);
1016 * Decode an image from a JPEG-2000 codestream
1017 * @param j2k J2K decompressor handle
1018 * @param cio Input buffer stream
1019 * @param cstr_info Codestream information structure if required, NULL otherwise
1020 * @return Returns a decoded image if successful, returns NULL otherwise
1022 opj_bool j2k_decode_v2(opj_j2k_v2_t *j2k, struct opj_stream_private *cio, opj_image_t* p_image, opj_event_mgr_t * p_manager);
1025 opj_bool j2k_get_tile( opj_j2k_v2_t *p_j2k,
1026 opj_stream_private_t *p_stream,
1027 opj_image_t* p_image,
1028 struct opj_event_mgr * p_manager,
1029 OPJ_UINT32 tile_index );
1031 opj_bool j2k_set_decoded_resolution_factor(opj_j2k_v2_t *p_j2k, OPJ_UINT32 res_factor, opj_event_mgr_t * p_manager);
1036 * @param p_j2k the jpeg2000 codec.
1037 * @param p_stream the stream to write data to.
1038 * @param p_manager the user event manager.
1040 opj_bool j2k_write_tile ( opj_j2k_v2_t * p_j2k,
1041 OPJ_UINT32 p_tile_index,
1043 OPJ_UINT32 p_data_size,
1044 struct opj_stream_private *p_stream,
1045 struct opj_event_mgr * p_manager );
1048 * Encodes an image into a JPEG-2000 codestream
1050 opj_bool j2k_encode_v2( opj_j2k_v2_t * p_j2k,
1051 opj_stream_private_t *cio,
1052 struct opj_event_mgr * p_manager );
1055 * Starts a compression scheme, i.e. validates the codec parameters, writes the header.
1057 * @param p_j2k the jpeg2000 codec.
1058 * @param cio the stream object.
1059 * @param p_manager the user event manager.
1061 * @return true if the codec is valid.
1063 opj_bool j2k_start_compress(opj_j2k_v2_t *p_j2k,
1064 struct opj_stream_private *cio,
1065 struct opj_image * p_image,
1066 struct opj_event_mgr * p_manager );
1069 * Ends the compression procedures and possibiliy add data to be read after the
1072 opj_bool j2k_end_compress( opj_j2k_v2_t *p_j2k,
1073 opj_stream_private_t *cio,
1074 struct opj_event_mgr * p_manager);
1076 opj_bool j2k_setup_mct_encoding (opj_tcp_v2_t * p_tcp, opj_image_t * p_image);
1079 #endif /* __J2K_H */