enable all progression orders
[openjpeg.git] / libopenjpeg / j2k.h
index 82cceec1cb9ddb6fcd7b0f5c8b1ac66e39aa5024..5ff07f5e76c57410ac0a5207b1d5ec2505c84900 100644 (file)
@@ -77,15 +77,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
@@ -122,6 +119,27 @@ typedef enum J2K_STATUS {
        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;
+
 /* ----------------------------------------------------------------------- */
 
 /** 
@@ -247,28 +265,9 @@ typedef struct opj_tcp {
        opj_tccp_t *tccps;
 } opj_tcp_t;
 
-
-/**
- * Type of data for storing 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 data for storing the MCT data
+ * FIXME DOC
  */
-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;
@@ -279,6 +278,9 @@ typedef struct opj_mct_data
 }
 opj_mct_data_t;
 
+/**
+ * FIXME DOC
+ */
 typedef struct opj_simple_mcc_decorrelation_data
 {
        OPJ_UINT32                       m_index;
@@ -553,6 +555,7 @@ typedef struct opj_cp_v2
 
        /** tile coding parameters */
        opj_tcp_v2_t *tcps;
+
        union
        {
                opj_decoding_param_t m_dec;
@@ -564,15 +567,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) */
@@ -598,7 +601,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 */
@@ -631,6 +634,12 @@ typedef struct opj_j2k_dec
        OPJ_UINT32 m_start_tile_y;
        OPJ_UINT32 m_end_tile_x;
        OPJ_UINT32 m_end_tile_y;
+       /**
+        * 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;
@@ -745,6 +754,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;
@@ -752,12 +765,9 @@ 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 encoded / decoded image */
        //opj_image_t *m_image;
-       opj_image_header_t* m_image_header;
+       opj_image_t* m_image;
 
        /** Coding parameters */
        opj_cp_v2_t m_cp;
@@ -769,13 +779,16 @@ typedef struct opj_j2k_v2
        struct opj_procedure_list *     m_validation_list;
 
        /** helper used to write the index file */
-       opj_codestream_info_v2_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;
@@ -886,7 +899,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,
-                                                       opj_file_info_t * p_file_info,
+                                                       opj_image_t** p_image,
                                                        struct opj_event_mgr* p_manager );
 
 
@@ -945,21 +958,75 @@ 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_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);
+
+
 #endif /* __J2K_H */