Updated Doxygen comments, removed an incorrectly placed LGPL header (we own
[opus.git] / libcelt / mdct.c
1 /* (C) 2008 Jean-Marc Valin, CSIRO
2 */
3 /*
4    Redistribution and use in source and binary forms, with or without
5    modification, are permitted provided that the following conditions
6    are met:
7    
8    - Redistributions of source code must retain the above copyright
9    notice, this list of conditions and the following disclaimer.
10    
11    - Redistributions in binary form must reproduce the above copyright
12    notice, this list of conditions and the following disclaimer in the
13    documentation and/or other materials provided with the distribution.
14    
15    - Neither the name of the Xiph.org Foundation nor the names of its
16    contributors may be used to endorse or promote products derived from
17    this software without specific prior written permission.
18    
19    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
23    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 /* This is a simple MDCT implementation that uses a N/4 complex FFT
33    to do most of the work. It should be relatively straightforward to
34    plug in pretty much and FFT here.
35    
36    This replaces the Vorbis FFT (and uses the exact same API), which 
37    was a bit too messy and that was ending up duplicating code 
38    (might as well use the same FFT everywhere).
39    
40    The algorithm is similar to (and inspired from) Fabrice Bellard's
41    MDCT implementation in FFMPEG, but has differences in signs, ordering
42    and scaling in many places. 
43 */
44
45 #ifdef HAVE_CONFIG_H
46 #include "config.h"
47 #endif
48
49 #include "mdct.h"
50 #include "kiss_fft.h"
51 #include <math.h>
52 #include "os_support.h"
53
54 #ifndef M_PI
55 #define M_PI 3.14159263
56 #endif
57
58 void mdct_init(mdct_lookup *l,int N)
59 {
60    int i;
61    int N2, N4;
62    l->n = N;
63    N2 = N/2;
64    N4 = N/4;
65    l->kfft = kiss_fft_alloc(N4, NULL, NULL);
66    l->trig = celt_alloc(N2*sizeof(float));
67    /* We have enough points that sine isn't necessary */
68    for (i=0;i<N2;i++)
69       l->trig[i] = cos(2*M_PI*(i+1./8.)/N);
70    l->scale = 1./N4;
71 }
72
73 void mdct_clear(mdct_lookup *l)
74 {
75    kiss_fft_free(l->kfft);
76    celt_free(l->trig);
77 }
78
79 void mdct_forward(mdct_lookup *l, float *in, float *out)
80 {
81    int i;
82    int N, N2, N4, N8;
83    VARDECL(float *f);
84    N = l->n;
85    N2 = N/2;
86    N4 = N/4;
87    N8 = N/8;
88    ALLOC(f, N2, float);
89    
90    /* Consider the input to be compused of four blocks: [a, b, c, d] */
91    /* Shuffle, fold, pre-rotate (part 1) */
92    for(i=0;i<N8;i++)
93    {
94       float re, im;
95       /* Real part arranged as -d-cR, Imag part arranged as -b+aR*/
96       re = -in[N2+N4+2*i] - in[N2+N4-2*i-1];
97       im = -in[N4+2*i]    + in[N4-2*i-1];
98       out[2*i]   = re*l->trig[i]  -  im*l->trig[i+N4];
99       out[2*i+1] = im*l->trig[i]  +  re*l->trig[i+N4];
100    }
101    for(;i<N4;i++)
102    {
103       float re, im;
104       /* Real part arranged as a-bR, Imag part arranged as -c-dR */
105       re =   in[2*i-N4] - in[N2+N4-2*i-1];
106       im = -(in[N4+2*i] + in[N+N4-2*i-1]);
107       out[2*i]   = re*l->trig[i]  -  im*l->trig[i+N4];
108       out[2*i+1] = im*l->trig[i]  +  re*l->trig[i+N4];
109    }
110
111    /* N/4 complex FFT, which should normally down-scale by 4/N (but doesn't now) */
112    kiss_fft(l->kfft, (const kiss_fft_cpx *)out, (kiss_fft_cpx *)f);
113
114    /* Post-rotate and apply the scaling if the FFT doesn't to it itself */
115    for(i=0;i<N4;i++)
116    {
117       out[2*i]      = l->scale * (-f[2*i+1]*l->trig[i+N4] + f[2*i]  *l->trig[i]);
118       out[N2-1-2*i] = l->scale * (-f[2*i]  *l->trig[i+N4] - f[2*i+1]*l->trig[i]);
119    }
120 }
121
122
123 void mdct_backward(mdct_lookup *l, float *in, float *out)
124 {
125    int i;
126    int N, N2, N4, N8;
127    VARDECL(float *f);
128    N = l->n;
129    N2 = N/2;
130    N4 = N/4;
131    N8 = N/8;
132    ALLOC(f, N2, float);
133    
134    /* Pre-rotate */
135    for(i=0;i<N4;i++) 
136    {
137       out[2*i]   = -in[N2-2*i-1] * l->trig[i]    - in[2*i]*l->trig[i+N4];
138       out[2*i+1] =  in[N2-2*i-1] * l->trig[i+N4] - in[2*i]*l->trig[i];
139    }
140
141    /* Inverse N/4 complex FFT. This one should *not* downscale even in fixed-point */
142    kiss_ifft(l->kfft, (const kiss_fft_cpx *)out, (kiss_fft_cpx *)f);
143    
144    /* Post-rotate */
145    for(i=0;i<N4;i++)
146    {
147       float re, im;
148       re = f[2*i];
149       im = f[2*i+1];
150       f[2*i]   = re*l->trig[i] + im*l->trig[i+N4];
151       f[2*i+1] = im*l->trig[i] - re*l->trig[i+N4];
152    }
153    /* De-shuffle the components for the middle of the window only */
154    for(i = 0; i < N4; i++)
155    {
156       out[N4+2*i]   =-f[2*i];
157       out[N4+2*i+1] = f[N2-2*i-1];
158    }
159
160    /* Mirror on both sides for TDAC */
161    for(i = 0; i < N4; i++)
162    {
163       out[i]     =-out[N2-i-1];
164       out[N-i-1] = out[N2+i];
165    }
166 }
167
168