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 "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/audio_buffer.h"
37 #include "ardour/audioengine.h"
38 #include "ardour/debug.h"
39 #include "ardour/lv2_event_buffer.h"
40 #include "ardour/lv2_plugin.h"
41 #include "ardour/session.h"
43 #include "pbd/stl_delete.h"
48 #include "lv2ext/lv2_files.h"
49 #include "lv2ext/lv2_persist.h"
52 #define NS_DC "http://dublincore.org/documents/dcmi-namespace/"
53 #define NS_LV2 "http://lv2plug.in/ns/lv2core#"
54 #define NS_PSET "http://lv2plug.in/ns/dev/presets#"
55 #define NS_UI "http://lv2plug.in/ns/extensions/ui#"
58 using namespace ARDOUR;
61 URIMap LV2Plugin::_uri_map;
62 uint32_t LV2Plugin::_midi_event_type = _uri_map.uri_to_id(
63 "http://lv2plug.in/ns/ext/event",
64 "http://lv2plug.in/ns/ext/midi#MidiEvent");
66 LV2Plugin::LV2Plugin (AudioEngine& engine,
71 : Plugin(engine, session)
76 init(world, plugin, rate);
79 LV2Plugin::LV2Plugin (const LV2Plugin& other)
81 , _world(other._world)
83 , _insert_id(other._insert_id)
85 init(other._world, other._plugin, other._sample_rate);
87 for (uint32_t i = 0; i < parameter_count(); ++i) {
88 _control_data[i] = other._shadow_data[i];
89 _shadow_data[i] = other._shadow_data[i];
94 LV2Plugin::init(LV2World& world, SLV2Plugin plugin, framecnt_t rate)
96 DEBUG_TRACE(DEBUG::LV2, "init\n");
103 _latency_control_port = 0;
104 _was_activated = false;
106 _instance_access_feature.URI = "http://lv2plug.in/ns/ext/instance-access";
107 _data_access_feature.URI = "http://lv2plug.in/ns/ext/data-access";
108 _path_support_feature.URI = LV2_FILES_PATH_SUPPORT_URI;
109 _new_file_support_feature.URI = LV2_FILES_NEW_FILE_SUPPORT_URI;
110 _persist_feature.URI = "http://lv2plug.in/ns/ext/persist";
111 _persist_feature.data = NULL;
113 SLV2Value persist_uri = slv2_value_new_uri(_world.world, _persist_feature.URI);
114 _supports_persist = slv2_plugin_has_feature(plugin, persist_uri);
115 slv2_value_free(persist_uri);
117 _features = (LV2_Feature**)malloc(sizeof(LV2_Feature*) * 7);
118 _features[0] = &_instance_access_feature;
119 _features[1] = &_data_access_feature;
120 _features[2] = &_path_support_feature;
121 _features[3] = &_new_file_support_feature;
122 _features[4] = &_persist_feature;
123 _features[5] = _uri_map.feature();
126 LV2_Files_Path_Support* path_support = (LV2_Files_Path_Support*)malloc(
127 sizeof(LV2_Files_Path_Support));
128 path_support->host_data = this;
129 path_support->abstract_path = &lv2_files_abstract_path;
130 path_support->absolute_path = &lv2_files_absolute_path;
131 _path_support_feature.data = path_support;
133 LV2_Files_New_File_Support* new_file_support = (LV2_Files_New_File_Support*)malloc(
134 sizeof(LV2_Files_New_File_Support));
135 new_file_support->host_data = this;
136 new_file_support->new_file_path = &lv2_files_new_file_path;
137 _new_file_support_feature.data = new_file_support;
139 _instance = slv2_plugin_instantiate(plugin, rate, _features);
140 _name = slv2_plugin_get_name(plugin);
141 _author = slv2_plugin_get_author_name(plugin);
143 if (_instance == 0) {
144 error << _("LV2: Failed to instantiate plugin ")
145 << slv2_value_as_string(slv2_plugin_get_uri(plugin)) << endmsg;
146 throw failed_constructor();
149 _instance_access_feature.data = (void*)_instance->lv2_handle;
150 _data_access_extension_data.extension_data = _instance->lv2_descriptor->extension_data;
151 _data_access_feature.data = &_data_access_extension_data;
153 if (slv2_plugin_has_feature(plugin, world.in_place_broken)) {
154 error << string_compose(
155 _("LV2: \"%1\" cannot be used, since it cannot do inplace processing"),
156 slv2_value_as_string(_name)) << endmsg;
157 slv2_value_free(_name);
158 slv2_value_free(_author);
159 throw failed_constructor();
164 const uint32_t num_ports = slv2_plugin_get_num_ports(plugin);
165 const bool latent = slv2_plugin_has_latency(plugin);
166 const uint32_t latency_port = (latent)
167 ? slv2_plugin_get_latency_port_index(plugin)
170 _control_data = new float[num_ports];
171 _shadow_data = new float[num_ports];
172 _defaults = new float[num_ports];
174 for (uint32_t i = 0; i < num_ports; ++i) {
175 SLV2Port port = slv2_plugin_get_port_by_index(plugin, i);
176 SLV2Value sym = slv2_port_get_symbol(_plugin, port);
178 // Store index in map so we can look up index by symbol
179 _port_indices.insert(std::make_pair(slv2_value_as_string(sym), i));
181 // Get range and default value if applicable
182 if (parameter_is_control(i)) {
184 slv2_port_get_range(plugin, port, &def, NULL, NULL);
185 _defaults[i] = def ? slv2_value_as_float(def) : 0.0f;
186 slv2_value_free(def);
188 slv2_instance_connect_port(_instance, i, &_control_data[i]);
190 if (latent && ( i == latency_port) ) {
191 _latency_control_port = &_control_data[i];
192 *_latency_control_port = 0;
195 if (parameter_is_input(i)) {
196 _shadow_data[i] = default_value(i);
203 SLV2UIs uis = slv2_plugin_get_uis(_plugin);
204 if (slv2_uis_size(uis) > 0) {
205 // Look for Gtk native UI
206 for (unsigned i = 0; i < slv2_uis_size(uis); ++i) {
207 SLV2UI ui = slv2_uis_get_at(uis, i);
208 if (slv2_ui_is_a(ui, _world.gtk_gui)) {
214 // If Gtk UI is not available, try to find external UI
216 for (unsigned i = 0; i < slv2_uis_size(uis); ++i) {
217 SLV2UI ui = slv2_uis_get_at(uis, i);
218 if (slv2_ui_is_a(ui, _world.external_gui)) {
226 latency_compute_run();
229 LV2Plugin::~LV2Plugin ()
231 DEBUG_TRACE(DEBUG::LV2, string_compose("%1 destroy\n", name()));
236 slv2_instance_free(_instance);
237 slv2_value_free(_name);
238 slv2_value_free(_author);
240 delete [] _control_data;
241 delete [] _shadow_data;
245 LV2Plugin::is_external_ui() const
247 return slv2_ui_is_a(_ui, _world.external_gui);
251 LV2Plugin::unique_id() const
253 return slv2_value_as_uri(slv2_plugin_get_uri(_plugin));
257 LV2Plugin::default_value(uint32_t port)
259 return _defaults[port];
263 LV2Plugin::port_symbol(uint32_t index) const
265 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, index);
267 error << name() << ": Invalid port index " << index << endmsg;
270 SLV2Value sym = slv2_port_get_symbol(_plugin, port);
271 return slv2_value_as_string(sym);
275 LV2Plugin::set_parameter(uint32_t which, float val)
277 DEBUG_TRACE(DEBUG::LV2, string_compose(
278 "%1 set parameter %2 to %3\n", name(), which, val));
280 if (which < slv2_plugin_get_num_ports(_plugin)) {
281 _shadow_data[which] = val;
283 warning << string_compose(
284 _("Illegal parameter number used with plugin \"%1\". "
285 "This is a bug in either %2 or the LV2 plugin <%3>"),
286 name(), PROGRAM_NAME, unique_id()) << endmsg;
289 Plugin::set_parameter(which, val);
293 LV2Plugin::get_parameter(uint32_t which) const
295 if (parameter_is_input(which)) {
296 return (float)_shadow_data[which];
298 return (float)_control_data[which];
304 LV2Plugin::nth_parameter(uint32_t n, bool& ok) const
307 for (uint32_t c = 0, x = 0; x < slv2_plugin_get_num_ports(_plugin); ++x) {
308 if (parameter_is_control(x)) {
319 struct PersistValue {
320 inline PersistValue(uint32_t k, const void* v, size_t s, uint32_t t, uint32_t f)
321 : key(k), value(v), size(s), type(t), flags(f)
331 struct PersistState {
332 PersistState(URIMap& map) : uri_map(map) {}
334 typedef std::map<uint32_t, std::string> URIs;
335 typedef std::map<uint32_t, PersistValue> Values;
337 uint32_t file_id_to_runtime_id(uint32_t file_id) const {
338 URIs::const_iterator i = uris.find(file_id);
339 if (i == uris.end()) {
340 error << "LV2 state refers to undefined URI ID" << endmsg;
343 return uri_map.uri_to_id(NULL, i->second.c_str());
346 int add_uri(uint32_t file_id, const char* str) {
347 // TODO: check for clashes (invalid file)
348 uris.insert(make_pair(file_id, str));
352 int add_value(uint32_t file_key,
357 const uint32_t key = file_id_to_runtime_id(file_key);
358 const uint32_t type = file_id_to_runtime_id(file_type);
363 Values::const_iterator i = values.find(key);
364 if (i != values.end()) {
365 error << "LV2 state contains duplicate keys" << endmsg;
368 void* value_copy = malloc(size);
369 memcpy(value_copy, value, size); // FIXME: leak
372 PersistValue(key, value_copy, size, type, flags)));
383 LV2Plugin::lv2_persist_store_callback(void* host_data,
390 DEBUG_TRACE(DEBUG::LV2, string_compose(
391 "persist store %1 (size: %2, type: %3)\n",
392 _uri_map.id_to_uri(NULL, key),
394 _uri_map.id_to_uri(NULL, type)));
396 PersistState* state = (PersistState*)host_data;
397 state->add_uri(key, _uri_map.id_to_uri(NULL, key));
398 state->add_uri(type, _uri_map.id_to_uri(NULL, type));
399 return state->add_value(key, value, size, type, flags);
403 LV2Plugin::lv2_persist_retrieve_callback(void* host_data,
409 PersistState* state = (PersistState*)host_data;
410 PersistState::Values::const_iterator i = state->values.find(key);
411 if (i == state->values.end()) {
412 warning << "LV2 plugin attempted to retrieve nonexistent key: "
413 << _uri_map.id_to_uri(NULL, key) << endmsg;
416 *size = i->second.size;
417 *type = i->second.type;
418 *flags = LV2_PERSIST_IS_POD | LV2_PERSIST_IS_PORTABLE; // FIXME
419 DEBUG_TRACE(DEBUG::LV2, string_compose(
420 "persist retrieve %1 = %2 (size: %3, type: %4)\n",
421 _uri_map.id_to_uri(NULL, key),
422 i->second.value, *size, *type));
423 return i->second.value;
427 LV2Plugin::lv2_files_abstract_path(LV2_Files_Host_Data host_data,
428 const char* absolute_path)
430 LV2Plugin* me = (LV2Plugin*)host_data;
431 if (me->_insert_id == PBD::ID("0")) {
432 return g_strdup(absolute_path);
435 const std::string state_dir = Glib::build_filename(me->_session.plugins_dir(),
436 me->_insert_id.to_s());
439 if (strncmp(absolute_path, state_dir.c_str(), state_dir.length())) {
440 ret = g_strdup(absolute_path);
442 const std::string path(absolute_path + state_dir.length() + 1);
443 ret = g_strndup(path.c_str(), path.length());
446 DEBUG_TRACE(DEBUG::LV2, string_compose("abstract path %1 => %2\n",
447 absolute_path, ret));
453 LV2Plugin::lv2_files_absolute_path(LV2_Files_Host_Data host_data,
454 const char* abstract_path)
456 LV2Plugin* me = (LV2Plugin*)host_data;
457 if (me->_insert_id == PBD::ID("0")) {
458 return g_strdup(abstract_path);
462 if (g_path_is_absolute(abstract_path)) {
463 ret = g_strdup(abstract_path);
465 const std::string apath(abstract_path);
466 const std::string state_dir = Glib::build_filename(me->_session.plugins_dir(),
467 me->_insert_id.to_s());
468 const std::string path = Glib::build_filename(state_dir,
470 ret = g_strndup(path.c_str(), path.length());
473 DEBUG_TRACE(DEBUG::LV2, string_compose("absolute path %1 => %2\n",
474 abstract_path, ret));
480 LV2Plugin::lv2_files_new_file_path(LV2_Files_Host_Data host_data,
481 const char* relative_path)
483 LV2Plugin* me = (LV2Plugin*)host_data;
484 if (me->_insert_id == PBD::ID("0")) {
485 return g_strdup(relative_path);
488 const std::string state_dir = Glib::build_filename(me->_session.plugins_dir(),
489 me->_insert_id.to_s());
490 const std::string path = Glib::build_filename(state_dir,
493 char* dirname = g_path_get_dirname(path.c_str());
494 g_mkdir_with_parents(dirname, 0744);
497 DEBUG_TRACE(DEBUG::LV2, string_compose("new file path %1 => %2\n",
498 relative_path, path));
500 return g_strndup(path.c_str(), path.length());
504 LV2Plugin::add_state(XMLNode* root) const
506 assert(_insert_id != PBD::ID("0"));
510 LocaleGuard lg(X_("POSIX"));
512 for (uint32_t i = 0; i < parameter_count(); ++i) {
513 if (parameter_is_input(i) && parameter_is_control(i)) {
514 child = new XMLNode("Port");
515 child->add_property("symbol", port_symbol(i));
516 snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
517 child->add_property("value", string(buf));
518 root->add_child_nocopy(*child);
522 if (_supports_persist) {
523 // Create state directory for this plugin instance
524 const std::string state_filename = _insert_id.to_s() + ".rdff";
525 const std::string state_path = Glib::build_filename(
526 _session.plugins_dir(), state_filename);
528 cout << "Saving LV2 plugin state to " << state_path << endl;
530 // Get LV2 Persist extension data from plugin instance
531 LV2_Persist* persist = (LV2_Persist*)slv2_instance_get_extension_data(
532 _instance, "http://lv2plug.in/ns/ext/persist");
534 warning << string_compose(
535 _("Plugin \"%1\% failed to return LV2 persist data"),
540 // Save plugin state to state object
541 PersistState state(_uri_map);
542 persist->save(_instance->lv2_handle,
543 &LV2Plugin::lv2_persist_store_callback,
547 RDFF file = rdff_open(state_path.c_str(), true);
549 // Write all referenced URIs to state file
550 for (PersistState::URIs::const_iterator i = state.uris.begin();
551 i != state.uris.end(); ++i) {
558 // Write all values to state file
559 for (PersistState::Values::const_iterator i = state.values.begin();
560 i != state.values.end(); ++i) {
561 const uint32_t key = i->first;
562 const PersistValue& val = i->second;
563 rdff_write_triple(file,
574 root->add_property("state-file", state_filename);
578 static inline SLV2Value
579 get_value(SLV2Plugin p, SLV2Value subject, SLV2Value predicate)
581 SLV2Values vs = slv2_plugin_get_value_for_subject(p, subject, predicate);
582 return vs ? slv2_values_get_at(vs, 0) : NULL;
586 LV2Plugin::find_presets()
588 SLV2Value dc_title = slv2_value_new_uri(_world.world, NS_DC "title");
589 SLV2Value pset_hasPreset = slv2_value_new_uri(_world.world, NS_PSET "hasPreset");
591 SLV2Values presets = slv2_plugin_get_value(_plugin, pset_hasPreset);
592 for (unsigned i = 0; i < slv2_values_size(presets); ++i) {
593 SLV2Value preset = slv2_values_get_at(presets, i);
594 SLV2Value name = get_value(_plugin, preset, dc_title);
596 _presets.insert(std::make_pair(slv2_value_as_string(preset),
598 slv2_value_as_string(preset),
599 slv2_value_as_string(name))));
601 warning << string_compose(
602 _("Plugin \"%1\% preset \"%2%\" is missing a dc:title\n"),
603 unique_id(), slv2_value_as_string(preset));
606 slv2_values_free(presets);
608 slv2_value_free(pset_hasPreset);
609 slv2_value_free(dc_title);
613 LV2Plugin::load_preset(PresetRecord r)
615 Plugin::load_preset(r);
618 // New (>= 0.7.0) slv2 no longer supports SPARQL, but exposes blank nodes
619 // so querying ports is possible with the simple/fast API
620 SLV2Value lv2_port = slv2_value_new_uri(_world.world, NS_LV2 "port");
621 SLV2Value lv2_symbol = slv2_value_new_uri(_world.world, NS_LV2 "symbol");
622 SLV2Value pset_value = slv2_value_new_uri(_world.world, NS_PSET "value");
623 SLV2Value preset = slv2_value_new_uri(_world.world, r.uri.c_str());
625 SLV2Values ports = slv2_plugin_get_value_for_subject(_plugin, preset, lv2_port);
626 for (unsigned i = 0; i < slv2_values_size(ports); ++i) {
627 SLV2Value port = slv2_values_get_at(ports, i);
628 SLV2Value symbol = get_value(_plugin, port, lv2_symbol);
629 SLV2Value value = get_value(_plugin, port, pset_value);
630 if (value && slv2_value_is_float(value)) {
631 set_parameter(_port_indices[slv2_value_as_string(symbol)],
632 slv2_value_as_float(value));
635 slv2_values_free(ports);
637 slv2_value_free(preset);
638 slv2_value_free(pset_value);
639 slv2_value_free(lv2_symbol);
640 slv2_value_free(lv2_port);
642 const string query = string(
643 "PREFIX lv2p: <http://lv2plug.in/ns/dev/presets#>\n"
644 "PREFIX dc: <http://dublincore.org/documents/dcmi-namespace/>\n"
645 "SELECT ?sym ?val WHERE { <") + r.uri + "> lv2:port ?port . "
646 " ?port lv2:symbol ?sym ; lv2p:value ?val . }";
647 SLV2Results values = slv2_plugin_query_sparql(_plugin, query.c_str());
648 for (; !slv2_results_finished(values); slv2_results_next(values)) {
649 SLV2Value sym = slv2_results_get_binding_value(values, 0);
650 SLV2Value val = slv2_results_get_binding_value(values, 1);
651 if (slv2_value_is_float(val)) {
652 uint32_t index = _port_indices[slv2_value_as_string(sym)];
653 set_parameter(index, slv2_value_as_float(val));
656 slv2_results_free(values);
662 LV2Plugin::do_save_preset(string /*name*/)
668 LV2Plugin::do_remove_preset(string /*name*/)
672 LV2Plugin::has_editor() const
678 LV2Plugin::set_insert_info(const PluginInsert* insert)
680 _insert_id = insert->id();
684 LV2Plugin::set_state(const XMLNode& node, int version)
687 const XMLProperty* prop;
688 XMLNodeConstIterator iter;
693 LocaleGuard lg(X_("POSIX"));
695 if (node.name() != state_node_name()) {
696 error << _("Bad node sent to LV2Plugin::set_state") << endmsg;
700 if (version < 3000) {
701 nodes = node.children("port");
703 nodes = node.children("Port");
706 for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
710 if ((prop = child->property("symbol")) != 0) {
711 sym = prop->value().c_str();
713 warning << _("LV2: port has no symbol, ignored") << endmsg;
717 map<string, uint32_t>::iterator i = _port_indices.find(sym);
719 if (i != _port_indices.end()) {
722 warning << _("LV2: port has unknown index, ignored") << endmsg;
726 if ((prop = child->property("value")) != 0) {
727 value = prop->value().c_str();
729 warning << _("LV2: port has no value, ignored") << endmsg;
733 set_parameter(port_id, atof(value));
736 if ((prop = node.property("state-file")) != 0) {
737 std::string state_path = Glib::build_filename(_session.plugins_dir(),
740 cout << "LV2 state path " << state_path << endl;
742 // Get LV2 Persist extension data from plugin instance
743 LV2_Persist* persist = (LV2_Persist*)slv2_instance_get_extension_data(
744 _instance, "http://lv2plug.in/ns/ext/persist");
746 cout << "Loading LV2 state from " << state_path << endl;
747 RDFF file = rdff_open(state_path.c_str(), false);
749 PersistState state(_uri_map);
751 // Load file into state object
752 RDFFChunk* chunk = (RDFFChunk*)malloc(sizeof(RDFFChunk));
754 while (!rdff_read_chunk(file, &chunk)) {
755 if (rdff_chunk_is_uri(chunk)) {
756 RDFFURIChunk* body = (RDFFURIChunk*)chunk->data;
757 state.add_uri(body->id, body->uri);
758 } else if (rdff_chunk_is_triple(chunk)) {
759 RDFFTripleChunk* body = (RDFFTripleChunk*)chunk->data;
760 state.add_value(body->predicate,
764 LV2_PERSIST_IS_POD | LV2_PERSIST_IS_PORTABLE);
769 persist->restore(_instance->lv2_handle,
770 &LV2Plugin::lv2_persist_retrieve_callback,
774 warning << string_compose(
775 _("Plugin \"%1\% failed to return LV2 persist data"),
780 latency_compute_run();
782 return Plugin::set_state(node, version);
786 LV2Plugin::get_parameter_descriptor(uint32_t which, ParameterDescriptor& desc) const
788 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, which);
790 SLV2Value def, min, max;
791 slv2_port_get_range(_plugin, port, &def, &min, &max);
793 desc.integer_step = slv2_port_has_property(_plugin, port, _world.integer);
794 desc.toggled = slv2_port_has_property(_plugin, port, _world.toggled);
795 desc.logarithmic = slv2_port_has_property(_plugin, port, _world.logarithmic);
796 desc.sr_dependent = slv2_port_has_property(_plugin, port, _world.srate);
797 desc.label = slv2_value_as_string(slv2_port_get_name(_plugin, port));
798 desc.lower = min ? slv2_value_as_float(min) : 0.0f;
799 desc.upper = max ? slv2_value_as_float(max) : 1.0f;
800 desc.min_unbound = false; // TODO: LV2 extension required
801 desc.max_unbound = false; // TODO: LV2 extension required
803 if (desc.integer_step) {
805 desc.smallstep = 0.1;
806 desc.largestep = 10.0;
808 const float delta = desc.upper - desc.lower;
809 desc.step = delta / 1000.0f;
810 desc.smallstep = delta / 10000.0f;
811 desc.largestep = delta / 10.0f;
814 slv2_value_free(def);
815 slv2_value_free(min);
816 slv2_value_free(max);
822 LV2Plugin::describe_parameter(Evoral::Parameter which)
824 if (( which.type() == PluginAutomation) && ( which.id() < parameter_count()) ) {
825 SLV2Value name = slv2_port_get_name(_plugin,
826 slv2_plugin_get_port_by_index(_plugin, which.id()));
827 string ret(slv2_value_as_string(name));
828 slv2_value_free(name);
836 LV2Plugin::signal_latency() const
838 if (_latency_control_port) {
839 return (framecnt_t)floor(*_latency_control_port);
845 set<Evoral::Parameter>
846 LV2Plugin::automatable() const
848 set<Evoral::Parameter> ret;
850 for (uint32_t i = 0; i < parameter_count(); ++i) {
851 if (parameter_is_input(i) && parameter_is_control(i)) {
852 ret.insert(ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
860 LV2Plugin::activate()
862 DEBUG_TRACE(DEBUG::LV2, string_compose("%1 activate\n", name()));
864 if (!_was_activated) {
865 slv2_instance_activate(_instance);
866 _was_activated = true;
871 LV2Plugin::deactivate()
873 DEBUG_TRACE(DEBUG::LV2, string_compose("%1 deactivate\n", name()));
875 if (_was_activated) {
876 slv2_instance_deactivate(_instance);
877 _was_activated = false;
884 DEBUG_TRACE(DEBUG::LV2, string_compose("%1 cleanup\n", name()));
888 slv2_instance_free(_instance);
893 LV2Plugin::connect_and_run(BufferSet& bufs,
894 ChanMapping in_map, ChanMapping out_map,
895 pframes_t nframes, framecnt_t offset)
897 DEBUG_TRACE(DEBUG::LV2, string_compose("%1 run %2 offset %3\n", name(), nframes, offset));
898 Plugin::connect_and_run(bufs, in_map, out_map, nframes, offset);
900 cycles_t then = get_cycles();
902 uint32_t audio_in_index = 0;
903 uint32_t audio_out_index = 0;
904 uint32_t midi_in_index = 0;
905 uint32_t midi_out_index = 0;
906 for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
907 if (parameter_is_audio(port_index)) {
908 if (parameter_is_input(port_index)) {
909 const uint32_t buf_index = in_map.get(DataType::AUDIO, audio_in_index++);
910 slv2_instance_connect_port(_instance, port_index,
911 bufs.get_audio(buf_index).data(offset));
912 } else if (parameter_is_output(port_index)) {
913 const uint32_t buf_index = out_map.get(DataType::AUDIO, audio_out_index++);
914 //cerr << port_index << " : " << " AUDIO OUT " << buf_index << endl;
915 slv2_instance_connect_port(_instance, port_index,
916 bufs.get_audio(buf_index).data(offset));
918 } else if (parameter_is_midi(port_index)) {
919 if (parameter_is_input(port_index)) {
920 const uint32_t buf_index = in_map.get(DataType::MIDI, midi_in_index++);
921 slv2_instance_connect_port(_instance, port_index,
922 bufs.get_lv2_midi(true, buf_index).data());
923 } else if (parameter_is_output(port_index)) {
924 const uint32_t buf_index = out_map.get(DataType::MIDI, midi_out_index++);
925 slv2_instance_connect_port(_instance, port_index,
926 bufs.get_lv2_midi(false, buf_index).data());
928 } else if (!parameter_is_control(port_index)) {
929 // Optional port (it'd better be if we've made it this far...)
930 slv2_instance_connect_port(_instance, port_index, NULL);
937 for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
938 if (parameter_is_midi(port_index) && parameter_is_output(port_index)) {
939 const uint32_t buf_index = out_map.get(DataType::MIDI, midi_out_index++);
940 bufs.flush_lv2_midi(true, buf_index);
944 cycles_t now = get_cycles();
945 set_cycles((uint32_t)(now - then));
951 LV2Plugin::parameter_is_control(uint32_t param) const
953 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
954 return slv2_port_is_a(_plugin, port, _world.control_class);
958 LV2Plugin::parameter_is_audio(uint32_t param) const
960 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
961 return slv2_port_is_a(_plugin, port, _world.audio_class);
965 LV2Plugin::parameter_is_midi(uint32_t param) const
967 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
968 return slv2_port_is_a(_plugin, port, _world.event_class);
969 // && slv2_port_supports_event(_plugin, port, _world.midi_class);
973 LV2Plugin::parameter_is_output(uint32_t param) const
975 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
976 return slv2_port_is_a(_plugin, port, _world.output_class);
980 LV2Plugin::parameter_is_input(uint32_t param) const
982 SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
983 return slv2_port_is_a(_plugin, port, _world.input_class);
987 LV2Plugin::print_parameter(uint32_t param, char* buf, uint32_t len) const
990 if (param < parameter_count()) {
991 snprintf(buf, len, "%.3f", get_parameter(param));
999 LV2Plugin::run(pframes_t nframes)
1001 for (uint32_t i = 0; i < parameter_count(); ++i) {
1002 if (parameter_is_control(i) && parameter_is_input(i)) {
1003 _control_data[i] = _shadow_data[i];
1007 slv2_instance_run(_instance, nframes);
1011 LV2Plugin::latency_compute_run()
1013 if (!_latency_control_port) {
1017 // Run the plugin so that it can set its latency parameter
1021 uint32_t port_index = 0;
1022 uint32_t in_index = 0;
1023 uint32_t out_index = 0;
1025 const framecnt_t bufsize = 1024;
1026 float buffer[bufsize];
1028 memset(buffer, 0, sizeof(float) * bufsize);
1030 // FIXME: Ensure plugins can handle in-place processing
1034 while (port_index < parameter_count()) {
1035 if (parameter_is_audio(port_index)) {
1036 if (parameter_is_input(port_index)) {
1037 slv2_instance_connect_port(_instance, port_index, buffer);
1039 } else if (parameter_is_output(port_index)) {
1040 slv2_instance_connect_port(_instance, port_index, buffer);
1051 LV2World::LV2World()
1052 : world(slv2_world_new())
1054 slv2_world_load_all(world);
1055 input_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_INPUT);
1056 output_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_OUTPUT);
1057 control_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_CONTROL);
1058 audio_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_AUDIO);
1059 event_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_EVENT);
1060 midi_class = slv2_value_new_uri(world, SLV2_EVENT_CLASS_MIDI);
1061 in_place_broken = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "inPlaceBroken");
1062 integer = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "integer");
1063 toggled = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "toggled");
1064 srate = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "sampleRate");
1065 gtk_gui = slv2_value_new_uri(world, NS_UI "GtkUI");
1066 external_gui = slv2_value_new_uri(world, NS_UI "external");
1067 logarithmic = slv2_value_new_uri(world, "http://lv2plug.in/ns/dev/extportinfo#logarithmic");
1070 LV2World::~LV2World()
1072 slv2_value_free(input_class);
1073 slv2_value_free(output_class);
1074 slv2_value_free(control_class);
1075 slv2_value_free(audio_class);
1076 slv2_value_free(event_class);
1077 slv2_value_free(midi_class);
1078 slv2_value_free(in_place_broken);
1081 LV2PluginInfo::LV2PluginInfo (void* lv2_world, void* slv2_plugin)
1082 : _lv2_world(lv2_world)
1083 , _slv2_plugin(slv2_plugin)
1088 LV2PluginInfo::~LV2PluginInfo()
1092 LV2PluginInfo::load(Session& session)
1097 plugin.reset(new LV2Plugin(session.engine(), session,
1098 *(LV2World*)_lv2_world, (SLV2Plugin)_slv2_plugin,
1099 session.frame_rate()));
1101 plugin->set_info(PluginInfoPtr(new LV2PluginInfo(*this)));
1103 } catch (failed_constructor& err) {
1104 return PluginPtr((Plugin*)0);
1111 LV2PluginInfo::discover(void* lv2_world)
1113 PluginInfoList* plugs = new PluginInfoList;
1114 LV2World* world = (LV2World*)lv2_world;
1115 SLV2Plugins plugins = slv2_world_get_all_plugins(world->world);
1117 cerr << "LV2: Discovering " << slv2_plugins_size(plugins) << " plugins" << endl;
1119 for (unsigned i = 0; i < slv2_plugins_size(plugins); ++i) {
1120 SLV2Plugin p = slv2_plugins_get_at(plugins, i);
1121 LV2PluginInfoPtr info(new LV2PluginInfo(lv2_world, p));
1123 SLV2Value name = slv2_plugin_get_name(p);
1126 cerr << "LV2: invalid plugin\n";
1132 info->name = string(slv2_value_as_string(name));
1133 slv2_value_free(name);
1135 SLV2PluginClass pclass = slv2_plugin_get_class(p);
1136 SLV2Value label = slv2_plugin_class_get_label(pclass);
1137 info->category = slv2_value_as_string(label);
1139 SLV2Value author_name = slv2_plugin_get_author_name(p);
1140 info->creator = author_name ? string(slv2_value_as_string(author_name)) : "Unknown";
1141 slv2_value_free(author_name);
1143 info->path = "/NOPATH"; // Meaningless for LV2
1145 info->n_inputs.set_audio(
1146 slv2_plugin_get_num_ports_of_class(
1147 p, world->input_class, world->audio_class, NULL));
1148 info->n_inputs.set_midi(
1149 slv2_plugin_get_num_ports_of_class(
1150 p, world->input_class, world->event_class, NULL));
1152 info->n_outputs.set_audio(
1153 slv2_plugin_get_num_ports_of_class(
1154 p, world->output_class, world->audio_class, NULL));
1155 info->n_outputs.set_midi(
1156 slv2_plugin_get_num_ports_of_class(
1157 p, world->output_class, world->event_class, NULL));
1159 info->unique_id = slv2_value_as_uri(slv2_plugin_get_uri(p));
1160 info->index = 0; // Meaningless for LV2
1162 plugs->push_back(info);
1165 cerr << "Done LV2 discovery" << endl;