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_MHSOC = 0x0001, /**< a SOC marker is expected */
111 J2K_STATE_MHSIZ = 0x0002, /**< a SIZ marker is expected */
112 J2K_STATE_MH = 0x0004, /**< the decoding process is in the main header */
113 J2K_STATE_TPHSOT = 0x0008, /**< the decoding process is in a tile part header and expects a SOT marker */
114 J2K_STATE_TPH = 0x0010, /**< the decoding process is in a tile part header */
115 J2K_STATE_MT = 0x0020, /**< the EOC marker has just been read */
116 J2K_STATE_NEOC = 0x0040, /**< the decoding process must not expect a EOC marker because the codestream is truncated */
118 J2K_STATE_EOC = 0x0100, /**< the decoding process has encountered the EOC marker */
119 J2K_STATE_ERR = 0x8000 /**< the decoding process has encountered an error (FIXME warning V1 = 0x0080)*/
123 * Type of elements storing in the MCT data
125 typedef enum MCT_ELEMENT_TYPE
127 MCT_TYPE_INT16 = 0, /** MCT data is stored as signed shorts*/
128 MCT_TYPE_INT32 = 1, /** MCT data is stored as signed integers*/
129 MCT_TYPE_FLOAT = 2, /** MCT data is stored as floats*/
130 MCT_TYPE_DOUBLE = 3 /** MCT data is stored as doubles*/
131 } J2K_MCT_ELEMENT_TYPE;
136 typedef enum MCT_ARRAY_TYPE
138 MCT_TYPE_DEPENDENCY = 0,
139 MCT_TYPE_DECORRELATION = 1,
141 } J2K_MCT_ARRAY_TYPE;
143 /* ----------------------------------------------------------------------- */
148 typedef enum T2_MODE {
149 THRESH_CALC = 0, /** Function called in Rate allocation process*/
150 FINAL_PASS = 1 /** Function called in Tier 2 process*/
154 * Quantization stepsize
156 typedef struct opj_stepsize {
164 Tile-component coding parameters
166 typedef struct opj_tccp
170 /** number of resolutions */
171 OPJ_UINT32 numresolutions;
172 /** code-blocks width */
174 /** code-blocks height */
176 /** code-block coding style */
178 /** discrete wavelet transform identifier */
180 /** quantisation style */
182 /** stepsizes used for quantization */
183 opj_stepsize_t stepsizes[J2K_MAXBANDS];
184 /** number of guard bits */
186 /** Region Of Interest shift */
188 /** precinct width */
189 OPJ_UINT32 prcw[J2K_MAXRLVLS];
190 /** precinct height */
191 OPJ_UINT32 prch[J2K_MAXRLVLS];
192 /** the dc_level_shift **/
193 OPJ_INT32 m_dc_level_shift;
199 Tile coding parameters :
200 this structure is used to store coding/decoding parameters common to all
201 tiles (information like COD, COC in main header)
203 typedef struct opj_tcp {
204 /** 1 : first part-tile of a tile */
208 /** progression order */
210 /** number of layers */
212 /** multi-component transform identifier */
214 /** rates of layers */
216 /** number of progression order changes */
218 /** indicates if a POC marker has been used O:NO, 1:YES */
220 /** progression order changes */
222 /** packet header store there for futur use in t2_decode_packet */
223 unsigned char *ppt_data;
224 /** pointer remaining on the first byte of the first header if ppt is used */
225 unsigned char *ppt_data_first;
226 /** If ppt == 1 --> there was a PPT marker for the present tile */
228 /** used in case of multiple marker PPT (number of info already stored) */
232 /** add fixed_quality */
233 float distoratio[100];
234 /** tile-component coding parameters */
241 typedef struct opj_mct_data
243 J2K_MCT_ELEMENT_TYPE m_element_type;
244 J2K_MCT_ARRAY_TYPE m_array_type;
247 OPJ_UINT32 m_data_size;
254 typedef struct opj_simple_mcc_decorrelation_data
257 OPJ_UINT32 m_nb_comps;
258 opj_mct_data_t * m_decorrelation_array;
259 opj_mct_data_t * m_offset_array;
260 OPJ_UINT32 m_is_irreversible : 1;
262 opj_simple_mcc_decorrelation_data_t;
265 Tile coding parameters :
266 this structure is used to store coding/decoding parameters common to all
267 tiles (information like COD, COC in main header)
269 typedef struct opj_tcp_v2
273 /** progression order */
275 /** number of layers */
276 OPJ_UINT32 numlayers;
277 OPJ_UINT32 num_layers_to_decode;
278 /** multi-component transform identifier */
280 /** rates of layers */
281 OPJ_FLOAT32 rates[100];
282 /** number of progression order changes */
284 /** progression order changes */
286 /** packet header store there for futur use in t2_decode_packet */
288 /** used to keep a track of the allocated memory */
289 OPJ_BYTE *ppt_buffer;
290 /** Number of bytes stored inside ppt_data*/
291 OPJ_UINT32 ppt_data_size;
292 /** size of ppt_data*/
294 /** add fixed_quality */
295 OPJ_FLOAT32 distoratio[100];
296 /** tile-component coding parameters */
298 /** number of tile parts for the tile. */
299 OPJ_UINT32 m_nb_tile_parts;
300 /** data for the tile */
303 OPJ_UINT32 m_data_size;
304 /** encoding norms */
305 OPJ_FLOAT64 * mct_norms;
306 /** the mct decoding matrix */
307 OPJ_FLOAT32 * m_mct_decoding_matrix;
308 /** the mct coding matrix */
309 OPJ_FLOAT32 * m_mct_coding_matrix;
311 opj_mct_data_t * m_mct_records;
312 /** the number of mct records. */
313 OPJ_UINT32 m_nb_mct_records;
314 /** the max number of mct records. */
315 OPJ_UINT32 m_nb_max_mct_records;
317 opj_simple_mcc_decorrelation_data_t * m_mcc_records;
318 /** the number of mct records. */
319 OPJ_UINT32 m_nb_mcc_records;
320 /** the max number of mct records. */
321 OPJ_UINT32 m_nb_max_mcc_records;
324 /***** FLAGS *******/
325 /** If ppt == 1 --> there was a PPT marker for the present tile */
327 /** indicates if a POC marker has been used O:NO, 1:YES */
338 typedef struct opj_cp {
339 /** Digital cinema profile*/
340 OPJ_CINEMA_MODE cinema;
341 /** Maximum rate for each component. If == 0, component size limitation is not considered */
343 /** Size of the image in bits*/
346 OPJ_RSIZ_CAPABILITIES rsiz;
347 /** Enabling Tile part generation*/
349 /** Flag determining tile part generation*/
351 /** Position of tile part flag in progression order*/
353 /** allocation by rate/distortion */
355 /** allocation by fixed layer */
357 /** add fixed_quality */
359 /** if != 0, then original dimension divided by 2^(reduce); if == 0 or not used, image is decoded to the full resolution */
361 /** if != 0, then only the first "layer" layers are decoded; if == 0 or not used, all the quality layers are decoded */
363 /** if == NO_LIMITATION, decode entire codestream; if == LIMIT_TO_MAIN_HEADER then only decode the main header */
364 OPJ_LIMIT_DECODING limit_decoding;
373 /** comment for coding */
375 /** number of tiles in width */
377 /** number of tiles in heigth */
379 /** ID number of the tiles present in the codestream */
381 /** size of the vector tileno */
383 /** packet header store there for futur use in t2_decode_packet */
384 unsigned char *ppm_data;
385 /** pointer remaining on the first byte of the first header if ppm is used */
386 unsigned char *ppm_data_first;
387 /** if ppm == 1 --> there was a PPM marker for the present tile */
389 /** use in case of multiple marker PPM (number of info already store) */
391 /** use in case of multiple marker PPM (case on non-finished previous info) */
395 /** tile coding parameters */
401 /** enables writing of EPC in MH, thus activating JPWL */
403 /** enables writing of EPB, in case of activated JPWL */
405 /** enables writing of ESD, in case of activated JPWL */
407 /** enables writing of informative techniques of ESD, in case of activated JPWL */
409 /** enables writing of RED, in case of activated JPWL */
411 /** error protection method for MH (0,1,16,32,37-128) */
413 /** tile number of header protection specification (>=0) */
414 int hprot_TPH_tileno[JPWL_MAX_NO_TILESPECS];
415 /** error protection methods for TPHs (0,1,16,32,37-128) */
416 int hprot_TPH[JPWL_MAX_NO_TILESPECS];
417 /** tile number of packet protection specification (>=0) */
418 int pprot_tileno[JPWL_MAX_NO_PACKSPECS];
419 /** packet number of packet protection specification (>=0) */
420 int pprot_packno[JPWL_MAX_NO_PACKSPECS];
421 /** error protection methods for packets (0,1,16,32,37-128) */
422 int pprot[JPWL_MAX_NO_PACKSPECS];
423 /** enables writing of ESD, (0/2/4 bytes) */
425 /** sensitivity addressing size (0=auto/2/4 bytes) */
427 /** sensitivity range (0-3) */
429 /** sensitivity method for MH (-1,0-7) */
431 /** tile number of sensitivity specification (>=0) */
432 int sens_TPH_tileno[JPWL_MAX_NO_TILESPECS];
433 /** sensitivity methods for TPHs (-1,0-7) */
434 int sens_TPH[JPWL_MAX_NO_TILESPECS];
435 /** enables JPWL correction at the decoder */
437 /** expected number of components at the decoder */
439 /** maximum number of tiles at the decoder */
441 #endif /* USE_JPWL */
445 typedef struct opj_encoding_param
447 /** Digital cinema profile*/
448 OPJ_CINEMA_MODE m_cinema;
449 /** Maximum rate for each component. If == 0, component size limitation is not considered */
450 OPJ_UINT32 m_max_comp_size;
451 /** Position of tile part flag in progression order*/
454 OPJ_INT32 *m_matrice;
455 /** Flag determining tile part generation*/
457 /** allocation by rate/distortion */
458 OPJ_UINT32 m_disto_alloc : 1;
459 /** allocation by fixed layer */
460 OPJ_UINT32 m_fixed_alloc : 1;
461 /** add fixed_quality */
462 OPJ_UINT32 m_fixed_quality : 1;
463 /** Enabling Tile part generation*/
464 OPJ_UINT32 m_tp_on : 1;
466 opj_encoding_param_t;
468 typedef struct opj_decoding_param
470 /** if != 0, then original dimension divided by 2^(reduce); if == 0 or not used, image is decoded to the full resolution */
472 /** if != 0, then only the first "layer" layers are decoded; if == 0 or not used, all the quality layers are decoded */
475 opj_decoding_param_t;
481 typedef struct opj_cp_v2
483 /** Size of the image in bits*/
486 OPJ_RSIZ_CAPABILITIES rsiz;
488 OPJ_UINT32 tx0; // MSD see norm
490 OPJ_UINT32 ty0; // MSD see norm
497 /** number of tiles in width */
499 /** number of tiles in heigth */
502 /** packet header store there for futur use in t2_decode_packet */
504 /** size of the ppm_data*/
506 /** size of the ppm_data*/
507 OPJ_UINT32 ppm_data_read;
509 OPJ_BYTE *ppm_data_current;
511 /** packet header storage original buffer */
512 OPJ_BYTE *ppm_buffer;
513 /** pointer remaining on the first byte of the first header if ppm is used */
514 OPJ_BYTE *ppm_data_first;
515 /** Number of bytes actually stored inside the ppm_data */
516 OPJ_UINT32 ppm_data_size;
517 /** use in case of multiple marker PPM (number of info already store) */
519 /** use in case of multiple marker PPM (case on non-finished previous info) */
520 OPJ_INT32 ppm_previous;
522 /** tile coding parameters */
527 opj_decoding_param_t m_dec;
528 opj_encoding_param_t m_enc;
535 /** enables writing of EPC in MH, thus activating JPWL */
537 /** enables writing of EPB, in case of activated JPWL */
539 /** enables writing of ESD, in case of activated JPWL */
541 /** enables writing of informative techniques of ESD, in case of activated JPWL */
543 /** enables writing of RED, in case of activated JPWL */
545 /** error protection method for MH (0,1,16,32,37-128) */
547 /** tile number of header protection specification (>=0) */
548 int hprot_TPH_tileno[JPWL_MAX_NO_TILESPECS];
549 /** error protection methods for TPHs (0,1,16,32,37-128) */
550 int hprot_TPH[JPWL_MAX_NO_TILESPECS];
551 /** tile number of packet protection specification (>=0) */
552 int pprot_tileno[JPWL_MAX_NO_PACKSPECS];
553 /** packet number of packet protection specification (>=0) */
554 int pprot_packno[JPWL_MAX_NO_PACKSPECS];
555 /** error protection methods for packets (0,1,16,32,37-128) */
556 int pprot[JPWL_MAX_NO_PACKSPECS];
557 /** enables writing of ESD, (0/2/4 bytes) */
559 /** sensitivity addressing size (0=auto/2/4 bytes) */
561 /** sensitivity range (0-3) */
563 /** sensitivity method for MH (-1,0-7) */
565 /** tile number of sensitivity specification (>=0) */
566 int sens_TPH_tileno[JPWL_MAX_NO_TILESPECS];
567 /** sensitivity methods for TPHs (-1,0-7) */
568 int sens_TPH[JPWL_MAX_NO_TILESPECS];
569 /** enables JPWL correction at the decoder */
571 /** expected number of components at the decoder */
573 /** maximum number of tiles at the decoder */
575 #endif /* USE_JPWL */
577 /******** FLAGS *********/
578 /** if ppm == 1 --> there was a PPM marker*/
580 /** tells if the parameter is a coding or decoding one */
581 OPJ_UINT32 m_is_decoder : 1;
586 typedef struct opj_j2k_dec
588 /** locate in which part of the codestream the decoder is (main header, tile header, end) */
591 * store decoding parameters common to all tiles (information like COD, COC in main header)
593 opj_tcp_v2_t *m_default_tcp;
594 OPJ_BYTE *m_header_data;
595 OPJ_UINT32 m_header_data_size;
596 /** to tell the tile part length */
597 OPJ_UINT32 m_sot_length;
598 /** Only tiles index in the correct range will be decoded.*/
599 OPJ_UINT32 m_start_tile_x;
600 OPJ_UINT32 m_start_tile_y;
601 OPJ_UINT32 m_end_tile_x;
602 OPJ_UINT32 m_end_tile_y;
604 * Decoded area set by the user
611 * Indicate that the current tile-part is assume as the last tile part of the codestream.
612 * It is useful in the case of PSot is equal to zero. The sot length will be compute in the
613 * SOD reader function. FIXME NOT USED for the moment
615 opj_bool m_last_tile_part;
616 /** to tell that a tile can be decoded. */
617 OPJ_UINT32 m_can_decode : 1;
618 OPJ_UINT32 m_discard_tiles : 1;
619 OPJ_UINT32 m_skip_data : 1;
623 typedef struct opj_j2k_enc
625 /** Tile part number, regardless of poc, for each new poc, tp is reset to 1*/
626 OPJ_UINT32 m_current_poc_tile_part_number; // tp_num
628 /** 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.*/
629 OPJ_UINT32 m_current_tile_part_number; //cur_tp_num
632 locate the start position of the TLM marker
633 after encoding the tilepart, a jump (in j2k_write_sod) is done to the TLM marker to store the value of its length.
635 OPJ_SIZE_T m_tlm_start;
637 * Stores the sizes of the tlm.
639 OPJ_BYTE * m_tlm_sot_offsets_buffer;
641 * The current offset of the tlm buffer.
643 OPJ_BYTE * m_tlm_sot_offsets_current;
645 /** Total num of tile parts in whole image = num tiles* num tileparts in each tile*/
646 /** used in TLMmarker*/
647 OPJ_UINT32 m_total_tile_parts; // totnum_tp
649 /* encoded data for a tile */
650 OPJ_BYTE * m_encoded_tile_data;
652 /* size of the encoded_data */
653 OPJ_UINT32 m_encoded_tile_size;
655 /* encoded data for a tile */
656 OPJ_BYTE * m_header_tile_data;
658 /* size of the encoded_data */
659 OPJ_UINT32 m_header_tile_data_size;
665 JPEG-2000 codestream reader/writer
667 typedef struct opj_j2k {
669 opj_common_ptr cinfo;
671 /** locate in which part of the codestream the decoder is (main header, tile header, end) */
673 /** number of the tile curently concern by coding/decoding */
675 /** Tile part number*/
677 /** Tilepart number currently coding*/
679 /** Total number of tileparts of the current tile*/
682 locate the start position of the TLM marker
683 after encoding the tilepart, a jump (in j2k_write_sod) is done to the TLM marker to store the value of its length.
686 /** Total num of tile parts in whole image = num tiles* num tileparts in each tile*/
687 /** used in TLMmarker*/
690 locate the position of the end of the tile in the codestream,
691 used to detect a truncated codestream (in j2k_read_sod)
695 locate the start position of the SOT marker of the current coded tile:
696 after encoding the tile, a jump (in j2k_write_sod) is done to the SOT marker to store the value of its length.
701 as the J2K-file is written in several parts during encoding,
702 it enables to make the right correction in position return by cio_tell
705 /** array used to store the data of each tile */
706 unsigned char **tile_data;
707 /** array used to store the length of each tile */
711 store decoding parameters common to all tiles (information like COD, COC in main header)
713 opj_tcp_t *default_tcp;
714 /** pointer to the encoded / decoded image */
716 /** pointer to the coding parameters */
718 /** helper used to write the index file */
719 opj_codestream_info_t *cstr_info;
720 /** pointer to the byte i/o stream */
726 JPEG-2000 codestream reader/writer
728 typedef struct opj_j2k_v2
730 /* J2K codestream is decoded*/
731 opj_bool m_is_decoder;
736 opj_j2k_dec_t m_decoder;
737 opj_j2k_enc_t m_encoder;
741 /** pointer to the internal/private encoded / decoded image */
742 opj_image_t* m_private_image;
744 /* pointer to the output image (decoded)*/
745 opj_image_t* m_output_image;
747 /** Coding parameters */
750 /** the list of procedures to exec **/
751 struct opj_procedure_list * m_procedure_list;
753 /** the list of validation procedures to follow to make sure the code is valid **/
754 struct opj_procedure_list * m_validation_list;
756 /** helper used to write the index file */
757 opj_codestream_index_t *cstr_index;
759 /** number of the tile curently concern by coding/decoding */
760 OPJ_UINT32 m_current_tile_number;
762 /** the current tile coder/decoder **/
763 struct opj_tcd_v2 * m_tcd;
771 /** @name Exported functions */
773 /* ----------------------------------------------------------------------- */
775 Creates a J2K decompression structure
776 @param cinfo Codec context info
777 @return Returns a handle to a J2K decompressor if successful, returns NULL otherwise
779 opj_j2k_t* j2k_create_decompress(opj_common_ptr cinfo);
781 Destroy a J2K decompressor handle
782 @param j2k J2K decompressor handle to destroy
784 void j2k_destroy_decompress(opj_j2k_t *j2k);
786 Setup the decoder decoding parameters using user parameters.
787 Decoding parameters are returned in j2k->cp.
788 @param j2k J2K decompressor handle
789 @param parameters decompression parameters
791 void j2k_setup_decoder(opj_j2k_t *j2k, opj_dparameters_t *parameters);
793 void j2k_setup_decoder_v2(opj_j2k_v2_t *j2k, opj_dparameters_t *parameters);
796 Decode an image from a JPEG-2000 codestream
797 @param j2k J2K decompressor handle
798 @param cio Input buffer stream
799 @param cstr_info Codestream information structure if required, NULL otherwise
800 @return Returns a decoded image if successful, returns NULL otherwise
802 opj_image_t* j2k_decode(opj_j2k_t *j2k, opj_cio_t *cio, opj_codestream_info_t *cstr_info);
804 Decode an image form a JPT-stream (JPEG 2000, JPIP)
805 @param j2k J2K decompressor handle
806 @param cio Input buffer stream
807 @param cstr_info Codestream information structure if required, NULL otherwise
808 @return Returns a decoded image if successful, returns NULL otherwise
810 opj_image_t* j2k_decode_jpt_stream(opj_j2k_t *j2k, opj_cio_t *cio, opj_codestream_info_t *cstr_info);
812 Creates a J2K compression structure
813 @param cinfo Codec context info
814 @return Returns a handle to a J2K compressor if successful, returns NULL otherwise
816 opj_j2k_t* j2k_create_compress(opj_common_ptr cinfo);
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_v2_t* j2k_create_compress_v2();
826 Destroy a J2K compressor handle
827 @param j2k J2K compressor handle to destroy
829 void j2k_destroy_compress(opj_j2k_t *j2k);
831 Setup the encoder parameters using the current image and using user parameters.
832 Coding parameters are returned in j2k->cp.
833 @param j2k J2K compressor handle
834 @param parameters compression parameters
835 @param image input filled image
837 void j2k_setup_encoder(opj_j2k_t *j2k, opj_cparameters_t *parameters, opj_image_t *image);
839 Converts an enum type progression order to string type
841 char *j2k_convert_progression_order(OPJ_PROG_ORDER prg_order);
843 Encode an image into a JPEG-2000 codestream
844 @param j2k J2K compressor handle
845 @param cio Output buffer stream
846 @param image Image to encode
847 @param cstr_info Codestream information structure if required, NULL otherwise
848 @return Returns true if successful, returns false otherwise
850 opj_bool j2k_encode(opj_j2k_t *j2k, opj_cio_t *cio, opj_image_t *image, opj_codestream_info_t *cstr_info);
852 /* ----------------------------------------------------------------------- */
858 * Ends the decompression procedures and possibiliy add data to be read after the
861 opj_bool j2k_end_decompress(opj_j2k_v2_t *j2k, struct opj_stream_private *cio, struct opj_event_mgr * p_manager);
864 * Reads a jpeg2000 codestream header structure.
866 * @param cio the stream to read data from.
867 * @param p_j2k the jpeg2000 codec.
868 * @param p_manager the user event manager.
870 * @return true if the box is valid.
872 opj_bool j2k_read_header( struct opj_stream_private *p_stream,
874 opj_image_t** p_image,
875 struct opj_event_mgr* p_manager );
879 * Destroys a jpeg2000 codec.
881 * @param p_j2k the jpeg20000 structure to destroy.
883 void j2k_destroy (opj_j2k_v2_t *p_j2k);
886 * Destroys a codestream index structure.
888 * @param p_cstr_ind the codestream index parameter to destroy.
890 void j2k_destroy_cstr_index (opj_codestream_index_t *p_cstr_ind);
894 * @param p_j2k the jpeg2000 codec.
895 * @param p_stream the stream to write data to.
896 * @param p_manager the user event manager.
898 opj_bool j2k_decode_tile (
899 opj_j2k_v2_t * p_j2k,
900 OPJ_UINT32 p_tile_index,
902 OPJ_UINT32 p_data_size,
903 struct opj_stream_private *p_stream,
904 struct opj_event_mgr * p_manager
908 * Reads a tile header.
909 * @param p_j2k the jpeg2000 codec.
910 * @param p_stream the stream to write data to.
911 * @param p_manager the user event manager.
913 opj_bool j2k_read_tile_header (
914 opj_j2k_v2_t * p_j2k,
915 OPJ_UINT32 * p_tile_index,
916 OPJ_UINT32 * p_data_size,
917 OPJ_INT32 * p_tile_x0,
918 OPJ_INT32 * p_tile_y0,
919 OPJ_INT32 * p_tile_x1,
920 OPJ_INT32 * p_tile_y1,
921 OPJ_UINT32 * p_nb_comps,
923 struct opj_stream_private *p_stream,
924 struct opj_event_mgr * p_manager
929 * Sets the given area to be decoded. This function should be called right after opj_read_header and before any tile header reading.
931 * @param p_j2k the jpeg2000 codec.
932 * @param p_start_x the left position of the rectangle to decode (in image coordinates).
933 * @param p_end_x the right position of the rectangle to decode (in image coordinates).
934 * @param p_start_y the up position of the rectangle to decode (in image coordinates).
935 * @param p_end_y the bottom position of the rectangle to decode (in image coordinates).
936 * @param p_manager the user event manager
938 * @return true if the area could be set.
940 opj_bool j2k_set_decode_area( opj_j2k_v2_t *p_j2k,
941 opj_image_t* p_image,
942 OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,
943 OPJ_INT32 p_end_x, OPJ_INT32 p_end_y,
944 struct opj_event_mgr * p_manager );
947 * Creates a J2K decompression structure.
949 * @return a handle to a J2K decompressor if successful, NULL otherwise.
951 opj_j2k_v2_t* j2k_create_decompress_v2();
955 * Dump some elements from the J2K decompression structure .
957 *@param p_j2k the jpeg2000 codec.
958 *@param flag flag to describe what elments are dump.
959 *@param out_stream output stream where dump the elements.
962 void j2k_dump (opj_j2k_v2_t* p_j2k, OPJ_INT32 flag, FILE* out_stream);
967 * Dump an image header structure.
969 *@param img_header the image header to dump.
970 *@param dev_dump_flag flag to describe if we are in the case of this function is use outside j2k_dump function
971 *@param out_stream output stream where dump the elements.
973 void j2k_dump_image_header(opj_image_t* image, opj_bool dev_dump_flag, FILE* out_stream);
976 * Dump a component image header structure.
978 *@param comp_header the component image header to dump.
979 *@param dev_dump_flag flag to describe if we are in the case of this function is use outside j2k_dump function
980 *@param out_stream output stream where dump the elements.
982 void j2k_dump_image_comp_header(opj_image_comp_t* comp, opj_bool dev_dump_flag, FILE* out_stream);
985 * Get the codestream info from a JPEG2000 codec.
987 *@param p_j2k the component image header to dump.
989 *@return the codestream information extract from the jpg2000 codec
991 opj_codestream_info_v2_t* j2k_get_cstr_info(opj_j2k_v2_t* p_j2k);
994 * Get the codestream index from a JPEG2000 codec.
996 *@param p_j2k the component image header to dump.
998 *@return the codestream index extract from the jpg2000 codec
1000 opj_codestream_index_t* j2k_get_cstr_index(opj_j2k_v2_t* p_j2k);
1003 * Decode an image from a JPEG-2000 codestream
1004 * @param j2k J2K decompressor handle
1005 * @param cio Input buffer stream
1006 * @param cstr_info Codestream information structure if required, NULL otherwise
1007 * @return Returns a decoded image if successful, returns NULL otherwise
1009 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);
1012 #endif /* __J2K_H */