gst/audiofx/audiowsincband.c

   1 /* -*- c-basic-offset: 2 -*-
   2  *
   3  * GStreamer
   4  * Copyright (C) 1999-2001 Erik Walthinsen <omega@cse.ogi.edu>
   5  *               2006 Dreamlab Technologies Ltd. <mathis.hofer@dreamlab.net>
   6  *               2007-2009 Sebastian Dröge <sebastian.droege@collabora.co.uk>
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  *
  23  *
  24  * this windowed sinc filter is taken from the freely downloadable DSP book,
  25  * "The Scientist and Engineer's Guide to Digital Signal Processing",
  26  * chapter 16
  27  * available at http://www.dspguide.com/
  28  *
  29  * For the window functions see
  30  * http://en.wikipedia.org/wiki/Window_function
  31  */
  32
  33 /**
  34  * SECTION:element-audiowsincband
  35  *
  36  * Attenuates all frequencies outside (bandpass) or inside (bandreject) of a frequency
  37  * band. The length parameter controls the rolloff, the window parameter
  38  * controls rolloff and stopband attenuation. The Hamming window provides a faster rolloff but a bit
  39  * worse stopband attenuation, the other way around for the Blackman window.
  40  *
  41  * This element has the advantage over the Chebyshev bandpass and bandreject filter that it has
  42  * a much better rolloff when using a larger kernel size and almost linear phase. The only
  43  * disadvantage is the much slower execution time with larger kernels.
  44  *
  45  * <refsect2>
  46  * <title>Example launch line</title>
  47  * |[
  48  * gst-launch audiotestsrc freq=1500 ! audioconvert ! audiosincband mode=band-pass lower-frequency=3000 upper-frequency=10000 length=501 window=blackman ! audioconvert ! alsasink
  49  * gst-launch filesrc location="melo1.ogg" ! oggdemux ! vorbisdec ! audioconvert ! audiowsincband mode=band-reject lower-frequency=59 upper-frequency=61 length=10001 window=hamming ! audioconvert ! alsasink
  50  * gst-launch audiotestsrc wave=white-noise ! audioconvert ! audiowsincband mode=band-pass lower-frequency=1000 upper-frequency=2000 length=31 ! audioconvert ! alsasink
  51  * ]|
  52  * </refsect2>
  53  */
  54
  55 #ifdef HAVE_CONFIG_H
  56 #include "config.h"
  57 #endif
  58
  59 #include <string.h>
  60 #include <math.h>
  61 #include <gst/gst.h>
  62 #include <gst/audio/gstaudiofilter.h>
  63 #include <gst/controller/gstcontroller.h>
  64
  65 #include "audiowsincband.h"
  66
  67 #include "gst/glib-compat-private.h"
  68
  69 #define GST_CAT_DEFAULT gst_gst_audio_wsincband_debug
  70 GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);
  71
  72 enum
  73 {
  74   PROP_0,
  75   PROP_LENGTH,
  76   PROP_LOWER_FREQUENCY,
  77   PROP_UPPER_FREQUENCY,
  78   PROP_MODE,
  79   PROP_WINDOW
  80 };
  81
  82 enum
  83 {
  84   MODE_BAND_PASS = 0,
  85   MODE_BAND_REJECT
  86 };
  87
  88 #define GST_TYPE_AUDIO_WSINC_BAND_MODE (gst_gst_audio_wsincband_mode_get_type ())
  89 static GType
  90 gst_gst_audio_wsincband_mode_get_type (void)
  91 {
  92   static GType gtype = 0;
  93
  94   if (gtype == 0) {
  95     static const GEnumValue values[] = {
  96       {MODE_BAND_PASS, "Band pass (default)",
  97           "band-pass"},
  98       {MODE_BAND_REJECT, "Band reject",
  99           "band-reject"},
 100       {0, NULL, NULL}
 101     };
 102
 103     gtype = g_enum_register_static ("GstAudioWSincBandMode", values);
 104   }
 105   return gtype;
 106 }
 107
 108 enum
 109 {
 110   WINDOW_HAMMING = 0,
 111   WINDOW_BLACKMAN,
 112   WINDOW_GAUSSIAN,
 113   WINDOW_COSINE,
 114   WINDOW_HANN
 115 };
 116
 117 #define GST_TYPE_AUDIO_WSINC_BAND_WINDOW (gst_gst_audio_wsincband_window_get_type ())
 118 static GType
 119 gst_gst_audio_wsincband_window_get_type (void)
 120 {
 121   static GType gtype = 0;
 122
 123   if (gtype == 0) {
 124     static const GEnumValue values[] = {
 125       {WINDOW_HAMMING, "Hamming window (default)",
 126           "hamming"},
 127       {WINDOW_BLACKMAN, "Blackman window",
 128           "blackman"},
 129       {WINDOW_GAUSSIAN, "Gaussian window",
 130           "gaussian"},
 131       {WINDOW_COSINE, "Cosine window",
 132           "cosine"},
 133       {WINDOW_HANN, "Hann window",
 134           "hann"},
 135       {0, NULL, NULL}
 136     };
 137
 138     gtype = g_enum_register_static ("GstAudioWSincBandWindow", values);
 139   }
 140   return gtype;
 141 }
 142
 143 #define DEBUG_INIT(bla) \
 144   GST_DEBUG_CATEGORY_INIT (gst_gst_audio_wsincband_debug, "audiowsincband", 0, \
 145       "Band-pass and Band-reject Windowed sinc filter plugin");
 146
 147 GST_BOILERPLATE_FULL (GstAudioWSincBand, gst_audio_wsincband, GstAudioFilter,
 148     GST_TYPE_AUDIO_FX_BASE_FIR_FILTER, DEBUG_INIT);
 149
 150 static void gst_audio_wsincband_set_property (GObject * object, guint prop_id,
 151     const GValue * value, GParamSpec * pspec);
 152 static void gst_audio_wsincband_get_property (GObject * object, guint prop_id,
 153     GValue * value, GParamSpec * pspec);
 154 static void gst_audio_wsincband_finalize (GObject * object);
 155
 156 static gboolean gst_audio_wsincband_setup (GstAudioFilter * base,
 157     GstRingBufferSpec * format);
 158
 159
 160 #define POW2(x)  (x)*(x)
 161
 162 /* Element class */
 163 static void
 164 gst_audio_wsincband_base_init (gpointer g_class)
 165 {
 166   GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
 167
 168   gst_element_class_set_details_simple (element_class,
 169       "Band pass & band reject filter", "Filter/Effect/Audio",
 170       "Band pass and band reject windowed sinc filter",
 171       "Thomas Vander Stichele <thomas at apestaart dot org>, "
 172       "Steven W. Smith, "
 173       "Dreamlab Technologies Ltd. <mathis.hofer@dreamlab.net>, "
 174       "Sebastian Dröge <sebastian.droege@collabora.co.uk>");
 175 }
 176
 177 static void
 178 gst_audio_wsincband_class_init (GstAudioWSincBandClass * klass)
 179 {
 180   GObjectClass *gobject_class = (GObjectClass *) klass;
 181   GstAudioFilterClass *filter_class = (GstAudioFilterClass *) klass;
 182
 183   gobject_class->set_property = gst_audio_wsincband_set_property;
 184   gobject_class->get_property = gst_audio_wsincband_get_property;
 185   gobject_class->finalize = gst_audio_wsincband_finalize;
 186
 187   /* FIXME: Don't use the complete possible range but restrict the upper boundary
 188    * so automatically generated UIs can use a slider */
 189   g_object_class_install_property (gobject_class, PROP_LOWER_FREQUENCY,
 190       g_param_spec_float ("lower-frequency", "Lower Frequency",
 191           "Cut-off lower frequency (Hz)", 0.0, 100000.0, 0,
 192           G_PARAM_READWRITE | GST_PARAM_CONTROLLABLE | G_PARAM_STATIC_STRINGS));
 193   g_object_class_install_property (gobject_class, PROP_UPPER_FREQUENCY,
 194       g_param_spec_float ("upper-frequency", "Upper Frequency",
 195           "Cut-off upper frequency (Hz)", 0.0, 100000.0, 0,
 196           G_PARAM_READWRITE | GST_PARAM_CONTROLLABLE | G_PARAM_STATIC_STRINGS));
 197   g_object_class_install_property (gobject_class, PROP_LENGTH,
 198       g_param_spec_int ("length", "Length",
 199           "Filter kernel length, will be rounded to the next odd number", 3,
 200           256000, 101,
 201           G_PARAM_READWRITE | GST_PARAM_CONTROLLABLE | G_PARAM_STATIC_STRINGS));
 202
 203   g_object_class_install_property (gobject_class, PROP_MODE,
 204       g_param_spec_enum ("mode", "Mode",
 205           "Band pass or band reject mode", GST_TYPE_AUDIO_WSINC_BAND_MODE,
 206           MODE_BAND_PASS,
 207           G_PARAM_READWRITE | GST_PARAM_CONTROLLABLE | G_PARAM_STATIC_STRINGS));
 208
 209   g_object_class_install_property (gobject_class, PROP_WINDOW,
 210       g_param_spec_enum ("window", "Window",
 211           "Window function to use", GST_TYPE_AUDIO_WSINC_BAND_WINDOW,
 212           WINDOW_HAMMING,
 213           G_PARAM_READWRITE | GST_PARAM_CONTROLLABLE | G_PARAM_STATIC_STRINGS));
 214
 215   filter_class->setup = GST_DEBUG_FUNCPTR (gst_audio_wsincband_setup);
 216 }
 217
 218 static void
 219 gst_audio_wsincband_init (GstAudioWSincBand * self,
 220     GstAudioWSincBandClass * g_class)
 221 {
 222   self->kernel_length = 101;
 223   self->lower_frequency = 0.0;
 224   self->upper_frequency = 0.0;
 225   self->mode = MODE_BAND_PASS;
 226   self->window = WINDOW_HAMMING;
 227
 228   self->lock = g_mutex_new ();
 229 }
 230
 231 static void
 232 gst_audio_wsincband_build_kernel (GstAudioWSincBand * self)
 233 {
 234   gint i = 0;
 235   gdouble sum = 0.0;
 236   gint len = 0;
 237   gdouble *kernel_lp, *kernel_hp;
 238   gdouble w;
 239   gdouble *kernel;
 240
 241   len = self->kernel_length;
 242
 243   if (GST_AUDIO_FILTER (self)->format.rate == 0) {
 244     GST_DEBUG ("rate not set yet");
 245     return;
 246   }
 247
 248   if (GST_AUDIO_FILTER (self)->format.channels == 0) {
 249     GST_DEBUG ("channels not set yet");
 250     return;
 251   }
 252
 253   /* Clamp frequencies */
 254   self->lower_frequency =
 255       CLAMP (self->lower_frequency, 0.0,
 256       GST_AUDIO_FILTER (self)->format.rate / 2);
 257   self->upper_frequency =
 258       CLAMP (self->upper_frequency, 0.0,
 259       GST_AUDIO_FILTER (self)->format.rate / 2);
 260   if (self->lower_frequency > self->upper_frequency) {
 261     gint tmp = self->lower_frequency;
 262
 263     self->lower_frequency = self->upper_frequency;
 264     self->upper_frequency = tmp;
 265   }
 266
 267   GST_DEBUG ("gst_audio_wsincband: initializing filter kernel of length %d "
 268       "with lower frequency %.2lf Hz "
 269       ", upper frequency %.2lf Hz for mode %s",
 270       len, self->lower_frequency, self->upper_frequency,
 271       (self->mode == MODE_BAND_PASS) ? "band-pass" : "band-reject");
 272
 273   /* fill the lp kernel */
 274   w = 2 * G_PI * (self->lower_frequency / GST_AUDIO_FILTER (self)->format.rate);
 275   kernel_lp = g_new (gdouble, len);
 276   for (i = 0; i < len; ++i) {
 277     if (i == (len - 1) / 2.0)
 278       kernel_lp[i] = w;
 279     else
 280       kernel_lp[i] = sin (w * (i - (len - 1) / 2.0)) / (i - (len - 1) / 2.0);
 281
 282     /* windowing */
 283     switch (self->window) {
 284       case WINDOW_HAMMING:
 285         kernel_lp[i] *= (0.54 - 0.46 * cos (2 * G_PI * i / (len - 1)));
 286         break;
 287       case WINDOW_BLACKMAN:
 288         kernel_lp[i] *= (0.42 - 0.5 * cos (2 * G_PI * i / (len - 1)) +
 289             0.08 * cos (4 * G_PI * i / (len - 1)));
 290         break;
 291       case WINDOW_GAUSSIAN:
 292         kernel_lp[i] *= exp (-0.5 * POW2 (3.0 / len * (2 * i - (len - 1))));
 293         break;
 294       case WINDOW_COSINE:
 295         kernel_lp[i] *= cos (G_PI * i / (len - 1) - G_PI / 2);
 296         break;
 297       case WINDOW_HANN:
 298         kernel_lp[i] *= 0.5 * (1 - cos (2 * G_PI * i / (len - 1)));
 299         break;
 300     }
 301   }
 302
 303   /* normalize for unity gain at DC */
 304   sum = 0.0;
 305   for (i = 0; i < len; ++i)
 306     sum += kernel_lp[i];
 307   for (i = 0; i < len; ++i)
 308     kernel_lp[i] /= sum;
 309
 310   /* fill the hp kernel */
 311   w = 2 * G_PI * (self->upper_frequency / GST_AUDIO_FILTER (self)->format.rate);
 312   kernel_hp = g_new (gdouble, len);
 313   for (i = 0; i < len; ++i) {
 314     if (i == (len - 1) / 2.0)
 315       kernel_hp[i] = w;
 316     else
 317       kernel_hp[i] = sin (w * (i - (len - 1) / 2.0)) / (i - (len - 1) / 2.0);
 318
 319     /* Windowing */
 320     switch (self->window) {
 321       case WINDOW_HAMMING:
 322         kernel_hp[i] *= (0.54 - 0.46 * cos (2 * G_PI * i / (len - 1)));
 323         break;
 324       case WINDOW_BLACKMAN:
 325         kernel_hp[i] *= (0.42 - 0.5 * cos (2 * G_PI * i / (len - 1)) +
 326             0.08 * cos (4 * G_PI * i / (len - 1)));
 327         break;
 328       case WINDOW_GAUSSIAN:
 329         kernel_hp[i] *= exp (-0.5 * POW2 (3.0 / len * (2 * i - (len - 1))));
 330         break;
 331       case WINDOW_COSINE:
 332         kernel_hp[i] *= cos (G_PI * i / (len - 1) - G_PI / 2);
 333         break;
 334       case WINDOW_HANN:
 335         kernel_hp[i] *= 0.5 * (1 - cos (2 * G_PI * i / (len - 1)));
 336         break;
 337     }
 338   }
 339
 340   /* normalize for unity gain at DC */
 341   sum = 0.0;
 342   for (i = 0; i < len; ++i)
 343     sum += kernel_hp[i];
 344   for (i = 0; i < len; ++i)
 345     kernel_hp[i] /= sum;
 346
 347   /* do spectral inversion to go from lowpass to highpass */
 348   for (i = 0; i < len; ++i)
 349     kernel_hp[i] = -kernel_hp[i];
 350   if (len % 2 == 1) {
 351     kernel_hp[(len - 1) / 2] += 1.0;
 352   } else {
 353     kernel_hp[len / 2 - 1] += 0.5;
 354     kernel_hp[len / 2] += 0.5;
 355   }
 356
 357   /* combine the two kernels */
 358   kernel = g_new (gdouble, len);
 359
 360   for (i = 0; i < len; ++i)
 361     kernel[i] = kernel_lp[i] + kernel_hp[i];
 362
 363   /* free the helper kernels */
 364   g_free (kernel_lp);
 365   g_free (kernel_hp);
 366
 367   /* do spectral inversion to go from bandreject to bandpass
 368    * if specified */
 369   if (self->mode == MODE_BAND_PASS) {
 370     for (i = 0; i < len; ++i)
 371       kernel[i] = -kernel[i];
 372     kernel[len / 2] += 1;
 373   }
 374
 375   gst_audio_fx_base_fir_filter_set_kernel (GST_AUDIO_FX_BASE_FIR_FILTER (self),
 376       kernel, self->kernel_length, (len - 1) / 2);
 377 }
 378
 379 /* GstAudioFilter vmethod implementations */
 380
 381 /* get notified of caps and plug in the correct process function */
 382 static gboolean
 383 gst_audio_wsincband_setup (GstAudioFilter * base, GstRingBufferSpec * format)
 384 {
 385   GstAudioWSincBand *self = GST_AUDIO_WSINC_BAND (base);
 386
 387   gst_audio_wsincband_build_kernel (self);
 388
 389   return GST_AUDIO_FILTER_CLASS (parent_class)->setup (base, format);
 390 }
 391
 392 static void
 393 gst_audio_wsincband_finalize (GObject * object)
 394 {
 395   GstAudioWSincBand *self = GST_AUDIO_WSINC_BAND (object);
 396
 397   g_mutex_free (self->lock);
 398   self->lock = NULL;
 399
 400   G_OBJECT_CLASS (parent_class)->finalize (object);
 401 }
 402
 403 static void
 404 gst_audio_wsincband_set_property (GObject * object, guint prop_id,
 405     const GValue * value, GParamSpec * pspec)
 406 {
 407   GstAudioWSincBand *self = GST_AUDIO_WSINC_BAND (object);
 408
 409   g_return_if_fail (GST_IS_AUDIO_WSINC_BAND (self));
 410
 411   switch (prop_id) {
 412     case PROP_LENGTH:{
 413       gint val;
 414
 415       g_mutex_lock (self->lock);
 416       val = g_value_get_int (value);
 417       if (val % 2 == 0)
 418         val++;
 419
 420       if (val != self->kernel_length) {
 421         gst_audio_fx_base_fir_filter_push_residue (GST_AUDIO_FX_BASE_FIR_FILTER
 422             (self));
 423         self->kernel_length = val;
 424         gst_audio_wsincband_build_kernel (self);
 425       }
 426       g_mutex_unlock (self->lock);
 427       break;
 428     }
 429     case PROP_LOWER_FREQUENCY:
 430       g_mutex_lock (self->lock);
 431       self->lower_frequency = g_value_get_float (value);
 432       gst_audio_wsincband_build_kernel (self);
 433       g_mutex_unlock (self->lock);
 434       break;
 435     case PROP_UPPER_FREQUENCY:
 436       g_mutex_lock (self->lock);
 437       self->upper_frequency = g_value_get_float (value);
 438       gst_audio_wsincband_build_kernel (self);
 439       g_mutex_unlock (self->lock);
 440       break;
 441     case PROP_MODE:
 442       g_mutex_lock (self->lock);
 443       self->mode = g_value_get_enum (value);
 444       gst_audio_wsincband_build_kernel (self);
 445       g_mutex_unlock (self->lock);
 446       break;
 447     case PROP_WINDOW:
 448       g_mutex_lock (self->lock);
 449       self->window = g_value_get_enum (value);
 450       gst_audio_wsincband_build_kernel (self);
 451       g_mutex_unlock (self->lock);
 452       break;
 453     default:
 454       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 455       break;
 456   }
 457 }
 458
 459 static void
 460 gst_audio_wsincband_get_property (GObject * object, guint prop_id,
 461     GValue * value, GParamSpec * pspec)
 462 {
 463   GstAudioWSincBand *self = GST_AUDIO_WSINC_BAND (object);
 464
 465   switch (prop_id) {
 466     case PROP_LENGTH:
 467       g_value_set_int (value, self->kernel_length);
 468       break;
 469     case PROP_LOWER_FREQUENCY:
 470       g_value_set_float (value, self->lower_frequency);
 471       break;
 472     case PROP_UPPER_FREQUENCY:
 473       g_value_set_float (value, self->upper_frequency);
 474       break;
 475     case PROP_MODE:
 476       g_value_set_enum (value, self->mode);
 477       break;
 478     case PROP_WINDOW:
 479       g_value_set_enum (value, self->window);
 480       break;
 481     default:
 482       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 483       break;
 484   }
 485 }