src/lib/openmj2/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) 2002-2014, Universite catholique de Louvain (UCL), Belgium
   8  * Copyright (c) 2002-2014, Professor Benoit Macq
   9  * Copyright (c) 2001-2003, David Janssens
  10  * Copyright (c) 2002-2003, Yannick Verschueren
  11  * Copyright (c) 2003-2007, Francois-Olivier Devaux
  12  * Copyright (c) 2003-2014, Antonin Descampe
  13  * Copyright (c) 2005, Herve Drolon, FreeImage Team
  14  * All rights reserved.
  15  *
  16  * Redistribution and use in source and binary forms, with or without
  17  * modification, are permitted provided that the following conditions
  18  * are met:
  19  * 1. Redistributions of source code must retain the above copyright
  20  *    notice, this list of conditions and the following disclaimer.
  21  * 2. Redistributions in binary form must reproduce the above copyright
  22  *    notice, this list of conditions and the following disclaimer in the
  23  *    documentation and/or other materials provided with the distribution.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  26  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  29  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  30  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  32  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  33  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  */
  37
  38 #ifndef __TGT_H
  39 #define __TGT_H
  40 /**
  41 @file tgt.h
  42 @brief Implementation of a tag-tree coder (TGT)
  43
  44 The functions in TGT.C have for goal to realize a tag-tree coder. The functions in TGT.C
  45 are used by some function in T2.C.
  46 */
  47
  48 /** @defgroup TGT TGT - Implementation of a tag-tree coder */
  49 /*@{*/
  50
  51 /**
  52 Tag node
  53 */
  54 typedef struct opj_tgt_node {
  55     struct opj_tgt_node *parent;
  56     int value;
  57     int low;
  58     int known;
  59 } opj_tgt_node_t;
  60
  61 /**
  62 Tag tree
  63 */
  64 typedef struct opj_tgt_tree {
  65     int numleafsh;
  66     int numleafsv;
  67     int numnodes;
  68     opj_tgt_node_t *nodes;
  69 } opj_tgt_tree_t;
  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 *tgt_create(int numleafsh, int numleafsv);
  81 /**
  82 Destroy a tag-tree, liberating memory
  83 @param tree Tag-tree to destroy
  84 */
  85 void tgt_destroy(opj_tgt_tree_t *tree);
  86 /**
  87 Reset a tag-tree (set all leaves to 0)
  88 @param tree Tag-tree to reset
  89 */
  90 void tgt_reset(opj_tgt_tree_t *tree);
  91 /**
  92 Set the value of a leaf of a tag-tree
  93 @param tree Tag-tree to modify
  94 @param leafno Number that identifies the leaf to modify
  95 @param value New value of the leaf
  96 */
  97 void tgt_setvalue(opj_tgt_tree_t *tree, int leafno, int value);
  98 /**
  99 Encode the value of a leaf of the tag-tree up to a given threshold
 100 @param bio Pointer to a BIO handle
 101 @param tree Tag-tree to modify
 102 @param leafno Number that identifies the leaf to encode
 103 @param threshold Threshold to use when encoding value of the leaf
 104 */
 105 void tgt_encode(opj_bio_t *bio, opj_tgt_tree_t *tree, int leafno,
 106                 int threshold);
 107 /**
 108 Decode 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 decode
 111 @param leafno Number that identifies the leaf to decode
 112 @param threshold Threshold to use when decoding value of the leaf
 113 @return Returns 1 if the node's value < threshold, returns 0 otherwise
 114 */
 115 int tgt_decode(opj_bio_t *bio, opj_tgt_tree_t *tree, int leafno, int threshold);
 116 /* ----------------------------------------------------------------------- */
 117 /*@}*/
 118
 119 /*@}*/
 120
 121 #endif /* __TGT_H */