libs/ardour/lv2_plugin.cc

   1 /*
   2     Copyright (C) 2008 Paul Davis
   3     Author: Dave 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 <vector>
  22 #include <string>
  23
  24 #include <cstdlib>
  25 #include <cmath>
  26 #include <cstring>
  27
  28 #include <pbd/compose.h>
  29 #include <pbd/error.h>
  30 #include <pbd/pathscanner.h>
  31 #include <pbd/xml++.h>
  32
  33 #include <ardour/ardour.h>
  34 #include <ardour/session.h>
  35 #include <ardour/audioengine.h>
  36 #include <ardour/lv2_plugin.h>
  37
  38 #include <pbd/stl_delete.h>
  39
  40 #include "i18n.h"
  41 #include <locale.h>
  42
  43 using namespace std;
  44 using namespace ARDOUR;
  45 using namespace PBD;
  46
  47 LV2Plugin::LV2Plugin (AudioEngine& e, Session& session, LV2World& world, SLV2Plugin plugin, nframes_t rate)
  48         : Plugin (e, session)
  49         , _world(world)
  50         , _features(NULL)
  51 {
  52         init (world, plugin, rate);
  53 }
  54
  55 LV2Plugin::LV2Plugin (const LV2Plugin &other)
  56         : Plugin (other)
  57         , _world(other._world)
  58         , _features(NULL)
  59 {
  60         init (other._world, other._plugin, other._sample_rate);
  61
  62         for (uint32_t i = 0; i < parameter_count(); ++i) {
  63                 _control_data[i] = other._shadow_data[i];
  64                 _shadow_data[i] = other._shadow_data[i];
  65         }
  66 }
  67
  68 void
  69 LV2Plugin::init (LV2World& world, SLV2Plugin plugin, nframes_t rate)
  70 {
  71         _world = world;
  72         _plugin = plugin;
  73         _ui = NULL;
  74         _control_data = 0;
  75         _shadow_data = 0;
  76         _latency_control_port = 0;
  77         _was_activated = false;
  78
  79         _instance = slv2_plugin_instantiate(plugin, rate, _features);
  80         _name = slv2_plugin_get_name(plugin);
  81         assert(_name);
  82         _author = slv2_plugin_get_author_name(plugin);
  83
  84         if (_instance == 0) {
  85                 error << _("LV2: Failed to instantiate plugin ") << slv2_plugin_get_uri(plugin) << endl;
  86                 throw failed_constructor();
  87         }
  88
  89         if (slv2_plugin_has_feature(plugin, world.in_place_broken)) {
  90                 error << string_compose(_("LV2: \"%1\" cannot be used, since it cannot do inplace processing"),
  91                                 slv2_value_as_string(_name));
  92                 slv2_value_free(_name);
  93                 slv2_value_free(_author);
  94                 throw failed_constructor();
  95         }
  96
  97         _instance_access_feature.URI = "http://lv2plug.in/ns/ext/instance-access";
  98         _instance_access_feature.data = (void*)_instance->lv2_handle;
  99
 100         _data_access_extension_data.extension_data = _instance->lv2_descriptor->extension_data;
 101         _data_access_feature.URI = "http://lv2plug.in/ns/ext/data-access";
 102         _data_access_feature.data = &_data_access_extension_data;
 103
 104         _features = (LV2_Feature**)malloc(sizeof(LV2_Feature*) * 3);
 105         _features[0] = &_instance_access_feature;
 106         _features[1] = &_data_access_feature;
 107         _features[2] = NULL;
 108
 109         _sample_rate = rate;
 110
 111         const uint32_t num_ports = slv2_plugin_get_num_ports(plugin);
 112
 113         _control_data = new float[num_ports];
 114         _shadow_data = new float[num_ports];
 115         _defaults = new float[num_ports];
 116
 117         const bool latent = slv2_plugin_has_latency(plugin);
 118         uint32_t latency_port = (latent ? slv2_plugin_get_latency_port_index(plugin) : 0);
 119
 120         for (uint32_t i = 0; i < num_ports; ++i) {
 121                 if (parameter_is_control(i)) {
 122                         SLV2Port port = slv2_plugin_get_port_by_index(plugin, i);
 123                         SLV2Value def;
 124                         slv2_port_get_range(plugin, port, &def, NULL, NULL);
 125                         _defaults[i] = def ? slv2_value_as_float(def) : 0.0f;
 126                         slv2_value_free(def);
 127
 128                         slv2_instance_connect_port (_instance, i, &_control_data[i]);
 129
 130                         if (latent && i == latency_port) {
 131                                 _latency_control_port = &_control_data[i];
 132                                 *_latency_control_port = 0;
 133                         }
 134
 135                         if (parameter_is_input(i)) {
 136                                 _shadow_data[i] = default_value (i);
 137                         }
 138                 } else {
 139                         _defaults[i] = 0.0f;
 140                 }
 141         }
 142
 143         SLV2UIs uis = slv2_plugin_get_uis(_plugin);
 144         if (slv2_uis_size(uis) > 0) {
 145                 for (unsigned i=0; i < slv2_uis_size(uis); ++i) {
 146                         SLV2UI ui = slv2_uis_get_at(uis, i);
 147                         if (slv2_ui_is_a(ui, _world.gtk_gui)) {
 148                                 _ui = ui;
 149                                 break;
 150                         }
 151                 }
 152         }
 153
 154         latency_compute_run ();
 155 }
 156
 157 LV2Plugin::~LV2Plugin ()
 158 {
 159         deactivate ();
 160         cleanup ();
 161
 162         GoingAway (); /* EMIT SIGNAL */
 163
 164         slv2_instance_free(_instance);
 165         slv2_value_free(_name);
 166         slv2_value_free(_author);
 167
 168         if (_control_data) {
 169                 delete [] _control_data;
 170         }
 171
 172         if (_shadow_data) {
 173                 delete [] _shadow_data;
 174         }
 175 }
 176
 177 string
 178 LV2Plugin::unique_id() const
 179 {
 180         return slv2_value_as_uri(slv2_plugin_get_uri(_plugin));
 181 }
 182
 183
 184 float
 185 LV2Plugin::default_value (uint32_t port)
 186 {
 187         return _defaults[port];
 188 }
 189
 190 const char*
 191 LV2Plugin::port_symbol (uint32_t index)
 192 {
 193         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, index);
 194         if (!port) {
 195                 error << name() << ": Invalid port index " << index << endmsg;
 196         }
 197
 198         SLV2Value sym = slv2_port_get_symbol(_plugin, port);
 199         return slv2_value_as_string(sym);
 200 }
 201
 202
 203 void
 204 LV2Plugin::set_parameter (uint32_t which, float val)
 205 {
 206         if (which < slv2_plugin_get_num_ports(_plugin)) {
 207                 _shadow_data[which] = val;
 208 #if 0
 209                 ParameterChanged (which, val); /* EMIT SIGNAL */
 210
 211                 if (which < parameter_count() && controls[which]) {
 212                         controls[which]->Changed ();
 213                 }
 214 #endif
 215
 216         } else {
 217                 warning << string_compose (_("Illegal parameter number used with plugin \"%1\"."
 218                                 "This is a bug in either Ardour or the LV2 plugin (%2)"),
 219                                 name(), unique_id()) << endmsg;
 220         }
 221 }
 222
 223 float
 224 LV2Plugin::get_parameter (uint32_t which) const
 225 {
 226         if (parameter_is_input(which)) {
 227                 return (float) _shadow_data[which];
 228         } else {
 229                 return (float) _control_data[which];
 230         }
 231         return 0.0f;
 232 }
 233
 234 uint32_t
 235 LV2Plugin::nth_parameter (uint32_t n, bool& ok) const
 236 {
 237         uint32_t x, c;
 238
 239         ok = false;
 240
 241         for (c = 0, x = 0; x < slv2_plugin_get_num_ports(_plugin); ++x) {
 242                 if (parameter_is_control (x)) {
 243                         if (c++ == n) {
 244                                 ok = true;
 245                                 return x;
 246                         }
 247                 }
 248         }
 249
 250         return 0;
 251 }
 252
 253 XMLNode&
 254 LV2Plugin::get_state()
 255 {
 256         XMLNode *root = new XMLNode(state_node_name());
 257         XMLNode *child;
 258         char buf[16];
 259         LocaleGuard lg (X_("POSIX"));
 260
 261         for (uint32_t i = 0; i < parameter_count(); ++i){
 262
 263                 if (parameter_is_input(i) && parameter_is_control(i)) {
 264                         child = new XMLNode("port");
 265                         snprintf(buf, sizeof(buf), "%u", i);
 266                         child->add_property("number", string(buf));
 267                         child->add_property("symbol", port_symbol(i));
 268                         snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
 269                         child->add_property("value", string(buf));
 270                         root->add_child_nocopy (*child);
 271
 272                         /*if (i < controls.size() && controls[i]) {
 273                                 root->add_child_nocopy (controls[i]->get_state());
 274                         }*/
 275                 }
 276         }
 277
 278         return *root;
 279 }
 280
 281 bool
 282 LV2Plugin::save_preset (string name)
 283 {
 284         return Plugin::save_preset (name, "lv2");
 285 }
 286
 287 bool
 288 LV2Plugin::has_editor() const
 289 {
 290         return (_ui != NULL);
 291 }
 292
 293 int
 294 LV2Plugin::set_state(const XMLNode& node)
 295 {
 296         XMLNodeList nodes;
 297         XMLProperty *prop;
 298         XMLNodeConstIterator iter;
 299         XMLNode *child;
 300         const char *port;
 301         const char *data;
 302         uint32_t port_id;
 303         LocaleGuard lg (X_("POSIX"));
 304
 305         if (node.name() != state_node_name()) {
 306                 error << _("Bad node sent to LV2Plugin::set_state") << endmsg;
 307                 return -1;
 308         }
 309
 310         nodes = node.children ("port");
 311
 312         for(iter = nodes.begin(); iter != nodes.end(); ++iter){
 313
 314                 child = *iter;
 315
 316                 if ((prop = child->property("number")) != 0) {
 317                         port = prop->value().c_str();
 318                 } else {
 319                         warning << _("LV2: no lv2 port number") << endmsg;
 320                         continue;
 321                 }
 322
 323                 if ((prop = child->property("value")) != 0) {
 324                         data = prop->value().c_str();
 325                 } else {
 326                         warning << _("LV2: no lv2 port data") << endmsg;
 327                         continue;
 328                 }
 329
 330                 sscanf (port, "%" PRIu32, &port_id);
 331                 set_parameter (port_id, atof(data));
 332         }
 333
 334         latency_compute_run ();
 335
 336         return 0;
 337 }
 338
 339 int
 340 LV2Plugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
 341 {
 342         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, which);
 343
 344         SLV2Value def, min, max;
 345         slv2_port_get_range(_plugin, port, &def, &min, &max);
 346
 347     desc.integer_step = slv2_port_has_property(_plugin, port, _world.integer);
 348     desc.toggled = slv2_port_has_property(_plugin, port, _world.toggled);
 349     desc.logarithmic = false; // TODO (LV2 extension)
 350     desc.sr_dependent = slv2_port_has_property(_plugin, port, _world.srate);
 351     desc.label = slv2_value_as_string(slv2_port_get_name(_plugin, port));
 352     desc.lower = min ? slv2_value_as_float(min) : 0.0f;
 353     desc.upper = max ? slv2_value_as_float(max) : 1.0f;
 354     desc.min_unbound = false; // TODO (LV2 extension)
 355     desc.max_unbound = false; // TODO (LV2 extension)
 356
 357         if (desc.integer_step) {
 358                 desc.step = 1.0;
 359                 desc.smallstep = 0.1;
 360                 desc.largestep = 10.0;
 361         } else {
 362                 const float delta = desc.upper - desc.lower;
 363                 desc.step = delta / 1000.0f;
 364                 desc.smallstep = delta / 10000.0f;
 365                 desc.largestep = delta/10.0f;
 366         }
 367
 368         slv2_value_free(def);
 369         slv2_value_free(min);
 370         slv2_value_free(max);
 371
 372         return 0;
 373 }
 374
 375
 376 string
 377 LV2Plugin::describe_parameter (Evoral::Parameter which)
 378 {
 379         if (which.type() == PluginAutomation && which.id() < parameter_count()) {
 380                 SLV2Value name = slv2_port_get_name(_plugin,
 381                         slv2_plugin_get_port_by_index(_plugin, which));
 382                 string ret(slv2_value_as_string(name));
 383                 slv2_value_free(name);
 384                 return ret;
 385         } else {
 386                 return "??";
 387         }
 388 }
 389
 390 nframes_t
 391 LV2Plugin::signal_latency () const
 392 {
 393         if (_latency_control_port) {
 394                 return (nframes_t) floor (*_latency_control_port);
 395         } else {
 396                 return 0;
 397         }
 398 }
 399
 400 set<Evoral::Parameter>
 401 LV2Plugin::automatable () const
 402 {
 403         set<Evoral::Parameter> ret;
 404
 405         for (uint32_t i = 0; i < parameter_count(); ++i){
 406                 if (parameter_is_input(i) && parameter_is_control(i)) {
 407                         ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
 408                 }
 409         }
 410
 411         return ret;
 412 }
 413
 414 int
 415 LV2Plugin::connect_and_run (BufferSet& bufs, uint32_t& in_index, uint32_t& out_index, nframes_t nframes, nframes_t offset)
 416 {
 417         uint32_t port_index;
 418         cycles_t then, now;
 419
 420         port_index = 0;
 421
 422         then = get_cycles ();
 423
 424         const uint32_t nbufs = bufs.count().n_audio();
 425
 426         while (port_index < parameter_count()) {
 427                 if (parameter_is_audio(port_index)) {
 428                         if (parameter_is_input(port_index)) {
 429                                 const size_t index = min(in_index, nbufs - 1);
 430                                 slv2_instance_connect_port(_instance, port_index,
 431                                                 bufs.get_audio(index).data(nframes, offset));
 432                                 in_index++;
 433                         } else if (parameter_is_output(port_index)) {
 434                                 const size_t index = min(out_index,nbufs - 1);
 435                                 slv2_instance_connect_port(_instance, port_index,
 436                                                 bufs.get_audio(index).data(nframes, offset));
 437                                 out_index++;
 438                         }
 439                 } else if (parameter_is_midi(port_index)) {
 440                         // FIXME: Switch MIDI buffer format to LV2 event buffer
 441                         if (parameter_is_input(port_index)) {
 442                                 //const size_t index = min(in_index, nbufs - 1);
 443                                 //slv2_instance_connect_port(_instance, port_index,
 444                                 //              bufs.get_midi(index).data(nframes, offset));
 445                                 // FIXME: hope it's connection optional...
 446                                 slv2_instance_connect_port(_instance, port_index, NULL);
 447                                 in_index++;
 448                         } else if (parameter_is_output(port_index)) {
 449                                 //const size_t index = min(out_index,nbufs - 1);
 450                                 //slv2_instance_connect_port(_instance, port_index,
 451                                 //              bufs.get_midi(index).data(nframes, offset));
 452                                 // FIXME: hope it's connection optional...
 453                                 slv2_instance_connect_port(_instance, port_index, NULL);
 454                                 out_index++;
 455                         }
 456                 }
 457                 port_index++;
 458         }
 459
 460         run (nframes);
 461         now = get_cycles ();
 462         set_cycles ((uint32_t) (now - then));
 463
 464         return 0;
 465 }
 466
 467 bool
 468 LV2Plugin::parameter_is_control (uint32_t param) const
 469 {
 470         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
 471         return slv2_port_is_a(_plugin, port, _world.control_class);
 472 }
 473
 474 bool
 475 LV2Plugin::parameter_is_audio (uint32_t param) const
 476 {
 477         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
 478         return slv2_port_is_a(_plugin, port, _world.audio_class);
 479 }
 480
 481 bool
 482 LV2Plugin::parameter_is_midi (uint32_t param) const
 483 {
 484         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
 485         return slv2_port_is_a(_plugin, port, _world.event_class)
 486                 && slv2_port_supports_event(_plugin, port, _world.midi_class);
 487 }
 488
 489 bool
 490 LV2Plugin::parameter_is_output (uint32_t param) const
 491 {
 492         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
 493         return slv2_port_is_a(_plugin, port, _world.output_class);
 494 }
 495
 496 bool
 497 LV2Plugin::parameter_is_input (uint32_t param) const
 498 {
 499         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
 500         return slv2_port_is_a(_plugin, port, _world.input_class);
 501 }
 502
 503 void
 504 LV2Plugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
 505 {
 506         if (buf && len) {
 507                 if (param < parameter_count()) {
 508                         snprintf (buf, len, "%.3f", get_parameter (param));
 509                 } else {
 510                         strcat (buf, "0");
 511                 }
 512         }
 513 }
 514
 515 void
 516 LV2Plugin::run (nframes_t nframes)
 517 {
 518         for (uint32_t i = 0; i < parameter_count(); ++i) {
 519                 if (parameter_is_control(i) && parameter_is_input(i))  {
 520                         _control_data[i] = _shadow_data[i];
 521                 }
 522         }
 523
 524         slv2_instance_run(_instance, nframes);
 525 }
 526
 527 void
 528 LV2Plugin::latency_compute_run ()
 529 {
 530         if (!_latency_control_port) {
 531                 return;
 532         }
 533
 534         /* we need to run the plugin so that it can set its latency
 535            parameter.
 536         */
 537
 538         activate ();
 539
 540         uint32_t port_index = 0;
 541         uint32_t in_index = 0;
 542         uint32_t out_index = 0;
 543         const nframes_t bufsize = 1024;
 544         float buffer[bufsize];
 545
 546         memset(buffer,0,sizeof(float)*bufsize);
 547
 548         /* Note that we've already required that plugins
 549            be able to handle in-place processing.
 550         */
 551
 552         port_index = 0;
 553
 554         while (port_index < parameter_count()) {
 555                 if (parameter_is_audio (port_index)) {
 556                         if (parameter_is_input (port_index)) {
 557                                 slv2_instance_connect_port (_instance, port_index, buffer);
 558                                 in_index++;
 559                         } else if (parameter_is_output (port_index)) {
 560                                 slv2_instance_connect_port (_instance, port_index, buffer);
 561                                 out_index++;
 562                         }
 563                 }
 564                 port_index++;
 565         }
 566
 567         run (bufsize);
 568         deactivate ();
 569 }
 570
 571 LV2World::LV2World()
 572         : world(slv2_world_new())
 573 {
 574         slv2_world_load_all(world);
 575         input_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_INPUT);
 576         output_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_OUTPUT);
 577         control_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_CONTROL);
 578         audio_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_AUDIO);
 579         event_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_EVENT);
 580         midi_class = slv2_value_new_uri(world, SLV2_EVENT_CLASS_MIDI);
 581         in_place_broken = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "inPlaceBroken");
 582         integer = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "integer");
 583         toggled = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "toggled");
 584         srate = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "sampleRate");
 585         gtk_gui = slv2_value_new_uri(world, "http://lv2plug.in/ns/extensions/ui#GtkUI");
 586 }
 587
 588 LV2World::~LV2World()
 589 {
 590         slv2_value_free(input_class);
 591         slv2_value_free(output_class);
 592         slv2_value_free(control_class);
 593         slv2_value_free(audio_class);
 594         slv2_value_free(event_class);
 595         slv2_value_free(midi_class);
 596         slv2_value_free(in_place_broken);
 597 }
 598
 599 LV2PluginInfo::LV2PluginInfo (void* lv2_world, void* slv2_plugin)
 600         : _lv2_world(lv2_world)
 601         , _slv2_plugin(slv2_plugin)
 602 {
 603 }
 604
 605 LV2PluginInfo::~LV2PluginInfo()
 606 {
 607 }
 608
 609 PluginPtr
 610 LV2PluginInfo::load (Session& session)
 611 {
 612         try {
 613                 PluginPtr plugin;
 614
 615                 plugin.reset (new LV2Plugin (session.engine(), session,
 616                                 *(LV2World*)_lv2_world, (SLV2Plugin)_slv2_plugin, session.frame_rate()));
 617
 618                 plugin->set_info(PluginInfoPtr(new LV2PluginInfo(*this)));
 619                 return plugin;
 620         }
 621
 622         catch (failed_constructor &err) {
 623                 return PluginPtr ((Plugin*) 0);
 624         }
 625
 626         return PluginPtr();
 627 }
 628
 629 PluginInfoList
 630 LV2PluginInfo::discover (void* lv2_world)
 631 {
 632         PluginInfoList plugs;
 633
 634         LV2World* world = (LV2World*)lv2_world;
 635         SLV2Plugins plugins = slv2_world_get_all_plugins(world->world);
 636
 637         for (unsigned i=0; i < slv2_plugins_size(plugins); ++i) {
 638                 SLV2Plugin p = slv2_plugins_get_at(plugins, i);
 639                 LV2PluginInfoPtr info (new LV2PluginInfo(lv2_world, p));
 640
 641                 SLV2Value name = slv2_plugin_get_name(p);
 642                 info->name = string(slv2_value_as_string(name));
 643                 slv2_value_free(name);
 644
 645                 SLV2PluginClass pclass = slv2_plugin_get_class(p);
 646                 SLV2Value label = slv2_plugin_class_get_label(pclass);
 647                 info->category = slv2_value_as_string(label);
 648
 649                 SLV2Value author_name = slv2_plugin_get_author_name(p);
 650                 info->creator = author_name ? string(slv2_value_as_string(author_name)) : "Unknown";
 651                 slv2_value_free(author_name);
 652
 653                 info->path = "/NOPATH"; // Meaningless for LV2
 654
 655                 info->n_inputs.set_audio(slv2_plugin_get_num_ports_of_class(p,
 656                                 world->input_class, world->audio_class, NULL));
 657                 info->n_inputs.set_midi(slv2_plugin_get_num_ports_of_class(p,
 658                                 world->input_class, world->event_class, NULL));
 659
 660                 info->n_outputs.set_audio(slv2_plugin_get_num_ports_of_class(p,
 661                                 world->output_class, world->audio_class, NULL));
 662                 info->n_outputs.set_midi(slv2_plugin_get_num_ports_of_class(p,
 663                                 world->output_class, world->event_class, NULL));
 664
 665                 info->unique_id = slv2_value_as_uri(slv2_plugin_get_uri(p));
 666                 info->index = 0; // Meaningless for LV2
 667
 668                 plugs.push_back (info);
 669         }
 670
 671         return plugs;
 672 }
 673