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