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 "pbd/gstdio_compat.h"
29 #include <glib/gprintf.h>
32 #include <boost/utility.hpp>
34 #include "pbd/file_utils.h"
35 #include "pbd/stl_delete.h"
36 #include "pbd/compose.h"
37 #include "pbd/error.h"
38 #include "pbd/xml++.h"
40 #include "libardour-config.h"
42 #include "ardour/audio_buffer.h"
43 #include "ardour/audioengine.h"
44 #include "ardour/debug.h"
45 #include "ardour/lv2_plugin.h"
46 #include "ardour/session.h"
47 #include "ardour/tempo.h"
48 #include "ardour/types.h"
49 #include "ardour/utils.h"
50 #include "ardour/worker.h"
51 #include "ardour/search_paths.h"
56 #include <lilv/lilv.h>
58 #include "lv2/lv2plug.in/ns/ext/atom/atom.h"
59 #include "lv2/lv2plug.in/ns/ext/atom/forge.h"
60 #include "lv2/lv2plug.in/ns/ext/log/log.h"
61 #include "lv2/lv2plug.in/ns/ext/midi/midi.h"
62 #include "lv2/lv2plug.in/ns/ext/port-props/port-props.h"
63 #include "lv2/lv2plug.in/ns/ext/presets/presets.h"
64 #include "lv2/lv2plug.in/ns/ext/state/state.h"
65 #include "lv2/lv2plug.in/ns/ext/time/time.h"
66 #include "lv2/lv2plug.in/ns/ext/worker/worker.h"
67 #include "lv2/lv2plug.in/ns/ext/resize-port/resize-port.h"
68 #include "lv2/lv2plug.in/ns/extensions/ui/ui.h"
69 #include "lv2/lv2plug.in/ns/extensions/units/units.h"
70 #include "lv2/lv2plug.in/ns/ext/patch/patch.h"
72 #include "lv2/lv2plug.in/ns/ext/buf-size/buf-size.h"
73 #include "lv2/lv2plug.in/ns/ext/options/options.h"
76 #include "lv2_evbuf.h"
79 #include <suil/suil.h>
82 // Compatibility for old LV2
83 #ifndef LV2_ATOM_CONTENTS_CONST
84 #define LV2_ATOM_CONTENTS_CONST(type, atom) \
85 ((const void*)((const uint8_t*)(atom) + sizeof(type)))
87 #ifndef LV2_ATOM_BODY_CONST
88 #define LV2_ATOM_BODY_CONST(atom) LV2_ATOM_CONTENTS_CONST(LV2_Atom, atom)
90 #ifndef LV2_PATCH__property
91 #define LV2_PATCH__property LV2_PATCH_PREFIX "property"
93 #ifndef LV2_PATCH__value
94 #define LV2_PATCH__value LV2_PATCH_PREFIX "value"
96 #ifndef LV2_PATCH__writable
97 #define LV2_PATCH__writable LV2_PATCH_PREFIX "writable"
100 /** The number of MIDI buffers that will fit in a UI/worker comm buffer.
101 This needs to be roughly the number of cycles the UI will get around to
102 actually processing the traffic. Lower values are flakier but save memory.
104 static const size_t NBUFS = 4;
107 using namespace ARDOUR;
110 class LV2World : boost::noncopyable {
115 void load_bundled_plugins(bool verbose=false);
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_isSideChain;
136 LilvNode* lv2_integer;
137 LilvNode* lv2_default;
138 LilvNode* lv2_minimum;
139 LilvNode* lv2_maximum;
140 LilvNode* lv2_reportsLatency;
141 LilvNode* lv2_sampleRate;
142 LilvNode* lv2_toggled;
143 LilvNode* midi_MidiEvent;
144 LilvNode* rdfs_comment;
145 LilvNode* rdfs_label;
146 LilvNode* rdfs_range;
147 LilvNode* rsz_minimumSize;
148 LilvNode* time_Position;
150 LilvNode* ui_external;
151 LilvNode* ui_externalkx;
154 LilvNode* units_unit;
155 LilvNode* units_render;
156 LilvNode* units_midiNote;
157 LilvNode* patch_writable;
158 LilvNode* patch_Message;
159 #ifdef HAVE_LV2_1_2_0
160 LilvNode* bufz_powerOf2BlockLength;
161 LilvNode* bufz_fixedBlockLength;
162 LilvNode* bufz_nominalBlockLength;
165 #ifdef HAVE_LV2_1_10_0
167 LilvNode* atom_float;
168 LilvNode* atom_object; // new in 1.8
169 LilvNode* atom_vector;
172 LilvNode* lv2_noSampleAccurateCtrl;
173 LilvNode* auto_can_write_automatation; // lv2:optionalFeature
174 LilvNode* auto_automation_control; // atom:supports
175 LilvNode* auto_automation_controlled; // lv2:portProperty
179 bool _bundle_checked;
182 static LV2World _world;
184 /* worker extension */
186 /** Called by the plugin to schedule non-RT work. */
187 static LV2_Worker_Status
188 work_schedule(LV2_Worker_Schedule_Handle handle,
192 LV2Plugin* plugin = (LV2Plugin*)handle;
193 if (plugin->session().engine().freewheeling()) {
194 // Freewheeling, do the work immediately in this (audio) thread
195 return (LV2_Worker_Status)plugin->work(size, data);
197 // Enqueue message for the worker thread
198 return plugin->worker()->schedule(size, data) ?
199 LV2_WORKER_SUCCESS : LV2_WORKER_ERR_UNKNOWN;
203 /** Called by the plugin to respond to non-RT work. */
204 static LV2_Worker_Status
205 work_respond(LV2_Worker_Respond_Handle handle,
209 LV2Plugin* plugin = (LV2Plugin*)handle;
210 if (plugin->session().engine().freewheeling()) {
211 // Freewheeling, respond immediately in this (audio) thread
212 return (LV2_Worker_Status)plugin->work_response(size, data);
214 // Enqueue response for the worker
215 return plugin->worker()->respond(size, data) ?
216 LV2_WORKER_SUCCESS : LV2_WORKER_ERR_UNKNOWN;
221 /* inline display extension */
223 queue_draw (LV2_Inline_Display_Handle handle)
225 LV2Plugin* plugin = (LV2Plugin*)handle;
226 plugin->QueueDraw(); /* EMIT SIGNAL */
233 log_vprintf(LV2_Log_Handle /*handle*/,
239 const int ret = g_vasprintf(&str, fmt, args);
240 if (type == URIMap::instance().urids.log_Error) {
241 error << str << endmsg;
242 } else if (type == URIMap::instance().urids.log_Warning) {
243 warning << str << endmsg;
244 } else if (type == URIMap::instance().urids.log_Note) {
245 info << str << endmsg;
247 // TODO: Toggleable log:Trace message support
252 log_printf(LV2_Log_Handle handle,
254 const char* fmt, ...)
258 const int ret = log_vprintf(handle, type, fmt, args);
263 struct LV2Plugin::Impl {
264 Impl() : plugin(0), ui(0), ui_type(0), name(0), author(0), instance(0)
266 #ifdef HAVE_LV2_1_2_0
271 #ifdef HAVE_LV2_1_2_0
279 /** Find the LV2 input port with the given designation.
280 * If found, bufptrs[port_index] will be set to bufptr.
282 const LilvPort* designated_input (const char* uri, void** bufptrs[], void** bufptr);
284 const LilvPlugin* plugin;
286 const LilvNode* ui_type;
289 LilvInstance* instance;
290 const LV2_Worker_Interface* work_iface;
291 #ifdef HAVE_LV2_1_2_0
292 const LV2_Options_Interface* opts_iface;
295 LV2_Atom_Forge forge;
296 LV2_Atom_Forge ui_forge;
297 int32_t block_length;
298 #ifdef HAVE_LV2_1_2_0
299 LV2_Options_Option* options;
302 LV2_Inline_Display* queue_draw;
306 LV2Plugin::LV2Plugin (AudioEngine& engine,
308 const void* c_plugin,
310 : Plugin (engine, session)
316 , _patch_port_in_index((uint32_t)-1)
317 , _patch_port_out_index((uint32_t)-1)
318 , _uri_map(URIMap::instance())
319 , _no_sample_accurate_ctrl (false)
321 init(c_plugin, rate);
324 LV2Plugin::LV2Plugin (const LV2Plugin& other)
330 , _insert_id(other._insert_id)
331 , _patch_port_in_index((uint32_t)-1)
332 , _patch_port_out_index((uint32_t)-1)
333 , _uri_map(URIMap::instance())
334 , _no_sample_accurate_ctrl (false)
336 init(other._impl->plugin, other._sample_rate);
338 for (uint32_t i = 0; i < parameter_count(); ++i) {
339 _control_data[i] = other._shadow_data[i];
340 _shadow_data[i] = other._shadow_data[i];
345 LV2Plugin::init(const void* c_plugin, framecnt_t rate)
347 DEBUG_TRACE(DEBUG::LV2, "init\n");
349 _impl->plugin = (const LilvPlugin*)c_plugin;
351 _impl->ui_type = NULL;
356 _atom_ev_buffers = 0;
358 _bpm_control_port = 0;
359 _freewheel_control_port = 0;
360 _latency_control_port = 0;
361 _next_cycle_start = std::numeric_limits<framepos_t>::max();
362 _next_cycle_speed = 1.0;
363 _seq_size = _engine.raw_buffer_size(DataType::MIDI);
365 _was_activated = false;
366 _has_state_interface = false;
367 _can_write_automation = false;
369 _current_latency = 0;
370 _impl->block_length = _session.get_block_size();
372 _instance_access_feature.URI = "http://lv2plug.in/ns/ext/instance-access";
373 _data_access_feature.URI = "http://lv2plug.in/ns/ext/data-access";
374 _make_path_feature.URI = LV2_STATE__makePath;
375 _log_feature.URI = LV2_LOG__log;
376 _work_schedule_feature.URI = LV2_WORKER__schedule;
377 _work_schedule_feature.data = NULL;
378 _def_state_feature.URI = LV2_STATE_PREFIX "loadDefaultState"; // Post LV2-1.2.0
379 _def_state_feature.data = NULL;
381 const LilvPlugin* plugin = _impl->plugin;
383 LilvNode* state_iface_uri = lilv_new_uri(_world.world, LV2_STATE__interface);
384 LilvNode* state_uri = lilv_new_uri(_world.world, LV2_STATE_URI);
385 _has_state_interface =
386 // What plugins should have (lv2:extensionData state:Interface)
387 lilv_plugin_has_extension_data(plugin, state_iface_uri)
388 // What some outdated/incorrect ones have
389 || lilv_plugin_has_feature(plugin, state_uri);
390 lilv_node_free(state_uri);
391 lilv_node_free(state_iface_uri);
393 _features = (LV2_Feature**)calloc(12, sizeof(LV2_Feature*));
394 _features[0] = &_instance_access_feature;
395 _features[1] = &_data_access_feature;
396 _features[2] = &_make_path_feature;
397 _features[3] = _uri_map.uri_map_feature();
398 _features[4] = _uri_map.urid_map_feature();
399 _features[5] = _uri_map.urid_unmap_feature();
400 _features[6] = &_log_feature;
402 unsigned n_features = 7;
403 #ifdef HAVE_LV2_1_2_0
404 _features[n_features++] = &_def_state_feature;
407 lv2_atom_forge_init(&_impl->forge, _uri_map.urid_map());
408 lv2_atom_forge_init(&_impl->ui_forge, _uri_map.urid_map());
411 _impl->queue_draw = (LV2_Inline_Display*)
412 malloc (sizeof(LV2_Inline_Display));
413 _impl->queue_draw->handle = this;
414 _impl->queue_draw->queue_draw = queue_draw;
416 _queue_draw_feature.URI = LV2_INLINEDISPLAY__queue_draw;
417 _queue_draw_feature.data = _impl->queue_draw;
418 _features[n_features++] = &_queue_draw_feature;
421 #ifdef HAVE_LV2_1_2_0
422 LV2_URID atom_Int = _uri_map.uri_to_id(LV2_ATOM__Int);
423 static const int32_t _min_block_length = 1; // may happen during split-cycles
424 static const int32_t _max_block_length = 8192; // max possible (with all engines and during export)
425 /* Consider updating max-block-size whenever the buffersize changes.
426 * It requires re-instantiating the plugin (which is a non-realtime operation),
427 * so it should be done lightly and only for plugins that require it.
429 * given that the block-size can change at any time (split-cycles) ardour currently
430 * does not support plugins that require bufz_fixedBlockLength.
432 LV2_Options_Option options[] = {
433 { LV2_OPTIONS_INSTANCE, 0, _uri_map.uri_to_id(LV2_BUF_SIZE__minBlockLength),
434 sizeof(int32_t), atom_Int, &_min_block_length },
435 { LV2_OPTIONS_INSTANCE, 0, _uri_map.uri_to_id(LV2_BUF_SIZE__maxBlockLength),
436 sizeof(int32_t), atom_Int, &_max_block_length },
437 { LV2_OPTIONS_INSTANCE, 0, _uri_map.uri_to_id(LV2_BUF_SIZE__sequenceSize),
438 sizeof(int32_t), atom_Int, &_seq_size },
439 { LV2_OPTIONS_INSTANCE, 0, _uri_map.uri_to_id("http://lv2plug.in/ns/ext/buf-size#nominalBlockLength"),
440 sizeof(int32_t), atom_Int, &_impl->block_length },
441 { LV2_OPTIONS_INSTANCE, 0, 0, 0, 0, NULL }
444 _impl->options = (LV2_Options_Option*) malloc (sizeof (options));
445 memcpy ((void*) _impl->options, (void*) options, sizeof (options));
447 _options_feature.URI = LV2_OPTIONS__options;
448 _options_feature.data = _impl->options;
449 _features[n_features++] = &_options_feature;
452 LV2_State_Make_Path* make_path = (LV2_State_Make_Path*)malloc(
453 sizeof(LV2_State_Make_Path));
454 make_path->handle = this;
455 make_path->path = &lv2_state_make_path;
456 _make_path_feature.data = make_path;
458 LV2_Log_Log* log = (LV2_Log_Log*)malloc(sizeof(LV2_Log_Log));
460 log->printf = &log_printf;
461 log->vprintf = &log_vprintf;
462 _log_feature.data = log;
464 LilvNode* worker_schedule = lilv_new_uri(_world.world, LV2_WORKER__schedule);
465 if (lilv_plugin_has_feature(plugin, worker_schedule)) {
466 LV2_Worker_Schedule* schedule = (LV2_Worker_Schedule*)malloc(
467 sizeof(LV2_Worker_Schedule));
468 size_t buf_size = _session.engine().raw_buffer_size(DataType::MIDI) * NBUFS;
469 _worker = new Worker(this, buf_size);
470 schedule->handle = this;
471 schedule->schedule_work = work_schedule;
472 _work_schedule_feature.data = schedule;
473 _features[n_features++] = &_work_schedule_feature;
475 lilv_node_free(worker_schedule);
477 _impl->instance = lilv_plugin_instantiate(plugin, rate, _features);
478 _impl->name = lilv_plugin_get_name(plugin);
479 _impl->author = lilv_plugin_get_author_name(plugin);
481 if (_impl->instance == 0) {
482 error << _("LV2: Failed to instantiate plugin ") << uri() << endmsg;
483 throw failed_constructor();
486 _instance_access_feature.data = (void*)_impl->instance->lv2_handle;
487 _data_access_extension_data.extension_data = _impl->instance->lv2_descriptor->extension_data;
488 _data_access_feature.data = &_data_access_extension_data;
490 LilvNode* worker_iface_uri = lilv_new_uri(_world.world, LV2_WORKER__interface);
491 if (lilv_plugin_has_extension_data(plugin, worker_iface_uri)) {
492 _impl->work_iface = (const LV2_Worker_Interface*)extension_data(
493 LV2_WORKER__interface);
495 lilv_node_free(worker_iface_uri);
498 #ifdef HAVE_LV2_1_2_0
499 LilvNode* options_iface_uri = lilv_new_uri(_world.world, LV2_OPTIONS__interface);
500 if (lilv_plugin_has_extension_data(plugin, options_iface_uri)) {
501 _impl->opts_iface = (const LV2_Options_Interface*)extension_data(
502 LV2_OPTIONS__interface);
504 lilv_node_free(options_iface_uri);
508 _display_interface = (const LV2_Inline_Display_Interface*)
509 extension_data (LV2_INLINEDISPLAY__interface);
512 if (lilv_plugin_has_feature(plugin, _world.lv2_inPlaceBroken)) {
513 error << string_compose(
514 _("LV2: \"%1\" cannot be used, since it cannot do inplace processing."),
515 lilv_node_as_string(_impl->name)) << endmsg;
516 lilv_node_free(_impl->name);
517 lilv_node_free(_impl->author);
518 throw failed_constructor();
521 #ifdef HAVE_LV2_1_2_0
522 LilvNodes *required_features = lilv_plugin_get_required_features (plugin);
523 if (lilv_nodes_contains (required_features, _world.bufz_powerOf2BlockLength) ||
524 lilv_nodes_contains (required_features, _world.bufz_fixedBlockLength)
526 error << string_compose(
527 _("LV2: \"%1\" buffer-size requirements cannot be satisfied."),
528 lilv_node_as_string(_impl->name)) << endmsg;
529 lilv_node_free(_impl->name);
530 lilv_node_free(_impl->author);
531 lilv_nodes_free(required_features);
532 throw failed_constructor();
534 lilv_nodes_free(required_features);
538 LilvNodes* optional_features = lilv_plugin_get_optional_features (plugin);
539 if (lilv_nodes_contains (optional_features, _world.lv2_noSampleAccurateCtrl)) {
540 _no_sample_accurate_ctrl = true;
542 if (lilv_nodes_contains (optional_features, _world.auto_can_write_automatation)) {
543 _can_write_automation = true;
545 lilv_nodes_free(optional_features);
548 #ifdef HAVE_LILV_0_16_0
549 // Load default state
550 LilvState* state = lilv_state_new_from_world(
551 _world.world, _uri_map.urid_map(), lilv_plugin_get_uri(_impl->plugin));
552 if (state && _has_state_interface) {
553 lilv_state_restore(state, _impl->instance, NULL, NULL, 0, NULL);
555 lilv_state_free(state);
560 const uint32_t num_ports = this->num_ports();
561 for (uint32_t i = 0; i < num_ports; ++i) {
562 const LilvPort* port = lilv_plugin_get_port_by_index(_impl->plugin, i);
564 size_t minimumSize = 0;
566 if (lilv_port_is_a(_impl->plugin, port, _world.lv2_OutputPort)) {
567 flags |= PORT_OUTPUT;
568 } else if (lilv_port_is_a(_impl->plugin, port, _world.lv2_InputPort)) {
571 error << string_compose(
572 "LV2: \"%1\" port %2 is neither input nor output",
573 lilv_node_as_string(_impl->name), i) << endmsg;
574 throw failed_constructor();
577 if (lilv_port_is_a(_impl->plugin, port, _world.lv2_ControlPort)) {
578 flags |= PORT_CONTROL;
579 } else if (lilv_port_is_a(_impl->plugin, port, _world.lv2_AudioPort)) {
581 } else if (lilv_port_is_a(_impl->plugin, port, _world.ev_EventPort)) {
583 flags |= PORT_MIDI; // We assume old event API ports are for MIDI
584 } else if (lilv_port_is_a(_impl->plugin, port, _world.atom_AtomPort)) {
585 LilvNodes* buffer_types = lilv_port_get_value(
586 _impl->plugin, port, _world.atom_bufferType);
587 LilvNodes* atom_supports = lilv_port_get_value(
588 _impl->plugin, port, _world.atom_supports);
590 if (lilv_nodes_contains(buffer_types, _world.atom_Sequence)) {
591 flags |= PORT_SEQUENCE;
592 if (lilv_nodes_contains(atom_supports, _world.midi_MidiEvent)) {
595 if (lilv_nodes_contains(atom_supports, _world.time_Position)) {
596 flags |= PORT_POSITION;
599 if (lilv_nodes_contains(atom_supports, _world.auto_automation_control)) {
600 flags |= PORT_AUTOCTRL;
603 if (lilv_nodes_contains(atom_supports, _world.patch_Message)) {
604 flags |= PORT_PATCHMSG;
605 if (flags & PORT_INPUT) {
606 _patch_port_in_index = i;
608 _patch_port_out_index = i;
612 LilvNodes* min_size_v = lilv_port_get_value(_impl->plugin, port, _world.rsz_minimumSize);
613 LilvNode* min_size = min_size_v ? lilv_nodes_get_first(min_size_v) : NULL;
614 if (min_size && lilv_node_is_int(min_size)) {
615 minimumSize = lilv_node_as_int(min_size);
617 lilv_nodes_free(min_size_v);
618 lilv_nodes_free(buffer_types);
619 lilv_nodes_free(atom_supports);
621 error << string_compose(
622 "LV2: \"%1\" port %2 has no known data type",
623 lilv_node_as_string(_impl->name), i) << endmsg;
624 throw failed_constructor();
628 if (lilv_port_has_property(_impl->plugin, port, _world.auto_automation_controlled)) {
629 if ((flags & PORT_INPUT) && (flags & PORT_CONTROL)) {
630 flags |= PORT_CTRLED;
635 _port_flags.push_back(flags);
636 _port_minimumSize.push_back(minimumSize);
639 _control_data = new float[num_ports];
640 _shadow_data = new float[num_ports];
641 _defaults = new float[num_ports];
642 _ev_buffers = new LV2_Evbuf*[num_ports];
643 memset(_ev_buffers, 0, sizeof(LV2_Evbuf*) * num_ports);
645 const bool latent = lilv_plugin_has_latency(plugin);
646 const uint32_t latency_index = (latent)
647 ? lilv_plugin_get_latency_port_index(plugin)
650 // Build an array of pointers to special parameter buffers
651 void*** params = new void**[num_ports];
652 for (uint32_t i = 0; i < num_ports; ++i) {
655 _impl->designated_input (LV2_TIME__beatsPerMinute, params, (void**)&_bpm_control_port);
656 _impl->designated_input (LV2_CORE__freeWheeling, params, (void**)&_freewheel_control_port);
658 for (uint32_t i = 0; i < num_ports; ++i) {
659 const LilvPort* port = lilv_plugin_get_port_by_index(plugin, i);
660 const LilvNode* sym = lilv_port_get_symbol(plugin, port);
662 // Store index in map so we can look up index by symbol
663 _port_indices.insert(std::make_pair(lilv_node_as_string(sym), i));
665 // Get range and default value if applicable
666 if (parameter_is_control(i)) {
668 lilv_port_get_range(plugin, port, &def, NULL, NULL);
669 _defaults[i] = def ? lilv_node_as_float(def) : 0.0f;
670 if (lilv_port_has_property (plugin, port, _world.lv2_sampleRate)) {
671 _defaults[i] *= _session.frame_rate ();
675 lilv_instance_connect_port(_impl->instance, i, &_control_data[i]);
677 if (latent && i == latency_index) {
679 lilv_port_get_range(_impl->plugin, port, NULL, NULL, &max);
680 _max_latency = max ? lilv_node_as_float(max) : .02 * _sample_rate;
681 _latency_control_port = &_control_data[i];
682 *_latency_control_port = 0;
685 if (parameter_is_input(i)) {
686 _shadow_data[i] = default_value(i);
688 *params[i] = (void*)&_shadow_data[i];
698 LilvUIs* uis = lilv_plugin_get_uis(plugin);
699 if (lilv_uis_size(uis) > 0) {
701 // Look for embeddable UI
702 LILV_FOREACH(uis, u, uis) {
703 const LilvUI* this_ui = lilv_uis_get(uis, u);
704 const LilvNode* this_ui_type = NULL;
705 if (lilv_ui_is_supported(this_ui,
709 // TODO: Multiple UI support
711 _impl->ui_type = this_ui_type;
716 // Look for Gtk native UI
717 LILV_FOREACH(uis, i, uis) {
718 const LilvUI* ui = lilv_uis_get(uis, i);
719 if (lilv_ui_is_a(ui, _world.ui_GtkUI)) {
721 _impl->ui_type = _world.ui_GtkUI;
727 // If Gtk UI is not available, try to find external UI
729 LILV_FOREACH(uis, i, uis) {
730 const LilvUI* ui = lilv_uis_get(uis, i);
731 if (lilv_ui_is_a(ui, _world.ui_externalkx)) {
733 _impl->ui_type = _world.ui_external;
736 if (lilv_ui_is_a(ui, _world.ui_external)) {
738 _impl->ui_type = _world.ui_external;
744 load_supported_properties(_property_descriptors);
745 allocate_atom_event_buffers();
746 latency_compute_run();
750 LV2Plugin::set_block_size (pframes_t nframes)
752 #ifdef HAVE_LV2_1_2_0
753 if (_impl->opts_iface) {
754 LV2_URID atom_Int = _uri_map.uri_to_id(LV2_ATOM__Int);
755 _impl->block_length = nframes;
756 LV2_Options_Option block_size_option = {
757 LV2_OPTIONS_INSTANCE, 0, _uri_map.uri_to_id ("http://lv2plug.in/ns/ext/buf-size#nominalBlockLength"),
758 sizeof(int32_t), atom_Int, (void*)&_impl->block_length
760 _impl->opts_iface->set (_impl->instance->lv2_handle, &block_size_option);
767 LV2Plugin::requires_fixed_sized_buffers () const
769 /* This controls if Ardour will split the plugin's run()
770 * on automation events in order to pass sample-accurate automation
771 * via standard control-ports.
773 * When returning true Ardour will *not* sub-divide the process-cycle.
774 * Automation events that happen between cycle-start and cycle-end will be
775 * ignored (ctrl values are interpolated to cycle-start).
776 * NB. Atom Sequences are still sample accurate.
778 * Note: This does not guarantee a fixed block-size.
779 * e.g The process cycle may be split when looping, also
780 * the period-size may change any time: see set_block_size()
782 if (get_info()->n_inputs.n_midi() > 0) {
783 /* we don't yet implement midi buffer offsets (for split cycles).
784 * Also connect_and_run() also uses _session.transport_frame() directly
785 * (for BBT) which is not offset for plugin cycle split.
789 return _no_sample_accurate_ctrl;
792 LV2Plugin::~LV2Plugin ()
794 DEBUG_TRACE(DEBUG::LV2, string_compose("%1 destroy\n", name()));
799 lilv_instance_free(_impl->instance);
800 lilv_state_free(_impl->state);
801 lilv_node_free(_impl->name);
802 lilv_node_free(_impl->author);
803 #ifdef HAVE_LV2_1_2_0
804 free(_impl->options);
807 free(_impl->queue_draw);
811 free(_log_feature.data);
812 free(_make_path_feature.data);
813 free(_work_schedule_feature.data);
819 if (_atom_ev_buffers) {
820 LV2_Evbuf** b = _atom_ev_buffers;
825 free(_atom_ev_buffers);
828 delete [] _control_data;
829 delete [] _shadow_data;
831 delete [] _ev_buffers;
836 LV2Plugin::is_external_ui() const
841 return lilv_ui_is_a(_impl->ui, _world.ui_external) || lilv_ui_is_a(_impl->ui, _world.ui_externalkx);
845 LV2Plugin::is_external_kx() const
850 return lilv_ui_is_a(_impl->ui, _world.ui_externalkx);
854 LV2Plugin::ui_is_resizable () const
856 const LilvNode* s = lilv_ui_get_uri(_impl->ui);
857 LilvNode* p = lilv_new_uri(_world.world, LV2_CORE__optionalFeature);
858 LilvNode* fs = lilv_new_uri(_world.world, LV2_UI__fixedSize);
859 LilvNode* nrs = lilv_new_uri(_world.world, LV2_UI__noUserResize);
861 LilvNodes* fs_matches = lilv_world_find_nodes(_world.world, s, p, fs);
862 LilvNodes* nrs_matches = lilv_world_find_nodes(_world.world, s, p, nrs);
864 lilv_nodes_free(nrs_matches);
865 lilv_nodes_free(fs_matches);
870 return !fs_matches && !nrs_matches;
875 LV2Plugin::has_inline_display () {
876 return _display_interface ? true : false;
879 Plugin::Display_Image_Surface*
880 LV2Plugin::render_inline_display (uint32_t w, uint32_t h) {
881 if (_display_interface) {
882 /* Plugin::Display_Image_Surface is identical to
883 * LV2_Inline_Display_Image_Surface */
884 return (Plugin::Display_Image_Surface*) _display_interface->render ((void*)_impl->instance->lv2_handle, w, h);
891 LV2Plugin::unique_id() const
893 return lilv_node_as_uri(lilv_plugin_get_uri(_impl->plugin));
897 LV2Plugin::uri() const
899 return lilv_node_as_uri(lilv_plugin_get_uri(_impl->plugin));
903 LV2Plugin::label() const
905 return lilv_node_as_string(_impl->name);
909 LV2Plugin::name() const
911 return lilv_node_as_string(_impl->name);
915 LV2Plugin::maker() const
917 return _impl->author ? lilv_node_as_string (_impl->author) : "Unknown";
921 LV2Plugin::num_ports() const
923 return lilv_plugin_get_num_ports(_impl->plugin);
927 LV2Plugin::parameter_count() const
929 return lilv_plugin_get_num_ports(_impl->plugin);
933 LV2Plugin::default_value(uint32_t port)
935 return _defaults[port];
939 LV2Plugin::port_symbol(uint32_t index) const
941 const LilvPort* port = lilv_plugin_get_port_by_index(_impl->plugin, index);
943 error << name() << ": Invalid port index " << index << endmsg;
946 const LilvNode* sym = lilv_port_get_symbol(_impl->plugin, port);
947 return lilv_node_as_string(sym);
951 LV2Plugin::port_index (const char* symbol) const
953 const map<string, uint32_t>::const_iterator i = _port_indices.find(symbol);
954 if (i != _port_indices.end()) {
957 warning << string_compose(_("LV2: Unknown port %1"), symbol) << endmsg;
963 LV2Plugin::set_parameter(uint32_t which, float val)
965 DEBUG_TRACE(DEBUG::LV2, string_compose(
966 "%1 set parameter %2 to %3\n", name(), which, val));
968 if (which < lilv_plugin_get_num_ports(_impl->plugin)) {
969 if (get_parameter (which) == val) {
973 _shadow_data[which] = val;
975 warning << string_compose(
976 _("Illegal parameter number used with plugin \"%1\". "
977 "This is a bug in either %2 or the LV2 plugin <%3>"),
978 name(), PROGRAM_NAME, unique_id()) << endmsg;
981 Plugin::set_parameter(which, val);
985 LV2Plugin::get_parameter(uint32_t which) const
987 if (parameter_is_input(which)) {
988 return (float)_shadow_data[which];
990 return (float)_control_data[which];
996 LV2Plugin::get_docs() const
998 LilvNodes* comments = lilv_plugin_get_value(_impl->plugin, _world.rdfs_comment);
1000 const std::string docs(lilv_node_as_string(lilv_nodes_get_first(comments)));
1001 lilv_nodes_free(comments);
1009 LV2Plugin::get_parameter_docs(uint32_t which) const
1011 LilvNodes* comments = lilv_port_get_value(
1013 lilv_plugin_get_port_by_index(_impl->plugin, which),
1014 _world.rdfs_comment);
1017 const std::string docs(lilv_node_as_string(lilv_nodes_get_first(comments)));
1018 lilv_nodes_free(comments);
1026 LV2Plugin::nth_parameter(uint32_t n, bool& ok) const
1029 for (uint32_t c = 0, x = 0; x < lilv_plugin_get_num_ports(_impl->plugin); ++x) {
1030 if (parameter_is_control(x)) {
1042 LV2Plugin::extension_data(const char* uri) const
1044 return lilv_instance_get_extension_data(_impl->instance, uri);
1048 LV2Plugin::c_plugin()
1050 return _impl->plugin;
1056 return (const void*)_impl->ui;
1060 LV2Plugin::c_ui_type()
1062 return (const void*)_impl->ui_type;
1065 /** Directory for all plugin state. */
1067 LV2Plugin::plugin_dir() const
1069 if (!_plugin_state_dir.empty ()){
1070 return Glib::build_filename(_plugin_state_dir, _insert_id.to_s());
1072 return Glib::build_filename(_session.plugins_dir(), _insert_id.to_s());
1076 /** Directory for files created by the plugin (except during save). */
1078 LV2Plugin::scratch_dir() const
1080 return Glib::build_filename(plugin_dir(), "scratch");
1083 /** Directory for snapshots of files in the scratch directory. */
1085 LV2Plugin::file_dir() const
1087 return Glib::build_filename(plugin_dir(), "files");
1090 /** Directory to save state snapshot version @c num into. */
1092 LV2Plugin::state_dir(unsigned num) const
1094 return Glib::build_filename(plugin_dir(), string_compose("state%1", num));
1097 /** Implementation of state:makePath for files created at instantiation time.
1098 * Note this is not used for files created at save time (Lilv deals with that).
1101 LV2Plugin::lv2_state_make_path(LV2_State_Make_Path_Handle handle,
1104 LV2Plugin* me = (LV2Plugin*)handle;
1105 if (me->_insert_id == PBD::ID("0")) {
1106 warning << string_compose(
1107 "File path \"%1\" requested but LV2 %2 has no insert ID",
1108 path, me->name()) << endmsg;
1109 return g_strdup(path);
1112 const std::string abs_path = Glib::build_filename(me->scratch_dir(), path);
1113 const std::string dirname = Glib::path_get_dirname(abs_path);
1114 g_mkdir_with_parents(dirname.c_str(), 0744);
1116 DEBUG_TRACE(DEBUG::LV2, string_compose("new file path %1 => %2\n",
1119 return g_strndup(abs_path.c_str(), abs_path.length());
1123 LV2Plugin::add_state(XMLNode* root) const
1125 assert(_insert_id != PBD::ID("0"));
1129 LocaleGuard lg(X_("C"));
1131 for (uint32_t i = 0; i < parameter_count(); ++i) {
1132 if (parameter_is_input(i) && parameter_is_control(i)) {
1133 child = new XMLNode("Port");
1134 child->add_property("symbol", port_symbol(i));
1135 snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
1136 child->add_property("value", string(buf));
1137 root->add_child_nocopy(*child);
1141 if (!_plugin_state_dir.empty()) {
1142 root->add_property("template-dir", _plugin_state_dir);
1145 if (_has_state_interface) {
1146 // Provisionally increment state version and create directory
1147 const std::string new_dir = state_dir(++_state_version);
1148 g_mkdir_with_parents(new_dir.c_str(), 0744);
1150 LilvState* state = lilv_state_new_from_instance(
1153 _uri_map.urid_map(),
1154 scratch_dir().c_str(),
1156 _session.externals_dir().c_str(),
1159 const_cast<LV2Plugin*>(this),
1163 if (!_plugin_state_dir.empty()
1165 || !lilv_state_equals(state, _impl->state)) {
1166 lilv_state_save(_world.world,
1167 _uri_map.urid_map(),
1168 _uri_map.urid_unmap(),
1174 if (_plugin_state_dir.empty()) {
1175 // normal session save
1176 lilv_state_free(_impl->state);
1177 _impl->state = state;
1179 // template save (dedicated state-dir)
1180 lilv_state_free(state);
1183 // State is identical, decrement version and nuke directory
1184 lilv_state_free(state);
1185 PBD::remove_directory(new_dir);
1189 root->add_property("state-dir", string_compose("state%1", _state_version));
1193 // TODO: Once we can rely on lilv 0.16.0, lilv_world_get can replace this
1195 get_value(LilvWorld* world, const LilvNode* subject, const LilvNode* predicate)
1197 LilvNodes* vs = lilv_world_find_nodes(world, subject, predicate, NULL);
1199 LilvNode* node = lilv_node_duplicate(lilv_nodes_get_first(vs));
1200 lilv_nodes_free(vs);
1207 LV2Plugin::find_presets()
1209 LilvNode* lv2_appliesTo = lilv_new_uri(_world.world, LV2_CORE__appliesTo);
1210 LilvNode* pset_Preset = lilv_new_uri(_world.world, LV2_PRESETS__Preset);
1211 LilvNode* rdfs_label = lilv_new_uri(_world.world, LILV_NS_RDFS "label");
1213 LilvNodes* presets = lilv_plugin_get_related(_impl->plugin, pset_Preset);
1214 LILV_FOREACH(nodes, i, presets) {
1215 const LilvNode* preset = lilv_nodes_get(presets, i);
1216 lilv_world_load_resource(_world.world, preset);
1217 LilvNode* name = get_value(_world.world, preset, rdfs_label);
1218 bool userpreset = true; // TODO
1220 _presets.insert(std::make_pair(lilv_node_as_string(preset),
1221 Plugin::PresetRecord(
1222 lilv_node_as_string(preset),
1223 lilv_node_as_string(name),
1225 lilv_node_free(name);
1227 warning << string_compose(
1228 _("Plugin \"%1\" preset \"%2\" is missing a label\n"),
1229 lilv_node_as_string(lilv_plugin_get_uri(_impl->plugin)),
1230 lilv_node_as_string(preset)) << endmsg;
1233 lilv_nodes_free(presets);
1235 lilv_node_free(rdfs_label);
1236 lilv_node_free(pset_Preset);
1237 lilv_node_free(lv2_appliesTo);
1241 set_port_value(const char* port_symbol,
1247 LV2Plugin* self = (LV2Plugin*)user_data;
1248 if (type != 0 && type != URIMap::instance().urids.atom_Float) {
1249 return; // TODO: Support non-float ports
1252 const uint32_t port_index = self->port_index(port_symbol);
1253 if (port_index != (uint32_t)-1) {
1254 self->set_parameter(port_index, *(const float*)value);
1259 LV2Plugin::load_preset(PresetRecord r)
1261 LilvWorld* world = _world.world;
1262 LilvNode* pset = lilv_new_uri(world, r.uri.c_str());
1263 LilvState* state = lilv_state_new_from_world(world, _uri_map.urid_map(), pset);
1266 lilv_state_restore(state, _impl->instance, set_port_value, this, 0, NULL);
1267 lilv_state_free(state);
1268 Plugin::load_preset(r);
1271 lilv_node_free(pset);
1276 ARDOUR::lv2plugin_get_port_value(const char* port_symbol,
1281 LV2Plugin *plugin = (LV2Plugin *) user_data;
1283 uint32_t index = plugin->port_index(port_symbol);
1284 if (index != (uint32_t) -1) {
1285 if (plugin->parameter_is_input(index) && plugin->parameter_is_control(index)) {
1287 *size = sizeof(float);
1288 *type = plugin->_uri_map.uri_to_id(LV2_ATOM__Float);
1289 value = &plugin->_shadow_data[index];
1301 LV2Plugin::do_save_preset(string name)
1303 LilvNode* plug_name = lilv_plugin_get_name(_impl->plugin);
1304 const string prefix = legalize_for_uri(lilv_node_as_string(plug_name));
1305 const string base_name = legalize_for_uri(name);
1306 const string file_name = base_name + ".ttl";
1307 const string bundle = Glib::build_filename(
1308 Glib::get_home_dir(),
1309 Glib::build_filename(".lv2", prefix + "_" + base_name + ".lv2"));
1311 #ifdef HAVE_LILV_0_21_3
1312 /* delete reference to old preset (if any) */
1313 const PresetRecord* r = preset_by_label(name);
1315 LilvNode* pset = lilv_new_uri (_world.world, r->uri.c_str());
1317 lilv_world_unload_resource (_world.world, pset);
1318 lilv_node_free(pset);
1323 LilvState* state = lilv_state_new_from_instance(
1326 _uri_map.urid_map(),
1327 scratch_dir().c_str(), // file_dir
1328 bundle.c_str(), // copy_dir
1329 bundle.c_str(), // link_dir
1330 bundle.c_str(), // save_dir
1331 lv2plugin_get_port_value, // get_value
1332 (void*)this, // user_data
1333 LV2_STATE_IS_POD|LV2_STATE_IS_PORTABLE, // flags
1334 _features // features
1337 lilv_state_set_label(state, name.c_str());
1339 _world.world, // world
1340 _uri_map.urid_map(), // map
1341 _uri_map.urid_unmap(), // unmap
1343 NULL, // uri (NULL = use file URI)
1344 bundle.c_str(), // dir
1345 file_name.c_str() // filename
1348 lilv_state_free(state);
1350 std::string uri = Glib::filename_to_uri(Glib::build_filename(bundle, file_name));
1351 LilvNode *node_bundle = lilv_new_uri(_world.world, Glib::filename_to_uri(Glib::build_filename(bundle, "/")).c_str());
1352 LilvNode *node_preset = lilv_new_uri(_world.world, uri.c_str());
1353 #ifdef HAVE_LILV_0_21_3
1354 lilv_world_unload_resource(_world.world, node_preset);
1355 lilv_world_unload_bundle(_world.world, node_bundle);
1357 lilv_world_load_bundle(_world.world, node_bundle);
1358 lilv_world_load_resource(_world.world, node_preset);
1359 lilv_node_free(node_bundle);
1360 lilv_node_free(node_preset);
1361 lilv_node_free(plug_name);
1366 LV2Plugin::do_remove_preset(string name)
1368 #ifdef HAVE_LILV_0_21_3
1369 /* Look up preset record by label (FIXME: ick, label as ID) */
1370 const PresetRecord* r = preset_by_label(name);
1375 /* Load a LilvState for the preset. */
1376 LilvWorld* world = _world.world;
1377 LilvNode* pset = lilv_new_uri(world, r->uri.c_str());
1378 LilvState* state = lilv_state_new_from_world(world, _uri_map.urid_map(), pset);
1380 lilv_node_free(pset);
1384 /* Unload preset from world. */
1385 lilv_world_unload_resource(world, pset);
1387 /* Delete it from the file system. This will remove the preset file and the entry
1388 from the manifest. If this results in an empty manifest (i.e. the
1389 preset is the only thing in the bundle), then the bundle is removed. */
1390 lilv_state_delete(world, state);
1392 lilv_state_free(state);
1393 lilv_node_free(pset);
1395 /* Without lilv_state_delete(), we could delete the preset file, but this
1396 would leave a broken bundle/manifest around, so the preset would still
1397 be visible, but broken. Naively deleting a bundle is too dangerous, so
1398 we simply do not support preset deletion with older Lilv */
1402 LV2Plugin::has_editor() const
1404 return _impl->ui != NULL;
1408 LV2Plugin::has_message_output() const
1410 for (uint32_t i = 0; i < num_ports(); ++i) {
1411 if ((_port_flags[i] & PORT_SEQUENCE) &&
1412 (_port_flags[i] & PORT_OUTPUT)) {
1420 LV2Plugin::write_to(RingBuffer<uint8_t>* dest,
1424 const uint8_t* body)
1426 const uint32_t buf_size = sizeof(UIMessage) + size;
1427 vector<uint8_t> buf(buf_size);
1429 UIMessage* msg = (UIMessage*)&buf[0];
1431 msg->protocol = protocol;
1433 memcpy(msg + 1, body, size);
1435 return (dest->write(&buf[0], buf_size) == buf_size);
1439 LV2Plugin::write_from_ui(uint32_t index,
1442 const uint8_t* body)
1445 size_t rbs = _session.engine().raw_buffer_size(DataType::MIDI) * NBUFS;
1446 /* buffer data communication from plugin UI to plugin instance.
1447 * this buffer needs to potentially hold
1448 * (port's minimumSize) * (audio-periods) / (UI-periods)
1451 * e.g 48kSPS / 128fpp -> audio-periods = 375 Hz
1452 * ui-periods = 25 Hz (SuperRapidScreenUpdate)
1453 * default minimumSize = 32K (see LV2Plugin::allocate_atom_event_buffers()
1455 * it is NOT safe to overflow (msg.size will be misinterpreted)
1457 uint32_t bufsiz = 32768;
1458 if (_atom_ev_buffers && _atom_ev_buffers[0]) {
1459 bufsiz = lv2_evbuf_get_capacity(_atom_ev_buffers[0]);
1461 rbs = max((size_t) bufsiz * 8, rbs);
1462 _from_ui = new RingBuffer<uint8_t>(rbs);
1465 if (!write_to(_from_ui, index, protocol, size, body)) {
1466 error << "Error writing from UI to plugin" << endmsg;
1473 LV2Plugin::write_to_ui(uint32_t index,
1476 const uint8_t* body)
1478 if (!write_to(_to_ui, index, protocol, size, body)) {
1479 error << "Error writing from plugin to UI" << endmsg;
1486 forge_variant(LV2_Atom_Forge* forge, const Variant& value)
1488 switch (value.type()) {
1489 case Variant::NOTHING:
1491 case Variant::BEATS:
1492 // No atom type for this, just forge a double
1493 lv2_atom_forge_double(forge, value.get_beats().to_double());
1496 lv2_atom_forge_bool(forge, value.get_bool());
1498 case Variant::DOUBLE:
1499 lv2_atom_forge_double(forge, value.get_double());
1501 case Variant::FLOAT:
1502 lv2_atom_forge_float(forge, value.get_float());
1505 lv2_atom_forge_int(forge, value.get_int());
1508 lv2_atom_forge_long(forge, value.get_long());
1511 lv2_atom_forge_path(
1512 forge, value.get_path().c_str(), value.get_path().size());
1514 case Variant::STRING:
1515 lv2_atom_forge_string(
1516 forge, value.get_string().c_str(), value.get_string().size());
1520 forge, value.get_uri().c_str(), value.get_uri().size());
1525 /** Get a variant type from a URI, return false iff no match found. */
1527 uri_to_variant_type(const std::string& uri, Variant::Type& type)
1529 if (uri == LV2_ATOM__Bool) {
1530 type = Variant::BOOL;
1531 } else if (uri == LV2_ATOM__Double) {
1532 type = Variant::DOUBLE;
1533 } else if (uri == LV2_ATOM__Float) {
1534 type = Variant::FLOAT;
1535 } else if (uri == LV2_ATOM__Int) {
1536 type = Variant::INT;
1537 } else if (uri == LV2_ATOM__Long) {
1538 type = Variant::LONG;
1539 } else if (uri == LV2_ATOM__Path) {
1540 type = Variant::PATH;
1541 } else if (uri == LV2_ATOM__String) {
1542 type = Variant::STRING;
1543 } else if (uri == LV2_ATOM__URI) {
1544 type = Variant::URI;
1552 LV2Plugin::set_property(uint32_t key, const Variant& value)
1554 if (_patch_port_in_index == (uint32_t)-1) {
1555 error << "LV2: set_property called with unset patch_port_in_index" << endmsg;
1557 } else if (value.type() == Variant::NOTHING) {
1558 error << "LV2: set_property called with void value" << endmsg;
1562 // Set up forge to write to temporary buffer on the stack
1563 LV2_Atom_Forge* forge = &_impl->ui_forge;
1564 LV2_Atom_Forge_Frame frame;
1565 uint8_t buf[PATH_MAX]; // Ought to be enough for anyone...
1567 lv2_atom_forge_set_buffer(forge, buf, sizeof(buf));
1569 // Serialize patch:Set message to set property
1570 #ifdef HAVE_LV2_1_10_0
1571 lv2_atom_forge_object(forge, &frame, 1, _uri_map.urids.patch_Set);
1572 lv2_atom_forge_key(forge, _uri_map.urids.patch_property);
1573 lv2_atom_forge_urid(forge, key);
1574 lv2_atom_forge_key(forge, _uri_map.urids.patch_value);
1576 lv2_atom_forge_blank(forge, &frame, 1, _uri_map.urids.patch_Set);
1577 lv2_atom_forge_property_head(forge, _uri_map.urids.patch_property, 0);
1578 lv2_atom_forge_urid(forge, key);
1579 lv2_atom_forge_property_head(forge, _uri_map.urids.patch_value, 0);
1582 forge_variant(forge, value);
1584 // Write message to UI=>Plugin ring
1585 const LV2_Atom* const atom = (const LV2_Atom*)buf;
1586 write_from_ui(_patch_port_in_index,
1587 _uri_map.urids.atom_eventTransfer,
1588 lv2_atom_total_size(atom),
1589 (const uint8_t*)atom);
1592 const ParameterDescriptor&
1593 LV2Plugin::get_property_descriptor(uint32_t id) const
1595 PropertyDescriptors::const_iterator p = _property_descriptors.find(id);
1596 if (p != _property_descriptors.end()) {
1599 return Plugin::get_property_descriptor(id);
1603 load_parameter_descriptor_units(LilvWorld* lworld, ParameterDescriptor& desc, const LilvNodes* units)
1605 if (lilv_nodes_contains(units, _world.units_midiNote)) {
1606 desc.unit = ParameterDescriptor::MIDI_NOTE;
1607 } else if (lilv_nodes_contains(units, _world.units_db)) {
1608 desc.unit = ParameterDescriptor::DB;
1609 } else if (lilv_nodes_contains(units, _world.units_hz)) {
1610 desc.unit = ParameterDescriptor::HZ;
1612 if (lilv_nodes_size(units) > 0) {
1613 const LilvNode* unit = lilv_nodes_get_first(units);
1614 LilvNode* render = get_value(lworld, unit, _world.units_render);
1616 desc.print_fmt = lilv_node_as_string(render);
1617 lilv_node_free(render);
1623 load_parameter_descriptor(LV2World& world,
1624 ParameterDescriptor& desc,
1625 Variant::Type datatype,
1626 const LilvNode* subject)
1628 LilvWorld* lworld = _world.world;
1629 LilvNode* label = get_value(lworld, subject, _world.rdfs_label);
1630 LilvNode* def = get_value(lworld, subject, _world.lv2_default);
1631 LilvNode* minimum = get_value(lworld, subject, _world.lv2_minimum);
1632 LilvNode* maximum = get_value(lworld, subject, _world.lv2_maximum);
1633 LilvNodes* units = lilv_world_find_nodes(lworld, subject, _world.units_unit, NULL);
1635 desc.label = lilv_node_as_string(label);
1637 if (def && lilv_node_is_float(def)) {
1638 desc.normal = lilv_node_as_float(def);
1640 if (minimum && lilv_node_is_float(minimum)) {
1641 desc.lower = lilv_node_as_float(minimum);
1643 if (maximum && lilv_node_is_float(maximum)) {
1644 desc.upper = lilv_node_as_float(maximum);
1646 load_parameter_descriptor_units(lworld, desc, units);
1647 desc.datatype = datatype;
1648 desc.toggled |= datatype == Variant::BOOL;
1649 desc.integer_step |= datatype == Variant::INT || datatype == Variant::LONG;
1650 desc.update_steps();
1652 lilv_nodes_free(units);
1653 lilv_node_free(label);
1654 lilv_node_free(def);
1655 lilv_node_free(minimum);
1656 lilv_node_free(maximum);
1660 LV2Plugin::load_supported_properties(PropertyDescriptors& descs)
1662 LilvWorld* lworld = _world.world;
1663 const LilvNode* subject = lilv_plugin_get_uri(_impl->plugin);
1664 LilvNodes* properties = lilv_world_find_nodes(
1665 lworld, subject, _world.patch_writable, NULL);
1666 LILV_FOREACH(nodes, p, properties) {
1667 // Get label and range
1668 const LilvNode* prop = lilv_nodes_get(properties, p);
1669 LilvNode* range = get_value(lworld, prop, _world.rdfs_range);
1671 warning << string_compose(_("LV2: property <%1> has no range datatype, ignoring"),
1672 lilv_node_as_uri(prop)) << endmsg;
1676 // Convert range to variant type (TODO: support for multiple range types)
1677 Variant::Type datatype;
1678 if (!uri_to_variant_type(lilv_node_as_uri(range), datatype)) {
1679 error << string_compose(_("LV2: property <%1> has unsupported datatype <%1>"),
1680 lilv_node_as_uri(prop), lilv_node_as_uri(range)) << endmsg;
1684 // Add description to result
1685 ParameterDescriptor desc;
1686 desc.key = _uri_map.uri_to_id(lilv_node_as_uri(prop));
1687 desc.datatype = datatype;
1688 load_parameter_descriptor(_world, desc, datatype, prop);
1689 descs.insert(std::make_pair(desc.key, desc));
1691 lilv_node_free(range);
1693 lilv_nodes_free(properties);
1697 LV2Plugin::announce_property_values()
1699 if (_patch_port_in_index == (uint32_t)-1) {
1703 // Set up forge to write to temporary buffer on the stack
1704 LV2_Atom_Forge* forge = &_impl->ui_forge;
1705 LV2_Atom_Forge_Frame frame;
1706 uint8_t buf[PATH_MAX]; // Ought to be enough for anyone...
1708 lv2_atom_forge_set_buffer(forge, buf, sizeof(buf));
1710 // Serialize patch:Get message with no subject (implicitly plugin instance)
1711 #ifdef HAVE_LV2_1_10_0
1712 lv2_atom_forge_object(forge, &frame, 1, _uri_map.urids.patch_Get);
1714 lv2_atom_forge_blank(forge, &frame, 1, _uri_map.urids.patch_Get);
1717 // Write message to UI=>Plugin ring
1718 const LV2_Atom* const atom = (const LV2_Atom*)buf;
1719 write_from_ui(_patch_port_in_index,
1720 _uri_map.urids.atom_eventTransfer,
1721 lv2_atom_total_size(atom),
1722 (const uint8_t*)atom);
1726 LV2Plugin::enable_ui_emission()
1729 /* see note in LV2Plugin::write_from_ui() */
1730 uint32_t bufsiz = 32768;
1731 if (_atom_ev_buffers && _atom_ev_buffers[0]) {
1732 bufsiz = lv2_evbuf_get_capacity(_atom_ev_buffers[0]);
1734 size_t rbs = _session.engine().raw_buffer_size(DataType::MIDI) * NBUFS;
1735 rbs = max((size_t) bufsiz * 8, rbs);
1736 _to_ui = new RingBuffer<uint8_t>(rbs);
1741 LV2Plugin::emit_to_ui(void* controller, UIMessageSink sink)
1747 uint32_t read_space = _to_ui->read_space();
1748 while (read_space > sizeof(UIMessage)) {
1750 if (_to_ui->read((uint8_t*)&msg, sizeof(msg)) != sizeof(msg)) {
1751 error << "Error reading from Plugin=>UI RingBuffer" << endmsg;
1754 vector<uint8_t> body(msg.size);
1755 if (_to_ui->read(&body[0], msg.size) != msg.size) {
1756 error << "Error reading from Plugin=>UI RingBuffer" << endmsg;
1760 sink(controller, msg.index, msg.size, msg.protocol, &body[0]);
1762 read_space -= sizeof(msg) + msg.size;
1767 LV2Plugin::work(uint32_t size, const void* data)
1769 return _impl->work_iface->work(
1770 _impl->instance->lv2_handle, work_respond, this, size, data);
1774 LV2Plugin::work_response(uint32_t size, const void* data)
1776 return _impl->work_iface->work_response(
1777 _impl->instance->lv2_handle, size, data);
1781 LV2Plugin::set_insert_id(PBD::ID id)
1783 if (_insert_id == "0") {
1785 } else if (_insert_id != id) {
1786 lilv_state_free(_impl->state);
1787 _impl->state = NULL;
1793 LV2Plugin::set_state_dir (const std::string& d)
1795 _plugin_state_dir = d;
1799 LV2Plugin::set_state(const XMLNode& node, int version)
1802 const XMLProperty* prop;
1803 XMLNodeConstIterator iter;
1808 LocaleGuard lg(X_("C"));
1810 if (node.name() != state_node_name()) {
1811 error << _("Bad node sent to LV2Plugin::set_state") << endmsg;
1815 #ifndef NO_PLUGIN_STATE
1817 if (version < 3000) {
1818 nodes = node.children("port");
1820 nodes = node.children("Port");
1823 for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
1827 if ((prop = child->property("symbol")) != 0) {
1828 sym = prop->value().c_str();
1830 warning << _("LV2: port has no symbol, ignored") << endmsg;
1834 map<string, uint32_t>::iterator i = _port_indices.find(sym);
1836 if (i != _port_indices.end()) {
1837 port_id = i->second;
1839 warning << _("LV2: port has unknown index, ignored") << endmsg;
1843 if ((prop = child->property("value")) != 0) {
1844 value = prop->value().c_str();
1846 warning << _("LV2: port has no value, ignored") << endmsg;
1850 set_parameter(port_id, atof(value));
1853 if ((prop = node.property("template-dir")) != 0) {
1854 set_state_dir (prop->value ());
1858 if ((prop = node.property("state-dir")) != 0) {
1859 if (sscanf(prop->value().c_str(), "state%u", &_state_version) != 1) {
1860 error << string_compose(
1861 "LV2: failed to parse state version from \"%1\"",
1862 prop->value()) << endmsg;
1865 std::string state_file = Glib::build_filename(
1867 Glib::build_filename(prop->value(), "state.ttl"));
1869 LilvState* state = lilv_state_new_from_file(
1870 _world.world, _uri_map.urid_map(), NULL, state_file.c_str());
1872 lilv_state_restore(state, _impl->instance, NULL, NULL, 0, NULL);
1873 lilv_state_free(_impl->state);
1874 _impl->state = state;
1877 if (!_plugin_state_dir.empty ()) {
1878 // force save with session, next time (increment counter)
1879 lilv_state_free (_impl->state);
1880 _impl->state = NULL;
1884 latency_compute_run();
1887 return Plugin::set_state(node, version);
1891 LV2Plugin::get_parameter_descriptor(uint32_t which, ParameterDescriptor& desc) const
1893 const LilvPort* port = lilv_plugin_get_port_by_index(_impl->plugin, which);
1895 error << string_compose("LV2: get descriptor of non-existent port %1", which)
1900 LilvNodes* portunits;
1901 LilvNode *def, *min, *max;
1902 lilv_port_get_range(_impl->plugin, port, &def, &min, &max);
1903 portunits = lilv_port_get_value(_impl->plugin, port, _world.units_unit);
1905 // TODO: Once we can rely on lilv 0.18.0 being present,
1906 // load_parameter_descriptor() can be used for ports as well
1907 desc.integer_step = lilv_port_has_property(_impl->plugin, port, _world.lv2_integer);
1908 desc.toggled = lilv_port_has_property(_impl->plugin, port, _world.lv2_toggled);
1909 desc.logarithmic = lilv_port_has_property(_impl->plugin, port, _world.ext_logarithmic);
1910 desc.sr_dependent = lilv_port_has_property(_impl->plugin, port, _world.lv2_sampleRate);
1911 desc.label = lilv_node_as_string(lilv_port_get_name(_impl->plugin, port));
1912 desc.normal = def ? lilv_node_as_float(def) : 0.0f;
1913 desc.lower = min ? lilv_node_as_float(min) : 0.0f;
1914 desc.upper = max ? lilv_node_as_float(max) : 1.0f;
1915 load_parameter_descriptor_units(_world.world, desc, portunits);
1917 if (desc.sr_dependent) {
1918 desc.lower *= _session.frame_rate ();
1919 desc.upper *= _session.frame_rate ();
1922 desc.min_unbound = false; // TODO: LV2 extension required
1923 desc.max_unbound = false; // TODO: LV2 extension required
1925 desc.enumeration = lilv_port_has_property(_impl->plugin, port, _world.lv2_enumeration);
1926 desc.scale_points = get_scale_points(which);
1928 desc.update_steps();
1930 lilv_node_free(def);
1931 lilv_node_free(min);
1932 lilv_node_free(max);
1933 lilv_nodes_free(portunits);
1938 Plugin::IOPortDescription
1939 LV2Plugin::describe_io_port (ARDOUR::DataType dt, bool input, uint32_t id) const
1941 PortFlags match = 0;
1943 case DataType::AUDIO:
1946 case DataType::MIDI:
1947 match = PORT_SEQUENCE | PORT_MIDI; // ignore old PORT_EVENT
1950 return Plugin::IOPortDescription ("?");
1954 match |= PORT_INPUT;
1956 match |= PORT_OUTPUT;
1960 uint32_t idx = UINT32_MAX;
1962 uint32_t const num_ports = parameter_count();
1963 for (uint32_t port_index = 0; port_index < num_ports; ++port_index) {
1964 PortFlags flags = _port_flags[port_index];
1965 if ((flags & match) == match) {
1972 if (idx == UINT32_MAX) {
1973 return Plugin::IOPortDescription ("?");
1976 LilvNode* name = lilv_port_get_name(_impl->plugin,
1977 lilv_plugin_get_port_by_index(_impl->plugin, idx));
1978 Plugin::IOPortDescription iod (lilv_node_as_string (name));
1979 lilv_node_free(name);
1981 if (lilv_port_has_property(_impl->plugin,
1982 lilv_plugin_get_port_by_index(_impl->plugin, idx), _world.lv2_isSideChain)) {
1983 iod.is_sidechain = true;
1989 LV2Plugin::describe_parameter(Evoral::Parameter which)
1991 if (( which.type() == PluginAutomation) && ( which.id() < parameter_count()) ) {
1993 if (lilv_port_has_property(_impl->plugin,
1994 lilv_plugin_get_port_by_index(_impl->plugin, which.id()), _world.ext_notOnGUI)) {
1995 return X_("hidden");
1998 if (lilv_port_has_property(_impl->plugin,
1999 lilv_plugin_get_port_by_index(_impl->plugin, which.id()), _world.lv2_freewheeling)) {
2000 return X_("hidden");
2003 if (lilv_port_has_property(_impl->plugin,
2004 lilv_plugin_get_port_by_index(_impl->plugin, which.id()), _world.lv2_reportsLatency)) {
2005 return X_("latency");
2008 LilvNode* name = lilv_port_get_name(_impl->plugin,
2009 lilv_plugin_get_port_by_index(_impl->plugin, which.id()));
2010 string ret(lilv_node_as_string(name));
2011 lilv_node_free(name);
2019 LV2Plugin::max_latency () const
2021 return _max_latency;
2025 LV2Plugin::signal_latency() const
2027 if (_latency_control_port) {
2028 return (framecnt_t)floor(*_latency_control_port);
2034 set<Evoral::Parameter>
2035 LV2Plugin::automatable() const
2037 set<Evoral::Parameter> ret;
2039 for (uint32_t i = 0; i < parameter_count(); ++i) {
2040 if (parameter_is_input(i) && parameter_is_control(i)) {
2041 ret.insert(ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
2045 for (PropertyDescriptors::const_iterator p = _property_descriptors.begin();
2046 p != _property_descriptors.end();
2048 ret.insert(ret.end(), Evoral::Parameter(PluginPropertyAutomation, 0, p->first));
2054 LV2Plugin::set_automation_control (uint32_t i, boost::shared_ptr<AutomationControl> c)
2056 if ((_port_flags[i] & PORT_CTRLED)) {
2057 _ctrl_map [i] = AutomationCtrlPtr (new AutomationCtrl(c));
2061 LV2Plugin::AutomationCtrlPtr
2062 LV2Plugin::get_automation_control (uint32_t i)
2064 if (_ctrl_map.find (i) == _ctrl_map.end()) {
2065 return AutomationCtrlPtr ();
2067 return _ctrl_map[i];
2071 LV2Plugin::activate()
2073 DEBUG_TRACE(DEBUG::LV2, string_compose("%1 activate\n", name()));
2075 if (!_was_activated) {
2076 lilv_instance_activate(_impl->instance);
2077 _was_activated = true;
2082 LV2Plugin::deactivate()
2084 DEBUG_TRACE(DEBUG::LV2, string_compose("%1 deactivate\n", name()));
2086 if (_was_activated) {
2087 lilv_instance_deactivate(_impl->instance);
2088 _was_activated = false;
2093 LV2Plugin::cleanup()
2095 DEBUG_TRACE(DEBUG::LV2, string_compose("%1 cleanup\n", name()));
2098 lilv_instance_free(_impl->instance);
2099 _impl->instance = NULL;
2103 LV2Plugin::allocate_atom_event_buffers()
2105 /* reserve local scratch buffers for ATOM event-queues */
2106 const LilvPlugin* p = _impl->plugin;
2108 /* count non-MIDI atom event-ports
2109 * TODO: nicely ask drobilla to make a lilv_ call for that
2111 int count_atom_out = 0;
2112 int count_atom_in = 0;
2113 int minimumSize = 32768; // TODO use a per-port minimum-size
2114 for (uint32_t i = 0; i < lilv_plugin_get_num_ports(p); ++i) {
2115 const LilvPort* port = lilv_plugin_get_port_by_index(p, i);
2116 if (lilv_port_is_a(p, port, _world.atom_AtomPort)) {
2117 LilvNodes* buffer_types = lilv_port_get_value(
2118 p, port, _world.atom_bufferType);
2119 LilvNodes* atom_supports = lilv_port_get_value(
2120 p, port, _world.atom_supports);
2122 if (!lilv_nodes_contains(buffer_types, _world.atom_Sequence)
2123 || !lilv_nodes_contains(atom_supports, _world.midi_MidiEvent)) {
2124 if (lilv_port_is_a(p, port, _world.lv2_InputPort)) {
2127 if (lilv_port_is_a(p, port, _world.lv2_OutputPort)) {
2130 LilvNodes* min_size_v = lilv_port_get_value(_impl->plugin, port, _world.rsz_minimumSize);
2131 LilvNode* min_size = min_size_v ? lilv_nodes_get_first(min_size_v) : NULL;
2132 if (min_size && lilv_node_is_int(min_size)) {
2133 minimumSize = std::max(minimumSize, lilv_node_as_int(min_size));
2135 lilv_nodes_free(min_size_v);
2137 lilv_nodes_free(buffer_types);
2138 lilv_nodes_free(atom_supports);
2142 DEBUG_TRACE(DEBUG::LV2, string_compose("%1 need buffers for %2 atom-in and %3 atom-out event-ports\n",
2143 name(), count_atom_in, count_atom_out));
2145 const int total_atom_buffers = (count_atom_in + count_atom_out);
2146 if (_atom_ev_buffers || total_atom_buffers == 0) {
2150 DEBUG_TRACE(DEBUG::LV2, string_compose("allocate %1 atom_ev_buffers of %d bytes\n", total_atom_buffers, minimumSize));
2151 _atom_ev_buffers = (LV2_Evbuf**) malloc((total_atom_buffers + 1) * sizeof(LV2_Evbuf*));
2152 for (int i = 0; i < total_atom_buffers; ++i ) {
2153 _atom_ev_buffers[i] = lv2_evbuf_new(minimumSize, LV2_EVBUF_ATOM,
2154 _uri_map.urids.atom_Chunk, _uri_map.urids.atom_Sequence);
2156 _atom_ev_buffers[total_atom_buffers] = 0;
2160 /** Write an ardour position/time/tempo/meter as an LV2 event.
2161 * @return true on success.
2164 write_position(LV2_Atom_Forge* forge,
2166 const TempoMetric& t,
2167 Timecode::BBT_Time& bbt,
2169 framepos_t position,
2172 const URIMap::URIDs& urids = URIMap::instance().urids;
2174 uint8_t pos_buf[256];
2175 lv2_atom_forge_set_buffer(forge, pos_buf, sizeof(pos_buf));
2176 LV2_Atom_Forge_Frame frame;
2177 #ifdef HAVE_LV2_1_10_0
2178 lv2_atom_forge_object(forge, &frame, 1, urids.time_Position);
2179 lv2_atom_forge_key(forge, urids.time_frame);
2180 lv2_atom_forge_long(forge, position);
2181 lv2_atom_forge_key(forge, urids.time_speed);
2182 lv2_atom_forge_float(forge, speed);
2183 lv2_atom_forge_key(forge, urids.time_barBeat);
2184 lv2_atom_forge_float(forge, bbt.beats - 1 +
2185 (bbt.ticks / Timecode::BBT_Time::ticks_per_beat));
2186 lv2_atom_forge_key(forge, urids.time_bar);
2187 lv2_atom_forge_long(forge, bbt.bars - 1);
2188 lv2_atom_forge_key(forge, urids.time_beatUnit);
2189 lv2_atom_forge_int(forge, t.meter().note_divisor());
2190 lv2_atom_forge_key(forge, urids.time_beatsPerBar);
2191 lv2_atom_forge_float(forge, t.meter().divisions_per_bar());
2192 lv2_atom_forge_key(forge, urids.time_beatsPerMinute);
2193 lv2_atom_forge_float(forge, t.tempo().beats_per_minute());
2195 lv2_atom_forge_blank(forge, &frame, 1, urids.time_Position);
2196 lv2_atom_forge_property_head(forge, urids.time_frame, 0);
2197 lv2_atom_forge_long(forge, position);
2198 lv2_atom_forge_property_head(forge, urids.time_speed, 0);
2199 lv2_atom_forge_float(forge, speed);
2200 lv2_atom_forge_property_head(forge, urids.time_barBeat, 0);
2201 lv2_atom_forge_float(forge, bbt.beats - 1 +
2202 (bbt.ticks / Timecode::BBT_Time::ticks_per_beat));
2203 lv2_atom_forge_property_head(forge, urids.time_bar, 0);
2204 lv2_atom_forge_long(forge, bbt.bars - 1);
2205 lv2_atom_forge_property_head(forge, urids.time_beatUnit, 0);
2206 lv2_atom_forge_int(forge, t.meter().note_divisor());
2207 lv2_atom_forge_property_head(forge, urids.time_beatsPerBar, 0);
2208 lv2_atom_forge_float(forge, t.meter().divisions_per_bar());
2209 lv2_atom_forge_property_head(forge, urids.time_beatsPerMinute, 0);
2210 lv2_atom_forge_float(forge, t.tempo().beats_per_minute());
2213 LV2_Evbuf_Iterator end = lv2_evbuf_end(buf);
2214 const LV2_Atom* const atom = (const LV2_Atom*)pos_buf;
2215 return lv2_evbuf_write(&end, offset, 0, atom->type, atom->size,
2216 (const uint8_t*)(atom + 1));
2220 LV2Plugin::connect_and_run(BufferSet& bufs,
2221 ChanMapping in_map, ChanMapping out_map,
2222 pframes_t nframes, framecnt_t offset)
2224 DEBUG_TRACE(DEBUG::LV2, string_compose("%1 run %2 offset %3\n", name(), nframes, offset));
2225 Plugin::connect_and_run(bufs, in_map, out_map, nframes, offset);
2227 cycles_t then = get_cycles();
2229 TempoMap& tmap = _session.tempo_map();
2230 Metrics::const_iterator metric_i = tmap.metrics_end();
2231 TempoMetric tmetric = tmap.metric_at(_session.transport_frame(), &metric_i);
2233 if (_freewheel_control_port) {
2234 *_freewheel_control_port = _session.engine().freewheeling() ? 1.f : 0.f;
2237 if (_bpm_control_port) {
2238 *_bpm_control_port = tmetric.tempo().beats_per_minute();
2242 if (_can_write_automation && _session.transport_frame() != _next_cycle_start) {
2243 // add guard-points after locating
2244 for (AutomationCtrlMap::iterator i = _ctrl_map.begin(); i != _ctrl_map.end(); ++i) {
2245 i->second->guard = true;
2250 ChanCount bufs_count;
2251 bufs_count.set(DataType::AUDIO, 1);
2252 bufs_count.set(DataType::MIDI, 1);
2253 BufferSet& silent_bufs = _session.get_silent_buffers(bufs_count);
2254 BufferSet& scratch_bufs = _session.get_scratch_buffers(bufs_count);
2255 uint32_t const num_ports = parameter_count();
2256 uint32_t const nil_index = std::numeric_limits<uint32_t>::max();
2258 uint32_t audio_in_index = 0;
2259 uint32_t audio_out_index = 0;
2260 uint32_t midi_in_index = 0;
2261 uint32_t midi_out_index = 0;
2262 uint32_t atom_port_index = 0;
2263 for (uint32_t port_index = 0; port_index < num_ports; ++port_index) {
2265 uint32_t index = nil_index;
2266 PortFlags flags = _port_flags[port_index];
2268 if (flags & PORT_AUDIO) {
2269 if (flags & PORT_INPUT) {
2270 index = in_map.get(DataType::AUDIO, audio_in_index++, &valid);
2272 ? bufs.get_audio(index).data(offset)
2273 : silent_bufs.get_audio(0).data(offset);
2275 index = out_map.get(DataType::AUDIO, audio_out_index++, &valid);
2277 ? bufs.get_audio(index).data(offset)
2278 : scratch_bufs.get_audio(0).data(offset);
2280 } else if (flags & (PORT_EVENT|PORT_SEQUENCE)) {
2281 /* FIXME: The checks here for bufs.count().n_midi() > index shouldn't
2282 be necessary, but the mapping is illegal in some cases. Ideally
2283 that should be fixed, but this is easier...
2285 if (flags & PORT_MIDI) {
2286 if (flags & PORT_INPUT) {
2287 index = in_map.get(DataType::MIDI, midi_in_index++, &valid);
2289 index = out_map.get(DataType::MIDI, midi_out_index++, &valid);
2291 if (valid && bufs.count().n_midi() > index) {
2292 /* Note, ensure_lv2_bufsize() is not RT safe!
2293 * However free()/alloc() is only called if a
2294 * plugin requires a rsz:minimumSize buffersize
2295 * and the existing buffer if smaller.
2297 bufs.ensure_lv2_bufsize((flags & PORT_INPUT), index, _port_minimumSize[port_index]);
2298 _ev_buffers[port_index] = bufs.get_lv2_midi(
2299 (flags & PORT_INPUT), index, (flags & PORT_EVENT));
2301 } else if ((flags & PORT_POSITION) && (flags & PORT_INPUT)) {
2302 lv2_evbuf_reset(_atom_ev_buffers[atom_port_index], true);
2303 _ev_buffers[port_index] = _atom_ev_buffers[atom_port_index++];
2307 if (valid && (flags & PORT_INPUT)) {
2308 Timecode::BBT_Time bbt;
2309 if ((flags & PORT_POSITION)) {
2310 if (_session.transport_frame() != _next_cycle_start ||
2311 _session.transport_speed() != _next_cycle_speed) {
2312 // Transport has changed, write position at cycle start
2313 tmap.bbt_time(_session.transport_frame(), bbt);
2314 write_position(&_impl->forge, _ev_buffers[port_index],
2315 tmetric, bbt, _session.transport_speed(),
2316 _session.transport_frame(), 0);
2320 // Get MIDI iterator range (empty range if no MIDI)
2321 MidiBuffer::iterator m = (index != nil_index)
2322 ? bufs.get_midi(index).begin()
2323 : silent_bufs.get_midi(0).end();
2324 MidiBuffer::iterator m_end = (index != nil_index)
2325 ? bufs.get_midi(index).end()
2328 // Now merge MIDI and any transport events into the buffer
2329 const uint32_t type = _uri_map.urids.midi_MidiEvent;
2330 const framepos_t tend = _session.transport_frame() + nframes;
2332 while (m != m_end || (metric_i != tmap.metrics_end() &&
2333 (*metric_i)->frame() < tend)) {
2334 MetricSection* metric = (metric_i != tmap.metrics_end())
2336 if (m != m_end && (!metric || metric->frame() > (*m).time())) {
2337 const Evoral::MIDIEvent<framepos_t> ev(*m, false);
2338 if (ev.time() < nframes) {
2339 LV2_Evbuf_Iterator eend = lv2_evbuf_end(_ev_buffers[port_index]);
2340 lv2_evbuf_write(&eend, ev.time(), 0, type, ev.size(), ev.buffer());
2344 tmetric.set_metric(metric);
2345 bbt = metric->start();
2346 write_position(&_impl->forge, _ev_buffers[port_index],
2347 tmetric, bbt, _session.transport_speed(),
2349 metric->frame() - _session.transport_frame());
2353 } else if (!valid) {
2354 // Nothing we understand or care about, connect to scratch
2355 // see note for midi-buffer size above
2356 scratch_bufs.ensure_lv2_bufsize((flags & PORT_INPUT),
2357 0, _port_minimumSize[port_index]);
2358 _ev_buffers[port_index] = scratch_bufs.get_lv2_midi(
2359 (flags & PORT_INPUT), 0, (flags & PORT_EVENT));
2362 buf = lv2_evbuf_get_buffer(_ev_buffers[port_index]);
2364 continue; // Control port, leave buffer alone
2366 lilv_instance_connect_port(_impl->instance, port_index, buf);
2369 // Read messages from UI and push into appropriate buffers
2371 uint32_t read_space = _from_ui->read_space();
2372 while (read_space > sizeof(UIMessage)) {
2374 if (_from_ui->read((uint8_t*)&msg, sizeof(msg)) != sizeof(msg)) {
2375 error << "Error reading from UI=>Plugin RingBuffer" << endmsg;
2378 vector<uint8_t> body(msg.size);
2379 if (_from_ui->read(&body[0], msg.size) != msg.size) {
2380 error << "Error reading from UI=>Plugin RingBuffer" << endmsg;
2383 if (msg.protocol == URIMap::instance().urids.atom_eventTransfer) {
2384 LV2_Evbuf* buf = _ev_buffers[msg.index];
2385 LV2_Evbuf_Iterator i = lv2_evbuf_end(buf);
2386 const LV2_Atom* const atom = (const LV2_Atom*)&body[0];
2387 if (!lv2_evbuf_write(&i, nframes - 1, 0, atom->type, atom->size,
2388 (const uint8_t*)(atom + 1))) {
2389 error << "Failed to write data to LV2 event buffer\n";
2392 error << "Received unknown message type from UI" << endmsg;
2394 read_space -= sizeof(UIMessage) + msg.size;
2401 for (uint32_t port_index = 0; port_index < num_ports; ++port_index) {
2402 PortFlags flags = _port_flags[port_index];
2405 /* TODO ask drobilla about comment
2406 * "Make Ardour event buffers generic so plugins can communicate"
2407 * in libs/ardour/buffer_set.cc:310
2409 * ideally the user could choose which of the following two modes
2410 * to use (e.g. instrument/effect chains MIDI OUT vs MIDI TRHU).
2412 * This implementation follows the discussion on IRC Mar 16 2013 16:47 UTC
2413 * 16:51 < drobilla> rgareus: [..] i.e always replace with MIDI output [of LV2 plugin] if it's there
2414 * 16:52 < drobilla> rgareus: That would probably be good enough [..] to make users not complain
2415 * for quite a while at least ;)
2417 // copy output of LV2 plugin's MIDI port to Ardour MIDI buffers -- MIDI OUT
2418 if ((flags & PORT_OUTPUT) && (flags & (PORT_EVENT|PORT_SEQUENCE|PORT_MIDI))) {
2419 const uint32_t buf_index = out_map.get(
2420 DataType::MIDI, midi_out_index++, &valid);
2422 bufs.forward_lv2_midi(_ev_buffers[port_index], buf_index);
2425 // Flush MIDI (write back to Ardour MIDI buffers) -- MIDI THRU
2426 else if ((flags & PORT_OUTPUT) && (flags & (PORT_EVENT|PORT_SEQUENCE))) {
2427 const uint32_t buf_index = out_map.get(
2428 DataType::MIDI, midi_out_index++, &valid);
2430 bufs.flush_lv2_midi(true, buf_index);
2434 // Write messages to UI
2435 if ((_to_ui || _can_write_automation || _patch_port_out_index != (uint32_t)-1) &&
2436 (flags & PORT_OUTPUT) && (flags & (PORT_EVENT|PORT_SEQUENCE))) {
2437 LV2_Evbuf* buf = _ev_buffers[port_index];
2438 for (LV2_Evbuf_Iterator i = lv2_evbuf_begin(buf);
2439 lv2_evbuf_is_valid(i);
2440 i = lv2_evbuf_next(i)) {
2441 uint32_t frames, subframes, type, size;
2443 lv2_evbuf_get(i, &frames, &subframes, &type, &size, &data);
2446 // Intercept Automation Write Events
2447 if ((flags & PORT_AUTOCTRL)) {
2448 LV2_Atom* atom = (LV2_Atom*)(data - sizeof(LV2_Atom));
2449 if (atom->type == _uri_map.urids.atom_Blank ||
2450 atom->type == _uri_map.urids.atom_Object) {
2451 LV2_Atom_Object* obj = (LV2_Atom_Object*)atom;
2452 if (obj->body.otype == _uri_map.urids.auto_event) {
2453 // only if transport_rolling ??
2454 const LV2_Atom* parameter = NULL;
2455 const LV2_Atom* value = NULL;
2456 lv2_atom_object_get(obj,
2457 _uri_map.urids.auto_parameter, ¶meter,
2458 _uri_map.urids.auto_value, &value,
2460 if (parameter && value) {
2461 const uint32_t p = ((const LV2_Atom_Int*)parameter)->body;
2462 const float v = ((const LV2_Atom_Float*)value)->body;
2463 // -> add automation event..
2464 AutomationCtrlPtr c = get_automation_control (p);
2465 if (c && c->ac->automation_state() == Touch) {
2468 c->ac->list()->add (_session.transport_frame() + frames, v, true, true);
2470 c->ac->set_double (v, _session.transport_frame() + frames, true);
2475 else if (obj->body.otype == _uri_map.urids.auto_setup) {
2476 // TODO optional arguments, for now we assume the plugin
2477 // writes automation for its own inputs
2478 // -> put them in "touch" mode (preferably "exclusive plugin touch(TM)"
2479 for (AutomationCtrlMap::iterator i = _ctrl_map.begin(); i != _ctrl_map.end(); ++i) {
2480 i->second->ac->set_automation_state (Touch);
2483 else if (obj->body.otype == _uri_map.urids.auto_finalize) {
2484 // set [touched] parameters to "play" ??
2486 else if (obj->body.otype == _uri_map.urids.auto_start) {
2487 const LV2_Atom* parameter = NULL;
2488 lv2_atom_object_get(obj,
2489 _uri_map.urids.auto_parameter, ¶meter,
2492 const uint32_t p = ((const LV2_Atom_Int*)parameter)->body;
2493 AutomationCtrlPtr c = get_automation_control (p);
2495 c->ac->start_touch (_session.transport_frame());
2500 else if (obj->body.otype == _uri_map.urids.auto_end) {
2501 const LV2_Atom* parameter = NULL;
2502 lv2_atom_object_get(obj,
2503 _uri_map.urids.auto_parameter, ¶meter,
2506 const uint32_t p = ((const LV2_Atom_Int*)parameter)->body;
2507 AutomationCtrlPtr c = get_automation_control (p);
2509 c->ac->stop_touch (true, _session.transport_frame());
2517 // Intercept patch change messages to emit PropertyChanged signal
2518 if ((flags & PORT_PATCHMSG)) {
2519 LV2_Atom* atom = (LV2_Atom*)(data - sizeof(LV2_Atom));
2520 if (atom->type == _uri_map.urids.atom_Blank ||
2521 atom->type == _uri_map.urids.atom_Object) {
2522 LV2_Atom_Object* obj = (LV2_Atom_Object*)atom;
2523 if (obj->body.otype == _uri_map.urids.patch_Set) {
2524 const LV2_Atom* property = NULL;
2525 const LV2_Atom* value = NULL;
2526 lv2_atom_object_get(obj,
2527 _uri_map.urids.patch_property, &property,
2528 _uri_map.urids.patch_value, &value,
2531 if (property && value &&
2532 property->type == _uri_map.urids.atom_URID &&
2533 value->type == _uri_map.urids.atom_Path) {
2534 const uint32_t prop_id = ((const LV2_Atom_URID*)property)->body;
2535 const char* path = (const char*)LV2_ATOM_BODY_CONST(value);
2537 // Emit PropertyChanged signal for UI
2538 // TODO: This should emit the control's Changed signal
2539 PropertyChanged(prop_id, Variant(Variant::PATH, path));
2541 std::cerr << "warning: patch:Set for unknown property" << std::endl;
2547 if (!_to_ui) continue;
2548 write_to_ui(port_index, URIMap::instance().urids.atom_eventTransfer,
2549 size + sizeof(LV2_Atom),
2550 data - sizeof(LV2_Atom));
2555 cycles_t now = get_cycles();
2556 set_cycles((uint32_t)(now - then));
2558 // Update expected transport information for next cycle so we can detect changes
2559 _next_cycle_speed = _session.transport_speed();
2560 _next_cycle_start = _session.transport_frame() + (nframes * _next_cycle_speed);
2562 if (_latency_control_port) {
2563 framecnt_t new_latency = signal_latency ();
2564 if (_current_latency != new_latency) {
2565 LatencyChanged (_current_latency, new_latency); /* EMIT SIGNAL */
2567 _current_latency = new_latency;
2573 LV2Plugin::parameter_is_control(uint32_t param) const
2575 assert(param < _port_flags.size());
2576 return _port_flags[param] & PORT_CONTROL;
2580 LV2Plugin::parameter_is_audio(uint32_t param) const
2582 assert(param < _port_flags.size());
2583 return _port_flags[param] & PORT_AUDIO;
2587 LV2Plugin::parameter_is_event(uint32_t param) const
2589 assert(param < _port_flags.size());
2590 return _port_flags[param] & PORT_EVENT;
2594 LV2Plugin::parameter_is_output(uint32_t param) const
2596 assert(param < _port_flags.size());
2597 return _port_flags[param] & PORT_OUTPUT;
2601 LV2Plugin::parameter_is_input(uint32_t param) const
2603 assert(param < _port_flags.size());
2604 return _port_flags[param] & PORT_INPUT;
2608 LV2Plugin::print_parameter(uint32_t param, char* buf, uint32_t len) const
2611 if (param < parameter_count()) {
2612 snprintf(buf, len, "%.3f", get_parameter(param));
2619 boost::shared_ptr<ScalePoints>
2620 LV2Plugin::get_scale_points(uint32_t port_index) const
2622 const LilvPort* port = lilv_plugin_get_port_by_index(_impl->plugin, port_index);
2623 LilvScalePoints* points = lilv_port_get_scale_points(_impl->plugin, port);
2625 boost::shared_ptr<ScalePoints> ret;
2630 ret = boost::shared_ptr<ScalePoints>(new ScalePoints());
2632 LILV_FOREACH(scale_points, i, points) {
2633 const LilvScalePoint* p = lilv_scale_points_get(points, i);
2634 const LilvNode* label = lilv_scale_point_get_label(p);
2635 const LilvNode* value = lilv_scale_point_get_value(p);
2636 if (label && (lilv_node_is_float(value) || lilv_node_is_int(value))) {
2637 ret->insert(make_pair(lilv_node_as_string(label),
2638 lilv_node_as_float(value)));
2642 lilv_scale_points_free(points);
2647 LV2Plugin::run(pframes_t nframes)
2649 uint32_t const N = parameter_count();
2650 for (uint32_t i = 0; i < N; ++i) {
2651 if (parameter_is_control(i) && parameter_is_input(i)) {
2652 _control_data[i] = _shadow_data[i];
2656 lilv_instance_run(_impl->instance, nframes);
2658 if (_impl->work_iface) {
2659 _worker->emit_responses();
2660 if (_impl->work_iface->end_run) {
2661 _impl->work_iface->end_run(_impl->instance->lv2_handle);
2667 LV2Plugin::latency_compute_run()
2669 if (!_latency_control_port) {
2673 // Run the plugin so that it can set its latency parameter
2675 bool was_activated = _was_activated;
2678 uint32_t port_index = 0;
2679 uint32_t in_index = 0;
2680 uint32_t out_index = 0;
2682 // this is done in the main thread. non realtime.
2683 const framecnt_t bufsize = _engine.samples_per_cycle();
2684 float *buffer = (float*) malloc(_engine.samples_per_cycle() * sizeof(float));
2686 memset(buffer, 0, sizeof(float) * bufsize);
2688 // FIXME: Ensure plugins can handle in-place processing
2692 while (port_index < parameter_count()) {
2693 if (parameter_is_audio(port_index)) {
2694 if (parameter_is_input(port_index)) {
2695 lilv_instance_connect_port(_impl->instance, port_index, buffer);
2697 } else if (parameter_is_output(port_index)) {
2698 lilv_instance_connect_port(_impl->instance, port_index, buffer);
2707 if (was_activated) {
2714 LV2Plugin::Impl::designated_input (const char* uri, void** bufptrs[], void** bufptr)
2716 const LilvPort* port = NULL;
2717 LilvNode* designation = lilv_new_uri(_world.world, uri);
2718 port = lilv_plugin_get_port_by_designation(
2719 plugin, _world.lv2_InputPort, designation);
2720 lilv_node_free(designation);
2722 bufptrs[lilv_port_get_index(plugin, port)] = bufptr;
2727 static bool lv2_filter (const string& str, void* /*arg*/)
2729 /* Not a dotfile, has a prefix before a period, suffix is "lv2" */
2731 return str[0] != '.' && (str.length() > 3 && str.find (".lv2") == (str.length() - 4));
2735 LV2World::LV2World()
2736 : world(lilv_world_new())
2737 , _bundle_checked(false)
2739 atom_AtomPort = lilv_new_uri(world, LV2_ATOM__AtomPort);
2740 atom_Chunk = lilv_new_uri(world, LV2_ATOM__Chunk);
2741 atom_Sequence = lilv_new_uri(world, LV2_ATOM__Sequence);
2742 atom_bufferType = lilv_new_uri(world, LV2_ATOM__bufferType);
2743 atom_supports = lilv_new_uri(world, LV2_ATOM__supports);
2744 atom_eventTransfer = lilv_new_uri(world, LV2_ATOM__eventTransfer);
2745 ev_EventPort = lilv_new_uri(world, LILV_URI_EVENT_PORT);
2746 ext_logarithmic = lilv_new_uri(world, LV2_PORT_PROPS__logarithmic);
2747 ext_notOnGUI = lilv_new_uri(world, LV2_PORT_PROPS__notOnGUI);
2748 lv2_AudioPort = lilv_new_uri(world, LILV_URI_AUDIO_PORT);
2749 lv2_ControlPort = lilv_new_uri(world, LILV_URI_CONTROL_PORT);
2750 lv2_InputPort = lilv_new_uri(world, LILV_URI_INPUT_PORT);
2751 lv2_OutputPort = lilv_new_uri(world, LILV_URI_OUTPUT_PORT);
2752 lv2_inPlaceBroken = lilv_new_uri(world, LV2_CORE__inPlaceBroken);
2753 lv2_isSideChain = lilv_new_uri(world, LV2_CORE_PREFIX "isSideChain");
2754 lv2_integer = lilv_new_uri(world, LV2_CORE__integer);
2755 lv2_default = lilv_new_uri(world, LV2_CORE__default);
2756 lv2_minimum = lilv_new_uri(world, LV2_CORE__minimum);
2757 lv2_maximum = lilv_new_uri(world, LV2_CORE__maximum);
2758 lv2_reportsLatency = lilv_new_uri(world, LV2_CORE__reportsLatency);
2759 lv2_sampleRate = lilv_new_uri(world, LV2_CORE__sampleRate);
2760 lv2_toggled = lilv_new_uri(world, LV2_CORE__toggled);
2761 lv2_enumeration = lilv_new_uri(world, LV2_CORE__enumeration);
2762 lv2_freewheeling = lilv_new_uri(world, LV2_CORE__freeWheeling);
2763 midi_MidiEvent = lilv_new_uri(world, LILV_URI_MIDI_EVENT);
2764 rdfs_comment = lilv_new_uri(world, LILV_NS_RDFS "comment");
2765 rdfs_label = lilv_new_uri(world, LILV_NS_RDFS "label");
2766 rdfs_range = lilv_new_uri(world, LILV_NS_RDFS "range");
2767 rsz_minimumSize = lilv_new_uri(world, LV2_RESIZE_PORT__minimumSize);
2768 time_Position = lilv_new_uri(world, LV2_TIME__Position);
2769 ui_GtkUI = lilv_new_uri(world, LV2_UI__GtkUI);
2770 ui_external = lilv_new_uri(world, "http://lv2plug.in/ns/extensions/ui#external");
2771 ui_externalkx = lilv_new_uri(world, "http://kxstudio.sf.net/ns/lv2ext/external-ui#Widget");
2772 units_unit = lilv_new_uri(world, LV2_UNITS__unit);
2773 units_render = lilv_new_uri(world, LV2_UNITS__render);
2774 units_hz = lilv_new_uri(world, LV2_UNITS__hz);
2775 units_midiNote = lilv_new_uri(world, LV2_UNITS__midiNote);
2776 units_db = lilv_new_uri(world, LV2_UNITS__db);
2777 patch_writable = lilv_new_uri(world, LV2_PATCH__writable);
2778 patch_Message = lilv_new_uri(world, LV2_PATCH__Message);
2780 lv2_noSampleAccurateCtrl = lilv_new_uri(world, "http://ardour.org/lv2/ext#noSampleAccurateControls");
2781 auto_can_write_automatation = lilv_new_uri(world, LV2_AUTOMATE_URI__can_write);
2782 auto_automation_control = lilv_new_uri(world, LV2_AUTOMATE_URI__control);
2783 auto_automation_controlled = lilv_new_uri(world, LV2_AUTOMATE_URI__controlled);
2785 #ifdef HAVE_LV2_1_2_0
2786 bufz_powerOf2BlockLength = lilv_new_uri(world, LV2_BUF_SIZE__powerOf2BlockLength);
2787 bufz_fixedBlockLength = lilv_new_uri(world, LV2_BUF_SIZE__fixedBlockLength);
2788 bufz_nominalBlockLength = lilv_new_uri(world, "http://lv2plug.in/ns/ext/buf-size#nominalBlockLength");
2793 LV2World::~LV2World()
2798 #ifdef HAVE_LV2_1_2_0
2799 lilv_node_free(bufz_nominalBlockLength);
2800 lilv_node_free(bufz_fixedBlockLength);
2801 lilv_node_free(bufz_powerOf2BlockLength);
2804 lilv_node_free(lv2_noSampleAccurateCtrl);
2805 lilv_node_free(auto_can_write_automatation);
2806 lilv_node_free(auto_automation_control);
2807 lilv_node_free(auto_automation_controlled);
2809 lilv_node_free(patch_Message);
2810 lilv_node_free(patch_writable);
2811 lilv_node_free(units_hz);
2812 lilv_node_free(units_midiNote);
2813 lilv_node_free(units_db);
2814 lilv_node_free(units_unit);
2815 lilv_node_free(units_render);
2816 lilv_node_free(ui_externalkx);
2817 lilv_node_free(ui_external);
2818 lilv_node_free(ui_GtkUI);
2819 lilv_node_free(time_Position);
2820 lilv_node_free(rsz_minimumSize);
2821 lilv_node_free(rdfs_comment);
2822 lilv_node_free(rdfs_label);
2823 lilv_node_free(rdfs_range);
2824 lilv_node_free(midi_MidiEvent);
2825 lilv_node_free(lv2_enumeration);
2826 lilv_node_free(lv2_freewheeling);
2827 lilv_node_free(lv2_toggled);
2828 lilv_node_free(lv2_sampleRate);
2829 lilv_node_free(lv2_reportsLatency);
2830 lilv_node_free(lv2_integer);
2831 lilv_node_free(lv2_isSideChain);
2832 lilv_node_free(lv2_inPlaceBroken);
2833 lilv_node_free(lv2_OutputPort);
2834 lilv_node_free(lv2_InputPort);
2835 lilv_node_free(lv2_ControlPort);
2836 lilv_node_free(lv2_AudioPort);
2837 lilv_node_free(ext_notOnGUI);
2838 lilv_node_free(ext_logarithmic);
2839 lilv_node_free(ev_EventPort);
2840 lilv_node_free(atom_supports);
2841 lilv_node_free(atom_eventTransfer);
2842 lilv_node_free(atom_bufferType);
2843 lilv_node_free(atom_Sequence);
2844 lilv_node_free(atom_Chunk);
2845 lilv_node_free(atom_AtomPort);
2846 lilv_world_free(world);
2851 LV2World::load_bundled_plugins(bool verbose)
2853 if (!_bundle_checked) {
2855 cout << "Scanning folders for bundled LV2s: " << ARDOUR::lv2_bundled_search_path().to_string() << endl;
2858 vector<string> plugin_objects;
2859 find_paths_matching_filter (plugin_objects, ARDOUR::lv2_bundled_search_path(), lv2_filter, 0, true, true, true);
2860 for ( vector<string>::iterator x = plugin_objects.begin(); x != plugin_objects.end (); ++x) {
2861 #ifdef PLATFORM_WINDOWS
2862 string uri = "file:///" + *x + "/";
2864 string uri = "file://" + *x + "/";
2866 LilvNode *node = lilv_new_uri(world, uri.c_str());
2867 lilv_world_load_bundle(world, node);
2868 lilv_node_free(node);
2871 lilv_world_load_all(world);
2872 _bundle_checked = true;
2876 LV2PluginInfo::LV2PluginInfo (const char* plugin_uri)
2879 _plugin_uri = strdup(plugin_uri);
2882 LV2PluginInfo::~LV2PluginInfo()
2889 LV2PluginInfo::load(Session& session)
2893 const LilvPlugins* plugins = lilv_world_get_all_plugins(_world.world);
2894 LilvNode* uri = lilv_new_uri(_world.world, _plugin_uri);
2895 if (!uri) { throw failed_constructor(); }
2896 const LilvPlugin* lp = lilv_plugins_get_by_uri(plugins, uri);
2897 if (!lp) { throw failed_constructor(); }
2898 plugin.reset(new LV2Plugin(session.engine(), session, lp, session.frame_rate()));
2899 lilv_node_free(uri);
2900 plugin->set_info(PluginInfoPtr(shared_from_this ()));
2902 } catch (failed_constructor& err) {
2903 return PluginPtr((Plugin*)0);
2909 std::vector<Plugin::PresetRecord>
2910 LV2PluginInfo::get_presets (bool /*user_only*/) const
2912 std::vector<Plugin::PresetRecord> p;
2913 #ifndef NO_PLUGIN_STATE
2914 const LilvPlugin* lp = NULL;
2917 const LilvPlugins* plugins = lilv_world_get_all_plugins(_world.world);
2918 LilvNode* uri = lilv_new_uri(_world.world, _plugin_uri);
2919 if (!uri) { throw failed_constructor(); }
2920 lp = lilv_plugins_get_by_uri(plugins, uri);
2921 if (!lp) { throw failed_constructor(); }
2922 lilv_node_free(uri);
2923 } catch (failed_constructor& err) {
2927 // see LV2Plugin::find_presets
2928 LilvNode* lv2_appliesTo = lilv_new_uri(_world.world, LV2_CORE__appliesTo);
2929 LilvNode* pset_Preset = lilv_new_uri(_world.world, LV2_PRESETS__Preset);
2930 LilvNode* rdfs_label = lilv_new_uri(_world.world, LILV_NS_RDFS "label");
2932 LilvNodes* presets = lilv_plugin_get_related(lp, pset_Preset);
2933 LILV_FOREACH(nodes, i, presets) {
2934 const LilvNode* preset = lilv_nodes_get(presets, i);
2935 lilv_world_load_resource(_world.world, preset);
2936 LilvNode* name = get_value(_world.world, preset, rdfs_label);
2937 bool userpreset = true; // TODO
2939 p.push_back (Plugin::PresetRecord (lilv_node_as_string(preset), lilv_node_as_string(name), userpreset));
2940 lilv_node_free(name);
2943 lilv_nodes_free(presets);
2944 lilv_node_free(rdfs_label);
2945 lilv_node_free(pset_Preset);
2946 lilv_node_free(lv2_appliesTo);
2952 LV2PluginInfo::in_category (const std::string &c) const
2954 // TODO use untranslated lilv_plugin_get_class()
2955 // match gtk2_ardour/plugin_selector.cc
2956 if (category == c) {
2963 LV2PluginInfo::is_instrument () const
2965 if (category == "Instrument") {
2969 /* until we make sure that category remains untranslated in the lv2.ttl spec
2970 * and until most instruments also classify themselves as such, there's a 2nd check:
2972 if (n_inputs.n_midi() > 0 && n_inputs.n_audio() == 0 && n_outputs.n_audio() > 0) {
2980 LV2PluginInfo::discover()
2983 world.load_bundled_plugins();
2984 _world.load_bundled_plugins(true);
2986 PluginInfoList* plugs = new PluginInfoList;
2987 const LilvPlugins* plugins = lilv_world_get_all_plugins(world.world);
2989 LILV_FOREACH(plugins, i, plugins) {
2990 const LilvPlugin* p = lilv_plugins_get(plugins, i);
2991 const LilvNode* pun = lilv_plugin_get_uri(p);
2993 LV2PluginInfoPtr info(new LV2PluginInfo(lilv_node_as_string(pun)));
2995 LilvNode* name = lilv_plugin_get_name(p);
2996 if (!name || !lilv_plugin_get_port_by_index(p, 0)) {
2997 warning << "Ignoring invalid LV2 plugin "
2998 << lilv_node_as_string(lilv_plugin_get_uri(p))
3003 if (lilv_plugin_has_feature(p, world.lv2_inPlaceBroken)) {
3004 warning << string_compose(
3005 _("Ignoring LV2 plugin \"%1\" since it cannot do inplace processing."),
3006 lilv_node_as_string(name)) << endmsg;
3007 lilv_node_free(name);
3011 #ifdef HAVE_LV2_1_2_0
3012 LilvNodes *required_features = lilv_plugin_get_required_features (p);
3013 if (lilv_nodes_contains (required_features, world.bufz_powerOf2BlockLength) ||
3014 lilv_nodes_contains (required_features, world.bufz_fixedBlockLength)
3016 warning << string_compose(
3017 _("Ignoring LV2 plugin \"%1\" because its buffer-size requirements cannot be satisfied."),
3018 lilv_node_as_string(name)) << endmsg;
3019 lilv_nodes_free(required_features);
3020 lilv_node_free(name);
3023 lilv_nodes_free(required_features);
3028 info->name = string(lilv_node_as_string(name));
3029 lilv_node_free(name);
3030 ARDOUR::PluginScanMessage(_("LV2"), info->name, false);
3032 const LilvPluginClass* pclass = lilv_plugin_get_class(p);
3033 const LilvNode* label = lilv_plugin_class_get_label(pclass);
3034 info->category = lilv_node_as_string(label);
3036 LilvNode* author_name = lilv_plugin_get_author_name(p);
3037 info->creator = author_name ? string(lilv_node_as_string(author_name)) : "Unknown";
3038 lilv_node_free(author_name);
3040 info->path = "/NOPATH"; // Meaningless for LV2
3042 /* count atom-event-ports that feature
3043 * atom:supports <http://lv2plug.in/ns/ext/midi#MidiEvent>
3045 * TODO: nicely ask drobilla to make a lilv_ call for that
3047 int count_midi_out = 0;
3048 int count_midi_in = 0;
3049 for (uint32_t i = 0; i < lilv_plugin_get_num_ports(p); ++i) {
3050 const LilvPort* port = lilv_plugin_get_port_by_index(p, i);
3051 if (lilv_port_is_a(p, port, world.atom_AtomPort)) {
3052 LilvNodes* buffer_types = lilv_port_get_value(
3053 p, port, world.atom_bufferType);
3054 LilvNodes* atom_supports = lilv_port_get_value(
3055 p, port, world.atom_supports);
3057 if (lilv_nodes_contains(buffer_types, world.atom_Sequence)
3058 && lilv_nodes_contains(atom_supports, world.midi_MidiEvent)) {
3059 if (lilv_port_is_a(p, port, world.lv2_InputPort)) {
3062 if (lilv_port_is_a(p, port, world.lv2_OutputPort)) {
3066 lilv_nodes_free(buffer_types);
3067 lilv_nodes_free(atom_supports);
3071 info->n_inputs.set_audio(
3072 lilv_plugin_get_num_ports_of_class(
3073 p, world.lv2_InputPort, world.lv2_AudioPort, NULL));
3074 info->n_inputs.set_midi(
3075 lilv_plugin_get_num_ports_of_class(
3076 p, world.lv2_InputPort, world.ev_EventPort, NULL)
3079 info->n_outputs.set_audio(
3080 lilv_plugin_get_num_ports_of_class(
3081 p, world.lv2_OutputPort, world.lv2_AudioPort, NULL));
3082 info->n_outputs.set_midi(
3083 lilv_plugin_get_num_ports_of_class(
3084 p, world.lv2_OutputPort, world.ev_EventPort, NULL)
3087 info->unique_id = lilv_node_as_uri(lilv_plugin_get_uri(p));
3088 info->index = 0; // Meaningless for LV2
3090 plugs->push_back(info);