2 * Copyright (c) 1999-2000 Image Power, Inc. and the University of
4 * Copyright (c) 2001-2003 Michael David Adams.
8 /* __START_OF_JASPER_LICENSE__
10 * JasPer License Version 2.0
12 * Copyright (c) 1999-2000 Image Power, Inc.
13 * Copyright (c) 1999-2000 The University of British Columbia
14 * Copyright (c) 2001-2003 Michael David Adams
16 * All rights reserved.
18 * Permission is hereby granted, free of charge, to any person (the
19 * "User") obtaining a copy of this software and associated documentation
20 * files (the "Software"), to deal in the Software without restriction,
21 * including without limitation the rights to use, copy, modify, merge,
22 * publish, distribute, and/or sell copies of the Software, and to permit
23 * persons to whom the Software is furnished to do so, subject to the
24 * following conditions:
26 * 1. The above copyright notices and this permission notice (which
27 * includes the disclaimer below) shall be included in all copies or
28 * substantial portions of the Software.
30 * 2. The name of a copyright holder shall not be used to endorse or
31 * promote products derived from the Software without specific prior
34 * THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS
35 * LICENSE. NO USE OF THE SOFTWARE IS AUTHORIZED HEREUNDER EXCEPT UNDER
36 * THIS DISCLAIMER. THE SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS
37 * "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
38 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
39 * PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS. IN NO
40 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
41 * INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
42 * FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
43 * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
44 * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. NO ASSURANCES ARE
45 * PROVIDED BY THE COPYRIGHT HOLDERS THAT THE SOFTWARE DOES NOT INFRINGE
46 * THE PATENT OR OTHER INTELLECTUAL PROPERTY RIGHTS OF ANY OTHER ENTITY.
47 * EACH COPYRIGHT HOLDER DISCLAIMS ANY LIABILITY TO THE USER FOR CLAIMS
48 * BROUGHT BY ANY OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL
49 * PROPERTY RIGHTS OR OTHERWISE. AS A CONDITION TO EXERCISING THE RIGHTS
50 * GRANTED HEREUNDER, EACH USER HEREBY ASSUMES SOLE RESPONSIBILITY TO SECURE
51 * ANY OTHER INTELLECTUAL PROPERTY RIGHTS NEEDED, IF ANY. THE SOFTWARE
52 * IS NOT FAULT-TOLERANT AND IS NOT INTENDED FOR USE IN MISSION-CRITICAL
53 * SYSTEMS, SUCH AS THOSE USED IN THE OPERATION OF NUCLEAR FACILITIES,
54 * AIRCRAFT NAVIGATION OR COMMUNICATION SYSTEMS, AIR TRAFFIC CONTROL
55 * SYSTEMS, DIRECT LIFE SUPPORT MACHINES, OR WEAPONS SYSTEMS, IN WHICH
56 * THE FAILURE OF THE SOFTWARE OR SYSTEM COULD LEAD DIRECTLY TO DEATH,
57 * PERSONAL INJURY, OR SEVERE PHYSICAL OR ENVIRONMENTAL DAMAGE ("HIGH
58 * RISK ACTIVITIES"). THE COPYRIGHT HOLDERS SPECIFICALLY DISCLAIM ANY
59 * EXPRESS OR IMPLIED WARRANTY OF FITNESS FOR HIGH RISK ACTIVITIES.
61 * __END_OF_JASPER_LICENSE__
67 * $Id: jpc_tagtree.c,v 1.1 2005/05/22 18:33:06 malaterre Exp $
70 /******************************************************************************\
72 \******************************************************************************/
79 #include "jasper/jas_malloc.h"
81 #include "jpc_tagtree.h"
83 /******************************************************************************\
85 \******************************************************************************/
87 static jpc_tagtree_t *jpc_tagtree_alloc(void);
89 /******************************************************************************\
90 * Code for creating and destroying tag trees.
91 \******************************************************************************/
93 /* Create a tag tree. */
95 jpc_tagtree_t *jpc_tagtree_create(int numleafsh, int numleafsv)
97 int nplh[JPC_TAGTREE_MAXDEPTH];
98 int nplv[JPC_TAGTREE_MAXDEPTH];
99 jpc_tagtreenode_t *node;
100 jpc_tagtreenode_t *parentnode;
101 jpc_tagtreenode_t *parentnode0;
109 assert(numleafsh > 0 && numleafsv > 0);
111 if (!(tree = jpc_tagtree_alloc())) {
114 tree->numleafsh_ = numleafsh;
115 tree->numleafsv_ = numleafsv;
121 n = nplh[numlvls] * nplv[numlvls];
122 nplh[numlvls + 1] = (nplh[numlvls] + 1) / 2;
123 nplv[numlvls + 1] = (nplv[numlvls] + 1) / 2;
124 tree->numnodes_ += n;
128 if (!(tree->nodes_ = jas_malloc(tree->numnodes_ * sizeof(jpc_tagtreenode_t)))) {
132 /* Initialize the parent links for all nodes in the tree. */
135 parentnode = &tree->nodes_[tree->numleafsh_ * tree->numleafsv_];
136 parentnode0 = parentnode;
138 for (i = 0; i < numlvls - 1; ++i) {
139 for (j = 0; j < nplv[i]; ++j) {
142 node->parent_ = parentnode;
145 node->parent_ = parentnode;
150 if ((j & 1) || j == nplv[i] - 1) {
151 parentnode0 = parentnode;
153 parentnode = parentnode0;
154 parentnode0 += nplh[i];
160 /* Initialize the data values to something sane. */
162 jpc_tagtree_reset(tree);
167 /* Destroy a tag tree. */
169 void jpc_tagtree_destroy(jpc_tagtree_t *tree)
172 jas_free(tree->nodes_);
177 static jpc_tagtree_t *jpc_tagtree_alloc()
181 if (!(tree = jas_malloc(sizeof(jpc_tagtree_t)))) {
184 tree->numleafsh_ = 0;
185 tree->numleafsv_ = 0;
192 /******************************************************************************\
194 \******************************************************************************/
196 /* Copy state information from one tag tree to another. */
198 void jpc_tagtree_copy(jpc_tagtree_t *dsttree, jpc_tagtree_t *srctree)
201 jpc_tagtreenode_t *srcnode;
202 jpc_tagtreenode_t *dstnode;
204 /* The two tag trees must have similar sizes. */
205 assert(srctree->numleafsh_ == dsttree->numleafsh_ &&
206 srctree->numleafsv_ == dsttree->numleafsv_);
208 n = srctree->numnodes_;
209 srcnode = srctree->nodes_;
210 dstnode = dsttree->nodes_;
212 dstnode->value_ = srcnode->value_;
213 dstnode->low_ = srcnode->low_;
214 dstnode->known_ = srcnode->known_;
220 /* Reset all of the state information associated with a tag tree. */
222 void jpc_tagtree_reset(jpc_tagtree_t *tree)
225 jpc_tagtreenode_t *node;
231 node->value_ = INT_MAX;
238 /* Set the value associated with the specified leaf node, updating
239 the other nodes as necessary. */
241 void jpc_tagtree_setvalue(jpc_tagtree_t *tree, jpc_tagtreenode_t *leaf,
244 jpc_tagtreenode_t *node;
246 /* Avoid compiler warnings about unused parameters. */
252 while (node && node->value_ > value) {
253 node->value_ = value;
254 node = node->parent_;
258 /* Get a particular leaf node. */
260 jpc_tagtreenode_t *jpc_tagtree_getleaf(jpc_tagtree_t *tree, int n)
262 return &tree->nodes_[n];
265 /* Invoke the tag tree encoding procedure. */
267 int jpc_tagtree_encode(jpc_tagtree_t *tree, jpc_tagtreenode_t *leaf,
268 int threshold, jpc_bitstream_t *out)
270 jpc_tagtreenode_t *stk[JPC_TAGTREE_MAXDEPTH - 1];
271 jpc_tagtreenode_t **stkptr;
272 jpc_tagtreenode_t *node;
275 /* Avoid compiler warnings about unused parameters. */
279 assert(threshold >= 0);
281 /* Traverse to the root of the tree, recording the path taken. */
284 while (node->parent_) {
286 node = node->parent_;
291 if (low > node->low_) {
292 /* Deferred propagation of the lower bound downward in
299 while (low < threshold) {
300 if (low >= node->value_) {
302 if (jpc_bitstream_putbit(out, 1) == EOF) {
309 if (jpc_bitstream_putbit(out, 0) == EOF) {
321 return (leaf->low_ < threshold) ? 1 : 0;
325 /* Invoke the tag tree decoding procedure. */
327 int jpc_tagtree_decode(jpc_tagtree_t *tree, jpc_tagtreenode_t *leaf,
328 int threshold, jpc_bitstream_t *in)
330 jpc_tagtreenode_t *stk[JPC_TAGTREE_MAXDEPTH - 1];
331 jpc_tagtreenode_t **stkptr;
332 jpc_tagtreenode_t *node;
336 /* Avoid compiler warnings about unused parameters. */
339 assert(threshold >= 0);
341 /* Traverse to the root of the tree, recording the path taken. */
344 while (node->parent_) {
346 node = node->parent_;
351 if (low > node->low_) {
356 while (low < threshold && low < node->value_) {
357 if ((ret = jpc_bitstream_getbit(in)) < 0) {
373 return (node->value_ < threshold) ? 1 : 0;
376 /******************************************************************************\
377 * Code for debugging.
378 \******************************************************************************/
380 void jpc_tagtree_dump(jpc_tagtree_t *tree, FILE *out)
382 jpc_tagtreenode_t *node;
388 fprintf(out, "node %p, parent %p, value %d, lower %d, known %d\n",
389 (void *) node, (void *) node->parent_, node->value_, node->low_,