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         return Glib::filename_to_uri(Glib::build_filename(bundle, file_name));
1097 }
1098
1099 void
1100 LV2Plugin::do_remove_preset(string name)
1101 {
1102         string preset_file = Glib::build_filename(
1103                 Glib::get_home_dir(),
1104                 Glib::build_filename(
1105                         Glib::build_filename(".lv2", "presets"),
1106                         name + ".ttl"
1107                 )
1108         );
1109         unlink(preset_file.c_str());
1110 }
1111
1112 bool
1113 LV2Plugin::has_editor() const
1114 {
1115         return _impl->ui != NULL;
1116 }
1117
1118 bool
1119 LV2Plugin::has_message_output() const
1120 {
1121         for (uint32_t i = 0; i < num_ports(); ++i) {
1122                 if ((_port_flags[i] & PORT_SEQUENCE) &&
1123                     (_port_flags[i] & PORT_OUTPUT)) {
1124                         return true;
1125                 }
1126         }
1127         return false;
1128 }
1129
1130 bool
1131 LV2Plugin::write_to(RingBuffer<uint8_t>* dest,
1132                     uint32_t             index,
1133                     uint32_t             protocol,
1134                     uint32_t             size,
1135                     const uint8_t*       body)
1136 {
1137         const uint32_t buf_size = sizeof(UIMessage) + size;
1138         uint8_t        buf[buf_size];
1139
1140         UIMessage* msg = (UIMessage*)buf;
1141         msg->index    = index;
1142         msg->protocol = protocol;
1143         msg->size     = size;
1144         memcpy(msg + 1, body, size);
1145
1146         return (dest->write(buf, buf_size) == buf_size);
1147 }
1148
1149 bool
1150 LV2Plugin::write_from_ui(uint32_t       index,
1151                          uint32_t       protocol,
1152                          uint32_t       size,
1153                          const uint8_t* body)
1154 {
1155         if (!_from_ui) {
1156                 size_t rbs = _session.engine().raw_buffer_size(DataType::MIDI) * NBUFS;
1157                 /* buffer data communication from plugin UI to plugin instance.
1158                  * this buffer needs to potentially hold
1159                  *   (port's minimumSize) * (audio-periods) / (UI-periods)
1160                  * bytes.
1161                  *
1162                  *  e.g 48kSPS / 128fpp -> audio-periods = 375 Hz
1163                  *  ui-periods = 25 Hz (SuperRapidScreenUpdate)
1164                  *  default minimumSize = 32K (see LV2Plugin::allocate_atom_event_buffers()
1165                  *
1166                  * it is NOT safe to overflow (msg.size will be misinterpreted)
1167                  */
1168                 uint32_t bufsiz = 32768;
1169                 if (_atom_ev_buffers && _atom_ev_buffers[0]) {
1170                         bufsiz =  lv2_evbuf_get_capacity(_atom_ev_buffers[0]);
1171                 }
1172                 rbs = max((size_t) bufsiz * 8, rbs);
1173                 _from_ui = new RingBuffer<uint8_t>(rbs);
1174         }
1175
1176         if (!write_to(_from_ui, index, protocol, size, body)) {
1177                 error << "Error writing from UI to plugin" << endmsg;
1178                 return false;
1179         }
1180         return true;
1181 }
1182
1183 bool
1184 LV2Plugin::write_to_ui(uint32_t       index,
1185                        uint32_t       protocol,
1186                        uint32_t       size,
1187                        const uint8_t* body)
1188 {
1189         if (!write_to(_to_ui, index, protocol, size, body)) {
1190                 error << "Error writing from plugin to UI" << endmsg;
1191                 return false;
1192         }
1193         return true;
1194 }
1195
1196 void
1197 LV2Plugin::enable_ui_emmission()
1198 {
1199         if (!_to_ui) {
1200                 /* see note in LV2Plugin::write_from_ui() */
1201                 uint32_t bufsiz = 32768;
1202                 if (_atom_ev_buffers && _atom_ev_buffers[0]) {
1203                         bufsiz =  lv2_evbuf_get_capacity(_atom_ev_buffers[0]);
1204                 }
1205                 size_t rbs = _session.engine().raw_buffer_size(DataType::MIDI) * NBUFS;
1206                 rbs = max((size_t) bufsiz * 8, rbs);
1207                 _to_ui = new RingBuffer<uint8_t>(rbs);
1208         }
1209 }
1210
1211 void
1212 LV2Plugin::emit_to_ui(void* controller, UIMessageSink sink)
1213 {
1214         if (!_to_ui) {
1215                 return;
1216         }
1217
1218         uint32_t read_space = _to_ui->read_space();
1219         while (read_space > sizeof(UIMessage)) {
1220                 UIMessage msg;
1221                 if (_to_ui->read((uint8_t*)&msg, sizeof(msg)) != sizeof(msg)) {
1222                         error << "Error reading from Plugin=>UI RingBuffer" << endmsg;
1223                         break;
1224                 }
1225                 uint8_t body[msg.size];
1226                 if (_to_ui->read(body, msg.size) != msg.size) {
1227                         error << "Error reading from Plugin=>UI RingBuffer" << endmsg;
1228                         break;
1229                 }
1230
1231                 sink(controller, msg.index, msg.size, msg.protocol, body);
1232
1233                 read_space -= sizeof(msg) + msg.size;
1234         }
1235 }
1236
1237 int
1238 LV2Plugin::work(uint32_t size, const void* data)
1239 {
1240         return _impl->work_iface->work(
1241                 _impl->instance->lv2_handle, work_respond, this, size, data);
1242 }
1243
1244 int
1245 LV2Plugin::work_response(uint32_t size, const void* data)
1246 {
1247         return _impl->work_iface->work_response(
1248                 _impl->instance->lv2_handle, size, data);
1249 }
1250
1251 void
1252 LV2Plugin::set_insert_info(const PluginInsert* insert)
1253 {
1254         _insert_id = insert->id();
1255 }
1256
1257 int
1258 LV2Plugin::set_state(const XMLNode& node, int version)
1259 {
1260         XMLNodeList          nodes;
1261         const XMLProperty*   prop;
1262         XMLNodeConstIterator iter;
1263         XMLNode*             child;
1264         const char*          sym;
1265         const char*          value;
1266         uint32_t             port_id;
1267         LocaleGuard          lg(X_("POSIX"));
1268
1269         if (node.name() != state_node_name()) {
1270                 error << _("Bad node sent to LV2Plugin::set_state") << endmsg;
1271                 return -1;
1272         }
1273
1274 #ifndef NO_PLUGIN_STATE
1275
1276         if (version < 3000) {
1277                 nodes = node.children("port");
1278         } else {
1279                 nodes = node.children("Port");
1280         }
1281
1282         for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
1283
1284                 child = *iter;
1285
1286                 if ((prop = child->property("symbol")) != 0) {
1287                         sym = prop->value().c_str();
1288                 } else {
1289                         warning << _("LV2: port has no symbol, ignored") << endmsg;
1290                         continue;
1291                 }
1292
1293                 map<string, uint32_t>::iterator i = _port_indices.find(sym);
1294
1295                 if (i != _port_indices.end()) {
1296                         port_id = i->second;
1297                 } else {
1298                         warning << _("LV2: port has unknown index, ignored") << endmsg;
1299                         continue;
1300                 }
1301
1302                 if ((prop = child->property("value")) != 0) {
1303                         value = prop->value().c_str();
1304                 } else {
1305                         warning << _("LV2: port has no value, ignored") << endmsg;
1306                         continue;
1307                 }
1308
1309                 set_parameter(port_id, atof(value));
1310         }
1311
1312         _state_version = 0;
1313         if ((prop = node.property("state-dir")) != 0) {
1314                 if (sscanf(prop->value().c_str(), "state%u", &_state_version) != 1) {
1315                         error << string_compose(
1316                                 "LV2: failed to parse state version from \"%1\"",
1317                                 prop->value()) << endmsg;
1318                 }
1319
1320                 std::string state_file = Glib::build_filename(
1321                         plugin_dir(),
1322                         Glib::build_filename(prop->value(), "state.ttl"));
1323
1324                 LilvState* state = lilv_state_new_from_file(
1325                         _world.world, _uri_map.urid_map(), NULL, state_file.c_str());
1326
1327                 lilv_state_restore(state, _impl->instance, NULL, NULL, 0, NULL);
1328         }
1329
1330         latency_compute_run();
1331 #endif
1332
1333         return Plugin::set_state(node, version);
1334 }
1335
1336 int
1337 LV2Plugin::get_parameter_descriptor(uint32_t which, ParameterDescriptor& desc) const
1338 {
1339         const LilvPort* port = lilv_plugin_get_port_by_index(_impl->plugin, which);
1340
1341         LilvNodes* portunits;
1342         LilvNode *def, *min, *max;
1343         lilv_port_get_range(_impl->plugin, port, &def, &min, &max);
1344         portunits = lilv_port_get_value(_impl->plugin, port, _world.units_unit);
1345
1346         desc.integer_step = lilv_port_has_property(_impl->plugin, port, _world.lv2_integer);
1347         desc.toggled      = lilv_port_has_property(_impl->plugin, port, _world.lv2_toggled);
1348         desc.logarithmic  = lilv_port_has_property(_impl->plugin, port, _world.ext_logarithmic);
1349         desc.sr_dependent = lilv_port_has_property(_impl->plugin, port, _world.lv2_sampleRate);
1350         desc.label        = lilv_node_as_string(lilv_port_get_name(_impl->plugin, port));
1351         desc.lower        = min ? lilv_node_as_float(min) : 0.0f;
1352         desc.upper        = max ? lilv_node_as_float(max) : 1.0f;
1353         desc.midinote     = lilv_nodes_contains(portunits, _world.units_midiNote);
1354
1355         if (desc.sr_dependent) {
1356                 desc.lower *= _session.frame_rate ();
1357                 desc.upper *= _session.frame_rate ();
1358         }
1359
1360         desc.min_unbound  = false; // TODO: LV2 extension required
1361         desc.max_unbound  = false; // TODO: LV2 extension required
1362
1363         if (desc.integer_step) {
1364                 desc.step      = 1.0;
1365                 desc.smallstep = 0.1;
1366                 desc.largestep = 10.0;
1367         } else {
1368                 const float delta = desc.upper - desc.lower;
1369                 desc.step      = delta / 1000.0f;
1370                 desc.smallstep = delta / 10000.0f;
1371                 desc.largestep = delta / 10.0f;
1372         }
1373
1374         desc.enumeration = lilv_port_has_property(_impl->plugin, port, _world.lv2_enumeration);
1375
1376         lilv_node_free(def);
1377         lilv_node_free(min);
1378         lilv_node_free(max);
1379         lilv_nodes_free(portunits);
1380
1381         return 0;
1382 }
1383
1384 string
1385 LV2Plugin::describe_parameter(Evoral::Parameter which)
1386 {
1387         if (( which.type() == PluginAutomation) && ( which.id() < parameter_count()) ) {
1388
1389                 if (lilv_port_has_property(_impl->plugin,
1390                                         lilv_plugin_get_port_by_index(_impl->plugin, which.id()), _world.ext_notOnGUI)) {
1391                         return X_("hidden");
1392                 }
1393
1394                 if (lilv_port_has_property(_impl->plugin,
1395                                         lilv_plugin_get_port_by_index(_impl->plugin, which.id()), _world.lv2_freewheeling)) {
1396                         return X_("hidden");
1397                 }
1398
1399                 if (lilv_port_has_property(_impl->plugin,
1400                                         lilv_plugin_get_port_by_index(_impl->plugin, which.id()), _world.lv2_reportsLatency)) {
1401                         return X_("latency");
1402                 }
1403
1404                 LilvNode* name = lilv_port_get_name(_impl->plugin,
1405                                                     lilv_plugin_get_port_by_index(_impl->plugin, which.id()));
1406                 string ret(lilv_node_as_string(name));
1407                 lilv_node_free(name);
1408                 return ret;
1409         } else {
1410                 return "??";
1411         }
1412 }
1413
1414 framecnt_t
1415 LV2Plugin::signal_latency() const
1416 {
1417         if (_latency_control_port) {
1418                 return (framecnt_t)floor(*_latency_control_port);
1419         } else {
1420                 return 0;
1421         }
1422 }
1423
1424 set<Evoral::Parameter>
1425 LV2Plugin::automatable() const
1426 {
1427         set<Evoral::Parameter> ret;
1428
1429         for (uint32_t i = 0; i < parameter_count(); ++i) {
1430                 if (parameter_is_input(i) && parameter_is_control(i)) {
1431                         ret.insert(ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
1432                 }
1433         }
1434
1435         return ret;
1436 }
1437
1438 void
1439 LV2Plugin::activate()
1440 {
1441         DEBUG_TRACE(DEBUG::LV2, string_compose("%1 activate\n", name()));
1442
1443         if (!_was_activated) {
1444                 lilv_instance_activate(_impl->instance);
1445                 _was_activated = true;
1446         }
1447 }
1448
1449 void
1450 LV2Plugin::deactivate()
1451 {
1452         DEBUG_TRACE(DEBUG::LV2, string_compose("%1 deactivate\n", name()));
1453
1454         if (_was_activated) {
1455                 lilv_instance_deactivate(_impl->instance);
1456                 _was_activated = false;
1457         }
1458 }
1459
1460 void
1461 LV2Plugin::cleanup()
1462 {
1463         DEBUG_TRACE(DEBUG::LV2, string_compose("%1 cleanup\n", name()));
1464
1465         activate();
1466         deactivate();
1467         lilv_instance_free(_impl->instance);
1468         _impl->instance = NULL;
1469 }
1470
1471 void
1472 LV2Plugin::allocate_atom_event_buffers()
1473 {
1474         /* reserve local scratch buffers for ATOM event-queues */
1475         const LilvPlugin* p = _impl->plugin;
1476
1477         /* count non-MIDI atom event-ports
1478          * TODO: nicely ask drobilla to make a lilv_ call for that
1479          */
1480         int count_atom_out = 0;
1481         int count_atom_in = 0;
1482         int minimumSize = 32768; // TODO use a per-port minimum-size
1483         for (uint32_t i = 0; i < lilv_plugin_get_num_ports(p); ++i) {
1484                 const LilvPort* port  = lilv_plugin_get_port_by_index(p, i);
1485                 if (lilv_port_is_a(p, port, _world.atom_AtomPort)) {
1486                         LilvNodes* buffer_types = lilv_port_get_value(
1487                                 p, port, _world.atom_bufferType);
1488                         LilvNodes* atom_supports = lilv_port_get_value(
1489                                 p, port, _world.atom_supports);
1490
1491                         if (!lilv_nodes_contains(buffer_types, _world.atom_Sequence)
1492                                         || !lilv_nodes_contains(atom_supports, _world.midi_MidiEvent)) {
1493                                 if (lilv_port_is_a(p, port, _world.lv2_InputPort)) {
1494                                         count_atom_in++;
1495                                 }
1496                                 if (lilv_port_is_a(p, port, _world.lv2_OutputPort)) {
1497                                         count_atom_out++;
1498                                 }
1499                                 LilvNodes* min_size_v = lilv_port_get_value(_impl->plugin, port, _world.rsz_minimumSize);
1500                                 LilvNode* min_size = min_size_v ? lilv_nodes_get_first(min_size_v) : NULL;
1501                                 if (min_size && lilv_node_is_int(min_size)) {
1502                                         minimumSize = std::max(minimumSize, lilv_node_as_int(min_size));
1503                                 }
1504                                 lilv_nodes_free(min_size_v);
1505                         }
1506                         lilv_nodes_free(buffer_types);
1507                         lilv_nodes_free(atom_supports);
1508                 }
1509         }
1510
1511         DEBUG_TRACE(DEBUG::LV2, string_compose("%1 need buffers for %2 atom-in and %3 atom-out event-ports\n",
1512                                 name(), count_atom_in, count_atom_out));
1513
1514         const int total_atom_buffers = (count_atom_in + count_atom_out);
1515         if (_atom_ev_buffers || total_atom_buffers == 0) {
1516                 return;
1517         }
1518
1519         DEBUG_TRACE(DEBUG::LV2, string_compose("allocate %1 atom_ev_buffers of %d bytes\n", total_atom_buffers, minimumSize));
1520         _atom_ev_buffers = (LV2_Evbuf**) malloc((total_atom_buffers + 1) * sizeof(LV2_Evbuf*));
1521         for (int i = 0; i < total_atom_buffers; ++i ) {
1522                 _atom_ev_buffers[i] = lv2_evbuf_new(minimumSize, LV2_EVBUF_ATOM,
1523                                 LV2Plugin::urids.atom_Chunk, LV2Plugin::urids.atom_Sequence);
1524         }
1525         _atom_ev_buffers[total_atom_buffers] = 0;
1526         return;
1527 }
1528
1529 /** Write an ardour position/time/tempo/meter as an LV2 event.
1530  * @return true on success.
1531  */
1532 static bool
1533 write_position(LV2_Atom_Forge*     forge,
1534                LV2_Evbuf*          buf,
1535                const TempoMetric&  t,
1536                Timecode::BBT_Time& bbt,
1537                double              speed,
1538                framepos_t          position,
1539                framecnt_t          offset)
1540 {
1541         uint8_t pos_buf[256];
1542         lv2_atom_forge_set_buffer(forge, pos_buf, sizeof(pos_buf));
1543         LV2_Atom_Forge_Frame frame;
1544         lv2_atom_forge_blank(forge, &frame, 1, LV2Plugin::urids.time_Position);
1545         lv2_atom_forge_property_head(forge, LV2Plugin::urids.time_frame, 0);
1546         lv2_atom_forge_long(forge, position);
1547         lv2_atom_forge_property_head(forge, LV2Plugin::urids.time_speed, 0);
1548         lv2_atom_forge_float(forge, speed);
1549         lv2_atom_forge_property_head(forge, LV2Plugin::urids.time_barBeat, 0);
1550         lv2_atom_forge_float(forge, bbt.beats - 1 +
1551                              (bbt.ticks / Timecode::BBT_Time::ticks_per_beat));
1552         lv2_atom_forge_property_head(forge, LV2Plugin::urids.time_bar, 0);
1553         lv2_atom_forge_long(forge, bbt.bars - 1);
1554         lv2_atom_forge_property_head(forge, LV2Plugin::urids.time_beatUnit, 0);
1555         lv2_atom_forge_int(forge, t.meter().note_divisor());
1556         lv2_atom_forge_property_head(forge, LV2Plugin::urids.time_beatsPerBar, 0);
1557         lv2_atom_forge_float(forge, t.meter().divisions_per_bar());
1558         lv2_atom_forge_property_head(forge, LV2Plugin::urids.time_beatsPerMinute, 0);
1559         lv2_atom_forge_float(forge, t.tempo().beats_per_minute());
1560
1561         LV2_Evbuf_Iterator    end  = lv2_evbuf_end(buf);
1562         const LV2_Atom* const atom = (const LV2_Atom*)pos_buf;
1563         return lv2_evbuf_write(&end, offset, 0, atom->type, atom->size,
1564                                (const uint8_t*)(atom + 1));
1565 }
1566
1567 int
1568 LV2Plugin::connect_and_run(BufferSet& bufs,
1569         ChanMapping in_map, ChanMapping out_map,
1570         pframes_t nframes, framecnt_t offset)
1571 {
1572         DEBUG_TRACE(DEBUG::LV2, string_compose("%1 run %2 offset %3\n", name(), nframes, offset));
1573         Plugin::connect_and_run(bufs, in_map, out_map, nframes, offset);
1574
1575         cycles_t then = get_cycles();
1576
1577         TempoMap&               tmap     = _session.tempo_map();
1578         Metrics::const_iterator metric_i = tmap.metrics_end();
1579         TempoMetric             tmetric  = tmap.metric_at(_session.transport_frame(), &metric_i);
1580
1581         if (_freewheel_control_port) {
1582                 *_freewheel_control_port = _session.engine().freewheeling();
1583         }
1584
1585         if (_bpm_control_port) {
1586                 *_bpm_control_port = tmetric.tempo().beats_per_minute();
1587         }
1588
1589         ChanCount bufs_count;
1590         bufs_count.set(DataType::AUDIO, 1);
1591         bufs_count.set(DataType::MIDI, 1);
1592         BufferSet& silent_bufs  = _session.get_silent_buffers(bufs_count);
1593         BufferSet& scratch_bufs = _session.get_scratch_buffers(bufs_count);
1594         uint32_t const num_ports = parameter_count();
1595         uint32_t const nil_index = std::numeric_limits<uint32_t>::max();
1596
1597         uint32_t audio_in_index  = 0;
1598         uint32_t audio_out_index = 0;
1599         uint32_t midi_in_index   = 0;
1600         uint32_t midi_out_index  = 0;
1601         uint32_t atom_port_index = 0;
1602         for (uint32_t port_index = 0; port_index < num_ports; ++port_index) {
1603                 void*     buf   = NULL;
1604                 uint32_t  index = nil_index;
1605                 PortFlags flags = _port_flags[port_index];
1606                 bool      valid = false;
1607                 if (flags & PORT_AUDIO) {
1608                         if (flags & PORT_INPUT) {
1609                                 index = in_map.get(DataType::AUDIO, audio_in_index++, &valid);
1610                                 buf = (valid)
1611                                         ? bufs.get_audio(index).data(offset)
1612                                         : silent_bufs.get_audio(0).data(offset);
1613                         } else {
1614                                 index = out_map.get(DataType::AUDIO, audio_out_index++, &valid);
1615                                 buf = (valid)
1616                                         ? bufs.get_audio(index).data(offset)
1617                                         : scratch_bufs.get_audio(0).data(offset);
1618                         }
1619                 } else if (flags & (PORT_EVENT|PORT_SEQUENCE)) {
1620                         /* FIXME: The checks here for bufs.count().n_midi() > index shouldn't
1621                            be necessary, but the mapping is illegal in some cases.  Ideally
1622                            that should be fixed, but this is easier...
1623                         */
1624                         if (flags & PORT_MIDI) {
1625                                 if (flags & PORT_INPUT) {
1626                                         index = in_map.get(DataType::MIDI, midi_in_index++, &valid);
1627                                 } else {
1628                                         index = out_map.get(DataType::MIDI, midi_out_index++, &valid);
1629                                 }
1630                                 if (valid && bufs.count().n_midi() > index) {
1631                                         /* Note, ensure_lv2_bufsize() is not RT safe!
1632                                          * However free()/alloc() is only called if a
1633                                          * plugin requires a rsz:minimumSize buffersize
1634                                          * and the existing buffer if smaller.
1635                                          */
1636                                         bufs.ensure_lv2_bufsize((flags & PORT_INPUT), index, _port_minimumSize[port_index]);
1637                                         _ev_buffers[port_index] = bufs.get_lv2_midi(
1638                                                 (flags & PORT_INPUT), index, (flags & PORT_EVENT));
1639                                 }
1640                         } else if ((flags & PORT_POSITION) && (flags & PORT_INPUT)) {
1641                                 lv2_evbuf_reset(_atom_ev_buffers[atom_port_index], true);
1642                                 _ev_buffers[port_index] = _atom_ev_buffers[atom_port_index++];
1643                                 valid                   = true;
1644                         }
1645
1646                         if (valid && (flags & PORT_INPUT)) {
1647                                 Timecode::BBT_Time bbt;
1648                                 if ((flags & PORT_POSITION)) {
1649                                         if (_session.transport_frame() != _next_cycle_start ||
1650                                             _session.transport_speed() != _next_cycle_speed) {
1651                                                 // Transport has changed, write position at cycle start
1652                                                 tmap.bbt_time(_session.transport_frame(), bbt);
1653                                                 write_position(&_impl->forge, _ev_buffers[port_index],
1654                                                                tmetric, bbt, _session.transport_speed(),
1655                                                                _session.transport_frame(), 0);
1656                                         }
1657                                 }
1658
1659                                 // Get MIDI iterator range (empty range if no MIDI)
1660                                 MidiBuffer::iterator m = (index != nil_index)
1661                                         ? bufs.get_midi(index).begin()
1662                                         : silent_bufs.get_midi(0).end();
1663                                 MidiBuffer::iterator m_end = (index != nil_index)
1664                                         ? bufs.get_midi(index).end()
1665                                         : m;
1666
1667                                 // Now merge MIDI and any transport events into the buffer
1668                                 const uint32_t     type = LV2Plugin::urids.midi_MidiEvent;
1669                                 const framepos_t   tend = _session.transport_frame() + nframes;
1670                                 ++metric_i;
1671                                 while (m != m_end || (metric_i != tmap.metrics_end() &&
1672                                                       (*metric_i)->frame() < tend)) {
1673                                         MetricSection* metric = (metric_i != tmap.metrics_end())
1674                                                 ? *metric_i : NULL;
1675                                         if (m != m_end && (!metric || metric->frame() > (*m).time())) {
1676                                                 const Evoral::MIDIEvent<framepos_t> ev(*m, false);
1677                                                 LV2_Evbuf_Iterator eend = lv2_evbuf_end(_ev_buffers[port_index]);
1678                                                 lv2_evbuf_write(&eend, ev.time(), 0, type, ev.size(), ev.buffer());
1679                                                 ++m;
1680                                         } else {
1681                                                 tmetric.set_metric(metric);
1682                                                 bbt = metric->start();
1683                                                 write_position(&_impl->forge, _ev_buffers[port_index],
1684                                                                tmetric, bbt, _session.transport_speed(),
1685                                                                metric->frame(),
1686                                                                metric->frame() - _session.transport_frame());
1687                                                 ++metric_i;
1688                                         }
1689                                 }
1690                         } else if (!valid) {
1691                                 // Nothing we understand or care about, connect to scratch
1692                                 // see note for midi-buffer size above
1693                                 scratch_bufs.ensure_lv2_bufsize((flags & PORT_INPUT),
1694                                                 0, _port_minimumSize[port_index]);
1695                                 _ev_buffers[port_index] = scratch_bufs.get_lv2_midi(
1696                                         (flags & PORT_INPUT), 0, (flags & PORT_EVENT));
1697                         }
1698                         buf = lv2_evbuf_get_buffer(_ev_buffers[port_index]);
1699                 } else {
1700                         continue;  // Control port, leave buffer alone
1701                 }
1702                 lilv_instance_connect_port(_impl->instance, port_index, buf);
1703         }
1704
1705         // Read messages from UI and push into appropriate buffers
1706         if (_from_ui) {
1707                 uint32_t read_space = _from_ui->read_space();
1708                 while (read_space > sizeof(UIMessage)) {
1709                         UIMessage msg;
1710                         if (_from_ui->read((uint8_t*)&msg, sizeof(msg)) != sizeof(msg)) {
1711                                 error << "Error reading from UI=>Plugin RingBuffer" << endmsg;
1712                                 break;
1713                         }
1714                         uint8_t body[msg.size];
1715                         if (_from_ui->read(body, msg.size) != msg.size) {
1716                                 error << "Error reading from UI=>Plugin RingBuffer" << endmsg;
1717                                 break;
1718                         }
1719                         if (msg.protocol == urids.atom_eventTransfer) {
1720                                 LV2_Evbuf*            buf  = _ev_buffers[msg.index];
1721                                 LV2_Evbuf_Iterator    i    = lv2_evbuf_end(buf);
1722                                 const LV2_Atom* const atom = (const LV2_Atom*)body;
1723                                 if (!lv2_evbuf_write(&i, nframes, 0, atom->type, atom->size,
1724                                                 (const uint8_t*)(atom + 1))) {
1725                                         error << "Failed to write data to LV2 event buffer\n";
1726                                 }
1727                         } else {
1728                                 error << "Received unknown message type from UI" << endmsg;
1729                         }
1730                         read_space -= sizeof(UIMessage) + msg.size;
1731                 }
1732         }
1733
1734         run(nframes);
1735
1736         midi_out_index = 0;
1737         for (uint32_t port_index = 0; port_index < num_ports; ++port_index) {
1738                 PortFlags flags = _port_flags[port_index];
1739                 bool      valid = false;
1740
1741                 /* TODO ask drobilla about comment
1742                  * "Make Ardour event buffers generic so plugins can communicate"
1743                  * in libs/ardour/buffer_set.cc:310
1744                  *
1745                  * ideally the user could choose which of the following two modes
1746                  * to use (e.g. instrument/effect chains  MIDI OUT vs MIDI TRHU).
1747                  *
1748                  * This implementation follows the discussion on IRC Mar 16 2013 16:47 UTC
1749                  * 16:51 < drobilla> rgareus: [..] i.e always replace with MIDI output [of LV2 plugin] if it's there
1750                  * 16:52 < drobilla> rgareus: That would probably be good enough [..] to make users not complain
1751                  *                            for quite a while at least ;)
1752                  */
1753                 // copy output of LV2 plugin's MIDI port to Ardour MIDI buffers -- MIDI OUT
1754                 if ((flags & PORT_OUTPUT) && (flags & (PORT_EVENT|PORT_SEQUENCE|PORT_MIDI))) {
1755                         const uint32_t buf_index = out_map.get(
1756                                 DataType::MIDI, midi_out_index++, &valid);
1757                         if (valid) {
1758                                 bufs.forward_lv2_midi(_ev_buffers[port_index], buf_index);
1759                         }
1760                 }
1761                 // Flush MIDI (write back to Ardour MIDI buffers) -- MIDI THRU
1762                 else if ((flags & PORT_OUTPUT) && (flags & (PORT_EVENT|PORT_SEQUENCE))) {
1763                         const uint32_t buf_index = out_map.get(
1764                                 DataType::MIDI, midi_out_index++, &valid);
1765                         if (valid) {
1766                                 bufs.flush_lv2_midi(true, buf_index);
1767                         }
1768                 }
1769
1770                 // Write messages to UI
1771                 if (_to_ui && (flags & PORT_OUTPUT) && (flags & (PORT_EVENT|PORT_SEQUENCE))) {
1772                         LV2_Evbuf* buf = _ev_buffers[port_index];
1773                         for (LV2_Evbuf_Iterator i = lv2_evbuf_begin(buf);
1774                              lv2_evbuf_is_valid(i);
1775                              i = lv2_evbuf_next(i)) {
1776                                 uint32_t frames, subframes, type, size;
1777                                 uint8_t* data;
1778                                 lv2_evbuf_get(i, &frames, &subframes, &type, &size, &data);
1779                                 write_to_ui(port_index, urids.atom_eventTransfer,
1780                                             size + sizeof(LV2_Atom),
1781                                             data - sizeof(LV2_Atom));
1782                         }
1783                 }
1784         }
1785
1786         cycles_t now = get_cycles();
1787         set_cycles((uint32_t)(now - then));
1788
1789         // Update expected transport information for next cycle so we can detect changes
1790         _next_cycle_speed = _session.transport_speed();
1791         _next_cycle_start = _session.transport_frame() + (nframes * _next_cycle_speed);
1792
1793         return 0;
1794 }
1795
1796 bool
1797 LV2Plugin::parameter_is_control(uint32_t param) const
1798 {
1799         assert(param < _port_flags.size());
1800         return _port_flags[param] & PORT_CONTROL;
1801 }
1802
1803 bool
1804 LV2Plugin::parameter_is_audio(uint32_t param) const
1805 {
1806         assert(param < _port_flags.size());
1807         return _port_flags[param] & PORT_AUDIO;
1808 }
1809
1810 bool
1811 LV2Plugin::parameter_is_event(uint32_t param) const
1812 {
1813         assert(param < _port_flags.size());
1814         return _port_flags[param] & PORT_EVENT;
1815 }
1816
1817 bool
1818 LV2Plugin::parameter_is_output(uint32_t param) const
1819 {
1820         assert(param < _port_flags.size());
1821         return _port_flags[param] & PORT_OUTPUT;
1822 }
1823
1824 bool
1825 LV2Plugin::parameter_is_input(uint32_t param) const
1826 {
1827         assert(param < _port_flags.size());
1828         return _port_flags[param] & PORT_INPUT;
1829 }
1830
1831 void
1832 LV2Plugin::print_parameter(uint32_t param, char* buf, uint32_t len) const
1833 {
1834         if (buf && len) {
1835                 if (param < parameter_count()) {
1836                         snprintf(buf, len, "%.3f", get_parameter(param));
1837                 } else {
1838                         strcat(buf, "0");
1839                 }
1840         }
1841 }
1842
1843 boost::shared_ptr<Plugin::ScalePoints>
1844 LV2Plugin::get_scale_points(uint32_t port_index) const
1845 {
1846         const LilvPort*  port   = lilv_plugin_get_port_by_index(_impl->plugin, port_index);
1847         LilvScalePoints* points = lilv_port_get_scale_points(_impl->plugin, port);
1848
1849         boost::shared_ptr<Plugin::ScalePoints> ret;
1850         if (!points) {
1851                 return ret;
1852         }
1853
1854         ret = boost::shared_ptr<Plugin::ScalePoints>(new ScalePoints());
1855
1856         LILV_FOREACH(scale_points, i, points) {
1857                 const LilvScalePoint* p     = lilv_scale_points_get(points, i);
1858                 const LilvNode*       label = lilv_scale_point_get_label(p);
1859                 const LilvNode*       value = lilv_scale_point_get_value(p);
1860                 if (label && (lilv_node_is_float(value) || lilv_node_is_int(value))) {
1861                         ret->insert(make_pair(lilv_node_as_string(label),
1862                                               lilv_node_as_float(value)));
1863                 }
1864         }
1865
1866         lilv_scale_points_free(points);
1867         return ret;
1868 }
1869
1870 void
1871 LV2Plugin::run(pframes_t nframes)
1872 {
1873         uint32_t const N = parameter_count();
1874         for (uint32_t i = 0; i < N; ++i) {
1875                 if (parameter_is_control(i) && parameter_is_input(i)) {
1876                         _control_data[i] = _shadow_data[i];
1877                 }
1878         }
1879
1880         lilv_instance_run(_impl->instance, nframes);
1881
1882         if (_impl->work_iface) {
1883                 _worker->emit_responses();
1884                 if (_impl->work_iface->end_run) {
1885                         _impl->work_iface->end_run(_impl->instance->lv2_handle);
1886                 }
1887         }
1888 }
1889
1890 void
1891 LV2Plugin::latency_compute_run()
1892 {
1893         if (!_latency_control_port) {
1894                 return;
1895         }
1896
1897         // Run the plugin so that it can set its latency parameter
1898
1899         activate();
1900
1901         uint32_t port_index = 0;
1902         uint32_t in_index   = 0;
1903         uint32_t out_index  = 0;
1904
1905         const framecnt_t bufsize = 1024;
1906         float            buffer[bufsize];
1907
1908         memset(buffer, 0, sizeof(float) * bufsize);
1909
1910         // FIXME: Ensure plugins can handle in-place processing
1911
1912         port_index = 0;
1913
1914         while (port_index < parameter_count()) {
1915                 if (parameter_is_audio(port_index)) {
1916                         if (parameter_is_input(port_index)) {
1917                                 lilv_instance_connect_port(_impl->instance, port_index, buffer);
1918                                 in_index++;
1919                         } else if (parameter_is_output(port_index)) {
1920                                 lilv_instance_connect_port(_impl->instance, port_index, buffer);
1921                                 out_index++;
1922                         }
1923                 }
1924                 port_index++;
1925         }
1926
1927         run(bufsize);
1928         deactivate();
1929 }
1930
1931 const LilvPort*
1932 LV2Plugin::Impl::designated_input (const char* uri, void** bufptrs[], void** bufptr)
1933 {
1934         const LilvPort* port = NULL;
1935         LilvNode* designation = lilv_new_uri(_world.world, uri);
1936         port = lilv_plugin_get_port_by_designation(
1937                 plugin, _world.lv2_InputPort, designation);
1938         lilv_node_free(designation);
1939         if (port) {
1940                 bufptrs[lilv_port_get_index(plugin, port)] = bufptr;
1941         }
1942         return port;
1943 }
1944
1945 static bool lv2_filter (const string& str, void* /*arg*/)
1946 {
1947         /* Not a dotfile, has a prefix before a period, suffix is "lv2" */
1948
1949         return str[0] != '.' && (str.length() > 3 && str.find (".lv2") == (str.length() - 4));
1950 }
1951
1952
1953 LV2World::LV2World()
1954         : world(lilv_world_new())
1955         , _bundle_checked(false)
1956 {
1957         lilv_world_load_all(world);
1958
1959         atom_AtomPort      = lilv_new_uri(world, LV2_ATOM__AtomPort);
1960         atom_Chunk         = lilv_new_uri(world, LV2_ATOM__Chunk);
1961         atom_Sequence      = lilv_new_uri(world, LV2_ATOM__Sequence);
1962         atom_bufferType    = lilv_new_uri(world, LV2_ATOM__bufferType);
1963         atom_supports      = lilv_new_uri(world, LV2_ATOM__supports);
1964         atom_eventTransfer = lilv_new_uri(world, LV2_ATOM__eventTransfer);
1965         ev_EventPort       = lilv_new_uri(world, LILV_URI_EVENT_PORT);
1966         ext_logarithmic    = lilv_new_uri(world, LV2_PORT_PROPS__logarithmic);
1967         ext_notOnGUI       = lilv_new_uri(world, LV2_PORT_PROPS__notOnGUI);
1968         lv2_AudioPort      = lilv_new_uri(world, LILV_URI_AUDIO_PORT);
1969         lv2_ControlPort    = lilv_new_uri(world, LILV_URI_CONTROL_PORT);
1970         lv2_InputPort      = lilv_new_uri(world, LILV_URI_INPUT_PORT);
1971         lv2_OutputPort     = lilv_new_uri(world, LILV_URI_OUTPUT_PORT);
1972         lv2_inPlaceBroken  = lilv_new_uri(world, LV2_CORE__inPlaceBroken);
1973         lv2_integer        = lilv_new_uri(world, LV2_CORE__integer);
1974         lv2_reportsLatency = lilv_new_uri(world, LV2_CORE__reportsLatency);
1975         lv2_sampleRate     = lilv_new_uri(world, LV2_CORE__sampleRate);
1976         lv2_toggled        = lilv_new_uri(world, LV2_CORE__toggled);
1977         lv2_enumeration    = lilv_new_uri(world, LV2_CORE__enumeration);
1978         lv2_freewheeling   = lilv_new_uri(world, LV2_CORE__freeWheeling);
1979         midi_MidiEvent     = lilv_new_uri(world, LILV_URI_MIDI_EVENT);
1980         rdfs_comment       = lilv_new_uri(world, LILV_NS_RDFS "comment");
1981         rsz_minimumSize    = lilv_new_uri(world, LV2_RESIZE_PORT__minimumSize);
1982         time_Position      = lilv_new_uri(world, LV2_TIME__Position);
1983         ui_GtkUI           = lilv_new_uri(world, LV2_UI__GtkUI);
1984         ui_external        = lilv_new_uri(world, "http://lv2plug.in/ns/extensions/ui#external");
1985         ui_externalkx      = lilv_new_uri(world, "http://kxstudio.sf.net/ns/lv2ext/external-ui#Widget");
1986         units_unit         = lilv_new_uri(world, "http://lv2plug.in/ns/extensions/units#unit");
1987         units_midiNote     = lilv_new_uri(world, "http://lv2plug.in/ns/extensions/units#midiNote");
1988 }
1989
1990 LV2World::~LV2World()
1991 {
1992         lilv_node_free(units_midiNote);
1993         lilv_node_free(units_unit);
1994         lilv_node_free(ui_externalkx);
1995         lilv_node_free(ui_external);
1996         lilv_node_free(ui_GtkUI);
1997         lilv_node_free(time_Position);
1998         lilv_node_free(rsz_minimumSize);
1999         lilv_node_free(rdfs_comment);
2000         lilv_node_free(midi_MidiEvent);
2001         lilv_node_free(lv2_enumeration);
2002         lilv_node_free(lv2_freewheeling);
2003         lilv_node_free(lv2_toggled);
2004         lilv_node_free(lv2_sampleRate);
2005         lilv_node_free(lv2_reportsLatency);
2006         lilv_node_free(lv2_integer);
2007         lilv_node_free(lv2_inPlaceBroken);
2008         lilv_node_free(lv2_OutputPort);
2009         lilv_node_free(lv2_InputPort);
2010         lilv_node_free(lv2_ControlPort);
2011         lilv_node_free(lv2_AudioPort);
2012         lilv_node_free(ext_notOnGUI);
2013         lilv_node_free(ext_logarithmic);
2014         lilv_node_free(ev_EventPort);
2015         lilv_node_free(atom_supports);
2016         lilv_node_free(atom_eventTransfer);
2017         lilv_node_free(atom_bufferType);
2018         lilv_node_free(atom_Sequence);
2019         lilv_node_free(atom_Chunk);
2020         lilv_node_free(atom_AtomPort);
2021 }
2022
2023 void
2024 LV2World::load_bundled_plugins()
2025 {
2026         if (!_bundle_checked) {
2027                 cout << "Scanning folders for bundled LV2s: " << ARDOUR::lv2_bundled_search_path().to_string() << endl;
2028                 PathScanner scanner;
2029                 vector<string *> *plugin_objects = scanner (ARDOUR::lv2_bundled_search_path().to_string(), lv2_filter, 0, true, true);
2030                 if (plugin_objects) {
2031                         for ( vector<string *>::iterator x = plugin_objects->begin(); x != plugin_objects->end (); ++x) {
2032 #ifdef WINDOWS
2033                                 string uri = "file:///" + **x + "/";
2034 #else
2035                                 string uri = "file://" + **x + "/";
2036 #endif
2037                                 LilvNode *node = lilv_new_uri(world, uri.c_str());
2038                                 lilv_world_load_bundle(world, node);
2039                                 lilv_node_free(node);
2040                         }
2041                 }
2042                 delete (plugin_objects);
2043
2044                 _bundle_checked = true;
2045         }
2046 }
2047
2048 LV2PluginInfo::LV2PluginInfo (const void* c_plugin)
2049         : _c_plugin(c_plugin)
2050 {
2051         type = ARDOUR::LV2;
2052 }
2053
2054 LV2PluginInfo::~LV2PluginInfo()
2055 {}
2056
2057 PluginPtr
2058 LV2PluginInfo::load(Session& session)
2059 {
2060         try {
2061                 PluginPtr plugin;
2062
2063                 plugin.reset(new LV2Plugin(session.engine(), session,
2064                                            (const LilvPlugin*)_c_plugin,
2065                                            session.frame_rate()));
2066
2067                 plugin->set_info(PluginInfoPtr(new LV2PluginInfo(*this)));
2068                 return plugin;
2069         } catch (failed_constructor& err) {
2070                 return PluginPtr((Plugin*)0);
2071         }
2072
2073         return PluginPtr();
2074 }
2075
2076 PluginInfoList*
2077 LV2PluginInfo::discover()
2078 {
2079         _world.load_bundled_plugins();
2080
2081         PluginInfoList*    plugs   = new PluginInfoList;
2082         const LilvPlugins* plugins = lilv_world_get_all_plugins(_world.world);
2083
2084         info << "LV2: Discovering " << lilv_plugins_size(plugins) << " plugins" << endmsg;
2085
2086         LILV_FOREACH(plugins, i, plugins) {
2087                 const LilvPlugin* p = lilv_plugins_get(plugins, i);
2088                 LV2PluginInfoPtr  info(new LV2PluginInfo((const void*)p));
2089
2090                 LilvNode* name = lilv_plugin_get_name(p);
2091                 if (!name || !lilv_plugin_get_port_by_index(p, 0)) {
2092                         warning << "Ignoring invalid LV2 plugin "
2093                                 << lilv_node_as_string(lilv_plugin_get_uri(p))
2094                                 << endmsg;
2095                         continue;
2096                 }
2097
2098                 info->type = LV2;
2099
2100                 info->name = string(lilv_node_as_string(name));
2101                 lilv_node_free(name);
2102
2103                 const LilvPluginClass* pclass = lilv_plugin_get_class(p);
2104                 const LilvNode*        label  = lilv_plugin_class_get_label(pclass);
2105                 info->category = lilv_node_as_string(label);
2106
2107                 LilvNode* author_name = lilv_plugin_get_author_name(p);
2108                 info->creator = author_name ? string(lilv_node_as_string(author_name)) : "Unknown";
2109                 lilv_node_free(author_name);
2110
2111                 info->path = "/NOPATH"; // Meaningless for LV2
2112
2113                 /* count atom-event-ports that feature
2114                  * atom:supports <http://lv2plug.in/ns/ext/midi#MidiEvent>
2115                  *
2116                  * TODO: nicely ask drobilla to make a lilv_ call for that
2117                  */
2118                 int count_midi_out = 0;
2119                 int count_midi_in = 0;
2120                 for (uint32_t i = 0; i < lilv_plugin_get_num_ports(p); ++i) {
2121                         const LilvPort* port  = lilv_plugin_get_port_by_index(p, i);
2122                         if (lilv_port_is_a(p, port, _world.atom_AtomPort)) {
2123                                 LilvNodes* buffer_types = lilv_port_get_value(
2124                                         p, port, _world.atom_bufferType);
2125                                 LilvNodes* atom_supports = lilv_port_get_value(
2126                                         p, port, _world.atom_supports);
2127
2128                                 if (lilv_nodes_contains(buffer_types, _world.atom_Sequence)
2129                                                 && lilv_nodes_contains(atom_supports, _world.midi_MidiEvent)) {
2130                                         if (lilv_port_is_a(p, port, _world.lv2_InputPort)) {
2131                                                 count_midi_in++;
2132                                         }
2133                                         if (lilv_port_is_a(p, port, _world.lv2_OutputPort)) {
2134                                                 count_midi_out++;
2135                                         }
2136                                 }
2137                                 lilv_nodes_free(buffer_types);
2138                                 lilv_nodes_free(atom_supports);
2139                         }
2140                 }
2141
2142                 info->n_inputs.set_audio(
2143                         lilv_plugin_get_num_ports_of_class(
2144                                 p, _world.lv2_InputPort, _world.lv2_AudioPort, NULL));
2145                 info->n_inputs.set_midi(
2146                         lilv_plugin_get_num_ports_of_class(
2147                                 p, _world.lv2_InputPort, _world.ev_EventPort, NULL)
2148                         + count_midi_in);
2149
2150                 info->n_outputs.set_audio(
2151                         lilv_plugin_get_num_ports_of_class(
2152                                 p, _world.lv2_OutputPort, _world.lv2_AudioPort, NULL));
2153                 info->n_outputs.set_midi(
2154                         lilv_plugin_get_num_ports_of_class(
2155                                 p, _world.lv2_OutputPort, _world.ev_EventPort, NULL)
2156                         + count_midi_out);
2157
2158                 info->unique_id = lilv_node_as_uri(lilv_plugin_get_uri(p));
2159                 info->index     = 0; // Meaningless for LV2
2160
2161                 plugs->push_back(info);
2162         }
2163
2164         return plugs;
2165 }