src/lib/openjp2/t1.h

   1 /*
   2  * Copyright (c) 2002-2007, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
   3  * Copyright (c) 2002-2007, Professor Benoit Macq
   4  * Copyright (c) 2001-2003, David Janssens
   5  * Copyright (c) 2002-2003, Yannick Verschueren
   6  * Copyright (c) 2003-2007, Francois-Olivier Devaux and Antonin Descampe
   7  * Copyright (c) 2005, Herve Drolon, FreeImage Team
   8  * All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29  * POSSIBILITY OF SUCH DAMAGE.
  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_SIG_NE 0x0001        /**< Context orientation : North-East direction */
  48 #define T1_SIG_SE 0x0002        /**< Context orientation : South-East direction */
  49 #define T1_SIG_SW 0x0004        /**< Context orientation : South-West direction */
  50 #define T1_SIG_NW 0x0008        /**< Context orientation : North-West direction */
  51 #define T1_SIG_N 0x0010         /**< Context orientation : North direction */
  52 #define T1_SIG_E 0x0020         /**< Context orientation : East direction */
  53 #define T1_SIG_S 0x0040         /**< Context orientation : South direction */
  54 #define T1_SIG_W 0x0080         /**< Context orientation : West direction */
  55 #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)
  56 #define T1_SIG_PRIM (T1_SIG_N|T1_SIG_E|T1_SIG_S|T1_SIG_W)
  57
  58 #define T1_SGN_N 0x0100
  59 #define T1_SGN_E 0x0200
  60 #define T1_SGN_S 0x0400
  61 #define T1_SGN_W 0x0800
  62 #define T1_SGN (T1_SGN_N|T1_SGN_E|T1_SGN_S|T1_SGN_W)
  63
  64 #define T1_SIG 0x1000
  65 #define T1_REFINE 0x2000
  66 #define T1_VISIT 0x4000
  67
  68 #define T1_NUMCTXS_ZC 9
  69 #define T1_NUMCTXS_SC 5
  70 #define T1_NUMCTXS_MAG 3
  71 #define T1_NUMCTXS_AGG 1
  72 #define T1_NUMCTXS_UNI 1
  73
  74 #define T1_CTXNO_ZC 0
  75 #define T1_CTXNO_SC (T1_CTXNO_ZC+T1_NUMCTXS_ZC)
  76 #define T1_CTXNO_MAG (T1_CTXNO_SC+T1_NUMCTXS_SC)
  77 #define T1_CTXNO_AGG (T1_CTXNO_MAG+T1_NUMCTXS_MAG)
  78 #define T1_CTXNO_UNI (T1_CTXNO_AGG+T1_NUMCTXS_AGG)
  79 #define T1_NUMCTXS (T1_CTXNO_UNI+T1_NUMCTXS_UNI)
  80
  81 #define T1_NMSEDEC_FRACBITS (T1_NMSEDEC_BITS-1)
  82
  83 #define T1_TYPE_MQ 0    /**< Normal coding using entropy coder */
  84 #define T1_TYPE_RAW 1   /**< No encoding the information is store under raw format in codestream (mode switch RAW)*/
  85
  86 /* ----------------------------------------------------------------------- */
  87
  88 typedef OPJ_INT16 opj_flag_t;
  89
  90 /**
  91 Tier-1 coding (coding of code-block coefficients)
  92 */
  93 typedef struct opj_t1 {
  94
  95         /** MQC component */
  96         opj_mqc_t *mqc;
  97         /** RAW component */
  98         opj_raw_t *raw;
  99
 100     OPJ_INT32 *data;
 101         opj_flag_t *flags;
 102         OPJ_UINT32 w;
 103         OPJ_UINT32 h;
 104         OPJ_UINT32 datasize;
 105         OPJ_UINT32 flagssize;
 106         OPJ_UINT32 flags_stride;
 107 } opj_t1_t;
 108
 109 #define MACRO_t1_flags(x,y) t1->flags[((x)*(t1->flags_stride))+(y)]
 110
 111 /** @name Exported functions */
 112 /*@{*/
 113 /* ----------------------------------------------------------------------- */
 114
 115 /**
 116 Encode the code-blocks of a tile
 117 @param t1 T1 handle
 118 @param tile The tile to encode
 119 @param tcp Tile coding parameters
 120 @param mct_norms  FIXME DOC
 121 */
 122 OPJ_BOOL opj_t1_encode_cblks(   opj_t1_t *t1,
 123                                 opj_tcd_tile_t *tile,
 124                                 opj_tcp_t *tcp,
 125                                 const OPJ_FLOAT64 * mct_norms);
 126
 127 /**
 128 Decode the code-blocks of a tile
 129 @param t1 T1 handle
 130 @param tilec The tile to decode
 131 @param tccp Tile coding parameters
 132 */
 133 OPJ_BOOL opj_t1_decode_cblks(   opj_t1_t* t1,
 134                                 opj_tcd_tilecomp_t* tilec,
 135                                 opj_tccp_t* tccp);
 136
 137
 138
 139 /**
 140  * Creates a new Tier 1 handle
 141  * and initializes the look-up tables of the Tier-1 coder/decoder
 142  * @return a new T1 handle if successful, returns NULL otherwise
 143 */
 144 opj_t1_t* opj_t1_create(void);
 145
 146 /**
 147  * Destroys a previously created T1 handle
 148  *
 149  * @param p_t1 Tier 1 handle to destroy
 150 */
 151 void opj_t1_destroy(opj_t1_t *p_t1);
 152 /* ----------------------------------------------------------------------- */
 153 /*@}*/
 154
 155 /*@}*/
 156
 157 #endif /* __T1_H */