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.
39 #include "opj_includes.h"
41 /** @defgroup MQC MQC - Implementation of an MQ-Coder */
44 /** @name Local static functions */
48 Output a byte, doing bit-stuffing if necessary.
49 After a 0xff byte, the next byte must be smaller than 0x90.
52 static void opj_mqc_byteout(opj_mqc_t *mqc);
54 Renormalize mqc->a and mqc->c while encoding, so that mqc->a stays between 0x8000 and 0x10000
57 static void opj_mqc_renorme(opj_mqc_t *mqc);
59 Encode the most probable symbol
62 static void opj_mqc_codemps(opj_mqc_t *mqc);
64 Encode the most least symbol
67 static void opj_mqc_codelps(opj_mqc_t *mqc);
69 Fill mqc->c with 1's for flushing
72 static void opj_mqc_setbits(opj_mqc_t *mqc);
78 static INLINE OPJ_INT32 opj_mqc_mpsexchange(opj_mqc_t *const mqc);
84 static INLINE OPJ_INT32 opj_mqc_lpsexchange(opj_mqc_t *const mqc);
89 static INLINE void opj_mqc_bytein(opj_mqc_t *const mqc);
91 Renormalize mqc->a and mqc->c while decoding
94 static INLINE void opj_mqc_renormd(opj_mqc_t *const mqc);
100 /* This array defines all the possible states for a context. */
102 static opj_mqc_state_t mqc_states[47 * 2] = {
103 {0x5601, 0, &mqc_states[2], &mqc_states[3]},
104 {0x5601, 1, &mqc_states[3], &mqc_states[2]},
105 {0x3401, 0, &mqc_states[4], &mqc_states[12]},
106 {0x3401, 1, &mqc_states[5], &mqc_states[13]},
107 {0x1801, 0, &mqc_states[6], &mqc_states[18]},
108 {0x1801, 1, &mqc_states[7], &mqc_states[19]},
109 {0x0ac1, 0, &mqc_states[8], &mqc_states[24]},
110 {0x0ac1, 1, &mqc_states[9], &mqc_states[25]},
111 {0x0521, 0, &mqc_states[10], &mqc_states[58]},
112 {0x0521, 1, &mqc_states[11], &mqc_states[59]},
113 {0x0221, 0, &mqc_states[76], &mqc_states[66]},
114 {0x0221, 1, &mqc_states[77], &mqc_states[67]},
115 {0x5601, 0, &mqc_states[14], &mqc_states[13]},
116 {0x5601, 1, &mqc_states[15], &mqc_states[12]},
117 {0x5401, 0, &mqc_states[16], &mqc_states[28]},
118 {0x5401, 1, &mqc_states[17], &mqc_states[29]},
119 {0x4801, 0, &mqc_states[18], &mqc_states[28]},
120 {0x4801, 1, &mqc_states[19], &mqc_states[29]},
121 {0x3801, 0, &mqc_states[20], &mqc_states[28]},
122 {0x3801, 1, &mqc_states[21], &mqc_states[29]},
123 {0x3001, 0, &mqc_states[22], &mqc_states[34]},
124 {0x3001, 1, &mqc_states[23], &mqc_states[35]},
125 {0x2401, 0, &mqc_states[24], &mqc_states[36]},
126 {0x2401, 1, &mqc_states[25], &mqc_states[37]},
127 {0x1c01, 0, &mqc_states[26], &mqc_states[40]},
128 {0x1c01, 1, &mqc_states[27], &mqc_states[41]},
129 {0x1601, 0, &mqc_states[58], &mqc_states[42]},
130 {0x1601, 1, &mqc_states[59], &mqc_states[43]},
131 {0x5601, 0, &mqc_states[30], &mqc_states[29]},
132 {0x5601, 1, &mqc_states[31], &mqc_states[28]},
133 {0x5401, 0, &mqc_states[32], &mqc_states[28]},
134 {0x5401, 1, &mqc_states[33], &mqc_states[29]},
135 {0x5101, 0, &mqc_states[34], &mqc_states[30]},
136 {0x5101, 1, &mqc_states[35], &mqc_states[31]},
137 {0x4801, 0, &mqc_states[36], &mqc_states[32]},
138 {0x4801, 1, &mqc_states[37], &mqc_states[33]},
139 {0x3801, 0, &mqc_states[38], &mqc_states[34]},
140 {0x3801, 1, &mqc_states[39], &mqc_states[35]},
141 {0x3401, 0, &mqc_states[40], &mqc_states[36]},
142 {0x3401, 1, &mqc_states[41], &mqc_states[37]},
143 {0x3001, 0, &mqc_states[42], &mqc_states[38]},
144 {0x3001, 1, &mqc_states[43], &mqc_states[39]},
145 {0x2801, 0, &mqc_states[44], &mqc_states[38]},
146 {0x2801, 1, &mqc_states[45], &mqc_states[39]},
147 {0x2401, 0, &mqc_states[46], &mqc_states[40]},
148 {0x2401, 1, &mqc_states[47], &mqc_states[41]},
149 {0x2201, 0, &mqc_states[48], &mqc_states[42]},
150 {0x2201, 1, &mqc_states[49], &mqc_states[43]},
151 {0x1c01, 0, &mqc_states[50], &mqc_states[44]},
152 {0x1c01, 1, &mqc_states[51], &mqc_states[45]},
153 {0x1801, 0, &mqc_states[52], &mqc_states[46]},
154 {0x1801, 1, &mqc_states[53], &mqc_states[47]},
155 {0x1601, 0, &mqc_states[54], &mqc_states[48]},
156 {0x1601, 1, &mqc_states[55], &mqc_states[49]},
157 {0x1401, 0, &mqc_states[56], &mqc_states[50]},
158 {0x1401, 1, &mqc_states[57], &mqc_states[51]},
159 {0x1201, 0, &mqc_states[58], &mqc_states[52]},
160 {0x1201, 1, &mqc_states[59], &mqc_states[53]},
161 {0x1101, 0, &mqc_states[60], &mqc_states[54]},
162 {0x1101, 1, &mqc_states[61], &mqc_states[55]},
163 {0x0ac1, 0, &mqc_states[62], &mqc_states[56]},
164 {0x0ac1, 1, &mqc_states[63], &mqc_states[57]},
165 {0x09c1, 0, &mqc_states[64], &mqc_states[58]},
166 {0x09c1, 1, &mqc_states[65], &mqc_states[59]},
167 {0x08a1, 0, &mqc_states[66], &mqc_states[60]},
168 {0x08a1, 1, &mqc_states[67], &mqc_states[61]},
169 {0x0521, 0, &mqc_states[68], &mqc_states[62]},
170 {0x0521, 1, &mqc_states[69], &mqc_states[63]},
171 {0x0441, 0, &mqc_states[70], &mqc_states[64]},
172 {0x0441, 1, &mqc_states[71], &mqc_states[65]},
173 {0x02a1, 0, &mqc_states[72], &mqc_states[66]},
174 {0x02a1, 1, &mqc_states[73], &mqc_states[67]},
175 {0x0221, 0, &mqc_states[74], &mqc_states[68]},
176 {0x0221, 1, &mqc_states[75], &mqc_states[69]},
177 {0x0141, 0, &mqc_states[76], &mqc_states[70]},
178 {0x0141, 1, &mqc_states[77], &mqc_states[71]},
179 {0x0111, 0, &mqc_states[78], &mqc_states[72]},
180 {0x0111, 1, &mqc_states[79], &mqc_states[73]},
181 {0x0085, 0, &mqc_states[80], &mqc_states[74]},
182 {0x0085, 1, &mqc_states[81], &mqc_states[75]},
183 {0x0049, 0, &mqc_states[82], &mqc_states[76]},
184 {0x0049, 1, &mqc_states[83], &mqc_states[77]},
185 {0x0025, 0, &mqc_states[84], &mqc_states[78]},
186 {0x0025, 1, &mqc_states[85], &mqc_states[79]},
187 {0x0015, 0, &mqc_states[86], &mqc_states[80]},
188 {0x0015, 1, &mqc_states[87], &mqc_states[81]},
189 {0x0009, 0, &mqc_states[88], &mqc_states[82]},
190 {0x0009, 1, &mqc_states[89], &mqc_states[83]},
191 {0x0005, 0, &mqc_states[90], &mqc_states[84]},
192 {0x0005, 1, &mqc_states[91], &mqc_states[85]},
193 {0x0001, 0, &mqc_states[90], &mqc_states[86]},
194 {0x0001, 1, &mqc_states[91], &mqc_states[87]},
195 {0x5601, 0, &mqc_states[92], &mqc_states[92]},
196 {0x5601, 1, &mqc_states[93], &mqc_states[93]},
200 ==========================================================
202 ==========================================================
205 void opj_mqc_byteout(opj_mqc_t *mqc) {
206 if (*mqc->bp == 0xff) {
208 *mqc->bp = (OPJ_BYTE)(mqc->c >> 20);
212 if ((mqc->c & 0x8000000) == 0) { /* ((mqc->c&0x8000000)==0) CHANGE */
214 *mqc->bp = (OPJ_BYTE)(mqc->c >> 19);
219 if (*mqc->bp == 0xff) {
222 *mqc->bp = (OPJ_BYTE)(mqc->c >> 20);
227 *mqc->bp = (OPJ_BYTE)(mqc->c >> 19);
235 void opj_mqc_renorme(opj_mqc_t *mqc) {
241 opj_mqc_byteout(mqc);
243 } while ((mqc->a & 0x8000) == 0);
246 void opj_mqc_codemps(opj_mqc_t *mqc) {
247 mqc->a -= (*mqc->curctx)->qeval;
248 if ((mqc->a & 0x8000) == 0) {
249 if (mqc->a < (*mqc->curctx)->qeval) {
250 mqc->a = (*mqc->curctx)->qeval;
252 mqc->c += (*mqc->curctx)->qeval;
254 *mqc->curctx = (*mqc->curctx)->nmps;
255 opj_mqc_renorme(mqc);
257 mqc->c += (*mqc->curctx)->qeval;
261 void opj_mqc_codelps(opj_mqc_t *mqc) {
262 mqc->a -= (*mqc->curctx)->qeval;
263 if (mqc->a < (*mqc->curctx)->qeval) {
264 mqc->c += (*mqc->curctx)->qeval;
266 mqc->a = (*mqc->curctx)->qeval;
268 *mqc->curctx = (*mqc->curctx)->nlps;
269 opj_mqc_renorme(mqc);
272 void opj_mqc_setbits(opj_mqc_t *mqc) {
273 OPJ_UINT32 tempc = mqc->c + mqc->a;
275 if (mqc->c >= tempc) {
280 static INLINE OPJ_INT32 opj_mqc_mpsexchange(opj_mqc_t *const mqc) {
282 if (mqc->a < (*mqc->curctx)->qeval) {
283 d = (OPJ_INT32)(1 - (*mqc->curctx)->mps);
284 *mqc->curctx = (*mqc->curctx)->nlps;
286 d = (OPJ_INT32)(*mqc->curctx)->mps;
287 *mqc->curctx = (*mqc->curctx)->nmps;
293 static INLINE OPJ_INT32 opj_mqc_lpsexchange(opj_mqc_t *const mqc) {
295 if (mqc->a < (*mqc->curctx)->qeval) {
296 mqc->a = (*mqc->curctx)->qeval;
297 d = (OPJ_INT32)(*mqc->curctx)->mps;
298 *mqc->curctx = (*mqc->curctx)->nmps;
300 mqc->a = (*mqc->curctx)->qeval;
301 d = (OPJ_INT32)(1 - (*mqc->curctx)->mps);
302 *mqc->curctx = (*mqc->curctx)->nlps;
309 static INLINE void opj_mqc_bytein(opj_mqc_t *const mqc) {
310 unsigned int i = *((unsigned int *) mqc->bp);
311 mqc->c += i & 0xffff00;
313 mqc->bp += (i >> 2) & 0x04;
316 static void opj_mqc_bytein(opj_mqc_t *const mqc) {
317 if (mqc->bp != mqc->end) {
319 if (mqc->bp + 1 != mqc->end) {
324 if (*mqc->bp == 0xff) {
345 static INLINE void opj_mqc_renormd(opj_mqc_t *const mqc) {
353 } while (mqc->a < 0x8000);
357 ==========================================================
359 ==========================================================
362 opj_mqc_t* opj_mqc_create(void) {
363 opj_mqc_t *mqc = (opj_mqc_t*)opj_malloc(sizeof(opj_mqc_t));
372 void opj_mqc_destroy(opj_mqc_t *mqc) {
376 opj_free(mqc->buffer);
383 OPJ_UINT32 opj_mqc_numbytes(opj_mqc_t *mqc) {
384 const ptrdiff_t diff = mqc->bp - mqc->start;
386 assert( diff <= 0xffffffff && diff >= 0 ); /* UINT32_MAX */
388 return (OPJ_UINT32)diff;
391 void opj_mqc_init_enc(opj_mqc_t *mqc, OPJ_BYTE *bp) {
392 /* TODO MSD: need to take a look to the v2 version */
393 opj_mqc_setcurctx(mqc, 0);
398 if (*mqc->bp == 0xff) {
404 void opj_mqc_encode(opj_mqc_t *mqc, OPJ_UINT32 d) {
405 if ((*mqc->curctx)->mps == d) {
406 opj_mqc_codemps(mqc);
408 opj_mqc_codelps(mqc);
412 void opj_mqc_flush(opj_mqc_t *mqc) {
413 opj_mqc_setbits(mqc);
415 opj_mqc_byteout(mqc);
417 opj_mqc_byteout(mqc);
419 if (*mqc->bp != 0xff) {
424 void opj_mqc_bypass_init_enc(opj_mqc_t *mqc) {
427 /*if (*mqc->bp == 0xff) {
432 void opj_mqc_bypass_enc(opj_mqc_t *mqc, OPJ_UINT32 d) {
434 mqc->c = mqc->c + (d << mqc->ct);
437 *mqc->bp = (OPJ_BYTE)mqc->c;
439 if (*mqc->bp == 0xff) {
446 OPJ_UINT32 opj_mqc_bypass_flush_enc(opj_mqc_t *mqc) {
447 OPJ_BYTE bit_padding;
452 while (mqc->ct > 0) {
454 mqc->c += (OPJ_UINT32)(bit_padding << mqc->ct);
455 bit_padding = (bit_padding + 1) & 0x01;
458 *mqc->bp = (OPJ_BYTE)mqc->c;
466 void opj_mqc_reset_enc(opj_mqc_t *mqc) {
467 opj_mqc_resetstates(mqc);
468 opj_mqc_setstate(mqc, T1_CTXNO_UNI, 0, 46);
469 opj_mqc_setstate(mqc, T1_CTXNO_AGG, 0, 3);
470 opj_mqc_setstate(mqc, T1_CTXNO_ZC, 0, 4);
473 OPJ_UINT32 opj_mqc_restart_enc(opj_mqc_t *mqc) {
474 OPJ_UINT32 correction = 1;
477 OPJ_INT32 n = (OPJ_INT32)(27 - 15 - mqc->ct);
480 opj_mqc_byteout(mqc);
481 n -= (OPJ_INT32)mqc->ct;
484 opj_mqc_byteout(mqc);
489 void opj_mqc_restart_init_enc(opj_mqc_t *mqc) {
491 opj_mqc_setcurctx(mqc, 0);
496 if (*mqc->bp == 0xff) {
501 void opj_mqc_erterm_enc(opj_mqc_t *mqc) {
502 OPJ_INT32 k = (OPJ_INT32)(11 - mqc->ct + 1);
507 opj_mqc_byteout(mqc);
508 k -= (OPJ_INT32)mqc->ct;
511 if (*mqc->bp != 0xff) {
512 opj_mqc_byteout(mqc);
516 void opj_mqc_segmark_enc(opj_mqc_t *mqc) {
518 opj_mqc_setcurctx(mqc, 18);
520 for (i = 1; i < 5; i++) {
521 opj_mqc_encode(mqc, i % 2);
525 OPJ_BOOL opj_mqc_init_dec(opj_mqc_t *mqc, OPJ_BYTE *bp, OPJ_UINT32 len) {
526 opj_mqc_setcurctx(mqc, 0);
530 if (len==0) mqc->c = 0xff << 16;
531 else mqc->c = (OPJ_UINT32)(*mqc->bp << 16);
533 #ifdef MQC_PERF_OPT /* TODO_MSD: check this option and put in experimental */
537 OPJ_BYTE *end = mqc->end - 1;
538 void* new_buffer = opj_realloc(mqc->buffer, (len + 1) * sizeof(OPJ_UINT32));
540 opj_free(mqc->buffer);
544 mqc->buffer = new_buffer;
546 ip = (OPJ_UINT32 *) mqc->buffer;
554 *ip = 0x00000017 | (c << 9);
557 *ip = 0x00000018 | (c << 8);
563 /* Handle last byte of data */
569 *ip = 0x00000018 | (c << 8);
574 mqc->bp = mqc->buffer;
584 OPJ_INT32 opj_mqc_decode(opj_mqc_t *const mqc) {
586 mqc->a -= (*mqc->curctx)->qeval;
587 if ((mqc->c >> 16) < (*mqc->curctx)->qeval) {
588 d = opj_mqc_lpsexchange(mqc);
589 opj_mqc_renormd(mqc);
591 mqc->c -= (*mqc->curctx)->qeval << 16;
592 if ((mqc->a & 0x8000) == 0) {
593 d = opj_mqc_mpsexchange(mqc);
594 opj_mqc_renormd(mqc);
596 d = (OPJ_INT32)(*mqc->curctx)->mps;
603 void opj_mqc_resetstates(opj_mqc_t *mqc) {
605 for (i = 0; i < MQC_NUMCTXS; i++) {
606 mqc->ctxs[i] = mqc_states;
610 void opj_mqc_setstate(opj_mqc_t *mqc, OPJ_UINT32 ctxno, OPJ_UINT32 msb, OPJ_INT32 prob) {
611 mqc->ctxs[ctxno] = &mqc_states[msb + (OPJ_UINT32)(prob << 1)];