Revert "OpenJPEG: update to 2.1 from 1.5"
[blender.git] / extern / libopenjpeg / jp2.h
index c11d2f3135f489f066c2ccd2cf0a83bf9845ce98..acb643cad77581a79e3f6d1b9a3d1f36798d8e3d 100644 (file)
@@ -1,15 +1,8 @@
 /*
- * 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) 2002-2007, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
+ * Copyright (c) 2002-2007, Professor Benoit Macq
  * Copyright (c) 2002-2003, Yannick Verschueren
  * Copyright (c) 2005, Herve Drolon, FreeImage Team
- * Copyright (c) 2008, 2011-2012, Centre National d'Etudes Spatiales (CNES), FR 
- * Copyright (c) 2012, CS Systemes d'Information, France
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
 /** @defgroup JP2 JP2 - JPEG-2000 file format reader/writer */
 /*@{*/
 
-/*#define JPIP_JPIP 0x6a706970*/
-
-#define     JP2_JP   0x6a502020    /**< JPEG 2000 signature box */
-#define     JP2_FTYP 0x66747970    /**< File type box */
-#define     JP2_JP2H 0x6a703268    /**< JP2 header box (super-box) */
-#define     JP2_IHDR 0x69686472    /**< Image header box */
-#define     JP2_COLR 0x636f6c72    /**< Colour specification box */
-#define     JP2_JP2C 0x6a703263    /**< Contiguous codestream box */
-#define     JP2_URL  0x75726c20    /**< Data entry URL box */
-#define     JP2_PCLR 0x70636c72    /**< Palette box */
-#define     JP2_CMAP 0x636d6170    /**< Component Mapping box */
-#define     JP2_CDEF 0x63646566    /**< Channel Definition box */
-#define     JP2_DTBL 0x6474626c    /**< Data Reference box */
-#define     JP2_BPCC 0x62706363    /**< Bits per component box */
-#define     JP2_JP2  0x6a703220    /**< File type fields */
-
-/* For the future */
-/* #define JP2_RES 0x72657320 */  /**< Resolution box (super-box) */
-/* #define JP2_JP2I 0x6a703269 */  /**< Intellectual property box */
-/* #define JP2_XML  0x786d6c20 */  /**< XML box */
-/* #define JP2_UUID 0x75756994 */  /**< UUID box */
-/* #define JP2_UINF 0x75696e66 */  /**< UUID info box (super-box) */
-/* #define JP2_ULST 0x756c7374 */  /**< UUID list box */
+#define JPIP_JPIP 0x6a706970
+
+#define JP2_JP   0x6a502020            /**< JPEG 2000 signature box */
+#define JP2_FTYP 0x66747970            /**< File type box */
+#define JP2_JP2H 0x6a703268            /**< JP2 header box */
+#define JP2_IHDR 0x69686472            /**< Image header box */
+#define JP2_COLR 0x636f6c72            /**< Colour specification box */
+#define JP2_JP2C 0x6a703263            /**< Contiguous codestream box */
+#define JP2_URL  0x75726c20            /**< URL box */
+#define JP2_DTBL 0x6474626c            /**< Data Reference box */
+#define JP2_BPCC 0x62706363            /**< Bits per component box */
+#define JP2_JP2  0x6a703220            /**< File type fields */
+#define JP2_PCLR 0x70636c72            /**< Palette box */
+#define JP2_CMAP 0x636d6170            /**< Component Mapping box */
+#define JP2_CDEF 0x63646566            /**< Channel Definition box */
 
 /* ----------------------------------------------------------------------- */
