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.
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, nframes_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, nframes_t rate)
87 _latency_control_port = 0;
88 _was_activated = false;
90 SLV2Value persist_uri = slv2_value_new_uri(_world.world, "http://lv2plug.in/ns/ext/persist");
91 _supports_persist = slv2_plugin_has_feature(plugin, persist_uri);
92 slv2_value_free(persist_uri);
94 _instance_access_feature.URI = "http://lv2plug.in/ns/ext/instance-access";
95 _data_access_feature.URI = "http://lv2plug.in/ns/ext/data-access";
96 _persist_feature.URI = "http://lv2plug.in/ns/ext/persist";
97 _persist_feature.data = NULL;
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);
109 _author = slv2_plugin_get_author_name(plugin);
111 if (_instance == 0) {
112 error << _("LV2: Failed to instantiate plugin ") << slv2_plugin_get_uri(plugin) << endl;
113 throw failed_constructor();
116 _instance_access_feature.data = (void*)_instance->lv2_handle;
117 _data_access_extension_data.extension_data = _instance->lv2_descriptor->extension_data;
118 _data_access_feature.data = &_data_access_extension_data;
120 if (slv2_plugin_has_feature(plugin, world.in_place_broken)) {
121 error << string_compose(
122 _("LV2: \"%1\" cannot be used, since it cannot do inplace processing"),
123 slv2_value_as_string(_name));
124 slv2_value_free(_name);
125 slv2_value_free(_author);
126 throw failed_constructor();
131 const uint32_t num_ports = slv2_plugin_get_num_ports(plugin);
133 _control_data = new float[num_ports];
134 _shadow_data = new float[num_ports];
135 _defaults = new float[num_ports];
137 const bool latent = slv2_plugin_has_latency(plugin);
138 uint32_t latency_port = (latent ? slv2_plugin_get_latency_port_index(plugin) : 0);
140 for (uint32_t i = 0; i < num_ports; ++i) {
141 SLV2Port port = slv2_plugin_get_port_by_index(plugin, i);
142 SLV2Value sym = slv2_port_get_symbol(_plugin, port);
143 _port_indices.insert(std::make_pair(slv2_value_as_string(sym), i));
144 if (parameter_is_control(i)) {
146 slv2_port_get_range(plugin, port, &def, NULL, NULL);
147 _defaults[i] = def ? slv2_value_as_float(def) : 0.0f;
148 slv2_value_free(def);
150 slv2_instance_connect_port (_instance, i, &_control_data[i]);
152 if (latent && i == latency_port) {
153 _latency_control_port = &_control_data[i];
154 *_latency_control_port = 0;
157 if (parameter_is_input(i)) {
158 _shadow_data[i] = default_value (i);
165 SLV2UIs uis = slv2_plugin_get_uis(_plugin);
166 if (slv2_uis_size(uis) > 0) {
167 for (unsigned i=0; i < slv2_uis_size(uis); ++i) {
168 SLV2UI ui = slv2_uis_get_at(uis, i);
169 if (slv2_ui_is_a(ui, _world.gtk_gui)) {
175 // if gtk gui is not available, try to find external gui
177 for (unsigned i=0; i < slv2_uis_size(uis); ++i) {
178 SLV2UI ui = slv2_uis_get_at(uis, i);
179 if (slv2_ui_is_a(ui, _world.external_gui)) {
187 latency_compute_run ();
190 LV2Plugin::~LV2Plugin ()
195 slv2_instance_free(_instance);
196 slv2_value_free(_name);
197 slv2_value_free(_author);
199 delete [] _control_data;
200 delete [] _shadow_data;
204 LV2Plugin::is_external_ui() const
206 return slv2_ui_is_a(_ui, _world.external_gui);
210 LV2Plugin::unique_id() const
212 return slv2_value_as_uri(slv2_plugin_get_uri(_plugin));
217 LV2Plugin::default_value (uint32_t port)
219 return _defaults[port];
223 LV2Plugin::port_symbol (uint32_t index)
225 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, index);
227 error << name() << ": Invalid port index " << index << endmsg;
230 SLV2Value sym = slv2_port_get_symbol(_plugin, port);
231 return slv2_value_as_string(sym);
236 LV2Plugin::set_parameter (uint32_t which, float val)
238 if (which < slv2_plugin_get_num_ports(_plugin)) {
239 _shadow_data[which] = val;
240 ParameterChanged (which, val); /* EMIT SIGNAL */
243 if (which < parameter_count() && controls[which]) {
244 controls[which]->Changed ();
249 warning << string_compose (_("Illegal parameter number used with plugin \"%1\"."
250 "This is a bug in either %2 or the LV2 plugin (%3)"),
251 name(), PROGRAM_NAME, unique_id()) << endmsg;
256 LV2Plugin::get_parameter (uint32_t which) const
258 if (parameter_is_input(which)) {
259 return (float) _shadow_data[which];
261 return (float) _control_data[which];
267 LV2Plugin::nth_parameter (uint32_t n, bool& ok) const
273 for (c = 0, x = 0; x < slv2_plugin_get_num_ports(_plugin); ++x) {
274 if (parameter_is_control (x)) {
285 struct LV2Value { void* value; uint32_t type; };
286 typedef std::map< std::string, LV2Value > LV2State;
289 lv2_persist_store_callback(void* callback_data,
295 cout << "LV2 PERSIST STORE " << key << " = " << value << " :: " << type << endl;
299 LV2Plugin::get_state()
301 XMLNode *root = new XMLNode(state_node_name());
304 LocaleGuard lg (X_("POSIX"));
306 for (uint32_t i = 0; i < parameter_count(); ++i){
308 if (parameter_is_input(i) && parameter_is_control(i)) {
309 child = new XMLNode("Port");
310 /*snprintf(buf, sizeof(buf), "%u", i);
311 child->add_property("number", string(buf));*/
312 child->add_property("symbol", port_symbol(i));
313 snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
314 child->add_property("value", string(buf));
315 root->add_child_nocopy (*child);
317 /*if (i < controls.size() && controls[i]) {
318 root->add_child_nocopy (controls[i]->get_state());
323 if (_supports_persist) {
324 // Create state directory for this plugin instance
325 const std::string state_path = Glib::build_filename(_session.plugins_dir(), _id.to_s());
326 cout << "LV2 plugin state path " << state_path << endl;
328 // Get LV2 Persist extension data from plugin instance
329 LV2_Persist* persist = (LV2_Persist*)slv2_instance_get_extension_data(
330 _instance, "http://lv2plug.in/ns/ext/persist");
332 warning << string_compose(
333 _("Plugin \"%1\% failed to return LV2 persist data"),
335 return *root; // FIXME: Possibly inconsistent state
339 persist->save(_instance, lv2_persist_store_callback, &state);
345 vector<Plugin::PresetRecord>
346 LV2Plugin::get_presets()
348 vector<PresetRecord> result;
349 SLV2Results presets = slv2_plugin_query_sparql(_plugin,
350 "PREFIX lv2p: <http://lv2plug.in/ns/dev/presets#>\n"
351 "PREFIX dc: <http://dublincore.org/documents/dcmi-namespace/>\n"
352 "SELECT ?p ?name WHERE { <> lv2p:hasPreset ?p . ?p dc:title ?name }\n");
353 for (; !slv2_results_finished(presets); slv2_results_next(presets)) {
354 SLV2Value uri = slv2_results_get_binding_value(presets, 0);
355 SLV2Value name = slv2_results_get_binding_value(presets, 1);
356 PresetRecord rec(slv2_value_as_string(uri), slv2_value_as_string(name));
357 result.push_back(rec);
358 this->presets.insert(std::make_pair(slv2_value_as_string(uri), rec));
360 slv2_results_free(presets);
365 LV2Plugin::load_preset(const string& uri)
367 const string query = string(
368 "PREFIX lv2p: <http://lv2plug.in/ns/dev/presets#>\n"
369 "PREFIX dc: <http://dublincore.org/documents/dcmi-namespace/>\n"
370 "SELECT ?sym ?val WHERE { <") + uri + "> lv2:port ?port . "
371 " ?port lv2:symbol ?sym ; lv2p:value ?val . }";
372 SLV2Results values = slv2_plugin_query_sparql(_plugin, query.c_str());
373 for (; !slv2_results_finished(values); slv2_results_next(values)) {
374 SLV2Value sym = slv2_results_get_binding_value(values, 0);
375 SLV2Value val = slv2_results_get_binding_value(values, 1);
376 if (slv2_value_is_float(val)) {
377 uint32_t index = _port_indices[slv2_value_as_string(sym)];
378 set_parameter(index, slv2_value_as_float(val));
381 slv2_results_free(values);
386 LV2Plugin::save_preset (string /*name*/)
392 LV2Plugin::has_editor() const
394 return (_ui != NULL);
398 LV2Plugin::set_state(const XMLNode& node, int version)
402 XMLNodeConstIterator iter;
407 LocaleGuard lg (X_("POSIX"));
409 if (node.name() != state_node_name()) {
410 error << _("Bad node sent to LV2Plugin::set_state") << endmsg;
415 nodes = node.children ("port");
417 nodes = node.children ("Port");
420 for (iter = nodes.begin(); iter != nodes.end(); ++iter){
424 if ((prop = child->property("symbol")) != 0) {
425 sym = prop->value().c_str();
427 warning << _("LV2: port has no symbol, ignored") << endmsg;
431 map<string,uint32_t>::iterator i = _port_indices.find(sym);
433 if (i != _port_indices.end()) {
436 warning << _("LV2: port has unknown index, ignored") << endmsg;
440 if ((prop = child->property("value")) != 0) {
441 value = prop->value().c_str();
443 warning << _("LV2: port has no value, ignored") << endmsg;
447 set_parameter (port_id, atof(value));
450 latency_compute_run ();
456 LV2Plugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
458 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, which);
460 SLV2Value def, min, max;
461 slv2_port_get_range(_plugin, port, &def, &min, &max);
463 desc.integer_step = slv2_port_has_property(_plugin, port, _world.integer);
464 desc.toggled = slv2_port_has_property(_plugin, port, _world.toggled);
465 desc.logarithmic = slv2_port_has_property(_plugin, port, _world.logarithmic);
466 desc.sr_dependent = slv2_port_has_property(_plugin, port, _world.srate);
467 desc.label = slv2_value_as_string(slv2_port_get_name(_plugin, port));
468 desc.lower = min ? slv2_value_as_float(min) : 0.0f;
469 desc.upper = max ? slv2_value_as_float(max) : 1.0f;
470 desc.min_unbound = false; // TODO (LV2 extension)
471 desc.max_unbound = false; // TODO (LV2 extension)
473 if (desc.integer_step) {
475 desc.smallstep = 0.1;
476 desc.largestep = 10.0;
478 const float delta = desc.upper - desc.lower;
479 desc.step = delta / 1000.0f;
480 desc.smallstep = delta / 10000.0f;
481 desc.largestep = delta/10.0f;
484 slv2_value_free(def);
485 slv2_value_free(min);
486 slv2_value_free(max);
493 LV2Plugin::describe_parameter (Evoral::Parameter which)
495 if (which.type() == PluginAutomation && which.id() < parameter_count()) {
496 SLV2Value name = slv2_port_get_name(_plugin,
497 slv2_plugin_get_port_by_index(_plugin, which));
498 string ret(slv2_value_as_string(name));
499 slv2_value_free(name);
507 LV2Plugin::signal_latency () const
509 if (_latency_control_port) {
510 return (nframes_t) floor (*_latency_control_port);
516 set<Evoral::Parameter>
517 LV2Plugin::automatable () const
519 set<Evoral::Parameter> ret;
521 for (uint32_t i = 0; i < parameter_count(); ++i){
522 if (parameter_is_input(i) && parameter_is_control(i)) {
523 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
531 LV2Plugin::connect_and_run (BufferSet& bufs,
532 ChanMapping in_map, ChanMapping out_map,
533 nframes_t nframes, nframes_t offset)
535 cycles_t then = get_cycles ();
537 uint32_t audio_in_index = 0;
538 uint32_t audio_out_index = 0;
539 uint32_t midi_in_index = 0;
540 uint32_t midi_out_index = 0;
541 for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
542 if (parameter_is_audio(port_index)) {
543 if (parameter_is_input(port_index)) {
544 const uint32_t buf_index = in_map.get(DataType::AUDIO, audio_in_index++);
545 //cerr << port_index << " : " << " AUDIO IN " << buf_index << endl;
546 slv2_instance_connect_port(_instance, port_index,
547 bufs.get_audio(buf_index).data(offset));
548 } else if (parameter_is_output(port_index)) {
549 const uint32_t buf_index = out_map.get(DataType::AUDIO, audio_out_index++);
550 //cerr << port_index << " : " << " AUDIO OUT " << buf_index << endl;
551 slv2_instance_connect_port(_instance, port_index,
552 bufs.get_audio(buf_index).data(offset));
554 } else if (parameter_is_midi(port_index)) {
555 if (parameter_is_input(port_index)) {
556 const uint32_t buf_index = in_map.get(DataType::MIDI, midi_in_index++);
557 //cerr << port_index << " : " << " MIDI IN " << buf_index << endl;
558 slv2_instance_connect_port(_instance, port_index,
559 bufs.get_lv2_midi(true, buf_index).data());
560 } else if (parameter_is_output(port_index)) {
561 const uint32_t buf_index = out_map.get(DataType::MIDI, midi_out_index++);
562 //cerr << port_index << " : " << " MIDI OUT " << buf_index << endl;
563 slv2_instance_connect_port(_instance, port_index,
564 bufs.get_lv2_midi(false, buf_index).data());
566 } else if (!parameter_is_control(port_index)) {
567 // Optional port (it'd better be if we've made it this far...)
568 slv2_instance_connect_port(_instance, port_index, NULL);
575 for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
576 if (parameter_is_midi(port_index) && parameter_is_output(port_index)) {
577 const uint32_t buf_index = out_map.get(DataType::MIDI, midi_out_index++);
578 bufs.flush_lv2_midi(true, buf_index);
582 cycles_t now = get_cycles ();
583 set_cycles ((uint32_t) (now - then));
589 LV2Plugin::parameter_is_control (uint32_t param) const
591 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
592 return slv2_port_is_a(_plugin, port, _world.control_class);
596 LV2Plugin::parameter_is_audio (uint32_t param) const
598 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
599 return slv2_port_is_a(_plugin, port, _world.audio_class);
603 LV2Plugin::parameter_is_midi (uint32_t param) const
605 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
606 return slv2_port_is_a(_plugin, port, _world.event_class);
607 // && slv2_port_supports_event(_plugin, port, _world.midi_class);
611 LV2Plugin::parameter_is_output (uint32_t param) const
613 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
614 return slv2_port_is_a(_plugin, port, _world.output_class);
618 LV2Plugin::parameter_is_input (uint32_t param) const
620 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
621 return slv2_port_is_a(_plugin, port, _world.input_class);
625 LV2Plugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
628 if (param < parameter_count()) {
629 snprintf (buf, len, "%.3f", get_parameter (param));
637 LV2Plugin::run (nframes_t nframes)
639 for (uint32_t i = 0; i < parameter_count(); ++i) {
640 if (parameter_is_control(i) && parameter_is_input(i)) {
641 _control_data[i] = _shadow_data[i];
645 slv2_instance_run(_instance, nframes);
649 LV2Plugin::latency_compute_run ()
651 if (!_latency_control_port) {
655 /* we need to run the plugin so that it can set its latency
661 uint32_t port_index = 0;
662 uint32_t in_index = 0;
663 uint32_t out_index = 0;
664 const nframes_t bufsize = 1024;
665 float buffer[bufsize];
667 memset(buffer,0,sizeof(float)*bufsize);
669 /* Note that we've already required that plugins
670 be able to handle in-place processing.
675 while (port_index < parameter_count()) {
676 if (parameter_is_audio (port_index)) {
677 if (parameter_is_input (port_index)) {
678 slv2_instance_connect_port (_instance, port_index, buffer);
680 } else if (parameter_is_output (port_index)) {
681 slv2_instance_connect_port (_instance, port_index, buffer);
693 : world(slv2_world_new())
695 slv2_world_load_all(world);
696 input_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_INPUT);
697 output_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_OUTPUT);
698 control_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_CONTROL);
699 audio_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_AUDIO);
700 event_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_EVENT);
701 midi_class = slv2_value_new_uri(world, SLV2_EVENT_CLASS_MIDI);
702 in_place_broken = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "inPlaceBroken");
703 integer = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "integer");
704 toggled = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "toggled");
705 srate = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "sampleRate");
706 gtk_gui = slv2_value_new_uri(world, "http://lv2plug.in/ns/extensions/ui#GtkUI");
707 external_gui = slv2_value_new_uri(world, "http://lv2plug.in/ns/extensions/ui#external");
708 logarithmic = slv2_value_new_uri(world, "http://lv2plug.in/ns/dev/extportinfo#logarithmic");
711 LV2World::~LV2World()
713 slv2_value_free(input_class);
714 slv2_value_free(output_class);
715 slv2_value_free(control_class);
716 slv2_value_free(audio_class);
717 slv2_value_free(event_class);
718 slv2_value_free(midi_class);
719 slv2_value_free(in_place_broken);
722 LV2PluginInfo::LV2PluginInfo (void* lv2_world, void* slv2_plugin)
723 : _lv2_world(lv2_world)
724 , _slv2_plugin(slv2_plugin)
729 LV2PluginInfo::~LV2PluginInfo()
734 LV2PluginInfo::load (Session& session)
739 plugin.reset (new LV2Plugin (session.engine(), session,
740 *(LV2World*)_lv2_world, (SLV2Plugin)_slv2_plugin, session.frame_rate()));
742 plugin->set_info(PluginInfoPtr(new LV2PluginInfo(*this)));
746 catch (failed_constructor &err) {
747 return PluginPtr ((Plugin*) 0);
754 LV2PluginInfo::discover (void* lv2_world)
756 PluginInfoList* plugs = new PluginInfoList;
758 LV2World* world = (LV2World*)lv2_world;
759 SLV2Plugins plugins = slv2_world_get_all_plugins(world->world);
761 cerr << "LV2: Discovering " << slv2_plugins_size (plugins) << " plugins" << endl;
763 for (unsigned i=0; i < slv2_plugins_size(plugins); ++i) {
764 SLV2Plugin p = slv2_plugins_get_at(plugins, i);
765 LV2PluginInfoPtr info (new LV2PluginInfo(lv2_world, p));
767 SLV2Value name = slv2_plugin_get_name(p);
770 cerr << "LV2: invalid plugin\n";
776 info->name = string(slv2_value_as_string(name));
777 slv2_value_free(name);
779 SLV2PluginClass pclass = slv2_plugin_get_class(p);
780 SLV2Value label = slv2_plugin_class_get_label(pclass);
781 info->category = slv2_value_as_string(label);
783 SLV2Value author_name = slv2_plugin_get_author_name(p);
784 info->creator = author_name ? string(slv2_value_as_string(author_name)) : "Unknown";
785 slv2_value_free(author_name);
787 info->path = "/NOPATH"; // Meaningless for LV2
789 info->n_inputs.set_audio(slv2_plugin_get_num_ports_of_class(p,
790 world->input_class, world->audio_class, NULL));
791 info->n_inputs.set_midi(slv2_plugin_get_num_ports_of_class(p,
792 world->input_class, world->event_class, NULL));
794 info->n_outputs.set_audio(slv2_plugin_get_num_ports_of_class(p,
795 world->output_class, world->audio_class, NULL));
796 info->n_outputs.set_midi(slv2_plugin_get_num_ports_of_class(p,
797 world->output_class, world->event_class, NULL));
799 info->unique_id = slv2_value_as_uri(slv2_plugin_get_uri(p));
800 info->index = 0; // Meaningless for LV2
802 plugs->push_back (info);
805 cerr << "Done LV2 discovery" << endl;