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