src/spectral/fft.c

   1 /*
   2   Copyright (C) 2003-2009 Paul Brossier <piem@aubio.org>
   3
   4   This file is part of aubio.
   5
   6   aubio is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   aubio 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
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with aubio.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #include "aubio_priv.h"
  22 #include "fvec.h"
  23 #include "cvec.h"
  24 #include "mathutils.h"
  25 #include "spectral/fft.h"
  26
  27 #ifdef HAVE_FFTW3             // using FFTW3
  28 /* note that <complex.h> is not included here but only in aubio_priv.h, so that
  29  * c++ projects can still use their own complex definition. */
  30 #include <fftw3.h>
  31 #include <pthread.h>
  32
  33 #ifdef HAVE_COMPLEX_H
  34 #ifdef HAVE_FFTW3F
  35 /** fft data type with complex.h and fftw3f */
  36 #define FFTW_TYPE fftwf_complex
  37 #else
  38 /** fft data type with complex.h and fftw3 */
  39 #define FFTW_TYPE fftw_complex
  40 #endif
  41 #else
  42 #ifdef HAVE_FFTW3F
  43 /** fft data type without complex.h and with fftw3f */
  44 #define FFTW_TYPE float
  45 #else
  46 /** fft data type without complex.h and with fftw */
  47 #define FFTW_TYPE double
  48 #endif
  49 #endif
  50
  51 /** fft data type */
  52 typedef FFTW_TYPE fft_data_t;
  53
  54 #ifdef HAVE_FFTW3F
  55 #define fftw_malloc            fftwf_malloc
  56 #define fftw_free              fftwf_free
  57 #define fftw_execute           fftwf_execute
  58 #define fftw_plan_dft_r2c_1d   fftwf_plan_dft_r2c_1d
  59 #define fftw_plan_dft_c2r_1d   fftwf_plan_dft_c2r_1d
  60 #define fftw_plan_r2r_1d       fftwf_plan_r2r_1d
  61 #define fftw_plan              fftwf_plan
  62 #define fftw_destroy_plan      fftwf_destroy_plan
  63 #endif
  64
  65 #ifdef HAVE_FFTW3F
  66 #if HAVE_AUBIO_DOUBLE
  67 #error "Using aubio in double precision with fftw3 in single precision"
  68 #endif /* HAVE_AUBIO_DOUBLE */
  69 #define real_t float
  70 #elif defined (HAVE_FFTW3) /* HAVE_FFTW3F */
  71 #if !HAVE_AUBIO_DOUBLE
  72 #error "Using aubio in single precision with fftw3 in double precision"
  73 #endif /* HAVE_AUBIO_DOUBLE */
  74 #define real_t double
  75 #endif /* HAVE_FFTW3F */
  76
  77 // a global mutex for FFTW thread safety
  78 pthread_mutex_t aubio_fftw_mutex = PTHREAD_MUTEX_INITIALIZER;
  79
  80 #else
  81 #ifdef HAVE_ACCELERATE        // using ACCELERATE
  82 // https://developer.apple.com/library/mac/#documentation/Accelerate/Reference/vDSPRef/Reference/reference.html
  83 #include <Accelerate/Accelerate.h>
  84
  85 #if !HAVE_AUBIO_DOUBLE
  86 #define aubio_vDSP_ctoz                vDSP_ctoz
  87 #define aubio_vDSP_fft_zrip            vDSP_fft_zrip
  88 #define aubio_vDSP_ztoc                vDSP_ztoc
  89 #define aubio_vDSP_zvmags              vDSP_zvmags
  90 #define aubio_vDSP_zvphas              vDSP_zvphas
  91 #define aubio_vDSP_vsadd               vDSP_vsadd
  92 #define aubio_vDSP_vsmul               vDSP_vsmul
  93 #define aubio_vDSP_create_fftsetup     vDSP_create_fftsetup
  94 #define aubio_vDSP_destroy_fftsetup    vDSP_destroy_fftsetup
  95 #define aubio_DSPComplex               DSPComplex
  96 #define aubio_DSPSplitComplex          DSPSplitComplex
  97 #define aubio_FFTSetup                 FFTSetup
  98 #define aubio_vvsqrt                   vvsqrtf
  99 #else
 100 #define aubio_vDSP_ctoz                vDSP_ctozD
 101 #define aubio_vDSP_fft_zrip            vDSP_fft_zripD
 102 #define aubio_vDSP_ztoc                vDSP_ztocD
 103 #define aubio_vDSP_zvmags              vDSP_zvmagsD
 104 #define aubio_vDSP_zvphas              vDSP_zvphasD
 105 #define aubio_vDSP_vsadd               vDSP_vsaddD
 106 #define aubio_vDSP_vsmul               vDSP_vsmulD
 107 #define aubio_vDSP_create_fftsetup     vDSP_create_fftsetupD
 108 #define aubio_vDSP_destroy_fftsetup    vDSP_destroy_fftsetupD
 109 #define aubio_DSPComplex               DSPDoubleComplex
 110 #define aubio_DSPSplitComplex          DSPDoubleSplitComplex
 111 #define aubio_FFTSetup                 FFTSetupD
 112 #define aubio_vvsqrt                   vvsqrt
 113 #endif /* HAVE_AUBIO_DOUBLE */
 114
 115 #else                         // using OOURA
 116 // let's use ooura instead
 117 extern void aubio_ooura_rdft(int, int, smpl_t *, int *, smpl_t *);
 118
 119 #endif /* HAVE_ACCELERATE */
 120 #endif /* HAVE_FFTW3 */
 121
 122 struct _aubio_fft_t {
 123   uint_t winsize;
 124   uint_t fft_size;
 125 #ifdef HAVE_FFTW3             // using FFTW3
 126   real_t *in, *out;
 127   fftw_plan pfw, pbw;
 128   fft_data_t * specdata;      /* complex spectral data */
 129 #else
 130 #ifdef HAVE_ACCELERATE        // using ACCELERATE
 131   int log2fftsize;
 132   aubio_FFTSetup fftSetup;
 133   aubio_DSPSplitComplex spec;
 134   smpl_t *in, *out;
 135 #else                         // using OOURA
 136   smpl_t *in, *out;
 137   smpl_t *w;
 138   int *ip;
 139 #endif /* HAVE_ACCELERATE */
 140 #endif /* HAVE_FFTW3 */
 141   fvec_t * compspec;
 142 };
 143
 144 aubio_fft_t * new_aubio_fft (uint_t winsize) {
 145   aubio_fft_t * s = AUBIO_NEW(aubio_fft_t);
 146   if ((sint_t)winsize < 2) {
 147     AUBIO_ERR("fft: got winsize %d, but can not be < 2\n", winsize);
 148     goto beach;
 149   }
 150 #ifdef HAVE_FFTW3
 151   uint_t i;
 152   s->winsize  = winsize;
 153   /* allocate memory */
 154   s->in       = AUBIO_ARRAY(real_t,winsize);
 155   s->out      = AUBIO_ARRAY(real_t,winsize);
 156   s->compspec = new_fvec(winsize);
 157   /* create plans */
 158   pthread_mutex_lock(&aubio_fftw_mutex);
 159 #ifdef HAVE_COMPLEX_H
 160   s->fft_size = winsize/2 + 1;
 161   s->specdata = (fft_data_t*)fftw_malloc(sizeof(fft_data_t)*s->fft_size);
 162   s->pfw = fftw_plan_dft_r2c_1d(winsize, s->in,  s->specdata, FFTW_ESTIMATE);
 163   s->pbw = fftw_plan_dft_c2r_1d(winsize, s->specdata, s->out, FFTW_ESTIMATE);
 164 #else
 165   s->fft_size = winsize;
 166   s->specdata = (fft_data_t*)fftw_malloc(sizeof(fft_data_t)*s->fft_size);
 167   s->pfw = fftw_plan_r2r_1d(winsize, s->in,  s->specdata, FFTW_R2HC, FFTW_ESTIMATE);
 168   s->pbw = fftw_plan_r2r_1d(winsize, s->specdata, s->out, FFTW_HC2R, FFTW_ESTIMATE);
 169 #endif
 170   pthread_mutex_unlock(&aubio_fftw_mutex);
 171   for (i = 0; i < s->winsize; i++) {
 172     s->in[i] = 0.;
 173     s->out[i] = 0.;
 174   }
 175   for (i = 0; i < s->fft_size; i++) {
 176     s->specdata[i] = 0.;
 177   }
 178 #else
 179 #ifdef HAVE_ACCELERATE        // using ACCELERATE
 180   s->winsize = winsize;
 181   s->fft_size = winsize;
 182   s->compspec = new_fvec(winsize);
 183   s->log2fftsize = (uint_t)log2f(s->fft_size);
 184   s->in = AUBIO_ARRAY(smpl_t, s->fft_size);
 185   s->out = AUBIO_ARRAY(smpl_t, s->fft_size);
 186   s->spec.realp = AUBIO_ARRAY(smpl_t, s->fft_size/2);
 187   s->spec.imagp = AUBIO_ARRAY(smpl_t, s->fft_size/2);
 188   s->fftSetup = aubio_vDSP_create_fftsetup(s->log2fftsize, FFT_RADIX2);
 189 #else                         // using OOURA
 190   if (aubio_is_power_of_two(winsize) != 1) {
 191     AUBIO_ERR("fft: can only create with sizes power of two, requested %d,"
 192         " try recompiling aubio with --enable-fftw3\n", winsize);
 193     goto beach;
 194   }
 195   s->winsize = winsize;
 196   s->fft_size = winsize / 2 + 1;
 197   s->compspec = new_fvec(winsize);
 198   s->in    = AUBIO_ARRAY(smpl_t, s->winsize);
 199   s->out   = AUBIO_ARRAY(smpl_t, s->winsize);
 200   s->ip    = AUBIO_ARRAY(int   , s->fft_size);
 201   s->w     = AUBIO_ARRAY(smpl_t, s->fft_size);
 202   s->ip[0] = 0;
 203 #endif /* HAVE_ACCELERATE */
 204 #endif /* HAVE_FFTW3 */
 205   return s;
 206 beach:
 207   AUBIO_FREE(s);
 208   return NULL;
 209 }
 210
 211 void del_aubio_fft(aubio_fft_t * s) {
 212   /* destroy data */
 213   del_fvec(s->compspec);
 214 #ifdef HAVE_FFTW3             // using FFTW3
 215   pthread_mutex_lock(&aubio_fftw_mutex);
 216   fftw_destroy_plan(s->pfw);
 217   fftw_destroy_plan(s->pbw);
 218   fftw_free(s->specdata);
 219   pthread_mutex_unlock(&aubio_fftw_mutex);
 220 #else /* HAVE_FFTW3 */
 221 #ifdef HAVE_ACCELERATE        // using ACCELERATE
 222   AUBIO_FREE(s->spec.realp);
 223   AUBIO_FREE(s->spec.imagp);
 224   aubio_vDSP_destroy_fftsetup(s->fftSetup);
 225 #else                         // using OOURA
 226   AUBIO_FREE(s->w);
 227   AUBIO_FREE(s->ip);
 228 #endif /* HAVE_ACCELERATE */
 229 #endif /* HAVE_FFTW3 */
 230   AUBIO_FREE(s->out);
 231   AUBIO_FREE(s->in);
 232   AUBIO_FREE(s);
 233 }
 234
 235 void aubio_fft_do(aubio_fft_t * s, const fvec_t * input, cvec_t * spectrum) {
 236   aubio_fft_do_complex(s, input, s->compspec);
 237   aubio_fft_get_spectrum(s->compspec, spectrum);
 238 }
 239
 240 void aubio_fft_rdo(aubio_fft_t * s, const cvec_t * spectrum, fvec_t * output) {
 241   aubio_fft_get_realimag(spectrum, s->compspec);
 242   aubio_fft_rdo_complex(s, s->compspec, output);
 243 }
 244
 245 void aubio_fft_do_complex(aubio_fft_t * s, const fvec_t * input, fvec_t * compspec) {
 246   uint_t i;
 247 #ifndef HAVE_MEMCPY_HACKS
 248   for (i=0; i < s->winsize; i++) {
 249     s->in[i] = input->data[i];
 250   }
 251 #else
 252   memcpy(s->in, input->data, s->winsize * sizeof(smpl_t));
 253 #endif /* HAVE_MEMCPY_HACKS */
 254 #ifdef HAVE_FFTW3             // using FFTW3
 255   fftw_execute(s->pfw);
 256 #ifdef HAVE_COMPLEX_H
 257   compspec->data[0] = REAL(s->specdata[0]);
 258   for (i = 1; i < s->fft_size -1 ; i++) {
 259     compspec->data[i] = REAL(s->specdata[i]);
 260     compspec->data[compspec->length - i] = IMAG(s->specdata[i]);
 261   }
 262   compspec->data[s->fft_size-1] = REAL(s->specdata[s->fft_size-1]);
 263 #else /* HAVE_COMPLEX_H  */
 264   for (i = 0; i < s->fft_size; i++) {
 265     compspec->data[i] = s->specdata[i];
 266   }
 267 #endif /* HAVE_COMPLEX_H */
 268 #else /* HAVE_FFTW3 */
 269 #ifdef HAVE_ACCELERATE        // using ACCELERATE
 270   // convert real data to even/odd format used in vDSP
 271   aubio_vDSP_ctoz((aubio_DSPComplex*)s->in, 2, &s->spec, 1, s->fft_size/2);
 272   // compute the FFT
 273   aubio_vDSP_fft_zrip(s->fftSetup, &s->spec, 1, s->log2fftsize, FFT_FORWARD);
 274   // convert from vDSP complex split to [ r0, r1, ..., rN, iN-1, .., i2, i1]
 275   compspec->data[0] = s->spec.realp[0];
 276   compspec->data[s->fft_size / 2] = s->spec.imagp[0];
 277   for (i = 1; i < s->fft_size / 2; i++) {
 278     compspec->data[i] = s->spec.realp[i];
 279     compspec->data[s->fft_size - i] = s->spec.imagp[i];
 280   }
 281   // apply scaling
 282   smpl_t scale = 1./2.;
 283   aubio_vDSP_vsmul(compspec->data, 1, &scale, compspec->data, 1, s->fft_size);
 284 #else                         // using OOURA
 285   aubio_ooura_rdft(s->winsize, 1, s->in, s->ip, s->w);
 286   compspec->data[0] = s->in[0];
 287   compspec->data[s->winsize / 2] = s->in[1];
 288   for (i = 1; i < s->fft_size - 1; i++) {
 289     compspec->data[i] = s->in[2 * i];
 290     compspec->data[s->winsize - i] = - s->in[2 * i + 1];
 291   }
 292 #endif /* HAVE_ACCELERATE */
 293 #endif /* HAVE_FFTW3 */
 294 }
 295
 296 void aubio_fft_rdo_complex(aubio_fft_t * s, const fvec_t * compspec, fvec_t * output) {
 297   uint_t i;
 298 #ifdef HAVE_FFTW3
 299   const smpl_t renorm = 1./(smpl_t)s->winsize;
 300 #ifdef HAVE_COMPLEX_H
 301   s->specdata[0] = compspec->data[0];
 302   for (i=1; i < s->fft_size - 1; i++) {
 303     s->specdata[i] = compspec->data[i] +
 304       I * compspec->data[compspec->length - i];
 305   }
 306   s->specdata[s->fft_size - 1] = compspec->data[s->fft_size - 1];
 307 #else
 308   for (i=0; i < s->fft_size; i++) {
 309     s->specdata[i] = compspec->data[i];
 310   }
 311 #endif
 312   fftw_execute(s->pbw);
 313   for (i = 0; i < output->length; i++) {
 314     output->data[i] = s->out[i]*renorm;
 315   }
 316 #else /* HAVE_FFTW3 */
 317 #ifdef HAVE_ACCELERATE        // using ACCELERATE
 318   // convert from real imag  [ r0, r1, ..., rN, iN-1, .., i2, i1]
 319   // to vDSP packed format   [ r0, rN, r1, i1, ..., rN-1, iN-1 ]
 320   s->out[0] = compspec->data[0];
 321   s->out[1] = compspec->data[s->winsize / 2];
 322   for (i = 1; i < s->fft_size / 2; i++) {
 323     s->out[2 * i] = compspec->data[i];
 324     s->out[2 * i + 1] = compspec->data[s->winsize - i];
 325   }
 326   // convert to split complex format used in vDSP
 327   aubio_vDSP_ctoz((aubio_DSPComplex*)s->out, 2, &s->spec, 1, s->fft_size/2);
 328   // compute the FFT
 329   aubio_vDSP_fft_zrip(s->fftSetup, &s->spec, 1, s->log2fftsize, FFT_INVERSE);
 330   // convert result to real output
 331   aubio_vDSP_ztoc(&s->spec, 1, (aubio_DSPComplex*)output->data, 2, s->fft_size/2);
 332   // apply scaling
 333   smpl_t scale = 1.0 / s->winsize;
 334   aubio_vDSP_vsmul(output->data, 1, &scale, output->data, 1, s->fft_size);
 335 #else                         // using OOURA
 336   smpl_t scale = 2.0 / s->winsize;
 337   s->out[0] = compspec->data[0];
 338   s->out[1] = compspec->data[s->winsize / 2];
 339   for (i = 1; i < s->fft_size - 1; i++) {
 340     s->out[2 * i] = compspec->data[i];
 341     s->out[2 * i + 1] = - compspec->data[s->winsize - i];
 342   }
 343   aubio_ooura_rdft(s->winsize, -1, s->out, s->ip, s->w);
 344   for (i=0; i < s->winsize; i++) {
 345     output->data[i] = s->out[i] * scale;
 346   }
 347 #endif /* HAVE_ACCELERATE */
 348 #endif /* HAVE_FFTW3 */
 349 }
 350
 351 void aubio_fft_get_spectrum(const fvec_t * compspec, cvec_t * spectrum) {
 352   aubio_fft_get_phas(compspec, spectrum);
 353   aubio_fft_get_norm(compspec, spectrum);
 354 }
 355
 356 void aubio_fft_get_realimag(const cvec_t * spectrum, fvec_t * compspec) {
 357   aubio_fft_get_imag(spectrum, compspec);
 358   aubio_fft_get_real(spectrum, compspec);
 359 }
 360
 361 void aubio_fft_get_phas(const fvec_t * compspec, cvec_t * spectrum) {
 362   uint_t i;
 363   if (compspec->data[0] < 0) {
 364     spectrum->phas[0] = PI;
 365   } else {
 366     spectrum->phas[0] = 0.;
 367   }
 368   for (i=1; i < spectrum->length - 1; i++) {
 369     spectrum->phas[i] = ATAN2(compspec->data[compspec->length-i],
 370         compspec->data[i]);
 371   }
 372   if (compspec->data[compspec->length/2] < 0) {
 373     spectrum->phas[spectrum->length - 1] = PI;
 374   } else {
 375     spectrum->phas[spectrum->length - 1] = 0.;
 376   }
 377 }
 378
 379 void aubio_fft_get_norm(const fvec_t * compspec, cvec_t * spectrum) {
 380   uint_t i = 0;
 381   spectrum->norm[0] = ABS(compspec->data[0]);
 382   for (i=1; i < spectrum->length - 1; i++) {
 383     spectrum->norm[i] = SQRT(SQR(compspec->data[i])
 384         + SQR(compspec->data[compspec->length - i]) );
 385   }
 386   spectrum->norm[spectrum->length-1] =
 387     ABS(compspec->data[compspec->length/2]);
 388 }
 389
 390 void aubio_fft_get_imag(const cvec_t * spectrum, fvec_t * compspec) {
 391   uint_t i;
 392   for (i = 1; i < ( compspec->length + 1 ) / 2 /*- 1 + 1*/; i++) {
 393     compspec->data[compspec->length - i] =
 394       spectrum->norm[i]*SIN(spectrum->phas[i]);
 395   }
 396 }
 397
 398 void aubio_fft_get_real(const cvec_t * spectrum, fvec_t * compspec) {
 399   uint_t i;
 400   for (i = 0; i < compspec->length / 2 + 1; i++) {
 401     compspec->data[i] =
 402       spectrum->norm[i]*COS(spectrum->phas[i]);
 403   }
 404 }