src/lib/openjp3d/tgt.h

   1 /*
   2  * The copyright in this software is being made available under the 2-clauses
   3  * BSD License, included below. This software may be subject to other third
   4  * party and contributor rights, including patent rights, and no such rights
   5  * are granted under this license.
   6  *
   7  * Copyright (c) 2001-2003, David Janssens
   8  * Copyright (c) 2002-2003, Yannick Verschueren
   9  * Copyright (c) 2003-2005, Francois Devaux and Antonin Descampe
  10  * Copyright (c) 2005, Herve Drolon, FreeImage Team
  11  * Copyright (c) 2002-2005, Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium
  12  * All rights reserved.
  13  *
  14  * Redistribution and use in source and binary forms, with or without
  15  * modification, are permitted provided that the following conditions
  16  * are met:
  17  * 1. Redistributions of source code must retain the above copyright
  18  *    notice, this list of conditions and the following disclaimer.
  19  * 2. Redistributions in binary form must reproduce the above copyright
  20  *    notice, this list of conditions and the following disclaimer in the
  21  *    documentation and/or other materials provided with the distribution.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  24  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  27  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  28  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  29  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  30  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  31  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  32  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  33  * POSSIBILITY OF SUCH DAMAGE.
  34  */
  35
  36 #ifndef __TGT_H
  37 #define __TGT_H
  38 /**
  39 @file tgt.h
  40 @brief Implementation of a tag-tree coder (TGT)
  41
  42 The functions in TGT.C have for goal to realize a tag-tree coder. The functions in TGT.C
  43 are used by some function in T2.C.
  44 */
  45
  46 /** @defgroup TGT TGT - Implementation of a tag-tree coder */
  47 /*@{*/
  48
  49 /**
  50 Tag node
  51 */
  52 typedef struct opj_tgt_node {
  53     /** Node parent reference */
  54     struct opj_tgt_node *parent;
  55     /**  */
  56     int value;
  57     /**  */
  58     int low;
  59     /**  */
  60     int known;
  61 } opj_tgt_node_t;
  62
  63 /**
  64 Tag tree
  65 */
  66 typedef struct opj_tgt_tree {
  67     /** Number of leaves from horizontal axis */
  68     int numleafsh;
  69     /** Number of leaves from vertical axis */
  70     int numleafsv;
  71     /** Number of leaves from axial axis */
  72     int numleafsz;
  73     /** Number of nodes */
  74     int numnodes;
  75     /** Reference to each node instance */
  76     opj_tgt_node_t *nodes;
  77 } opj_tgt_tree_t;
  78
  79 /** @name Funciones generales */
  80 /*@{*/
  81 /* ----------------------------------------------------------------------- */
  82 /**
  83 Create a tag-tree
  84 @param numleafsh Width of the array of leafs of the tree
  85 @param numleafsv Height of the array of leafs of the tree
  86 @param numleafsz Depth of the array of leafs of the tree
  87 @return Returns a new tag-tree if successful, returns NULL otherwise
  88 */
  89 opj_tgt_tree_t *tgt_create(int numleafsh, int numleafsv, int numleafsz);
  90 /**
  91 Destroy a tag-tree, liberating memory
  92 @param tree Tag-tree to destroy
  93 */
  94 void tgt_destroy(opj_tgt_tree_t *tree);
  95 /**
  96 Reset a tag-tree (set all leaves to 0)
  97 @param tree Tag-tree to reset
  98 */
  99 void tgt_reset(opj_tgt_tree_t *tree);
 100 /**
 101 Set the value of a leaf of a tag-tree
 102 @param tree Tag-tree to modify
 103 @param leafno Number that identifies the leaf to modify
 104 @param value New value of the leaf
 105 */
 106 void tgt_setvalue(opj_tgt_tree_t *tree, int leafno, int value);
 107 /**
 108 Encode the value of a leaf of the tag-tree up to a given threshold
 109 @param bio Pointer to a BIO handle
 110 @param tree Tag-tree to modify
 111 @param leafno Number that identifies the leaf to encode
 112 @param threshold Threshold to use when encoding value of the leaf
 113 */
 114 void tgt_encode(opj_bio_t *bio, opj_tgt_tree_t *tree, int leafno,
 115                 int threshold);
 116 /**
 117 Decode the value of a leaf of the tag-tree up to a given threshold
 118 @param bio Pointer to a BIO handle
 119 @param tree Tag-tree to decode
 120 @param leafno Number that identifies the leaf to decode
 121 @param threshold Threshold to use when decoding value of the leaf
 122 @return Returns 1 if the node's value < threshold, returns 0 otherwise
 123 */
 124 int tgt_decode(opj_bio_t *bio, opj_tgt_tree_t *tree, int leafno, int threshold);
 125
 126 /*@}*/
 127 /* ----------------------------------------------------------------------- */
 128 void tgt_tree_dump(FILE *fd, opj_tgt_tree_t * tree);
 129 /*@}*/
 130
 131 #endif /* __TGT_H */