non-negative mdct input index
[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 * restrict out, const celt_word16_t *window, int overlap)
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    {
103       /* Temp pointers to make it really clear to the compiler what we're doing */
104       const kiss_fft_scalar * restrict xp1 = in+overlap/2;
105       const kiss_fft_scalar * restrict xp2 = in+N2-1+overlap/2;
106       kiss_fft_scalar * restrict yp = out;
107       kiss_fft_scalar *t = &l->trig[0];
108       const celt_word16_t * restrict wp1 = window+overlap/2;
109       const celt_word16_t * restrict wp2 = window+overlap/2-1;
110       for(i=0;i<overlap/4;i++)
111       {
112          kiss_fft_scalar re, im;
113          /* Real part arranged as -d-cR, Imag part arranged as -b+aR*/
114          re = -HALF32(MULT16_32_Q15(*wp2, xp1[N2]) + MULT16_32_Q15(*wp1,*xp2));
115          im = -HALF32(MULT16_32_Q15(*wp1, *xp1)    - MULT16_32_Q15(*wp2, xp2[-N2]));
116          xp1+=2;
117          xp2-=2;
118          wp1+=2;
119          wp2-=2;
120          /* We could remove the HALF32 above and just use MULT16_32_Q16 below
121          (MIXED_PRECISION only) */
122          *yp++ = S_MUL(re,t[0])  -  S_MUL(im,t[N4]);
123          *yp++ = S_MUL(im,t[0])  +  S_MUL(re,t[N4]);
124          t++;
125       }
126       for(;i<N/8;i++)
127       {
128          kiss_fft_scalar re, im;
129          /* Real part arranged as -d-cR, Imag part arranged as -b+aR*/
130          re = -HALF32(*xp2);
131          im = -HALF32(*xp1);
132          xp1+=2;
133          xp2-=2;
134          /* We could remove the HALF32 above and just use MULT16_32_Q16 below
135             (MIXED_PRECISION only) */
136          *yp++ = S_MUL(re,t[0])  -  S_MUL(im,t[N4]);
137          *yp++ = S_MUL(im,t[0])  +  S_MUL(re,t[N4]);
138          t++;
139       }
140       wp1 = window;
141       wp2 = window+overlap-1;
142       for(;i<N4-overlap/4;i++)
143       {
144          kiss_fft_scalar re, im;
145          /* Real part arranged as a-bR, Imag part arranged as -c-dR */
146          re =  HALF32(-*xp2);
147          im = -HALF32(*xp1);
148          xp1+=2;
149          xp2-=2;
150          /* We could remove the HALF32 above and just use MULT16_32_Q16 below
151             (MIXED_PRECISION only) */
152          *yp++ = S_MUL(re,t[0])  -  S_MUL(im,t[N4]);
153          *yp++ = S_MUL(im,t[0])  +  S_MUL(re,t[N4]);
154          t++;
155       }
156       for(;i<N4;i++)
157       {
158          kiss_fft_scalar re, im;
159          /* Real part arranged as a-bR, Imag part arranged as -c-dR */
160          re =  HALF32(MULT16_32_Q15(*wp1, xp1[-N2]) - MULT16_32_Q15(*wp2, *xp2));
161          im = -HALF32(MULT16_32_Q15(*wp2, *xp1)     + MULT16_32_Q15(*wp1, xp2[N2]));
162          xp1+=2;
163          xp2-=2;
164          wp1+=2;
165          wp2-=2;
166          /* We could remove the HALF32 above and just use MULT16_32_Q16 below
167          (MIXED_PRECISION only) */
168          *yp++ = S_MUL(re,t[0])  -  S_MUL(im,t[N4]);
169          *yp++ = S_MUL(im,t[0])  +  S_MUL(re,t[N4]);
170          t++;
171       }
172    }
173
174    /* N/4 complex FFT, which should normally down-scale by 4/N (but doesn't now) */
175    cpx32_fft(l->kfft, out, f, N4);
176
177    /* Post-rotate and apply the scaling if the FFT doesn't to it itself */
178    {
179       /* Temp pointers to make it really clear to the compiler what we're doing */
180       const kiss_fft_scalar * restrict fp = f;
181       kiss_fft_scalar * restrict yp1 = out;
182       kiss_fft_scalar * restrict yp2 = out+N2-1;
183       kiss_fft_scalar *t = &l->trig[0];
184       /* Temp pointers to make it really clear to the compiler what we're doing */
185       for(i=0;i<N4;i++)
186       {
187          *yp1 = -S_MUL(fp[1],t[N4]) + S_MUL(fp[0],t[0]);
188          *yp2 = -S_MUL(fp[0],t[N4]) - S_MUL(fp[1],t[0]);
189          fp += 2;
190          yp1 += 2;
191          yp2 -= 2;
192          t++;
193       }
194    }
195    RESTORE_STACK;
196 }
197
198
199 void mdct_backward(const mdct_lookup *l, kiss_fft_scalar *in, kiss_fft_scalar * restrict out)
200 {
201    int i;
202    int N, N2, N4;
203    VARDECL(kiss_fft_scalar, f);
204    SAVE_STACK;
205    N = l->n;
206    N2 = N>>1;
207    N4 = N>>2;
208    ALLOC(f, N2, kiss_fft_scalar);
209    
210    /* Pre-rotate */
211    {
212       /* Temp pointers to make it really clear to the compiler what we're doing */
213       const kiss_fft_scalar * restrict xp1 = in;
214       const kiss_fft_scalar * restrict xp2 = in+N2-1;
215       kiss_fft_scalar * restrict yp = out;
216       kiss_fft_scalar *t = &l->trig[0];
217       for(i=0;i<N4;i++) 
218       {
219          *yp++ = -S_MUL(*xp2, t[0])  - S_MUL(*xp1,t[N4]);
220          *yp++ =  S_MUL(*xp2, t[N4]) - S_MUL(*xp1,t[0]);
221          xp1+=2;
222          xp2-=2;
223          t++;
224       }
225    }
226
227    /* Inverse N/4 complex FFT. This one should *not* downscale even in fixed-point */
228    cpx32_ifft(l->kfft, out, f, N4);
229    
230    /* Post-rotate */
231    {
232       kiss_fft_scalar * restrict fp = f;
233       kiss_fft_scalar *t = &l->trig[0];
234
235       for(i=0;i<N4;i++)
236       {
237          kiss_fft_scalar re, im;
238          re = fp[0];
239          im = fp[1];
240          /* We'd scale up by 2 here, but instead it's done when mixing the windows */
241          *fp++ = S_MUL(re,*t) + S_MUL(im,t[N4]);
242          *fp++ = S_MUL(im,*t) - S_MUL(re,t[N4]);
243          t++;
244       }
245    }
246    /* De-shuffle the components for the middle of the window only */
247    {
248       const kiss_fft_scalar * restrict fp1 = f;
249       const kiss_fft_scalar * restrict fp2 = f+N2-1;
250       kiss_fft_scalar * restrict yp = out+N4;
251       for(i = 0; i < N4; i++)
252       {
253          *yp++ =-*fp1;
254          *yp++ = *fp2;
255          fp1 += 2;
256          fp2 -= 2;
257       }
258    }
259
260    /* Mirror on both sides for TDAC */
261    {
262       const kiss_fft_scalar * restrict xp1 = out+N2-1;
263       const kiss_fft_scalar * restrict xp2 = out+N2;
264       kiss_fft_scalar * restrict yp1 = out;
265       kiss_fft_scalar * restrict yp2 = out+N-1;
266       for(i = 0; i < N4; i++)
267       {
268          *yp1++ =-*xp1--;
269          *yp2-- = *xp2++;
270       }
271    }
272    RESTORE_STACK;
273 }
274
275