Merge pull request #636 from uclouvain/opj_malloc-625
[openjpeg.git] / src / lib / openjp2 / j2k.h
index 0087dc1d44125f746c18f61e4fb0d24ba5b9e0b1..358e0739652c0b96481f6c23100c4768cef4c6a6 100644 (file)
@@ -1,13 +1,20 @@
 /*
- * Copyright (c) 2002-2007, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
- * Copyright (c) 2002-2007, Professor Benoit Macq
+ * The copyright in this software is being made available under the 2-clauses 
+ * BSD License, included below. This software may be subject to other third 
+ * party and contributor rights, including patent rights, and no such rights
+ * are granted under this license.
+ *
+ * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
+ * Copyright (c) 2002-2014, Professor Benoit Macq
  * Copyright (c) 2001-2003, David Janssens
  * Copyright (c) 2002-2003, Yannick Verschueren
- * Copyright (c) 2003-2007, Francois-Olivier Devaux and Antonin Descampe
+ * Copyright (c) 2003-2007, Francois-Olivier Devaux 
+ * Copyright (c) 2003-2014, Antonin Descampe
  * Copyright (c) 2005, Herve Drolon, FreeImage Team
  * Copyright (c) 2006-2007, Parvatha Elangovan
  * Copyright (c) 2008, Jerome Fimes, Communications & Systemes <jerome.fimes@c-s.fr>
- * Copyright (c) 2011, Mickael Savinaud, Communications & Systemes <mickael.savinaud@c-s.fr>
+ * Copyright (c) 2011-2012, Centre National d'Etudes Spatiales (CNES), France 
+ * Copyright (c) 2012, CS Systemes d'Information, France
  *
  * All rights reserved.
  *
@@ -58,6 +65,8 @@ The functions in J2K.C have for goal to read/write the several parts of the code
 #define J2K_CCP_QNTSTY_SIQNT 1
 #define J2K_CCP_QNTSTY_SEQNT 2
 
+#define OPJ_J2K_DEFAULT_CBLK_DATA_SIZE 8192
+
 /* ----------------------------------------------------------------------- */
 
 #define J2K_MS_SOC 0xff4f      /**< SOC marker value */
@@ -156,9 +165,9 @@ typedef enum T2_MODE {
  */
 typedef struct opj_stepsize {
        /** exponent */
-       int expn;
+       OPJ_INT32 expn;
        /** mantissa */
-       int mant;
+       OPJ_INT32 mant;
 } opj_stepsize_t;
 
 /**
@@ -223,6 +232,12 @@ typedef struct opj_simple_mcc_decorrelation_data
 }
 opj_simple_mcc_decorrelation_data_t;
 
+typedef struct opj_ppx_struct
+{
+       OPJ_BYTE*   m_data; /* m_data == NULL => Zppx not read yet */
+       OPJ_UINT32      m_data_size;
+} opj_ppx;
+
 /**
 Tile coding parameters :
 this structure is used to store coding/decoding parameters common to all
@@ -245,7 +260,13 @@ typedef struct opj_tcp
        OPJ_UINT32 numpocs;
        /** progression order changes */
        opj_poc_t pocs[32];
-       /** packet header store there for futur use in t2_decode_packet */
+       
+       /** number of ppt markers (reserved size) */
+       OPJ_UINT32 ppt_markers_count;
+       /** ppt markers data (table indexed by Zppt) */
+       opj_ppx* ppt_markers;
+       
+       /** packet header store there for future use in t2_decode_packet */
        OPJ_BYTE *ppt_data;
        /** used to keep a track of the allocated memory */
        OPJ_BYTE *ppt_buffer;
@@ -284,6 +305,8 @@ typedef struct opj_tcp
 
 
        /***** FLAGS *******/
+       /** If cod == 1 --> there was a COD marker for the present tile */
+       OPJ_UINT32 cod : 1;
        /** If ppt == 1 --> there was a PPT marker for the present tile */
        OPJ_UINT32 ppt : 1;
        /** indicates if a POC marker has been used O:NO, 1:YES */
