]> Creatis software - gdcm.git/blobdiff - src/gdcmopenjpeg/libopenjpeg/mqc.h
ENH: Huge update to openjpeg 1.0 (actually more CVS)...
[gdcm.git] / src / gdcmopenjpeg / libopenjpeg / mqc.h
index ea01d809f6773be40b0a7f474b11c2c12c907d5f..6b38bd36e4504edc682d42a1cad1827b53b3d7f8 100644 (file)
-/*
- * Copyright (c) 2001-2002, David Janssens
- * Copyright (c) 2002-2003, Yannick Verschueren
- * Copyright (c) 2002-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 __MQC_H
-#define __MQC_H
-
-/*
- * Return the number of bytes written/read since initialisation
- */
-int mqc_numbytes();
-
-/*
- * Reset the states of all the context of the coder/decoder
- * (each context is set to a state where 0 and 1 are more or less equiprobable)
- */
-void mqc_resetstates();
-
-/*
- * Set the state of a particular context
- * ctxno: number that identifies the context
- * msb: the MSB of the new state of the context
- * prob: number that identifies the probability of the symbols for the new state of the context
- */
-void mqc_setstate(int ctxno, int msb, int prob);
-
-/*
- * Initialize the encoder
- * bp: pointer to the start of the buffer where the bytes will be written
- */
-void mqc_init_enc(unsigned char *bp);
-
-/*
- * Set the current context used for coding/decoding
- * ctxno: number that identifies the context
- */
-void mqc_setcurctx(int ctxno);
-
-/*
- * Encode a bit
- * d: bit to encode (0 or 1)
- */
-void mqc_encode(int d);
-
-/*
- * Flush the encoder, so that all remaining data is written
- */
-void mqc_flush();
-
-/*
- * BYPASS mode switch
- */
-void mqc_bypass_init_enc();
-
-/*
- * BYPASS mode switch
- */
-void mqc_bypass_enc(int d);
-
-/*
- * BYPASS mode switch
- */
-int mqc_bypass_flush_enc();
-
-/*
- * RESET mode switch
- */
-void mqc_reset_enc();
-
-/*
- * RESTART mode switch (TERMALL)
- */
-int mqc_restart_enc();
-
-/*
- * RESTART mode switch (TERMALL)
- */
-void mqc_restart_init_enc();
-
-/*
- * ERTERM mode switch (PTERM)
- */
-void mqc_erterm_enc();
-
-/*
- * SEGMARK mode switch (SEGSYM)
- */
-void mqc_segmark_enc();
-
-
-/*
- * Initialize the decoder
- * bp: pointer to the start of the buffer from which the bytes will be read
- * len: length of the input buffer
- */
-void mqc_init_dec(unsigned char *bp, int len);
-
-/*
- * Decode a bit (returns 0 or 1)
- */
-int mqc_decode();
-
-#endif
+/*\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
+\r
+#ifndef __MQC_H\r
+#define __MQC_H\r
+/**\r
+@file mqc.h\r
+@brief Implementation of an MQ-Coder (MQC)\r
+\r
+The functions in MQC.C have for goal to realize the MQ-coder operations. The functions\r
+in MQC.C are used by some function in T1.C.\r
+*/\r
+\r
+/** @defgroup MQC MQC - Implementation of an MQ-Coder */\r
+/*@{*/\r
+\r
+/**\r
+This struct defines the state of a context.\r
+*/\r
+typedef struct opj_mqc_state {\r
+  /** the probability of the Least Probable Symbol (0.75->0x8000, 1.5->0xffff) */\r
+  unsigned int qeval;\r
+  /** the Most Probable Symbol (0 or 1) */\r
+  int mps;\r
+  /** next state if the next encoded symbol is the MPS */\r
+  struct opj_mqc_state *nmps;\r
+  /** next state if the next encoded symbol is the LPS */\r
+  struct opj_mqc_state *nlps;\r
+} opj_mqc_state_t;\r
+\r
+#define MQC_NUMCTXS 32\r
+\r
+/**\r
+MQ coder\r
+*/\r
+typedef struct opj_mqc {\r
+  unsigned int c;\r
+  unsigned int a;\r
+  unsigned int ct;\r
+  unsigned char *bp;\r
+  unsigned char *start;\r
+  unsigned char *end;\r
+  opj_mqc_state_t *ctxs[MQC_NUMCTXS];\r
+  opj_mqc_state_t **curctx;\r
+} opj_mqc_t;\r
+\r
+/** @name Exported functions */\r
+/*@{*/\r
+/* ----------------------------------------------------------------------- */\r
+/**\r
+Create a new MQC handle \r
+@return Returns a new MQC handle if successful, returns NULL otherwise\r
+*/\r
+opj_mqc_t* mqc_create();\r
+/**\r
+Destroy a previously created MQC handle\r
+@param mqc MQC handle to destroy\r
+*/\r
+void mqc_destroy(opj_mqc_t *mqc);\r
+/**\r
+Return the number of bytes written/read since initialisation\r
+@param mqc MQC handle\r
+@return Returns the number of bytes already encoded\r
+*/\r
+int mqc_numbytes(opj_mqc_t *mqc);\r
+/**\r
+Reset the states of all the context of the coder/decoder \r
+(each context is set to a state where 0 and 1 are more or less equiprobable)\r
+@param mqc MQC handle\r
+*/\r
+void mqc_resetstates(opj_mqc_t *mqc);\r
+/**\r
+Set the state of a particular context\r
+@param mqc MQC handle\r
+@param ctxno Number that identifies the context\r
+@param msb The MSB of the new state of the context\r
+@param prob Number that identifies the probability of the symbols for the new state of the context\r
+*/\r
+void mqc_setstate(opj_mqc_t *mqc, int ctxno, int msb, int prob);\r
+/**\r
+Initialize the encoder\r
+@param mqc MQC handle\r
+@param bp Pointer to the start of the buffer where the bytes will be written\r
+*/\r
+void mqc_init_enc(opj_mqc_t *mqc, unsigned char *bp);\r
+/**\r
+Set the current context used for coding/decoding\r
+@param mqc MQC handle\r
+@param ctxno Number that identifies the context\r
+*/\r
+void mqc_setcurctx(opj_mqc_t *mqc, int ctxno);\r
+/**\r
+Encode a symbol using the MQ-coder\r
+@param mqc MQC handle\r
+@param d The symbol to be encoded (0 or 1)\r
+*/\r
+void mqc_encode(opj_mqc_t *mqc, int d);\r
+/**\r
+Flush the encoder, so that all remaining data is written\r
+@param mqc MQC handle\r
+*/\r
+void mqc_flush(opj_mqc_t *mqc);\r
+/**\r
+BYPASS mode switch, initialization operation. \r
+JPEG 2000 p 505. \r
+<h2>Not fully implemented and tested !!</h2>\r
+@param mqc MQC handle\r
+*/\r
+void mqc_bypass_init_enc(opj_mqc_t *mqc);\r
+/**\r
+BYPASS mode switch, coding operation. \r
+JPEG 2000 p 505. \r
+<h2>Not fully implemented and tested !!</h2>\r
+@param mqc MQC handle\r
+@param d The symbol to be encoded (0 or 1)\r
+*/\r
+void mqc_bypass_enc(opj_mqc_t *mqc, int d);\r
+/**\r
+BYPASS mode switch, flush operation\r
+<h2>Not fully implemented and tested !!</h2>\r
+@param mqc MQC handle\r
+@return Returns 1 (always)\r
+*/\r
+int mqc_bypass_flush_enc(opj_mqc_t *mqc);\r
+/**\r
+RESET mode switch\r
+@param mqc MQC handle\r
+*/\r
+void mqc_reset_enc(opj_mqc_t *mqc);\r
+/**\r
+RESTART mode switch (TERMALL)\r
+@param mqc MQC handle\r
+@return Returns 1 (always)\r
+*/\r
+int mqc_restart_enc(opj_mqc_t *mqc);\r
+/**\r
+RESTART mode switch (TERMALL) reinitialisation\r
+@param mqc MQC handle\r
+*/\r
+void mqc_restart_init_enc(opj_mqc_t *mqc);\r
+/**\r
+ERTERM mode switch (PTERM)\r
+@param mqc MQC handle\r
+*/\r
+void mqc_erterm_enc(opj_mqc_t *mqc);\r
+/**\r
+SEGMARK mode switch (SEGSYM)\r
+@param mqc MQC handle\r
+*/\r
+void mqc_segmark_enc(opj_mqc_t *mqc);\r
+/**\r
+Initialize the decoder\r
+@param mqc MQC handle\r
+@param bp Pointer to the start of the buffer from which the bytes will be read\r
+@param len Length of the input buffer\r
+*/\r
+void mqc_init_dec(opj_mqc_t *mqc, unsigned char *bp, int len);\r
+/**\r
+Decode a symbol\r
+@param mqc MQC handle\r
+@return Returns the decoded symbol (0 or 1)\r
+*/\r
+int mqc_decode(opj_mqc_t *mqc);\r
+/* ----------------------------------------------------------------------- */\r
+/*@}*/\r
+\r
+/*@}*/\r
+\r
+#endif /* __MQC_H */\r