[trunk] remove all api with invalid FILE* parameters which could leads to issues...
[openjpeg.git] / src / lib / openjp2 / j2k.h
index 5287b1f25aad387f18c0a52e419a054a9eeccdb8..22d38762409d8c97ba0a7c4f94e6b7137565b40c 100644 (file)
@@ -7,7 +7,8 @@
  * 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 +59,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 +159,9 @@ typedef enum T2_MODE {
  */
 typedef struct opj_stepsize {
        /** exponent */
-       int expn;
+       OPJ_INT32 expn;
        /** mantissa */
-       int mant;
+       OPJ_INT32 mant;
 } opj_stepsize_t;
 
 /**
@@ -181,60 +184,21 @@ typedef struct opj_tccp
        /** quantisation style */
        OPJ_UINT32 qntsty;
        /** stepsizes used for quantization */
-       opj_stepsize_t stepsizes[J2K_MAXBANDS];
+       opj_stepsize_t stepsizes[OPJ_J2K_MAXBANDS];
        /** number of guard bits */
        OPJ_UINT32 numgbits;
        /** Region Of Interest shift */
        OPJ_INT32 roishift;
        /** precinct width */
-       OPJ_UINT32 prcw[J2K_MAXRLVLS];
+       OPJ_UINT32 prcw[OPJ_J2K_MAXRLVLS];
        /** precinct height */
-       OPJ_UINT32 prch[J2K_MAXRLVLS];
+       OPJ_UINT32 prch[OPJ_J2K_MAXRLVLS];
        /** the dc_level_shift **/
        OPJ_INT32 m_dc_level_shift;
 }
 opj_tccp_t;
 
 
-/** V1 STYLE
-Tile coding parameters : 
-this structure is used to store coding/decoding parameters common to all
-tiles (information like COD, COC in main header)
-*/
-typedef struct opj_tcp {
-       /** 1 : first part-tile of a tile */
-       int first;
-       /** coding style */
-       int csty;
-       /** progression order */
-       OPJ_PROG_ORDER prg;
-       /** number of layers */
-       int numlayers;
-       /** multi-component transform identifier */
-       int mct;
-       /** rates of layers */
-       float rates[100];
-       /** number of progression order changes */
-       int numpocs;
-       /** indicates if a POC marker has been used O:NO, 1:YES */
-       int POC;
-       /** progression order changes */
-       opj_poc_t pocs[32];
-       /** packet header store there for futur use in t2_decode_packet */
-       unsigned char *ppt_data;
-       /** pointer remaining on the first byte of the first header if ppt is used */
-       unsigned char *ppt_data_first;
-       /** If ppt == 1 --> there was a PPT marker for the present tile */
-       int ppt;
-       /** used in case of multiple marker PPT (number of info already stored) */
-       int ppt_store;
-       /** ppmbug1 */
-       int ppt_len;
-       /** add fixed_quality */
-       float distoratio[100];
-       /** tile-component coding parameters */
-       opj_tccp_t *tccps;
-} opj_tcp_t;
 
 /**
  * FIXME DOC
@@ -267,7 +231,7 @@ Tile coding parameters :
 this structure is used to store coding/decoding parameters common to all
 tiles (information like COD, COC in main header)
 */
-typedef struct opj_tcp_v2
+typedef struct opj_tcp
 {
        /** coding style */
        OPJ_UINT32 csty;
@@ -327,7 +291,7 @@ typedef struct opj_tcp_v2
        OPJ_UINT32 ppt : 1;
        /** indicates if a POC marker has been used O:NO, 1:YES */
        OPJ_UINT32 POC : 1;
-} opj_tcp_v2_t;
+} opj_tcp_t;
 
 
 
@@ -410,7 +374,7 @@ typedef struct opj_cp
        OPJ_INT32 ppm_previous;
 
        /** tile coding parameters */
-       opj_tcp_v2_t *tcps;
+       opj_tcp_t *tcps;
 
        union
        {
@@ -423,15 +387,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) */
@@ -457,7 +421,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 */
@@ -480,7 +444,7 @@ typedef struct opj_j2k_dec
        /**
         * store decoding parameters common to all tiles (information like COD, COC in main header)
         */
-       opj_tcp_v2_t *m_default_tcp;
+       opj_tcp_t *m_default_tcp;
        OPJ_BYTE  *m_header_data;
        OPJ_UINT32 m_header_data_size;
        /** to tell the tile part length */
@@ -508,7 +472,7 @@ 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;
@@ -566,7 +530,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
@@ -645,7 +609,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);
 
@@ -659,7 +623,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 );
@@ -688,7 +652,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,
@@ -709,7 +673,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,
@@ -717,7 +681,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 );
 
@@ -735,7 +699,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,
@@ -768,7 +732,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.
@@ -777,7 +741,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.
@@ -805,19 +769,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);
 
@@ -831,7 +795,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,
@@ -841,7 +805,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 );
 
@@ -855,7 +819,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);
@@ -864,11 +828,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_v2_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 */