libjp3dvm/t1.h

   1 /*\r
   2  * Copyright (c) 2001-2003, David Janssens\r
   3  * Copyright (c) 2002-2003, Yannick Verschueren\r
   4  * Copyright (c) 2003-2005, Francois Devaux and Antonin Descampe\r
   5  * Copyright (c) 2005, Herv� Drolon, FreeImage Team\r
   6  * Copyright (c) 2002-2005, Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium\r
   7  * All rights reserved.\r
   8  *\r
   9  * Redistribution and use in source and binary forms, with or without\r
  10  * modification, are permitted provided that the following conditions\r
  11  * are met:\r
  12  * 1. Redistributions of source code must retain the above copyright\r
  13  *    notice, this list of conditions and the following disclaimer.\r
  14  * 2. Redistributions in binary form must reproduce the above copyright\r
  15  *    notice, this list of conditions and the following disclaimer in the\r
  16  *    documentation and/or other materials provided with the distribution.\r
  17  *\r
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'\r
  19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\r
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE\r
  22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR\r
  23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF\r
  24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS\r
  25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN\r
  26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)\r
  27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE\r
  28  * POSSIBILITY OF SUCH DAMAGE.\r
  29  */\r
  30 #ifndef __T1_H\r
  31 #define __T1_H\r
  32 /**\r
  33 @file t1.h\r
  34 @brief Implementation of the tier-1 coding (coding of code-block coefficients) (T1)\r
  35 \r
  36 The functions in T1.C have for goal to realize the tier-1 coding operation. The functions\r
  37 in T1.C are used by some function in TCD.C.\r
  38 */\r
  39 \r
  40 /** @defgroup T1 T1 - Implementation of the tier-1 coding */\r
  41 /*@{*/\r
  42 \r
  43 /* ----------------------------------------------------------------------- */\r
  44 #define T1_NMSEDEC_BITS 7\r
  45 \r
  46 #define T1_MAXCBLKW 256 /*< Maximum size of code-block (width) */\r
  47 #define T1_MAXCBLKH 256 /*< Maximum size of code-block (heigth) */\r
  48 #define T1_MAXCBLKD 256 /*< Maximum size of code-block (depth) */\r
  49 #define T1_MINCBLKW 4           /*< Minimum size of code-block (width) */\r
  50 #define T1_MINCBLKH 4           /*< Minimum size of code-block (heigth) */\r
  51 #define T1_MINCBLKD 4           /*< Minimum size of code-block (depth) */\r
  52 #define T1_MAXWHD 18    \r
  53 #define T1_CBLKW 256\r
  54 #define T1_CBLKH 256\r
  55 #define T1_CBLKD 256\r
  56 \r
  57 #define T1_SIG_NE 0x0001        /*< Context orientation : North-East direction */\r
  58 #define T1_SIG_SE 0x0002        /*< Context orientation : South-East direction */\r
  59 #define T1_SIG_SW 0x0004        /*< Context orientation : South-West direction */\r
  60 #define T1_SIG_NW 0x0008        /*< Context orientation : North-West direction */\r
  61 #define T1_SIG_N 0x0010         /*< Context orientation : North direction */\r
  62 #define T1_SIG_E 0x0020         /*< Context orientation : East direction */\r
  63 #define T1_SIG_S 0x0040         /*< Context orientation : South direction */\r
  64 #define T1_SIG_W 0x0080         /*< Context orientation : West direction */\r
  65 #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
  66 #define T1_SIG_PRIM (T1_SIG_N|T1_SIG_E|T1_SIG_S|T1_SIG_W)\r
  67 \r
  68 #define T1_SGN_N 0x0100\r
  69 #define T1_SGN_E 0x0200\r
  70 #define T1_SGN_S 0x0400\r
  71 #define T1_SGN_W 0x0800\r
  72 #define T1_SGN (T1_SGN_N|T1_SGN_E|T1_SGN_S|T1_SGN_W)\r
  73 \r
  74 #define T1_SIG 0x1000\r
  75 #define T1_REFINE 0x2000\r
  76 #define T1_VISIT 0x4000\r
  77 \r
  78 #define T1_NUMCTXS_AGG 1\r
  79 #define T1_NUMCTXS_ZC 9\r
  80 #define T1_NUMCTXS_MAG 3\r
  81 #define T1_NUMCTXS_SC 5\r
  82 #define T1_NUMCTXS_UNI 1\r
  83 \r
  84 #define T1_CTXNO_AGG 0\r
  85 #define T1_CTXNO_ZC (T1_CTXNO_AGG+T1_NUMCTXS_AGG)\r
  86 #define T1_CTXNO_MAG (T1_CTXNO_ZC+T1_NUMCTXS_ZC)\r
  87 #define T1_CTXNO_SC (T1_CTXNO_MAG+T1_NUMCTXS_MAG)\r
  88 #define T1_CTXNO_UNI (T1_CTXNO_SC+T1_NUMCTXS_SC)\r
  89 #define T1_NUMCTXS (T1_CTXNO_UNI+T1_NUMCTXS_UNI)\r
  90 \r
  91 #define T1_NMSEDEC_FRACBITS (T1_NMSEDEC_BITS-1)\r
  92 \r
  93 #define T1_TYPE_MQ 0    /*< Normal coding using entropy coder */\r
  94 #define T1_TYPE_RAW 1   /*< No encoding the information is store under raw format in codestream (mode switch RAW)*/\r
  95 \r
  96 /* ----------------------------------------------------------------------- */\r
  97 \r
  98 /**\r
  99 Tier-1 coding (coding of code-block coefficients)\r
 100 */\r
 101 typedef struct opj_t1 {\r
 102         /** codec context */\r
 103         opj_common_ptr cinfo;\r
 104 \r
 105         /** MQC component */\r
 106         opj_mqc_t *mqc;\r
 107         /** RAW component */\r
 108         opj_raw_t *raw;\r
 109         /** LUTs for context-based coding */\r
 110         int lut_ctxno_zc[1024];\r
 111         int lut_ctxno_sc[256];\r
 112         int lut_ctxno_mag[4096];\r
 113         int lut_spb[256];\r
 114         /** LUTs for decoding normalised MSE */\r
 115         int lut_nmsedec_sig[1 << T1_NMSEDEC_BITS];\r
 116         int lut_nmsedec_sig0[1 << T1_NMSEDEC_BITS];\r
 117         int lut_nmsedec_ref[1 << T1_NMSEDEC_BITS];\r
 118         int lut_nmsedec_ref0[1 << T1_NMSEDEC_BITS];\r
 119         /** Codeblock data */\r
 120         int data[T1_CBLKD][T1_CBLKH][T1_CBLKW];//int ***data;\r
 121         /** Context information for each voxel in codeblock */\r
 122         int flags[T1_CBLKD + 2][T1_CBLKH + 2][T1_CBLKH + 2];//int ***flags;\r
 123 } opj_t1_t;\r
 124 \r
 125 /** @name Exported functions */\r
 126 /*@{*/\r
 127 /* ----------------------------------------------------------------------- */\r
 128 /**\r
 129 Create a new T1 handle \r
 130 and initialize the look-up tables of the Tier-1 coder/decoder\r
 131 @return Returns a new T1 handle if successful, returns NULL otherwise\r
 132 @see t1_init_luts\r
 133 */\r
 134 opj_t1_t* t1_create(opj_common_ptr cinfo);\r
 135 /**\r
 136 Destroy a previously created T1 handle\r
 137 @param t1 T1 handle to destroy\r
 138 */\r
 139 void t1_destroy(opj_t1_t *t1);\r
 140 /**\r
 141 Encode the code-blocks of a tile\r
 142 @param t1 T1 handle\r
 143 @param tile The tile to encode\r
 144 @param tcp Tile coding parameters\r
 145 */\r
 146 void t1_encode_cblks(opj_t1_t *t1, opj_tcd_tile_t *tile, opj_tcp_t *tcp);\r
 147 /**\r
 148 Decode the code-blocks of a tile\r
 149 @param t1 T1 handle\r
 150 @param tile The tile to decode\r
 151 @param tcp Tile coding parameters\r
 152 */\r
 153 void t1_decode_cblks(opj_t1_t *t1, opj_tcd_tile_t *tile, opj_tcp_t *tcp);\r
 154 /**\r
 155 Get weigths of MSE decoding\r
 156 @param nmsedec The normalized MSE reduction\r
 157 @param compno \r
 158 @param level \r
 159 @param orient\r
 160 @param bpno\r
 161 @param stepsize\r
 162 @param numcomps\r
 163 @param dwtid\r
 164 returns MSE associated to decoding pass\r
 165 */\r
 166 double t1_getwmsedec(int nmsedec, int compno, int level[3], int orient, int bpno, double stepsize, int numcomps, int dwtid[3]);\r
 167 \r
 168 /* ----------------------------------------------------------------------- */\r
 169 /*@}*/\r
 170 \r
 171 /*@}*/\r
 172 \r
 173 #endif /* __T1_H */\r