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.
7 * Copyright (c) 2001-2003, David Janssens
8 * Copyright (c) 2002-2003, Yannick Verschueren
9 * Copyright (c) 2003-2005, Francois Devaux and Antonin Descampe
10 * Copyright (c) 2005, Herve Drolon, FreeImage Team
11 * Copyright (c) 2002-2005, Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium
12 * All rights reserved.
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 * 2. Redistributions in binary form must reproduce the above copyright
20 * notice, this list of conditions and the following disclaimer in the
21 * documentation and/or other materials provided with the distribution.
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
24 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
27 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 * POSSIBILITY OF SUCH DAMAGE.
39 @brief Implementation of the tier-1 coding (coding of code-block coefficients) (T1)
41 The functions in T1.C have for goal to realize the tier-1 coding operation. The functions
42 in T1.C are used by some function in TCD.C.
45 /** @defgroup T1 T1 - Implementation of the tier-1 coding */
48 /* ----------------------------------------------------------------------- */
49 #define T1_NMSEDEC_BITS 7
51 #define T1_MAXCBLKW 256 /*< Maximum size of code-block (width) */
52 #define T1_MAXCBLKH 256 /*< Maximum size of code-block (heigth) */
53 #define T1_MAXCBLKD 256 /*< Maximum size of code-block (depth) */
54 #define T1_MINCBLKW 4 /*< Minimum size of code-block (width) */
55 #define T1_MINCBLKH 4 /*< Minimum size of code-block (heigth) */
56 #define T1_MINCBLKD 4 /*< Minimum size of code-block (depth) */
62 #define T1_SIG_NE 0x0001 /*< Context orientation : North-East direction */
63 #define T1_SIG_SE 0x0002 /*< Context orientation : South-East direction */
64 #define T1_SIG_SW 0x0004 /*< Context orientation : South-West direction */
65 #define T1_SIG_NW 0x0008 /*< Context orientation : North-West direction */
66 #define T1_SIG_N 0x0010 /*< Context orientation : North direction */
67 #define T1_SIG_E 0x0020 /*< Context orientation : East direction */
68 #define T1_SIG_S 0x0040 /*< Context orientation : South direction */
69 #define T1_SIG_W 0x0080 /*< Context orientation : West direction */
70 #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)
71 #define T1_SIG_PRIM (T1_SIG_N|T1_SIG_E|T1_SIG_S|T1_SIG_W)
73 #define T1_SGN_N 0x0100
74 #define T1_SGN_E 0x0200
75 #define T1_SGN_S 0x0400
76 #define T1_SGN_W 0x0800
77 #define T1_SGN (T1_SGN_N|T1_SGN_E|T1_SGN_S|T1_SGN_W)
80 #define T1_REFINE 0x2000
81 #define T1_VISIT 0x4000
83 #define T1_NUMCTXS_AGG 1
84 #define T1_NUMCTXS_ZC 9
85 #define T1_NUMCTXS_MAG 3
86 #define T1_NUMCTXS_SC 5
87 #define T1_NUMCTXS_UNI 1
89 #define T1_CTXNO_AGG 0
90 #define T1_CTXNO_ZC (T1_CTXNO_AGG+T1_NUMCTXS_AGG)
91 #define T1_CTXNO_MAG (T1_CTXNO_ZC+T1_NUMCTXS_ZC)
92 #define T1_CTXNO_SC (T1_CTXNO_MAG+T1_NUMCTXS_MAG)
93 #define T1_CTXNO_UNI (T1_CTXNO_SC+T1_NUMCTXS_SC)
94 #define T1_NUMCTXS (T1_CTXNO_UNI+T1_NUMCTXS_UNI)
96 #define T1_NMSEDEC_FRACBITS (T1_NMSEDEC_BITS-1)
98 #define T1_TYPE_MQ 0 /*< Normal coding using entropy coder */
99 #define T1_TYPE_RAW 1 /*< No encoding the information is store under raw format in codestream (mode switch RAW)*/
101 /* ----------------------------------------------------------------------- */
104 Tier-1 coding (coding of code-block coefficients)
106 typedef struct opj_t1 {
108 opj_common_ptr cinfo;
114 /** LUTs for context-based coding */
115 int lut_ctxno_zc[1024];
116 int lut_ctxno_sc[256];
117 int lut_ctxno_mag[4096];
119 /** LUTs for decoding normalised MSE */
120 int lut_nmsedec_sig[1 << T1_NMSEDEC_BITS];
121 int lut_nmsedec_sig0[1 << T1_NMSEDEC_BITS];
122 int lut_nmsedec_ref[1 << T1_NMSEDEC_BITS];
123 int lut_nmsedec_ref0[1 << T1_NMSEDEC_BITS];
124 /** Codeblock data */
125 int data[T1_CBLKD][T1_CBLKH][T1_CBLKW];/*int ***data;*/
126 /** Context information for each voxel in codeblock */
127 int flags[T1_CBLKD + 2][T1_CBLKH + 2][T1_CBLKH + 2];/*int ***flags;*/
130 /** @name Exported functions */
132 /* ----------------------------------------------------------------------- */
134 Create a new T1 handle
135 and initialize the look-up tables of the Tier-1 coder/decoder
136 @return Returns a new T1 handle if successful, returns NULL otherwise
139 opj_t1_t* t1_create(opj_common_ptr cinfo);
141 Destroy a previously created T1 handle
142 @param t1 T1 handle to destroy
144 void t1_destroy(opj_t1_t *t1);
146 Encode the code-blocks of a tile
148 @param tile The tile to encode
149 @param tcp Tile coding parameters
151 void t1_encode_cblks(opj_t1_t *t1, opj_tcd_tile_t *tile, opj_tcp_t *tcp);
153 Decode the code-blocks of a tile
155 @param tile The tile to decode
156 @param tcp Tile coding parameters
158 void t1_decode_cblks(opj_t1_t *t1, opj_tcd_tile_t *tile, opj_tcp_t *tcp);
160 Get weigths of MSE decoding
161 @param nmsedec The normalized MSE reduction
169 returns MSE associated to decoding pass
171 double t1_getwmsedec(int nmsedec, int compno, int level[3], int orient,
172 int bpno, double stepsize, int numcomps, int dwtid[3]);
174 /* ----------------------------------------------------------------------- */