2 Copyright (C) 2008 Paul Davis
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program 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
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28 #include <pbd/compose.h>
29 #include <pbd/error.h>
30 #include <pbd/pathscanner.h>
31 #include <pbd/xml++.h>
33 #include <ardour/ardour.h>
34 #include <ardour/session.h>
35 #include <ardour/audioengine.h>
36 #include <ardour/audio_buffer.h>
37 #include <ardour/lv2_plugin.h>
39 #include <pbd/stl_delete.h>
45 using namespace ARDOUR;
48 LV2Plugin::LV2Plugin (AudioEngine& e, Session& session, LV2World& world, SLV2Plugin plugin, nframes_t rate)
53 init (world, plugin, rate);
56 LV2Plugin::LV2Plugin (const LV2Plugin &other)
58 , _world(other._world)
61 init (other._world, other._plugin, other._sample_rate);
63 for (uint32_t i = 0; i < parameter_count(); ++i) {
64 _control_data[i] = other._shadow_data[i];
65 _shadow_data[i] = other._shadow_data[i];
70 LV2Plugin::init (LV2World& world, SLV2Plugin plugin, nframes_t rate)
77 _latency_control_port = 0;
78 _was_activated = false;
80 _instance = slv2_plugin_instantiate(plugin, rate, _features);
81 _name = slv2_plugin_get_name(plugin);
83 _author = slv2_plugin_get_author_name(plugin);
86 error << _("LV2: Failed to instantiate plugin ") << slv2_plugin_get_uri(plugin) << endl;
87 throw failed_constructor();
90 if (slv2_plugin_has_feature(plugin, world.in_place_broken)) {
91 error << string_compose(_("LV2: \"%1\" cannot be used, since it cannot do inplace processing"),
92 slv2_value_as_string(_name));
93 slv2_value_free(_name);
94 slv2_value_free(_author);
95 throw failed_constructor();
98 _instance_access_feature.URI = "http://lv2plug.in/ns/ext/instance-access";
99 _instance_access_feature.data = (void*)_instance->lv2_handle;
101 _data_access_extension_data.extension_data = _instance->lv2_descriptor->extension_data;
102 _data_access_feature.URI = "http://lv2plug.in/ns/ext/data-access";
103 _data_access_feature.data = &_data_access_extension_data;
105 _features = (LV2_Feature**)malloc(sizeof(LV2_Feature*) * 3);
106 _features[0] = &_instance_access_feature;
107 _features[1] = &_data_access_feature;
112 const uint32_t num_ports = slv2_plugin_get_num_ports(plugin);
114 _control_data = new float[num_ports];
115 _shadow_data = new float[num_ports];
116 _defaults = new float[num_ports];
118 const bool latent = slv2_plugin_has_latency(plugin);
119 uint32_t latency_port = (latent ? slv2_plugin_get_latency_port_index(plugin) : 0);
121 for (uint32_t i = 0; i < num_ports; ++i) {
122 SLV2Port port = slv2_plugin_get_port_by_index(plugin, i);
123 SLV2Value sym = slv2_port_get_symbol(_plugin, port);
124 _port_indices.insert(std::make_pair(slv2_value_as_string(sym), i));
125 if (parameter_is_control(i)) {
127 slv2_port_get_range(plugin, port, &def, NULL, NULL);
128 _defaults[i] = def ? slv2_value_as_float(def) : 0.0f;
129 slv2_value_free(def);
131 slv2_instance_connect_port (_instance, i, &_control_data[i]);
133 if (latent && i == latency_port) {
134 _latency_control_port = &_control_data[i];
135 *_latency_control_port = 0;
138 if (parameter_is_input(i)) {
139 _shadow_data[i] = default_value (i);
146 SLV2UIs uis = slv2_plugin_get_uis(_plugin);
147 if (slv2_uis_size(uis) > 0) {
148 for (unsigned i=0; i < slv2_uis_size(uis); ++i) {
149 SLV2UI ui = slv2_uis_get_at(uis, i);
150 if (slv2_ui_is_a(ui, _world.gtk_gui)) {
157 latency_compute_run ();
160 LV2Plugin::~LV2Plugin ()
165 GoingAway (); /* EMIT SIGNAL */
167 slv2_instance_free(_instance);
168 slv2_value_free(_name);
169 slv2_value_free(_author);
171 delete [] _control_data;
172 delete [] _shadow_data;
176 LV2Plugin::unique_id() const
178 return slv2_value_as_uri(slv2_plugin_get_uri(_plugin));
183 LV2Plugin::default_value (uint32_t port)
185 return _defaults[port];
189 LV2Plugin::port_symbol (uint32_t index)
191 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, index);
193 error << name() << ": Invalid port index " << index << endmsg;
196 SLV2Value sym = slv2_port_get_symbol(_plugin, port);
197 return slv2_value_as_string(sym);
202 LV2Plugin::set_parameter (uint32_t which, float val)
204 if (which < slv2_plugin_get_num_ports(_plugin)) {
205 _shadow_data[which] = val;
207 ParameterChanged (which, val); /* EMIT SIGNAL */
209 if (which < parameter_count() && controls[which]) {
210 controls[which]->Changed ();
215 warning << string_compose (_("Illegal parameter number used with plugin \"%1\"."
216 "This is a bug in either Ardour or the LV2 plugin (%2)"),
217 name(), unique_id()) << endmsg;
222 LV2Plugin::get_parameter (uint32_t which) const
224 if (parameter_is_input(which)) {
225 return (float) _shadow_data[which];
227 return (float) _control_data[which];
233 LV2Plugin::nth_parameter (uint32_t n, bool& ok) const
239 for (c = 0, x = 0; x < slv2_plugin_get_num_ports(_plugin); ++x) {
240 if (parameter_is_control (x)) {
252 LV2Plugin::get_state()
254 XMLNode *root = new XMLNode(state_node_name());
257 LocaleGuard lg (X_("POSIX"));
259 for (uint32_t i = 0; i < parameter_count(); ++i){
261 if (parameter_is_input(i) && parameter_is_control(i)) {
262 child = new XMLNode("Port");
263 snprintf(buf, sizeof(buf), "%u", i);
264 child->add_property("number", string(buf));
265 child->add_property("symbol", port_symbol(i));
266 snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
267 child->add_property("value", string(buf));
268 root->add_child_nocopy (*child);
270 /*if (i < controls.size() && controls[i]) {
271 root->add_child_nocopy (controls[i]->get_state());
279 vector<Plugin::PresetRecord>
280 LV2Plugin::get_presets()
282 vector<PresetRecord> result;
283 SLV2Results presets = slv2_plugin_query_sparql(_plugin,
284 "PREFIX lv2p: <http://lv2plug.in/ns/dev/presets#>\n"
285 "PREFIX dc: <http://dublincore.org/documents/dcmi-namespace/>\n"
286 "SELECT ?p ?name WHERE { <> lv2p:hasPreset ?p . ?p dc:title ?name }\n");
287 for (; !slv2_results_finished(presets); slv2_results_next(presets)) {
288 SLV2Value uri = slv2_results_get_binding_value(presets, 0);
289 SLV2Value name = slv2_results_get_binding_value(presets, 1);
290 PresetRecord rec(slv2_value_as_string(uri), slv2_value_as_string(name));
291 result.push_back(rec);
292 this->presets.insert(std::make_pair(slv2_value_as_string(uri), rec));
294 slv2_results_free(presets);
299 LV2Plugin::load_preset(const string uri)
301 const string query = string(
302 "PREFIX lv2p: <http://lv2plug.in/ns/dev/presets#>\n"
303 "PREFIX dc: <http://dublincore.org/documents/dcmi-namespace/>\n"
304 "SELECT ?sym ?val WHERE { <") + uri + "> lv2:port ?port . "
305 " ?port lv2:symbol ?sym ; lv2p:value ?val . }";
306 SLV2Results values = slv2_plugin_query_sparql(_plugin, query.c_str());
307 for (; !slv2_results_finished(values); slv2_results_next(values)) {
308 SLV2Value sym = slv2_results_get_binding_value(values, 0);
309 SLV2Value val = slv2_results_get_binding_value(values, 1);
310 if (slv2_value_is_float(val)) {
311 uint32_t index = _port_indices[slv2_value_as_string(sym)];
312 set_parameter(index, slv2_value_as_float(val));
315 slv2_results_free(values);
320 LV2Plugin::save_preset (string name)
326 LV2Plugin::has_editor() const
328 return (_ui != NULL);
332 LV2Plugin::set_state(const XMLNode& node)
336 XMLNodeConstIterator iter;
341 LocaleGuard lg (X_("POSIX"));
343 if (node.name() != state_node_name()) {
344 error << _("Bad node sent to LV2Plugin::set_state") << endmsg;
348 nodes = node.children ("Port");
350 for(iter = nodes.begin(); iter != nodes.end(); ++iter){
354 if ((prop = child->property("number")) != 0) {
355 port = prop->value().c_str();
357 warning << _("LV2: no lv2 port number") << endmsg;
361 if ((prop = child->property("value")) != 0) {
362 data = prop->value().c_str();
364 warning << _("LV2: no lv2 port data") << endmsg;
368 sscanf (port, "%" PRIu32, &port_id);
369 set_parameter (port_id, atof(data));
372 latency_compute_run ();
378 LV2Plugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
380 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, which);
382 SLV2Value def, min, max;
383 slv2_port_get_range(_plugin, port, &def, &min, &max);
385 desc.integer_step = slv2_port_has_property(_plugin, port, _world.integer);
386 desc.toggled = slv2_port_has_property(_plugin, port, _world.toggled);
387 desc.logarithmic = false; // TODO (LV2 extension)
388 desc.sr_dependent = slv2_port_has_property(_plugin, port, _world.srate);
389 desc.label = slv2_value_as_string(slv2_port_get_name(_plugin, port));
390 desc.lower = min ? slv2_value_as_float(min) : 0.0f;
391 desc.upper = max ? slv2_value_as_float(max) : 1.0f;
392 desc.min_unbound = false; // TODO (LV2 extension)
393 desc.max_unbound = false; // TODO (LV2 extension)
395 if (desc.integer_step) {
397 desc.smallstep = 0.1;
398 desc.largestep = 10.0;
400 const float delta = desc.upper - desc.lower;
401 desc.step = delta / 1000.0f;
402 desc.smallstep = delta / 10000.0f;
403 desc.largestep = delta/10.0f;
406 slv2_value_free(def);
407 slv2_value_free(min);
408 slv2_value_free(max);
415 LV2Plugin::describe_parameter (Evoral::Parameter which)
417 if (which.type() == PluginAutomation && which.id() < parameter_count()) {
418 SLV2Value name = slv2_port_get_name(_plugin,
419 slv2_plugin_get_port_by_index(_plugin, which));
420 string ret(slv2_value_as_string(name));
421 slv2_value_free(name);
429 LV2Plugin::signal_latency () const
431 if (_latency_control_port) {
432 return (nframes_t) floor (*_latency_control_port);
438 set<Evoral::Parameter>
439 LV2Plugin::automatable () const
441 set<Evoral::Parameter> ret;
443 for (uint32_t i = 0; i < parameter_count(); ++i){
444 if (parameter_is_input(i) && parameter_is_control(i)) {
445 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
453 LV2Plugin::connect_and_run (BufferSet& bufs, uint32_t& in_index, uint32_t& out_index, nframes_t nframes, nframes_t offset)
460 then = get_cycles ();
462 const uint32_t nbufs = bufs.count().n_audio();
464 while (port_index < parameter_count()) {
465 if (parameter_is_audio(port_index)) {
466 if (parameter_is_input(port_index)) {
467 const size_t index = min(in_index, nbufs - 1);
468 slv2_instance_connect_port(_instance, port_index,
469 bufs.get_audio(index).data(nframes, offset));
471 } else if (parameter_is_output(port_index)) {
472 const size_t index = min(out_index,nbufs - 1);
473 slv2_instance_connect_port(_instance, port_index,
474 bufs.get_audio(index).data(nframes, offset));
477 } else if (parameter_is_midi(port_index)) {
478 // FIXME: Switch MIDI buffer format to LV2 event buffer
479 if (parameter_is_input(port_index)) {
480 //const size_t index = min(in_index, nbufs - 1);
481 //slv2_instance_connect_port(_instance, port_index,
482 // bufs.get_midi(index).data(nframes, offset));
483 // FIXME: hope it's connection optional...
484 slv2_instance_connect_port(_instance, port_index, NULL);
486 } else if (parameter_is_output(port_index)) {
487 //const size_t index = min(out_index,nbufs - 1);
488 //slv2_instance_connect_port(_instance, port_index,
489 // bufs.get_midi(index).data(nframes, offset));
490 // FIXME: hope it's connection optional...
491 slv2_instance_connect_port(_instance, port_index, NULL);
500 set_cycles ((uint32_t) (now - then));
506 LV2Plugin::parameter_is_control (uint32_t param) const
508 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
509 return slv2_port_is_a(_plugin, port, _world.control_class);
513 LV2Plugin::parameter_is_audio (uint32_t param) const
515 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
516 return slv2_port_is_a(_plugin, port, _world.audio_class);
520 LV2Plugin::parameter_is_midi (uint32_t param) const
522 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
523 return slv2_port_is_a(_plugin, port, _world.event_class)
524 && slv2_port_supports_event(_plugin, port, _world.midi_class);
528 LV2Plugin::parameter_is_output (uint32_t param) const
530 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
531 return slv2_port_is_a(_plugin, port, _world.output_class);
535 LV2Plugin::parameter_is_input (uint32_t param) const
537 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
538 return slv2_port_is_a(_plugin, port, _world.input_class);
542 LV2Plugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
545 if (param < parameter_count()) {
546 snprintf (buf, len, "%.3f", get_parameter (param));
554 LV2Plugin::run (nframes_t nframes)
556 for (uint32_t i = 0; i < parameter_count(); ++i) {
557 if (parameter_is_control(i) && parameter_is_input(i)) {
558 _control_data[i] = _shadow_data[i];
562 slv2_instance_run(_instance, nframes);
566 LV2Plugin::latency_compute_run ()
568 if (!_latency_control_port) {
572 /* we need to run the plugin so that it can set its latency
578 uint32_t port_index = 0;
579 uint32_t in_index = 0;
580 uint32_t out_index = 0;
581 const nframes_t bufsize = 1024;
582 float buffer[bufsize];
584 memset(buffer,0,sizeof(float)*bufsize);
586 /* Note that we've already required that plugins
587 be able to handle in-place processing.
592 while (port_index < parameter_count()) {
593 if (parameter_is_audio (port_index)) {
594 if (parameter_is_input (port_index)) {
595 slv2_instance_connect_port (_instance, port_index, buffer);
597 } else if (parameter_is_output (port_index)) {
598 slv2_instance_connect_port (_instance, port_index, buffer);
610 : world(slv2_world_new())
612 slv2_world_load_all(world);
613 input_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_INPUT);
614 output_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_OUTPUT);
615 control_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_CONTROL);
616 audio_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_AUDIO);
617 event_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_EVENT);
618 midi_class = slv2_value_new_uri(world, SLV2_EVENT_CLASS_MIDI);
619 in_place_broken = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "inPlaceBroken");
620 integer = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "integer");
621 toggled = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "toggled");
622 srate = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "sampleRate");
623 gtk_gui = slv2_value_new_uri(world, "http://lv2plug.in/ns/extensions/ui#GtkUI");
626 LV2World::~LV2World()
628 slv2_value_free(input_class);
629 slv2_value_free(output_class);
630 slv2_value_free(control_class);
631 slv2_value_free(audio_class);
632 slv2_value_free(event_class);
633 slv2_value_free(midi_class);
634 slv2_value_free(in_place_broken);
637 LV2PluginInfo::LV2PluginInfo (void* lv2_world, void* slv2_plugin)
638 : _lv2_world(lv2_world)
639 , _slv2_plugin(slv2_plugin)
643 LV2PluginInfo::~LV2PluginInfo()
648 LV2PluginInfo::load (Session& session)
653 plugin.reset (new LV2Plugin (session.engine(), session,
654 *(LV2World*)_lv2_world, (SLV2Plugin)_slv2_plugin, session.frame_rate()));
656 plugin->set_info(PluginInfoPtr(new LV2PluginInfo(*this)));
660 catch (failed_constructor &err) {
661 return PluginPtr ((Plugin*) 0);
668 LV2PluginInfo::discover (void* lv2_world)
670 PluginInfoList plugs;
672 LV2World* world = (LV2World*)lv2_world;
673 SLV2Plugins plugins = slv2_world_get_all_plugins(world->world);
675 for (unsigned i=0; i < slv2_plugins_size(plugins); ++i) {
676 SLV2Plugin p = slv2_plugins_get_at(plugins, i);
677 LV2PluginInfoPtr info (new LV2PluginInfo(lv2_world, p));
679 SLV2Value name = slv2_plugin_get_name(p);
680 info->name = string(slv2_value_as_string(name));
681 slv2_value_free(name);
683 SLV2PluginClass pclass = slv2_plugin_get_class(p);
684 SLV2Value label = slv2_plugin_class_get_label(pclass);
685 info->category = slv2_value_as_string(label);
687 SLV2Value author_name = slv2_plugin_get_author_name(p);
688 info->creator = author_name ? string(slv2_value_as_string(author_name)) : "Unknown";
689 slv2_value_free(author_name);
691 info->path = "/NOPATH"; // Meaningless for LV2
693 info->n_inputs.set_audio(slv2_plugin_get_num_ports_of_class(p,
694 world->input_class, world->audio_class, NULL));
695 info->n_inputs.set_midi(slv2_plugin_get_num_ports_of_class(p,
696 world->input_class, world->event_class, NULL));
698 info->n_outputs.set_audio(slv2_plugin_get_num_ports_of_class(p,
699 world->output_class, world->audio_class, NULL));
700 info->n_outputs.set_midi(slv2_plugin_get_num_ports_of_class(p,
701 world->output_class, world->event_class, NULL));
703 info->unique_id = slv2_value_as_uri(slv2_plugin_get_uri(p));
704 info->index = 0; // Meaningless for LV2
706 plugs.push_back (info);