Added a few "restrict" keywords and changed some divisions to shifts
[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 "kfft_double.h"
51 #include <math.h>
52 #include "os_support.h"
53 #include "mathops.h"
54 #include "stack_alloc.h"
55
56 #ifndef M_PI
57 #define M_PI 3.141592653
58 #endif
59
60 void mdct_init(mdct_lookup *l,int N)
61 {
62    int i;
63    int N2;
64    l->n = N;
65    N2 = N>>1;
66    l->kfft = cpx32_fft_alloc(N>>2);
67    l->trig = (kiss_twiddle_scalar*)celt_alloc(N2*sizeof(kiss_twiddle_scalar));
68    /* We have enough points that sine isn't necessary */
69 #if defined(FIXED_POINT)
70 #if defined(DOUBLE_PRECISION) & !defined(MIXED_PRECISION)
71    for (i=0;i<N2;i++)
72       l->trig[i] = SAMP_MAX*cos(2*M_PI*(i+1./8.)/N);
73 #else
74    for (i=0;i<N2;i++)
75       l->trig[i] = TRIG_UPSCALE*celt_cos_norm(DIV32(ADD32(SHL32(EXTEND32(i),17),16386),N));
76 #endif
77 #else
78    for (i=0;i<N2;i++)
79       l->trig[i] = cos(2*M_PI*(i+1./8.)/N);
80 #endif
81 }
82
83 void mdct_clear(mdct_lookup *l)
84 {
85    cpx32_fft_free(l->kfft);
86    celt_free(l->trig);
87 }
88
89 void mdct_forward(const mdct_lookup *l, kiss_fft_scalar *in, kiss_fft_scalar *out)
90 {
91    int i;
92    int N, N2, N4;
93    VARDECL(kiss_fft_scalar, f);
94    SAVE_STACK;
95    N = l->n;
96    N2 = N>>1;
97    N4 = N>>2;
98    ALLOC(f, N2, kiss_fft_scalar);
99    
100    /* Consider the input to be compused of four blocks: [a, b, c, d] */
101    /* Shuffle, fold, pre-rotate (part 1) */
102    for(i=0;i<N/8;i++)
103    {
104       kiss_fft_scalar re, im;
105       /* Real part arranged as -d-cR, Imag part arranged as -b+aR*/
106       re = -HALF32(in[N2+N4+2*i] + in[N2+N4-2*i-1]);
107       im = -HALF32(in[N4+2*i]    - in[N4-2*i-1]);
108       out[2*i]   = S_MUL(re,l->trig[i])  -  S_MUL(im,l->trig[i+N4]);
109       out[2*i+1] = S_MUL(im,l->trig[i])  +  S_MUL(re,l->trig[i+N4]);
110    }
111    for(;i<N4;i++)
112    {
113       kiss_fft_scalar re, im;
114       /* Real part arranged as a-bR, Imag part arranged as -c-dR */
115       re =  HALF32(in[2*i-N4] - in[N2+N4-2*i-1]);
116       im = -HALF32(in[N4+2*i] + in[N+N4-2*i-1]);
117       out[2*i]   = S_MUL(re,l->trig[i])  -  S_MUL(im,l->trig[i+N4]);
118       out[2*i+1] = S_MUL(im,l->trig[i])  +  S_MUL(re,l->trig[i+N4]);
119    }
120
121    /* N/4 complex FFT, which should normally down-scale by 4/N (but doesn't now) */
122    cpx32_fft(l->kfft, out, f, N4);
123
124    /* Post-rotate and apply the scaling if the FFT doesn't to it itself */
125    for(i=0;i<N4;i++)
126    {
127       out[2*i]      = -S_MUL(f[2*i+1],l->trig[i+N4]) + S_MUL(f[2*i]  ,l->trig[i]);
128       out[N2-1-2*i] = -S_MUL(f[2*i]  ,l->trig[i+N4]) - S_MUL(f[2*i+1],l->trig[i]);
129    }
130    RESTORE_STACK;
131 }
132
133
134 void mdct_backward(const mdct_lookup *l, kiss_fft_scalar *in, kiss_fft_scalar *out)
135 {
136    int i;
137    int N, N2, N4;
138    VARDECL(kiss_fft_scalar, f);
139    SAVE_STACK;
140    N = l->n;
141    N2 = N>>1;
142    N4 = N>>2;
143    ALLOC(f, N2, kiss_fft_scalar);
144    
145    /* Pre-rotate */
146    for(i=0;i<N4;i++) 
147    {
148       out[2*i]   = -S_MUL(in[N2-2*i-1], l->trig[i])    - S_MUL(in[2*i],l->trig[i+N4]);
149       out[2*i+1] =  S_MUL(in[N2-2*i-1], l->trig[i+N4]) - S_MUL(in[2*i],l->trig[i]);
150    }
151
152    /* Inverse N/4 complex FFT. This one should *not* downscale even in fixed-point */
153    cpx32_ifft(l->kfft, out, f, N4);
154    
155    /* Post-rotate */
156    for(i=0;i<N4;i++)
157    {
158       kiss_fft_scalar re, im;
159       re = f[2*i];
160       im = f[2*i+1];
161       /* We'd scale up by 2 here, but instead it's done when mixing the windows */
162       f[2*i]   = S_MUL(re,l->trig[i]) + S_MUL(im,l->trig[i+N4]);
163       f[2*i+1] = S_MUL(im,l->trig[i]) - S_MUL(re,l->trig[i+N4]);
164    }
165    /* De-shuffle the components for the middle of the window only */
166    for(i = 0; i < N4; i++)
167    {
168       out[N4+2*i]   =-f[2*i];
169       out[N4+2*i+1] = f[N2-2*i-1];
170    }
171
172    /* Mirror on both sides for TDAC */
173    for(i = 0; i < N4; i++)
174    {
175       out[i]     =-out[N2-i-1];
176       out[N-i-1] = out[N2+i];
177    }
178    RESTORE_STACK;
179 }
180
181