libs/ardour/lv2_plugin.cc

   1 /*
   2     Copyright (C) 2008-2011 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
  21 #include <string>
  22 #include <vector>
  23
  24 #include <cmath>
  25 #include <cstdlib>
  26 #include <cstring>
  27
  28 #include <glibmm.h>
  29
  30 #include "pbd/compose.h"
  31 #include "pbd/error.h"
  32 #include "pbd/pathscanner.h"
  33 #include "pbd/xml++.h"
  34
  35 #include "ardour/ardour.h"
  36 #include "ardour/audio_buffer.h"
  37 #include "ardour/audioengine.h"
  38 #include "ardour/debug.h"
  39 #include "ardour/lv2_event_buffer.h"
  40 #include "ardour/lv2_plugin.h"
  41 #include "ardour/session.h"
  42
  43 #include "pbd/stl_delete.h"
  44
  45 #include "i18n.h"
  46 #include <locale.h>
  47
  48 #include "lv2ext/lv2_persist.h"
  49 #include "lv2_pfile.h"
  50
  51 #define NS_DC   "http://dublincore.org/documents/dcmi-namespace/"
  52 #define NS_LV2  "http://lv2plug.in/ns/lv2core#"
  53 #define NS_PSET "http://lv2plug.in/ns/dev/presets#"
  54 #define NS_UI   "http://lv2plug.in/ns/extensions/ui#"
  55
  56 using namespace std;
  57 using namespace ARDOUR;
  58 using namespace PBD;
  59
  60 URIMap LV2Plugin::  _uri_map;
  61 uint32_t LV2Plugin::_midi_event_type = _uri_map.uri_to_id(
  62         "http://lv2plug.in/ns/ext/event",
  63         "http://lv2plug.in/ns/ext/midi#MidiEvent");
  64
  65 LV2Plugin::LV2Plugin (AudioEngine& engine,
  66                       Session&     session,
  67                       LV2World&    world,
  68                       SLV2Plugin   plugin,
  69                       framecnt_t   rate)
  70         : Plugin(engine, session)
  71         , _world(world)
  72         , _features(NULL)
  73 {
  74         init(world, plugin, rate);
  75 }
  76
  77 LV2Plugin::LV2Plugin (const LV2Plugin& other)
  78         : Plugin(other)
  79         , _world(other._world)
  80         , _features(NULL)
  81 {
  82         init(other._world, other._plugin, other._sample_rate);
  83
  84         for (uint32_t i = 0; i < parameter_count(); ++i) {
  85                 _control_data[i] = other._shadow_data[i];
  86                 _shadow_data[i]  = other._shadow_data[i];
  87         }
  88 }
  89
  90 void
  91 LV2Plugin::init(LV2World& world, SLV2Plugin plugin, framecnt_t rate)
  92 {
  93         DEBUG_TRACE(DEBUG::LV2, "LV2 plugin init\n");
  94
  95         _world                = world;
  96         _plugin               = plugin;
  97         _ui                   = NULL;
  98         _control_data         = 0;
  99         _shadow_data          = 0;
 100         _latency_control_port = 0;
 101         _was_activated        = false;
 102
 103         _instance_access_feature.URI = "http://lv2plug.in/ns/ext/instance-access";
 104         _data_access_feature.URI     = "http://lv2plug.in/ns/ext/data-access";
 105         _persist_feature.URI         = "http://lv2plug.in/ns/ext/persist";
 106         _persist_feature.data        = NULL;
 107
 108         SLV2Value persist_uri = slv2_value_new_uri(_world.world, _persist_feature.URI);
 109         _supports_persist = slv2_plugin_has_feature(plugin, persist_uri);
 110         slv2_value_free(persist_uri);
 111
 112         _features    = (LV2_Feature**)malloc(sizeof(LV2_Feature*) * 5);
 113         _features[0] = &_instance_access_feature;
 114         _features[1] = &_data_access_feature;
 115         _features[2] = &_persist_feature;
 116         _features[3] = _uri_map.feature();
 117         _features[4] = NULL;
 118
 119         _instance = slv2_plugin_instantiate(plugin, rate, _features);
 120         _name     = slv2_plugin_get_name(plugin);
 121         _author   = slv2_plugin_get_author_name(plugin);
 122
 123         if (_instance == 0) {
 124                 error << _("LV2: Failed to instantiate plugin ")
 125                       << slv2_value_as_string(slv2_plugin_get_uri(plugin)) << endmsg;
 126                 throw failed_constructor();
 127         }
 128
 129         _instance_access_feature.data              = (void*)_instance->lv2_handle;
 130         _data_access_extension_data.extension_data = _instance->lv2_descriptor->extension_data;
 131         _data_access_feature.data                  = &_data_access_extension_data;
 132
 133         if (slv2_plugin_has_feature(plugin, world.in_place_broken)) {
 134                 error << string_compose(
 135                     _("LV2: \"%1\" cannot be used, since it cannot do inplace processing"),
 136                     slv2_value_as_string(_name)) << endmsg;
 137                 slv2_value_free(_name);
 138                 slv2_value_free(_author);
 139                 throw failed_constructor();
 140         }
 141
 142         _sample_rate = rate;
 143
 144         const uint32_t num_ports    = slv2_plugin_get_num_ports(plugin);
 145         const bool     latent       = slv2_plugin_has_latency(plugin);
 146         const uint32_t latency_port = (latent)
 147             ? slv2_plugin_get_latency_port_index(plugin)
 148                 : 0;
 149
 150         _control_data = new float[num_ports];
 151         _shadow_data  = new float[num_ports];
 152         _defaults     = new float[num_ports];
 153
 154         for (uint32_t i = 0; i < num_ports; ++i) {
 155                 SLV2Port  port = slv2_plugin_get_port_by_index(plugin, i);
 156                 SLV2Value sym  = slv2_port_get_symbol(_plugin, port);
 157
 158                 // Store index in map so we can look up index by symbol
 159                 _port_indices.insert(std::make_pair(slv2_value_as_string(sym), i));
 160
 161                 // Get range and default value if applicable
 162                 if (parameter_is_control(i)) {
 163                         SLV2Value def;
 164                         slv2_port_get_range(plugin, port, &def, NULL, NULL);
 165                         _defaults[i] = def ? slv2_value_as_float(def) : 0.0f;
 166                         slv2_value_free(def);
 167
 168                         slv2_instance_connect_port(_instance, i, &_control_data[i]);
 169
 170                         if (latent && ( i == latency_port) ) {
 171                                 _latency_control_port  = &_control_data[i];
 172                                 *_latency_control_port = 0;
 173                         }
 174
 175                         if (parameter_is_input(i)) {
 176                                 _shadow_data[i] = default_value(i);
 177                         }
 178                 } else {
 179                         _defaults[i] = 0.0f;
 180                 }
 181         }
 182
 183         SLV2UIs uis = slv2_plugin_get_uis(_plugin);
 184         if (slv2_uis_size(uis) > 0) {
 185                 // Look for Gtk native UI
 186                 for (unsigned i = 0; i < slv2_uis_size(uis); ++i) {
 187                         SLV2UI ui = slv2_uis_get_at(uis, i);
 188                         if (slv2_ui_is_a(ui, _world.gtk_gui)) {
 189                                 _ui = ui;
 190                                 break;
 191                         }
 192                 }
 193
 194                 // If Gtk UI is not available, try to find external UI
 195                 if (!_ui) {
 196                         for (unsigned i = 0; i < slv2_uis_size(uis); ++i) {
 197                                 SLV2UI ui = slv2_uis_get_at(uis, i);
 198                                 if (slv2_ui_is_a(ui, _world.external_gui)) {
 199                                         _ui = ui;
 200                                         break;
 201                                 }
 202                         }
 203                 }
 204         }
 205
 206         latency_compute_run();
 207 }
 208
 209 LV2Plugin::~LV2Plugin ()
 210 {
 211         DEBUG_TRACE(DEBUG::LV2, string_compose("%1 destroy\n", name()));
 212
 213         deactivate();
 214         cleanup();
 215
 216         slv2_instance_free(_instance);
 217         slv2_value_free(_name);
 218         slv2_value_free(_author);
 219
 220         delete [] _control_data;
 221         delete [] _shadow_data;
 222 }
 223
 224 bool
 225 LV2Plugin::is_external_ui() const
 226 {
 227         return slv2_ui_is_a(_ui, _world.external_gui);
 228 }
 229
 230 string
 231 LV2Plugin::unique_id() const
 232 {
 233         return slv2_value_as_uri(slv2_plugin_get_uri(_plugin));
 234 }
 235
 236 float
 237 LV2Plugin::default_value(uint32_t port)
 238 {
 239         return _defaults[port];
 240 }
 241
 242 const char*
 243 LV2Plugin::port_symbol(uint32_t index) const
 244 {
 245         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, index);
 246         if (!port) {
 247                 error << name() << ": Invalid port index " << index << endmsg;
 248         }
 249
 250         SLV2Value sym = slv2_port_get_symbol(_plugin, port);
 251         return slv2_value_as_string(sym);
 252 }
 253
 254 void
 255 LV2Plugin::set_parameter(uint32_t which, float val)
 256 {
 257         DEBUG_TRACE(DEBUG::LV2, string_compose(
 258                         "%1 set parameter %2 to %3\n", name(), which, val));
 259
 260         if (which < slv2_plugin_get_num_ports(_plugin)) {
 261                 _shadow_data[which] = val;
 262         } else {
 263                 warning << string_compose(
 264                     _("Illegal parameter number used with plugin \"%1\". "
 265                       "This is a bug in either %2 or the LV2 plugin <%3>"),
 266                     name(), PROGRAM_NAME, unique_id()) << endmsg;
 267         }
 268
 269         Plugin::set_parameter(which, val);
 270 }
 271
 272 float
 273 LV2Plugin::get_parameter(uint32_t which) const
 274 {
 275         if (parameter_is_input(which)) {
 276                 return (float)_shadow_data[which];
 277         } else {
 278                 return (float)_control_data[which];
 279         }
 280         return 0.0f;
 281 }
 282
 283 uint32_t
 284 LV2Plugin::nth_parameter(uint32_t n, bool& ok) const
 285 {
 286         ok = false;
 287         for (uint32_t c = 0, x = 0; x < slv2_plugin_get_num_ports(_plugin); ++x) {
 288                 if (parameter_is_control(x)) {
 289                         if (c++ == n) {
 290                                 ok = true;
 291                                 return x;
 292                         }
 293                 }
 294         }
 295
 296         return 0;
 297 }
 298
 299 void
 300 LV2Plugin::lv2_persist_store_callback(void*       callback_data,
 301                                       const char* key,
 302                                       const void* value,
 303                                       size_t      size,
 304                                       uint32_t    type)
 305 {
 306         LV2PFile file = (LV2PFile)callback_data;
 307
 308         // FIXME: assumes URIs are mapped in the default context (or not event, at least)
 309         const char* type_uri = LV2Plugin::_uri_map.id_to_uri(NULL, type);
 310         cout << "LV2 PERSIST STORE " << key << " = " << value << " :: " << type_uri << endl;
 311         lv2_pfile_write(file, key, value, size, type_uri);
 312 }
 313
 314 const void*
 315 LV2Plugin::lv2_persist_retrieve_callback(void*       callback_data,
 316                                          const char* key,
 317                                          size_t*     size,
 318                                          uint32_t*   type)
 319 {
 320         //LV2PFile file = (LV2PFile)callback_data;
 321         cout << "LV2 PERSIST RETRIEVE " << key << endl;
 322         return NULL;
 323 }
 324
 325 void
 326 LV2Plugin::add_state(XMLNode* root) const
 327 {
 328         XMLNode*    child;
 329         char        buf[16];
 330         LocaleGuard lg(X_("POSIX"));
 331
 332         for (uint32_t i = 0; i < parameter_count(); ++i) {
 333                 if (parameter_is_input(i) && parameter_is_control(i)) {
 334                         child = new XMLNode("Port");
 335                         child->add_property("symbol", port_symbol(i));
 336                         snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
 337                         child->add_property("value", string(buf));
 338                         root->add_child_nocopy(*child);
 339                 }
 340         }
 341
 342         if (_supports_persist) {
 343                 // Create state directory for this plugin instance
 344                 const std::string state_filename = _id.to_s() + ".lv2pfile";
 345                 const std::string state_path     = Glib::build_filename(
 346                         _session.plugins_dir(), state_filename);
 347
 348                 cout << "Saving LV2 plugin state to " << state_path << endl;
 349
 350                 // Get LV2 Persist extension data from plugin instance
 351                 LV2_Persist* persist = (LV2_Persist*)slv2_instance_get_extension_data(
 352                         _instance, "http://lv2plug.in/ns/ext/persist");
 353                 if (!persist) {
 354                         warning << string_compose(
 355                             _("Plugin \"%1\% failed to return LV2 persist data"),
 356                             unique_id());
 357                         return;
 358                 }
 359
 360                 LV2PFile file = lv2_pfile_open(state_path.c_str(), true);
 361                 persist->save(_instance->lv2_handle, &LV2Plugin::lv2_persist_store_callback, file);
 362                 lv2_pfile_close(file);
 363
 364                 root->add_property("state-file", state_filename);
 365         }
 366 }
 367
 368 static inline SLV2Value
 369 get_value(SLV2Plugin p, SLV2Value subject, SLV2Value predicate)
 370 {
 371         SLV2Values vs = slv2_plugin_get_value_for_subject(p, subject, predicate);
 372         return vs ? slv2_values_get_at(vs, 0) : NULL;
 373 }
 374
 375 void
 376 LV2Plugin::find_presets()
 377 {
 378         SLV2Value dc_title       = slv2_value_new_uri(_world.world, NS_DC   "title");
 379         SLV2Value pset_hasPreset = slv2_value_new_uri(_world.world, NS_PSET "hasPreset");
 380
 381         SLV2Values presets = slv2_plugin_get_value(_plugin, pset_hasPreset);
 382         for (unsigned i = 0; i < slv2_values_size(presets); ++i) {
 383                 SLV2Value preset = slv2_values_get_at(presets, i);
 384                 SLV2Value name   = get_value(_plugin, preset, dc_title);
 385                 if (name) {
 386                         _presets.insert(std::make_pair(slv2_value_as_string(preset),
 387                                                        PresetRecord(
 388                                                            slv2_value_as_string(preset),
 389                                                            slv2_value_as_string(name))));
 390                 } else {
 391                         warning << string_compose(
 392                             _("Plugin \"%1\% preset \"%2%\" is missing a dc:title\n"),
 393                             unique_id(), slv2_value_as_string(preset));
 394                 }
 395         }
 396         slv2_values_free(presets);
 397
 398         slv2_value_free(pset_hasPreset);
 399         slv2_value_free(dc_title);
 400 }
 401
 402 bool
 403 LV2Plugin::load_preset(PresetRecord r)
 404 {
 405         Plugin::load_preset(r);
 406
 407 #ifdef HAVE_NEW_SLV2
 408         // New (>= 0.7.0) slv2 no longer supports SPARQL, but exposes blank nodes
 409         // so querying ports is possible with the simple/fast API
 410         SLV2Value lv2_port   = slv2_value_new_uri(_world.world, NS_LV2 "port");
 411         SLV2Value lv2_symbol = slv2_value_new_uri(_world.world, NS_LV2 "symbol");
 412         SLV2Value pset_value = slv2_value_new_uri(_world.world, NS_PSET "value");
 413         SLV2Value preset     = slv2_value_new_uri(_world.world, r.uri.c_str());
 414
 415         SLV2Values ports = slv2_plugin_get_value_for_subject(_plugin, preset, lv2_port);
 416         for (unsigned i = 0; i < slv2_values_size(ports); ++i) {
 417                 SLV2Value port   = slv2_values_get_at(ports, i);
 418                 SLV2Value symbol = get_value(_plugin, port, lv2_symbol);
 419                 SLV2Value value  = get_value(_plugin, port, pset_value);
 420                 if (value && slv2_value_is_float(value)) {
 421                         set_parameter(_port_indices[slv2_value_as_string(symbol)],
 422                                       slv2_value_as_float(value));
 423                 }
 424         }
 425         slv2_values_free(ports);
 426
 427         slv2_value_free(preset);
 428         slv2_value_free(pset_value);
 429         slv2_value_free(lv2_symbol);
 430         slv2_value_free(lv2_port);
 431 #else
 432         const string query = string(
 433                 "PREFIX lv2p: <http://lv2plug.in/ns/dev/presets#>\n"
 434                 "PREFIX dc:  <http://dublincore.org/documents/dcmi-namespace/>\n"
 435                 "SELECT ?sym ?val WHERE { <") + r.uri + "> lv2:port ?port . "
 436             " ?port lv2:symbol ?sym ; lv2p:value ?val . }";
 437         SLV2Results values = slv2_plugin_query_sparql(_plugin, query.c_str());
 438         for (; !slv2_results_finished(values); slv2_results_next(values)) {
 439                 SLV2Value sym = slv2_results_get_binding_value(values, 0);
 440                 SLV2Value val = slv2_results_get_binding_value(values, 1);
 441                 if (slv2_value_is_float(val)) {
 442                         uint32_t index = _port_indices[slv2_value_as_string(sym)];
 443                         set_parameter(index, slv2_value_as_float(val));
 444                 }
 445         }
 446         slv2_results_free(values);
 447 #endif
 448         return true;
 449 }
 450
 451 std::string
 452 LV2Plugin::do_save_preset(string /*name*/)
 453 {
 454         return "";
 455 }
 456
 457 void
 458 LV2Plugin::do_remove_preset(string /*name*/)
 459 {}
 460
 461 bool
 462 LV2Plugin::has_editor() const
 463 {
 464         return _ui != NULL;
 465 }
 466
 467 int
 468 LV2Plugin::set_state(const XMLNode& node, int version)
 469 {
 470         XMLNodeList          nodes;
 471         const XMLProperty*   prop;
 472         XMLNodeConstIterator iter;
 473         XMLNode*             child;
 474         const char*          sym;
 475         const char*          value;
 476         uint32_t             port_id;
 477         LocaleGuard          lg(X_("POSIX"));
 478
 479         if (node.name() != state_node_name()) {
 480                 error << _("Bad node sent to LV2Plugin::set_state") << endmsg;
 481                 return -1;
 482         }
 483
 484         if (version < 3000) {
 485                 nodes = node.children("port");
 486         } else {
 487                 nodes = node.children("Port");
 488         }
 489
 490         for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
 491
 492                 child = *iter;
 493
 494                 if ((prop = child->property("symbol")) != 0) {
 495                         sym = prop->value().c_str();
 496                 } else {
 497                         warning << _("LV2: port has no symbol, ignored") << endmsg;
 498                         continue;
 499                 }
 500
 501                 map<string, uint32_t>::iterator i = _port_indices.find(sym);
 502
 503                 if (i != _port_indices.end()) {
 504                         port_id = i->second;
 505                 } else {
 506                         warning << _("LV2: port has unknown index, ignored") << endmsg;
 507                         continue;
 508                 }
 509
 510                 if ((prop = child->property("value")) != 0) {
 511                         value = prop->value().c_str();
 512                 } else {
 513                         warning << _("LV2: port has no value, ignored") << endmsg;
 514                         continue;
 515                 }
 516
 517                 set_parameter(port_id, atof(value));
 518         }
 519
 520         if ((prop = node.property("state-file")) != 0) {
 521                 std::string state_path = Glib::build_filename(_session.plugins_dir(),
 522                                                               prop->value());
 523
 524                 // Get LV2 Persist extension data from plugin instance
 525                 LV2_Persist* persist = (LV2_Persist*)slv2_instance_get_extension_data(
 526                         _instance, "http://lv2plug.in/ns/ext/persist");
 527                 if (persist) {
 528                         cout << "Loading LV2 state from " << state_path << endl;
 529                         LV2PFile file = lv2_pfile_open(state_path.c_str(), false);
 530                         persist->restore(_instance->lv2_handle,
 531                                          &LV2Plugin::lv2_persist_retrieve_callback,
 532                                          file);
 533                         lv2_pfile_close(file);
 534                 } else {
 535                         warning << string_compose(
 536                             _("Plugin \"%1\% failed to return LV2 persist data"),
 537                             unique_id());
 538                 }
 539         }
 540
 541         latency_compute_run();
 542
 543         return Plugin::set_state(node, version);
 544 }
 545
 546 int
 547 LV2Plugin::get_parameter_descriptor(uint32_t which, ParameterDescriptor& desc) const
 548 {
 549         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, which);
 550
 551         SLV2Value def, min, max;
 552         slv2_port_get_range(_plugin, port, &def, &min, &max);
 553
 554         desc.integer_step = slv2_port_has_property(_plugin, port, _world.integer);
 555         desc.toggled      = slv2_port_has_property(_plugin, port, _world.toggled);
 556         desc.logarithmic  = slv2_port_has_property(_plugin, port, _world.logarithmic);
 557         desc.sr_dependent = slv2_port_has_property(_plugin, port, _world.srate);
 558         desc.label        = slv2_value_as_string(slv2_port_get_name(_plugin, port));
 559         desc.lower        = min ? slv2_value_as_float(min) : 0.0f;
 560         desc.upper        = max ? slv2_value_as_float(max) : 1.0f;
 561         desc.min_unbound  = false; // TODO: LV2 extension required
 562         desc.max_unbound  = false; // TODO: LV2 extension required
 563
 564         if (desc.integer_step) {
 565                 desc.step      = 1.0;
 566                 desc.smallstep = 0.1;
 567                 desc.largestep = 10.0;
 568         } else {
 569                 const float delta = desc.upper - desc.lower;
 570                 desc.step      = delta / 1000.0f;
 571                 desc.smallstep = delta / 10000.0f;
 572                 desc.largestep = delta / 10.0f;
 573         }
 574
 575         slv2_value_free(def);
 576         slv2_value_free(min);
 577         slv2_value_free(max);
 578
 579         return 0;
 580 }
 581
 582 string
 583 LV2Plugin::describe_parameter(Evoral::Parameter which)
 584 {
 585         if (( which.type() == PluginAutomation) && ( which.id() < parameter_count()) ) {
 586                 SLV2Value name = slv2_port_get_name(_plugin,
 587                                                     slv2_plugin_get_port_by_index(_plugin, which.id()));
 588                 string ret(slv2_value_as_string(name));
 589                 slv2_value_free(name);
 590                 return ret;
 591         } else {
 592                 return "??";
 593         }
 594 }
 595
 596 framecnt_t
 597 LV2Plugin::signal_latency() const
 598 {
 599         if (_latency_control_port) {
 600                 return (framecnt_t)floor(*_latency_control_port);
 601         } else {
 602                 return 0;
 603         }
 604 }
 605
 606 set<Evoral::Parameter>
 607 LV2Plugin::automatable() const
 608 {
 609         set<Evoral::Parameter> ret;
 610
 611         for (uint32_t i = 0; i < parameter_count(); ++i) {
 612                 if (parameter_is_input(i) && parameter_is_control(i)) {
 613                         ret.insert(ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
 614                 }
 615         }
 616
 617         return ret;
 618 }
 619
 620 void
 621 LV2Plugin::activate()
 622 {
 623         DEBUG_TRACE(DEBUG::LV2, string_compose("%1 activate\n", name()));
 624
 625         if (!_was_activated) {
 626                 slv2_instance_activate(_instance);
 627                 _was_activated = true;
 628         }
 629 }
 630
 631 void
 632 LV2Plugin::deactivate()
 633 {
 634         DEBUG_TRACE(DEBUG::LV2, string_compose("%1 deactivate\n", name()));
 635
 636         if (_was_activated) {
 637                 slv2_instance_deactivate(_instance);
 638                 _was_activated = false;
 639         }
 640 }
 641
 642 void
 643 LV2Plugin::cleanup()
 644 {
 645         DEBUG_TRACE(DEBUG::LV2, string_compose("%1 cleanup\n", name()));
 646
 647         activate();
 648         deactivate();
 649         slv2_instance_free(_instance);
 650         _instance = NULL;
 651 }
 652
 653 int
 654 LV2Plugin::connect_and_run(BufferSet& bufs,
 655         ChanMapping in_map, ChanMapping out_map,
 656         pframes_t nframes, framecnt_t offset)
 657 {
 658         DEBUG_TRACE(DEBUG::LV2, string_compose("%1 run %2 offset %3\n", name(), nframes, offset));
 659         Plugin::connect_and_run(bufs, in_map, out_map, nframes, offset);
 660
 661         cycles_t then = get_cycles();
 662
 663         uint32_t audio_in_index  = 0;
 664         uint32_t audio_out_index = 0;
 665         uint32_t midi_in_index   = 0;
 666         uint32_t midi_out_index  = 0;
 667         for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
 668                 if (parameter_is_audio(port_index)) {
 669                         if (parameter_is_input(port_index)) {
 670                                 const uint32_t buf_index = in_map.get(DataType::AUDIO, audio_in_index++);
 671                                 slv2_instance_connect_port(_instance, port_index,
 672                                                            bufs.get_audio(buf_index).data(offset));
 673                         } else if (parameter_is_output(port_index)) {
 674                                 const uint32_t buf_index = out_map.get(DataType::AUDIO, audio_out_index++);
 675                                 //cerr << port_index << " : " << " AUDIO OUT " << buf_index << endl;
 676                                 slv2_instance_connect_port(_instance, port_index,
 677                                                            bufs.get_audio(buf_index).data(offset));
 678                         }
 679                 } else if (parameter_is_midi(port_index)) {
 680                         if (parameter_is_input(port_index)) {
 681                                 const uint32_t buf_index = in_map.get(DataType::MIDI, midi_in_index++);
 682                                 slv2_instance_connect_port(_instance, port_index,
 683                                                            bufs.get_lv2_midi(true, buf_index).data());
 684                         } else if (parameter_is_output(port_index)) {
 685                                 const uint32_t buf_index = out_map.get(DataType::MIDI, midi_out_index++);
 686                                 slv2_instance_connect_port(_instance, port_index,
 687                                                            bufs.get_lv2_midi(false, buf_index).data());
 688                         }
 689                 } else if (!parameter_is_control(port_index)) {
 690                         // Optional port (it'd better be if we've made it this far...)
 691                         slv2_instance_connect_port(_instance, port_index, NULL);
 692                 }
 693         }
 694
 695         run(nframes);
 696
 697         midi_out_index = 0;
 698         for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
 699                 if (parameter_is_midi(port_index) && parameter_is_output(port_index)) {
 700                         const uint32_t buf_index = out_map.get(DataType::MIDI, midi_out_index++);
 701                         bufs.flush_lv2_midi(true, buf_index);
 702                 }
 703         }
 704
 705         cycles_t now = get_cycles();
 706         set_cycles((uint32_t)(now - then));
 707
 708         return 0;
 709 }
 710
 711 bool
 712 LV2Plugin::parameter_is_control(uint32_t param) const
 713 {
 714         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
 715         return slv2_port_is_a(_plugin, port, _world.control_class);
 716 }
 717
 718 bool
 719 LV2Plugin::parameter_is_audio(uint32_t param) const
 720 {
 721         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
 722         return slv2_port_is_a(_plugin, port, _world.audio_class);
 723 }
 724
 725 bool
 726 LV2Plugin::parameter_is_midi(uint32_t param) const
 727 {
 728         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
 729         return slv2_port_is_a(_plugin, port, _world.event_class);
 730         //      && slv2_port_supports_event(_plugin, port, _world.midi_class);
 731 }
 732
 733 bool
 734 LV2Plugin::parameter_is_output(uint32_t param) const
 735 {
 736         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
 737         return slv2_port_is_a(_plugin, port, _world.output_class);
 738 }
 739
 740 bool
 741 LV2Plugin::parameter_is_input(uint32_t param) const
 742 {
 743         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
 744         return slv2_port_is_a(_plugin, port, _world.input_class);
 745 }
 746
 747 void
 748 LV2Plugin::print_parameter(uint32_t param, char* buf, uint32_t len) const
 749 {
 750         if (buf && len) {
 751                 if (param < parameter_count()) {
 752                         snprintf(buf, len, "%.3f", get_parameter(param));
 753                 } else {
 754                         strcat(buf, "0");
 755                 }
 756         }
 757 }
 758
 759 void
 760 LV2Plugin::run(pframes_t nframes)
 761 {
 762         for (uint32_t i = 0; i < parameter_count(); ++i) {
 763                 if (parameter_is_control(i) && parameter_is_input(i)) {
 764                         _control_data[i] = _shadow_data[i];
 765                 }
 766         }
 767
 768         slv2_instance_run(_instance, nframes);
 769 }
 770
 771 void
 772 LV2Plugin::latency_compute_run()
 773 {
 774         if (!_latency_control_port) {
 775                 return;
 776         }
 777
 778         // Run the plugin so that it can set its latency parameter
 779
 780         activate();
 781
 782         uint32_t port_index = 0;
 783         uint32_t in_index   = 0;
 784         uint32_t out_index  = 0;
 785
 786         const framecnt_t bufsize = 1024;
 787         float            buffer[bufsize];
 788
 789         memset(buffer, 0, sizeof(float) * bufsize);
 790
 791         // FIXME: Ensure plugins can handle in-place processing
 792
 793         port_index = 0;
 794
 795         while (port_index < parameter_count()) {
 796                 if (parameter_is_audio(port_index)) {
 797                         if (parameter_is_input(port_index)) {
 798                                 slv2_instance_connect_port(_instance, port_index, buffer);
 799                                 in_index++;
 800                         } else if (parameter_is_output(port_index)) {
 801                                 slv2_instance_connect_port(_instance, port_index, buffer);
 802                                 out_index++;
 803                         }
 804                 }
 805                 port_index++;
 806         }
 807
 808         run(bufsize);
 809         deactivate();
 810 }
 811
 812 LV2World::LV2World()
 813         : world(slv2_world_new())
 814 {
 815         slv2_world_load_all(world);
 816         input_class     = slv2_value_new_uri(world, SLV2_PORT_CLASS_INPUT);
 817         output_class    = slv2_value_new_uri(world, SLV2_PORT_CLASS_OUTPUT);
 818         control_class   = slv2_value_new_uri(world, SLV2_PORT_CLASS_CONTROL);
 819         audio_class     = slv2_value_new_uri(world, SLV2_PORT_CLASS_AUDIO);
 820         event_class     = slv2_value_new_uri(world, SLV2_PORT_CLASS_EVENT);
 821         midi_class      = slv2_value_new_uri(world, SLV2_EVENT_CLASS_MIDI);
 822         in_place_broken = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "inPlaceBroken");
 823         integer         = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "integer");
 824         toggled         = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "toggled");
 825         srate           = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "sampleRate");
 826         gtk_gui         = slv2_value_new_uri(world, NS_UI "GtkUI");
 827         external_gui    = slv2_value_new_uri(world, NS_UI "external");
 828         logarithmic     = slv2_value_new_uri(world, "http://lv2plug.in/ns/dev/extportinfo#logarithmic");
 829 }
 830
 831 LV2World::~LV2World()
 832 {
 833         slv2_value_free(input_class);
 834         slv2_value_free(output_class);
 835         slv2_value_free(control_class);
 836         slv2_value_free(audio_class);
 837         slv2_value_free(event_class);
 838         slv2_value_free(midi_class);
 839         slv2_value_free(in_place_broken);
 840 }
 841
 842 LV2PluginInfo::LV2PluginInfo (void* lv2_world, void* slv2_plugin)
 843         : _lv2_world(lv2_world)
 844         , _slv2_plugin(slv2_plugin)
 845 {
 846         type = ARDOUR::LV2;
 847 }
 848
 849 LV2PluginInfo::~LV2PluginInfo()
 850 {}
 851
 852 PluginPtr
 853 LV2PluginInfo::load(Session& session)
 854 {
 855         try {
 856                 PluginPtr plugin;
 857
 858                 plugin.reset(new LV2Plugin(session.engine(), session,
 859                                            *(LV2World*)_lv2_world, (SLV2Plugin)_slv2_plugin,
 860                                            session.frame_rate()));
 861
 862                 plugin->set_info(PluginInfoPtr(new LV2PluginInfo(*this)));
 863                 return plugin;
 864         } catch (failed_constructor& err) {
 865                 return PluginPtr((Plugin*)0);
 866         }
 867
 868         return PluginPtr();
 869 }
 870
 871 PluginInfoList*
 872 LV2PluginInfo::discover(void* lv2_world)
 873 {
 874         PluginInfoList* plugs   = new PluginInfoList;
 875         LV2World*       world   = (LV2World*)lv2_world;
 876         SLV2Plugins     plugins = slv2_world_get_all_plugins(world->world);
 877
 878         cerr << "LV2: Discovering " << slv2_plugins_size(plugins) << " plugins" << endl;
 879
 880         for (unsigned i = 0; i < slv2_plugins_size(plugins); ++i) {
 881                 SLV2Plugin       p = slv2_plugins_get_at(plugins, i);
 882                 LV2PluginInfoPtr info(new LV2PluginInfo(lv2_world, p));
 883
 884                 SLV2Value name = slv2_plugin_get_name(p);
 885
 886                 if (!name) {
 887                         cerr << "LV2: invalid plugin\n";
 888                         continue;
 889                 }
 890
 891                 info->type = LV2;
 892
 893                 info->name = string(slv2_value_as_string(name));
 894                 slv2_value_free(name);
 895
 896                 SLV2PluginClass pclass = slv2_plugin_get_class(p);
 897                 SLV2Value       label  = slv2_plugin_class_get_label(pclass);
 898                 info->category = slv2_value_as_string(label);
 899
 900                 SLV2Value author_name = slv2_plugin_get_author_name(p);
 901                 info->creator = author_name ? string(slv2_value_as_string(author_name)) : "Unknown";
 902                 slv2_value_free(author_name);
 903
 904                 info->path = "/NOPATH"; // Meaningless for LV2
 905
 906                 info->n_inputs.set_audio(
 907                         slv2_plugin_get_num_ports_of_class(
 908                                 p, world->input_class, world->audio_class, NULL));
 909                 info->n_inputs.set_midi(
 910                         slv2_plugin_get_num_ports_of_class(
 911                                 p, world->input_class, world->event_class, NULL));
 912
 913                 info->n_outputs.set_audio(
 914                         slv2_plugin_get_num_ports_of_class(
 915                                 p, world->output_class, world->audio_class, NULL));
 916                 info->n_outputs.set_midi(
 917                         slv2_plugin_get_num_ports_of_class(
 918                                 p, world->output_class, world->event_class, NULL));
 919
 920                 info->unique_id = slv2_value_as_uri(slv2_plugin_get_uri(p));
 921                 info->index     = 0; // Meaningless for LV2
 922
 923                 plugs->push_back(info);
 924         }
 925
 926         cerr << "Done LV2 discovery" << endl;
 927
 928         return plugs;
 929 }