libopenjpeg/t1.h

   1 /*
   2  * Copyright (c) 2001-2003, David Janssens
   3  * Copyright (c) 2002-2003, Yannick Verschueren
   4  * Copyright (c) 2003-2005, Francois Devaux and Antonin Descampe
   5  * Copyright (c) 2005, Herv� Drolon, FreeImage Team
   6  * Copyright (c) 2002-2005, Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28  * POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef __T1_H
  32 #define __T1_H
  33 /**
  34 @file t1.h
  35 @brief Implementation of the tier-1 coding (coding of code-block coefficients) (T1)
  36
  37 The functions in T1.C have for goal to realize the tier-1 coding operation. The functions
  38 in T1.C are used by some function in TCD.C.
  39 */
  40
  41 /** @defgroup T1 T1 - Implementation of the tier-1 coding */
  42 /*@{*/
  43
  44 /* ----------------------------------------------------------------------- */
  45 #define T1_NMSEDEC_BITS 7
  46
  47 #define T1_MAXCBLKW 1024  /**< Maximum size of code-block (width) */
  48 #define T1_MAXCBLKH 1024  /**< Maximum size of code-block (heigth) */
  49
  50 #define T1_SIG_NE 0x0001  /**< Context orientation : North-East direction */
  51 #define T1_SIG_SE 0x0002  /**< Context orientation : South-East direction */
  52 #define T1_SIG_SW 0x0004  /**< Context orientation : South-West direction */
  53 #define T1_SIG_NW 0x0008  /**< Context orientation : North-West direction */
  54 #define T1_SIG_N 0x0010   /**< Context orientation : North direction */
  55 #define T1_SIG_E 0x0020   /**< Context orientation : East direction */
  56 #define T1_SIG_S 0x0040   /**< Context orientation : South direction */
  57 #define T1_SIG_W 0x0080   /**< Context orientation : West direction */
  58 #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)
  59 #define T1_SIG_PRIM (T1_SIG_N|T1_SIG_E|T1_SIG_S|T1_SIG_W)
  60
  61 #define T1_SGN_N 0x0100
  62 #define T1_SGN_E 0x0200
  63 #define T1_SGN_S 0x0400
  64 #define T1_SGN_W 0x0800
  65 #define T1_SGN (T1_SGN_N|T1_SGN_E|T1_SGN_S|T1_SGN_W)
  66
  67 #define T1_SIG 0x1000
  68 #define T1_REFINE 0x2000
  69 #define T1_VISIT 0x4000
  70
  71 #define T1_NUMCTXS_AGG 1
  72 #define T1_NUMCTXS_ZC 9
  73 #define T1_NUMCTXS_MAG 3
  74 #define T1_NUMCTXS_SC 5
  75 #define T1_NUMCTXS_UNI 1
  76
  77 #define T1_CTXNO_AGG 0
  78 #define T1_CTXNO_ZC (T1_CTXNO_AGG+T1_NUMCTXS_AGG)
  79 #define T1_CTXNO_MAG (T1_CTXNO_ZC+T1_NUMCTXS_ZC)
  80 #define T1_CTXNO_SC (T1_CTXNO_MAG+T1_NUMCTXS_MAG)
  81 #define T1_CTXNO_UNI (T1_CTXNO_SC+T1_NUMCTXS_SC)
  82 #define T1_NUMCTXS (T1_CTXNO_UNI+T1_NUMCTXS_UNI)
  83
  84 #define T1_NMSEDEC_FRACBITS (T1_NMSEDEC_BITS-1)
  85
  86 #define T1_TYPE_MQ 0  /**< Normal coding using entropy coder */
  87 #define T1_TYPE_RAW 1 /**< No encoding the information is store under raw format in codestream (mode switch RAW)*/
  88
  89 /* ----------------------------------------------------------------------- */
  90
  91 /**
  92 Tier-1 coding (coding of code-block coefficients)
  93 */
  94 typedef struct opj_t1 {
  95   /** codec context */
  96   opj_common_ptr cinfo;
  97
  98   /** MQC component */
  99   opj_mqc_t *mqc;
 100   /** RAW component */
 101   opj_raw_t *raw;
 102
 103   int lut_ctxno_zc[1024];
 104   int lut_ctxno_sc[256];
 105   int lut_ctxno_mag[4096];
 106   int lut_spb[256];
 107   int lut_nmsedec_sig[1 << T1_NMSEDEC_BITS];
 108   int lut_nmsedec_sig0[1 << T1_NMSEDEC_BITS];
 109   int lut_nmsedec_ref[1 << T1_NMSEDEC_BITS];
 110   int lut_nmsedec_ref0[1 << T1_NMSEDEC_BITS];
 111
 112   int data[T1_MAXCBLKH][T1_MAXCBLKW];
 113   int flags[T1_MAXCBLKH + 2][T1_MAXCBLKH + 2];
 114
 115 } opj_t1_t;
 116
 117 /** @name Local static functions */
 118 /*@{*/
 119 /* ----------------------------------------------------------------------- */
 120 static int t1_getctxno_zc(opj_t1_t *t1, int f, int orient);
 121 static int t1_getctxno_sc(opj_t1_t *t1, int f);
 122 static int t1_getctxno_mag(opj_t1_t *t1, int f);
 123 static int t1_getspb(opj_t1_t *t1, int f);
 124 static int t1_getnmsedec_sig(opj_t1_t *t1, int x, int bitpos);
 125 static int t1_getnmsedec_ref(opj_t1_t *t1, int x, int bitpos);
 126 static void t1_updateflags(int *fp, int s);
 127 /**
 128 Encode significant pass
 129 */
 130 static void t1_enc_sigpass_step(opj_t1_t *t1, int *fp, int *dp, int orient, int bpno, int one, int *nmsedec, char type, int vsc);
 131 /**
 132 Decode significant pass
 133 */
 134 static void t1_dec_sigpass_step(opj_t1_t *t1, int *fp, int *dp, int orient, int oneplushalf, char type, int vsc);
 135 /**
 136 Encode significant pass
 137 */
 138 static void t1_enc_sigpass(opj_t1_t *t1, int w, int h, int bpno, int orient, int *nmsedec, char type, int cblksty);
 139 /**
 140 Decode significant pass
 141 */
 142 static void t1_dec_sigpass(opj_t1_t *t1, int w, int h, int bpno, int orient, char type, int cblksty);
 143 /**
 144 Encode refinement pass
 145 */
 146 static void t1_enc_refpass_step(opj_t1_t *t1, int *fp, int *dp, int bpno, int one, int *nmsedec, char type, int vsc);
 147 /**
 148 Decode refinement pass
 149 */
 150 static void t1_dec_refpass_step(opj_t1_t *t1, int *fp, int *dp, int poshalf, int neghalf, char type, int vsc);
 151 /**
 152 Encode refinement pass
 153 */
 154 static void t1_enc_refpass(opj_t1_t *t1, int w, int h, int bpno, int *nmsedec, char type, int cblksty);
 155 /**
 156 Decode refinement pass
 157 */
 158 static void t1_dec_refpass(opj_t1_t *t1, int w, int h, int bpno, char type, int cblksty);
 159 /**
 160 Encode clean-up pass
 161 */
 162 static void t1_enc_clnpass_step(opj_t1_t *t1, int *fp, int *dp, int orient, int bpno, int one, int *nmsedec, int partial, int vsc);
 163 /**
 164 Decode clean-up pass
 165 */
 166 static void t1_dec_clnpass_step(opj_t1_t *t1, int *fp, int *dp, int orient, int oneplushalf, int partial, int vsc);
 167 /**
 168 Encode clean-up pass
 169 */
 170 static void t1_enc_clnpass(opj_t1_t *t1, int w, int h, int bpno, int orient, int *nmsedec, int cblksty);
 171 /**
 172 Decode clean-up pass
 173 */
 174 static void t1_dec_clnpass(opj_t1_t *t1, int w, int h, int bpno, int orient, int cblksty);
 175 static double t1_getwmsedec(opj_t1_t *t1, int nmsedec, int compno, int level, int orient, int bpno, int qmfbid, double stepsize, int numcomps);
 176 /**
 177 Encode 1 code-block
 178 @param t1 T1 handle
 179 @param cblk Code-block coding parameters
 180 @param orient
 181 @param compno Component number
 182 @param level
 183 @param qmfbid
 184 @param stepsize
 185 @param cblksty Code-block style
 186 @param numcomps
 187 @param tile
 188 */
 189 static void t1_encode_cblk(opj_t1_t *t1, opj_tcd_cblk_t * cblk, int orient, int compno, int level, int qmfbid, double stepsize, int cblksty, int numcomps, opj_tcd_tile_t * tile);
 190 /**
 191 Decode 1 code-block
 192 @param t1 T1 handle
 193 @param cblk Code-block coding parameters
 194 @param orient
 195 @param roishift Region of interest shifting value
 196 @param cblksty Code-block style
 197 */
 198 static void t1_decode_cblk(opj_t1_t *t1, opj_tcd_cblk_t * cblk, int orient, int roishift, int cblksty);
 199 static int t1_init_ctxno_zc(int f, int orient);
 200 static int t1_init_ctxno_sc(int f);
 201 static int t1_init_ctxno_mag(int f);
 202 static int t1_init_spb(int f);
 203 /**
 204 Initialize the look-up tables of the Tier-1 coder/decoder
 205 @param t1 T1 handle
 206 */
 207 static void t1_init_luts(opj_t1_t *t1);
 208
 209 /* ----------------------------------------------------------------------- */
 210 /*@}*/
 211
 212 /** @name Exported functions */
 213 /*@{*/
 214 /* ----------------------------------------------------------------------- */
 215 /**
 216 Create a new T1 handle
 217 and initialize the look-up tables of the Tier-1 coder/decoder
 218 @return Returns a new T1 handle if successful, returns NULL otherwise
 219 @see t1_init_luts
 220 */
 221 opj_t1_t* t1_create(opj_common_ptr cinfo);
 222 /**
 223 Destroy a previously created T1 handle
 224 @param t1 T1 handle to destroy
 225 */
 226 void t1_destroy(opj_t1_t *t1);
 227 /**
 228 Encode the code-blocks of a tile
 229 @param t1 T1 handle
 230 @param tile The tile to encode
 231 @param tcp Tile coding parameters
 232 */
 233 void t1_encode_cblks(opj_t1_t *t1, opj_tcd_tile_t *tile, opj_tcp_t *tcp);
 234 /**
 235 Decode the code-blocks of a tile
 236 @param t1 T1 handle
 237 @param tile The tile to decode
 238 @param tcp Tile coding parameters
 239 */
 240 void t1_decode_cblks(opj_t1_t *t1, opj_tcd_tile_t *tile, opj_tcp_t *tcp);
 241 /* ----------------------------------------------------------------------- */
 242 /*@}*/
 243
 244 /*@}*/
 245
 246 #endif /* __T1_H */