Fix XFA builds under chromium checkouts
[pdfium.git] / core / src / fxcodec / fx_libopenjpeg / libopenjpeg20 / mct.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  * Copyright (c) 2008, 2011-2012, Centre National d'Etudes Spatiales (CNES), FR 
15  * Copyright (c) 2012, CS Systemes d'Information, France
16  * All rights reserved.
17  *
18  * Redistribution and use in source and binary forms, with or without
19  * modification, are permitted provided that the following conditions
20  * are met:
21  * 1. Redistributions of source code must retain the above copyright
22  *    notice, this list of conditions and the following disclaimer.
23  * 2. Redistributions in binary form must reproduce the above copyright
24  *    notice, this list of conditions and the following disclaimer in the
25  *    documentation and/or other materials provided with the distribution.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
28  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
31  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37  * POSSIBILITY OF SUCH DAMAGE.
38  */
39
40 #ifndef __MCT_H
41 #define __MCT_H
42 /**
43 @file mct.h
44 @brief Implementation of a multi-component transforms (MCT)
45
46 The functions in MCT.C have for goal to realize reversible and irreversible multicomponent
47 transform. The functions in MCT.C are used by some function in TCD.C.
48 */
49
50 /** @defgroup MCT MCT - Implementation of a multi-component transform */
51 /*@{*/
52
53 /** @name Exported functions */
54 /*@{*/
55 /* ----------------------------------------------------------------------- */
56 /**
57 Apply a reversible multi-component transform to an image
58 @param c0 Samples for red component
59 @param c1 Samples for green component
60 @param c2 Samples blue component
61 @param n Number of samples for each component
62 */
63 void opj_mct_encode(OPJ_INT32 *c0, OPJ_INT32 *c1, OPJ_INT32 *c2, OPJ_UINT32 n);
64 /**
65 Apply a reversible multi-component inverse transform to an image
66 @param c0 Samples for luminance component
67 @param c1 Samples for red chrominance component
68 @param c2 Samples for blue chrominance component
69 @param n Number of samples for each component
70 */
71 void opj_mct_decode(OPJ_INT32 *c0, OPJ_INT32 *c1, OPJ_INT32 *c2, OPJ_UINT32 n);
72 /**
73 Get norm of the basis function used for the reversible multi-component transform
74 @param compno Number of the component (0->Y, 1->U, 2->V)
75 @return 
76 */
77 OPJ_FLOAT64 opj_mct_getnorm(OPJ_UINT32 compno);
78
79 /**
80 Apply an irreversible multi-component transform to an image
81 @param c0 Samples for red component
82 @param c1 Samples for green component
83 @param c2 Samples blue component
84 @param n Number of samples for each component
85 */
86 void opj_mct_encode_real(OPJ_INT32 *c0, OPJ_INT32 *c1, OPJ_INT32 *c2, OPJ_UINT32 n);
87 /**
88 Apply an irreversible multi-component inverse transform to an image
89 @param c0 Samples for luminance component
90 @param c1 Samples for red chrominance component
91 @param c2 Samples for blue chrominance component
92 @param n Number of samples for each component
93 */
94 void opj_mct_decode_real(OPJ_FLOAT32* c0, OPJ_FLOAT32* c1, OPJ_FLOAT32* c2, OPJ_UINT32 n);
95 /**
96 Get norm of the basis function used for the irreversible multi-component transform
97 @param compno Number of the component (0->Y, 1->U, 2->V)
98 @return 
99 */
100 OPJ_FLOAT64 opj_mct_getnorm_real(OPJ_UINT32 compno);
101
102 /**
103 FIXME DOC
104 @param p_coding_data    MCT data
105 @param n                size of components
106 @param p_data           components
107 @param p_nb_comp        nb of components (i.e. size of p_data)
108 @param is_signed        tells if the data is signed
109 @return OPJ_FALSE if function encounter a problem, OPJ_TRUE otherwise
110 */
111 OPJ_BOOL opj_mct_encode_custom(
112                                            OPJ_BYTE * p_coding_data,
113                                            OPJ_UINT32 n,
114                                            OPJ_BYTE ** p_data,
115                                            OPJ_UINT32 p_nb_comp,
116                                            OPJ_UINT32 is_signed);
117 /**
118 FIXME DOC
119 @param pDecodingData    MCT data
120 @param n                size of components
121 @param pData            components
122 @param pNbComp          nb of components (i.e. size of p_data)
123 @param isSigned         tells if the data is signed
124 @return OPJ_FALSE if function encounter a problem, OPJ_TRUE otherwise
125 */
126 OPJ_BOOL opj_mct_decode_custom(
127                                            OPJ_BYTE * pDecodingData,
128                                            OPJ_UINT32 n,
129                                            OPJ_BYTE ** pData,
130                                            OPJ_UINT32 pNbComp,
131                                            OPJ_UINT32 isSigned);
132 /**
133 FIXME DOC
134 @param pNorms           MCT data
135 @param p_nb_comps       size of components
136 @param pMatrix          components
137 @return 
138 */
139 void opj_calculate_norms(   OPJ_FLOAT64 * pNorms,
140                             OPJ_UINT32 p_nb_comps,
141                             OPJ_FLOAT32 * pMatrix);
142 /**
143 FIXME DOC 
144 */
145 const OPJ_FLOAT64 * opj_mct_get_mct_norms (void);
146 /**
147 FIXME DOC 
148 */
149 const OPJ_FLOAT64 * opj_mct_get_mct_norms_real (void);
150 /* ----------------------------------------------------------------------- */
151 /*@}*/
152
153 /*@}*/
154
155 #endif /* __MCT_H */