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