@@ -295,8 +318,6 @@ typedef struct opj_tcp
 
 typedef struct opj_encoding_param
 {
-       /** Digital cinema profile*/
-       OPJ_CINEMA_MODE m_cinema;
        /** Maximum rate for each component. If == 0, component size limitation is not considered */
        OPJ_UINT32 m_max_comp_size;
        /** Position of tile part flag in progression order*/
@@ -334,7 +355,7 @@ typedef struct opj_cp
        /** Size of the image in bits*/
        /*int img_size;*/
        /** Rsiz*/
-       OPJ_RSIZ_CAPABILITIES rsiz;
+    OPJ_UINT16 rsiz;
        /** XTOsiz */
        OPJ_UINT32 tx0; /* MSD see norm */
        /** YTOsiz */
@@ -350,7 +371,12 @@ typedef struct opj_cp
        /** number of tiles in heigth */
        OPJ_UINT32 th;
 
-       /** packet header store there for futur use in t2_decode_packet */
+       /** number of ppm markers (reserved size) */
+       OPJ_UINT32 ppm_markers_count;
+       /** ppm markers data (table indexed by Zppm) */
+       opj_ppx* ppm_markers;
+       
+       /** packet header store there for future use in t2_decode_packet */
        OPJ_BYTE *ppm_data;
        /** size of the ppm_data*/
        OPJ_UINT32 ppm_len;
@@ -384,15 +410,15 @@ typedef struct opj_cp
 /* UniPG>> */
 #ifdef USE_JPWL
        /** enables writing of EPC in MH, thus activating JPWL */
-       opj_bool epc_on;
+       OPJ_BOOL epc_on;
        /** enables writing of EPB, in case of activated JPWL */
-       opj_bool epb_on;
+       OPJ_BOOL epb_on;
        /** enables writing of ESD, in case of activated JPWL */
-       opj_bool esd_on;
+       OPJ_BOOL esd_on;
        /** enables writing of informative techniques of ESD, in case of activated JPWL */
-       opj_bool info_on;
+       OPJ_BOOL info_on;
        /** enables writing of RED, in case of activated JPWL */
-       opj_bool red_on;
+       OPJ_BOOL red_on;
        /** error protection method for MH (0,1,16,32,37-128) */
        int hprot_MH;
        /** tile number of header protection specification (>=0) */
@@ -418,7 +444,7 @@ typedef struct opj_cp
        /** sensitivity methods for TPHs (-1,0-7) */
        int sens_TPH[JPWL_MAX_NO_TILESPECS];
        /** enables JPWL correction at the decoder */
-       opj_bool correct;
+       OPJ_BOOL correct;
        /** expected number of components at the decoder */
        int exp_comps;
        /** maximum number of tiles at the decoder */
@@ -469,11 +495,14 @@ typedef struct opj_j2k_dec
         * It is useful in the case of PSot is equal to zero. The sot length will be compute in the
         * SOD reader function. FIXME NOT USED for the moment
         */
-       opj_bool   m_last_tile_part;
+       OPJ_BOOL   m_last_tile_part;
        /** to tell that a tile can be decoded. */
        OPJ_UINT32 m_can_decode                 : 1;
        OPJ_UINT32 m_discard_tiles              : 1;
        OPJ_UINT32 m_skip_data                  : 1;
+       /** TNsot correction : see issue 254 **/
+       OPJ_UINT32 m_nb_tile_parts_correction_checked : 1;
+       OPJ_UINT32 m_nb_tile_parts_correction : 1;
 
 } opj_j2k_dec_t;
 
@@ -527,7 +556,7 @@ JPEG-2000 codestream reader/writer
 typedef struct opj_j2k
 {
        /* J2K codestream is decoded*/
-       opj_bool m_is_decoder;
+       OPJ_BOOL m_is_decoder;
 
        /* FIXME DOC*/
        union
@@ -560,7 +589,6 @@ typedef struct opj_j2k
 
        /** the current tile coder/decoder **/
        struct opj_tcd *        m_tcd;
-
 }
 opj_j2k_t;
 
@@ -587,7 +615,7 @@ void opj_j2k_setup_decoder(opj_j2k_t *j2k, opj_dparameters_t *parameters);
 opj_j2k_t* opj_j2k_create_compress(void);
 
 
