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 * Tag Tree Library 115 * 116 * $Id: jpc_tagtree.c 14449 2005-10-20 12:15:56Z stippi $ 117 */ 118 119/******************************************************************************\ 120* Includes. 121\******************************************************************************/ 122 123#include <limits.h> 124#include <stdlib.h> 125#include <assert.h> 126#include <stdio.h> 127 128#include "jasper/jas_malloc.h" 129 130#include "jpc_tagtree.h" 131 132/******************************************************************************\ 133* Prototypes. 134\******************************************************************************/ 135 136static jpc_tagtree_t *jpc_tagtree_alloc(); 137 138/******************************************************************************\ 139* Code for creating and destroying tag trees. 140\******************************************************************************/ 141 142/* Create a tag tree. */ 143 144jpc_tagtree_t *jpc_tagtree_create(int numleafsh, int numleafsv) 145{ 146 int nplh[JPC_TAGTREE_MAXDEPTH]; 147 int nplv[JPC_TAGTREE_MAXDEPTH]; 148 jpc_tagtreenode_t *node; 149 jpc_tagtreenode_t *parentnode; 150 jpc_tagtreenode_t *parentnode0; 151 jpc_tagtree_t *tree; 152 int i; 153 int j; 154 int k; 155 int numlvls; 156 int n; 157 158 assert(numleafsh > 0 && numleafsv > 0); 159 160 if (!(tree = jpc_tagtree_alloc())) { 161 return 0; 162 } 163 tree->numleafsh_ = numleafsh; 164 tree->numleafsv_ = numleafsv; 165 166 numlvls = 0; 167 nplh[0] = numleafsh; 168 nplv[0] = numleafsv; 169 do { 170 n = nplh[numlvls] * nplv[numlvls]; 171 nplh[numlvls + 1] = (nplh[numlvls] + 1) / 2; 172 nplv[numlvls + 1] = (nplv[numlvls] + 1) / 2; 173 tree->numnodes_ += n; 174 ++numlvls; 175 } while (n > 1); 176 177 if (!(tree->nodes_ = jas_malloc(tree->numnodes_ * sizeof(jpc_tagtreenode_t)))) { 178 return 0; 179 } 180 181 /* Initialize the parent links for all nodes in the tree. */ 182 183 node = tree->nodes_; 184 parentnode = &tree->nodes_[tree->numleafsh_ * tree->numleafsv_]; 185 parentnode0 = parentnode; 186 187 for (i = 0; i < numlvls - 1; ++i) { 188 for (j = 0; j < nplv[i]; ++j) { 189 k = nplh[i]; 190 while (--k >= 0) { 191 node->parent_ = parentnode; 192 ++node; 193 if (--k >= 0) { 194 node->parent_ = parentnode; 195 ++node; 196 } 197 ++parentnode; 198 } 199 if ((j & 1) || j == nplv[i] - 1) { 200 parentnode0 = parentnode; 201 } else { 202 parentnode = parentnode0; 203 parentnode0 += nplh[i]; 204 } 205 } 206 } 207 node->parent_ = 0; 208 209 /* Initialize the data values to something sane. */ 210 211 jpc_tagtree_reset(tree); 212 213 return tree; 214} 215 216/* Destroy a tag tree. */ 217 218void jpc_tagtree_destroy(jpc_tagtree_t *tree) 219{ 220 if (tree->nodes_) { 221 jas_free(tree->nodes_); 222 } 223 jas_free(tree); 224} 225 226static jpc_tagtree_t *jpc_tagtree_alloc() 227{ 228 jpc_tagtree_t *tree; 229 230 if (!(tree = jas_malloc(sizeof(jpc_tagtree_t)))) { 231 return 0; 232 } 233 tree->numleafsh_ = 0; 234 tree->numleafsv_ = 0; 235 tree->numnodes_ = 0; 236 tree->nodes_ = 0; 237 238 return tree; 239} 240 241/******************************************************************************\ 242* Code. 243\******************************************************************************/ 244 245/* Copy state information from one tag tree to another. */ 246 247void jpc_tagtree_copy(jpc_tagtree_t *dsttree, jpc_tagtree_t *srctree) 248{ 249 int n; 250 jpc_tagtreenode_t *srcnode; 251 jpc_tagtreenode_t *dstnode; 252 253 /* The two tag trees must have similar sizes. */ 254 assert(srctree->numleafsh_ == dsttree->numleafsh_ && 255 srctree->numleafsv_ == dsttree->numleafsv_); 256 257 n = srctree->numnodes_; 258 srcnode = srctree->nodes_; 259 dstnode = dsttree->nodes_; 260 while (--n >= 0) { 261 dstnode->value_ = srcnode->value_; 262 dstnode->low_ = srcnode->low_; 263 dstnode->known_ = srcnode->known_; 264 ++dstnode; 265 ++srcnode; 266 } 267} 268 269/* Reset all of the state information associated with a tag tree. */ 270 271void jpc_tagtree_reset(jpc_tagtree_t *tree) 272{ 273 int n; 274 jpc_tagtreenode_t *node; 275 276 n = tree->numnodes_; 277 node = tree->nodes_; 278 279 while (--n >= 0) { 280 node->value_ = INT_MAX; 281 node->low_ = 0; 282 node->known_ = 0; 283 ++node; 284 } 285} 286 287/* Set the value associated with the specified leaf node, updating 288the other nodes as necessary. */ 289 290void jpc_tagtree_setvalue(jpc_tagtree_t *tree, jpc_tagtreenode_t *leaf, int value) 291{ 292 jpc_tagtreenode_t *node; 293 294 assert(value >= 0); 295 296 node = leaf; 297 while (node && node->value_ > value) { 298 node->value_ = value; 299 node = node->parent_; 300 } 301} 302 303/* Get a particular leaf node. */ 304 305jpc_tagtreenode_t *jpc_tagtree_getleaf(jpc_tagtree_t *tree, int n) 306{ 307 return &tree->nodes_[n]; 308} 309 310/* Invoke the tag tree encoding procedure. */ 311 312int jpc_tagtree_encode(jpc_tagtree_t *tree, jpc_tagtreenode_t *leaf, int threshold, 313 jpc_bitstream_t *out) 314{ 315 jpc_tagtreenode_t *stk[JPC_TAGTREE_MAXDEPTH - 1]; 316 jpc_tagtreenode_t **stkptr; 317 jpc_tagtreenode_t *node; 318 int low; 319 320 assert(leaf); 321 assert(threshold >= 0); 322 323 /* Traverse to the root of the tree, recording the path taken. */ 324 stkptr = stk; 325 node = leaf; 326 while (node->parent_) { 327 *stkptr++ = node; 328 node = node->parent_; 329 } 330 331 low = 0; 332 for (;;) { 333 if (low > node->low_) { 334 /* Deferred propagation of the lower bound downward in 335 the tree. */ 336 node->low_ = low; 337 } else { 338 low = node->low_; 339 } 340 341 while (low < threshold) { 342 if (low >= node->value_) { 343 if (!node->known_) { 344 if (jpc_bitstream_putbit(out, 1) == EOF) { 345 return -1; 346 } 347 node->known_ = 1; 348 } 349 break; 350 } 351 if (jpc_bitstream_putbit(out, 0) == EOF) { 352 return -1; 353 } 354 ++low; 355 } 356 node->low_ = low; 357 if (stkptr == stk) { 358 break; 359 } 360 node = *--stkptr; 361 362 } 363 return (leaf->low_ < threshold) ? 1 : 0; 364 365} 366 367/* Invoke the tag tree decoding procedure. */ 368 369int jpc_tagtree_decode(jpc_tagtree_t *tree, jpc_tagtreenode_t *leaf, int threshold, 370 jpc_bitstream_t *in) 371{ 372 jpc_tagtreenode_t *stk[JPC_TAGTREE_MAXDEPTH - 1]; 373 jpc_tagtreenode_t **stkptr; 374 jpc_tagtreenode_t *node; 375 int low; 376 int ret; 377 378 assert(threshold >= 0); 379 380 /* Traverse to the root of the tree, recording the path taken. */ 381 stkptr = stk; 382 node = leaf; 383 while (node->parent_) { 384 *stkptr++ = node; 385 node = node->parent_; 386 } 387 388 low = 0; 389 for (;;) { 390 if (low > node->low_) { 391 node->low_ = low; 392 } else { 393 low = node->low_; 394 } 395 while (low < threshold && low < node->value_) { 396 if ((ret = jpc_bitstream_getbit(in)) < 0) { 397 return -1; 398 } 399 if (ret) { 400 node->value_ = low; 401 } else { 402 ++low; 403 } 404 } 405 node->low_ = low; 406 if (stkptr == stk) { 407 break; 408 } 409 node = *--stkptr; 410 } 411 412 return (node->value_ < threshold) ? 1 : 0; 413} 414 415/******************************************************************************\ 416* Code for debugging. 417\******************************************************************************/ 418 419void jpc_tagtree_dump(jpc_tagtree_t *tree, FILE *out) 420{ 421 jpc_tagtreenode_t *node; 422 int n; 423 424 node = tree->nodes_; 425 n = tree->numnodes_; 426 while (--n >= 0) { 427 fprintf(out, "node %p, parent %p, value %d, lower %d, known %d\n", 428 (void *) node, (void *) node->parent_, node->value_, node->low_, 429 node->known_); 430 ++node; 431 } 432} 433