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