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
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
36 @brief The JPEG-2000 Codestream Reader/Writer (J2K)
38 The functions in J2K.C have for goal to read/write the several parts of the codestream: markers and data.
41 /** @defgroup J2K J2K - JPEG-2000 codestream reader/writer */
44 #define J2K_CP_CSTY_PRT 0x01
45 #define J2K_CP_CSTY_SOP 0x02
46 #define J2K_CP_CSTY_EPH 0x04
47 #define J2K_CCP_CSTY_PRT 0x01
48 #define J2K_CCP_CBLKSTY_LAZY 0x01 /**< Selective arithmetic coding bypass */
49 #define J2K_CCP_CBLKSTY_RESET 0x02 /**< Reset context probabilities on coding pass boundaries */
50 #define J2K_CCP_CBLKSTY_TERMALL 0x04 /**< Termination on each coding pass */
51 #define J2K_CCP_CBLKSTY_VSC 0x08 /**< Vertically stripe causal context */
52 #define J2K_CCP_CBLKSTY_PTERM 0x10 /**< Predictable termination */
53 #define J2K_CCP_CBLKSTY_SEGSYM 0x20 /**< Segmentation symbols are used */
54 #define J2K_CCP_QNTSTY_NOQNT 0
55 #define J2K_CCP_QNTSTY_SIQNT 1
56 #define J2K_CCP_QNTSTY_SEQNT 2
58 /* ----------------------------------------------------------------------- */
60 #define J2K_MS_SOC 0xff4f /**< SOC marker value */
61 #define J2K_MS_SOT 0xff90 /**< SOT marker value */
62 #define J2K_MS_SOD 0xff93 /**< SOD marker value */
63 #define J2K_MS_EOC 0xffd9 /**< EOC marker value */
64 #define J2K_MS_SIZ 0xff51 /**< SIZ marker value */
65 #define J2K_MS_COD 0xff52 /**< COD marker value */
66 #define J2K_MS_COC 0xff53 /**< COC marker value */
67 #define J2K_MS_RGN 0xff5e /**< RGN marker value */
68 #define J2K_MS_QCD 0xff5c /**< QCD marker value */
69 #define J2K_MS_QCC 0xff5d /**< QCC marker value */
70 #define J2K_MS_POC 0xff5f /**< POC marker value */
71 #define J2K_MS_TLM 0xff55 /**< TLM marker value */
72 #define J2K_MS_PLM 0xff57 /**< PLM marker value */
73 #define J2K_MS_PLT 0xff58 /**< PLT marker value */
74 #define J2K_MS_PPM 0xff60 /**< PPM marker value */
75 #define J2K_MS_PPT 0xff61 /**< PPT marker value */
76 #define J2K_MS_SOP 0xff91 /**< SOP marker value */
77 #define J2K_MS_EPH 0xff92 /**< EPH marker value */
78 #define J2K_MS_CRG 0xff63 /**< CRG marker value */
79 #define J2K_MS_COM 0xff64 /**< COM marker value */
81 #define J2K_MS_UNK 0 /**< UNKNOWN marker value */
83 #ifdef TODO_MS /* FIXME */
84 #define J2K_MS_CBD 0xff78 /**< CBD marker value */
85 #define J2K_MS_MCC 0xff75 /**< MCC marker value */
86 #define J2K_MS_MCT 0xff74 /**< MCT marker value */
87 #define J2K_MS_MCO 0xff77 /**< MCO 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 */
104 struct opj_stream_private;
106 /* ----------------------------------------------------------------------- */
109 Values that specify the status of the decoding process when decoding the main header.
110 These values may be combined with a | operator.
112 typedef enum J2K_STATUS {
113 J2K_STATE_MHSOC = 0x0001, /**< a SOC marker is expected */
114 J2K_STATE_MHSIZ = 0x0002, /**< a SIZ marker is expected */
115 J2K_STATE_MH = 0x0004, /**< the decoding process is in the main header */
116 J2K_STATE_TPHSOT = 0x0008, /**< the decoding process is in a tile part header and expects a SOT marker */
117 J2K_STATE_TPH = 0x0010, /**< the decoding process is in a tile part header */
118 J2K_STATE_MT = 0x0020, /**< the EOC marker has just been read */
119 J2K_STATE_NEOC = 0x0040, /**< the decoding process must not expect a EOC marker because the codestream is truncated */
121 J2K_STATE_EOC = 0x0100, /**< the decoding process has encountered the EOC marker */
122 J2K_STATE_ERR = 0x8000 /**< the decoding process has encountered an error (FIXME warning V1 = 0x0080)*/
125 /* ----------------------------------------------------------------------- */
130 typedef enum T2_MODE {
131 THRESH_CALC = 0, /** Function called in Rate allocation process*/
132 FINAL_PASS = 1 /** Function called in Tier 2 process*/
136 Quantization stepsize
138 typedef struct opj_stepsize {
146 //Tile-component coding parameters
148 //typedef struct opj_tccp {
149 // /** coding style */
151 // /** number of resolutions */
152 // int numresolutions;
153 // /** code-blocks width */
155 // /** code-blocks height */
157 // /** code-block coding style */
159 // /** discrete wavelet transform identifier */
161 // /** quantisation style */
163 // /** stepsizes used for quantization */
164 // opj_stepsize_t stepsizes[J2K_MAXBANDS];
165 // /** number of guard bits */
167 // /** Region Of Interest shift */
169 // /** precinct width */
170 // int prcw[J2K_MAXRLVLS];
171 // /** precinct height */
172 // int prch[J2K_MAXRLVLS];
176 Tile-component coding parameters
178 typedef struct opj_tccp
182 /** number of resolutions */
183 OPJ_UINT32 numresolutions;
184 /** code-blocks width */
186 /** code-blocks height */
188 /** code-block coding style */
190 /** discrete wavelet transform identifier */
192 /** quantisation style */
194 /** stepsizes used for quantization */
195 opj_stepsize_t stepsizes[J2K_MAXBANDS];
196 /** number of guard bits */
198 /** Region Of Interest shift */
200 /** precinct width */
201 OPJ_UINT32 prcw[J2K_MAXRLVLS];
202 /** precinct height */
203 OPJ_UINT32 prch[J2K_MAXRLVLS];
204 /** the dc_level_shift **/
205 OPJ_INT32 m_dc_level_shift;
211 Tile coding parameters :
212 this structure is used to store coding/decoding parameters common to all
213 tiles (information like COD, COC in main header)
215 typedef struct opj_tcp {
216 /** 1 : first part-tile of a tile */
220 /** progression order */
222 /** number of layers */
224 /** multi-component transform identifier */
226 /** rates of layers */
228 /** number of progression order changes */
230 /** indicates if a POC marker has been used O:NO, 1:YES */
232 /** progression order changes */
234 /** packet header store there for futur use in t2_decode_packet */
235 unsigned char *ppt_data;
236 /** pointer remaining on the first byte of the first header if ppt is used */
237 unsigned char *ppt_data_first;
238 /** If ppt == 1 --> there was a PPT marker for the present tile */
240 /** used in case of multiple marker PPT (number of info already stored) */
244 /** add fixed_quality */
245 float distoratio[100];
246 /** tile-component coding parameters */
252 * Type of data for storing the MCT data
254 typedef enum MCT_ELEMENT_TYPE
256 MCT_TYPE_INT16 = 0, /** MCT data is stored as signed shorts*/
257 MCT_TYPE_INT32 = 1, /** MCT data is stored as signed integers*/
258 MCT_TYPE_FLOAT = 2, /** MCT data is stored as floats*/
259 MCT_TYPE_DOUBLE = 3 /** MCT data is stored as doubles*/
260 } J2K_MCT_ELEMENT_TYPE;
263 * Type of data for storing the MCT data
265 typedef enum MCT_ARRAY_TYPE
267 MCT_TYPE_DEPENDENCY = 0,
268 MCT_TYPE_DECORRELATION = 1,
270 } J2K_MCT_ARRAY_TYPE;
272 typedef struct opj_mct_data
274 J2K_MCT_ELEMENT_TYPE m_element_type;
275 J2K_MCT_ARRAY_TYPE m_array_type;
278 OPJ_UINT32 m_data_size;
282 typedef struct opj_simple_mcc_decorrelation_data
285 OPJ_UINT32 m_nb_comps;
286 opj_mct_data_t * m_decorrelation_array;
287 opj_mct_data_t * m_offset_array;
288 OPJ_UINT32 m_is_irreversible : 1;
290 opj_simple_mcc_decorrelation_data_t;
293 Tile coding parameters :
294 this structure is used to store coding/decoding parameters common to all
295 tiles (information like COD, COC in main header)
297 typedef struct opj_tcp_v2
301 /** progression order */
303 /** number of layers */
304 OPJ_UINT32 numlayers;
305 OPJ_UINT32 num_layers_to_decode;
306 /** multi-component transform identifier */
308 /** rates of layers */
309 OPJ_FLOAT32 rates[100];
310 /** number of progression order changes */
312 /** progression order changes */
314 /** packet header store there for futur use in t2_decode_packet */
316 /** used to keep a track of the allocated memory */
317 OPJ_BYTE *ppt_buffer;
318 /** Number of bytes stored inside ppt_data*/
319 OPJ_UINT32 ppt_data_size;
320 /** size of ppt_data*/
322 /** add fixed_quality */
323 OPJ_FLOAT32 distoratio[100];
324 /** tile-component coding parameters */
326 /** number of tile parts for the tile. */
327 OPJ_UINT32 m_nb_tile_parts;
328 /** data for the tile */
331 OPJ_UINT32 m_data_size;
332 /** encoding norms */
333 OPJ_FLOAT64 * mct_norms;
334 /** the mct decoding matrix */
335 OPJ_FLOAT32 * m_mct_decoding_matrix;
336 /** the mct coding matrix */
337 OPJ_FLOAT32 * m_mct_coding_matrix;
339 opj_mct_data_t * m_mct_records;
340 /** the number of mct records. */
341 OPJ_UINT32 m_nb_mct_records;
342 /** the max number of mct records. */
343 OPJ_UINT32 m_nb_max_mct_records;
345 opj_simple_mcc_decorrelation_data_t * m_mcc_records;
346 /** the number of mct records. */
347 OPJ_UINT32 m_nb_mcc_records;
348 /** the max number of mct records. */
349 OPJ_UINT32 m_nb_max_mcc_records;
353 /***** FLAGS *******/
354 /** If ppt == 1 --> there was a PPT marker for the present tile */
356 /** indicates if a POC marker has been used O:NO, 1:YES */
367 typedef struct opj_cp {
368 /** Digital cinema profile*/
369 OPJ_CINEMA_MODE cinema;
370 /** Maximum rate for each component. If == 0, component size limitation is not considered */
372 /** Size of the image in bits*/
375 OPJ_RSIZ_CAPABILITIES rsiz;
376 /** Enabling Tile part generation*/
378 /** Flag determining tile part generation*/
380 /** Position of tile part flag in progression order*/
382 /** allocation by rate/distortion */
384 /** allocation by fixed layer */
386 /** add fixed_quality */
388 /** if != 0, then original dimension divided by 2^(reduce); if == 0 or not used, image is decoded to the full resolution */
390 /** if != 0, then only the first "layer" layers are decoded; if == 0 or not used, all the quality layers are decoded */
392 /** if == NO_LIMITATION, decode entire codestream; if == LIMIT_TO_MAIN_HEADER then only decode the main header */
393 OPJ_LIMIT_DECODING limit_decoding;
402 /** comment for coding */
404 /** number of tiles in width */
406 /** number of tiles in heigth */
408 /** ID number of the tiles present in the codestream */
410 /** size of the vector tileno */
412 /** packet header store there for futur use in t2_decode_packet */
413 unsigned char *ppm_data;
414 /** pointer remaining on the first byte of the first header if ppm is used */
415 unsigned char *ppm_data_first;
416 /** if ppm == 1 --> there was a PPM marker for the present tile */
418 /** use in case of multiple marker PPM (number of info already store) */
420 /** use in case of multiple marker PPM (case on non-finished previous info) */
424 /** tile coding parameters */
430 /** enables writing of EPC in MH, thus activating JPWL */
432 /** enables writing of EPB, in case of activated JPWL */
434 /** enables writing of ESD, in case of activated JPWL */
436 /** enables writing of informative techniques of ESD, in case of activated JPWL */
438 /** enables writing of RED, in case of activated JPWL */
440 /** error protection method for MH (0,1,16,32,37-128) */
442 /** tile number of header protection specification (>=0) */
443 int hprot_TPH_tileno[JPWL_MAX_NO_TILESPECS];
444 /** error protection methods for TPHs (0,1,16,32,37-128) */
445 int hprot_TPH[JPWL_MAX_NO_TILESPECS];
446 /** tile number of packet protection specification (>=0) */
447 int pprot_tileno[JPWL_MAX_NO_PACKSPECS];
448 /** packet number of packet protection specification (>=0) */
449 int pprot_packno[JPWL_MAX_NO_PACKSPECS];
450 /** error protection methods for packets (0,1,16,32,37-128) */
451 int pprot[JPWL_MAX_NO_PACKSPECS];
452 /** enables writing of ESD, (0/2/4 bytes) */
454 /** sensitivity addressing size (0=auto/2/4 bytes) */
456 /** sensitivity range (0-3) */
458 /** sensitivity method for MH (-1,0-7) */
460 /** tile number of sensitivity specification (>=0) */
461 int sens_TPH_tileno[JPWL_MAX_NO_TILESPECS];
462 /** sensitivity methods for TPHs (-1,0-7) */
463 int sens_TPH[JPWL_MAX_NO_TILESPECS];
464 /** enables JPWL correction at the decoder */
466 /** expected number of components at the decoder */
468 /** maximum number of tiles at the decoder */
470 #endif /* USE_JPWL */
474 typedef struct opj_encoding_param
476 /** Digital cinema profile*/
477 OPJ_CINEMA_MODE m_cinema;
478 /** Maximum rate for each component. If == 0, component size limitation is not considered */
479 OPJ_UINT32 m_max_comp_size;
480 /** Position of tile part flag in progression order*/
483 OPJ_INT32 *m_matrice;
484 /** Flag determining tile part generation*/
486 /** allocation by rate/distortion */
487 OPJ_UINT32 m_disto_alloc : 1;
488 /** allocation by fixed layer */
489 OPJ_UINT32 m_fixed_alloc : 1;
490 /** add fixed_quality */
491 OPJ_UINT32 m_fixed_quality : 1;
492 /** Enabling Tile part generation*/
493 OPJ_UINT32 m_tp_on : 1;
495 opj_encoding_param_t;
497 typedef struct opj_decoding_param
499 /** if != 0, then original dimension divided by 2^(reduce); if == 0 or not used, image is decoded to the full resolution */
501 /** if != 0, then only the first "layer" layers are decoded; if == 0 or not used, all the quality layers are decoded */
504 opj_decoding_param_t;
510 typedef struct opj_cp_v2
512 /** Size of the image in bits*/
515 OPJ_RSIZ_CAPABILITIES rsiz;
517 OPJ_UINT32 tx0; // MSD see norm
519 OPJ_UINT32 ty0; // MSD see norm
526 /** number of tiles in width */
528 /** number of tiles in heigth */
534 /** packet header store there for futur use in t2_decode_packet */
536 /** size of the ppm_data*/
538 /** size of the ppm_data*/
539 OPJ_UINT32 ppm_data_read;
541 OPJ_BYTE *ppm_data_current;
543 /** packet header storage original buffer */
544 OPJ_BYTE *ppm_buffer;
545 /** pointer remaining on the first byte of the first header if ppm is used */
546 OPJ_BYTE *ppm_data_first;
547 /** Number of bytes actually stored inside the ppm_data */
548 OPJ_UINT32 ppm_data_size;
549 /** use in case of multiple marker PPM (number of info already store) */
551 /** use in case of multiple marker PPM (case on non-finished previous info) */
552 OPJ_INT32 ppm_previous;
554 /** tile coding parameters */
559 opj_decoding_param_t m_dec;
560 opj_encoding_param_t m_enc;
567 /** enables writing of EPC in MH, thus activating JPWL */
569 /** enables writing of EPB, in case of activated JPWL */
571 /** enables writing of ESD, in case of activated JPWL */
573 /** enables writing of informative techniques of ESD, in case of activated JPWL */
575 /** enables writing of RED, in case of activated JPWL */
577 /** error protection method for MH (0,1,16,32,37-128) */
579 /** tile number of header protection specification (>=0) */
580 int hprot_TPH_tileno[JPWL_MAX_NO_TILESPECS];
581 /** error protection methods for TPHs (0,1,16,32,37-128) */
582 int hprot_TPH[JPWL_MAX_NO_TILESPECS];
583 /** tile number of packet protection specification (>=0) */
584 int pprot_tileno[JPWL_MAX_NO_PACKSPECS];
585 /** packet number of packet protection specification (>=0) */
586 int pprot_packno[JPWL_MAX_NO_PACKSPECS];
587 /** error protection methods for packets (0,1,16,32,37-128) */
588 int pprot[JPWL_MAX_NO_PACKSPECS];
589 /** enables writing of ESD, (0/2/4 bytes) */
591 /** sensitivity addressing size (0=auto/2/4 bytes) */
593 /** sensitivity range (0-3) */
595 /** sensitivity method for MH (-1,0-7) */
597 /** tile number of sensitivity specification (>=0) */
598 int sens_TPH_tileno[JPWL_MAX_NO_TILESPECS];
599 /** sensitivity methods for TPHs (-1,0-7) */
600 int sens_TPH[JPWL_MAX_NO_TILESPECS];
601 /** enables JPWL correction at the decoder */
603 /** expected number of components at the decoder */
605 /** maximum number of tiles at the decoder */
607 #endif /* USE_JPWL */
609 /******** FLAGS *********/
610 /** if ppm == 1 --> there was a PPM marker*/
612 /** tells if the parameter is a coding or decoding one */
613 OPJ_UINT32 m_is_decoder : 1;
618 typedef struct opj_j2k_dec
620 /** locate in which part of the codestream the decoder is (main header, tile header, end) */
623 * store decoding parameters common to all tiles (information like COD, COC in main header)
625 opj_tcp_v2_t *m_default_tcp;
626 OPJ_BYTE *m_header_data;
627 OPJ_UINT32 m_header_data_size;
628 /** to tell the tile part length */
629 OPJ_UINT32 m_sot_length;
630 /** Only tiles index in the correct range will be decoded.*/
631 OPJ_UINT32 m_start_tile_x;
632 OPJ_UINT32 m_start_tile_y;
633 OPJ_UINT32 m_end_tile_x;
634 OPJ_UINT32 m_end_tile_y;
636 * Indicate that the current tile-part is assume as the last tile part of the codestream.
637 * It is useful in the case of PSot is equal to zero. The sot length will be compute in the
638 * SOD reader function. FIXME NOT USED for the moment
640 opj_bool m_last_tile_part;
641 /** to tell that a tile can be decoded. */
642 OPJ_UINT32 m_can_decode : 1;
643 OPJ_UINT32 m_discard_tiles : 1;
644 OPJ_UINT32 m_skip_data : 1;
648 typedef struct opj_j2k_enc
650 /** Tile part number, regardless of poc, for each new poc, tp is reset to 1*/
651 OPJ_UINT32 m_current_poc_tile_part_number; // tp_num
653 /** 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.*/
654 OPJ_UINT32 m_current_tile_part_number; //cur_tp_num
657 locate the start position of the TLM marker
658 after encoding the tilepart, a jump (in j2k_write_sod) is done to the TLM marker to store the value of its length.
660 OPJ_SIZE_T m_tlm_start;
662 * Stores the sizes of the tlm.
664 OPJ_BYTE * m_tlm_sot_offsets_buffer;
666 * The current offset of the tlm buffer.
668 OPJ_BYTE * m_tlm_sot_offsets_current;
670 /** Total num of tile parts in whole image = num tiles* num tileparts in each tile*/
671 /** used in TLMmarker*/
672 OPJ_UINT32 m_total_tile_parts; // totnum_tp
674 /* encoded data for a tile */
675 OPJ_BYTE * m_encoded_tile_data;
677 /* size of the encoded_data */
678 OPJ_UINT32 m_encoded_tile_size;
680 /* encoded data for a tile */
681 OPJ_BYTE * m_header_tile_data;
683 /* size of the encoded_data */
684 OPJ_UINT32 m_header_tile_data_size;
690 JPEG-2000 codestream reader/writer
692 typedef struct opj_j2k {
694 opj_common_ptr cinfo;
696 /** locate in which part of the codestream the decoder is (main header, tile header, end) */
698 /** number of the tile curently concern by coding/decoding */
700 /** Tile part number*/
702 /** Tilepart number currently coding*/
704 /** Total number of tileparts of the current tile*/
707 locate the start position of the TLM marker
708 after encoding the tilepart, a jump (in j2k_write_sod) is done to the TLM marker to store the value of its length.
711 /** Total num of tile parts in whole image = num tiles* num tileparts in each tile*/
712 /** used in TLMmarker*/
715 locate the position of the end of the tile in the codestream,
716 used to detect a truncated codestream (in j2k_read_sod)
720 locate the start position of the SOT marker of the current coded tile:
721 after encoding the tile, a jump (in j2k_write_sod) is done to the SOT marker to store the value of its length.
726 as the J2K-file is written in several parts during encoding,
727 it enables to make the right correction in position return by cio_tell
730 /** array used to store the data of each tile */
731 unsigned char **tile_data;
732 /** array used to store the length of each tile */
736 store decoding parameters common to all tiles (information like COD, COC in main header)
738 opj_tcp_t *default_tcp;
739 /** pointer to the encoded / decoded image */
741 /** pointer to the coding parameters */
743 /** helper used to write the index file */
744 opj_codestream_info_t *cstr_info;
745 /** pointer to the byte i/o stream */
751 JPEG-2000 codestream reader/writer
753 typedef struct opj_j2k_v2
755 /* J2K codestream is decoded*/
756 opj_bool m_is_decoder;
761 opj_j2k_dec_t m_decoder;
762 opj_j2k_enc_t m_encoder;
766 /** pointer to the encoded / decoded image */
767 //opj_image_t *m_image;
768 opj_image_t* m_image;
770 /** Coding parameters */
773 /** the list of procedures to exec **/
774 struct opj_procedure_list * m_procedure_list;
776 /** the list of validation procedures to follow to make sure the code is valid **/
777 struct opj_procedure_list * m_validation_list;
779 /** helper used to write the index file */
780 opj_codestream_index_t *cstr_index;
782 /** number of the tile curently concern by coding/decoding */
783 OPJ_UINT32 m_current_tile_number;
785 /** the current tile coder/decoder **/
786 struct opj_tcd_v2 * m_tcd;
787 //opj_tcd_v2_t * m_tcd;
797 /** @name Exported functions */
799 /* ----------------------------------------------------------------------- */
801 Creates a J2K decompression structure
802 @param cinfo Codec context info
803 @return Returns a handle to a J2K decompressor if successful, returns NULL otherwise
805 opj_j2k_t* j2k_create_decompress(opj_common_ptr cinfo);
807 Destroy a J2K decompressor handle
808 @param j2k J2K decompressor handle to destroy
810 void j2k_destroy_decompress(opj_j2k_t *j2k);
812 Setup the decoder decoding parameters using user parameters.
813 Decoding parameters are returned in j2k->cp.
814 @param j2k J2K decompressor handle
815 @param parameters decompression parameters
817 void j2k_setup_decoder(opj_j2k_t *j2k, opj_dparameters_t *parameters);
819 void j2k_setup_decoder_v2(opj_j2k_v2_t *j2k, opj_dparameters_t *parameters);
822 Decode an image from a JPEG-2000 codestream
823 @param j2k J2K decompressor handle
824 @param cio Input buffer stream
825 @param cstr_info Codestream information structure if required, NULL otherwise
826 @return Returns a decoded image if successful, returns NULL otherwise
828 opj_image_t* j2k_decode(opj_j2k_t *j2k, opj_cio_t *cio, opj_codestream_info_t *cstr_info);
830 Decode an image form a JPT-stream (JPEG 2000, JPIP)
831 @param j2k J2K decompressor handle
832 @param cio Input buffer stream
833 @param cstr_info Codestream information structure if required, NULL otherwise
834 @return Returns a decoded image if successful, returns NULL otherwise
836 opj_image_t* j2k_decode_jpt_stream(opj_j2k_t *j2k, opj_cio_t *cio, opj_codestream_info_t *cstr_info);
838 Creates a J2K compression structure
839 @param cinfo Codec context info
840 @return Returns a handle to a J2K compressor if successful, returns NULL otherwise
842 opj_j2k_t* j2k_create_compress(opj_common_ptr cinfo);
845 Creates a J2K compression structure
846 @param cinfo Codec context info
847 @return Returns a handle to a J2K compressor if successful, returns NULL otherwise
849 opj_j2k_v2_t* j2k_create_compress_v2();
852 Destroy a J2K compressor handle
853 @param j2k J2K compressor handle to destroy
855 void j2k_destroy_compress(opj_j2k_t *j2k);
857 Setup the encoder parameters using the current image and using user parameters.
858 Coding parameters are returned in j2k->cp.
859 @param j2k J2K compressor handle
860 @param parameters compression parameters
861 @param image input filled image
863 void j2k_setup_encoder(opj_j2k_t *j2k, opj_cparameters_t *parameters, opj_image_t *image);
865 Converts an enum type progression order to string type
867 char *j2k_convert_progression_order(OPJ_PROG_ORDER prg_order);
869 Encode an image into a JPEG-2000 codestream
870 @param j2k J2K compressor handle
871 @param cio Output buffer stream
872 @param image Image to encode
873 @param cstr_info Codestream information structure if required, NULL otherwise
874 @return Returns true if successful, returns false otherwise
876 opj_bool j2k_encode(opj_j2k_t *j2k, opj_cio_t *cio, opj_image_t *image, opj_codestream_info_t *cstr_info);
878 /* ----------------------------------------------------------------------- */
884 * Ends the decompression procedures and possibiliy add data to be read after the
887 opj_bool j2k_end_decompress(opj_j2k_v2_t *j2k, struct opj_stream_private *cio, struct opj_event_mgr * p_manager);
890 * Reads a jpeg2000 codestream header structure.
892 * @param cio the stream to read data from.
893 * @param p_j2k the jpeg2000 codec.
894 * @param p_manager the user event manager.
896 * @return true if the box is valid.
898 opj_bool j2k_read_header( struct opj_stream_private *p_stream,
900 opj_image_t* p_image,
901 struct opj_event_mgr* p_manager );
905 * Destroys a jpeg2000 codec.
907 * @param p_j2k the jpeg20000 structure to destroy.
909 void j2k_destroy (opj_j2k_v2_t *p_j2k);
913 * @param p_j2k the jpeg2000 codec.
914 * @param p_stream the stream to write data to.
915 * @param p_manager the user event manager.
917 opj_bool j2k_decode_tile (
918 opj_j2k_v2_t * p_j2k,
919 OPJ_UINT32 p_tile_index,
921 OPJ_UINT32 p_data_size,
922 struct opj_stream_private *p_stream,
923 struct opj_event_mgr * p_manager
927 * Reads a tile header.
928 * @param p_j2k the jpeg2000 codec.
929 * @param p_stream the stream to write data to.
930 * @param p_manager the user event manager.
932 opj_bool j2k_read_tile_header (
933 opj_j2k_v2_t * p_j2k,
934 OPJ_UINT32 * p_tile_index,
935 OPJ_UINT32 * p_data_size,
936 OPJ_INT32 * p_tile_x0,
937 OPJ_INT32 * p_tile_y0,
938 OPJ_INT32 * p_tile_x1,
939 OPJ_INT32 * p_tile_y1,
940 OPJ_UINT32 * p_nb_comps,
942 struct opj_stream_private *p_stream,
943 struct opj_event_mgr * p_manager
948 * Sets the given area to be decoded. This function should be called right after opj_read_header and before any tile header reading.
950 * @param p_j2k the jpeg2000 codec.
951 * @param p_start_x the left position of the rectangle to decode (in image coordinates).
952 * @param p_end_x the right position of the rectangle to decode (in image coordinates).
953 * @param p_start_y the up position of the rectangle to decode (in image coordinates).
954 * @param p_end_y the bottom position of the rectangle to decode (in image coordinates).
955 * @param p_manager the user event manager
957 * @return true if the area could be set.
959 opj_bool j2k_set_decode_area( opj_j2k_v2_t *p_j2k,
960 OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,
961 OPJ_INT32 p_end_x, OPJ_INT32 p_end_y,
962 struct opj_event_mgr * p_manager );
965 * Creates a J2K decompression structure.
967 * @return a handle to a J2K decompressor if successful, NULL otherwise.
969 opj_j2k_v2_t* j2k_create_decompress_v2();
973 * Dump some elements from the J2K decompression structure .
975 *@param p_j2k the jpeg2000 codec.
976 *@param flag flag to describe what elments are dump.
977 *@param out_stream output stream where dump the elements.
980 void j2k_dump (opj_j2k_v2_t* p_j2k, OPJ_INT32 flag, FILE* out_stream);
985 * Dump an image header structure.
987 *@param img_header the image header to dump.
988 *@param dev_dump_flag flag to describe if we are in the case of this function is use outside j2k_dump function
989 *@param out_stream output stream where dump the elements.
991 void j2k_dump_image_header(opj_image_t* image, opj_bool dev_dump_flag, FILE* out_stream);
994 * Dump a component image header structure.
996 *@param comp_header the component image header to dump.
997 *@param dev_dump_flag flag to describe if we are in the case of this function is use outside j2k_dump function
998 *@param out_stream output stream where dump the elements.
1000 void j2k_dump_image_comp_header(opj_image_comp_t* comp, opj_bool dev_dump_flag, FILE* out_stream);
1003 * Get the codestream info from a JPEG2000 codec.
1005 *@param p_j2k the component image header to dump.
1007 *@return the codestream information extract from the jpg2000 codec
1009 opj_codestream_info_v2_t* j2k_get_cstr_info(opj_j2k_v2_t* p_j2k);
1012 * Get the codestream index from a JPEG2000 codec.
1014 *@param p_j2k the component image header to dump.
1016 *@return the codestream index extract from the jpg2000 codec
1018 opj_codestream_index_t* j2k_get_cstr_index(opj_j2k_v2_t* p_j2k);
1021 * Decode an image from a JPEG-2000 codestream
1022 * @param j2k J2K decompressor handle
1023 * @param cio Input buffer stream
1024 * @param cstr_info Codestream information structure if required, NULL otherwise
1025 * @return Returns a decoded image if successful, returns NULL otherwise
1027 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);
1030 #endif /* __J2K_H */