src/mathutils.c

   1 /*
   2   Copyright (C) 2003-2014 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 /* see in mathutils.h for doc */
  22
  23 #include "aubio_priv.h"
  24 #include "fvec.h"
  25 #include "mathutils.h"
  26 #include "musicutils.h"
  27 #include "config.h"
  28
  29 #ifdef HAVE_ACCELERATE
  30 #include <Accelerate/Accelerate.h>
  31 #endif
  32
  33 /** Window types */
  34 typedef enum
  35 {
  36   aubio_win_rectangle,
  37   aubio_win_hamming,
  38   aubio_win_hanning,
  39   aubio_win_hanningz,
  40   aubio_win_blackman,
  41   aubio_win_blackman_harris,
  42   aubio_win_gaussian,
  43   aubio_win_welch,
  44   aubio_win_parzen,
  45   aubio_win_default = aubio_win_hanningz,
  46 } aubio_window_type;
  47
  48 fvec_t *
  49 new_aubio_window (char_t * window_type, uint_t length)
  50 {
  51   fvec_t * win = new_fvec (length);
  52   uint_t err;
  53   if (win == NULL) {
  54     return NULL;
  55   }
  56   err = fvec_set_window (win, window_type);
  57   if (err != 0) {
  58     del_fvec(win);
  59     return NULL;
  60   }
  61   return win;
  62 }
  63
  64 uint_t fvec_set_window (fvec_t *win, char_t *window_type) {
  65   smpl_t * w = win->data;
  66   uint_t i, size = win->length;
  67   aubio_window_type wintype;
  68   if (window_type == NULL) {
  69       AUBIO_ERR ("window type can not be null.\n");
  70       return 1;
  71   } else if (strcmp (window_type, "rectangle") == 0)
  72       wintype = aubio_win_rectangle;
  73   else if (strcmp (window_type, "hamming") == 0)
  74       wintype = aubio_win_hamming;
  75   else if (strcmp (window_type, "hanning") == 0)
  76       wintype = aubio_win_hanning;
  77   else if (strcmp (window_type, "hanningz") == 0)
  78       wintype = aubio_win_hanningz;
  79   else if (strcmp (window_type, "blackman") == 0)
  80       wintype = aubio_win_blackman;
  81   else if (strcmp (window_type, "blackman_harris") == 0)
  82       wintype = aubio_win_blackman_harris;
  83   else if (strcmp (window_type, "gaussian") == 0)
  84       wintype = aubio_win_gaussian;
  85   else if (strcmp (window_type, "welch") == 0)
  86       wintype = aubio_win_welch;
  87   else if (strcmp (window_type, "parzen") == 0)
  88       wintype = aubio_win_parzen;
  89   else if (strcmp (window_type, "default") == 0)
  90       wintype = aubio_win_default;
  91   else {
  92       AUBIO_ERR ("unknown window type `%s`.\n", window_type);
  93       return 1;
  94   }
  95   switch(wintype) {
  96     case aubio_win_rectangle:
  97       for (i=0;i<size;i++)
  98         w[i] = 0.5;
  99       break;
 100     case aubio_win_hamming:
 101       for (i=0;i<size;i++)
 102         w[i] = 0.54 - 0.46 * COS(TWO_PI * i / (size));
 103       break;
 104     case aubio_win_hanning:
 105       for (i=0;i<size;i++)
 106         w[i] = 0.5 - (0.5 * COS(TWO_PI * i / (size)));
 107       break;
 108     case aubio_win_hanningz:
 109       for (i=0;i<size;i++)
 110         w[i] = 0.5 * (1.0 - COS(TWO_PI * i / (size)));
 111       break;
 112     case aubio_win_blackman:
 113       for (i=0;i<size;i++)
 114         w[i] = 0.42
 115           - 0.50 * COS(    TWO_PI*i/(size-1.0))
 116           + 0.08 * COS(2.0*TWO_PI*i/(size-1.0));
 117       break;
 118     case aubio_win_blackman_harris:
 119       for (i=0;i<size;i++)
 120         w[i] = 0.35875
 121           - 0.48829 * COS(    TWO_PI*i/(size-1.0))
 122           + 0.14128 * COS(2.0*TWO_PI*i/(size-1.0))
 123           - 0.01168 * COS(3.0*TWO_PI*i/(size-1.0));
 124       break;
 125     case aubio_win_gaussian:
 126       {
 127         lsmp_t a, b, c = 0.5;
 128         uint_t n;
 129         for (n = 0; n < size; n++)
 130         {
 131           a = (n-c*(size-1))/(SQR(c)*(size-1));
 132           b = -c*SQR(a);
 133           w[n] = EXP(b);
 134         }
 135       }
 136       break;
 137     case aubio_win_welch:
 138       for (i=0;i<size;i++)
 139         w[i] = 1.0 - SQR((2.*i-size)/(size+1.0));
 140       break;
 141     case aubio_win_parzen:
 142       for (i=0;i<size;i++)
 143         w[i] = 1.0 - ABS((2.f*i-size)/(size+1.0f));
 144       break;
 145     default:
 146       break;
 147   }
 148   return 0;
 149 }
 150
 151 smpl_t
 152 aubio_unwrap2pi (smpl_t phase)
 153 {
 154   /* mod(phase+pi,-2pi)+pi */
 155   return phase + TWO_PI * (1. + FLOOR (-(phase + PI) / TWO_PI));
 156 }
 157
 158 smpl_t
 159 fvec_mean (fvec_t * s)
 160 {
 161   smpl_t tmp = 0.0;
 162 #ifndef HAVE_ACCELERATE
 163   uint_t j;
 164   for (j = 0; j < s->length; j++) {
 165     tmp += s->data[j];
 166   }
 167   return tmp / (smpl_t) (s->length);
 168 #else
 169 #if !HAVE_AUBIO_DOUBLE
 170   vDSP_meanv(s->data, 1, &tmp, s->length);
 171 #else /* HAVE_AUBIO_DOUBLE */
 172   vDSP_meanvD(s->data, 1, &tmp, s->length);
 173 #endif /* HAVE_AUBIO_DOUBLE */
 174   return tmp;
 175 #endif /* HAVE_ACCELERATE */
 176 }
 177
 178 smpl_t
 179 fvec_sum (fvec_t * s)
 180 {
 181   smpl_t tmp = 0.0;
 182 #ifndef HAVE_ACCELERATE
 183   uint_t j;
 184   for (j = 0; j < s->length; j++) {
 185     tmp += s->data[j];
 186   }
 187 #else
 188 #if !HAVE_AUBIO_DOUBLE
 189   vDSP_sve(s->data, 1, &tmp, s->length);
 190 #else /* HAVE_AUBIO_DOUBLE */
 191   vDSP_sveD(s->data, 1, &tmp, s->length);
 192 #endif /* HAVE_AUBIO_DOUBLE */
 193 #endif /* HAVE_ACCELERATE */
 194   return tmp;
 195 }
 196
 197 smpl_t
 198 fvec_max (fvec_t * s)
 199 {
 200 #ifndef HAVE_ACCELERATE
 201   uint_t j;
 202   smpl_t tmp = 0.0;
 203   for (j = 0; j < s->length; j++) {
 204     tmp = (tmp > s->data[j]) ? tmp : s->data[j];
 205   }
 206 #else
 207   smpl_t tmp = 0.;
 208 #if !HAVE_AUBIO_DOUBLE
 209   vDSP_maxv(s->data, 1, &tmp, s->length);
 210 #else
 211   vDSP_maxvD(s->data, 1, &tmp, s->length);
 212 #endif
 213 #endif
 214   return tmp;
 215 }
 216
 217 smpl_t
 218 fvec_min (fvec_t * s)
 219 {
 220 #ifndef HAVE_ACCELERATE
 221   uint_t j;
 222   smpl_t tmp = s->data[0];
 223   for (j = 0; j < s->length; j++) {
 224     tmp = (tmp < s->data[j]) ? tmp : s->data[j];
 225   }
 226 #else
 227   smpl_t tmp = 0.;
 228 #if !HAVE_AUBIO_DOUBLE
 229   vDSP_minv(s->data, 1, &tmp, s->length);
 230 #else
 231   vDSP_minvD(s->data, 1, &tmp, s->length);
 232 #endif
 233 #endif
 234   return tmp;
 235 }
 236
 237 uint_t
 238 fvec_min_elem (fvec_t * s)
 239 {
 240 #ifndef HAVE_ACCELERATE
 241   uint_t j, pos = 0.;
 242   smpl_t tmp = s->data[0];
 243   for (j = 0; j < s->length; j++) {
 244     pos = (tmp < s->data[j]) ? pos : j;
 245     tmp = (tmp < s->data[j]) ? tmp : s->data[j];
 246   }
 247 #else
 248   smpl_t tmp = 0.;
 249   uint_t pos = 0.;
 250 #if !HAVE_AUBIO_DOUBLE
 251   vDSP_minvi(s->data, 1, &tmp, (vDSP_Length *)&pos, s->length);
 252 #else
 253   vDSP_minviD(s->data, 1, &tmp, (vDSP_Length *)&pos, s->length);
 254 #endif
 255 #endif
 256   return pos;
 257 }
 258
 259 uint_t
 260 fvec_max_elem (fvec_t * s)
 261 {
 262 #ifndef HAVE_ACCELERATE
 263   uint_t j, pos = 0;
 264   smpl_t tmp = 0.0;
 265   for (j = 0; j < s->length; j++) {
 266     pos = (tmp > s->data[j]) ? pos : j;
 267     tmp = (tmp > s->data[j]) ? tmp : s->data[j];
 268   }
 269 #else
 270   smpl_t tmp = 0.;
 271   uint_t pos = 0.;
 272 #if !HAVE_AUBIO_DOUBLE
 273   vDSP_maxvi(s->data, 1, &tmp, (vDSP_Length *)&pos, s->length);
 274 #else
 275   vDSP_maxviD(s->data, 1, &tmp, (vDSP_Length *)&pos, s->length);
 276 #endif
 277 #endif
 278   return pos;
 279 }
 280
 281 void
 282 fvec_shift (fvec_t * s)
 283 {
 284   uint_t j;
 285   for (j = 0; j < s->length / 2; j++) {
 286     ELEM_SWAP (s->data[j], s->data[j + s->length / 2]);
 287   }
 288 }
 289
 290 smpl_t
 291 aubio_level_lin (fvec_t * f)
 292 {
 293   smpl_t energy = 0.;
 294   uint_t j;
 295   for (j = 0; j < f->length; j++) {
 296     energy += SQR (f->data[j]);
 297   }
 298   return energy / f->length;
 299 }
 300
 301 smpl_t
 302 fvec_local_hfc (fvec_t * v)
 303 {
 304   smpl_t hfc = 0.;
 305   uint_t j;
 306   for (j = 0; j < v->length; j++) {
 307     hfc += (j + 1) * v->data[j];
 308   }
 309   return hfc;
 310 }
 311
 312 void
 313 fvec_min_removal (fvec_t * v)
 314 {
 315   smpl_t v_min = fvec_min (v);
 316   fvec_add (v,  - v_min );
 317 }
 318
 319 smpl_t
 320 fvec_alpha_norm (fvec_t * o, smpl_t alpha)
 321 {
 322   uint_t j;
 323   smpl_t tmp = 0.;
 324   for (j = 0; j < o->length; j++) {
 325     tmp += POW (ABS (o->data[j]), alpha);
 326   }
 327   return POW (tmp / o->length, 1. / alpha);
 328 }
 329
 330 void
 331 fvec_alpha_normalise (fvec_t * o, smpl_t alpha)
 332 {
 333   uint_t j;
 334   smpl_t norm = fvec_alpha_norm (o, alpha);
 335   for (j = 0; j < o->length; j++) {
 336     o->data[j] /= norm;
 337   }
 338 }
 339
 340 void
 341 fvec_add (fvec_t * o, smpl_t val)
 342 {
 343   uint_t j;
 344   for (j = 0; j < o->length; j++) {
 345     o->data[j] += val;
 346   }
 347 }
 348
 349 void fvec_adapt_thres(fvec_t * vec, fvec_t * tmp,
 350     uint_t post, uint_t pre) {
 351   uint_t length = vec->length, j;
 352   for (j=0;j<length;j++) {
 353     vec->data[j] -= fvec_moving_thres(vec, tmp, post, pre, j);
 354   }
 355 }
 356
 357 smpl_t
 358 fvec_moving_thres (fvec_t * vec, fvec_t * tmpvec,
 359     uint_t post, uint_t pre, uint_t pos)
 360 {
 361   uint_t k;
 362   smpl_t *medar = (smpl_t *) tmpvec->data;
 363   uint_t win_length = post + pre + 1;
 364   uint_t length = vec->length;
 365   /* post part of the buffer does not exist */
 366   if (pos < post + 1) {
 367     for (k = 0; k < post + 1 - pos; k++)
 368       medar[k] = 0.;            /* 0-padding at the beginning */
 369     for (k = post + 1 - pos; k < win_length; k++)
 370       medar[k] = vec->data[k + pos - post];
 371     /* the buffer is fully defined */
 372   } else if (pos + pre < length) {
 373     for (k = 0; k < win_length; k++)
 374       medar[k] = vec->data[k + pos - post];
 375     /* pre part of the buffer does not exist */
 376   } else {
 377     for (k = 0; k < length - pos + post; k++)
 378       medar[k] = vec->data[k + pos - post];
 379     for (k = length - pos + post; k < win_length; k++)
 380       medar[k] = 0.;            /* 0-padding at the end */
 381   }
 382   return fvec_median (tmpvec);
 383 }
 384
 385 smpl_t fvec_median (fvec_t * input) {
 386   uint_t n = input->length;
 387   smpl_t * arr = (smpl_t *) input->data;
 388   uint_t low, high ;
 389   uint_t median;
 390   uint_t middle, ll, hh;
 391
 392   low = 0 ; high = n-1 ; median = (low + high) / 2;
 393   for (;;) {
 394     if (high <= low) /* One element only */
 395       return arr[median] ;
 396
 397     if (high == low + 1) {  /* Two elements only */
 398       if (arr[low] > arr[high])
 399         ELEM_SWAP(arr[low], arr[high]) ;
 400       return arr[median] ;
 401     }
 402
 403     /* Find median of low, middle and high items; swap into position low */
 404     middle = (low + high) / 2;
 405     if (arr[middle] > arr[high])    ELEM_SWAP(arr[middle], arr[high]);
 406     if (arr[low]    > arr[high])    ELEM_SWAP(arr[low],    arr[high]);
 407     if (arr[middle] > arr[low])     ELEM_SWAP(arr[middle], arr[low]) ;
 408
 409     /* Swap low item (now in position middle) into position (low+1) */
 410     ELEM_SWAP(arr[middle], arr[low+1]) ;
 411
 412     /* Nibble from each end towards middle, swapping items when stuck */
 413     ll = low + 1;
 414     hh = high;
 415     for (;;) {
 416       do ll++; while (arr[low] > arr[ll]) ;
 417       do hh--; while (arr[hh]  > arr[low]) ;
 418
 419       if (hh < ll)
 420         break;
 421
 422       ELEM_SWAP(arr[ll], arr[hh]) ;
 423     }
 424
 425     /* Swap middle item (in position low) back into correct position */
 426     ELEM_SWAP(arr[low], arr[hh]) ;
 427
 428     /* Re-set active partition */
 429     if (hh <= median)
 430       low = ll;
 431     if (hh >= median)
 432       high = hh - 1;
 433   }
 434 }
 435
 436 smpl_t fvec_quadratic_peak_pos (fvec_t * x, uint_t pos) {
 437   smpl_t s0, s1, s2; uint_t x0, x2;
 438   if (pos == 0 || pos == x->length - 1) return pos;
 439   x0 = (pos < 1) ? pos : pos - 1;
 440   x2 = (pos + 1 < x->length) ? pos + 1 : pos;
 441   if (x0 == pos) return (x->data[pos] <= x->data[x2]) ? pos : x2;
 442   if (x2 == pos) return (x->data[pos] <= x->data[x0]) ? pos : x0;
 443   s0 = x->data[x0];
 444   s1 = x->data[pos];
 445   s2 = x->data[x2];
 446   return pos + 0.5 * (s0 - s2 ) / (s0 - 2.* s1 + s2);
 447 }
 448
 449 smpl_t fvec_quadratic_peak_mag (fvec_t *x, smpl_t pos) {
 450   smpl_t x0, x1, x2;
 451   uint_t index = (uint_t)(pos - .5) + 1;
 452   if (pos >= x->length || pos < 0.) return 0.;
 453   if ((smpl_t)index == pos) return x->data[index];
 454   x0 = x->data[index - 1];
 455   x1 = x->data[index];
 456   x2 = x->data[index + 1];
 457   return x1 - .25 * (x0 - x2) * (pos - index);
 458 }
 459
 460 uint_t fvec_peakpick(fvec_t * onset, uint_t pos) {
 461   uint_t tmp=0;
 462   tmp = (onset->data[pos] > onset->data[pos-1]
 463       &&  onset->data[pos] > onset->data[pos+1]
 464       &&  onset->data[pos] > 0.);
 465   return tmp;
 466 }
 467
 468 smpl_t
 469 aubio_quadfrac (smpl_t s0, smpl_t s1, smpl_t s2, smpl_t pf)
 470 {
 471   smpl_t tmp =
 472       s0 + (pf / 2.) * (pf * (s0 - 2. * s1 + s2) - 3. * s0 + 4. * s1 - s2);
 473   return tmp;
 474 }
 475
 476 smpl_t
 477 aubio_freqtomidi (smpl_t freq)
 478 {
 479   smpl_t midi;
 480   if (freq < 2. || freq > 100000.) return 0.; // avoid nans and infs
 481   /* log(freq/A-2)/log(2) */
 482   midi = freq / 6.875;
 483   midi = LOG (midi) / 0.69314718055995;
 484   midi *= 12;
 485   midi -= 3;
 486   return midi;
 487 }
 488
 489 smpl_t
 490 aubio_miditofreq (smpl_t midi)
 491 {
 492   smpl_t freq;
 493   if (midi > 140.) return 0.; // avoid infs
 494   freq = (midi + 3.) / 12.;
 495   freq = EXP (freq * 0.69314718055995);
 496   freq *= 6.875;
 497   return freq;
 498 }
 499
 500 smpl_t
 501 aubio_bintofreq (smpl_t bin, smpl_t samplerate, smpl_t fftsize)
 502 {
 503   smpl_t freq = samplerate / fftsize;
 504   return freq * MAX(bin, 0);
 505 }
 506
 507 smpl_t
 508 aubio_bintomidi (smpl_t bin, smpl_t samplerate, smpl_t fftsize)
 509 {
 510   smpl_t midi = aubio_bintofreq (bin, samplerate, fftsize);
 511   return aubio_freqtomidi (midi);
 512 }
 513
 514 smpl_t
 515 aubio_freqtobin (smpl_t freq, smpl_t samplerate, smpl_t fftsize)
 516 {
 517   smpl_t bin = fftsize / samplerate;
 518   return MAX(freq, 0) * bin;
 519 }
 520
 521 smpl_t
 522 aubio_miditobin (smpl_t midi, smpl_t samplerate, smpl_t fftsize)
 523 {
 524   smpl_t freq = aubio_miditofreq (midi);
 525   return aubio_freqtobin (freq, samplerate, fftsize);
 526 }
 527
 528 uint_t
 529 aubio_is_power_of_two (uint_t a)
 530 {
 531   if ((a & (a - 1)) == 0) {
 532     return 1;
 533   } else {
 534     return 0;
 535   }
 536 }
 537
 538 uint_t
 539 aubio_next_power_of_two (uint_t a)
 540 {
 541   uint_t i = 1;
 542   while (i < a) i <<= 1;
 543   return i;
 544 }
 545
 546 smpl_t
 547 aubio_db_spl (fvec_t * o)
 548 {
 549   return 10. * LOG10 (aubio_level_lin (o));
 550 }
 551
 552 uint_t
 553 aubio_silence_detection (fvec_t * o, smpl_t threshold)
 554 {
 555   return (aubio_db_spl (o) < threshold);
 556 }
 557
 558 smpl_t
 559 aubio_level_detection (fvec_t * o, smpl_t threshold)
 560 {
 561   smpl_t db_spl = aubio_db_spl (o);
 562   if (db_spl < threshold) {
 563     return 1.;
 564   } else {
 565     return db_spl;
 566   }
 567 }
 568
 569 smpl_t
 570 aubio_zero_crossing_rate (fvec_t * input)
 571 {
 572   uint_t j;
 573   uint_t zcr = 0;
 574   for (j = 1; j < input->length; j++) {
 575     // previous was strictly negative
 576     if (input->data[j - 1] < 0.) {
 577       // current is positive or null
 578       if (input->data[j] >= 0.) {
 579         zcr += 1;
 580       }
 581       // previous was positive or null
 582     } else {
 583       // current is strictly negative
 584       if (input->data[j] < 0.) {
 585         zcr += 1;
 586       }
 587     }
 588   }
 589   return zcr / (smpl_t) input->length;
 590 }
 591
 592 void
 593 aubio_autocorr (fvec_t * input, fvec_t * output)
 594 {
 595   uint_t i, j, length = input->length;
 596   smpl_t *data, *acf;
 597   smpl_t tmp = 0;
 598   data = input->data;
 599   acf = output->data;
 600   for (i = 0; i < length; i++) {
 601     tmp = 0.;
 602     for (j = i; j < length; j++) {
 603       tmp += data[j - i] * data[j];
 604     }
 605     acf[i] = tmp / (smpl_t) (length - i);
 606   }
 607 }
 608
 609 void
 610 aubio_cleanup (void)
 611 {
 612 #ifdef HAVE_FFTW3F
 613   fftwf_cleanup ();
 614 #else
 615 #ifdef HAVE_FFTW3
 616   fftw_cleanup ();
 617 #endif
 618 #endif
 619 }