]> Creatis software - gdcm.git/blobdiff - src/gdcmopenjpeg/libopenjpeg/jp2.h
ENH: Huge update to openjpeg 1.0 (actually more CVS)...
[gdcm.git] / src / gdcmopenjpeg / libopenjpeg / jp2.h
index da45aba2d314e7247801473fe4949afee7aa5366..1d47fa6e29d662ec3dcb1e9e52cab8748edbcbec 100644 (file)
-/*
- * Copyright (c) 2003, Yannick Verschueren
- * Copyright (c) 2003,  Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- *    notice, this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in the
- *    documentation and/or other materials provided with the distribution.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
- * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
- * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
- * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
- * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
- * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGE.
- */
-#ifndef __JP2_H
-#define __JP2_H
-
-#include "j2k.h"
-
-typedef struct {
-  int depth;        
-  int sgnd;         
-  int bpcc;
-} jp2_comps_t;
-
-typedef struct {
-  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;
-  jp2_comps_t *comps;
-  j2k_image_t *image;
-  unsigned int j2k_codestream_offset;
-  unsigned int j2k_codestream_len;
-} jp2_struct_t;
-
-typedef struct {
-  int length;
-  int type;
-  int init_pos;
-} jp2_box_t;
-
-/* int jp2_init_stdjp2(jp2_struct_t * jp2_struct, j2k_image_t * img); 
- *
- * Create a standard jp2_structure
- * jp2_struct: the structure you are creating
- * img: a j2k_image_t wich will help you to create the jp2_structure
- */
-int jp2_init_stdjp2(jp2_struct_t * jp2_struct);
-
-/* int jp2_write_jp2c(int j2k_len, int *j2k_codestream_offset, char *j2k_codestream)
- *
- * Write the jp2c codestream box 
- * j2k_len: the j2k codestream length
- * j2k_codestream_offset: the function will return the j2k codestream offset
- * j2k_codestream: the j2k codestream to include in jp2 file
- */
-int jp2_write_jp2c(int j2k_len, int *j2k_codestream_offset, char *j2k_codestream);
-
-/* int jp2_write_jp2h(jp2_struct_t * jp2_struct);
- *
- * Write the jp2h header box 
- * jp2_struct: the jp2 structure you are working with
- */
-void jp2_write_jp2h(jp2_struct_t * jp2_struct);
-
-/* int jp2_read_jp2h(jp2_struct_t * jp2_struct);
- *
- * Read the jp2h header box 
- * jp2_struct: the jp2 structure you are working with
- */
-int jp2_read_jp2h(jp2_struct_t * jp2_struct);
-
-/* int jp2_wrap_j2k(jp2_struct_t * jp2_struct, char *j2k_codestream, 
-     int j2k_len, char *output)
- *
- * Wrap a J2K codestream in a JP2 file
- * jp2_struct: the jp2 structure used to create jp2 boxes
- * j2k_codestream: the j2k codestream to include in jp2 file
- * output: pointer to jp2 codestream that will be created
- */
-int jp2_wrap_j2k(jp2_struct_t * jp2_struct, char *j2k_codestream, 
-        char *output);
-
-
-/* int jp2_read_struct(unsigned char *src, jp2_struct_t * jp2_struct);
- *
- * Decode the structure of a JP2 file
- * src: pointer to memory where compressed data is stored
- * jp2_struct: the jp2 structure that will be created 
- * len: length of jp2 codestream
- */
-int jp2_read_struct(unsigned char *src, jp2_struct_t * jp2_struct, int len);
-
-#endif
+/*\r
+ * Copyright (c) 2004, Yannick Verschueren\r
+ * Copyright (c) 2005, HervĂ© Drolon, FreeImage Team\r
+ * Copyright (c) 2002-2005, Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium\r
+ * All rights reserved.\r
+ *\r
+ * Redistribution and use in source and binary forms, with or without\r
+ * modification, are permitted provided that the following conditions\r
+ * are met:\r
+ * 1. Redistributions of source code must retain the above copyright\r
+ *    notice, this list of conditions and the following disclaimer.\r
+ * 2. Redistributions in binary form must reproduce the above copyright\r
+ *    notice, this list of conditions and the following disclaimer in the\r
+ *    documentation and/or other materials provided with the distribution.\r
+ *\r
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'\r
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\r
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE\r
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR\r
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF\r
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS\r
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN\r
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)\r
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE\r
+ * POSSIBILITY OF SUCH DAMAGE.\r
+ */\r
+#ifndef __JP2_H\r
+#define __JP2_H\r
+/**\r
+@file jp2.h\r
+@brief The JPEG-2000 file format Reader/Writer (JP2)\r
+\r
+*/\r
+\r
+/** @defgroup JP2 JP2 - JPEG-2000 file format reader/writer */\r
+/*@{*/\r
+\r
+#define JPIP_JPIP 0x6a706970\r
+\r
+#define JP2_JP   0x6a502020    /**< JPEG 2000 signature box */\r
+#define JP2_FTYP 0x66747970    /**< File type box */\r
+#define JP2_JP2H 0x6a703268    /**< JP2 header box */\r
+#define JP2_IHDR 0x69686472    /**< Image header box */\r
+#define JP2_COLR 0x636f6c72    /**< Colour specification box */\r
+#define JP2_JP2C 0x6a703263    /**< Contiguous codestream box */\r
+#define JP2_URL  0x75726c20    /**< URL box */\r
+#define JP2_DBTL 0x6474626c    /**< ??? */\r
+#define JP2_BPCC 0x62706363    /**< Bits per component box */\r
+#define JP2_JP2  0x6a703220    /**< File type fields */\r
+\r
+/* ----------------------------------------------------------------------- */\r
+\r
+/** \r
+JP2 component\r
+*/\r
+typedef struct opj_jp2_comps {\r
+  int depth;      \r
+  int sgnd;       \r
+  int bpcc;\r
+} opj_jp2_comps_t;\r
+\r
+/**\r
+JPEG-2000 file format reader/writer\r
+*/\r
+typedef struct opj_jp2 {\r
+  /** codec context */\r
+  opj_common_ptr cinfo;\r
+  /** handle to the J2K codec  */\r
+  opj_j2k_t *j2k;\r
+  unsigned int w;\r
+  unsigned int h;\r
+  unsigned int numcomps;\r
+  unsigned int bpc;\r
+  unsigned int C;\r
+  unsigned int UnkC;\r
+  unsigned int IPR;\r
+  unsigned int meth;\r
+  unsigned int approx;\r
+  unsigned int enumcs;\r
+  unsigned int precedence;\r
+  unsigned int brand;\r
+  unsigned int minversion;\r
+  unsigned int numcl;\r
+  unsigned int *cl;\r
+  opj_jp2_comps_t *comps;\r
+  opj_image_t *image;\r
+  unsigned int j2k_codestream_offset;\r
+  unsigned int j2k_codestream_length;\r
+} opj_jp2_t;\r
+\r
+/**\r
+JP2 Box\r
+*/\r
+typedef struct opj_jp2_box {\r
+  int length;\r
+  int type;\r
+  int init_pos;\r
+} opj_jp2_box_t;\r
+\r
+/** @name Exported functions */\r
+/*@{*/\r
+/* ----------------------------------------------------------------------- */\r
+/**\r
+Creates a JP2 decompression structure\r
+@param cinfo Codec context info\r
+@return Returns a handle to a JP2 decompressor if successful, returns NULL otherwise\r
+*/\r
+opj_jp2_t* jp2_create_decompress(opj_common_ptr cinfo);\r
+/**\r
+Destroy a JP2 decompressor handle\r
+@param jp2 JP2 decompressor handle to destroy\r
+*/\r
+void jp2_destroy_decompress(opj_jp2_t *jp2);\r
+/**\r
+Setup the decoder decoding parameters using user parameters.\r
+Decoding parameters are returned in jp2->j2k->cp. \r
+@param jp2 JP2 decompressor handle\r
+@param parameters decompression parameters\r
+*/\r
+void jp2_setup_decoder(opj_jp2_t *jp2, opj_dparameters_t *parameters);\r
+/**\r
+Decode an image from a JPEG-2000 file stream\r
+@param jp2 JP2 decompressor handle\r
+@param cio Input buffer stream\r
+@return Returns a decoded image if successful, returns NULL otherwise\r
+*/\r
+opj_image_t* jp2_decode(opj_jp2_t *jp2, opj_cio_t *cio);\r
+/**\r
+Creates a JP2 compression structure\r
+@param cinfo Codec context info\r
+@return Returns a handle to a JP2 compressor if successful, returns NULL otherwise\r
+*/\r
+opj_jp2_t* jp2_create_compress(opj_common_ptr cinfo);\r
+/**\r
+Destroy a JP2 compressor handle\r
+@param jp2 JP2 compressor handle to destroy\r
+*/\r
+void jp2_destroy_compress(opj_jp2_t *jp2);\r
+/**\r
+Setup the encoder parameters using the current image and using user parameters. \r
+Coding parameters are returned in jp2->j2k->cp. \r
+@param jp2 JP2 compressor handle\r
+@param parameters compression parameters\r
+@param image input filled image\r
+*/\r
+void jp2_setup_encoder(opj_jp2_t *jp2, opj_cparameters_t *parameters, opj_image_t *image);\r
+/**\r
+Encode an image into a JPEG-2000 file stream\r
+@param jp2 JP2 compressor handle\r
+@param cio Output buffer stream\r
+@param image Image to encode\r
+@param index Name of the index file if required, NULL otherwise\r
+@return Returns true if successful, returns false otherwise\r
+*/\r
+bool jp2_encode(opj_jp2_t *jp2, opj_cio_t *cio, opj_image_t *image, char *index);\r
+/* ----------------------------------------------------------------------- */\r
+/*@}*/\r
+\r
+/*@}*/\r
+\r
+#endif /* __JP2_H */\r
+\r