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