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
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
20 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
23 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
32 #include "opj_includes.h"
34 /** @defgroup MQC MQC - Implementation of an MQ-Coder */
37 /** @name Local static functions */
41 Output a byte, doing bit-stuffing if necessary.
42 After a 0xff byte, the next byte must be smaller than 0x90.
45 static void mqc_byteout(opj_mqc_t *mqc);
47 Renormalize mqc->a and mqc->c while encoding, so that mqc->a stays between 0x8000 and 0x10000
50 static void mqc_renorme(opj_mqc_t *mqc);
52 Encode the most probable symbol
55 static void mqc_codemps(opj_mqc_t *mqc);
57 Encode the most least symbol
60 static void mqc_codelps(opj_mqc_t *mqc);
62 Fill mqc->c with 1's for flushing
65 static void mqc_setbits(opj_mqc_t *mqc);
67 FIXME: documentation ???
71 static int mqc_mpsexchange(opj_mqc_t *mqc);
73 FIXME: documentation ???
77 static int mqc_lpsexchange(opj_mqc_t *mqc);
82 static void mqc_bytein(opj_mqc_t *mqc);
84 Renormalize mqc->a and mqc->c while decoding
87 static void mqc_renormd(opj_mqc_t *mqc);
94 /* This array defines all the possible states for a context. */
96 static opj_mqc_state_t mqc_states[47 * 2] = {
97 {0x5601, 0, &mqc_states[2], &mqc_states[3]},
98 {0x5601, 1, &mqc_states[3], &mqc_states[2]},
99 {0x3401, 0, &mqc_states[4], &mqc_states[12]},
100 {0x3401, 1, &mqc_states[5], &mqc_states[13]},
101 {0x1801, 0, &mqc_states[6], &mqc_states[18]},
102 {0x1801, 1, &mqc_states[7], &mqc_states[19]},
103 {0x0ac1, 0, &mqc_states[8], &mqc_states[24]},
104 {0x0ac1, 1, &mqc_states[9], &mqc_states[25]},
105 {0x0521, 0, &mqc_states[10], &mqc_states[58]},
106 {0x0521, 1, &mqc_states[11], &mqc_states[59]},
107 {0x0221, 0, &mqc_states[76], &mqc_states[66]},
108 {0x0221, 1, &mqc_states[77], &mqc_states[67]},
109 {0x5601, 0, &mqc_states[14], &mqc_states[13]},
110 {0x5601, 1, &mqc_states[15], &mqc_states[12]},
111 {0x5401, 0, &mqc_states[16], &mqc_states[28]},
112 {0x5401, 1, &mqc_states[17], &mqc_states[29]},
113 {0x4801, 0, &mqc_states[18], &mqc_states[28]},
114 {0x4801, 1, &mqc_states[19], &mqc_states[29]},
115 {0x3801, 0, &mqc_states[20], &mqc_states[28]},
116 {0x3801, 1, &mqc_states[21], &mqc_states[29]},
117 {0x3001, 0, &mqc_states[22], &mqc_states[34]},
118 {0x3001, 1, &mqc_states[23], &mqc_states[35]},
119 {0x2401, 0, &mqc_states[24], &mqc_states[36]},
120 {0x2401, 1, &mqc_states[25], &mqc_states[37]},
121 {0x1c01, 0, &mqc_states[26], &mqc_states[40]},
122 {0x1c01, 1, &mqc_states[27], &mqc_states[41]},
123 {0x1601, 0, &mqc_states[58], &mqc_states[42]},
124 {0x1601, 1, &mqc_states[59], &mqc_states[43]},
125 {0x5601, 0, &mqc_states[30], &mqc_states[29]},
126 {0x5601, 1, &mqc_states[31], &mqc_states[28]},
127 {0x5401, 0, &mqc_states[32], &mqc_states[28]},
128 {0x5401, 1, &mqc_states[33], &mqc_states[29]},
129 {0x5101, 0, &mqc_states[34], &mqc_states[30]},
130 {0x5101, 1, &mqc_states[35], &mqc_states[31]},
131 {0x4801, 0, &mqc_states[36], &mqc_states[32]},
132 {0x4801, 1, &mqc_states[37], &mqc_states[33]},
133 {0x3801, 0, &mqc_states[38], &mqc_states[34]},
134 {0x3801, 1, &mqc_states[39], &mqc_states[35]},
135 {0x3401, 0, &mqc_states[40], &mqc_states[36]},
136 {0x3401, 1, &mqc_states[41], &mqc_states[37]},
137 {0x3001, 0, &mqc_states[42], &mqc_states[38]},
138 {0x3001, 1, &mqc_states[43], &mqc_states[39]},
139 {0x2801, 0, &mqc_states[44], &mqc_states[38]},
140 {0x2801, 1, &mqc_states[45], &mqc_states[39]},
141 {0x2401, 0, &mqc_states[46], &mqc_states[40]},
142 {0x2401, 1, &mqc_states[47], &mqc_states[41]},
143 {0x2201, 0, &mqc_states[48], &mqc_states[42]},
144 {0x2201, 1, &mqc_states[49], &mqc_states[43]},
145 {0x1c01, 0, &mqc_states[50], &mqc_states[44]},
146 {0x1c01, 1, &mqc_states[51], &mqc_states[45]},
147 {0x1801, 0, &mqc_states[52], &mqc_states[46]},
148 {0x1801, 1, &mqc_states[53], &mqc_states[47]},
149 {0x1601, 0, &mqc_states[54], &mqc_states[48]},
150 {0x1601, 1, &mqc_states[55], &mqc_states[49]},
151 {0x1401, 0, &mqc_states[56], &mqc_states[50]},
152 {0x1401, 1, &mqc_states[57], &mqc_states[51]},
153 {0x1201, 0, &mqc_states[58], &mqc_states[52]},
154 {0x1201, 1, &mqc_states[59], &mqc_states[53]},
155 {0x1101, 0, &mqc_states[60], &mqc_states[54]},
156 {0x1101, 1, &mqc_states[61], &mqc_states[55]},
157 {0x0ac1, 0, &mqc_states[62], &mqc_states[56]},
158 {0x0ac1, 1, &mqc_states[63], &mqc_states[57]},
159 {0x09c1, 0, &mqc_states[64], &mqc_states[58]},
160 {0x09c1, 1, &mqc_states[65], &mqc_states[59]},
161 {0x08a1, 0, &mqc_states[66], &mqc_states[60]},
162 {0x08a1, 1, &mqc_states[67], &mqc_states[61]},
163 {0x0521, 0, &mqc_states[68], &mqc_states[62]},
164 {0x0521, 1, &mqc_states[69], &mqc_states[63]},
165 {0x0441, 0, &mqc_states[70], &mqc_states[64]},
166 {0x0441, 1, &mqc_states[71], &mqc_states[65]},
167 {0x02a1, 0, &mqc_states[72], &mqc_states[66]},
168 {0x02a1, 1, &mqc_states[73], &mqc_states[67]},
169 {0x0221, 0, &mqc_states[74], &mqc_states[68]},
170 {0x0221, 1, &mqc_states[75], &mqc_states[69]},
171 {0x0141, 0, &mqc_states[76], &mqc_states[70]},
172 {0x0141, 1, &mqc_states[77], &mqc_states[71]},
173 {0x0111, 0, &mqc_states[78], &mqc_states[72]},
174 {0x0111, 1, &mqc_states[79], &mqc_states[73]},
175 {0x0085, 0, &mqc_states[80], &mqc_states[74]},
176 {0x0085, 1, &mqc_states[81], &mqc_states[75]},
177 {0x0049, 0, &mqc_states[82], &mqc_states[76]},
178 {0x0049, 1, &mqc_states[83], &mqc_states[77]},
179 {0x0025, 0, &mqc_states[84], &mqc_states[78]},
180 {0x0025, 1, &mqc_states[85], &mqc_states[79]},
181 {0x0015, 0, &mqc_states[86], &mqc_states[80]},
182 {0x0015, 1, &mqc_states[87], &mqc_states[81]},
183 {0x0009, 0, &mqc_states[88], &mqc_states[82]},
184 {0x0009, 1, &mqc_states[89], &mqc_states[83]},
185 {0x0005, 0, &mqc_states[90], &mqc_states[84]},
186 {0x0005, 1, &mqc_states[91], &mqc_states[85]},
187 {0x0001, 0, &mqc_states[90], &mqc_states[86]},
188 {0x0001, 1, &mqc_states[91], &mqc_states[87]},
189 {0x5601, 0, &mqc_states[92], &mqc_states[92]},
190 {0x5601, 1, &mqc_states[93], &mqc_states[93]},
194 ==========================================================
196 ==========================================================
199 static void mqc_byteout(opj_mqc_t *mqc) {
200 if (*mqc->bp == 0xff) {
202 *mqc->bp = mqc->c >> 20;
206 if ((mqc->c & 0x8000000) == 0) { /* ((mqc->c&0x8000000)==0) CHANGE */
208 *mqc->bp = mqc->c >> 19;
213 if (*mqc->bp == 0xff) {
216 *mqc->bp = mqc->c >> 20;
221 *mqc->bp = mqc->c >> 19;
229 static void mqc_renorme(opj_mqc_t *mqc) {
237 } while ((mqc->a & 0x8000) == 0);
240 static void mqc_codemps(opj_mqc_t *mqc) {
241 mqc->a -= (*mqc->curctx)->qeval;
242 if ((mqc->a & 0x8000) == 0) {
243 if (mqc->a < (*mqc->curctx)->qeval) {
244 mqc->a = (*mqc->curctx)->qeval;
246 mqc->c += (*mqc->curctx)->qeval;
248 *mqc->curctx = (*mqc->curctx)->nmps;
251 mqc->c += (*mqc->curctx)->qeval;
255 static void mqc_codelps(opj_mqc_t *mqc) {
256 mqc->a -= (*mqc->curctx)->qeval;
257 if (mqc->a < (*mqc->curctx)->qeval) {
258 mqc->c += (*mqc->curctx)->qeval;
260 mqc->a = (*mqc->curctx)->qeval;
262 *mqc->curctx = (*mqc->curctx)->nlps;
266 static void mqc_setbits(opj_mqc_t *mqc) {
267 unsigned int tempc = mqc->c + mqc->a;
269 if (mqc->c >= tempc) {
274 static int mqc_mpsexchange(opj_mqc_t *mqc) {
276 if (mqc->a < (*mqc->curctx)->qeval) {
277 d = 1 - (*mqc->curctx)->mps;
278 *mqc->curctx = (*mqc->curctx)->nlps;
280 d = (*mqc->curctx)->mps;
281 *mqc->curctx = (*mqc->curctx)->nmps;
287 static int mqc_lpsexchange(opj_mqc_t *mqc) {
289 if (mqc->a < (*mqc->curctx)->qeval) {
290 mqc->a = (*mqc->curctx)->qeval;
291 d = (*mqc->curctx)->mps;
292 *mqc->curctx = (*mqc->curctx)->nmps;
294 mqc->a = (*mqc->curctx)->qeval;
295 d = 1 - (*mqc->curctx)->mps;
296 *mqc->curctx = (*mqc->curctx)->nlps;
302 static void mqc_bytein(opj_mqc_t *mqc) {
303 if (mqc->bp != mqc->end) {
305 if (mqc->bp + 1 != mqc->end) {
310 if (*mqc->bp == 0xff) {
330 static void mqc_renormd(opj_mqc_t *mqc) {
338 } while (mqc->a < 0x8000);
342 ==========================================================
344 ==========================================================
347 opj_mqc_t* mqc_create() {
348 opj_mqc_t *mqc = (opj_mqc_t*)opj_malloc(sizeof(opj_mqc_t));
352 void mqc_destroy(opj_mqc_t *mqc) {
358 int mqc_numbytes(opj_mqc_t *mqc) {
359 return mqc->bp - mqc->start;
362 void mqc_init_enc(opj_mqc_t *mqc, unsigned char *bp) {
363 mqc_setcurctx(mqc, 0);
368 if (*mqc->bp == 0xff) {
374 void mqc_setcurctx(opj_mqc_t *mqc, int ctxno) {
375 mqc->curctx = &mqc->ctxs[ctxno];
378 void mqc_encode(opj_mqc_t *mqc, int d) {
379 if ((*mqc->curctx)->mps == d) {
386 void mqc_flush(opj_mqc_t *mqc) {
393 if (*mqc->bp != 0xff) {
398 void mqc_bypass_init_enc(opj_mqc_t *mqc) {
401 /*if (*mqc->bp == 0xff) {
406 void mqc_bypass_enc(opj_mqc_t *mqc, int d) {
408 mqc->c = mqc->c + (d << mqc->ct);
413 if (*mqc->bp == 0xff) {
420 int mqc_bypass_flush_enc(opj_mqc_t *mqc) {
421 unsigned char bit_padding;
426 while (mqc->ct > 0) {
428 mqc->c += bit_padding << mqc->ct;
429 bit_padding = (bit_padding + 1) & 0x01;
440 void mqc_reset_enc(opj_mqc_t *mqc) {
441 mqc_resetstates(mqc);
442 mqc_setstate(mqc, 18, 0, 46);
443 mqc_setstate(mqc, 0, 0, 3);
444 mqc_setstate(mqc, 1, 0, 4);
447 int mqc_restart_enc(opj_mqc_t *mqc) {
451 int n = 27 - 15 - mqc->ct;
463 void mqc_restart_init_enc(opj_mqc_t *mqc) {
465 mqc_setcurctx(mqc, 0);
470 if (*mqc->bp == 0xff) {
475 void mqc_erterm_enc(opj_mqc_t *mqc) {
476 int k = 11 - mqc->ct + 1;
485 if (*mqc->bp != 0xff) {
490 void mqc_segmark_enc(opj_mqc_t *mqc) {
492 mqc_setcurctx(mqc, 18);
494 for (i = 1; i < 5; i++) {
495 mqc_encode(mqc, i % 2);
499 void mqc_init_dec(opj_mqc_t *mqc, unsigned char *bp, int len) {
500 mqc_setcurctx(mqc, 0);
504 if (len==0) mqc->c = 0xff << 16;
505 else mqc->c = *mqc->bp << 16;
512 int mqc_decode(opj_mqc_t *mqc) {
514 mqc->a -= (*mqc->curctx)->qeval;
515 if ((mqc->c >> 16) < (*mqc->curctx)->qeval) {
516 d = mqc_lpsexchange(mqc);
519 mqc->c -= (*mqc->curctx)->qeval << 16;
520 if ((mqc->a & 0x8000) == 0) {
521 d = mqc_mpsexchange(mqc);
524 d = (*mqc->curctx)->mps;
531 void mqc_resetstates(opj_mqc_t *mqc) {
533 for (i = 0; i < MQC_NUMCTXS; i++) {
534 mqc->ctxs[i] = mqc_states;
538 void mqc_setstate(opj_mqc_t *mqc, int ctxno, int msb, int prob) {
539 mqc->ctxs[ctxno] = &mqc_states[msb + (prob << 1)];