3 * Copyright (C) 2009 Sebastian Dröge <sebastian.droege@collabora.co.uk>
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.
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.
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.
23 * SECTION:element-audioiirfilter
25 * audioiirfilter implements a generic audio <ulink url="http://en.wikipedia.org/wiki/Infinite_impulse_response">IIR filter</ulink>. Before usage the
26 * "a" and "b" properties have to be set to the filter coefficients that
29 * The filter coefficients describe the numerator and denominator of the
32 * To change the filter coefficients whenever the sampling rate changes the
33 * "rate-changed" signal can be used. This should be done for most
34 * IIR filters as they're depending on the sampling rate.
37 * <title>Example application</title>
39 * <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" parse="text" href="../../../../tests/examples/audiofx/iirfilter-example.c" />
44 /* FIXME 0.11: suppress warnings for deprecated API such as GValueArray
45 * with newer GLib versions (>= 2.31.0) */
46 #define GLIB_DISABLE_DEPRECATION_WARNINGS
55 #include <gst/audio/gstaudiofilter.h>
56 #include <gst/controller/gstcontroller.h>
58 #include "audioiirfilter.h"
60 #include "gst/glib-compat-private.h"
62 #define GST_CAT_DEFAULT gst_audio_iir_filter_debug
63 GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);
78 static guint gst_audio_iir_filter_signals[LAST_SIGNAL] = { 0, };
80 #define DEBUG_INIT(bla) \
81 GST_DEBUG_CATEGORY_INIT (gst_audio_iir_filter_debug, "audioiirfilter", 0, \
82 "Generic audio IIR filter plugin");
84 GST_BOILERPLATE_FULL (GstAudioIIRFilter, gst_audio_iir_filter, GstAudioFilter,
85 GST_TYPE_AUDIO_FX_BASE_IIR_FILTER, DEBUG_INIT);
87 static void gst_audio_iir_filter_set_property (GObject * object, guint prop_id,
88 const GValue * value, GParamSpec * pspec);
89 static void gst_audio_iir_filter_get_property (GObject * object, guint prop_id,
90 GValue * value, GParamSpec * pspec);
91 static void gst_audio_iir_filter_finalize (GObject * object);
93 static gboolean gst_audio_iir_filter_setup (GstAudioFilter * base,
94 GstRingBufferSpec * format);
98 gst_audio_iir_filter_base_init (gpointer g_class)
100 GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
102 gst_element_class_set_details_simple (element_class,
103 "Audio IIR filter", "Filter/Effect/Audio",
104 "Generic audio IIR filter with custom filter kernel",
105 "Sebastian Dröge <sebastian.droege@collabora.co.uk>");
109 gst_audio_iir_filter_class_init (GstAudioIIRFilterClass * klass)
111 GObjectClass *gobject_class = (GObjectClass *) klass;
112 GstAudioFilterClass *filter_class = (GstAudioFilterClass *) klass;
114 gobject_class->set_property = gst_audio_iir_filter_set_property;
115 gobject_class->get_property = gst_audio_iir_filter_get_property;
116 gobject_class->finalize = gst_audio_iir_filter_finalize;
118 g_object_class_install_property (gobject_class, PROP_A,
119 g_param_spec_value_array ("a", "A",
120 "Filter coefficients (numerator of transfer function)",
121 g_param_spec_double ("Coefficient", "Filter Coefficient",
122 "Filter coefficient", -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_B,
126 g_param_spec_value_array ("b", "B",
127 "Filter coefficients (denominator of transfer function)",
128 g_param_spec_double ("Coefficient", "Filter Coefficient",
129 "Filter coefficient", -G_MAXDOUBLE, G_MAXDOUBLE, 0.0,
130 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS),
131 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
133 filter_class->setup = GST_DEBUG_FUNCPTR (gst_audio_iir_filter_setup);
136 * GstAudioIIRFilter::rate-changed:
137 * @filter: the filter on which the signal is emitted
138 * @rate: the new sampling rate
140 * Will be emitted when the sampling rate changes. The callbacks
141 * will be called from the streaming thread and processing will
142 * stop until the event is handled.
144 gst_audio_iir_filter_signals[SIGNAL_RATE_CHANGED] =
145 g_signal_new ("rate-changed", G_TYPE_FROM_CLASS (klass),
146 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstAudioIIRFilterClass, rate_changed),
147 NULL, NULL, gst_marshal_VOID__INT, G_TYPE_NONE, 1, G_TYPE_INT);
151 gst_audio_iir_filter_update_coefficients (GstAudioIIRFilter * self,
152 GValueArray * va, GValueArray * vb)
154 gdouble *a = NULL, *b = NULL;
159 g_value_array_free (self->a);
165 g_value_array_free (self->b);
170 if (self->a && self->a->n_values > 0) {
171 a = g_new (gdouble, self->a->n_values);
173 for (i = 0; i < self->a->n_values; i++) {
174 GValue *v = g_value_array_get_nth (self->a, i);
175 a[i] = g_value_get_double (v);
179 if (self->b && self->b->n_values > 0) {
180 b = g_new (gdouble, self->b->n_values);
181 for (i = 0; i < self->b->n_values; i++) {
182 GValue *v = g_value_array_get_nth (self->b, i);
183 b[i] = g_value_get_double (v);
187 gst_audio_fx_base_iir_filter_set_coefficients (GST_AUDIO_FX_BASE_IIR_FILTER
188 (self), a, (self->a) ? self->a->n_values : 0, b,
189 (self->b) ? self->b->n_values : 0);
193 gst_audio_iir_filter_init (GstAudioIIRFilter * self,
194 GstAudioIIRFilterClass * g_class)
199 a = g_value_array_new (1);
201 g_value_init (&v, G_TYPE_DOUBLE);
202 g_value_set_double (&v, 1.0);
203 g_value_array_append (a, &v);
207 gst_audio_iir_filter_update_coefficients (self, a, b);
209 self->lock = g_mutex_new ();
212 /* GstAudioFilter vmethod implementations */
214 /* get notified of caps and plug in the correct process function */
216 gst_audio_iir_filter_setup (GstAudioFilter * base, GstRingBufferSpec * format)
218 GstAudioIIRFilter *self = GST_AUDIO_IIR_FILTER (base);
220 if (self->rate != format->rate) {
221 g_signal_emit (G_OBJECT (self),
222 gst_audio_iir_filter_signals[SIGNAL_RATE_CHANGED], 0, format->rate);
223 self->rate = format->rate;
226 return GST_AUDIO_FILTER_CLASS (parent_class)->setup (base, format);
230 gst_audio_iir_filter_finalize (GObject * object)
232 GstAudioIIRFilter *self = GST_AUDIO_IIR_FILTER (object);
234 g_mutex_free (self->lock);
238 g_value_array_free (self->a);
241 g_value_array_free (self->b);
244 G_OBJECT_CLASS (parent_class)->finalize (object);
248 gst_audio_iir_filter_set_property (GObject * object, guint prop_id,
249 const GValue * value, GParamSpec * pspec)
251 GstAudioIIRFilter *self = GST_AUDIO_IIR_FILTER (object);
253 g_return_if_fail (GST_IS_AUDIO_IIR_FILTER (self));
257 g_mutex_lock (self->lock);
258 gst_audio_iir_filter_update_coefficients (self, g_value_dup_boxed (value),
260 g_mutex_unlock (self->lock);
263 g_mutex_lock (self->lock);
264 gst_audio_iir_filter_update_coefficients (self, NULL,
265 g_value_dup_boxed (value));
266 g_mutex_unlock (self->lock);
269 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
275 gst_audio_iir_filter_get_property (GObject * object, guint prop_id,
276 GValue * value, GParamSpec * pspec)
278 GstAudioIIRFilter *self = GST_AUDIO_IIR_FILTER (object);
282 g_value_set_boxed (value, self->a);
285 g_value_set_boxed (value, self->b);
288 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);