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