Fix compilation against older LV2.
[ardour.git] / libs / ardour / lv2_plugin.cc
1 /*
2     Copyright (C) 2008-2012 Paul Davis
3     Author: David Robillard
4
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.
9
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.
14
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.
18 */
19
20 #include <string>
21 #include <vector>
22 #include <limits>
23
24 #include <cmath>
25 #include <cstdlib>
26 #include <cstring>
27
28 #include <glib/gstdio.h>
29 #include <glib/gprintf.h>
30 #include <glibmm.h>
31
32 #include <boost/utility.hpp>
33
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"
39
40 #include "libardour-config.h"
41
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"
52
53 #include "i18n.h"
54 #include <locale.h>
55
56 #include <lilv/lilv.h>
57
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/ext/patch/patch.h"
70 #ifdef HAVE_LV2_1_2_0
71 #include "lv2/lv2plug.in/ns/ext/buf-size/buf-size.h"
72 #include "lv2/lv2plug.in/ns/ext/options/options.h"
73 #endif
74
75 #include "lv2_evbuf.h"
76
77 #ifdef HAVE_SUIL
78 #include <suil/suil.h>
79 #endif
80
81 // Compatibility for lv2-1.0.0
82 #ifndef LV2_ATOM_CONTENTS_CONST
83 #define LV2_ATOM_CONTENTS_CONST(type, atom) \
84         ((const void*)((const uint8_t*)(atom) + sizeof(type)))
85 #endif
86 #ifndef LV2_ATOM_BODY_CONST
87 #define LV2_ATOM_BODY_CONST(atom) LV2_ATOM_CONTENTS_CONST(LV2_Atom, atom)
88 #endif
89
90 /** The number of MIDI buffers that will fit in a UI/worker comm buffer.
91     This needs to be roughly the number of cycles the UI will get around to
92     actually processing the traffic.  Lower values are flakier but save memory.
93 */
94 static const size_t NBUFS = 4;
95
96 using namespace std;
97 using namespace ARDOUR;
98 using namespace PBD;
99
100 URIMap LV2Plugin::_uri_map;
101
102 LV2Plugin::URIDs LV2Plugin::urids = {
103         _uri_map.uri_to_id(LV2_ATOM__Chunk),
104         _uri_map.uri_to_id(LV2_ATOM__Path),
105         _uri_map.uri_to_id(LV2_ATOM__Sequence),
106         _uri_map.uri_to_id(LV2_ATOM__eventTransfer),
107         _uri_map.uri_to_id(LV2_ATOM__URID),
108         _uri_map.uri_to_id(LV2_ATOM__Blank),
109         _uri_map.uri_to_id(LV2_ATOM__Object),
110         _uri_map.uri_to_id(LV2_LOG__Error),
111         _uri_map.uri_to_id(LV2_LOG__Note),
112         _uri_map.uri_to_id(LV2_LOG__Warning),
113         _uri_map.uri_to_id(LV2_MIDI__MidiEvent),
114         _uri_map.uri_to_id(LV2_TIME__Position),
115         _uri_map.uri_to_id(LV2_TIME__bar),
116         _uri_map.uri_to_id(LV2_TIME__barBeat),
117         _uri_map.uri_to_id(LV2_TIME__beatUnit),
118         _uri_map.uri_to_id(LV2_TIME__beatsPerBar),
119         _uri_map.uri_to_id(LV2_TIME__beatsPerMinute),
120         _uri_map.uri_to_id(LV2_TIME__frame),
121         _uri_map.uri_to_id(LV2_TIME__speed),
122         _uri_map.uri_to_id(LV2_PATCH__Get),
123         _uri_map.uri_to_id(LV2_PATCH__Set),
124         _uri_map.uri_to_id(LV2_PATCH__property),
125         _uri_map.uri_to_id(LV2_PATCH__value)
126 };
127
128 class LV2World : boost::noncopyable {
129 public:
130         LV2World ();
131         ~LV2World ();
132
133         void load_bundled_plugins(bool verbose=false);
134
135         LilvWorld* world;
136
137         LilvNode* atom_AtomPort;
138         LilvNode* atom_Chunk;
139         LilvNode* atom_Sequence;
140         LilvNode* atom_bufferType;
141         LilvNode* atom_eventTransfer;
142         LilvNode* atom_supports;
143         LilvNode* ev_EventPort;
144         LilvNode* ext_logarithmic;
145         LilvNode* ext_notOnGUI;
146         LilvNode* lv2_AudioPort;
147         LilvNode* lv2_ControlPort;
148         LilvNode* lv2_InputPort;
149         LilvNode* lv2_OutputPort;
150         LilvNode* lv2_enumeration;
151         LilvNode* lv2_freewheeling;
152         LilvNode* lv2_inPlaceBroken;
153         LilvNode* lv2_integer;
154         LilvNode* lv2_reportsLatency;
155         LilvNode* lv2_sampleRate;
156         LilvNode* lv2_toggled;
157         LilvNode* midi_MidiEvent;
158         LilvNode* rdfs_comment;
159         LilvNode* rdfs_label;
160         LilvNode* rdfs_range;
161         LilvNode* rsz_minimumSize;
162         LilvNode* time_Position;
163         LilvNode* ui_GtkUI;
164         LilvNode* ui_external;
165         LilvNode* ui_externalkx;
166         LilvNode* units_unit;
167         LilvNode* units_midiNote;
168         LilvNode* patch_writable;
169         LilvNode* patch_Message;
170
171 private:
172         bool _bundle_checked;
173 };
174
175 static LV2World _world;
176
177 /* worker extension */
178
179 /** Called by the plugin to schedule non-RT work. */
180 static LV2_Worker_Status
181 work_schedule(LV2_Worker_Schedule_Handle handle,
182               uint32_t                   size,
183               const void*                data)
184 {
185         LV2Plugin* plugin = (LV2Plugin*)handle;
186         if (plugin->session().engine().freewheeling()) {
187                 // Freewheeling, do the work immediately in this (audio) thread
188                 return (LV2_Worker_Status)plugin->work(size, data);
189         } else {
190                 // Enqueue message for the worker thread
191                 return plugin->worker()->schedule(size, data) ?
192                         LV2_WORKER_SUCCESS : LV2_WORKER_ERR_UNKNOWN;
193         }
194 }
195
196 /** Called by the plugin to respond to non-RT work. */
197 static LV2_Worker_Status
198 work_respond(LV2_Worker_Respond_Handle handle,
199              uint32_t                  size,
200              const void*               data)
201 {
202         LV2Plugin* plugin = (LV2Plugin*)handle;
203         if (plugin->session().engine().freewheeling()) {
204                 // Freewheeling, respond immediately in this (audio) thread
205                 return (LV2_Worker_Status)plugin->work_response(size, data);
206         } else {
207                 // Enqueue response for the worker
208                 return plugin->worker()->respond(size, data) ?
209                         LV2_WORKER_SUCCESS : LV2_WORKER_ERR_UNKNOWN;
210         }
211 }
212
213 /* log extension */
214
215 static int
216 log_vprintf(LV2_Log_Handle /*handle*/,
217             LV2_URID       type,
218             const char*    fmt,
219             va_list        args)
220 {
221         char* str = NULL;
222         const int ret = g_vasprintf(&str, fmt, args);
223         if (type == LV2Plugin::urids.log_Error) {
224                 error << str << endmsg;
225         } else if (type == LV2Plugin::urids.log_Warning) {
226                 warning << str << endmsg;
227         } else if (type == LV2Plugin::urids.log_Note) {
228                 info << str << endmsg;
229         }
230         // TODO: Toggleable log:Trace message support
231         return ret;
232 }
233
234 static int
235 log_printf(LV2_Log_Handle handle,
236            LV2_URID       type,
237            const char*    fmt, ...)
238 {
239         va_list args;
240         va_start(args, fmt);
241         const int ret = log_vprintf(handle, type, fmt, args);
242         va_end(args);
243         return ret;
244 }
245
246 struct LV2Plugin::Impl {
247         Impl() : plugin(0), ui(0), ui_type(0), name(0), author(0), instance(0)
248                , work_iface(0)
249                , state(0)
250         {}
251
252         /** Find the LV2 input port with the given designation.
253          * If found, bufptrs[port_index] will be set to bufptr.
254          */
255         const LilvPort* designated_input (const char* uri, void** bufptrs[], void** bufptr);
256
257         const LilvPlugin*           plugin;
258         const LilvUI*               ui;
259         const LilvNode*             ui_type;
260         LilvNode*                   name;
261         LilvNode*                   author;
262         LilvInstance*               instance;
263         const LV2_Worker_Interface* work_iface;
264         LilvState*                  state;
265         LV2_Atom_Forge              forge;
266         LV2_Atom_Forge              ui_forge;
267 };
268
269 LV2Plugin::LV2Plugin (AudioEngine& engine,
270                       Session&     session,
271                       const void*  c_plugin,
272                       framecnt_t   rate)
273         : Plugin (engine, session)
274         , Workee ()
275         , _impl(new Impl())
276         , _features(NULL)
277         , _worker(NULL)
278         , _insert_id("0")
279         , _patch_port_in_index((uint32_t)-1)
280         , _patch_port_out_index((uint32_t)-1)
281 {
282         init(c_plugin, rate);
283 }
284
285 LV2Plugin::LV2Plugin (const LV2Plugin& other)
286         : Plugin (other)
287         , Workee ()
288         , _impl(new Impl())
289         , _features(NULL)
290         , _worker(NULL)
291         , _insert_id(other._insert_id)
292         , _patch_port_in_index((uint32_t)-1)
293         , _patch_port_out_index((uint32_t)-1)
294 {
295         init(other._impl->plugin, other._sample_rate);
296
297         for (uint32_t i = 0; i < parameter_count(); ++i) {
298                 _control_data[i] = other._shadow_data[i];
299                 _shadow_data[i]  = other._shadow_data[i];
300         }
301 }
302
303 void
304 LV2Plugin::init(const void* c_plugin, framecnt_t rate)
305 {
306         DEBUG_TRACE(DEBUG::LV2, "init\n");
307
308         _impl->plugin           = (const LilvPlugin*)c_plugin;
309         _impl->ui               = NULL;
310         _impl->ui_type          = NULL;
311         _to_ui                  = NULL;
312         _from_ui                = NULL;
313         _control_data           = 0;
314         _shadow_data            = 0;
315         _atom_ev_buffers        = 0;
316         _ev_buffers             = 0;
317         _bpm_control_port       = 0;
318         _freewheel_control_port = 0;
319         _latency_control_port   = 0;
320         _next_cycle_start       = std::numeric_limits<framepos_t>::max();
321         _next_cycle_speed       = 1.0;
322         _block_length           = _engine.samples_per_cycle();
323         _seq_size               = _engine.raw_buffer_size(DataType::MIDI);
324         _state_version          = 0;
325         _was_activated          = false;
326         _has_state_interface    = false;
327
328         _instance_access_feature.URI = "http://lv2plug.in/ns/ext/instance-access";
329         _data_access_feature.URI     = "http://lv2plug.in/ns/ext/data-access";
330         _make_path_feature.URI       = LV2_STATE__makePath;
331         _log_feature.URI             = LV2_LOG__log;
332         _work_schedule_feature.URI   = LV2_WORKER__schedule;
333         _work_schedule_feature.data  = NULL;
334         _def_state_feature.URI       = LV2_STATE_PREFIX "loadDefaultState";  // Post LV2-1.2.0
335         _def_state_feature.data      = NULL;
336
337         const LilvPlugin* plugin = _impl->plugin;
338
339         LilvNode* state_iface_uri = lilv_new_uri(_world.world, LV2_STATE__interface);
340         LilvNode* state_uri       = lilv_new_uri(_world.world, LV2_STATE_URI);
341         _has_state_interface =
342                 // What plugins should have (lv2:extensionData state:Interface)
343                 lilv_plugin_has_extension_data(plugin, state_iface_uri)
344                 // What some outdated/incorrect ones have
345                 || lilv_plugin_has_feature(plugin, state_uri);
346         lilv_node_free(state_uri);
347         lilv_node_free(state_iface_uri);
348
349         _features    = (LV2_Feature**)calloc(11, sizeof(LV2_Feature*));
350         _features[0] = &_instance_access_feature;
351         _features[1] = &_data_access_feature;
352         _features[2] = &_make_path_feature;
353         _features[3] = _uri_map.uri_map_feature();
354         _features[4] = _uri_map.urid_map_feature();
355         _features[5] = _uri_map.urid_unmap_feature();
356         _features[6] = &_log_feature;
357
358         unsigned n_features = 7;
359 #ifdef HAVE_LV2_1_2_0
360         _features[n_features++] = &_def_state_feature;
361 #endif
362
363         lv2_atom_forge_init(&_impl->forge, _uri_map.urid_map());
364         lv2_atom_forge_init(&_impl->ui_forge, _uri_map.urid_map());
365
366 #ifdef HAVE_LV2_1_2_0
367         LV2_URID atom_Int = _uri_map.uri_to_id(LV2_ATOM__Int);
368         LV2_Options_Option options[] = {
369                 { LV2_OPTIONS_INSTANCE, 0, _uri_map.uri_to_id(LV2_BUF_SIZE__minBlockLength),
370                   sizeof(int32_t), atom_Int, &_block_length },
371                 { LV2_OPTIONS_INSTANCE, 0, _uri_map.uri_to_id(LV2_BUF_SIZE__maxBlockLength),
372                   sizeof(int32_t), atom_Int, &_block_length },
373                 { LV2_OPTIONS_INSTANCE, 0, _uri_map.uri_to_id(LV2_BUF_SIZE__sequenceSize),
374                   sizeof(int32_t), atom_Int, &_seq_size },
375                 { LV2_OPTIONS_INSTANCE, 0, 0, 0, 0, NULL }
376         };
377
378         _options_feature.URI    = LV2_OPTIONS__options;
379         _options_feature.data   = options;
380         _features[n_features++] = &_options_feature;
381 #endif
382
383         LV2_State_Make_Path* make_path = (LV2_State_Make_Path*)malloc(
384                 sizeof(LV2_State_Make_Path));
385         make_path->handle = this;
386         make_path->path = &lv2_state_make_path;
387         _make_path_feature.data = make_path;
388
389         LV2_Log_Log* log = (LV2_Log_Log*)malloc(sizeof(LV2_Log_Log));
390         log->handle  = this;
391         log->printf  = &log_printf;
392         log->vprintf = &log_vprintf;
393         _log_feature.data = log;
394
395         LilvNode* worker_schedule = lilv_new_uri(_world.world, LV2_WORKER__schedule);
396         if (lilv_plugin_has_feature(plugin, worker_schedule)) {
397                 LV2_Worker_Schedule* schedule = (LV2_Worker_Schedule*)malloc(
398                         sizeof(LV2_Worker_Schedule));
399                 size_t buf_size = _session.engine().raw_buffer_size(DataType::MIDI) * NBUFS;
400                 _worker                     = new Worker(this, buf_size);
401                 schedule->handle            = this;
402                 schedule->schedule_work     = work_schedule;
403                 _work_schedule_feature.data = schedule;
404                 _features[n_features++]     = &_work_schedule_feature;
405         }
406         lilv_node_free(worker_schedule);
407
408         _impl->instance = lilv_plugin_instantiate(plugin, rate, _features);
409         _impl->name     = lilv_plugin_get_name(plugin);
410         _impl->author   = lilv_plugin_get_author_name(plugin);
411
412         if (_impl->instance == 0) {
413                 error << _("LV2: Failed to instantiate plugin ") << uri() << endmsg;
414                 throw failed_constructor();
415         }
416
417         _instance_access_feature.data              = (void*)_impl->instance->lv2_handle;
418         _data_access_extension_data.extension_data = _impl->instance->lv2_descriptor->extension_data;
419         _data_access_feature.data                  = &_data_access_extension_data;
420
421         LilvNode* worker_iface_uri = lilv_new_uri(_world.world, LV2_WORKER__interface);
422         if (lilv_plugin_has_extension_data(plugin, worker_iface_uri)) {
423                 _impl->work_iface = (const LV2_Worker_Interface*)extension_data(
424                         LV2_WORKER__interface);
425         }
426         lilv_node_free(worker_iface_uri);
427
428         if (lilv_plugin_has_feature(plugin, _world.lv2_inPlaceBroken)) {
429                 error << string_compose(
430                     _("LV2: \"%1\" cannot be used, since it cannot do inplace processing"),
431                     lilv_node_as_string(_impl->name)) << endmsg;
432                 lilv_node_free(_impl->name);
433                 lilv_node_free(_impl->author);
434                 throw failed_constructor();
435         }
436
437 #ifdef HAVE_LILV_0_16_0
438         // Load default state
439         LilvState* state = lilv_state_new_from_world(
440                 _world.world, _uri_map.urid_map(), lilv_plugin_get_uri(_impl->plugin));
441         if (state && _has_state_interface) {
442                 lilv_state_restore(state, _impl->instance, NULL, NULL, 0, NULL);
443         }
444 #endif
445
446         _sample_rate = rate;
447
448         const uint32_t num_ports = this->num_ports();
449         for (uint32_t i = 0; i < num_ports; ++i) {
450                 const LilvPort* port  = lilv_plugin_get_port_by_index(_impl->plugin, i);
451                 PortFlags       flags = 0;
452                 size_t          minimumSize = 0;
453
454                 if (lilv_port_is_a(_impl->plugin, port, _world.lv2_OutputPort)) {
455                         flags |= PORT_OUTPUT;
456                 } else if (lilv_port_is_a(_impl->plugin, port, _world.lv2_InputPort)) {
457                         flags |= PORT_INPUT;
458                 } else {
459                         error << string_compose(
460                                 "LV2: \"%1\" port %2 is neither input nor output",
461                                 lilv_node_as_string(_impl->name), i) << endmsg;
462                         throw failed_constructor();
463                 }
464
465                 if (lilv_port_is_a(_impl->plugin, port, _world.lv2_ControlPort)) {
466                         flags |= PORT_CONTROL;
467                 } else if (lilv_port_is_a(_impl->plugin, port, _world.lv2_AudioPort)) {
468                         flags |= PORT_AUDIO;
469                 } else if (lilv_port_is_a(_impl->plugin, port, _world.ev_EventPort)) {
470                         flags |= PORT_EVENT;
471                         flags |= PORT_MIDI;  // We assume old event API ports are for MIDI
472                 } else if (lilv_port_is_a(_impl->plugin, port, _world.atom_AtomPort)) {
473                         LilvNodes* buffer_types = lilv_port_get_value(
474                                 _impl->plugin, port, _world.atom_bufferType);
475                         LilvNodes* atom_supports = lilv_port_get_value(
476                                 _impl->plugin, port, _world.atom_supports);
477
478                         if (lilv_nodes_contains(buffer_types, _world.atom_Sequence)) {
479                                 flags |= PORT_SEQUENCE;
480                                 if (lilv_nodes_contains(atom_supports, _world.midi_MidiEvent)) {
481                                         flags |= PORT_MIDI;
482                                 }
483                                 if (lilv_nodes_contains(atom_supports, _world.time_Position)) {
484                                         flags |= PORT_POSITION;
485                                 }
486                                 if (lilv_nodes_contains(atom_supports, _world.patch_Message)) {
487                                         flags |= PORT_PATCHMSG;
488                                         if (flags & PORT_INPUT) {
489                                                 _patch_port_in_index = i;
490                                         } else {
491                                                 _patch_port_out_index = i;
492                                         }
493                                 }
494                         }
495                         LilvNodes* min_size_v = lilv_port_get_value(_impl->plugin, port, _world.rsz_minimumSize);
496                         LilvNode* min_size = min_size_v ? lilv_nodes_get_first(min_size_v) : NULL;
497                         if (min_size && lilv_node_is_int(min_size)) {
498                                 minimumSize = lilv_node_as_int(min_size);
499                         }
500                         lilv_nodes_free(min_size_v);
501                         lilv_nodes_free(buffer_types);
502                         lilv_nodes_free(atom_supports);
503                 } else {
504                         error << string_compose(
505                                 "LV2: \"%1\" port %2 has no known data type",
506                                 lilv_node_as_string(_impl->name), i) << endmsg;
507                         throw failed_constructor();
508                 }
509
510                 _port_flags.push_back(flags);
511                 _port_minimumSize.push_back(minimumSize);
512         }
513
514         _control_data = new float[num_ports];
515         _shadow_data  = new float[num_ports];
516         _defaults     = new float[num_ports];
517         _ev_buffers   = new LV2_Evbuf*[num_ports];
518         memset(_ev_buffers, 0, sizeof(LV2_Evbuf*) * num_ports);
519
520         const bool     latent        = lilv_plugin_has_latency(plugin);
521         const uint32_t latency_index = (latent)
522                 ? lilv_plugin_get_latency_port_index(plugin)
523                 : 0;
524
525         // Build an array of pointers to special parameter buffers
526         void*** params = new void**[num_ports];
527         for (uint32_t i = 0; i < num_ports; ++i) {
528                 params[i] = NULL;
529         }
530         _impl->designated_input (LV2_TIME__beatsPerMinute, params, (void**)&_bpm_control_port);
531         _impl->designated_input (LV2_CORE__freeWheeling, params, (void**)&_freewheel_control_port);
532
533         for (uint32_t i = 0; i < num_ports; ++i) {
534                 const LilvPort* port = lilv_plugin_get_port_by_index(plugin, i);
535                 const LilvNode* sym  = lilv_port_get_symbol(plugin, port);
536
537                 // Store index in map so we can look up index by symbol
538                 _port_indices.insert(std::make_pair(lilv_node_as_string(sym), i));
539
540                 // Get range and default value if applicable
541                 if (parameter_is_control(i)) {
542                         LilvNode* def;
543                         lilv_port_get_range(plugin, port, &def, NULL, NULL);
544                         _defaults[i] = def ? lilv_node_as_float(def) : 0.0f;
545                         if (lilv_port_has_property (plugin, port, _world.lv2_sampleRate)) {
546                                 _defaults[i] *= _session.frame_rate ();
547                         }
548                         lilv_node_free(def);
549
550                         lilv_instance_connect_port(_impl->instance, i, &_control_data[i]);
551
552                         if (latent && i == latency_index) {
553                                 _latency_control_port  = &_control_data[i];
554                                 *_latency_control_port = 0;
555                         }
556
557                         if (parameter_is_input(i)) {
558                                 _shadow_data[i] = default_value(i);
559                                 if (params[i]) {
560                                         *params[i] = (void*)&_shadow_data[i];
561                                 }
562                         }
563                 } else {
564                         _defaults[i] = 0.0f;
565                 }
566         }
567
568         delete[] params;
569
570         LilvUIs* uis = lilv_plugin_get_uis(plugin);
571         if (lilv_uis_size(uis) > 0) {
572 #ifdef HAVE_SUIL
573                 // Look for embeddable UI
574                 LILV_FOREACH(uis, u, uis) {
575                         const LilvUI*   this_ui      = lilv_uis_get(uis, u);
576                         const LilvNode* this_ui_type = NULL;
577                         if (lilv_ui_is_supported(this_ui,
578                                                  suil_ui_supported,
579                                                  _world.ui_GtkUI,
580                                                  &this_ui_type)) {
581                                 // TODO: Multiple UI support
582                                 _impl->ui      = this_ui;
583                                 _impl->ui_type = this_ui_type;
584                                 break;
585                         }
586                 }
587 #else
588                 // Look for Gtk native UI
589                 LILV_FOREACH(uis, i, uis) {
590                         const LilvUI* ui = lilv_uis_get(uis, i);
591                         if (lilv_ui_is_a(ui, _world.ui_GtkUI)) {
592                                 _impl->ui      = ui;
593                                 _impl->ui_type = _world.ui_GtkUI;
594                                 break;
595                         }
596                 }
597 #endif
598
599                 // If Gtk UI is not available, try to find external UI
600                 if (!_impl->ui) {
601                         LILV_FOREACH(uis, i, uis) {
602                                 const LilvUI* ui = lilv_uis_get(uis, i);
603                                 if (lilv_ui_is_a(ui, _world.ui_externalkx)) {
604                                         _impl->ui      = ui;
605                                         _impl->ui_type = _world.ui_external;
606                                         break;
607                                 }
608                                 if (lilv_ui_is_a(ui, _world.ui_external)) {
609                                         _impl->ui      = ui;
610                                         _impl->ui_type = _world.ui_external;
611                                 }
612                         }
613                 }
614         }
615
616         allocate_atom_event_buffers();
617         latency_compute_run();
618 }
619
620 LV2Plugin::~LV2Plugin ()
621 {
622         DEBUG_TRACE(DEBUG::LV2, string_compose("%1 destroy\n", name()));
623
624         deactivate();
625         cleanup();
626
627         lilv_instance_free(_impl->instance);
628         lilv_node_free(_impl->name);
629         lilv_node_free(_impl->author);
630
631         free(_features);
632         free(_make_path_feature.data);
633         free(_work_schedule_feature.data);
634
635         delete _to_ui;
636         delete _from_ui;
637         delete _worker;
638
639         if (_atom_ev_buffers) {
640                 LV2_Evbuf**  b = _atom_ev_buffers;
641                 while (*b) {
642                         free(*b);
643                         b++;
644                 }
645                 free(_atom_ev_buffers);
646         }
647
648         delete [] _control_data;
649         delete [] _shadow_data;
650         delete [] _ev_buffers;
651 }
652
653 bool
654 LV2Plugin::is_external_ui() const
655 {
656         if (!_impl->ui) {
657                 return false;
658         }
659         return lilv_ui_is_a(_impl->ui, _world.ui_external) || lilv_ui_is_a(_impl->ui, _world.ui_externalkx);
660 }
661
662 bool
663 LV2Plugin::is_external_kx() const
664 {
665         if (!_impl->ui) {
666                 return false;
667         }
668         return lilv_ui_is_a(_impl->ui, _world.ui_externalkx);
669 }
670
671 bool
672 LV2Plugin::ui_is_resizable () const
673 {
674         const LilvNode* s   = lilv_ui_get_uri(_impl->ui);
675         LilvNode*       p   = lilv_new_uri(_world.world, LV2_CORE__optionalFeature);
676         LilvNode*       fs  = lilv_new_uri(_world.world, LV2_UI__fixedSize);
677         LilvNode*       nrs = lilv_new_uri(_world.world, LV2_UI__noUserResize);
678
679         LilvNodes* fs_matches = lilv_world_find_nodes(_world.world, s, p, fs);
680         LilvNodes* nrs_matches = lilv_world_find_nodes(_world.world, s, p, nrs);
681
682         lilv_nodes_free(nrs_matches);
683         lilv_nodes_free(fs_matches);
684         lilv_node_free(nrs);
685         lilv_node_free(fs);
686         lilv_node_free(p);
687
688         return !fs_matches && !nrs_matches;
689 }
690
691 string
692 LV2Plugin::unique_id() const
693 {
694         return lilv_node_as_uri(lilv_plugin_get_uri(_impl->plugin));
695 }
696
697 const char*
698 LV2Plugin::uri() const
699 {
700         return lilv_node_as_uri(lilv_plugin_get_uri(_impl->plugin));
701 }
702
703 const char*
704 LV2Plugin::label() const
705 {
706         return lilv_node_as_string(_impl->name);
707 }
708
709 const char*
710 LV2Plugin::name() const
711 {
712         return lilv_node_as_string(_impl->name);
713 }
714
715 const char*
716 LV2Plugin::maker() const
717 {
718         return _impl->author ? lilv_node_as_string (_impl->author) : "Unknown";
719 }
720
721 uint32_t
722 LV2Plugin::num_ports() const
723 {
724         return lilv_plugin_get_num_ports(_impl->plugin);
725 }
726
727 uint32_t
728 LV2Plugin::parameter_count() const
729 {
730         return lilv_plugin_get_num_ports(_impl->plugin);
731 }
732
733 float
734 LV2Plugin::default_value(uint32_t port)
735 {
736         return _defaults[port];
737 }
738
739 const char*
740 LV2Plugin::port_symbol(uint32_t index) const
741 {
742         const LilvPort* port = lilv_plugin_get_port_by_index(_impl->plugin, index);
743         if (!port) {
744                 error << name() << ": Invalid port index " << index << endmsg;
745         }
746
747         const LilvNode* sym = lilv_port_get_symbol(_impl->plugin, port);
748         return lilv_node_as_string(sym);
749 }
750
751 uint32_t
752 LV2Plugin::port_index (const char* symbol) const
753 {
754         const map<string, uint32_t>::const_iterator i = _port_indices.find(symbol);
755         if (i != _port_indices.end()) {
756                 return  i->second;
757         } else {
758                 warning << string_compose(_("LV2: Unknown port %1"), symbol) << endmsg;
759                 return (uint32_t)-1;
760         }
761 }
762
763 void
764 LV2Plugin::set_parameter(uint32_t which, float val)
765 {
766         DEBUG_TRACE(DEBUG::LV2, string_compose(
767                             "%1 set parameter %2 to %3\n", name(), which, val));
768
769         if (which < lilv_plugin_get_num_ports(_impl->plugin)) {
770                 if (get_parameter (which) == val) {
771                         return;
772                 }
773
774                 _shadow_data[which] = val;
775         } else {
776                 warning << string_compose(
777                     _("Illegal parameter number used with plugin \"%1\". "
778                       "This is a bug in either %2 or the LV2 plugin <%3>"),
779                     name(), PROGRAM_NAME, unique_id()) << endmsg;
780         }
781
782         Plugin::set_parameter(which, val);
783 }
784
785 float
786 LV2Plugin::get_parameter(uint32_t which) const
787 {
788         if (parameter_is_input(which)) {
789                 return (float)_shadow_data[which];
790         } else {
791                 return (float)_control_data[which];
792         }
793         return 0.0f;
794 }
795
796 std::string
797 LV2Plugin::get_docs() const
798 {
799         LilvNodes* comments = lilv_plugin_get_value(_impl->plugin, _world.rdfs_comment);
800         if (comments) {
801                 const std::string docs(lilv_node_as_string(lilv_nodes_get_first(comments)));
802                 lilv_nodes_free(comments);
803                 return docs;
804         }
805
806         return "";
807 }
808
809 std::string
810 LV2Plugin::get_parameter_docs(uint32_t which) const
811 {
812         LilvNodes* comments = lilv_port_get_value(
813                 _impl->plugin,
814                 lilv_plugin_get_port_by_index(_impl->plugin, which),
815                 _world.rdfs_comment);
816
817         if (comments) {
818                 const std::string docs(lilv_node_as_string(lilv_nodes_get_first(comments)));
819                 lilv_nodes_free(comments);
820                 return docs;
821         }
822
823         return "";
824 }
825
826 uint32_t
827 LV2Plugin::nth_parameter(uint32_t n, bool& ok) const
828 {
829         ok = false;
830         for (uint32_t c = 0, x = 0; x < lilv_plugin_get_num_ports(_impl->plugin); ++x) {
831                 if (parameter_is_control(x)) {
832                         if (c++ == n) {
833                                 ok = true;
834                                 return x;
835                         }
836                 }
837         }
838
839         return 0;
840 }
841
842 const void*
843 LV2Plugin::extension_data(const char* uri) const
844 {
845         return lilv_instance_get_extension_data(_impl->instance, uri);
846 }
847
848 const void*
849 LV2Plugin::c_plugin()
850 {
851         return _impl->plugin;
852 }
853
854 const void*
855 LV2Plugin::c_ui()
856 {
857         return (const void*)_impl->ui;
858 }
859
860 const void*
861 LV2Plugin::c_ui_type()
862 {
863         return (const void*)_impl->ui_type;
864 }
865
866 /** Directory for all plugin state. */
867 const std::string
868 LV2Plugin::plugin_dir() const
869 {
870         return Glib::build_filename(_session.plugins_dir(), _insert_id.to_s());
871 }
872
873 /** Directory for files created by the plugin (except during save). */
874 const std::string
875 LV2Plugin::scratch_dir() const
876 {
877         return Glib::build_filename(plugin_dir(), "scratch");
878 }
879
880 /** Directory for snapshots of files in the scratch directory. */
881 const std::string
882 LV2Plugin::file_dir() const
883 {
884         return Glib::build_filename(plugin_dir(), "files");
885 }
886
887 /** Directory to save state snapshot version @c num into. */
888 const std::string
889 LV2Plugin::state_dir(unsigned num) const
890 {
891         return Glib::build_filename(plugin_dir(), string_compose("state%1", num));
892 }
893
894 /** Implementation of state:makePath for files created at instantiation time.
895  * Note this is not used for files created at save time (Lilv deals with that).
896  */
897 char*
898 LV2Plugin::lv2_state_make_path(LV2_State_Make_Path_Handle handle,
899                                const char*                path)
900 {
901         LV2Plugin* me = (LV2Plugin*)handle;
902         if (me->_insert_id == PBD::ID("0")) {
903                 warning << string_compose(
904                         "File path \"%1\" requested but LV2 %2 has no insert ID",
905                         path, me->name()) << endmsg;
906                 return g_strdup(path);
907         }
908
909         const std::string abs_path = Glib::build_filename(me->scratch_dir(), path);
910         const std::string dirname  = Glib::path_get_dirname(abs_path);
911         g_mkdir_with_parents(dirname.c_str(), 0744);
912
913         DEBUG_TRACE(DEBUG::LV2, string_compose("new file path %1 => %2\n",
914                                                path, abs_path));
915
916         return g_strndup(abs_path.c_str(), abs_path.length());
917 }
918
919 void
920 LV2Plugin::add_state(XMLNode* root) const
921 {
922         assert(_insert_id != PBD::ID("0"));
923
924         XMLNode*    child;
925         char        buf[16];
926         LocaleGuard lg(X_("POSIX"));
927
928         for (uint32_t i = 0; i < parameter_count(); ++i) {
929                 if (parameter_is_input(i) && parameter_is_control(i)) {
930                         child = new XMLNode("Port");
931                         child->add_property("symbol", port_symbol(i));
932                         snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
933                         child->add_property("value", string(buf));
934                         root->add_child_nocopy(*child);
935                 }
936         }
937
938         if (_has_state_interface) {
939                 // Provisionally increment state version and create directory
940                 const std::string new_dir = state_dir(++_state_version);
941                 g_mkdir_with_parents(new_dir.c_str(), 0744);
942
943                 LilvState* state = lilv_state_new_from_instance(
944                         _impl->plugin,
945                         _impl->instance,
946                         _uri_map.urid_map(),
947                         scratch_dir().c_str(),
948                         file_dir().c_str(),
949                         _session.externals_dir().c_str(),
950                         new_dir.c_str(),
951                         NULL,
952                         const_cast<LV2Plugin*>(this),
953                         0,
954                         NULL);
955
956                 if (!_impl->state || !lilv_state_equals(state, _impl->state)) {
957                         lilv_state_save(_world.world,
958                                         _uri_map.urid_map(),
959                                         _uri_map.urid_unmap(),
960                                         state,
961                                         NULL,
962                                         new_dir.c_str(),
963                                         "state.ttl");
964
965                         lilv_state_free(_impl->state);
966                         _impl->state = state;
967                 } else {
968                         // State is identical, decrement version and nuke directory
969                         lilv_state_free(state);
970                         PBD::remove_directory(new_dir);
971                         --_state_version;
972                 }
973
974                 root->add_property("state-dir", string_compose("state%1", _state_version));
975         }
976 }
977
978 static inline const LilvNode*
979 get_value(LilvWorld* world, const LilvNode* subject, const LilvNode* predicate)
980 {
981         LilvNodes* vs = lilv_world_find_nodes(world, subject, predicate, NULL);
982         return vs ? lilv_nodes_get_first(vs) : NULL;
983 }
984
985 void
986 LV2Plugin::find_presets()
987 {
988         LilvNode* lv2_appliesTo = lilv_new_uri(_world.world, LV2_CORE__appliesTo);
989         LilvNode* pset_Preset   = lilv_new_uri(_world.world, LV2_PRESETS__Preset);
990         LilvNode* rdfs_label    = lilv_new_uri(_world.world, LILV_NS_RDFS "label");
991
992         LilvNodes* presets = lilv_plugin_get_related(_impl->plugin, pset_Preset);
993         LILV_FOREACH(nodes, i, presets) {
994                 const LilvNode* preset = lilv_nodes_get(presets, i);
995                 lilv_world_load_resource(_world.world, preset);
996                 const LilvNode* name = get_value(_world.world, preset, rdfs_label);
997                 if (name) {
998                         _presets.insert(std::make_pair(lilv_node_as_string(preset),
999                                                        Plugin::PresetRecord(
1000                                                                lilv_node_as_string(preset),
1001                                                                lilv_node_as_string(name))));
1002                 } else {
1003                         warning << string_compose(
1004                             _("Plugin \"%1\" preset \"%2\" is missing a label\n"),
1005                             lilv_node_as_string(lilv_plugin_get_uri(_impl->plugin)),
1006                             lilv_node_as_string(preset)) << endmsg;
1007                 }
1008         }
1009         lilv_nodes_free(presets);
1010
1011         lilv_node_free(rdfs_label);
1012         lilv_node_free(pset_Preset);
1013         lilv_node_free(lv2_appliesTo);
1014 }
1015
1016 static void
1017 set_port_value(const char* port_symbol,
1018                void*       user_data,
1019                const void* value,
1020                uint32_t    /*size*/,
1021                uint32_t    type)
1022 {
1023         LV2Plugin* self = (LV2Plugin*)user_data;
1024         if (type != 0 && type != self->_uri_map.uri_to_id(LV2_ATOM__Float)) {
1025                 return;  // TODO: Support non-float ports
1026         }
1027
1028         const uint32_t port_index = self->port_index(port_symbol);
1029         if (port_index != (uint32_t)-1) {
1030                 self->set_parameter(port_index, *(const float*)value);
1031         }
1032 }
1033
1034 bool
1035 LV2Plugin::load_preset(PresetRecord r)
1036 {
1037         LilvWorld* world = _world.world;
1038         LilvNode*  pset  = lilv_new_uri(world, r.uri.c_str());
1039         LilvState* state = lilv_state_new_from_world(world, _uri_map.urid_map(), pset);
1040
1041         if (state) {
1042                 lilv_state_restore(state, _impl->instance, set_port_value, this, 0, NULL);
1043                 lilv_state_free(state);
1044                 Plugin::load_preset(r);
1045         }
1046
1047         lilv_node_free(pset);
1048         return state;
1049 }
1050
1051 const void*
1052 ARDOUR::lv2plugin_get_port_value(const char* port_symbol,
1053                                  void*       user_data,
1054                                  uint32_t*   size,
1055                                  uint32_t*   type)
1056 {
1057         LV2Plugin *plugin = (LV2Plugin *) user_data;
1058
1059         uint32_t index = plugin->port_index(port_symbol);
1060         if (index != (uint32_t) -1) {
1061                 if (plugin->parameter_is_input(index) && plugin->parameter_is_control(index)) {
1062                         float *value;
1063                         *size = sizeof(float);
1064                         *type = plugin->_uri_map.uri_to_id(LV2_ATOM__Float);
1065                         value = &plugin->_shadow_data[index];
1066
1067                         return value;
1068                 }
1069         }
1070
1071         *size = *type = 0;
1072         return NULL;
1073 }
1074
1075
1076 std::string
1077 LV2Plugin::do_save_preset(string name)
1078 {
1079         const string base_name = legalize_for_uri(name);
1080         const string file_name = base_name + ".ttl";
1081         const string bundle    = Glib::build_filename(
1082                 Glib::get_home_dir(),
1083                 Glib::build_filename(".lv2", base_name + ".lv2"));
1084
1085         LilvState* state = lilv_state_new_from_instance(
1086                 _impl->plugin,
1087                 _impl->instance,
1088                 _uri_map.urid_map(),
1089                 scratch_dir().c_str(),                   // file_dir
1090                 bundle.c_str(),                          // copy_dir
1091                 bundle.c_str(),                          // link_dir
1092                 bundle.c_str(),                          // save_dir
1093                 lv2plugin_get_port_value,                // get_value
1094                 (void*)this,                             // user_data
1095                 LV2_STATE_IS_POD|LV2_STATE_IS_PORTABLE,  // flags
1096                 _features                                // features
1097         );
1098
1099         lilv_state_set_label(state, name.c_str());
1100         lilv_state_save(
1101                 _world.world,           // world
1102                 _uri_map.urid_map(),    // map
1103                 _uri_map.urid_unmap(),  // unmap
1104                 state,                  // state
1105                 NULL,                   // uri (NULL = use file URI)
1106                 bundle.c_str(),         // dir
1107                 file_name.c_str()       // filename
1108         );
1109
1110         lilv_state_free(state);
1111
1112         std::string uri = Glib::filename_to_uri(Glib::build_filename(bundle, file_name));
1113         LilvNode *node_bundle = lilv_new_uri(_world.world, Glib::filename_to_uri(Glib::build_filename(bundle, "/")).c_str());
1114         LilvNode *node_preset = lilv_new_uri(_world.world, uri.c_str());
1115 #ifdef HAVE_LILV_0_19_2
1116         lilv_world_unload_resource(_world.world, node_preset);
1117         lilv_world_unload_bundle(_world.world, node_bundle);
1118 #endif
1119         lilv_world_load_bundle(_world.world, node_bundle);
1120         lilv_world_load_resource(_world.world, node_preset);
1121         lilv_node_free(node_bundle);
1122         lilv_node_free(node_preset);
1123         return uri;
1124 }
1125
1126 void
1127 LV2Plugin::do_remove_preset(string name)
1128 {
1129         string preset_file = Glib::build_filename(
1130                 Glib::get_home_dir(),
1131                 Glib::build_filename(
1132                         Glib::build_filename(".lv2", "presets"),
1133                         name + ".ttl"
1134                 )
1135         );
1136         ::g_unlink(preset_file.c_str());
1137 }
1138
1139 bool
1140 LV2Plugin::has_editor() const
1141 {
1142         return _impl->ui != NULL;
1143 }
1144
1145 bool
1146 LV2Plugin::has_message_output() const
1147 {
1148         for (uint32_t i = 0; i < num_ports(); ++i) {
1149                 if ((_port_flags[i] & PORT_SEQUENCE) &&
1150                     (_port_flags[i] & PORT_OUTPUT)) {
1151                         return true;
1152                 }
1153         }
1154         return false;
1155 }
1156
1157 bool
1158 LV2Plugin::write_to(RingBuffer<uint8_t>* dest,
1159                     uint32_t             index,
1160                     uint32_t             protocol,
1161                     uint32_t             size,
1162                     const uint8_t*       body)
1163 {
1164         const uint32_t  buf_size = sizeof(UIMessage) + size;
1165         vector<uint8_t> buf(buf_size);
1166
1167         UIMessage* msg = (UIMessage*)&buf[0];
1168         msg->index    = index;
1169         msg->protocol = protocol;
1170         msg->size     = size;
1171         memcpy(msg + 1, body, size);
1172
1173         return (dest->write(&buf[0], buf_size) == buf_size);
1174 }
1175
1176 bool
1177 LV2Plugin::write_from_ui(uint32_t       index,
1178                          uint32_t       protocol,
1179                          uint32_t       size,
1180                          const uint8_t* body)
1181 {
1182         if (!_from_ui) {
1183                 size_t rbs = _session.engine().raw_buffer_size(DataType::MIDI) * NBUFS;
1184                 /* buffer data communication from plugin UI to plugin instance.
1185                  * this buffer needs to potentially hold
1186                  *   (port's minimumSize) * (audio-periods) / (UI-periods)
1187                  * bytes.
1188                  *
1189                  *  e.g 48kSPS / 128fpp -> audio-periods = 375 Hz
1190                  *  ui-periods = 25 Hz (SuperRapidScreenUpdate)
1191                  *  default minimumSize = 32K (see LV2Plugin::allocate_atom_event_buffers()
1192                  *
1193                  * it is NOT safe to overflow (msg.size will be misinterpreted)
1194                  */
1195                 uint32_t bufsiz = 32768;
1196                 if (_atom_ev_buffers && _atom_ev_buffers[0]) {
1197                         bufsiz =  lv2_evbuf_get_capacity(_atom_ev_buffers[0]);
1198                 }
1199                 rbs = max((size_t) bufsiz * 8, rbs);
1200                 _from_ui = new RingBuffer<uint8_t>(rbs);
1201         }
1202
1203         if (!write_to(_from_ui, index, protocol, size, body)) {
1204                 error << "Error writing from UI to plugin" << endmsg;
1205                 return false;
1206         }
1207         return true;
1208 }
1209
1210 bool
1211 LV2Plugin::write_to_ui(uint32_t       index,
1212                        uint32_t       protocol,
1213                        uint32_t       size,
1214                        const uint8_t* body)
1215 {
1216         if (!write_to(_to_ui, index, protocol, size, body)) {
1217                 error << "Error writing from plugin to UI" << endmsg;
1218                 return false;
1219         }
1220         return true;
1221 }
1222
1223 static void
1224 forge_variant(LV2_Atom_Forge* forge, const Variant& value)
1225 {
1226         switch (value.type()) {
1227         case Variant::BOOL:
1228                 lv2_atom_forge_bool(forge, value.get_bool());
1229                 break;
1230         case Variant::DOUBLE:
1231                 lv2_atom_forge_double(forge, value.get_double());
1232                 break;
1233         case Variant::FLOAT:
1234                 lv2_atom_forge_float(forge, value.get_float());
1235                 break;
1236         case Variant::INT:
1237                 lv2_atom_forge_int(forge, value.get_int());
1238                 break;
1239         case Variant::LONG:
1240                 lv2_atom_forge_long(forge, value.get_long());
1241                 break;
1242         case Variant::PATH:
1243                 lv2_atom_forge_path(
1244                         forge, value.get_path().c_str(), value.get_path().size());
1245                 break;
1246         case Variant::STRING:
1247                 lv2_atom_forge_string(
1248                         forge, value.get_string().c_str(), value.get_string().size());
1249                 break;
1250         case Variant::URI:
1251                 lv2_atom_forge_uri(
1252                         forge, value.get_uri().c_str(), value.get_uri().size());
1253                 break;
1254         }
1255 }
1256
1257 /** Get a variant type from a URI, return false iff no match found. */
1258 static bool
1259 uri_to_variant_type(const std::string& uri, Variant::Type& type)
1260 {
1261         if (uri == LV2_ATOM__Bool) {
1262                 type = Variant::BOOL;
1263         } else if (uri == LV2_ATOM__Double) {
1264                 type = Variant::DOUBLE;
1265         } else if (uri == LV2_ATOM__Float) {
1266                 type = Variant::FLOAT;
1267         } else if (uri == LV2_ATOM__Int) {
1268                 type = Variant::INT;
1269         } else if (uri == LV2_ATOM__Long) {
1270                 type = Variant::LONG;
1271         } else if (uri == LV2_ATOM__Path) {
1272                 type = Variant::PATH;
1273         } else if (uri == LV2_ATOM__String) {
1274                 type = Variant::STRING;
1275         } else if (uri == LV2_ATOM__URI) {
1276                 type = Variant::URI;
1277         } else {
1278                 return false;
1279         }
1280         return true;
1281 }
1282
1283 void
1284 LV2Plugin::set_property(uint32_t key, const Variant& value)
1285 {
1286         if (_patch_port_in_index == (uint32_t)-1) {
1287                 error << "LV2: set_property called with unset patch_port_in_index" << endmsg;
1288                 return;
1289         }
1290
1291         // Set up forge to write to temporary buffer on the stack
1292         LV2_Atom_Forge*      forge = &_impl->ui_forge;
1293         LV2_Atom_Forge_Frame frame;
1294         uint8_t              buf[PATH_MAX];  // Ought to be enough for anyone...
1295
1296         lv2_atom_forge_set_buffer(forge, buf, sizeof(buf));
1297
1298         // Serialize patch:Set message to set property
1299 #ifdef HAVE_LV2_1_10_0
1300         lv2_atom_forge_object(forge, &frame, 1, LV2Plugin::urids.patch_Set);
1301         lv2_atom_forge_key(forge, LV2Plugin::urids.patch_property);
1302         lv2_atom_forge_urid(forge, key);
1303         lv2_atom_forge_key(forge, LV2Plugin::urids.patch_value);
1304 #else
1305         lv2_atom_forge_blank(forge, &frame, 1, LV2Plugin::urids.patch_Set);
1306         lv2_atom_forge_property_head(forge, LV2Plugin::urids.patch_property, 0);
1307         lv2_atom_forge_urid(forge, key);
1308         lv2_atom_forge_property_head(forge, LV2Plugin::urids.patch_value, 0);
1309 #endif
1310
1311         forge_variant(forge, value);
1312
1313         // Write message to UI=>Plugin ring
1314         const LV2_Atom* const atom = (const LV2_Atom*)buf;
1315         write_from_ui(_patch_port_in_index,
1316                       LV2Plugin::urids.atom_eventTransfer,
1317                       lv2_atom_total_size(atom),
1318                       (const uint8_t*)atom);
1319 }
1320
1321 void
1322 LV2Plugin::get_supported_properties(std::vector<ParameterDescriptor>& descs)
1323 {
1324         LilvWorld*       lworld     = _world.world;
1325         const LilvNode*  subject    = lilv_plugin_get_uri(_impl->plugin);
1326         LilvNodes*       properties = lilv_world_find_nodes(
1327                 lworld, subject, _world.patch_writable, NULL);
1328         LILV_FOREACH(nodes, p, properties) {
1329                 // Get label and range
1330                 const LilvNode* prop  = lilv_nodes_get(properties, p);
1331                 LilvNode*       label = lilv_world_get(lworld, prop, _world.rdfs_label, NULL);
1332                 LilvNode*       range = lilv_world_get(lworld, prop, _world.rdfs_range, NULL);
1333
1334                 // Convert range to variant type (TODO: support for multiple range types)
1335                 Variant::Type datatype;
1336                 if (!uri_to_variant_type(lilv_node_as_uri(range), datatype)) {
1337                         error << string_compose(_("LV2: unknown variant datatype \"%1\""),
1338                                                 lilv_node_as_uri(range));
1339                         continue;
1340                 }
1341
1342                 // Add description to result
1343                 ParameterDescriptor desc;
1344                 desc.key          = _uri_map.uri_to_id(lilv_node_as_uri(prop));
1345                 desc.label        = lilv_node_as_string(label);
1346                 desc.datatype     = datatype;
1347                 desc.toggled      = datatype == Variant::BOOL;
1348                 desc.integer_step = datatype == Variant::INT || datatype == Variant::LONG;
1349                 descs.push_back(desc);
1350
1351                 lilv_node_free(label);
1352                 lilv_node_free(range);
1353         }
1354         lilv_nodes_free(properties);
1355 }
1356
1357 void
1358 LV2Plugin::announce_property_values()
1359 {
1360         if (_patch_port_in_index == (uint32_t)-1) {
1361                 error << "LV2: set_property called with unset patch_port_in_index" << endmsg;
1362                 return;
1363         }
1364
1365         // Set up forge to write to temporary buffer on the stack
1366         LV2_Atom_Forge*      forge = &_impl->ui_forge;
1367         LV2_Atom_Forge_Frame frame;
1368         uint8_t              buf[PATH_MAX];  // Ought to be enough for anyone...
1369
1370         lv2_atom_forge_set_buffer(forge, buf, sizeof(buf));
1371
1372         // Serialize patch:Get message with no subject (implicitly plugin instance)
1373 #ifdef HAVE_LV2_1_10_0
1374         lv2_atom_forge_object(forge, &frame, 1, LV2Plugin::urids.patch_Get);
1375 #else
1376         lv2_atom_forge_blank(forge, &frame, 1, LV2Plugin::urids.patch_Get);
1377 #endif
1378
1379         // Write message to UI=>Plugin ring
1380         const LV2_Atom* const atom = (const LV2_Atom*)buf;
1381         write_from_ui(_patch_port_in_index,
1382                       LV2Plugin::urids.atom_eventTransfer,
1383                       lv2_atom_total_size(atom),
1384                       (const uint8_t*)atom);
1385 }
1386
1387 void
1388 LV2Plugin::enable_ui_emission()
1389 {
1390         if (!_to_ui) {
1391                 /* see note in LV2Plugin::write_from_ui() */
1392                 uint32_t bufsiz = 32768;
1393                 if (_atom_ev_buffers && _atom_ev_buffers[0]) {
1394                         bufsiz =  lv2_evbuf_get_capacity(_atom_ev_buffers[0]);
1395                 }
1396                 size_t rbs = _session.engine().raw_buffer_size(DataType::MIDI) * NBUFS;
1397                 rbs = max((size_t) bufsiz * 8, rbs);
1398                 _to_ui = new RingBuffer<uint8_t>(rbs);
1399         }
1400 }
1401
1402 void
1403 LV2Plugin::emit_to_ui(void* controller, UIMessageSink sink)
1404 {
1405         if (!_to_ui) {
1406                 return;
1407         }
1408
1409         uint32_t read_space = _to_ui->read_space();
1410         while (read_space > sizeof(UIMessage)) {
1411                 UIMessage msg;
1412                 if (_to_ui->read((uint8_t*)&msg, sizeof(msg)) != sizeof(msg)) {
1413                         error << "Error reading from Plugin=>UI RingBuffer" << endmsg;
1414                         break;
1415                 }
1416                 vector<uint8_t> body(msg.size);
1417                 if (_to_ui->read(&body[0], msg.size) != msg.size) {
1418                         error << "Error reading from Plugin=>UI RingBuffer" << endmsg;
1419                         break;
1420                 }
1421
1422                 sink(controller, msg.index, msg.size, msg.protocol, &body[0]);
1423
1424                 read_space -= sizeof(msg) + msg.size;
1425         }
1426 }
1427
1428 int
1429 LV2Plugin::work(uint32_t size, const void* data)
1430 {
1431         return _impl->work_iface->work(
1432                 _impl->instance->lv2_handle, work_respond, this, size, data);
1433 }
1434
1435 int
1436 LV2Plugin::work_response(uint32_t size, const void* data)
1437 {
1438         return _impl->work_iface->work_response(
1439                 _impl->instance->lv2_handle, size, data);
1440 }
1441
1442 void
1443 LV2Plugin::set_insert_info(const PluginInsert* insert)
1444 {
1445         _insert_id = insert->id();
1446 }
1447
1448 int
1449 LV2Plugin::set_state(const XMLNode& node, int version)
1450 {
1451         XMLNodeList          nodes;
1452         const XMLProperty*   prop;
1453         XMLNodeConstIterator iter;
1454         XMLNode*             child;
1455         const char*          sym;
1456         const char*          value;
1457         uint32_t             port_id;
1458         LocaleGuard          lg(X_("POSIX"));
1459
1460         if (node.name() != state_node_name()) {
1461                 error << _("Bad node sent to LV2Plugin::set_state") << endmsg;
1462                 return -1;
1463         }
1464
1465 #ifndef NO_PLUGIN_STATE
1466
1467         if (version < 3000) {
1468                 nodes = node.children("port");
1469         } else {
1470                 nodes = node.children("Port");
1471         }
1472
1473         for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
1474
1475                 child = *iter;
1476
1477                 if ((prop = child->property("symbol")) != 0) {
1478                         sym = prop->value().c_str();
1479                 } else {
1480                         warning << _("LV2: port has no symbol, ignored") << endmsg;
1481                         continue;
1482                 }
1483
1484                 map<string, uint32_t>::iterator i = _port_indices.find(sym);
1485
1486                 if (i != _port_indices.end()) {
1487                         port_id = i->second;
1488                 } else {
1489                         warning << _("LV2: port has unknown index, ignored") << endmsg;
1490                         continue;
1491                 }
1492
1493                 if ((prop = child->property("value")) != 0) {
1494                         value = prop->value().c_str();
1495                 } else {
1496                         warning << _("LV2: port has no value, ignored") << endmsg;
1497                         continue;
1498                 }
1499
1500                 set_parameter(port_id, atof(value));
1501         }
1502
1503         _state_version = 0;
1504         if ((prop = node.property("state-dir")) != 0) {
1505                 if (sscanf(prop->value().c_str(), "state%u", &_state_version) != 1) {
1506                         error << string_compose(
1507                                 "LV2: failed to parse state version from \"%1\"",
1508                                 prop->value()) << endmsg;
1509                 }
1510
1511                 std::string state_file = Glib::build_filename(
1512                         plugin_dir(),
1513                         Glib::build_filename(prop->value(), "state.ttl"));
1514
1515                 LilvState* state = lilv_state_new_from_file(
1516                         _world.world, _uri_map.urid_map(), NULL, state_file.c_str());
1517
1518                 lilv_state_restore(state, _impl->instance, NULL, NULL, 0, NULL);
1519         }
1520
1521         latency_compute_run();
1522 #endif
1523
1524         return Plugin::set_state(node, version);
1525 }
1526
1527 int
1528 LV2Plugin::get_parameter_descriptor(uint32_t which, ParameterDescriptor& desc) const
1529 {
1530         const LilvPort* port = lilv_plugin_get_port_by_index(_impl->plugin, which);
1531
1532         LilvNodes* portunits;
1533         LilvNode *def, *min, *max;
1534         lilv_port_get_range(_impl->plugin, port, &def, &min, &max);
1535         portunits = lilv_port_get_value(_impl->plugin, port, _world.units_unit);
1536
1537         desc.integer_step = lilv_port_has_property(_impl->plugin, port, _world.lv2_integer);
1538         desc.toggled      = lilv_port_has_property(_impl->plugin, port, _world.lv2_toggled);
1539         desc.logarithmic  = lilv_port_has_property(_impl->plugin, port, _world.ext_logarithmic);
1540         desc.sr_dependent = lilv_port_has_property(_impl->plugin, port, _world.lv2_sampleRate);
1541         desc.label        = lilv_node_as_string(lilv_port_get_name(_impl->plugin, port));
1542         desc.lower        = min ? lilv_node_as_float(min) : 0.0f;
1543         desc.upper        = max ? lilv_node_as_float(max) : 1.0f;
1544         desc.midinote     = lilv_nodes_contains(portunits, _world.units_midiNote);
1545
1546         if (desc.sr_dependent) {
1547                 desc.lower *= _session.frame_rate ();
1548                 desc.upper *= _session.frame_rate ();
1549         }
1550
1551         desc.min_unbound  = false; // TODO: LV2 extension required
1552         desc.max_unbound  = false; // TODO: LV2 extension required
1553
1554         if (desc.integer_step) {
1555                 desc.step      = 1.0;
1556                 desc.smallstep = 0.1;
1557                 desc.largestep = 10.0;
1558         } else {
1559                 const float delta = desc.upper - desc.lower;
1560                 desc.step      = delta / 1000.0f;
1561                 desc.smallstep = delta / 10000.0f;
1562                 desc.largestep = delta / 10.0f;
1563         }
1564
1565         desc.enumeration = lilv_port_has_property(_impl->plugin, port, _world.lv2_enumeration);
1566
1567         lilv_node_free(def);
1568         lilv_node_free(min);
1569         lilv_node_free(max);
1570         lilv_nodes_free(portunits);
1571
1572         return 0;
1573 }
1574
1575 string
1576 LV2Plugin::describe_parameter(Evoral::Parameter which)
1577 {
1578         if (( which.type() == PluginAutomation) && ( which.id() < parameter_count()) ) {
1579
1580                 if (lilv_port_has_property(_impl->plugin,
1581                                         lilv_plugin_get_port_by_index(_impl->plugin, which.id()), _world.ext_notOnGUI)) {
1582                         return X_("hidden");
1583                 }
1584
1585                 if (lilv_port_has_property(_impl->plugin,
1586                                         lilv_plugin_get_port_by_index(_impl->plugin, which.id()), _world.lv2_freewheeling)) {
1587                         return X_("hidden");
1588                 }
1589
1590                 if (lilv_port_has_property(_impl->plugin,
1591                                         lilv_plugin_get_port_by_index(_impl->plugin, which.id()), _world.lv2_reportsLatency)) {
1592                         return X_("latency");
1593                 }
1594
1595                 LilvNode* name = lilv_port_get_name(_impl->plugin,
1596                                                     lilv_plugin_get_port_by_index(_impl->plugin, which.id()));
1597                 string ret(lilv_node_as_string(name));
1598                 lilv_node_free(name);
1599                 return ret;
1600         } else {
1601                 return "??";
1602         }
1603 }
1604
1605 framecnt_t
1606 LV2Plugin::signal_latency() const
1607 {
1608         if (_latency_control_port) {
1609                 return (framecnt_t)floor(*_latency_control_port);
1610         } else {
1611                 return 0;
1612         }
1613 }
1614
1615 set<Evoral::Parameter>
1616 LV2Plugin::automatable() const
1617 {
1618         set<Evoral::Parameter> ret;
1619
1620         for (uint32_t i = 0; i < parameter_count(); ++i) {
1621                 if (parameter_is_input(i) && parameter_is_control(i)) {
1622                         ret.insert(ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
1623                 }
1624         }
1625
1626         return ret;
1627 }
1628
1629 void
1630 LV2Plugin::activate()
1631 {
1632         DEBUG_TRACE(DEBUG::LV2, string_compose("%1 activate\n", name()));
1633
1634         if (!_was_activated) {
1635                 lilv_instance_activate(_impl->instance);
1636                 _was_activated = true;
1637         }
1638 }
1639
1640 void
1641 LV2Plugin::deactivate()
1642 {
1643         DEBUG_TRACE(DEBUG::LV2, string_compose("%1 deactivate\n", name()));
1644
1645         if (_was_activated) {
1646                 lilv_instance_deactivate(_impl->instance);
1647                 _was_activated = false;
1648         }
1649 }
1650
1651 void
1652 LV2Plugin::cleanup()
1653 {
1654         DEBUG_TRACE(DEBUG::LV2, string_compose("%1 cleanup\n", name()));
1655
1656         activate();
1657         deactivate();
1658         lilv_instance_free(_impl->instance);
1659         _impl->instance = NULL;
1660 }
1661
1662 void
1663 LV2Plugin::allocate_atom_event_buffers()
1664 {
1665         /* reserve local scratch buffers for ATOM event-queues */
1666         const LilvPlugin* p = _impl->plugin;
1667
1668         /* count non-MIDI atom event-ports
1669          * TODO: nicely ask drobilla to make a lilv_ call for that
1670          */
1671         int count_atom_out = 0;
1672         int count_atom_in = 0;
1673         int minimumSize = 32768; // TODO use a per-port minimum-size
1674         for (uint32_t i = 0; i < lilv_plugin_get_num_ports(p); ++i) {
1675                 const LilvPort* port  = lilv_plugin_get_port_by_index(p, i);
1676                 if (lilv_port_is_a(p, port, _world.atom_AtomPort)) {
1677                         LilvNodes* buffer_types = lilv_port_get_value(
1678                                 p, port, _world.atom_bufferType);
1679                         LilvNodes* atom_supports = lilv_port_get_value(
1680                                 p, port, _world.atom_supports);
1681
1682                         if (!lilv_nodes_contains(buffer_types, _world.atom_Sequence)
1683                                         || !lilv_nodes_contains(atom_supports, _world.midi_MidiEvent)) {
1684                                 if (lilv_port_is_a(p, port, _world.lv2_InputPort)) {
1685                                         count_atom_in++;
1686                                 }
1687                                 if (lilv_port_is_a(p, port, _world.lv2_OutputPort)) {
1688                                         count_atom_out++;
1689                                 }
1690                                 LilvNodes* min_size_v = lilv_port_get_value(_impl->plugin, port, _world.rsz_minimumSize);
1691                                 LilvNode* min_size = min_size_v ? lilv_nodes_get_first(min_size_v) : NULL;
1692                                 if (min_size && lilv_node_is_int(min_size)) {
1693                                         minimumSize = std::max(minimumSize, lilv_node_as_int(min_size));
1694                                 }
1695                                 lilv_nodes_free(min_size_v);
1696                         }
1697                         lilv_nodes_free(buffer_types);
1698                         lilv_nodes_free(atom_supports);
1699                 }
1700         }
1701
1702         DEBUG_TRACE(DEBUG::LV2, string_compose("%1 need buffers for %2 atom-in and %3 atom-out event-ports\n",
1703                                 name(), count_atom_in, count_atom_out));
1704
1705         const int total_atom_buffers = (count_atom_in + count_atom_out);
1706         if (_atom_ev_buffers || total_atom_buffers == 0) {
1707                 return;
1708         }
1709
1710         DEBUG_TRACE(DEBUG::LV2, string_compose("allocate %1 atom_ev_buffers of %d bytes\n", total_atom_buffers, minimumSize));
1711         _atom_ev_buffers = (LV2_Evbuf**) malloc((total_atom_buffers + 1) * sizeof(LV2_Evbuf*));
1712         for (int i = 0; i < total_atom_buffers; ++i ) {
1713                 _atom_ev_buffers[i] = lv2_evbuf_new(minimumSize, LV2_EVBUF_ATOM,
1714                                 LV2Plugin::urids.atom_Chunk, LV2Plugin::urids.atom_Sequence);
1715         }
1716         _atom_ev_buffers[total_atom_buffers] = 0;
1717         return;
1718 }
1719
1720 /** Write an ardour position/time/tempo/meter as an LV2 event.
1721  * @return true on success.
1722  */
1723 static bool
1724 write_position(LV2_Atom_Forge*     forge,
1725                LV2_Evbuf*          buf,
1726                const TempoMetric&  t,
1727                Timecode::BBT_Time& bbt,
1728                double              speed,
1729                framepos_t          position,
1730                framecnt_t          offset)
1731 {
1732         uint8_t pos_buf[256];
1733         lv2_atom_forge_set_buffer(forge, pos_buf, sizeof(pos_buf));
1734         LV2_Atom_Forge_Frame frame;
1735 #ifdef HAVE_LV2_1_10_0
1736         lv2_atom_forge_object(forge, &frame, 1, LV2Plugin::urids.time_Position);
1737         lv2_atom_forge_key(forge, LV2Plugin::urids.time_frame);
1738         lv2_atom_forge_long(forge, position);
1739         lv2_atom_forge_key(forge, LV2Plugin::urids.time_speed);
1740         lv2_atom_forge_float(forge, speed);
1741         lv2_atom_forge_key(forge, LV2Plugin::urids.time_barBeat);
1742         lv2_atom_forge_float(forge, bbt.beats - 1 +
1743                              (bbt.ticks / Timecode::BBT_Time::ticks_per_beat));
1744         lv2_atom_forge_key(forge, LV2Plugin::urids.time_bar);
1745         lv2_atom_forge_long(forge, bbt.bars - 1);
1746         lv2_atom_forge_key(forge, LV2Plugin::urids.time_beatUnit);
1747         lv2_atom_forge_int(forge, t.meter().note_divisor());
1748         lv2_atom_forge_key(forge, LV2Plugin::urids.time_beatsPerBar);
1749         lv2_atom_forge_float(forge, t.meter().divisions_per_bar());
1750         lv2_atom_forge_key(forge, LV2Plugin::urids.time_beatsPerMinute);
1751         lv2_atom_forge_float(forge, t.tempo().beats_per_minute());
1752 #else
1753         lv2_atom_forge_blank(forge, &frame, 1, LV2Plugin::urids.time_Position);
1754         lv2_atom_forge_property_head(forge, LV2Plugin::urids.time_frame, 0);
1755         lv2_atom_forge_long(forge, position);
1756         lv2_atom_forge_property_head(forge, LV2Plugin::urids.time_speed, 0);
1757         lv2_atom_forge_float(forge, speed);
1758         lv2_atom_forge_property_head(forge, LV2Plugin::urids.time_barBeat, 0);
1759         lv2_atom_forge_float(forge, bbt.beats - 1 +
1760                              (bbt.ticks / Timecode::BBT_Time::ticks_per_beat));
1761         lv2_atom_forge_property_head(forge, LV2Plugin::urids.time_bar, 0);
1762         lv2_atom_forge_long(forge, bbt.bars - 1);
1763         lv2_atom_forge_property_head(forge, LV2Plugin::urids.time_beatUnit, 0);
1764         lv2_atom_forge_int(forge, t.meter().note_divisor());
1765         lv2_atom_forge_property_head(forge, LV2Plugin::urids.time_beatsPerBar, 0);
1766         lv2_atom_forge_float(forge, t.meter().divisions_per_bar());
1767         lv2_atom_forge_property_head(forge, LV2Plugin::urids.time_beatsPerMinute, 0);
1768         lv2_atom_forge_float(forge, t.tempo().beats_per_minute());
1769 #endif
1770
1771         LV2_Evbuf_Iterator    end  = lv2_evbuf_end(buf);
1772         const LV2_Atom* const atom = (const LV2_Atom*)pos_buf;
1773         return lv2_evbuf_write(&end, offset, 0, atom->type, atom->size,
1774                                (const uint8_t*)(atom + 1));
1775 }
1776
1777 int
1778 LV2Plugin::connect_and_run(BufferSet& bufs,
1779         ChanMapping in_map, ChanMapping out_map,
1780         pframes_t nframes, framecnt_t offset)
1781 {
1782         DEBUG_TRACE(DEBUG::LV2, string_compose("%1 run %2 offset %3\n", name(), nframes, offset));
1783         Plugin::connect_and_run(bufs, in_map, out_map, nframes, offset);
1784
1785         cycles_t then = get_cycles();
1786
1787         TempoMap&               tmap     = _session.tempo_map();
1788         Metrics::const_iterator metric_i = tmap.metrics_end();
1789         TempoMetric             tmetric  = tmap.metric_at(_session.transport_frame(), &metric_i);
1790
1791         if (_freewheel_control_port) {
1792                 *_freewheel_control_port = _session.engine().freewheeling();
1793         }
1794
1795         if (_bpm_control_port) {
1796                 *_bpm_control_port = tmetric.tempo().beats_per_minute();
1797         }
1798
1799         ChanCount bufs_count;
1800         bufs_count.set(DataType::AUDIO, 1);
1801         bufs_count.set(DataType::MIDI, 1);
1802         BufferSet& silent_bufs  = _session.get_silent_buffers(bufs_count);
1803         BufferSet& scratch_bufs = _session.get_scratch_buffers(bufs_count);
1804         uint32_t const num_ports = parameter_count();
1805         uint32_t const nil_index = std::numeric_limits<uint32_t>::max();
1806
1807         uint32_t audio_in_index  = 0;
1808         uint32_t audio_out_index = 0;
1809         uint32_t midi_in_index   = 0;
1810         uint32_t midi_out_index  = 0;
1811         uint32_t atom_port_index = 0;
1812         for (uint32_t port_index = 0; port_index < num_ports; ++port_index) {
1813                 void*     buf   = NULL;
1814                 uint32_t  index = nil_index;
1815                 PortFlags flags = _port_flags[port_index];
1816                 bool      valid = false;
1817                 if (flags & PORT_AUDIO) {
1818                         if (flags & PORT_INPUT) {
1819                                 index = in_map.get(DataType::AUDIO, audio_in_index++, &valid);
1820                                 buf = (valid)
1821                                         ? bufs.get_audio(index).data(offset)
1822                                         : silent_bufs.get_audio(0).data(offset);
1823                         } else {
1824                                 index = out_map.get(DataType::AUDIO, audio_out_index++, &valid);
1825                                 buf = (valid)
1826                                         ? bufs.get_audio(index).data(offset)
1827                                         : scratch_bufs.get_audio(0).data(offset);
1828                         }
1829                 } else if (flags & (PORT_EVENT|PORT_SEQUENCE)) {
1830                         /* FIXME: The checks here for bufs.count().n_midi() > index shouldn't
1831                            be necessary, but the mapping is illegal in some cases.  Ideally
1832                            that should be fixed, but this is easier...
1833                         */
1834                         if (flags & PORT_MIDI) {
1835                                 if (flags & PORT_INPUT) {
1836                                         index = in_map.get(DataType::MIDI, midi_in_index++, &valid);
1837                                 } else {
1838                                         index = out_map.get(DataType::MIDI, midi_out_index++, &valid);
1839                                 }
1840                                 if (valid && bufs.count().n_midi() > index) {
1841                                         /* Note, ensure_lv2_bufsize() is not RT safe!
1842                                          * However free()/alloc() is only called if a
1843                                          * plugin requires a rsz:minimumSize buffersize
1844                                          * and the existing buffer if smaller.
1845                                          */
1846                                         bufs.ensure_lv2_bufsize((flags & PORT_INPUT), index, _port_minimumSize[port_index]);
1847                                         _ev_buffers[port_index] = bufs.get_lv2_midi(
1848                                                 (flags & PORT_INPUT), index, (flags & PORT_EVENT));
1849                                 }
1850                         } else if ((flags & PORT_POSITION) && (flags & PORT_INPUT)) {
1851                                 lv2_evbuf_reset(_atom_ev_buffers[atom_port_index], true);
1852                                 _ev_buffers[port_index] = _atom_ev_buffers[atom_port_index++];
1853                                 valid                   = true;
1854                         }
1855
1856                         if (valid && (flags & PORT_INPUT)) {
1857                                 Timecode::BBT_Time bbt;
1858                                 if ((flags & PORT_POSITION)) {
1859                                         if (_session.transport_frame() != _next_cycle_start ||
1860                                             _session.transport_speed() != _next_cycle_speed) {
1861                                                 // Transport has changed, write position at cycle start
1862                                                 tmap.bbt_time(_session.transport_frame(), bbt);
1863                                                 write_position(&_impl->forge, _ev_buffers[port_index],
1864                                                                tmetric, bbt, _session.transport_speed(),
1865                                                                _session.transport_frame(), 0);
1866                                         }
1867                                 }
1868
1869                                 // Get MIDI iterator range (empty range if no MIDI)
1870                                 MidiBuffer::iterator m = (index != nil_index)
1871                                         ? bufs.get_midi(index).begin()
1872                                         : silent_bufs.get_midi(0).end();
1873                                 MidiBuffer::iterator m_end = (index != nil_index)
1874                                         ? bufs.get_midi(index).end()
1875                                         : m;
1876
1877                                 // Now merge MIDI and any transport events into the buffer
1878                                 const uint32_t     type = LV2Plugin::urids.midi_MidiEvent;
1879                                 const framepos_t   tend = _session.transport_frame() + nframes;
1880                                 ++metric_i;
1881                                 while (m != m_end || (metric_i != tmap.metrics_end() &&
1882                                                       (*metric_i)->frame() < tend)) {
1883                                         MetricSection* metric = (metric_i != tmap.metrics_end())
1884                                                 ? *metric_i : NULL;
1885                                         if (m != m_end && (!metric || metric->frame() > (*m).time())) {
1886                                                 const Evoral::MIDIEvent<framepos_t> ev(*m, false);
1887                                                 LV2_Evbuf_Iterator eend = lv2_evbuf_end(_ev_buffers[port_index]);
1888                                                 lv2_evbuf_write(&eend, ev.time(), 0, type, ev.size(), ev.buffer());
1889                                                 ++m;
1890                                         } else {
1891                                                 tmetric.set_metric(metric);
1892                                                 bbt = metric->start();
1893                                                 write_position(&_impl->forge, _ev_buffers[port_index],
1894                                                                tmetric, bbt, _session.transport_speed(),
1895                                                                metric->frame(),
1896                                                                metric->frame() - _session.transport_frame());
1897                                                 ++metric_i;
1898                                         }
1899                                 }
1900                         } else if (!valid) {
1901                                 // Nothing we understand or care about, connect to scratch
1902                                 // see note for midi-buffer size above
1903                                 scratch_bufs.ensure_lv2_bufsize((flags & PORT_INPUT),
1904                                                 0, _port_minimumSize[port_index]);
1905                                 _ev_buffers[port_index] = scratch_bufs.get_lv2_midi(
1906                                         (flags & PORT_INPUT), 0, (flags & PORT_EVENT));
1907                         }
1908
1909                         buf = lv2_evbuf_get_buffer(_ev_buffers[port_index]);
1910                 } else {
1911                         continue;  // Control port, leave buffer alone
1912                 }
1913                 lilv_instance_connect_port(_impl->instance, port_index, buf);
1914         }
1915
1916         // Read messages from UI and push into appropriate buffers
1917         if (_from_ui) {
1918                 uint32_t read_space = _from_ui->read_space();
1919                 while (read_space > sizeof(UIMessage)) {
1920                         UIMessage msg;
1921                         if (_from_ui->read((uint8_t*)&msg, sizeof(msg)) != sizeof(msg)) {
1922                                 error << "Error reading from UI=>Plugin RingBuffer" << endmsg;
1923                                 break;
1924                         }
1925                         vector<uint8_t> body(msg.size);
1926                         if (_from_ui->read(&body[0], msg.size) != msg.size) {
1927                                 error << "Error reading from UI=>Plugin RingBuffer" << endmsg;
1928                                 break;
1929                         }
1930                         if (msg.protocol == urids.atom_eventTransfer) {
1931                                 LV2_Evbuf*            buf  = _ev_buffers[msg.index];
1932                                 LV2_Evbuf_Iterator    i    = lv2_evbuf_end(buf);
1933                                 const LV2_Atom* const atom = (const LV2_Atom*)&body[0];
1934                                 if (!lv2_evbuf_write(&i, nframes, 0, atom->type, atom->size,
1935                                                 (const uint8_t*)(atom + 1))) {
1936                                         error << "Failed to write data to LV2 event buffer\n";
1937                                 }
1938                         } else {
1939                                 error << "Received unknown message type from UI" << endmsg;
1940                         }
1941                         read_space -= sizeof(UIMessage) + msg.size;
1942                 }
1943         }
1944
1945         run(nframes);
1946
1947         midi_out_index = 0;
1948         for (uint32_t port_index = 0; port_index < num_ports; ++port_index) {
1949                 PortFlags flags = _port_flags[port_index];
1950                 bool      valid = false;
1951
1952                 /* TODO ask drobilla about comment
1953                  * "Make Ardour event buffers generic so plugins can communicate"
1954                  * in libs/ardour/buffer_set.cc:310
1955                  *
1956                  * ideally the user could choose which of the following two modes
1957                  * to use (e.g. instrument/effect chains  MIDI OUT vs MIDI TRHU).
1958                  *
1959                  * This implementation follows the discussion on IRC Mar 16 2013 16:47 UTC
1960                  * 16:51 < drobilla> rgareus: [..] i.e always replace with MIDI output [of LV2 plugin] if it's there
1961                  * 16:52 < drobilla> rgareus: That would probably be good enough [..] to make users not complain
1962                  *                            for quite a while at least ;)
1963                  */
1964                 // copy output of LV2 plugin's MIDI port to Ardour MIDI buffers -- MIDI OUT
1965                 if ((flags & PORT_OUTPUT) && (flags & (PORT_EVENT|PORT_SEQUENCE|PORT_MIDI))) {
1966                         const uint32_t buf_index = out_map.get(
1967                                 DataType::MIDI, midi_out_index++, &valid);
1968                         if (valid) {
1969                                 bufs.forward_lv2_midi(_ev_buffers[port_index], buf_index);
1970                         }
1971                 }
1972                 // Flush MIDI (write back to Ardour MIDI buffers) -- MIDI THRU
1973                 else if ((flags & PORT_OUTPUT) && (flags & (PORT_EVENT|PORT_SEQUENCE))) {
1974                         const uint32_t buf_index = out_map.get(
1975                                 DataType::MIDI, midi_out_index++, &valid);
1976                         if (valid) {
1977                                 bufs.flush_lv2_midi(true, buf_index);
1978                         }
1979                 }
1980
1981
1982                 // Write messages to UI
1983                 if ((_to_ui || _patch_port_out_index != (uint32_t)-1) &&
1984                     (flags & PORT_OUTPUT) && (flags & (PORT_EVENT|PORT_SEQUENCE))) {
1985                         LV2_Evbuf* buf = _ev_buffers[port_index];
1986                         for (LV2_Evbuf_Iterator i = lv2_evbuf_begin(buf);
1987                              lv2_evbuf_is_valid(i);
1988                              i = lv2_evbuf_next(i)) {
1989                                 uint32_t frames, subframes, type, size;
1990                                 uint8_t* data;
1991                                 lv2_evbuf_get(i, &frames, &subframes, &type, &size, &data);
1992
1993                                 // Intercept patch change messages to emit PropertyChanged signal
1994                                 if ((flags & PORT_PATCHMSG)) {
1995                                         LV2_Atom* atom = (LV2_Atom*)(data - sizeof(LV2_Atom));
1996                                         if (atom->type == LV2Plugin::urids.atom_Blank ||
1997                                             atom->type == LV2Plugin::urids.atom_Object) {
1998                                                 LV2_Atom_Object* obj = (LV2_Atom_Object*)atom;
1999                                                 if (obj->body.otype == LV2Plugin::urids.patch_Set) {
2000                                                         const LV2_Atom* property = NULL;
2001                                                         const LV2_Atom* value    = NULL;
2002                                                         lv2_atom_object_get(obj,
2003                                                                             LV2Plugin::urids.patch_property, &property,
2004                                                                             LV2Plugin::urids.patch_value,    &value,
2005                                                                             0);
2006
2007                                                         if (!property || !value ||
2008                                                             property->type != LV2Plugin::urids.atom_URID ||
2009                                                             value->type != LV2Plugin::urids.atom_Path) {
2010                                                                 std::cerr << "warning: patch:Set for unknown property" << std::endl;
2011                                                                 continue;
2012                                                         }
2013
2014                                                         const uint32_t prop_id = ((const LV2_Atom_URID*)property)->body;
2015                                                         const char*    path    = (const char*)LV2_ATOM_BODY_CONST(value);
2016
2017                                                         // Emit PropertyChanged signal for UI
2018                                                         PropertyChanged(prop_id, Variant(Variant::PATH, path));
2019                                                 }
2020                                         }
2021                                 }
2022
2023                                 if (!_to_ui) continue;
2024                                 write_to_ui(port_index, urids.atom_eventTransfer,
2025                                             size + sizeof(LV2_Atom),
2026                                             data - sizeof(LV2_Atom));
2027                         }
2028                 }
2029         }
2030
2031         cycles_t now = get_cycles();
2032         set_cycles((uint32_t)(now - then));
2033
2034         // Update expected transport information for next cycle so we can detect changes
2035         _next_cycle_speed = _session.transport_speed();
2036         _next_cycle_start = _session.transport_frame() + (nframes * _next_cycle_speed);
2037
2038         return 0;
2039 }
2040
2041 bool
2042 LV2Plugin::parameter_is_control(uint32_t param) const
2043 {
2044         assert(param < _port_flags.size());
2045         return _port_flags[param] & PORT_CONTROL;
2046 }
2047
2048 bool
2049 LV2Plugin::parameter_is_audio(uint32_t param) const
2050 {
2051         assert(param < _port_flags.size());
2052         return _port_flags[param] & PORT_AUDIO;
2053 }
2054
2055 bool
2056 LV2Plugin::parameter_is_event(uint32_t param) const
2057 {
2058         assert(param < _port_flags.size());
2059         return _port_flags[param] & PORT_EVENT;
2060 }
2061
2062 bool
2063 LV2Plugin::parameter_is_output(uint32_t param) const
2064 {
2065         assert(param < _port_flags.size());
2066         return _port_flags[param] & PORT_OUTPUT;
2067 }
2068
2069 bool
2070 LV2Plugin::parameter_is_input(uint32_t param) const
2071 {
2072         assert(param < _port_flags.size());
2073         return _port_flags[param] & PORT_INPUT;
2074 }
2075
2076 void
2077 LV2Plugin::print_parameter(uint32_t param, char* buf, uint32_t len) const
2078 {
2079         if (buf && len) {
2080                 if (param < parameter_count()) {
2081                         snprintf(buf, len, "%.3f", get_parameter(param));
2082                 } else {
2083                         strcat(buf, "0");
2084                 }
2085         }
2086 }
2087
2088 boost::shared_ptr<Plugin::ScalePoints>
2089 LV2Plugin::get_scale_points(uint32_t port_index) const
2090 {
2091         const LilvPort*  port   = lilv_plugin_get_port_by_index(_impl->plugin, port_index);
2092         LilvScalePoints* points = lilv_port_get_scale_points(_impl->plugin, port);
2093
2094         boost::shared_ptr<Plugin::ScalePoints> ret;
2095         if (!points) {
2096                 return ret;
2097         }
2098
2099         ret = boost::shared_ptr<Plugin::ScalePoints>(new ScalePoints());
2100
2101         LILV_FOREACH(scale_points, i, points) {
2102                 const LilvScalePoint* p     = lilv_scale_points_get(points, i);
2103                 const LilvNode*       label = lilv_scale_point_get_label(p);
2104                 const LilvNode*       value = lilv_scale_point_get_value(p);
2105                 if (label && (lilv_node_is_float(value) || lilv_node_is_int(value))) {
2106                         ret->insert(make_pair(lilv_node_as_string(label),
2107                                               lilv_node_as_float(value)));
2108                 }
2109         }
2110
2111         lilv_scale_points_free(points);
2112         return ret;
2113 }
2114
2115 void
2116 LV2Plugin::run(pframes_t nframes)
2117 {
2118         uint32_t const N = parameter_count();
2119         for (uint32_t i = 0; i < N; ++i) {
2120                 if (parameter_is_control(i) && parameter_is_input(i)) {
2121                         _control_data[i] = _shadow_data[i];
2122                 }
2123         }
2124
2125         lilv_instance_run(_impl->instance, nframes);
2126
2127         if (_impl->work_iface) {
2128                 _worker->emit_responses();
2129                 if (_impl->work_iface->end_run) {
2130                         _impl->work_iface->end_run(_impl->instance->lv2_handle);
2131                 }
2132         }
2133 }
2134
2135 void
2136 LV2Plugin::latency_compute_run()
2137 {
2138         if (!_latency_control_port) {
2139                 return;
2140         }
2141
2142         // Run the plugin so that it can set its latency parameter
2143
2144         bool was_activated = _was_activated;
2145         activate();
2146
2147         uint32_t port_index = 0;
2148         uint32_t in_index   = 0;
2149         uint32_t out_index  = 0;
2150
2151         // this is done in the main thread. non realtime.
2152         const framecnt_t bufsize = _engine.samples_per_cycle();
2153         float            *buffer = (float*) malloc(_engine.samples_per_cycle() * sizeof(float));
2154
2155         memset(buffer, 0, sizeof(float) * bufsize);
2156
2157         // FIXME: Ensure plugins can handle in-place processing
2158
2159         port_index = 0;
2160
2161         while (port_index < parameter_count()) {
2162                 if (parameter_is_audio(port_index)) {
2163                         if (parameter_is_input(port_index)) {
2164                                 lilv_instance_connect_port(_impl->instance, port_index, buffer);
2165                                 in_index++;
2166                         } else if (parameter_is_output(port_index)) {
2167                                 lilv_instance_connect_port(_impl->instance, port_index, buffer);
2168                                 out_index++;
2169                         }
2170                 }
2171                 port_index++;
2172         }
2173
2174         run(bufsize);
2175         deactivate();
2176         if (was_activated) {
2177                 activate();
2178         }
2179         free(buffer);
2180 }
2181
2182 const LilvPort*
2183 LV2Plugin::Impl::designated_input (const char* uri, void** bufptrs[], void** bufptr)
2184 {
2185         const LilvPort* port = NULL;
2186         LilvNode* designation = lilv_new_uri(_world.world, uri);
2187         port = lilv_plugin_get_port_by_designation(
2188                 plugin, _world.lv2_InputPort, designation);
2189         lilv_node_free(designation);
2190         if (port) {
2191                 bufptrs[lilv_port_get_index(plugin, port)] = bufptr;
2192         }
2193         return port;
2194 }
2195
2196 static bool lv2_filter (const string& str, void* /*arg*/)
2197 {
2198         /* Not a dotfile, has a prefix before a period, suffix is "lv2" */
2199         
2200         return str[0] != '.' && (str.length() > 3 && str.find (".lv2") == (str.length() - 4));
2201 }
2202
2203
2204 LV2World::LV2World()
2205         : world(lilv_world_new())
2206         , _bundle_checked(false)
2207 {
2208         lilv_world_load_all(world);
2209
2210         atom_AtomPort      = lilv_new_uri(world, LV2_ATOM__AtomPort);
2211         atom_Chunk         = lilv_new_uri(world, LV2_ATOM__Chunk);
2212         atom_Sequence      = lilv_new_uri(world, LV2_ATOM__Sequence);
2213         atom_bufferType    = lilv_new_uri(world, LV2_ATOM__bufferType);
2214         atom_supports      = lilv_new_uri(world, LV2_ATOM__supports);
2215         atom_eventTransfer = lilv_new_uri(world, LV2_ATOM__eventTransfer);
2216         ev_EventPort       = lilv_new_uri(world, LILV_URI_EVENT_PORT);
2217         ext_logarithmic    = lilv_new_uri(world, LV2_PORT_PROPS__logarithmic);
2218         ext_notOnGUI       = lilv_new_uri(world, LV2_PORT_PROPS__notOnGUI);
2219         lv2_AudioPort      = lilv_new_uri(world, LILV_URI_AUDIO_PORT);
2220         lv2_ControlPort    = lilv_new_uri(world, LILV_URI_CONTROL_PORT);
2221         lv2_InputPort      = lilv_new_uri(world, LILV_URI_INPUT_PORT);
2222         lv2_OutputPort     = lilv_new_uri(world, LILV_URI_OUTPUT_PORT);
2223         lv2_inPlaceBroken  = lilv_new_uri(world, LV2_CORE__inPlaceBroken);
2224         lv2_integer        = lilv_new_uri(world, LV2_CORE__integer);
2225         lv2_reportsLatency = lilv_new_uri(world, LV2_CORE__reportsLatency);
2226         lv2_sampleRate     = lilv_new_uri(world, LV2_CORE__sampleRate);
2227         lv2_toggled        = lilv_new_uri(world, LV2_CORE__toggled);
2228         lv2_enumeration    = lilv_new_uri(world, LV2_CORE__enumeration);
2229         lv2_freewheeling   = lilv_new_uri(world, LV2_CORE__freeWheeling);
2230         midi_MidiEvent     = lilv_new_uri(world, LILV_URI_MIDI_EVENT);
2231         rdfs_comment       = lilv_new_uri(world, LILV_NS_RDFS "comment");
2232         rdfs_label         = lilv_new_uri(world, LILV_NS_RDFS "label");
2233         rdfs_range         = lilv_new_uri(world, LILV_NS_RDFS "range");
2234         rsz_minimumSize    = lilv_new_uri(world, LV2_RESIZE_PORT__minimumSize);
2235         time_Position      = lilv_new_uri(world, LV2_TIME__Position);
2236         ui_GtkUI           = lilv_new_uri(world, LV2_UI__GtkUI);
2237         ui_external        = lilv_new_uri(world, "http://lv2plug.in/ns/extensions/ui#external");
2238         ui_externalkx      = lilv_new_uri(world, "http://kxstudio.sf.net/ns/lv2ext/external-ui#Widget");
2239         units_unit         = lilv_new_uri(world, "http://lv2plug.in/ns/extensions/units#unit");
2240         units_midiNote     = lilv_new_uri(world, "http://lv2plug.in/ns/extensions/units#midiNote");
2241         patch_writable     = lilv_new_uri(world, LV2_PATCH__writable);
2242         patch_Message      = lilv_new_uri(world, LV2_PATCH__Message);
2243 }
2244
2245 LV2World::~LV2World()
2246 {
2247         lilv_node_free(patch_Message);
2248         lilv_node_free(patch_writable);
2249         lilv_node_free(units_midiNote);
2250         lilv_node_free(units_unit);
2251         lilv_node_free(ui_externalkx);
2252         lilv_node_free(ui_external);
2253         lilv_node_free(ui_GtkUI);
2254         lilv_node_free(time_Position);
2255         lilv_node_free(rsz_minimumSize);
2256         lilv_node_free(rdfs_comment);
2257         lilv_node_free(rdfs_label);
2258         lilv_node_free(rdfs_range);
2259         lilv_node_free(midi_MidiEvent);
2260         lilv_node_free(lv2_enumeration);
2261         lilv_node_free(lv2_freewheeling);
2262         lilv_node_free(lv2_toggled);
2263         lilv_node_free(lv2_sampleRate);
2264         lilv_node_free(lv2_reportsLatency);
2265         lilv_node_free(lv2_integer);
2266         lilv_node_free(lv2_inPlaceBroken);
2267         lilv_node_free(lv2_OutputPort);
2268         lilv_node_free(lv2_InputPort);
2269         lilv_node_free(lv2_ControlPort);
2270         lilv_node_free(lv2_AudioPort);
2271         lilv_node_free(ext_notOnGUI);
2272         lilv_node_free(ext_logarithmic);
2273         lilv_node_free(ev_EventPort);
2274         lilv_node_free(atom_supports);
2275         lilv_node_free(atom_eventTransfer);
2276         lilv_node_free(atom_bufferType);
2277         lilv_node_free(atom_Sequence);
2278         lilv_node_free(atom_Chunk);
2279         lilv_node_free(atom_AtomPort);
2280         lilv_world_free(world);
2281 }
2282
2283 void
2284 LV2World::load_bundled_plugins(bool verbose)
2285 {
2286         if (!_bundle_checked) {
2287                 if (verbose) {
2288                         cout << "Scanning folders for bundled LV2s: " << ARDOUR::lv2_bundled_search_path().to_string() << endl;
2289                 }
2290
2291                 vector<string> plugin_objects;
2292                 find_paths_matching_filter (plugin_objects, ARDOUR::lv2_bundled_search_path(), lv2_filter, 0, true, true, true);
2293                 for ( vector<string>::iterator x = plugin_objects.begin(); x != plugin_objects.end (); ++x) {
2294 #ifdef PLATFORM_WINDOWS
2295                         string uri = "file:///" + *x + "/";
2296 #else
2297                         string uri = "file://" + *x + "/";
2298 #endif
2299                         LilvNode *node = lilv_new_uri(world, uri.c_str());
2300                         lilv_world_load_bundle(world, node);
2301                         lilv_node_free(node);
2302                 }
2303
2304                 _bundle_checked = true;
2305         }
2306 }
2307
2308 LV2PluginInfo::LV2PluginInfo (const char* plugin_uri)
2309 {
2310         type = ARDOUR::LV2;
2311         _plugin_uri = strdup(plugin_uri);
2312 }
2313
2314 LV2PluginInfo::~LV2PluginInfo()
2315 {
2316         free(_plugin_uri);
2317         _plugin_uri = NULL;
2318 }
2319
2320 PluginPtr
2321 LV2PluginInfo::load(Session& session)
2322 {
2323         try {
2324                 PluginPtr plugin;
2325                 const LilvPlugins* plugins = lilv_world_get_all_plugins(_world.world);
2326                 LilvNode* uri = lilv_new_uri(_world.world, _plugin_uri);
2327                 if (!uri) { throw failed_constructor(); }
2328                 const LilvPlugin* lp = lilv_plugins_get_by_uri(plugins, uri);
2329                 if (!lp) { throw failed_constructor(); }
2330                 plugin.reset(new LV2Plugin(session.engine(), session, lp, session.frame_rate()));
2331                 lilv_node_free(uri);
2332                 plugin->set_info(PluginInfoPtr(shared_from_this ()));
2333                 return plugin;
2334         } catch (failed_constructor& err) {
2335                 return PluginPtr((Plugin*)0);
2336         }
2337
2338         return PluginPtr();
2339 }
2340
2341 PluginInfoList*
2342 LV2PluginInfo::discover()
2343 {
2344         LV2World world;
2345         world.load_bundled_plugins();
2346         _world.load_bundled_plugins(true);
2347
2348         PluginInfoList*    plugs   = new PluginInfoList;
2349         const LilvPlugins* plugins = lilv_world_get_all_plugins(world.world);
2350
2351         if (!Config->get_show_plugin_scan_window()) {
2352                 info << "LV2: Discovering " << lilv_plugins_size(plugins) << " plugins" << endmsg;
2353         }
2354
2355         LILV_FOREACH(plugins, i, plugins) {
2356                 const LilvPlugin* p = lilv_plugins_get(plugins, i);
2357                 const LilvNode* pun = lilv_plugin_get_uri(p);
2358                 if (!pun) continue;
2359                 LV2PluginInfoPtr info(new LV2PluginInfo(lilv_node_as_string(pun)));
2360
2361                 LilvNode* name = lilv_plugin_get_name(p);
2362                 if (!name || !lilv_plugin_get_port_by_index(p, 0)) {
2363                         warning << "Ignoring invalid LV2 plugin "
2364                                 << lilv_node_as_string(lilv_plugin_get_uri(p))
2365                                 << endmsg;
2366                         continue;
2367                 }
2368
2369                 info->type = LV2;
2370
2371                 info->name = string(lilv_node_as_string(name));
2372                 lilv_node_free(name);
2373                 ARDOUR::PluginScanMessage(_("LV2"), info->name, false);
2374
2375                 const LilvPluginClass* pclass = lilv_plugin_get_class(p);
2376                 const LilvNode*        label  = lilv_plugin_class_get_label(pclass);
2377                 info->category = lilv_node_as_string(label);
2378
2379                 LilvNode* author_name = lilv_plugin_get_author_name(p);
2380                 info->creator = author_name ? string(lilv_node_as_string(author_name)) : "Unknown";
2381                 lilv_node_free(author_name);
2382
2383                 info->path = "/NOPATH"; // Meaningless for LV2
2384
2385                 /* count atom-event-ports that feature
2386                  * atom:supports <http://lv2plug.in/ns/ext/midi#MidiEvent>
2387                  *
2388                  * TODO: nicely ask drobilla to make a lilv_ call for that
2389                  */
2390                 int count_midi_out = 0;
2391                 int count_midi_in = 0;
2392                 for (uint32_t i = 0; i < lilv_plugin_get_num_ports(p); ++i) {
2393                         const LilvPort* port  = lilv_plugin_get_port_by_index(p, i);
2394                         if (lilv_port_is_a(p, port, world.atom_AtomPort)) {
2395                                 LilvNodes* buffer_types = lilv_port_get_value(
2396                                         p, port, world.atom_bufferType);
2397                                 LilvNodes* atom_supports = lilv_port_get_value(
2398                                         p, port, world.atom_supports);
2399
2400                                 if (lilv_nodes_contains(buffer_types, world.atom_Sequence)
2401                                                 && lilv_nodes_contains(atom_supports, world.midi_MidiEvent)) {
2402                                         if (lilv_port_is_a(p, port, world.lv2_InputPort)) {
2403                                                 count_midi_in++;
2404                                         }
2405                                         if (lilv_port_is_a(p, port, world.lv2_OutputPort)) {
2406                                                 count_midi_out++;
2407                                         }
2408                                 }
2409                                 lilv_nodes_free(buffer_types);
2410                                 lilv_nodes_free(atom_supports);
2411                         }
2412                 }
2413
2414                 info->n_inputs.set_audio(
2415                         lilv_plugin_get_num_ports_of_class(
2416                                 p, world.lv2_InputPort, world.lv2_AudioPort, NULL));
2417                 info->n_inputs.set_midi(
2418                         lilv_plugin_get_num_ports_of_class(
2419                                 p, world.lv2_InputPort, world.ev_EventPort, NULL)
2420                         + count_midi_in);
2421
2422                 info->n_outputs.set_audio(
2423                         lilv_plugin_get_num_ports_of_class(
2424                                 p, world.lv2_OutputPort, world.lv2_AudioPort, NULL));
2425                 info->n_outputs.set_midi(
2426                         lilv_plugin_get_num_ports_of_class(
2427                                 p, world.lv2_OutputPort, world.ev_EventPort, NULL)
2428                         + count_midi_out);
2429
2430                 info->unique_id = lilv_node_as_uri(lilv_plugin_get_uri(p));
2431                 info->index     = 0; // Meaningless for LV2
2432
2433                 plugs->push_back(info);
2434         }
2435
2436         return plugs;
2437 }