2 Copyright (C) 2008-2010 Paul Davis
3 Author: David Robillard
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.
30 #include "pbd/compose.h"
31 #include "pbd/error.h"
32 #include "pbd/pathscanner.h"
33 #include "pbd/xml++.h"
35 #include "ardour/ardour.h"
36 #include "ardour/session.h"
37 #include "ardour/audioengine.h"
38 #include "ardour/audio_buffer.h"
39 #include "ardour/lv2_event_buffer.h"
40 #include "ardour/lv2_plugin.h"
42 #include "pbd/stl_delete.h"
47 #include "lv2ext/lv2_persist.h"
50 using namespace ARDOUR;
53 URIMap LV2Plugin::_uri_map;
54 uint32_t LV2Plugin::_midi_event_type = _uri_map.uri_to_id(
55 "http://lv2plug.in/ns/ext/event",
56 "http://lv2plug.in/ns/ext/midi#MidiEvent");
58 LV2Plugin::LV2Plugin (AudioEngine& e, Session& session, LV2World& world, SLV2Plugin plugin, framecnt_t rate)
63 init (world, plugin, rate);
66 LV2Plugin::LV2Plugin (const LV2Plugin &other)
68 , _world(other._world)
71 init (other._world, other._plugin, other._sample_rate);
73 for (uint32_t i = 0; i < parameter_count(); ++i) {
74 _control_data[i] = other._shadow_data[i];
75 _shadow_data[i] = other._shadow_data[i];
80 LV2Plugin::init (LV2World& world, SLV2Plugin plugin, framecnt_t rate)
87 _latency_control_port = 0;
88 _was_activated = false;
90 _instance_access_feature.URI = "http://lv2plug.in/ns/ext/instance-access";
91 _data_access_feature.URI = "http://lv2plug.in/ns/ext/data-access";
92 _persist_feature.URI = "http://lv2plug.in/ns/ext/persist";
93 _persist_feature.data = NULL;
95 SLV2Value persist_uri = slv2_value_new_uri(_world.world, _persist_feature.URI);
96 _supports_persist = slv2_plugin_has_feature(plugin, persist_uri);
97 slv2_value_free(persist_uri);
99 _features = (LV2_Feature**)malloc(sizeof(LV2_Feature*) * 5);
100 _features[0] = &_instance_access_feature;
101 _features[1] = &_data_access_feature;
102 _features[2] = &_persist_feature;
103 _features[3] = _uri_map.feature();
106 _instance = slv2_plugin_instantiate(plugin, rate, _features);
107 _name = slv2_plugin_get_name(plugin);
108 _author = slv2_plugin_get_author_name(plugin);
110 if (_instance == 0) {
111 error << _("LV2: Failed to instantiate plugin ") << slv2_plugin_get_uri(plugin) << endl;
112 throw failed_constructor();
115 _instance_access_feature.data = (void*)_instance->lv2_handle;
116 _data_access_extension_data.extension_data = _instance->lv2_descriptor->extension_data;
117 _data_access_feature.data = &_data_access_extension_data;
119 if (slv2_plugin_has_feature(plugin, world.in_place_broken)) {
120 error << string_compose(
121 _("LV2: \"%1\" cannot be used, since it cannot do inplace processing"),
122 slv2_value_as_string(_name));
123 slv2_value_free(_name);
124 slv2_value_free(_author);
125 throw failed_constructor();
130 const bool latent = slv2_plugin_has_latency(plugin);
131 uint32_t latency_port = (latent ? slv2_plugin_get_latency_port_index(plugin) : 0);
132 const uint32_t num_ports = slv2_plugin_get_num_ports(plugin);
134 _control_data = new float[num_ports];
135 _shadow_data = new float[num_ports];
136 _defaults = new float[num_ports];
138 for (uint32_t i = 0; i < num_ports; ++i) {
139 SLV2Port port = slv2_plugin_get_port_by_index(plugin, i);
140 SLV2Value sym = slv2_port_get_symbol(_plugin, port);
141 _port_indices.insert(std::make_pair(slv2_value_as_string(sym), i));
142 if (parameter_is_control(i)) {
144 slv2_port_get_range(plugin, port, &def, NULL, NULL);
145 _defaults[i] = def ? slv2_value_as_float(def) : 0.0f;
146 slv2_value_free(def);
148 slv2_instance_connect_port (_instance, i, &_control_data[i]);
150 if (latent && i == latency_port) {
151 _latency_control_port = &_control_data[i];
152 *_latency_control_port = 0;
155 if (parameter_is_input(i)) {
156 _shadow_data[i] = default_value (i);
163 SLV2UIs uis = slv2_plugin_get_uis(_plugin);
164 if (slv2_uis_size(uis) > 0) {
165 for (unsigned i=0; i < slv2_uis_size(uis); ++i) {
166 SLV2UI ui = slv2_uis_get_at(uis, i);
167 if (slv2_ui_is_a(ui, _world.gtk_gui)) {
173 // if gtk gui is not available, try to find external gui
175 for (unsigned i=0; i < slv2_uis_size(uis); ++i) {
176 SLV2UI ui = slv2_uis_get_at(uis, i);
177 if (slv2_ui_is_a(ui, _world.external_gui)) {
185 latency_compute_run ();
188 LV2Plugin::~LV2Plugin ()
193 slv2_instance_free(_instance);
194 slv2_value_free(_name);
195 slv2_value_free(_author);
197 delete [] _control_data;
198 delete [] _shadow_data;
202 LV2Plugin::is_external_ui() const
204 return slv2_ui_is_a(_ui, _world.external_gui);
208 LV2Plugin::unique_id() const
210 return slv2_value_as_uri(slv2_plugin_get_uri(_plugin));
215 LV2Plugin::default_value (uint32_t port)
217 return _defaults[port];
221 LV2Plugin::port_symbol (uint32_t index)
223 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, index);
225 error << name() << ": Invalid port index " << index << endmsg;
228 SLV2Value sym = slv2_port_get_symbol(_plugin, port);
229 return slv2_value_as_string(sym);
234 LV2Plugin::set_parameter (uint32_t which, float val)
236 if (which < slv2_plugin_get_num_ports(_plugin)) {
237 _shadow_data[which] = val;
238 ParameterChanged (which, val); /* EMIT SIGNAL */
241 if (which < parameter_count() && controls[which]) {
242 controls[which]->Changed ();
247 warning << string_compose (_("Illegal parameter number used with plugin \"%1\"."
248 "This is a bug in either %2 or the LV2 plugin (%3)"),
249 name(), PROGRAM_NAME, unique_id()) << endmsg;
254 LV2Plugin::get_parameter (uint32_t which) const
256 if (parameter_is_input(which)) {
257 return (float) _shadow_data[which];
259 return (float) _control_data[which];
265 LV2Plugin::nth_parameter (uint32_t n, bool& ok) const
271 for (c = 0, x = 0; x < slv2_plugin_get_num_ports(_plugin); ++x) {
272 if (parameter_is_control (x)) {
283 struct LV2Value { void* value; uint32_t type; };
284 typedef std::map< std::string, LV2Value > LV2State;
287 lv2_persist_store_callback(void* callback_data,
293 cout << "LV2 PERSIST STORE " << key << " = " << value << " :: " << type << endl;
297 LV2Plugin::get_state()
299 XMLNode *root = new XMLNode(state_node_name());
302 LocaleGuard lg (X_("POSIX"));
304 for (uint32_t i = 0; i < parameter_count(); ++i){
306 if (parameter_is_input(i) && parameter_is_control(i)) {
307 child = new XMLNode("Port");
308 /*snprintf(buf, sizeof(buf), "%u", i);
309 child->add_property("number", string(buf));*/
310 child->add_property("symbol", port_symbol(i));
311 snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
312 child->add_property("value", string(buf));
313 root->add_child_nocopy (*child);
315 /*if (i < controls.size() && controls[i]) {
316 root->add_child_nocopy (controls[i]->get_state());
321 if (_supports_persist) {
322 // Create state directory for this plugin instance
323 const std::string state_path = Glib::build_filename(_session.plugins_dir(), _id.to_s());
324 cout << "LV2 plugin state path " << state_path << endl;
326 // Get LV2 Persist extension data from plugin instance
327 LV2_Persist* persist = (LV2_Persist*)slv2_instance_get_extension_data(
328 _instance, "http://lv2plug.in/ns/ext/persist");
330 warning << string_compose(
331 _("Plugin \"%1\% failed to return LV2 persist data"),
333 return *root; // FIXME: Possibly inconsistent state
337 persist->save(_instance->lv2_handle, lv2_persist_store_callback, &state);
343 vector<Plugin::PresetRecord>
344 LV2Plugin::get_presets()
346 vector<PresetRecord> result;
347 SLV2Results presets = slv2_plugin_query_sparql(_plugin,
348 "PREFIX lv2p: <http://lv2plug.in/ns/dev/presets#>\n"
349 "PREFIX dc: <http://dublincore.org/documents/dcmi-namespace/>\n"
350 "SELECT ?p ?name WHERE { <> lv2p:hasPreset ?p . ?p dc:title ?name }\n");
351 for (; !slv2_results_finished(presets); slv2_results_next(presets)) {
352 SLV2Value uri = slv2_results_get_binding_value(presets, 0);
353 SLV2Value name = slv2_results_get_binding_value(presets, 1);
354 PresetRecord rec(slv2_value_as_string(uri), slv2_value_as_string(name));
355 result.push_back(rec);
356 _presets.insert(std::make_pair(slv2_value_as_string(uri), rec));
358 slv2_results_free(presets);
363 LV2Plugin::load_preset(const string& uri)
365 const string query = string(
366 "PREFIX lv2p: <http://lv2plug.in/ns/dev/presets#>\n"
367 "PREFIX dc: <http://dublincore.org/documents/dcmi-namespace/>\n"
368 "SELECT ?sym ?val WHERE { <") + uri + "> lv2:port ?port . "
369 " ?port lv2:symbol ?sym ; lv2p:value ?val . }";
370 SLV2Results values = slv2_plugin_query_sparql(_plugin, query.c_str());
371 for (; !slv2_results_finished(values); slv2_results_next(values)) {
372 SLV2Value sym = slv2_results_get_binding_value(values, 0);
373 SLV2Value val = slv2_results_get_binding_value(values, 1);
374 if (slv2_value_is_float(val)) {
375 uint32_t index = _port_indices[slv2_value_as_string(sym)];
376 set_parameter(index, slv2_value_as_float(val));
379 slv2_results_free(values);
384 LV2Plugin::do_save_preset (string /*name*/)
390 LV2Plugin::do_remove_preset (string /*name*/)
396 LV2Plugin::has_editor() const
398 return (_ui != NULL);
402 LV2Plugin::set_state(const XMLNode& node, int version)
406 XMLNodeConstIterator iter;
411 LocaleGuard lg(X_("POSIX"));
413 if (node.name() != state_node_name()) {
414 error << _("Bad node sent to LV2Plugin::set_state") << endmsg;
419 nodes = node.children ("port");
421 nodes = node.children ("Port");
424 for (iter = nodes.begin(); iter != nodes.end(); ++iter){
428 if ((prop = child->property("symbol")) != 0) {
429 sym = prop->value().c_str();
431 warning << _("LV2: port has no symbol, ignored") << endmsg;
435 map<string,uint32_t>::iterator i = _port_indices.find(sym);
437 if (i != _port_indices.end()) {
440 warning << _("LV2: port has unknown index, ignored") << endmsg;
444 if ((prop = child->property("value")) != 0) {
445 value = prop->value().c_str();
447 warning << _("LV2: port has no value, ignored") << endmsg;
451 set_parameter (port_id, atof(value));
454 latency_compute_run ();
460 LV2Plugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
462 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, which);
464 SLV2Value def, min, max;
465 slv2_port_get_range(_plugin, port, &def, &min, &max);
467 desc.integer_step = slv2_port_has_property(_plugin, port, _world.integer);
468 desc.toggled = slv2_port_has_property(_plugin, port, _world.toggled);
469 desc.logarithmic = slv2_port_has_property(_plugin, port, _world.logarithmic);
470 desc.sr_dependent = slv2_port_has_property(_plugin, port, _world.srate);
471 desc.label = slv2_value_as_string(slv2_port_get_name(_plugin, port));
472 desc.lower = min ? slv2_value_as_float(min) : 0.0f;
473 desc.upper = max ? slv2_value_as_float(max) : 1.0f;
474 desc.min_unbound = false; // TODO: LV2 extension required
475 desc.max_unbound = false; // TODO: LV2 extension required
477 if (desc.integer_step) {
479 desc.smallstep = 0.1;
480 desc.largestep = 10.0;
482 const float delta = desc.upper - desc.lower;
483 desc.step = delta / 1000.0f;
484 desc.smallstep = delta / 10000.0f;
485 desc.largestep = delta/10.0f;
488 slv2_value_free(def);
489 slv2_value_free(min);
490 slv2_value_free(max);
497 LV2Plugin::describe_parameter (Evoral::Parameter which)
499 if (which.type() == PluginAutomation && which.id() < parameter_count()) {
500 SLV2Value name = slv2_port_get_name(_plugin,
501 slv2_plugin_get_port_by_index(_plugin, which.id()));
502 string ret(slv2_value_as_string(name));
503 slv2_value_free(name);
511 LV2Plugin::signal_latency () const
513 if (_latency_control_port) {
514 return (framecnt_t) floor (*_latency_control_port);
520 set<Evoral::Parameter>
521 LV2Plugin::automatable () const
523 set<Evoral::Parameter> ret;
525 for (uint32_t i = 0; i < parameter_count(); ++i){
526 if (parameter_is_input(i) && parameter_is_control(i)) {
527 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
535 LV2Plugin::connect_and_run (BufferSet& bufs,
536 ChanMapping in_map, ChanMapping out_map,
537 pframes_t nframes, framecnt_t offset)
539 Plugin::connect_and_run (bufs, in_map, out_map, nframes, offset);
541 cycles_t then = get_cycles ();
543 uint32_t audio_in_index = 0;
544 uint32_t audio_out_index = 0;
545 uint32_t midi_in_index = 0;
546 uint32_t midi_out_index = 0;
547 for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
548 if (parameter_is_audio(port_index)) {
549 if (parameter_is_input(port_index)) {
550 const uint32_t buf_index = in_map.get(DataType::AUDIO, audio_in_index++);
551 //cerr << port_index << " : " << " AUDIO IN " << buf_index << endl;
552 slv2_instance_connect_port(_instance, port_index,
553 bufs.get_audio(buf_index).data(offset));
554 } else if (parameter_is_output(port_index)) {
555 const uint32_t buf_index = out_map.get(DataType::AUDIO, audio_out_index++);
556 //cerr << port_index << " : " << " AUDIO OUT " << buf_index << endl;
557 slv2_instance_connect_port(_instance, port_index,
558 bufs.get_audio(buf_index).data(offset));
560 } else if (parameter_is_midi(port_index)) {
561 if (parameter_is_input(port_index)) {
562 const uint32_t buf_index = in_map.get(DataType::MIDI, midi_in_index++);
563 //cerr << port_index << " : " << " MIDI IN " << buf_index << endl;
564 slv2_instance_connect_port(_instance, port_index,
565 bufs.get_lv2_midi(true, buf_index).data());
566 } else if (parameter_is_output(port_index)) {
567 const uint32_t buf_index = out_map.get(DataType::MIDI, midi_out_index++);
568 //cerr << port_index << " : " << " MIDI OUT " << buf_index << endl;
569 slv2_instance_connect_port(_instance, port_index,
570 bufs.get_lv2_midi(false, buf_index).data());
572 } else if (!parameter_is_control(port_index)) {
573 // Optional port (it'd better be if we've made it this far...)
574 slv2_instance_connect_port(_instance, port_index, NULL);
581 for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
582 if (parameter_is_midi(port_index) && parameter_is_output(port_index)) {
583 const uint32_t buf_index = out_map.get(DataType::MIDI, midi_out_index++);
584 bufs.flush_lv2_midi(true, buf_index);
588 cycles_t now = get_cycles ();
589 set_cycles ((uint32_t) (now - then));
595 LV2Plugin::parameter_is_control (uint32_t param) const
597 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
598 return slv2_port_is_a(_plugin, port, _world.control_class);
602 LV2Plugin::parameter_is_audio (uint32_t param) const
604 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
605 return slv2_port_is_a(_plugin, port, _world.audio_class);
609 LV2Plugin::parameter_is_midi (uint32_t param) const
611 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
612 return slv2_port_is_a(_plugin, port, _world.event_class);
613 // && slv2_port_supports_event(_plugin, port, _world.midi_class);
617 LV2Plugin::parameter_is_output (uint32_t param) const
619 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
620 return slv2_port_is_a(_plugin, port, _world.output_class);
624 LV2Plugin::parameter_is_input (uint32_t param) const
626 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
627 return slv2_port_is_a(_plugin, port, _world.input_class);
631 LV2Plugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
634 if (param < parameter_count()) {
635 snprintf (buf, len, "%.3f", get_parameter (param));
643 LV2Plugin::run (pframes_t nframes)
645 for (uint32_t i = 0; i < parameter_count(); ++i) {
646 if (parameter_is_control(i) && parameter_is_input(i)) {
647 _control_data[i] = _shadow_data[i];
651 slv2_instance_run(_instance, nframes);
655 LV2Plugin::latency_compute_run ()
657 if (!_latency_control_port) {
661 /* we need to run the plugin so that it can set its latency
667 uint32_t port_index = 0;
668 uint32_t in_index = 0;
669 uint32_t out_index = 0;
671 const framecnt_t bufsize = 1024;
672 float buffer[bufsize];
674 memset(buffer, 0, sizeof(float) * bufsize);
676 // FIXME: Ensure plugins can handle in-place processing
680 while (port_index < parameter_count()) {
681 if (parameter_is_audio (port_index)) {
682 if (parameter_is_input (port_index)) {
683 slv2_instance_connect_port (_instance, port_index, buffer);
685 } else if (parameter_is_output (port_index)) {
686 slv2_instance_connect_port (_instance, port_index, buffer);
698 : world(slv2_world_new())
700 slv2_world_load_all(world);
701 input_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_INPUT);
702 output_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_OUTPUT);
703 control_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_CONTROL);
704 audio_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_AUDIO);
705 event_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_EVENT);
706 midi_class = slv2_value_new_uri(world, SLV2_EVENT_CLASS_MIDI);
707 in_place_broken = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "inPlaceBroken");
708 integer = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "integer");
709 toggled = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "toggled");
710 srate = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "sampleRate");
711 gtk_gui = slv2_value_new_uri(world, "http://lv2plug.in/ns/extensions/ui#GtkUI");
712 external_gui = slv2_value_new_uri(world, "http://lv2plug.in/ns/extensions/ui#external");
713 logarithmic = slv2_value_new_uri(world, "http://lv2plug.in/ns/dev/extportinfo#logarithmic");
716 LV2World::~LV2World()
718 slv2_value_free(input_class);
719 slv2_value_free(output_class);
720 slv2_value_free(control_class);
721 slv2_value_free(audio_class);
722 slv2_value_free(event_class);
723 slv2_value_free(midi_class);
724 slv2_value_free(in_place_broken);
727 LV2PluginInfo::LV2PluginInfo (void* lv2_world, void* slv2_plugin)
728 : _lv2_world(lv2_world)
729 , _slv2_plugin(slv2_plugin)
734 LV2PluginInfo::~LV2PluginInfo()
739 LV2PluginInfo::load (Session& session)
744 plugin.reset (new LV2Plugin (session.engine(), session,
745 *(LV2World*)_lv2_world, (SLV2Plugin)_slv2_plugin, session.frame_rate()));
747 plugin->set_info(PluginInfoPtr(new LV2PluginInfo(*this)));
751 catch (failed_constructor &err) {
752 return PluginPtr ((Plugin*) 0);
759 LV2PluginInfo::discover (void* lv2_world)
761 PluginInfoList* plugs = new PluginInfoList;
762 LV2World* world = (LV2World*)lv2_world;
763 SLV2Plugins plugins = slv2_world_get_all_plugins(world->world);
765 cerr << "LV2: Discovering " << slv2_plugins_size (plugins) << " plugins" << endl;
767 for (unsigned i=0; i < slv2_plugins_size(plugins); ++i) {
768 SLV2Plugin p = slv2_plugins_get_at(plugins, i);
769 LV2PluginInfoPtr info (new LV2PluginInfo(lv2_world, p));
771 SLV2Value name = slv2_plugin_get_name(p);
774 cerr << "LV2: invalid plugin\n";
780 info->name = string(slv2_value_as_string(name));
781 slv2_value_free(name);
783 SLV2PluginClass pclass = slv2_plugin_get_class(p);
784 SLV2Value label = slv2_plugin_class_get_label(pclass);
785 info->category = slv2_value_as_string(label);
787 SLV2Value author_name = slv2_plugin_get_author_name(p);
788 info->creator = author_name ? string(slv2_value_as_string(author_name)) : "Unknown";
789 slv2_value_free(author_name);
791 info->path = "/NOPATH"; // Meaningless for LV2
793 info->n_inputs.set_audio(slv2_plugin_get_num_ports_of_class(p,
794 world->input_class, world->audio_class, NULL));
795 info->n_inputs.set_midi(slv2_plugin_get_num_ports_of_class(p,
796 world->input_class, world->event_class, NULL));
798 info->n_outputs.set_audio(slv2_plugin_get_num_ports_of_class(p,
799 world->output_class, world->audio_class, NULL));
800 info->n_outputs.set_midi(slv2_plugin_get_num_ports_of_class(p,
801 world->output_class, world->event_class, NULL));
803 info->unique_id = slv2_value_as_uri(slv2_plugin_get_uri(p));
804 info->index = 0; // Meaningless for LV2
806 plugs->push_back (info);
809 cerr << "Done LV2 discovery" << endl;