src/lib/openjp2/tgt.h

   1 /*
   2  * Copyright (c) 2002-2007, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
   3  * Copyright (c) 2002-2007, Professor Benoit Macq
   4  * Copyright (c) 2001-2003, David Janssens
   5  * Copyright (c) 2002-2003, Yannick Verschueren
   6  * Copyright (c) 2003-2007, Francois-Olivier Devaux and Antonin Descampe
   7  * Copyright (c) 2005, Herve Drolon, FreeImage Team
   8  * Copyright (c) 2008, Jerome Fimes, Communications & Systemes <jerome.fimes@c-s.fr>
   9  * Copyright (c) 2011-2012, Centre National d'Etudes Spatiales (CNES), France
  10  * Copyright (c) 2012, CS Systemes d'Information, France
  11  * All rights reserved.
  12  *
  13  * Redistribution and use in source and binary forms, with or without
  14  * modification, are permitted provided that the following conditions
  15  * are met:
  16  * 1. Redistributions of source code must retain the above copyright
  17  *    notice, this list of conditions and the following disclaimer.
  18  * 2. Redistributions in binary form must reproduce the above copyright
  19  *    notice, this list of conditions and the following disclaimer in the
  20  *    documentation and/or other materials provided with the distribution.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  23  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  26  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  32  * POSSIBILITY OF SUCH DAMAGE.
  33  */
  34
  35 #ifndef __TGT_H
  36 #define __TGT_H
  37 /**
  38 @file tgt.h
  39 @brief Implementation of a tag-tree coder (TGT)
  40
  41 The functions in TGT.C have for goal to realize a tag-tree coder. The functions in TGT.C
  42 are used by some function in T2.C.
  43 */
  44
  45 /** @defgroup TGT TGT - Implementation of a tag-tree coder */
  46 /*@{*/
  47
  48 /**
  49 Tag node
  50 */
  51 typedef struct opj_tgt_node {
  52     struct opj_tgt_node *parent;
  53     OPJ_INT32 value;
  54     OPJ_INT32 low;
  55     OPJ_UINT32 known;
  56 } opj_tgt_node_t;
  57
  58 /**
  59 Tag tree
  60 */
  61 typedef struct opj_tgt_tree
  62 {
  63         OPJ_UINT32  numleafsh;
  64         OPJ_UINT32  numleafsv;
  65         OPJ_UINT32 numnodes;
  66         opj_tgt_node_t *nodes;
  67         OPJ_UINT32  nodes_size;         /* maximum size taken by nodes */
  68 } opj_tgt_tree_t;
  69
  70
  71 /** @name Exported functions */
  72 /*@{*/
  73 /* ----------------------------------------------------------------------- */
  74 /**
  75 Create a tag-tree
  76 @param numleafsh Width of the array of leafs of the tree
  77 @param numleafsv Height of the array of leafs of the tree
  78 @return Returns a new tag-tree if successful, returns NULL otherwise
  79 */
  80 opj_tgt_tree_t *opj_tgt_create(OPJ_UINT32 numleafsh, OPJ_UINT32 numleafsv);
  81
  82 /**
  83  * Reinitialises a tag-tree from an exixting one.
  84  *
  85  * @param       p_tree                          the tree to reinitialize.
  86  * @param       p_num_leafs_h           the width of the array of leafs of the tree
  87  * @param       p_num_leafs_v           the height of the array of leafs of the tree
  88  * @return      a new tag-tree if successful, NULL otherwise
  89 */
  90 opj_tgt_tree_t *opj_tgt_init(opj_tgt_tree_t * p_tree,
  91                              OPJ_UINT32  p_num_leafs_h,
  92                              OPJ_UINT32  p_num_leafs_v);
  93 /**
  94 Destroy a tag-tree, liberating memory
  95 @param tree Tag-tree to destroy
  96 */
  97 void opj_tgt_destroy(opj_tgt_tree_t *tree);
  98 /**
  99 Reset a tag-tree (set all leaves to 0)
 100 @param tree Tag-tree to reset
 101 */
 102 void opj_tgt_reset(opj_tgt_tree_t *tree);
 103 /**
 104 Set the value of a leaf of a tag-tree
 105 @param tree Tag-tree to modify
 106 @param leafno Number that identifies the leaf to modify
 107 @param value New value of the leaf
 108 */
 109 void opj_tgt_setvalue(opj_tgt_tree_t *tree,
 110                       OPJ_UINT32 leafno,
 111                       OPJ_INT32 value);
 112 /**
 113 Encode the value of a leaf of the tag-tree up to a given threshold
 114 @param bio Pointer to a BIO handle
 115 @param tree Tag-tree to modify
 116 @param leafno Number that identifies the leaf to encode
 117 @param threshold Threshold to use when encoding value of the leaf
 118 */
 119 void opj_tgt_encode(opj_bio_t *bio,
 120                     opj_tgt_tree_t *tree,
 121                     OPJ_UINT32 leafno,
 122                     OPJ_INT32 threshold);
 123 /**
 124 Decode the value of a leaf of the tag-tree up to a given threshold
 125 @param bio Pointer to a BIO handle
 126 @param tree Tag-tree to decode
 127 @param leafno Number that identifies the leaf to decode
 128 @param threshold Threshold to use when decoding value of the leaf
 129 @return Returns 1 if the node's value < threshold, returns 0 otherwise
 130 */
 131 OPJ_UINT32 opj_tgt_decode(opj_bio_t *bio,
 132                           opj_tgt_tree_t *tree,
 133                           OPJ_UINT32 leafno,
 134                           OPJ_INT32 threshold);
 135 /* ----------------------------------------------------------------------- */
 136 /*@}*/
 137
 138 /*@}*/
 139
 140 #endif /* __TGT_H */