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 #define GST_CAT_DEFAULT gst_audio_fir_filter_debug
  61 GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);
  62
  63 enum
  64 {
  65   SIGNAL_RATE_CHANGED,
  66   LAST_SIGNAL
  67 };
  68
  69 enum
  70 {
  71   PROP_0,
  72   PROP_KERNEL,
  73   PROP_LATENCY
  74 };
  75
  76 static guint gst_audio_fir_filter_signals[LAST_SIGNAL] = { 0, };
  77
  78 #define gst_audio_fir_filter_parent_class parent_class
  79 G_DEFINE_TYPE (GstAudioFIRFilter, gst_audio_fir_filter,
  80     GST_TYPE_AUDIO_FX_BASE_FIR_FILTER);
  81
  82 static void gst_audio_fir_filter_set_property (GObject * object, guint prop_id,
  83     const GValue * value, GParamSpec * pspec);
  84 static void gst_audio_fir_filter_get_property (GObject * object, guint prop_id,
  85     GValue * value, GParamSpec * pspec);
  86 static void gst_audio_fir_filter_finalize (GObject * object);
  87
  88 static gboolean gst_audio_fir_filter_setup (GstAudioFilter * base,
  89     const GstAudioInfo * info);
  90
  91
  92 static void
  93 gst_audio_fir_filter_class_init (GstAudioFIRFilterClass * klass)
  94 {
  95   GObjectClass *gobject_class = (GObjectClass *) klass;
  96   GstElementClass *gstelement_class = (GstElementClass *) klass;
  97   GstAudioFilterClass *filter_class = (GstAudioFilterClass *) klass;
  98
  99   GST_DEBUG_CATEGORY_INIT (gst_audio_fir_filter_debug, "audiofirfilter", 0,
 100       "Generic audio FIR filter plugin");
 101
 102   gobject_class->set_property = gst_audio_fir_filter_set_property;
 103   gobject_class->get_property = gst_audio_fir_filter_get_property;
 104   gobject_class->finalize = gst_audio_fir_filter_finalize;
 105
 106   g_object_class_install_property (gobject_class, PROP_KERNEL,
 107       g_param_spec_value_array ("kernel", "Filter Kernel",
 108           "Filter kernel for the FIR filter",
 109           g_param_spec_double ("Element", "Filter Kernel Element",
 110               "Element of the filter kernel", -G_MAXDOUBLE, G_MAXDOUBLE, 0.0,
 111               G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS),
 112           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 113   g_object_class_install_property (gobject_class, PROP_LATENCY,
 114       g_param_spec_uint64 ("latency", "Latecy",
 115           "Filter latency in samples",
 116           0, G_MAXUINT64, 0, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 117
 118   filter_class->setup = GST_DEBUG_FUNCPTR (gst_audio_fir_filter_setup);
 119
 120   /**
 121    * GstAudioFIRFilter::rate-changed:
 122    * @filter: the filter on which the signal is emitted
 123    * @rate: the new sampling rate
 124    *
 125    * Will be emitted when the sampling rate changes. The callbacks
 126    * will be called from the streaming thread and processing will
 127    * stop until the event is handled.
 128    */
 129   gst_audio_fir_filter_signals[SIGNAL_RATE_CHANGED] =
 130       g_signal_new ("rate-changed", G_TYPE_FROM_CLASS (klass),
 131       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstAudioFIRFilterClass, rate_changed),
 132       NULL, NULL, gst_marshal_VOID__INT, G_TYPE_NONE, 1, G_TYPE_INT);
 133
 134   gst_element_class_set_details_simple (gstelement_class,
 135       "Audio FIR filter", "Filter/Effect/Audio",
 136       "Generic audio FIR filter with custom filter kernel",
 137       "Sebastian Dröge <sebastian.droege@collabora.co.uk>");
 138 }
 139
 140 static void
 141 gst_audio_fir_filter_update_kernel (GstAudioFIRFilter * self, GValueArray * va)
 142 {
 143   gdouble *kernel;
 144   guint i;
 145
 146   if (va) {
 147     if (self->kernel)
 148       g_value_array_free (self->kernel);
 149
 150     self->kernel = va;
 151   }
 152
 153   kernel = g_new (gdouble, self->kernel->n_values);
 154
 155   for (i = 0; i < self->kernel->n_values; i++) {
 156     GValue *v = g_value_array_get_nth (self->kernel, i);
 157     kernel[i] = g_value_get_double (v);
 158   }
 159
 160   gst_audio_fx_base_fir_filter_set_kernel (GST_AUDIO_FX_BASE_FIR_FILTER (self),
 161       kernel, self->kernel->n_values, self->latency);
 162 }
 163
 164 static void
 165 gst_audio_fir_filter_init (GstAudioFIRFilter * self)
 166 {
 167   GValue v = { 0, };
 168   GValueArray *va;
 169
 170   self->latency = 0;
 171   va = g_value_array_new (1);
 172
 173   g_value_init (&v, G_TYPE_DOUBLE);
 174   g_value_set_double (&v, 1.0);
 175   g_value_array_append (va, &v);
 176   g_value_unset (&v);
 177   gst_audio_fir_filter_update_kernel (self, va);
 178
 179   self->lock = g_mutex_new ();
 180 }
 181
 182 /* GstAudioFilter vmethod implementations */
 183
 184 /* get notified of caps and plug in the correct process function */
 185 static gboolean
 186 gst_audio_fir_filter_setup (GstAudioFilter * base, const GstAudioInfo * info)
 187 {
 188   GstAudioFIRFilter *self = GST_AUDIO_FIR_FILTER (base);
 189   gint new_rate = GST_AUDIO_INFO_RATE (info);
 190
 191   if (GST_AUDIO_FILTER_RATE (self) != new_rate) {
 192     g_signal_emit (G_OBJECT (self),
 193         gst_audio_fir_filter_signals[SIGNAL_RATE_CHANGED], 0, new_rate);
 194   }
 195
 196   return GST_AUDIO_FILTER_CLASS (parent_class)->setup (base, info);
 197 }
 198
 199 static void
 200 gst_audio_fir_filter_finalize (GObject * object)
 201 {
 202   GstAudioFIRFilter *self = GST_AUDIO_FIR_FILTER (object);
 203
 204   g_mutex_free (self->lock);
 205   self->lock = NULL;
 206
 207   if (self->kernel)
 208     g_value_array_free (self->kernel);
 209   self->kernel = NULL;
 210
 211   G_OBJECT_CLASS (parent_class)->finalize (object);
 212 }
 213
 214 static void
 215 gst_audio_fir_filter_set_property (GObject * object, guint prop_id,
 216     const GValue * value, GParamSpec * pspec)
 217 {
 218   GstAudioFIRFilter *self = GST_AUDIO_FIR_FILTER (object);
 219
 220   g_return_if_fail (GST_IS_AUDIO_FIR_FILTER (self));
 221
 222   switch (prop_id) {
 223     case PROP_KERNEL:
 224       g_mutex_lock (self->lock);
 225       /* update kernel already pushes residues */
 226       gst_audio_fir_filter_update_kernel (self, g_value_dup_boxed (value));
 227       g_mutex_unlock (self->lock);
 228       break;
 229     case PROP_LATENCY:
 230       g_mutex_lock (self->lock);
 231       self->latency = g_value_get_uint64 (value);
 232       gst_audio_fir_filter_update_kernel (self, NULL);
 233       g_mutex_unlock (self->lock);
 234       break;
 235     default:
 236       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 237       break;
 238   }
 239 }
 240
 241 static void
 242 gst_audio_fir_filter_get_property (GObject * object, guint prop_id,
 243     GValue * value, GParamSpec * pspec)
 244 {
 245   GstAudioFIRFilter *self = GST_AUDIO_FIR_FILTER (object);
 246
 247   switch (prop_id) {
 248     case PROP_KERNEL:
 249       g_value_set_boxed (value, self->kernel);
 250       break;
 251     case PROP_LATENCY:
 252       g_value_set_uint64 (value, self->latency);
 253       break;
 254     default:
 255       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 256       break;
 257   }
 258 }