2 * Copyright (c) 2001-2003, David Janssens
\r
3 * Copyright (c) 2002-2003, Yannick Verschueren
\r
4 * Copyright (c) 2003-2005, Francois Devaux and Antonin Descampe
\r
5 * Copyright (c) 2005, Hervé Drolon, FreeImage Team
\r
6 * Copyright (c) 2002-2005, Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium
\r
7 * All rights reserved.
\r
9 * Redistribution and use in source and binary forms, with or without
\r
10 * modification, are permitted provided that the following conditions
\r
12 * 1. Redistributions of source code must retain the above copyright
\r
13 * notice, this list of conditions and the following disclaimer.
\r
14 * 2. Redistributions in binary form must reproduce the above copyright
\r
15 * notice, this list of conditions and the following disclaimer in the
\r
16 * documentation and/or other materials provided with the distribution.
\r
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
\r
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
\r
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
\r
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
\r
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
\r
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
\r
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
\r
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
\r
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
\r
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
\r
28 * POSSIBILITY OF SUCH DAMAGE.
\r
35 @brief Implementation of a tag-tree coder (TGT)
\r
37 The functions in TGT.C have for goal to realize a tag-tree coder. The functions in TGT.C
\r
38 are used by some function in T2.C.
\r
41 /** @defgroup TGT TGT - Implementation of a tag-tree coder */
\r
47 typedef struct opj_tgt_node {
\r
48 struct opj_tgt_node *parent;
\r
57 typedef struct opj_tgt_tree {
\r
61 opj_tgt_node_t *nodes;
\r
64 /** @name Exported functions */
\r
66 /* ----------------------------------------------------------------------- */
\r
69 @param numleafsh Width of the array of leafs of the tree
\r
70 @param numleafsv Height of the array of leafs of the tree
\r
71 @return Returns a new tag-tree if successful, returns NULL otherwise
\r
73 opj_tgt_tree_t *tgt_create(int numleafsh, int numleafsv);
\r
75 Destroy a tag-tree, liberating memory
\r
76 @param tree Tag-tree to destroy
\r
78 void tgt_destroy(opj_tgt_tree_t *tree);
\r
80 Reset a tag-tree (set all leaves to 0)
\r
81 @param tree Tag-tree to reset
\r
83 void tgt_reset(opj_tgt_tree_t *tree);
\r
85 Set the value of a leaf of a tag-tree
\r
86 @param tree Tag-tree to modify
\r
87 @param leafno Number that identifies the leaf to modify
\r
88 @param value New value of the leaf
\r
90 void tgt_setvalue(opj_tgt_tree_t *tree, int leafno, int value);
\r
92 Encode the value of a leaf of the tag-tree up to a given threshold
\r
93 @param bio Pointer to a BIO handle
\r
94 @param tree Tag-tree to modify
\r
95 @param leafno Number that identifies the leaf to encode
\r
96 @param threshold Threshold to use when encoding value of the leaf
\r
98 void tgt_encode(opj_bio_t *bio, opj_tgt_tree_t *tree, int leafno, int threshold);
\r
100 Decode the value of a leaf of the tag-tree up to a given threshold
\r
101 @param bio Pointer to a BIO handle
\r
102 @param tree Tag-tree to decode
\r
103 @param leafno Number that identifies the leaf to decode
\r
104 @param threshold Threshold to use when decoding value of the leaf
\r
105 @return Returns 1 if the node's value < threshold, returns 0 otherwise
\r
107 int tgt_decode(opj_bio_t *bio, opj_tgt_tree_t *tree, int leafno, int threshold);
\r
108 /* ----------------------------------------------------------------------- */
\r
113 #endif /* __TGT_H */
\r