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_CBLKSTY_HT 0x40       /**< (high throughput) HT codeblocks */
  65 #define J2K_CCP_CBLKSTY_HTMIXED 0x80  /**< MIXED mode HT codeblocks */
  66 #define J2K_CCP_QNTSTY_NOQNT 0
  67 #define J2K_CCP_QNTSTY_SIQNT 1
  68 #define J2K_CCP_QNTSTY_SEQNT 2
  69
  70 /* ----------------------------------------------------------------------- */
  71
  72 #define J2K_MS_SOC 0xff4f   /**< SOC marker value */
  73 #define J2K_MS_SOT 0xff90   /**< SOT marker value */
  74 #define J2K_MS_SOD 0xff93   /**< SOD marker value */
  75 #define J2K_MS_EOC 0xffd9   /**< EOC marker value */
  76 #define J2K_MS_CAP 0xff50   /**< CAP marker value */
  77 #define J2K_MS_SIZ 0xff51   /**< SIZ marker value */
  78 #define J2K_MS_COD 0xff52   /**< COD marker value */
  79 #define J2K_MS_COC 0xff53   /**< COC marker value */
  80 #define J2K_MS_CPF 0xff59   /**< CPF marker value */
  81 #define J2K_MS_RGN 0xff5e   /**< RGN marker value */
  82 #define J2K_MS_QCD 0xff5c   /**< QCD marker value */
  83 #define J2K_MS_QCC 0xff5d   /**< QCC marker value */
  84 #define J2K_MS_POC 0xff5f   /**< POC marker value */
  85 #define J2K_MS_TLM 0xff55   /**< TLM marker value */
  86 #define J2K_MS_PLM 0xff57   /**< PLM marker value */
  87 #define J2K_MS_PLT 0xff58   /**< PLT marker value */
  88 #define J2K_MS_PPM 0xff60   /**< PPM marker value */
  89 #define J2K_MS_PPT 0xff61   /**< PPT marker value */
  90 #define J2K_MS_SOP 0xff91   /**< SOP marker value */
  91 #define J2K_MS_EPH 0xff92   /**< EPH marker value */
  92 #define J2K_MS_CRG 0xff63   /**< CRG marker value */
  93 #define J2K_MS_COM 0xff64   /**< COM marker value */
  94 #define J2K_MS_CBD 0xff78   /**< CBD marker value */
  95 #define J2K_MS_MCC 0xff75   /**< MCC marker value */
  96 #define J2K_MS_MCT 0xff74   /**< MCT marker value */
  97 #define J2K_MS_MCO 0xff77   /**< MCO marker value */
  98
  99 #define J2K_MS_UNK 0        /**< UNKNOWN marker value */
 100
 101 /* UniPG>> */
 102 #ifdef USE_JPWL
 103 #define J2K_MS_EPC 0xff68   /**< EPC marker value (Part 11: JPEG 2000 for Wireless) */
 104 #define J2K_MS_EPB 0xff66   /**< EPB marker value (Part 11: JPEG 2000 for Wireless) */
 105 #define J2K_MS_ESD 0xff67   /**< ESD marker value (Part 11: JPEG 2000 for Wireless) */
 106 #define J2K_MS_RED 0xff69   /**< RED marker value (Part 11: JPEG 2000 for Wireless) */
 107 #endif /* USE_JPWL */
 108 #ifdef USE_JPSEC
 109 #define J2K_MS_SEC 0xff65    /**< SEC marker value (Part 8: Secure JPEG 2000) */
 110 #define J2K_MS_INSEC 0xff94  /**< INSEC marker value (Part 8: Secure JPEG 2000) */
 111 #endif /* USE_JPSEC */
 112 /* <<UniPG */
 113
 114 #define J2K_MAX_POCS    32      /**< Maximum number of POCs */
 115
 116 #define J2K_TCD_MATRIX_MAX_LAYER_COUNT 10
 117 #define J2K_TCD_MATRIX_MAX_RESOLUTION_COUNT 10
 118
 119 /* ----------------------------------------------------------------------- */
 120
 121 /**
 122  * Values that specify the status of the decoding process when decoding the main header.
 123  * These values may be combined with a | operator.
 124  * */
 125 typedef enum J2K_STATUS {
 126     J2K_STATE_NONE  =  0x0000, /**< a SOC marker is expected */
 127     J2K_STATE_MHSOC  = 0x0001, /**< a SOC marker is expected */
 128     J2K_STATE_MHSIZ  = 0x0002, /**< a SIZ marker is expected */
 129     J2K_STATE_MH     = 0x0004, /**< the decoding process is in the main header */
 130     J2K_STATE_TPHSOT = 0x0008, /**< the decoding process is in a tile part header and expects a SOT marker */
 131     J2K_STATE_TPH    = 0x0010, /**< the decoding process is in a tile part header */
 132     J2K_STATE_MT     = 0x0020, /**< the EOC marker has just been read */
 133     J2K_STATE_NEOC   = 0x0040, /**< the decoding process must not expect a EOC marker because the codestream is truncated */
 134     J2K_STATE_DATA   = 0x0080, /**< a tile header has been successfully read and codestream is expected */
 135
 136     J2K_STATE_EOC    = 0x0100, /**< the decoding process has encountered the EOC marker */
 137     J2K_STATE_ERR    = 0x8000  /**< the decoding process has encountered an error (FIXME warning V1 = 0x0080)*/
 138 } J2K_STATUS;
 139
 140 /**
 141  * Type of elements storing in the MCT data
 142  */
 143 typedef enum MCT_ELEMENT_TYPE {
 144     MCT_TYPE_INT16 = 0,     /** MCT data is stored as signed shorts*/
 145     MCT_TYPE_INT32 = 1,     /** MCT data is stored as signed integers*/
 146     MCT_TYPE_FLOAT = 2,     /** MCT data is stored as floats*/
 147     MCT_TYPE_DOUBLE = 3     /** MCT data is stored as doubles*/
 148 } J2K_MCT_ELEMENT_TYPE;
 149
 150 /**
 151  * Type of MCT array
 152  */
 153 typedef enum MCT_ARRAY_TYPE {
 154     MCT_TYPE_DEPENDENCY = 0,
 155     MCT_TYPE_DECORRELATION = 1,
 156     MCT_TYPE_OFFSET = 2
 157 } J2K_MCT_ARRAY_TYPE;
 158
 159 /* ----------------------------------------------------------------------- */
 160
 161 /**
 162 T2 encoding mode
 163 */
 164 typedef enum T2_MODE {
 165     THRESH_CALC = 0,    /** Function called in Rate allocation process*/
 166     FINAL_PASS = 1      /** Function called in Tier 2 process*/
 167 } J2K_T2_MODE;
 168
 169 /**
 170  * Quantization stepsize
 171  */
 172 typedef struct opj_stepsize {
 173     /** exponent */
 174     OPJ_INT32 expn;
 175     /** mantissa */
 176     OPJ_INT32 mant;
 177 } opj_stepsize_t;
 178
 179 /**
 180 Tile-component coding parameters
 181 */
 182 typedef struct opj_tccp {
 183     /** coding style */
 184     OPJ_UINT32 csty;
 185     /** number of resolutions */
 186     OPJ_UINT32 numresolutions;
 187     /** code-blocks width */
 188     OPJ_UINT32 cblkw;
 189     /** code-blocks height */
 190     OPJ_UINT32 cblkh;
 191     /** code-block coding style */
 192     OPJ_UINT32 cblksty;
 193     /** discrete wavelet transform identifier */
 194     OPJ_UINT32 qmfbid;
 195     /** quantisation style */
 196     OPJ_UINT32 qntsty;
 197     /** stepsizes used for quantization */
 198     opj_stepsize_t stepsizes[OPJ_J2K_MAXBANDS];
 199     /** number of guard bits */
 200     OPJ_UINT32 numgbits;
 201     /** Region Of Interest shift */
 202     OPJ_INT32 roishift;
 203     /** precinct width */
 204     OPJ_UINT32 prcw[OPJ_J2K_MAXRLVLS];
 205     /** precinct height */
 206     OPJ_UINT32 prch[OPJ_J2K_MAXRLVLS];
 207     /** the dc_level_shift **/
 208     OPJ_INT32 m_dc_level_shift;
 209 }
 210 opj_tccp_t;
 211
 212
 213
 214 /**
 215  * FIXME DOC
 216  */
 217 typedef struct opj_mct_data {
 218     J2K_MCT_ELEMENT_TYPE m_element_type;
 219     J2K_MCT_ARRAY_TYPE   m_array_type;
 220     OPJ_UINT32           m_index;
 221     OPJ_BYTE *           m_data;
 222     OPJ_UINT32           m_data_size;
 223 }
 224 opj_mct_data_t;
 225
 226 /**
 227  * FIXME DOC
 228  */
 229 typedef struct opj_simple_mcc_decorrelation_data {
 230     OPJ_UINT32           m_index;
 231     OPJ_UINT32           m_nb_comps;
 232     opj_mct_data_t *     m_decorrelation_array;
 233     opj_mct_data_t *     m_offset_array;
 234     OPJ_BITFIELD         m_is_irreversible : 1;
 235 }
 236 opj_simple_mcc_decorrelation_data_t;
 237
 238 typedef struct opj_ppx_struct {
 239     OPJ_BYTE*   m_data; /* m_data == NULL => Zppx not read yet */
 240     OPJ_UINT32  m_data_size;
 241 } opj_ppx;
 242
 243 /**
 244 Tile coding parameters :
 245 this structure is used to store coding/decoding parameters common to all
 246 tiles (information like COD, COC in main header)
 247 */
 248 typedef struct opj_tcp {
 249     /** coding style */
 250     OPJ_UINT32 csty;
 251     /** progression order */
 252     OPJ_PROG_ORDER prg;
 253     /** number of layers */
 254     OPJ_UINT32 numlayers;
 255     OPJ_UINT32 num_layers_to_decode;
 256     /** multi-component transform identifier */
 257     OPJ_UINT32 mct;
 258     /** rates of layers */
 259     OPJ_FLOAT32 rates[100];
 260     /** number of progression order changes */
 261     OPJ_UINT32 numpocs;
 262     /** progression order changes */
 263     opj_poc_t pocs[J2K_MAX_POCS];
 264
 265     /** number of ppt markers (reserved size) */
 266     OPJ_UINT32 ppt_markers_count;
 267     /** ppt markers data (table indexed by Zppt) */
 268     opj_ppx* ppt_markers;
 269
 270     /** packet header store there for future use in t2_decode_packet */
 271     OPJ_BYTE *ppt_data;
 272     /** used to keep a track of the allocated memory */
 273     OPJ_BYTE *ppt_buffer;
 274     /** Number of bytes stored inside ppt_data*/
 275     OPJ_UINT32 ppt_data_size;
 276     /** size of ppt_data*/
 277     OPJ_UINT32 ppt_len;
 278     /** PSNR values */
 279     OPJ_FLOAT32 distoratio[100];
 280     /** tile-component coding parameters */
 281     opj_tccp_t *tccps;
 282     /** current tile part number or -1 if first time into this tile */
 283     OPJ_INT32  m_current_tile_part_number;
 284     /** number of tile parts for the tile. */
 285     OPJ_UINT32 m_nb_tile_parts;
 286     /** data for the tile */
 287     OPJ_BYTE *      m_data;
 288     /** size of data */
 289     OPJ_UINT32      m_data_size;
 290     /** encoding norms */
 291     OPJ_FLOAT64 *   mct_norms;
 292     /** the mct decoding matrix */
 293     OPJ_FLOAT32 *   m_mct_decoding_matrix;
 294     /** the mct coding matrix */
 295     OPJ_FLOAT32 *   m_mct_coding_matrix;
 296     /** mct records */
 297     opj_mct_data_t * m_mct_records;
 298     /** the number of mct records. */
 299     OPJ_UINT32 m_nb_mct_records;
 300     /** the max number of mct records. */
 301     OPJ_UINT32 m_nb_max_mct_records;
 302     /** mcc records */
 303     opj_simple_mcc_decorrelation_data_t * m_mcc_records;
 304     /** the number of mct records. */
 305     OPJ_UINT32 m_nb_mcc_records;
 306     /** the max number of mct records. */
 307     OPJ_UINT32 m_nb_max_mcc_records;
 308
 309
 310     /***** FLAGS *******/
 311     /** If cod == 1 --> there was a COD marker for the present tile */
 312     OPJ_BITFIELD cod : 1;
 313     /** If ppt == 1 --> there was a PPT marker for the present tile */
 314     OPJ_BITFIELD ppt : 1;
 315     /** indicates if a POC marker has been used O:NO, 1:YES */
 316     OPJ_BITFIELD POC : 1;
 317 } opj_tcp_t;
 318
 319
 320 /**
 321 Rate allocation strategy
 322 */
 323 typedef enum {
 324     RATE_DISTORTION_RATIO = 0,    /** allocation by rate/distortion */
 325     FIXED_DISTORTION_RATIO = 1,   /** allocation by fixed distortion ratio (PSNR) (fixed quality) */
 326     FIXED_LAYER = 2,              /** allocation by fixed layer (number of passes per layer / resolution / subband) */
 327 } J2K_QUALITY_LAYER_ALLOCATION_STRATEGY;
 328
 329
 330 typedef struct opj_encoding_param {
 331     /** Maximum rate for each component. If == 0, component size limitation is not considered */
 332     OPJ_UINT32 m_max_comp_size;
 333     /** Position of tile part flag in progression order*/
 334     OPJ_INT32 m_tp_pos;
 335     /** fixed layer */
 336     OPJ_INT32 *m_matrice;
 337     /** Flag determining tile part generation*/
 338     OPJ_BYTE m_tp_flag;
 339     /** Quality layer allocation strategy */
 340     J2K_QUALITY_LAYER_ALLOCATION_STRATEGY m_quality_layer_alloc_strategy;
 341     /** Enabling Tile part generation*/
 342     OPJ_BITFIELD m_tp_on : 1;
 343 }
 344 opj_encoding_param_t;
 345
 346 typedef struct opj_decoding_param {
 347     /** if != 0, then original dimension divided by 2^(reduce); if == 0 or not used, image is decoded to the full resolution */
 348     OPJ_UINT32 m_reduce;
 349     /** if != 0, then only the first "layer" layers are decoded; if == 0 or not used, all the quality layers are decoded */
 350     OPJ_UINT32 m_layer;
 351 }
 352 opj_decoding_param_t;
 353
 354
 355 /**
 356  * Coding parameters
 357  */
 358 typedef struct opj_cp {
 359     /** Size of the image in bits*/
 360     /*int img_size;*/
 361     /** Rsiz*/
 362     OPJ_UINT16 rsiz;
 363     /** XTOsiz */
 364     OPJ_UINT32 tx0; /* MSD see norm */
 365     /** YTOsiz */
 366     OPJ_UINT32 ty0; /* MSD see norm */
 367     /** XTsiz */
 368     OPJ_UINT32 tdx;
 369     /** YTsiz */
 370     OPJ_UINT32 tdy;
 371     /** comment */
 372     OPJ_CHAR *comment;
 373     /** number of tiles in width */
 374     OPJ_UINT32 tw;
 375     /** number of tiles in height */
 376     OPJ_UINT32 th;
 377
 378     /** number of ppm markers (reserved size) */
 379     OPJ_UINT32 ppm_markers_count;
 380     /** ppm markers data (table indexed by Zppm) */
 381     opj_ppx* ppm_markers;
 382
 383     /** packet header store there for future use in t2_decode_packet */
 384     OPJ_BYTE *ppm_data;
 385     /** size of the ppm_data*/
 386     OPJ_UINT32 ppm_len;
 387     /** size of the ppm_data*/
 388     OPJ_UINT32 ppm_data_read;
 389
 390     OPJ_BYTE *ppm_data_current;
 391
 392     /** packet header storage original buffer */
 393     OPJ_BYTE *ppm_buffer;
 394     /** pointer remaining on the first byte of the first header if ppm is used */
 395     OPJ_BYTE *ppm_data_first;
 396     /** Number of bytes actually stored inside the ppm_data */
 397     OPJ_UINT32 ppm_data_size;
 398     /** use in case of multiple marker PPM (number of info already store) */
 399     OPJ_INT32 ppm_store;
 400     /** use in case of multiple marker PPM (case on non-finished previous info) */
 401     OPJ_INT32 ppm_previous;
 402
 403     /** tile coding parameters */
 404     opj_tcp_t *tcps;
 405
 406     union {
 407         opj_decoding_param_t m_dec;
 408         opj_encoding_param_t m_enc;
 409     }
 410     m_specific_param;
 411
 412     /** OPJ_TRUE if entire bit stream must be decoded, OPJ_FALSE if partial bitstream decoding allowed */
 413     OPJ_BOOL strict;
 414
 415     /* UniPG>> */
 416 #ifdef USE_JPWL
 417     /** enables writing of EPC in MH, thus activating JPWL */
 418     OPJ_BOOL epc_on;
 419     /** enables writing of EPB, in case of activated JPWL */
 420     OPJ_BOOL epb_on;
 421     /** enables writing of ESD, in case of activated JPWL */
 422     OPJ_BOOL esd_on;
 423     /** enables writing of informative techniques of ESD, in case of activated JPWL */
 424     OPJ_BOOL info_on;
 425     /** enables writing of RED, in case of activated JPWL */
 426     OPJ_BOOL red_on;
 427     /** error protection method for MH (0,1,16,32,37-128) */
 428     int hprot_MH;
 429     /** tile number of header protection specification (>=0) */
 430     int hprot_TPH_tileno[JPWL_MAX_NO_TILESPECS];
 431     /** error protection methods for TPHs (0,1,16,32,37-128) */
 432     int hprot_TPH[JPWL_MAX_NO_TILESPECS];
 433     /** tile number of packet protection specification (>=0) */
 434     int pprot_tileno[JPWL_MAX_NO_PACKSPECS];
 435     /** packet number of packet protection specification (>=0) */
 436     int pprot_packno[JPWL_MAX_NO_PACKSPECS];
 437     /** error protection methods for packets (0,1,16,32,37-128) */
 438     int pprot[JPWL_MAX_NO_PACKSPECS];
 439     /** enables writing of ESD, (0/2/4 bytes) */
 440     int sens_size;
 441     /** sensitivity addressing size (0=auto/2/4 bytes) */
 442     int sens_addr;
 443     /** sensitivity range (0-3) */
 444     int sens_range;
 445     /** sensitivity method for MH (-1,0-7) */
 446     int sens_MH;
 447     /** tile number of sensitivity specification (>=0) */
 448     int sens_TPH_tileno[JPWL_MAX_NO_TILESPECS];
 449     /** sensitivity methods for TPHs (-1,0-7) */
 450     int sens_TPH[JPWL_MAX_NO_TILESPECS];
 451     /** enables JPWL correction at the decoder */
 452     OPJ_BOOL correct;
 453     /** expected number of components at the decoder */
 454     int exp_comps;
 455     /** maximum number of tiles at the decoder */
 456     OPJ_UINT32 max_tiles;
 457 #endif /* USE_JPWL */
 458
 459     /******** FLAGS *********/
 460     /** if ppm == 1 --> there was a PPM marker*/
 461     OPJ_BITFIELD ppm : 1;
 462     /** tells if the parameter is a coding or decoding one */
 463     OPJ_BITFIELD m_is_decoder : 1;
 464     /** whether different bit depth or sign per component is allowed. Decoder only for ow */
 465     OPJ_BITFIELD allow_different_bit_depth_sign : 1;
 466     /* <<UniPG */
 467 } opj_cp_t;
 468
 469
 470 typedef struct opj_j2k_dec {
 471     /** locate in which part of the codestream the decoder is (main header, tile header, end) */
 472     OPJ_UINT32 m_state;
 473     /**
 474      * store decoding parameters common to all tiles (information like COD, COC in main header)
 475      */
 476     opj_tcp_t *m_default_tcp;
 477     OPJ_BYTE  *m_header_data;
 478     OPJ_UINT32 m_header_data_size;
 479     /** to tell the tile part length */
 480     OPJ_UINT32 m_sot_length;
 481     /** Only tiles index in the correct range will be decoded.*/
 482     OPJ_UINT32 m_start_tile_x;
 483     OPJ_UINT32 m_start_tile_y;
 484     OPJ_UINT32 m_end_tile_x;
 485     OPJ_UINT32 m_end_tile_y;
 486
 487     /** Index of the tile to decode (used in get_tile) */
 488     OPJ_INT32 m_tile_ind_to_dec;
 489     /** Position of the last SOT marker read */
 490     OPJ_OFF_T m_last_sot_read_pos;
 491
 492     /**
 493      * Indicate that the current tile-part is assume as the last tile part of the codestream.
 494      * It is useful in the case of PSot is equal to zero. The sot length will be compute in the
 495      * SOD reader function. FIXME NOT USED for the moment
 496      */
 497     OPJ_BOOL   m_last_tile_part;
 498
 499     OPJ_UINT32   m_numcomps_to_decode;
 500     OPJ_UINT32  *m_comps_indices_to_decode;
 501
 502     /** to tell that a tile can be decoded. */
 503     OPJ_BITFIELD m_can_decode : 1;
 504     OPJ_BITFIELD m_discard_tiles : 1;
 505     OPJ_BITFIELD m_skip_data : 1;
 506     /** TNsot correction : see issue 254 **/
 507     OPJ_BITFIELD m_nb_tile_parts_correction_checked : 1;
 508     OPJ_BITFIELD m_nb_tile_parts_correction : 1;
 509
 510 } opj_j2k_dec_t;
 511
 512 typedef struct opj_j2k_enc {
 513     /** Tile part number, regardless of poc, for each new poc, tp is reset to 1*/
 514     OPJ_UINT32 m_current_poc_tile_part_number; /* tp_num */
 515
 516     /** 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.*/
 517     OPJ_UINT32 m_current_tile_part_number; /*cur_tp_num */
 518
 519     /* whether to generate TLM markers */
 520     OPJ_BOOL   m_TLM;
 521
 522     /* whether the Ttlmi field in a TLM marker is a byte (otherwise a uint16) */
 523     OPJ_BOOL   m_Ttlmi_is_byte;
 524
 525     /**
 526     locate the start position of the TLM marker
 527     after encoding the tilepart, a jump (in j2k_write_sod) is done to the TLM marker to store the value of its length.
 528     */
 529     OPJ_OFF_T m_tlm_start;
 530     /**
 531      * Stores the sizes of the tlm.
 532      */
 533     OPJ_BYTE * m_tlm_sot_offsets_buffer;
 534     /**
 535      * The current offset of the tlm buffer.
 536      */
 537     OPJ_BYTE * m_tlm_sot_offsets_current;
 538
 539     /** Total num of tile parts in whole image = num tiles* num tileparts in each tile*/
 540     /** used in TLMmarker*/
 541     OPJ_UINT32 m_total_tile_parts;   /* totnum_tp */
 542
 543     /* encoded data for a tile */
 544     OPJ_BYTE * m_encoded_tile_data;
 545
 546     /* size of the encoded_data */
 547     OPJ_UINT32 m_encoded_tile_size;
 548
 549     /* encoded data for a tile */
 550     OPJ_BYTE * m_header_tile_data;
 551
 552     /* size of the encoded_data */
 553
 554     OPJ_UINT32 m_header_tile_data_size;
 555
 556     /* whether to generate PLT markers */
 557     OPJ_BOOL   m_PLT;
 558
 559     /* reserved bytes in m_encoded_tile_size for PLT markers */
 560     OPJ_UINT32 m_reserved_bytes_for_PLT;
 561
 562     /** Number of components */
 563     OPJ_UINT32 m_nb_comps;
 564
 565 } opj_j2k_enc_t;
 566
 567
 568
 569 struct opj_tcd;
 570 /**
 571 JPEG-2000 codestream reader/writer
 572 */
 573 typedef struct opj_j2k {
 574     /* J2K codestream is decoded*/
 575     OPJ_BOOL m_is_decoder;
 576
 577     /* FIXME DOC*/
 578     union {
 579         opj_j2k_dec_t m_decoder;
 580         opj_j2k_enc_t m_encoder;
 581     }
 582     m_specific_param;
 583
 584     /** pointer to the internal/private encoded / decoded image */
 585     opj_image_t* m_private_image;
 586
 587     /* pointer to the output image (decoded)*/
 588     opj_image_t* m_output_image;
 589
 590     /** Coding parameters */
 591     opj_cp_t m_cp;
 592
 593     /** the list of procedures to exec **/
 594     opj_procedure_list_t *  m_procedure_list;
 595
 596     /** the list of validation procedures to follow to make sure the code is valid **/
 597     opj_procedure_list_t *  m_validation_list;
 598
 599     /** helper used to write the index file */
 600     opj_codestream_index_t *cstr_index;
 601
 602     /** number of the tile currently concern by coding/decoding */
 603     OPJ_UINT32 m_current_tile_number;
 604
 605     /** the current tile coder/decoder **/
 606     struct opj_tcd *    m_tcd;
 607
 608     /** Thread pool */
 609     opj_thread_pool_t* m_tp;
 610
 611     /** Image width coming from JP2 IHDR box. 0 from a pure codestream */
 612     OPJ_UINT32 ihdr_w;
 613
 614     /** Image height coming from JP2 IHDR box. 0 from a pure codestream */
 615     OPJ_UINT32 ihdr_h;
 616
 617     /** Set to 1 by the decoder initialization if OPJ_DPARAMETERS_DUMP_FLAG is set */
 618     unsigned int dump_state;
 619 }
 620 opj_j2k_t;
 621
 622
 623
 624
 625 /** @name Exported functions */
 626 /*@{*/
 627 /* ----------------------------------------------------------------------- */
 628
 629 /**
 630 Setup the decoder decoding parameters using user parameters.
 631 Decoding parameters are returned in j2k->cp.
 632 @param j2k J2K decompressor handle
 633 @param parameters decompression parameters
 634 */
 635 void opj_j2k_setup_decoder(opj_j2k_t *j2k, opj_dparameters_t *parameters);
 636
 637 void opj_j2k_decoder_set_strict_mode(opj_j2k_t *j2k, OPJ_BOOL strict);
 638
 639 OPJ_BOOL opj_j2k_set_threads(opj_j2k_t *j2k, OPJ_UINT32 num_threads);
 640
 641 /**
 642  * Creates a J2K compression structure
 643  *
 644  * @return Returns a handle to a J2K compressor if successful, returns NULL otherwise
 645 */
 646 opj_j2k_t* opj_j2k_create_compress(void);
 647
 648
 649 OPJ_BOOL opj_j2k_setup_encoder(opj_j2k_t *p_j2k,
 650                                opj_cparameters_t *parameters,
 651                                opj_image_t *image,
 652                                opj_event_mgr_t * p_manager);
 653
 654 /**
 655 Converts an enum type progression order to string type
 656 */
 657 const char *opj_j2k_convert_progression_order(OPJ_PROG_ORDER prg_order);
 658
 659 /* ----------------------------------------------------------------------- */
 660 /*@}*/
 661
 662 /*@}*/
 663
 664 /**
 665  * Ends the decompression procedures and possibiliy add data to be read after the
 666  * codestream.
 667  */
 668 OPJ_BOOL opj_j2k_end_decompress(opj_j2k_t *j2k,
 669                                 opj_stream_private_t *p_stream,
 670                                 opj_event_mgr_t * p_manager);
 671
 672 /**
 673  * Reads a jpeg2000 codestream header structure.
 674  *
 675  * @param p_stream the stream to read data from.
 676  * @param p_j2k the jpeg2000 codec.
 677  * @param p_image FIXME DOC
 678  * @param p_manager the user event manager.
 679  *
 680  * @return true if the box is valid.
 681  */
 682 OPJ_BOOL opj_j2k_read_header(opj_stream_private_t *p_stream,
 683                              opj_j2k_t* p_j2k,
 684                              opj_image_t** p_image,
 685                              opj_event_mgr_t* p_manager);
 686
 687
 688 /**
 689  * Destroys a jpeg2000 codec.
 690  *
 691  * @param   p_j2k   the jpeg20000 structure to destroy.
 692  */
 693 void opj_j2k_destroy(opj_j2k_t *p_j2k);
 694
 695 /**
 696  * Destroys a codestream index structure.
 697  *
 698  * @param   p_cstr_ind  the codestream index parameter to destroy.
 699  */
 700 void j2k_destroy_cstr_index(opj_codestream_index_t *p_cstr_ind);
 701
 702 /**
 703  * Decode tile data.
 704  * @param   p_j2k       the jpeg2000 codec.
 705  * @param   p_tile_index
 706  * @param p_data       FIXME DOC
 707  * @param p_data_size  FIXME DOC
 708  * @param   p_stream            the stream to write data to.
 709  * @param   p_manager   the user event manager.
 710  */
 711 OPJ_BOOL opj_j2k_decode_tile(opj_j2k_t * p_j2k,
 712                              OPJ_UINT32 p_tile_index,
 713                              OPJ_BYTE * p_data,
 714                              OPJ_UINT32 p_data_size,
 715                              opj_stream_private_t *p_stream,
 716                              opj_event_mgr_t * p_manager);
 717
 718 /**
 719  * Reads a tile header.
 720  * @param   p_j2k       the jpeg2000 codec.
 721  * @param   p_tile_index FIXME DOC
 722  * @param   p_data_size FIXME DOC
 723  * @param   p_tile_x0 FIXME DOC
 724  * @param   p_tile_y0 FIXME DOC
 725  * @param   p_tile_x1 FIXME DOC
 726  * @param   p_tile_y1 FIXME DOC
 727  * @param   p_nb_comps FIXME DOC
 728  * @param   p_go_on FIXME DOC
 729  * @param   p_stream            the stream to write data to.
 730  * @param   p_manager   the user event manager.
 731  */
 732 OPJ_BOOL opj_j2k_read_tile_header(opj_j2k_t * p_j2k,
 733                                   OPJ_UINT32 * p_tile_index,
 734                                   OPJ_UINT32 * p_data_size,
 735                                   OPJ_INT32 * p_tile_x0,
 736                                   OPJ_INT32 * p_tile_y0,
 737                                   OPJ_INT32 * p_tile_x1,
 738                                   OPJ_INT32 * p_tile_y1,
 739                                   OPJ_UINT32 * p_nb_comps,
 740                                   OPJ_BOOL * p_go_on,
 741                                   opj_stream_private_t *p_stream,
 742                                   opj_event_mgr_t * p_manager);
 743
 744
 745 /** Sets the indices of the components to decode.
 746  *
 747  * @param p_j2k         the jpeg2000 codec.
 748  * @param numcomps      Number of components to decode.
 749  * @param comps_indices Array of num_compts indices (numbering starting at 0)
 750  *                      corresponding to the components to decode.
 751  * @param p_manager     Event manager
 752  *
 753  * @return OPJ_TRUE in case of success.
 754  */
 755 OPJ_BOOL opj_j2k_set_decoded_components(opj_j2k_t *p_j2k,
 756                                         OPJ_UINT32 numcomps,
 757                                         const OPJ_UINT32* comps_indices,
 758                                         opj_event_mgr_t * p_manager);
 759
 760 /**
 761  * Sets the given area to be decoded. This function should be called right after opj_read_header and before any tile header reading.
 762  *
 763  * @param   p_j2k           the jpeg2000 codec.
 764  * @param   p_image     FIXME DOC
 765  * @param   p_start_x       the left position of the rectangle to decode (in image coordinates).
 766  * @param   p_start_y       the up position of the rectangle to decode (in image coordinates).
 767  * @param   p_end_x         the right position of the rectangle to decode (in image coordinates).
 768  * @param   p_end_y         the bottom position of the rectangle to decode (in image coordinates).
 769  * @param   p_manager       the user event manager
 770  *
 771  * @return  true            if the area could be set.
 772  */
 773 OPJ_BOOL opj_j2k_set_decode_area(opj_j2k_t *p_j2k,
 774                                  opj_image_t* p_image,
 775                                  OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,
 776                                  OPJ_INT32 p_end_x, OPJ_INT32 p_end_y,
 777                                  opj_event_mgr_t * p_manager);
 778
 779 /**
 780  * Creates a J2K decompression structure.
 781  *
 782  * @return a handle to a J2K decompressor if successful, NULL otherwise.
 783  */
 784 opj_j2k_t* opj_j2k_create_decompress(void);
 785
 786
 787 /**
 788  * Dump some elements from the J2K decompression structure .
 789  *
 790  *@param p_j2k              the jpeg2000 codec.
 791  *@param flag               flag to describe what elements are dump.
 792  *@param out_stream         output stream where dump the elements.
 793  *
 794 */
 795 void j2k_dump(opj_j2k_t* p_j2k, OPJ_INT32 flag, FILE* out_stream);
 796
 797
 798
 799 /**
 800  * Dump an image header structure.
 801  *
 802  *@param image          the image header to dump.
 803  *@param dev_dump_flag      flag to describe if we are in the case of this function is use outside j2k_dump function
 804  *@param out_stream         output stream where dump the elements.
 805  */
 806 void j2k_dump_image_header(opj_image_t* image, OPJ_BOOL dev_dump_flag,
 807                            FILE* out_stream);
 808
 809 /**
 810  * Dump a component image header structure.
 811  *
 812  *@param comp       the component image header to dump.
 813  *@param dev_dump_flag      flag to describe if we are in the case of this function is use outside j2k_dump function
 814  *@param out_stream         output stream where dump the elements.
 815  */
 816 void j2k_dump_image_comp_header(opj_image_comp_t* comp, OPJ_BOOL dev_dump_flag,
 817                                 FILE* out_stream);
 818
 819 /**
 820  * Get the codestream info from a JPEG2000 codec.
 821  *
 822  *@param    p_j2k               the component image header to dump.
 823  *
 824  *@return   the codestream information extract from the jpg2000 codec
 825  */
 826 opj_codestream_info_v2_t* j2k_get_cstr_info(opj_j2k_t* p_j2k);
 827
 828 /**
 829  * Get the codestream index from a JPEG2000 codec.
 830  *
 831  *@param    p_j2k               the component image header to dump.
 832  *
 833  *@return   the codestream index extract from the jpg2000 codec
 834  */
 835 opj_codestream_index_t* j2k_get_cstr_index(opj_j2k_t* p_j2k);
 836
 837 /**
 838  * Decode an image from a JPEG-2000 codestream
 839  * @param j2k J2K decompressor handle
 840  * @param p_stream  FIXME DOC
 841  * @param p_image   FIXME DOC
 842  * @param p_manager FIXME DOC
 843  * @return FIXME DOC
 844 */
 845 OPJ_BOOL opj_j2k_decode(opj_j2k_t *j2k,
 846                         opj_stream_private_t *p_stream,
 847                         opj_image_t *p_image,
 848                         opj_event_mgr_t *p_manager);
 849
 850
 851 OPJ_BOOL opj_j2k_get_tile(opj_j2k_t *p_j2k,
 852                           opj_stream_private_t *p_stream,
 853                           opj_image_t* p_image,
 854                           opj_event_mgr_t * p_manager,
 855                           OPJ_UINT32 tile_index);
 856
 857 OPJ_BOOL opj_j2k_set_decoded_resolution_factor(opj_j2k_t *p_j2k,
 858         OPJ_UINT32 res_factor,
 859         opj_event_mgr_t * p_manager);
 860
 861 /**
 862  * Specify extra options for the encoder.
 863  *
 864  * @param  p_j2k        the jpeg2000 codec.
 865  * @param  p_options    options
 866  * @param  p_manager    the user event manager
 867  *
 868  * @see opj_encoder_set_extra_options() for more details.
 869  */
 870 OPJ_BOOL opj_j2k_encoder_set_extra_options(
 871     opj_j2k_t *p_j2k,
 872     const char* const* p_options,
 873     opj_event_mgr_t * p_manager);
 874
 875 /**
 876  * Writes a tile.
 877  * @param   p_j2k       the jpeg2000 codec.
 878  * @param p_tile_index FIXME DOC
 879  * @param p_data FIXME DOC
 880  * @param p_data_size FIXME DOC
 881  * @param   p_stream            the stream to write data to.
 882  * @param   p_manager   the user event manager.
 883  */
 884 OPJ_BOOL opj_j2k_write_tile(opj_j2k_t * p_j2k,
 885                             OPJ_UINT32 p_tile_index,
 886                             OPJ_BYTE * p_data,
 887                             OPJ_UINT32 p_data_size,
 888                             opj_stream_private_t *p_stream,
 889                             opj_event_mgr_t * p_manager);
 890
 891 /**
 892  * Encodes an image into a JPEG-2000 codestream
 893  */
 894 OPJ_BOOL opj_j2k_encode(opj_j2k_t * p_j2k,
 895                         opj_stream_private_t *cio,
 896                         opj_event_mgr_t * p_manager);
 897
 898 /**
 899  * Starts a compression scheme, i.e. validates the codec parameters, writes the header.
 900  *
 901  * @param   p_j2k       the jpeg2000 codec.
 902  * @param   p_stream            the stream object.
 903  * @param   p_image FIXME DOC
 904  * @param   p_manager   the user event manager.
 905  *
 906  * @return true if the codec is valid.
 907  */
 908 OPJ_BOOL opj_j2k_start_compress(opj_j2k_t *p_j2k,
 909                                 opj_stream_private_t *p_stream,
 910                                 opj_image_t * p_image,
 911                                 opj_event_mgr_t * p_manager);
 912
 913 /**
 914  * Ends the compression procedures and possibiliy add data to be read after the
 915  * codestream.
 916  */
 917 OPJ_BOOL opj_j2k_end_compress(opj_j2k_t *p_j2k,
 918                               opj_stream_private_t *cio,
 919                               opj_event_mgr_t * p_manager);
 920
 921 OPJ_BOOL opj_j2k_setup_mct_encoding(opj_tcp_t * p_tcp, opj_image_t * p_image);
 922
 923
 924 #endif /* OPJ_J2K_H */