2 Copyright (C) 2008-2011 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 <boost/utility.hpp>
32 #include "pbd/compose.h"
33 #include "pbd/error.h"
34 #include "pbd/pathscanner.h"
35 #include "pbd/stl_delete.h"
36 #include "pbd/xml++.h"
38 #include "libardour-config.h"
40 #include "ardour/ardour.h"
41 #include "ardour/audio_buffer.h"
42 #include "ardour/audioengine.h"
43 #include "ardour/debug.h"
44 #include "ardour/lv2_event_buffer.h"
45 #include "ardour/lv2_plugin.h"
46 #include "ardour/session.h"
51 #include <slv2/slv2.h>
53 #include "lv2ext/lv2_files.h"
54 #include "lv2ext/lv2_persist.h"
57 #include <suil/suil.h>
60 #define NS_DC "http://dublincore.org/documents/dcmi-namespace/"
61 #define NS_LV2 "http://lv2plug.in/ns/lv2core#"
62 #define NS_PSET "http://lv2plug.in/ns/dev/presets#"
63 #define NS_UI "http://lv2plug.in/ns/extensions/ui#"
66 using namespace ARDOUR;
69 URIMap LV2Plugin::_uri_map;
70 uint32_t LV2Plugin::_midi_event_type = _uri_map.uri_to_id(
71 "http://lv2plug.in/ns/ext/event",
72 "http://lv2plug.in/ns/ext/midi#MidiEvent");
74 class LV2World : boost::noncopyable {
80 SLV2Value input_class; ///< Input port
81 SLV2Value output_class; ///< Output port
82 SLV2Value audio_class; ///< Audio port
83 SLV2Value control_class; ///< Control port
84 SLV2Value event_class; ///< Event port
85 SLV2Value midi_class; ///< MIDI event
86 SLV2Value in_place_broken;
91 SLV2Value external_gui;
92 SLV2Value logarithmic;
95 static LV2World _world;
97 struct LV2Plugin::Impl {
98 Impl() : plugin(0), ui(0), ui_type(0), name(0), author(0), instance(0) {}
104 SLV2Instance instance;
107 LV2Plugin::LV2Plugin (AudioEngine& engine,
111 : Plugin(engine, session)
116 init(c_plugin, rate);
119 LV2Plugin::LV2Plugin (const LV2Plugin& other)
123 , _insert_id(other._insert_id)
125 init(other._impl->plugin, other._sample_rate);
127 for (uint32_t i = 0; i < parameter_count(); ++i) {
128 _control_data[i] = other._shadow_data[i];
129 _shadow_data[i] = other._shadow_data[i];
134 LV2Plugin::init(void* c_plugin, framecnt_t rate)
136 DEBUG_TRACE(DEBUG::LV2, "init\n");
138 _impl->plugin = (SLV2Plugin)c_plugin;
140 _impl->ui_type = NULL;
143 _latency_control_port = 0;
144 _was_activated = false;
146 _instance_access_feature.URI = "http://lv2plug.in/ns/ext/instance-access";
147 _data_access_feature.URI = "http://lv2plug.in/ns/ext/data-access";
148 _path_support_feature.URI = LV2_FILES_PATH_SUPPORT_URI;
149 _new_file_support_feature.URI = LV2_FILES_NEW_FILE_SUPPORT_URI;
150 _persist_feature.URI = "http://lv2plug.in/ns/ext/persist";
151 _persist_feature.data = NULL;
153 SLV2Plugin plugin = _impl->plugin;
155 SLV2Value persist_uri = slv2_value_new_uri(_world.world, _persist_feature.URI);
156 _supports_persist = slv2_plugin_has_feature(plugin, persist_uri);
157 slv2_value_free(persist_uri);
159 _features = (LV2_Feature**)malloc(sizeof(LV2_Feature*) * 7);
160 _features[0] = &_instance_access_feature;
161 _features[1] = &_data_access_feature;
162 _features[2] = &_path_support_feature;
163 _features[3] = &_new_file_support_feature;
164 _features[4] = &_persist_feature;
165 _features[5] = _uri_map.feature();
168 LV2_Files_Path_Support* path_support = (LV2_Files_Path_Support*)malloc(
169 sizeof(LV2_Files_Path_Support));
170 path_support->host_data = this;
171 path_support->abstract_path = &lv2_files_abstract_path;
172 path_support->absolute_path = &lv2_files_absolute_path;
173 _path_support_feature.data = path_support;
175 LV2_Files_New_File_Support* new_file_support = (LV2_Files_New_File_Support*)malloc(
176 sizeof(LV2_Files_New_File_Support));
177 new_file_support->host_data = this;
178 new_file_support->new_file_path = &lv2_files_new_file_path;
179 _new_file_support_feature.data = new_file_support;
181 _impl->instance = slv2_plugin_instantiate(plugin, rate, _features);
182 _impl->name = slv2_plugin_get_name(plugin);
183 _impl->author = slv2_plugin_get_author_name(plugin);
185 if (_impl->instance == 0) {
186 error << _("LV2: Failed to instantiate plugin ") << uri() << endmsg;
187 throw failed_constructor();
190 _instance_access_feature.data = (void*)_impl->instance->lv2_handle;
191 _data_access_extension_data.extension_data = _impl->instance->lv2_descriptor->extension_data;
192 _data_access_feature.data = &_data_access_extension_data;
194 if (slv2_plugin_has_feature(plugin, _world.in_place_broken)) {
195 error << string_compose(
196 _("LV2: \"%1\" cannot be used, since it cannot do inplace processing"),
197 slv2_value_as_string(_impl->name)) << endmsg;
198 slv2_value_free(_impl->name);
199 slv2_value_free(_impl->author);
200 throw failed_constructor();
205 const uint32_t num_ports = this->num_ports();
206 const bool latent = slv2_plugin_has_latency(plugin);
207 const uint32_t latency_port = (latent)
208 ? slv2_plugin_get_latency_port_index(plugin)
211 _control_data = new float[num_ports];
212 _shadow_data = new float[num_ports];
213 _defaults = new float[num_ports];
215 for (uint32_t i = 0; i < num_ports; ++i) {
216 SLV2Port port = slv2_plugin_get_port_by_index(plugin, i);
217 SLV2Value sym = slv2_port_get_symbol(plugin, port);
219 // Store index in map so we can look up index by symbol
220 _port_indices.insert(std::make_pair(slv2_value_as_string(sym), i));
222 // Get range and default value if applicable
223 if (parameter_is_control(i)) {
225 slv2_port_get_range(plugin, port, &def, NULL, NULL);
226 _defaults[i] = def ? slv2_value_as_float(def) : 0.0f;
227 slv2_value_free(def);
229 slv2_instance_connect_port(_impl->instance, i, &_control_data[i]);
231 if (latent && ( i == latency_port) ) {
232 _latency_control_port = &_control_data[i];
233 *_latency_control_port = 0;
236 if (parameter_is_input(i)) {
237 _shadow_data[i] = default_value(i);
244 SLV2UIs uis = slv2_plugin_get_uis(plugin);
245 if (slv2_uis_size(uis) > 0) {
246 #if defined(HAVE_NEW_SLV2) and defined(HAVE_SUIL)
247 // Look for embeddable UI
248 SLV2Value ui_type = NULL;
249 SLV2_FOREACH(uis, u, uis) {
250 SLV2UI this_ui = slv2_uis_get(uis, u);
251 SLV2Value this_ui_type = NULL;
252 if (slv2_ui_is_supported(this_ui,
256 // TODO: Multiple UI support
258 _ui_type = this_ui_type;
263 // Look for Gtk native UI
264 for (unsigned i = 0; i < slv2_uis_size(uis); ++i) {
265 SLV2UI ui = slv2_uis_get_at(uis, i);
266 if (slv2_ui_is_a(ui, _world.gtk_gui)) {
268 _impl->ui_type = _world.gtk_gui;
274 // If Gtk UI is not available, try to find external UI
276 for (unsigned i = 0; i < slv2_uis_size(uis); ++i) {
277 SLV2UI ui = slv2_uis_get_at(uis, i);
278 if (slv2_ui_is_a(ui, _world.external_gui)) {
280 _impl->ui_type = _world.external_gui;
287 latency_compute_run();
290 LV2Plugin::~LV2Plugin ()
292 DEBUG_TRACE(DEBUG::LV2, string_compose("%1 destroy\n", name()));
297 slv2_instance_free(_impl->instance);
298 slv2_value_free(_impl->name);
299 slv2_value_free(_impl->author);
300 #if defined(HAVE_NEW_SLV2) and defined(HAVE_SUIL)
301 slv2_value_free(_impl->ui_type);
303 /* _ui_type points to a global, so leave it alone */
305 delete [] _control_data;
306 delete [] _shadow_data;
310 LV2Plugin::is_external_ui() const
315 return slv2_ui_is_a(_impl->ui, _world.external_gui);
319 LV2Plugin::unique_id() const
321 return slv2_value_as_uri(slv2_plugin_get_uri(_impl->plugin));
325 LV2Plugin::uri() const
327 return slv2_value_as_uri(slv2_plugin_get_uri(_impl->plugin));
331 LV2Plugin::label() const
333 return slv2_value_as_string(_impl->name);
337 LV2Plugin::name() const
339 return slv2_value_as_string(_impl->name);
343 LV2Plugin::maker() const
345 return _impl->author ? slv2_value_as_string (_impl->author) : "Unknown";
349 LV2Plugin::num_ports() const
351 return slv2_plugin_get_num_ports(_impl->plugin);
355 LV2Plugin::parameter_count() const
357 return slv2_plugin_get_num_ports(_impl->plugin);
361 LV2Plugin::default_value(uint32_t port)
363 return _defaults[port];
367 LV2Plugin::port_symbol(uint32_t index) const
369 SLV2Port port = slv2_plugin_get_port_by_index(_impl->plugin, index);
371 error << name() << ": Invalid port index " << index << endmsg;
374 SLV2Value sym = slv2_port_get_symbol(_impl->plugin, port);
375 return slv2_value_as_string(sym);
379 LV2Plugin::set_parameter(uint32_t which, float val)
381 DEBUG_TRACE(DEBUG::LV2, string_compose(
382 "%1 set parameter %2 to %3\n", name(), which, val));
384 if (which < slv2_plugin_get_num_ports(_impl->plugin)) {
385 _shadow_data[which] = val;
387 warning << string_compose(
388 _("Illegal parameter number used with plugin \"%1\". "
389 "This is a bug in either %2 or the LV2 plugin <%3>"),
390 name(), PROGRAM_NAME, unique_id()) << endmsg;
393 Plugin::set_parameter(which, val);
397 LV2Plugin::get_parameter(uint32_t which) const
399 if (parameter_is_input(which)) {
400 return (float)_shadow_data[which];
402 return (float)_control_data[which];
408 LV2Plugin::nth_parameter(uint32_t n, bool& ok) const
411 for (uint32_t c = 0, x = 0; x < slv2_plugin_get_num_ports(_impl->plugin); ++x) {
412 if (parameter_is_control(x)) {
424 LV2Plugin::extension_data (const char* uri)
426 return _impl->instance->lv2_descriptor->extension_data (uri);
430 LV2Plugin::c_plugin ()
432 return _impl->plugin;
441 struct PersistValue {
442 inline PersistValue(uint32_t k, const void* v, size_t s, uint32_t t, uint32_t f)
443 : key(k), value(v), size(s), type(t), flags(f)
453 struct PersistState {
454 PersistState(URIMap& map) : uri_map(map) {}
456 typedef std::map<uint32_t, std::string> URIs;
457 typedef std::map<uint32_t, PersistValue> Values;
459 uint32_t file_id_to_runtime_id(uint32_t file_id) const {
460 URIs::const_iterator i = uris.find(file_id);
461 if (i == uris.end()) {
462 error << "LV2 state refers to undefined URI ID" << endmsg;
465 return uri_map.uri_to_id(NULL, i->second.c_str());
468 int add_uri(uint32_t file_id, const char* str) {
469 // TODO: check for clashes (invalid file)
470 uris.insert(make_pair(file_id, str));
474 int add_value(uint32_t file_key,
479 const uint32_t key = file_id_to_runtime_id(file_key);
480 const uint32_t type = file_id_to_runtime_id(file_type);
485 Values::const_iterator i = values.find(key);
486 if (i != values.end()) {
487 error << "LV2 state contains duplicate keys" << endmsg;
490 void* value_copy = malloc(size);
491 memcpy(value_copy, value, size); // FIXME: leak
494 PersistValue(key, value_copy, size, type, flags)));
505 LV2Plugin::lv2_persist_store_callback(void* host_data,
512 DEBUG_TRACE(DEBUG::LV2, string_compose(
513 "persist store %1 (size: %2, type: %3)\n",
514 _uri_map.id_to_uri(NULL, key),
516 _uri_map.id_to_uri(NULL, type)));
518 PersistState* state = (PersistState*)host_data;
519 state->add_uri(key, _uri_map.id_to_uri(NULL, key));
520 state->add_uri(type, _uri_map.id_to_uri(NULL, type));
521 return state->add_value(key, value, size, type, flags);
525 LV2Plugin::lv2_persist_retrieve_callback(void* host_data,
531 PersistState* state = (PersistState*)host_data;
532 PersistState::Values::const_iterator i = state->values.find(key);
533 if (i == state->values.end()) {
534 warning << "LV2 plugin attempted to retrieve nonexistent key: "
535 << _uri_map.id_to_uri(NULL, key) << endmsg;
538 *size = i->second.size;
539 *type = i->second.type;
540 *flags = LV2_PERSIST_IS_POD | LV2_PERSIST_IS_PORTABLE; // FIXME
541 DEBUG_TRACE(DEBUG::LV2, string_compose(
542 "persist retrieve %1 = %2 (size: %3, type: %4)\n",
543 _uri_map.id_to_uri(NULL, key),
544 i->second.value, *size, *type));
545 return i->second.value;
549 LV2Plugin::lv2_files_abstract_path(LV2_Files_Host_Data host_data,
550 const char* absolute_path)
552 LV2Plugin* me = (LV2Plugin*)host_data;
553 if (me->_insert_id == PBD::ID("0")) {
554 return g_strdup(absolute_path);
557 const std::string state_dir = Glib::build_filename(me->_session.plugins_dir(),
558 me->_insert_id.to_s());
561 if (strncmp(absolute_path, state_dir.c_str(), state_dir.length())) {
562 ret = g_strdup(absolute_path);
564 const std::string path(absolute_path + state_dir.length() + 1);
565 ret = g_strndup(path.c_str(), path.length());
568 DEBUG_TRACE(DEBUG::LV2, string_compose("abstract path %1 => %2\n",
569 absolute_path, ret));
575 LV2Plugin::lv2_files_absolute_path(LV2_Files_Host_Data host_data,
576 const char* abstract_path)
578 LV2Plugin* me = (LV2Plugin*)host_data;
579 if (me->_insert_id == PBD::ID("0")) {
580 return g_strdup(abstract_path);
584 if (g_path_is_absolute(abstract_path)) {
585 ret = g_strdup(abstract_path);
587 const std::string apath(abstract_path);
588 const std::string state_dir = Glib::build_filename(me->_session.plugins_dir(),
589 me->_insert_id.to_s());
590 const std::string path = Glib::build_filename(state_dir,
592 ret = g_strndup(path.c_str(), path.length());
595 DEBUG_TRACE(DEBUG::LV2, string_compose("absolute path %1 => %2\n",
596 abstract_path, ret));
602 LV2Plugin::lv2_files_new_file_path(LV2_Files_Host_Data host_data,
603 const char* relative_path)
605 LV2Plugin* me = (LV2Plugin*)host_data;
606 if (me->_insert_id == PBD::ID("0")) {
607 return g_strdup(relative_path);
610 const std::string state_dir = Glib::build_filename(me->_session.plugins_dir(),
611 me->_insert_id.to_s());
612 const std::string path = Glib::build_filename(state_dir,
615 char* dirname = g_path_get_dirname(path.c_str());
616 g_mkdir_with_parents(dirname, 0744);
619 DEBUG_TRACE(DEBUG::LV2, string_compose("new file path %1 => %2\n",
620 relative_path, path));
622 return g_strndup(path.c_str(), path.length());
626 LV2Plugin::add_state(XMLNode* root) const
628 assert(_insert_id != PBD::ID("0"));
632 LocaleGuard lg(X_("POSIX"));
634 for (uint32_t i = 0; i < parameter_count(); ++i) {
635 if (parameter_is_input(i) && parameter_is_control(i)) {
636 child = new XMLNode("Port");
637 child->add_property("symbol", port_symbol(i));
638 snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
639 child->add_property("value", string(buf));
640 root->add_child_nocopy(*child);
644 if (_supports_persist) {
645 // Create state directory for this plugin instance
646 const std::string state_filename = _insert_id.to_s() + ".rdff";
647 const std::string state_path = Glib::build_filename(
648 _session.plugins_dir(), state_filename);
650 cout << "Saving LV2 plugin state to " << state_path << endl;
652 // Get LV2 Persist extension data from plugin instance
653 LV2_Persist* persist = (LV2_Persist*)slv2_instance_get_extension_data(
654 _impl->instance, "http://lv2plug.in/ns/ext/persist");
656 warning << string_compose(
657 _("Plugin \"%1\% failed to return LV2 persist data"),
662 // Save plugin state to state object
663 PersistState state(_uri_map);
664 persist->save(_impl->instance->lv2_handle,
665 &LV2Plugin::lv2_persist_store_callback,
669 RDFF file = rdff_open(state_path.c_str(), true);
671 // Write all referenced URIs to state file
672 for (PersistState::URIs::const_iterator i = state.uris.begin();
673 i != state.uris.end(); ++i) {
680 // Write all values to state file
681 for (PersistState::Values::const_iterator i = state.values.begin();
682 i != state.values.end(); ++i) {
683 const uint32_t key = i->first;
684 const PersistValue& val = i->second;
685 rdff_write_triple(file,
696 root->add_property("state-file", state_filename);
700 static inline SLV2Value
701 get_value(SLV2Plugin p, SLV2Value subject, SLV2Value predicate)
703 SLV2Values vs = slv2_plugin_get_value_for_subject(p, subject, predicate);
704 return vs ? slv2_values_get_at(vs, 0) : NULL;
708 LV2Plugin::find_presets()
710 SLV2Value dc_title = slv2_value_new_uri(_world.world, NS_DC "title");
711 SLV2Value pset_hasPreset = slv2_value_new_uri(_world.world, NS_PSET "hasPreset");
713 SLV2Values presets = slv2_plugin_get_value(_impl->plugin, pset_hasPreset);
714 for (unsigned i = 0; i < slv2_values_size(presets); ++i) {
715 SLV2Value preset = slv2_values_get_at(presets, i);
716 SLV2Value name = get_value(_impl->plugin, preset, dc_title);
718 _presets.insert(std::make_pair(slv2_value_as_string(preset),
720 slv2_value_as_string(preset),
721 slv2_value_as_string(name))));
723 warning << string_compose(
724 _("Plugin \"%1\% preset \"%2%\" is missing a dc:title\n"),
725 unique_id(), slv2_value_as_string(preset));
728 slv2_values_free(presets);
730 slv2_value_free(pset_hasPreset);
731 slv2_value_free(dc_title);
735 LV2Plugin::load_preset(PresetRecord r)
737 Plugin::load_preset(r);
740 // New (>= 0.7.0) slv2 no longer supports SPARQL, but exposes blank nodes
741 // so querying ports is possible with the simple/fast API
742 SLV2Value lv2_port = slv2_value_new_uri(_world.world, NS_LV2 "port");
743 SLV2Value lv2_symbol = slv2_value_new_uri(_world.world, NS_LV2 "symbol");
744 SLV2Value pset_value = slv2_value_new_uri(_world.world, NS_PSET "value");
745 SLV2Value preset = slv2_value_new_uri(_world.world, r.uri.c_str());
747 SLV2Values ports = slv2_plugin_get_value_for_subject(_impl->plugin, preset, lv2_port);
748 for (unsigned i = 0; i < slv2_values_size(ports); ++i) {
749 SLV2Value port = slv2_values_get_at(ports, i);
750 SLV2Value symbol = get_value(_impl->plugin, port, lv2_symbol);
751 SLV2Value value = get_value(_impl->plugin, port, pset_value);
752 if (value && slv2_value_is_float(value)) {
753 set_parameter(_port_indices[slv2_value_as_string(symbol)],
754 slv2_value_as_float(value));
757 slv2_values_free(ports);
759 slv2_value_free(preset);
760 slv2_value_free(pset_value);
761 slv2_value_free(lv2_symbol);
762 slv2_value_free(lv2_port);
764 const string query = string(
765 "PREFIX lv2p: <http://lv2plug.in/ns/dev/presets#>\n"
766 "PREFIX dc: <http://dublincore.org/documents/dcmi-namespace/>\n"
767 "SELECT ?sym ?val WHERE { <") + r.uri + "> lv2:port ?port . "
768 " ?port lv2:symbol ?sym ; lv2p:value ?val . }";
769 SLV2Results values = slv2_plugin_query_sparql(_impl->plugin, query.c_str());
770 for (; !slv2_results_finished(values); slv2_results_next(values)) {
771 SLV2Value sym = slv2_results_get_binding_value(values, 0);
772 SLV2Value val = slv2_results_get_binding_value(values, 1);
773 if (slv2_value_is_float(val)) {
774 uint32_t index = _port_indices[slv2_value_as_string(sym)];
775 set_parameter(index, slv2_value_as_float(val));
778 slv2_results_free(values);
784 LV2Plugin::do_save_preset(string /*name*/)
790 LV2Plugin::do_remove_preset(string /*name*/)
794 LV2Plugin::has_editor() const
796 return _impl->ui != NULL;
800 LV2Plugin::set_insert_info(const PluginInsert* insert)
802 _insert_id = insert->id();
806 LV2Plugin::set_state(const XMLNode& node, int version)
809 const XMLProperty* prop;
810 XMLNodeConstIterator iter;
815 LocaleGuard lg(X_("POSIX"));
817 if (node.name() != state_node_name()) {
818 error << _("Bad node sent to LV2Plugin::set_state") << endmsg;
822 if (version < 3000) {
823 nodes = node.children("port");
825 nodes = node.children("Port");
828 for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
832 if ((prop = child->property("symbol")) != 0) {
833 sym = prop->value().c_str();
835 warning << _("LV2: port has no symbol, ignored") << endmsg;
839 map<string, uint32_t>::iterator i = _port_indices.find(sym);
841 if (i != _port_indices.end()) {
844 warning << _("LV2: port has unknown index, ignored") << endmsg;
848 if ((prop = child->property("value")) != 0) {
849 value = prop->value().c_str();
851 warning << _("LV2: port has no value, ignored") << endmsg;
855 set_parameter(port_id, atof(value));
858 if ((prop = node.property("state-file")) != 0) {
859 std::string state_path = Glib::build_filename(_session.plugins_dir(),
862 cout << "LV2 state path " << state_path << endl;
864 // Get LV2 Persist extension data from plugin instance
865 LV2_Persist* persist = (LV2_Persist*)slv2_instance_get_extension_data(
866 _impl->instance, "http://lv2plug.in/ns/ext/persist");
868 cout << "Loading LV2 state from " << state_path << endl;
869 RDFF file = rdff_open(state_path.c_str(), false);
871 PersistState state(_uri_map);
873 // Load file into state object
874 RDFFChunk* chunk = (RDFFChunk*)malloc(sizeof(RDFFChunk));
876 while (!rdff_read_chunk(file, &chunk)) {
877 if (rdff_chunk_is_uri(chunk)) {
878 RDFFURIChunk* body = (RDFFURIChunk*)chunk->data;
879 state.add_uri(body->id, body->uri);
880 } else if (rdff_chunk_is_triple(chunk)) {
881 RDFFTripleChunk* body = (RDFFTripleChunk*)chunk->data;
882 state.add_value(body->predicate,
886 LV2_PERSIST_IS_POD | LV2_PERSIST_IS_PORTABLE);
891 persist->restore(_impl->instance->lv2_handle,
892 &LV2Plugin::lv2_persist_retrieve_callback,
896 warning << string_compose(
897 _("Plugin \"%1\% failed to return LV2 persist data"),
902 latency_compute_run();
904 return Plugin::set_state(node, version);
908 LV2Plugin::get_parameter_descriptor(uint32_t which, ParameterDescriptor& desc) const
910 SLV2Port port = slv2_plugin_get_port_by_index(_impl->plugin, which);
912 SLV2Value def, min, max;
913 slv2_port_get_range(_impl->plugin, port, &def, &min, &max);
915 desc.integer_step = slv2_port_has_property(_impl->plugin, port, _world.integer);
916 desc.toggled = slv2_port_has_property(_impl->plugin, port, _world.toggled);
917 desc.logarithmic = slv2_port_has_property(_impl->plugin, port, _world.logarithmic);
918 desc.sr_dependent = slv2_port_has_property(_impl->plugin, port, _world.srate);
919 desc.label = slv2_value_as_string(slv2_port_get_name(_impl->plugin, port));
920 desc.lower = min ? slv2_value_as_float(min) : 0.0f;
921 desc.upper = max ? slv2_value_as_float(max) : 1.0f;
922 desc.min_unbound = false; // TODO: LV2 extension required
923 desc.max_unbound = false; // TODO: LV2 extension required
925 if (desc.integer_step) {
927 desc.smallstep = 0.1;
928 desc.largestep = 10.0;
930 const float delta = desc.upper - desc.lower;
931 desc.step = delta / 1000.0f;
932 desc.smallstep = delta / 10000.0f;
933 desc.largestep = delta / 10.0f;
936 slv2_value_free(def);
937 slv2_value_free(min);
938 slv2_value_free(max);
944 LV2Plugin::describe_parameter(Evoral::Parameter which)
946 if (( which.type() == PluginAutomation) && ( which.id() < parameter_count()) ) {
947 SLV2Value name = slv2_port_get_name(_impl->plugin,
948 slv2_plugin_get_port_by_index(_impl->plugin, which.id()));
949 string ret(slv2_value_as_string(name));
950 slv2_value_free(name);
958 LV2Plugin::signal_latency() const
960 if (_latency_control_port) {
961 return (framecnt_t)floor(*_latency_control_port);
967 set<Evoral::Parameter>
968 LV2Plugin::automatable() const
970 set<Evoral::Parameter> ret;
972 for (uint32_t i = 0; i < parameter_count(); ++i) {
973 if (parameter_is_input(i) && parameter_is_control(i)) {
974 ret.insert(ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
982 LV2Plugin::activate()
984 DEBUG_TRACE(DEBUG::LV2, string_compose("%1 activate\n", name()));
986 if (!_was_activated) {
987 slv2_instance_activate(_impl->instance);
988 _was_activated = true;
993 LV2Plugin::deactivate()
995 DEBUG_TRACE(DEBUG::LV2, string_compose("%1 deactivate\n", name()));
997 if (_was_activated) {
998 slv2_instance_deactivate(_impl->instance);
999 _was_activated = false;
1004 LV2Plugin::cleanup()
1006 DEBUG_TRACE(DEBUG::LV2, string_compose("%1 cleanup\n", name()));
1010 slv2_instance_free(_impl->instance);
1011 _impl->instance = NULL;
1015 LV2Plugin::connect_and_run(BufferSet& bufs,
1016 ChanMapping in_map, ChanMapping out_map,
1017 pframes_t nframes, framecnt_t offset)
1019 DEBUG_TRACE(DEBUG::LV2, string_compose("%1 run %2 offset %3\n", name(), nframes, offset));
1020 Plugin::connect_and_run(bufs, in_map, out_map, nframes, offset);
1022 cycles_t then = get_cycles();
1024 uint32_t audio_in_index = 0;
1025 uint32_t audio_out_index = 0;
1026 uint32_t midi_in_index = 0;
1027 uint32_t midi_out_index = 0;
1028 for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
1029 if (parameter_is_audio(port_index)) {
1030 if (parameter_is_input(port_index)) {
1031 const uint32_t buf_index = in_map.get(DataType::AUDIO, audio_in_index++);
1032 slv2_instance_connect_port(_impl->instance, port_index,
1033 bufs.get_audio(buf_index).data(offset));
1034 } else if (parameter_is_output(port_index)) {
1035 const uint32_t buf_index = out_map.get(DataType::AUDIO, audio_out_index++);
1036 //cerr << port_index << " : " << " AUDIO OUT " << buf_index << endl;
1037 slv2_instance_connect_port(_impl->instance, port_index,
1038 bufs.get_audio(buf_index).data(offset));
1040 } else if (parameter_is_midi(port_index)) {
1041 if (parameter_is_input(port_index)) {
1042 const uint32_t buf_index = in_map.get(DataType::MIDI, midi_in_index++);
1043 slv2_instance_connect_port(_impl->instance, port_index,
1044 bufs.get_lv2_midi(true, buf_index).data());
1045 } else if (parameter_is_output(port_index)) {
1046 const uint32_t buf_index = out_map.get(DataType::MIDI, midi_out_index++);
1047 slv2_instance_connect_port(_impl->instance, port_index,
1048 bufs.get_lv2_midi(false, buf_index).data());
1050 } else if (!parameter_is_control(port_index)) {
1051 // Optional port (it'd better be if we've made it this far...)
1052 slv2_instance_connect_port(_impl->instance, port_index, NULL);
1059 for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
1060 if (parameter_is_midi(port_index) && parameter_is_output(port_index)) {
1061 const uint32_t buf_index = out_map.get(DataType::MIDI, midi_out_index++);
1062 bufs.flush_lv2_midi(true, buf_index);
1066 cycles_t now = get_cycles();
1067 set_cycles((uint32_t)(now - then));
1073 LV2Plugin::parameter_is_control(uint32_t param) const
1075 SLV2Port port = slv2_plugin_get_port_by_index(_impl->plugin, param);
1076 return slv2_port_is_a(_impl->plugin, port, _world.control_class);
1080 LV2Plugin::parameter_is_audio(uint32_t param) const
1082 SLV2Port port = slv2_plugin_get_port_by_index(_impl->plugin, param);
1083 return slv2_port_is_a(_impl->plugin, port, _world.audio_class);
1087 LV2Plugin::parameter_is_midi(uint32_t param) const
1089 SLV2Port port = slv2_plugin_get_port_by_index(_impl->plugin, param);
1090 return slv2_port_is_a(_impl->plugin, port, _world.event_class);
1091 // && slv2_port_supports_event(_impl->plugin, port, _world.midi_class);
1095 LV2Plugin::parameter_is_output(uint32_t param) const
1097 SLV2Port port = slv2_plugin_get_port_by_index(_impl->plugin, param);
1098 return slv2_port_is_a(_impl->plugin, port, _world.output_class);
1102 LV2Plugin::parameter_is_input(uint32_t param) const
1104 SLV2Port port = slv2_plugin_get_port_by_index(_impl->plugin, param);
1105 return slv2_port_is_a(_impl->plugin, port, _world.input_class);
1109 LV2Plugin::print_parameter(uint32_t param, char* buf, uint32_t len) const
1112 if (param < parameter_count()) {
1113 snprintf(buf, len, "%.3f", get_parameter(param));
1120 boost::shared_ptr<Plugin::ScalePoints>
1121 LV2Plugin::get_scale_points(uint32_t port_index) const
1123 SLV2Port port = slv2_plugin_get_port_by_index(_impl->plugin, port_index);
1124 SLV2ScalePoints points = slv2_port_get_scale_points(_impl->plugin, port);
1126 boost::shared_ptr<Plugin::ScalePoints> ret;
1131 ret = boost::shared_ptr<Plugin::ScalePoints>(new ScalePoints());
1133 for (unsigned i = 0; i < slv2_scale_points_size(points); ++i) {
1134 SLV2ScalePoint p = slv2_scale_points_get_at(points, i);
1135 SLV2Value label = slv2_scale_point_get_label(p);
1136 SLV2Value value = slv2_scale_point_get_value(p);
1137 if (label && (slv2_value_is_float(value) || slv2_value_is_int(value))) {
1138 ret->insert(make_pair(slv2_value_as_string(label),
1139 slv2_value_as_float(value)));
1143 slv2_scale_points_free(points);
1148 LV2Plugin::run(pframes_t nframes)
1150 for (uint32_t i = 0; i < parameter_count(); ++i) {
1151 if (parameter_is_control(i) && parameter_is_input(i)) {
1152 _control_data[i] = _shadow_data[i];
1156 slv2_instance_run(_impl->instance, nframes);
1160 LV2Plugin::latency_compute_run()
1162 if (!_latency_control_port) {
1166 // Run the plugin so that it can set its latency parameter
1170 uint32_t port_index = 0;
1171 uint32_t in_index = 0;
1172 uint32_t out_index = 0;
1174 const framecnt_t bufsize = 1024;
1175 float buffer[bufsize];
1177 memset(buffer, 0, sizeof(float) * bufsize);
1179 // FIXME: Ensure plugins can handle in-place processing
1183 while (port_index < parameter_count()) {
1184 if (parameter_is_audio(port_index)) {
1185 if (parameter_is_input(port_index)) {
1186 slv2_instance_connect_port(_impl->instance, port_index, buffer);
1188 } else if (parameter_is_output(port_index)) {
1189 slv2_instance_connect_port(_impl->instance, port_index, buffer);
1200 LV2World::LV2World()
1201 : world(slv2_world_new())
1203 slv2_world_load_all(world);
1204 input_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_INPUT);
1205 output_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_OUTPUT);
1206 control_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_CONTROL);
1207 audio_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_AUDIO);
1208 event_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_EVENT);
1209 midi_class = slv2_value_new_uri(world, SLV2_EVENT_CLASS_MIDI);
1210 in_place_broken = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "inPlaceBroken");
1211 integer = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "integer");
1212 toggled = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "toggled");
1213 srate = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "sampleRate");
1214 gtk_gui = slv2_value_new_uri(world, NS_UI "GtkUI");
1215 external_gui = slv2_value_new_uri(world, NS_UI "external");
1216 logarithmic = slv2_value_new_uri(world, "http://lv2plug.in/ns/dev/extportinfo#logarithmic");
1219 LV2World::~LV2World()
1221 slv2_value_free(input_class);
1222 slv2_value_free(output_class);
1223 slv2_value_free(control_class);
1224 slv2_value_free(audio_class);
1225 slv2_value_free(event_class);
1226 slv2_value_free(midi_class);
1227 slv2_value_free(in_place_broken);
1230 LV2PluginInfo::LV2PluginInfo (void* c_plugin)
1231 : _c_plugin(c_plugin)
1236 LV2PluginInfo::~LV2PluginInfo()
1240 LV2PluginInfo::load(Session& session)
1245 plugin.reset(new LV2Plugin(session.engine(), session,
1246 (SLV2Plugin)_c_plugin,
1247 session.frame_rate()));
1249 plugin->set_info(PluginInfoPtr(new LV2PluginInfo(*this)));
1251 } catch (failed_constructor& err) {
1252 return PluginPtr((Plugin*)0);
1259 LV2PluginInfo::discover()
1261 PluginInfoList* plugs = new PluginInfoList;
1262 SLV2Plugins plugins = slv2_world_get_all_plugins(_world.world);
1264 cerr << "LV2: Discovering " << slv2_plugins_size(plugins) << " plugins" << endl;
1266 for (unsigned i = 0; i < slv2_plugins_size(plugins); ++i) {
1267 SLV2Plugin p = slv2_plugins_get_at(plugins, i);
1268 LV2PluginInfoPtr info(new LV2PluginInfo(p));
1270 SLV2Value name = slv2_plugin_get_name(p);
1273 cerr << "LV2: invalid plugin\n";
1279 info->name = string(slv2_value_as_string(name));
1280 slv2_value_free(name);
1282 SLV2PluginClass pclass = slv2_plugin_get_class(p);
1283 SLV2Value label = slv2_plugin_class_get_label(pclass);
1284 info->category = slv2_value_as_string(label);
1286 SLV2Value author_name = slv2_plugin_get_author_name(p);
1287 info->creator = author_name ? string(slv2_value_as_string(author_name)) : "Unknown";
1288 slv2_value_free(author_name);
1290 info->path = "/NOPATH"; // Meaningless for LV2
1292 info->n_inputs.set_audio(
1293 slv2_plugin_get_num_ports_of_class(
1294 p, _world.input_class, _world.audio_class, NULL));
1295 info->n_inputs.set_midi(
1296 slv2_plugin_get_num_ports_of_class(
1297 p, _world.input_class, _world.event_class, NULL));
1299 info->n_outputs.set_audio(
1300 slv2_plugin_get_num_ports_of_class(
1301 p, _world.output_class, _world.audio_class, NULL));
1302 info->n_outputs.set_midi(
1303 slv2_plugin_get_num_ports_of_class(
1304 p, _world.output_class, _world.event_class, NULL));
1306 info->unique_id = slv2_value_as_uri(slv2_plugin_get_uri(p));
1307 info->index = 0; // Meaningless for LV2
1309 plugs->push_back(info);
1312 cerr << "Done LV2 discovery" << endl;