src/lib/openjp2/t1.h

   1 /*
   2  * The copyright in this software is being made available under the 2-clauses
   3  * BSD License, included below. This software may be subject to other third
   4  * party and contributor rights, including patent rights, and no such rights
   5  * are granted under this license.
   6  *
   7  * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
   8  * Copyright (c) 2002-2014, Professor Benoit Macq
   9  * Copyright (c) 2001-2003, David Janssens
  10  * Copyright (c) 2002-2003, Yannick Verschueren
  11  * Copyright (c) 2003-2007, Francois-Olivier Devaux
  12  * Copyright (c) 2003-2014, Antonin Descampe
  13  * Copyright (c) 2005, Herve Drolon, FreeImage Team
  14  * All rights reserved.
  15  *
  16  * Redistribution and use in source and binary forms, with or without
  17  * modification, are permitted provided that the following conditions
  18  * are met:
  19  * 1. Redistributions of source code must retain the above copyright
  20  *    notice, this list of conditions and the following disclaimer.
  21  * 2. Redistributions in binary form must reproduce the above copyright
  22  *    notice, this list of conditions and the following disclaimer in the
  23  *    documentation and/or other materials provided with the distribution.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  26  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  29  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  30  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  32  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  33  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  */
  37 #ifndef __T1_H
  38 #define __T1_H
  39 /**
  40 @file t1.h
  41 @brief Implementation of the tier-1 coding (coding of code-block coefficients) (T1)
  42
  43 The functions in T1.C have for goal to realize the tier-1 coding operation. The functions
  44 in T1.C are used by some function in TCD.C.
  45 */
  46
  47 /** @defgroup T1 T1 - Implementation of the tier-1 coding */
  48 /*@{*/
  49
  50 /* ----------------------------------------------------------------------- */
  51 #define T1_NMSEDEC_BITS 7
  52
  53 /* CAUTION: the value of those constants must not be changed, otherwise the */
  54 /* optimization of opj_t1_updateflags() will break! */
  55 /* BEGINNING of flags that apply to opj_flag_t */
  56 #define T1_SIG_NE 0x0001U /**< Context orientation : North-East direction */
  57 #define T1_SIG_SE 0x0002U /**< Context orientation : South-East direction */
  58 #define T1_SIG_SW 0x0004U /**< Context orientation : South-West direction */
  59 #define T1_SIG_NW 0x0008U /**< Context orientation : North-West direction */
  60 #define T1_SIG_N 0x0010U  /**< Context orientation : North direction */
  61 #define T1_SIG_E 0x0020U  /**< Context orientation : East direction */
  62 #define T1_SIG_S 0x0040U  /**< Context orientation : South direction */
  63 #define T1_SIG_W 0x0080U  /**< Context orientation : West direction */
  64 #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)
  65 #define T1_SIG_PRIM (T1_SIG_N|T1_SIG_E|T1_SIG_S|T1_SIG_W)
  66
  67 #define T1_SGN_N 0x0100U
  68 #define T1_SGN_E 0x0200U
  69 #define T1_SGN_S 0x0400U
  70 #define T1_SGN_W 0x0800U
  71 #define T1_SGN (T1_SGN_N|T1_SGN_E|T1_SGN_S|T1_SGN_W)
  72
  73 #define T1_SIG    0x1000U /**< No longer used by decoder */
  74 #define T1_REFINE 0x2000U /**< No longer used by decoder */
  75 #define T1_VISIT  0x4000U /**< No longer used by decoder */
  76 /* END of flags that apply to opj_flag_t */
  77
  78 #define T1_NUMCTXS_ZC  9
  79 #define T1_NUMCTXS_SC  5
  80 #define T1_NUMCTXS_MAG 3
  81 #define T1_NUMCTXS_AGG 1
  82 #define T1_NUMCTXS_UNI 1
  83
  84 #define T1_CTXNO_ZC  0
  85 #define T1_CTXNO_SC  (T1_CTXNO_ZC+T1_NUMCTXS_ZC)
  86 #define T1_CTXNO_MAG (T1_CTXNO_SC+T1_NUMCTXS_SC)
  87 #define T1_CTXNO_AGG (T1_CTXNO_MAG+T1_NUMCTXS_MAG)
  88 #define T1_CTXNO_UNI (T1_CTXNO_AGG+T1_NUMCTXS_AGG)
  89 #define T1_NUMCTXS   (T1_CTXNO_UNI+T1_NUMCTXS_UNI)
  90
  91 #define T1_NMSEDEC_FRACBITS (T1_NMSEDEC_BITS-1)
  92
  93 #define T1_TYPE_MQ 0    /**< Normal coding using entropy coder */
  94 #define T1_TYPE_RAW 1   /**< No encoding the information is store under raw format in codestream (mode switch RAW)*/
  95
  96 /* Those flags are used by opj_colflag_t */
  97 #define T1_COLFLAG_RBS              4U /* RBS = Row Bit Shift */
  98 #define T1_COLFLAG_SIG_OTHER_ROW_0 (1U << 0U)  /**< This sample has at least one significant neighbour */
  99 #define T1_COLFLAG_SIG_ROW_0       (1U << 1U)  /**< This sample is significant */
 100 #define T1_COLFLAG_VISIT_ROW_0     (1U << 2U)  /**< This sample has been visited */
 101 #define T1_COLFLAG_REFINE_ROW_0    (1U << 3U)  /**< This sample has been refined */
 102 #define T1_COLFLAG_SIG_OTHER_ROW_1 (T1_COLFLAG_SIG_OTHER_ROW_0 << (1U * T1_COLFLAG_RBS))
 103 #define T1_COLFLAG_SIG_ROW_1       (T1_COLFLAG_SIG_ROW_0       << (1U * T1_COLFLAG_RBS))
 104 #define T1_COLFLAG_VISIT_ROW_1     (T1_COLFLAG_VISIT_ROW_0     << (1U * T1_COLFLAG_RBS))
 105 #define T1_COLFLAG_REFINE_ROW_1    (T1_COLFLAG_REFINE_ROW_0    << (1U * T1_COLFLAG_RBS))
 106 #define T1_COLFLAG_SIG_OTHER_ROW_2 (T1_COLFLAG_SIG_OTHER_ROW_0 << (2U * T1_COLFLAG_RBS))
 107 #define T1_COLFLAG_SIG_ROW_2       (T1_COLFLAG_SIG_ROW_0       << (2U * T1_COLFLAG_RBS))
 108 #define T1_COLFLAG_VISIT_ROW_2     (T1_COLFLAG_VISIT_ROW_0     << (2U * T1_COLFLAG_RBS))
 109 #define T1_COLFLAG_REFINE_ROW_2    (T1_COLFLAG_REFINE_ROW_0    << (2U * T1_COLFLAG_RBS))
 110 #define T1_COLFLAG_SIG_OTHER_ROW_3 (T1_COLFLAG_SIG_OTHER_ROW_0 << (3U * T1_COLFLAG_RBS))
 111 #define T1_COLFLAG_SIG_ROW_3       (T1_COLFLAG_SIG_ROW_0       << (3U * T1_COLFLAG_RBS))
 112 #define T1_COLFLAG_VISIT_ROW_3     (T1_COLFLAG_VISIT_ROW_0     << (3U * T1_COLFLAG_RBS))
 113 #define T1_COLFLAG_REFINE_ROW_3    (T1_COLFLAG_REFINE_ROW_0    << (3U * T1_COLFLAG_RBS))
 114
 115 /* ----------------------------------------------------------------------- */
 116
 117 typedef OPJ_UINT16 opj_flag_t;
 118
 119 /** Flags for 4 consecutive rows of a column */
 120 typedef OPJ_UINT16 opj_colflag_t;
 121
 122 /**
 123 Tier-1 coding (coding of code-block coefficients)
 124 */
 125 typedef struct opj_t1 {
 126
 127         /** MQC component */
 128         opj_mqc_t *mqc;
 129         /** RAW component */
 130         opj_raw_t *raw;
 131
 132         OPJ_INT32  *data;
 133         opj_flag_t *flags;
 134         /** Addition flag array such that colflags[1+0] is for state of col=0,row=0..3,
 135            colflags[1+1] for col=1, row=0..3, colflags[1+flags_stride] for col=0,row=4..7, ...
 136            This array avoids too much cache trashing when processing by 4 vertical samples
 137            as done in the various decoding steps. */
 138         opj_colflag_t* colflags;
 139         OPJ_UINT32 w;
 140         OPJ_UINT32 h;
 141         OPJ_UINT32 datasize;
 142         OPJ_UINT32 flagssize;
 143         OPJ_UINT32 flags_stride;
 144         OPJ_UINT32 colflags_size;
 145         OPJ_UINT32 data_stride;
 146         OPJ_BOOL   encoder;
 147 } opj_t1_t;
 148
 149 #define MACRO_t1_flags(x,y) t1->flags[((x)*(t1->flags_stride))+(y)]
 150
 151 /** @name Exported functions */
 152 /*@{*/
 153 /* ----------------------------------------------------------------------- */
 154
 155 /**
 156 Encode the code-blocks of a tile
 157 @param t1 T1 handle
 158 @param tile The tile to encode
 159 @param tcp Tile coding parameters
 160 @param mct_norms  FIXME DOC
 161 @param mct_numcomps Number of components used for MCT
 162 */
 163 OPJ_BOOL opj_t1_encode_cblks(   opj_t1_t *t1,
 164                                 opj_tcd_tile_t *tile,
 165                                 opj_tcp_t *tcp,
 166                                 const OPJ_FLOAT64 * mct_norms,
 167                                 OPJ_UINT32 mct_numcomps);
 168
 169 /**
 170 Decode the code-blocks of a tile
 171 @param t1 T1 handle
 172 @param tilec The tile to decode
 173 @param tccp Tile coding parameters
 174 */
 175 void opj_t1_decode_cblks(   opj_thread_pool_t* tp,
 176                                 volatile OPJ_BOOL* pret,
 177                                 opj_tcd_tilecomp_t* tilec,
 178                                 opj_tccp_t* tccp);
 179
 180
 181
 182 /**
 183  * Creates a new Tier 1 handle
 184  * and initializes the look-up tables of the Tier-1 coder/decoder
 185  * @return a new T1 handle if successful, returns NULL otherwise
 186 */
 187 opj_t1_t* opj_t1_create(OPJ_BOOL isEncoder);
 188
 189 /**
 190  * Destroys a previously created T1 handle
 191  *
 192  * @param p_t1 Tier 1 handle to destroy
 193 */
 194 void opj_t1_destroy(opj_t1_t *p_t1);
 195 /* ----------------------------------------------------------------------- */
 196 /*@}*/
 197
 198 /*@}*/
 199
 200 #endif /* __T1_H */