libavcodec: Implementation of 32 bit fixed point FFT
[ffmpeg.git] / libavcodec / fft-test.c
1 /*
2  * (c) 2002 Fabrice Bellard
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 /**
22  * @file
23  * FFT and MDCT tests.
24  */
25
26 #include "libavutil/cpu.h"
27 #include "libavutil/mathematics.h"
28 #include "libavutil/lfg.h"
29 #include "libavutil/log.h"
30 #include "libavutil/time.h"
31 #include "fft.h"
32 #if CONFIG_FFT_FLOAT
33 #include "dct.h"
34 #include "rdft.h"
35 #endif
36 #include <math.h>
37 #if HAVE_UNISTD_H
38 #include <unistd.h>
39 #endif
40 #include <stdlib.h>
41 #include <string.h>
42
43 /* reference fft */
44
45 #define MUL16(a,b) ((a) * (b))
46
47 #define CMAC(pre, pim, are, aim, bre, bim) \
48 {\
49    pre += (MUL16(are, bre) - MUL16(aim, bim));\
50    pim += (MUL16(are, bim) + MUL16(bre, aim));\
51 }
52
53 #if CONFIG_FFT_FLOAT
54 #   define RANGE 1.0
55 #   define REF_SCALE(x, bits)  (x)
56 #   define FMT "%10.6f"
57 #elif CONFIG_FFT_FIXED_32
58 #   define RANGE 8388608
59 #   define REF_SCALE(x, bits) (x)
60 #   define FMT "%6d"
61 #else
62 #   define RANGE 16384
63 #   define REF_SCALE(x, bits) ((x) / (1<<(bits)))
64 #   define FMT "%6d"
65 #endif
66
67 struct {
68     float re, im;
69 } *exptab;
70
71 static void fft_ref_init(int nbits, int inverse)
72 {
73     int n, i;
74     double c1, s1, alpha;
75
76     n = 1 << nbits;
77     exptab = av_malloc((n / 2) * sizeof(*exptab));
78
79     for (i = 0; i < (n/2); i++) {
80         alpha = 2 * M_PI * (float)i / (float)n;
81         c1 = cos(alpha);
82         s1 = sin(alpha);
83         if (!inverse)
84             s1 = -s1;
85         exptab[i].re = c1;
86         exptab[i].im = s1;
87     }
88 }
89
90 static void fft_ref(FFTComplex *tabr, FFTComplex *tab, int nbits)
91 {
92     int n, i, j, k, n2;
93     double tmp_re, tmp_im, s, c;
94     FFTComplex *q;
95
96     n = 1 << nbits;
97     n2 = n >> 1;
98     for (i = 0; i < n; i++) {
99         tmp_re = 0;
100         tmp_im = 0;
101         q = tab;
102         for (j = 0; j < n; j++) {
103             k = (i * j) & (n - 1);
104             if (k >= n2) {
105                 c = -exptab[k - n2].re;
106                 s = -exptab[k - n2].im;
107             } else {
108                 c = exptab[k].re;
109                 s = exptab[k].im;
110             }
111             CMAC(tmp_re, tmp_im, c, s, q->re, q->im);
112             q++;
113         }
114         tabr[i].re = REF_SCALE(tmp_re, nbits);
115         tabr[i].im = REF_SCALE(tmp_im, nbits);
116     }
117 }
118
119 static void imdct_ref(FFTSample *out, FFTSample *in, int nbits)
120 {
121     int n = 1<<nbits;
122     int k, i, a;
123     double sum, f;
124
125     for (i = 0; i < n; i++) {
126         sum = 0;
127         for (k = 0; k < n/2; k++) {
128             a = (2 * i + 1 + (n / 2)) * (2 * k + 1);
129             f = cos(M_PI * a / (double)(2 * n));
130             sum += f * in[k];
131         }
132         out[i] = REF_SCALE(-sum, nbits - 2);
133     }
134 }
135
136 /* NOTE: no normalisation by 1 / N is done */
137 static void mdct_ref(FFTSample *output, FFTSample *input, int nbits)
138 {
139     int n = 1<<nbits;
140     int k, i;
141     double a, s;
142
143     /* do it by hand */
144     for (k = 0; k < n/2; k++) {
145         s = 0;
146         for (i = 0; i < n; i++) {
147             a = (2*M_PI*(2*i+1+n/2)*(2*k+1) / (4 * n));
148             s += input[i] * cos(a);
149         }
150         output[k] = REF_SCALE(s, nbits - 1);
151     }
152 }
153
154 #if CONFIG_FFT_FLOAT
155 static void idct_ref(FFTSample *output, FFTSample *input, int nbits)
156 {
157     int n = 1<<nbits;
158     int k, i;
159     double a, s;
160
161     /* do it by hand */
162     for (i = 0; i < n; i++) {
163         s = 0.5 * input[0];
164         for (k = 1; k < n; k++) {
165             a = M_PI*k*(i+0.5) / n;
166             s += input[k] * cos(a);
167         }
168         output[i] = 2 * s / n;
169     }
170 }
171 static void dct_ref(FFTSample *output, FFTSample *input, int nbits)
172 {
173     int n = 1<<nbits;
174     int k, i;
175     double a, s;
176
177     /* do it by hand */
178     for (k = 0; k < n; k++) {
179         s = 0;
180         for (i = 0; i < n; i++) {
181             a = M_PI*k*(i+0.5) / n;
182             s += input[i] * cos(a);
183         }
184         output[k] = s;
185     }
186 }
187 #endif
188
189
190 static FFTSample frandom(AVLFG *prng)
191 {
192     return (int16_t)av_lfg_get(prng) / 32768.0 * RANGE;
193 }
194
195 static int check_diff(FFTSample *tab1, FFTSample *tab2, int n, double scale)
196 {
197     int i;
198     double max= 0;
199     double error= 0;
200     int err = 0;
201
202     for (i = 0; i < n; i++) {
203         double e = fabsf(tab1[i] - (tab2[i] / scale)) / RANGE;
204         if (e >= 1e-3) {
205             av_log(NULL, AV_LOG_ERROR, "ERROR %5d: "FMT" "FMT"\n",
206                    i, tab1[i], tab2[i]);
207             err = 1;
208         }
209         error+= e*e;
210         if(e>max) max= e;
211     }
212     av_log(NULL, AV_LOG_INFO, "max:%f e:%g\n", max, sqrt(error/n));
213     return err;
214 }
215
216
217 static void help(void)
218 {
219     av_log(NULL, AV_LOG_INFO,"usage: fft-test [-h] [-s] [-i] [-n b]\n"
220            "-h     print this help\n"
221            "-s     speed test\n"
222            "-m     (I)MDCT test\n"
223            "-d     (I)DCT test\n"
224            "-r     (I)RDFT test\n"
225            "-i     inverse transform test\n"
226            "-n b   set the transform size to 2^b\n"
227            "-f x   set scale factor for output data of (I)MDCT to x\n"
228            );
229 }
230
231 enum tf_transform {
232     TRANSFORM_FFT,
233     TRANSFORM_MDCT,
234     TRANSFORM_RDFT,
235     TRANSFORM_DCT,
236 };
237
238 #if !HAVE_GETOPT
239 #include "compat/getopt.c"
240 #endif
241
242 int main(int argc, char **argv)
243 {
244     FFTComplex *tab, *tab1, *tab_ref;
245     FFTSample *tab2;
246     int it, i, c;
247     int cpuflags;
248     int do_speed = 0;
249     int err = 1;
250     enum tf_transform transform = TRANSFORM_FFT;
251     int do_inverse = 0;
252     FFTContext s1, *s = &s1;
253     FFTContext m1, *m = &m1;
254 #if CONFIG_FFT_FLOAT
255     RDFTContext r1, *r = &r1;
256     DCTContext d1, *d = &d1;
257     int fft_size_2;
258 #endif
259     int fft_nbits, fft_size;
260     double scale = 1.0;
261     AVLFG prng;
262     av_lfg_init(&prng, 1);
263
264     fft_nbits = 9;
265     for(;;) {
266         c = getopt(argc, argv, "hsimrdn:f:c:");
267         if (c == -1)
268             break;
269         switch(c) {
270         case 'h':
271             help();
272             return 1;
273         case 's':
274             do_speed = 1;
275             break;
276         case 'i':
277             do_inverse = 1;
278             break;
279         case 'm':
280             transform = TRANSFORM_MDCT;
281             break;
282         case 'r':
283             transform = TRANSFORM_RDFT;
284             break;
285         case 'd':
286             transform = TRANSFORM_DCT;
287             break;
288         case 'n':
289             fft_nbits = atoi(optarg);
290             break;
291         case 'f':
292             scale = atof(optarg);
293             break;
294         case 'c':
295             cpuflags = av_get_cpu_flags();
296
297             if (av_parse_cpu_caps(&cpuflags, optarg) < 0)
298                 return 1;
299
300             av_force_cpu_flags(cpuflags);
301             break;
302         }
303     }
304
305     fft_size = 1 << fft_nbits;
306     tab = av_malloc(fft_size * sizeof(FFTComplex));
307     tab1 = av_malloc(fft_size * sizeof(FFTComplex));
308     tab_ref = av_malloc(fft_size * sizeof(FFTComplex));
309     tab2 = av_malloc(fft_size * sizeof(FFTSample));
310
311     switch (transform) {
312     case TRANSFORM_MDCT:
313         av_log(NULL, AV_LOG_INFO,"Scale factor is set to %f\n", scale);
314         if (do_inverse)
315             av_log(NULL, AV_LOG_INFO,"IMDCT");
316         else
317             av_log(NULL, AV_LOG_INFO,"MDCT");
318         ff_mdct_init(m, fft_nbits, do_inverse, scale);
319         break;
320     case TRANSFORM_FFT:
321         if (do_inverse)
322             av_log(NULL, AV_LOG_INFO,"IFFT");
323         else
324             av_log(NULL, AV_LOG_INFO,"FFT");
325         ff_fft_init(s, fft_nbits, do_inverse);
326         fft_ref_init(fft_nbits, do_inverse);
327         break;
328 #if CONFIG_FFT_FLOAT
329     case TRANSFORM_RDFT:
330         if (do_inverse)
331             av_log(NULL, AV_LOG_INFO,"IDFT_C2R");
332         else
333             av_log(NULL, AV_LOG_INFO,"DFT_R2C");
334         ff_rdft_init(r, fft_nbits, do_inverse ? IDFT_C2R : DFT_R2C);
335         fft_ref_init(fft_nbits, do_inverse);
336         break;
337     case TRANSFORM_DCT:
338         if (do_inverse)
339             av_log(NULL, AV_LOG_INFO,"DCT_III");
340         else
341             av_log(NULL, AV_LOG_INFO,"DCT_II");
342         ff_dct_init(d, fft_nbits, do_inverse ? DCT_III : DCT_II);
343         break;
344 #endif
345     default:
346         av_log(NULL, AV_LOG_ERROR, "Requested transform not supported\n");
347         return 1;
348     }
349     av_log(NULL, AV_LOG_INFO," %d test\n", fft_size);
350
351     /* generate random data */
352
353     for (i = 0; i < fft_size; i++) {
354         tab1[i].re = frandom(&prng);
355         tab1[i].im = frandom(&prng);
356     }
357
358     /* checking result */
359     av_log(NULL, AV_LOG_INFO,"Checking...\n");
360
361     switch (transform) {
362     case TRANSFORM_MDCT:
363         if (do_inverse) {
364             imdct_ref((FFTSample *)tab_ref, (FFTSample *)tab1, fft_nbits);
365             m->imdct_calc(m, tab2, (FFTSample *)tab1);
366             err = check_diff((FFTSample *)tab_ref, tab2, fft_size, scale);
367         } else {
368             mdct_ref((FFTSample *)tab_ref, (FFTSample *)tab1, fft_nbits);
369
370             m->mdct_calc(m, tab2, (FFTSample *)tab1);
371
372             err = check_diff((FFTSample *)tab_ref, tab2, fft_size / 2, scale);
373         }
374         break;
375     case TRANSFORM_FFT:
376         memcpy(tab, tab1, fft_size * sizeof(FFTComplex));
377         s->fft_permute(s, tab);
378         s->fft_calc(s, tab);
379
380         fft_ref(tab_ref, tab1, fft_nbits);
381         err = check_diff((FFTSample *)tab_ref, (FFTSample *)tab, fft_size * 2, 1.0);
382         break;
383 #if CONFIG_FFT_FLOAT
384     case TRANSFORM_RDFT:
385         fft_size_2 = fft_size >> 1;
386         if (do_inverse) {
387             tab1[         0].im = 0;
388             tab1[fft_size_2].im = 0;
389             for (i = 1; i < fft_size_2; i++) {
390                 tab1[fft_size_2+i].re =  tab1[fft_size_2-i].re;
391                 tab1[fft_size_2+i].im = -tab1[fft_size_2-i].im;
392             }
393
394             memcpy(tab2, tab1, fft_size * sizeof(FFTSample));
395             tab2[1] = tab1[fft_size_2].re;
396
397             r->rdft_calc(r, tab2);
398             fft_ref(tab_ref, tab1, fft_nbits);
399             for (i = 0; i < fft_size; i++) {
400                 tab[i].re = tab2[i];
401                 tab[i].im = 0;
402             }
403             err = check_diff((float *)tab_ref, (float *)tab, fft_size * 2, 0.5);
404         } else {
405             for (i = 0; i < fft_size; i++) {
406                 tab2[i]    = tab1[i].re;
407                 tab1[i].im = 0;
408             }
409             r->rdft_calc(r, tab2);
410             fft_ref(tab_ref, tab1, fft_nbits);
411             tab_ref[0].im = tab_ref[fft_size_2].re;
412             err = check_diff((float *)tab_ref, (float *)tab2, fft_size, 1.0);
413         }
414         break;
415     case TRANSFORM_DCT:
416         memcpy(tab, tab1, fft_size * sizeof(FFTComplex));
417         d->dct_calc(d, (FFTSample *)tab);
418         if (do_inverse) {
419             idct_ref((FFTSample*)tab_ref, (FFTSample *)tab1, fft_nbits);
420         } else {
421             dct_ref((FFTSample*)tab_ref, (FFTSample *)tab1, fft_nbits);
422         }
423         err = check_diff((float *)tab_ref, (float *)tab, fft_size, 1.0);
424         break;
425 #endif
426     }
427
428     /* do a speed test */
429
430     if (do_speed) {
431         int64_t time_start, duration;
432         int nb_its;
433
434         av_log(NULL, AV_LOG_INFO,"Speed test...\n");
435         /* we measure during about 1 seconds */
436         nb_its = 1;
437         for(;;) {
438             time_start = av_gettime();
439             for (it = 0; it < nb_its; it++) {
440                 switch (transform) {
441                 case TRANSFORM_MDCT:
442                     if (do_inverse) {
443                         m->imdct_calc(m, (FFTSample *)tab, (FFTSample *)tab1);
444                     } else {
445                         m->mdct_calc(m, (FFTSample *)tab, (FFTSample *)tab1);
446                     }
447                     break;
448                 case TRANSFORM_FFT:
449                     memcpy(tab, tab1, fft_size * sizeof(FFTComplex));
450                     s->fft_calc(s, tab);
451                     break;
452 #if CONFIG_FFT_FLOAT
453                 case TRANSFORM_RDFT:
454                     memcpy(tab2, tab1, fft_size * sizeof(FFTSample));
455                     r->rdft_calc(r, tab2);
456                     break;
457                 case TRANSFORM_DCT:
458                     memcpy(tab2, tab1, fft_size * sizeof(FFTSample));
459                     d->dct_calc(d, tab2);
460                     break;
461 #endif
462                 }
463             }
464             duration = av_gettime() - time_start;
465             if (duration >= 1000000)
466                 break;
467             nb_its *= 2;
468         }
469         av_log(NULL, AV_LOG_INFO,"time: %0.1f us/transform [total time=%0.2f s its=%d]\n",
470                (double)duration / nb_its,
471                (double)duration / 1000000.0,
472                nb_its);
473     }
474
475     switch (transform) {
476     case TRANSFORM_MDCT:
477         ff_mdct_end(m);
478         break;
479     case TRANSFORM_FFT:
480         ff_fft_end(s);
481         break;
482 #if CONFIG_FFT_FLOAT
483     case TRANSFORM_RDFT:
484         ff_rdft_end(r);
485         break;
486     case TRANSFORM_DCT:
487         ff_dct_end(d);
488         break;
489 #endif
490     }
491
492     av_free(tab);
493     av_free(tab1);
494     av_free(tab2);
495     av_free(tab_ref);
496     av_free(exptab);
497
498     return err;
499 }