2 Copyright (C) 2008-2012 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.
28 #include <giomm/file.h>
29 #include <glib/gprintf.h>
32 #include <boost/utility.hpp>
34 #include "pbd/pathscanner.h"
35 #include "pbd/compose.h"
36 #include "pbd/error.h"
37 #include "pbd/xml++.h"
39 #include "libardour-config.h"
41 #include "ardour/audio_buffer.h"
42 #include "ardour/audioengine.h"
43 #include "ardour/debug.h"
44 #include "ardour/lv2_plugin.h"
45 #include "ardour/session.h"
46 #include "ardour/tempo.h"
47 #include "ardour/types.h"
48 #include "ardour/utils.h"
49 #include "ardour/worker.h"
50 #include "ardour/lv2_bundled_search_path.h"
55 #include <lilv/lilv.h>
57 #include "lv2/lv2plug.in/ns/ext/atom/atom.h"
58 #include "lv2/lv2plug.in/ns/ext/atom/forge.h"
59 #include "lv2/lv2plug.in/ns/ext/log/log.h"
60 #include "lv2/lv2plug.in/ns/ext/midi/midi.h"
61 #include "lv2/lv2plug.in/ns/ext/port-props/port-props.h"
62 #include "lv2/lv2plug.in/ns/ext/presets/presets.h"
63 #include "lv2/lv2plug.in/ns/ext/state/state.h"
64 #include "lv2/lv2plug.in/ns/ext/time/time.h"
65 #include "lv2/lv2plug.in/ns/ext/worker/worker.h"
66 #include "lv2/lv2plug.in/ns/ext/resize-port/resize-port.h"
67 #include "lv2/lv2plug.in/ns/extensions/ui/ui.h"
69 #include "lv2/lv2plug.in/ns/ext/buf-size/buf-size.h"
70 #include "lv2/lv2plug.in/ns/ext/options/options.h"
73 #include "lv2_evbuf.h"
76 #include <suil/suil.h>
79 /** The number of MIDI buffers that will fit in a UI/worker comm buffer.
80 This needs to be roughly the number of cycles the UI will get around to
81 actually processing the traffic. Lower values are flakier but save memory.
83 static const size_t NBUFS = 4;
86 using namespace ARDOUR;
89 URIMap LV2Plugin::_uri_map;
91 LV2Plugin::URIDs LV2Plugin::urids = {
92 _uri_map.uri_to_id(LV2_ATOM__Chunk),
93 _uri_map.uri_to_id(LV2_ATOM__Path),
94 _uri_map.uri_to_id(LV2_ATOM__Sequence),
95 _uri_map.uri_to_id(LV2_ATOM__eventTransfer),
96 _uri_map.uri_to_id(LV2_LOG__Error),
97 _uri_map.uri_to_id(LV2_LOG__Note),
98 _uri_map.uri_to_id(LV2_LOG__Warning),
99 _uri_map.uri_to_id(LV2_MIDI__MidiEvent),
100 _uri_map.uri_to_id(LV2_TIME__Position),
101 _uri_map.uri_to_id(LV2_TIME__bar),
102 _uri_map.uri_to_id(LV2_TIME__barBeat),
103 _uri_map.uri_to_id(LV2_TIME__beatUnit),
104 _uri_map.uri_to_id(LV2_TIME__beatsPerBar),
105 _uri_map.uri_to_id(LV2_TIME__beatsPerMinute),
106 _uri_map.uri_to_id(LV2_TIME__frame),
107 _uri_map.uri_to_id(LV2_TIME__speed)
110 class LV2World : boost::noncopyable {
115 void load_bundled_plugins();
119 LilvNode* atom_AtomPort;
120 LilvNode* atom_Chunk;
121 LilvNode* atom_Sequence;
122 LilvNode* atom_bufferType;
123 LilvNode* atom_eventTransfer;
124 LilvNode* atom_supports;
125 LilvNode* ev_EventPort;
126 LilvNode* ext_logarithmic;
127 LilvNode* ext_notOnGUI;
128 LilvNode* lv2_AudioPort;
129 LilvNode* lv2_ControlPort;
130 LilvNode* lv2_InputPort;
131 LilvNode* lv2_OutputPort;
132 LilvNode* lv2_enumeration;
133 LilvNode* lv2_freewheeling;
134 LilvNode* lv2_inPlaceBroken;
135 LilvNode* lv2_integer;
136 LilvNode* lv2_reportsLatency;
137 LilvNode* lv2_sampleRate;
138 LilvNode* lv2_toggled;
139 LilvNode* midi_MidiEvent;
140 LilvNode* rdfs_comment;
141 LilvNode* rsz_minimumSize;
142 LilvNode* time_Position;
144 LilvNode* ui_external;
145 LilvNode* ui_externalkx;
146 LilvNode* units_unit;
147 LilvNode* units_midiNote;
150 bool _bundle_checked;
153 static LV2World _world;
155 /* worker extension */
157 /** Called by the plugin to schedule non-RT work. */
158 static LV2_Worker_Status
159 work_schedule(LV2_Worker_Schedule_Handle handle,
163 LV2Plugin* plugin = (LV2Plugin*)handle;
164 if (plugin->session().engine().freewheeling()) {
165 // Freewheeling, do the work immediately in this (audio) thread
166 return (LV2_Worker_Status)plugin->work(size, data);
168 // Enqueue message for the worker thread
169 return plugin->worker()->schedule(size, data) ?
170 LV2_WORKER_SUCCESS : LV2_WORKER_ERR_UNKNOWN;
174 /** Called by the plugin to respond to non-RT work. */
175 static LV2_Worker_Status
176 work_respond(LV2_Worker_Respond_Handle handle,
180 LV2Plugin* plugin = (LV2Plugin*)handle;
181 if (plugin->session().engine().freewheeling()) {
182 // Freewheeling, respond immediately in this (audio) thread
183 return (LV2_Worker_Status)plugin->work_response(size, data);
185 // Enqueue response for the worker
186 return plugin->worker()->respond(size, data) ?
187 LV2_WORKER_SUCCESS : LV2_WORKER_ERR_UNKNOWN;
194 log_vprintf(LV2_Log_Handle /*handle*/,
200 const int ret = g_vasprintf(&str, fmt, args);
201 if (type == LV2Plugin::urids.log_Error) {
202 error << str << endmsg;
203 } else if (type == LV2Plugin::urids.log_Warning) {
204 warning << str << endmsg;
205 } else if (type == LV2Plugin::urids.log_Note) {
206 info << str << endmsg;
208 // TODO: Toggleable log:Trace message support
213 log_printf(LV2_Log_Handle handle,
215 const char* fmt, ...)
219 const int ret = log_vprintf(handle, type, fmt, args);
224 struct LV2Plugin::Impl {
225 Impl() : plugin(0), ui(0), ui_type(0), name(0), author(0), instance(0)
230 /** Find the LV2 input port with the given designation.
231 * If found, bufptrs[port_index] will be set to bufptr.
233 const LilvPort* designated_input (const char* uri, void** bufptrs[], void** bufptr);
235 const LilvPlugin* plugin;
237 const LilvNode* ui_type;
240 LilvInstance* instance;
241 const LV2_Worker_Interface* work_iface;
243 LV2_Atom_Forge forge;
246 LV2Plugin::LV2Plugin (AudioEngine& engine,
248 const void* c_plugin,
250 : Plugin (engine, session)
257 init(c_plugin, rate);
260 LV2Plugin::LV2Plugin (const LV2Plugin& other)
266 , _insert_id(other._insert_id)
268 init(other._impl->plugin, other._sample_rate);
270 for (uint32_t i = 0; i < parameter_count(); ++i) {
271 _control_data[i] = other._shadow_data[i];
272 _shadow_data[i] = other._shadow_data[i];
277 LV2Plugin::init(const void* c_plugin, framecnt_t rate)
279 DEBUG_TRACE(DEBUG::LV2, "init\n");
281 _impl->plugin = (const LilvPlugin*)c_plugin;
283 _impl->ui_type = NULL;
288 _atom_ev_buffers = 0;
290 _bpm_control_port = 0;
291 _freewheel_control_port = 0;
292 _latency_control_port = 0;
293 _next_cycle_start = std::numeric_limits<framepos_t>::max();
294 _next_cycle_speed = 1.0;
295 _block_length = _engine.samples_per_cycle();
296 _seq_size = _engine.raw_buffer_size(DataType::MIDI);
298 _was_activated = false;
299 _has_state_interface = false;
301 _instance_access_feature.URI = "http://lv2plug.in/ns/ext/instance-access";
302 _data_access_feature.URI = "http://lv2plug.in/ns/ext/data-access";
303 _make_path_feature.URI = LV2_STATE__makePath;
304 _log_feature.URI = LV2_LOG__log;
305 _work_schedule_feature.URI = LV2_WORKER__schedule;
306 _work_schedule_feature.data = NULL;
307 _def_state_feature.URI = LV2_STATE_PREFIX "loadDefaultState"; // Post LV2-1.2.0
308 _def_state_feature.data = NULL;
310 const LilvPlugin* plugin = _impl->plugin;
312 LilvNode* state_iface_uri = lilv_new_uri(_world.world, LV2_STATE__interface);
313 LilvNode* state_uri = lilv_new_uri(_world.world, LV2_STATE_URI);
314 _has_state_interface =
315 // What plugins should have (lv2:extensionData state:Interface)
316 lilv_plugin_has_extension_data(plugin, state_iface_uri)
317 // What some outdated/incorrect ones have
318 || lilv_plugin_has_feature(plugin, state_uri);
319 lilv_node_free(state_uri);
320 lilv_node_free(state_iface_uri);
322 _features = (LV2_Feature**)calloc(11, sizeof(LV2_Feature*));
323 _features[0] = &_instance_access_feature;
324 _features[1] = &_data_access_feature;
325 _features[2] = &_make_path_feature;
326 _features[3] = _uri_map.uri_map_feature();
327 _features[4] = _uri_map.urid_map_feature();
328 _features[5] = _uri_map.urid_unmap_feature();
329 _features[6] = &_log_feature;
331 unsigned n_features = 7;
333 _features[n_features++] = &_def_state_feature;
336 lv2_atom_forge_init(&_impl->forge, _uri_map.urid_map());
339 LV2_URID atom_Int = _uri_map.uri_to_id(LV2_ATOM__Int);
340 LV2_Options_Option options[] = {
341 { LV2_OPTIONS_INSTANCE, 0, _uri_map.uri_to_id(LV2_BUF_SIZE__minBlockLength),
342 sizeof(int32_t), atom_Int, &_block_length },
343 { LV2_OPTIONS_INSTANCE, 0, _uri_map.uri_to_id(LV2_BUF_SIZE__maxBlockLength),
344 sizeof(int32_t), atom_Int, &_block_length },
345 { LV2_OPTIONS_INSTANCE, 0, _uri_map.uri_to_id(LV2_BUF_SIZE__sequenceSize),
346 sizeof(int32_t), atom_Int, &_seq_size },
347 { LV2_OPTIONS_INSTANCE, 0, 0, 0, 0, NULL }
350 _options_feature.URI = LV2_OPTIONS__options;
351 _options_feature.data = options;
352 _features[n_features++] = &_options_feature;
355 LV2_State_Make_Path* make_path = (LV2_State_Make_Path*)malloc(
356 sizeof(LV2_State_Make_Path));
357 make_path->handle = this;
358 make_path->path = &lv2_state_make_path;
359 _make_path_feature.data = make_path;
361 LV2_Log_Log* log = (LV2_Log_Log*)malloc(sizeof(LV2_Log_Log));
363 log->printf = &log_printf;
364 log->vprintf = &log_vprintf;
365 _log_feature.data = log;
367 LilvNode* worker_schedule = lilv_new_uri(_world.world, LV2_WORKER__schedule);
368 if (lilv_plugin_has_feature(plugin, worker_schedule)) {
369 LV2_Worker_Schedule* schedule = (LV2_Worker_Schedule*)malloc(
370 sizeof(LV2_Worker_Schedule));
371 size_t buf_size = _session.engine().raw_buffer_size(DataType::MIDI) * NBUFS;
372 _worker = new Worker(this, buf_size);
373 schedule->handle = this;
374 schedule->schedule_work = work_schedule;
375 _work_schedule_feature.data = schedule;
376 _features[n_features++] = &_work_schedule_feature;
378 lilv_node_free(worker_schedule);
380 _impl->instance = lilv_plugin_instantiate(plugin, rate, _features);
381 _impl->name = lilv_plugin_get_name(plugin);
382 _impl->author = lilv_plugin_get_author_name(plugin);
384 if (_impl->instance == 0) {
385 error << _("LV2: Failed to instantiate plugin ") << uri() << endmsg;
386 throw failed_constructor();
389 _instance_access_feature.data = (void*)_impl->instance->lv2_handle;
390 _data_access_extension_data.extension_data = _impl->instance->lv2_descriptor->extension_data;
391 _data_access_feature.data = &_data_access_extension_data;
393 LilvNode* worker_iface_uri = lilv_new_uri(_world.world, LV2_WORKER__interface);
394 if (lilv_plugin_has_extension_data(plugin, worker_iface_uri)) {
395 _impl->work_iface = (const LV2_Worker_Interface*)extension_data(
396 LV2_WORKER__interface);
398 lilv_node_free(worker_iface_uri);
400 if (lilv_plugin_has_feature(plugin, _world.lv2_inPlaceBroken)) {
401 error << string_compose(
402 _("LV2: \"%1\" cannot be used, since it cannot do inplace processing"),
403 lilv_node_as_string(_impl->name)) << endmsg;
404 lilv_node_free(_impl->name);
405 lilv_node_free(_impl->author);
406 throw failed_constructor();
410 // Load default state
411 LilvState* state = lilv_state_new_from_world(
412 _world.world, _uri_map.urid_map(), lilv_plugin_get_uri(_impl->plugin));
413 if (state && _has_state_interface) {
414 lilv_state_restore(state, _impl->instance, NULL, NULL, 0, NULL);
420 const uint32_t num_ports = this->num_ports();
421 for (uint32_t i = 0; i < num_ports; ++i) {
422 const LilvPort* port = lilv_plugin_get_port_by_index(_impl->plugin, i);
424 size_t minimumSize = 0;
426 if (lilv_port_is_a(_impl->plugin, port, _world.lv2_OutputPort)) {
427 flags |= PORT_OUTPUT;
428 } else if (lilv_port_is_a(_impl->plugin, port, _world.lv2_InputPort)) {
431 error << string_compose(
432 "LV2: \"%1\" port %2 is neither input nor output",
433 lilv_node_as_string(_impl->name), i) << endmsg;
434 throw failed_constructor();
437 if (lilv_port_is_a(_impl->plugin, port, _world.lv2_ControlPort)) {
438 flags |= PORT_CONTROL;
439 } else if (lilv_port_is_a(_impl->plugin, port, _world.lv2_AudioPort)) {
441 } else if (lilv_port_is_a(_impl->plugin, port, _world.ev_EventPort)) {
443 flags |= PORT_MIDI; // We assume old event API ports are for MIDI
444 } else if (lilv_port_is_a(_impl->plugin, port, _world.atom_AtomPort)) {
445 LilvNodes* buffer_types = lilv_port_get_value(
446 _impl->plugin, port, _world.atom_bufferType);
447 LilvNodes* atom_supports = lilv_port_get_value(
448 _impl->plugin, port, _world.atom_supports);
450 if (lilv_nodes_contains(buffer_types, _world.atom_Sequence)) {
451 flags |= PORT_SEQUENCE;
452 if (lilv_nodes_contains(atom_supports, _world.midi_MidiEvent)) {
455 if (lilv_nodes_contains(atom_supports, _world.time_Position)) {
456 flags |= PORT_POSITION;
459 LilvNodes* min_size_v = lilv_port_get_value(_impl->plugin, port, _world.rsz_minimumSize);
460 LilvNode* min_size = min_size_v ? lilv_nodes_get_first(min_size_v) : NULL;
461 if (min_size && lilv_node_is_int(min_size)) {
462 minimumSize = lilv_node_as_int(min_size);
464 lilv_nodes_free(min_size_v);
465 lilv_nodes_free(buffer_types);
466 lilv_nodes_free(atom_supports);
468 error << string_compose(
469 "LV2: \"%1\" port %2 has no known data type",
470 lilv_node_as_string(_impl->name), i) << endmsg;
471 throw failed_constructor();
474 _port_flags.push_back(flags);
475 _port_minimumSize.push_back(minimumSize);
478 _control_data = new float[num_ports];
479 _shadow_data = new float[num_ports];
480 _defaults = new float[num_ports];
481 _ev_buffers = new LV2_Evbuf*[num_ports];
482 memset(_ev_buffers, 0, sizeof(LV2_Evbuf*) * num_ports);
484 const bool latent = lilv_plugin_has_latency(plugin);
485 const uint32_t latency_index = (latent)
486 ? lilv_plugin_get_latency_port_index(plugin)
489 // Build an array of pointers to special parameter buffers
490 void*** params = new void**[num_ports];
491 for (uint32_t i = 0; i < num_ports; ++i) {
494 _impl->designated_input (LV2_TIME__beatsPerMinute, params, (void**)&_bpm_control_port);
495 _impl->designated_input (LV2_CORE__freeWheeling, params, (void**)&_freewheel_control_port);
497 for (uint32_t i = 0; i < num_ports; ++i) {
498 const LilvPort* port = lilv_plugin_get_port_by_index(plugin, i);
499 const LilvNode* sym = lilv_port_get_symbol(plugin, port);
501 // Store index in map so we can look up index by symbol
502 _port_indices.insert(std::make_pair(lilv_node_as_string(sym), i));
504 // Get range and default value if applicable
505 if (parameter_is_control(i)) {
507 lilv_port_get_range(plugin, port, &def, NULL, NULL);
508 _defaults[i] = def ? lilv_node_as_float(def) : 0.0f;
509 if (lilv_port_has_property (plugin, port, _world.lv2_sampleRate)) {
510 _defaults[i] *= _session.frame_rate ();
514 lilv_instance_connect_port(_impl->instance, i, &_control_data[i]);
516 if (latent && i == latency_index) {
517 _latency_control_port = &_control_data[i];
518 *_latency_control_port = 0;
521 if (parameter_is_input(i)) {
522 _shadow_data[i] = default_value(i);
524 *params[i] = (void*)&_shadow_data[i];
534 LilvUIs* uis = lilv_plugin_get_uis(plugin);
535 if (lilv_uis_size(uis) > 0) {
537 // Look for embeddable UI
538 LILV_FOREACH(uis, u, uis) {
539 const LilvUI* this_ui = lilv_uis_get(uis, u);
540 const LilvNode* this_ui_type = NULL;
541 if (lilv_ui_is_supported(this_ui,
545 // TODO: Multiple UI support
547 _impl->ui_type = this_ui_type;
552 // Look for Gtk native UI
553 LILV_FOREACH(uis, i, uis) {
554 const LilvUI* ui = lilv_uis_get(uis, i);
555 if (lilv_ui_is_a(ui, _world.ui_GtkUI)) {
557 _impl->ui_type = _world.ui_GtkUI;
563 // If Gtk UI is not available, try to find external UI
565 LILV_FOREACH(uis, i, uis) {
566 const LilvUI* ui = lilv_uis_get(uis, i);
567 if (lilv_ui_is_a(ui, _world.ui_externalkx)) {
569 _impl->ui_type = _world.ui_external;
572 if (lilv_ui_is_a(ui, _world.ui_external)) {
574 _impl->ui_type = _world.ui_external;
580 allocate_atom_event_buffers();
581 latency_compute_run();
584 LV2Plugin::~LV2Plugin ()
586 DEBUG_TRACE(DEBUG::LV2, string_compose("%1 destroy\n", name()));
591 lilv_instance_free(_impl->instance);
592 lilv_node_free(_impl->name);
593 lilv_node_free(_impl->author);
596 free(_make_path_feature.data);
597 free(_work_schedule_feature.data);
603 if (_atom_ev_buffers) {
604 LV2_Evbuf** b = _atom_ev_buffers;
609 free(_atom_ev_buffers);
612 delete [] _control_data;
613 delete [] _shadow_data;
614 delete [] _ev_buffers;
618 LV2Plugin::is_external_ui() const
623 return lilv_ui_is_a(_impl->ui, _world.ui_external) || lilv_ui_is_a(_impl->ui, _world.ui_externalkx);
627 LV2Plugin::is_external_kx() const
632 return lilv_ui_is_a(_impl->ui, _world.ui_externalkx);
636 LV2Plugin::ui_is_resizable () const
638 const LilvNode* s = lilv_ui_get_uri(_impl->ui);
639 LilvNode* p = lilv_new_uri(_world.world, LV2_CORE__optionalFeature);
640 LilvNode* fs = lilv_new_uri(_world.world, LV2_UI__fixedSize);
641 LilvNode* nrs = lilv_new_uri(_world.world, LV2_UI__noUserResize);
643 LilvNodes* fs_matches = lilv_world_find_nodes(_world.world, s, p, fs);
644 LilvNodes* nrs_matches = lilv_world_find_nodes(_world.world, s, p, nrs);
646 lilv_nodes_free(nrs_matches);
647 lilv_nodes_free(fs_matches);
652 return !fs_matches && !nrs_matches;
656 LV2Plugin::unique_id() const
658 return lilv_node_as_uri(lilv_plugin_get_uri(_impl->plugin));
662 LV2Plugin::uri() const
664 return lilv_node_as_uri(lilv_plugin_get_uri(_impl->plugin));
668 LV2Plugin::label() const
670 return lilv_node_as_string(_impl->name);
674 LV2Plugin::name() const
676 return lilv_node_as_string(_impl->name);
680 LV2Plugin::maker() const
682 return _impl->author ? lilv_node_as_string (_impl->author) : "Unknown";
686 LV2Plugin::num_ports() const
688 return lilv_plugin_get_num_ports(_impl->plugin);
692 LV2Plugin::parameter_count() const
694 return lilv_plugin_get_num_ports(_impl->plugin);
698 LV2Plugin::default_value(uint32_t port)
700 return _defaults[port];
704 LV2Plugin::port_symbol(uint32_t index) const
706 const LilvPort* port = lilv_plugin_get_port_by_index(_impl->plugin, index);
708 error << name() << ": Invalid port index " << index << endmsg;
711 const LilvNode* sym = lilv_port_get_symbol(_impl->plugin, port);
712 return lilv_node_as_string(sym);
716 LV2Plugin::port_index (const char* symbol) const
718 const map<string, uint32_t>::const_iterator i = _port_indices.find(symbol);
719 if (i != _port_indices.end()) {
722 warning << string_compose(_("LV2: Unknown port %1"), symbol) << endmsg;
728 LV2Plugin::set_parameter(uint32_t which, float val)
730 DEBUG_TRACE(DEBUG::LV2, string_compose(
731 "%1 set parameter %2 to %3\n", name(), which, val));
733 if (which < lilv_plugin_get_num_ports(_impl->plugin)) {
734 if (get_parameter (which) == val) {
738 _shadow_data[which] = val;
740 warning << string_compose(
741 _("Illegal parameter number used with plugin \"%1\". "
742 "This is a bug in either %2 or the LV2 plugin <%3>"),
743 name(), PROGRAM_NAME, unique_id()) << endmsg;
746 Plugin::set_parameter(which, val);
750 LV2Plugin::get_parameter(uint32_t which) const
752 if (parameter_is_input(which)) {
753 return (float)_shadow_data[which];
755 return (float)_control_data[which];
761 LV2Plugin::get_docs() const
763 LilvNodes* comments = lilv_plugin_get_value(_impl->plugin, _world.rdfs_comment);
765 const std::string docs(lilv_node_as_string(lilv_nodes_get_first(comments)));
766 lilv_nodes_free(comments);
774 LV2Plugin::get_parameter_docs(uint32_t which) const
776 LilvNodes* comments = lilv_port_get_value(
778 lilv_plugin_get_port_by_index(_impl->plugin, which),
779 _world.rdfs_comment);
782 const std::string docs(lilv_node_as_string(lilv_nodes_get_first(comments)));
783 lilv_nodes_free(comments);
791 LV2Plugin::nth_parameter(uint32_t n, bool& ok) const
794 for (uint32_t c = 0, x = 0; x < lilv_plugin_get_num_ports(_impl->plugin); ++x) {
795 if (parameter_is_control(x)) {
807 LV2Plugin::extension_data(const char* uri) const
809 return lilv_instance_get_extension_data(_impl->instance, uri);
813 LV2Plugin::c_plugin()
815 return _impl->plugin;
821 return (const void*)_impl->ui;
825 LV2Plugin::c_ui_type()
827 return (const void*)_impl->ui_type;
830 /** Directory for all plugin state. */
832 LV2Plugin::plugin_dir() const
834 return Glib::build_filename(_session.plugins_dir(), _insert_id.to_s());
837 /** Directory for files created by the plugin (except during save). */
839 LV2Plugin::scratch_dir() const
841 return Glib::build_filename(plugin_dir(), "scratch");
844 /** Directory for snapshots of files in the scratch directory. */
846 LV2Plugin::file_dir() const
848 return Glib::build_filename(plugin_dir(), "files");
851 /** Directory to save state snapshot version @c num into. */
853 LV2Plugin::state_dir(unsigned num) const
855 return Glib::build_filename(plugin_dir(), string_compose("state%1", num));
858 /** Implementation of state:makePath for files created at instantiation time.
859 * Note this is not used for files created at save time (Lilv deals with that).
862 LV2Plugin::lv2_state_make_path(LV2_State_Make_Path_Handle handle,
865 LV2Plugin* me = (LV2Plugin*)handle;
866 if (me->_insert_id == PBD::ID("0")) {
867 warning << string_compose(
868 "File path \"%1\" requested but LV2 %2 has no insert ID",
869 path, me->name()) << endmsg;
870 return g_strdup(path);
873 const std::string abs_path = Glib::build_filename(me->scratch_dir(), path);
874 const std::string dirname = Glib::path_get_dirname(abs_path);
875 g_mkdir_with_parents(dirname.c_str(), 0744);
877 DEBUG_TRACE(DEBUG::LV2, string_compose("new file path %1 => %2\n",
880 return g_strndup(abs_path.c_str(), abs_path.length());
884 remove_directory(const std::string& path)
886 if (!Glib::file_test(path, Glib::FILE_TEST_IS_DIR)) {
887 warning << string_compose("\"%1\" is not a directory", path) << endmsg;
891 Glib::RefPtr<Gio::File> dir = Gio::File::create_for_path(path);
892 Glib::RefPtr<Gio::FileEnumerator> e = dir->enumerate_children();
893 Glib::RefPtr<Gio::FileInfo> fi;
894 while ((fi = e->next_file())) {
895 if (fi->get_type() == Gio::FILE_TYPE_DIRECTORY) {
896 remove_directory(fi->get_name());
898 dir->get_child(fi->get_name())->remove();
905 LV2Plugin::add_state(XMLNode* root) const
907 assert(_insert_id != PBD::ID("0"));
911 LocaleGuard lg(X_("POSIX"));
913 for (uint32_t i = 0; i < parameter_count(); ++i) {
914 if (parameter_is_input(i) && parameter_is_control(i)) {
915 child = new XMLNode("Port");
916 child->add_property("symbol", port_symbol(i));
917 snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
918 child->add_property("value", string(buf));
919 root->add_child_nocopy(*child);
923 if (_has_state_interface) {
924 // Provisionally increment state version and create directory
925 const std::string new_dir = state_dir(++_state_version);
926 g_mkdir_with_parents(new_dir.c_str(), 0744);
928 LilvState* state = lilv_state_new_from_instance(
932 scratch_dir().c_str(),
934 _session.externals_dir().c_str(),
937 const_cast<LV2Plugin*>(this),
941 if (!_impl->state || !lilv_state_equals(state, _impl->state)) {
942 lilv_state_save(_world.world,
944 _uri_map.urid_unmap(),
950 lilv_state_free(_impl->state);
951 _impl->state = state;
953 // State is identical, decrement version and nuke directory
954 lilv_state_free(state);
955 remove_directory(new_dir);
959 root->add_property("state-dir", string_compose("state%1", _state_version));
963 static inline const LilvNode*
964 get_value(LilvWorld* world, const LilvNode* subject, const LilvNode* predicate)
966 LilvNodes* vs = lilv_world_find_nodes(world, subject, predicate, NULL);
967 return vs ? lilv_nodes_get_first(vs) : NULL;
971 LV2Plugin::find_presets()
973 LilvNode* lv2_appliesTo = lilv_new_uri(_world.world, LV2_CORE__appliesTo);
974 LilvNode* pset_Preset = lilv_new_uri(_world.world, LV2_PRESETS__Preset);
975 LilvNode* rdfs_label = lilv_new_uri(_world.world, LILV_NS_RDFS "label");
977 LilvNodes* presets = lilv_plugin_get_related(_impl->plugin, pset_Preset);
978 LILV_FOREACH(nodes, i, presets) {
979 const LilvNode* preset = lilv_nodes_get(presets, i);
980 lilv_world_load_resource(_world.world, preset);
981 const LilvNode* name = get_value(_world.world, preset, rdfs_label);
983 _presets.insert(std::make_pair(lilv_node_as_string(preset),
984 Plugin::PresetRecord(
985 lilv_node_as_string(preset),
986 lilv_node_as_string(name))));
988 warning << string_compose(
989 _("Plugin \"%1\" preset \"%2\" is missing a label\n"),
990 lilv_node_as_string(lilv_plugin_get_uri(_impl->plugin)),
991 lilv_node_as_string(preset)) << endmsg;
994 lilv_nodes_free(presets);
996 lilv_node_free(rdfs_label);
997 lilv_node_free(pset_Preset);
998 lilv_node_free(lv2_appliesTo);
1002 set_port_value(const char* port_symbol,
1008 LV2Plugin* self = (LV2Plugin*)user_data;
1009 if (type != 0 && type != self->_uri_map.uri_to_id(LV2_ATOM__Float)) {
1010 return; // TODO: Support non-float ports
1013 const uint32_t port_index = self->port_index(port_symbol);
1014 if (port_index != (uint32_t)-1) {
1015 self->set_parameter(port_index, *(const float*)value);
1020 LV2Plugin::load_preset(PresetRecord r)
1022 LilvWorld* world = _world.world;
1023 LilvNode* pset = lilv_new_uri(world, r.uri.c_str());
1024 LilvState* state = lilv_state_new_from_world(world, _uri_map.urid_map(), pset);
1027 lilv_state_restore(state, _impl->instance, set_port_value, this, 0, NULL);
1028 lilv_state_free(state);
1031 lilv_node_free(pset);
1036 ARDOUR::lv2plugin_get_port_value(const char* port_symbol,
1041 LV2Plugin *plugin = (LV2Plugin *) user_data;
1043 uint32_t index = plugin->port_index(port_symbol);
1044 if (index != (uint32_t) -1) {
1045 if (plugin->parameter_is_input(index) && plugin->parameter_is_control(index)) {
1047 *size = sizeof(float);
1048 *type = plugin->_uri_map.uri_to_id(LV2_ATOM__Float);
1049 value = &plugin->_shadow_data[index];
1061 LV2Plugin::do_save_preset(string name)
1063 const string base_name = legalize_for_uri(name);
1064 const string file_name = base_name + ".ttl";
1065 const string bundle = Glib::build_filename(
1066 Glib::get_home_dir(),
1067 Glib::build_filename(".lv2", base_name + ".lv2"));
1069 LilvState* state = lilv_state_new_from_instance(
1072 _uri_map.urid_map(),
1073 scratch_dir().c_str(), // file_dir
1074 bundle.c_str(), // copy_dir
1075 bundle.c_str(), // link_dir
1076 bundle.c_str(), // save_dir
1077 lv2plugin_get_port_value, // get_value
1078 (void*)this, // user_data
1079 LV2_STATE_IS_POD|LV2_STATE_IS_PORTABLE, // flags
1080 _features // features
1083 lilv_state_set_label(state, name.c_str());
1085 _world.world, // world
1086 _uri_map.urid_map(), // map
1087 _uri_map.urid_unmap(), // unmap
1089 NULL, // uri (NULL = use file URI)
1090 bundle.c_str(), // dir
1091 file_name.c_str() // filename
1094 lilv_state_free(state);
1096 return Glib::filename_to_uri(Glib::build_filename(bundle, file_name));
1100 LV2Plugin::do_remove_preset(string name)
1102 string preset_file = Glib::build_filename(
1103 Glib::get_home_dir(),
1104 Glib::build_filename(
1105 Glib::build_filename(".lv2", "presets"),
1109 unlink(preset_file.c_str());
1113 LV2Plugin::has_editor() const
1115 return _impl->ui != NULL;
1119 LV2Plugin::has_message_output() const
1121 for (uint32_t i = 0; i < num_ports(); ++i) {
1122 if ((_port_flags[i] & PORT_SEQUENCE) &&
1123 (_port_flags[i] & PORT_OUTPUT)) {
1131 LV2Plugin::write_to(RingBuffer<uint8_t>* dest,
1135 const uint8_t* body)
1137 const uint32_t buf_size = sizeof(UIMessage) + size;
1138 uint8_t buf[buf_size];
1140 UIMessage* msg = (UIMessage*)buf;
1142 msg->protocol = protocol;
1144 memcpy(msg + 1, body, size);
1146 return (dest->write(buf, buf_size) == buf_size);
1150 LV2Plugin::write_from_ui(uint32_t index,
1153 const uint8_t* body)
1156 size_t rbs = _session.engine().raw_buffer_size(DataType::MIDI) * NBUFS;
1157 /* buffer data communication from plugin UI to plugin instance.
1158 * this buffer needs to potentially hold
1159 * (port's minimumSize) * (audio-periods) / (UI-periods)
1162 * e.g 48kSPS / 128fpp -> audio-periods = 375 Hz
1163 * ui-periods = 25 Hz (SuperRapidScreenUpdate)
1164 * default minimumSize = 32K (see LV2Plugin::allocate_atom_event_buffers()
1166 * it is safe to overflow (but the plugin state may be inconsistent).
1168 rbs = max((size_t) 32768 * 6, rbs);
1169 _from_ui = new RingBuffer<uint8_t>(rbs);
1172 if (!write_to(_from_ui, index, protocol, size, body)) {
1173 error << "Error writing from UI to plugin" << endmsg;
1180 LV2Plugin::write_to_ui(uint32_t index,
1183 const uint8_t* body)
1185 if (!write_to(_to_ui, index, protocol, size, body)) {
1186 error << "Error writing from plugin to UI" << endmsg;
1193 LV2Plugin::enable_ui_emmission()
1196 /* see note in LV2Plugin::write_from_ui() */
1197 size_t rbs = _session.engine().raw_buffer_size(DataType::MIDI) * NBUFS;
1198 rbs = max((size_t) 32768 * 8, rbs);
1199 _to_ui = new RingBuffer<uint8_t>(rbs);
1204 LV2Plugin::emit_to_ui(void* controller, UIMessageSink sink)
1210 uint32_t read_space = _to_ui->read_space();
1211 while (read_space > sizeof(UIMessage)) {
1213 if (_to_ui->read((uint8_t*)&msg, sizeof(msg)) != sizeof(msg)) {
1214 error << "Error reading from Plugin=>UI RingBuffer" << endmsg;
1217 uint8_t body[msg.size];
1218 if (_to_ui->read(body, msg.size) != msg.size) {
1219 error << "Error reading from Plugin=>UI RingBuffer" << endmsg;
1223 sink(controller, msg.index, msg.size, msg.protocol, body);
1225 read_space -= sizeof(msg) + msg.size;
1230 LV2Plugin::work(uint32_t size, const void* data)
1232 return _impl->work_iface->work(
1233 _impl->instance->lv2_handle, work_respond, this, size, data);
1237 LV2Plugin::work_response(uint32_t size, const void* data)
1239 return _impl->work_iface->work_response(
1240 _impl->instance->lv2_handle, size, data);
1244 LV2Plugin::set_insert_info(const PluginInsert* insert)
1246 _insert_id = insert->id();
1250 LV2Plugin::set_state(const XMLNode& node, int version)
1253 const XMLProperty* prop;
1254 XMLNodeConstIterator iter;
1259 LocaleGuard lg(X_("POSIX"));
1261 if (node.name() != state_node_name()) {
1262 error << _("Bad node sent to LV2Plugin::set_state") << endmsg;
1266 #ifndef NO_PLUGIN_STATE
1268 if (version < 3000) {
1269 nodes = node.children("port");
1271 nodes = node.children("Port");
1274 for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
1278 if ((prop = child->property("symbol")) != 0) {
1279 sym = prop->value().c_str();
1281 warning << _("LV2: port has no symbol, ignored") << endmsg;
1285 map<string, uint32_t>::iterator i = _port_indices.find(sym);
1287 if (i != _port_indices.end()) {
1288 port_id = i->second;
1290 warning << _("LV2: port has unknown index, ignored") << endmsg;
1294 if ((prop = child->property("value")) != 0) {
1295 value = prop->value().c_str();
1297 warning << _("LV2: port has no value, ignored") << endmsg;
1301 set_parameter(port_id, atof(value));
1305 if ((prop = node.property("state-dir")) != 0) {
1306 if (sscanf(prop->value().c_str(), "state%u", &_state_version) != 1) {
1307 error << string_compose(
1308 "LV2: failed to parse state version from \"%1\"",
1309 prop->value()) << endmsg;
1312 std::string state_file = Glib::build_filename(
1314 Glib::build_filename(prop->value(), "state.ttl"));
1316 LilvState* state = lilv_state_new_from_file(
1317 _world.world, _uri_map.urid_map(), NULL, state_file.c_str());
1319 lilv_state_restore(state, _impl->instance, NULL, NULL, 0, NULL);
1322 latency_compute_run();
1325 return Plugin::set_state(node, version);
1329 LV2Plugin::get_parameter_descriptor(uint32_t which, ParameterDescriptor& desc) const
1331 const LilvPort* port = lilv_plugin_get_port_by_index(_impl->plugin, which);
1333 LilvNodes* portunits;
1334 LilvNode *def, *min, *max;
1335 lilv_port_get_range(_impl->plugin, port, &def, &min, &max);
1336 portunits = lilv_port_get_value(_impl->plugin, port, _world.units_unit);
1338 desc.integer_step = lilv_port_has_property(_impl->plugin, port, _world.lv2_integer);
1339 desc.toggled = lilv_port_has_property(_impl->plugin, port, _world.lv2_toggled);
1340 desc.logarithmic = lilv_port_has_property(_impl->plugin, port, _world.ext_logarithmic);
1341 desc.sr_dependent = lilv_port_has_property(_impl->plugin, port, _world.lv2_sampleRate);
1342 desc.label = lilv_node_as_string(lilv_port_get_name(_impl->plugin, port));
1343 desc.lower = min ? lilv_node_as_float(min) : 0.0f;
1344 desc.upper = max ? lilv_node_as_float(max) : 1.0f;
1345 desc.midinote = lilv_nodes_contains(portunits, _world.units_midiNote);
1347 if (desc.sr_dependent) {
1348 desc.lower *= _session.frame_rate ();
1349 desc.upper *= _session.frame_rate ();
1352 desc.min_unbound = false; // TODO: LV2 extension required
1353 desc.max_unbound = false; // TODO: LV2 extension required
1355 if (desc.integer_step) {
1357 desc.smallstep = 0.1;
1358 desc.largestep = 10.0;
1360 const float delta = desc.upper - desc.lower;
1361 desc.step = delta / 1000.0f;
1362 desc.smallstep = delta / 10000.0f;
1363 desc.largestep = delta / 10.0f;
1366 desc.enumeration = lilv_port_has_property(_impl->plugin, port, _world.lv2_enumeration);
1368 lilv_node_free(def);
1369 lilv_node_free(min);
1370 lilv_node_free(max);
1371 lilv_nodes_free(portunits);
1377 LV2Plugin::describe_parameter(Evoral::Parameter which)
1379 if (( which.type() == PluginAutomation) && ( which.id() < parameter_count()) ) {
1381 if (lilv_port_has_property(_impl->plugin,
1382 lilv_plugin_get_port_by_index(_impl->plugin, which.id()), _world.ext_notOnGUI)) {
1383 return X_("hidden");
1386 if (lilv_port_has_property(_impl->plugin,
1387 lilv_plugin_get_port_by_index(_impl->plugin, which.id()), _world.lv2_freewheeling)) {
1388 return X_("hidden");
1391 if (lilv_port_has_property(_impl->plugin,
1392 lilv_plugin_get_port_by_index(_impl->plugin, which.id()), _world.lv2_reportsLatency)) {
1393 return X_("latency");
1396 LilvNode* name = lilv_port_get_name(_impl->plugin,
1397 lilv_plugin_get_port_by_index(_impl->plugin, which.id()));
1398 string ret(lilv_node_as_string(name));
1399 lilv_node_free(name);
1407 LV2Plugin::signal_latency() const
1409 if (_latency_control_port) {
1410 return (framecnt_t)floor(*_latency_control_port);
1416 set<Evoral::Parameter>
1417 LV2Plugin::automatable() const
1419 set<Evoral::Parameter> ret;
1421 for (uint32_t i = 0; i < parameter_count(); ++i) {
1422 if (parameter_is_input(i) && parameter_is_control(i)) {
1423 ret.insert(ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
1431 LV2Plugin::activate()
1433 DEBUG_TRACE(DEBUG::LV2, string_compose("%1 activate\n", name()));
1435 if (!_was_activated) {
1436 lilv_instance_activate(_impl->instance);
1437 _was_activated = true;
1442 LV2Plugin::deactivate()
1444 DEBUG_TRACE(DEBUG::LV2, string_compose("%1 deactivate\n", name()));
1446 if (_was_activated) {
1447 lilv_instance_deactivate(_impl->instance);
1448 _was_activated = false;
1453 LV2Plugin::cleanup()
1455 DEBUG_TRACE(DEBUG::LV2, string_compose("%1 cleanup\n", name()));
1459 lilv_instance_free(_impl->instance);
1460 _impl->instance = NULL;
1464 LV2Plugin::allocate_atom_event_buffers()
1466 /* reserve local scratch buffers for ATOM event-queues */
1467 const LilvPlugin* p = _impl->plugin;
1469 /* count non-MIDI atom event-ports
1470 * TODO: nicely ask drobilla to make a lilv_ call for that
1472 int count_atom_out = 0;
1473 int count_atom_in = 0;
1474 int minimumSize = 32768; // TODO use a per-port minimum-size
1475 for (uint32_t i = 0; i < lilv_plugin_get_num_ports(p); ++i) {
1476 const LilvPort* port = lilv_plugin_get_port_by_index(p, i);
1477 if (lilv_port_is_a(p, port, _world.atom_AtomPort)) {
1478 LilvNodes* buffer_types = lilv_port_get_value(
1479 p, port, _world.atom_bufferType);
1480 LilvNodes* atom_supports = lilv_port_get_value(
1481 p, port, _world.atom_supports);
1483 if (!lilv_nodes_contains(buffer_types, _world.atom_Sequence)
1484 || !lilv_nodes_contains(atom_supports, _world.midi_MidiEvent)) {
1485 if (lilv_port_is_a(p, port, _world.lv2_InputPort)) {
1488 if (lilv_port_is_a(p, port, _world.lv2_OutputPort)) {
1491 LilvNodes* min_size_v = lilv_port_get_value(_impl->plugin, port, _world.rsz_minimumSize);
1492 LilvNode* min_size = min_size_v ? lilv_nodes_get_first(min_size_v) : NULL;
1493 if (min_size && lilv_node_is_int(min_size)) {
1494 minimumSize = std::max(minimumSize, lilv_node_as_int(min_size));
1496 lilv_nodes_free(min_size_v);
1498 lilv_nodes_free(buffer_types);
1499 lilv_nodes_free(atom_supports);
1503 DEBUG_TRACE(DEBUG::LV2, string_compose("%1 need buffers for %2 atom-in and %3 atom-out event-ports\n",
1504 name(), count_atom_in, count_atom_out));
1506 const int total_atom_buffers = (count_atom_in + count_atom_out);
1507 if (_atom_ev_buffers || total_atom_buffers == 0) {
1511 DEBUG_TRACE(DEBUG::LV2, string_compose("allocate %1 atom_ev_buffers of %d bytes\n", total_atom_buffers, minimumSize));
1512 _atom_ev_buffers = (LV2_Evbuf**) malloc((total_atom_buffers + 1) * sizeof(LV2_Evbuf*));
1513 for (int i = 0; i < total_atom_buffers; ++i ) {
1514 _atom_ev_buffers[i] = lv2_evbuf_new(minimumSize, LV2_EVBUF_ATOM,
1515 LV2Plugin::urids.atom_Chunk, LV2Plugin::urids.atom_Sequence);
1517 _atom_ev_buffers[total_atom_buffers] = 0;
1521 /** Write an ardour position/time/tempo/meter as an LV2 event.
1522 * @return true on success.
1525 write_position(LV2_Atom_Forge* forge,
1527 const TempoMetric& t,
1528 Timecode::BBT_Time& bbt,
1530 framepos_t position,
1533 uint8_t pos_buf[256];
1534 lv2_atom_forge_set_buffer(forge, pos_buf, sizeof(pos_buf));
1535 LV2_Atom_Forge_Frame frame;
1536 lv2_atom_forge_blank(forge, &frame, 1, LV2Plugin::urids.time_Position);
1537 lv2_atom_forge_property_head(forge, LV2Plugin::urids.time_frame, 0);
1538 lv2_atom_forge_long(forge, position);
1539 lv2_atom_forge_property_head(forge, LV2Plugin::urids.time_speed, 0);
1540 lv2_atom_forge_float(forge, speed);
1541 lv2_atom_forge_property_head(forge, LV2Plugin::urids.time_barBeat, 0);
1542 lv2_atom_forge_float(forge, bbt.beats - 1 +
1543 (bbt.ticks / Timecode::BBT_Time::ticks_per_beat));
1544 lv2_atom_forge_property_head(forge, LV2Plugin::urids.time_bar, 0);
1545 lv2_atom_forge_long(forge, bbt.bars - 1);
1546 lv2_atom_forge_property_head(forge, LV2Plugin::urids.time_beatUnit, 0);
1547 lv2_atom_forge_int(forge, t.meter().note_divisor());
1548 lv2_atom_forge_property_head(forge, LV2Plugin::urids.time_beatsPerBar, 0);
1549 lv2_atom_forge_float(forge, t.meter().divisions_per_bar());
1550 lv2_atom_forge_property_head(forge, LV2Plugin::urids.time_beatsPerMinute, 0);
1551 lv2_atom_forge_float(forge, t.tempo().beats_per_minute());
1553 LV2_Evbuf_Iterator end = lv2_evbuf_end(buf);
1554 const LV2_Atom* const atom = (const LV2_Atom*)pos_buf;
1555 return lv2_evbuf_write(&end, offset, 0, atom->type, atom->size,
1556 (const uint8_t*)(atom + 1));
1560 LV2Plugin::connect_and_run(BufferSet& bufs,
1561 ChanMapping in_map, ChanMapping out_map,
1562 pframes_t nframes, framecnt_t offset)
1564 DEBUG_TRACE(DEBUG::LV2, string_compose("%1 run %2 offset %3\n", name(), nframes, offset));
1565 Plugin::connect_and_run(bufs, in_map, out_map, nframes, offset);
1567 cycles_t then = get_cycles();
1569 TempoMap& tmap = _session.tempo_map();
1570 Metrics::const_iterator metric_i = tmap.metrics_end();
1571 TempoMetric tmetric = tmap.metric_at(_session.transport_frame(), &metric_i);
1573 if (_freewheel_control_port) {
1574 *_freewheel_control_port = _session.engine().freewheeling();
1577 if (_bpm_control_port) {
1578 *_bpm_control_port = tmetric.tempo().beats_per_minute();
1581 ChanCount bufs_count;
1582 bufs_count.set(DataType::AUDIO, 1);
1583 bufs_count.set(DataType::MIDI, 1);
1584 BufferSet& silent_bufs = _session.get_silent_buffers(bufs_count);
1585 BufferSet& scratch_bufs = _session.get_scratch_buffers(bufs_count);
1586 uint32_t const num_ports = parameter_count();
1587 uint32_t const nil_index = std::numeric_limits<uint32_t>::max();
1589 uint32_t audio_in_index = 0;
1590 uint32_t audio_out_index = 0;
1591 uint32_t midi_in_index = 0;
1592 uint32_t midi_out_index = 0;
1593 uint32_t atom_port_index = 0;
1594 for (uint32_t port_index = 0; port_index < num_ports; ++port_index) {
1596 uint32_t index = nil_index;
1597 PortFlags flags = _port_flags[port_index];
1599 if (flags & PORT_AUDIO) {
1600 if (flags & PORT_INPUT) {
1601 index = in_map.get(DataType::AUDIO, audio_in_index++, &valid);
1603 ? bufs.get_audio(index).data(offset)
1604 : silent_bufs.get_audio(0).data(offset);
1606 index = out_map.get(DataType::AUDIO, audio_out_index++, &valid);
1608 ? bufs.get_audio(index).data(offset)
1609 : scratch_bufs.get_audio(0).data(offset);
1611 } else if (flags & (PORT_EVENT|PORT_SEQUENCE)) {
1612 /* FIXME: The checks here for bufs.count().n_midi() > index shouldn't
1613 be necessary, but the mapping is illegal in some cases. Ideally
1614 that should be fixed, but this is easier...
1616 if (flags & PORT_MIDI) {
1617 if (flags & PORT_INPUT) {
1618 index = in_map.get(DataType::MIDI, midi_in_index++, &valid);
1620 index = out_map.get(DataType::MIDI, midi_out_index++, &valid);
1622 if (valid && bufs.count().n_midi() > index) {
1623 /* Note, ensure_lv2_bufsize() is not RT safe!
1624 * However free()/alloc() is only called if a
1625 * plugin requires a rsz:minimumSize buffersize
1626 * and the existing buffer if smaller.
1628 bufs.ensure_lv2_bufsize((flags & PORT_INPUT), index, _port_minimumSize[port_index]);
1629 _ev_buffers[port_index] = bufs.get_lv2_midi(
1630 (flags & PORT_INPUT), index, (flags & PORT_EVENT));
1632 } else if ((flags & PORT_POSITION) && (flags & PORT_INPUT)) {
1633 lv2_evbuf_reset(_atom_ev_buffers[atom_port_index], true);
1634 _ev_buffers[port_index] = _atom_ev_buffers[atom_port_index++];
1638 if (valid && (flags & PORT_INPUT)) {
1639 Timecode::BBT_Time bbt;
1640 if ((flags & PORT_POSITION)) {
1641 if (_session.transport_frame() != _next_cycle_start ||
1642 _session.transport_speed() != _next_cycle_speed) {
1643 // Transport has changed, write position at cycle start
1644 tmap.bbt_time(_session.transport_frame(), bbt);
1645 write_position(&_impl->forge, _ev_buffers[port_index],
1646 tmetric, bbt, _session.transport_speed(),
1647 _session.transport_frame(), 0);
1651 // Get MIDI iterator range (empty range if no MIDI)
1652 MidiBuffer::iterator m = (index != nil_index)
1653 ? bufs.get_midi(index).begin()
1654 : silent_bufs.get_midi(0).end();
1655 MidiBuffer::iterator m_end = (index != nil_index)
1656 ? bufs.get_midi(index).end()
1659 // Now merge MIDI and any transport events into the buffer
1660 const uint32_t type = LV2Plugin::urids.midi_MidiEvent;
1661 const framepos_t tend = _session.transport_frame() + nframes;
1663 while (m != m_end || (metric_i != tmap.metrics_end() &&
1664 (*metric_i)->frame() < tend)) {
1665 MetricSection* metric = (metric_i != tmap.metrics_end())
1667 if (m != m_end && (!metric || metric->frame() > (*m).time())) {
1668 const Evoral::MIDIEvent<framepos_t> ev(*m, false);
1669 LV2_Evbuf_Iterator eend = lv2_evbuf_end(_ev_buffers[port_index]);
1670 lv2_evbuf_write(&eend, ev.time(), 0, type, ev.size(), ev.buffer());
1673 tmetric.set_metric(metric);
1674 bbt = metric->start();
1675 write_position(&_impl->forge, _ev_buffers[port_index],
1676 tmetric, bbt, _session.transport_speed(),
1678 metric->frame() - _session.transport_frame());
1682 } else if (!valid) {
1683 // Nothing we understand or care about, connect to scratch
1684 // see note for midi-buffer size above
1685 scratch_bufs.ensure_lv2_bufsize((flags & PORT_INPUT),
1686 0, _port_minimumSize[port_index]);
1687 _ev_buffers[port_index] = scratch_bufs.get_lv2_midi(
1688 (flags & PORT_INPUT), 0, (flags & PORT_EVENT));
1690 buf = lv2_evbuf_get_buffer(_ev_buffers[port_index]);
1692 continue; // Control port, leave buffer alone
1694 lilv_instance_connect_port(_impl->instance, port_index, buf);
1697 // Read messages from UI and push into appropriate buffers
1699 uint32_t read_space = _from_ui->read_space();
1700 while (read_space > sizeof(UIMessage)) {
1702 if (_from_ui->read((uint8_t*)&msg, sizeof(msg)) != sizeof(msg)) {
1703 error << "Error reading from UI=>Plugin RingBuffer" << endmsg;
1706 uint8_t body[msg.size];
1707 if (_from_ui->read(body, msg.size) != msg.size) {
1708 error << "Error reading from UI=>Plugin RingBuffer" << endmsg;
1711 if (msg.protocol == urids.atom_eventTransfer) {
1712 LV2_Evbuf* buf = _ev_buffers[msg.index];
1713 LV2_Evbuf_Iterator i = lv2_evbuf_end(buf);
1714 const LV2_Atom* const atom = (const LV2_Atom*)body;
1715 if (!lv2_evbuf_write(&i, nframes, 0, atom->type, atom->size,
1716 (const uint8_t*)(atom + 1))) {
1717 error << "Failed to write data to LV2 event buffer\n";
1720 error << "Received unknown message type from UI" << endmsg;
1722 read_space -= sizeof(UIMessage) + msg.size;
1729 for (uint32_t port_index = 0; port_index < num_ports; ++port_index) {
1730 PortFlags flags = _port_flags[port_index];
1733 /* TODO ask drobilla about comment
1734 * "Make Ardour event buffers generic so plugins can communicate"
1735 * in libs/ardour/buffer_set.cc:310
1737 * ideally the user could choose which of the following two modes
1738 * to use (e.g. instrument/effect chains MIDI OUT vs MIDI TRHU).
1740 * This implementation follows the discussion on IRC Mar 16 2013 16:47 UTC
1741 * 16:51 < drobilla> rgareus: [..] i.e always replace with MIDI output [of LV2 plugin] if it's there
1742 * 16:52 < drobilla> rgareus: That would probably be good enough [..] to make users not complain
1743 * for quite a while at least ;)
1745 // copy output of LV2 plugin's MIDI port to Ardour MIDI buffers -- MIDI OUT
1746 if ((flags & PORT_OUTPUT) && (flags & (PORT_EVENT|PORT_SEQUENCE|PORT_MIDI))) {
1747 const uint32_t buf_index = out_map.get(
1748 DataType::MIDI, midi_out_index++, &valid);
1750 bufs.forward_lv2_midi(_ev_buffers[port_index], buf_index);
1753 // Flush MIDI (write back to Ardour MIDI buffers) -- MIDI THRU
1754 else if ((flags & PORT_OUTPUT) && (flags & (PORT_EVENT|PORT_SEQUENCE))) {
1755 const uint32_t buf_index = out_map.get(
1756 DataType::MIDI, midi_out_index++, &valid);
1758 bufs.flush_lv2_midi(true, buf_index);
1762 // Write messages to UI
1763 if (_to_ui && (flags & PORT_OUTPUT) && (flags & (PORT_EVENT|PORT_SEQUENCE))) {
1764 LV2_Evbuf* buf = _ev_buffers[port_index];
1765 for (LV2_Evbuf_Iterator i = lv2_evbuf_begin(buf);
1766 lv2_evbuf_is_valid(i);
1767 i = lv2_evbuf_next(i)) {
1768 uint32_t frames, subframes, type, size;
1770 lv2_evbuf_get(i, &frames, &subframes, &type, &size, &data);
1771 write_to_ui(port_index, urids.atom_eventTransfer,
1772 size + sizeof(LV2_Atom),
1773 data - sizeof(LV2_Atom));
1778 cycles_t now = get_cycles();
1779 set_cycles((uint32_t)(now - then));
1781 // Update expected transport information for next cycle so we can detect changes
1782 _next_cycle_speed = _session.transport_speed();
1783 _next_cycle_start = _session.transport_frame() + (nframes * _next_cycle_speed);
1789 LV2Plugin::parameter_is_control(uint32_t param) const
1791 assert(param < _port_flags.size());
1792 return _port_flags[param] & PORT_CONTROL;
1796 LV2Plugin::parameter_is_audio(uint32_t param) const
1798 assert(param < _port_flags.size());
1799 return _port_flags[param] & PORT_AUDIO;
1803 LV2Plugin::parameter_is_event(uint32_t param) const
1805 assert(param < _port_flags.size());
1806 return _port_flags[param] & PORT_EVENT;
1810 LV2Plugin::parameter_is_output(uint32_t param) const
1812 assert(param < _port_flags.size());
1813 return _port_flags[param] & PORT_OUTPUT;
1817 LV2Plugin::parameter_is_input(uint32_t param) const
1819 assert(param < _port_flags.size());
1820 return _port_flags[param] & PORT_INPUT;
1824 LV2Plugin::print_parameter(uint32_t param, char* buf, uint32_t len) const
1827 if (param < parameter_count()) {
1828 snprintf(buf, len, "%.3f", get_parameter(param));
1835 boost::shared_ptr<Plugin::ScalePoints>
1836 LV2Plugin::get_scale_points(uint32_t port_index) const
1838 const LilvPort* port = lilv_plugin_get_port_by_index(_impl->plugin, port_index);
1839 LilvScalePoints* points = lilv_port_get_scale_points(_impl->plugin, port);
1841 boost::shared_ptr<Plugin::ScalePoints> ret;
1846 ret = boost::shared_ptr<Plugin::ScalePoints>(new ScalePoints());
1848 LILV_FOREACH(scale_points, i, points) {
1849 const LilvScalePoint* p = lilv_scale_points_get(points, i);
1850 const LilvNode* label = lilv_scale_point_get_label(p);
1851 const LilvNode* value = lilv_scale_point_get_value(p);
1852 if (label && (lilv_node_is_float(value) || lilv_node_is_int(value))) {
1853 ret->insert(make_pair(lilv_node_as_string(label),
1854 lilv_node_as_float(value)));
1858 lilv_scale_points_free(points);
1863 LV2Plugin::run(pframes_t nframes)
1865 uint32_t const N = parameter_count();
1866 for (uint32_t i = 0; i < N; ++i) {
1867 if (parameter_is_control(i) && parameter_is_input(i)) {
1868 _control_data[i] = _shadow_data[i];
1872 lilv_instance_run(_impl->instance, nframes);
1874 if (_impl->work_iface) {
1875 _worker->emit_responses();
1876 if (_impl->work_iface->end_run) {
1877 _impl->work_iface->end_run(_impl->instance->lv2_handle);
1883 LV2Plugin::latency_compute_run()
1885 if (!_latency_control_port) {
1889 // Run the plugin so that it can set its latency parameter
1893 uint32_t port_index = 0;
1894 uint32_t in_index = 0;
1895 uint32_t out_index = 0;
1897 const framecnt_t bufsize = 1024;
1898 float buffer[bufsize];
1900 memset(buffer, 0, sizeof(float) * bufsize);
1902 // FIXME: Ensure plugins can handle in-place processing
1906 while (port_index < parameter_count()) {
1907 if (parameter_is_audio(port_index)) {
1908 if (parameter_is_input(port_index)) {
1909 lilv_instance_connect_port(_impl->instance, port_index, buffer);
1911 } else if (parameter_is_output(port_index)) {
1912 lilv_instance_connect_port(_impl->instance, port_index, buffer);
1924 LV2Plugin::Impl::designated_input (const char* uri, void** bufptrs[], void** bufptr)
1926 const LilvPort* port = NULL;
1927 LilvNode* designation = lilv_new_uri(_world.world, uri);
1928 port = lilv_plugin_get_port_by_designation(
1929 plugin, _world.lv2_InputPort, designation);
1930 lilv_node_free(designation);
1932 bufptrs[lilv_port_get_index(plugin, port)] = bufptr;
1937 static bool lv2_filter (const string& str, void* /*arg*/)
1939 /* Not a dotfile, has a prefix before a period, suffix is "lv2" */
1941 return str[0] != '.' && (str.length() > 3 && str.find (".lv2") == (str.length() - 4));
1945 LV2World::LV2World()
1946 : world(lilv_world_new())
1947 , _bundle_checked(false)
1949 lilv_world_load_all(world);
1951 atom_AtomPort = lilv_new_uri(world, LV2_ATOM__AtomPort);
1952 atom_Chunk = lilv_new_uri(world, LV2_ATOM__Chunk);
1953 atom_Sequence = lilv_new_uri(world, LV2_ATOM__Sequence);
1954 atom_bufferType = lilv_new_uri(world, LV2_ATOM__bufferType);
1955 atom_supports = lilv_new_uri(world, LV2_ATOM__supports);
1956 atom_eventTransfer = lilv_new_uri(world, LV2_ATOM__eventTransfer);
1957 ev_EventPort = lilv_new_uri(world, LILV_URI_EVENT_PORT);
1958 ext_logarithmic = lilv_new_uri(world, LV2_PORT_PROPS__logarithmic);
1959 ext_notOnGUI = lilv_new_uri(world, LV2_PORT_PROPS__notOnGUI);
1960 lv2_AudioPort = lilv_new_uri(world, LILV_URI_AUDIO_PORT);
1961 lv2_ControlPort = lilv_new_uri(world, LILV_URI_CONTROL_PORT);
1962 lv2_InputPort = lilv_new_uri(world, LILV_URI_INPUT_PORT);
1963 lv2_OutputPort = lilv_new_uri(world, LILV_URI_OUTPUT_PORT);
1964 lv2_inPlaceBroken = lilv_new_uri(world, LV2_CORE__inPlaceBroken);
1965 lv2_integer = lilv_new_uri(world, LV2_CORE__integer);
1966 lv2_reportsLatency = lilv_new_uri(world, LV2_CORE__reportsLatency);
1967 lv2_sampleRate = lilv_new_uri(world, LV2_CORE__sampleRate);
1968 lv2_toggled = lilv_new_uri(world, LV2_CORE__toggled);
1969 lv2_enumeration = lilv_new_uri(world, LV2_CORE__enumeration);
1970 lv2_freewheeling = lilv_new_uri(world, LV2_CORE__freeWheeling);
1971 midi_MidiEvent = lilv_new_uri(world, LILV_URI_MIDI_EVENT);
1972 rdfs_comment = lilv_new_uri(world, LILV_NS_RDFS "comment");
1973 rsz_minimumSize = lilv_new_uri(world, LV2_RESIZE_PORT__minimumSize);
1974 time_Position = lilv_new_uri(world, LV2_TIME__Position);
1975 ui_GtkUI = lilv_new_uri(world, LV2_UI__GtkUI);
1976 ui_external = lilv_new_uri(world, "http://lv2plug.in/ns/extensions/ui#external");
1977 ui_externalkx = lilv_new_uri(world, "http://kxstudio.sf.net/ns/lv2ext/external-ui#Widget");
1978 units_unit = lilv_new_uri(world, "http://lv2plug.in/ns/extensions/units#unit");
1979 units_midiNote = lilv_new_uri(world, "http://lv2plug.in/ns/extensions/units#midiNote");
1982 LV2World::~LV2World()
1984 lilv_node_free(units_midiNote);
1985 lilv_node_free(units_unit);
1986 lilv_node_free(ui_externalkx);
1987 lilv_node_free(ui_external);
1988 lilv_node_free(ui_GtkUI);
1989 lilv_node_free(time_Position);
1990 lilv_node_free(rsz_minimumSize);
1991 lilv_node_free(rdfs_comment);
1992 lilv_node_free(midi_MidiEvent);
1993 lilv_node_free(lv2_enumeration);
1994 lilv_node_free(lv2_freewheeling);
1995 lilv_node_free(lv2_toggled);
1996 lilv_node_free(lv2_sampleRate);
1997 lilv_node_free(lv2_reportsLatency);
1998 lilv_node_free(lv2_integer);
1999 lilv_node_free(lv2_inPlaceBroken);
2000 lilv_node_free(lv2_OutputPort);
2001 lilv_node_free(lv2_InputPort);
2002 lilv_node_free(lv2_ControlPort);
2003 lilv_node_free(lv2_AudioPort);
2004 lilv_node_free(ext_notOnGUI);
2005 lilv_node_free(ext_logarithmic);
2006 lilv_node_free(ev_EventPort);
2007 lilv_node_free(atom_supports);
2008 lilv_node_free(atom_eventTransfer);
2009 lilv_node_free(atom_bufferType);
2010 lilv_node_free(atom_Sequence);
2011 lilv_node_free(atom_Chunk);
2012 lilv_node_free(atom_AtomPort);
2016 LV2World::load_bundled_plugins()
2018 if (!_bundle_checked) {
2019 cout << "Scanning folders for bundled LV2s: " << ARDOUR::lv2_bundled_search_path().to_string() << endl;
2020 PathScanner scanner;
2021 vector<string *> *plugin_objects = scanner (ARDOUR::lv2_bundled_search_path().to_string(), lv2_filter, 0, true, true);
2022 if (plugin_objects) {
2023 for ( vector<string *>::iterator x = plugin_objects->begin(); x != plugin_objects->end (); ++x) {
2025 string uri = "file:///" + **x + "/";
2027 string uri = "file://" + **x + "/";
2029 LilvNode *node = lilv_new_uri(world, uri.c_str());
2030 lilv_world_load_bundle(world, node);
2031 lilv_node_free(node);
2034 delete (plugin_objects);
2036 _bundle_checked = true;
2040 LV2PluginInfo::LV2PluginInfo (const void* c_plugin)
2041 : _c_plugin(c_plugin)
2046 LV2PluginInfo::~LV2PluginInfo()
2050 LV2PluginInfo::load(Session& session)
2055 plugin.reset(new LV2Plugin(session.engine(), session,
2056 (const LilvPlugin*)_c_plugin,
2057 session.frame_rate()));
2059 plugin->set_info(PluginInfoPtr(new LV2PluginInfo(*this)));
2061 } catch (failed_constructor& err) {
2062 return PluginPtr((Plugin*)0);
2069 LV2PluginInfo::discover()
2071 _world.load_bundled_plugins();
2073 PluginInfoList* plugs = new PluginInfoList;
2074 const LilvPlugins* plugins = lilv_world_get_all_plugins(_world.world);
2076 info << "LV2: Discovering " << lilv_plugins_size(plugins) << " plugins" << endmsg;
2078 LILV_FOREACH(plugins, i, plugins) {
2079 const LilvPlugin* p = lilv_plugins_get(plugins, i);
2080 LV2PluginInfoPtr info(new LV2PluginInfo((const void*)p));
2082 LilvNode* name = lilv_plugin_get_name(p);
2083 if (!name || !lilv_plugin_get_port_by_index(p, 0)) {
2084 warning << "Ignoring invalid LV2 plugin "
2085 << lilv_node_as_string(lilv_plugin_get_uri(p))
2092 info->name = string(lilv_node_as_string(name));
2093 lilv_node_free(name);
2095 const LilvPluginClass* pclass = lilv_plugin_get_class(p);
2096 const LilvNode* label = lilv_plugin_class_get_label(pclass);
2097 info->category = lilv_node_as_string(label);
2099 LilvNode* author_name = lilv_plugin_get_author_name(p);
2100 info->creator = author_name ? string(lilv_node_as_string(author_name)) : "Unknown";
2101 lilv_node_free(author_name);
2103 info->path = "/NOPATH"; // Meaningless for LV2
2105 /* count atom-event-ports that feature
2106 * atom:supports <http://lv2plug.in/ns/ext/midi#MidiEvent>
2108 * TODO: nicely ask drobilla to make a lilv_ call for that
2110 int count_midi_out = 0;
2111 int count_midi_in = 0;
2112 for (uint32_t i = 0; i < lilv_plugin_get_num_ports(p); ++i) {
2113 const LilvPort* port = lilv_plugin_get_port_by_index(p, i);
2114 if (lilv_port_is_a(p, port, _world.atom_AtomPort)) {
2115 LilvNodes* buffer_types = lilv_port_get_value(
2116 p, port, _world.atom_bufferType);
2117 LilvNodes* atom_supports = lilv_port_get_value(
2118 p, port, _world.atom_supports);
2120 if (lilv_nodes_contains(buffer_types, _world.atom_Sequence)
2121 && lilv_nodes_contains(atom_supports, _world.midi_MidiEvent)) {
2122 if (lilv_port_is_a(p, port, _world.lv2_InputPort)) {
2125 if (lilv_port_is_a(p, port, _world.lv2_OutputPort)) {
2129 lilv_nodes_free(buffer_types);
2130 lilv_nodes_free(atom_supports);
2134 info->n_inputs.set_audio(
2135 lilv_plugin_get_num_ports_of_class(
2136 p, _world.lv2_InputPort, _world.lv2_AudioPort, NULL));
2137 info->n_inputs.set_midi(
2138 lilv_plugin_get_num_ports_of_class(
2139 p, _world.lv2_InputPort, _world.ev_EventPort, NULL)
2142 info->n_outputs.set_audio(
2143 lilv_plugin_get_num_ports_of_class(
2144 p, _world.lv2_OutputPort, _world.lv2_AudioPort, NULL));
2145 info->n_outputs.set_midi(
2146 lilv_plugin_get_num_ports_of_class(
2147 p, _world.lv2_OutputPort, _world.ev_EventPort, NULL)
2150 info->unique_id = lilv_node_as_uri(lilv_plugin_get_uri(p));
2151 info->index = 0; // Meaningless for LV2
2153 plugs->push_back(info);