-
-typedef enum
-{
-  JP2_STATE_NONE            = 0x0,
-  JP2_STATE_SIGNATURE       = 0x1,
-  JP2_STATE_FILE_TYPE       = 0x2,
-  JP2_STATE_HEADER          = 0x4,
-  JP2_STATE_CODESTREAM      = 0x8,
-  JP2_STATE_END_CODESTREAM  = 0x10,
-  JP2_STATE_UNKNOWN         = 0x7fffffff /* ISO C restricts enumerator values to range of 'int' */
-}
-JP2_STATE;
-
-typedef enum
-{
-  JP2_IMG_STATE_NONE        = 0x0,
-  JP2_IMG_STATE_UNKNOWN     = 0x7fffffff
-}
-JP2_IMG_STATE;
-
 /** 
 Channel description: channel index, type, assocation
 */
 typedef struct opj_jp2_cdef_info
 {
-    OPJ_UINT16 cn, typ, asoc;
+    unsigned short cn, typ, asoc;
 } opj_jp2_cdef_info_t;
 
 /** 
@@ -103,7 +68,7 @@ Channel descriptions and number of descriptions
 typedef struct opj_jp2_cdef
 {
     opj_jp2_cdef_info_t *info;
-    OPJ_UINT16 n;
+    unsigned short n;
 } opj_jp2_cdef_t;
 
 /** 
@@ -111,8 +76,8 @@ Component mappings: channel index, mapping type, palette index
 */
 typedef struct opj_jp2_cmap_comp
 {
-    OPJ_UINT16 cmp;
-    OPJ_BYTE mtyp, pcol;
+    unsigned short cmp;
+    unsigned char mtyp, pcol;
 } opj_jp2_cmap_comp_t;
 
 /** 
@@ -120,12 +85,11 @@ Palette data: table entries, palette columns
 */
 typedef struct opj_jp2_pclr
 {
-    OPJ_UINT32 *entries;
-    OPJ_BYTE *channel_sign;
-    OPJ_BYTE *channel_size;
+    unsigned int *entries;
+    unsigned char *channel_sign;
+    unsigned char *channel_size;
     opj_jp2_cmap_comp_t *cmap;
-    OPJ_UINT16 nr_entries;
-    OPJ_BYTE nr_channels;
+    unsigned short nr_entries, nr_channels;
 } opj_jp2_pclr_t;
 
 /** 
@@ -133,360 +97,135 @@ Collector for ICC profile, palette, component mapping, channel description
 */
 typedef struct opj_jp2_color
 {
-    OPJ_BYTE *icc_profile_buf;
-    OPJ_UINT32 icc_profile_len;
+    unsigned char *icc_profile_buf;
+    int icc_profile_len;
 
     opj_jp2_cdef_t *jp2_cdef;
     opj_jp2_pclr_t *jp2_pclr;
-    OPJ_BYTE jp2_has_colr;
+    unsigned char jp2_has_colr;
 } opj_jp2_color_t;
 
 /** 
 JP2 component
 */
 typedef struct opj_jp2_comps {
-  OPJ_UINT32 depth;      
-  OPJ_UINT32 sgnd;       
-  OPJ_UINT32 bpcc;
+  int depth;             
+  int sgnd;               
+  int bpcc;
 } opj_jp2_comps_t;
 
 /**
 JPEG-2000 file format reader/writer
 */
-typedef struct opj_jp2
-{
-  /** handle to the J2K codec  */
-  opj_j2k_t *j2k;
-  /** list of validation procedures */
-  struct opj_procedure_list * m_validation_list;
-  /** list of execution procedures */
-  struct opj_procedure_list * m_procedure_list;
-
-  /* width of image */
-  OPJ_UINT32 w;
-  /* height of image */
-  OPJ_UINT32 h;
-  /* number of components in the image */
-  OPJ_UINT32 numcomps;
-  OPJ_UINT32 bpc;
-  OPJ_UINT32 C;
-  OPJ_UINT32 UnkC;
-  OPJ_UINT32 IPR;
-  OPJ_UINT32 meth;
-  OPJ_UINT32 approx;
-  OPJ_UINT32 enumcs;
-  OPJ_UINT32 precedence;
-  OPJ_UINT32 brand;
-  OPJ_UINT32 minversion;
-  OPJ_UINT32 numcl;
-  OPJ_UINT32 *cl;
-  opj_jp2_comps_t *comps;
-  /* FIXME: The following two variables are used to save offset
-    as we write out a JP2 file to disk. This mecanism is not flexible
-    as codec writers will need to extand those fields as new part
-    of the standard are implemented.
-  */
-    OPJ_OFF_T j2k_codestream_offset;
-    OPJ_OFF_T jpip_iptr_offset;
-       OPJ_BOOL jpip_on;
-  OPJ_UINT32 jp2_state;
-  OPJ_UINT32 jp2_img_state;
-
-  opj_jp2_color_t color;
-    
-    OPJ_BOOL ignore_pclr_cmap_cdef;
-}
-opj_jp2_t;
+typedef struct opj_jp2 {
+       /** codec context */
+       opj_common_ptr cinfo;
+       /** handle to the J2K codec  */
+       opj_j2k_t *j2k;
+       unsigned int w;
+       unsigned int h;
+       unsigned int numcomps;
+       unsigned int bpc;
+       unsigned int C;
+       unsigned int UnkC;
+       unsigned int IPR;
+       unsigned int meth;
+       unsigned int approx;
+       unsigned int enumcs;
+       unsigned int precedence;
+       unsigned int brand;
+       unsigned int minversion;
+       unsigned int numcl;
+       unsigned int *cl;
+       opj_jp2_comps_t *comps;
+       unsigned int j2k_codestream_offset;
+       unsigned int j2k_codestream_length;
+       opj_bool jpip_on;
+       opj_bool ignore_pclr_cmap_cdef;
+} opj_jp2_t;
 
 /**
 JP2 Box
 */
 typedef struct opj_jp2_box {
-    OPJ_UINT32 length;
-    OPJ_UINT32 type;
-    OPJ_INT32 init_pos;
+  int length;
+  int type;
+  int init_pos;
 } opj_jp2_box_t;
 
