src/lib/openjp2/j2k.h

   1 /*
   2  * Copyright (c) 2002-2007, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
   3  * Copyright (c) 2002-2007, Professor Benoit Macq
   4  * Copyright (c) 2001-2003, David Janssens
   5  * Copyright (c) 2002-2003, Yannick Verschueren
   6  * Copyright (c) 2003-2007, Francois-Olivier Devaux and Antonin Descampe
   7  * Copyright (c) 2005, Herve Drolon, FreeImage Team
   8  * Copyright (c) 2006-2007, Parvatha Elangovan
   9  * Copyright (c) 2008, Jerome Fimes, Communications & Systemes <jerome.fimes@c-s.fr>
  10  * Copyright (c) 2011-2012, Centre National d'Etudes Spatiales (CNES), France
  11  * Copyright (c) 2012, CS Systemes d'Information, France
  12  *
  13  * All rights reserved.
  14  *
  15  * Redistribution and use in source and binary forms, with or without
  16  * modification, are permitted provided that the following conditions
  17  * are met:
  18  * 1. Redistributions of source code must retain the above copyright
  19  *    notice, this list of conditions and the following disclaimer.
  20  * 2. Redistributions in binary form must reproduce the above copyright
  21  *    notice, this list of conditions and the following disclaimer in the
  22  *    documentation and/or other materials provided with the distribution.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  25  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  28  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  29  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  30  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  31  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  32  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  33  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  34  * POSSIBILITY OF SUCH DAMAGE.
  35  */
  36 #ifndef __J2K_H
  37 #define __J2K_H
  38 /**
  39 @file j2k.h
  40 @brief The JPEG-2000 Codestream Reader/Writer (J2K)
  41
  42 The functions in J2K.C have for goal to read/write the several parts of the codestream: markers and data.
  43 */
  44
  45 /** @defgroup J2K J2K - JPEG-2000 codestream reader/writer */
  46 /*@{*/
  47
  48 #define J2K_CP_CSTY_PRT 0x01
  49 #define J2K_CP_CSTY_SOP 0x02
  50 #define J2K_CP_CSTY_EPH 0x04
  51 #define J2K_CCP_CSTY_PRT 0x01
  52 #define J2K_CCP_CBLKSTY_LAZY 0x01     /**< Selective arithmetic coding bypass */
  53 #define J2K_CCP_CBLKSTY_RESET 0x02    /**< Reset context probabilities on coding pass boundaries */
  54 #define J2K_CCP_CBLKSTY_TERMALL 0x04  /**< Termination on each coding pass */
  55 #define J2K_CCP_CBLKSTY_VSC 0x08      /**< Vertically stripe causal context */
  56 #define J2K_CCP_CBLKSTY_PTERM 0x10    /**< Predictable termination */
  57 #define J2K_CCP_CBLKSTY_SEGSYM 0x20   /**< Segmentation symbols are used */
  58 #define J2K_CCP_QNTSTY_NOQNT 0
  59 #define J2K_CCP_QNTSTY_SIQNT 1
  60 #define J2K_CCP_QNTSTY_SEQNT 2
  61
  62 #define OPJ_J2K_DEFAULT_CBLK_DATA_SIZE 8192
  63
  64 /* ----------------------------------------------------------------------- */
  65
  66 #define J2K_MS_SOC 0xff4f       /**< SOC marker value */
  67 #define J2K_MS_SOT 0xff90       /**< SOT marker value */
  68 #define J2K_MS_SOD 0xff93       /**< SOD marker value */
  69 #define J2K_MS_EOC 0xffd9       /**< EOC marker value */
  70 #define J2K_MS_SIZ 0xff51       /**< SIZ marker value */
  71 #define J2K_MS_COD 0xff52       /**< COD marker value */
  72 #define J2K_MS_COC 0xff53       /**< COC marker value */
  73 #define J2K_MS_RGN 0xff5e       /**< RGN marker value */
  74 #define J2K_MS_QCD 0xff5c       /**< QCD marker value */
  75 #define J2K_MS_QCC 0xff5d       /**< QCC marker value */
  76 #define J2K_MS_POC 0xff5f       /**< POC marker value */
  77 #define J2K_MS_TLM 0xff55       /**< TLM marker value */
  78 #define J2K_MS_PLM 0xff57       /**< PLM marker value */
  79 #define J2K_MS_PLT 0xff58       /**< PLT marker value */
  80 #define J2K_MS_PPM 0xff60       /**< PPM marker value */
  81 #define J2K_MS_PPT 0xff61       /**< PPT marker value */
  82 #define J2K_MS_SOP 0xff91       /**< SOP marker value */
  83 #define J2K_MS_EPH 0xff92       /**< EPH marker value */
  84 #define J2K_MS_CRG 0xff63       /**< CRG marker value */
  85 #define J2K_MS_COM 0xff64       /**< COM marker value */
  86 #define J2K_MS_CBD 0xff78       /**< CBD marker value */
  87 #define J2K_MS_MCC 0xff75       /**< MCC marker value */
  88 #define J2K_MS_MCT 0xff74       /**< MCT marker value */
  89 #define J2K_MS_MCO 0xff77       /**< MCO marker value */
  90
  91 #define J2K_MS_UNK 0            /**< UNKNOWN marker value */
  92
  93 /* UniPG>> */
  94 #ifdef USE_JPWL
  95 #define J2K_MS_EPC 0xff68       /**< EPC marker value (Part 11: JPEG 2000 for Wireless) */
  96 #define J2K_MS_EPB 0xff66       /**< EPB marker value (Part 11: JPEG 2000 for Wireless) */
  97 #define J2K_MS_ESD 0xff67       /**< ESD marker value (Part 11: JPEG 2000 for Wireless) */
  98 #define J2K_MS_RED 0xff69       /**< RED marker value (Part 11: JPEG 2000 for Wireless) */
  99 #endif /* USE_JPWL */
 100 #ifdef USE_JPSEC
 101 #define J2K_MS_SEC 0xff65    /**< SEC marker value (Part 8: Secure JPEG 2000) */
 102 #define J2K_MS_INSEC 0xff94  /**< INSEC marker value (Part 8: Secure JPEG 2000) */
 103 #endif /* USE_JPSEC */
 104 /* <<UniPG */
 105
 106 /* ----------------------------------------------------------------------- */
 107
 108 /**
 109  * Values that specify the status of the decoding process when decoding the main header.
 110  * These values may be combined with a | operator.
 111  * */
 112 typedef enum J2K_STATUS {
 113         J2K_STATE_NONE  =  0x0000, /**< a SOC marker is expected */
 114         J2K_STATE_MHSOC  = 0x0001, /**< a SOC marker is expected */
 115         J2K_STATE_MHSIZ  = 0x0002, /**< a SIZ marker is expected */
 116         J2K_STATE_MH     = 0x0004, /**< the decoding process is in the main header */
 117         J2K_STATE_TPHSOT = 0x0008, /**< the decoding process is in a tile part header and expects a SOT marker */
 118         J2K_STATE_TPH    = 0x0010, /**< the decoding process is in a tile part header */
 119         J2K_STATE_MT     = 0x0020, /**< the EOC marker has just been read */
 120         J2K_STATE_NEOC   = 0x0040, /**< the decoding process must not expect a EOC marker because the codestream is truncated */
 121
 122         J2K_STATE_EOC    = 0x0100, /**< the decoding process has encountered the EOC marker */
 123         J2K_STATE_ERR    = 0x8000  /**< the decoding process has encountered an error (FIXME warning V1 = 0x0080)*/
 124 } J2K_STATUS;
 125
 126 /**
 127  * Type of elements storing in the MCT data
 128  */
 129 typedef enum MCT_ELEMENT_TYPE
 130 {
 131         MCT_TYPE_INT16 = 0,             /** MCT data is stored as signed shorts*/
 132         MCT_TYPE_INT32 = 1,             /** MCT data is stored as signed integers*/
 133         MCT_TYPE_FLOAT = 2,             /** MCT data is stored as floats*/
 134         MCT_TYPE_DOUBLE = 3             /** MCT data is stored as doubles*/
 135 } J2K_MCT_ELEMENT_TYPE;
 136
 137 /**
 138  * Type of MCT array
 139  */
 140 typedef enum MCT_ARRAY_TYPE
 141 {
 142         MCT_TYPE_DEPENDENCY = 0,
 143         MCT_TYPE_DECORRELATION = 1,
 144         MCT_TYPE_OFFSET = 2
 145 } J2K_MCT_ARRAY_TYPE;
 146
 147 /* ----------------------------------------------------------------------- */
 148
 149 /**
 150 T2 encoding mode
 151 */
 152 typedef enum T2_MODE {
 153         THRESH_CALC = 0,        /** Function called in Rate allocation process*/
 154         FINAL_PASS = 1          /** Function called in Tier 2 process*/
 155 }J2K_T2_MODE;
 156
 157 /**
 158  * Quantization stepsize
 159  */
 160 typedef struct opj_stepsize {
 161         /** exponent */
 162         OPJ_INT32 expn;
 163         /** mantissa */
 164         OPJ_INT32 mant;
 165 } opj_stepsize_t;
 166
 167 /**
 168 Tile-component coding parameters
 169 */
 170 typedef struct opj_tccp
 171 {
 172         /** coding style */
 173         OPJ_UINT32 csty;
 174         /** number of resolutions */
 175         OPJ_UINT32 numresolutions;
 176         /** code-blocks width */
 177         OPJ_UINT32 cblkw;
 178         /** code-blocks height */
 179         OPJ_UINT32 cblkh;
 180         /** code-block coding style */
 181         OPJ_UINT32 cblksty;
 182         /** discrete wavelet transform identifier */
 183         OPJ_UINT32 qmfbid;
 184         /** quantisation style */
 185         OPJ_UINT32 qntsty;
 186         /** stepsizes used for quantization */
 187         opj_stepsize_t stepsizes[OPJ_J2K_MAXBANDS];
 188         /** number of guard bits */
 189         OPJ_UINT32 numgbits;
 190         /** Region Of Interest shift */
 191         OPJ_INT32 roishift;
 192         /** precinct width */
 193         OPJ_UINT32 prcw[OPJ_J2K_MAXRLVLS];
 194         /** precinct height */
 195         OPJ_UINT32 prch[OPJ_J2K_MAXRLVLS];
 196         /** the dc_level_shift **/
 197         OPJ_INT32 m_dc_level_shift;
 198 }
 199 opj_tccp_t;
 200
 201
 202
 203 /**
 204  * FIXME DOC
 205  */
 206 typedef struct opj_mct_data
 207 {
 208         J2K_MCT_ELEMENT_TYPE m_element_type;
 209         J2K_MCT_ARRAY_TYPE       m_array_type;
 210         OPJ_UINT32                       m_index;
 211         OPJ_BYTE *                       m_data;
 212         OPJ_UINT32                       m_data_size;
 213 }
 214 opj_mct_data_t;
 215
 216 /**
 217  * FIXME DOC
 218  */
 219 typedef struct opj_simple_mcc_decorrelation_data
 220 {
 221         OPJ_UINT32                       m_index;
 222         OPJ_UINT32                       m_nb_comps;
 223         opj_mct_data_t *         m_decorrelation_array;
 224         opj_mct_data_t *         m_offset_array;
 225         OPJ_UINT32                       m_is_irreversible : 1;
 226 }
 227 opj_simple_mcc_decorrelation_data_t;
 228
 229 /**
 230 Tile coding parameters :
 231 this structure is used to store coding/decoding parameters common to all
 232 tiles (information like COD, COC in main header)
 233 */
 234 typedef struct opj_tcp
 235 {
 236         /** coding style */
 237         OPJ_UINT32 csty;
 238         /** progression order */
 239         OPJ_PROG_ORDER prg;
 240         /** number of layers */
 241         OPJ_UINT32 numlayers;
 242         OPJ_UINT32 num_layers_to_decode;
 243         /** multi-component transform identifier */
 244         OPJ_UINT32 mct;
 245         /** rates of layers */
 246         OPJ_FLOAT32 rates[100];
 247         /** number of progression order changes */
 248         OPJ_UINT32 numpocs;
 249         /** progression order changes */
 250         opj_poc_t pocs[32];
 251         /** packet header store there for futur use in t2_decode_packet */
 252         OPJ_BYTE *ppt_data;
 253         /** used to keep a track of the allocated memory */
 254         OPJ_BYTE *ppt_buffer;
 255         /** Number of bytes stored inside ppt_data*/
 256         OPJ_UINT32 ppt_data_size;
 257         /** size of ppt_data*/
 258         OPJ_UINT32 ppt_len;
 259         /** add fixed_quality */
 260         OPJ_FLOAT32 distoratio[100];
 261         /** tile-component coding parameters */
 262         opj_tccp_t *tccps;
 263         /** number of tile parts for the tile. */
 264         OPJ_UINT32 m_nb_tile_parts;
 265         /** data for the tile */
 266         OPJ_BYTE *              m_data;
 267         /** size of data */
 268         OPJ_UINT32              m_data_size;
 269         /** encoding norms */
 270         OPJ_FLOAT64 *   mct_norms;
 271         /** the mct decoding matrix */
 272         OPJ_FLOAT32 *   m_mct_decoding_matrix;
 273         /** the mct coding matrix */
 274         OPJ_FLOAT32 *   m_mct_coding_matrix;
 275         /** mct records */
 276         opj_mct_data_t * m_mct_records;
 277         /** the number of mct records. */
 278         OPJ_UINT32 m_nb_mct_records;
 279         /** the max number of mct records. */
 280         OPJ_UINT32 m_nb_max_mct_records;
 281         /** mcc records */
 282         opj_simple_mcc_decorrelation_data_t * m_mcc_records;
 283         /** the number of mct records. */
 284         OPJ_UINT32 m_nb_mcc_records;
 285         /** the max number of mct records. */
 286         OPJ_UINT32 m_nb_max_mcc_records;
 287
 288
 289         /***** FLAGS *******/
 290         /** If ppt == 1 --> there was a PPT marker for the present tile */
 291         OPJ_UINT32 ppt : 1;
 292         /** indicates if a POC marker has been used O:NO, 1:YES */
 293         OPJ_UINT32 POC : 1;
 294 } opj_tcp_t;
 295
 296
 297
 298
 299 typedef struct opj_encoding_param
 300 {
 301         /** Digital cinema profile*/
 302         OPJ_CINEMA_MODE m_cinema;
 303         /** Maximum rate for each component. If == 0, component size limitation is not considered */
 304         OPJ_UINT32 m_max_comp_size;
 305         /** Position of tile part flag in progression order*/
 306         OPJ_INT32 m_tp_pos;
 307         /** fixed layer */
 308         OPJ_INT32 *m_matrice;
 309         /** Flag determining tile part generation*/
 310         OPJ_BYTE m_tp_flag;
 311         /** allocation by rate/distortion */
 312         OPJ_UINT32 m_disto_alloc : 1;
 313         /** allocation by fixed layer */
 314         OPJ_UINT32 m_fixed_alloc : 1;
 315         /** add fixed_quality */
 316         OPJ_UINT32 m_fixed_quality : 1;
 317         /** Enabling Tile part generation*/
 318         OPJ_UINT32 m_tp_on : 1;
 319 }
 320 opj_encoding_param_t;
 321
 322 typedef struct opj_decoding_param
 323 {
 324         /** if != 0, then original dimension divided by 2^(reduce); if == 0 or not used, image is decoded to the full resolution */
 325         OPJ_UINT32 m_reduce;
 326         /** if != 0, then only the first "layer" layers are decoded; if == 0 or not used, all the quality layers are decoded */
 327         OPJ_UINT32 m_layer;
 328 }
 329 opj_decoding_param_t;
 330
 331
 332 /**
 333  * Coding parameters
 334  */
 335 typedef struct opj_cp
 336 {
 337         /** Size of the image in bits*/
 338         /*int img_size;*/
 339         /** Rsiz*/
 340         OPJ_RSIZ_CAPABILITIES rsiz;
 341         /** XTOsiz */
 342         OPJ_UINT32 tx0; /* MSD see norm */
 343         /** YTOsiz */
 344         OPJ_UINT32 ty0; /* MSD see norm */
 345         /** XTsiz */
 346         OPJ_UINT32 tdx;
 347         /** YTsiz */
 348         OPJ_UINT32 tdy;
 349         /** comment */
 350         OPJ_CHAR *comment;
 351         /** number of tiles in width */
 352         OPJ_UINT32 tw;
 353         /** number of tiles in heigth */
 354         OPJ_UINT32 th;
 355
 356         /** packet header store there for futur use in t2_decode_packet */
 357         OPJ_BYTE *ppm_data;
 358         /** size of the ppm_data*/
 359         OPJ_UINT32 ppm_len;
 360         /** size of the ppm_data*/
 361         OPJ_UINT32 ppm_data_read;
 362
 363         OPJ_BYTE *ppm_data_current;
 364
 365         /** packet header storage original buffer */
 366         OPJ_BYTE *ppm_buffer;
 367         /** pointer remaining on the first byte of the first header if ppm is used */
 368         OPJ_BYTE *ppm_data_first;
 369         /** Number of bytes actually stored inside the ppm_data */
 370         OPJ_UINT32 ppm_data_size;
 371         /** use in case of multiple marker PPM (number of info already store) */
 372         OPJ_INT32 ppm_store;
 373         /** use in case of multiple marker PPM (case on non-finished previous info) */
 374         OPJ_INT32 ppm_previous;
 375
 376         /** tile coding parameters */
 377         opj_tcp_t *tcps;
 378
 379         union
 380         {
 381                 opj_decoding_param_t m_dec;
 382                 opj_encoding_param_t m_enc;
 383         }
 384         m_specific_param;
 385
 386
 387 /* UniPG>> */
 388 #ifdef USE_JPWL
 389         /** enables writing of EPC in MH, thus activating JPWL */
 390         OPJ_BOOL epc_on;
 391         /** enables writing of EPB, in case of activated JPWL */
 392         OPJ_BOOL epb_on;
 393         /** enables writing of ESD, in case of activated JPWL */
 394         OPJ_BOOL esd_on;
 395         /** enables writing of informative techniques of ESD, in case of activated JPWL */
 396         OPJ_BOOL info_on;
 397         /** enables writing of RED, in case of activated JPWL */
 398         OPJ_BOOL red_on;
 399         /** error protection method for MH (0,1,16,32,37-128) */
 400         int hprot_MH;
 401         /** tile number of header protection specification (>=0) */
 402         int hprot_TPH_tileno[JPWL_MAX_NO_TILESPECS];
 403         /** error protection methods for TPHs (0,1,16,32,37-128) */
 404         int hprot_TPH[JPWL_MAX_NO_TILESPECS];
 405         /** tile number of packet protection specification (>=0) */
 406         int pprot_tileno[JPWL_MAX_NO_PACKSPECS];
 407         /** packet number of packet protection specification (>=0) */
 408         int pprot_packno[JPWL_MAX_NO_PACKSPECS];
 409         /** error protection methods for packets (0,1,16,32,37-128) */
 410         int pprot[JPWL_MAX_NO_PACKSPECS];
 411         /** enables writing of ESD, (0/2/4 bytes) */
 412         int sens_size;
 413         /** sensitivity addressing size (0=auto/2/4 bytes) */
 414         int sens_addr;
 415         /** sensitivity range (0-3) */
 416         int sens_range;
 417         /** sensitivity method for MH (-1,0-7) */
 418         int sens_MH;
 419         /** tile number of sensitivity specification (>=0) */
 420         int sens_TPH_tileno[JPWL_MAX_NO_TILESPECS];
 421         /** sensitivity methods for TPHs (-1,0-7) */
 422         int sens_TPH[JPWL_MAX_NO_TILESPECS];
 423         /** enables JPWL correction at the decoder */
 424         OPJ_BOOL correct;
 425         /** expected number of components at the decoder */
 426         int exp_comps;
 427         /** maximum number of tiles at the decoder */
 428         OPJ_UINT32 max_tiles;
 429 #endif /* USE_JPWL */
 430
 431         /******** FLAGS *********/
 432         /** if ppm == 1 --> there was a PPM marker*/
 433         OPJ_UINT32 ppm : 1;
 434         /** tells if the parameter is a coding or decoding one */
 435         OPJ_UINT32 m_is_decoder : 1;
 436 /* <<UniPG */
 437 } opj_cp_t;
 438
 439
 440 typedef struct opj_j2k_dec
 441 {
 442         /** locate in which part of the codestream the decoder is (main header, tile header, end) */
 443         OPJ_UINT32 m_state;
 444         /**
 445          * store decoding parameters common to all tiles (information like COD, COC in main header)
 446          */
 447         opj_tcp_t *m_default_tcp;
 448         OPJ_BYTE  *m_header_data;
 449         OPJ_UINT32 m_header_data_size;
 450         /** to tell the tile part length */
 451         OPJ_UINT32 m_sot_length;
 452         /** Only tiles index in the correct range will be decoded.*/
 453         OPJ_UINT32 m_start_tile_x;
 454         OPJ_UINT32 m_start_tile_y;
 455         OPJ_UINT32 m_end_tile_x;
 456         OPJ_UINT32 m_end_tile_y;
 457         /**
 458          * Decoded area set by the user
 459          */
 460         OPJ_UINT32 m_DA_x0;
 461         OPJ_UINT32 m_DA_y0;
 462         OPJ_UINT32 m_DA_x1;
 463         OPJ_UINT32 m_DA_y1;
 464
 465         /** Index of the tile to decode (used in get_tile) */
 466         OPJ_INT32 m_tile_ind_to_dec;
 467         /** Position of the last SOT marker read */
 468         OPJ_OFF_T m_last_sot_read_pos;
 469
 470         /**
 471          * Indicate that the current tile-part is assume as the last tile part of the codestream.
 472          * It is useful in the case of PSot is equal to zero. The sot length will be compute in the
 473          * SOD reader function. FIXME NOT USED for the moment
 474          */
 475         OPJ_BOOL   m_last_tile_part;
 476         /** to tell that a tile can be decoded. */
 477         OPJ_UINT32 m_can_decode                 : 1;
 478         OPJ_UINT32 m_discard_tiles              : 1;
 479         OPJ_UINT32 m_skip_data                  : 1;
 480
 481 } opj_j2k_dec_t;
 482
 483 typedef struct opj_j2k_enc
 484 {
 485         /** Tile part number, regardless of poc, for each new poc, tp is reset to 1*/
 486         OPJ_UINT32 m_current_poc_tile_part_number; /* tp_num */
 487
 488         /** 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.*/
 489         OPJ_UINT32 m_current_tile_part_number; /*cur_tp_num */
 490
 491         /**
 492         locate the start position of the TLM marker
 493         after encoding the tilepart, a jump (in j2k_write_sod) is done to the TLM marker to store the value of its length.
 494         */
 495     OPJ_OFF_T m_tlm_start;
 496         /**
 497          * Stores the sizes of the tlm.
 498          */
 499         OPJ_BYTE * m_tlm_sot_offsets_buffer;
 500         /**
 501          * The current offset of the tlm buffer.
 502          */
 503         OPJ_BYTE * m_tlm_sot_offsets_current;
 504
 505         /** Total num of tile parts in whole image = num tiles* num tileparts in each tile*/
 506         /** used in TLMmarker*/
 507         OPJ_UINT32 m_total_tile_parts;   /* totnum_tp */
 508
 509         /* encoded data for a tile */
 510         OPJ_BYTE * m_encoded_tile_data;
 511
 512         /* size of the encoded_data */
 513         OPJ_UINT32 m_encoded_tile_size;
 514
 515         /* encoded data for a tile */
 516         OPJ_BYTE * m_header_tile_data;
 517
 518         /* size of the encoded_data */
 519         OPJ_UINT32 m_header_tile_data_size;
 520
 521
 522 } opj_j2k_enc_t;
 523
 524
 525
 526 struct opj_tcd;
 527 /**
 528 JPEG-2000 codestream reader/writer
 529 */
 530 typedef struct opj_j2k
 531 {
 532         /* J2K codestream is decoded*/
 533         OPJ_BOOL m_is_decoder;
 534
 535         /* FIXME DOC*/
 536         union
 537         {
 538                 opj_j2k_dec_t m_decoder;
 539                 opj_j2k_enc_t m_encoder;
 540         }
 541         m_specific_param;
 542
 543         /** pointer to the internal/private encoded / decoded image */
 544         opj_image_t* m_private_image;
 545
 546         /* pointer to the output image (decoded)*/
 547         opj_image_t* m_output_image;
 548
 549         /** Coding parameters */
 550         opj_cp_t m_cp;
 551
 552         /** the list of procedures to exec **/
 553         opj_procedure_list_t *  m_procedure_list;
 554
 555         /** the list of validation procedures to follow to make sure the code is valid **/
 556         opj_procedure_list_t *  m_validation_list;
 557
 558         /** helper used to write the index file */
 559         opj_codestream_index_t *cstr_index;
 560
 561         /** number of the tile curently concern by coding/decoding */
 562         OPJ_UINT32 m_current_tile_number;
 563
 564         /** the current tile coder/decoder **/
 565         struct opj_tcd *        m_tcd;
 566
 567 }
 568 opj_j2k_t;
 569
 570
 571
 572
 573 /** @name Exported functions */
 574 /*@{*/
 575 /* ----------------------------------------------------------------------- */
 576
 577 /**
 578 Setup the decoder decoding parameters using user parameters.
 579 Decoding parameters are returned in j2k->cp.
 580 @param j2k J2K decompressor handle
 581 @param parameters decompression parameters
 582 */
 583 void opj_j2k_setup_decoder(opj_j2k_t *j2k, opj_dparameters_t *parameters);
 584
 585 /**
 586  * Creates a J2K compression structure
 587  *
 588  * @return Returns a handle to a J2K compressor if successful, returns NULL otherwise
 589 */
 590 opj_j2k_t* opj_j2k_create_compress(void);
 591
 592
 593 void opj_j2k_setup_encoder(     opj_j2k_t *p_j2k,
 594                                                     opj_cparameters_t *parameters,
 595                                                     opj_image_t *image,
 596                                                     opj_event_mgr_t * p_manager);
 597
 598 /**
 599 Converts an enum type progression order to string type
 600 */
 601 char *opj_j2k_convert_progression_order(OPJ_PROG_ORDER prg_order);
 602
 603 /* ----------------------------------------------------------------------- */
 604 /*@}*/
 605
 606 /*@}*/
 607
 608 /**
 609  * Ends the decompression procedures and possibiliy add data to be read after the
 610  * codestream.
 611  */
 612 OPJ_BOOL opj_j2k_end_decompress(opj_j2k_t *j2k,
 613                                 opj_stream_private_t *p_stream,
 614                                 opj_event_mgr_t * p_manager);
 615
 616 /**
 617  * Reads a jpeg2000 codestream header structure.
 618  *
 619  * @param p_stream the stream to read data from.
 620  * @param p_j2k the jpeg2000 codec.
 621  * @param p_image FIXME DOC
 622  * @param p_manager the user event manager.
 623  *
 624  * @return true if the box is valid.
 625  */
 626 OPJ_BOOL opj_j2k_read_header(   opj_stream_private_t *p_stream,
 627                                 opj_j2k_t* p_j2k,
 628                                 opj_image_t** p_image,
 629                                 opj_event_mgr_t* p_manager );
 630
 631
 632 /**
 633  * Destroys a jpeg2000 codec.
 634  *
 635  * @param       p_j2k   the jpeg20000 structure to destroy.
 636  */
 637 void opj_j2k_destroy (opj_j2k_t *p_j2k);
 638
 639 /**
 640  * Destroys a codestream index structure.
 641  *
 642  * @param       p_cstr_ind      the codestream index parameter to destroy.
 643  */
 644 void j2k_destroy_cstr_index (opj_codestream_index_t *p_cstr_ind);
 645
 646 /**
 647  * Decode tile data.
 648  * @param       p_j2k           the jpeg2000 codec.
 649  * @param       p_tile_index
 650  * @param p_data       FIXME DOC
 651  * @param p_data_size  FIXME DOC
 652  * @param       p_stream                        the stream to write data to.
 653  * @param       p_manager       the user event manager.
 654  */
 655 OPJ_BOOL opj_j2k_decode_tile (  opj_j2k_t * p_j2k,
 656                                 OPJ_UINT32 p_tile_index,
 657                                 OPJ_BYTE * p_data,
 658                                 OPJ_UINT32 p_data_size,
 659                                 opj_stream_private_t *p_stream,
 660                                 opj_event_mgr_t * p_manager );
 661
 662 /**
 663  * Reads a tile header.
 664  * @param       p_j2k           the jpeg2000 codec.
 665  * @param       p_tile_index FIXME DOC
 666  * @param       p_data_size FIXME DOC
 667  * @param       p_tile_x0 FIXME DOC
 668  * @param       p_tile_y0 FIXME DOC
 669  * @param       p_tile_x1 FIXME DOC
 670  * @param       p_tile_y1 FIXME DOC
 671  * @param       p_nb_comps FIXME DOC
 672  * @param       p_go_on FIXME DOC
 673  * @param       p_stream                        the stream to write data to.
 674  * @param       p_manager       the user event manager.
 675  */
 676 OPJ_BOOL opj_j2k_read_tile_header ( opj_j2k_t * p_j2k,
 677                                     OPJ_UINT32 * p_tile_index,
 678                                     OPJ_UINT32 * p_data_size,
 679                                     OPJ_INT32 * p_tile_x0,
 680                                     OPJ_INT32 * p_tile_y0,
 681                                     OPJ_INT32 * p_tile_x1,
 682                                     OPJ_INT32 * p_tile_y1,
 683                                     OPJ_UINT32 * p_nb_comps,
 684                                     OPJ_BOOL * p_go_on,
 685                                     opj_stream_private_t *p_stream,
 686                                     opj_event_mgr_t * p_manager );
 687
 688
 689 /**
 690  * Sets the given area to be decoded. This function should be called right after opj_read_header and before any tile header reading.
 691  *
 692  * @param       p_j2k                   the jpeg2000 codec.
 693  * @param       p_image     FIXME DOC
 694  * @param       p_start_x               the left position of the rectangle to decode (in image coordinates).
 695  * @param       p_start_y               the up position of the rectangle to decode (in image coordinates).
 696  * @param       p_end_x                 the right position of the rectangle to decode (in image coordinates).
 697  * @param       p_end_y                 the bottom position of the rectangle to decode (in image coordinates).
 698  * @param       p_manager               the user event manager
 699  *
 700  * @return      true                    if the area could be set.
 701  */
 702 OPJ_BOOL opj_j2k_set_decode_area(       opj_j2k_t *p_j2k,
 703                                                                     opj_image_t* p_image,
 704                                                                     OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,
 705                                                                     OPJ_INT32 p_end_x, OPJ_INT32 p_end_y,
 706                                                                     opj_event_mgr_t * p_manager );
 707
 708 /**
 709  * Creates a J2K decompression structure.
 710  *
 711  * @return a handle to a J2K decompressor if successful, NULL otherwise.
 712  */
 713 opj_j2k_t* opj_j2k_create_decompress(void);
 714
 715
 716 /**
 717  * Dump some elements from the J2K decompression structure .
 718  *
 719  *@param p_j2k                          the jpeg2000 codec.
 720  *@param flag                           flag to describe what elments are dump.
 721  *@param out_stream                     output stream where dump the elements.
 722  *
 723 */
 724 void j2k_dump (opj_j2k_t* p_j2k, OPJ_INT32 flag, FILE* out_stream);
 725
 726
 727
 728 /**
 729  * Dump an image header structure.
 730  *
 731  *@param image                  the image header to dump.
 732  *@param dev_dump_flag          flag to describe if we are in the case of this function is use outside j2k_dump function
 733  *@param out_stream                     output stream where dump the elements.
 734  */
 735 void j2k_dump_image_header(opj_image_t* image, OPJ_BOOL dev_dump_flag, FILE* out_stream);
 736
 737 /**
 738  * Dump a component image header structure.
 739  *
 740  *@param comp           the component image header to dump.
 741  *@param dev_dump_flag          flag to describe if we are in the case of this function is use outside j2k_dump function
 742  *@param out_stream                     output stream where dump the elements.
 743  */
 744 void j2k_dump_image_comp_header(opj_image_comp_t* comp, OPJ_BOOL dev_dump_flag, FILE* out_stream);
 745
 746 /**
 747  * Get the codestream info from a JPEG2000 codec.
 748  *
 749  *@param        p_j2k                           the component image header to dump.
 750  *
 751  *@return       the codestream information extract from the jpg2000 codec
 752  */
 753 opj_codestream_info_v2_t* j2k_get_cstr_info(opj_j2k_t* p_j2k);
 754
 755 /**
 756  * Get the codestream index from a JPEG2000 codec.
 757  *
 758  *@param        p_j2k                           the component image header to dump.
 759  *
 760  *@return       the codestream index extract from the jpg2000 codec
 761  */
 762 opj_codestream_index_t* j2k_get_cstr_index(opj_j2k_t* p_j2k);
 763
 764 /**
 765  * Decode an image from a JPEG-2000 codestream
 766  * @param j2k J2K decompressor handle
 767  * @param p_stream  FIXME DOC
 768  * @param p_image   FIXME DOC
 769  * @param p_manager FIXME DOC
 770  * @return FIXME DOC
 771 */
 772 OPJ_BOOL opj_j2k_decode(opj_j2k_t *j2k,
 773                         opj_stream_private_t *p_stream,
 774                         opj_image_t *p_image,
 775                         opj_event_mgr_t *p_manager);
 776
 777
 778 OPJ_BOOL opj_j2k_get_tile(      opj_j2k_t *p_j2k,
 779                                                 opj_stream_private_t *p_stream,
 780                                                 opj_image_t* p_image,
 781                                                 opj_event_mgr_t * p_manager,
 782                                                     OPJ_UINT32 tile_index );
 783
 784 OPJ_BOOL opj_j2k_set_decoded_resolution_factor(opj_j2k_t *p_j2k,
 785                                                OPJ_UINT32 res_factor,
 786                                                opj_event_mgr_t * p_manager);
 787
 788
 789 /**
 790  * Writes a tile.
 791  * @param       p_j2k           the jpeg2000 codec.
 792  * @param p_tile_index FIXME DOC
 793  * @param p_data FIXME DOC
 794  * @param p_data_size FIXME DOC
 795  * @param       p_stream                        the stream to write data to.
 796  * @param       p_manager       the user event manager.
 797  */
 798 OPJ_BOOL opj_j2k_write_tile (   opj_j2k_t * p_j2k,
 799                                                             OPJ_UINT32 p_tile_index,
 800                                                             OPJ_BYTE * p_data,
 801                                                             OPJ_UINT32 p_data_size,
 802                                                             opj_stream_private_t *p_stream,
 803                                                             opj_event_mgr_t * p_manager );
 804
 805 /**
 806  * Encodes an image into a JPEG-2000 codestream
 807  */
 808 OPJ_BOOL opj_j2k_encode(        opj_j2k_t * p_j2k,
 809                                                 opj_stream_private_t *cio,
 810                                                 opj_event_mgr_t * p_manager );
 811
 812 /**
 813  * Starts a compression scheme, i.e. validates the codec parameters, writes the header.
 814  *
 815  * @param       p_j2k           the jpeg2000 codec.
 816  * @param       p_stream                        the stream object.
 817  * @param       p_image FIXME DOC
 818  * @param       p_manager       the user event manager.
 819  *
 820  * @return true if the codec is valid.
 821  */
 822 OPJ_BOOL opj_j2k_start_compress(opj_j2k_t *p_j2k,
 823                                                             opj_stream_private_t *p_stream,
 824                                                             opj_image_t * p_image,
 825                                                             opj_event_mgr_t * p_manager);
 826
 827 /**
 828  * Ends the compression procedures and possibiliy add data to be read after the
 829  * codestream.
 830  */
 831 OPJ_BOOL opj_j2k_end_compress(  opj_j2k_t *p_j2k,
 832                                                             opj_stream_private_t *cio,
 833                                                             opj_event_mgr_t * p_manager);
 834
 835 OPJ_BOOL opj_j2k_setup_mct_encoding (opj_tcp_t * p_tcp, opj_image_t * p_image);
 836
 837
 838 #endif /* __J2K_H */