Move FFT parts from dsputil.h to fft.h
[ffmpeg.git] / libavcodec / fft.c
1 /*
2  * FFT/IFFT transforms
3  * Copyright (c) 2008 Loren Merritt
4  * Copyright (c) 2002 Fabrice Bellard
5  * Partly based on libdjbfft by D. J. Bernstein
6  *
7  * This file is part of FFmpeg.
8  *
9  * FFmpeg is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public
11  * License as published by the Free Software Foundation; either
12  * version 2.1 of the License, or (at your option) any later version.
13  *
14  * FFmpeg is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with FFmpeg; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22  */
23
24 /**
25  * @file libavcodec/fft.c
26  * FFT/IFFT transforms.
27  */
28
29 #include "libavutil/mathematics.h"
30 #include "fft.h"
31
32 /* cos(2*pi*x/n) for 0<=x<=n/4, followed by its reverse */
33 #if !CONFIG_HARDCODED_TABLES
34 COSTABLE(16);
35 COSTABLE(32);
36 COSTABLE(64);
37 COSTABLE(128);
38 COSTABLE(256);
39 COSTABLE(512);
40 COSTABLE(1024);
41 COSTABLE(2048);
42 COSTABLE(4096);
43 COSTABLE(8192);
44 COSTABLE(16384);
45 COSTABLE(32768);
46 COSTABLE(65536);
47 #endif
48 COSTABLE_CONST FFTSample * const ff_cos_tabs[] = {
49     NULL, NULL, NULL, NULL,
50     ff_cos_16, ff_cos_32, ff_cos_64, ff_cos_128, ff_cos_256, ff_cos_512, ff_cos_1024,
51     ff_cos_2048, ff_cos_4096, ff_cos_8192, ff_cos_16384, ff_cos_32768, ff_cos_65536,
52 };
53
54 static int split_radix_permutation(int i, int n, int inverse)
55 {
56     int m;
57     if(n <= 2) return i&1;
58     m = n >> 1;
59     if(!(i&m))            return split_radix_permutation(i, m, inverse)*2;
60     m >>= 1;
61     if(inverse == !(i&m)) return split_radix_permutation(i, m, inverse)*4 + 1;
62     else                  return split_radix_permutation(i, m, inverse)*4 - 1;
63 }
64
65 av_cold void ff_init_ff_cos_tabs(int index)
66 {
67 #if !CONFIG_HARDCODED_TABLES
68     int i;
69     int m = 1<<index;
70     double freq = 2*M_PI/m;
71     FFTSample *tab = ff_cos_tabs[index];
72     for(i=0; i<=m/4; i++)
73         tab[i] = cos(i*freq);
74     for(i=1; i<m/4; i++)
75         tab[m/2-i] = tab[i];
76 #endif
77 }
78
79 av_cold int ff_fft_init(FFTContext *s, int nbits, int inverse)
80 {
81     int i, j, m, n;
82     float alpha, c1, s1, s2;
83     int av_unused has_vectors;
84
85     if (nbits < 2 || nbits > 16)
86         goto fail;
87     s->nbits = nbits;
88     n = 1 << nbits;
89
90     s->tmp_buf = NULL;
91     s->exptab  = av_malloc((n / 2) * sizeof(FFTComplex));
92     if (!s->exptab)
93         goto fail;
94     s->revtab = av_malloc(n * sizeof(uint16_t));
95     if (!s->revtab)
96         goto fail;
97     s->inverse = inverse;
98
99     s2 = inverse ? 1.0 : -1.0;
100
101     s->fft_permute = ff_fft_permute_c;
102     s->fft_calc    = ff_fft_calc_c;
103 #if CONFIG_MDCT
104     s->imdct_calc  = ff_imdct_calc_c;
105     s->imdct_half  = ff_imdct_half_c;
106     s->mdct_calc   = ff_mdct_calc_c;
107 #endif
108     s->exptab1     = NULL;
109     s->split_radix = 1;
110
111     if (ARCH_ARM)     ff_fft_init_arm(s);
112     if (HAVE_ALTIVEC) ff_fft_init_altivec(s);
113     if (HAVE_MMX)     ff_fft_init_mmx(s);
114
115     if (s->split_radix) {
116         for(j=4; j<=nbits; j++) {
117             ff_init_ff_cos_tabs(j);
118         }
119         for(i=0; i<n; i++)
120             s->revtab[-split_radix_permutation(i, n, s->inverse) & (n-1)] = i;
121         s->tmp_buf = av_malloc(n * sizeof(FFTComplex));
122     } else {
123         int np, nblocks, np2, l;
124         FFTComplex *q;
125
126         for(i=0; i<(n/2); i++) {
127             alpha = 2 * M_PI * (float)i / (float)n;
128             c1 = cos(alpha);
129             s1 = sin(alpha) * s2;
130             s->exptab[i].re = c1;
131             s->exptab[i].im = s1;
132         }
133
134         np = 1 << nbits;
135         nblocks = np >> 3;
136         np2 = np >> 1;
137         s->exptab1 = av_malloc(np * 2 * sizeof(FFTComplex));
138         if (!s->exptab1)
139             goto fail;
140         q = s->exptab1;
141         do {
142             for(l = 0; l < np2; l += 2 * nblocks) {
143                 *q++ = s->exptab[l];
144                 *q++ = s->exptab[l + nblocks];
145
146                 q->re = -s->exptab[l].im;
147                 q->im = s->exptab[l].re;
148                 q++;
149                 q->re = -s->exptab[l + nblocks].im;
150                 q->im = s->exptab[l + nblocks].re;
151                 q++;
152             }
153             nblocks = nblocks >> 1;
154         } while (nblocks != 0);
155         av_freep(&s->exptab);
156
157         /* compute bit reverse table */
158         for(i=0;i<n;i++) {
159             m=0;
160             for(j=0;j<nbits;j++) {
161                 m |= ((i >> j) & 1) << (nbits-j-1);
162             }
163             s->revtab[i]=m;
164         }
165     }
166
167     return 0;
168  fail:
169     av_freep(&s->revtab);
170     av_freep(&s->exptab);
171     av_freep(&s->exptab1);
172     av_freep(&s->tmp_buf);
173     return -1;
174 }
175
176 void ff_fft_permute_c(FFTContext *s, FFTComplex *z)
177 {
178     int j, k, np;
179     FFTComplex tmp;
180     const uint16_t *revtab = s->revtab;
181     np = 1 << s->nbits;
182
183     if (s->tmp_buf) {
184         /* TODO: handle split-radix permute in a more optimal way, probably in-place */
185         for(j=0;j<np;j++) s->tmp_buf[revtab[j]] = z[j];
186         memcpy(z, s->tmp_buf, np * sizeof(FFTComplex));
187         return;
188     }
189
190     /* reverse */
191     for(j=0;j<np;j++) {
192         k = revtab[j];
193         if (k < j) {
194             tmp = z[k];
195             z[k] = z[j];
196             z[j] = tmp;
197         }
198     }
199 }
200
201 av_cold void ff_fft_end(FFTContext *s)
202 {
203     av_freep(&s->revtab);
204     av_freep(&s->exptab);
205     av_freep(&s->exptab1);
206     av_freep(&s->tmp_buf);
207 }
208
209 #define sqrthalf (float)M_SQRT1_2
210
211 #define BF(x,y,a,b) {\
212     x = a - b;\
213     y = a + b;\
214 }
215
216 #define BUTTERFLIES(a0,a1,a2,a3) {\
217     BF(t3, t5, t5, t1);\
218     BF(a2.re, a0.re, a0.re, t5);\
219     BF(a3.im, a1.im, a1.im, t3);\
220     BF(t4, t6, t2, t6);\
221     BF(a3.re, a1.re, a1.re, t4);\
222     BF(a2.im, a0.im, a0.im, t6);\
223 }
224
225 // force loading all the inputs before storing any.
226 // this is slightly slower for small data, but avoids store->load aliasing
227 // for addresses separated by large powers of 2.
228 #define BUTTERFLIES_BIG(a0,a1,a2,a3) {\
229     FFTSample r0=a0.re, i0=a0.im, r1=a1.re, i1=a1.im;\
230     BF(t3, t5, t5, t1);\
231     BF(a2.re, a0.re, r0, t5);\
232     BF(a3.im, a1.im, i1, t3);\
233     BF(t4, t6, t2, t6);\
234     BF(a3.re, a1.re, r1, t4);\
235     BF(a2.im, a0.im, i0, t6);\
236 }
237
238 #define TRANSFORM(a0,a1,a2,a3,wre,wim) {\
239     t1 = a2.re * wre + a2.im * wim;\
240     t2 = a2.im * wre - a2.re * wim;\
241     t5 = a3.re * wre - a3.im * wim;\
242     t6 = a3.im * wre + a3.re * wim;\
243     BUTTERFLIES(a0,a1,a2,a3)\
244 }
245
246 #define TRANSFORM_ZERO(a0,a1,a2,a3) {\
247     t1 = a2.re;\
248     t2 = a2.im;\
249     t5 = a3.re;\
250     t6 = a3.im;\
251     BUTTERFLIES(a0,a1,a2,a3)\
252 }
253
254 /* z[0...8n-1], w[1...2n-1] */
255 #define PASS(name)\
256 static void name(FFTComplex *z, const FFTSample *wre, unsigned int n)\
257 {\
258     FFTSample t1, t2, t3, t4, t5, t6;\
259     int o1 = 2*n;\
260     int o2 = 4*n;\
261     int o3 = 6*n;\
262     const FFTSample *wim = wre+o1;\
263     n--;\
264 \
265     TRANSFORM_ZERO(z[0],z[o1],z[o2],z[o3]);\
266     TRANSFORM(z[1],z[o1+1],z[o2+1],z[o3+1],wre[1],wim[-1]);\
267     do {\
268         z += 2;\
269         wre += 2;\
270         wim -= 2;\
271         TRANSFORM(z[0],z[o1],z[o2],z[o3],wre[0],wim[0]);\
272         TRANSFORM(z[1],z[o1+1],z[o2+1],z[o3+1],wre[1],wim[-1]);\
273     } while(--n);\
274 }
275
276 PASS(pass)
277 #undef BUTTERFLIES
278 #define BUTTERFLIES BUTTERFLIES_BIG
279 PASS(pass_big)
280
281 #define DECL_FFT(n,n2,n4)\
282 static void fft##n(FFTComplex *z)\
283 {\
284     fft##n2(z);\
285     fft##n4(z+n4*2);\
286     fft##n4(z+n4*3);\
287     pass(z,ff_cos_##n,n4/2);\
288 }
289
290 static void fft4(FFTComplex *z)
291 {
292     FFTSample t1, t2, t3, t4, t5, t6, t7, t8;
293
294     BF(t3, t1, z[0].re, z[1].re);
295     BF(t8, t6, z[3].re, z[2].re);
296     BF(z[2].re, z[0].re, t1, t6);
297     BF(t4, t2, z[0].im, z[1].im);
298     BF(t7, t5, z[2].im, z[3].im);
299     BF(z[3].im, z[1].im, t4, t8);
300     BF(z[3].re, z[1].re, t3, t7);
301     BF(z[2].im, z[0].im, t2, t5);
302 }
303
304 static void fft8(FFTComplex *z)
305 {
306     FFTSample t1, t2, t3, t4, t5, t6, t7, t8;
307
308     fft4(z);
309
310     BF(t1, z[5].re, z[4].re, -z[5].re);
311     BF(t2, z[5].im, z[4].im, -z[5].im);
312     BF(t3, z[7].re, z[6].re, -z[7].re);
313     BF(t4, z[7].im, z[6].im, -z[7].im);
314     BF(t8, t1, t3, t1);
315     BF(t7, t2, t2, t4);
316     BF(z[4].re, z[0].re, z[0].re, t1);
317     BF(z[4].im, z[0].im, z[0].im, t2);
318     BF(z[6].re, z[2].re, z[2].re, t7);
319     BF(z[6].im, z[2].im, z[2].im, t8);
320
321     TRANSFORM(z[1],z[3],z[5],z[7],sqrthalf,sqrthalf);
322 }
323
324 #if !CONFIG_SMALL
325 static void fft16(FFTComplex *z)
326 {
327     FFTSample t1, t2, t3, t4, t5, t6;
328
329     fft8(z);
330     fft4(z+8);
331     fft4(z+12);
332
333     TRANSFORM_ZERO(z[0],z[4],z[8],z[12]);
334     TRANSFORM(z[2],z[6],z[10],z[14],sqrthalf,sqrthalf);
335     TRANSFORM(z[1],z[5],z[9],z[13],ff_cos_16[1],ff_cos_16[3]);
336     TRANSFORM(z[3],z[7],z[11],z[15],ff_cos_16[3],ff_cos_16[1]);
337 }
338 #else
339 DECL_FFT(16,8,4)
340 #endif
341 DECL_FFT(32,16,8)
342 DECL_FFT(64,32,16)
343 DECL_FFT(128,64,32)
344 DECL_FFT(256,128,64)
345 DECL_FFT(512,256,128)
346 #if !CONFIG_SMALL
347 #define pass pass_big
348 #endif
349 DECL_FFT(1024,512,256)
350 DECL_FFT(2048,1024,512)
351 DECL_FFT(4096,2048,1024)
352 DECL_FFT(8192,4096,2048)
353 DECL_FFT(16384,8192,4096)
354 DECL_FFT(32768,16384,8192)
355 DECL_FFT(65536,32768,16384)
356
357 static void (* const fft_dispatch[])(FFTComplex*) = {
358     fft4, fft8, fft16, fft32, fft64, fft128, fft256, fft512, fft1024,
359     fft2048, fft4096, fft8192, fft16384, fft32768, fft65536,
360 };
361
362 void ff_fft_calc_c(FFTContext *s, FFTComplex *z)
363 {
364     fft_dispatch[s->nbits-2](z);
365 }
366