-typedef struct opj_jp2_header_handler
-{
-  /* marker value */
-  OPJ_UINT32 id;
-  /* action linked to the marker */
-  OPJ_BOOL (*handler) (     opj_jp2_t *jp2, 
-                            OPJ_BYTE *p_header_data, 
-                            OPJ_UINT32 p_header_size, 
-                            opj_event_mgr_t * p_manager);
-}
-opj_jp2_header_handler_t;
-
-
-typedef struct opj_jp2_img_header_writer_handler 
-{
-  /* action to perform */
-  OPJ_BYTE*   (*handler) (opj_jp2_t *jp2, OPJ_UINT32 * p_data_size);
-  /* result of the action : data */
-  OPJ_BYTE*   m_data;
-  /* size of data */
-  OPJ_UINT32  m_size;
-} 
-opj_jp2_img_header_writer_handler_t;
-
 /** @name Exported functions */
 /*@{*/
 /* ----------------------------------------------------------------------- */
-
 /**
- * Writes the Jpeg2000 file Header box - JP2 Header box (warning, this is a super box).
- *
- * @param  jp2      the jpeg2000 file codec.
- * @param  stream      the stream to write data to.
- * @param  p_manager  user event manager.
- *
- * @return true if writing was successful.
+Write the JP2H box - JP2 Header box (used in MJ2)
+@param jp2 JP2 handle
+@param cio Output buffer stream
 */
-OPJ_BOOL opj_jp2_write_jp2h(opj_jp2_t *jp2,
-                            opj_stream_private_t *stream,
-                            opj_event_mgr_t * p_manager );
-
+void jp2_write_jp2h(opj_jp2_t *jp2, opj_cio_t *cio);
 /**
-Setup the decoder decoding parameters using user parameters.
-Decoding parameters are returned in jp2->j2k->cp.
-@param jp2 JP2 decompressor handle
-@param parameters decompression parameters
+Read the JP2H box - JP2 Header box (used in MJ2)
+@param jp2 JP2 handle
+@param cio Input buffer stream
+@param ext Collector for profile, cdef and pclr data
+@return Returns true if successful, returns false otherwise
 */
-void opj_jp2_setup_decoder(opj_jp2_t *jp2, opj_dparameters_t *parameters);
-
+opj_bool jp2_read_jp2h(opj_jp2_t *jp2, opj_cio_t *cio, opj_jp2_color_t *color);
 /**
- * Decode an image from a JPEG-2000 file stream
- * @param jp2 JP2 decompressor handle
- * @param p_stream  FIXME DOC
- * @param p_image   FIXME DOC
- * @param p_manager FIXME DOC
- *
- * @return Returns a decoded image if successful, returns NULL otherwise
+Creates a JP2 decompression structure
+@param cinfo Codec context info
+@return Returns a handle to a JP2 decompressor if successful, returns NULL otherwise
 */
-OPJ_BOOL opj_jp2_decode(opj_jp2_t *jp2,
-                        opj_stream_private_t *p_stream,
-            opj_image_t* p_image,
-            opj_event_mgr_t * p_manager);
-
+opj_jp2_t* jp2_create_decompress(opj_common_ptr cinfo);
 /**
- * Setup the encoder parameters using the current image and using user parameters. 
- * Coding parameters are returned in jp2->j2k->cp. 
- *
- * @param jp2 JP2 compressor handle
- * @param parameters compression parameters
- * @param image input filled image
- * @param p_manager  FIXME DOC
+Destroy a JP2 decompressor handle
+@param jp2 JP2 decompressor handle to destroy
 */
-void opj_jp2_setup_encoder(  opj_jp2_t *jp2, 
-                            opj_cparameters_t *parameters, 
-                            opj_image_t *image, 
-                            opj_event_mgr_t * p_manager);
-
+void jp2_destroy_decompress(opj_jp2_t *jp2);
 /**
-Encode an image into a JPEG-2000 file stream
-@param jp2      JP2 compressor handle
-@param stream    Output buffer stream
-@param p_manager  event manager
-@return Returns true if successful, returns false otherwise
+Setup the decoder decoding parameters using user parameters.
+Decoding parameters are returned in jp2->j2k->cp. 
+@param jp2 JP2 decompressor handle
+@param parameters decompression parameters
 */
