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/stl_delete.h"
  34 #include "pbd/xml++.h"
  35
  36 #include "libardour-config.h"
  37
  38 #include "ardour/ardour.h"
  39 #include "ardour/audio_buffer.h"
  40 #include "ardour/audioengine.h"
  41 #include "ardour/debug.h"
  42 #include "ardour/lv2_event_buffer.h"
  43 #include "ardour/lv2_plugin.h"
  44 #include "ardour/session.h"
  45
  46 #include "i18n.h"
  47 #include <locale.h>
  48
  49 #include "lv2ext/lv2_files.h"
  50 #include "lv2ext/lv2_persist.h"
  51 #include "rdff.h"
  52 #ifdef HAVE_SUIL
  53 #include <suil/suil.h>
  54 #endif
  55
  56 #define NS_DC   "http://dublincore.org/documents/dcmi-namespace/"
  57 #define NS_LV2  "http://lv2plug.in/ns/lv2core#"
  58 #define NS_PSET "http://lv2plug.in/ns/dev/presets#"
  59 #define NS_UI   "http://lv2plug.in/ns/extensions/ui#"
  60
  61 using namespace std;
  62 using namespace ARDOUR;
  63 using namespace PBD;
  64
  65 URIMap LV2Plugin::_uri_map;
  66 uint32_t LV2Plugin::_midi_event_type = _uri_map.uri_to_id(
  67         "http://lv2plug.in/ns/ext/event",
  68         "http://lv2plug.in/ns/ext/midi#MidiEvent");
  69
  70 LV2Plugin::LV2Plugin (AudioEngine& engine,
  71                       Session&     session,
  72                       LV2World&    world,
  73                       SLV2Plugin   plugin,
  74                       framecnt_t   rate)
  75         : Plugin(engine, session)
  76         , _world(world)
  77         , _features(NULL)
  78         , _insert_id("0")
  79 {
  80         init(world, plugin, rate);
  81 }
  82
  83 LV2Plugin::LV2Plugin (const LV2Plugin& other)
  84         : Plugin(other)
  85         , _world(other._world)
  86         , _features(NULL)
  87         , _insert_id(other._insert_id)
  88 {
  89         init(other._world, other._plugin, other._sample_rate);
  90
  91         for (uint32_t i = 0; i < parameter_count(); ++i) {
  92                 _control_data[i] = other._shadow_data[i];
  93                 _shadow_data[i]  = other._shadow_data[i];
  94         }
  95 }
  96
  97 void
  98 LV2Plugin::init(LV2World& world, SLV2Plugin plugin, framecnt_t rate)
  99 {
 100         DEBUG_TRACE(DEBUG::LV2, "init\n");
 101
 102         _world                = world;
 103         _plugin               = plugin;
 104         _ui                   = NULL;
 105         _ui_type              = NULL;
 106         _control_data         = 0;
 107         _shadow_data          = 0;
 108         _latency_control_port = 0;
 109         _was_activated        = false;
 110
 111         _instance_access_feature.URI  = "http://lv2plug.in/ns/ext/instance-access";
 112         _data_access_feature.URI      = "http://lv2plug.in/ns/ext/data-access";
 113         _path_support_feature.URI     = LV2_FILES_PATH_SUPPORT_URI;
 114         _new_file_support_feature.URI = LV2_FILES_NEW_FILE_SUPPORT_URI;
 115         _persist_feature.URI          = "http://lv2plug.in/ns/ext/persist";
 116         _persist_feature.data         = NULL;
 117
 118         SLV2Value persist_uri = slv2_value_new_uri(_world.world, _persist_feature.URI);
 119         _supports_persist = slv2_plugin_has_feature(plugin, persist_uri);
 120         slv2_value_free(persist_uri);
 121
 122         _features    = (LV2_Feature**)malloc(sizeof(LV2_Feature*) * 7);
 123         _features[0] = &_instance_access_feature;
 124         _features[1] = &_data_access_feature;
 125         _features[2] = &_path_support_feature;
 126         _features[3] = &_new_file_support_feature;
 127         _features[4] = &_persist_feature;
 128         _features[5] = _uri_map.feature();
 129         _features[6] = NULL;
 130
 131         LV2_Files_Path_Support* path_support = (LV2_Files_Path_Support*)malloc(
 132                 sizeof(LV2_Files_Path_Support));
 133         path_support->host_data = this;
 134         path_support->abstract_path = &lv2_files_abstract_path;
 135         path_support->absolute_path = &lv2_files_absolute_path;
 136         _path_support_feature.data = path_support;
 137
 138         LV2_Files_New_File_Support* new_file_support = (LV2_Files_New_File_Support*)malloc(
 139                 sizeof(LV2_Files_New_File_Support));
 140         new_file_support->host_data = this;
 141         new_file_support->new_file_path = &lv2_files_new_file_path;
 142         _new_file_support_feature.data = new_file_support;
 143
 144         _instance = slv2_plugin_instantiate(plugin, rate, _features);
 145         _name     = slv2_plugin_get_name(plugin);
 146         _author   = slv2_plugin_get_author_name(plugin);
 147
 148         if (_instance == 0) {
 149                 error << _("LV2: Failed to instantiate plugin ")
 150                       << slv2_value_as_string(slv2_plugin_get_uri(plugin)) << endmsg;
 151                 throw failed_constructor();
 152         }
 153
 154         _instance_access_feature.data              = (void*)_instance->lv2_handle;
 155         _data_access_extension_data.extension_data = _instance->lv2_descriptor->extension_data;
 156         _data_access_feature.data                  = &_data_access_extension_data;
 157
 158         if (slv2_plugin_has_feature(plugin, world.in_place_broken)) {
 159                 error << string_compose(
 160                     _("LV2: \"%1\" cannot be used, since it cannot do inplace processing"),
 161                     slv2_value_as_string(_name)) << endmsg;
 162                 slv2_value_free(_name);
 163                 slv2_value_free(_author);
 164                 throw failed_constructor();
 165         }
 166
 167         _sample_rate = rate;
 168
 169         const uint32_t num_ports    = slv2_plugin_get_num_ports(plugin);
 170         const bool     latent       = slv2_plugin_has_latency(plugin);
 171         const uint32_t latency_port = (latent)
 172             ? slv2_plugin_get_latency_port_index(plugin)
 173                 : 0;
 174
 175         _control_data = new float[num_ports];
 176         _shadow_data  = new float[num_ports];
 177         _defaults     = new float[num_ports];
 178
 179         for (uint32_t i = 0; i < num_ports; ++i) {
 180                 SLV2Port  port = slv2_plugin_get_port_by_index(plugin, i);
 181                 SLV2Value sym  = slv2_port_get_symbol(_plugin, port);
 182
 183                 // Store index in map so we can look up index by symbol
 184                 _port_indices.insert(std::make_pair(slv2_value_as_string(sym), i));
 185
 186                 // Get range and default value if applicable
 187                 if (parameter_is_control(i)) {
 188                         SLV2Value def;
 189                         slv2_port_get_range(plugin, port, &def, NULL, NULL);
 190                         _defaults[i] = def ? slv2_value_as_float(def) : 0.0f;
 191                         slv2_value_free(def);
 192
 193                         slv2_instance_connect_port(_instance, i, &_control_data[i]);
 194
 195                         if (latent && ( i == latency_port) ) {
 196                                 _latency_control_port  = &_control_data[i];
 197                                 *_latency_control_port = 0;
 198                         }
 199
 200                         if (parameter_is_input(i)) {
 201                                 _shadow_data[i] = default_value(i);
 202                         }
 203                 } else {
 204                         _defaults[i] = 0.0f;
 205                 }
 206         }
 207
 208         SLV2UIs uis = slv2_plugin_get_uis(_plugin);
 209         cerr << name() << " appears to have " << slv2_uis_size(uis) << endl;
 210         if (slv2_uis_size(uis) > 0) {
 211 #if defined(HAVE_NEW_SLV2) and defined(HAVE_SUIL)
 212                 // Look for embeddable UI
 213                 SLV2Value ui_type = NULL;
 214                 SLV2_FOREACH(u, uis) {
 215                         SLV2UI this_ui = slv2_uis_get(uis, u);
 216                         if (slv2_ui_is_supported(this_ui,
 217                                                  suil_ui_supported,
 218                                                  _world.gtk_gui,
 219                                                  &_ui_type)) {
 220                                 // TODO: Multiple UI support
 221                                 _ui = this_ui;
 222                                 break;
 223                         }
 224                 }
 225 #else
 226                 // Look for Gtk native UI
 227                 for (unsigned i = 0; i < slv2_uis_size(uis); ++i) {
 228                         SLV2UI ui = slv2_uis_get_at(uis, i);
 229                         if (slv2_ui_is_a(ui, _world.gtk_gui)) {
 230                                 _ui = ui;
 231                                 break;
 232                         }
 233                 }
 234 #endif
 235
 236                 // If Gtk UI is not available, try to find external UI
 237                 if (!_ui) {
 238                         for (unsigned i = 0; i < slv2_uis_size(uis); ++i) {
 239                                 SLV2UI ui = slv2_uis_get_at(uis, i);
 240                                 if (slv2_ui_is_a(ui, _world.external_gui)) {
 241                                         _ui = ui;
 242                                         break;
 243                                 }
 244                         }
 245                 }
 246         }
 247
 248         latency_compute_run();
 249 }
 250
 251 LV2Plugin::~LV2Plugin ()
 252 {
 253         DEBUG_TRACE(DEBUG::LV2, string_compose("%1 destroy\n", name()));
 254
 255         deactivate();
 256         cleanup();
 257
 258         slv2_instance_free(_instance);
 259         slv2_value_free(_name);
 260         slv2_value_free(_author);
 261         slv2_value_free(_ui_type);
 262
 263         delete [] _control_data;
 264         delete [] _shadow_data;
 265 }
 266
 267 bool
 268 LV2Plugin::is_external_ui() const
 269 {
 270         return slv2_ui_is_a(_ui, _world.external_gui);
 271 }
 272
 273 string
 274 LV2Plugin::unique_id() const
 275 {
 276         return slv2_value_as_uri(slv2_plugin_get_uri(_plugin));
 277 }
 278
 279 float
 280 LV2Plugin::default_value(uint32_t port)
 281 {
 282         return _defaults[port];
 283 }
 284
 285 const char*
 286 LV2Plugin::port_symbol(uint32_t index) const
 287 {
 288         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, index);
 289         if (!port) {
 290                 error << name() << ": Invalid port index " << index << endmsg;
 291         }
 292
 293         SLV2Value sym = slv2_port_get_symbol(_plugin, port);
 294         return slv2_value_as_string(sym);
 295 }
 296
 297 void
 298 LV2Plugin::set_parameter(uint32_t which, float val)
 299 {
 300         DEBUG_TRACE(DEBUG::LV2, string_compose(
 301                             "%1 set parameter %2 to %3\n", name(), which, val));
 302
 303         if (which < slv2_plugin_get_num_ports(_plugin)) {
 304                 _shadow_data[which] = val;
 305         } else {
 306                 warning << string_compose(
 307                     _("Illegal parameter number used with plugin \"%1\". "
 308                       "This is a bug in either %2 or the LV2 plugin <%3>"),
 309                     name(), PROGRAM_NAME, unique_id()) << endmsg;
 310         }
 311
 312         Plugin::set_parameter(which, val);
 313 }
 314
 315 float
 316 LV2Plugin::get_parameter(uint32_t which) const
 317 {
 318         if (parameter_is_input(which)) {
 319                 return (float)_shadow_data[which];
 320         } else {
 321                 return (float)_control_data[which];
 322         }
 323         return 0.0f;
 324 }
 325
 326 uint32_t
 327 LV2Plugin::nth_parameter(uint32_t n, bool& ok) const
 328 {
 329         ok = false;
 330         for (uint32_t c = 0, x = 0; x < slv2_plugin_get_num_ports(_plugin); ++x) {
 331                 if (parameter_is_control(x)) {
 332                         if (c++ == n) {
 333                                 ok = true;
 334                                 return x;
 335                         }
 336                 }
 337         }
 338
 339         return 0;
 340 }
 341
 342 struct PersistValue {
 343         inline PersistValue(uint32_t k, const void* v, size_t s, uint32_t t, uint32_t f)
 344                 : key(k), value(v), size(s), type(t), flags(f)
 345         {}
 346
 347         const uint32_t key;
 348         const void*    value;
 349         const size_t   size;
 350         const uint32_t type;
 351         const bool     flags;
 352 };
 353
 354 struct PersistState {
 355         PersistState(URIMap& map) : uri_map(map) {}
 356
 357         typedef std::map<uint32_t, std::string>  URIs;
 358         typedef std::map<uint32_t, PersistValue> Values;
 359
 360         uint32_t file_id_to_runtime_id(uint32_t file_id) const {
 361                 URIs::const_iterator i = uris.find(file_id);
 362                 if (i == uris.end()) {
 363                         error << "LV2 state refers to undefined URI ID" << endmsg;
 364                         return 0;
 365                 }
 366                 return uri_map.uri_to_id(NULL, i->second.c_str());
 367         }
 368
 369         int add_uri(uint32_t file_id, const char* str) {
 370                 // TODO: check for clashes (invalid file)
 371                 uris.insert(make_pair(file_id, str));
 372                 return 0;
 373         }
 374
 375         int add_value(uint32_t    file_key,
 376                       const void* value,
 377                       size_t      size,
 378                       uint32_t    file_type,
 379                       uint32_t    flags) {
 380                 const uint32_t key  = file_id_to_runtime_id(file_key);
 381                 const uint32_t type = file_id_to_runtime_id(file_type);
 382                 if (!key || !type) {
 383                         return 1;
 384                 }
 385
 386                 Values::const_iterator i = values.find(key);
 387                 if (i != values.end()) {
 388                         error << "LV2 state contains duplicate keys" << endmsg;
 389                         return 1;
 390                 } else {
 391                         void* value_copy = malloc(size);
 392                         memcpy(value_copy, value, size); // FIXME: leak
 393                         values.insert(
 394                                 make_pair(key,
 395                                           PersistValue(key, value_copy, size, type, flags)));
 396                         return 0;
 397                 }
 398         }
 399
 400         URIMap& uri_map;
 401         URIs    uris;
 402         Values  values;
 403 };
 404
 405 int
 406 LV2Plugin::lv2_persist_store_callback(void*       host_data,
 407                                       uint32_t    key,
 408                                       const void* value,
 409                                       size_t      size,
 410                                       uint32_t    type,
 411                                       uint32_t    flags)
 412 {
 413         DEBUG_TRACE(DEBUG::LV2, string_compose(
 414                             "persist store %1 (size: %2, type: %3)\n",
 415                             _uri_map.id_to_uri(NULL, key),
 416                             size,
 417                             _uri_map.id_to_uri(NULL, type)));
 418
 419         PersistState* state = (PersistState*)host_data;
 420         state->add_uri(key,  _uri_map.id_to_uri(NULL, key));
 421         state->add_uri(type, _uri_map.id_to_uri(NULL, type));
 422         return state->add_value(key, value, size, type, flags);
 423 }
 424
 425 const void*
 426 LV2Plugin::lv2_persist_retrieve_callback(void*     host_data,
 427                                          uint32_t  key,
 428                                          size_t*   size,
 429                                          uint32_t* type,
 430                                          uint32_t* flags)
 431 {
 432         PersistState* state = (PersistState*)host_data;
 433         PersistState::Values::const_iterator i = state->values.find(key);
 434         if (i == state->values.end()) {
 435                 warning << "LV2 plugin attempted to retrieve nonexistent key: "
 436                         << _uri_map.id_to_uri(NULL, key) << endmsg;
 437                 return NULL;
 438         }
 439         *size = i->second.size;
 440         *type = i->second.type;
 441         *flags = LV2_PERSIST_IS_POD | LV2_PERSIST_IS_PORTABLE; // FIXME
 442         DEBUG_TRACE(DEBUG::LV2, string_compose(
 443                             "persist retrieve %1 = %2 (size: %3, type: %4)\n",
 444                             _uri_map.id_to_uri(NULL, key),
 445                             i->second.value, *size, *type));
 446         return i->second.value;
 447 }
 448
 449 char*
 450 LV2Plugin::lv2_files_abstract_path(LV2_Files_Host_Data host_data,
 451                                    const char*         absolute_path)
 452 {
 453         LV2Plugin* me = (LV2Plugin*)host_data;
 454         if (me->_insert_id == PBD::ID("0")) {
 455                 return g_strdup(absolute_path);
 456         }
 457
 458         const std::string state_dir = Glib::build_filename(me->_session.plugins_dir(),
 459                                                            me->_insert_id.to_s());
 460
 461         char* ret = NULL;
 462         if (strncmp(absolute_path, state_dir.c_str(), state_dir.length())) {
 463                 ret = g_strdup(absolute_path);
 464         } else {
 465                 const std::string path(absolute_path + state_dir.length() + 1);
 466                 ret = g_strndup(path.c_str(), path.length());
 467         }
 468
 469         DEBUG_TRACE(DEBUG::LV2, string_compose("abstract path %1 => %2\n",
 470                                                absolute_path, ret));
 471
 472         return ret;
 473 }
 474
 475 char*
 476 LV2Plugin::lv2_files_absolute_path(LV2_Files_Host_Data host_data,
 477                                    const char*         abstract_path)
 478 {
 479         LV2Plugin* me = (LV2Plugin*)host_data;
 480         if (me->_insert_id == PBD::ID("0")) {
 481                 return g_strdup(abstract_path);
 482         }
 483
 484         char* ret = NULL;
 485         if (g_path_is_absolute(abstract_path)) {
 486                 ret = g_strdup(abstract_path);
 487         } else {
 488                 const std::string apath(abstract_path);
 489                 const std::string state_dir = Glib::build_filename(me->_session.plugins_dir(),
 490                                                                    me->_insert_id.to_s());
 491                 const std::string path = Glib::build_filename(state_dir,
 492                                                               apath);
 493                 ret = g_strndup(path.c_str(), path.length());
 494         }
 495
 496         DEBUG_TRACE(DEBUG::LV2, string_compose("absolute path %1 => %2\n",
 497                                                abstract_path, ret));
 498
 499         return ret;
 500 }
 501
 502 char*
 503 LV2Plugin::lv2_files_new_file_path(LV2_Files_Host_Data host_data,
 504                                    const char*         relative_path)
 505 {
 506         LV2Plugin* me = (LV2Plugin*)host_data;
 507         if (me->_insert_id == PBD::ID("0")) {
 508                 return g_strdup(relative_path);
 509         }
 510
 511         const std::string state_dir = Glib::build_filename(me->_session.plugins_dir(),
 512                                                            me->_insert_id.to_s());
 513         const std::string path = Glib::build_filename(state_dir,
 514                                                       relative_path);
 515
 516         char* dirname = g_path_get_dirname(path.c_str());
 517         g_mkdir_with_parents(dirname, 0744);
 518         free(dirname);
 519
 520         DEBUG_TRACE(DEBUG::LV2, string_compose("new file path %1 => %2\n",
 521                                                relative_path, path));
 522
 523         return g_strndup(path.c_str(), path.length());
 524 }
 525
 526 void
 527 LV2Plugin::add_state(XMLNode* root) const
 528 {
 529         assert(_insert_id != PBD::ID("0"));
 530
 531         XMLNode*    child;
 532         char        buf[16];
 533         LocaleGuard lg(X_("POSIX"));
 534
 535         for (uint32_t i = 0; i < parameter_count(); ++i) {
 536                 if (parameter_is_input(i) && parameter_is_control(i)) {
 537                         child = new XMLNode("Port");
 538                         child->add_property("symbol", port_symbol(i));
 539                         snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
 540                         child->add_property("value", string(buf));
 541                         root->add_child_nocopy(*child);
 542                 }
 543         }
 544
 545         if (_supports_persist) {
 546                 // Create state directory for this plugin instance
 547                 const std::string state_filename = _insert_id.to_s() + ".rdff";
 548                 const std::string state_path     = Glib::build_filename(
 549                         _session.plugins_dir(), state_filename);
 550
 551                 cout << "Saving LV2 plugin state to " << state_path << endl;
 552
 553                 // Get LV2 Persist extension data from plugin instance
 554                 LV2_Persist* persist = (LV2_Persist*)slv2_instance_get_extension_data(
 555                         _instance, "http://lv2plug.in/ns/ext/persist");
 556                 if (!persist) {
 557                         warning << string_compose(
 558                             _("Plugin \"%1\% failed to return LV2 persist data"),
 559                             unique_id());
 560                         return;
 561                 }
 562
 563                 // Save plugin state to state object
 564                 PersistState state(_uri_map);
 565                 persist->save(_instance->lv2_handle,
 566                               &LV2Plugin::lv2_persist_store_callback,
 567                               &state);
 568
 569                 // Open state file
 570                 RDFF file = rdff_open(state_path.c_str(), true);
 571
 572                 // Write all referenced URIs to state file
 573                 for (PersistState::URIs::const_iterator i = state.uris.begin();
 574                      i != state.uris.end(); ++i) {
 575                         rdff_write_uri(file,
 576                                        i->first,
 577                                        i->second.length(),
 578                                        i->second.c_str());
 579                 }
 580
 581                 // Write all values to state file
 582                 for (PersistState::Values::const_iterator i = state.values.begin();
 583                      i != state.values.end(); ++i) {
 584                         const uint32_t      key = i->first;
 585                         const PersistValue& val = i->second;
 586                         rdff_write_triple(file,
 587                                           0,
 588                                           key,
 589                                           val.type,
 590                                           val.size,
 591                                           val.value);
 592                 }
 593
 594                 // Close state file
 595                 rdff_close(file);
 596
 597                 root->add_property("state-file", state_filename);
 598         }
 599 }
 600
 601 static inline SLV2Value
 602 get_value(SLV2Plugin p, SLV2Value subject, SLV2Value predicate)
 603 {
 604         SLV2Values vs = slv2_plugin_get_value_for_subject(p, subject, predicate);
 605         return vs ? slv2_values_get_at(vs, 0) : NULL;
 606 }
 607
 608 void
 609 LV2Plugin::find_presets()
 610 {
 611         SLV2Value dc_title       = slv2_value_new_uri(_world.world, NS_DC   "title");
 612         SLV2Value pset_hasPreset = slv2_value_new_uri(_world.world, NS_PSET "hasPreset");
 613
 614         SLV2Values presets = slv2_plugin_get_value(_plugin, pset_hasPreset);
 615         for (unsigned i = 0; i < slv2_values_size(presets); ++i) {
 616                 SLV2Value preset = slv2_values_get_at(presets, i);
 617                 SLV2Value name   = get_value(_plugin, preset, dc_title);
 618                 if (name) {
 619                         _presets.insert(std::make_pair(slv2_value_as_string(preset),
 620                                                        PresetRecord(
 621                                                            slv2_value_as_string(preset),
 622                                                            slv2_value_as_string(name))));
 623                 } else {
 624                         warning << string_compose(
 625                             _("Plugin \"%1\% preset \"%2%\" is missing a dc:title\n"),
 626                             unique_id(), slv2_value_as_string(preset));
 627                 }
 628         }
 629         slv2_values_free(presets);
 630
 631         slv2_value_free(pset_hasPreset);
 632         slv2_value_free(dc_title);
 633 }
 634
 635 bool
 636 LV2Plugin::load_preset(PresetRecord r)
 637 {
 638         Plugin::load_preset(r);
 639
 640 #ifdef HAVE_NEW_SLV2
 641         // New (>= 0.7.0) slv2 no longer supports SPARQL, but exposes blank nodes
 642         // so querying ports is possible with the simple/fast API
 643         SLV2Value lv2_port   = slv2_value_new_uri(_world.world, NS_LV2 "port");
 644         SLV2Value lv2_symbol = slv2_value_new_uri(_world.world, NS_LV2 "symbol");
 645         SLV2Value pset_value = slv2_value_new_uri(_world.world, NS_PSET "value");
 646         SLV2Value preset     = slv2_value_new_uri(_world.world, r.uri.c_str());
 647
 648         SLV2Values ports = slv2_plugin_get_value_for_subject(_plugin, preset, lv2_port);
 649         for (unsigned i = 0; i < slv2_values_size(ports); ++i) {
 650                 SLV2Value port   = slv2_values_get_at(ports, i);
 651                 SLV2Value symbol = get_value(_plugin, port, lv2_symbol);
 652                 SLV2Value value  = get_value(_plugin, port, pset_value);
 653                 if (value && slv2_value_is_float(value)) {
 654                         set_parameter(_port_indices[slv2_value_as_string(symbol)],
 655                                       slv2_value_as_float(value));
 656                 }
 657         }
 658         slv2_values_free(ports);
 659
 660         slv2_value_free(preset);
 661         slv2_value_free(pset_value);
 662         slv2_value_free(lv2_symbol);
 663         slv2_value_free(lv2_port);
 664 #else
 665         const string query = string(
 666                 "PREFIX lv2p: <http://lv2plug.in/ns/dev/presets#>\n"
 667                 "PREFIX dc:  <http://dublincore.org/documents/dcmi-namespace/>\n"
 668                 "SELECT ?sym ?val WHERE { <") + r.uri + "> lv2:port ?port . "
 669             " ?port lv2:symbol ?sym ; lv2p:value ?val . }";
 670         SLV2Results values = slv2_plugin_query_sparql(_plugin, query.c_str());
 671         for (; !slv2_results_finished(values); slv2_results_next(values)) {
 672                 SLV2Value sym = slv2_results_get_binding_value(values, 0);
 673                 SLV2Value val = slv2_results_get_binding_value(values, 1);
 674                 if (slv2_value_is_float(val)) {
 675                         uint32_t index = _port_indices[slv2_value_as_string(sym)];
 676                         set_parameter(index, slv2_value_as_float(val));
 677                 }
 678         }
 679         slv2_results_free(values);
 680 #endif
 681         return true;
 682 }
 683
 684 std::string
 685 LV2Plugin::do_save_preset(string /*name*/)
 686 {
 687         return "";
 688 }
 689
 690 void
 691 LV2Plugin::do_remove_preset(string /*name*/)
 692 {}
 693
 694 bool
 695 LV2Plugin::has_editor() const
 696 {
 697         return _ui != NULL;
 698 }
 699
 700 void
 701 LV2Plugin::set_insert_info(const PluginInsert* insert)
 702 {
 703         _insert_id = insert->id();
 704 }
 705
 706 int
 707 LV2Plugin::set_state(const XMLNode& node, int version)
 708 {
 709         XMLNodeList          nodes;
 710         const XMLProperty*   prop;
 711         XMLNodeConstIterator iter;
 712         XMLNode*             child;
 713         const char*          sym;
 714         const char*          value;
 715         uint32_t             port_id;
 716         LocaleGuard          lg(X_("POSIX"));
 717
 718         if (node.name() != state_node_name()) {
 719                 error << _("Bad node sent to LV2Plugin::set_state") << endmsg;
 720                 return -1;
 721         }
 722
 723         if (version < 3000) {
 724                 nodes = node.children("port");
 725         } else {
 726                 nodes = node.children("Port");
 727         }
 728
 729         for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
 730
 731                 child = *iter;
 732
 733                 if ((prop = child->property("symbol")) != 0) {
 734                         sym = prop->value().c_str();
 735                 } else {
 736                         warning << _("LV2: port has no symbol, ignored") << endmsg;
 737                         continue;
 738                 }
 739
 740                 map<string, uint32_t>::iterator i = _port_indices.find(sym);
 741
 742                 if (i != _port_indices.end()) {
 743                         port_id = i->second;
 744                 } else {
 745                         warning << _("LV2: port has unknown index, ignored") << endmsg;
 746                         continue;
 747                 }
 748
 749                 if ((prop = child->property("value")) != 0) {
 750                         value = prop->value().c_str();
 751                 } else {
 752                         warning << _("LV2: port has no value, ignored") << endmsg;
 753                         continue;
 754                 }
 755
 756                 set_parameter(port_id, atof(value));
 757         }
 758
 759         if ((prop = node.property("state-file")) != 0) {
 760                 std::string state_path = Glib::build_filename(_session.plugins_dir(),
 761                                                               prop->value());
 762
 763                 cout << "LV2 state path " << state_path << endl;
 764
 765                 // Get LV2 Persist extension data from plugin instance
 766                 LV2_Persist* persist = (LV2_Persist*)slv2_instance_get_extension_data(
 767                         _instance, "http://lv2plug.in/ns/ext/persist");
 768                 if (persist) {
 769                         cout << "Loading LV2 state from " << state_path << endl;
 770                         RDFF file = rdff_open(state_path.c_str(), false);
 771
 772                         PersistState state(_uri_map);
 773
 774                         // Load file into state object
 775                         RDFFChunk* chunk = (RDFFChunk*)malloc(sizeof(RDFFChunk));
 776                         chunk->size = 0;
 777                         while (!rdff_read_chunk(file, &chunk)) {
 778                                 if (rdff_chunk_is_uri(chunk)) {
 779                                         RDFFURIChunk* body = (RDFFURIChunk*)chunk->data;
 780                                         state.add_uri(body->id, body->uri);
 781                                 } else if (rdff_chunk_is_triple(chunk)) {
 782                                         RDFFTripleChunk* body = (RDFFTripleChunk*)chunk->data;
 783                                         state.add_value(body->predicate,
 784                                                         body->object,
 785                                                         body->object_size,
 786                                                         body->object_type,
 787                                                         LV2_PERSIST_IS_POD | LV2_PERSIST_IS_PORTABLE);
 788                                 }
 789                         }
 790                         free(chunk);
 791
 792                         persist->restore(_instance->lv2_handle,
 793                                          &LV2Plugin::lv2_persist_retrieve_callback,
 794                                          &state);
 795                         rdff_close(file);
 796                 } else {
 797                         warning << string_compose(
 798                             _("Plugin \"%1\% failed to return LV2 persist data"),
 799                             unique_id());
 800                 }
 801         }
 802
 803         latency_compute_run();
 804
 805         return Plugin::set_state(node, version);
 806 }
 807
 808 int
 809 LV2Plugin::get_parameter_descriptor(uint32_t which, ParameterDescriptor& desc) const
 810 {
 811         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, which);
 812
 813         SLV2Value def, min, max;
 814         slv2_port_get_range(_plugin, port, &def, &min, &max);
 815
 816         desc.integer_step = slv2_port_has_property(_plugin, port, _world.integer);
 817         desc.toggled      = slv2_port_has_property(_plugin, port, _world.toggled);
 818         desc.logarithmic  = slv2_port_has_property(_plugin, port, _world.logarithmic);
 819         desc.sr_dependent = slv2_port_has_property(_plugin, port, _world.srate);
 820         desc.label        = slv2_value_as_string(slv2_port_get_name(_plugin, port));
 821         desc.lower        = min ? slv2_value_as_float(min) : 0.0f;
 822         desc.upper        = max ? slv2_value_as_float(max) : 1.0f;
 823         desc.min_unbound  = false; // TODO: LV2 extension required
 824         desc.max_unbound  = false; // TODO: LV2 extension required
 825
 826         if (desc.integer_step) {
 827                 desc.step      = 1.0;
 828                 desc.smallstep = 0.1;
 829                 desc.largestep = 10.0;
 830         } else {
 831                 const float delta = desc.upper - desc.lower;
 832                 desc.step      = delta / 1000.0f;
 833                 desc.smallstep = delta / 10000.0f;
 834                 desc.largestep = delta / 10.0f;
 835         }
 836
 837         slv2_value_free(def);
 838         slv2_value_free(min);
 839         slv2_value_free(max);
 840
 841         return 0;
 842 }
 843
 844 string
 845 LV2Plugin::describe_parameter(Evoral::Parameter which)
 846 {
 847         if (( which.type() == PluginAutomation) && ( which.id() < parameter_count()) ) {
 848                 SLV2Value name = slv2_port_get_name(_plugin,
 849                                                     slv2_plugin_get_port_by_index(_plugin, which.id()));
 850                 string ret(slv2_value_as_string(name));
 851                 slv2_value_free(name);
 852                 return ret;
 853         } else {
 854                 return "??";
 855         }
 856 }
 857
 858 framecnt_t
 859 LV2Plugin::signal_latency() const
 860 {
 861         if (_latency_control_port) {
 862                 return (framecnt_t)floor(*_latency_control_port);
 863         } else {
 864                 return 0;
 865         }
 866 }
 867
 868 set<Evoral::Parameter>
 869 LV2Plugin::automatable() const
 870 {
 871         set<Evoral::Parameter> ret;
 872
 873         for (uint32_t i = 0; i < parameter_count(); ++i) {
 874                 if (parameter_is_input(i) && parameter_is_control(i)) {
 875                         ret.insert(ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
 876                 }
 877         }
 878
 879         return ret;
 880 }
 881
 882 void
 883 LV2Plugin::activate()
 884 {
 885         DEBUG_TRACE(DEBUG::LV2, string_compose("%1 activate\n", name()));
 886
 887         if (!_was_activated) {
 888                 slv2_instance_activate(_instance);
 889                 _was_activated = true;
 890         }
 891 }
 892
 893 void
 894 LV2Plugin::deactivate()
 895 {
 896         DEBUG_TRACE(DEBUG::LV2, string_compose("%1 deactivate\n", name()));
 897
 898         if (_was_activated) {
 899                 slv2_instance_deactivate(_instance);
 900                 _was_activated = false;
 901         }
 902 }
 903
 904 void
 905 LV2Plugin::cleanup()
 906 {
 907         DEBUG_TRACE(DEBUG::LV2, string_compose("%1 cleanup\n", name()));
 908
 909         activate();
 910         deactivate();
 911         slv2_instance_free(_instance);
 912         _instance = NULL;
 913 }
 914
 915 int
 916 LV2Plugin::connect_and_run(BufferSet& bufs,
 917         ChanMapping in_map, ChanMapping out_map,
 918         pframes_t nframes, framecnt_t offset)
 919 {
 920         DEBUG_TRACE(DEBUG::LV2, string_compose("%1 run %2 offset %3\n", name(), nframes, offset));
 921         Plugin::connect_and_run(bufs, in_map, out_map, nframes, offset);
 922
 923         cycles_t then = get_cycles();
 924
 925         uint32_t audio_in_index  = 0;
 926         uint32_t audio_out_index = 0;
 927         uint32_t midi_in_index   = 0;
 928         uint32_t midi_out_index  = 0;
 929         for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
 930                 if (parameter_is_audio(port_index)) {
 931                         if (parameter_is_input(port_index)) {
 932                                 const uint32_t buf_index = in_map.get(DataType::AUDIO, audio_in_index++);
 933                                 slv2_instance_connect_port(_instance, port_index,
 934                                                            bufs.get_audio(buf_index).data(offset));
 935                         } else if (parameter_is_output(port_index)) {
 936                                 const uint32_t buf_index = out_map.get(DataType::AUDIO, audio_out_index++);
 937                                 //cerr << port_index << " : " << " AUDIO OUT " << buf_index << endl;
 938                                 slv2_instance_connect_port(_instance, port_index,
 939                                                            bufs.get_audio(buf_index).data(offset));
 940                         }
 941                 } else if (parameter_is_midi(port_index)) {
 942                         if (parameter_is_input(port_index)) {
 943                                 const uint32_t buf_index = in_map.get(DataType::MIDI, midi_in_index++);
 944                                 slv2_instance_connect_port(_instance, port_index,
 945                                                            bufs.get_lv2_midi(true, buf_index).data());
 946                         } else if (parameter_is_output(port_index)) {
 947                                 const uint32_t buf_index = out_map.get(DataType::MIDI, midi_out_index++);
 948                                 slv2_instance_connect_port(_instance, port_index,
 949                                                            bufs.get_lv2_midi(false, buf_index).data());
 950                         }
 951                 } else if (!parameter_is_control(port_index)) {
 952                         // Optional port (it'd better be if we've made it this far...)
 953                         slv2_instance_connect_port(_instance, port_index, NULL);
 954                 }
 955         }
 956
 957         run(nframes);
 958
 959         midi_out_index = 0;
 960         for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
 961                 if (parameter_is_midi(port_index) && parameter_is_output(port_index)) {
 962                         const uint32_t buf_index = out_map.get(DataType::MIDI, midi_out_index++);
 963                         bufs.flush_lv2_midi(true, buf_index);
 964                 }
 965         }
 966
 967         cycles_t now = get_cycles();
 968         set_cycles((uint32_t)(now - then));
 969
 970         return 0;
 971 }
 972
 973 bool
 974 LV2Plugin::parameter_is_control(uint32_t param) const
 975 {
 976         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
 977         return slv2_port_is_a(_plugin, port, _world.control_class);
 978 }
 979
 980 bool
 981 LV2Plugin::parameter_is_audio(uint32_t param) const
 982 {
 983         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
 984         return slv2_port_is_a(_plugin, port, _world.audio_class);
 985 }
 986
 987 bool
 988 LV2Plugin::parameter_is_midi(uint32_t param) const
 989 {
 990         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
 991         return slv2_port_is_a(_plugin, port, _world.event_class);
 992         //      && slv2_port_supports_event(_plugin, port, _world.midi_class);
 993 }
 994
 995 bool
 996 LV2Plugin::parameter_is_output(uint32_t param) const
 997 {
 998         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
 999         return slv2_port_is_a(_plugin, port, _world.output_class);
1000 }
1001
1002 bool
1003 LV2Plugin::parameter_is_input(uint32_t param) const
1004 {
1005         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
1006         return slv2_port_is_a(_plugin, port, _world.input_class);
1007 }
1008
1009 void
1010 LV2Plugin::print_parameter(uint32_t param, char* buf, uint32_t len) const
1011 {
1012         if (buf && len) {
1013                 if (param < parameter_count()) {
1014                         snprintf(buf, len, "%.3f", get_parameter(param));
1015                 } else {
1016                         strcat(buf, "0");
1017                 }
1018         }
1019 }
1020
1021 void
1022 LV2Plugin::run(pframes_t nframes)
1023 {
1024         for (uint32_t i = 0; i < parameter_count(); ++i) {
1025                 if (parameter_is_control(i) && parameter_is_input(i)) {
1026                         _control_data[i] = _shadow_data[i];
1027                 }
1028         }
1029
1030         slv2_instance_run(_instance, nframes);
1031 }
1032
1033 void
1034 LV2Plugin::latency_compute_run()
1035 {
1036         if (!_latency_control_port) {
1037                 return;
1038         }
1039
1040         // Run the plugin so that it can set its latency parameter
1041
1042         activate();
1043
1044         uint32_t port_index = 0;
1045         uint32_t in_index   = 0;
1046         uint32_t out_index  = 0;
1047
1048         const framecnt_t bufsize = 1024;
1049         float            buffer[bufsize];
1050
1051         memset(buffer, 0, sizeof(float) * bufsize);
1052
1053         // FIXME: Ensure plugins can handle in-place processing
1054
1055         port_index = 0;
1056
1057         while (port_index < parameter_count()) {
1058                 if (parameter_is_audio(port_index)) {
1059                         if (parameter_is_input(port_index)) {
1060                                 slv2_instance_connect_port(_instance, port_index, buffer);
1061                                 in_index++;
1062                         } else if (parameter_is_output(port_index)) {
1063                                 slv2_instance_connect_port(_instance, port_index, buffer);
1064                                 out_index++;
1065                         }
1066                 }
1067                 port_index++;
1068         }
1069
1070         run(bufsize);
1071         deactivate();
1072 }
1073
1074 LV2World::LV2World()
1075         : world(slv2_world_new())
1076 {
1077         slv2_world_load_all(world);
1078         input_class     = slv2_value_new_uri(world, SLV2_PORT_CLASS_INPUT);
1079         output_class    = slv2_value_new_uri(world, SLV2_PORT_CLASS_OUTPUT);
1080         control_class   = slv2_value_new_uri(world, SLV2_PORT_CLASS_CONTROL);
1081         audio_class     = slv2_value_new_uri(world, SLV2_PORT_CLASS_AUDIO);
1082         event_class     = slv2_value_new_uri(world, SLV2_PORT_CLASS_EVENT);
1083         midi_class      = slv2_value_new_uri(world, SLV2_EVENT_CLASS_MIDI);
1084         in_place_broken = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "inPlaceBroken");
1085         integer         = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "integer");
1086         toggled         = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "toggled");
1087         srate           = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "sampleRate");
1088         gtk_gui         = slv2_value_new_uri(world, NS_UI "GtkUI");
1089         external_gui    = slv2_value_new_uri(world, NS_UI "external");
1090         logarithmic     = slv2_value_new_uri(world, "http://lv2plug.in/ns/dev/extportinfo#logarithmic");
1091 }
1092
1093 LV2World::~LV2World()
1094 {
1095         slv2_value_free(input_class);
1096         slv2_value_free(output_class);
1097         slv2_value_free(control_class);
1098         slv2_value_free(audio_class);
1099         slv2_value_free(event_class);
1100         slv2_value_free(midi_class);
1101         slv2_value_free(in_place_broken);
1102 }
1103
1104 LV2PluginInfo::LV2PluginInfo (void* lv2_world, void* slv2_plugin)
1105         : _lv2_world(lv2_world)
1106         , _slv2_plugin(slv2_plugin)
1107 {
1108         type = ARDOUR::LV2;
1109 }
1110
1111 LV2PluginInfo::~LV2PluginInfo()
1112 {}
1113
1114 PluginPtr
1115 LV2PluginInfo::load(Session& session)
1116 {
1117         try {
1118                 PluginPtr plugin;
1119
1120                 plugin.reset(new LV2Plugin(session.engine(), session,
1121                                            *(LV2World*)_lv2_world, (SLV2Plugin)_slv2_plugin,
1122                                            session.frame_rate()));
1123
1124                 plugin->set_info(PluginInfoPtr(new LV2PluginInfo(*this)));
1125                 return plugin;
1126         } catch (failed_constructor& err) {
1127                 return PluginPtr((Plugin*)0);
1128         }
1129
1130         return PluginPtr();
1131 }
1132
1133 PluginInfoList*
1134 LV2PluginInfo::discover(void* lv2_world)
1135 {
1136         PluginInfoList* plugs   = new PluginInfoList;
1137         LV2World*       world   = (LV2World*)lv2_world;
1138         SLV2Plugins     plugins = slv2_world_get_all_plugins(world->world);
1139
1140         cerr << "LV2: Discovering " << slv2_plugins_size(plugins) << " plugins" << endl;
1141
1142         for (unsigned i = 0; i < slv2_plugins_size(plugins); ++i) {
1143                 SLV2Plugin       p = slv2_plugins_get_at(plugins, i);
1144                 LV2PluginInfoPtr info(new LV2PluginInfo(lv2_world, p));
1145
1146                 SLV2Value name = slv2_plugin_get_name(p);
1147
1148                 if (!name) {
1149                         cerr << "LV2: invalid plugin\n";
1150                         continue;
1151                 }
1152
1153                 info->type = LV2;
1154
1155                 info->name = string(slv2_value_as_string(name));
1156                 slv2_value_free(name);
1157
1158                 SLV2PluginClass pclass = slv2_plugin_get_class(p);
1159                 SLV2Value       label  = slv2_plugin_class_get_label(pclass);
1160                 info->category = slv2_value_as_string(label);
1161
1162                 SLV2Value author_name = slv2_plugin_get_author_name(p);
1163                 info->creator = author_name ? string(slv2_value_as_string(author_name)) : "Unknown";
1164                 slv2_value_free(author_name);
1165
1166                 info->path = "/NOPATH"; // Meaningless for LV2
1167
1168                 info->n_inputs.set_audio(
1169                         slv2_plugin_get_num_ports_of_class(
1170                                 p, world->input_class, world->audio_class, NULL));
1171                 info->n_inputs.set_midi(
1172                         slv2_plugin_get_num_ports_of_class(
1173                                 p, world->input_class, world->event_class, NULL));
1174
1175                 info->n_outputs.set_audio(
1176                         slv2_plugin_get_num_ports_of_class(
1177                                 p, world->output_class, world->audio_class, NULL));
1178                 info->n_outputs.set_midi(
1179                         slv2_plugin_get_num_ports_of_class(
1180                                 p, world->output_class, world->event_class, NULL));
1181
1182                 info->unique_id = slv2_value_as_uri(slv2_plugin_get_uri(p));
1183                 info->index     = 0; // Meaningless for LV2
1184
1185                 plugs->push_back(info);
1186         }
1187
1188         cerr << "Done LV2 discovery" << endl;
1189
1190         return plugs;
1191 }