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 /* This array defines all the possible states for a context. */
80 static opj_mqc_state_t mqc_states[47 * 2] = {
81 {0x5601, 0, &mqc_states[2], &mqc_states[3]},
82 {0x5601, 1, &mqc_states[3], &mqc_states[2]},
83 {0x3401, 0, &mqc_states[4], &mqc_states[12]},
84 {0x3401, 1, &mqc_states[5], &mqc_states[13]},
85 {0x1801, 0, &mqc_states[6], &mqc_states[18]},
86 {0x1801, 1, &mqc_states[7], &mqc_states[19]},
87 {0x0ac1, 0, &mqc_states[8], &mqc_states[24]},
88 {0x0ac1, 1, &mqc_states[9], &mqc_states[25]},
89 {0x0521, 0, &mqc_states[10], &mqc_states[58]},
90 {0x0521, 1, &mqc_states[11], &mqc_states[59]},
91 {0x0221, 0, &mqc_states[76], &mqc_states[66]},
92 {0x0221, 1, &mqc_states[77], &mqc_states[67]},
93 {0x5601, 0, &mqc_states[14], &mqc_states[13]},
94 {0x5601, 1, &mqc_states[15], &mqc_states[12]},
95 {0x5401, 0, &mqc_states[16], &mqc_states[28]},
96 {0x5401, 1, &mqc_states[17], &mqc_states[29]},
97 {0x4801, 0, &mqc_states[18], &mqc_states[28]},
98 {0x4801, 1, &mqc_states[19], &mqc_states[29]},
99 {0x3801, 0, &mqc_states[20], &mqc_states[28]},
100 {0x3801, 1, &mqc_states[21], &mqc_states[29]},
101 {0x3001, 0, &mqc_states[22], &mqc_states[34]},
102 {0x3001, 1, &mqc_states[23], &mqc_states[35]},
103 {0x2401, 0, &mqc_states[24], &mqc_states[36]},
104 {0x2401, 1, &mqc_states[25], &mqc_states[37]},
105 {0x1c01, 0, &mqc_states[26], &mqc_states[40]},
106 {0x1c01, 1, &mqc_states[27], &mqc_states[41]},
107 {0x1601, 0, &mqc_states[58], &mqc_states[42]},
108 {0x1601, 1, &mqc_states[59], &mqc_states[43]},
109 {0x5601, 0, &mqc_states[30], &mqc_states[29]},
110 {0x5601, 1, &mqc_states[31], &mqc_states[28]},
111 {0x5401, 0, &mqc_states[32], &mqc_states[28]},
112 {0x5401, 1, &mqc_states[33], &mqc_states[29]},
113 {0x5101, 0, &mqc_states[34], &mqc_states[30]},
114 {0x5101, 1, &mqc_states[35], &mqc_states[31]},
115 {0x4801, 0, &mqc_states[36], &mqc_states[32]},
116 {0x4801, 1, &mqc_states[37], &mqc_states[33]},
117 {0x3801, 0, &mqc_states[38], &mqc_states[34]},
118 {0x3801, 1, &mqc_states[39], &mqc_states[35]},
119 {0x3401, 0, &mqc_states[40], &mqc_states[36]},
120 {0x3401, 1, &mqc_states[41], &mqc_states[37]},
121 {0x3001, 0, &mqc_states[42], &mqc_states[38]},
122 {0x3001, 1, &mqc_states[43], &mqc_states[39]},
123 {0x2801, 0, &mqc_states[44], &mqc_states[38]},
124 {0x2801, 1, &mqc_states[45], &mqc_states[39]},
125 {0x2401, 0, &mqc_states[46], &mqc_states[40]},
126 {0x2401, 1, &mqc_states[47], &mqc_states[41]},
127 {0x2201, 0, &mqc_states[48], &mqc_states[42]},
128 {0x2201, 1, &mqc_states[49], &mqc_states[43]},
129 {0x1c01, 0, &mqc_states[50], &mqc_states[44]},
130 {0x1c01, 1, &mqc_states[51], &mqc_states[45]},
131 {0x1801, 0, &mqc_states[52], &mqc_states[46]},
132 {0x1801, 1, &mqc_states[53], &mqc_states[47]},
133 {0x1601, 0, &mqc_states[54], &mqc_states[48]},
134 {0x1601, 1, &mqc_states[55], &mqc_states[49]},
135 {0x1401, 0, &mqc_states[56], &mqc_states[50]},
136 {0x1401, 1, &mqc_states[57], &mqc_states[51]},
137 {0x1201, 0, &mqc_states[58], &mqc_states[52]},
138 {0x1201, 1, &mqc_states[59], &mqc_states[53]},
139 {0x1101, 0, &mqc_states[60], &mqc_states[54]},
140 {0x1101, 1, &mqc_states[61], &mqc_states[55]},
141 {0x0ac1, 0, &mqc_states[62], &mqc_states[56]},
142 {0x0ac1, 1, &mqc_states[63], &mqc_states[57]},
143 {0x09c1, 0, &mqc_states[64], &mqc_states[58]},
144 {0x09c1, 1, &mqc_states[65], &mqc_states[59]},
145 {0x08a1, 0, &mqc_states[66], &mqc_states[60]},
146 {0x08a1, 1, &mqc_states[67], &mqc_states[61]},
147 {0x0521, 0, &mqc_states[68], &mqc_states[62]},
148 {0x0521, 1, &mqc_states[69], &mqc_states[63]},
149 {0x0441, 0, &mqc_states[70], &mqc_states[64]},
150 {0x0441, 1, &mqc_states[71], &mqc_states[65]},
151 {0x02a1, 0, &mqc_states[72], &mqc_states[66]},
152 {0x02a1, 1, &mqc_states[73], &mqc_states[67]},
153 {0x0221, 0, &mqc_states[74], &mqc_states[68]},
154 {0x0221, 1, &mqc_states[75], &mqc_states[69]},
155 {0x0141, 0, &mqc_states[76], &mqc_states[70]},
156 {0x0141, 1, &mqc_states[77], &mqc_states[71]},
157 {0x0111, 0, &mqc_states[78], &mqc_states[72]},
158 {0x0111, 1, &mqc_states[79], &mqc_states[73]},
159 {0x0085, 0, &mqc_states[80], &mqc_states[74]},
160 {0x0085, 1, &mqc_states[81], &mqc_states[75]},
161 {0x0049, 0, &mqc_states[82], &mqc_states[76]},
162 {0x0049, 1, &mqc_states[83], &mqc_states[77]},
163 {0x0025, 0, &mqc_states[84], &mqc_states[78]},
164 {0x0025, 1, &mqc_states[85], &mqc_states[79]},
165 {0x0015, 0, &mqc_states[86], &mqc_states[80]},
166 {0x0015, 1, &mqc_states[87], &mqc_states[81]},
167 {0x0009, 0, &mqc_states[88], &mqc_states[82]},
168 {0x0009, 1, &mqc_states[89], &mqc_states[83]},
169 {0x0005, 0, &mqc_states[90], &mqc_states[84]},
170 {0x0005, 1, &mqc_states[91], &mqc_states[85]},
171 {0x0001, 0, &mqc_states[90], &mqc_states[86]},
172 {0x0001, 1, &mqc_states[91], &mqc_states[87]},
173 {0x5601, 0, &mqc_states[92], &mqc_states[92]},
174 {0x5601, 1, &mqc_states[93], &mqc_states[93]},
178 ==========================================================
180 ==========================================================
183 static void opj_mqc_byteout(opj_mqc_t *mqc)
185 /* avoid accessing uninitialized memory*/
186 if (mqc->bp == mqc->start - 1) {
188 *mqc->bp = (OPJ_BYTE)(mqc->c >> 19);
191 } else if (*mqc->bp == 0xff) {
193 *mqc->bp = (OPJ_BYTE)(mqc->c >> 20);
197 if ((mqc->c & 0x8000000) == 0) {
199 *mqc->bp = (OPJ_BYTE)(mqc->c >> 19);
204 if (*mqc->bp == 0xff) {
207 *mqc->bp = (OPJ_BYTE)(mqc->c >> 20);
212 *mqc->bp = (OPJ_BYTE)(mqc->c >> 19);
220 static void opj_mqc_renorme(opj_mqc_t *mqc)
227 opj_mqc_byteout(mqc);
229 } while ((mqc->a & 0x8000) == 0);
232 static void opj_mqc_codemps(opj_mqc_t *mqc)
234 mqc->a -= (*mqc->curctx)->qeval;
235 if ((mqc->a & 0x8000) == 0) {
236 if (mqc->a < (*mqc->curctx)->qeval) {
237 mqc->a = (*mqc->curctx)->qeval;
239 mqc->c += (*mqc->curctx)->qeval;
241 *mqc->curctx = (*mqc->curctx)->nmps;
242 opj_mqc_renorme(mqc);
244 mqc->c += (*mqc->curctx)->qeval;
248 static void opj_mqc_codelps(opj_mqc_t *mqc)
250 mqc->a -= (*mqc->curctx)->qeval;
251 if (mqc->a < (*mqc->curctx)->qeval) {
252 mqc->c += (*mqc->curctx)->qeval;
254 mqc->a = (*mqc->curctx)->qeval;
256 *mqc->curctx = (*mqc->curctx)->nlps;
257 opj_mqc_renorme(mqc);
260 static void opj_mqc_setbits(opj_mqc_t *mqc)
262 OPJ_UINT32 tempc = mqc->c + mqc->a;
264 if (mqc->c >= tempc) {
270 ==========================================================
272 ==========================================================
275 opj_mqc_t* opj_mqc_create(void)
277 opj_mqc_t *mqc = (opj_mqc_t*)opj_malloc(sizeof(opj_mqc_t));
281 void opj_mqc_destroy(opj_mqc_t *mqc)
288 OPJ_UINT32 opj_mqc_numbytes(opj_mqc_t *mqc)
290 const ptrdiff_t diff = mqc->bp - mqc->start;
292 assert(diff <= 0xffffffff && diff >= 0); /* UINT32_MAX */
294 return (OPJ_UINT32)diff;
297 void opj_mqc_init_enc(opj_mqc_t *mqc, OPJ_BYTE *bp)
299 /* TODO MSD: need to take a look to the v2 version */
300 opj_mqc_setcurctx(mqc, 0);
308 void opj_mqc_encode(opj_mqc_t *mqc, OPJ_UINT32 d)
310 if ((*mqc->curctx)->mps == d) {
311 opj_mqc_codemps(mqc);
313 opj_mqc_codelps(mqc);
317 void opj_mqc_flush(opj_mqc_t *mqc)
319 opj_mqc_setbits(mqc);
321 opj_mqc_byteout(mqc);
323 opj_mqc_byteout(mqc);
325 if (*mqc->bp != 0xff) {
330 void opj_mqc_bypass_init_enc(opj_mqc_t *mqc)
334 /*if (*mqc->bp == 0xff) {
339 void opj_mqc_bypass_enc(opj_mqc_t *mqc, OPJ_UINT32 d)
342 mqc->c = mqc->c + (d << mqc->ct);
345 *mqc->bp = (OPJ_BYTE)mqc->c;
347 if (*mqc->bp == 0xff) {
354 OPJ_UINT32 opj_mqc_bypass_flush_enc(opj_mqc_t *mqc)
356 OPJ_BYTE bit_padding;
361 while (mqc->ct > 0) {
363 mqc->c += (OPJ_UINT32)(bit_padding << mqc->ct);
364 bit_padding = (bit_padding + 1) & 0x01;
367 *mqc->bp = (OPJ_BYTE)mqc->c;
375 void opj_mqc_reset_enc(opj_mqc_t *mqc)
377 opj_mqc_resetstates(mqc);
378 opj_mqc_setstate(mqc, T1_CTXNO_UNI, 0, 46);
379 opj_mqc_setstate(mqc, T1_CTXNO_AGG, 0, 3);
380 opj_mqc_setstate(mqc, T1_CTXNO_ZC, 0, 4);
383 OPJ_UINT32 opj_mqc_restart_enc(opj_mqc_t *mqc)
385 OPJ_UINT32 correction = 1;
388 OPJ_INT32 n = (OPJ_INT32)(27 - 15 - mqc->ct);
391 opj_mqc_byteout(mqc);
392 n -= (OPJ_INT32)mqc->ct;
395 opj_mqc_byteout(mqc);
400 void opj_mqc_restart_init_enc(opj_mqc_t *mqc)
403 opj_mqc_setcurctx(mqc, 0);
408 if (*mqc->bp == 0xff) {
413 void opj_mqc_erterm_enc(opj_mqc_t *mqc)
415 OPJ_INT32 k = (OPJ_INT32)(11 - mqc->ct + 1);
420 opj_mqc_byteout(mqc);
421 k -= (OPJ_INT32)mqc->ct;
424 if (*mqc->bp != 0xff) {
425 opj_mqc_byteout(mqc);
429 void opj_mqc_segmark_enc(opj_mqc_t *mqc)
432 opj_mqc_setcurctx(mqc, 18);
434 for (i = 1; i < 5; i++) {
435 opj_mqc_encode(mqc, i % 2);
439 OPJ_BOOL opj_mqc_init_dec(opj_mqc_t *mqc, OPJ_BYTE *bp, OPJ_UINT32 len)
441 /* Implements ISO 15444-1 C.3.5 Initialization of the decoder (INITDEC) */
442 /* Note: alternate "J.1 - Initialization of the software-conventions */
443 /* decoder" has been tried, but does */
444 /* not bring any improvement. */
445 /* See https://github.com/uclouvain/openjpeg/issues/921 */
446 opj_mqc_setcurctx(mqc, 0);
453 mqc->c = (OPJ_UINT32)(*mqc->bp << 16);
463 void opj_mqc_resetstates(opj_mqc_t *mqc)
466 for (i = 0; i < MQC_NUMCTXS; i++) {
467 mqc->ctxs[i] = mqc_states;
471 void opj_mqc_setstate(opj_mqc_t *mqc, OPJ_UINT32 ctxno, OPJ_UINT32 msb,
474 mqc->ctxs[ctxno] = &mqc_states[msb + (OPJ_UINT32)(prob << 1)];