renamed and reorganized "jp3d" directory to "openjpeg3d". Is now a standalone directo...
[openjpeg.git] / libopenjpeg3d / mct.h
1 /*\r
2  * Copyright (c) 2001-2003, David Janssens\r
3  * Copyright (c) 2002-2003, Yannick Verschueren\r
4  * Copyright (c) 2003-2005, Francois Devaux and Antonin Descampe\r
5  * Copyright (c) 2005, Herve Drolon, FreeImage Team\r
6  * Copyright (c) 2002-2005, Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium\r
7  * All rights reserved.\r
8  *\r
9  * Redistribution and use in source and binary forms, with or without\r
10  * modification, are permitted provided that the following conditions\r
11  * are met:\r
12  * 1. Redistributions of source code must retain the above copyright\r
13  *    notice, this list of conditions and the following disclaimer.\r
14  * 2. Redistributions in binary form must reproduce the above copyright\r
15  *    notice, this list of conditions and the following disclaimer in the\r
16  *    documentation and/or other materials provided with the distribution.\r
17  *\r
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'\r
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\r
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE\r
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR\r
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF\r
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS\r
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN\r
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)\r
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE\r
28  * POSSIBILITY OF SUCH DAMAGE.\r
29  */\r
30 \r
31 #ifndef __MCT_H\r
32 #define __MCT_H\r
33 /**\r
34 @file mct.h\r
35 @brief Implementation of a multi-component transforms (MCT)\r
36 \r
37 The functions in MCT.C have for goal to realize reversible and irreversible multicomponent\r
38 transform. The functions in MCT.C are used by some function in TCD.C.\r
39 */\r
40 \r
41 /** @defgroup MCT MCT - Implementation of a multi-component transform */\r
42 /*@{*/\r
43 \r
44 /** @name Funciones generales */\r
45 /*@{*/\r
46 /* ----------------------------------------------------------------------- */\r
47 /**\r
48 Apply a reversible multi-component transform to an image\r
49 @param c0 Samples for red component\r
50 @param c1 Samples for green component\r
51 @param c2 Samples blue component\r
52 @param n Number of samples for each component\r
53 */\r
54 void mct_encode(int *c0, int *c1, int *c2, int n);\r
55 /**\r
56 Apply a reversible multi-component inverse transform to an image\r
57 @param c0 Samples for luminance component\r
58 @param c1 Samples for red chrominance component\r
59 @param c2 Samples for blue chrominance component\r
60 @param n Number of samples for each component\r
61 */\r
62 void mct_decode(int *c0, int *c1, int *c2, int n);\r
63 /**\r
64 Get norm of the basis function used for the reversible multi-component transform\r
65 @param compno Number of the component (0->Y, 1->U, 2->V)\r
66 @return \r
67 */\r
68 double mct_getnorm(int compno);\r
69 \r
70 /**\r
71 Apply an irreversible multi-component transform to an image\r
72 @param c0 Samples for red component\r
73 @param c1 Samples for green component\r
74 @param c2 Samples blue component\r
75 @param n Number of samples for each component\r
76 */\r
77 void mct_encode_real(int *c0, int *c1, int *c2, int n);\r
78 /**\r
79 Apply an irreversible multi-component inverse transform to an image\r
80 @param c0 Samples for luminance component\r
81 @param c1 Samples for red chrominance component\r
82 @param c2 Samples for blue chrominance component\r
83 @param n Number of samples for each component\r
84 */\r
85 void mct_decode_real(int *c0, int *c1, int *c2, int n);\r
86 /**\r
87 Get norm of the basis function used for the irreversible multi-component transform\r
88 @param compno Number of the component (0->Y, 1->U, 2->V)\r
89 @return \r
90 */\r
91 double mct_getnorm_real(int compno);\r
92 /* ----------------------------------------------------------------------- */\r
93 /*@}*/\r
94 \r
95 /*@}*/\r
96 \r
97 #endif /* __MCT_H */\r