[filterbank] fix get_power
[aubio.git] / src / spectral / filterbank.c
index aa1336b..e82d93d 100644 (file)
 /*
-   Copyright (C) 2007 Amaury Hazan <ahazan@iua.upf.edu>
-                  and Paul Brossier <piem@piem.org>
+  Copyright (C) 2007-2009 Paul Brossier <piem@aubio.org>
+                      and Amaury Hazan <ahazan@iua.upf.edu>
 
-   This program is free software; you can redistribute it and/or modify
-   it under the terms of the GNU General Public License as published by
-   the Free Software Foundation; either version 2 of the License, or
-   (at your option) any later version.
+  This file is part of aubio.
 
-   This program is distributed in the hope that it will be useful,
-   but WITHOUT ANY WARRANTY; without even the implied warranty of
-   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-   GNU General Public License for more details.
+  aubio is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
 
-   You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+  aubio is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
 
-*/
+  You should have received a copy of the GNU General Public License
+  along with aubio.  If not, see <http://www.gnu.org/licenses/>.
 
+*/
 
 #include "aubio_priv.h"
-#include "sample.h"
+#include "fvec.h"
+#include "fmat.h"
+#include "cvec.h"
+#include "vecutils.h"
 #include "spectral/filterbank.h"
 #include "mathutils.h"
 
-#define VERY_SMALL_NUMBER 2e-42
-
 /** \brief A structure to store a set of n_filters filters of lenghts win_s */
