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_event_buffer.h"
38 #include "ardour/lv2_plugin.h"
40 #include "pbd/stl_delete.h"
46 using namespace ARDOUR;
49 URIMap LV2Plugin::_uri_map;
50 uint32_t LV2Plugin::_midi_event_type = _uri_map.uri_to_id(
51 "http://lv2plug.in/ns/ext/event",
52 "http://lv2plug.in/ns/ext/midi#MidiEvent");
54 LV2Plugin::LV2Plugin (AudioEngine& e, Session& session, LV2World& world, SLV2Plugin plugin, nframes_t rate)
59 init (world, plugin, rate);
62 LV2Plugin::LV2Plugin (const LV2Plugin &other)
64 , _world(other._world)
67 init (other._world, other._plugin, other._sample_rate);
69 for (uint32_t i = 0; i < parameter_count(); ++i) {
70 _control_data[i] = other._shadow_data[i];
71 _shadow_data[i] = other._shadow_data[i];
76 LV2Plugin::init (LV2World& world, SLV2Plugin plugin, nframes_t rate)
83 _latency_control_port = 0;
84 _was_activated = false;
86 _instance = slv2_plugin_instantiate(plugin, rate, _features);
87 _name = slv2_plugin_get_name(plugin);
89 _author = slv2_plugin_get_author_name(plugin);
92 error << _("LV2: Failed to instantiate plugin ") << slv2_plugin_get_uri(plugin) << endl;
93 throw failed_constructor();
96 if (slv2_plugin_has_feature(plugin, world.in_place_broken)) {
97 error << string_compose(
98 _("LV2: \"%1\" cannot be used, since it cannot do inplace processing"),
99 slv2_value_as_string(_name));
100 slv2_value_free(_name);
101 slv2_value_free(_author);
102 throw failed_constructor();
105 _instance_access_feature.URI = "http://lv2plug.in/ns/ext/instance-access";
106 _instance_access_feature.data = (void*)_instance->lv2_handle;
108 _data_access_extension_data.extension_data = _instance->lv2_descriptor->extension_data;
109 _data_access_feature.URI = "http://lv2plug.in/ns/ext/data-access";
110 _data_access_feature.data = &_data_access_extension_data;
112 _features = (LV2_Feature**)malloc(sizeof(LV2_Feature*) * 4);
113 _features[0] = &_instance_access_feature;
114 _features[1] = &_data_access_feature;
115 _features[2] = _uri_map.feature();
120 const uint32_t num_ports = slv2_plugin_get_num_ports(plugin);
122 _control_data = new float[num_ports];
123 _shadow_data = new float[num_ports];
124 _defaults = new float[num_ports];
126 const bool latent = slv2_plugin_has_latency(plugin);
127 uint32_t latency_port = (latent ? slv2_plugin_get_latency_port_index(plugin) : 0);
129 for (uint32_t i = 0; i < num_ports; ++i) {
130 SLV2Port port = slv2_plugin_get_port_by_index(plugin, i);
131 SLV2Value sym = slv2_port_get_symbol(_plugin, port);
132 _port_indices.insert(std::make_pair(slv2_value_as_string(sym), i));
133 if (parameter_is_control(i)) {
135 slv2_port_get_range(plugin, port, &def, NULL, NULL);
136 _defaults[i] = def ? slv2_value_as_float(def) : 0.0f;
137 slv2_value_free(def);
139 slv2_instance_connect_port (_instance, i, &_control_data[i]);
141 if (latent && i == latency_port) {
142 _latency_control_port = &_control_data[i];
143 *_latency_control_port = 0;
146 if (parameter_is_input(i)) {
147 _shadow_data[i] = default_value (i);
154 SLV2UIs uis = slv2_plugin_get_uis(_plugin);
155 if (slv2_uis_size(uis) > 0) {
156 for (unsigned i=0; i < slv2_uis_size(uis); ++i) {
157 SLV2UI ui = slv2_uis_get_at(uis, i);
158 if (slv2_ui_is_a(ui, _world.gtk_gui)) {
164 // if gtk gui is not available, try to find external gui
166 for (unsigned i=0; i < slv2_uis_size(uis); ++i) {
167 SLV2UI ui = slv2_uis_get_at(uis, i);
168 if (slv2_ui_is_a(ui, _world.external_gui)) {
176 latency_compute_run ();
179 LV2Plugin::~LV2Plugin ()
184 GoingAway (); /* EMIT SIGNAL */
186 slv2_instance_free(_instance);
187 slv2_value_free(_name);
188 slv2_value_free(_author);
190 delete [] _control_data;
191 delete [] _shadow_data;
195 LV2Plugin::is_external_ui() const
197 return slv2_ui_is_a(_ui, _world.external_gui);
201 LV2Plugin::unique_id() const
203 return slv2_value_as_uri(slv2_plugin_get_uri(_plugin));
208 LV2Plugin::default_value (uint32_t port)
210 return _defaults[port];
214 LV2Plugin::port_symbol (uint32_t index)
216 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, index);
218 error << name() << ": Invalid port index " << index << endmsg;
221 SLV2Value sym = slv2_port_get_symbol(_plugin, port);
222 return slv2_value_as_string(sym);
227 LV2Plugin::set_parameter (uint32_t which, float val)
229 if (which < slv2_plugin_get_num_ports(_plugin)) {
230 _shadow_data[which] = val;
232 ParameterChanged (which, val); /* EMIT SIGNAL */
234 if (which < parameter_count() && controls[which]) {
235 controls[which]->Changed ();
240 warning << string_compose (_("Illegal parameter number used with plugin \"%1\"."
241 "This is a bug in either Ardour or the LV2 plugin (%2)"),
242 name(), unique_id()) << endmsg;
247 LV2Plugin::get_parameter (uint32_t which) const
249 if (parameter_is_input(which)) {
250 return (float) _shadow_data[which];
252 return (float) _control_data[which];
258 LV2Plugin::nth_parameter (uint32_t n, bool& ok) const
264 for (c = 0, x = 0; x < slv2_plugin_get_num_ports(_plugin); ++x) {
265 if (parameter_is_control (x)) {
277 LV2Plugin::get_state()
279 XMLNode *root = new XMLNode(state_node_name());
282 LocaleGuard lg (X_("POSIX"));
284 for (uint32_t i = 0; i < parameter_count(); ++i){
286 if (parameter_is_input(i) && parameter_is_control(i)) {
287 child = new XMLNode("Port");
288 /*snprintf(buf, sizeof(buf), "%u", i);
289 child->add_property("number", string(buf));*/
290 child->add_property("symbol", port_symbol(i));
291 snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
292 child->add_property("value", string(buf));
293 root->add_child_nocopy (*child);
295 /*if (i < controls.size() && controls[i]) {
296 root->add_child_nocopy (controls[i]->get_state());
304 vector<Plugin::PresetRecord>
305 LV2Plugin::get_presets()
307 vector<PresetRecord> result;
308 SLV2Results presets = slv2_plugin_query_sparql(_plugin,
309 "PREFIX lv2p: <http://lv2plug.in/ns/dev/presets#>\n"
310 "PREFIX dc: <http://dublincore.org/documents/dcmi-namespace/>\n"
311 "SELECT ?p ?name WHERE { <> lv2p:hasPreset ?p . ?p dc:title ?name }\n");
312 for (; !slv2_results_finished(presets); slv2_results_next(presets)) {
313 SLV2Value uri = slv2_results_get_binding_value(presets, 0);
314 SLV2Value name = slv2_results_get_binding_value(presets, 1);
315 PresetRecord rec(slv2_value_as_string(uri), slv2_value_as_string(name));
316 result.push_back(rec);
317 this->presets.insert(std::make_pair(slv2_value_as_string(uri), rec));
319 slv2_results_free(presets);
324 LV2Plugin::load_preset(const string uri)
326 const string query = string(
327 "PREFIX lv2p: <http://lv2plug.in/ns/dev/presets#>\n"
328 "PREFIX dc: <http://dublincore.org/documents/dcmi-namespace/>\n"
329 "SELECT ?sym ?val WHERE { <") + uri + "> lv2:port ?port . "
330 " ?port lv2:symbol ?sym ; lv2p:value ?val . }";
331 SLV2Results values = slv2_plugin_query_sparql(_plugin, query.c_str());
332 for (; !slv2_results_finished(values); slv2_results_next(values)) {
333 SLV2Value sym = slv2_results_get_binding_value(values, 0);
334 SLV2Value val = slv2_results_get_binding_value(values, 1);
335 if (slv2_value_is_float(val)) {
336 uint32_t index = _port_indices[slv2_value_as_string(sym)];
337 set_parameter(index, slv2_value_as_float(val));
340 slv2_results_free(values);
345 LV2Plugin::save_preset (string /*name*/)
351 LV2Plugin::has_editor() const
353 return (_ui != NULL);
357 LV2Plugin::set_state(const XMLNode& node, int version)
361 XMLNodeConstIterator iter;
366 LocaleGuard lg (X_("POSIX"));
368 if (node.name() != state_node_name()) {
369 error << _("Bad node sent to LV2Plugin::set_state") << endmsg;
373 nodes = node.children ("Port");
375 for (iter = nodes.begin(); iter != nodes.end(); ++iter){
379 if ((prop = child->property("symbol")) != 0) {
380 sym = prop->value().c_str();
382 warning << _("LV2: port has no symbol, ignored") << endmsg;
386 map<string,uint32_t>::iterator i = _port_indices.find(sym);
387 if (i != _port_indices.end()) {
390 warning << _("LV2: port has unknown index, ignored") << endmsg;
394 if ((prop = child->property("value")) != 0) {
395 value = prop->value().c_str();
397 warning << _("LV2: port has no value, ignored") << endmsg;
401 set_parameter (port_id, atof(value));
404 latency_compute_run ();
410 LV2Plugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
412 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, which);
414 SLV2Value def, min, max;
415 slv2_port_get_range(_plugin, port, &def, &min, &max);
417 desc.integer_step = slv2_port_has_property(_plugin, port, _world.integer);
418 desc.toggled = slv2_port_has_property(_plugin, port, _world.toggled);
419 desc.logarithmic = slv2_port_has_property(_plugin, port, _world.logarithmic);
420 desc.sr_dependent = slv2_port_has_property(_plugin, port, _world.srate);
421 desc.label = slv2_value_as_string(slv2_port_get_name(_plugin, port));
422 desc.lower = min ? slv2_value_as_float(min) : 0.0f;
423 desc.upper = max ? slv2_value_as_float(max) : 1.0f;
424 desc.min_unbound = false; // TODO (LV2 extension)
425 desc.max_unbound = false; // TODO (LV2 extension)
427 if (desc.integer_step) {
429 desc.smallstep = 0.1;
430 desc.largestep = 10.0;
432 const float delta = desc.upper - desc.lower;
433 desc.step = delta / 1000.0f;
434 desc.smallstep = delta / 10000.0f;
435 desc.largestep = delta/10.0f;
438 slv2_value_free(def);
439 slv2_value_free(min);
440 slv2_value_free(max);
447 LV2Plugin::describe_parameter (Evoral::Parameter which)
449 if (which.type() == PluginAutomation && which.id() < parameter_count()) {
450 SLV2Value name = slv2_port_get_name(_plugin,
451 slv2_plugin_get_port_by_index(_plugin, which));
452 string ret(slv2_value_as_string(name));
453 slv2_value_free(name);
461 LV2Plugin::signal_latency () const
463 if (_latency_control_port) {
464 return (nframes_t) floor (*_latency_control_port);
470 set<Evoral::Parameter>
471 LV2Plugin::automatable () const
473 set<Evoral::Parameter> ret;
475 for (uint32_t i = 0; i < parameter_count(); ++i){
476 if (parameter_is_input(i) && parameter_is_control(i)) {
477 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
485 LV2Plugin::connect_and_run (BufferSet& bufs,
486 ChanMapping in_map, ChanMapping out_map,
487 nframes_t nframes, nframes_t offset)
489 cycles_t then = get_cycles ();
491 uint32_t audio_in_index = 0;
492 uint32_t audio_out_index = 0;
493 uint32_t midi_in_index = 0;
494 uint32_t midi_out_index = 0;
495 for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
496 if (parameter_is_audio(port_index)) {
497 if (parameter_is_input(port_index)) {
498 const uint32_t buf_index = in_map.get(DataType::AUDIO, audio_in_index++);
499 //cerr << port_index << " : " << " AUDIO IN " << buf_index << endl;
500 slv2_instance_connect_port(_instance, port_index,
501 bufs.get_audio(buf_index).data(offset));
502 } else if (parameter_is_output(port_index)) {
503 const uint32_t buf_index = out_map.get(DataType::AUDIO, audio_out_index++);
504 //cerr << port_index << " : " << " AUDIO OUT " << buf_index << endl;
505 slv2_instance_connect_port(_instance, port_index,
506 bufs.get_audio(buf_index).data(offset));
508 } else if (parameter_is_midi(port_index)) {
509 if (parameter_is_input(port_index)) {
510 const uint32_t buf_index = in_map.get(DataType::MIDI, midi_in_index++);
511 //cerr << port_index << " : " << " MIDI IN " << buf_index << endl;
512 slv2_instance_connect_port(_instance, port_index,
513 bufs.get_lv2_midi(true, buf_index).data());
514 } else if (parameter_is_output(port_index)) {
515 const uint32_t buf_index = out_map.get(DataType::MIDI, midi_out_index++);
516 //cerr << port_index << " : " << " MIDI OUT " << buf_index << endl;
517 slv2_instance_connect_port(_instance, port_index,
518 bufs.get_lv2_midi(false, buf_index).data());
520 } else if (!parameter_is_control(port_index)) {
521 // Optional port (it'd better be if we've made it this far...)
522 slv2_instance_connect_port(_instance, port_index, NULL);
529 for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
530 if (parameter_is_midi(port_index) && parameter_is_output(port_index)) {
531 const uint32_t buf_index = out_map.get(DataType::MIDI, midi_out_index++);
532 bufs.flush_lv2_midi(true, buf_index);
536 cycles_t now = get_cycles ();
537 set_cycles ((uint32_t) (now - then));
543 LV2Plugin::parameter_is_control (uint32_t param) const
545 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
546 return slv2_port_is_a(_plugin, port, _world.control_class);
550 LV2Plugin::parameter_is_audio (uint32_t param) const
552 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
553 return slv2_port_is_a(_plugin, port, _world.audio_class);
557 LV2Plugin::parameter_is_midi (uint32_t param) const
559 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
560 return slv2_port_is_a(_plugin, port, _world.event_class);
561 // && slv2_port_supports_event(_plugin, port, _world.midi_class);
565 LV2Plugin::parameter_is_output (uint32_t param) const
567 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
568 return slv2_port_is_a(_plugin, port, _world.output_class);
572 LV2Plugin::parameter_is_input (uint32_t param) const
574 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
575 return slv2_port_is_a(_plugin, port, _world.input_class);
579 LV2Plugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
582 if (param < parameter_count()) {
583 snprintf (buf, len, "%.3f", get_parameter (param));
591 LV2Plugin::run (nframes_t nframes)
593 for (uint32_t i = 0; i < parameter_count(); ++i) {
594 if (parameter_is_control(i) && parameter_is_input(i)) {
595 _control_data[i] = _shadow_data[i];
599 slv2_instance_run(_instance, nframes);
603 LV2Plugin::latency_compute_run ()
605 if (!_latency_control_port) {
609 /* we need to run the plugin so that it can set its latency
615 uint32_t port_index = 0;
616 uint32_t in_index = 0;
617 uint32_t out_index = 0;
618 const nframes_t bufsize = 1024;
619 float buffer[bufsize];
621 memset(buffer,0,sizeof(float)*bufsize);
623 /* Note that we've already required that plugins
624 be able to handle in-place processing.
629 while (port_index < parameter_count()) {
630 if (parameter_is_audio (port_index)) {
631 if (parameter_is_input (port_index)) {
632 slv2_instance_connect_port (_instance, port_index, buffer);
634 } else if (parameter_is_output (port_index)) {
635 slv2_instance_connect_port (_instance, port_index, buffer);
647 : world(slv2_world_new())
649 slv2_world_load_all(world);
650 input_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_INPUT);
651 output_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_OUTPUT);
652 control_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_CONTROL);
653 audio_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_AUDIO);
654 event_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_EVENT);
655 midi_class = slv2_value_new_uri(world, SLV2_EVENT_CLASS_MIDI);
656 in_place_broken = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "inPlaceBroken");
657 integer = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "integer");
658 toggled = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "toggled");
659 srate = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "sampleRate");
660 gtk_gui = slv2_value_new_uri(world, "http://lv2plug.in/ns/extensions/ui#GtkUI");
661 external_gui = slv2_value_new_uri(world, "http://lv2plug.in/ns/extensions/ui#external");
662 logarithmic = slv2_value_new_uri(world, "http://lv2plug.in/ns/dev/extportinfo#logarithmic");
665 LV2World::~LV2World()
667 slv2_value_free(input_class);
668 slv2_value_free(output_class);
669 slv2_value_free(control_class);
670 slv2_value_free(audio_class);
671 slv2_value_free(event_class);
672 slv2_value_free(midi_class);
673 slv2_value_free(in_place_broken);
676 LV2PluginInfo::LV2PluginInfo (void* lv2_world, void* slv2_plugin)
677 : _lv2_world(lv2_world)
678 , _slv2_plugin(slv2_plugin)
682 LV2PluginInfo::~LV2PluginInfo()
687 LV2PluginInfo::load (Session& session)
692 plugin.reset (new LV2Plugin (session.engine(), session,
693 *(LV2World*)_lv2_world, (SLV2Plugin)_slv2_plugin, session.frame_rate()));
695 plugin->set_info(PluginInfoPtr(new LV2PluginInfo(*this)));
699 catch (failed_constructor &err) {
700 return PluginPtr ((Plugin*) 0);
707 LV2PluginInfo::discover (void* lv2_world)
709 PluginInfoList plugs;
711 LV2World* world = (LV2World*)lv2_world;
712 SLV2Plugins plugins = slv2_world_get_all_plugins(world->world);
714 cerr << "LV2: Discovered " << slv2_plugins_size (plugins) << " plugins\n";
716 for (unsigned i=0; i < slv2_plugins_size(plugins); ++i) {
717 SLV2Plugin p = slv2_plugins_get_at(plugins, i);
718 LV2PluginInfoPtr info (new LV2PluginInfo(lv2_world, p));
720 SLV2Value name = slv2_plugin_get_name(p);
723 cerr << "LV2: invalid plugin\n";
727 info->name = string(slv2_value_as_string(name));
728 slv2_value_free(name);
730 SLV2PluginClass pclass = slv2_plugin_get_class(p);
731 SLV2Value label = slv2_plugin_class_get_label(pclass);
732 info->category = slv2_value_as_string(label);
734 SLV2Value author_name = slv2_plugin_get_author_name(p);
735 info->creator = author_name ? string(slv2_value_as_string(author_name)) : "Unknown";
736 slv2_value_free(author_name);
738 info->path = "/NOPATH"; // Meaningless for LV2
740 info->n_inputs.set_audio(slv2_plugin_get_num_ports_of_class(p,
741 world->input_class, world->audio_class, NULL));
742 info->n_inputs.set_midi(slv2_plugin_get_num_ports_of_class(p,
743 world->input_class, world->event_class, NULL));
745 info->n_outputs.set_audio(slv2_plugin_get_num_ports_of_class(p,
746 world->output_class, world->audio_class, NULL));
747 info->n_outputs.set_midi(slv2_plugin_get_num_ports_of_class(p,
748 world->output_class, world->event_class, NULL));
750 info->unique_id = slv2_value_as_uri(slv2_plugin_get_uri(p));
751 info->index = 0; // Meaningless for LV2
753 plugs.push_back (info);