-OPJ_BOOL opj_jp2_encode(  opj_jp2_t *jp2, 
-              opj_stream_private_t *stream, 
-              opj_event_mgr_t * p_manager);
-
-
-/**
- * Starts a compression scheme, i.e. validates the codec parameters, writes the header.
- *
- * @param  jp2    the jpeg2000 file codec.
- * @param  stream    the stream object.
- * @param  p_image   FIXME DOC
- * @param p_manager FIXME DOC
- *
- * @return true if the codec is valid.
- */
-OPJ_BOOL opj_jp2_start_compress(opj_jp2_t *jp2,
-                                opj_stream_private_t *stream,
-                                opj_image_t * p_image,
-                                opj_event_mgr_t * p_manager);
-
-
+void jp2_setup_decoder(opj_jp2_t *jp2, opj_dparameters_t *parameters);
 /**
- * Ends the compression procedures and possibiliy add data to be read after the
- * codestream.
- */
-OPJ_BOOL opj_jp2_end_compress(  opj_jp2_t *jp2,
-                  opj_stream_private_t *cio,
-                  opj_event_mgr_t * p_manager);
-
-/* ----------------------------------------------------------------------- */
-
-/**
- * Ends the decompression procedures and possibiliy add data to be read after the
- * codestream.
- */
-OPJ_BOOL opj_jp2_end_decompress(opj_jp2_t *jp2, 
-                                opj_stream_private_t *cio,
-                                opj_event_mgr_t * p_manager);
-
-/**
- * Reads a jpeg2000 file header structure.
- *
- * @param p_stream the stream to read data from.
- * @param jp2 the jpeg2000 file header structure.
- * @param p_image   FIXME DOC
- * @param p_manager the user event manager.
- *
- * @return true if the box is valid.
- */
-OPJ_BOOL opj_jp2_read_header(  opj_stream_private_t *p_stream,
-                                opj_jp2_t *jp2,
-                                opj_image_t ** p_image,
-                                opj_event_mgr_t * p_manager );
-
-/**
- * Reads a tile header.
- * @param  p_jp2         the jpeg2000 codec.
- * @param  p_tile_index  FIXME DOC
- * @param  p_data_size   FIXME DOC
- * @param  p_tile_x0     FIXME DOC
- * @param  p_tile_y0     FIXME DOC
- * @param  p_tile_x1     FIXME DOC
- * @param  p_tile_y1     FIXME DOC
- * @param  p_nb_comps    FIXME DOC
- * @param  p_go_on       FIXME DOC
- * @param  p_stream      the stream to write data to.
- * @param  p_manager     the user event manager.
- */
-OPJ_BOOL opj_jp2_read_tile_header ( opj_jp2_t * p_jp2,
-                                    OPJ_UINT32 * p_tile_index,
-                                    OPJ_UINT32 * p_data_size,
-                                    OPJ_INT32 * p_tile_x0,
-                                    OPJ_INT32 * p_tile_y0,
-                                    OPJ_INT32 * p_tile_x1,
-                                    OPJ_INT32 * p_tile_y1,
-                                    OPJ_UINT32 * p_nb_comps,
-                                    OPJ_BOOL * p_go_on,
-                                    opj_stream_private_t *p_stream,
-                                    opj_event_mgr_t * p_manager );
-
-/**
- * Writes a tile.
- *
- * @param  p_jp2    the jpeg2000 codec.
- * @param p_tile_index  FIXME DOC
- * @param p_data        FIXME DOC
- * @param p_data_size   FIXME DOC
- * @param  p_stream      the stream to write data to.
- * @param  p_manager  the user event manager.
- */
-OPJ_BOOL opj_jp2_write_tile (  opj_jp2_t *p_jp2,
-                    OPJ_UINT32 p_tile_index,
-                    OPJ_BYTE * p_data,
-                    OPJ_UINT32 p_data_size,
-                    opj_stream_private_t *p_stream,
-                    opj_event_mgr_t * p_manager );
-
-/**
- * Decode tile data.
- * @param  p_jp2    the jpeg2000 codec.
- * @param  p_tile_index FIXME DOC
- * @param  p_data       FIXME DOC
- * @param  p_data_size  FIXME DOC
- * @param  p_stream      the stream to write data to.
- * @param  p_manager  the user event manager.
- *
- * @return FIXME DOC
- */
-OPJ_BOOL opj_jp2_decode_tile (  opj_jp2_t * p_jp2,
-                                OPJ_UINT32 p_tile_index,
-                                OPJ_BYTE * p_data,
-                                OPJ_UINT32 p_data_size,
-                                opj_stream_private_t *p_stream,
-                                opj_event_mgr_t * p_manager );
-
-/**
- * Creates a jpeg2000 file decompressor.
- *
- * @return  an empty jpeg2000 file codec.
- */
-opj_jp2_t* opj_jp2_create (OPJ_BOOL p_is_decoder);
-
-/**
-Destroy a JP2 decompressor handle
-@param jp2 JP2 decompressor handle to destroy
+Decode an image from a JPEG-2000 file stream
+@param jp2 JP2 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
 */
