[trunk] fix warnings when printing large integers
[openjpeg.git] / libopenjpeg / j2k.h
index 0835e09afa8ec736802ff6cd29f8d7d4e9470a14..2ec8980d3d1b2e648a9be00678fa1a49b4570fc1 100644 (file)
@@ -6,6 +6,9 @@
  * Copyright (c) 2003-2007, Francois-Olivier Devaux and 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>
+ *
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -77,15 +80,12 @@ The functions in J2K.C have for goal to read/write the several parts of the code
 #define J2K_MS_EPH 0xff92      /**< EPH marker value */
 #define J2K_MS_CRG 0xff63      /**< CRG marker value */
 #define J2K_MS_COM 0xff64      /**< COM marker value */
-
-#define J2K_MS_UNK 0           /**< UNKNOWN marker value */
-
-#ifdef TODO_MS
 #define J2K_MS_CBD 0xff78      /**< CBD marker value */
 #define J2K_MS_MCC 0xff75      /**< MCC marker value */
 #define J2K_MS_MCT 0xff74      /**< MCT marker value */
 #define J2K_MS_MCO 0xff77      /**< MCO marker value */
-#endif
+
+#define J2K_MS_UNK 0           /**< UNKNOWN marker value */
 
 /* UniPG>> */
 #ifdef USE_JPWL
@@ -100,15 +100,12 @@ The functions in J2K.C have for goal to read/write the several parts of the code
 #endif /* USE_JPSEC */
 /* <<UniPG */
 
