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