]> Creatis software - gdcm.git/blobdiff - src/gdcmopenjpeg/libopenjpeg/tgt.h
ENH: Huge update to openjpeg 1.0 (actually more CVS)...
[gdcm.git] / src / gdcmopenjpeg / libopenjpeg / tgt.h
index d7b5ab7eb6fe7e3705fd2f6a7835c9afefdf1010..c77e027a133a11e749fdc3072f67968c84b556f2 100644 (file)
-/*
- * Copyright (c) 2001-2002, David Janssens
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- *    notice, this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in the
- *    documentation and/or other materials provided with the distribution.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
- * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
- * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
- * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
- * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
- * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGE.
- */
-
-#ifndef __TGT_H
-#define __TGT_H
-
-typedef struct tgt_node {
-  struct tgt_node *parent;
-  int value;
-  int low;
-  int known;
-} tgt_node_t;
-
-typedef struct {
-  int numleafsh;
-  int numleafsv;
-  int numnodes;
-  tgt_node_t *nodes;
-} tgt_tree_t;
-
-
-
-/*
- * Reset a tag-tree (set all leaves to 0)
- * tree: tag-tree to reset
- */
-void tgt_reset(tgt_tree_t * tree);
-
-/*
- * Create a tag-tree
- * numleafsh: width of the array of leafs of the tree
- * numleafsv: height of the array of leafs of the tree
- */
-tgt_tree_t *tgt_create(int numleafsh, int numleafsv);
-
-/*
- * Destroy a tag-tree, liberating memory
- * tree: tag-tree to destroy
- */
-void tgt_destroy(tgt_tree_t * tree);
-
-/*
- * Set the value of a leaf of a tag-tree
- * tree: tag-tree to modify
- * leafno: number that identifies the leaf to modify
- * value: new value of the leaf
- */
-void tgt_setvalue(tgt_tree_t * tree, int leafno, int value);
-
-/*
- * Encode the value of a leaf of the tag-tree up to a given threshold
- * leafno: number that identifies the leaf to encode
- * threshold: threshold to use when encoding value of the leaf
- */
-void tgt_encode(tgt_tree_t * tree, int leafno, int threshold);
-
-/*
- * Decode the value of a leaf of the tag-tree up to a given threshold
- * leafno: number that identifies the leaf to decode
- * threshold: threshold to use when decoding value of the leaf
- */
-int tgt_decode(tgt_tree_t * tree, int leafno, int threshold);
-
-#endif
+/*\r
+ * Copyright (c) 2001-2003, David Janssens\r
+ * Copyright (c) 2002-2003, Yannick Verschueren\r
+ * Copyright (c) 2003-2005, Francois Devaux and Antonin Descampe\r
+ * Copyright (c) 2005, HervĂ© Drolon, FreeImage Team\r
+ * Copyright (c) 2002-2005, Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium\r
+ * All rights reserved.\r
+ *\r
+ * Redistribution and use in source and binary forms, with or without\r
+ * modification, are permitted provided that the following conditions\r
+ * are met:\r
+ * 1. Redistributions of source code must retain the above copyright\r
+ *    notice, this list of conditions and the following disclaimer.\r
+ * 2. Redistributions in binary form must reproduce the above copyright\r
+ *    notice, this list of conditions and the following disclaimer in the\r
+ *    documentation and/or other materials provided with the distribution.\r
+ *\r
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'\r
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\r
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE\r
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR\r
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF\r
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS\r
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN\r
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)\r
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE\r
+ * POSSIBILITY OF SUCH DAMAGE.\r
+ */\r
+\r
+#ifndef __TGT_H\r
+#define __TGT_H\r
+/**\r
+@file tgt.h\r
+@brief Implementation of a tag-tree coder (TGT)\r
+\r
+The functions in TGT.C have for goal to realize a tag-tree coder. The functions in TGT.C\r
+are used by some function in T2.C.\r
+*/\r
+\r
+/** @defgroup TGT TGT - Implementation of a tag-tree coder */\r
+/*@{*/\r
+\r
+/**\r
+Tag node\r
+*/\r
+typedef struct opj_tgt_node {\r
+  struct opj_tgt_node *parent;\r
+  int value;\r
+  int low;\r
+  int known;\r
+} opj_tgt_node_t;\r
+\r
+/**\r
+Tag tree\r
+*/\r
+typedef struct opj_tgt_tree {\r
+  int numleafsh;\r
+  int numleafsv;\r
+  int numnodes;\r
+  opj_tgt_node_t *nodes;\r
+} opj_tgt_tree_t;\r
+\r
+/** @name Exported functions */\r
+/*@{*/\r
+/* ----------------------------------------------------------------------- */\r
+/**\r
+Create a tag-tree\r
+@param numleafsh Width of the array of leafs of the tree\r
+@param numleafsv Height of the array of leafs of the tree\r
+@return Returns a new tag-tree if successful, returns NULL otherwise\r
+*/\r
+opj_tgt_tree_t *tgt_create(int numleafsh, int numleafsv);\r
+/**\r
+Destroy a tag-tree, liberating memory\r
+@param tree Tag-tree to destroy\r
+*/\r
+void tgt_destroy(opj_tgt_tree_t *tree);\r
+/**\r
+Reset a tag-tree (set all leaves to 0)\r
+@param tree Tag-tree to reset\r
+*/\r
+void tgt_reset(opj_tgt_tree_t *tree);\r
+/**\r
+Set the value of a leaf of a tag-tree\r
+@param tree Tag-tree to modify\r
+@param leafno Number that identifies the leaf to modify\r
+@param value New value of the leaf\r
+*/\r
+void tgt_setvalue(opj_tgt_tree_t *tree, int leafno, int value);\r
+/**\r
+Encode the value of a leaf of the tag-tree up to a given threshold\r
+@param bio Pointer to a BIO handle\r
+@param tree Tag-tree to modify\r
+@param leafno Number that identifies the leaf to encode\r
+@param threshold Threshold to use when encoding value of the leaf\r
+*/\r
+void tgt_encode(opj_bio_t *bio, opj_tgt_tree_t *tree, int leafno, int threshold);\r
+/**\r
+Decode the value of a leaf of the tag-tree up to a given threshold\r
+@param bio Pointer to a BIO handle\r
+@param tree Tag-tree to decode\r
+@param leafno Number that identifies the leaf to decode\r
+@param threshold Threshold to use when decoding value of the leaf\r
+@return Returns 1 if the node's value < threshold, returns 0 otherwise\r
+*/\r
+int tgt_decode(opj_bio_t *bio, opj_tgt_tree_t *tree, int leafno, int threshold);\r
+/* ----------------------------------------------------------------------- */\r
+/*@}*/\r
+\r
+/*@}*/\r
+\r
+#endif /* __TGT_H */\r