gst/audiofx/audiofirfilter.c

   1 /*
   2  * GStreamer
   3  * Copyright (C) 2009 Sebastian Dröge <sebastian.droege@collabora.co.uk>
   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
  22 /**
  23  * SECTION:element-audiofirfilter
  24  *
  25  * audiofirfilter implements a generic audio <ulink url="http://en.wikipedia.org/wiki/Finite_impulse_response">FIR filter</ulink>. Before usage the
  26  * "kernel" property has to be set to the filter kernel that should be
  27  * used and the "latency" property has to be set to the latency (in samples)
  28  * that is introduced by the filter kernel. Setting a latency of n samples
  29  * will lead to the first n samples being dropped from the output and
  30  * n samples added to the end.
  31  *
  32  * The filter kernel describes the impulse response of the filter. To
  33  * calculate the frequency response of the filter you have to calculate
  34  * the Fourier Transform of the impulse response.
  35  *
  36  * To change the filter kernel whenever the sampling rate changes the
  37  * "rate-changed" signal can be used. This should be done for most
  38  * FIR filters as they're depending on the sampling rate.
  39  *
  40  * <refsect2>
  41  * <title>Example application</title>
  42  * |[
  43  * <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" parse="text" href="../../../../tests/examples/audiofx/firfilter-example.c" />
  44  * ]|
  45  * </refsect2>
  46  */
  47
  48 #ifdef HAVE_CONFIG_H
  49 #include "config.h"
  50 #endif
  51
  52 #include <string.h>
  53 #include <math.h>
  54 #include <gst/gst.h>
  55 #include <gst/audio/gstaudiofilter.h>
  56 #include <gst/controller/gstcontroller.h>
  57
  58 #include "audiofirfilter.h"
  59
  60 #include "gst/glib-compat-private.h"
  61
  62 #define GST_CAT_DEFAULT gst_audio_fir_filter_debug
  63 GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);
  64
  65 enum
  66 {
  67   SIGNAL_RATE_CHANGED,
  68   LAST_SIGNAL
  69 };
  70
  71 enum
  72 {
  73   PROP_0,
  74   PROP_KERNEL,
  75   PROP_LATENCY
  76 };
  77
  78 static guint gst_audio_fir_filter_signals[LAST_SIGNAL] = { 0, };
  79
  80 #define DEBUG_INIT(bla) \
  81   GST_DEBUG_CATEGORY_INIT (gst_audio_fir_filter_debug, "audiofirfilter", 0, \
  82       "Generic audio FIR filter plugin");
  83
  84 GST_BOILERPLATE_FULL (GstAudioFIRFilter, gst_audio_fir_filter, GstAudioFilter,
  85     GST_TYPE_AUDIO_FX_BASE_FIR_FILTER, DEBUG_INIT);
  86
  87 static void gst_audio_fir_filter_set_property (GObject * object, guint prop_id,
  88     const GValue * value, GParamSpec * pspec);
  89 static void gst_audio_fir_filter_get_property (GObject * object, guint prop_id,
  90     GValue * value, GParamSpec * pspec);
  91 static void gst_audio_fir_filter_finalize (GObject * object);
  92
  93 static gboolean gst_audio_fir_filter_setup (GstAudioFilter * base,
  94     GstRingBufferSpec * format);
  95
  96 /* Element class */
  97 static void
  98 gst_audio_fir_filter_base_init (gpointer g_class)
  99 {
 100   GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
 101
 102   gst_element_class_set_details_simple (element_class,
 103       "Audio FIR filter", "Filter/Effect/Audio",
 104       "Generic audio FIR filter with custom filter kernel",
 105       "Sebastian Dröge <sebastian.droege@collabora.co.uk>");
 106 }
 107
 108 static void
 109 gst_audio_fir_filter_class_init (GstAudioFIRFilterClass * klass)
 110 {
 111   GObjectClass *gobject_class = (GObjectClass *) klass;
 112   GstAudioFilterClass *filter_class = (GstAudioFilterClass *) klass;
 113
 114   gobject_class->set_property = gst_audio_fir_filter_set_property;
 115   gobject_class->get_property = gst_audio_fir_filter_get_property;
 116   gobject_class->finalize = gst_audio_fir_filter_finalize;
 117
 118   g_object_class_install_property (gobject_class, PROP_KERNEL,
 119       g_param_spec_value_array ("kernel", "Filter Kernel",
 120           "Filter kernel for the FIR filter",
 121           g_param_spec_double ("Element", "Filter Kernel Element",
 122               "Element of the filter kernel", -G_MAXDOUBLE, G_MAXDOUBLE, 0.0,
 123               G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS),
 124           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 125   g_object_class_install_property (gobject_class, PROP_LATENCY,
 126       g_param_spec_uint64 ("latency", "Latecy",
 127           "Filter latency in samples",
 128           0, G_MAXUINT64, 0, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 129
 130   filter_class->setup = GST_DEBUG_FUNCPTR (gst_audio_fir_filter_setup);
 131
 132   /**
 133    * GstAudioFIRFilter::rate-changed:
 134    * @filter: the filter on which the signal is emitted
 135    * @rate: the new sampling rate
 136    *
 137    * Will be emitted when the sampling rate changes. The callbacks
 138    * will be called from the streaming thread and processing will
 139    * stop until the event is handled.
 140    */
 141   gst_audio_fir_filter_signals[SIGNAL_RATE_CHANGED] =
 142       g_signal_new ("rate-changed", G_TYPE_FROM_CLASS (klass),
 143       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstAudioFIRFilterClass, rate_changed),
 144       NULL, NULL, gst_marshal_VOID__INT, G_TYPE_NONE, 1, G_TYPE_INT);
 145 }
 146
 147 static void
 148 gst_audio_fir_filter_update_kernel (GstAudioFIRFilter * self, GValueArray * va)
 149 {
 150   gdouble *kernel;
 151   guint i;
 152
 153   if (va) {
 154     if (self->kernel)
 155       g_value_array_free (self->kernel);
 156
 157     self->kernel = va;
 158   }
 159
 160   kernel = g_new (gdouble, self->kernel->n_values);
 161
 162   for (i = 0; i < self->kernel->n_values; i++) {
 163     GValue *v = g_value_array_get_nth (self->kernel, i);
 164     kernel[i] = g_value_get_double (v);
 165   }
 166
 167   gst_audio_fx_base_fir_filter_set_kernel (GST_AUDIO_FX_BASE_FIR_FILTER (self),
 168       kernel, self->kernel->n_values, self->latency);
 169 }
 170
 171 static void
 172 gst_audio_fir_filter_init (GstAudioFIRFilter * self,
 173     GstAudioFIRFilterClass * g_class)
 174 {
 175   GValue v = { 0, };
 176   GValueArray *va;
 177
 178   self->latency = 0;
 179   va = g_value_array_new (1);
 180
 181   g_value_init (&v, G_TYPE_DOUBLE);
 182   g_value_set_double (&v, 1.0);
 183   g_value_array_append (va, &v);
 184   g_value_unset (&v);
 185   gst_audio_fir_filter_update_kernel (self, va);
 186
 187   self->lock = g_mutex_new ();
 188 }
 189
 190 /* GstAudioFilter vmethod implementations */
 191
 192 /* get notified of caps and plug in the correct process function */
 193 static gboolean
 194 gst_audio_fir_filter_setup (GstAudioFilter * base, GstRingBufferSpec * format)
 195 {
 196   GstAudioFIRFilter *self = GST_AUDIO_FIR_FILTER (base);
 197
 198   if (self->rate != format->rate) {
 199     g_signal_emit (G_OBJECT (self),
 200         gst_audio_fir_filter_signals[SIGNAL_RATE_CHANGED], 0, format->rate);
 201     self->rate = format->rate;
 202   }
 203
 204   return GST_AUDIO_FILTER_CLASS (parent_class)->setup (base, format);
 205 }
 206
 207 static void
 208 gst_audio_fir_filter_finalize (GObject * object)
 209 {
 210   GstAudioFIRFilter *self = GST_AUDIO_FIR_FILTER (object);
 211
 212   g_mutex_free (self->lock);
 213   self->lock = NULL;
 214
 215   if (self->kernel)
 216     g_value_array_free (self->kernel);
 217   self->kernel = NULL;
 218
 219   G_OBJECT_CLASS (parent_class)->finalize (object);
 220 }
 221
 222 static void
 223 gst_audio_fir_filter_set_property (GObject * object, guint prop_id,
 224     const GValue * value, GParamSpec * pspec)
 225 {
 226   GstAudioFIRFilter *self = GST_AUDIO_FIR_FILTER (object);
 227
 228   g_return_if_fail (GST_IS_AUDIO_FIR_FILTER (self));
 229
 230   switch (prop_id) {
 231     case PROP_KERNEL:
 232       g_mutex_lock (self->lock);
 233       /* update kernel already pushes residues */
 234       gst_audio_fir_filter_update_kernel (self, g_value_dup_boxed (value));
 235       g_mutex_unlock (self->lock);
 236       break;
 237     case PROP_LATENCY:
 238       g_mutex_lock (self->lock);
 239       self->latency = g_value_get_uint64 (value);
 240       gst_audio_fir_filter_update_kernel (self, NULL);
 241       g_mutex_unlock (self->lock);
 242       break;
 243     default:
 244       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 245       break;
 246   }
 247 }
 248
 249 static void
 250 gst_audio_fir_filter_get_property (GObject * object, guint prop_id,
 251     GValue * value, GParamSpec * pspec)
 252 {
 253   GstAudioFIRFilter *self = GST_AUDIO_FIR_FILTER (object);
 254
 255   switch (prop_id) {
 256     case PROP_KERNEL:
 257       g_value_set_boxed (value, self->kernel);
 258       break;
 259     case PROP_LATENCY:
 260       g_value_set_uint64 (value, self->latency);
 261       break;
 262     default:
 263       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 264       break;
 265   }
 266 }