[1.5] Man page syntax fixes. Thanks to vskytta for patch.
[openjpeg.git] / libopenjpeg / jp2.h
index ea7c09bd2bba6302bd7ea3a9d291f9218cf58769..acb643cad77581a79e3f6d1b9a3d1f36798d8e3d 100644 (file)
@@ -1,7 +1,8 @@
 /*
- * Copyright (c) 2004, Yannick Verschueren
- * Copyright (c) 2005, Herv� Drolon, FreeImage Team
- * Copyright (c) 2002-2005, Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium
+ * 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
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
 
 #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_DBTL 0x6474626c   /**< ??? */
-#define JP2_BPCC 0x62706363   /**< Bits per component box */
-#define JP2_JP2  0x6a703220   /**< File type fields */
+#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 */
 
 /* ----------------------------------------------------------------------- */
+/** 
+Channel description: channel index, type, assocation
+*/
+typedef struct opj_jp2_cdef_info
+{
+    unsigned short cn, typ, asoc;
+} opj_jp2_cdef_info_t;
+
+/** 
+Channel descriptions and number of descriptions
+*/
+typedef struct opj_jp2_cdef
+{
+    opj_jp2_cdef_info_t *info;
+    unsigned short n;
+} opj_jp2_cdef_t;
+
+/** 
+Component mappings: channel index, mapping type, palette index
+*/
+typedef struct opj_jp2_cmap_comp
+{
+    unsigned short cmp;
+    unsigned char mtyp, pcol;
+} opj_jp2_cmap_comp_t;
+
+/** 
+Palette data: table entries, palette columns
+*/
+typedef struct opj_jp2_pclr
+{
+    unsigned int *entries;
+    unsigned char *channel_sign;
+    unsigned char *channel_size;
+    opj_jp2_cmap_comp_t *cmap;
+    unsigned short nr_entries, nr_channels;
+} opj_jp2_pclr_t;
+
+/** 
+Collector for ICC profile, palette, component mapping, channel description 
+*/
+typedef struct opj_jp2_color
+{
+    unsigned char *icc_profile_buf;
+    int icc_profile_len;
+
+    opj_jp2_cdef_t *jp2_cdef;
+    opj_jp2_pclr_t *jp2_pclr;
+    unsigned char jp2_has_colr;
+} opj_jp2_color_t;
 
 /** 
 JP2 component
 */
 typedef struct opj_jp2_comps {
-  int depth;      
-  int sgnd;      
+  int depth;             
+  int sgnd;               
   int bpcc;
 } opj_jp2_comps_t;
 
@@ -64,29 +118,30 @@ typedef struct opj_jp2_comps {
 JPEG-2000 file format reader/writer
 */
 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;
-  opj_image_t *image;
-  unsigned int j2k_codestream_offset;
-  unsigned int j2k_codestream_length;
+       /** 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;
 
 /**
@@ -98,79 +153,23 @@ typedef struct opj_jp2_box {
   int init_pos;
 } opj_jp2_box_t;
 
-/** @name Local static functions */
+/** @name Exported functions */
 /*@{*/
 /* ----------------------------------------------------------------------- */
 /**
-Read box headers
-@param cinfo Codec context info
-@param cio Input stream
-@param box
-@return Returns true if successful, returns false otherwise
-*/
-static bool jp2_read_boxhdr(opj_common_ptr cinfo, opj_cio_t *cio, opj_jp2_box_t *box);
-static void jp2_write_url(opj_cio_t *cio, char *Idx_file);
-/**
-Read the IHDR box - Image Header box
-@param jp2 JP2 handle
-@param cio Input buffer stream
-@return Returns true if successful, returns false otherwise
-*/
-static bool jp2_read_ihdr(opj_jp2_t *jp2, opj_cio_t *cio);
-static void jp2_write_ihdr(opj_jp2_t *jp2, opj_cio_t *cio);
-static void jp2_write_bpcc(opj_jp2_t *jp2, opj_cio_t *cio);
-static bool jp2_read_bpcc(opj_jp2_t *jp2, opj_cio_t *cio);
-static void jp2_write_colr(opj_jp2_t *jp2, opj_cio_t *cio);
-static bool jp2_read_colr(opj_jp2_t *jp2, opj_cio_t *cio);
-/**
-Write the JP2H box - JP2 Header box
-@param jp2 JP2 handle
-@param cio Output buffer stream
-*/
-static void jp2_write_jp2h(opj_jp2_t *jp2, opj_cio_t *cio);
-/**
-Read the JP2H box - JP2 Header box
-@param jp2 JP2 handle
-@param cio Input buffer stream
-@return Returns true if successful, returns false otherwise
-*/
-static bool jp2_read_jp2h(opj_jp2_t *jp2, opj_cio_t *cio);
-/**
-Write the FTYP box - File type box
+Write the JP2H box - JP2 Header box (used in MJ2)
 @param jp2 JP2 handle
 @param cio Output buffer stream
 */
-static void jp2_write_ftyp(opj_jp2_t *jp2, opj_cio_t *cio);
-/**
-Read the FTYP box - File type box
-@param jp2 JP2 handle
-@param cio Input buffer stream
-@return Returns true if successful, returns false otherwise
-*/
-static bool jp2_read_ftyp(opj_jp2_t *jp2, opj_cio_t *cio);
-static int jp2_write_jp2c(opj_jp2_t *jp2, opj_cio_t *cio, char *index);
-static bool jp2_read_jp2c(opj_jp2_t *jp2, opj_cio_t *cio, unsigned int *j2k_codestream_length, unsigned int *j2k_codestream_offset);
-static void jp2_write_jp(opj_cio_t *cio);
+void jp2_write_jp2h(opj_jp2_t *jp2, opj_cio_t *cio);
 /**
-Read the JP box - JPEG 2000 signature
+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
 */
-static bool jp2_read_jp(opj_jp2_t *jp2, opj_cio_t *cio);
-/**
-Decode the structure of a JP2 file
-@param jp2 JP2 handle
-@param cio Input buffer stream
-@return Returns true if successful, returns false otherwise
-*/
-static bool jp2_read_struct(opj_jp2_t *jp2, opj_cio_t *cio);
-/* ----------------------------------------------------------------------- */
-/*@}*/
-
-/** @name Exported functions */
-/*@{*/
-/* ----------------------------------------------------------------------- */
+opj_bool jp2_read_jp2h(opj_jp2_t *jp2, opj_cio_t *cio, opj_jp2_color_t *color);
 /**
 Creates a JP2 decompression structure
 @param cinfo Codec context info
@@ -193,9 +192,10 @@ void jp2_setup_decoder(opj_jp2_t *jp2, opj_dparameters_t *parameters);
 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
 */
-opj_image_t* jp2_decode(opj_jp2_t *jp2, opj_cio_t *cio);
+opj_image_t* opj_jp2_decode(opj_jp2_t *jp2, opj_cio_t *cio, opj_codestream_info_t *cstr_info);
 /**
 Creates a JP2 compression structure
 @param cinfo Codec context info
@@ -220,10 +220,11 @@ 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 index Name of the index file if required, NULL otherwise
+@param cstr_info Codestream information structure if required, NULL otherwise
 @return Returns true if successful, returns false otherwise
 */
-bool jp2_encode(opj_jp2_t *jp2, opj_cio_t *cio, opj_image_t *image, char *index);
+opj_bool opj_jp2_encode(opj_jp2_t *jp2, opj_cio_t *cio, opj_image_t *image, opj_codestream_info_t *cstr_info);
+
 /* ----------------------------------------------------------------------- */
 /*@}*/