minor change for readability
[openjpeg.git] / jpwl / encoder / libopenjpeg / tgt.h
1 /*
2  * Copyright (c) 2001-2002, David Janssens
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
18  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24  * POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #ifndef __TGT_H
28 #define __TGT_H
29
30 typedef struct tgt_node {
31   struct tgt_node *parent;
32   int value;
33   int low;
34   int known;
35 } tgt_node_t;
36
37 typedef struct {
38   int numleafsh;
39   int numleafsv;
40   int numnodes;
41   tgt_node_t *nodes;
42 } tgt_tree_t;
43
44
45
46 /*
47  * Reset a tag-tree (set all leaves to 0)
48  * tree: tag-tree to reset
49  */
50 void tgt_reset(tgt_tree_t * tree);
51
52 /*
53  * Create a tag-tree
54  * numleafsh: width of the array of leafs of the tree
55  * numleafsv: height of the array of leafs of the tree
56  */
57 tgt_tree_t *tgt_create(int numleafsh, int numleafsv);
58
59 /*
60  * Destroy a tag-tree, liberating memory
61  * tree: tag-tree to destroy
62  */
63 void tgt_destroy(tgt_tree_t * tree);
64
65 /*
66  * Set the value of a leaf of a tag-tree
67  * tree: tag-tree to modify
68  * leafno: number that identifies the leaf to modify
69  * value: new value of the leaf
70  */
71 void tgt_setvalue(tgt_tree_t * tree, int leafno, int value);
72
73 /*
74  * Encode the value of a leaf of the tag-tree up to a given threshold
75  * leafno: number that identifies the leaf to encode
76  * threshold: threshold to use when encoding value of the leaf
77  */
78 void tgt_encode(tgt_tree_t * tree, int leafno, int threshold);
79
80 /*
81  * Decode the value of a leaf of the tag-tree up to a given threshold
82  * leafno: number that identifies the leaf to decode
83  * threshold: threshold to use when decoding value of the leaf
84  */
85 int tgt_decode(tgt_tree_t * tree, int leafno, int threshold);
86
87 #endif