OpenJPEG  2.3.1
j2k.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) 2001-2003, David Janssens
10  * Copyright (c) 2002-2003, Yannick Verschueren
11  * Copyright (c) 2003-2007, Francois-Olivier Devaux
12  * Copyright (c) 2003-2014, Antonin Descampe
13  * Copyright (c) 2005, Herve Drolon, FreeImage Team
14  * Copyright (c) 2006-2007, Parvatha Elangovan
15  * Copyright (c) 2008, Jerome Fimes, Communications & Systemes <jerome.fimes@c-s.fr>
16  * Copyright (c) 2011-2012, Centre National d'Etudes Spatiales (CNES), France
17  * Copyright (c) 2012, CS Systemes d'Information, France
18  *
19  * All rights reserved.
20  *
21  * Redistribution and use in source and binary forms, with or without
22  * modification, are permitted provided that the following conditions
23  * are met:
24  * 1. Redistributions of source code must retain the above copyright
25  * notice, this list of conditions and the following disclaimer.
26  * 2. Redistributions in binary form must reproduce the above copyright
27  * notice, this list of conditions and the following disclaimer in the
28  * documentation and/or other materials provided with the distribution.
29  *
30  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
31  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
32  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
34  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
35  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
36  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
37  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
38  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
39  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
40  * POSSIBILITY OF SUCH DAMAGE.
41  */
42 #ifndef OPJ_J2K_H
43 #define OPJ_J2K_H
44 
53 
54 #define J2K_CP_CSTY_PRT 0x01
55 #define J2K_CP_CSTY_SOP 0x02
56 #define J2K_CP_CSTY_EPH 0x04
57 #define J2K_CCP_CSTY_PRT 0x01
58 #define J2K_CCP_CBLKSTY_LAZY 0x01
59 #define J2K_CCP_CBLKSTY_RESET 0x02
60 #define J2K_CCP_CBLKSTY_TERMALL 0x04
61 #define J2K_CCP_CBLKSTY_VSC 0x08
62 #define J2K_CCP_CBLKSTY_PTERM 0x10
63 #define J2K_CCP_CBLKSTY_SEGSYM 0x20
64 #define J2K_CCP_QNTSTY_NOQNT 0
65 #define J2K_CCP_QNTSTY_SIQNT 1
66 #define J2K_CCP_QNTSTY_SEQNT 2
67 
68 /* ----------------------------------------------------------------------- */
69 
70 #define J2K_MS_SOC 0xff4f
71 #define J2K_MS_SOT 0xff90
72 #define J2K_MS_SOD 0xff93
73 #define J2K_MS_EOC 0xffd9
74 #define J2K_MS_SIZ 0xff51
75 #define J2K_MS_COD 0xff52
76 #define J2K_MS_COC 0xff53
77 #define J2K_MS_RGN 0xff5e
78 #define J2K_MS_QCD 0xff5c
79 #define J2K_MS_QCC 0xff5d
80 #define J2K_MS_POC 0xff5f
81 #define J2K_MS_TLM 0xff55
82 #define J2K_MS_PLM 0xff57
83 #define J2K_MS_PLT 0xff58
84 #define J2K_MS_PPM 0xff60
85 #define J2K_MS_PPT 0xff61
86 #define J2K_MS_SOP 0xff91
87 #define J2K_MS_EPH 0xff92
88 #define J2K_MS_CRG 0xff63
89 #define J2K_MS_COM 0xff64
90 #define J2K_MS_CBD 0xff78
91 #define J2K_MS_MCC 0xff75
92 #define J2K_MS_MCT 0xff74
93 #define J2K_MS_MCO 0xff77
95 #define J2K_MS_UNK 0
97 /* UniPG>> */
98 #ifdef USE_JPWL
99 #define J2K_MS_EPC 0xff68
100 #define J2K_MS_EPB 0xff66
101 #define J2K_MS_ESD 0xff67
102 #define J2K_MS_RED 0xff69
103 #endif /* USE_JPWL */
104 #ifdef USE_JPSEC
105 #define J2K_MS_SEC 0xff65
106 #define J2K_MS_INSEC 0xff94
107 #endif /* USE_JPSEC */
108 /* <<UniPG */
109 
110 #define J2K_MAX_POCS 32
112 /* ----------------------------------------------------------------------- */
113 
118 typedef enum J2K_STATUS {
119  J2K_STATE_NONE = 0x0000,
120  J2K_STATE_MHSOC = 0x0001,
121  J2K_STATE_MHSIZ = 0x0002,
122  J2K_STATE_MH = 0x0004,
123  J2K_STATE_TPHSOT = 0x0008,
124  J2K_STATE_TPH = 0x0010,
125  J2K_STATE_MT = 0x0020,
126  J2K_STATE_NEOC = 0x0040,
127  J2K_STATE_DATA = 0x0080,
129  J2K_STATE_EOC = 0x0100,
130  J2K_STATE_ERR = 0x8000
131 } J2K_STATUS;
132 
136 typedef enum MCT_ELEMENT_TYPE {
137  MCT_TYPE_INT16 = 0,
138  MCT_TYPE_INT32 = 1,
139  MCT_TYPE_FLOAT = 2,
140  MCT_TYPE_DOUBLE = 3
141 } J2K_MCT_ELEMENT_TYPE;
142 
146 typedef enum MCT_ARRAY_TYPE {
147  MCT_TYPE_DEPENDENCY = 0,
148  MCT_TYPE_DECORRELATION = 1,
149  MCT_TYPE_OFFSET = 2
150 } J2K_MCT_ARRAY_TYPE;
151 
152 /* ----------------------------------------------------------------------- */
153 
157 typedef enum T2_MODE {
158  THRESH_CALC = 0,
159  FINAL_PASS = 1
160 } J2K_T2_MODE;
161 
165 typedef struct opj_stepsize {
167  OPJ_INT32 expn;
169  OPJ_INT32 mant;
170 } opj_stepsize_t;
171 
175 typedef struct opj_tccp {
177  OPJ_UINT32 csty;
179  OPJ_UINT32 numresolutions;
181  OPJ_UINT32 cblkw;
183  OPJ_UINT32 cblkh;
185  OPJ_UINT32 cblksty;
187  OPJ_UINT32 qmfbid;
189  OPJ_UINT32 qntsty;
191  opj_stepsize_t stepsizes[OPJ_J2K_MAXBANDS];
193  OPJ_UINT32 numgbits;
195  OPJ_INT32 roishift;
197  OPJ_UINT32 prcw[OPJ_J2K_MAXRLVLS];
199  OPJ_UINT32 prch[OPJ_J2K_MAXRLVLS];
201  OPJ_INT32 m_dc_level_shift;
202 }
203 opj_tccp_t;
204 
205 
206 
210 typedef struct opj_mct_data {
211  J2K_MCT_ELEMENT_TYPE m_element_type;
212  J2K_MCT_ARRAY_TYPE m_array_type;
213  OPJ_UINT32 m_index;
214  OPJ_BYTE * m_data;
215  OPJ_UINT32 m_data_size;
216 }
217 opj_mct_data_t;
218 
222 typedef struct opj_simple_mcc_decorrelation_data {
223  OPJ_UINT32 m_index;
224  OPJ_UINT32 m_nb_comps;
225  opj_mct_data_t * m_decorrelation_array;
226  opj_mct_data_t * m_offset_array;
227  OPJ_BITFIELD m_is_irreversible : 1;
228 }
229 opj_simple_mcc_decorrelation_data_t;
230 
231 typedef struct opj_ppx_struct {
232  OPJ_BYTE* m_data; /* m_data == NULL => Zppx not read yet */
233  OPJ_UINT32 m_data_size;
234 } opj_ppx;
235 
241 typedef struct opj_tcp {
243  OPJ_UINT32 csty;
245  OPJ_PROG_ORDER prg;
247  OPJ_UINT32 numlayers;
248  OPJ_UINT32 num_layers_to_decode;
250  OPJ_UINT32 mct;
252  OPJ_FLOAT32 rates[100];
254  OPJ_UINT32 numpocs;
256  opj_poc_t pocs[J2K_MAX_POCS];
257 
259  OPJ_UINT32 ppt_markers_count;
261  opj_ppx* ppt_markers;
262 
264  OPJ_BYTE *ppt_data;
266  OPJ_BYTE *ppt_buffer;
268  OPJ_UINT32 ppt_data_size;
270  OPJ_UINT32 ppt_len;
272  OPJ_FLOAT32 distoratio[100];
274  opj_tccp_t *tccps;
276  OPJ_INT32 m_current_tile_part_number;
278  OPJ_UINT32 m_nb_tile_parts;
280  OPJ_BYTE * m_data;
282  OPJ_UINT32 m_data_size;
284  OPJ_FLOAT64 * mct_norms;
286  OPJ_FLOAT32 * m_mct_decoding_matrix;
288  OPJ_FLOAT32 * m_mct_coding_matrix;
290  opj_mct_data_t * m_mct_records;
292  OPJ_UINT32 m_nb_mct_records;
294  OPJ_UINT32 m_nb_max_mct_records;
296  opj_simple_mcc_decorrelation_data_t * m_mcc_records;
298  OPJ_UINT32 m_nb_mcc_records;
300  OPJ_UINT32 m_nb_max_mcc_records;
301 
302 
303  /***** FLAGS *******/
305  OPJ_BITFIELD cod : 1;
307  OPJ_BITFIELD ppt : 1;
309  OPJ_BITFIELD POC : 1;
310 } opj_tcp_t;
311 
312 
313 
314 
315 typedef struct opj_encoding_param {
317  OPJ_UINT32 m_max_comp_size;
319  OPJ_INT32 m_tp_pos;
321  OPJ_INT32 *m_matrice;
323  OPJ_BYTE m_tp_flag;
325  OPJ_BITFIELD m_disto_alloc : 1;
327  OPJ_BITFIELD m_fixed_alloc : 1;
329  OPJ_BITFIELD m_fixed_quality : 1;
331  OPJ_BITFIELD m_tp_on : 1;
332 }
333 opj_encoding_param_t;
334 
335 typedef struct opj_decoding_param {
337  OPJ_UINT32 m_reduce;
339  OPJ_UINT32 m_layer;
340 }
341 opj_decoding_param_t;
342 
343 
347 typedef struct opj_cp {
349  /*int img_size;*/
351  OPJ_UINT16 rsiz;
353  OPJ_UINT32 tx0; /* MSD see norm */
355  OPJ_UINT32 ty0; /* MSD see norm */
357  OPJ_UINT32 tdx;
359  OPJ_UINT32 tdy;
361  OPJ_CHAR *comment;
363  OPJ_UINT32 tw;
365  OPJ_UINT32 th;
366 
368  OPJ_UINT32 ppm_markers_count;
370  opj_ppx* ppm_markers;
371 
373  OPJ_BYTE *ppm_data;
375  OPJ_UINT32 ppm_len;
377  OPJ_UINT32 ppm_data_read;
378 
379  OPJ_BYTE *ppm_data_current;
380 
382  OPJ_BYTE *ppm_buffer;
384  OPJ_BYTE *ppm_data_first;
386  OPJ_UINT32 ppm_data_size;
388  OPJ_INT32 ppm_store;
390  OPJ_INT32 ppm_previous;
391 
393  opj_tcp_t *tcps;
394 
395  union {
396  opj_decoding_param_t m_dec;
397  opj_encoding_param_t m_enc;
398  }
399  m_specific_param;
400 
401 
402  /* UniPG>> */
403 #ifdef USE_JPWL
404 
405  OPJ_BOOL epc_on;
407  OPJ_BOOL epb_on;
409  OPJ_BOOL esd_on;
411  OPJ_BOOL info_on;
413  OPJ_BOOL red_on;
415  int hprot_MH;
417  int hprot_TPH_tileno[JPWL_MAX_NO_TILESPECS];
419  int hprot_TPH[JPWL_MAX_NO_TILESPECS];
421  int pprot_tileno[JPWL_MAX_NO_PACKSPECS];
423  int pprot_packno[JPWL_MAX_NO_PACKSPECS];
425  int pprot[JPWL_MAX_NO_PACKSPECS];
427  int sens_size;
429  int sens_addr;
431  int sens_range;
433  int sens_MH;
435  int sens_TPH_tileno[JPWL_MAX_NO_TILESPECS];
437  int sens_TPH[JPWL_MAX_NO_TILESPECS];
439  OPJ_BOOL correct;
441  int exp_comps;
443  OPJ_UINT32 max_tiles;
444 #endif /* USE_JPWL */
445 
446  /******** FLAGS *********/
448  OPJ_BITFIELD ppm : 1;
450  OPJ_BITFIELD m_is_decoder : 1;
452  OPJ_BITFIELD allow_different_bit_depth_sign : 1;
453  /* <<UniPG */
454 } opj_cp_t;
455 
456 
457 typedef struct opj_j2k_dec {
459  OPJ_UINT32 m_state;
463  opj_tcp_t *m_default_tcp;
464  OPJ_BYTE *m_header_data;
465  OPJ_UINT32 m_header_data_size;
467  OPJ_UINT32 m_sot_length;
469  OPJ_UINT32 m_start_tile_x;
470  OPJ_UINT32 m_start_tile_y;
471  OPJ_UINT32 m_end_tile_x;
472  OPJ_UINT32 m_end_tile_y;
473 
475  OPJ_INT32 m_tile_ind_to_dec;
477  OPJ_OFF_T m_last_sot_read_pos;
478 
484  OPJ_BOOL m_last_tile_part;
485 
486  OPJ_UINT32 m_numcomps_to_decode;
487  OPJ_UINT32 *m_comps_indices_to_decode;
488 
490  OPJ_BITFIELD m_can_decode : 1;
491  OPJ_BITFIELD m_discard_tiles : 1;
492  OPJ_BITFIELD m_skip_data : 1;
494  OPJ_BITFIELD m_nb_tile_parts_correction_checked : 1;
495  OPJ_BITFIELD m_nb_tile_parts_correction : 1;
496 
497 } opj_j2k_dec_t;
498 
499 typedef struct opj_j2k_enc {
501  OPJ_UINT32 m_current_poc_tile_part_number; /* tp_num */
502 
504  OPJ_UINT32 m_current_tile_part_number; /*cur_tp_num */
505 
510  OPJ_OFF_T m_tlm_start;
514  OPJ_BYTE * m_tlm_sot_offsets_buffer;
518  OPJ_BYTE * m_tlm_sot_offsets_current;
519 
522  OPJ_UINT32 m_total_tile_parts; /* totnum_tp */
523 
524  /* encoded data for a tile */
525  OPJ_BYTE * m_encoded_tile_data;
526 
527  /* size of the encoded_data */
528  OPJ_UINT32 m_encoded_tile_size;
529 
530  /* encoded data for a tile */
531  OPJ_BYTE * m_header_tile_data;
532 
533  /* size of the encoded_data */
534  OPJ_UINT32 m_header_tile_data_size;
535 
536 
537 } opj_j2k_enc_t;
538 
539 
540 
541 struct opj_tcd;
545 typedef struct opj_j2k {
546  /* J2K codestream is decoded*/
547  OPJ_BOOL m_is_decoder;
548 
549  /* FIXME DOC*/
550  union {
551  opj_j2k_dec_t m_decoder;
552  opj_j2k_enc_t m_encoder;
553  }
554  m_specific_param;
555 
557  opj_image_t* m_private_image;
558 
559  /* pointer to the output image (decoded)*/
560  opj_image_t* m_output_image;
561 
563  opj_cp_t m_cp;
564 
566  opj_procedure_list_t * m_procedure_list;
567 
569  opj_procedure_list_t * m_validation_list;
570 
572  opj_codestream_index_t *cstr_index;
573 
575  OPJ_UINT32 m_current_tile_number;
576 
578  struct opj_tcd * m_tcd;
579 
581  int m_num_threads;
582 
584  opj_thread_pool_t* m_tp;
585 
586  OPJ_UINT32 ihdr_w;
587  OPJ_UINT32 ihdr_h;
588  OPJ_UINT32 enumcs;
589  unsigned int dump_state;
590 }
591 opj_j2k_t;
592 
593 
594 
595 
598 /* ----------------------------------------------------------------------- */
599 
606 void opj_j2k_setup_decoder(opj_j2k_t *j2k, opj_dparameters_t *parameters);
607 
608 OPJ_BOOL opj_j2k_set_threads(opj_j2k_t *j2k, OPJ_UINT32 num_threads);
609 
615 opj_j2k_t* opj_j2k_create_compress(void);
616 
617 
618 OPJ_BOOL opj_j2k_setup_encoder(opj_j2k_t *p_j2k,
619  opj_cparameters_t *parameters,
620  opj_image_t *image,
621  opj_event_mgr_t * p_manager);
622 
626 const char *opj_j2k_convert_progression_order(OPJ_PROG_ORDER prg_order);
627 
628 /* ----------------------------------------------------------------------- */
632 
637 OPJ_BOOL opj_j2k_end_decompress(opj_j2k_t *j2k,
638  opj_stream_private_t *p_stream,
639  opj_event_mgr_t * p_manager);
640 
651 OPJ_BOOL opj_j2k_read_header(opj_stream_private_t *p_stream,
652  opj_j2k_t* p_j2k,
653  opj_image_t** p_image,
654  opj_event_mgr_t* p_manager);
655 
656 
662 void opj_j2k_destroy(opj_j2k_t *p_j2k);
663 
669 void j2k_destroy_cstr_index(opj_codestream_index_t *p_cstr_ind);
670 
680 OPJ_BOOL opj_j2k_decode_tile(opj_j2k_t * p_j2k,
681  OPJ_UINT32 p_tile_index,
682  OPJ_BYTE * p_data,
683  OPJ_UINT32 p_data_size,
684  opj_stream_private_t *p_stream,
685  opj_event_mgr_t * p_manager);
686 
701 OPJ_BOOL opj_j2k_read_tile_header(opj_j2k_t * p_j2k,
702  OPJ_UINT32 * p_tile_index,
703  OPJ_UINT32 * p_data_size,
704  OPJ_INT32 * p_tile_x0,
705  OPJ_INT32 * p_tile_y0,
706  OPJ_INT32 * p_tile_x1,
707  OPJ_INT32 * p_tile_y1,
708  OPJ_UINT32 * p_nb_comps,
709  OPJ_BOOL * p_go_on,
710  opj_stream_private_t *p_stream,
711  opj_event_mgr_t * p_manager);
712 
713 
724 OPJ_BOOL opj_j2k_set_decoded_components(opj_j2k_t *p_j2k,
725  OPJ_UINT32 numcomps,
726  const OPJ_UINT32* comps_indices,
727  opj_event_mgr_t * p_manager);
728 
742 OPJ_BOOL opj_j2k_set_decode_area(opj_j2k_t *p_j2k,
743  opj_image_t* p_image,
744  OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,
745  OPJ_INT32 p_end_x, OPJ_INT32 p_end_y,
746  opj_event_mgr_t * p_manager);
747 
753 opj_j2k_t* opj_j2k_create_decompress(void);
754 
755 
764 void j2k_dump(opj_j2k_t* p_j2k, OPJ_INT32 flag, FILE* out_stream);
765 
766 
767 
775 void j2k_dump_image_header(opj_image_t* image, OPJ_BOOL dev_dump_flag,
776  FILE* out_stream);
777 
785 void j2k_dump_image_comp_header(opj_image_comp_t* comp, OPJ_BOOL dev_dump_flag,
786  FILE* out_stream);
787 
795 opj_codestream_info_v2_t* j2k_get_cstr_info(opj_j2k_t* p_j2k);
796 
804 opj_codestream_index_t* j2k_get_cstr_index(opj_j2k_t* p_j2k);
805 
814 OPJ_BOOL opj_j2k_decode(opj_j2k_t *j2k,
815  opj_stream_private_t *p_stream,
816  opj_image_t *p_image,
817  opj_event_mgr_t *p_manager);
818 
819 
820 OPJ_BOOL opj_j2k_get_tile(opj_j2k_t *p_j2k,
821  opj_stream_private_t *p_stream,
822  opj_image_t* p_image,
823  opj_event_mgr_t * p_manager,
824  OPJ_UINT32 tile_index);
825 
826 OPJ_BOOL opj_j2k_set_decoded_resolution_factor(opj_j2k_t *p_j2k,
827  OPJ_UINT32 res_factor,
828  opj_event_mgr_t * p_manager);
829 
830 
840 OPJ_BOOL opj_j2k_write_tile(opj_j2k_t * p_j2k,
841  OPJ_UINT32 p_tile_index,
842  OPJ_BYTE * p_data,
843  OPJ_UINT32 p_data_size,
844  opj_stream_private_t *p_stream,
845  opj_event_mgr_t * p_manager);
846 
850 OPJ_BOOL opj_j2k_encode(opj_j2k_t * p_j2k,
851  opj_stream_private_t *cio,
852  opj_event_mgr_t * p_manager);
853 
864 OPJ_BOOL opj_j2k_start_compress(opj_j2k_t *p_j2k,
865  opj_stream_private_t *p_stream,
866  opj_image_t * p_image,
867  opj_event_mgr_t * p_manager);
868 
873 OPJ_BOOL opj_j2k_end_compress(opj_j2k_t *p_j2k,
874  opj_stream_private_t *cio,
875  opj_event_mgr_t * p_manager);
876 
877 OPJ_BOOL opj_j2k_setup_mct_encoding(opj_tcp_t * p_tcp, opj_image_t * p_image);
878 
879 
880 #endif /* OPJ_J2K_H */
Generated by   doxygen 1.8.1