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 "rdff.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 struct PersistValue {
 300         inline PersistValue(uint32_t k, const void* v, size_t s, uint32_t t, uint32_t f)
 301                 : key(k), value(v), size(s), type(t), flags(f)
 302         {}
 303
 304         const uint32_t key;
 305         const void*    value;
 306         const size_t   size;
 307         const uint32_t type;
 308         const bool     flags;
 309 };
 310
 311 struct PersistState {
 312         PersistState(URIMap& map) : uri_map(map) {}
 313
 314         typedef std::map<uint32_t, std::string>  URIs;
 315         typedef std::map<uint32_t, PersistValue> Values;
 316
 317         uint32_t file_id_to_runtime_id(uint32_t file_id) const {
 318                 URIs::const_iterator i = uris.find(file_id);
 319                 if (i == uris.end()) {
 320                         error << "LV2 state refers to undefined URI ID" << endmsg;
 321                         return 0;
 322                 }
 323                 return uri_map.uri_to_id(NULL, i->second.c_str());
 324         }
 325
 326         int add_uri(uint32_t file_id, const char* str) {
 327                 // TODO: check for clashes (invalid file)
 328                 uris.insert(make_pair(file_id, str));
 329                 return 0;
 330         }
 331
 332         int add_value(uint32_t    file_key,
 333                       const void* value,
 334                       size_t      size,
 335                       uint32_t    file_type,
 336                       uint32_t    flags) {
 337                 const uint32_t key  = file_id_to_runtime_id(file_key);
 338                 const uint32_t type = file_id_to_runtime_id(file_type);
 339                 if (!key || !type) {
 340                         return 1;
 341                 }
 342
 343                 Values::const_iterator i = values.find(key);
 344                 if (i != values.end()) {
 345                         error << "LV2 state contains duplicate keys" << endmsg;
 346                         return 1;
 347                 } else {
 348                         void* value_copy = malloc(size);
 349                         memcpy(value_copy, value, size); // FIXME: leak
 350                         values.insert(
 351                                 make_pair(key,
 352                                           PersistValue(key, value_copy, size, type, flags)));
 353                         return 0;
 354                 }
 355         }
 356
 357         URIMap& uri_map;
 358         URIs    uris;
 359         Values  values;
 360 };
 361
 362 int
 363 LV2Plugin::lv2_persist_store_callback(void*       callback_data,
 364                                       uint32_t    key,
 365                                       const void* value,
 366                                       size_t      size,
 367                                       uint32_t    type,
 368                                       uint32_t    flags)
 369 {
 370         DEBUG_TRACE(DEBUG::LV2, string_compose("persist store %1\n",
 371                                                _uri_map.id_to_uri(NULL, key)));
 372
 373         PersistState* state = (PersistState*)callback_data;
 374         state->add_uri(key,  _uri_map.id_to_uri(NULL, key));
 375         state->add_uri(type, _uri_map.id_to_uri(NULL, type));
 376         return state->add_value(key, value, size, type, flags);
 377 }
 378
 379 const void*
 380 LV2Plugin::lv2_persist_retrieve_callback(void*     callback_data,
 381                                          uint32_t  key,
 382                                          size_t*   size,
 383                                          uint32_t* type,
 384                                          uint32_t* flags)
 385 {
 386         PersistState* state = (PersistState*)callback_data;
 387         PersistState::Values::const_iterator i = state->values.find(key);
 388         if (i == state->values.end()) {
 389                 warning << "LV2 plugin attempted to retrieve nonexistent key: "
 390                         << _uri_map.id_to_uri(NULL, key) << endmsg;
 391                 return NULL;
 392         }
 393         *size = i->second.size;
 394         *type = i->second.type;
 395         *flags = LV2_PERSIST_IS_POD | LV2_PERSIST_IS_PORTABLE; // FIXME
 396         DEBUG_TRACE(DEBUG::LV2, string_compose(
 397                             "persist retrieve %1 = %s (size: %u, type: %u)\n",
 398                             _uri_map.id_to_uri(NULL, key), i->second.value, *size, *type));
 399         return i->second.value;
 400 }
 401
 402 void
 403 LV2Plugin::add_state(XMLNode* root) const
 404 {
 405         XMLNode*    child;
 406         char        buf[16];
 407         LocaleGuard lg(X_("POSIX"));
 408
 409         for (uint32_t i = 0; i < parameter_count(); ++i) {
 410                 if (parameter_is_input(i) && parameter_is_control(i)) {
 411                         child = new XMLNode("Port");
 412                         child->add_property("symbol", port_symbol(i));
 413                         snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
 414                         child->add_property("value", string(buf));
 415                         root->add_child_nocopy(*child);
 416                 }
 417         }
 418
 419         if (_supports_persist) {
 420                 // Create state directory for this plugin instance
 421                 const std::string state_filename = _id.to_s() + ".rdff";
 422                 const std::string state_path     = Glib::build_filename(
 423                         _session.plugins_dir(), state_filename);
 424
 425                 cout << "Saving LV2 plugin state to " << state_path << endl;
 426
 427                 // Get LV2 Persist extension data from plugin instance
 428                 LV2_Persist* persist = (LV2_Persist*)slv2_instance_get_extension_data(
 429                         _instance, "http://lv2plug.in/ns/ext/persist");
 430                 if (!persist) {
 431                         warning << string_compose(
 432                             _("Plugin \"%1\% failed to return LV2 persist data"),
 433                             unique_id());
 434                         return;
 435                 }
 436
 437                 // Save plugin state to state object
 438                 PersistState state(_uri_map);
 439                 persist->save(_instance->lv2_handle,
 440                               &LV2Plugin::lv2_persist_store_callback,
 441                               &state);
 442
 443                 // Open state file
 444                 RDFF file = rdff_open(state_path.c_str(), true);
 445
 446                 // Write all referenced URIs to state file
 447                 for (PersistState::URIs::const_iterator i = state.uris.begin();
 448                      i != state.uris.end(); ++i) {
 449                         rdff_write_uri(file,
 450                                        i->first,
 451                                        i->second.length(),
 452                                        i->second.c_str());
 453                 }
 454
 455                 // Write all values to state file
 456                 for (PersistState::Values::const_iterator i = state.values.begin();
 457                      i != state.values.end(); ++i) {
 458                         const uint32_t      key = i->first;
 459                         const PersistValue& val = i->second;
 460                         rdff_write_triple(file,
 461                                           0,
 462                                           key,
 463                                           val.type,
 464                                           val.size,
 465                                           val.value);
 466                 }
 467
 468                 // Close state file
 469                 rdff_close(file);
 470
 471                 root->add_property("state-file", state_filename);
 472         }
 473 }
 474
 475 static inline SLV2Value
 476 get_value(SLV2Plugin p, SLV2Value subject, SLV2Value predicate)
 477 {
 478         SLV2Values vs = slv2_plugin_get_value_for_subject(p, subject, predicate);
 479         return vs ? slv2_values_get_at(vs, 0) : NULL;
 480 }
 481
 482 void
 483 LV2Plugin::find_presets()
 484 {
 485         SLV2Value dc_title       = slv2_value_new_uri(_world.world, NS_DC   "title");
 486         SLV2Value pset_hasPreset = slv2_value_new_uri(_world.world, NS_PSET "hasPreset");
 487
 488         SLV2Values presets = slv2_plugin_get_value(_plugin, pset_hasPreset);
 489         for (unsigned i = 0; i < slv2_values_size(presets); ++i) {
 490                 SLV2Value preset = slv2_values_get_at(presets, i);
 491                 SLV2Value name   = get_value(_plugin, preset, dc_title);
 492                 if (name) {
 493                         _presets.insert(std::make_pair(slv2_value_as_string(preset),
 494                                                        PresetRecord(
 495                                                            slv2_value_as_string(preset),
 496                                                            slv2_value_as_string(name))));
 497                 } else {
 498                         warning << string_compose(
 499                             _("Plugin \"%1\% preset \"%2%\" is missing a dc:title\n"),
 500                             unique_id(), slv2_value_as_string(preset));
 501                 }
 502         }
 503         slv2_values_free(presets);
 504
 505         slv2_value_free(pset_hasPreset);
 506         slv2_value_free(dc_title);
 507 }
 508
 509 bool
 510 LV2Plugin::load_preset(PresetRecord r)
 511 {
 512         Plugin::load_preset(r);
 513
 514 #ifdef HAVE_NEW_SLV2
 515         // New (>= 0.7.0) slv2 no longer supports SPARQL, but exposes blank nodes
 516         // so querying ports is possible with the simple/fast API
 517         SLV2Value lv2_port   = slv2_value_new_uri(_world.world, NS_LV2 "port");
 518         SLV2Value lv2_symbol = slv2_value_new_uri(_world.world, NS_LV2 "symbol");
 519         SLV2Value pset_value = slv2_value_new_uri(_world.world, NS_PSET "value");
 520         SLV2Value preset     = slv2_value_new_uri(_world.world, r.uri.c_str());
 521
 522         SLV2Values ports = slv2_plugin_get_value_for_subject(_plugin, preset, lv2_port);
 523         for (unsigned i = 0; i < slv2_values_size(ports); ++i) {
 524                 SLV2Value port   = slv2_values_get_at(ports, i);
 525                 SLV2Value symbol = get_value(_plugin, port, lv2_symbol);
 526                 SLV2Value value  = get_value(_plugin, port, pset_value);
 527                 if (value && slv2_value_is_float(value)) {
 528                         set_parameter(_port_indices[slv2_value_as_string(symbol)],
 529                                       slv2_value_as_float(value));
 530                 }
 531         }
 532         slv2_values_free(ports);
 533
 534         slv2_value_free(preset);
 535         slv2_value_free(pset_value);
 536         slv2_value_free(lv2_symbol);
 537         slv2_value_free(lv2_port);
 538 #else
 539         const string query = string(
 540                 "PREFIX lv2p: <http://lv2plug.in/ns/dev/presets#>\n"
 541                 "PREFIX dc:  <http://dublincore.org/documents/dcmi-namespace/>\n"
 542                 "SELECT ?sym ?val WHERE { <") + r.uri + "> lv2:port ?port . "
 543             " ?port lv2:symbol ?sym ; lv2p:value ?val . }";
 544         SLV2Results values = slv2_plugin_query_sparql(_plugin, query.c_str());
 545         for (; !slv2_results_finished(values); slv2_results_next(values)) {
 546                 SLV2Value sym = slv2_results_get_binding_value(values, 0);
 547                 SLV2Value val = slv2_results_get_binding_value(values, 1);
 548                 if (slv2_value_is_float(val)) {
 549                         uint32_t index = _port_indices[slv2_value_as_string(sym)];
 550                         set_parameter(index, slv2_value_as_float(val));
 551                 }
 552         }
 553         slv2_results_free(values);
 554 #endif
 555         return true;
 556 }
 557
 558 std::string
 559 LV2Plugin::do_save_preset(string /*name*/)
 560 {
 561         return "";
 562 }
 563
 564 void
 565 LV2Plugin::do_remove_preset(string /*name*/)
 566 {}
 567
 568 bool
 569 LV2Plugin::has_editor() const
 570 {
 571         return _ui != NULL;
 572 }
 573
 574 int
 575 LV2Plugin::set_state(const XMLNode& node, int version)
 576 {
 577         XMLNodeList          nodes;
 578         const XMLProperty*   prop;
 579         XMLNodeConstIterator iter;
 580         XMLNode*             child;
 581         const char*          sym;
 582         const char*          value;
 583         uint32_t             port_id;
 584         LocaleGuard          lg(X_("POSIX"));
 585
 586         if (node.name() != state_node_name()) {
 587                 error << _("Bad node sent to LV2Plugin::set_state") << endmsg;
 588                 return -1;
 589         }
 590
 591         if (version < 3000) {
 592                 nodes = node.children("port");
 593         } else {
 594                 nodes = node.children("Port");
 595         }
 596
 597         for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
 598
 599                 child = *iter;
 600
 601                 if ((prop = child->property("symbol")) != 0) {
 602                         sym = prop->value().c_str();
 603                 } else {
 604                         warning << _("LV2: port has no symbol, ignored") << endmsg;
 605                         continue;
 606                 }
 607
 608                 map<string, uint32_t>::iterator i = _port_indices.find(sym);
 609
 610                 if (i != _port_indices.end()) {
 611                         port_id = i->second;
 612                 } else {
 613                         warning << _("LV2: port has unknown index, ignored") << endmsg;
 614                         continue;
 615                 }
 616
 617                 if ((prop = child->property("value")) != 0) {
 618                         value = prop->value().c_str();
 619                 } else {
 620                         warning << _("LV2: port has no value, ignored") << endmsg;
 621                         continue;
 622                 }
 623
 624                 set_parameter(port_id, atof(value));
 625         }
 626
 627         if ((prop = node.property("state-file")) != 0) {
 628                 std::string state_path = Glib::build_filename(_session.plugins_dir(),
 629                                                               prop->value());
 630
 631                 // Get LV2 Persist extension data from plugin instance
 632                 LV2_Persist* persist = (LV2_Persist*)slv2_instance_get_extension_data(
 633                         _instance, "http://lv2plug.in/ns/ext/persist");
 634                 if (persist) {
 635                         cout << "Loading LV2 state from " << state_path << endl;
 636                         RDFF file = rdff_open(state_path.c_str(), false);
 637
 638                         PersistState state(_uri_map);
 639
 640                         // Load file into state object
 641                         RDFFChunk* chunk = (RDFFChunk*)malloc(sizeof(RDFFChunk));
 642                         chunk->size = 0;
 643                         while (!rdff_read_chunk(file, &chunk)) {
 644                                 if (rdff_chunk_is_uri(chunk)) {
 645                                         RDFFURIChunk* body = (RDFFURIChunk*)chunk->data;
 646                                         printf("READ URI %u: %s\n", body->id, body->uri);
 647                                         state.add_uri(body->id, body->uri);
 648                                 } else if (rdff_chunk_is_triple(chunk)) {
 649                                         RDFFTripleChunk* body = (RDFFTripleChunk*)chunk->data;
 650                                         printf("READ VAL %u = %s (size: %u type: %u)\n",
 651                                                body->predicate, body->object,
 652                                                body->object_size, body->object_type);
 653                                         state.add_value(body->predicate,
 654                                                         body->object,
 655                                                         body->object_size,
 656                                                         body->object_type,
 657                                                         LV2_PERSIST_IS_POD | LV2_PERSIST_IS_PORTABLE);
 658                                 }
 659                         }
 660                         free(chunk);
 661
 662                         persist->restore(_instance->lv2_handle,
 663                                          &LV2Plugin::lv2_persist_retrieve_callback,
 664                                          &state);
 665                         rdff_close(file);
 666                 } else {
 667                         warning << string_compose(
 668                             _("Plugin \"%1\% failed to return LV2 persist data"),
 669                             unique_id());
 670                 }
 671         }
 672
 673         latency_compute_run();
 674
 675         return Plugin::set_state(node, version);
 676 }
 677
 678 int
 679 LV2Plugin::get_parameter_descriptor(uint32_t which, ParameterDescriptor& desc) const
 680 {
 681         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, which);
 682
 683         SLV2Value def, min, max;
 684         slv2_port_get_range(_plugin, port, &def, &min, &max);
 685
 686         desc.integer_step = slv2_port_has_property(_plugin, port, _world.integer);
 687         desc.toggled      = slv2_port_has_property(_plugin, port, _world.toggled);
 688         desc.logarithmic  = slv2_port_has_property(_plugin, port, _world.logarithmic);
 689         desc.sr_dependent = slv2_port_has_property(_plugin, port, _world.srate);
 690         desc.label        = slv2_value_as_string(slv2_port_get_name(_plugin, port));
 691         desc.lower        = min ? slv2_value_as_float(min) : 0.0f;
 692         desc.upper        = max ? slv2_value_as_float(max) : 1.0f;
 693         desc.min_unbound  = false; // TODO: LV2 extension required
 694         desc.max_unbound  = false; // TODO: LV2 extension required
 695
 696         if (desc.integer_step) {
 697                 desc.step      = 1.0;
 698                 desc.smallstep = 0.1;
 699                 desc.largestep = 10.0;
 700         } else {
 701                 const float delta = desc.upper - desc.lower;
 702                 desc.step      = delta / 1000.0f;
 703                 desc.smallstep = delta / 10000.0f;
 704                 desc.largestep = delta / 10.0f;
 705         }
 706
 707         slv2_value_free(def);
 708         slv2_value_free(min);
 709         slv2_value_free(max);
 710
 711         return 0;
 712 }
 713
 714 string
 715 LV2Plugin::describe_parameter(Evoral::Parameter which)
 716 {
 717         if (( which.type() == PluginAutomation) && ( which.id() < parameter_count()) ) {
 718                 SLV2Value name = slv2_port_get_name(_plugin,
 719                                                     slv2_plugin_get_port_by_index(_plugin, which.id()));
 720                 string ret(slv2_value_as_string(name));
 721                 slv2_value_free(name);
 722                 return ret;
 723         } else {
 724                 return "??";
 725         }
 726 }
 727
 728 framecnt_t
 729 LV2Plugin::signal_latency() const
 730 {
 731         if (_latency_control_port) {
 732                 return (framecnt_t)floor(*_latency_control_port);
 733         } else {
 734                 return 0;
 735         }
 736 }
 737
 738 set<Evoral::Parameter>
 739 LV2Plugin::automatable() const
 740 {
 741         set<Evoral::Parameter> ret;
 742
 743         for (uint32_t i = 0; i < parameter_count(); ++i) {
 744                 if (parameter_is_input(i) && parameter_is_control(i)) {
 745                         ret.insert(ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
 746                 }
 747         }
 748
 749         return ret;
 750 }
 751
 752 void
 753 LV2Plugin::activate()
 754 {
 755         DEBUG_TRACE(DEBUG::LV2, string_compose("%1 activate\n", name()));
 756
 757         if (!_was_activated) {
 758                 slv2_instance_activate(_instance);
 759                 _was_activated = true;
 760         }
 761 }
 762
 763 void
 764 LV2Plugin::deactivate()
 765 {
 766         DEBUG_TRACE(DEBUG::LV2, string_compose("%1 deactivate\n", name()));
 767
 768         if (_was_activated) {
 769                 slv2_instance_deactivate(_instance);
 770                 _was_activated = false;
 771         }
 772 }
 773
 774 void
 775 LV2Plugin::cleanup()
 776 {
 777         DEBUG_TRACE(DEBUG::LV2, string_compose("%1 cleanup\n", name()));
 778
 779         activate();
 780         deactivate();
 781         slv2_instance_free(_instance);
 782         _instance = NULL;
 783 }
 784
 785 int
 786 LV2Plugin::connect_and_run(BufferSet& bufs,
 787         ChanMapping in_map, ChanMapping out_map,
 788         pframes_t nframes, framecnt_t offset)
 789 {
 790         DEBUG_TRACE(DEBUG::LV2, string_compose("%1 run %2 offset %3\n", name(), nframes, offset));
 791         Plugin::connect_and_run(bufs, in_map, out_map, nframes, offset);
 792
 793         cycles_t then = get_cycles();
 794
 795         uint32_t audio_in_index  = 0;
 796         uint32_t audio_out_index = 0;
 797         uint32_t midi_in_index   = 0;
 798         uint32_t midi_out_index  = 0;
 799         for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
 800                 if (parameter_is_audio(port_index)) {
 801                         if (parameter_is_input(port_index)) {
 802                                 const uint32_t buf_index = in_map.get(DataType::AUDIO, audio_in_index++);
 803                                 slv2_instance_connect_port(_instance, port_index,
 804                                                            bufs.get_audio(buf_index).data(offset));
 805                         } else if (parameter_is_output(port_index)) {
 806                                 const uint32_t buf_index = out_map.get(DataType::AUDIO, audio_out_index++);
 807                                 //cerr << port_index << " : " << " AUDIO OUT " << buf_index << endl;
 808                                 slv2_instance_connect_port(_instance, port_index,
 809                                                            bufs.get_audio(buf_index).data(offset));
 810                         }
 811                 } else if (parameter_is_midi(port_index)) {
 812                         if (parameter_is_input(port_index)) {
 813                                 const uint32_t buf_index = in_map.get(DataType::MIDI, midi_in_index++);
 814                                 slv2_instance_connect_port(_instance, port_index,
 815                                                            bufs.get_lv2_midi(true, buf_index).data());
 816                         } else if (parameter_is_output(port_index)) {
 817                                 const uint32_t buf_index = out_map.get(DataType::MIDI, midi_out_index++);
 818                                 slv2_instance_connect_port(_instance, port_index,
 819                                                            bufs.get_lv2_midi(false, buf_index).data());
 820                         }
 821                 } else if (!parameter_is_control(port_index)) {
 822                         // Optional port (it'd better be if we've made it this far...)
 823                         slv2_instance_connect_port(_instance, port_index, NULL);
 824                 }
 825         }
 826
 827         run(nframes);
 828
 829         midi_out_index = 0;
 830         for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
 831                 if (parameter_is_midi(port_index) && parameter_is_output(port_index)) {
 832                         const uint32_t buf_index = out_map.get(DataType::MIDI, midi_out_index++);
 833                         bufs.flush_lv2_midi(true, buf_index);
 834                 }
 835         }
 836
 837         cycles_t now = get_cycles();
 838         set_cycles((uint32_t)(now - then));
 839
 840         return 0;
 841 }
 842
 843 bool
 844 LV2Plugin::parameter_is_control(uint32_t param) const
 845 {
 846         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
 847         return slv2_port_is_a(_plugin, port, _world.control_class);
 848 }
 849
 850 bool
 851 LV2Plugin::parameter_is_audio(uint32_t param) const
 852 {
 853         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
 854         return slv2_port_is_a(_plugin, port, _world.audio_class);
 855 }
 856
 857 bool
 858 LV2Plugin::parameter_is_midi(uint32_t param) const
 859 {
 860         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
 861         return slv2_port_is_a(_plugin, port, _world.event_class);
 862         //      && slv2_port_supports_event(_plugin, port, _world.midi_class);
 863 }
 864
 865 bool
 866 LV2Plugin::parameter_is_output(uint32_t param) const
 867 {
 868         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
 869         return slv2_port_is_a(_plugin, port, _world.output_class);
 870 }
 871
 872 bool
 873 LV2Plugin::parameter_is_input(uint32_t param) const
 874 {
 875         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
 876         return slv2_port_is_a(_plugin, port, _world.input_class);
 877 }
 878
 879 void
 880 LV2Plugin::print_parameter(uint32_t param, char* buf, uint32_t len) const
 881 {
 882         if (buf && len) {
 883                 if (param < parameter_count()) {
 884                         snprintf(buf, len, "%.3f", get_parameter(param));
 885                 } else {
 886                         strcat(buf, "0");
 887                 }
 888         }
 889 }
 890
 891 void
 892 LV2Plugin::run(pframes_t nframes)
 893 {
 894         for (uint32_t i = 0; i < parameter_count(); ++i) {
 895                 if (parameter_is_control(i) && parameter_is_input(i)) {
 896                         _control_data[i] = _shadow_data[i];
 897                 }
 898         }
 899
 900         slv2_instance_run(_instance, nframes);
 901 }
 902
 903 void
 904 LV2Plugin::latency_compute_run()
 905 {
 906         if (!_latency_control_port) {
 907                 return;
 908         }
 909
 910         // Run the plugin so that it can set its latency parameter
 911
 912         activate();
 913
 914         uint32_t port_index = 0;
 915         uint32_t in_index   = 0;
 916         uint32_t out_index  = 0;
 917
 918         const framecnt_t bufsize = 1024;
 919         float            buffer[bufsize];
 920
 921         memset(buffer, 0, sizeof(float) * bufsize);
 922
 923         // FIXME: Ensure plugins can handle in-place processing
 924
 925         port_index = 0;
 926
 927         while (port_index < parameter_count()) {
 928                 if (parameter_is_audio(port_index)) {
 929                         if (parameter_is_input(port_index)) {
 930                                 slv2_instance_connect_port(_instance, port_index, buffer);
 931                                 in_index++;
 932                         } else if (parameter_is_output(port_index)) {
 933                                 slv2_instance_connect_port(_instance, port_index, buffer);
 934                                 out_index++;
 935                         }
 936                 }
 937                 port_index++;
 938         }
 939
 940         run(bufsize);
 941         deactivate();
 942 }
 943
 944 LV2World::LV2World()
 945         : world(slv2_world_new())
 946 {
 947         slv2_world_load_all(world);
 948         input_class     = slv2_value_new_uri(world, SLV2_PORT_CLASS_INPUT);
 949         output_class    = slv2_value_new_uri(world, SLV2_PORT_CLASS_OUTPUT);
 950         control_class   = slv2_value_new_uri(world, SLV2_PORT_CLASS_CONTROL);
 951         audio_class     = slv2_value_new_uri(world, SLV2_PORT_CLASS_AUDIO);
 952         event_class     = slv2_value_new_uri(world, SLV2_PORT_CLASS_EVENT);
 953         midi_class      = slv2_value_new_uri(world, SLV2_EVENT_CLASS_MIDI);
 954         in_place_broken = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "inPlaceBroken");
 955         integer         = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "integer");
 956         toggled         = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "toggled");
 957         srate           = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "sampleRate");
 958         gtk_gui         = slv2_value_new_uri(world, NS_UI "GtkUI");
 959         external_gui    = slv2_value_new_uri(world, NS_UI "external");
 960         logarithmic     = slv2_value_new_uri(world, "http://lv2plug.in/ns/dev/extportinfo#logarithmic");
 961 }
 962
 963 LV2World::~LV2World()
 964 {
 965         slv2_value_free(input_class);
 966         slv2_value_free(output_class);
 967         slv2_value_free(control_class);
 968         slv2_value_free(audio_class);
 969         slv2_value_free(event_class);
 970         slv2_value_free(midi_class);
 971         slv2_value_free(in_place_broken);
 972 }
 973
 974 LV2PluginInfo::LV2PluginInfo (void* lv2_world, void* slv2_plugin)
 975         : _lv2_world(lv2_world)
 976         , _slv2_plugin(slv2_plugin)
 977 {
 978         type = ARDOUR::LV2;
 979 }
 980
 981 LV2PluginInfo::~LV2PluginInfo()
 982 {}
 983
 984 PluginPtr
 985 LV2PluginInfo::load(Session& session)
 986 {
 987         try {
 988                 PluginPtr plugin;
 989
 990                 plugin.reset(new LV2Plugin(session.engine(), session,
 991                                            *(LV2World*)_lv2_world, (SLV2Plugin)_slv2_plugin,
 992                                            session.frame_rate()));
 993
 994                 plugin->set_info(PluginInfoPtr(new LV2PluginInfo(*this)));
 995                 return plugin;
 996         } catch (failed_constructor& err) {
 997                 return PluginPtr((Plugin*)0);
 998         }
 999
1000         return PluginPtr();
1001 }
1002
1003 PluginInfoList*
1004 LV2PluginInfo::discover(void* lv2_world)
1005 {
1006         PluginInfoList* plugs   = new PluginInfoList;
1007         LV2World*       world   = (LV2World*)lv2_world;
1008         SLV2Plugins     plugins = slv2_world_get_all_plugins(world->world);
1009
1010         cerr << "LV2: Discovering " << slv2_plugins_size(plugins) << " plugins" << endl;
1011
1012         for (unsigned i = 0; i < slv2_plugins_size(plugins); ++i) {
1013                 SLV2Plugin       p = slv2_plugins_get_at(plugins, i);
1014                 LV2PluginInfoPtr info(new LV2PluginInfo(lv2_world, p));
1015
1016                 SLV2Value name = slv2_plugin_get_name(p);
1017
1018                 if (!name) {
1019                         cerr << "LV2: invalid plugin\n";
1020                         continue;
1021                 }
1022
1023                 info->type = LV2;
1024
1025                 info->name = string(slv2_value_as_string(name));
1026                 slv2_value_free(name);
1027
1028                 SLV2PluginClass pclass = slv2_plugin_get_class(p);
1029                 SLV2Value       label  = slv2_plugin_class_get_label(pclass);
1030                 info->category = slv2_value_as_string(label);
1031
1032                 SLV2Value author_name = slv2_plugin_get_author_name(p);
1033                 info->creator = author_name ? string(slv2_value_as_string(author_name)) : "Unknown";
1034                 slv2_value_free(author_name);
1035
1036                 info->path = "/NOPATH"; // Meaningless for LV2
1037
1038                 info->n_inputs.set_audio(
1039                         slv2_plugin_get_num_ports_of_class(
1040                                 p, world->input_class, world->audio_class, NULL));
1041                 info->n_inputs.set_midi(
1042                         slv2_plugin_get_num_ports_of_class(
1043                                 p, world->input_class, world->event_class, NULL));
1044
1045                 info->n_outputs.set_audio(
1046                         slv2_plugin_get_num_ports_of_class(
1047                                 p, world->output_class, world->audio_class, NULL));
1048                 info->n_outputs.set_midi(
1049                         slv2_plugin_get_num_ports_of_class(
1050                                 p, world->output_class, world->event_class, NULL));
1051
1052                 info->unique_id = slv2_value_as_uri(slv2_plugin_get_uri(p));
1053                 info->index     = 0; // Meaningless for LV2
1054
1055                 plugs->push_back(info);
1056         }
1057
1058         cerr << "Done LV2 discovery" << endl;
1059
1060         return plugs;
1061 }