libjp3dvm/tgt.h

   1 /*\r
   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, Herve 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
   8  *\r
   9  * Redistribution and use in source and binary forms, with or without\r
  10  * modification, are permitted provided that the following conditions\r
  11  * are met:\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
  17  *\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
  29  */\r
  30 \r
  31 #ifndef __TGT_H\r
  32 #define __TGT_H\r
  33 /**\r
  34 @file tgt.h\r
  35 @brief Implementation of a tag-tree coder (TGT)\r
  36 \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
  39 */\r
  40 \r
  41 /** @defgroup TGT TGT - Implementation of a tag-tree coder */\r
  42 /*@{*/\r
  43 \r
  44 /**\r
  45 Tag node\r
  46 */\r
  47 typedef struct opj_tgt_node {\r
  48 /** Node parent reference */\r
  49   struct opj_tgt_node *parent;\r
  50 /**  */\r
  51   int value;\r
  52 /**  */\r
  53   int low;\r
  54 /**  */\r
  55   int known;\r
  56 } opj_tgt_node_t;\r
  57 \r
  58 /**\r
  59 Tag tree\r
  60 */\r
  61 typedef struct opj_tgt_tree {\r
  62 /** Number of leaves from horizontal axis */\r
  63   int numleafsh;\r
  64 /** Number of leaves from vertical axis */\r
  65   int numleafsv;\r
  66 /** Number of leaves from axial axis */\r
  67   int numleafsz;\r
  68 /** Number of nodes */\r
  69   int numnodes;\r
  70 /** Reference to each node instance */\r
  71   opj_tgt_node_t *nodes;\r
  72 } opj_tgt_tree_t;\r
  73 \r
  74 /** @name Funciones generales */\r
  75 /*@{*/\r
  76 /* ----------------------------------------------------------------------- */\r
  77 /**\r
  78 Create a tag-tree\r
  79 @param numleafsh Width of the array of leafs of the tree\r
  80 @param numleafsv Height of the array of leafs of the tree\r
  81 @param numleafsz Depth of the array of leafs of the tree\r
  82 @return Returns a new tag-tree if successful, returns NULL otherwise\r
  83 */\r
  84 opj_tgt_tree_t *tgt_create(int numleafsh, int numleafsv, int numleafsz);\r
  85 /**\r
  86 Destroy a tag-tree, liberating memory\r
  87 @param tree Tag-tree to destroy\r
  88 */\r
  89 void tgt_destroy(opj_tgt_tree_t *tree);\r
  90 /**\r
  91 Reset a tag-tree (set all leaves to 0)\r
  92 @param tree Tag-tree to reset\r
  93 */\r
  94 void tgt_reset(opj_tgt_tree_t *tree);\r
  95 /**\r
  96 Set the value of a leaf of a tag-tree\r
  97 @param tree Tag-tree to modify\r
  98 @param leafno Number that identifies the leaf to modify\r
  99 @param value New value of the leaf\r
 100 */\r
 101 void tgt_setvalue(opj_tgt_tree_t *tree, int leafno, int value);\r
 102 /**\r
 103 Encode the value of a leaf of the tag-tree up to a given threshold\r
 104 @param bio Pointer to a BIO handle\r
 105 @param tree Tag-tree to modify\r
 106 @param leafno Number that identifies the leaf to encode\r
 107 @param threshold Threshold to use when encoding value of the leaf\r
 108 */\r
 109 void tgt_encode(opj_bio_t *bio, opj_tgt_tree_t *tree, int leafno, int threshold);\r
 110 /**\r
 111 Decode the value of a leaf of the tag-tree up to a given threshold\r
 112 @param bio Pointer to a BIO handle\r
 113 @param tree Tag-tree to decode\r
 114 @param leafno Number that identifies the leaf to decode\r
 115 @param threshold Threshold to use when decoding value of the leaf\r
 116 @return Returns 1 if the node's value < threshold, returns 0 otherwise\r
 117 */\r
 118 int tgt_decode(opj_bio_t *bio, opj_tgt_tree_t *tree, int leafno, int threshold);\r
 119 \r
 120 /*@}*/\r
 121 /* ----------------------------------------------------------------------- */\r
 122 void tgt_tree_dump (FILE *fd, opj_tgt_tree_t * tree);\r
 123 \r
 124 #endif /* __TGT_H */\r