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 Encoder 115 * 116 * $Id: jpc_mqenc.h 14449 2005-10-20 12:15:56Z stippi $ 117 */ 118 119#ifndef JPC_MQENC_H 120#define JPC_MQENC_H 121 122/******************************************************************************\ 123* Includes. 124\******************************************************************************/ 125 126#include "jasper/jas_types.h" 127#include "jasper/jas_stream.h" 128 129#include "jpc_mqcod.h" 130 131/******************************************************************************\ 132* Constants. 133\******************************************************************************/ 134 135/* 136 * Termination modes. 137 */ 138 139#define JPC_MQENC_DEFTERM 0 /* default termination */ 140#define JPC_MQENC_PTERM 1 /* predictable termination */ 141 142/******************************************************************************\ 143* Types. 144\******************************************************************************/ 145 146/* MQ arithmetic encoder class. */ 147 148typedef struct { 149 150 /* The C register. */ 151 uint_fast32_t creg; 152 153 /* The A register. */ 154 uint_fast32_t areg; 155 156 /* The CT register. */ 157 uint_fast32_t ctreg; 158 159 /* The maximum number of contexts. */ 160 int maxctxs; 161 162 /* The per-context information. */ 163 jpc_mqstate_t **ctxs; 164 165 /* The current context. */ 166 jpc_mqstate_t **curctx; 167 168 /* The stream for encoder output. */ 169 jas_stream_t *out; 170 171 /* The byte buffer (i.e., the B variable in the standard). */ 172 int_fast16_t outbuf; 173 174 /* The last byte output. */ 175 int_fast16_t lastbyte; 176 177 /* The error indicator. */ 178 int err; 179 180} jpc_mqenc_t; 181 182/* MQ arithmetic encoder state information. */ 183 184typedef struct { 185 186 /* The A register. */ 187 unsigned areg; 188 189 /* The C register. */ 190 unsigned creg; 191 192 /* The CT register. */ 193 unsigned ctreg; 194 195 /* The last byte output by the encoder. */ 196 int lastbyte; 197 198} jpc_mqencstate_t; 199 200/******************************************************************************\ 201* Functions/macros for construction and destruction. 202\******************************************************************************/ 203 204/* Create a MQ encoder. */ 205jpc_mqenc_t *jpc_mqenc_create(int maxctxs, jas_stream_t *out); 206 207/* Destroy a MQ encoder. */ 208void jpc_mqenc_destroy(jpc_mqenc_t *enc); 209 210/******************************************************************************\ 211* Functions/macros for initialization. 212\******************************************************************************/ 213 214/* Initialize a MQ encoder. */ 215void jpc_mqenc_init(jpc_mqenc_t *enc); 216 217/******************************************************************************\ 218* Functions/macros for context manipulation. 219\******************************************************************************/ 220 221/* Set the current context. */ 222#define jpc_mqenc_setcurctx(enc, ctxno) \ 223 ((enc)->curctx = &(enc)->ctxs[ctxno]); 224 225/* Set the state information for a particular context. */ 226void jpc_mqenc_setctx(jpc_mqenc_t *enc, int ctxno, jpc_mqctx_t *ctx); 227 228/* Set the state information for multiple contexts. */ 229void jpc_mqenc_setctxs(jpc_mqenc_t *enc, int numctxs, jpc_mqctx_t *ctxs); 230 231/******************************************************************************\ 232* Miscellaneous functions/macros. 233\******************************************************************************/ 234 235/* Get the error state of a MQ encoder. */ 236#define jpc_mqenc_error(enc) \ 237 ((enc)->err) 238 239/* Get the current encoder state. */ 240void jpc_mqenc_getstate(jpc_mqenc_t *enc, jpc_mqencstate_t *state); 241 242/* Terminate the code. */ 243int jpc_mqenc_flush(jpc_mqenc_t *enc, int termmode); 244 245/******************************************************************************\ 246* Functions/macros for encoding bits. 247\******************************************************************************/ 248 249/* Encode a bit. */ 250#if !defined(DEBUG) 251#define jpc_mqenc_putbit(enc, bit) jpc_mqenc_putbit_macro(enc, bit) 252#else 253#define jpc_mqenc_putbit(enc, bit) jpc_mqenc_putbit_func(enc, bit) 254#endif 255 256/******************************************************************************\ 257* Functions/macros for debugging. 258\******************************************************************************/ 259 260int jpc_mqenc_dump(jpc_mqenc_t *mqenc, FILE *out); 261 262/******************************************************************************\ 263* Implementation-specific details. 264\******************************************************************************/ 265 266/* Note: This macro is included only to satisfy the needs of 267 the mqenc_putbit macro. */ 268#define jpc_mqenc_putbit_macro(enc, bit) \ 269 (((*((enc)->curctx))->mps == (bit)) ? \ 270 (((enc)->areg -= (*(enc)->curctx)->qeval), \ 271 ((!((enc)->areg & 0x8000)) ? (jpc_mqenc_codemps2(enc)) : \ 272 ((enc)->creg += (*(enc)->curctx)->qeval))) : \ 273 jpc_mqenc_codelps(enc)) 274 275/* Note: These function prototypes are included only to satisfy the 276 needs of the mqenc_putbit_macro macro. Do not call any of these 277 functions directly. */ 278int jpc_mqenc_codemps2(jpc_mqenc_t *enc); 279int jpc_mqenc_codelps(jpc_mqenc_t *enc); 280 281/* Note: This function prototype is included only to satisfy the needs of 282 the mqenc_putbit macro. */ 283int jpc_mqenc_putbit_func(jpc_mqenc_t *enc, int bit); 284 285#endif 286