-struct aubio_filterbank_t_ {
-    uint_t win_s;
-    uint_t n_filters;
-    fvec_t **filters;
+struct _aubio_filterbank_t
+{
+  uint_t win_s;
+  uint_t n_filters;
+  fmat_t *filters;
+  smpl_t norm;
+  smpl_t power;
 };
 
-aubio_filterbank_t * new_aubio_filterbank(uint_t n_filters, uint_t win_s){
-  /** allocating space for filterbank object */
-  aubio_filterbank_t * fb = AUBIO_NEW(aubio_filterbank_t);
-  uint_t filter_cnt;
-  fb->win_s=win_s;
-  fb->n_filters=n_filters;
+aubio_filterbank_t *
+new_aubio_filterbank (uint_t n_filters, uint_t win_s)
+{
+  /* allocate space for filterbank object */
+  aubio_filterbank_t *fb = AUBIO_NEW (aubio_filterbank_t);
 
-  /** allocating filter tables */
-  fb->filters=AUBIO_ARRAY(fvec_t*,n_filters);
-  for (filter_cnt=0; filter_cnt<n_filters; filter_cnt++)
-    /* considering one-channel filters */
-    fb->filters[filter_cnt]=new_fvec(win_s, 1);
+  if ((sint_t)n_filters <= 0) {
+    AUBIO_ERR("filterbank: n_filters should be > 0, got %d\n", n_filters);
+    goto fail;
+  }
+  if ((sint_t)win_s <= 0) {
+    AUBIO_ERR("filterbank: win_s should be > 0, got %d\n", win_s);
+    goto fail;
+  }
+  fb->win_s = win_s;
+  fb->n_filters = n_filters;
 
-  return fb;
-}
+  /* allocate filter tables, a matrix of length win_s and of height n_filters */
+  fb->filters = new_fmat (n_filters, win_s / 2 + 1);
 
-/*
-FB initialization based on Slaney's auditory toolbox
-TODO:
-  *solve memory leak problems while
-  *solve quantization issues when constructing signal:
-    *bug for win_s=512
-    *corrections for win_s=1024 -> why even filters with smaller amplitude
+  fb->norm = 1;
 
-*/
+  fb->power = 1;
 
-aubio_filterbank_t * new_aubio_filterbank_mfcc(uint_t n_filters, uint_t win_s, uint_t samplerate, smpl_t freq_min, smpl_t freq_max){
-  
-  aubio_filterbank_t * fb = new_aubio_filterbank(n_filters, win_s);
-  
-  
-  //slaney params
-  smpl_t lowestFrequency = 133.3333;
-  smpl_t linearSpacing = 66.66666666;
-  smpl_t logSpacing = 1.0711703;
-
-  uint_t linearFilters = 13;
-  uint_t logFilters = 27;
-  uint_t allFilters = linearFilters + logFilters;
-  
-  //buffers for computing filter frequencies
-  fvec_t * freqs=new_fvec(allFilters+2 , 1);
-  
-  fvec_t * lower_freqs=new_fvec( allFilters, 1);
-  fvec_t * upper_freqs=new_fvec( allFilters, 1);
-  fvec_t * center_freqs=new_fvec( allFilters, 1);
-
-  fvec_t * triangle_heights=new_fvec( allFilters, 1);
-  //lookup table of each bin frequency in hz
-  fvec_t * fft_freqs=new_fvec(win_s, 1);
-
-  uint_t filter_cnt, bin_cnt;
-  
-  //first step: filling all the linear filter frequencies
-  for(filter_cnt=0; filter_cnt<linearFilters; filter_cnt++){
-    freqs->data[0][filter_cnt]=lowestFrequency+ filter_cnt*linearSpacing;
-  }
-  smpl_t lastlinearCF=freqs->data[0][filter_cnt-1];
-  
-  //second step: filling all the log filter frequencies
-  for(filter_cnt=0; filter_cnt<logFilters+2; filter_cnt++){
-    freqs->data[0][filter_cnt+linearFilters] = 
-      lastlinearCF*(pow(logSpacing,filter_cnt+1));
-  }
+  return fb;
+fail:
+  AUBIO_FREE (fb);
+  return NULL;
+}
 
-  //Option 1. copying interesting values to lower_freqs, center_freqs and upper freqs arrays
-  //TODO: would be nicer to have a reference to freqs->data, anyway we do not care in this init step
-    
-  for(filter_cnt=0; filter_cnt<allFilters; filter_cnt++){
-    lower_freqs->data[0][filter_cnt]=freqs->data[0][filter_cnt];
-    center_freqs->data[0][filter_cnt]=freqs->data[0][filter_cnt+1];
-    upper_freqs->data[0][filter_cnt]=freqs->data[0][filter_cnt+2];
-  }
+void
+del_aubio_filterbank (aubio_filterbank_t * fb)
+{
+  del_fmat (fb->filters);
+  AUBIO_FREE (fb);
+}
 
-  //computing triangle heights so that each triangle has unit area
-  for(filter_cnt=0; filter_cnt<allFilters; filter_cnt++){
-    triangle_heights->data[0][filter_cnt] = 2./(upper_freqs->data[0][filter_cnt] 
-      - lower_freqs->data[0][filter_cnt]);
-  }
-  
-  //AUBIO_DBG("filter tables frequencies\n");
-  //for(filter_cnt=0; filter_cnt<allFilters; filter_cnt++)
-  //  AUBIO_DBG("filter n. %d %f %f %f %f\n",
-  //    filter_cnt, lower_freqs->data[0][filter_cnt], 
-  //    center_freqs->data[0][filter_cnt], upper_freqs->data[0][filter_cnt], 
-  //    triangle_heights->data[0][filter_cnt]);
-
-  //filling the fft_freqs lookup table, which assigns the frequency in hz to each bin
-  for(bin_cnt=0; bin_cnt<win_s; bin_cnt++){
-    fft_freqs->data[0][bin_cnt]= aubio_bintofreq(bin_cnt, samplerate, win_s);
-  }
+void
+aubio_filterbank_do (aubio_filterbank_t * f, const cvec_t * in, fvec_t * out)
+{
+  /* apply filter to all input channel, provided out has enough channels */
+  //uint_t max_filters = MIN (f->n_filters, out->length);
+  //uint_t max_length = MIN (in->length, f->filters->length);
 
-  //building each filter table
-  for(filter_cnt=0; filter_cnt<allFilters; filter_cnt++){
-
-    //TODO:check special case : lower freq =0
-    //calculating rise increment in mag/Hz
-    smpl_t riseInc= triangle_heights->data[0][filter_cnt]/(center_freqs->data[0][filter_cnt]-lower_freqs->data[0][filter_cnt]);
-    
-    //zeroing begining of filter
-    for(bin_cnt=0; bin_cnt<win_s-1; bin_cnt++){
-      fb->filters[filter_cnt]->data[0][bin_cnt]=0.f;
-      if( fft_freqs->data[0][bin_cnt]  <= lower_freqs->data[0][filter_cnt] &&
-          fft_freqs->data[0][bin_cnt+1] > lower_freqs->data[0][filter_cnt]) {
-        break;
-      }
-    }
-    bin_cnt++;
-    
-    //positive slope
-    for(; bin_cnt<win_s-1; bin_cnt++){
-      fb->filters[filter_cnt]->data[0][bin_cnt]=(fft_freqs->data[0][bin_cnt]-lower_freqs->data[0][filter_cnt])*riseInc;
-      //if(fft_freqs->data[0][bin_cnt]<= center_freqs->data[0][filter_cnt] && fft_freqs->data[0][bin_cnt+1]> center_freqs->data[0][filter_cnt])
-      if(fft_freqs->data[0][bin_cnt+1]> center_freqs->data[0][filter_cnt])
-        break;
-    }
-    //bin_cnt++;
-    
-    //negative slope
-    for(; bin_cnt<win_s-1; bin_cnt++){
-      
-      //checking whether last value is less than 0...
-      smpl_t val=triangle_heights->data[0][filter_cnt]-(fft_freqs->data[0][bin_cnt]-center_freqs->data[0][filter_cnt])*riseInc;
-      if(val>=0)
-        fb->filters[filter_cnt]->data[0][bin_cnt]=val;
-      else fb->filters[filter_cnt]->data[0][bin_cnt]=0.f;
-      
-      //if(fft_freqs->data[0][bin_cnt]<= upper_freqs->data[0][bin_cnt] && fft_freqs->data[0][bin_cnt+1]> upper_freqs->data[0][filter_cnt])
-      //TODO: CHECK whether bugfix correct
-      if(fft_freqs->data[0][bin_cnt+1]> upper_freqs->data[0][filter_cnt])
-        break;
-    }
-    //bin_cnt++;
-    
-    //zeroing tail
-    for(; bin_cnt<win_s; bin_cnt++)
-      fb->filters[filter_cnt]->data[0][bin_cnt]=0.f;
+  // view cvec->norm as fvec->data
+  fvec_t tmp;
+  tmp.length = in->length;
+  tmp.data = in->norm;
 
-  }
-  
-  
-  del_fvec(freqs);
-  del_fvec(lower_freqs);
-  del_fvec(upper_freqs);
-  del_fvec(center_freqs);
+  if (f->power != 1.) fvec_pow(&tmp, f->power);
 
-  del_fvec(triangle_heights);
-  del_fvec(fft_freqs);
+  fmat_vecmul(f->filters, &tmp, out);
 
-  return fb;
+  return;
+}
 
+fmat_t *
+aubio_filterbank_get_coeffs (const aubio_filterbank_t * f)
+{
+  return f->filters;
 }
 
-void del_aubio_filterbank(aubio_filterbank_t * fb){
-  uint_t filter_cnt;
-  /** deleting filter tables first */
-  for (filter_cnt=0; filter_cnt<fb->n_filters; filter_cnt++)
-    del_fvec(fb->filters[filter_cnt]);
-  AUBIO_FREE(fb->filters);
-  AUBIO_FREE(fb);
+uint_t
+aubio_filterbank_set_coeffs (aubio_filterbank_t * f, const fmat_t * filter_coeffs)
+{
+  fmat_copy(filter_coeffs, f->filters);
+  return 0;
 }
 
-void aubio_filterbank_do(aubio_filterbank_t * f, cvec_t * in, fvec_t *out) {
-  uint_t n, filter_cnt;
-  for(filter_cnt = 0; (filter_cnt < f->n_filters)
-    && (filter_cnt < out->length); filter_cnt++){
-      out->data[0][filter_cnt] = 0.f;
-      for(n = 0; n < in->length; n++){
-          out->data[0][filter_cnt] += in->norm[0][n] 
-            * f->filters[filter_cnt]->data[0][n];
-      }
-      out->data[0][filter_cnt] =
-        LOG(out->data[0][filter_cnt] < VERY_SMALL_NUMBER ? 
-            VERY_SMALL_NUMBER : out->data[0][filter_cnt]);
-  }
+uint_t
+aubio_filterbank_set_norm (aubio_filterbank_t *f, smpl_t norm)
+{
+  if (norm != 0 && norm != 1) return AUBIO_FAIL;
+  f->norm = norm;
+  return AUBIO_OK;
+}
 
-  return;
+smpl_t
+aubio_filterbank_get_norm (aubio_filterbank_t *f)
+{
+  return f->norm;
+}
+
+uint_t
+aubio_filterbank_set_power (aubio_filterbank_t *f, smpl_t power)
+{
+  f->power = power;
+  return AUBIO_OK;
 }
 
-fvec_t * aubio_filterbank_getchannel(aubio_filterbank_t * f, uint_t channel) {
-  if ( (channel < f->n_filters) ) { return f->filters[channel]; }
-  else { return NULL; }
+smpl_t
+aubio_filterbank_get_power (aubio_filterbank_t *f)
+{
+  return f->power;
 }