1 /* vim: set sts=2 sw=2 et: */
4 * Copyright (C) 2006 Josep Torra <j.torra@telefonica.net>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
26 #include <gst/audio/audio.h>
30 GST_DEBUG_CATEGORY_STATIC (gst_pitch_debug);
31 #define GST_CAT_DEFAULT gst_pitch_debug
34 #define WANTED RATE * 2
36 /* Filter signals and args */
48 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
51 GST_STATIC_CAPS ("audio/x-raw-int, "
53 "channels = (int) 1, "
54 "endianness = (int) BYTE_ORDER, "
55 "width = (int) 16, " "depth = (int) 16, " "signed = (boolean) true")
58 static GstStaticPadTemplate src_template = GST_STATIC_PAD_TEMPLATE ("src",
61 GST_STATIC_CAPS ("audio/x-raw-int, "
62 "rate = (int) [ 1, MAX ], "
63 "channels = (int) [1, MAX], "
64 "endianness = (int) BYTE_ORDER, "
65 "width = (int) 16, " "depth = (int) 16, " "signed = (boolean) true")
68 #define DEBUG_INIT(bla) \
69 GST_DEBUG_CATEGORY_INIT (gst_pitch_debug, "Pitch", 0, "fundamental frequency plugin");
71 GST_BOILERPLATE_FULL (GstPitch, gst_pitch, GstBaseTransform,
72 GST_TYPE_BASE_TRANSFORM, DEBUG_INIT);
74 static void gst_pitch_set_property (GObject * object, guint prop_id,
75 const GValue * value, GParamSpec * pspec);
76 static void gst_pitch_get_property (GObject * object, guint prop_id,
77 GValue * value, GParamSpec * pspec);
78 static void gst_pitch_dispose (GObject * object);
80 static gboolean gst_pitch_set_caps (GstBaseTransform * trans, GstCaps * in,
82 static gboolean gst_pitch_start (GstBaseTransform * trans);
84 static GstFlowReturn gst_pitch_transform_ip (GstBaseTransform * trans,
87 #define DEFAULT_PROP_ALGORITHM GST_PITCH_ALGORITHM_FFT
89 #define GST_TYPE_PITCH_ALGORITHM (gst_pitch_algorithm_get_type())
91 gst_pitch_algorithm_get_type (void)
93 static GType pitch_algorithm_type = 0;
94 static const GEnumValue pitch_algorithm[] = {
95 {GST_PITCH_ALGORITHM_FFT, "fft", "fft"},
96 {GST_PITCH_ALGORITHM_HPS, "hps", "hps"},
100 if (!pitch_algorithm_type) {
101 pitch_algorithm_type =
102 g_enum_register_static ("GstPitchAlgorithm",
105 return pitch_algorithm_type;
108 /* GObject vmethod implementations */
111 gst_pitch_base_init (gpointer klass)
113 static GstElementDetails element_details = {
115 "Filter/Analyzer/Audio",
116 "Run an FFT on the audio signal, output fundamental frequency",
117 "Josep Torra <j.torra@telefonica.net>"
119 GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
121 gst_element_class_add_pad_template (element_class,
122 gst_static_pad_template_get (&src_template));
123 gst_element_class_add_pad_template (element_class,
124 gst_static_pad_template_get (&sink_template));
125 gst_element_class_set_details (element_class, &element_details);
129 gst_pitch_class_init (GstPitchClass * klass)
131 GObjectClass *gobject_class;
132 GstBaseTransformClass *trans_class = GST_BASE_TRANSFORM_CLASS (klass);
134 gobject_class = (GObjectClass *) klass;
135 gobject_class->set_property = gst_pitch_set_property;
136 gobject_class->get_property = gst_pitch_get_property;
137 gobject_class->dispose = gst_pitch_dispose;
139 trans_class->set_caps = GST_DEBUG_FUNCPTR (gst_pitch_set_caps);
140 trans_class->start = GST_DEBUG_FUNCPTR (gst_pitch_start);
141 trans_class->transform_ip = GST_DEBUG_FUNCPTR (gst_pitch_transform_ip);
142 trans_class->passthrough_on_same_caps = TRUE;
144 g_object_class_install_property (gobject_class, PROP_SIGNAL_FFREQ,
145 g_param_spec_boolean ("message", "Message",
146 "Post a fundamental frequency message for each passed interval",
147 TRUE, G_PARAM_READWRITE));
149 g_object_class_install_property (gobject_class, PROP_SIGNAL_MINFREQ,
150 g_param_spec_int ("minfreq", "MinFreq",
151 "Initial scan frequency, default 30 Hz",
152 1, G_MAXINT, 30, G_PARAM_READWRITE));
154 g_object_class_install_property (gobject_class, PROP_SIGNAL_MAXFREQ,
155 g_param_spec_int ("maxfreq", "MaxFreq",
156 "Final scan frequency, default 1500 Hz",
157 1, G_MAXINT, 1500, G_PARAM_READWRITE));
159 g_object_class_install_property (gobject_class, PROP_ALGORITHM,
160 g_param_spec_enum ("algorithm", "Algorithm",
161 "Pitch detection algorithm to use",
162 GST_TYPE_PITCH_ALGORITHM, DEFAULT_PROP_ALGORITHM,
166 GST_BASE_TRANSFORM_CLASS (klass)->transform_ip =
167 GST_DEBUG_FUNCPTR (gst_pitch_transform_ip);
171 gst_pitch_setup_algorithm (GstPitch * filter)
173 if (filter->algorithm == GST_PITCH_ALGORITHM_HPS) {
174 filter->module = (gint *) g_malloc (RATE * sizeof (gint));
178 g_free (filter->module);
180 filter->module = NULL;
185 gst_pitch_init (GstPitch * filter, GstPitchClass * klass)
187 filter->adapter = gst_adapter_new ();
189 filter->minfreq = 30;
190 filter->maxfreq = 1500;
191 filter->message = TRUE;
192 filter->algorithm = DEFAULT_PROP_ALGORITHM;
193 gst_pitch_setup_algorithm (filter);
197 gst_pitch_dispose (GObject * object)
199 GstPitch *filter = GST_PITCH (object);
201 if (filter->adapter) {
202 g_object_unref (filter->adapter);
203 filter->adapter = NULL;
206 g_free (filter->fft_cfg);
207 g_free (filter->signal);
208 g_free (filter->spectrum);
210 g_free (filter->module);
214 G_OBJECT_CLASS (parent_class)->dispose (object);
218 gst_pitch_set_property (GObject * object, guint prop_id,
219 const GValue * value, GParamSpec * pspec)
221 GstPitch *filter = GST_PITCH (object);
224 case PROP_SIGNAL_FFREQ:
225 filter->message = g_value_get_boolean (value);
227 case PROP_SIGNAL_MINFREQ:
228 filter->minfreq = g_value_get_int (value);
230 case PROP_SIGNAL_MAXFREQ:
231 filter->maxfreq = g_value_get_int (value);
234 filter->algorithm = g_value_get_enum (value);
235 gst_pitch_setup_algorithm (filter);
238 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
244 gst_pitch_get_property (GObject * object, guint prop_id,
245 GValue * value, GParamSpec * pspec)
247 GstPitch *filter = GST_PITCH (object);
250 case PROP_SIGNAL_FFREQ:
251 g_value_set_boolean (value, filter->message);
253 case PROP_SIGNAL_MINFREQ:
254 g_value_set_int (value, filter->minfreq);
256 case PROP_SIGNAL_MAXFREQ:
257 g_value_set_int (value, filter->maxfreq);
260 g_value_set_enum (value, filter->algorithm);
263 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
269 gst_pitch_set_caps (GstBaseTransform * trans, GstCaps * in, GstCaps * out)
271 GstPitch *filter = GST_PITCH (trans);
273 filter->fft_cfg = kiss_fft_alloc (RATE, 0, NULL, NULL);
275 (kiss_fft_cpx *) g_malloc (RATE * sizeof (kiss_fft_cpx));
277 (kiss_fft_cpx *) g_malloc (RATE * sizeof (kiss_fft_cpx));
283 gst_pitch_start (GstBaseTransform * trans)
285 GstPitch *filter = GST_PITCH (trans);
287 gst_adapter_clear (filter->adapter);
293 gst_pitch_message_new (GstPitch * filter)
296 gint i, min_i, max_i;
297 gint frequency, frequency_module;
299 /* Extract fundamental frequency */
301 frequency_module = 0;
302 min_i = filter->minfreq;
303 max_i = filter->maxfreq;
305 GST_DEBUG_OBJECT (filter, "min_freq = %d, max_freq = %d", filter->minfreq,
307 /*GST_DEBUG_OBJECT (filter, "min_i = %d, max_i = %d", min_i, max_i); */
309 switch (filter->algorithm) {
311 case GST_PITCH_ALGORITHM_FFT:
315 for (i = min_i; i < max_i; i++) {
316 module = (filter->spectrum[i].r * filter->spectrum[i].r);
317 module += (filter->spectrum[i].i * filter->spectrum[i].i);
320 GST_LOG_OBJECT (filter, "module[%d] = %d", i, module);
322 /* find strongest peak */
323 if (module > frequency_module) {
324 frequency_module = module;
331 case GST_PITCH_ALGORITHM_HPS:
333 gint prev_frequency = 0;
336 for (i = min_i; i < RATE; i++) {
337 filter->module[i] = (filter->spectrum[i].r * filter->spectrum[i].r);
338 filter->module[i] += (filter->spectrum[i].i * filter->spectrum[i].i);
340 if (filter->module[i] > 0)
341 GST_LOG_OBJECT (filter, "module[%d] = %d", i, filter->module[i]);
344 /* Harmonic Product Spectrum algorithm */
345 #define MAX_DS_FACTOR (6)
346 for (i = min_i; (i <= max_i) && (i < RATE); i++) {
347 for (j = 2; j <= MAX_DS_FACTOR; j++) {
352 /* this is not part of the HPS but it seems
353 * there are lots of zeroes in the spectrum ...
355 if (filter->module[t] != 0)
356 filter->module[i] *= filter->module[t];
359 /* find strongest peak */
360 if (filter->module[i] > frequency_module) {
361 prev_frequency = frequency;
362 frequency_module = filter->module[i];
367 /* try to correct octave error */
368 if (frequency != 0 && prev_frequency != 0) {
369 float ratio = (float) frequency / (float) prev_frequency;
370 if (ratio >= 1.9 && ratio < 2.1 && (float) filter->module[prev_frequency] >= 0.2 * (float) frequency_module ) {
371 g_debug("Chose freq %d[%d] over %d[%d]\n", prev_frequency, filter->module[prev_frequency], frequency, filter->module[frequency]);
372 frequency = prev_frequency;
373 frequency_module = filter->module[prev_frequency];
383 g_debug("freq %d[%d]\n", frequency, frequency_module);
385 GST_DEBUG_OBJECT (filter, "preparing message, frequency = %d ", frequency);
387 s = gst_structure_new ("pitch", "frequency", G_TYPE_INT, frequency, NULL);
389 return gst_message_new_element (GST_OBJECT (filter), s);
392 /* GstBaseTransform vmethod implementations */
394 /* this function does the actual processing
397 gst_pitch_transform_ip (GstBaseTransform * trans, GstBuffer * in)
399 GstPitch *filter = GST_PITCH (trans);
404 GST_DEBUG_OBJECT (filter, "transform : %ld bytes", GST_BUFFER_SIZE (in));
405 gst_adapter_push (filter->adapter, gst_buffer_ref (in));
407 /* required number of bytes */
408 avail = gst_adapter_available (filter->adapter);
409 GST_DEBUG_OBJECT (filter, "avail: %d wanted: %d", avail, WANTED);
411 if (avail > WANTED) {
413 /* copy sample data in the complex vector */
414 samples = (gint16 *) gst_adapter_peek (filter->adapter, WANTED);
416 for (i = 0; i < RATE; i++) {
417 filter->signal[i].r = (kiss_fft_scalar) (samples[i]);
420 /* flush half second of data to implement sliding window */
421 gst_adapter_flush (filter->adapter, WANTED >> 1);
423 GST_DEBUG ("perform fft");
424 kiss_fft (filter->fft_cfg, filter->signal, filter->spectrum);
426 if (filter->message) {
427 GstMessage *m = gst_pitch_message_new (filter);
428 gst_element_post_message (GST_ELEMENT (filter), m);
436 /* entry point to initialize the plug-in
437 * initialize the plug-in itself
438 * register the element factories and pad templates
439 * register the features
441 * exchange the string 'plugin' with your elemnt name
443 /* static */ gboolean
444 plugin_pitch_init (GstPlugin * plugin)
446 return gst_element_register (plugin, "pitch", GST_RANK_NONE, GST_TYPE_PITCH);
449 /* this is the structure that gstreamer looks for to register plugins
451 * exchange the strings 'plugin' and 'Template plugin' with you plugin name and
455 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
458 "Run an FFT on the audio signal, output fundamental frequency",
459 plugin_init, VERSION, "LGPL", "GStreamer", "http://gstreamer.net/")