gst/audiofx/audiowsincband.c

   1 /* -*- c-basic-offset: 2 -*-
   2  * GStreamer
   3  * Copyright (C) 1999-2001 Erik Walthinsen <omega@cse.ogi.edu>
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Library General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Library General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20
  21 /* this windowed sinc filter is taken from the freely downloadable DSP book,
  22  * "The Scientist and Engineer's Guide to Digital Signal Processing",
  23  * chapter 16
  24  * available at http://www.dspguide.com/
  25  */
  26
  27 /* FIXME:
  28  * - this filter is totally unoptimized !
  29  * - we do not destroy the allocated memory for filters and residue
  30  * - this might be improved upon with bytestream
  31  */
  32
  33 #ifdef HAVE_CONFIG_H
  34 #include "config.h"
  35 #endif
  36 #include <gst/gst.h>
  37 #include "gstfilter.h"
  38 #include <math.h>               /* M_PI */
  39 #include <string.h>             /* memmove */
  40
  41 /* elementfactory information */
  42 static const GstElementDetails gst_bpwsinc_details =
  43 GST_ELEMENT_DETAILS ("BPWSinc",
  44     "Filter/Effect/Audio",
  45     "Band-Pass Windowed sinc filter",
  46     "Thomas <thomas@apestaart.org>, " "Steven W. Smith");
  47
  48 enum
  49 {
  50   /* FILL ME */
  51   LAST_SIGNAL
  52 };
  53
  54 enum
  55 {
  56   ARG_0,
  57   ARG_LENGTH,
  58   ARG_LOWER_FREQUENCY,
  59   ARG_UPPER_FREQUENCY
  60 };
  61
  62 #define GST_TYPE_BPWSINC \
  63   (gst_bpwsinc_get_type())
  64 #define GST_BPWSINC(obj) \
  65       (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_BPWSINC,GstBPWSinc))
  66 #define GST_BPWSINC_CLASS(klass) \
  67       (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ULAW,GstBPWSinc))
  68 #define GST_IS_BPWSINC(obj) \
  69       (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_BPWSINC))
  70 #define GST_IS_BPWSINC_CLASS(obj) \
  71       (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_BPWSINC))
  72
  73 typedef struct _GstBPWSinc GstBPWSinc;
  74 typedef struct _GstBPWSincClass GstBPWSincClass;
  75
  76 struct _GstBPWSinc
  77 {
  78   GstElement element;
  79
  80   GstPad *sinkpad, *srcpad;
  81
  82   double frequency;
  83   double lower_frequency, upper_frequency;
  84   int wing_size;                /* length of a "wing" of the filter;
  85                                    actual length is 2 * wing_size + 1 */
  86
  87   gfloat *residue;              /* buffer for left-over samples from previous buffer */
  88   double *kernel;
  89 };
  90
  91 struct _GstBPWSincClass
  92 {
  93   GstElementClass parent_class;
  94 };
  95
  96 static void gst_bpwsinc_base_init (gpointer g_class);
  97 static void gst_bpwsinc_class_init (GstBPWSincClass * klass);
  98 static void gst_bpwsinc_init (GstBPWSinc * filter);
  99
 100 static void gst_bpwsinc_set_property (GObject * object, guint prop_id,
 101     const GValue * value, GParamSpec * pspec);
 102 static void gst_bpwsinc_get_property (GObject * object, guint prop_id,
 103     GValue * value, GParamSpec * pspec);
 104
 105 static void gst_bpwsinc_chain (GstPad * pad, GstData * _data);
 106 static GstPadLinkReturn
 107 gst_bpwsinc_sink_connect (GstPad * pad, const GstCaps * caps);
 108
 109 static GstElementClass *parent_class = NULL;
 110
 111 /*static guint gst_bpwsinc_signals[LAST_SIGNAL] = { 0 }; */
 112
 113 GType
 114 gst_bpwsinc_get_type (void)
 115 {
 116   static GType bpwsinc_type = 0;
 117
 118   if (!bpwsinc_type) {
 119     static const GTypeInfo bpwsinc_info = {
 120       sizeof (GstBPWSincClass),
 121       gst_bpwsinc_base_init,
 122       NULL,
 123       (GClassInitFunc) gst_bpwsinc_class_init, NULL, NULL,
 124       sizeof (GstBPWSinc), 0,
 125       (GInstanceInitFunc) gst_bpwsinc_init,
 126     };
 127
 128     bpwsinc_type = g_type_register_static (GST_TYPE_ELEMENT, "GstBPWSinc",
 129         &bpwsinc_info, 0);
 130   }
 131   return bpwsinc_type;
 132 }
 133
 134 static void
 135 gst_bpwsinc_base_init (gpointer g_class)
 136 {
 137   GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
 138
 139   /* register src pads */
 140   gst_element_class_add_pad_template (element_class,
 141       gst_static_pad_template_get (&gst_filter_src_template));
 142   gst_element_class_add_pad_template (element_class,
 143       gst_static_pad_template_get (&gst_filter_sink_template));
 144
 145   gst_element_class_set_details (element_class, &gst_bpwsinc_details);
 146 }
 147
 148 static void
 149 gst_bpwsinc_class_init (GstBPWSincClass * klass)
 150 {
 151   GObjectClass *gobject_class;
 152   GstElementClass *gstelement_class;
 153
 154   gobject_class = (GObjectClass *) klass;
 155   gstelement_class = (GstElementClass *) klass;
 156
 157   parent_class = g_type_class_peek_parent (klass);
 158
 159   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_LOWER_FREQUENCY,
 160       g_param_spec_double ("lower-frequency", "Lower Frequency",
 161           "Cut-off lower frequency (relative to sample rate)",
 162           0.0, 0.5, 0, G_PARAM_READWRITE));
 163   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_UPPER_FREQUENCY,
 164       g_param_spec_double ("upper-frequency", "Upper Frequency",
 165           "Cut-off upper frequency (relative to sample rate)",
 166           0.0, 0.5, 0, G_PARAM_READWRITE));
 167   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_LENGTH,
 168       g_param_spec_int ("length", "Length",
 169           "N such that the filter length = 2N + 1",
 170           1, G_MAXINT, 1, G_PARAM_READWRITE));
 171
 172   gobject_class->set_property = gst_bpwsinc_set_property;
 173   gobject_class->get_property = gst_bpwsinc_get_property;
 174 }
 175
 176 static void
 177 gst_bpwsinc_init (GstBPWSinc * filter)
 178 {
 179   filter->sinkpad =
 180       gst_pad_new_from_template (gst_static_pad_template_get
 181       (&gst_filter_sink_template), "sink");
 182   gst_pad_set_chain_function (filter->sinkpad, gst_bpwsinc_chain);
 183   gst_pad_set_link_function (filter->sinkpad, gst_bpwsinc_sink_connect);
 184   gst_element_add_pad (GST_ELEMENT (filter), filter->sinkpad);
 185
 186   filter->srcpad =
 187       gst_pad_new_from_template (gst_static_pad_template_get
 188       (&gst_filter_src_template), "src");
 189   gst_element_add_pad (GST_ELEMENT (filter), filter->srcpad);
 190
 191   filter->wing_size = 50;
 192   filter->lower_frequency = 0.25;
 193   filter->upper_frequency = 0.3;
 194   filter->kernel = NULL;
 195 }
 196
 197 static GstPadLinkReturn
 198 gst_bpwsinc_sink_connect (GstPad * pad, const GstCaps * caps)
 199 {
 200   int i = 0;
 201   double sum = 0.0;
 202   int len = 0;
 203   double *kernel_lp, *kernel_hp;
 204   GstPadLinkReturn set_retval;
 205
 206   GstBPWSinc *filter = GST_BPWSINC (gst_pad_get_parent (pad));
 207
 208   g_assert (GST_IS_PAD (pad));
 209   g_assert (caps != NULL);
 210
 211   set_retval = gst_pad_try_set_caps (filter->srcpad, caps);
 212
 213   if (set_retval > 0) {
 214     len = filter->wing_size;
 215     /* fill the lp kernel */
 216     GST_DEBUG ("bpwsinc: initializing LP kernel of length %d with cut-off %f",
 217         len * 2 + 1, filter->lower_frequency);
 218     kernel_lp = (double *) g_malloc (sizeof (double) * (2 * len + 1));
 219     for (i = 0; i <= len * 2; ++i) {
 220       if (i == len)
 221         kernel_lp[i] = 2 * M_PI * filter->lower_frequency;
 222       else
 223         kernel_lp[i] = sin (2 * M_PI * filter->lower_frequency * (i - len))
 224             / (i - len);
 225       /* Blackman windowing */
 226       kernel_lp[i] *= (0.42 - 0.5 * cos (M_PI * i / len)
 227           + 0.08 * cos (2 * M_PI * i / len));
 228     }
 229
 230     /* normalize for unity gain at DC
 231      * FIXME: sure this is not supposed to be quadratic ? */
 232     sum = 0.0;
 233     for (i = 0; i <= len * 2; ++i)
 234       sum += kernel_lp[i];
 235     for (i = 0; i <= len * 2; ++i)
 236       kernel_lp[i] /= sum;
 237
 238     /* fill the hp kernel */
 239     GST_DEBUG ("bpwsinc: initializing HP kernel of length %d with cut-off %f",
 240         len * 2 + 1, filter->upper_frequency);
 241     kernel_hp = (double *) g_malloc (sizeof (double) * (2 * len + 1));
 242     for (i = 0; i <= len * 2; ++i) {
 243       if (i == len)
 244         kernel_hp[i] = 2 * M_PI * filter->upper_frequency;
 245       else
 246         kernel_hp[i] = sin (2 * M_PI * filter->upper_frequency * (i - len))
 247             / (i - len);
 248       /* Blackman windowing */
 249       kernel_hp[i] *= (0.42 - 0.5 * cos (M_PI * i / len)
 250           + 0.08 * cos (2 * M_PI * i / len));
 251     }
 252
 253     /* normalize for unity gain at DC
 254      * FIXME: sure this is not supposed to be quadratic ? */
 255     sum = 0.0;
 256     for (i = 0; i <= len * 2; ++i)
 257       sum += kernel_hp[i];
 258     for (i = 0; i <= len * 2; ++i)
 259       kernel_hp[i] /= sum;
 260
 261     /* do spectral inversion to get a HP filter */
 262     for (i = 0; i <= len * 2; ++i)
 263       kernel_hp[i] = -kernel_hp[i];
 264     kernel_hp[len] += 1;
 265
 266     /* combine the two filters */
 267
 268     filter->kernel = (double *) g_malloc (sizeof (double) * (2 * len + 1));
 269
 270     for (i = 0; i <= len * 2; ++i)
 271       filter->kernel[i] = kernel_lp[i] + kernel_hp[i];
 272
 273     /* do spectral inversion to go from band reject to bandpass */
 274     for (i = 0; i <= len * 2; ++i)
 275       filter->kernel[i] = -filter->kernel[i];
 276     filter->kernel[len] += 1;
 277
 278     /* free the helper kernels */
 279     g_free (kernel_lp);
 280     g_free (kernel_hp);
 281
 282     /* set up the residue memory space */
 283     filter->residue = (gfloat *) g_malloc (sizeof (gfloat) * (len * 2 + 1));
 284     for (i = 0; i <= len * 2; ++i)
 285       filter->residue[i] = 0.0;
 286   }
 287
 288   return set_retval;
 289 }
 290
 291 static void
 292 gst_bpwsinc_chain (GstPad * pad, GstData * _data)
 293 {
 294   GstBuffer *buf = GST_BUFFER (_data);
 295   GstBPWSinc *filter;
 296   gfloat *src;
 297   gfloat *input;
 298   gint residue_samples;
 299   gint input_samples;
 300   gint total_samples;
 301   int i, j;
 302
 303   filter = GST_BPWSINC (gst_pad_get_parent (pad));
 304
 305   /* FIXME: out of laziness, we copy the left-over bit from last buffer
 306    * together with the incoming buffer to a new buffer to make the loop
 307    * easy; this could be a lot more optimized though
 308    * to make amends we keep the incoming buffer around and write our
 309    * output samples there */
 310
 311   /* get a writable buffer */
 312   buf = gst_buffer_copy_on_write (buf);
 313
 314   src = (gfloat *) GST_BUFFER_DATA (buf);
 315   residue_samples = filter->wing_size * 2 + 1;
 316   input_samples = GST_BUFFER_SIZE (buf) / sizeof (gfloat);
 317   total_samples = residue_samples + input_samples;
 318
 319   input = (gfloat *) g_malloc (sizeof (gfloat) * total_samples);
 320
 321   /* copy the left-over bit */
 322   memcpy (input, filter->residue, sizeof (gfloat) * residue_samples);
 323
 324   /* copy the new buffer */
 325   memcpy (&input[residue_samples], src, sizeof (gfloat) * input_samples);
 326   /* copy the tail of the current input buffer to the residue */
 327   memcpy (filter->residue, &src[input_samples - residue_samples],
 328       sizeof (gfloat) * residue_samples);
 329
 330   /* convolution */
 331   /* since we copied the previous set of samples we needed before the actual
 332    * input data, we need to add the filter length to our indices for input */
 333   for (i = 0; i < input_samples; ++i) {
 334     src[i] = 0.0;
 335     for (j = 0; j < residue_samples; ++j)
 336       src[i] += input[i - j + residue_samples] * filter->kernel[j];
 337   }
 338
 339   g_free (input);
 340   gst_pad_push (filter->srcpad, GST_DATA (buf));
 341 }
 342
 343 static void
 344 gst_bpwsinc_set_property (GObject * object, guint prop_id, const GValue * value,
 345     GParamSpec * pspec)
 346 {
 347   GstBPWSinc *filter;
 348
 349   g_return_if_fail (GST_IS_BPWSINC (object));
 350
 351   filter = GST_BPWSINC (object);
 352
 353   switch (prop_id) {
 354     case ARG_LENGTH:
 355       filter->wing_size = g_value_get_int (value);
 356       break;
 357     case ARG_LOWER_FREQUENCY:
 358       filter->lower_frequency = g_value_get_double (value);
 359       break;
 360     case ARG_UPPER_FREQUENCY:
 361       filter->upper_frequency = g_value_get_double (value);
 362       break;
 363     default:
 364       break;
 365   }
 366 }
 367
 368 static void
 369 gst_bpwsinc_get_property (GObject * object, guint prop_id, GValue * value,
 370     GParamSpec * pspec)
 371 {
 372   GstBPWSinc *filter;
 373
 374   g_return_if_fail (GST_IS_BPWSINC (object));
 375
 376   filter = GST_BPWSINC (object);
 377
 378   switch (prop_id) {
 379     case ARG_LENGTH:
 380       g_value_set_int (value, filter->wing_size);
 381       break;
 382     case ARG_LOWER_FREQUENCY:
 383       g_value_set_double (value, filter->lower_frequency);
 384       break;
 385     case ARG_UPPER_FREQUENCY:
 386       g_value_set_double (value, filter->upper_frequency);
 387       break;
 388     default:
 389       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 390       break;
 391   }
 392 }