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