-void opj_jp2_destroy(opj_jp2_t *jp2);
-
-
-/**
- * Sets the given area to be decoded. This function should be called right after opj_read_header and before any tile header reading.
- *
- * @param  p_jp2      the jpeg2000 codec.
- * @param  p_image     FIXME DOC
- * @param  p_start_x   the left position of the rectangle to decode (in image coordinates).
- * @param  p_start_y    the up position of the rectangle to decode (in image coordinates).
- * @param  p_end_x      the right position of the rectangle to decode (in image coordinates).
- * @param  p_end_y      the bottom position of the rectangle to decode (in image coordinates).
- * @param  p_manager    the user event manager
- *
- * @return  true      if the area could be set.
- */
-OPJ_BOOL opj_jp2_set_decode_area(  opj_jp2_t *p_jp2,
-                    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,
-                    opj_event_mgr_t * p_manager );
-
- /**
- * 
- */
-OPJ_BOOL opj_jp2_get_tile(  opj_jp2_t *p_jp2,
-                            opj_stream_private_t *p_stream,
-                            opj_image_t* p_image,
-                            opj_event_mgr_t * p_manager,
-                            OPJ_UINT32 tile_index );
-
-
+opj_image_t* opj_jp2_decode(opj_jp2_t *jp2, opj_cio_t *cio, opj_codestream_info_t *cstr_info);
 /**
- * 
- */
-OPJ_BOOL opj_jp2_set_decoded_resolution_factor(opj_jp2_t *p_jp2, 
-                                               OPJ_UINT32 res_factor, 
-                                               opj_event_mgr_t * p_manager);
-
-
-/* TODO MSD: clean these 3 functions */
+Creates a JP2 compression structure
+@param cinfo Codec context info
+@return Returns a handle to a JP2 compressor if successful, returns NULL otherwise
+*/
+opj_jp2_t* jp2_create_compress(opj_common_ptr cinfo);
 /**
- * Dump some elements from the JP2 decompression structure .
- *
- *@param p_jp2        the jp2 codec.
- *@param flag        flag to describe what elments are dump.
- *@param out_stream      output stream where dump the elements.
- *
+Destroy a JP2 compressor handle
+@param jp2 JP2 compressor handle to destroy
 */
-void jp2_dump (opj_jp2_t* p_jp2, OPJ_INT32 flag, FILE* out_stream);
-
+void jp2_destroy_compress(opj_jp2_t *jp2);
 /**
- * Get the codestream info from a JPEG2000 codec.
- *
- *@param  p_jp2        jp2 codec.
- *
- *@return  the codestream information extract from the jpg2000 codec
- */
-opj_codestream_info_v2_t* jp2_get_cstr_info(opj_jp2_t* p_jp2);
-
+Setup the encoder parameters using the current image and using user parameters. 
+Coding parameters are returned in jp2->j2k->cp. 
+@param jp2 JP2 compressor handle
+@param parameters compression parameters
+@param image input filled image
+*/
+void jp2_setup_encoder(opj_jp2_t *jp2, opj_cparameters_t *parameters, opj_image_t *image);
 /**
- * Get the codestream index from a JPEG2000 codec.
- *
- *@param  p_jp2        jp2 codec.
- *
- *@return  the codestream index extract from the jpg2000 codec
- */
-opj_codestream_index_t* jp2_get_cstr_index(opj_jp2_t* p_jp2);
-
+Encode an image into a JPEG-2000 file stream
+@param jp2 JP2 compressor handle
+@param cio Output buffer stream
+@param image Image to encode
+@param cstr_info Codestream information structure if required, NULL otherwise
+@return Returns true if successful, returns false otherwise
+*/
+opj_bool opj_jp2_encode(opj_jp2_t *jp2, opj_cio_t *cio, opj_image_t *image, opj_codestream_info_t *cstr_info);
 
+/* ----------------------------------------------------------------------- */
 /*@}*/
 
 /*@}*/