Fix typos in comments and string
[openjpeg.git] / src / lib / openjp3d / dwt.h
index 3fa781b101761c08ab512d6eb4eeda47806aec15..00082900f969a8bc9c34a774b8ceb154554c9240 100644 (file)
-/*\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, Herve Drolon, FreeImage Team\r
- * Copyright (c) 2002-2005, Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium\r
- * Copyrigth (c) 2006, M�nica D�ez, LPI-UVA, Spain\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 __DWT_H\r
-#define __DWT_H\r
-/**\r
-@file dwt.h\r
-@brief Implementation of a discrete wavelet transform (DWT)\r
-\r
-The functions in DWT.C have for goal to realize forward and inverse discret wavelet\r
-transform with filter 5-3 (reversible) and filter 9-7 (irreversible). The functions in\r
-DWT.C are used by some function in TCD.C.\r
-*/\r
-\r
-/** @defgroup DWT DWT - Implementation of a discrete wavelet transform */\r
-/*@{*/\r
-\r
-/**\r
-DCCS-LIWT properties\r
-*/\r
-\r
-\r
-typedef struct opj_wtfilt {\r
-       double *LPS;\r
-       int lenLPS;\r
-       double *HPS;\r
-       int lenHPS;\r
-} opj_wtfilt_t;\r
-/** @name Funciones generales */\r
-/*@{*/\r
-/* ----------------------------------------------------------------------- */\r
-/**\r
-Forward 5-3 wavelet tranform in 3-D. \r
-Apply a reversible DWT transform to a component of an volume.\r
-@param tilec Tile component information (current tile)\r
-@param dwtid Number of identification of wavelet kernel(s) used in DWT in each direction\r
-*/\r
-void dwt_encode(opj_tcd_tilecomp_t * tilec, int dwtid[3]);\r
-/**\r
-Inverse 5-3 wavelet tranform in 3-D.\r
-Apply a reversible inverse DWT transform to a component of an volume.\r
-@param tilec Tile component information (current tile)\r
-@param stops Number of decoded resolution levels in each dimension\r
-@param dwtid Number of identification of wavelet kernel(s) used in DWT in each dimension\r
-*/\r
-void dwt_decode(opj_tcd_tilecomp_t * tilec, int stops[3], int dwtid[3]);\r
-/* ----------------------------------------------------------------------- */\r
-/**\r
-Get the gain of a subband for the reversible 3-D DWT.\r
-@param orient Number that identifies the subband (0->LLL, 1->HLL, 2->LHL, 3->HHL, 4->LLH, 5->HLH, 6->LHH, 7->HHH)\r
-@param reversible Wavelet transformation type\r
-@return Returns 0 if orient = 0, returns 1 if orient = 1,2 or 4, returns 2 if orient = 3,5 or 6, returns 3 otherwise\r
-*/\r
-int dwt_getgain(int orient, int reversible);\r
-/**\r
-Get the norm of a wavelet function of a subband at a specified level for the reversible 5-3 DWT or irreversible 9-7 in 3-D.\r
-@param orient Band of the wavelet function\r
-@param level Levels of the wavelet function in X,Y,Z axis\r
-@param dwtid Wavelet transformation identifier\r
-@return Returns the norm of the wavelet function\r
-*/\r
-double dwt_getnorm(int orient, int level[3], int dwtid[3]);\r
-/* ----------------------------------------------------------------------- */\r
-/**\r
-Calcula el valor del escal�n de cuantificaci�n correspondiente a cada subbanda.\r
-@param tccp Tile component coding parameters\r
-@param prec Precision of data\r
-*/\r
-void dwt_calc_explicit_stepsizes(opj_tccp_t * tccp, int prec);\r
-/*@}*/\r
-/*@}*/\r
-\r
-#endif /* __DWT_H */\r
+/*
+ * The copyright in this software is being made available under the 2-clauses 
+ * BSD License, included below. This software may be subject to other third 
+ * party and contributor rights, including patent rights, and no such rights
+ * are granted under this license.
+ *
+ * Copyright (c) 2001-2003, David Janssens
+ * Copyright (c) 2002-2003, Yannick Verschueren
+ * Copyright (c) 2003-2005, Francois Devaux and Antonin Descampe
+ * Copyright (c) 2005, Herve Drolon, FreeImage Team
+ * Copyright (c) 2002-2005, Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium
+ * Copyrigth (c) 2006, M�nica D�ez, LPI-UVA, Spain
+ * 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 __DWT_H
+#define __DWT_H
+/**
+@file dwt.h
+@brief Implementation of a discrete wavelet transform (DWT)
+
+The functions in DWT.C have for goal to realize forward and inverse discret wavelet
+transform with filter 5-3 (reversible) and filter 9-7 (irreversible). The functions in
+DWT.C are used by some function in TCD.C.
+*/
+
+/** @defgroup DWT DWT - Implementation of a discrete wavelet transform */
+/*@{*/
+
+/**
+DCCS-LIWT properties
+*/
+
+
+typedef struct opj_wtfilt {
+       double *LPS;
+       int lenLPS;
+       double *HPS;
+       int lenHPS;
+} opj_wtfilt_t;
+/** @name Funciones generales */
+/*@{*/
+/* ----------------------------------------------------------------------- */
+/**
+Forward 5-3 wavelet transform in 3-D.
+Apply a reversible DWT transform to a component of an volume.
+@param tilec Tile component information (current tile)
+@param dwtid Number of identification of wavelet kernel(s) used in DWT in each direction
+*/
+void dwt_encode(opj_tcd_tilecomp_t * tilec, int dwtid[3]);
+/**
+Inverse 5-3 wavelet transform in 3-D.
+Apply a reversible inverse DWT transform to a component of an volume.
+@param tilec Tile component information (current tile)
+@param stops Number of decoded resolution levels in each dimension
+@param dwtid Number of identification of wavelet kernel(s) used in DWT in each dimension
+*/
+void dwt_decode(opj_tcd_tilecomp_t * tilec, int stops[3], int dwtid[3]);
+/* ----------------------------------------------------------------------- */
+/**
+Get the gain of a subband for the reversible 3-D DWT.
+@param orient Number that identifies the subband (0->LLL, 1->HLL, 2->LHL, 3->HHL, 4->LLH, 5->HLH, 6->LHH, 7->HHH)
+@param reversible Wavelet transformation type
+@return Returns 0 if orient = 0, returns 1 if orient = 1,2 or 4, returns 2 if orient = 3,5 or 6, returns 3 otherwise
+*/
+int dwt_getgain(int orient, int reversible);
+/**
+Get the norm of a wavelet function of a subband at a specified level for the reversible 5-3 DWT or irreversible 9-7 in 3-D.
+@param orient Band of the wavelet function
+@param level Levels of the wavelet function in X,Y,Z axis
+@param dwtid Wavelet transformation identifier
+@return Returns the norm of the wavelet function
+*/
+double dwt_getnorm(int orient, int level[3], int dwtid[3]);
+/* ----------------------------------------------------------------------- */
+/**
+Calcula el valor del escal�n de cuantificaci�n correspondiente a cada subbanda.
+@param tccp Tile component coding parameters
+@param prec Precision of data
+*/
+void dwt_calc_explicit_stepsizes(opj_tccp_t * tccp, int prec);
+/*@}*/
+/*@}*/
+
+#endif /* __DWT_H */