vx32

Local 9vx git repository for patches.
git clone git://r-36.net/vx32
Log | Files | Refs

jpc_tagtree.h (5838B)

      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 License Version 2.0
     11  * 
     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
     15  * 
     16  * All rights reserved.
     17  * 
     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:
     25  * 
     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.
     29  * 
     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
     32  * written permission.
     33  * 
     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.
     60  * 
     61  * __END_OF_JASPER_LICENSE__
     62  */
     63 
     64 /*
     65  * Tag Tree Library
     66  *
     67  * $Id: jpc_tagtree.h 1918 2005-07-24 14:12:08Z baford $
     68  */
     69 
     70 #ifndef JPC_TAGTREE_H
     71 #define JPC_TAGTREE_H
     72 
     73 /******************************************************************************\
     74 * Includes
     75 \******************************************************************************/
     76 
     77 #include <limits.h>
     78 #include <stdio.h>
     79 
     80 #include "jpc_bs.h"
     81 
     82 /******************************************************************************\
     83 * Constants
     84 \******************************************************************************/
     85 
     86 /* The maximum allowable depth for a tag tree. */
     87 #define JPC_TAGTREE_MAXDEPTH	32
     88 
     89 /******************************************************************************\
     90 * Types
     91 \******************************************************************************/
     92 
     93 /*
     94  * Tag tree node.
     95  */
     96 
     97 typedef struct jpc_tagtreenode_ {
     98 
     99 	/* The parent of this node. */
    100 	struct jpc_tagtreenode_ *parent_;
    101 
    102 	/* The value associated with this node. */
    103 	int value_;
    104 
    105 	/* The lower bound on the value associated with this node. */
    106 	int low_;
    107 
    108 	/* A flag indicating if the value is known exactly. */
    109 	int known_;
    110 
    111 } jpc_tagtreenode_t;
    112 
    113 /*
    114  * Tag tree.
    115  */
    116 
    117 typedef struct {
    118 
    119 	/* The number of leaves in the horizontal direction. */
    120 	int numleafsh_;
    121 
    122 	/* The number of leaves in the vertical direction. */
    123 	int numleafsv_;
    124 
    125 	/* The total number of nodes in the tree. */
    126 	int numnodes_;
    127 
    128 	/* The nodes. */
    129 	jpc_tagtreenode_t *nodes_;
    130 
    131 } jpc_tagtree_t;
    132 
    133 /******************************************************************************\
    134 * Functions.
    135 \******************************************************************************/
    136 
    137 /* Create a tag tree. */
    138 jpc_tagtree_t *jpc_tagtree_create(int numleafsh, int numleafsv);
    139 
    140 /* Destroy a tag tree. */
    141 void jpc_tagtree_destroy(jpc_tagtree_t *tree);
    142 
    143 /* Copy data from one tag tree to another. */
    144 void jpc_tagtree_copy(jpc_tagtree_t *dsttree, jpc_tagtree_t *srctree);
    145 
    146 /* Reset the tag tree state. */
    147 void jpc_tagtree_reset(jpc_tagtree_t *tree);
    148 
    149 /* Set the value associated with a particular leaf node of a tag tree. */
    150 void jpc_tagtree_setvalue(jpc_tagtree_t *tree, jpc_tagtreenode_t *leaf,
    151   int value);
    152 
    153 /* Get a pointer to a particular leaf node. */
    154 jpc_tagtreenode_t *jpc_tagtree_getleaf(jpc_tagtree_t *tree, int n);
    155 
    156 /* Invoke the tag tree decoding procedure. */
    157 int jpc_tagtree_decode(jpc_tagtree_t *tree, jpc_tagtreenode_t *leaf,
    158   int threshold, jpc_bitstream_t *in);
    159 
    160 /* Invoke the tag tree encoding procedure. */
    161 int jpc_tagtree_encode(jpc_tagtree_t *tree, jpc_tagtreenode_t *leaf,
    162   int threshold, jpc_bitstream_t *out);
    163 
    164 /* Dump a tag tree (for debugging purposes). */
    165 void jpc_tagtree_dump(jpc_tagtree_t *tree, FILE *out);
    166 
    167 #endif