1 /*
2 * Copyright (c) 1999-2000 Image Power, Inc. and the University of
3 * British Columbia.
4 * Copyright (c) 2001-2002 Michael David Adams.
5 * All rights reserved.
6 */
7
8 /* __START_OF_JASPER_LICENSE__
9 *
10 * JasPer Software License
11 *
12 * IMAGE POWER JPEG-2000 PUBLIC LICENSE
13 * ************************************
14 *
15 * GRANT:
16 *
17 * Permission is hereby granted, free of charge, to any person (the "User")
18 * obtaining a copy of this software and associated documentation, to deal
19 * in the JasPer Software without restriction, including without limitation
20 * the right to use, copy, modify, merge, publish, distribute, sublicense,
21 * and/or sell copies of the JasPer Software (in source and binary forms),
22 * and to permit persons to whom the JasPer Software is furnished to do so,
23 * provided further that the License Conditions below are met.
24 *
25 * License Conditions
26 * ******************
27 *
28 * A. Redistributions of source code must retain the above copyright notice,
29 * and this list of conditions, and the following disclaimer.
30 *
31 * B. Redistributions in binary form must reproduce the above copyright
32 * notice, and this list of conditions, and the following disclaimer in
33 * the documentation and/or other materials provided with the distribution.
34 *
35 * C. Neither the name of Image Power, Inc. nor any other contributor
36 * (including, but not limited to, the University of British Columbia and
37 * Michael David Adams) may be used to endorse or promote products derived
38 * from this software without specific prior written permission.
39 *
40 * D. User agrees that it shall not commence any action against Image Power,
41 * Inc., the University of British Columbia, Michael David Adams, or any
42 * other contributors (collectively "Licensors") for infringement of any
43 * intellectual property rights ("IPR") held by the User in respect of any
44 * technology that User owns or has a right to license or sublicense and
45 * which is an element required in order to claim compliance with ISO/IEC
46 * 15444-1 (i.e., JPEG-2000 Part 1). "IPR" means all intellectual property
47 * rights worldwide arising under statutory or common law, and whether
48 * or not perfected, including, without limitation, all (i) patents and
49 * patent applications owned or licensable by User; (ii) rights associated
50 * with works of authorship including copyrights, copyright applications,
51 * copyright registrations, mask work rights, mask work applications,
52 * mask work registrations; (iii) rights relating to the protection of
53 * trade secrets and confidential information; (iv) any right analogous
54 * to those set forth in subsections (i), (ii), or (iii) and any other
55 * proprietary rights relating to intangible property (other than trademark,
56 * trade dress, or service mark rights); and (v) divisions, continuations,
57 * renewals, reissues and extensions of the foregoing (as and to the extent
58 * applicable) now existing, hereafter filed, issued or acquired.
59 *
60 * E. If User commences an infringement action against any Licensor(s) then
61 * such Licensor(s) shall have the right to terminate User's license and
62 * all sublicenses that have been granted hereunder by User to other parties.
63 *
64 * F. This software is for use only in hardware or software products that
65 * are compliant with ISO/IEC 15444-1 (i.e., JPEG-2000 Part 1). No license
66 * or right to this Software is granted for products that do not comply
67 * with ISO/IEC 15444-1. The JPEG-2000 Part 1 standard can be purchased
68 * from the ISO.
69 *
70 * THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS LICENSE.
71 * NO USE OF THE JASPER SOFTWARE IS AUTHORIZED HEREUNDER EXCEPT UNDER
72 * THIS DISCLAIMER. THE JASPER SOFTWARE IS PROVIDED BY THE LICENSORS AND
73 * CONTRIBUTORS UNDER THIS LICENSE ON AN ``AS-IS'' BASIS, WITHOUT WARRANTY
74 * OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION,
75 * WARRANTIES THAT THE JASPER SOFTWARE IS FREE OF DEFECTS, IS MERCHANTABLE,
76 * IS FIT FOR A PARTICULAR PURPOSE OR IS NON-INFRINGING. THOSE INTENDING
77 * TO USE THE JASPER SOFTWARE OR MODIFICATIONS THEREOF FOR USE IN HARDWARE
78 * OR SOFTWARE PRODUCTS ARE ADVISED THAT THEIR USE MAY INFRINGE EXISTING
79 * PATENTS, COPYRIGHTS, TRADEMARKS, OR OTHER INTELLECTUAL PROPERTY RIGHTS.
80 * THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE JASPER SOFTWARE
81 * IS WITH THE USER. SHOULD ANY PART OF THE JASPER SOFTWARE PROVE DEFECTIVE
82 * IN ANY RESPECT, THE USER (AND NOT THE INITIAL DEVELOPERS, THE UNIVERSITY
83 * OF BRITISH COLUMBIA, IMAGE POWER, INC., MICHAEL DAVID ADAMS, OR ANY
84 * OTHER CONTRIBUTOR) SHALL ASSUME THE COST OF ANY NECESSARY SERVICING,
85 * REPAIR OR CORRECTION. UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY,
86 * WHETHER TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE, SHALL THE
87 * INITIAL DEVELOPER, THE UNIVERSITY OF BRITISH COLUMBIA, IMAGE POWER, INC.,
88 * MICHAEL DAVID ADAMS, ANY OTHER CONTRIBUTOR, OR ANY DISTRIBUTOR OF THE
89 * JASPER SOFTWARE, OR ANY SUPPLIER OF ANY OF SUCH PARTIES, BE LIABLE TO
90 * THE USER OR ANY OTHER PERSON FOR ANY INDIRECT, SPECIAL, INCIDENTAL, OR
91 * CONSEQUENTIAL DAMAGES OF ANY CHARACTER INCLUDING, WITHOUT LIMITATION,
92 * DAMAGES FOR LOSS OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR
93 * MALFUNCTION, OR ANY AND ALL OTHER COMMERCIAL DAMAGES OR LOSSES, EVEN IF
94 * SUCH PARTY HAD BEEN INFORMED, OR OUGHT TO HAVE KNOWN, OF THE POSSIBILITY
95 * OF SUCH DAMAGES. THE JASPER SOFTWARE AND UNDERLYING TECHNOLOGY ARE NOT
96 * FAULT-TOLERANT AND ARE NOT DESIGNED, MANUFACTURED OR INTENDED FOR USE OR
97 * RESALE AS ON-LINE CONTROL EQUIPMENT IN HAZARDOUS ENVIRONMENTS REQUIRING
98 * FAIL-SAFE PERFORMANCE, SUCH AS IN THE OPERATION OF NUCLEAR FACILITIES,
99 * AIRCRAFT NAVIGATION OR COMMUNICATION SYSTEMS, AIR TRAFFIC CONTROL, DIRECT
100 * LIFE SUPPORT MACHINES, OR WEAPONS SYSTEMS, IN WHICH THE FAILURE OF THE
101 * JASPER SOFTWARE OR UNDERLYING TECHNOLOGY OR PRODUCT COULD LEAD DIRECTLY
102 * TO DEATH, PERSONAL INJURY, OR SEVERE PHYSICAL OR ENVIRONMENTAL DAMAGE
103 * ("HIGH RISK ACTIVITIES"). LICENSOR SPECIFICALLY DISCLAIMS ANY EXPRESS
104 * OR IMPLIED WARRANTY OF FITNESS FOR HIGH RISK ACTIVITIES. USER WILL NOT
105 * KNOWINGLY USE, DISTRIBUTE OR RESELL THE JASPER SOFTWARE OR UNDERLYING
106 * TECHNOLOGY OR PRODUCTS FOR HIGH RISK ACTIVITIES AND WILL ENSURE THAT ITS
107 * CUSTOMERS AND END-USERS OF ITS PRODUCTS ARE PROVIDED WITH A COPY OF THE
108 * NOTICE SPECIFIED IN THIS SECTION.
109 *
110 * __END_OF_JASPER_LICENSE__
111 */
112
113 /*
114 * MQ Arithmetic Decoder
115 *
116 * $Id$
117 */
118
119 /******************************************************************************\
120 * Includes.
121 \******************************************************************************/
122
123 #include <assert.h>
124 #include <stdlib.h>
125 #include <stdarg.h>
126
127 #include "jasper/jas_types.h"
128 #include "jasper/jas_malloc.h"
129 #include "jasper/jas_math.h"
130 #include "jasper/jas_debug.h"
131
132 #include "jpc_mqdec.h"
133
134 /******************************************************************************\
135 * Local macros.
136 \******************************************************************************/
137
138 #if defined(DEBUG)
139 #define MQDEC_CALL(n, x) \
140 ((jas_getdbglevel() >= (n)) ? ((void)(x)) : ((void)0))
141 #else
142 #define MQDEC_CALL(n, x)
143 #endif
144
145 /******************************************************************************\
146 * Local function prototypes.
147 \******************************************************************************/
148
149 static void jpc_mqdec_bytein(jpc_mqdec_t *mqdec);
150
151 /******************************************************************************\
152 * Code for creation and destruction of a MQ decoder.
153 \******************************************************************************/
154
155 /* Create a MQ decoder. */
jpc_mqdec_create(int maxctxs,jas_stream_t * in)156 jpc_mqdec_t *jpc_mqdec_create(int maxctxs, jas_stream_t *in)
157 {
158 jpc_mqdec_t *mqdec;
159
160 /* There must be at least one context. */
161 assert(maxctxs > 0);
162
163 /* Allocate memory for the MQ decoder. */
164 if (!(mqdec = jas_malloc(sizeof(jpc_mqdec_t)))) {
165 goto error;
166 }
167 mqdec->in = in;
168 mqdec->maxctxs = maxctxs;
169 /* Allocate memory for the per-context state information. */
170 if (!(mqdec->ctxs = jas_malloc(mqdec->maxctxs * sizeof(jpc_mqstate_t *)))) {
171 goto error;
172 }
173 /* Set the current context to the first context. */
174 mqdec->curctx = mqdec->ctxs;
175
176 /* If an input stream has been associated with the MQ decoder,
177 initialize the decoder state from the stream. */
178 if (mqdec->in) {
179 jpc_mqdec_init(mqdec);
180 }
181 /* Initialize the per-context state information. */
182 jpc_mqdec_setctxs(mqdec, 0, 0);
183
184 return mqdec;
185
186 error:
187 /* Oops... Something has gone wrong. */
188 if (mqdec) {
189 jpc_mqdec_destroy(mqdec);
190 }
191 return 0;
192 }
193
194 /* Destroy a MQ decoder. */
jpc_mqdec_destroy(jpc_mqdec_t * mqdec)195 void jpc_mqdec_destroy(jpc_mqdec_t *mqdec)
196 {
197 if (mqdec->ctxs) {
198 jas_free(mqdec->ctxs);
199 }
200 jas_free(mqdec);
201 }
202
203 /******************************************************************************\
204 * Code for initialization of a MQ decoder.
205 \******************************************************************************/
206
207 /* Initialize the state of a MQ decoder. */
208
jpc_mqdec_init(jpc_mqdec_t * mqdec)209 void jpc_mqdec_init(jpc_mqdec_t *mqdec)
210 {
211 int c;
212
213 mqdec->eof = 0;
214 mqdec->creg = 0;
215 /* Get the next byte from the input stream. */
216 if ((c = jas_stream_getc(mqdec->in)) == EOF) {
217 /* We have encountered an I/O error or EOF. */
218 c = 0xff;
219 mqdec->eof = 1;
220 }
221 mqdec->inbuffer = c;
222 mqdec->creg += mqdec->inbuffer << 16;
223 jpc_mqdec_bytein(mqdec);
224 mqdec->creg <<= 7;
225 mqdec->ctreg -= 7;
226 mqdec->areg = 0x8000;
227 }
228
229 /* Set the input stream for a MQ decoder. */
230
jpc_mqdec_setinput(jpc_mqdec_t * mqdec,jas_stream_t * in)231 void jpc_mqdec_setinput(jpc_mqdec_t *mqdec, jas_stream_t *in)
232 {
233 mqdec->in = in;
234 }
235
236 /* Initialize one or more contexts. */
237
jpc_mqdec_setctxs(jpc_mqdec_t * mqdec,int numctxs,jpc_mqctx_t * ctxs)238 void jpc_mqdec_setctxs(jpc_mqdec_t *mqdec, int numctxs, jpc_mqctx_t *ctxs)
239 {
240 jpc_mqstate_t **ctx;
241 int n;
242
243 ctx = mqdec->ctxs;
244 n = JAS_MIN(mqdec->maxctxs, numctxs);
245 while (--n >= 0) {
246 *ctx = &jpc_mqstates[2 * ctxs->ind + ctxs->mps];
247 ++ctx;
248 ++ctxs;
249 }
250 n = mqdec->maxctxs - numctxs;
251 while (--n >= 0) {
252 *ctx = &jpc_mqstates[0];
253 ++ctx;
254 }
255 }
256
257 /* Initialize a context. */
258
jpc_mqdec_setctx(jpc_mqdec_t * mqdec,int ctxno,jpc_mqctx_t * ctx)259 void jpc_mqdec_setctx(jpc_mqdec_t *mqdec, int ctxno, jpc_mqctx_t *ctx)
260 {
261 jpc_mqstate_t **ctxi;
262 ctxi = &mqdec->ctxs[ctxno];
263 *ctxi = &jpc_mqstates[2 * ctx->ind + ctx->mps];
264 }
265
266 /******************************************************************************\
267 * Code for decoding a bit.
268 \******************************************************************************/
269
270 /* Decode a bit. */
271
jpc_mqdec_getbit_func(register jpc_mqdec_t * mqdec)272 int jpc_mqdec_getbit_func(register jpc_mqdec_t *mqdec)
273 {
274 int bit;
275 JAS_DBGLOG(100, ("jpc_mqdec_getbit_func(%p)\n", mqdec));
276 MQDEC_CALL(100, jpc_mqdec_dump(mqdec, stderr));
277 bit = jpc_mqdec_getbit_macro(mqdec);
278 MQDEC_CALL(100, jpc_mqdec_dump(mqdec, stderr));
279 JAS_DBGLOG(100, ("ctx = %d, decoded %d\n", mqdec->curctx -
280 mqdec->ctxs, bit));
281 return bit;
282 }
283
284 /* Apply MPS_EXCHANGE algorithm (with RENORMD). */
jpc_mqdec_mpsexchrenormd(register jpc_mqdec_t * mqdec)285 int jpc_mqdec_mpsexchrenormd(register jpc_mqdec_t *mqdec)
286 {
287 int ret;
288 register jpc_mqstate_t *state = *mqdec->curctx;
289 jpc_mqdec_mpsexchange(mqdec->areg, state->qeval, mqdec->curctx, ret);
290 jpc_mqdec_renormd(mqdec->areg, mqdec->creg, mqdec->ctreg, mqdec->in,
291 mqdec->eof, mqdec->inbuffer);
292 return ret;
293 }
294
295 /* Apply LPS_EXCHANGE algorithm (with RENORMD). */
jpc_mqdec_lpsexchrenormd(register jpc_mqdec_t * mqdec)296 int jpc_mqdec_lpsexchrenormd(register jpc_mqdec_t *mqdec)
297 {
298 int ret;
299 register jpc_mqstate_t *state = *mqdec->curctx;
300 jpc_mqdec_lpsexchange(mqdec->areg, state->qeval, mqdec->curctx, ret);
301 jpc_mqdec_renormd(mqdec->areg, mqdec->creg, mqdec->ctreg, mqdec->in,
302 mqdec->eof, mqdec->inbuffer);
303 return ret;
304 }
305
306 /******************************************************************************\
307 * Support code.
308 \******************************************************************************/
309
310 /* Apply the BYTEIN algorithm. */
jpc_mqdec_bytein(jpc_mqdec_t * mqdec)311 static void jpc_mqdec_bytein(jpc_mqdec_t *mqdec)
312 {
313 int c;
314 unsigned char prevbuf;
315
316 if (!mqdec->eof) {
317 if ((c = jas_stream_getc(mqdec->in)) == EOF) {
318 mqdec->eof = 1;
319 c = 0xff;
320 }
321 prevbuf = mqdec->inbuffer;
322 mqdec->inbuffer = c;
323 if (prevbuf == 0xff) {
324 if (c > 0x8f) {
325 mqdec->creg += 0xff00;
326 mqdec->ctreg = 8;
327 } else {
328 mqdec->creg += c << 9;
329 mqdec->ctreg = 7;
330 }
331 } else {
332 mqdec->creg += c << 8;
333 mqdec->ctreg = 8;
334 }
335 } else {
336 mqdec->creg += 0xff00;
337 mqdec->ctreg = 8;
338 }
339 }
340