Not all compilers are equal -- making it clearer how the MDCT indexing is done
[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)
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+N4;
105       const kiss_fft_scalar * restrict xp2 = in+N2+N4-1;
106       kiss_fft_scalar * restrict yp = out;
107       for(i=0;i<N/8;i++)
108       {
109          kiss_fft_scalar re, im;
110          /* Real part arranged as -d-cR, Imag part arranged as -b+aR*/
111          re = -HALF32(xp1[N2] + *xp2);
112          im = -HALF32(*xp1    - xp2[-N2]);
113          xp1+=2;
114          xp2-=2;
115          /* We could remove the HALF32 above and just use MULT16_32_Q16 below
116             (MIXED_PRECISION only) */
117          *yp++ = S_MUL(re,l->trig[i])  -  S_MUL(im,l->trig[i+N4]);
118          *yp++ = S_MUL(im,l->trig[i])  +  S_MUL(re,l->trig[i+N4]);
119       }
120       for(;i<N4;i++)
121       {
122          kiss_fft_scalar re, im;
123          /* Real part arranged as a-bR, Imag part arranged as -c-dR */
124          re =  HALF32(xp1[-N2] - *xp2);
125          im = -HALF32(*xp1 + xp2[N2]);
126          xp1+=2;
127          xp2-=2;
128          /* We could remove the HALF32 above and just use MULT16_32_Q16 below
129             (MIXED_PRECISION only) */
130          *yp++ = S_MUL(re,l->trig[i])  -  S_MUL(im,l->trig[i+N4]);
131          *yp++ = S_MUL(im,l->trig[i])  +  S_MUL(re,l->trig[i+N4]);
132       }
133    }
134
135    /* N/4 complex FFT, which should normally down-scale by 4/N (but doesn't now) */
136    cpx32_fft(l->kfft, out, f, N4);
137
138    /* Post-rotate and apply the scaling if the FFT doesn't to it itself */
139    {
140       /* Temp pointers to make it really clear to the compiler what we're doing */
141       const kiss_fft_scalar * restrict fp = f;
142       kiss_fft_scalar * restrict yp1 = out;
143       kiss_fft_scalar * restrict yp2 = out+N2-1;
144       /* Temp pointers to make it really clear to the compiler what we're doing */
145       for(i=0;i<N4;i++)
146       {
147          *yp1 = -S_MUL(fp[1],l->trig[i+N4]) + S_MUL(fp[0],l->trig[i]);
148          *yp2 = -S_MUL(fp[0],l->trig[i+N4]) - S_MUL(fp[1],l->trig[i]);
149          fp += 2;
150          yp1 += 2;
151          yp2 -= 2;
152       }
153    }
154    RESTORE_STACK;
155 }
156
157
158 void mdct_backward(const mdct_lookup *l, kiss_fft_scalar *in, kiss_fft_scalar * restrict out)
159 {
160    int i;
161    int N, N2, N4;
162    VARDECL(kiss_fft_scalar, f);
163    SAVE_STACK;
164    N = l->n;
165    N2 = N>>1;
166    N4 = N>>2;
167    ALLOC(f, N2, kiss_fft_scalar);
168    
169    /* Pre-rotate */
170    for(i=0;i<N4;i++) 
171    {
172       out[2*i]   = -S_MUL(in[N2-2*i-1], l->trig[i])    - S_MUL(in[2*i],l->trig[i+N4]);
173       out[2*i+1] =  S_MUL(in[N2-2*i-1], l->trig[i+N4]) - S_MUL(in[2*i],l->trig[i]);
174    }
175
176    /* Inverse N/4 complex FFT. This one should *not* downscale even in fixed-point */
177    cpx32_ifft(l->kfft, out, f, N4);
178    
179    /* Post-rotate */
180    for(i=0;i<N4;i++)
181    {
182       kiss_fft_scalar re, im;
183       re = f[2*i];
184       im = f[2*i+1];
185       /* We'd scale up by 2 here, but instead it's done when mixing the windows */
186       f[2*i]   = S_MUL(re,l->trig[i]) + S_MUL(im,l->trig[i+N4]);
187       f[2*i+1] = S_MUL(im,l->trig[i]) - S_MUL(re,l->trig[i+N4]);
188    }
189    /* De-shuffle the components for the middle of the window only */
190    for(i = 0; i < N4; i++)
191    {
192       out[N4+2*i]   =-f[2*i];
193       out[N4+2*i+1] = f[N2-2*i-1];
194    }
195
196    /* Mirror on both sides for TDAC */
197    for(i = 0; i < N4; i++)
198    {
199       out[i]     =-out[N2-i-1];
200       out[N-i-1] = out[N2+i];
201    }
202    RESTORE_STACK;
203 }
204
205