2 * Copyright (C) 1999 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2001 Steve Baker <stevebaker_org@yahoo.co.uk>
4 * 2003 Andy Wingo <wingo at pobox.com>
5 * 2016 Thibault Saunier <thibault.saunier@collabora.com>
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Library General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Library General Public License for more details.
17 * You should have received a copy of the GNU Library General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
20 * Boston, MA 02110-1301, USA.
27 #include "gstlv2utils.h"
33 #include <lilv/lilv.h>
35 #include <gst/audio/audio.h>
36 #include <gst/audio/gstaudiofilter.h>
37 #include <gst/audio/audio-channels.h>
39 GST_DEBUG_CATEGORY_EXTERN (lv2_debug);
40 #define GST_CAT_DEFAULT lv2_debug
42 typedef struct _lv2_control_info
46 gfloat lowerbound, upperbound;
48 gboolean lower, upper, samplerate;
49 gboolean toggled, logarithmic, integer, writable;
53 typedef struct _GstLV2Filter GstLV2Filter;
54 typedef struct _GstLV2FilterClass GstLV2FilterClass;
59 GstAudioFilter parent;
64 struct _GstLV2FilterClass
66 GstAudioFilterClass parent_class;
71 static GstAudioFilter *parent_class = NULL;
73 /* preset interface */
76 gst_lv2_filter_get_preset_names (GstPreset * preset)
78 GstLV2Filter *self = (GstLV2Filter *) preset;
80 return gst_lv2_get_preset_names (&self->lv2, (GstObject *) self);
84 gst_lv2_filter_load_preset (GstPreset * preset, const gchar * name)
86 GstLV2Filter *self = (GstLV2Filter *) preset;
88 return gst_lv2_load_preset (&self->lv2, (GstObject *) self, name);
92 gst_lv2_filter_save_preset (GstPreset * preset, const gchar * name)
94 GstLV2Filter *self = (GstLV2Filter *) preset;
96 return gst_lv2_save_preset (&self->lv2, (GstObject *) self, name);
100 gst_lv2_filter_rename_preset (GstPreset * preset, const gchar * old_name,
101 const gchar * new_name)
107 gst_lv2_filter_delete_preset (GstPreset * preset, const gchar * name)
109 GstLV2Filter *self = (GstLV2Filter *) preset;
111 return gst_lv2_delete_preset (&self->lv2, (GstObject *) self, name);
115 gst_lv2_filter_set_meta (GstPreset * preset, const gchar * name,
116 const gchar * tag, const gchar * value)
122 gst_lv2_filter_get_meta (GstPreset * preset, const gchar * name,
123 const gchar * tag, gchar ** value)
130 gst_lv2_filter_preset_interface_init (gpointer g_iface, gpointer iface_data)
132 GstPresetInterface *iface = g_iface;
134 iface->get_preset_names = gst_lv2_filter_get_preset_names;
135 iface->load_preset = gst_lv2_filter_load_preset;
136 iface->save_preset = gst_lv2_filter_save_preset;
137 iface->rename_preset = gst_lv2_filter_rename_preset;
138 iface->delete_preset = gst_lv2_filter_delete_preset;
139 iface->set_meta = gst_lv2_filter_set_meta;
140 iface->get_meta = gst_lv2_filter_get_meta;
144 /* GObject vmethods implementation */
146 gst_lv2_filter_set_property (GObject * object, guint prop_id,
147 const GValue * value, GParamSpec * pspec)
149 GstLV2Filter *self = (GstLV2Filter *) object;
151 gst_lv2_object_set_property (&self->lv2, object, prop_id, value, pspec);
155 gst_lv2_filter_get_property (GObject * object, guint prop_id, GValue * value,
158 GstLV2Filter *self = (GstLV2Filter *) object;
160 gst_lv2_object_get_property (&self->lv2, object, prop_id, value, pspec);
164 gst_lv2_filter_finalize (GObject * object)
166 GstLV2Filter *self = (GstLV2Filter *) object;
168 gst_lv2_finalize (&self->lv2);
170 G_OBJECT_CLASS (parent_class)->finalize (object);
174 /* Convert an LV2 port role to a Gst channel position
175 * WARNING: If the group has only a single port,
176 * GST_AUDIO_CHANNEL_POSITION_FRONT_CENTER will be returned for pg:centerRole
177 * (which is used by LV2 for mono groups), but this is not correct. In this
178 * case the value must be changed to GST_AUDIO_CHANNEL_POSITION_FRONT_MONO
179 * (this can't be done by this function because this information isn't known
180 * at the time it is used).
182 static GstAudioChannelPosition
183 gst_lv2_filter_role_to_position (LilvNode * role)
185 /* Front. Mono and left/right are mututally exclusive */
186 if (lilv_node_equals (role, center_role)) {
188 return GST_AUDIO_CHANNEL_POSITION_FRONT_CENTER;
189 } else if (lilv_node_equals (role, left_role)) {
190 return GST_AUDIO_CHANNEL_POSITION_FRONT_LEFT;
191 } else if (lilv_node_equals (role, right_role)) {
192 return GST_AUDIO_CHANNEL_POSITION_FRONT_RIGHT;
194 /* Rear. Left/right and center are mututally exclusive */
195 } else if (lilv_node_equals (role, rear_center_role)) {
196 return GST_AUDIO_CHANNEL_POSITION_REAR_CENTER;
197 } else if (lilv_node_equals (role, rear_left_role)) {
198 return GST_AUDIO_CHANNEL_POSITION_REAR_LEFT;
199 } else if (lilv_node_equals (role, rear_right_role)) {
200 return GST_AUDIO_CHANNEL_POSITION_REAR_RIGHT;
202 /* Subwoofer/low-frequency-effects */
203 } else if (lilv_node_equals (role, lfe_role)) {
204 return GST_AUDIO_CHANNEL_POSITION_LFE1;
206 /* Center front speakers. Center and left/right_of_center
207 * are mutually exclusive */
208 } else if (lilv_node_equals (role, center_left_role)) {
209 return GST_AUDIO_CHANNEL_POSITION_FRONT_LEFT_OF_CENTER;
210 } else if (lilv_node_equals (role, center_right_role)) {
211 return GST_AUDIO_CHANNEL_POSITION_FRONT_RIGHT_OF_CENTER;
214 } else if (lilv_node_equals (role, side_left_role)) {
215 return GST_AUDIO_CHANNEL_POSITION_SIDE_LEFT;
216 } else if (lilv_node_equals (role, side_right_role)) {
217 return GST_AUDIO_CHANNEL_POSITION_SIDE_RIGHT;
220 return GST_AUDIO_CHANNEL_POSITION_INVALID;
223 static GstAudioChannelPosition *
224 gst_lv2_filter_build_positions (GstLV2Group * group)
226 GstAudioChannelPosition *positions = NULL;
228 /* don't do anything for mono */
229 if (group->ports->len > 1) {
232 positions = g_new (GstAudioChannelPosition, group->ports->len);
233 for (i = 0; i < group->ports->len; ++i)
234 positions[i] = g_array_index (group->ports, GstLV2Port, i).position;
240 /* Find and return the group @a uri in @a groups, or NULL if not found */
242 gst_lv2_filter_type_class_add_pad_templates (GstLV2FilterClass * klass)
244 GstCaps *srccaps, *sinkcaps;
245 GstPadTemplate *pad_template;
246 GstElementClass *elem_class = GST_ELEMENT_CLASS (klass);
248 gint in_channels = 1, out_channels = 1;
250 in_channels = klass->lv2.in_group.ports->len;
252 out_channels = klass->lv2.out_group.ports->len;
254 /* FIXME Implement deintereleaved audio support */
255 sinkcaps = gst_caps_new_simple ("audio/x-raw",
256 "format", G_TYPE_STRING, GST_AUDIO_NE (F32),
257 "channels", G_TYPE_INT, in_channels,
258 "rate", GST_TYPE_INT_RANGE, 1, G_MAXINT,
259 "layout", G_TYPE_STRING, "interleaved", NULL);
261 srccaps = gst_caps_new_simple ("audio/x-raw",
262 "format", G_TYPE_STRING, GST_AUDIO_NE (F32),
263 "channels", G_TYPE_INT, out_channels,
264 "rate", GST_TYPE_INT_RANGE, 1, G_MAXINT,
265 "layout", G_TYPE_STRING, "interleaved", NULL);
268 gst_pad_template_new (GST_BASE_TRANSFORM_SINK_NAME, GST_PAD_SINK,
269 GST_PAD_ALWAYS, sinkcaps);
270 gst_element_class_add_pad_template (elem_class, pad_template);
273 gst_pad_template_new (GST_BASE_TRANSFORM_SRC_NAME, GST_PAD_SRC,
274 GST_PAD_ALWAYS, srccaps);
275 gst_element_class_add_pad_template (elem_class, pad_template);
277 gst_caps_unref (sinkcaps);
278 gst_caps_unref (srccaps);
282 gst_lv2_filter_setup (GstAudioFilter * gsp, const GstAudioInfo * info)
284 GstLV2Filter *self = (GstLV2Filter *) gsp;
286 g_return_val_if_fail (self->lv2.activated == FALSE, FALSE);
288 GST_DEBUG_OBJECT (self, "instantiating the plugin at %d Hz",
289 GST_AUDIO_INFO_RATE (info));
291 if (!gst_lv2_setup (&self->lv2, GST_AUDIO_INFO_RATE (info)))
294 /* FIXME Handle audio channel positioning while negotiating CAPS */
297 /* set input group pad audio channel position */
298 for (i = 0; i < oclass->lv2.in_groups->len; ++i) {
299 group = &g_array_index (oclass->lv2.in_groups, GstLV2Group, i);
300 if (group->has_roles) {
301 if ((positions = gst_lv2_filter_build_positions (group))) {
302 if ((pad = gst_element_get_static_pad (GST_ELEMENT (gsp),
303 lilv_node_as_string (group->symbol)))) {
304 GST_INFO_OBJECT (self, "set audio channel positions on sink pad %s",
305 lilv_node_as_string (group->symbol));
306 s = gst_caps_get_structure (caps, 0);
307 gst_audio_set_channel_positions (s, positions);
308 gst_object_unref (pad);
315 /* set output group pad audio channel position */
316 for (i = 0; i < oclass->lv2.out_groups->len; ++i) {
317 group = &g_array_index (oclass->lv2.out_groups, GstLV2Group, i);
318 if (group->has_roles) {
319 if ((positions = gst_lv2_filter_build_positions (group))) {
320 if ((pad = gst_element_get_static_pad (GST_ELEMENT (gsp),
321 lilv_node_as_string (group->symbol)))) {
322 GST_INFO_OBJECT (self, "set audio channel positions on src pad %s",
323 lilv_node_as_string (group->symbol));
324 s = gst_caps_get_structure (caps, 0);
325 gst_audio_set_channel_positions (s, positions);
326 gst_object_unref (pad);
339 GST_ERROR_OBJECT (gsp, "could not create instance");
345 gst_lv2_filter_stop (GstBaseTransform * transform)
347 GstLV2Filter *lv2 = (GstLV2Filter *) transform;
349 return gst_lv2_cleanup (&lv2->lv2, (GstObject *) lv2);
353 gst_lv2_filter_deinterleave_data (guint n_channels, gfloat * outdata,
354 guint samples, gfloat * indata)
358 for (i = 0; i < n_channels; i++)
359 for (j = 0; j < samples; j++)
360 outdata[i * samples + j] = indata[j * n_channels + i];
364 gst_lv2_filter_interleave_data (guint n_channels, gfloat * outdata,
365 guint samples, gfloat * indata)
369 for (i = 0; i < n_channels; i++)
370 for (j = 0; j < samples; j++) {
371 outdata[j * n_channels + i] = indata[i * samples + j];
376 gst_lv2_filter_transform_data (GstLV2Filter * self,
377 GstMapInfo * in_map, GstMapInfo * out_map)
379 GstLV2FilterClass *klass =
380 (GstLV2FilterClass *) GST_AUDIO_FILTER_GET_CLASS (self);
381 GstLV2Class *lv2_class = &klass->lv2;
382 GstLV2Group *lv2_group;
383 GstLV2Port *lv2_port;
384 guint j, k, l, nframes, samples, out_samples;
385 gfloat *in = NULL, *out = NULL, *cv = NULL, *mem;
388 nframes = in_map->size / sizeof (float);
390 /* multi channel inputs */
391 lv2_group = &lv2_class->in_group;
392 samples = nframes / lv2_group->ports->len;
393 GST_LOG_OBJECT (self, "in : samples=%u, nframes=%u, ports=%d", samples,
394 nframes, lv2_group->ports->len);
396 if (lv2_group->ports->len > 1) {
397 in = g_new0 (gfloat, nframes);
398 out = g_new0 (gfloat, samples * lv2_group->ports->len);
399 gst_lv2_filter_deinterleave_data (lv2_group->ports->len, in,
400 samples, (gfloat *) in_map->data);
402 in = (gfloat *) in_map->data;
403 out = (gfloat *) out_map->data;
406 for (j = 0; j < lv2_group->ports->len; ++j) {
407 lv2_port = &g_array_index (lv2_group->ports, GstLV2Port, j);
408 lilv_instance_connect_port (self->lv2.instance, lv2_port->index,
412 /* multi channel outputs */
413 lv2_group = &lv2_class->out_group;
414 out_samples = nframes / lv2_group->ports->len;
416 GST_LOG_OBJECT (self, "out: samples=%u, nframes=%u, ports=%d", out_samples,
417 nframes, lv2_group->ports->len);
418 for (j = 0; j < lv2_group->ports->len; ++j) {
419 lv2_port = &g_array_index (lv2_group->ports, GstLV2Port, j);
420 lilv_instance_connect_port (self->lv2.instance, lv2_port->index,
421 out + (j * out_samples));
425 cv = g_new (gfloat, samples * lv2_class->num_cv_in);
426 for (j = k = 0; j < lv2_class->control_in_ports->len; j++) {
427 lv2_port = &g_array_index (lv2_class->control_in_ports, GstLV2Port, j);
428 if (lv2_port->type != GST_LV2_PORT_CV)
431 mem = cv + (k * samples);
432 val = self->lv2.ports.control.in[j];
433 /* FIXME: use gst_control_binding_get_value_array */
434 for (l = 0; l < samples; l++)
436 lilv_instance_connect_port (self->lv2.instance, lv2_port->index, mem);
440 lilv_instance_run (self->lv2.instance, samples);
442 if (lv2_group->ports->len > 1) {
443 gst_lv2_filter_interleave_data (lv2_group->ports->len,
444 (gfloat *) out_map->data, out_samples, out);
454 gst_lv2_filter_transform_ip (GstBaseTransform * transform, GstBuffer * buf)
459 gst_buffer_map (buf, &map, GST_MAP_READWRITE);
461 ret = gst_lv2_filter_transform_data ((GstLV2Filter *) transform, &map, &map);
463 gst_buffer_unmap (buf, &map);
469 gst_lv2_filter_transform (GstBaseTransform * transform,
470 GstBuffer * inbuf, GstBuffer * outbuf)
472 GstMapInfo in_map, out_map;
475 gst_buffer_map (inbuf, &in_map, GST_MAP_READ);
476 gst_buffer_map (outbuf, &out_map, GST_MAP_WRITE);
478 ret = gst_lv2_filter_transform_data ((GstLV2Filter *) transform,
481 gst_buffer_unmap (inbuf, &in_map);
482 gst_buffer_unmap (outbuf, &out_map);
488 gst_lv2_filter_base_init (gpointer g_class)
490 GstLV2FilterClass *klass = (GstLV2FilterClass *) g_class;
491 GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
493 gst_lv2_class_init (&klass->lv2, G_TYPE_FROM_CLASS (klass));
495 gst_lv2_element_class_set_metadata (&klass->lv2, element_class,
496 "Filter/Effect/Audio/LV2");
498 gst_lv2_filter_type_class_add_pad_templates (klass);
502 gst_lv2_filter_base_finalize (GstLV2FilterClass * lv2_class)
504 gst_lv2_class_finalize (&lv2_class->lv2);
508 gst_lv2_filter_class_init (GstLV2FilterClass * klass)
510 GObjectClass *gobject_class = (GObjectClass *) klass;
511 GstBaseTransformClass *transform_class = GST_BASE_TRANSFORM_CLASS (klass);
512 GstAudioFilterClass *audiofilter_class = GST_AUDIO_FILTER_CLASS (klass);
514 GST_DEBUG ("class_init %p", klass);
516 gobject_class->set_property = gst_lv2_filter_set_property;
517 gobject_class->get_property = gst_lv2_filter_get_property;
518 gobject_class->finalize = gst_lv2_filter_finalize;
520 audiofilter_class->setup = gst_lv2_filter_setup;
522 transform_class->stop = gst_lv2_filter_stop;
523 transform_class->transform = gst_lv2_filter_transform;
524 transform_class->transform_ip = gst_lv2_filter_transform_ip;
526 gst_lv2_class_install_properties (&klass->lv2, gobject_class, 1);
530 gst_lv2_filter_init (GstLV2Filter * self, GstLV2FilterClass * klass)
532 gst_lv2_init (&self->lv2, &klass->lv2);
534 if (!lilv_plugin_has_feature (klass->lv2.plugin, in_place_broken_pred))
535 gst_base_transform_set_in_place (GST_BASE_TRANSFORM (self), TRUE);
539 gst_lv2_filter_register_element (GstPlugin * plugin, GstStructure * lv2_meta)
542 sizeof (GstLV2FilterClass),
543 (GBaseInitFunc) gst_lv2_filter_base_init,
544 (GBaseFinalizeFunc) gst_lv2_filter_base_finalize,
545 (GClassInitFunc) gst_lv2_filter_class_init,
548 sizeof (GstLV2Filter),
550 (GInstanceInitFunc) gst_lv2_filter_init,
552 const gchar *type_name =
553 gst_structure_get_string (lv2_meta, "element-type-name");
555 g_type_register_static (GST_TYPE_AUDIO_FILTER, type_name, &info, 0);
556 gboolean can_do_presets;
558 /* register interfaces */
559 gst_structure_get_boolean (lv2_meta, "can-do-presets", &can_do_presets);
560 if (can_do_presets) {
561 const GInterfaceInfo preset_interface_info = {
562 (GInterfaceInitFunc) gst_lv2_filter_preset_interface_init,
566 g_type_add_interface_static (element_type, GST_TYPE_PRESET,
567 &preset_interface_info);
570 gst_element_register (plugin, type_name, GST_RANK_NONE, element_type);
573 parent_class = g_type_class_ref (GST_TYPE_AUDIO_FILTER);