git.sesse.net Git - ffmpeg/blob - 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 #include <stdint.h>
  26 #include "config.h"
  27 #include "libavutil/mem.h"
  28 #include "avfft.h"
  29
  30 /* FFT computation */
  31
  32 struct FFTContext {
  33     int nbits;
  34     int inverse;
  35     uint16_t *revtab;
  36     FFTComplex *tmp_buf;
  37     int mdct_size; /* size of MDCT (i.e. number of input data * 2) */
  38     int mdct_bits; /* n = 2^nbits */
  39     /* pre/post rotation tables */
  40     FFTSample *tcos;
  41     FFTSample *tsin;
  42     void (*fft_permute)(struct FFTContext *s, FFTComplex *z);
  43     void (*fft_calc)(struct FFTContext *s, FFTComplex *z);
  44     void (*imdct_calc)(struct FFTContext *s, FFTSample *output, const FFTSample *input);
  45     void (*imdct_half)(struct FFTContext *s, FFTSample *output, const FFTSample *input);
  46     void (*mdct_calc)(struct FFTContext *s, FFTSample *output, const FFTSample *input);
  47     int fft_permutation;
  48 #define FF_FFT_PERM_DEFAULT   0
  49 #define FF_FFT_PERM_SWAP_LSBS 1
  50     int mdct_permutation;
  51 #define FF_MDCT_PERM_NONE       0
  52 #define FF_MDCT_PERM_INTERLEAVE 1
  53 };
  54
  55 #if CONFIG_HARDCODED_TABLES
  56 #define COSTABLE_CONST const
  57 #define SINTABLE_CONST const
  58 #define SINETABLE_CONST const
  59 #else
  60 #define COSTABLE_CONST
  61 #define SINTABLE_CONST
  62 #define SINETABLE_CONST
  63 #endif
  64
  65 #define COSTABLE(size) \
  66     COSTABLE_CONST DECLARE_ALIGNED(16, FFTSample, ff_cos_##size)[size/2]
  67 #define SINTABLE(size) \
  68     SINTABLE_CONST DECLARE_ALIGNED(16, FFTSample, ff_sin_##size)[size/2]
  69 #define SINETABLE(size) \
  70     SINETABLE_CONST DECLARE_ALIGNED(16, float, ff_sine_##size)[size]
  71 extern COSTABLE(16);
  72 extern COSTABLE(32);
  73 extern COSTABLE(64);
  74 extern COSTABLE(128);
  75 extern COSTABLE(256);
  76 extern COSTABLE(512);
  77 extern COSTABLE(1024);
  78 extern COSTABLE(2048);
  79 extern COSTABLE(4096);
  80 extern COSTABLE(8192);
  81 extern COSTABLE(16384);
  82 extern COSTABLE(32768);
  83 extern COSTABLE(65536);
  84 extern COSTABLE_CONST FFTSample* const ff_cos_tabs[17];
  85
  86 /**
  87  * Initialize the cosine table in ff_cos_tabs[index]
  88  * \param index index in ff_cos_tabs array of the table to initialize
  89  */
  90 void ff_init_ff_cos_tabs(int index);
  91
  92 extern SINTABLE(16);
  93 extern SINTABLE(32);
  94 extern SINTABLE(64);
  95 extern SINTABLE(128);
  96 extern SINTABLE(256);
  97 extern SINTABLE(512);
  98 extern SINTABLE(1024);
  99 extern SINTABLE(2048);
 100 extern SINTABLE(4096);
 101 extern SINTABLE(8192);
 102 extern SINTABLE(16384);
 103 extern SINTABLE(32768);
 104 extern SINTABLE(65536);
 105
 106 /**
 107  * Set up a complex FFT.
 108  * @param nbits           log2 of the length of the input array
 109  * @param inverse         if 0 perform the forward transform, if 1 perform the inverse
 110  */
 111 int ff_fft_init(FFTContext *s, int nbits, int inverse);
 112
 113 void ff_fft_init_altivec(FFTContext *s);
 114 void ff_fft_init_mmx(FFTContext *s);
 115 void ff_fft_init_arm(FFTContext *s);
 116 void ff_dct_init_mmx(DCTContext *s);
 117
 118 /**
 119  * Do the permutation needed BEFORE calling ff_fft_calc().
 120  */
 121 static inline void ff_fft_permute(FFTContext *s, FFTComplex *z)
 122 {
 123     s->fft_permute(s, z);
 124 }
 125 /**
 126  * Do a complex FFT with the parameters defined in ff_fft_init(). The
 127  * input data must be permuted before. No 1.0/sqrt(n) normalization is done.
 128  */
 129 static inline void ff_fft_calc(FFTContext *s, FFTComplex *z)
 130 {
 131     s->fft_calc(s, z);
 132 }
 133 void ff_fft_end(FFTContext *s);
 134
 135 /* MDCT computation */
 136
 137 static inline void ff_imdct_calc(FFTContext *s, FFTSample *output, const FFTSample *input)
 138 {
 139     s->imdct_calc(s, output, input);
 140 }
 141 static inline void ff_imdct_half(FFTContext *s, FFTSample *output, const FFTSample *input)
 142 {
 143     s->imdct_half(s, output, input);
 144 }
 145
 146 static inline void ff_mdct_calc(FFTContext *s, FFTSample *output,
 147                                 const FFTSample *input)
 148 {
 149     s->mdct_calc(s, output, input);
 150 }
 151
 152 /**
 153  * Maximum window size for ff_kbd_window_init.
 154  */
 155 #define FF_KBD_WINDOW_MAX 1024
 156
 157 /**
 158  * Generate a Kaiser-Bessel Derived Window.
 159  * @param   window  pointer to half window
 160  * @param   alpha   determines window shape
 161  * @param   n       size of half window, max FF_KBD_WINDOW_MAX
 162  */
 163 void ff_kbd_window_init(float *window, float alpha, int n);
 164
 165 /**
 166  * Generate a sine window.
 167  * @param   window  pointer to half window
 168  * @param   n       size of half window
 169  */
 170 void ff_sine_window_init(float *window, int n);
 171
 172 /**
 173  * initialize the specified entry of ff_sine_windows
 174  */
 175 void ff_init_ff_sine_windows(int index);
 176 extern SINETABLE(  32);
 177 extern SINETABLE(  64);
 178 extern SINETABLE( 128);
 179 extern SINETABLE( 256);
 180 extern SINETABLE( 512);
 181 extern SINETABLE(1024);
 182 extern SINETABLE(2048);
 183 extern SINETABLE(4096);
 184 extern SINETABLE_CONST float * const ff_sine_windows[13];
 185
 186 int ff_mdct_init(FFTContext *s, int nbits, int inverse, double scale);
 187 void ff_imdct_calc_c(FFTContext *s, FFTSample *output, const FFTSample *input);
 188 void ff_imdct_half_c(FFTContext *s, FFTSample *output, const FFTSample *input);
 189 void ff_mdct_calc_c(FFTContext *s, FFTSample *output, const FFTSample *input);
 190 void ff_mdct_end(FFTContext *s);
 191
 192 /* Real Discrete Fourier Transform */
 193
 194 struct RDFTContext {
 195     int nbits;
 196     int inverse;
 197     int sign_convention;
 198
 199     /* pre/post rotation tables */
 200     const FFTSample *tcos;
 201     SINTABLE_CONST FFTSample *tsin;
 202     FFTContext fft;
 203     void (*rdft_calc)(struct RDFTContext *s, FFTSample *z);
 204 };
 205
 206 /**
 207  * Set up a real FFT.
 208  * @param nbits           log2 of the length of the input array
 209  * @param trans           the type of transform
 210  */
 211 int ff_rdft_init(RDFTContext *s, int nbits, enum RDFTransformType trans);
 212 void ff_rdft_end(RDFTContext *s);
 213
 214 void ff_rdft_init_arm(RDFTContext *s);
 215
 216 static av_always_inline void ff_rdft_calc(RDFTContext *s, FFTSample *data)
 217 {
 218     s->rdft_calc(s, data);
 219 }
 220
 221 /* Discrete Cosine Transform */
 222
 223 struct DCTContext {
 224     int nbits;
 225     int inverse;
 226     RDFTContext rdft;
 227     const float *costab;
 228     FFTSample *csc2;
 229     void (*dct_calc)(struct DCTContext *s, FFTSample *data);
 230     void (*dct32)(FFTSample *out, const FFTSample *in);
 231 };
 232
 233 /**
 234  * Set up DCT.
 235  * @param nbits           size of the input array:
 236  *                        (1 << nbits)     for DCT-II, DCT-III and DST-I
 237  *                        (1 << nbits) + 1 for DCT-I
 238  *
 239  * @note the first element of the input of DST-I is ignored
 240  */
 241 int  ff_dct_init(DCTContext *s, int nbits, enum DCTTransformType type);
 242 void ff_dct_calc(DCTContext *s, FFTSample *data);
 243 void ff_dct_end (DCTContext *s);
 244
 245 #endif /* AVCODEC_FFT_H */