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