-void opj_j2k_setup_encoder(    opj_j2k_t *p_j2k,
+OPJ_BOOL opj_j2k_setup_encoder(        opj_j2k_t *p_j2k,
                                                    opj_cparameters_t *parameters,
                                                    opj_image_t *image,
                                                    opj_event_mgr_t * p_manager);
@@ -606,7 +634,7 @@ char *opj_j2k_convert_progression_order(OPJ_PROG_ORDER prg_order);
  * Ends the decompression procedures and possibiliy add data to be read after the
  * codestream.
  */
-opj_bool opj_j2k_end_decompress(opj_j2k_t *j2k,
+OPJ_BOOL opj_j2k_end_decompress(opj_j2k_t *j2k,
                                 opj_stream_private_t *p_stream,
                                 opj_event_mgr_t * p_manager);
 
@@ -620,7 +648,7 @@ opj_bool opj_j2k_end_decompress(opj_j2k_t *j2k,
  *
  * @return true if the box is valid.
  */
-opj_bool opj_j2k_read_header(  opj_stream_private_t *p_stream,
+OPJ_BOOL opj_j2k_read_header(  opj_stream_private_t *p_stream,
                                 opj_j2k_t* p_j2k,
                                 opj_image_t** p_image,
                                 opj_event_mgr_t* p_manager );
@@ -649,7 +677,7 @@ void j2k_destroy_cstr_index (opj_codestream_index_t *p_cstr_ind);
  * @param      p_stream                        the stream to write data to.
  * @param      p_manager       the user event manager.
  */
-opj_bool opj_j2k_decode_tile (  opj_j2k_t * p_j2k,
+OPJ_BOOL opj_j2k_decode_tile (  opj_j2k_t * p_j2k,
                                 OPJ_UINT32 p_tile_index,
                                 OPJ_BYTE * p_data,
                                 OPJ_UINT32 p_data_size,
@@ -670,7 +698,7 @@ opj_bool opj_j2k_decode_tile (  opj_j2k_t * p_j2k,
  * @param      p_stream                        the stream to write data to.
  * @param      p_manager       the user event manager.
  */
-opj_bool opj_j2k_read_tile_header ( opj_j2k_t * p_j2k,
+OPJ_BOOL opj_j2k_read_tile_header ( opj_j2k_t * p_j2k,
                                     OPJ_UINT32 * p_tile_index,
                                     OPJ_UINT32 * p_data_size,
                                     OPJ_INT32 * p_tile_x0,
@@ -678,7 +706,7 @@ opj_bool opj_j2k_read_tile_header ( opj_j2k_t * p_j2k,
                                     OPJ_INT32 * p_tile_x1,
                                     OPJ_INT32 * p_tile_y1,
                                     OPJ_UINT32 * p_nb_comps,
-                                    opj_bool * p_go_on,
+                                    OPJ_BOOL * p_go_on,
                                     opj_stream_private_t *p_stream,
                                     opj_event_mgr_t * p_manager );
 
@@ -696,7 +724,7 @@ opj_bool opj_j2k_read_tile_header ( opj_j2k_t * p_j2k,
  *
  * @return     true                    if the area could be set.
  */
-opj_bool opj_j2k_set_decode_area(      opj_j2k_t *p_j2k,
+OPJ_BOOL opj_j2k_set_decode_area(      opj_j2k_t *p_j2k,
                                                                    opj_image_t* p_image,
                                                                    OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,
                                                                    OPJ_INT32 p_end_x, OPJ_INT32 p_end_y,
@@ -729,7 +757,7 @@ void j2k_dump (opj_j2k_t* p_j2k, OPJ_INT32 flag, FILE* out_stream);
  *@param dev_dump_flag         flag to describe if we are in the case of this function is use outside j2k_dump function
  *@param out_stream                    output stream where dump the elements.
  */
-void j2k_dump_image_header(opj_image_t* image, opj_bool dev_dump_flag, FILE* out_stream);
+void j2k_dump_image_header(opj_image_t* image, OPJ_BOOL dev_dump_flag, FILE* out_stream);
 
 /**
  * Dump a component image header structure.
@@ -738,7 +766,7 @@ void j2k_dump_image_header(opj_image_t* image, opj_bool dev_dump_flag, FILE* out
  *@param dev_dump_flag         flag to describe if we are in the case of this function is use outside j2k_dump function
  *@param out_stream                    output stream where dump the elements.
  */
-void j2k_dump_image_comp_header(opj_image_comp_t* comp, opj_bool dev_dump_flag, FILE* out_stream);
+void j2k_dump_image_comp_header(opj_image_comp_t* comp, OPJ_BOOL dev_dump_flag, FILE* out_stream);
 
 /**
  * Get the codestream info from a JPEG2000 codec.
@@ -766,19 +794,19 @@ opj_codestream_index_t* j2k_get_cstr_index(opj_j2k_t* p_j2k);
  * @param p_manager FIXME DOC
  * @return FIXME DOC
 */
-opj_bool opj_j2k_decode(opj_j2k_t *j2k,
+OPJ_BOOL opj_j2k_decode(opj_j2k_t *j2k,
                         opj_stream_private_t *p_stream,
                         opj_image_t *p_image,
                         opj_event_mgr_t *p_manager);
 
 
-opj_bool opj_j2k_get_tile(     opj_j2k_t *p_j2k,
+OPJ_BOOL opj_j2k_get_tile(     opj_j2k_t *p_j2k,
                                                opj_stream_private_t *p_stream,
                                                opj_image_t* p_image,
                                                opj_event_mgr_t * p_manager,
                                                    OPJ_UINT32 tile_index );
 
-opj_bool opj_j2k_set_decoded_resolution_factor(opj_j2k_t *p_j2k, 
+OPJ_BOOL opj_j2k_set_decoded_resolution_factor(opj_j2k_t *p_j2k, 
                                                OPJ_UINT32 res_factor,
                                                opj_event_mgr_t * p_manager);
 
@@ -792,7 +820,7 @@ opj_bool opj_j2k_set_decoded_resolution_factor(opj_j2k_t *p_j2k,
  * @param      p_stream                        the stream to write data to.
  * @param      p_manager       the user event manager.
  */
-opj_bool opj_j2k_write_tile (  opj_j2k_t * p_j2k,
+OPJ_BOOL opj_j2k_write_tile (  opj_j2k_t * p_j2k,
                                                            OPJ_UINT32 p_tile_index,
                                                            OPJ_BYTE * p_data,
                                                            OPJ_UINT32 p_data_size,
@@ -802,7 +830,7 @@ opj_bool opj_j2k_write_tile (       opj_j2k_t * p_j2k,
 /**
  * Encodes an image into a JPEG-2000 codestream
  */
-opj_bool opj_j2k_encode_v2(    opj_j2k_t * p_j2k,
+OPJ_BOOL opj_j2k_encode(       opj_j2k_t * p_j2k,
                                                opj_stream_private_t *cio,
                                                opj_event_mgr_t * p_manager );
 
@@ -816,7 +844,7 @@ opj_bool opj_j2k_encode_v2( opj_j2k_t * p_j2k,
  *
  * @return true if the codec is valid.
  */
-opj_bool opj_j2k_start_compress(opj_j2k_t *p_j2k,
+OPJ_BOOL opj_j2k_start_compress(opj_j2k_t *p_j2k,
                                                            opj_stream_private_t *p_stream,
                                                            opj_image_t * p_image,
                                                            opj_event_mgr_t * p_manager);
@@ -825,11 +853,11 @@ opj_bool opj_j2k_start_compress(opj_j2k_t *p_j2k,
  * Ends the compression procedures and possibiliy add data to be read after the
  * codestream.
  */
-opj_bool opj_j2k_end_compress(         opj_j2k_t *p_j2k,
+OPJ_BOOL opj_j2k_end_compress(         opj_j2k_t *p_j2k,
                                                            opj_stream_private_t *cio,
                                                            opj_event_mgr_t * p_manager);
 
-opj_bool opj_j2k_setup_mct_encoding (opj_tcp_t * p_tcp, opj_image_t * p_image);
+OPJ_BOOL opj_j2k_setup_mct_encoding (opj_tcp_t * p_tcp, opj_image_t * p_image);
 
 
 #endif /* __J2K_H */