minor change for readability
[openjpeg.git] / jpwl / decoder / libopenjpeg / dwt.h
1 /*
2  * Copyright (c) 2001-2002, David Janssens
3  * Copyright (c) 2002-2003, Yannick Verschueren
4  * Copyright (c) 2002-2003,  Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  * POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #include "tcd.h"
30
31 #ifndef __DWT_H
32 #define __DWT_H
33
34 /*
35  * Apply a reversible DWT transform to a component of an image  
36  * a: samples of the component
37  * w: width of the component
38  * h: height of the component
39  * tilec : tile component information (present tile)
40  * l: number of decomposition levels in the DWT
41  */
42 /* void dwt_encode(int* a, int w, int h, int l); */
43 void dwt_encode(int *a, int w, int h, tcd_tilecomp_t * tilec, int l);
44 /*
45  * Apply a reversible inverse DWT transform to a component of an image  
46  * a: samples of the component
47  * w: width of the component
48  * h: height of the component
49  * tilec : tile component information (present tile)
50  * l: number of decomposition levels in the DWT
51  * row_tilec : tile component information (previous tile on the same row)
52  * col_tilec : tile component information (previous tile on the same column)
53  */
54 void dwt_decode(int *a, int w, int h, tcd_tilecomp_t * tilec, int l,
55                 int stop);
56
57 /*
58  * Get the gain of a subband for the reversible DWT
59  * orient: number that identifies the subband (0->LL, 1->HL, 2->LH, 3->HH)
60  */
61 int dwt_getgain(int orient);
62
63 /*
64  * Get the norm of a wavelet function of a subband at a specified level for the reversible DWT
65  * level: level of the wavelet function
66  * orient: band of the wavelet function
67  */
68 double dwt_getnorm(int level, int orient);
69
70 /*
71  * Apply an irreversible DWT transform to a component of an image  
72  * a: samples of the component
73  * w: width of the component
74  * h: height of the component
75  * l: number of decomposition levels in the DWT
76  */
77 void dwt_encode_real(int *a, int w, int h, tcd_tilecomp_t * tilec, int l);
78
79 /*
80  * Apply an irreversible inverse DWT transform to a component of an image  
81  * a: samples of the component
82  * w: width of the component
83  * h: height of the component
84  * l: number of decomposition levels in the DWT
85  */
86 void dwt_decode_real(int *a, int w, int h, tcd_tilecomp_t * tilec, int l,
87                      int stop);
88 /*
89  * Get the gain of a subband for the irreversible DWT
90  * orient: number that identifies the subband (0->LL, 1->HL, 2->LH, 3->HH)
91  */
92 int dwt_getgain_real(int orient);
93
94 /*
95  * Get the norm of a wavelet function of a subband at a specified level for the irreversible DWT
96  * level: level of the wavelet function
97  * orient: band of the wavelet function
98  */
99 double dwt_getnorm_real(int level, int orient);
100
101 #endif