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) 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 * Copyright (c) 2008, Jerome Fimes, Communications & Systemes <jerome.fimes@c-s.fr>
15 * All rights reserved.
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions
20 * 1. Redistributions of source code must retain the above copyright
21 * notice, this list of conditions and the following disclaimer.
22 * 2. Redistributions in binary form must reproduce the above copyright
23 * notice, this list of conditions and the following disclaimer in the
24 * documentation and/or other materials provided with the distribution.
26 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
27 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
30 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 * POSSIBILITY OF SUCH DAMAGE.
43 @brief Implementation of an MQ-Coder (MQC)
45 The functions in MQC.C have for goal to realize the MQ-coder operations. The functions
46 in MQC.C are used by some function in T1.C.
49 /** @defgroup MQC MQC - Implementation of an MQ-Coder */
53 This struct defines the state of a context.
55 typedef struct opj_mqc_state {
56 /** the probability of the Least Probable Symbol (0.75->0x8000, 1.5->0xffff) */
58 /** the Most Probable Symbol (0 or 1) */
60 /** next state if the next encoded symbol is the MPS */
61 struct opj_mqc_state *nmps;
62 /** next state if the next encoded symbol is the LPS */
63 struct opj_mqc_state *nlps;
66 #define MQC_NUMCTXS 19
71 typedef struct opj_mqc {
78 opj_mqc_state_t *ctxs[MQC_NUMCTXS];
79 opj_mqc_state_t **curctx;
80 const OPJ_BYTE *lut_ctxno_zc_orient; /* lut_ctxno_zc shifted by 256 * bandno */
82 unsigned char *buffer;
88 /** @name Exported functions */
90 /* ----------------------------------------------------------------------- */
92 Create a new MQC handle
93 @return Returns a new MQC handle if successful, returns NULL otherwise
95 opj_mqc_t* opj_mqc_create(void);
97 Destroy a previously created MQC handle
98 @param mqc MQC handle to destroy
100 void opj_mqc_destroy(opj_mqc_t *mqc);
102 Return the number of bytes written/read since initialisation
103 @param mqc MQC handle
104 @return Returns the number of bytes already encoded
106 OPJ_UINT32 opj_mqc_numbytes(opj_mqc_t *mqc);
108 Reset the states of all the context of the coder/decoder
109 (each context is set to a state where 0 and 1 are more or less equiprobable)
110 @param mqc MQC handle
112 void opj_mqc_resetstates(opj_mqc_t *mqc);
114 Set the state of a particular context
115 @param mqc MQC handle
116 @param ctxno Number that identifies the context
117 @param msb The MSB of the new state of the context
118 @param prob Number that identifies the probability of the symbols for the new state of the context
120 void opj_mqc_setstate(opj_mqc_t *mqc, OPJ_UINT32 ctxno, OPJ_UINT32 msb, OPJ_INT32 prob);
122 Initialize the encoder
123 @param mqc MQC handle
124 @param bp Pointer to the start of the buffer where the bytes will be written
126 void opj_mqc_init_enc(opj_mqc_t *mqc, OPJ_BYTE *bp);
128 Set the current context used for coding/decoding
129 @param mqc MQC handle
130 @param ctxno Number that identifies the context
132 #define opj_mqc_setcurctx(mqc, ctxno) (mqc)->curctx = &(mqc)->ctxs[(OPJ_UINT32)(ctxno)]
134 Encode a symbol using the MQ-coder
135 @param mqc MQC handle
136 @param d The symbol to be encoded (0 or 1)
138 void opj_mqc_encode(opj_mqc_t *mqc, OPJ_UINT32 d);
140 Flush the encoder, so that all remaining data is written
141 @param mqc MQC handle
143 void opj_mqc_flush(opj_mqc_t *mqc);
145 BYPASS mode switch, initialization operation.
147 <h2>Not fully implemented and tested !!</h2>
148 @param mqc MQC handle
150 void opj_mqc_bypass_init_enc(opj_mqc_t *mqc);
152 BYPASS mode switch, coding operation.
154 <h2>Not fully implemented and tested !!</h2>
155 @param mqc MQC handle
156 @param d The symbol to be encoded (0 or 1)
158 void opj_mqc_bypass_enc(opj_mqc_t *mqc, OPJ_UINT32 d);
160 BYPASS mode switch, flush operation
161 <h2>Not fully implemented and tested !!</h2>
162 @param mqc MQC handle
163 @return Returns 1 (always)
165 OPJ_UINT32 opj_mqc_bypass_flush_enc(opj_mqc_t *mqc);
168 @param mqc MQC handle
170 void opj_mqc_reset_enc(opj_mqc_t *mqc);
172 RESTART mode switch (TERMALL)
173 @param mqc MQC handle
174 @return Returns 1 (always)
176 OPJ_UINT32 opj_mqc_restart_enc(opj_mqc_t *mqc);
178 RESTART mode switch (TERMALL) reinitialisation
179 @param mqc MQC handle
181 void opj_mqc_restart_init_enc(opj_mqc_t *mqc);
183 ERTERM mode switch (PTERM)
184 @param mqc MQC handle
186 void opj_mqc_erterm_enc(opj_mqc_t *mqc);
188 SEGMARK mode switch (SEGSYM)
189 @param mqc MQC handle
191 void opj_mqc_segmark_enc(opj_mqc_t *mqc);
193 Initialize the decoder
194 @param mqc MQC handle
195 @param bp Pointer to the start of the buffer from which the bytes will be read
196 @param len Length of the input buffer
198 OPJ_BOOL opj_mqc_init_dec(opj_mqc_t *mqc, OPJ_BYTE *bp, OPJ_UINT32 len);
201 @param mqc MQC handle
202 @return Returns the decoded symbol (0 or 1)
204 static INLINE OPJ_INT32 opj_mqc_decode(opj_mqc_t * const mqc);
205 /* ----------------------------------------------------------------------- */