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 __J2K_H
  43 #define __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 #define OPJ_J2K_DEFAULT_CBLK_DATA_SIZE 8192
  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_SIZ 0xff51       /**< SIZ marker value */
  77 #define J2K_MS_COD 0xff52       /**< COD marker value */
  78 #define J2K_MS_COC 0xff53       /**< COC marker value */
  79 #define J2K_MS_RGN 0xff5e       /**< RGN marker value */
  80 #define J2K_MS_QCD 0xff5c       /**< QCD marker value */
  81 #define J2K_MS_QCC 0xff5d       /**< QCC marker value */
  82 #define J2K_MS_POC 0xff5f       /**< POC marker value */
  83 #define J2K_MS_TLM 0xff55       /**< TLM marker value */
  84 #define J2K_MS_PLM 0xff57       /**< PLM marker value */
  85 #define J2K_MS_PLT 0xff58       /**< PLT marker value */
  86 #define J2K_MS_PPM 0xff60       /**< PPM marker value */
  87 #define J2K_MS_PPT 0xff61       /**< PPT marker value */
  88 #define J2K_MS_SOP 0xff91       /**< SOP marker value */
  89 #define J2K_MS_EPH 0xff92       /**< EPH marker value */
  90 #define J2K_MS_CRG 0xff63       /**< CRG marker value */
  91 #define J2K_MS_COM 0xff64       /**< COM marker value */
  92 #define J2K_MS_CBD 0xff78       /**< CBD marker value */
  93 #define J2K_MS_MCC 0xff75       /**< MCC marker value */
  94 #define J2K_MS_MCT 0xff74       /**< MCT marker value */
  95 #define J2K_MS_MCO 0xff77       /**< MCO marker value */
  96
  97 #define J2K_MS_UNK 0            /**< UNKNOWN marker value */
  98
  99 /* UniPG>> */
 100 #ifdef USE_JPWL
 101 #define J2K_MS_EPC 0xff68       /**< EPC marker value (Part 11: JPEG 2000 for Wireless) */
 102 #define J2K_MS_EPB 0xff66       /**< EPB marker value (Part 11: JPEG 2000 for Wireless) */
 103 #define J2K_MS_ESD 0xff67       /**< ESD marker value (Part 11: JPEG 2000 for Wireless) */
 104 #define J2K_MS_RED 0xff69       /**< RED marker value (Part 11: JPEG 2000 for Wireless) */
 105 #endif /* USE_JPWL */
 106 #ifdef USE_JPSEC
 107 #define J2K_MS_SEC 0xff65    /**< SEC marker value (Part 8: Secure JPEG 2000) */
 108 #define J2K_MS_INSEC 0xff94  /**< INSEC marker value (Part 8: Secure JPEG 2000) */
 109 #endif /* USE_JPSEC */
 110 /* <<UniPG */
 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
 128         J2K_STATE_EOC    = 0x0100, /**< the decoding process has encountered the EOC marker */
 129         J2K_STATE_ERR    = 0x8000  /**< the decoding process has encountered an error (FIXME warning V1 = 0x0080)*/
 130 } J2K_STATUS;
 131
 132 /**
 133  * Type of elements storing in the MCT data
 134  */
 135 typedef enum MCT_ELEMENT_TYPE
 136 {
 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 {
 148         MCT_TYPE_DEPENDENCY = 0,
 149         MCT_TYPE_DECORRELATION = 1,
 150         MCT_TYPE_OFFSET = 2
 151 } J2K_MCT_ARRAY_TYPE;
 152
 153 /* ----------------------------------------------------------------------- */
 154
 155 /**
 156 T2 encoding mode
 157 */
 158 typedef enum T2_MODE {
 159         THRESH_CALC = 0,        /** Function called in Rate allocation process*/
 160         FINAL_PASS = 1          /** Function called in Tier 2 process*/
 161 }J2K_T2_MODE;
 162
 163 /**
 164  * Quantization stepsize
 165  */
 166 typedef struct opj_stepsize {
 167         /** exponent */
 168         OPJ_INT32 expn;
 169         /** mantissa */
 170         OPJ_INT32 mant;
 171 } opj_stepsize_t;
 172
 173 /**
 174 Tile-component coding parameters
 175 */
 176 typedef struct opj_tccp
 177 {
 178         /** coding style */
 179         OPJ_UINT32 csty;
 180         /** number of resolutions */
 181         OPJ_UINT32 numresolutions;
 182         /** code-blocks width */
 183         OPJ_UINT32 cblkw;
 184         /** code-blocks height */
 185         OPJ_UINT32 cblkh;
 186         /** code-block coding style */
 187         OPJ_UINT32 cblksty;
 188         /** discrete wavelet transform identifier */
 189         OPJ_UINT32 qmfbid;
 190         /** quantisation style */
 191         OPJ_UINT32 qntsty;
 192         /** stepsizes used for quantization */
 193         opj_stepsize_t stepsizes[OPJ_J2K_MAXBANDS];
 194         /** number of guard bits */
 195         OPJ_UINT32 numgbits;
 196         /** Region Of Interest shift */
 197         OPJ_INT32 roishift;
 198         /** precinct width */
 199         OPJ_UINT32 prcw[OPJ_J2K_MAXRLVLS];
 200         /** precinct height */
 201         OPJ_UINT32 prch[OPJ_J2K_MAXRLVLS];
 202         /** the dc_level_shift **/
 203         OPJ_INT32 m_dc_level_shift;
 204 }
 205 opj_tccp_t;
 206
 207
 208
 209 /**
 210  * FIXME DOC
 211  */
 212 typedef struct opj_mct_data
 213 {
 214         J2K_MCT_ELEMENT_TYPE m_element_type;
 215         J2K_MCT_ARRAY_TYPE       m_array_type;
 216         OPJ_UINT32                       m_index;
 217         OPJ_BYTE *                       m_data;
 218         OPJ_UINT32                       m_data_size;
 219 }
 220 opj_mct_data_t;
 221
 222 /**
 223  * FIXME DOC
 224  */
 225 typedef struct opj_simple_mcc_decorrelation_data
 226 {
 227         OPJ_UINT32                       m_index;
 228         OPJ_UINT32                       m_nb_comps;
 229         opj_mct_data_t *         m_decorrelation_array;
 230         opj_mct_data_t *         m_offset_array;
 231         OPJ_BITFIELD             m_is_irreversible : 1;
 232 }
 233 opj_simple_mcc_decorrelation_data_t;
 234
 235 typedef struct opj_ppx_struct
 236 {
 237         OPJ_BYTE*   m_data; /* m_data == NULL => Zppx not read yet */
 238         OPJ_UINT32      m_data_size;
 239 } opj_ppx;
 240
 241 /**
 242 Tile coding parameters :
 243 this structure is used to store coding/decoding parameters common to all
 244 tiles (information like COD, COC in main header)
 245 */
 246 typedef struct opj_tcp
 247 {
 248         /** coding style */
 249         OPJ_UINT32 csty;
 250         /** progression order */
 251         OPJ_PROG_ORDER prg;
 252         /** number of layers */
 253         OPJ_UINT32 numlayers;
 254         OPJ_UINT32 num_layers_to_decode;
 255         /** multi-component transform identifier */
 256         OPJ_UINT32 mct;
 257         /** rates of layers */
 258         OPJ_FLOAT32 rates[100];
 259         /** number of progression order changes */
 260         OPJ_UINT32 numpocs;
 261         /** progression order changes */
 262         opj_poc_t pocs[32];
 263
 264         /** number of ppt markers (reserved size) */
 265         OPJ_UINT32 ppt_markers_count;
 266         /** ppt markers data (table indexed by Zppt) */
 267         opj_ppx* ppt_markers;
 268
 269         /** packet header store there for future use in t2_decode_packet */
 270         OPJ_BYTE *ppt_data;
 271         /** used to keep a track of the allocated memory */
 272         OPJ_BYTE *ppt_buffer;
 273         /** Number of bytes stored inside ppt_data*/
 274         OPJ_UINT32 ppt_data_size;
 275         /** size of ppt_data*/
 276         OPJ_UINT32 ppt_len;
 277         /** add fixed_quality */
 278         OPJ_FLOAT32 distoratio[100];
 279         /** tile-component coding parameters */
 280         opj_tccp_t *tccps;
 281         /** number of tile parts for the tile. */
 282         OPJ_UINT32 m_nb_tile_parts;
 283         /** data for the tile */
 284         OPJ_BYTE *              m_data;
 285         /** size of data */
 286         OPJ_UINT32              m_data_size;
 287         /** encoding norms */
 288         OPJ_FLOAT64 *   mct_norms;
 289         /** the mct decoding matrix */
 290         OPJ_FLOAT32 *   m_mct_decoding_matrix;
 291         /** the mct coding matrix */
 292         OPJ_FLOAT32 *   m_mct_coding_matrix;
 293         /** mct records */
 294         opj_mct_data_t * m_mct_records;
 295         /** the number of mct records. */
 296         OPJ_UINT32 m_nb_mct_records;
 297         /** the max number of mct records. */
 298         OPJ_UINT32 m_nb_max_mct_records;
 299         /** mcc records */
 300         opj_simple_mcc_decorrelation_data_t * m_mcc_records;
 301         /** the number of mct records. */
 302         OPJ_UINT32 m_nb_mcc_records;
 303         /** the max number of mct records. */
 304         OPJ_UINT32 m_nb_max_mcc_records;
 305
 306
 307         /***** FLAGS *******/
 308         /** If cod == 1 --> there was a COD marker for the present tile */
 309         OPJ_BITFIELD cod : 1;
 310         /** If ppt == 1 --> there was a PPT marker for the present tile */
 311         OPJ_BITFIELD ppt : 1;
 312         /** indicates if a POC marker has been used O:NO, 1:YES */
 313         OPJ_BITFIELD POC : 1;
 314 } opj_tcp_t;
 315
 316
 317
 318
 319 typedef struct opj_encoding_param
 320 {
 321         /** Maximum rate for each component. If == 0, component size limitation is not considered */
 322         OPJ_UINT32 m_max_comp_size;
 323         /** Position of tile part flag in progression order*/
 324         OPJ_INT32 m_tp_pos;
 325         /** fixed layer */
 326         OPJ_INT32 *m_matrice;
 327         /** Flag determining tile part generation*/
 328         OPJ_BYTE m_tp_flag;
 329         /** allocation by rate/distortion */
 330         OPJ_BITFIELD m_disto_alloc : 1;
 331         /** allocation by fixed layer */
 332         OPJ_BITFIELD m_fixed_alloc : 1;
 333         /** add fixed_quality */
 334         OPJ_BITFIELD m_fixed_quality : 1;
 335         /** Enabling Tile part generation*/
 336         OPJ_BITFIELD m_tp_on : 1;
 337 }
 338 opj_encoding_param_t;
 339
 340 typedef struct opj_decoding_param
 341 {
 342         /** if != 0, then original dimension divided by 2^(reduce); if == 0 or not used, image is decoded to the full resolution */
 343         OPJ_UINT32 m_reduce;
 344         /** if != 0, then only the first "layer" layers are decoded; if == 0 or not used, all the quality layers are decoded */
 345         OPJ_UINT32 m_layer;
 346 }
 347 opj_decoding_param_t;
 348
 349
 350 /**
 351  * Coding parameters
 352  */
 353 typedef struct opj_cp
 354 {
 355         /** Size of the image in bits*/
 356         /*int img_size;*/
 357         /** Rsiz*/
 358     OPJ_UINT16 rsiz;
 359         /** XTOsiz */
 360         OPJ_UINT32 tx0; /* MSD see norm */
 361         /** YTOsiz */
 362         OPJ_UINT32 ty0; /* MSD see norm */
 363         /** XTsiz */
 364         OPJ_UINT32 tdx;
 365         /** YTsiz */
 366         OPJ_UINT32 tdy;
 367         /** comment */
 368         OPJ_CHAR *comment;
 369         /** number of tiles in width */
 370         OPJ_UINT32 tw;
 371         /** number of tiles in heigth */
 372         OPJ_UINT32 th;
 373
 374         /** number of ppm markers (reserved size) */
 375         OPJ_UINT32 ppm_markers_count;
 376         /** ppm markers data (table indexed by Zppm) */
 377         opj_ppx* ppm_markers;
 378
 379         /** packet header store there for future use in t2_decode_packet */
 380         OPJ_BYTE *ppm_data;
 381         /** size of the ppm_data*/
 382         OPJ_UINT32 ppm_len;
 383         /** size of the ppm_data*/
 384         OPJ_UINT32 ppm_data_read;
 385
 386         OPJ_BYTE *ppm_data_current;
 387
 388         /** packet header storage original buffer */
 389         OPJ_BYTE *ppm_buffer;
 390         /** pointer remaining on the first byte of the first header if ppm is used */
 391         OPJ_BYTE *ppm_data_first;
 392         /** Number of bytes actually stored inside the ppm_data */
 393         OPJ_UINT32 ppm_data_size;
 394         /** use in case of multiple marker PPM (number of info already store) */
 395         OPJ_INT32 ppm_store;
 396         /** use in case of multiple marker PPM (case on non-finished previous info) */
 397         OPJ_INT32 ppm_previous;
 398
 399         /** tile coding parameters */
 400         opj_tcp_t *tcps;
 401
 402         union
 403         {
 404                 opj_decoding_param_t m_dec;
 405                 opj_encoding_param_t m_enc;
 406         }
 407         m_specific_param;
 408
 409
 410 /* UniPG>> */
 411 #ifdef USE_JPWL
 412         /** enables writing of EPC in MH, thus activating JPWL */
 413         OPJ_BOOL epc_on;
 414         /** enables writing of EPB, in case of activated JPWL */
 415         OPJ_BOOL epb_on;
 416         /** enables writing of ESD, in case of activated JPWL */
 417         OPJ_BOOL esd_on;
 418         /** enables writing of informative techniques of ESD, in case of activated JPWL */
 419         OPJ_BOOL info_on;
 420         /** enables writing of RED, in case of activated JPWL */
 421         OPJ_BOOL red_on;
 422         /** error protection method for MH (0,1,16,32,37-128) */
 423         int hprot_MH;
 424         /** tile number of header protection specification (>=0) */
 425         int hprot_TPH_tileno[JPWL_MAX_NO_TILESPECS];
 426         /** error protection methods for TPHs (0,1,16,32,37-128) */
 427         int hprot_TPH[JPWL_MAX_NO_TILESPECS];
 428         /** tile number of packet protection specification (>=0) */
 429         int pprot_tileno[JPWL_MAX_NO_PACKSPECS];
 430         /** packet number of packet protection specification (>=0) */
 431         int pprot_packno[JPWL_MAX_NO_PACKSPECS];
 432         /** error protection methods for packets (0,1,16,32,37-128) */
 433         int pprot[JPWL_MAX_NO_PACKSPECS];
 434         /** enables writing of ESD, (0/2/4 bytes) */
 435         int sens_size;
 436         /** sensitivity addressing size (0=auto/2/4 bytes) */
 437         int sens_addr;
 438         /** sensitivity range (0-3) */
 439         int sens_range;
 440         /** sensitivity method for MH (-1,0-7) */
 441         int sens_MH;
 442         /** tile number of sensitivity specification (>=0) */
 443         int sens_TPH_tileno[JPWL_MAX_NO_TILESPECS];
 444         /** sensitivity methods for TPHs (-1,0-7) */
 445         int sens_TPH[JPWL_MAX_NO_TILESPECS];
 446         /** enables JPWL correction at the decoder */
 447         OPJ_BOOL correct;
 448         /** expected number of components at the decoder */
 449         int exp_comps;
 450         /** maximum number of tiles at the decoder */
 451         OPJ_UINT32 max_tiles;
 452 #endif /* USE_JPWL */
 453
 454         /******** FLAGS *********/
 455         /** if ppm == 1 --> there was a PPM marker*/
 456         OPJ_BITFIELD ppm : 1;
 457         /** tells if the parameter is a coding or decoding one */
 458         OPJ_BITFIELD m_is_decoder : 1;
 459 /* <<UniPG */
 460 } opj_cp_t;
 461
 462
 463 typedef struct opj_j2k_dec
 464 {
 465         /** locate in which part of the codestream the decoder is (main header, tile header, end) */
 466         OPJ_UINT32 m_state;
 467         /**
 468          * store decoding parameters common to all tiles (information like COD, COC in main header)
 469          */
 470         opj_tcp_t *m_default_tcp;
 471         OPJ_BYTE  *m_header_data;
 472         OPJ_UINT32 m_header_data_size;
 473         /** to tell the tile part length */
 474         OPJ_UINT32 m_sot_length;
 475         /** Only tiles index in the correct range will be decoded.*/
 476         OPJ_UINT32 m_start_tile_x;
 477         OPJ_UINT32 m_start_tile_y;
 478         OPJ_UINT32 m_end_tile_x;
 479         OPJ_UINT32 m_end_tile_y;
 480         /**
 481          * Decoded area set by the user
 482          */
 483         OPJ_UINT32 m_DA_x0;
 484         OPJ_UINT32 m_DA_y0;
 485         OPJ_UINT32 m_DA_x1;
 486         OPJ_UINT32 m_DA_y1;
 487
 488         /** Index of the tile to decode (used in get_tile) */
 489         OPJ_INT32 m_tile_ind_to_dec;
 490         /** Position of the last SOT marker read */
 491         OPJ_OFF_T m_last_sot_read_pos;
 492
 493         /**
 494          * Indicate that the current tile-part is assume as the last tile part of the codestream.
 495          * It is useful in the case of PSot is equal to zero. The sot length will be compute in the
 496          * SOD reader function. FIXME NOT USED for the moment
 497          */
 498         OPJ_BOOL   m_last_tile_part;
 499         /** to tell that a tile can be decoded. */
 500         OPJ_BITFIELD m_can_decode         : 1;
 501         OPJ_BITFIELD m_discard_tiles  : 1;
 502         OPJ_BITFIELD m_skip_data          : 1;
 503         /** TNsot correction : see issue 254 **/
 504         OPJ_BITFIELD m_nb_tile_parts_correction_checked : 1;
 505         OPJ_BITFIELD m_nb_tile_parts_correction : 1;
 506
 507 } opj_j2k_dec_t;
 508
 509 typedef struct opj_j2k_enc
 510 {
 511         /** Tile part number, regardless of poc, for each new poc, tp is reset to 1*/
 512         OPJ_UINT32 m_current_poc_tile_part_number; /* tp_num */
 513
 514         /** 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.*/
 515         OPJ_UINT32 m_current_tile_part_number; /*cur_tp_num */
 516
 517         /**
 518         locate the start position of the TLM marker
 519         after encoding the tilepart, a jump (in j2k_write_sod) is done to the TLM marker to store the value of its length.
 520         */
 521     OPJ_OFF_T m_tlm_start;
 522         /**
 523          * Stores the sizes of the tlm.
 524          */
 525         OPJ_BYTE * m_tlm_sot_offsets_buffer;
 526         /**
 527          * The current offset of the tlm buffer.
 528          */
 529         OPJ_BYTE * m_tlm_sot_offsets_current;
 530
 531         /** Total num of tile parts in whole image = num tiles* num tileparts in each tile*/
 532         /** used in TLMmarker*/
 533         OPJ_UINT32 m_total_tile_parts;   /* totnum_tp */
 534
 535         /* encoded data for a tile */
 536         OPJ_BYTE * m_encoded_tile_data;
 537
 538         /* size of the encoded_data */
 539         OPJ_UINT32 m_encoded_tile_size;
 540
 541         /* encoded data for a tile */
 542         OPJ_BYTE * m_header_tile_data;
 543
 544         /* size of the encoded_data */
 545         OPJ_UINT32 m_header_tile_data_size;
 546
 547
 548 } opj_j2k_enc_t;
 549
 550
 551
 552 struct opj_tcd;
 553 /**
 554 JPEG-2000 codestream reader/writer
 555 */
 556 typedef struct opj_j2k
 557 {
 558         /* J2K codestream is decoded*/
 559         OPJ_BOOL m_is_decoder;
 560
 561         /* FIXME DOC*/
 562         union
 563         {
 564                 opj_j2k_dec_t m_decoder;
 565                 opj_j2k_enc_t m_encoder;
 566         }
 567         m_specific_param;
 568
 569         /** pointer to the internal/private encoded / decoded image */
 570         opj_image_t* m_private_image;
 571
 572         /* pointer to the output image (decoded)*/
 573         opj_image_t* m_output_image;
 574
 575         /** Coding parameters */
 576         opj_cp_t m_cp;
 577
 578         /** the list of procedures to exec **/
 579         opj_procedure_list_t *  m_procedure_list;
 580
 581         /** the list of validation procedures to follow to make sure the code is valid **/
 582         opj_procedure_list_t *  m_validation_list;
 583
 584         /** helper used to write the index file */
 585         opj_codestream_index_t *cstr_index;
 586
 587         /** number of the tile curently concern by coding/decoding */
 588         OPJ_UINT32 m_current_tile_number;
 589
 590         /** the current tile coder/decoder **/
 591         struct opj_tcd *        m_tcd;
 592 }
 593 opj_j2k_t;
 594
 595
 596
 597
 598 /** @name Exported functions */
 599 /*@{*/
 600 /* ----------------------------------------------------------------------- */
 601
 602 /**
 603 Setup the decoder decoding parameters using user parameters.
 604 Decoding parameters are returned in j2k->cp.
 605 @param j2k J2K decompressor handle
 606 @param parameters decompression parameters
 607 */
 608 void opj_j2k_setup_decoder(opj_j2k_t *j2k, opj_dparameters_t *parameters);
 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 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 /**
 715  * Sets the given area to be decoded. This function should be called right after opj_read_header and before any tile header reading.
 716  *
 717  * @param       p_j2k                   the jpeg2000 codec.
 718  * @param       p_image     FIXME DOC
 719  * @param       p_start_x               the left position of the rectangle to decode (in image coordinates).
 720  * @param       p_start_y               the up position of the rectangle to decode (in image coordinates).
 721  * @param       p_end_x                 the right position of the rectangle to decode (in image coordinates).
 722  * @param       p_end_y                 the bottom position of the rectangle to decode (in image coordinates).
 723  * @param       p_manager               the user event manager
 724  *
 725  * @return      true                    if the area could be set.
 726  */
 727 OPJ_BOOL opj_j2k_set_decode_area(       opj_j2k_t *p_j2k,
 728                                                                     opj_image_t* p_image,
 729                                                                     OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,
 730                                                                     OPJ_INT32 p_end_x, OPJ_INT32 p_end_y,
 731                                                                     opj_event_mgr_t * p_manager );
 732
 733 /**
 734  * Creates a J2K decompression structure.
 735  *
 736  * @return a handle to a J2K decompressor if successful, NULL otherwise.
 737  */
 738 opj_j2k_t* opj_j2k_create_decompress(void);
 739
 740
 741 /**
 742  * Dump some elements from the J2K decompression structure .
 743  *
 744  *@param p_j2k                          the jpeg2000 codec.
 745  *@param flag                           flag to describe what elments are dump.
 746  *@param out_stream                     output stream where dump the elements.
 747  *
 748 */
 749 void j2k_dump (opj_j2k_t* p_j2k, OPJ_INT32 flag, FILE* out_stream);
 750
 751
 752
 753 /**
 754  * Dump an image header structure.
 755  *
 756  *@param image                  the image header to dump.
 757  *@param dev_dump_flag          flag to describe if we are in the case of this function is use outside j2k_dump function
 758  *@param out_stream                     output stream where dump the elements.
 759  */
 760 void j2k_dump_image_header(opj_image_t* image, OPJ_BOOL dev_dump_flag, FILE* out_stream);
 761
 762 /**
 763  * Dump a component image header structure.
 764  *
 765  *@param comp           the component image header to dump.
 766  *@param dev_dump_flag          flag to describe if we are in the case of this function is use outside j2k_dump function
 767  *@param out_stream                     output stream where dump the elements.
 768  */
 769 void j2k_dump_image_comp_header(opj_image_comp_t* comp, OPJ_BOOL dev_dump_flag, FILE* out_stream);
 770
 771 /**
 772  * Get the codestream info from a JPEG2000 codec.
 773  *
 774  *@param        p_j2k                           the component image header to dump.
 775  *
 776  *@return       the codestream information extract from the jpg2000 codec
 777  */
 778 opj_codestream_info_v2_t* j2k_get_cstr_info(opj_j2k_t* p_j2k);
 779
 780 /**
 781  * Get the codestream index from a JPEG2000 codec.
 782  *
 783  *@param        p_j2k                           the component image header to dump.
 784  *
 785  *@return       the codestream index extract from the jpg2000 codec
 786  */
 787 opj_codestream_index_t* j2k_get_cstr_index(opj_j2k_t* p_j2k);
 788
 789 /**
 790  * Decode an image from a JPEG-2000 codestream
 791  * @param j2k J2K decompressor handle
 792  * @param p_stream  FIXME DOC
 793  * @param p_image   FIXME DOC
 794  * @param p_manager FIXME DOC
 795  * @return FIXME DOC
 796 */
 797 OPJ_BOOL opj_j2k_decode(opj_j2k_t *j2k,
 798                         opj_stream_private_t *p_stream,
 799                         opj_image_t *p_image,
 800                         opj_event_mgr_t *p_manager);
 801
 802
 803 OPJ_BOOL opj_j2k_get_tile(      opj_j2k_t *p_j2k,
 804                                                 opj_stream_private_t *p_stream,
 805                                                 opj_image_t* p_image,
 806                                                 opj_event_mgr_t * p_manager,
 807                                                     OPJ_UINT32 tile_index );
 808
 809 OPJ_BOOL opj_j2k_set_decoded_resolution_factor(opj_j2k_t *p_j2k,
 810                                                OPJ_UINT32 res_factor,
 811                                                opj_event_mgr_t * p_manager);
 812
 813
 814 /**
 815  * Writes a tile.
 816  * @param       p_j2k           the jpeg2000 codec.
 817  * @param p_tile_index FIXME DOC
 818  * @param p_data FIXME DOC
 819  * @param p_data_size FIXME DOC
 820  * @param       p_stream                        the stream to write data to.
 821  * @param       p_manager       the user event manager.
 822  */
 823 OPJ_BOOL opj_j2k_write_tile (   opj_j2k_t * p_j2k,
 824                                                             OPJ_UINT32 p_tile_index,
 825                                                             OPJ_BYTE * p_data,
 826                                                             OPJ_UINT32 p_data_size,
 827                                                             opj_stream_private_t *p_stream,
 828                                                             opj_event_mgr_t * p_manager );
 829
 830 /**
 831  * Encodes an image into a JPEG-2000 codestream
 832  */
 833 OPJ_BOOL opj_j2k_encode(        opj_j2k_t * p_j2k,
 834                                                 opj_stream_private_t *cio,
 835                                                 opj_event_mgr_t * p_manager );
 836
 837 /**
 838  * Starts a compression scheme, i.e. validates the codec parameters, writes the header.
 839  *
 840  * @param       p_j2k           the jpeg2000 codec.
 841  * @param       p_stream                        the stream object.
 842  * @param       p_image FIXME DOC
 843  * @param       p_manager       the user event manager.
 844  *
 845  * @return true if the codec is valid.
 846  */
 847 OPJ_BOOL opj_j2k_start_compress(opj_j2k_t *p_j2k,
 848                                                             opj_stream_private_t *p_stream,
 849                                                             opj_image_t * p_image,
 850                                                             opj_event_mgr_t * p_manager);
 851
 852 /**
 853  * Ends the compression procedures and possibiliy add data to be read after the
 854  * codestream.
 855  */
 856 OPJ_BOOL opj_j2k_end_compress(  opj_j2k_t *p_j2k,
 857                                                             opj_stream_private_t *cio,
 858                                                             opj_event_mgr_t * p_manager);
 859
 860 OPJ_BOOL opj_j2k_setup_mct_encoding (opj_tcp_t * p_tcp, opj_image_t * p_image);
 861
 862
 863 #endif /* __J2K_H */