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