Spelling fixes (patch by ka7, #890, rebased on top of master)
[openjpeg.git] / src / lib / openjp3d / t1.h
old mode 100755 (executable)
new mode 100644 (file)
index 7b4a18f..a027382
-/*\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, Herve 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 __T1_H\r
-#define __T1_H\r
-/**\r
-@file t1.h\r
-@brief Implementation of the tier-1 coding (coding of code-block coefficients) (T1)\r
-\r
-The functions in T1.C have for goal to realize the tier-1 coding operation. The functions\r
-in T1.C are used by some function in TCD.C.\r
-*/\r
-\r
-/** @defgroup T1 T1 - Implementation of the tier-1 coding */\r
-/*@{*/\r
-\r
-/* ----------------------------------------------------------------------- */\r
-#define T1_NMSEDEC_BITS 7\r
-\r
-#define T1_MAXCBLKW 256        /*< Maximum size of code-block (width) */\r
-#define T1_MAXCBLKH 256        /*< Maximum size of code-block (heigth) */\r
-#define T1_MAXCBLKD 256        /*< Maximum size of code-block (depth) */\r
-#define T1_MINCBLKW 4          /*< Minimum size of code-block (width) */\r
-#define T1_MINCBLKH 4          /*< Minimum size of code-block (heigth) */\r
-#define T1_MINCBLKD 4          /*< Minimum size of code-block (depth) */\r
-#define T1_MAXWHD 18   \r
-#define T1_CBLKW 256\r
-#define T1_CBLKH 256\r
-#define T1_CBLKD 256\r
-\r
-#define T1_SIG_NE 0x0001       /*< Context orientation : North-East direction */\r
-#define T1_SIG_SE 0x0002       /*< Context orientation : South-East direction */\r
-#define T1_SIG_SW 0x0004       /*< Context orientation : South-West direction */\r
-#define T1_SIG_NW 0x0008       /*< Context orientation : North-West direction */\r
-#define T1_SIG_N 0x0010                /*< Context orientation : North direction */\r
-#define T1_SIG_E 0x0020                /*< Context orientation : East direction */\r
-#define T1_SIG_S 0x0040                /*< Context orientation : South direction */\r
-#define T1_SIG_W 0x0080                /*< Context orientation : West direction */\r
-#define T1_SIG_OTH (T1_SIG_N|T1_SIG_NE|T1_SIG_E|T1_SIG_SE|T1_SIG_S|T1_SIG_SW|T1_SIG_W|T1_SIG_NW)\r
-#define T1_SIG_PRIM (T1_SIG_N|T1_SIG_E|T1_SIG_S|T1_SIG_W)\r
-\r
-#define T1_SGN_N 0x0100\r
-#define T1_SGN_E 0x0200\r
-#define T1_SGN_S 0x0400\r
-#define T1_SGN_W 0x0800\r
-#define T1_SGN (T1_SGN_N|T1_SGN_E|T1_SGN_S|T1_SGN_W)\r
-\r
-#define T1_SIG 0x1000\r
-#define T1_REFINE 0x2000\r
-#define T1_VISIT 0x4000\r
-\r
-#define T1_NUMCTXS_AGG 1\r
-#define T1_NUMCTXS_ZC 9\r
-#define T1_NUMCTXS_MAG 3\r
-#define T1_NUMCTXS_SC 5\r
-#define T1_NUMCTXS_UNI 1\r
-\r
-#define T1_CTXNO_AGG 0\r
-#define T1_CTXNO_ZC (T1_CTXNO_AGG+T1_NUMCTXS_AGG)\r
-#define T1_CTXNO_MAG (T1_CTXNO_ZC+T1_NUMCTXS_ZC)\r
-#define T1_CTXNO_SC (T1_CTXNO_MAG+T1_NUMCTXS_MAG)\r
-#define T1_CTXNO_UNI (T1_CTXNO_SC+T1_NUMCTXS_SC)\r
-#define T1_NUMCTXS (T1_CTXNO_UNI+T1_NUMCTXS_UNI)\r
-\r
-#define T1_NMSEDEC_FRACBITS (T1_NMSEDEC_BITS-1)\r
-\r
-#define T1_TYPE_MQ 0   /*< Normal coding using entropy coder */\r
-#define T1_TYPE_RAW 1  /*< No encoding the information is store under raw format in codestream (mode switch RAW)*/\r
-\r
-/* ----------------------------------------------------------------------- */\r
-\r
-/**\r
-Tier-1 coding (coding of code-block coefficients)\r
-*/\r
-typedef struct opj_t1 {\r
-       /** codec context */\r
-       opj_common_ptr cinfo;\r
-\r
-       /** MQC component */\r
-       opj_mqc_t *mqc;\r
-       /** RAW component */\r
-       opj_raw_t *raw;\r
-       /** LUTs for context-based coding */\r
-       int lut_ctxno_zc[1024];\r
-       int lut_ctxno_sc[256];\r
-       int lut_ctxno_mag[4096];\r
-       int lut_spb[256];\r
-       /** LUTs for decoding normalised MSE */\r
-       int lut_nmsedec_sig[1 << T1_NMSEDEC_BITS];\r
-       int lut_nmsedec_sig0[1 << T1_NMSEDEC_BITS];\r
-       int lut_nmsedec_ref[1 << T1_NMSEDEC_BITS];\r
-       int lut_nmsedec_ref0[1 << T1_NMSEDEC_BITS];\r
-       /** Codeblock data */\r
-       int data[T1_CBLKD][T1_CBLKH][T1_CBLKW];//int ***data;\r
-       /** Context information for each voxel in codeblock */\r
-       int flags[T1_CBLKD + 2][T1_CBLKH + 2][T1_CBLKH + 2];//int ***flags;\r
-} opj_t1_t;\r
-\r
-/** @name Exported functions */\r
-/*@{*/\r
-/* ----------------------------------------------------------------------- */\r
-/**\r
-Create a new T1 handle \r
-and initialize the look-up tables of the Tier-1 coder/decoder\r
-@return Returns a new T1 handle if successful, returns NULL otherwise\r
-@see t1_init_luts\r
-*/\r
-opj_t1_t* t1_create(opj_common_ptr cinfo);\r
-/**\r
-Destroy a previously created T1 handle\r
-@param t1 T1 handle to destroy\r
-*/\r
-void t1_destroy(opj_t1_t *t1);\r
-/**\r
-Encode the code-blocks of a tile\r
-@param t1 T1 handle\r
-@param tile The tile to encode\r
-@param tcp Tile coding parameters\r
-*/\r
-void t1_encode_cblks(opj_t1_t *t1, opj_tcd_tile_t *tile, opj_tcp_t *tcp);\r
-/**\r
-Decode the code-blocks of a tile\r
-@param t1 T1 handle\r
-@param tile The tile to decode\r
-@param tcp Tile coding parameters\r
-*/\r
-void t1_decode_cblks(opj_t1_t *t1, opj_tcd_tile_t *tile, opj_tcp_t *tcp);\r
-/**\r
-Get weigths of MSE decoding\r
-@param nmsedec The normalized MSE reduction\r
-@param compno \r
-@param level \r
-@param orient\r
-@param bpno\r
-@param stepsize\r
-@param numcomps\r
-@param dwtid\r
-returns MSE associated to decoding pass\r
-*/\r
-double t1_getwmsedec(int nmsedec, int compno, int level[3], int orient, int bpno, double stepsize, int numcomps, int dwtid[3]);\r
-\r
-/* ----------------------------------------------------------------------- */\r
-/*@}*/\r
-\r
-/*@}*/\r
-\r
-#endif /* __T1_H */\r
+/*
+ * 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) 2001-2003, David Janssens
+ * Copyright (c) 2002-2003, Yannick Verschueren
+ * Copyright (c) 2003-2005, Francois Devaux and Antonin Descampe
+ * Copyright (c) 2005, Herve 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 __T1_H
+#define __T1_H
+/**
+@file t1.h
+@brief Implementation of the tier-1 coding (coding of code-block coefficients) (T1)
+
+The functions in T1.C have for goal to realize the tier-1 coding operation. The functions
+in T1.C are used by some function in TCD.C.
+*/
+
+/** @defgroup T1 T1 - Implementation of the tier-1 coding */
+/*@{*/
+
+/* ----------------------------------------------------------------------- */
+#define T1_NMSEDEC_BITS 7
+
+#define T1_MAXCBLKW 256 /*< Maximum size of code-block (width) */
+#define T1_MAXCBLKH 256 /*< Maximum size of code-block (height) */
+#define T1_MAXCBLKD 256 /*< Maximum size of code-block (depth) */
+#define T1_MINCBLKW 4       /*< Minimum size of code-block (width) */
+#define T1_MINCBLKH 4       /*< Minimum size of code-block (height) */
+#define T1_MINCBLKD 4       /*< Minimum size of code-block (depth) */
+#define T1_MAXWHD 18
+#define T1_CBLKW 256
+#define T1_CBLKH 256
+#define T1_CBLKD 256
+
+#define T1_SIG_NE 0x0001    /*< Context orientation : North-East direction */
+#define T1_SIG_SE 0x0002    /*< Context orientation : South-East direction */
+#define T1_SIG_SW 0x0004    /*< Context orientation : South-West direction */
+#define T1_SIG_NW 0x0008    /*< Context orientation : North-West direction */
+#define T1_SIG_N 0x0010     /*< Context orientation : North direction */
+#define T1_SIG_E 0x0020     /*< Context orientation : East direction */
+#define T1_SIG_S 0x0040     /*< Context orientation : South direction */
+#define T1_SIG_W 0x0080     /*< Context orientation : West direction */
+#define T1_SIG_OTH (T1_SIG_N|T1_SIG_NE|T1_SIG_E|T1_SIG_SE|T1_SIG_S|T1_SIG_SW|T1_SIG_W|T1_SIG_NW)
+#define T1_SIG_PRIM (T1_SIG_N|T1_SIG_E|T1_SIG_S|T1_SIG_W)
+
+#define T1_SGN_N 0x0100
+#define T1_SGN_E 0x0200
+#define T1_SGN_S 0x0400
+#define T1_SGN_W 0x0800
+#define T1_SGN (T1_SGN_N|T1_SGN_E|T1_SGN_S|T1_SGN_W)
+
+#define T1_SIG 0x1000
+#define T1_REFINE 0x2000
+#define T1_VISIT 0x4000
+
+#define T1_NUMCTXS_AGG 1
+#define T1_NUMCTXS_ZC 9
+#define T1_NUMCTXS_MAG 3
+#define T1_NUMCTXS_SC 5
+#define T1_NUMCTXS_UNI 1
+
+#define T1_CTXNO_AGG 0
+#define T1_CTXNO_ZC (T1_CTXNO_AGG+T1_NUMCTXS_AGG)
+#define T1_CTXNO_MAG (T1_CTXNO_ZC+T1_NUMCTXS_ZC)
+#define T1_CTXNO_SC (T1_CTXNO_MAG+T1_NUMCTXS_MAG)
+#define T1_CTXNO_UNI (T1_CTXNO_SC+T1_NUMCTXS_SC)
+#define T1_NUMCTXS (T1_CTXNO_UNI+T1_NUMCTXS_UNI)
+
+#define T1_NMSEDEC_FRACBITS (T1_NMSEDEC_BITS-1)
+
+#define T1_TYPE_MQ 0    /*< Normal coding using entropy coder */
+#define T1_TYPE_RAW 1   /*< No encoding the information is store under raw format in codestream (mode switch RAW)*/
+
+/* ----------------------------------------------------------------------- */
+
+/**
+Tier-1 coding (coding of code-block coefficients)
+*/
+typedef struct opj_t1 {
+    /** codec context */
+    opj_common_ptr cinfo;
+
+    /** MQC component */
+    opj_mqc_t *mqc;
+    /** RAW component */
+    opj_raw_t *raw;
+    /** LUTs for context-based coding */
+    int lut_ctxno_zc[1024];
+    int lut_ctxno_sc[256];
+    int lut_ctxno_mag[4096];
+    int lut_spb[256];
+    /** LUTs for decoding normalised MSE */
+    int lut_nmsedec_sig[1 << T1_NMSEDEC_BITS];
+    int lut_nmsedec_sig0[1 << T1_NMSEDEC_BITS];
+    int lut_nmsedec_ref[1 << T1_NMSEDEC_BITS];
+    int lut_nmsedec_ref0[1 << T1_NMSEDEC_BITS];
+    /** Codeblock data */
+    int data[T1_CBLKD][T1_CBLKH][T1_CBLKW];/*int ***data;*/
+    /** Context information for each voxel in codeblock */
+    int flags[T1_CBLKD + 2][T1_CBLKH + 2][T1_CBLKH + 2];/*int ***flags;*/
+} opj_t1_t;
+
+/** @name Exported functions */
+/*@{*/
+/* ----------------------------------------------------------------------- */
+/**
+Create a new T1 handle
+and initialize the look-up tables of the Tier-1 coder/decoder
+@return Returns a new T1 handle if successful, returns NULL otherwise
+@see t1_init_luts
+*/
+opj_t1_t* t1_create(opj_common_ptr cinfo);
+/**
+Destroy a previously created T1 handle
+@param t1 T1 handle to destroy
+*/
+void t1_destroy(opj_t1_t *t1);
+/**
+Encode the code-blocks of a tile
+@param t1 T1 handle
+@param tile The tile to encode
+@param tcp Tile coding parameters
+*/
+void t1_encode_cblks(opj_t1_t *t1, opj_tcd_tile_t *tile, opj_tcp_t *tcp);
+/**
+Decode the code-blocks of a tile
+@param t1 T1 handle
+@param tile The tile to decode
+@param tcp Tile coding parameters
+*/
+void t1_decode_cblks(opj_t1_t *t1, opj_tcd_tile_t *tile, opj_tcp_t *tcp);
+/**
+Get weigths of MSE decoding
+@param nmsedec The normalized MSE reduction
+@param compno
+@param level
+@param orient
+@param bpno
+@param stepsize
+@param numcomps
+@param dwtid
+returns MSE associated to decoding pass
+*/
+double t1_getwmsedec(int nmsedec, int compno, int level[3], int orient,
+                     int bpno, double stepsize, int numcomps, int dwtid[3]);
+
+/* ----------------------------------------------------------------------- */
+/*@}*/
+
+/*@}*/
+
+#endif /* __T1_H */