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)) {
165 latency_compute_run ();
168 LV2Plugin::~LV2Plugin ()
173 GoingAway (); /* EMIT SIGNAL */
175 slv2_instance_free(_instance);
176 slv2_value_free(_name);
177 slv2_value_free(_author);
179 delete [] _control_data;
180 delete [] _shadow_data;
184 LV2Plugin::unique_id() const
186 return slv2_value_as_uri(slv2_plugin_get_uri(_plugin));
191 LV2Plugin::default_value (uint32_t port)
193 return _defaults[port];
197 LV2Plugin::port_symbol (uint32_t index)
199 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, index);
201 error << name() << ": Invalid port index " << index << endmsg;
204 SLV2Value sym = slv2_port_get_symbol(_plugin, port);
205 return slv2_value_as_string(sym);
210 LV2Plugin::set_parameter (uint32_t which, float val)
212 if (which < slv2_plugin_get_num_ports(_plugin)) {
213 _shadow_data[which] = val;
215 ParameterChanged (which, val); /* EMIT SIGNAL */
217 if (which < parameter_count() && controls[which]) {
218 controls[which]->Changed ();
223 warning << string_compose (_("Illegal parameter number used with plugin \"%1\"."
224 "This is a bug in either Ardour or the LV2 plugin (%2)"),
225 name(), unique_id()) << endmsg;
230 LV2Plugin::get_parameter (uint32_t which) const
232 if (parameter_is_input(which)) {
233 return (float) _shadow_data[which];
235 return (float) _control_data[which];
241 LV2Plugin::nth_parameter (uint32_t n, bool& ok) const
247 for (c = 0, x = 0; x < slv2_plugin_get_num_ports(_plugin); ++x) {
248 if (parameter_is_control (x)) {
260 LV2Plugin::get_state()
262 XMLNode *root = new XMLNode(state_node_name());
265 LocaleGuard lg (X_("POSIX"));
267 for (uint32_t i = 0; i < parameter_count(); ++i){
269 if (parameter_is_input(i) && parameter_is_control(i)) {
270 child = new XMLNode("Port");
271 /*snprintf(buf, sizeof(buf), "%u", i);
272 child->add_property("number", string(buf));*/
273 child->add_property("symbol", port_symbol(i));
274 snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
275 child->add_property("value", string(buf));
276 root->add_child_nocopy (*child);
278 /*if (i < controls.size() && controls[i]) {
279 root->add_child_nocopy (controls[i]->get_state());
287 vector<Plugin::PresetRecord>
288 LV2Plugin::get_presets()
290 vector<PresetRecord> result;
291 SLV2Results presets = slv2_plugin_query_sparql(_plugin,
292 "PREFIX lv2p: <http://lv2plug.in/ns/dev/presets#>\n"
293 "PREFIX dc: <http://dublincore.org/documents/dcmi-namespace/>\n"
294 "SELECT ?p ?name WHERE { <> lv2p:hasPreset ?p . ?p dc:title ?name }\n");
295 for (; !slv2_results_finished(presets); slv2_results_next(presets)) {
296 SLV2Value uri = slv2_results_get_binding_value(presets, 0);
297 SLV2Value name = slv2_results_get_binding_value(presets, 1);
298 PresetRecord rec(slv2_value_as_string(uri), slv2_value_as_string(name));
299 result.push_back(rec);
300 this->presets.insert(std::make_pair(slv2_value_as_string(uri), rec));
302 slv2_results_free(presets);
307 LV2Plugin::load_preset(const string uri)
309 const string query = string(
310 "PREFIX lv2p: <http://lv2plug.in/ns/dev/presets#>\n"
311 "PREFIX dc: <http://dublincore.org/documents/dcmi-namespace/>\n"
312 "SELECT ?sym ?val WHERE { <") + uri + "> lv2:port ?port . "
313 " ?port lv2:symbol ?sym ; lv2p:value ?val . }";
314 SLV2Results values = slv2_plugin_query_sparql(_plugin, query.c_str());
315 for (; !slv2_results_finished(values); slv2_results_next(values)) {
316 SLV2Value sym = slv2_results_get_binding_value(values, 0);
317 SLV2Value val = slv2_results_get_binding_value(values, 1);
318 if (slv2_value_is_float(val)) {
319 uint32_t index = _port_indices[slv2_value_as_string(sym)];
320 set_parameter(index, slv2_value_as_float(val));
323 slv2_results_free(values);
328 LV2Plugin::save_preset (string name)
334 LV2Plugin::has_editor() const
336 return (_ui != NULL);
340 LV2Plugin::set_state(const XMLNode& node)
344 XMLNodeConstIterator iter;
349 LocaleGuard lg (X_("POSIX"));
351 if (node.name() != state_node_name()) {
352 error << _("Bad node sent to LV2Plugin::set_state") << endmsg;
356 nodes = node.children ("Port");
358 for (iter = nodes.begin(); iter != nodes.end(); ++iter){
362 if ((prop = child->property("symbol")) != 0) {
363 sym = prop->value().c_str();
365 warning << _("LV2: port has no symbol, ignored") << endmsg;
369 map<string,uint32_t>::iterator i = _port_indices.find(sym);
370 if (i != _port_indices.end()) {
373 warning << _("LV2: port has unknown index, ignored") << endmsg;
377 if ((prop = child->property("value")) != 0) {
378 value = prop->value().c_str();
380 warning << _("LV2: port has no value, ignored") << endmsg;
384 set_parameter (port_id, atof(value));
387 latency_compute_run ();
393 LV2Plugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
395 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, which);
397 SLV2Value def, min, max;
398 slv2_port_get_range(_plugin, port, &def, &min, &max);
400 desc.integer_step = slv2_port_has_property(_plugin, port, _world.integer);
401 desc.toggled = slv2_port_has_property(_plugin, port, _world.toggled);
402 desc.logarithmic = false; // TODO (LV2 extension)
403 desc.sr_dependent = slv2_port_has_property(_plugin, port, _world.srate);
404 desc.label = slv2_value_as_string(slv2_port_get_name(_plugin, port));
405 desc.lower = min ? slv2_value_as_float(min) : 0.0f;
406 desc.upper = max ? slv2_value_as_float(max) : 1.0f;
407 desc.min_unbound = false; // TODO (LV2 extension)
408 desc.max_unbound = false; // TODO (LV2 extension)
410 if (desc.integer_step) {
412 desc.smallstep = 0.1;
413 desc.largestep = 10.0;
415 const float delta = desc.upper - desc.lower;
416 desc.step = delta / 1000.0f;
417 desc.smallstep = delta / 10000.0f;
418 desc.largestep = delta/10.0f;
421 slv2_value_free(def);
422 slv2_value_free(min);
423 slv2_value_free(max);
430 LV2Plugin::describe_parameter (Evoral::Parameter which)
432 if (which.type() == PluginAutomation && which.id() < parameter_count()) {
433 SLV2Value name = slv2_port_get_name(_plugin,
434 slv2_plugin_get_port_by_index(_plugin, which));
435 string ret(slv2_value_as_string(name));
436 slv2_value_free(name);
444 LV2Plugin::signal_latency () const
446 if (_latency_control_port) {
447 return (nframes_t) floor (*_latency_control_port);
453 set<Evoral::Parameter>
454 LV2Plugin::automatable () const
456 set<Evoral::Parameter> ret;
458 for (uint32_t i = 0; i < parameter_count(); ++i){
459 if (parameter_is_input(i) && parameter_is_control(i)) {
460 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
468 LV2Plugin::connect_and_run (BufferSet& bufs,
469 ChanMapping in_map, ChanMapping out_map,
470 nframes_t nframes, nframes_t offset)
472 cycles_t then = get_cycles ();
474 uint32_t audio_in_index = 0;
475 uint32_t audio_out_index = 0;
476 uint32_t midi_in_index = 0;
477 uint32_t midi_out_index = 0;
478 for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
479 if (parameter_is_audio(port_index)) {
480 if (parameter_is_input(port_index)) {
481 const uint32_t buf_index = in_map.get(DataType::AUDIO, audio_in_index++);
482 //cerr << port_index << " : " << " AUDIO IN " << buf_index << endl;
483 slv2_instance_connect_port(_instance, port_index,
484 bufs.get_audio(buf_index).data(offset));
485 } else if (parameter_is_output(port_index)) {
486 const uint32_t buf_index = out_map.get(DataType::AUDIO, audio_out_index++);
487 //cerr << port_index << " : " << " AUDIO OUT " << buf_index << endl;
488 slv2_instance_connect_port(_instance, port_index,
489 bufs.get_audio(buf_index).data(offset));
491 } else if (parameter_is_midi(port_index)) {
492 if (parameter_is_input(port_index)) {
493 const uint32_t buf_index = in_map.get(DataType::MIDI, midi_in_index++);
494 //cerr << port_index << " : " << " MIDI IN " << buf_index << endl;
495 slv2_instance_connect_port(_instance, port_index,
496 bufs.get_lv2_midi(true, buf_index).data());
497 } else if (parameter_is_output(port_index)) {
498 const uint32_t buf_index = out_map.get(DataType::MIDI, midi_out_index++);
499 //cerr << port_index << " : " << " MIDI OUT " << buf_index << endl;
500 slv2_instance_connect_port(_instance, port_index,
501 bufs.get_lv2_midi(false, buf_index).data());
503 } else if (!parameter_is_control(port_index)) {
504 // Optional port (it'd better be if we've made it this far...)
505 slv2_instance_connect_port(_instance, port_index, NULL);
512 for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
513 if (parameter_is_midi(port_index) && parameter_is_output(port_index)) {
514 const uint32_t buf_index = out_map.get(DataType::MIDI, midi_out_index++);
515 bufs.flush_lv2_midi(true, buf_index);
519 cycles_t now = get_cycles ();
520 set_cycles ((uint32_t) (now - then));
526 LV2Plugin::parameter_is_control (uint32_t param) const
528 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
529 return slv2_port_is_a(_plugin, port, _world.control_class);
533 LV2Plugin::parameter_is_audio (uint32_t param) const
535 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
536 return slv2_port_is_a(_plugin, port, _world.audio_class);
540 LV2Plugin::parameter_is_midi (uint32_t param) const
542 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
543 return slv2_port_is_a(_plugin, port, _world.event_class);
544 // && slv2_port_supports_event(_plugin, port, _world.midi_class);
548 LV2Plugin::parameter_is_output (uint32_t param) const
550 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
551 return slv2_port_is_a(_plugin, port, _world.output_class);
555 LV2Plugin::parameter_is_input (uint32_t param) const
557 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
558 return slv2_port_is_a(_plugin, port, _world.input_class);
562 LV2Plugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
565 if (param < parameter_count()) {
566 snprintf (buf, len, "%.3f", get_parameter (param));
574 LV2Plugin::run (nframes_t nframes)
576 for (uint32_t i = 0; i < parameter_count(); ++i) {
577 if (parameter_is_control(i) && parameter_is_input(i)) {
578 _control_data[i] = _shadow_data[i];
582 slv2_instance_run(_instance, nframes);
586 LV2Plugin::latency_compute_run ()
588 if (!_latency_control_port) {
592 /* we need to run the plugin so that it can set its latency
598 uint32_t port_index = 0;
599 uint32_t in_index = 0;
600 uint32_t out_index = 0;
601 const nframes_t bufsize = 1024;
602 float buffer[bufsize];
604 memset(buffer,0,sizeof(float)*bufsize);
606 /* Note that we've already required that plugins
607 be able to handle in-place processing.
612 while (port_index < parameter_count()) {
613 if (parameter_is_audio (port_index)) {
614 if (parameter_is_input (port_index)) {
615 slv2_instance_connect_port (_instance, port_index, buffer);
617 } else if (parameter_is_output (port_index)) {
618 slv2_instance_connect_port (_instance, port_index, buffer);
630 : world(slv2_world_new())
632 slv2_world_load_all(world);
633 input_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_INPUT);
634 output_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_OUTPUT);
635 control_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_CONTROL);
636 audio_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_AUDIO);
637 event_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_EVENT);
638 midi_class = slv2_value_new_uri(world, SLV2_EVENT_CLASS_MIDI);
639 in_place_broken = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "inPlaceBroken");
640 integer = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "integer");
641 toggled = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "toggled");
642 srate = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "sampleRate");
643 gtk_gui = slv2_value_new_uri(world, "http://lv2plug.in/ns/extensions/ui#GtkUI");
646 LV2World::~LV2World()
648 slv2_value_free(input_class);
649 slv2_value_free(output_class);
650 slv2_value_free(control_class);
651 slv2_value_free(audio_class);
652 slv2_value_free(event_class);
653 slv2_value_free(midi_class);
654 slv2_value_free(in_place_broken);
657 LV2PluginInfo::LV2PluginInfo (void* lv2_world, void* slv2_plugin)
658 : _lv2_world(lv2_world)
659 , _slv2_plugin(slv2_plugin)
663 LV2PluginInfo::~LV2PluginInfo()
668 LV2PluginInfo::load (Session& session)
673 plugin.reset (new LV2Plugin (session.engine(), session,
674 *(LV2World*)_lv2_world, (SLV2Plugin)_slv2_plugin, session.frame_rate()));
676 plugin->set_info(PluginInfoPtr(new LV2PluginInfo(*this)));
680 catch (failed_constructor &err) {
681 return PluginPtr ((Plugin*) 0);
688 LV2PluginInfo::discover (void* lv2_world)
690 PluginInfoList plugs;
692 LV2World* world = (LV2World*)lv2_world;
693 SLV2Plugins plugins = slv2_world_get_all_plugins(world->world);
695 cerr << "LV2: Discovered " << slv2_plugins_size (plugins) << " plugins\n";
697 for (unsigned i=0; i < slv2_plugins_size(plugins); ++i) {
698 SLV2Plugin p = slv2_plugins_get_at(plugins, i);
699 LV2PluginInfoPtr info (new LV2PluginInfo(lv2_world, p));
701 SLV2Value name = slv2_plugin_get_name(p);
702 info->name = string(slv2_value_as_string(name));
703 slv2_value_free(name);
705 SLV2PluginClass pclass = slv2_plugin_get_class(p);
706 SLV2Value label = slv2_plugin_class_get_label(pclass);
707 info->category = slv2_value_as_string(label);
709 SLV2Value author_name = slv2_plugin_get_author_name(p);
710 info->creator = author_name ? string(slv2_value_as_string(author_name)) : "Unknown";
711 slv2_value_free(author_name);
713 info->path = "/NOPATH"; // Meaningless for LV2
715 info->n_inputs.set_audio(slv2_plugin_get_num_ports_of_class(p,
716 world->input_class, world->audio_class, NULL));
717 info->n_inputs.set_midi(slv2_plugin_get_num_ports_of_class(p,
718 world->input_class, world->event_class, NULL));
720 info->n_outputs.set_audio(slv2_plugin_get_num_ports_of_class(p,
721 world->output_class, world->audio_class, NULL));
722 info->n_outputs.set_midi(slv2_plugin_get_num_ports_of_class(p,
723 world->output_class, world->event_class, NULL));
725 info->unique_id = slv2_value_as_uri(slv2_plugin_get_uri(p));
726 info->index = 0; // Meaningless for LV2
728 plugs.push_back (info);