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 #ifndef __T1_H
  31 #define __T1_H
  32 /**
  33 @file t1.h
  34 @brief Implementation of the tier-1 coding (coding of code-block coefficients) (T1)
  35
  36 The functions in T1.C have for goal to realize the tier-1 coding operation. The functions
  37 in T1.C are used by some function in TCD.C.
  38 */
  39
  40 /** @defgroup T1 T1 - Implementation of the tier-1 coding */
  41 /*@{*/
  42
  43 /* ----------------------------------------------------------------------- */
  44 #define T1_NMSEDEC_BITS 7
  45
  46 #define T1_MAXCBLKW 1024        /**< Maximum size of code-block (width) */
  47 #define T1_MAXCBLKH 1024        /**< Maximum size of code-block (heigth) */
  48
  49 #define T1_SIG_NE 0x0001        /**< Context orientation : North-East direction */
  50 #define T1_SIG_SE 0x0002        /**< Context orientation : South-East direction */
  51 #define T1_SIG_SW 0x0004        /**< Context orientation : South-West direction */
  52 #define T1_SIG_NW 0x0008        /**< Context orientation : North-West direction */
  53 #define T1_SIG_N 0x0010         /**< Context orientation : North direction */
  54 #define T1_SIG_E 0x0020         /**< Context orientation : East direction */
  55 #define T1_SIG_S 0x0040         /**< Context orientation : South direction */
  56 #define T1_SIG_W 0x0080         /**< Context orientation : West direction */
  57 #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)
  58 #define T1_SIG_PRIM (T1_SIG_N|T1_SIG_E|T1_SIG_S|T1_SIG_W)
  59
  60 #define T1_SGN_N 0x0100
  61 #define T1_SGN_E 0x0200
  62 #define T1_SGN_S 0x0400
  63 #define T1_SGN_W 0x0800
  64 #define T1_SGN (T1_SGN_N|T1_SGN_E|T1_SGN_S|T1_SGN_W)
  65
  66 #define T1_SIG 0x1000
  67 #define T1_REFINE 0x2000
  68 #define T1_VISIT 0x4000
  69
  70 #define T1_NUMCTXS_AGG 1
  71 #define T1_NUMCTXS_ZC 9
  72 #define T1_NUMCTXS_MAG 3
  73 #define T1_NUMCTXS_SC 5
  74 #define T1_NUMCTXS_UNI 1
  75
  76 #define T1_CTXNO_AGG 0
  77 #define T1_CTXNO_ZC (T1_CTXNO_AGG+T1_NUMCTXS_AGG)
  78 #define T1_CTXNO_MAG (T1_CTXNO_ZC+T1_NUMCTXS_ZC)
  79 #define T1_CTXNO_SC (T1_CTXNO_MAG+T1_NUMCTXS_MAG)
  80 #define T1_CTXNO_UNI (T1_CTXNO_SC+T1_NUMCTXS_SC)
  81 #define T1_NUMCTXS (T1_CTXNO_UNI+T1_NUMCTXS_UNI)
  82
  83 #define T1_NMSEDEC_FRACBITS (T1_NMSEDEC_BITS-1)
  84
  85 #define T1_TYPE_MQ 0    /**< Normal coding using entropy coder */
  86 #define T1_TYPE_RAW 1   /**< No encoding the information is store under raw format in codestream (mode switch RAW)*/
  87
  88 /* ----------------------------------------------------------------------- */
  89
  90 /**
  91 Tier-1 coding (coding of code-block coefficients)
  92 */
  93 typedef struct opj_t1 {
  94         /** codec context */
  95         opj_common_ptr cinfo;
  96
  97         /** MQC component */
  98         opj_mqc_t *mqc;
  99         /** RAW component */
 100         opj_raw_t *raw;
 101
 102         int lut_ctxno_zc[1024];
 103         int lut_ctxno_sc[256];
 104         int lut_ctxno_mag[4096];
 105         int lut_spb[256];
 106         int lut_nmsedec_sig[1 << T1_NMSEDEC_BITS];
 107         int lut_nmsedec_sig0[1 << T1_NMSEDEC_BITS];
 108         int lut_nmsedec_ref[1 << T1_NMSEDEC_BITS];
 109         int lut_nmsedec_ref0[1 << T1_NMSEDEC_BITS];
 110
 111         int data[T1_MAXCBLKH][T1_MAXCBLKW];
 112         int flags[T1_MAXCBLKH + 2][T1_MAXCBLKH + 2];
 113
 114 } opj_t1_t;
 115
 116 /** @name Exported functions */
 117 /*@{*/
 118 /* ----------------------------------------------------------------------- */
 119 /**
 120 Create a new T1 handle
 121 and initialize the look-up tables of the Tier-1 coder/decoder
 122 @return Returns a new T1 handle if successful, returns NULL otherwise
 123 @see t1_init_luts
 124 */
 125 opj_t1_t* t1_create(opj_common_ptr cinfo);
 126 /**
 127 Destroy a previously created T1 handle
 128 @param t1 T1 handle to destroy
 129 */
 130 void t1_destroy(opj_t1_t *t1);
 131 /**
 132 Encode the code-blocks of a tile
 133 @param t1 T1 handle
 134 @param tile The tile to encode
 135 @param tcp Tile coding parameters
 136 */
 137 void t1_encode_cblks(opj_t1_t *t1, opj_tcd_tile_t *tile, opj_tcp_t *tcp);
 138 /**
 139 Decode the code-blocks of a tile
 140 @param t1 T1 handle
 141 @param tile The tile to decode
 142 @param tcp Tile coding parameters
 143 */
 144 void t1_decode_cblks(opj_t1_t *t1, opj_tcd_tile_t *tile, opj_tcp_t *tcp);
 145 /* ----------------------------------------------------------------------- */
 146 /*@}*/
 147
 148 /*@}*/
 149
 150 #endif /* __T1_H */