source: src/spectral/filterbank_mel.c @ 6d41dac

feature/autosinkfeature/constantqfeature/pitchshiftfeature/pydocstringsfeature/timestretch
Last change on this file since 6d41dac was 6d41dac, checked in by Paul Brossier <piem@piem.org>, 20 months ago

[filterbank] factorize input validation

  • Property mode set to 100644
File size: 8.4 KB
Line 
1/*
2  Copyright (C) 2007-2009 Paul Brossier <piem@aubio.org>
3                      and Amaury Hazan <ahazan@iua.upf.edu>
4
5  This file is part of aubio.
6
7  aubio is free software: you can redistribute it and/or modify
8  it under the terms of the GNU General Public License as published by
9  the Free Software Foundation, either version 3 of the License, or
10  (at your option) any later version.
11
12  aubio 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
15  GNU General Public License for more details.
16
17  You should have received a copy of the GNU General Public License
18  along with aubio.  If not, see <http://www.gnu.org/licenses/>.
19
20*/
21
22#include "aubio_priv.h"
23#include "fmat.h"
24#include "fvec.h"
25#include "cvec.h"
26#include "spectral/filterbank.h"
27#include "spectral/filterbank_mel.h"
28#include "mathutils.h"
29
30uint_t
31aubio_filterbank_set_triangle_bands (aubio_filterbank_t * fb,
32    const fvec_t * freqs, smpl_t samplerate)
33{
34
35  fmat_t *filters = aubio_filterbank_get_coeffs (fb);
36  uint_t n_filters = filters->height, win_s = filters->length;
37  fvec_t *lower_freqs, *upper_freqs, *center_freqs;
38  fvec_t *triangle_heights, *fft_freqs;
39
40  uint_t fn;                    /* filter counter */
41  uint_t bin;                   /* bin counter */
42
43  smpl_t riseInc, downInc;
44
45  /* freqs define the bands of triangular overlapping windows.
46     throw a warning if filterbank object fb is too short. */
47  if (freqs->length - 2 > n_filters) {
48    AUBIO_WRN ("not enough filters, %d allocated but %d requested\n",
49        n_filters, freqs->length - 2);
50  }
51
52  if (freqs->length - 2 < n_filters) {
53    AUBIO_WRN ("too many filters, %d allocated but %d requested\n",
54        n_filters, freqs->length - 2);
55  }
56
57  for (fn = 0; fn < freqs->length; fn++) {
58    if (freqs->data[fn] < 0) {
59      AUBIO_ERR("filterbank_mel: freqs must contain only positive values.\n");
60      return AUBIO_FAIL;
61    } else if (freqs->data[fn] > samplerate / 2) {
62      AUBIO_WRN("filterbank_mel: freqs should contain only "
63          "values < samplerate / 2.\n");
64    } else if (fn > 0 && freqs->data[fn] < freqs->data[fn-1]) {
65      AUBIO_ERR("filterbank_mel: freqs should be a list of frequencies "
66          "sorted from low to high, but freq[%d] < freq[%d-1]\n", fn, fn);
67      return AUBIO_FAIL;
68    } else if (fn > 0 && freqs->data[fn] == freqs->data[fn-1]) {
69      AUBIO_WRN("filterbank_mel: set_triangle_bands received a list "
70          "with twice the frequency %f\n", freqs->data[fn]);
71    }
72  }
73
74  /* convenience reference to lower/center/upper frequency for each triangle */
75  lower_freqs = new_fvec (n_filters);
76  upper_freqs = new_fvec (n_filters);
77  center_freqs = new_fvec (n_filters);
78
79  /* height of each triangle */
80  triangle_heights = new_fvec (n_filters);
81
82  /* lookup table of each bin frequency in hz */
83  fft_freqs = new_fvec (win_s);
84
85  /* fill up the lower/center/upper */
86  for (fn = 0; fn < n_filters; fn++) {
87    lower_freqs->data[fn] = freqs->data[fn];
88    center_freqs->data[fn] = freqs->data[fn + 1];
89    upper_freqs->data[fn] = freqs->data[fn + 2];
90  }
91
92  /* compute triangle heights so that each triangle has unit area */
93  if (aubio_filterbank_get_norm(fb)) {
94    for (fn = 0; fn < n_filters; fn++) {
95      triangle_heights->data[fn] =
96          2. / (upper_freqs->data[fn] - lower_freqs->data[fn]);
97    }
98  } else {
99    fvec_ones (triangle_heights);
100  }
101
102  /* fill fft_freqs lookup table, which assigns the frequency in hz to each bin */
103  for (bin = 0; bin < win_s; bin++) {
104    fft_freqs->data[bin] =
105        aubio_bintofreq (bin, samplerate, (win_s - 1) * 2);
106  }
107
108  /* zeroing of all filters */
109  fmat_zeros (filters);
110
111  /* building each filter table */
112  for (fn = 0; fn < n_filters; fn++) {
113
114    /* skip first elements */
115    for (bin = 0; bin < win_s - 1; bin++) {
116      if (fft_freqs->data[bin] <= lower_freqs->data[fn] &&
117          fft_freqs->data[bin + 1] > lower_freqs->data[fn]) {
118        bin++;
119        break;
120      }
121    }
122
123    /* compute positive slope step size */
124    riseInc = triangle_heights->data[fn]
125      / (center_freqs->data[fn] - lower_freqs->data[fn]);
126
127    /* compute coefficients in positive slope */
128    for (; bin < win_s - 1; bin++) {
129      filters->data[fn][bin] =
130          (fft_freqs->data[bin] - lower_freqs->data[fn]) * riseInc;
131
132      if (fft_freqs->data[bin + 1] >= center_freqs->data[fn]) {
133        bin++;
134        break;
135      }
136    }
137
138    /* compute negative slope step size */
139    downInc = triangle_heights->data[fn]
140      / (upper_freqs->data[fn] - center_freqs->data[fn]);
141
142    /* compute coefficents in negative slope */
143    for (; bin < win_s - 1; bin++) {
144      filters->data[fn][bin] +=
145          (upper_freqs->data[fn] - fft_freqs->data[bin]) * downInc;
146
147      if (filters->data[fn][bin] < 0.) {
148        filters->data[fn][bin] = 0.;
149      }
150
151      if (fft_freqs->data[bin + 1] >= upper_freqs->data[fn])
152        break;
153    }
154    /* nothing else to do */
155
156  }
157
158  /* destroy temporarly allocated vectors */
159  del_fvec (lower_freqs);
160  del_fvec (upper_freqs);
161  del_fvec (center_freqs);
162
163  del_fvec (triangle_heights);
164  del_fvec (fft_freqs);
165
166  return AUBIO_OK;
167}
168
169uint_t
170aubio_filterbank_set_mel_coeffs_slaney (aubio_filterbank_t * fb,
171    smpl_t samplerate)
172{
173  uint_t retval;
174
175  /* Malcolm Slaney parameters */
176  smpl_t lowestFrequency = 133.3333;
177  smpl_t linearSpacing = 66.66666666;
178  smpl_t logSpacing = 1.0711703;
179
180  uint_t linearFilters = 13;
181  uint_t logFilters = 27;
182  uint_t n_filters = linearFilters + logFilters;
183
184  uint_t fn;                    /* filter counter */
185
186  smpl_t lastlinearCF;
187
188  /* buffers to compute filter frequencies */
189  fvec_t *freqs = new_fvec (n_filters + 2);
190
191  /* first step: fill all the linear filter frequencies */
192  for (fn = 0; fn < linearFilters; fn++) {
193    freqs->data[fn] = lowestFrequency + fn * linearSpacing;
194  }
195  lastlinearCF = freqs->data[fn - 1];
196
197  /* second step: fill all the log filter frequencies */
198  for (fn = 0; fn < logFilters + 2; fn++) {
199    freqs->data[fn + linearFilters] =
200        lastlinearCF * (POW (logSpacing, fn + 1));
201  }
202
203  /* now compute the actual coefficients */
204  retval = aubio_filterbank_set_triangle_bands (fb, freqs, samplerate);
205
206  /* destroy vector used to store frequency limits */
207  del_fvec (freqs);
208
209  return retval;
210}
211
212static uint_t aubio_filterbank_check_freqs (aubio_filterbank_t *fb UNUSED,
213    smpl_t samplerate, smpl_t *freq_min, smpl_t *freq_max)
214{
215  if (samplerate <= 0) {
216    AUBIO_ERR("filterbank: set_mel_coeffs samplerate should be > 0\n");
217    return AUBIO_FAIL;
218  }
219  if (*freq_max < 0) {
220    AUBIO_ERR("filterbank: set_mel_coeffs freq_max should be > 0\n");
221    return AUBIO_FAIL;
222  } else if (*freq_max == 0) {
223    *freq_max = samplerate / 2.;
224  }
225  if (*freq_min < 0) {
226    AUBIO_ERR("filterbank: set_mel_coeffs freq_min should be > 0\n");
227    return AUBIO_FAIL;
228  }
229  return AUBIO_OK;
230}
231
232uint_t
233aubio_filterbank_set_mel_coeffs (aubio_filterbank_t * fb, smpl_t samplerate,
234    smpl_t freq_min, smpl_t freq_max)
235{
236  uint_t m, retval;
237  smpl_t start = freq_min, end = freq_max, step;
238  fvec_t *freqs;
239  fmat_t *coeffs = aubio_filterbank_get_coeffs(fb);
240  uint_t n_bands = coeffs->height;
241
242  if (aubio_filterbank_check_freqs(fb, samplerate, &freq_min, &freq_max)) {
243    return AUBIO_FAIL;
244  }
245
246  start = aubio_hztomel(start);
247  end = aubio_hztomel(end);
248
249  freqs = new_fvec(n_bands + 2);
250  step = (end - start) / (n_bands + 1);
251
252  for (m = 0; m < n_bands + 2; m++)
253  {
254    freqs->data[m] = MIN(aubio_meltohz(start + step * m), samplerate/2.);
255  }
256
257  retval = aubio_filterbank_set_triangle_bands (fb, freqs, samplerate);
258
259  /* destroy vector used to store frequency limits */
260  del_fvec (freqs);
261  return retval;
262}
263
264uint_t
265aubio_filterbank_set_mel_coeffs_htk (aubio_filterbank_t * fb, smpl_t samplerate,
266    smpl_t freq_min, smpl_t freq_max)
267{
268  uint_t m, retval;
269  smpl_t start = freq_min, end = freq_max, step;
270  fvec_t *freqs;
271  fmat_t *coeffs = aubio_filterbank_get_coeffs(fb);
272  uint_t n_bands = coeffs->height;
273
274  if (aubio_filterbank_check_freqs(fb, samplerate, &freq_min, &freq_max)) {
275    return AUBIO_FAIL;
276  }
277
278  start = aubio_hztomel_htk(start);
279  end = aubio_hztomel_htk(end);
280
281  freqs = new_fvec (n_bands + 2);
282  step = (end - start) / (n_bands + 1);
283
284  for (m = 0; m < n_bands + 2; m++)
285  {
286    freqs->data[m] = MIN(aubio_meltohz_htk(start + step * m), samplerate/2.);
287  }
288
289  retval = aubio_filterbank_set_triangle_bands (fb, freqs, samplerate);
290
291  /* destroy vector used to store frequency limits */
292  del_fvec (freqs);
293  return retval;
294}
Note: See TracBrowser for help on using the repository browser.