v2/libopenjpeg/t1.h

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