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
8 * Copyright (c) 2008, Jerome Fimes, Communications & Systemes <jerome.fimes@c-s.fr>
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
33 #include "opj_includes.h"
35 /** @defgroup MQC MQC - Implementation of an MQ-Coder */
38 /** @name Local static functions */
42 Output a byte, doing bit-stuffing if necessary.
43 After a 0xff byte, the next byte must be smaller than 0x90.
46 static void opj_mqc_byteout(opj_mqc_t *mqc);
48 Renormalize mqc->a and mqc->c while encoding, so that mqc->a stays between 0x8000 and 0x10000
51 static void opj_mqc_renorme(opj_mqc_t *mqc);
53 Encode the most probable symbol
56 static void opj_mqc_codemps(opj_mqc_t *mqc);
58 Encode the most least symbol
61 static void opj_mqc_codelps(opj_mqc_t *mqc);
63 Fill mqc->c with 1's for flushing
66 static void opj_mqc_setbits(opj_mqc_t *mqc);
72 static INLINE OPJ_INT32 opj_mqc_mpsexchange(opj_mqc_t *const mqc);
78 static INLINE OPJ_INT32 opj_mqc_lpsexchange(opj_mqc_t *const mqc);
83 static INLINE void opj_mqc_bytein(opj_mqc_t *const mqc);
85 Renormalize mqc->a and mqc->c while decoding
88 static INLINE void opj_mqc_renormd(opj_mqc_t *const 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 void opj_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 void opj_mqc_renorme(opj_mqc_t *mqc) {
235 opj_mqc_byteout(mqc);
237 } while ((mqc->a & 0x8000) == 0);
240 void opj_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;
249 opj_mqc_renorme(mqc);
251 mqc->c += (*mqc->curctx)->qeval;
255 void opj_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;
263 opj_mqc_renorme(mqc);
266 void opj_mqc_setbits(opj_mqc_t *mqc) {
267 OPJ_UINT32 tempc = mqc->c + mqc->a;
269 if (mqc->c >= tempc) {
274 static INLINE OPJ_INT32 opj_mqc_mpsexchange(opj_mqc_t *const 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 INLINE OPJ_INT32 opj_mqc_lpsexchange(opj_mqc_t *const 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;
303 static INLINE void opj_mqc_bytein(opj_mqc_t *const mqc) {
304 unsigned int i = *((unsigned int *) mqc->bp);
305 mqc->c += i & 0xffff00;
307 mqc->bp += (i >> 2) & 0x04;
310 static void opj_mqc_bytein(opj_mqc_t *const mqc) {
311 if (mqc->bp != mqc->end) {
313 if (mqc->bp + 1 != mqc->end) {
318 if (*mqc->bp == 0xff) {
339 static INLINE void opj_mqc_renormd(opj_mqc_t *const mqc) {
347 } while (mqc->a < 0x8000);
351 ==========================================================
353 ==========================================================
356 opj_mqc_t* opj_mqc_create(void) {
357 opj_mqc_t *mqc = (opj_mqc_t*)opj_malloc(sizeof(opj_mqc_t));
364 void opj_mqc_destroy(opj_mqc_t *mqc) {
367 opj_free(mqc->buffer);
373 OPJ_UINT32 opj_mqc_numbytes(opj_mqc_t *mqc) {
374 return mqc->bp - mqc->start;
377 void opj_mqc_init_enc(opj_mqc_t *mqc, OPJ_BYTE *bp) {
378 /* TODO MSD: need to take a look to the v2 version */
379 opj_mqc_setcurctx(mqc, 0);
384 if (*mqc->bp == 0xff) {
390 void opj_mqc_encode(opj_mqc_t *mqc, OPJ_UINT32 d) {
391 if ((*mqc->curctx)->mps == d) {
392 opj_mqc_codemps(mqc);
394 opj_mqc_codelps(mqc);
398 void opj_mqc_flush(opj_mqc_t *mqc) {
399 opj_mqc_setbits(mqc);
401 opj_mqc_byteout(mqc);
403 opj_mqc_byteout(mqc);
405 if (*mqc->bp != 0xff) {
410 void opj_mqc_bypass_init_enc(opj_mqc_t *mqc) {
413 /*if (*mqc->bp == 0xff) {
418 void opj_mqc_bypass_enc(opj_mqc_t *mqc, OPJ_UINT32 d) {
420 mqc->c = mqc->c + (d << mqc->ct);
425 if (*mqc->bp == 0xff) {
432 OPJ_UINT32 opj_mqc_bypass_flush_enc(opj_mqc_t *mqc) {
433 OPJ_BYTE bit_padding;
438 while (mqc->ct > 0) {
440 mqc->c += bit_padding << mqc->ct;
441 bit_padding = (bit_padding + 1) & 0x01;
452 void opj_mqc_reset_enc(opj_mqc_t *mqc) {
453 opj_mqc_resetstates(mqc);
454 opj_mqc_setstate(mqc, T1_CTXNO_UNI, 0, 46);
455 opj_mqc_setstate(mqc, T1_CTXNO_AGG, 0, 3);
456 opj_mqc_setstate(mqc, T1_CTXNO_ZC, 0, 4);
459 OPJ_UINT32 opj_mqc_restart_enc(opj_mqc_t *mqc) {
460 OPJ_UINT32 correction = 1;
463 OPJ_INT32 n = 27 - 15 - mqc->ct;
466 opj_mqc_byteout(mqc);
470 opj_mqc_byteout(mqc);
475 void opj_mqc_restart_init_enc(opj_mqc_t *mqc) {
477 opj_mqc_setcurctx(mqc, 0);
482 if (*mqc->bp == 0xff) {
487 void opj_mqc_erterm_enc(opj_mqc_t *mqc) {
488 OPJ_INT32 k = 11 - mqc->ct + 1;
493 opj_mqc_byteout(mqc);
497 if (*mqc->bp != 0xff) {
498 opj_mqc_byteout(mqc);
502 void opj_mqc_segmark_enc(opj_mqc_t *mqc) {
504 opj_mqc_setcurctx(mqc, 18);
506 for (i = 1; i < 5; i++) {
507 opj_mqc_encode(mqc, i % 2);
511 OPJ_BOOL opj_mqc_init_dec(opj_mqc_t *mqc, OPJ_BYTE *bp, OPJ_UINT32 len) {
512 opj_mqc_setcurctx(mqc, 0);
516 if (len==0) mqc->c = 0xff << 16;
517 else mqc->c = *mqc->bp << 16;
519 #ifdef MQC_PERF_OPT /* TODO_MSD: check this option and put in experimental */
523 OPJ_BYTE *end = mqc->end - 1;
524 void* new_buffer = opj_realloc(mqc->buffer, (len + 1) * sizeof(OPJ_UINT32));
526 opj_free(mqc->buffer);
530 mqc->buffer = new_buffer;
532 ip = (OPJ_UINT32 *) mqc->buffer;
540 *ip = 0x00000017 | (c << 9);
543 *ip = 0x00000018 | (c << 8);
549 /* Handle last byte of data */
555 *ip = 0x00000018 | (c << 8);
560 mqc->bp = mqc->buffer;
570 OPJ_INT32 opj_mqc_decode(opj_mqc_t *const mqc) {
572 mqc->a -= (*mqc->curctx)->qeval;
573 if ((mqc->c >> 16) < (*mqc->curctx)->qeval) {
574 d = opj_mqc_lpsexchange(mqc);
575 opj_mqc_renormd(mqc);
577 mqc->c -= (*mqc->curctx)->qeval << 16;
578 if ((mqc->a & 0x8000) == 0) {
579 d = opj_mqc_mpsexchange(mqc);
580 opj_mqc_renormd(mqc);
582 d = (*mqc->curctx)->mps;
589 void opj_mqc_resetstates(opj_mqc_t *mqc) {
591 for (i = 0; i < MQC_NUMCTXS; i++) {
592 mqc->ctxs[i] = mqc_states;
596 void opj_mqc_setstate(opj_mqc_t *mqc, OPJ_UINT32 ctxno, OPJ_UINT32 msb, OPJ_INT32 prob) {
597 mqc->ctxs[ctxno] = &mqc_states[msb + (prob << 1)];