-
-struct opj_stream_private;
-
 /* ----------------------------------------------------------------------- */
 
 /**
-Values that specify the status of the decoding process when decoding the main header. 
-These values may be combined with a | operator. 
-*/
+ * Values that specify the status of the decoding process when decoding the main header.
+ * These values may be combined with a | operator.
+ * */
 typedef enum J2K_STATUS {
        J2K_STATE_MHSOC  = 0x0001, /**< a SOC marker is expected */
        J2K_STATE_MHSIZ  = 0x0002, /**< a SIZ marker is expected */
@@ -117,9 +114,32 @@ typedef enum J2K_STATUS {
        J2K_STATE_TPH    = 0x0010, /**< the decoding process is in a tile part header */
        J2K_STATE_MT     = 0x0020, /**< the EOC marker has just been read */
        J2K_STATE_NEOC   = 0x0040, /**< the decoding process must not expect a EOC marker because the codestream is truncated */
-       J2K_STATE_ERR    = 0x0080  /**< the decoding process has encountered an error */
+
+       J2K_STATE_EOC    = 0x0100, /**< the decoding process has encountered the EOC marker */
+       J2K_STATE_ERR    = 0x8000  /**< the decoding process has encountered an error (FIXME warning V1 = 0x0080)*/
 } J2K_STATUS;
 
+/**
+ * Type of elements storing in the MCT data
+ */
+typedef enum MCT_ELEMENT_TYPE
+{
+       MCT_TYPE_INT16 = 0,             /** MCT data is stored as signed shorts*/
+       MCT_TYPE_INT32 = 1,             /** MCT data is stored as signed integers*/
+       MCT_TYPE_FLOAT = 2,             /** MCT data is stored as floats*/
+       MCT_TYPE_DOUBLE = 3             /** MCT data is stored as doubles*/
+} J2K_MCT_ELEMENT_TYPE;
+
+/**
+ * Type of MCT array
+ */
+typedef enum MCT_ARRAY_TYPE
+{
+       MCT_TYPE_DEPENDENCY = 0,
+       MCT_TYPE_DECORRELATION = 1,
+       MCT_TYPE_OFFSET = 2
+} J2K_MCT_ARRAY_TYPE;
+
 /* ----------------------------------------------------------------------- */
 
 /** 
@@ -131,8 +151,8 @@ typedef enum T2_MODE {
 }J2K_T2_MODE;
 
 /**
-Quantization stepsize
-*/
+ * Quantization stepsize
+ */
 typedef struct opj_stepsize {
        /** exponent */
        int expn;
@@ -140,36 +160,6 @@ typedef struct opj_stepsize {
        int mant;
 } opj_stepsize_t;
 
-//OPJ_V1/**
-//Tile-component coding parameters
-//*/
-//typedef struct opj_tccp {
-//     /** coding style */
-//     int csty;
-//     /** number of resolutions */
-//     int numresolutions;
-//     /** code-blocks width */
-//     int cblkw;
-//     /** code-blocks height */
-//     int cblkh;
-//     /** code-block coding style */
-//     int cblksty;
-//     /** discrete wavelet transform identifier */
-//     int qmfbid;
-//     /** quantisation style */
-//     int qntsty;
-//     /** stepsizes used for quantization */
-//     opj_stepsize_t stepsizes[J2K_MAXBANDS];
-//     /** number of guard bits */
-//     int numgbits;
-//     /** Region Of Interest shift */
-//     int roishift;
-//     /** precinct width */
-//     int prcw[J2K_MAXRLVLS];
-//     /** precinct height */
-//     int prch[J2K_MAXRLVLS];
-//} opj_tccp_t;
-
 /**
 Tile-component coding parameters
 */
@@ -205,7 +195,7 @@ typedef struct opj_tccp
 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)
@@ -245,28 +235,9 @@ typedef struct opj_tcp {
        opj_tccp_t *tccps;
 } opj_tcp_t;
 
-
 /**
- * Type of data for storing the MCT data
+ * FIXME DOC
  */
-typedef enum MCT_ELEMENT_TYPE
-{
-       MCT_TYPE_INT16 = 0,             /** MCT data is stored as signed shorts*/
-       MCT_TYPE_INT32 = 1,             /** MCT data is stored as signed integers*/
-       MCT_TYPE_FLOAT = 2,             /** MCT data is stored as floats*/
-       MCT_TYPE_DOUBLE = 3             /** MCT data is stored as doubles*/
-} J2K_MCT_ELEMENT_TYPE;
-
-/**
- * Type of data for storing the MCT data
- */
-typedef enum MCT_ARRAY_TYPE
-{
-       MCT_TYPE_DEPENDENCY = 0,
-       MCT_TYPE_DECORRELATION = 1,
-       MCT_TYPE_OFFSET = 2
-} J2K_MCT_ARRAY_TYPE;
-
 typedef struct opj_mct_data
 {
        J2K_MCT_ELEMENT_TYPE m_element_type;
@@ -277,6 +248,9 @@ typedef struct opj_mct_data
 }
 opj_mct_data_t;
 
+/**
+ * FIXME DOC
+ */
 typedef struct opj_simple_mcc_decorrelation_data
 {
        OPJ_UINT32                       m_index;
@@ -347,7 +321,6 @@ typedef struct opj_tcp_v2
        OPJ_UINT32 m_nb_max_mcc_records;
 
 
-
        /***** FLAGS *******/
        /** If ppt == 1 --> there was a PPT marker for the present tile */
        OPJ_UINT32 ppt : 1;
@@ -359,7 +332,7 @@ typedef struct opj_tcp_v2
 
 
 
-/**
+/** V1 STYLE
 Coding parameters
 */
 typedef struct opj_cp {
@@ -503,8 +476,8 @@ opj_decoding_param_t;
 
 
 /**
-Coding parameters
-*/
+ * Coding parameters
+ */
 typedef struct opj_cp_v2
 {
        /** Size of the image in bits*/
@@ -526,9 +499,6 @@ typedef struct opj_cp_v2
        /** number of tiles in heigth */
        OPJ_UINT32 th;
 
-
-
-
        /** packet header store there for futur use in t2_decode_packet */
        OPJ_BYTE *ppm_data;
        /** size of the ppm_data*/
@@ -551,6 +521,7 @@ typedef struct opj_cp_v2
 
        /** tile coding parameters */
        opj_tcp_v2_t *tcps;
+
        union
        {
                opj_decoding_param_t m_dec;
@@ -562,15 +533,15 @@ typedef struct opj_cp_v2
 /* UniPG>> */
 #ifdef USE_JPWL
        /** enables writing of EPC in MH, thus activating JPWL */
-       bool epc_on;
+       opj_bool epc_on;
        /** enables writing of EPB, in case of activated JPWL */
-       bool epb_on;
+       opj_bool epb_on;
        /** enables writing of ESD, in case of activated JPWL */
-       bool esd_on;
+       opj_bool esd_on;
        /** enables writing of informative techniques of ESD, in case of activated JPWL */
-       bool info_on;
+       opj_bool info_on;
        /** enables writing of RED, in case of activated JPWL */
-       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) */
@@ -596,7 +567,7 @@ typedef struct opj_cp_v2
        /** sensitivity methods for TPHs (-1,0-7) */
        int sens_TPH[JPWL_MAX_NO_TILESPECS];
        /** enables JPWL correction at the decoder */
-       bool correct;
+       opj_bool correct;
        /** expected number of components at the decoder */
        int exp_comps;
        /** maximum number of tiles at the decoder */
@@ -629,6 +600,25 @@ typedef struct opj_j2k_dec
        OPJ_UINT32 m_start_tile_y;
        OPJ_UINT32 m_end_tile_x;
        OPJ_UINT32 m_end_tile_y;
+       /**
+        * Decoded area set by the user
+        */
+       OPJ_UINT32 m_DA_x0;
+       OPJ_UINT32 m_DA_y0;
+       OPJ_UINT32 m_DA_x1;
+       OPJ_UINT32 m_DA_y1;
+
+       /** Index of the tile to decode (used in get_tile) */
+       OPJ_INT32 m_tile_ind_to_dec;
+       /** Position of the last SOT marker read */
+       OPJ_OFF_T m_last_sot_read_pos;
+
+       /**
+        * Indicate that the current tile-part is assume as the last tile part of the codestream.
+        * 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;
        /** to tell that a tile can be decoded. */
        OPJ_UINT32 m_can_decode                 : 1;
        OPJ_UINT32 m_discard_tiles              : 1;
@@ -743,6 +733,10 @@ JPEG-2000 codestream reader/writer
 */
 typedef struct opj_j2k_v2
 {
+       /* J2K codestream is decoded*/
+       opj_bool m_is_decoder;
+
+       /* FIXME DOC*/
        union
        {
                opj_j2k_dec_t m_decoder;
@@ -750,12 +744,11 @@ typedef struct opj_j2k_v2
        }
        m_specific_param;
 
-       /** number of the tile curently concern by coding/decoding */
-       OPJ_UINT32 m_current_tile_number;
+       /** pointer to the internal/private encoded / decoded image */
+       opj_image_t* m_private_image;
 
-       /** pointer to the encoded / decoded image */
-       //opj_image_t *m_image;
-       opj_image_header_t* m_image_header;
+       /* pointer to the output image (decoded)*/
+       opj_image_t* m_output_image;
 
        /** Coding parameters */
        opj_cp_v2_t m_cp;
@@ -767,13 +760,13 @@ typedef struct opj_j2k_v2
        struct opj_procedure_list *     m_validation_list;
 
        /** helper used to write the index file */
-       opj_codestream_info_t *cstr_info;
+       opj_codestream_index_t *cstr_index;
+
+       /** number of the tile curently concern by coding/decoding */
+       OPJ_UINT32 m_current_tile_number;
 
        /** the current tile coder/decoder **/
        struct opj_tcd_v2 *     m_tcd;
-       //opj_tcd_v2_t *        m_tcd;
-
-       OPJ_UINT32 m_is_decoder : 1;
 
 }
 opj_j2k_v2_t;
@@ -884,8 +877,7 @@ opj_bool j2k_end_decompress(opj_j2k_v2_t *j2k, struct opj_stream_private *cio, s
  */
 opj_bool j2k_read_header(      struct opj_stream_private *p_stream,
                                                        opj_j2k_v2_t* p_j2k,
-                                                       struct opj_image_header** image_header,
-                                                       struct opj_codestream_info** cstr_info,
+                                                       opj_image_t** p_image,
                                                        struct opj_event_mgr* p_manager );
 
 
@@ -896,6 +888,13 @@ opj_bool j2k_read_header(  struct opj_stream_private *p_stream,
  */
 void j2k_destroy (opj_j2k_v2_t *p_j2k);
 
+/**
+ * Destroys a codestream index structure.
+ *
+ * @param      p_cstr_ind      the codestream index parameter to destroy.
+ */
+void j2k_destroy_cstr_index (opj_codestream_index_t *p_cstr_ind);
+
 /**
  * Decode tile data.
  * @param      p_j2k           the jpeg2000 codec.
@@ -944,21 +943,85 @@ opj_bool j2k_read_tile_header (
  *
  * @return     true                    if the area could be set.
  */
-opj_bool j2k_set_decode_area(
-                       opj_j2k_v2_t *p_j2k,
-                       OPJ_INT32 p_start_x,
-                       OPJ_INT32 p_start_y,
-                       OPJ_INT32 p_end_x,
-                       OPJ_INT32 p_end_y,
-                       struct opj_event_mgr * p_manager
-                       );
+opj_bool j2k_set_decode_area(  opj_j2k_v2_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,
+                                                               struct opj_event_mgr * p_manager );
 
 /**
  * Creates a J2K decompression structure.
  *
  * @return a handle to a J2K decompressor if successful, NULL otherwise.
-*/
+ */
 opj_j2k_v2_t* j2k_create_decompress_v2();
 
 
+/**
+ * Dump some elements from the J2K decompression structure .
+ *
+ *@param p_j2k                         the jpeg2000 codec.
+ *@param flag                          flag to describe what elments are dump.
+ *@param out_stream                    output stream where dump the elements.
+ *
+*/
+void j2k_dump (opj_j2k_v2_t* p_j2k, OPJ_INT32 flag, FILE* out_stream);
+
+
+
+/**
+ * Dump an image header structure.
+ *
+ *@param img_header                    the image header to dump.
+ *@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);
+
+/**
+ * Dump a component image header structure.
+ *
+ *@param comp_header           the component image header to dump.
+ *@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);
+
+/**
+ * Get the codestream info from a JPEG2000 codec.
+ *
+ *@param       p_j2k                           the component image header to dump.
+ *
+ *@return      the codestream information extract from the jpg2000 codec
+ */
+opj_codestream_info_v2_t* j2k_get_cstr_info(opj_j2k_v2_t* p_j2k);
+
+/**
+ * Get the codestream index from a JPEG2000 codec.
+ *
+ *@param       p_j2k                           the component image header to dump.
+ *
+ *@return      the codestream index extract from the jpg2000 codec
+ */
+opj_codestream_index_t* j2k_get_cstr_index(opj_j2k_v2_t* p_j2k);
+
+/**
+ * Decode an image from a JPEG-2000 codestream
+ * @param j2k J2K decompressor handle
+ * @param cio Input buffer stream
+ * @param cstr_info Codestream information structure if required, NULL otherwise
+ * @return Returns a decoded image if successful, returns NULL otherwise
+*/
+opj_bool j2k_decode_v2(opj_j2k_v2_t *j2k, struct opj_stream_private *cio, opj_image_t* p_image, opj_event_mgr_t * p_manager);
+
+
+opj_bool j2k_get_tile( opj_j2k_v2_t *p_j2k,
+                                               opj_stream_private_t *p_stream,
+                                               opj_image_t* p_image,
+                                               struct opj_event_mgr * p_manager,
+                                               OPJ_UINT32 tile_index );
+
+opj_bool j2k_set_decoded_resolution_factor(opj_j2k_v2_t *p_j2k, OPJ_UINT32 res_factor, opj_event_mgr_t * p_manager);
+
+
 #endif /* __J2K_H */