libopenjpeg/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  * Copyright (c) 2008, Jerome Fimes, Communications & Systemes <jerome.fimes@c-s.fr>
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  24  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30  * POSSIBILITY OF SUCH DAMAGE.
  31  */
  32 #ifndef __T1_H
  33 #define __T1_H
  34 /**
  35 @file t1.h
  36 @brief Implementation of the tier-1 coding (coding of code-block coefficients) (T1)
  37
  38 The functions in T1.C have for goal to realize the tier-1 coding operation. The functions
  39 in T1.C are used by some function in TCD.C.
  40 */
  41 #include "openjpeg.h"
  42 /** @defgroup T1 T1 - Implementation of the tier-1 coding */
  43 /*@{*/
  44 //#include "raw.h"
  45 /* ----------------------------------------------------------------------- */
  46 #define T1_NMSEDEC_BITS 7
  47
  48 #define T1_SIG_NE 0x0001        /**< Context orientation : North-East direction */
  49 #define T1_SIG_SE 0x0002        /**< Context orientation : South-East direction */
  50 #define T1_SIG_SW 0x0004        /**< Context orientation : South-West direction */
  51 #define T1_SIG_NW 0x0008        /**< Context orientation : North-West direction */
  52 #define T1_SIG_N 0x0010         /**< Context orientation : North direction */
  53 #define T1_SIG_E 0x0020         /**< Context orientation : East direction */
  54 #define T1_SIG_S 0x0040         /**< Context orientation : South direction */
  55 #define T1_SIG_W 0x0080         /**< Context orientation : West direction */
  56 #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)
  57 #define T1_SIG_PRIM (T1_SIG_N|T1_SIG_E|T1_SIG_S|T1_SIG_W)
  58
  59 #define T1_SGN_N 0x0100
  60 #define T1_SGN_E 0x0200
  61 #define T1_SGN_S 0x0400
  62 #define T1_SGN_W 0x0800
  63 #define T1_SGN (T1_SGN_N|T1_SGN_E|T1_SGN_S|T1_SGN_W)
  64
  65 #define T1_SIG 0x1000
  66 #define T1_REFINE 0x2000
  67 #define T1_VISIT 0x4000
  68
  69 #define T1_NUMCTXS_ZC 9
  70 #define T1_NUMCTXS_SC 5
  71 #define T1_NUMCTXS_MAG 3
  72 #define T1_NUMCTXS_AGG 1
  73 #define T1_NUMCTXS_UNI 1
  74
  75 #define T1_CTXNO_ZC 0
  76 #define T1_CTXNO_SC (T1_CTXNO_ZC+T1_NUMCTXS_ZC)
  77 #define T1_CTXNO_MAG (T1_CTXNO_SC+T1_NUMCTXS_SC)
  78 #define T1_CTXNO_AGG (T1_CTXNO_MAG+T1_NUMCTXS_MAG)
  79 #define T1_CTXNO_UNI (T1_CTXNO_AGG+T1_NUMCTXS_AGG)
  80 #define T1_NUMCTXS (T1_CTXNO_UNI+T1_NUMCTXS_UNI)
  81
  82 #define T1_NMSEDEC_FRACBITS (T1_NMSEDEC_BITS-1)
  83
  84 #define T1_TYPE_MQ 0    /**< Normal coding using entropy coder */
  85 #define T1_TYPE_RAW 1   /**< No encoding the information is store under raw format in codestream (mode switch RAW)*/
  86
  87 /* ----------------------------------------------------------------------- */
  88 struct opj_common_struct;
  89 struct opj_tcd_tile;
  90 struct opj_tcp;
  91 struct opj_tcd_tilecomp;
  92 struct opj_mqc;
  93 struct opj_raw;
  94 struct opj_tccp;
  95
  96
  97 typedef short flag_t;
  98
  99 /**
 100 Tier-1 coding (coding of code-block coefficients)
 101 */
 102 typedef struct opj_t1 {
 103         /** MQC component */
 104         struct opj_mqc *mqc;
 105         /** RAW component */
 106         struct opj_raw *raw;
 107
 108         OPJ_INT32 *data;
 109         flag_t *flags;
 110         OPJ_UINT32 w;
 111         OPJ_UINT32 h;
 112         OPJ_UINT32 datasize;
 113         OPJ_UINT32 flagssize;
 114         OPJ_UINT32 flags_stride;
 115 } opj_t1_t;
 116
 117 #define MACRO_t1_flags(x,y) t1->flags[((x)*(t1->flags_stride))+(y)]
 118
 119 /** @name Exported functions */
 120 /*@{*/
 121 /* ----------------------------------------------------------------------- */
 122
 123 /**
 124  * Creates a new Tier 1 handle
 125  * and initializes the look-up tables of the Tier-1 coder/decoder
 126  * @return a new T1 handle if successful, returns NULL otherwise
 127 */
 128 opj_t1_t* t1_create();
 129
 130 /**
 131  * Destroys a previously created T1 handle
 132  *
 133  * @param p_t1 Tier 1 handle to destroy
 134 */
 135 void t1_destroy(opj_t1_t *p_t1);
 136
 137 /**
 138 Encode the code-blocks of a tile
 139 @param t1 T1 handle
 140 @param tile The tile to encode
 141 @param tcp Tile coding parameters
 142 */
 143 bool t1_encode_cblks(opj_t1_t *t1, struct opj_tcd_tile *tile, struct opj_tcp *tcp,const OPJ_FLOAT64 * mct_norms);
 144 /**
 145 Decode the code-blocks of a tile
 146 @param t1 T1 handle
 147 @param tile The tile to decode
 148 @param tcp Tile coding parameters
 149 */
 150 void t1_decode_cblks(opj_t1_t* t1, struct opj_tcd_tilecomp* tilec, struct opj_tccp* tccp);
 151 /* ----------------------------------------------------------------------- */
 152 /*@}*/
 153
 154 /*@}*/
 155
 156 #endif /* __T1_H */