]> git.sesse.net Git - ffmpeg/blob - libavcodec/fft.h
5f67b61f067c7dbfda1c69728ac08b2e517ca808
[ffmpeg] / libavcodec / fft.h
1 /*
2  * Copyright (c) 2000, 2001, 2002 Fabrice Bellard
3  * Copyright (c) 2002-2004 Michael Niedermayer <michaelni@gmx.at>
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #ifndef AVCODEC_FFT_H
23 #define AVCODEC_FFT_H
24
25 #ifndef FFT_FLOAT
26 #define FFT_FLOAT 1
27 #endif
28
29 #ifndef FFT_FIXED_32
30 #define FFT_FIXED_32 0
31 #endif
32
33 #include <stdint.h>
34 #include "config.h"
35
36 #include "libavutil/mem_internal.h"
37
38 #if FFT_FLOAT
39
40 #include "avfft.h"
41
42 #define FFT_NAME(x) x
43
44 typedef float FFTDouble;
45
46 #else
47
48 #if FFT_FIXED_32
49
50 #define Q31(x) (int)((x)*2147483648.0 + 0.5)
51 #define FFT_NAME(x) x ## _fixed_32
52
53 typedef int32_t FFTSample;
54
55 #else /* FFT_FIXED_32 */
56
57 #define FFT_NAME(x) x ## _fixed
58
59 typedef int16_t FFTSample;
60
61 #endif /* FFT_FIXED_32 */
62
63 typedef struct FFTComplex {
64     FFTSample re, im;
65 } FFTComplex;
66
67 typedef int    FFTDouble;
68 typedef struct FFTContext FFTContext;
69
70 #endif /* FFT_FLOAT */
71
72 typedef struct FFTDComplex {
73     FFTDouble re, im;
74 } FFTDComplex;
75
76 /* FFT computation */
77
78 enum fft_permutation_type {
79     FF_FFT_PERM_DEFAULT,
80     FF_FFT_PERM_SWAP_LSBS,
81     FF_FFT_PERM_AVX,
82 };
83
84 enum mdct_permutation_type {
85     FF_MDCT_PERM_NONE,
86     FF_MDCT_PERM_INTERLEAVE,
87 };
88
89 struct FFTContext {
90     int nbits;
91     int inverse;
92     uint16_t *revtab;
93     FFTComplex *tmp_buf;
94     int mdct_size; /* size of MDCT (i.e. number of input data * 2) */
95     int mdct_bits; /* n = 2^nbits */
96     /* pre/post rotation tables */
97     FFTSample *tcos;
98     FFTSample *tsin;
99     /**
100      * Do the permutation needed BEFORE calling fft_calc().
101      */
102     void (*fft_permute)(struct FFTContext *s, FFTComplex *z);
103     /**
104      * Do a complex FFT with the parameters defined in ff_fft_init(). The
105      * input data must be permuted before. No 1.0/sqrt(n) normalization is done.
106      */
107     void (*fft_calc)(struct FFTContext *s, FFTComplex *z);
108     void (*imdct_calc)(struct FFTContext *s, FFTSample *output, const FFTSample *input);
109     void (*imdct_half)(struct FFTContext *s, FFTSample *output, const FFTSample *input);
110     void (*mdct_calc)(struct FFTContext *s, FFTSample *output, const FFTSample *input);
111     void (*mdct_calcw)(struct FFTContext *s, FFTDouble *output, const FFTSample *input);
112     enum fft_permutation_type fft_permutation;
113     enum mdct_permutation_type mdct_permutation;
114     uint32_t *revtab32;
115 };
116
117 #if CONFIG_HARDCODED_TABLES
118 #define COSTABLE_CONST const
119 #else
120 #define COSTABLE_CONST
121 #endif
122
123 #define COSTABLE(size) \
124     COSTABLE_CONST DECLARE_ALIGNED(32, FFTSample, FFT_NAME(ff_cos_##size))[size/2]
125
126 extern COSTABLE(16);
127 extern COSTABLE(32);
128 extern COSTABLE(64);
129 extern COSTABLE(128);
130 extern COSTABLE(256);
131 extern COSTABLE(512);
132 extern COSTABLE(1024);
133 extern COSTABLE(2048);
134 extern COSTABLE(4096);
135 extern COSTABLE(8192);
136 extern COSTABLE(16384);
137 extern COSTABLE(32768);
138 extern COSTABLE(65536);
139 extern COSTABLE(131072);
140 extern COSTABLE_CONST FFTSample* const FFT_NAME(ff_cos_tabs)[18];
141
142 #define ff_init_ff_cos_tabs FFT_NAME(ff_init_ff_cos_tabs)
143
144 /**
145  * Initialize the cosine table in ff_cos_tabs[index]
146  * @param index index in ff_cos_tabs array of the table to initialize
147  */
148 void ff_init_ff_cos_tabs(int index);
149
150 #define ff_fft_init FFT_NAME(ff_fft_init)
151 #define ff_fft_end  FFT_NAME(ff_fft_end)
152
153 /**
154  * Set up a complex FFT.
155  * @param nbits           log2 of the length of the input array
156  * @param inverse         if 0 perform the forward transform, if 1 perform the inverse
157  */
158 int ff_fft_init(FFTContext *s, int nbits, int inverse);
159
160 void ff_fft_init_aarch64(FFTContext *s);
161 void ff_fft_init_x86(FFTContext *s);
162 void ff_fft_init_arm(FFTContext *s);
163 void ff_fft_init_mips(FFTContext *s);
164 void ff_fft_init_ppc(FFTContext *s);
165
166 void ff_fft_fixed_init_arm(FFTContext *s);
167
168 void ff_fft_end(FFTContext *s);
169
170 #define ff_mdct_init FFT_NAME(ff_mdct_init)
171 #define ff_mdct_end  FFT_NAME(ff_mdct_end)
172
173 int ff_mdct_init(FFTContext *s, int nbits, int inverse, double scale);
174 void ff_mdct_end(FFTContext *s);
175
176 #endif /* AVCODEC_FFT_H */