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         delete [] _control_data;
 169         delete [] _shadow_data;
 170 }
 171
 172 string
 173 LV2Plugin::unique_id() const
 174 {
 175         return slv2_value_as_uri(slv2_plugin_get_uri(_plugin));
 176 }
 177
 178
 179 float
 180 LV2Plugin::default_value (uint32_t port)
 181 {
 182         return _defaults[port];
 183 }
 184
 185 const char*
 186 LV2Plugin::port_symbol (uint32_t index)
 187 {
 188         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, index);
 189         if (!port) {
 190                 error << name() << ": Invalid port index " << index << endmsg;
 191         }
 192
 193         SLV2Value sym = slv2_port_get_symbol(_plugin, port);
 194         return slv2_value_as_string(sym);
 195 }
 196
 197
 198 void
 199 LV2Plugin::set_parameter (uint32_t which, float val)
 200 {
 201         if (which < slv2_plugin_get_num_ports(_plugin)) {
 202                 _shadow_data[which] = val;
 203 #if 0
 204                 ParameterChanged (which, val); /* EMIT SIGNAL */
 205
 206                 if (which < parameter_count() && controls[which]) {
 207                         controls[which]->Changed ();
 208                 }
 209 #endif
 210
 211         } else {
 212                 warning << string_compose (_("Illegal parameter number used with plugin \"%1\"."
 213                                 "This is a bug in either Ardour or the LV2 plugin (%2)"),
 214                                 name(), unique_id()) << endmsg;
 215         }
 216 }
 217
 218 float
 219 LV2Plugin::get_parameter (uint32_t which) const
 220 {
 221         if (parameter_is_input(which)) {
 222                 return (float) _shadow_data[which];
 223         } else {
 224                 return (float) _control_data[which];
 225         }
 226         return 0.0f;
 227 }
 228
 229 uint32_t
 230 LV2Plugin::nth_parameter (uint32_t n, bool& ok) const
 231 {
 232         uint32_t x, c;
 233
 234         ok = false;
 235
 236         for (c = 0, x = 0; x < slv2_plugin_get_num_ports(_plugin); ++x) {
 237                 if (parameter_is_control (x)) {
 238                         if (c++ == n) {
 239                                 ok = true;
 240                                 return x;
 241                         }
 242                 }
 243         }
 244
 245         return 0;
 246 }
 247
 248 XMLNode&
 249 LV2Plugin::get_state()
 250 {
 251         XMLNode *root = new XMLNode(state_node_name());
 252         XMLNode *child;
 253         char buf[16];
 254         LocaleGuard lg (X_("POSIX"));
 255
 256         for (uint32_t i = 0; i < parameter_count(); ++i){
 257
 258                 if (parameter_is_input(i) && parameter_is_control(i)) {
 259                         child = new XMLNode("port");
 260                         snprintf(buf, sizeof(buf), "%u", i);
 261                         child->add_property("number", string(buf));
 262                         child->add_property("symbol", port_symbol(i));
 263                         snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
 264                         child->add_property("value", string(buf));
 265                         root->add_child_nocopy (*child);
 266
 267                         /*if (i < controls.size() && controls[i]) {
 268                                 root->add_child_nocopy (controls[i]->get_state());
 269                         }*/
 270                 }
 271         }
 272
 273         return *root;
 274 }
 275
 276 bool
 277 LV2Plugin::save_preset (string name)
 278 {
 279         return Plugin::save_preset (name, "lv2");
 280 }
 281
 282 bool
 283 LV2Plugin::has_editor() const
 284 {
 285         return (_ui != NULL);
 286 }
 287
 288 int
 289 LV2Plugin::set_state(const XMLNode& node)
 290 {
 291         XMLNodeList nodes;
 292         XMLProperty *prop;
 293         XMLNodeConstIterator iter;
 294         XMLNode *child;
 295         const char *port;
 296         const char *data;
 297         uint32_t port_id;
 298         LocaleGuard lg (X_("POSIX"));
 299
 300         if (node.name() != state_node_name()) {
 301                 error << _("Bad node sent to LV2Plugin::set_state") << endmsg;
 302                 return -1;
 303         }
 304
 305         nodes = node.children ("port");
 306
 307         for(iter = nodes.begin(); iter != nodes.end(); ++iter){
 308
 309                 child = *iter;
 310
 311                 if ((prop = child->property("number")) != 0) {
 312                         port = prop->value().c_str();
 313                 } else {
 314                         warning << _("LV2: no lv2 port number") << endmsg;
 315                         continue;
 316                 }
 317
 318                 if ((prop = child->property("value")) != 0) {
 319                         data = prop->value().c_str();
 320                 } else {
 321                         warning << _("LV2: no lv2 port data") << endmsg;
 322                         continue;
 323                 }
 324
 325                 sscanf (port, "%" PRIu32, &port_id);
 326                 set_parameter (port_id, atof(data));
 327         }
 328
 329         latency_compute_run ();
 330
 331         return 0;
 332 }
 333
 334 int
 335 LV2Plugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
 336 {
 337         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, which);
 338
 339         SLV2Value def, min, max;
 340         slv2_port_get_range(_plugin, port, &def, &min, &max);
 341
 342     desc.integer_step = slv2_port_has_property(_plugin, port, _world.integer);
 343     desc.toggled = slv2_port_has_property(_plugin, port, _world.toggled);
 344     desc.logarithmic = false; // TODO (LV2 extension)
 345     desc.sr_dependent = slv2_port_has_property(_plugin, port, _world.srate);
 346     desc.label = slv2_value_as_string(slv2_port_get_name(_plugin, port));
 347     desc.lower = min ? slv2_value_as_float(min) : 0.0f;
 348     desc.upper = max ? slv2_value_as_float(max) : 1.0f;
 349     desc.min_unbound = false; // TODO (LV2 extension)
 350     desc.max_unbound = false; // TODO (LV2 extension)
 351
 352         if (desc.integer_step) {
 353                 desc.step = 1.0;
 354                 desc.smallstep = 0.1;
 355                 desc.largestep = 10.0;
 356         } else {
 357                 const float delta = desc.upper - desc.lower;
 358                 desc.step = delta / 1000.0f;
 359                 desc.smallstep = delta / 10000.0f;
 360                 desc.largestep = delta/10.0f;
 361         }
 362
 363         slv2_value_free(def);
 364         slv2_value_free(min);
 365         slv2_value_free(max);
 366
 367         return 0;
 368 }
 369
 370
 371 string
 372 LV2Plugin::describe_parameter (Evoral::Parameter which)
 373 {
 374         if (which.type() == PluginAutomation && which.id() < parameter_count()) {
 375                 SLV2Value name = slv2_port_get_name(_plugin,
 376                         slv2_plugin_get_port_by_index(_plugin, which));
 377                 string ret(slv2_value_as_string(name));
 378                 slv2_value_free(name);
 379                 return ret;
 380         } else {
 381                 return "??";
 382         }
 383 }
 384
 385 nframes_t
 386 LV2Plugin::signal_latency () const
 387 {
 388         if (_latency_control_port) {
 389                 return (nframes_t) floor (*_latency_control_port);
 390         } else {
 391                 return 0;
 392         }
 393 }
 394
 395 set<Evoral::Parameter>
 396 LV2Plugin::automatable () const
 397 {
 398         set<Evoral::Parameter> ret;
 399
 400         for (uint32_t i = 0; i < parameter_count(); ++i){
 401                 if (parameter_is_input(i) && parameter_is_control(i)) {
 402                         ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
 403                 }
 404         }
 405
 406         return ret;
 407 }
 408
 409 int
 410 LV2Plugin::connect_and_run (BufferSet& bufs, uint32_t& in_index, uint32_t& out_index, nframes_t nframes, nframes_t offset)
 411 {
 412         uint32_t port_index;
 413         cycles_t then, now;
 414
 415         port_index = 0;
 416
 417         then = get_cycles ();
 418
 419         const uint32_t nbufs = bufs.count().n_audio();
 420
 421         while (port_index < parameter_count()) {
 422                 if (parameter_is_audio(port_index)) {
 423                         if (parameter_is_input(port_index)) {
 424                                 const size_t index = min(in_index, nbufs - 1);
 425                                 slv2_instance_connect_port(_instance, port_index,
 426                                                 bufs.get_audio(index).data(nframes, offset));
 427                                 in_index++;
 428                         } else if (parameter_is_output(port_index)) {
 429                                 const size_t index = min(out_index,nbufs - 1);
 430                                 slv2_instance_connect_port(_instance, port_index,
 431                                                 bufs.get_audio(index).data(nframes, offset));
 432                                 out_index++;
 433                         }
 434                 } else if (parameter_is_midi(port_index)) {
 435                         // FIXME: Switch MIDI buffer format to LV2 event buffer
 436                         if (parameter_is_input(port_index)) {
 437                                 //const size_t index = min(in_index, nbufs - 1);
 438                                 //slv2_instance_connect_port(_instance, port_index,
 439                                 //              bufs.get_midi(index).data(nframes, offset));
 440                                 // FIXME: hope it's connection optional...
 441                                 slv2_instance_connect_port(_instance, port_index, NULL);
 442                                 in_index++;
 443                         } else if (parameter_is_output(port_index)) {
 444                                 //const size_t index = min(out_index,nbufs - 1);
 445                                 //slv2_instance_connect_port(_instance, port_index,
 446                                 //              bufs.get_midi(index).data(nframes, offset));
 447                                 // FIXME: hope it's connection optional...
 448                                 slv2_instance_connect_port(_instance, port_index, NULL);
 449                                 out_index++;
 450                         }
 451                 }
 452                 port_index++;
 453         }
 454
 455         run (nframes);
 456         now = get_cycles ();
 457         set_cycles ((uint32_t) (now - then));
 458
 459         return 0;
 460 }
 461
 462 bool
 463 LV2Plugin::parameter_is_control (uint32_t param) const
 464 {
 465         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
 466         return slv2_port_is_a(_plugin, port, _world.control_class);
 467 }
 468
 469 bool
 470 LV2Plugin::parameter_is_audio (uint32_t param) const
 471 {
 472         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
 473         return slv2_port_is_a(_plugin, port, _world.audio_class);
 474 }
 475
 476 bool
 477 LV2Plugin::parameter_is_midi (uint32_t param) const
 478 {
 479         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
 480         return slv2_port_is_a(_plugin, port, _world.event_class)
 481                 && slv2_port_supports_event(_plugin, port, _world.midi_class);
 482 }
 483
 484 bool
 485 LV2Plugin::parameter_is_output (uint32_t param) const
 486 {
 487         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
 488         return slv2_port_is_a(_plugin, port, _world.output_class);
 489 }
 490
 491 bool
 492 LV2Plugin::parameter_is_input (uint32_t param) const
 493 {
 494         SLV2Port port = slv2_plugin_get_port_by_index(_plugin, param);
 495         return slv2_port_is_a(_plugin, port, _world.input_class);
 496 }
 497
 498 void
 499 LV2Plugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
 500 {
 501         if (buf && len) {
 502                 if (param < parameter_count()) {
 503                         snprintf (buf, len, "%.3f", get_parameter (param));
 504                 } else {
 505                         strcat (buf, "0");
 506                 }
 507         }
 508 }
 509
 510 void
 511 LV2Plugin::run (nframes_t nframes)
 512 {
 513         for (uint32_t i = 0; i < parameter_count(); ++i) {
 514                 if (parameter_is_control(i) && parameter_is_input(i))  {
 515                         _control_data[i] = _shadow_data[i];
 516                 }
 517         }
 518
 519         slv2_instance_run(_instance, nframes);
 520 }
 521
 522 void
 523 LV2Plugin::latency_compute_run ()
 524 {
 525         if (!_latency_control_port) {
 526                 return;
 527         }
 528
 529         /* we need to run the plugin so that it can set its latency
 530            parameter.
 531         */
 532
 533         activate ();
 534
 535         uint32_t port_index = 0;
 536         uint32_t in_index = 0;
 537         uint32_t out_index = 0;
 538         const nframes_t bufsize = 1024;
 539         float buffer[bufsize];
 540
 541         memset(buffer,0,sizeof(float)*bufsize);
 542
 543         /* Note that we've already required that plugins
 544            be able to handle in-place processing.
 545         */
 546
 547         port_index = 0;
 548
 549         while (port_index < parameter_count()) {
 550                 if (parameter_is_audio (port_index)) {
 551                         if (parameter_is_input (port_index)) {
 552                                 slv2_instance_connect_port (_instance, port_index, buffer);
 553                                 in_index++;
 554                         } else if (parameter_is_output (port_index)) {
 555                                 slv2_instance_connect_port (_instance, port_index, buffer);
 556                                 out_index++;
 557                         }
 558                 }
 559                 port_index++;
 560         }
 561
 562         run (bufsize);
 563         deactivate ();
 564 }
 565
 566 LV2World::LV2World()
 567         : world(slv2_world_new())
 568 {
 569         slv2_world_load_all(world);
 570         input_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_INPUT);
 571         output_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_OUTPUT);
 572         control_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_CONTROL);
 573         audio_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_AUDIO);
 574         event_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_EVENT);
 575         midi_class = slv2_value_new_uri(world, SLV2_EVENT_CLASS_MIDI);
 576         in_place_broken = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "inPlaceBroken");
 577         integer = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "integer");
 578         toggled = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "toggled");
 579         srate = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "sampleRate");
 580         gtk_gui = slv2_value_new_uri(world, "http://lv2plug.in/ns/extensions/ui#GtkUI");
 581 }
 582
 583 LV2World::~LV2World()
 584 {
 585         slv2_value_free(input_class);
 586         slv2_value_free(output_class);
 587         slv2_value_free(control_class);
 588         slv2_value_free(audio_class);
 589         slv2_value_free(event_class);
 590         slv2_value_free(midi_class);
 591         slv2_value_free(in_place_broken);
 592 }
 593
 594 LV2PluginInfo::LV2PluginInfo (void* lv2_world, void* slv2_plugin)
 595         : _lv2_world(lv2_world)
 596         , _slv2_plugin(slv2_plugin)
 597 {
 598 }
 599
 600 LV2PluginInfo::~LV2PluginInfo()
 601 {
 602 }
 603
 604 PluginPtr
 605 LV2PluginInfo::load (Session& session)
 606 {
 607         try {
 608                 PluginPtr plugin;
 609
 610                 plugin.reset (new LV2Plugin (session.engine(), session,
 611                                 *(LV2World*)_lv2_world, (SLV2Plugin)_slv2_plugin, session.frame_rate()));
 612
 613                 plugin->set_info(PluginInfoPtr(new LV2PluginInfo(*this)));
 614                 return plugin;
 615         }
 616
 617         catch (failed_constructor &err) {
 618                 return PluginPtr ((Plugin*) 0);
 619         }
 620
 621         return PluginPtr();
 622 }
 623
 624 PluginInfoList
 625 LV2PluginInfo::discover (void* lv2_world)
 626 {
 627         PluginInfoList plugs;
 628
 629         LV2World* world = (LV2World*)lv2_world;
 630         SLV2Plugins plugins = slv2_world_get_all_plugins(world->world);
 631
 632         for (unsigned i=0; i < slv2_plugins_size(plugins); ++i) {
 633                 SLV2Plugin p = slv2_plugins_get_at(plugins, i);
 634                 LV2PluginInfoPtr info (new LV2PluginInfo(lv2_world, p));
 635
 636                 SLV2Value name = slv2_plugin_get_name(p);
 637                 info->name = string(slv2_value_as_string(name));
 638                 slv2_value_free(name);
 639
 640                 SLV2PluginClass pclass = slv2_plugin_get_class(p);
 641                 SLV2Value label = slv2_plugin_class_get_label(pclass);
 642                 info->category = slv2_value_as_string(label);
 643
 644                 SLV2Value author_name = slv2_plugin_get_author_name(p);
 645                 info->creator = author_name ? string(slv2_value_as_string(author_name)) : "Unknown";
 646                 slv2_value_free(author_name);
 647
 648                 info->path = "/NOPATH"; // Meaningless for LV2
 649
 650                 info->n_inputs.set_audio(slv2_plugin_get_num_ports_of_class(p,
 651                                 world->input_class, world->audio_class, NULL));
 652                 info->n_inputs.set_midi(slv2_plugin_get_num_ports_of_class(p,
 653                                 world->input_class, world->event_class, NULL));
 654
 655                 info->n_outputs.set_audio(slv2_plugin_get_num_ports_of_class(p,
 656                                 world->output_class, world->audio_class, NULL));
 657                 info->n_outputs.set_midi(slv2_plugin_get_num_ports_of_class(p,
 658                                 world->output_class, world->event_class, NULL));
 659
 660                 info->unique_id = slv2_value_as_uri(slv2_plugin_get_uri(p));
 661                 info->index = 0; // Meaningless for LV2
 662
 663                 plugs.push_back (info);
 664         }
 665
 666         return plugs;
 667 }
 668