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) 2001-2003, David Janssens
8 * Copyright (c) 2002-2003, Yannick Verschueren
9 * Copyright (c) 2003-2005, Francois Devaux and Antonin Descampe
10 * Copyright (c) 2005, Herve Drolon, FreeImage Team
11 * Copyright (c) 2002-2005, Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium
12 * All rights reserved.
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 * 2. Redistributions in binary form must reproduce the above copyright
20 * notice, this list of conditions and the following disclaimer in the
21 * documentation and/or other materials provided with the distribution.
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
24 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
27 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 * POSSIBILITY OF SUCH DAMAGE.
36 #include "opj_includes.h"
38 /** @defgroup MQC MQC - Implementation of an MQ-Coder */
41 /** @name Local static functions */
45 Output a byte, doing bit-stuffing if necessary.
46 After a 0xff byte, the next byte must be smaller than 0x90.
49 static void mqc_byteout(opj_mqc_t *mqc);
51 Renormalize mqc->a and mqc->c while encoding, so that mqc->a stays between 0x8000 and 0x10000
54 static void mqc_renorme(opj_mqc_t *mqc);
56 Encode the most probable symbol
59 static void mqc_codemps(opj_mqc_t *mqc);
61 Encode the most least symbol
64 static void mqc_codelps(opj_mqc_t *mqc);
66 Fill mqc->c with 1's for flushing
69 static void mqc_setbits(opj_mqc_t *mqc);
75 static int mqc_mpsexchange(opj_mqc_t *mqc);
81 static int mqc_lpsexchange(opj_mqc_t *mqc);
86 static void mqc_bytein(opj_mqc_t *mqc);
88 Renormalize mqc->a and mqc->c while decoding
91 static void mqc_renormd(opj_mqc_t *mqc);
98 /* This array defines all the possible states for a context. */
100 static opj_mqc_state_t mqc_states[47 * 2] = {
101 {0x5601, 0, &mqc_states[2], &mqc_states[3]},
102 {0x5601, 1, &mqc_states[3], &mqc_states[2]},
103 {0x3401, 0, &mqc_states[4], &mqc_states[12]},
104 {0x3401, 1, &mqc_states[5], &mqc_states[13]},
105 {0x1801, 0, &mqc_states[6], &mqc_states[18]},
106 {0x1801, 1, &mqc_states[7], &mqc_states[19]},
107 {0x0ac1, 0, &mqc_states[8], &mqc_states[24]},
108 {0x0ac1, 1, &mqc_states[9], &mqc_states[25]},
109 {0x0521, 0, &mqc_states[10], &mqc_states[58]},
110 {0x0521, 1, &mqc_states[11], &mqc_states[59]},
111 {0x0221, 0, &mqc_states[76], &mqc_states[66]},
112 {0x0221, 1, &mqc_states[77], &mqc_states[67]},
113 {0x5601, 0, &mqc_states[14], &mqc_states[13]},
114 {0x5601, 1, &mqc_states[15], &mqc_states[12]},
115 {0x5401, 0, &mqc_states[16], &mqc_states[28]},
116 {0x5401, 1, &mqc_states[17], &mqc_states[29]},
117 {0x4801, 0, &mqc_states[18], &mqc_states[28]},
118 {0x4801, 1, &mqc_states[19], &mqc_states[29]},
119 {0x3801, 0, &mqc_states[20], &mqc_states[28]},
120 {0x3801, 1, &mqc_states[21], &mqc_states[29]},
121 {0x3001, 0, &mqc_states[22], &mqc_states[34]},
122 {0x3001, 1, &mqc_states[23], &mqc_states[35]},
123 {0x2401, 0, &mqc_states[24], &mqc_states[36]},
124 {0x2401, 1, &mqc_states[25], &mqc_states[37]},
125 {0x1c01, 0, &mqc_states[26], &mqc_states[40]},
126 {0x1c01, 1, &mqc_states[27], &mqc_states[41]},
127 {0x1601, 0, &mqc_states[58], &mqc_states[42]},
128 {0x1601, 1, &mqc_states[59], &mqc_states[43]},
129 {0x5601, 0, &mqc_states[30], &mqc_states[29]},
130 {0x5601, 1, &mqc_states[31], &mqc_states[28]},
131 {0x5401, 0, &mqc_states[32], &mqc_states[28]},
132 {0x5401, 1, &mqc_states[33], &mqc_states[29]},
133 {0x5101, 0, &mqc_states[34], &mqc_states[30]},
134 {0x5101, 1, &mqc_states[35], &mqc_states[31]},
135 {0x4801, 0, &mqc_states[36], &mqc_states[32]},
136 {0x4801, 1, &mqc_states[37], &mqc_states[33]},
137 {0x3801, 0, &mqc_states[38], &mqc_states[34]},
138 {0x3801, 1, &mqc_states[39], &mqc_states[35]},
139 {0x3401, 0, &mqc_states[40], &mqc_states[36]},
140 {0x3401, 1, &mqc_states[41], &mqc_states[37]},
141 {0x3001, 0, &mqc_states[42], &mqc_states[38]},
142 {0x3001, 1, &mqc_states[43], &mqc_states[39]},
143 {0x2801, 0, &mqc_states[44], &mqc_states[38]},
144 {0x2801, 1, &mqc_states[45], &mqc_states[39]},
145 {0x2401, 0, &mqc_states[46], &mqc_states[40]},
146 {0x2401, 1, &mqc_states[47], &mqc_states[41]},
147 {0x2201, 0, &mqc_states[48], &mqc_states[42]},
148 {0x2201, 1, &mqc_states[49], &mqc_states[43]},
149 {0x1c01, 0, &mqc_states[50], &mqc_states[44]},
150 {0x1c01, 1, &mqc_states[51], &mqc_states[45]},
151 {0x1801, 0, &mqc_states[52], &mqc_states[46]},
152 {0x1801, 1, &mqc_states[53], &mqc_states[47]},
153 {0x1601, 0, &mqc_states[54], &mqc_states[48]},
154 {0x1601, 1, &mqc_states[55], &mqc_states[49]},
155 {0x1401, 0, &mqc_states[56], &mqc_states[50]},
156 {0x1401, 1, &mqc_states[57], &mqc_states[51]},
157 {0x1201, 0, &mqc_states[58], &mqc_states[52]},
158 {0x1201, 1, &mqc_states[59], &mqc_states[53]},
159 {0x1101, 0, &mqc_states[60], &mqc_states[54]},
160 {0x1101, 1, &mqc_states[61], &mqc_states[55]},
161 {0x0ac1, 0, &mqc_states[62], &mqc_states[56]},
162 {0x0ac1, 1, &mqc_states[63], &mqc_states[57]},
163 {0x09c1, 0, &mqc_states[64], &mqc_states[58]},
164 {0x09c1, 1, &mqc_states[65], &mqc_states[59]},
165 {0x08a1, 0, &mqc_states[66], &mqc_states[60]},
166 {0x08a1, 1, &mqc_states[67], &mqc_states[61]},
167 {0x0521, 0, &mqc_states[68], &mqc_states[62]},
168 {0x0521, 1, &mqc_states[69], &mqc_states[63]},
169 {0x0441, 0, &mqc_states[70], &mqc_states[64]},
170 {0x0441, 1, &mqc_states[71], &mqc_states[65]},
171 {0x02a1, 0, &mqc_states[72], &mqc_states[66]},
172 {0x02a1, 1, &mqc_states[73], &mqc_states[67]},
173 {0x0221, 0, &mqc_states[74], &mqc_states[68]},
174 {0x0221, 1, &mqc_states[75], &mqc_states[69]},
175 {0x0141, 0, &mqc_states[76], &mqc_states[70]},
176 {0x0141, 1, &mqc_states[77], &mqc_states[71]},
177 {0x0111, 0, &mqc_states[78], &mqc_states[72]},
178 {0x0111, 1, &mqc_states[79], &mqc_states[73]},
179 {0x0085, 0, &mqc_states[80], &mqc_states[74]},
180 {0x0085, 1, &mqc_states[81], &mqc_states[75]},
181 {0x0049, 0, &mqc_states[82], &mqc_states[76]},
182 {0x0049, 1, &mqc_states[83], &mqc_states[77]},
183 {0x0025, 0, &mqc_states[84], &mqc_states[78]},
184 {0x0025, 1, &mqc_states[85], &mqc_states[79]},
185 {0x0015, 0, &mqc_states[86], &mqc_states[80]},
186 {0x0015, 1, &mqc_states[87], &mqc_states[81]},
187 {0x0009, 0, &mqc_states[88], &mqc_states[82]},
188 {0x0009, 1, &mqc_states[89], &mqc_states[83]},
189 {0x0005, 0, &mqc_states[90], &mqc_states[84]},
190 {0x0005, 1, &mqc_states[91], &mqc_states[85]},
191 {0x0001, 0, &mqc_states[90], &mqc_states[86]},
192 {0x0001, 1, &mqc_states[91], &mqc_states[87]},
193 {0x5601, 0, &mqc_states[92], &mqc_states[92]},
194 {0x5601, 1, &mqc_states[93], &mqc_states[93]},
198 ==========================================================
200 ==========================================================
203 static void mqc_byteout(opj_mqc_t *mqc)
205 if (*mqc->bp == 0xff) {
207 *mqc->bp = mqc->c >> 20;
211 if ((mqc->c & 0x8000000) == 0) { /* ((mqc->c&0x8000000)==0) CHANGE */
213 *mqc->bp = mqc->c >> 19;
218 if (*mqc->bp == 0xff) {
221 *mqc->bp = mqc->c >> 20;
226 *mqc->bp = mqc->c >> 19;
234 static void mqc_renorme(opj_mqc_t *mqc)
243 } while ((mqc->a & 0x8000) == 0);
246 static void mqc_codemps(opj_mqc_t *mqc)
248 mqc->a -= (*mqc->curctx)->qeval;
249 if ((mqc->a & 0x8000) == 0) {
250 if (mqc->a < (*mqc->curctx)->qeval) {
251 mqc->a = (*mqc->curctx)->qeval;
253 mqc->c += (*mqc->curctx)->qeval;
255 *mqc->curctx = (*mqc->curctx)->nmps;
258 mqc->c += (*mqc->curctx)->qeval;
262 static void mqc_codelps(opj_mqc_t *mqc)
264 mqc->a -= (*mqc->curctx)->qeval;
265 if (mqc->a < (*mqc->curctx)->qeval) {
266 mqc->c += (*mqc->curctx)->qeval;
268 mqc->a = (*mqc->curctx)->qeval;
270 *mqc->curctx = (*mqc->curctx)->nlps;
274 static void mqc_setbits(opj_mqc_t *mqc)
276 unsigned int tempc = mqc->c + mqc->a;
278 if (mqc->c >= tempc) {
283 static int mqc_mpsexchange(opj_mqc_t *mqc)
286 if (mqc->a < (*mqc->curctx)->qeval) {
287 d = 1 - (*mqc->curctx)->mps;
288 *mqc->curctx = (*mqc->curctx)->nlps;
290 d = (*mqc->curctx)->mps;
291 *mqc->curctx = (*mqc->curctx)->nmps;
297 static int mqc_lpsexchange(opj_mqc_t *mqc)
300 if (mqc->a < (*mqc->curctx)->qeval) {
301 mqc->a = (*mqc->curctx)->qeval;
302 d = (*mqc->curctx)->mps;
303 *mqc->curctx = (*mqc->curctx)->nmps;
305 mqc->a = (*mqc->curctx)->qeval;
306 d = 1 - (*mqc->curctx)->mps;
307 *mqc->curctx = (*mqc->curctx)->nlps;
313 static void mqc_bytein(opj_mqc_t *mqc)
315 if (mqc->bp != mqc->end) {
317 if (mqc->bp + 1 != mqc->end) {
322 if (*mqc->bp == 0xff) {
342 static void mqc_renormd(opj_mqc_t *mqc)
351 } while (mqc->a < 0x8000);
355 ==========================================================
357 ==========================================================
360 opj_mqc_t* mqc_create()
362 opj_mqc_t *mqc = (opj_mqc_t*)opj_malloc(sizeof(opj_mqc_t));
366 void mqc_destroy(opj_mqc_t *mqc)
373 int mqc_numbytes(opj_mqc_t *mqc)
375 return mqc->bp - mqc->start;
378 void mqc_init_enc(opj_mqc_t *mqc, unsigned char *bp)
380 mqc_setcurctx(mqc, 0);
385 if (*mqc->bp == 0xff) {
391 void mqc_setcurctx(opj_mqc_t *mqc, int ctxno)
393 mqc->curctx = &mqc->ctxs[ctxno];
396 void mqc_encode(opj_mqc_t *mqc, int d)
398 if ((*mqc->curctx)->mps == d) {
405 void mqc_flush(opj_mqc_t *mqc)
413 if (*mqc->bp != 0xff) {
418 void mqc_bypass_init_enc(opj_mqc_t *mqc)
422 /*if (*mqc->bp == 0xff) {
427 void mqc_bypass_enc(opj_mqc_t *mqc, int d)
430 mqc->c = mqc->c + (d << mqc->ct);
435 if (*mqc->bp == 0xff) {
442 int mqc_bypass_flush_enc(opj_mqc_t *mqc)
444 unsigned char bit_padding;
449 while (mqc->ct > 0) {
451 mqc->c += bit_padding << mqc->ct;
452 bit_padding = (bit_padding + 1) & 0x01;
463 void mqc_reset_enc(opj_mqc_t *mqc)
465 mqc_resetstates(mqc);
466 mqc_setstate(mqc, 18, 0, 46);
467 mqc_setstate(mqc, 0, 0, 3);
468 mqc_setstate(mqc, 1, 0, 4);
471 void mqc_reset_enc_3(opj_mqc_t *mqc)
473 mqc_resetstates(mqc);
474 mqc_setstate(mqc, T1_3D_CTXNO_UNI, 0, 46);
475 mqc_setstate(mqc, T1_3D_CTXNO_AGG, 0, 3);
476 mqc_setstate(mqc, T1_3D_CTXNO_ZC, 0, 4);
479 int mqc_restart_enc(opj_mqc_t *mqc)
484 int n = 27 - 15 - mqc->ct;
496 void mqc_restart_init_enc(opj_mqc_t *mqc)
499 mqc_setcurctx(mqc, 0);
504 if (*mqc->bp == 0xff) {
509 void mqc_erterm_enc(opj_mqc_t *mqc)
511 int k = 11 - mqc->ct + 1;
520 if (*mqc->bp != 0xff) {
525 void mqc_segmark_enc(opj_mqc_t *mqc)
528 mqc_setcurctx(mqc, 18);
530 for (i = 1; i < 5; i++) {
531 mqc_encode(mqc, i % 2);
535 void mqc_init_dec(opj_mqc_t *mqc, unsigned char *bp, int len)
537 mqc_setcurctx(mqc, 0);
544 mqc->c = *mqc->bp << 16;
552 int mqc_decode(opj_mqc_t *mqc)
555 mqc->a -= (*mqc->curctx)->qeval;
556 if ((mqc->c >> 16) < (*mqc->curctx)->qeval) {
557 d = mqc_lpsexchange(mqc);
560 mqc->c -= (*mqc->curctx)->qeval << 16;
561 if ((mqc->a & 0x8000) == 0) {
562 d = mqc_mpsexchange(mqc);
565 d = (*mqc->curctx)->mps;
572 void mqc_resetstates(opj_mqc_t *mqc)
575 for (i = 0; i < MQC_NUMCTXS; i++) {
576 mqc->ctxs[i] = mqc_states;
580 void mqc_setstate(opj_mqc_t *mqc, int ctxno, int msb, int prob)
582 mqc->ctxs[ctxno] = &mqc_states[msb + (prob << 1)];