]> Creatis software - gdcm.git/blobdiff - src/gdcmopenjpeg/libopenjpeg/openjpeg.h
ENH: This time for real. Install is ok. STYLE: some minor stuff
[gdcm.git] / src / gdcmopenjpeg / libopenjpeg / openjpeg.h
index 23f7d04b01e1f0e7f14436b09298bfe0518d2ca1..641b3d6f334d10a3e7141e286f81827647df84d4 100644 (file)
-/*\r
- * Copyright (c) 2001-2003, David Janssens\r
- * Copyright (c) 2002-2003, Yannick Verschueren\r
- * Copyright (c) 2003-2005, Francois Devaux and Antonin Descampe\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 OPENJPEG_H\r
-#define OPENJPEG_H\r
-\r
-#define OPENJPEG_VERSION "1.0.0"\r
-\r
-/* \r
-==========================================================\r
-   Compiler directives\r
-==========================================================\r
-*/\r
-#ifndef __cplusplus\r
-#if defined(HAVE_STDBOOL_H)\r
-/*\r
-The C language implementation does correctly provide the standard header\r
-file "stdbool.h".\r
- */\r
-#include <stdbool.h>\r
-#else\r
-/*\r
-The C language implementation does not provide the standard header file\r
-"stdbool.h" as required by ISO/IEC 9899:1999.  Try to compensate for this\r
-braindamage below.\r
-*/\r
-#if !defined(bool)\r
-#define  bool  int\r
-#endif\r
-#if !defined(true)\r
-#define true  1\r
-#endif\r
-#if !defined(false)\r
-#define  false  0\r
-#endif\r
-#endif\r
-#endif /* __cplusplus */\r
-\r
-/* \r
-==========================================================\r
-   Useful constant definitions\r
-==========================================================\r
-*/\r
-\r
-#ifndef MAX_PATH\r
-#define MAX_PATH 260  /**< Maximum allowed size for filenames */\r
-#endif /* MAX_PATH */\r
-\r
-#define J2K_MAXRLVLS 33          /**< Number of maximum resolution level authorized */\r
-#define J2K_MAXBANDS (3*J2K_MAXRLVLS-2)  /**< Number of maximum sub-band linked to number of resolution level */\r
-\r
-/* \r
-==========================================================\r
-   enum definitions\r
-==========================================================\r
-*/\r
-\r
-/** Progression order */\r
-typedef enum PROG_ORDER {\r
-  PROG_UNKNOWN = -1,  /**< place-holder */\r
-  LRCP = 0,    /**< layer-resolution-component-precinct order */\r
-  RLCP = 1,    /**< resolution-layer-component-precinct order */\r
-  RPCL = 2,    /**< resolution-precinct-component-layer order */\r
-  PCRL = 3,    /**< precinct-component-resolution-layer order */\r
-  CPRL = 4    /**< component-precinct-resolution-layer order */\r
-} OPJ_PROG_ORDER;\r
-\r
-/**\r
-Supported image color spaces\r
-*/\r
-typedef enum COLOR_SPACE {\r
-  CLRSPC_UNKNOWN = -1,  /**< place-holder */\r
-  CLRSPC_SRGB = 1,    /**< sRGB */\r
-  CLRSPC_GRAY = 2,    /**< grayscale */\r
-  CLRSPC_SYCC = 3      /**< YUV */\r
-} OPJ_COLOR_SPACE;\r
-\r
-/**\r
-Supported codec\r
-*/\r
-typedef enum CODEC_FORMAT {\r
-  CODEC_UNKNOWN = -1,  /**< place-holder */\r
-  CODEC_J2K = 0,    /**< JPEG-2000 codestream : read/write */\r
-  CODEC_JPT = 1,    /**< JPT-stream (JPEG 2000, JPIP) : read only */\r
-  CODEC_JP2 = 2    /**< JPEG-2000 file format : read/write */\r
-} OPJ_CODEC_FORMAT;\r
-\r
-/* \r
-==========================================================\r
-   event manager typedef definitions\r
-==========================================================\r
-*/\r
-\r
-/**\r
-Callback function prototype for events\r
-@param msg Event message\r
-@param client_data \r
-*/\r
-typedef void (*opj_msg_callback) (const char *msg, void *client_data);\r
-\r
-/**\r
-Message handler object\r
-used for \r
-<ul>\r
-<li>Error messages\r
-<li>Warning messages\r
-<li>Debugging messages\r
-</ul>\r
-*/\r
-typedef struct opj_event_mgr {\r
-  /** Error message callback if available, NULL otherwise */\r
-  opj_msg_callback error_handler;\r
-  /** Warning message callback if available, NULL otherwise */\r
-  opj_msg_callback warning_handler;\r
-  /** Debug message callback if available, NULL otherwise */\r
-  opj_msg_callback info_handler;\r
-} opj_event_mgr_t;\r
-\r
-\r
-/* \r
-==========================================================\r
-   codec typedef definitions\r
-==========================================================\r
-*/\r
-\r
-/**\r
-Progression order changes\r
-*/\r
-typedef struct opj_poc {\r
-  int resno0, compno0;\r
-  int layno1, resno1, compno1;\r
-  OPJ_PROG_ORDER prg;\r
-  int tile;\r
-  char progorder[4];\r
-} opj_poc_t;\r
-\r
-/**\r
-Compression parameters\r
-*/\r
-typedef struct opj_cparameters {\r
-  /** size of tile: tile_size_on = false (not in argument) or = true (in argument) */\r
-  bool tile_size_on;\r
-  /** XTOsiz */\r
-  int cp_tx0;\r
-  /** YTOsiz */\r
-  int cp_ty0;\r
-  /** XTsiz */\r
-  int cp_tdx;\r
-  /** YTsiz */\r
-  int cp_tdy;\r
-  /** allocation by rate/distortion */\r
-  int cp_disto_alloc;\r
-  /** allocation by fixed layer */\r
-  int cp_fixed_alloc;\r
-  /** add fixed_quality */\r
-  int cp_fixed_quality;\r
-  /** fixed layer */\r
-  int *cp_matrice;\r
-  /** comment for coding */\r
-  char *cp_comment;\r
-  /** csty : coding style */\r
-  int csty;\r
-  /** progression order (default LRCP) */\r
-  OPJ_PROG_ORDER prog_order;\r
-  /** progression order changes */\r
-  opj_poc_t POC[32];\r
-  /** number of progression order changes (POC), default to 0 */\r
-  int numpocs;\r
-  /** number of layers */\r
-  int tcp_numlayers;\r
-  /** rates of layers */\r
-  int tcp_rates[100];\r
-  /** different psnr for successive layers */\r
-  float tcp_distoratio[100];\r
-  /** number of resolutions */\r
-  int numresolution;\r
-  /** initial code block width, default to 64 */\r
-   int cblockw_init;\r
-  /** initial code block height, default to 64 */\r
-  int cblockh_init;\r
-  /** mode switch (cblk_style) */\r
-  int mode;\r
-  /** 1 : use the irreversible DWT 9-7, 0 : use lossless compression (default) */\r
-  int irreversible;\r
-  /** region of interest: affected component in [0..3], -1 means no ROI */\r
-  int roi_compno;\r
-  /** region of interest: upshift value */\r
-  int roi_shift;\r
-  /* number of precinct size specifications */\r
-  int res_spec;\r
-  /** initial precinct width */\r
-  int prcw_init[J2K_MAXRLVLS];\r
-  /** initial precinct height */\r
-  int prch_init[J2K_MAXRLVLS];\r
-\r
-  /**@name command line encoder parameters (not used inside the library) */\r
-  /*@{*/\r
-  /** input file name */\r
-  char infile[MAX_PATH];\r
-  /** output file name */\r
-  char outfile[MAX_PATH];\r
-  /** creation of an index file, default to 0 (false) */\r
-  int index_on;\r
-  /** index file name */\r
-  char index[MAX_PATH];\r
-  /** subimage encoding: origin image offset in x direction */\r
-  int image_offset_x0;\r
-  /** subimage encoding: origin image offset in y direction */\r
-  int image_offset_y0;\r
-  /** subsampling value for dx */\r
-  int subsampling_dx;\r
-  /** subsampling value for dy */\r
-  int subsampling_dy;\r
-  /** input file format 0: PGX, 1: PxM, 2: BMP */\r
-  int decod_format;\r
-  /** output file format 0: J2K, 1: JP2, 2: JPT */\r
-  int cod_format;\r
-  /*@}*/\r
-} opj_cparameters_t;\r
-\r
-/**\r
-Decompression parameters\r
-*/\r
-typedef struct opj_dparameters {\r
-  /** \r
-  Set the number of highest resolution levels to be discarded. \r
-  The image resolution is effectively divided by 2 to the power of the number of discarded levels. \r
-  The reduce factor is limited by the smallest total number of decomposition levels among tiles.\r
-  if != 0, then original dimension divided by 2^(reduce); \r
-  if == 0 or not used, image is decoded to the full resolution \r
-  */\r
-  int cp_reduce;\r
-  /** \r
-  Set the maximum number of quality layers to decode. \r
-  If there are less quality layers than the specified number, all the quality layers are decoded.\r
-  if != 0, then only the first "layer" layers are decoded; \r
-  if == 0 or not used, all the quality layers are decoded \r
-  */\r
-  int cp_layer;\r
-\r
-  /**@name command line encoder parameters (not used inside the library) */\r
-  /*@{*/\r
-  /** input file name */\r
-  char infile[MAX_PATH];\r
-  /** output file name */\r
-  char outfile[MAX_PATH];\r
-  /** input file format 0: J2K, 1: JP2, 2: JPT */\r
-  int decod_format;\r
-  /** output file format 0: PGX, 1: PxM, 2: BMP */\r
-  int cod_format;\r
-  /*@}*/\r
-} opj_dparameters_t;\r
-\r
-/** Common fields between JPEG-2000 compression and decompression master structs. */\r
-\r
-#define opj_common_fields \\r
-  opj_event_mgr_t *event_mgr;  /**< pointer to the event manager */\\r
-  void * client_data;      /**< Available for use by application */\\r
-  bool is_decompressor;    /**< So common code can tell which is which */\\r
-  OPJ_CODEC_FORMAT codec_format;  /**< selected codec */\\r
-  void *j2k_handle;      /**< pointer to the J2K codec */\\r
-  void *jp2_handle      /**< pointer to the JP2 codec */\r
-  \r
-/* Routines that are to be used by both halves of the library are declared\r
- * to receive a pointer to this structure.  There are no actual instances of\r
- * opj_common_struct_t, only of opj_cinfo_t and opj_dinfo_t.\r
- */\r
-typedef struct opj_common_struct {\r
-  opj_common_fields;    /* Fields common to both master struct types */\r
-  /* Additional fields follow in an actual opj_cinfo_t or\r
-   * opj_dinfo_t.  All three structs must agree on these\r
-   * initial fields!  (This would be a lot cleaner in C++.)\r
-   */\r
-} opj_common_struct_t;\r
-\r
-typedef opj_common_struct_t * opj_common_ptr;\r
-\r
-/**\r
-Compression context info\r
-*/\r
-typedef struct opj_cinfo {\r
-  /** Fields shared with opj_dinfo_t */\r
-  opj_common_fields;  \r
-  /* other specific fields go here */\r
-} opj_cinfo_t;\r
-\r
-/**\r
-Decompression context info\r
-*/\r
-typedef struct opj_dinfo {\r
-  /** Fields shared with opj_cinfo_t */\r
-  opj_common_fields;  \r
-  /* other specific fields go here */\r
-} opj_dinfo_t;\r
-\r
-/* \r
-==========================================================\r
-   I/O stream typedef definitions\r
-==========================================================\r
-*/\r
-\r
-/*\r
- * Stream open flags.\r
- */\r
-/** The stream was opened for reading. */\r
-#define OPJ_STREAM_READ  0x0001\r
-/** The stream was opened for writing. */\r
-#define OPJ_STREAM_WRITE 0x0002\r
-\r
-/**\r
-Byte input-output stream (CIO)\r
-*/\r
-typedef struct opj_cio {\r
-  /** codec context */\r
-  opj_common_ptr cinfo;\r
-\r
-  /** open mode (read/write) either OPJ_STREAM_READ or OPJ_STREAM_WRITE */\r
-  int openmode;\r
-  /** pointer to the start of the buffer */\r
-  unsigned char *buffer;\r
-  /** buffer size in bytes */\r
-  int length;\r
-\r
-  /** pointer to the start of the stream */\r
-  unsigned char *start;\r
-  /** pointer to the end of the stream */\r
-  unsigned char *end;\r
-  /** pointer to the current position */\r
-  unsigned char *bp;\r
-} opj_cio_t;\r
-\r
-/* \r
-==========================================================\r
-   image typedef definitions\r
-==========================================================\r
-*/\r
-\r
-/**\r
-Defines a single image component\r
-*/\r
-typedef struct opj_image_comp {\r
-  /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */\r
-  int dx;\r
-  /** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */\r
-  int dy;\r
-  /** data width */\r
-  int w;\r
-  /** data height */\r
-  int h;\r
-  /** x component offset compared to the whole image */\r
-  int x0;\r
-  /** y component offset compared to the whole image */\r
-  int y0;\r
-  /** precision */\r
-  int prec;\r
-  /** image depth in bits */\r
-  int bpp;\r
-  /** signed (1) / unsigned (0) */\r
-  int sgnd;\r
-  /** number of decoded resolution */\r
-  int resno_decoded;\r
-  /** number of division by 2 of the out image compared to the original size of image */\r
-  int factor;\r
-  /** image component data */\r
-  int *data;\r
-} opj_image_comp_t;\r
-\r
-/** \r
-Defines image data and characteristics\r
-*/\r
-typedef struct opj_image {\r
-  /** XOsiz: horizontal offset from the origin of the reference grid to the left side of the image area */\r
-  int x0;\r
-  /** YOsiz: vertical offset from the origin of the reference grid to the top side of the image area */\r
-  int y0;\r
-  /** Xsiz: width of the reference grid */\r
-  int x1;\r
-  /** Ysiz: height of the reference grid */\r
-  int y1;\r
-  /** number of components in the image */\r
-  int numcomps;\r
-  /** color space: sRGB, Greyscale or YUV */\r
-  OPJ_COLOR_SPACE color_space;\r
-  /** image components */\r
-  opj_image_comp_t *comps;\r
-} opj_image_t;\r
-\r
-/**\r
-Component parameters structure used by the opj_image_create function\r
-*/\r
-typedef struct opj_image_comptparm {\r
-  /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */\r
-  int dx;\r
-  /** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */\r
-  int dy;\r
-  /** data width */\r
-  int w;\r
-  /** data height */\r
-  int h;\r
-  /** x component offset compared to the whole image */\r
-  int x0;\r
-  /** y component offset compared to the whole image */\r
-  int y0;\r
-  /** precision */\r
-  int prec;\r
-  /** image depth in bits */\r
-  int bpp;\r
-  /** signed (1) / unsigned (0) */\r
-  int sgnd;\r
-} opj_image_cmptparm_t;\r
-\r
-#ifdef __cplusplus\r
-extern "C" {\r
-#endif\r
-\r
-\r
-/* \r
-==========================================================\r
-   openjpeg version\r
-==========================================================\r
-*/\r
-\r
-const char * opj_version();\r
-\r
-/* \r
-==========================================================\r
-   image functions definitions\r
-==========================================================\r
-*/\r
-\r
-/**\r
-Create an image\r
-@param numcmpts number of components\r
-@param cmptparms components parameters\r
-@param clrspc image color space\r
-@return returns a new image structure if successful, returns NULL otherwise\r
-*/\r
-opj_image_t *opj_image_create(int numcmpts, opj_image_cmptparm_t *cmptparms, OPJ_COLOR_SPACE clrspc);\r
-\r
-/**\r
-Deallocate any resources associated with an image\r
-@param image image to be destroyed\r
-*/\r
-void opj_image_destroy(opj_image_t *image);\r
-\r
-/* \r
-==========================================================\r
-   stream functions definitions\r
-==========================================================\r
-*/\r
-\r
-/**\r
-Open and allocate a memory stream for read / write. \r
-On reading, the user must provide a buffer containing encoded data. The buffer will be \r
-wrapped by the returned CIO handle. \r
-On writing, buffer parameters must be set to 0: a buffer will be allocated by the library \r
-to contain encoded data. \r
-@param cinfo Codec context info\r
-@param buffer Reading: buffer address. Writing: NULL\r
-@param length Reading: buffer length. Writing: 0\r
-@return Returns a CIO handle if successful, returns NULL otherwise\r
-*/\r
-opj_cio_t* opj_cio_open(opj_common_ptr cinfo, unsigned char *buffer, int length);\r
-\r
-/**\r
-Close and free a CIO handle\r
-@param cio CIO handle to free\r
-*/\r
-void opj_cio_close(opj_cio_t *cio);\r
-\r
-/**\r
-Get position in byte stream\r
-@param cio CIO handle\r
-@return Returns the position in bytes\r
-*/\r
-int cio_tell(opj_cio_t *cio);\r
-/**\r
-Set position in byte stream\r
-@param cio CIO handle\r
-@param pos Position, in number of bytes, from the beginning of the stream\r
-*/\r
-void cio_seek(opj_cio_t *cio, int pos);\r
-\r
-/* \r
-==========================================================\r
-   event manager functions definitions\r
-==========================================================\r
-*/\r
-\r
-opj_event_mgr_t* opj_set_event_mgr(opj_common_ptr cinfo, opj_event_mgr_t *event_mgr, void *context);\r
-\r
-/* \r
-==========================================================\r
-   codec functions definitions\r
-==========================================================\r
-*/\r
-/**\r
-Creates a J2K/JPT/JP2 decompression structure\r
-@param format Decoder to select\r
-@return Returns a handle to a decompressor if successful, returns NULL otherwise\r
-*/\r
-opj_dinfo_t* opj_create_decompress(OPJ_CODEC_FORMAT format);\r
-/**\r
-Destroy a decompressor handle\r
-@param dinfo decompressor handle to destroy\r
-*/\r
-void opj_destroy_decompress(opj_dinfo_t *dinfo);\r
-/**\r
-Set decoding parameters to default values\r
-@param parameters Decompression parameters\r
-*/\r
-void opj_set_default_decoder_parameters(opj_dparameters_t *parameters);\r
-/**\r
-Setup the decoder decoding parameters using user parameters.\r
-Decoding parameters are returned in j2k->cp. \r
-@param dinfo decompressor handle\r
-@param parameters decompression parameters\r
-*/\r
-void opj_setup_decoder(opj_dinfo_t *dinfo, opj_dparameters_t *parameters);\r
-/**\r
-Decode an image from a JPEG-2000 codestream\r
-@param dinfo decompressor handle\r
-@param cio Input buffer stream\r
-@return Returns a decoded image if successful, returns NULL otherwise\r
-*/\r
-opj_image_t* opj_decode(opj_dinfo_t *dinfo, opj_cio_t *cio);\r
-/**\r
-Creates a J2K/JP2 compression structure\r
-@param format Coder to select\r
-@return Returns a handle to a compressor if successful, returns NULL otherwise\r
-*/\r
-opj_cinfo_t* opj_create_compress(OPJ_CODEC_FORMAT format);\r
-/**\r
-Destroy a compressor handle\r
-@param cinfo compressor handle to destroy\r
-*/\r
-void opj_destroy_compress(opj_cinfo_t *cinfo);\r
-/**\r
-Set encoding parameters to default values, that means : \r
-<ul>\r
-<li>Lossless\r
-<li>1 tile\r
-<li>Size of precinct : 2^15 x 2^15 (means 1 precinct)\r
-<li>Size of code-block : 64 x 64\r
-<li>Number of resolutions: 6\r
-<li>No SOP marker in the codestream\r
-<li>No EPH marker in the codestream\r
-<li>No sub-sampling in x or y direction\r
-<li>No mode switch activated\r
-<li>Progression order: LRCP\r
-<li>No index file\r
-<li>No ROI upshifted\r
-<li>No offset of the origin of the image\r
-<li>No offset of the origin of the tiles\r
-<li>Reversible DWT 5-3\r
-</ul>\r
-@param parameters Compression parameters\r
-*/\r
-void opj_set_default_encoder_parameters(opj_cparameters_t *parameters);\r
-/**\r
-Setup the encoder parameters using the current image and using user parameters. \r
-@param cinfo compressor handle\r
-@param parameters compression parameters\r
-@param image input filled image\r
-*/\r
-void opj_setup_encoder(opj_cinfo_t *cinfo, opj_cparameters_t *parameters, opj_image_t *image);\r
-/**\r
-Encode an image into a JPEG-2000 codestream\r
-@param cinfo 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 opj_encode(opj_cinfo_t *cinfo, opj_cio_t *cio, opj_image_t *image, char *index);\r
-\r
-#ifdef __cplusplus\r
-}\r
-#endif\r
-\r
-#endif /* OPENJPEG_H */\r
+/*
+ * Copyright (c) 2001-2003, David Janssens
+ * Copyright (c) 2002-2003, Yannick Verschueren
+ * Copyright (c) 2003-2005, Francois Devaux and Antonin Descampe
+ * Copyright (c) 2005, HervĂ© Drolon, FreeImage Team
+ * Copyright (c) 2002-2005, 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 OPENJPEG_H
+#define OPENJPEG_H
+
+#define OPENJPEG_VERSION "1.0.0"
+
+/* 
+==========================================================
+   Compiler directives
+==========================================================
+*/
+
+#if defined(OPJ_STATIC) || !(defined(WIN32) || defined(__WIN32__))
+#define OPJ_API
+#define OPJ_CALLCONV
+#else
+#define OPJ_CALLCONV __stdcall
+/*
+The following ifdef block is the standard way of creating macros which make exporting 
+from a DLL simpler. All files within this DLL are compiled with the OPJ_EXPORTS
+symbol defined on the command line. this symbol should not be defined on any project
+that uses this DLL. This way any other project whose source files include this file see 
+OPJ_API functions as being imported from a DLL, wheras this DLL sees symbols
+defined with this macro as being exported.
+*/
+#ifdef OPJ_EXPORTS
+#define OPJ_API __declspec(dllexport)
+#else
+#define OPJ_API __declspec(dllimport)
+#endif /* OPJ_EXPORTS */
+#endif /* !OPJ_STATIC || !WIN32 */
+
+#ifndef __cplusplus
+#if defined(HAVE_STDBOOL_H)
+/*
+The C language implementation does correctly provide the standard header
+file "stdbool.h".
+ */
+#include <stdbool.h>
+#else
+/*
+The C language implementation does not provide the standard header file
+"stdbool.h" as required by ISO/IEC 9899:1999.  Try to compensate for this
+braindamage below.
+*/
+#if !defined(bool)
+#define  bool  int
+#endif
+#if !defined(true)
+#define true  1
+#endif
+#if !defined(false)
+#define  false  0
+#endif
+#endif
+#endif /* __cplusplus */
+
+/* 
+==========================================================
+   Useful constant definitions
+==========================================================
+*/
+
+#ifndef MAX_PATH
+#define MAX_PATH 260  /**< Maximum allowed size for filenames */
+#endif /* MAX_PATH */
+
+#define J2K_MAXRLVLS 33          /**< Number of maximum resolution level authorized */
+#define J2K_MAXBANDS (3*J2K_MAXRLVLS-2)  /**< Number of maximum sub-band linked to number of resolution level */
+
+/* 
+==========================================================
+   enum definitions
+==========================================================
+*/
+
+/** Progression order */
+typedef enum PROG_ORDER {
+  PROG_UNKNOWN = -1,  /**< place-holder */
+  LRCP = 0,    /**< layer-resolution-component-precinct order */
+  RLCP = 1,    /**< resolution-layer-component-precinct order */
+  RPCL = 2,    /**< resolution-precinct-component-layer order */
+  PCRL = 3,    /**< precinct-component-resolution-layer order */
+  CPRL = 4    /**< component-precinct-resolution-layer order */
+} OPJ_PROG_ORDER;
+
+/**
+Supported image color spaces
+*/
+typedef enum COLOR_SPACE {
+  CLRSPC_UNKNOWN = -1,  /**< place-holder */
+  CLRSPC_SRGB = 1,    /**< sRGB */
+  CLRSPC_GRAY = 2,    /**< grayscale */
+  CLRSPC_SYCC = 3      /**< YUV */
+} OPJ_COLOR_SPACE;
+
+/**
+Supported codec
+*/
+typedef enum CODEC_FORMAT {
+  CODEC_UNKNOWN = -1,  /**< place-holder */
+  CODEC_J2K = 0,    /**< JPEG-2000 codestream : read/write */
+  CODEC_JPT = 1,    /**< JPT-stream (JPEG 2000, JPIP) : read only */
+  CODEC_JP2 = 2    /**< JPEG-2000 file format : read/write */
+} OPJ_CODEC_FORMAT;
+
+/* 
+==========================================================
+   event manager typedef definitions
+==========================================================
+*/
+
+/**
+Callback function prototype for events
+@param msg Event message
+@param client_data 
+*/
+typedef void (*opj_msg_callback) (const char *msg, void *client_data);
+
+/**
+Message handler object
+used for 
+<ul>
+<li>Error messages
+<li>Warning messages
+<li>Debugging messages
+</ul>
+*/
+typedef struct opj_event_mgr {
+  /** Error message callback if available, NULL otherwise */
+  opj_msg_callback error_handler;
+  /** Warning message callback if available, NULL otherwise */
+  opj_msg_callback warning_handler;
+  /** Debug message callback if available, NULL otherwise */
+  opj_msg_callback info_handler;
+} opj_event_mgr_t;
+
+
+/* 
+==========================================================
+   codec typedef definitions
+==========================================================
+*/
+
+/**
+Progression order changes
+*/
+typedef struct opj_poc {
+  int resno0, compno0;
+  int layno1, resno1, compno1;
+  OPJ_PROG_ORDER prg;
+  int tile;
+  char progorder[4];
+} opj_poc_t;
+
+/**
+Compression parameters
+*/
+typedef struct opj_cparameters {
+  /** size of tile: tile_size_on = false (not in argument) or = true (in argument) */
+  bool tile_size_on;
+  /** XTOsiz */
+  int cp_tx0;
+  /** YTOsiz */
+  int cp_ty0;
+  /** XTsiz */
+  int cp_tdx;
+  /** YTsiz */
+  int cp_tdy;
+  /** allocation by rate/distortion */
+  int cp_disto_alloc;
+  /** allocation by fixed layer */
+  int cp_fixed_alloc;
+  /** add fixed_quality */
+  int cp_fixed_quality;
+  /** fixed layer */
+  int *cp_matrice;
+  /** comment for coding */
+  char *cp_comment;
+  /** csty : coding style */
+  int csty;
+  /** progression order (default LRCP) */
+  OPJ_PROG_ORDER prog_order;
+  /** progression order changes */
+  opj_poc_t POC[32];
+  /** number of progression order changes (POC), default to 0 */
+  int numpocs;
+  /** number of layers */
+  int tcp_numlayers;
+  /** rates of layers */
+  int tcp_rates[100];
+  /** different psnr for successive layers */
+  float tcp_distoratio[100];
+  /** number of resolutions */
+  int numresolution;
+  /** initial code block width, default to 64 */
+   int cblockw_init;
+  /** initial code block height, default to 64 */
+  int cblockh_init;
+  /** mode switch (cblk_style) */
+  int mode;
+  /** 1 : use the irreversible DWT 9-7, 0 : use lossless compression (default) */
+  int irreversible;
+  /** region of interest: affected component in [0..3], -1 means no ROI */
+  int roi_compno;
+  /** region of interest: upshift value */
+  int roi_shift;
+  /* number of precinct size specifications */
+  int res_spec;
+  /** initial precinct width */
+  int prcw_init[J2K_MAXRLVLS];
+  /** initial precinct height */
+  int prch_init[J2K_MAXRLVLS];
+
+  /**@name command line encoder parameters (not used inside the library) */
+  /*@{*/
+  /** input file name */
+  char infile[MAX_PATH];
+  /** output file name */
+  char outfile[MAX_PATH];
+  /** creation of an index file, default to 0 (false) */
+  int index_on;
+  /** index file name */
+  char index[MAX_PATH];
+  /** subimage encoding: origin image offset in x direction */
+  int image_offset_x0;
+  /** subimage encoding: origin image offset in y direction */
+  int image_offset_y0;
+  /** subsampling value for dx */
+  int subsampling_dx;
+  /** subsampling value for dy */
+  int subsampling_dy;
+  /** input file format 0: PGX, 1: PxM, 2: BMP */
+  int decod_format;
+  /** output file format 0: J2K, 1: JP2, 2: JPT */
+  int cod_format;
+  /*@}*/
+} opj_cparameters_t;
+
+/**
+Decompression parameters
+*/
+typedef struct opj_dparameters {
+  /** 
+  Set the number of highest resolution levels to be discarded. 
+  The image resolution is effectively divided by 2 to the power of the number of discarded levels. 
+  The reduce factor is limited by the smallest total number of decomposition levels among tiles.
+  if != 0, then original dimension divided by 2^(reduce); 
+  if == 0 or not used, image is decoded to the full resolution 
+  */
+  int cp_reduce;
+  /** 
+  Set the maximum number of quality layers to decode. 
+  If there are less quality layers than the specified number, all the quality layers are decoded.
+  if != 0, then only the first "layer" layers are decoded; 
+  if == 0 or not used, all the quality layers are decoded 
+  */
+  int cp_layer;
+
+  /**@name command line encoder parameters (not used inside the library) */
+  /*@{*/
+  /** input file name */
+  char infile[MAX_PATH];
+  /** output file name */
+  char outfile[MAX_PATH];
+  /** input file format 0: J2K, 1: JP2, 2: JPT */
+  int decod_format;
+  /** output file format 0: PGX, 1: PxM, 2: BMP */
+  int cod_format;
+  /*@}*/
+} opj_dparameters_t;
+
+/** Common fields between JPEG-2000 compression and decompression master structs. */
+
+#define opj_common_fields \
+  opj_event_mgr_t *event_mgr;  /**< pointer to the event manager */\
+  void * client_data;      /**< Available for use by application */\
+  bool is_decompressor;    /**< So common code can tell which is which */\
+  OPJ_CODEC_FORMAT codec_format;  /**< selected codec */\
+  void *j2k_handle;      /**< pointer to the J2K codec */\
+  void *jp2_handle      /**< pointer to the JP2 codec */
+  
+/* Routines that are to be used by both halves of the library are declared
+ * to receive a pointer to this structure.  There are no actual instances of
+ * opj_common_struct_t, only of opj_cinfo_t and opj_dinfo_t.
+ */
+typedef struct opj_common_struct {
+  opj_common_fields;    /* Fields common to both master struct types */
+  /* Additional fields follow in an actual opj_cinfo_t or
+   * opj_dinfo_t.  All three structs must agree on these
+   * initial fields!  (This would be a lot cleaner in C++.)
+   */
+} opj_common_struct_t;
+
+typedef opj_common_struct_t * opj_common_ptr;
+
+/**
+Compression context info
+*/
+typedef struct opj_cinfo {
+  /** Fields shared with opj_dinfo_t */
+  opj_common_fields;  
+  /* other specific fields go here */
+} opj_cinfo_t;
+
+/**
+Decompression context info
+*/
+typedef struct opj_dinfo {
+  /** Fields shared with opj_cinfo_t */
+  opj_common_fields;  
+  /* other specific fields go here */
+} opj_dinfo_t;
+
+/* 
+==========================================================
+   I/O stream typedef definitions
+==========================================================
+*/
+
+/*
+ * Stream open flags.
+ */
+/** The stream was opened for reading. */
+#define OPJ_STREAM_READ  0x0001
+/** The stream was opened for writing. */
+#define OPJ_STREAM_WRITE 0x0002
+
+/**
+Byte input-output stream (CIO)
+*/
+typedef struct opj_cio {
+  /** codec context */
+  opj_common_ptr cinfo;
+
+  /** open mode (read/write) either OPJ_STREAM_READ or OPJ_STREAM_WRITE */
+  int openmode;
+  /** pointer to the start of the buffer */
+  unsigned char *buffer;
+  /** buffer size in bytes */
+  int length;
+
+  /** pointer to the start of the stream */
+  unsigned char *start;
+  /** pointer to the end of the stream */
+  unsigned char *end;
+  /** pointer to the current position */
+  unsigned char *bp;
+} opj_cio_t;
+
+/* 
+==========================================================
+   image typedef definitions
+==========================================================
+*/
+
+/**
+Defines a single image component
+*/
+typedef struct opj_image_comp {
+  /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */
+  int dx;
+  /** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */
+  int dy;
+  /** data width */
+  int w;
+  /** data height */
+  int h;
+  /** x component offset compared to the whole image */
+  int x0;
+  /** y component offset compared to the whole image */
+  int y0;
+  /** precision */
+  int prec;
+  /** image depth in bits */
+  int bpp;
+  /** signed (1) / unsigned (0) */
+  int sgnd;
+  /** number of decoded resolution */
+  int resno_decoded;
+  /** number of division by 2 of the out image compared to the original size of image */
+  int factor;
+  /** image component data */
+  int *data;
+} opj_image_comp_t;
+
+/** 
+Defines image data and characteristics
+*/
+typedef struct opj_image {
+  /** XOsiz: horizontal offset from the origin of the reference grid to the left side of the image area */
+  int x0;
+  /** YOsiz: vertical offset from the origin of the reference grid to the top side of the image area */
+  int y0;
+  /** Xsiz: width of the reference grid */
+  int x1;
+  /** Ysiz: height of the reference grid */
+  int y1;
+  /** number of components in the image */
+  int numcomps;
+  /** color space: sRGB, Greyscale or YUV */
+  OPJ_COLOR_SPACE color_space;
+  /** image components */
+  opj_image_comp_t *comps;
+} opj_image_t;
+
+/**
+Component parameters structure used by the opj_image_create function
+*/
+typedef struct opj_image_comptparm {
+  /** XRsiz: horizontal separation of a sample of ith component with respect to the reference grid */
+  int dx;
+  /** YRsiz: vertical separation of a sample of ith component with respect to the reference grid */
+  int dy;
+  /** data width */
+  int w;
+  /** data height */
+  int h;
+  /** x component offset compared to the whole image */
+  int x0;
+  /** y component offset compared to the whole image */
+  int y0;
+  /** precision */
+  int prec;
+  /** image depth in bits */
+  int bpp;
+  /** signed (1) / unsigned (0) */
+  int sgnd;
+} opj_image_cmptparm_t;
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+
+/* 
+==========================================================
+   openjpeg version
+==========================================================
+*/
+
+OPJ_API const char * OPJ_CALLCONV opj_version();
+
+/* 
+==========================================================
+   image functions definitions
+==========================================================
+*/
+
+/**
+Create an image
+@param numcmpts number of components
+@param cmptparms components parameters
+@param clrspc image color space
+@return returns a new image structure if successful, returns NULL otherwise
+*/
+OPJ_API opj_image_t* OPJ_CALLCONV opj_image_create(int numcmpts, opj_image_cmptparm_t *cmptparms, OPJ_COLOR_SPACE clrspc);
+
+/**
+Deallocate any resources associated with an image
+@param image image to be destroyed
+*/
+OPJ_API void OPJ_CALLCONV opj_image_destroy(opj_image_t *image);
+
+/* 
+==========================================================
+   stream functions definitions
+==========================================================
+*/
+
+/**
+Open and allocate a memory stream for read / write. 
+On reading, the user must provide a buffer containing encoded data. The buffer will be 
+wrapped by the returned CIO handle. 
+On writing, buffer parameters must be set to 0: a buffer will be allocated by the library 
+to contain encoded data. 
+@param cinfo Codec context info
+@param buffer Reading: buffer address. Writing: NULL
+@param length Reading: buffer length. Writing: 0
+@return Returns a CIO handle if successful, returns NULL otherwise
+*/
+OPJ_API opj_cio_t* OPJ_CALLCONV opj_cio_open(opj_common_ptr cinfo, unsigned char *buffer, int length);
+
+/**
+Close and free a CIO handle
+@param cio CIO handle to free
+*/
+OPJ_API void OPJ_CALLCONV opj_cio_close(opj_cio_t *cio);
+
+/**
+Get position in byte stream
+@param cio CIO handle
+@return Returns the position in bytes
+*/
+OPJ_API int OPJ_CALLCONV cio_tell(opj_cio_t *cio);
+/**
+Set position in byte stream
+@param cio CIO handle
+@param pos Position, in number of bytes, from the beginning of the stream
+*/
+OPJ_API void OPJ_CALLCONV cio_seek(opj_cio_t *cio, int pos);
+
+/* 
+==========================================================
+   event manager functions definitions
+==========================================================
+*/
+
+OPJ_API opj_event_mgr_t* OPJ_CALLCONV opj_set_event_mgr(opj_common_ptr cinfo, opj_event_mgr_t *event_mgr, void *context);
+
+/* 
+==========================================================
+   codec functions definitions
+==========================================================
+*/
+/**
+Creates a J2K/JPT/JP2 decompression structure
+@param format Decoder to select
+@return Returns a handle to a decompressor if successful, returns NULL otherwise
+*/
+OPJ_API opj_dinfo_t* OPJ_CALLCONV opj_create_decompress(OPJ_CODEC_FORMAT format);
+/**
+Destroy a decompressor handle
+@param dinfo decompressor handle to destroy
+*/
+OPJ_API void OPJ_CALLCONV opj_destroy_decompress(opj_dinfo_t *dinfo);
+/**
+Set decoding parameters to default values
+@param parameters Decompression parameters
+*/
+OPJ_API void OPJ_CALLCONV opj_set_default_decoder_parameters(opj_dparameters_t *parameters);
+/**
+Setup the decoder decoding parameters using user parameters.
+Decoding parameters are returned in j2k->cp. 
+@param dinfo decompressor handle
+@param parameters decompression parameters
+*/
+OPJ_API void OPJ_CALLCONV opj_setup_decoder(opj_dinfo_t *dinfo, opj_dparameters_t *parameters);
+/**
+Decode an image from a JPEG-2000 codestream
+@param dinfo decompressor handle
+@param cio Input buffer stream
+@return Returns a decoded image if successful, returns NULL otherwise
+*/
+OPJ_API opj_image_t* OPJ_CALLCONV opj_decode(opj_dinfo_t *dinfo, opj_cio_t *cio);
+/**
+Creates a J2K/JP2 compression structure
+@param format Coder to select
+@return Returns a handle to a compressor if successful, returns NULL otherwise
+*/
+OPJ_API opj_cinfo_t* OPJ_CALLCONV opj_create_compress(OPJ_CODEC_FORMAT format);
+/**
+Destroy a compressor handle
+@param cinfo compressor handle to destroy
+*/
+OPJ_API void OPJ_CALLCONV opj_destroy_compress(opj_cinfo_t *cinfo);
+/**
+Set encoding parameters to default values, that means : 
+<ul>
+<li>Lossless
+<li>1 tile
+<li>Size of precinct : 2^15 x 2^15 (means 1 precinct)
+<li>Size of code-block : 64 x 64
+<li>Number of resolutions: 6
+<li>No SOP marker in the codestream
+<li>No EPH marker in the codestream
+<li>No sub-sampling in x or y direction
+<li>No mode switch activated
+<li>Progression order: LRCP
+<li>No index file
+<li>No ROI upshifted
+<li>No offset of the origin of the image
+<li>No offset of the origin of the tiles
+<li>Reversible DWT 5-3
+</ul>
+@param parameters Compression parameters
+*/
+OPJ_API void OPJ_CALLCONV opj_set_default_encoder_parameters(opj_cparameters_t *parameters);
+/**
+Setup the encoder parameters using the current image and using user parameters. 
+@param cinfo compressor handle
+@param parameters compression parameters
+@param image input filled image
+*/
+OPJ_API void OPJ_CALLCONV opj_setup_encoder(opj_cinfo_t *cinfo, opj_cparameters_t *parameters, opj_image_t *image);
+/**
+Encode an image into a JPEG-2000 codestream
+@param cinfo compressor handle
+@param cio Output buffer stream
+@param image Image to encode
+@param index Name of the index file if required, NULL otherwise
+@return Returns true if successful, returns false otherwise
+*/
+OPJ_API bool OPJ_CALLCONV opj_encode(opj_cinfo_t *cinfo, opj_cio_t *cio, opj_image_t *image, char *index);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* OPENJPEG_H */