src/lib/openjp2/j2k.h

   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 /**
  45 @file j2k.h
  46 @brief The JPEG-2000 Codestream Reader/Writer (J2K)
  47
  48 The functions in J2K.C have for goal to read/write the several parts of the codestream: markers and data.
  49 */
  50
  51 /** @defgroup J2K J2K - JPEG-2000 codestream reader/writer */
  52 /*@{*/
  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     /**< Selective arithmetic coding bypass */
  59 #define J2K_CCP_CBLKSTY_RESET 0x02    /**< Reset context probabilities on coding pass boundaries */
  60 #define J2K_CCP_CBLKSTY_TERMALL 0x04  /**< Termination on each coding pass */
  61 #define J2K_CCP_CBLKSTY_VSC 0x08      /**< Vertically stripe causal context */
  62 #define J2K_CCP_CBLKSTY_PTERM 0x10    /**< Predictable termination */
  63 #define J2K_CCP_CBLKSTY_SEGSYM 0x20   /**< Segmentation symbols are used */
  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   /**< SOC marker value */
  71 #define J2K_MS_SOT 0xff90   /**< SOT marker value */
  72 #define J2K_MS_SOD 0xff93   /**< SOD marker value */
  73 #define J2K_MS_EOC 0xffd9   /**< EOC marker value */
  74 #define J2K_MS_SIZ 0xff51   /**< SIZ marker value */
  75 #define J2K_MS_COD 0xff52   /**< COD marker value */
  76 #define J2K_MS_COC 0xff53   /**< COC marker value */
  77 #define J2K_MS_RGN 0xff5e   /**< RGN marker value */
  78 #define J2K_MS_QCD 0xff5c   /**< QCD marker value */
  79 #define J2K_MS_QCC 0xff5d   /**< QCC marker value */
  80 #define J2K_MS_POC 0xff5f   /**< POC marker value */
  81 #define J2K_MS_TLM 0xff55   /**< TLM marker value */
  82 #define J2K_MS_PLM 0xff57   /**< PLM marker value */
  83 #define J2K_MS_PLT 0xff58   /**< PLT marker value */
  84 #define J2K_MS_PPM 0xff60   /**< PPM marker value */
  85 #define J2K_MS_PPT 0xff61   /**< PPT marker value */
  86 #define J2K_MS_SOP 0xff91   /**< SOP marker value */
  87 #define J2K_MS_EPH 0xff92   /**< EPH marker value */
  88 #define J2K_MS_CRG 0xff63   /**< CRG marker value */
  89 #define J2K_MS_COM 0xff64   /**< COM marker value */
  90 #define J2K_MS_CBD 0xff78   /**< CBD marker value */
  91 #define J2K_MS_MCC 0xff75   /**< MCC marker value */
  92 #define J2K_MS_MCT 0xff74   /**< MCT marker value */
  93 #define J2K_MS_MCO 0xff77   /**< MCO marker value */
  94
  95 #define J2K_MS_UNK 0        /**< UNKNOWN marker value */
  96
  97 /* UniPG>> */
  98 #ifdef USE_JPWL
  99 #define J2K_MS_EPC 0xff68   /**< EPC marker value (Part 11: JPEG 2000 for Wireless) */
 100 #define J2K_MS_EPB 0xff66   /**< EPB marker value (Part 11: JPEG 2000 for Wireless) */
 101 #define J2K_MS_ESD 0xff67   /**< ESD marker value (Part 11: JPEG 2000 for Wireless) */
 102 #define J2K_MS_RED 0xff69   /**< RED marker value (Part 11: JPEG 2000 for Wireless) */
 103 #endif /* USE_JPWL */
 104 #ifdef USE_JPSEC
 105 #define J2K_MS_SEC 0xff65    /**< SEC marker value (Part 8: Secure JPEG 2000) */
 106 #define J2K_MS_INSEC 0xff94  /**< INSEC marker value (Part 8: Secure JPEG 2000) */
 107 #endif /* USE_JPSEC */
 108 /* <<UniPG */
 109
 110 #define J2K_MAX_POCS    32      /**< Maximum number of POCs */
 111
 112 /* ----------------------------------------------------------------------- */
 113
 114 /**
 115  * Values that specify the status of the decoding process when decoding the main header.
 116  * These values may be combined with a | operator.
 117  * */
 118 typedef enum J2K_STATUS {
 119     J2K_STATE_NONE  =  0x0000, /**< a SOC marker is expected */
 120     J2K_STATE_MHSOC  = 0x0001, /**< a SOC marker is expected */
 121     J2K_STATE_MHSIZ  = 0x0002, /**< a SIZ marker is expected */
 122     J2K_STATE_MH     = 0x0004, /**< the decoding process is in the main header */
 123     J2K_STATE_TPHSOT = 0x0008, /**< the decoding process is in a tile part header and expects a SOT marker */
 124     J2K_STATE_TPH    = 0x0010, /**< the decoding process is in a tile part header */
 125     J2K_STATE_MT     = 0x0020, /**< the EOC marker has just been read */
 126     J2K_STATE_NEOC   = 0x0040, /**< the decoding process must not expect a EOC marker because the codestream is truncated */
 127     J2K_STATE_DATA   = 0x0080, /**< a tile header has been successfully read and codestream is expected */
 128
 129     J2K_STATE_EOC    = 0x0100, /**< the decoding process has encountered the EOC marker */
 130     J2K_STATE_ERR    = 0x8000  /**< the decoding process has encountered an error (FIXME warning V1 = 0x0080)*/
 131 } J2K_STATUS;
 132
 133 /**
 134  * Type of elements storing in the MCT data
 135  */
 136 typedef enum MCT_ELEMENT_TYPE {
 137     MCT_TYPE_INT16 = 0,     /** MCT data is stored as signed shorts*/
 138     MCT_TYPE_INT32 = 1,     /** MCT data is stored as signed integers*/
 139     MCT_TYPE_FLOAT = 2,     /** MCT data is stored as floats*/
 140     MCT_TYPE_DOUBLE = 3     /** MCT data is stored as doubles*/
 141 } J2K_MCT_ELEMENT_TYPE;
 142
 143 /**
 144  * Type of MCT array
 145  */
 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
 154 /**
 155 T2 encoding mode
 156 */
 157 typedef enum T2_MODE {
 158     THRESH_CALC = 0,    /** Function called in Rate allocation process*/
 159     FINAL_PASS = 1      /** Function called in Tier 2 process*/
 160 } J2K_T2_MODE;
 161
 162 /**
 163  * Quantization stepsize
 164  */
 165 typedef struct opj_stepsize {
 166     /** exponent */
 167     OPJ_INT32 expn;
 168     /** mantissa */
 169     OPJ_INT32 mant;
 170 } opj_stepsize_t;
 171
 172 /**
 173 Tile-component coding parameters
 174 */
 175 typedef struct opj_tccp {
 176     /** coding style */
 177     OPJ_UINT32 csty;
 178     /** number of resolutions */
 179     OPJ_UINT32 numresolutions;
 180     /** code-blocks width */
 181     OPJ_UINT32 cblkw;
 182     /** code-blocks height */
 183     OPJ_UINT32 cblkh;
 184     /** code-block coding style */
 185     OPJ_UINT32 cblksty;
 186     /** discrete wavelet transform identifier */
 187     OPJ_UINT32 qmfbid;
 188     /** quantisation style */
 189     OPJ_UINT32 qntsty;
 190     /** stepsizes used for quantization */
 191     opj_stepsize_t stepsizes[OPJ_J2K_MAXBANDS];
 192     /** number of guard bits */
 193     OPJ_UINT32 numgbits;
 194     /** Region Of Interest shift */
 195     OPJ_INT32 roishift;
 196     /** precinct width */
 197     OPJ_UINT32 prcw[OPJ_J2K_MAXRLVLS];
 198     /** precinct height */
 199     OPJ_UINT32 prch[OPJ_J2K_MAXRLVLS];
 200     /** the dc_level_shift **/
 201     OPJ_INT32 m_dc_level_shift;
 202 }
 203 opj_tccp_t;
 204
 205
 206
 207 /**
 208  * FIXME DOC
 209  */
 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
 219 /**
 220  * FIXME DOC
 221  */
 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
 236 /**
 237 Tile coding parameters :
 238 this structure is used to store coding/decoding parameters common to all
 239 tiles (information like COD, COC in main header)
 240 */
 241 typedef struct opj_tcp {
 242     /** coding style */
 243     OPJ_UINT32 csty;
 244     /** progression order */
 245     OPJ_PROG_ORDER prg;
 246     /** number of layers */
 247     OPJ_UINT32 numlayers;
 248     OPJ_UINT32 num_layers_to_decode;
 249     /** multi-component transform identifier */
 250     OPJ_UINT32 mct;
 251     /** rates of layers */
 252     OPJ_FLOAT32 rates[100];
 253     /** number of progression order changes */
 254     OPJ_UINT32 numpocs;
 255     /** progression order changes */
 256     opj_poc_t pocs[J2K_MAX_POCS];
 257
 258     /** number of ppt markers (reserved size) */
 259     OPJ_UINT32 ppt_markers_count;
 260     /** ppt markers data (table indexed by Zppt) */
 261     opj_ppx* ppt_markers;
 262
 263     /** packet header store there for future use in t2_decode_packet */
 264     OPJ_BYTE *ppt_data;
 265     /** used to keep a track of the allocated memory */
 266     OPJ_BYTE *ppt_buffer;
 267     /** Number of bytes stored inside ppt_data*/
 268     OPJ_UINT32 ppt_data_size;
 269     /** size of ppt_data*/
 270     OPJ_UINT32 ppt_len;
 271     /** add fixed_quality */
 272     OPJ_FLOAT32 distoratio[100];
 273     /** tile-component coding parameters */
 274     opj_tccp_t *tccps;
 275     /** current tile part number or -1 if first time into this tile */
 276     OPJ_INT32  m_current_tile_part_number;
 277     /** number of tile parts for the tile. */
 278     OPJ_UINT32 m_nb_tile_parts;
 279     /** data for the tile */
 280     OPJ_BYTE *      m_data;
 281     /** size of data */
 282     OPJ_UINT32      m_data_size;
 283     /** encoding norms */
 284     OPJ_FLOAT64 *   mct_norms;
 285     /** the mct decoding matrix */
 286     OPJ_FLOAT32 *   m_mct_decoding_matrix;
 287     /** the mct coding matrix */
 288     OPJ_FLOAT32 *   m_mct_coding_matrix;
 289     /** mct records */
 290     opj_mct_data_t * m_mct_records;
 291     /** the number of mct records. */
 292     OPJ_UINT32 m_nb_mct_records;
 293     /** the max number of mct records. */
 294     OPJ_UINT32 m_nb_max_mct_records;
 295     /** mcc records */
 296     opj_simple_mcc_decorrelation_data_t * m_mcc_records;
 297     /** the number of mct records. */
 298     OPJ_UINT32 m_nb_mcc_records;
 299     /** the max number of mct records. */
 300     OPJ_UINT32 m_nb_max_mcc_records;
 301
 302
 303     /***** FLAGS *******/
 304     /** If cod == 1 --> there was a COD marker for the present tile */
 305     OPJ_BITFIELD cod : 1;
 306     /** If ppt == 1 --> there was a PPT marker for the present tile */
 307     OPJ_BITFIELD ppt : 1;
 308     /** indicates if a POC marker has been used O:NO, 1:YES */
 309     OPJ_BITFIELD POC : 1;
 310 } opj_tcp_t;
 311
 312
 313
 314
 315 typedef struct opj_encoding_param {
 316     /** Maximum rate for each component. If == 0, component size limitation is not considered */
 317     OPJ_UINT32 m_max_comp_size;
 318     /** Position of tile part flag in progression order*/
 319     OPJ_INT32 m_tp_pos;
 320     /** fixed layer */
 321     OPJ_INT32 *m_matrice;
 322     /** Flag determining tile part generation*/
 323     OPJ_BYTE m_tp_flag;
 324     /** allocation by rate/distortion */
 325     OPJ_BITFIELD m_disto_alloc : 1;
 326     /** allocation by fixed layer */
 327     OPJ_BITFIELD m_fixed_alloc : 1;
 328     /** add fixed_quality */
 329     OPJ_BITFIELD m_fixed_quality : 1;
 330     /** Enabling Tile part generation*/
 331     OPJ_BITFIELD m_tp_on : 1;
 332 }
 333 opj_encoding_param_t;
 334
 335 typedef struct opj_decoding_param {
 336     /** if != 0, then original dimension divided by 2^(reduce); if == 0 or not used, image is decoded to the full resolution */
 337     OPJ_UINT32 m_reduce;
 338     /** if != 0, then only the first "layer" layers are decoded; if == 0 or not used, all the quality layers are decoded */
 339     OPJ_UINT32 m_layer;
 340 }
 341 opj_decoding_param_t;
 342
 343
 344 /**
 345  * Coding parameters
 346  */
 347 typedef struct opj_cp {
 348     /** Size of the image in bits*/
 349     /*int img_size;*/
 350     /** Rsiz*/
 351     OPJ_UINT16 rsiz;
 352     /** XTOsiz */
 353     OPJ_UINT32 tx0; /* MSD see norm */
 354     /** YTOsiz */
 355     OPJ_UINT32 ty0; /* MSD see norm */
 356     /** XTsiz */
 357     OPJ_UINT32 tdx;
 358     /** YTsiz */
 359     OPJ_UINT32 tdy;
 360     /** comment */
 361     OPJ_CHAR *comment;
 362     /** number of tiles in width */
 363     OPJ_UINT32 tw;
 364     /** number of tiles in height */
 365     OPJ_UINT32 th;
 366
 367     /** number of ppm markers (reserved size) */
 368     OPJ_UINT32 ppm_markers_count;
 369     /** ppm markers data (table indexed by Zppm) */
 370     opj_ppx* ppm_markers;
 371
 372     /** packet header store there for future use in t2_decode_packet */
 373     OPJ_BYTE *ppm_data;
 374     /** size of the ppm_data*/
 375     OPJ_UINT32 ppm_len;
 376     /** size of the ppm_data*/
 377     OPJ_UINT32 ppm_data_read;
 378
 379     OPJ_BYTE *ppm_data_current;
 380
 381     /** packet header storage original buffer */
 382     OPJ_BYTE *ppm_buffer;
 383     /** pointer remaining on the first byte of the first header if ppm is used */
 384     OPJ_BYTE *ppm_data_first;
 385     /** Number of bytes actually stored inside the ppm_data */
 386     OPJ_UINT32 ppm_data_size;
 387     /** use in case of multiple marker PPM (number of info already store) */
 388     OPJ_INT32 ppm_store;
 389     /** use in case of multiple marker PPM (case on non-finished previous info) */
 390     OPJ_INT32 ppm_previous;
 391
 392     /** tile coding parameters */
 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     /** enables writing of EPC in MH, thus activating JPWL */
 405     OPJ_BOOL epc_on;
 406     /** enables writing of EPB, in case of activated JPWL */
 407     OPJ_BOOL epb_on;
 408     /** enables writing of ESD, in case of activated JPWL */
 409     OPJ_BOOL esd_on;
 410     /** enables writing of informative techniques of ESD, in case of activated JPWL */
 411     OPJ_BOOL info_on;
 412     /** enables writing of RED, in case of activated JPWL */
 413     OPJ_BOOL red_on;
 414     /** error protection method for MH (0,1,16,32,37-128) */
 415     int hprot_MH;
 416     /** tile number of header protection specification (>=0) */
 417     int hprot_TPH_tileno[JPWL_MAX_NO_TILESPECS];
 418     /** error protection methods for TPHs (0,1,16,32,37-128) */
 419     int hprot_TPH[JPWL_MAX_NO_TILESPECS];
 420     /** tile number of packet protection specification (>=0) */
 421     int pprot_tileno[JPWL_MAX_NO_PACKSPECS];
 422     /** packet number of packet protection specification (>=0) */
 423     int pprot_packno[JPWL_MAX_NO_PACKSPECS];
 424     /** error protection methods for packets (0,1,16,32,37-128) */
 425     int pprot[JPWL_MAX_NO_PACKSPECS];
 426     /** enables writing of ESD, (0/2/4 bytes) */
 427     int sens_size;
 428     /** sensitivity addressing size (0=auto/2/4 bytes) */
 429     int sens_addr;
 430     /** sensitivity range (0-3) */
 431     int sens_range;
 432     /** sensitivity method for MH (-1,0-7) */
 433     int sens_MH;
 434     /** tile number of sensitivity specification (>=0) */
 435     int sens_TPH_tileno[JPWL_MAX_NO_TILESPECS];
 436     /** sensitivity methods for TPHs (-1,0-7) */
 437     int sens_TPH[JPWL_MAX_NO_TILESPECS];
 438     /** enables JPWL correction at the decoder */
 439     OPJ_BOOL correct;
 440     /** expected number of components at the decoder */
 441     int exp_comps;
 442     /** maximum number of tiles at the decoder */
 443     OPJ_UINT32 max_tiles;
 444 #endif /* USE_JPWL */
 445
 446     /******** FLAGS *********/
 447     /** if ppm == 1 --> there was a PPM marker*/
 448     OPJ_BITFIELD ppm : 1;
 449     /** tells if the parameter is a coding or decoding one */
 450     OPJ_BITFIELD m_is_decoder : 1;
 451     /** whether different bit depth or sign per component is allowed. Decoder only for ow */
 452     OPJ_BITFIELD allow_different_bit_depth_sign : 1;
 453     /* <<UniPG */
 454 } opj_cp_t;
 455
 456
 457 typedef struct opj_j2k_dec {
 458     /** locate in which part of the codestream the decoder is (main header, tile header, end) */
 459     OPJ_UINT32 m_state;
 460     /**
 461      * store decoding parameters common to all tiles (information like COD, COC in main header)
 462      */
 463     opj_tcp_t *m_default_tcp;
 464     OPJ_BYTE  *m_header_data;
 465     OPJ_UINT32 m_header_data_size;
 466     /** to tell the tile part length */
 467     OPJ_UINT32 m_sot_length;
 468     /** Only tiles index in the correct range will be decoded.*/
 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
 474     /** Index of the tile to decode (used in get_tile) */
 475     OPJ_INT32 m_tile_ind_to_dec;
 476     /** Position of the last SOT marker read */
 477     OPJ_OFF_T m_last_sot_read_pos;
 478
 479     /**
 480      * Indicate that the current tile-part is assume as the last tile part of the codestream.
 481      * It is useful in the case of PSot is equal to zero. The sot length will be compute in the
 482      * SOD reader function. FIXME NOT USED for the moment
 483      */
 484     OPJ_BOOL   m_last_tile_part;
 485
 486     OPJ_UINT32   m_numcomps_to_decode;
 487     OPJ_UINT32  *m_comps_indices_to_decode;
 488
 489     /** to tell that a tile can be decoded. */
 490     OPJ_BITFIELD m_can_decode : 1;
 491     OPJ_BITFIELD m_discard_tiles : 1;
 492     OPJ_BITFIELD m_skip_data : 1;
 493     /** TNsot correction : see issue 254 **/
 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 {
 500     /** Tile part number, regardless of poc, for each new poc, tp is reset to 1*/
 501     OPJ_UINT32 m_current_poc_tile_part_number; /* tp_num */
 502
 503     /** 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.*/
 504     OPJ_UINT32 m_current_tile_part_number; /*cur_tp_num */
 505
 506     /**
 507     locate the start position of the TLM marker
 508     after encoding the tilepart, a jump (in j2k_write_sod) is done to the TLM marker to store the value of its length.
 509     */
 510     OPJ_OFF_T m_tlm_start;
 511     /**
 512      * Stores the sizes of the tlm.
 513      */
 514     OPJ_BYTE * m_tlm_sot_offsets_buffer;
 515     /**
 516      * The current offset of the tlm buffer.
 517      */
 518     OPJ_BYTE * m_tlm_sot_offsets_current;
 519
 520     /** Total num of tile parts in whole image = num tiles* num tileparts in each tile*/
 521     /** used in TLMmarker*/
 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;
 542 /**
 543 JPEG-2000 codestream reader/writer
 544 */
 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
 556     /** pointer to the internal/private encoded / decoded image */
 557     opj_image_t* m_private_image;
 558
 559     /* pointer to the output image (decoded)*/
 560     opj_image_t* m_output_image;
 561
 562     /** Coding parameters */
 563     opj_cp_t m_cp;
 564
 565     /** the list of procedures to exec **/
 566     opj_procedure_list_t *  m_procedure_list;
 567
 568     /** the list of validation procedures to follow to make sure the code is valid **/
 569     opj_procedure_list_t *  m_validation_list;
 570
 571     /** helper used to write the index file */
 572     opj_codestream_index_t *cstr_index;
 573
 574     /** number of the tile currently concern by coding/decoding */
 575     OPJ_UINT32 m_current_tile_number;
 576
 577     /** the current tile coder/decoder **/
 578     struct opj_tcd *    m_tcd;
 579
 580     /** Number of threads to use */
 581     int m_num_threads;
 582
 583     /** Thread pool */
 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
 596 /** @name Exported functions */
 597 /*@{*/
 598 /* ----------------------------------------------------------------------- */
 599
 600 /**
 601 Setup the decoder decoding parameters using user parameters.
 602 Decoding parameters are returned in j2k->cp.
 603 @param j2k J2K decompressor handle
 604 @param parameters decompression parameters
 605 */
 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
 610 /**
 611  * Creates a J2K compression structure
 612  *
 613  * @return Returns a handle to a J2K compressor if successful, returns NULL otherwise
 614 */
 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
 623 /**
 624 Converts an enum type progression order to string type
 625 */
 626 const char *opj_j2k_convert_progression_order(OPJ_PROG_ORDER prg_order);
 627
 628 /* ----------------------------------------------------------------------- */
 629 /*@}*/
 630
 631 /*@}*/
 632
 633 /**
 634  * Ends the decompression procedures and possibiliy add data to be read after the
 635  * codestream.
 636  */
 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
 641 /**
 642  * Reads a jpeg2000 codestream header structure.
 643  *
 644  * @param p_stream the stream to read data from.
 645  * @param p_j2k the jpeg2000 codec.
 646  * @param p_image FIXME DOC
 647  * @param p_manager the user event manager.
 648  *
 649  * @return true if the box is valid.
 650  */
 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
 657 /**
 658  * Destroys a jpeg2000 codec.
 659  *
 660  * @param   p_j2k   the jpeg20000 structure to destroy.
 661  */
 662 void opj_j2k_destroy(opj_j2k_t *p_j2k);
 663
 664 /**
 665  * Destroys a codestream index structure.
 666  *
 667  * @param   p_cstr_ind  the codestream index parameter to destroy.
 668  */
 669 void j2k_destroy_cstr_index(opj_codestream_index_t *p_cstr_ind);
 670
 671 /**
 672  * Decode tile data.
 673  * @param   p_j2k       the jpeg2000 codec.
 674  * @param   p_tile_index
 675  * @param p_data       FIXME DOC
 676  * @param p_data_size  FIXME DOC
 677  * @param   p_stream            the stream to write data to.
 678  * @param   p_manager   the user event manager.
 679  */
 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
 687 /**
 688  * Reads a tile header.
 689  * @param   p_j2k       the jpeg2000 codec.
 690  * @param   p_tile_index FIXME DOC
 691  * @param   p_data_size FIXME DOC
 692  * @param   p_tile_x0 FIXME DOC
 693  * @param   p_tile_y0 FIXME DOC
 694  * @param   p_tile_x1 FIXME DOC
 695  * @param   p_tile_y1 FIXME DOC
 696  * @param   p_nb_comps FIXME DOC
 697  * @param   p_go_on FIXME DOC
 698  * @param   p_stream            the stream to write data to.
 699  * @param   p_manager   the user event manager.
 700  */
 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
 714 /** Sets the indices of the components to decode.
 715  *
 716  * @param p_j2k         the jpeg2000 codec.
 717  * @param numcomps      Number of components to decode.
 718  * @param comps_indices Array of num_compts indices (numbering starting at 0)
 719  *                      corresponding to the components to decode.
 720  * @param p_manager     Event manager
 721  *
 722  * @return OPJ_TRUE in case of success.
 723  */
 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
 729 /**
 730  * Sets the given area to be decoded. This function should be called right after opj_read_header and before any tile header reading.
 731  *
 732  * @param   p_j2k           the jpeg2000 codec.
 733  * @param   p_image     FIXME DOC
 734  * @param   p_start_x       the left position of the rectangle to decode (in image coordinates).
 735  * @param   p_start_y       the up position of the rectangle to decode (in image coordinates).
 736  * @param   p_end_x         the right position of the rectangle to decode (in image coordinates).
 737  * @param   p_end_y         the bottom position of the rectangle to decode (in image coordinates).
 738  * @param   p_manager       the user event manager
 739  *
 740  * @return  true            if the area could be set.
 741  */
 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
 748 /**
 749  * Creates a J2K decompression structure.
 750  *
 751  * @return a handle to a J2K decompressor if successful, NULL otherwise.
 752  */
 753 opj_j2k_t* opj_j2k_create_decompress(void);
 754
 755
 756 /**
 757  * Dump some elements from the J2K decompression structure .
 758  *
 759  *@param p_j2k              the jpeg2000 codec.
 760  *@param flag               flag to describe what elements are dump.
 761  *@param out_stream         output stream where dump the elements.
 762  *
 763 */
 764 void j2k_dump(opj_j2k_t* p_j2k, OPJ_INT32 flag, FILE* out_stream);
 765
 766
 767
 768 /**
 769  * Dump an image header structure.
 770  *
 771  *@param image          the image header to dump.
 772  *@param dev_dump_flag      flag to describe if we are in the case of this function is use outside j2k_dump function
 773  *@param out_stream         output stream where dump the elements.
 774  */
 775 void j2k_dump_image_header(opj_image_t* image, OPJ_BOOL dev_dump_flag,
 776                            FILE* out_stream);
 777
 778 /**
 779  * Dump a component image header structure.
 780  *
 781  *@param comp       the component image header to dump.
 782  *@param dev_dump_flag      flag to describe if we are in the case of this function is use outside j2k_dump function
 783  *@param out_stream         output stream where dump the elements.
 784  */
 785 void j2k_dump_image_comp_header(opj_image_comp_t* comp, OPJ_BOOL dev_dump_flag,
 786                                 FILE* out_stream);
 787
 788 /**
 789  * Get the codestream info from a JPEG2000 codec.
 790  *
 791  *@param    p_j2k               the component image header to dump.
 792  *
 793  *@return   the codestream information extract from the jpg2000 codec
 794  */
 795 opj_codestream_info_v2_t* j2k_get_cstr_info(opj_j2k_t* p_j2k);
 796
 797 /**
 798  * Get the codestream index from a JPEG2000 codec.
 799  *
 800  *@param    p_j2k               the component image header to dump.
 801  *
 802  *@return   the codestream index extract from the jpg2000 codec
 803  */
 804 opj_codestream_index_t* j2k_get_cstr_index(opj_j2k_t* p_j2k);
 805
 806 /**
 807  * Decode an image from a JPEG-2000 codestream
 808  * @param j2k J2K decompressor handle
 809  * @param p_stream  FIXME DOC
 810  * @param p_image   FIXME DOC
 811  * @param p_manager FIXME DOC
 812  * @return FIXME DOC
 813 */
 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
 831 /**
 832  * Writes a tile.
 833  * @param   p_j2k       the jpeg2000 codec.
 834  * @param p_tile_index FIXME DOC
 835  * @param p_data FIXME DOC
 836  * @param p_data_size FIXME DOC
 837  * @param   p_stream            the stream to write data to.
 838  * @param   p_manager   the user event manager.
 839  */
 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
 847 /**
 848  * Encodes an image into a JPEG-2000 codestream
 849  */
 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
 854 /**
 855  * Starts a compression scheme, i.e. validates the codec parameters, writes the header.
 856  *
 857  * @param   p_j2k       the jpeg2000 codec.
 858  * @param   p_stream            the stream object.
 859  * @param   p_image FIXME DOC
 860  * @param   p_manager   the user event manager.
 861  *
 862  * @return true if the codec is valid.
 863  */
 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
 869 /**
 870  * Ends the compression procedures and possibiliy add data to be read after the
 871  * codestream.
 872  */
 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 */