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
43The functions in T1.C have for goal to realize the tier-1 coding operation. The functions
44in 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#define T1_SIG_NE 0x0001	/**< Context orientation : North-East direction */
54#define T1_SIG_SE 0x0002	/**< Context orientation : South-East direction */
55#define T1_SIG_SW 0x0004	/**< Context orientation : South-West direction */
56#define T1_SIG_NW 0x0008	/**< Context orientation : North-West direction */
57#define T1_SIG_N 0x0010		/**< Context orientation : North direction */
58#define T1_SIG_E 0x0020		/**< Context orientation : East direction */
59#define T1_SIG_S 0x0040		/**< Context orientation : South direction */
60#define T1_SIG_W 0x0080		/**< Context orientation : West direction */
61#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)
62#define T1_SIG_PRIM (T1_SIG_N|T1_SIG_E|T1_SIG_S|T1_SIG_W)
63
64#define T1_SGN_N 0x0100
65#define T1_SGN_E 0x0200
66#define T1_SGN_S 0x0400
67#define T1_SGN_W 0x0800
68#define T1_SGN (T1_SGN_N|T1_SGN_E|T1_SGN_S|T1_SGN_W)
69
70#define T1_SIG 0x1000
71#define T1_REFINE 0x2000
72#define T1_VISIT 0x4000
73
74#define T1_NUMCTXS_ZC 9
75#define T1_NUMCTXS_SC 5
76#define T1_NUMCTXS_MAG 3
77#define T1_NUMCTXS_AGG 1
78#define T1_NUMCTXS_UNI 1
79
80#define T1_CTXNO_ZC 0
81#define T1_CTXNO_SC (T1_CTXNO_ZC+T1_NUMCTXS_ZC)
82#define T1_CTXNO_MAG (T1_CTXNO_SC+T1_NUMCTXS_SC)
83#define T1_CTXNO_AGG (T1_CTXNO_MAG+T1_NUMCTXS_MAG)
84#define T1_CTXNO_UNI (T1_CTXNO_AGG+T1_NUMCTXS_AGG)
85#define T1_NUMCTXS (T1_CTXNO_UNI+T1_NUMCTXS_UNI)
86
87#define T1_NMSEDEC_FRACBITS (T1_NMSEDEC_BITS-1)
88
89#define T1_TYPE_MQ 0	/**< Normal coding using entropy coder */
90#define T1_TYPE_RAW 1	/**< No encoding the information is store under raw format in codestream (mode switch RAW)*/
91
92/* ----------------------------------------------------------------------- */
93
94typedef OPJ_INT16 opj_flag_t;
95
96/**
97Tier-1 coding (coding of code-block coefficients)
98*/
99typedef struct opj_t1 {
100
101	/** MQC component */
102	opj_mqc_t *mqc;
103	/** RAW component */
104	opj_raw_t *raw;
105
106	OPJ_INT32  *data;
107	opj_flag_t *flags;
108	OPJ_UINT32 w;
109	OPJ_UINT32 h;
110	OPJ_UINT32 datasize;
111	OPJ_UINT32 flagssize;
112	OPJ_UINT32 flags_stride;
113	OPJ_UINT32 data_stride;
114	OPJ_BOOL   encoder;
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/**
124Encode the code-blocks of a tile
125@param t1 T1 handle
126@param tile The tile to encode
127@param tcp Tile coding parameters
128@param mct_norms  FIXME DOC
129@param mct_numcomps Number of components used for MCT
130*/
131OPJ_BOOL opj_t1_encode_cblks(   opj_t1_t *t1,
132                                opj_tcd_tile_t *tile,
133                                opj_tcp_t *tcp,
134                                const OPJ_FLOAT64 * mct_norms,
135                                OPJ_UINT32 mct_numcomps);
136
137/**
138Decode the code-blocks of a tile
139@param t1 T1 handle
140@param tilec The tile to decode
141@param tccp Tile coding parameters
142*/
143OPJ_BOOL opj_t1_decode_cblks(   opj_t1_t* t1,
144                                opj_tcd_tilecomp_t* tilec,
145                                opj_tccp_t* tccp);
146
147
148
149/**
150 * Creates a new Tier 1 handle
151 * and initializes the look-up tables of the Tier-1 coder/decoder
152 * @return a new T1 handle if successful, returns NULL otherwise
153*/
154opj_t1_t* opj_t1_create(OPJ_BOOL isEncoder);
155
156/**
157 * Destroys a previously created T1 handle
158 *
159 * @param p_t1 Tier 1 handle to destroy
160*/
161void opj_t1_destroy(opj_t1_t *p_t1);
162/* ----------------------------------------------------------------------- */
163/*@}*/
164
165/*@}*/
166
167#endif /* __T1_H */
168