libs/ardour/ladspa_plugin.cc

   1 /*
   2     Copyright (C) 2000-2006 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #define __STDC_FORMAT_MACROS 1
  21 #include <inttypes.h>
  22
  23 #include <vector>
  24 #include <string>
  25
  26 #include <cstdlib>
  27 #include <cstdio> // so libraptor doesn't complain
  28 #include <cmath>
  29 #include <dirent.h>
  30 #include <sys/stat.h>
  31 #include <cerrno>
  32
  33 #include <lrdf.h>
  34
  35 #include "pbd/compose.h"
  36 #include "pbd/error.h"
  37 #include "pbd/xml++.h"
  38
  39 #include "midi++/manager.h"
  40
  41 #include "ardour/ardour.h"
  42 #include "ardour/session.h"
  43 #include "ardour/audioengine.h"
  44 #include "ardour/ladspa_plugin.h"
  45 #include "ardour/buffer_set.h"
  46 #include "ardour/audio_buffer.h"
  47
  48 #include "pbd/stl_delete.h"
  49
  50 #include "i18n.h"
  51 #include <locale.h>
  52
  53 using namespace std;
  54 using namespace ARDOUR;
  55 using namespace PBD;
  56
  57 LadspaPlugin::LadspaPlugin (void *mod, AudioEngine& e, Session& session, uint32_t index, nframes_t rate)
  58         : Plugin (e, session)
  59 {
  60         init (mod, index, rate);
  61 }
  62
  63 LadspaPlugin::LadspaPlugin (const LadspaPlugin &other)
  64         : Plugin (other)
  65 {
  66         init (other._module, other._index, other._sample_rate);
  67
  68         for (uint32_t i = 0; i < parameter_count(); ++i) {
  69                 _control_data[i] = other._shadow_data[i];
  70                 _shadow_data[i] = other._shadow_data[i];
  71         }
  72 }
  73
  74 void
  75 LadspaPlugin::init (void *mod, uint32_t index, nframes_t rate)
  76 {
  77         LADSPA_Descriptor_Function dfunc;
  78         uint32_t i, port_cnt;
  79         const char *errstr;
  80
  81         _module = mod;
  82         _control_data = 0;
  83         _shadow_data = 0;
  84         _latency_control_port = 0;
  85         _was_activated = false;
  86
  87         dfunc = (LADSPA_Descriptor_Function) dlsym (_module, "ladspa_descriptor");
  88
  89         if ((errstr = dlerror()) != NULL) {
  90                 error << _("LADSPA: module has no descriptor function.") << endmsg;
  91                 throw failed_constructor();
  92         }
  93
  94         if ((_descriptor = dfunc (index)) == 0) {
  95                 error << _("LADSPA: plugin has gone away since discovery!") << endmsg;
  96                 throw failed_constructor();
  97         }
  98
  99         _index = index;
 100
 101         if (LADSPA_IS_INPLACE_BROKEN(_descriptor->Properties)) {
 102                 error << string_compose(_("LADSPA: \"%1\" cannot be used, since it cannot do inplace processing"), _descriptor->Name) << endmsg;
 103                 throw failed_constructor();
 104         }
 105
 106         _sample_rate = rate;
 107
 108         if (_descriptor->instantiate == 0) {
 109                 throw failed_constructor();
 110         }
 111
 112         if ((_handle = _descriptor->instantiate (_descriptor, rate)) == 0) {
 113                 throw failed_constructor();
 114         }
 115
 116         port_cnt = parameter_count();
 117
 118         _control_data = new LADSPA_Data[port_cnt];
 119         _shadow_data = new LADSPA_Data[port_cnt];
 120
 121         for (i = 0; i < port_cnt; ++i) {
 122                 if (LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
 123                         connect_port (i, &_control_data[i]);
 124
 125                         if (LADSPA_IS_PORT_OUTPUT(port_descriptor (i)) &&
 126                             strcmp (port_names()[i], X_("latency")) == 0) {
 127                                 _latency_control_port = &_control_data[i];
 128                                 *_latency_control_port = 0;
 129                         }
 130
 131                         if (!LADSPA_IS_PORT_INPUT(port_descriptor (i))) {
 132                                 continue;
 133                         }
 134
 135                         _shadow_data[i] = default_value (i);
 136                 }
 137         }
 138
 139         latency_compute_run ();
 140 }
 141
 142 LadspaPlugin::~LadspaPlugin ()
 143 {
 144         deactivate ();
 145         cleanup ();
 146
 147         GoingAway (); /* EMIT SIGNAL */
 148
 149         /* XXX who should close a plugin? */
 150
 151         // dlclose (module);
 152
 153         delete [] _control_data;
 154         delete [] _shadow_data;
 155 }
 156
 157 string
 158 LadspaPlugin::unique_id() const
 159 {
 160         char buf[32];
 161         snprintf (buf, sizeof (buf), "%lu", _descriptor->UniqueID);
 162         return string (buf);
 163 }
 164
 165 float
 166 LadspaPlugin::default_value (uint32_t port)
 167 {
 168         const LADSPA_PortRangeHint *prh = port_range_hints();
 169         float ret = 0.0f;
 170         bool bounds_given = false;
 171         bool sr_scaling = false;
 172         bool earlier_hint = false;
 173
 174         /* defaults - case 1 */
 175
 176         if (LADSPA_IS_HINT_HAS_DEFAULT(prh[port].HintDescriptor)) {
 177                 if (LADSPA_IS_HINT_DEFAULT_MINIMUM(prh[port].HintDescriptor)) {
 178                         ret = prh[port].LowerBound;
 179                         bounds_given = true;
 180                         sr_scaling = true;
 181                         earlier_hint = true;
 182                 }
 183
 184                 /* FIXME: add support for logarithmic defaults */
 185
 186                 else if (LADSPA_IS_HINT_DEFAULT_LOW(prh[port].HintDescriptor)) {
 187                         ret = prh[port].LowerBound * 0.75f + prh[port].UpperBound * 0.25f;
 188                         bounds_given = true;
 189                         sr_scaling = true;
 190                         earlier_hint = true;
 191                 }
 192                 else if (LADSPA_IS_HINT_DEFAULT_MIDDLE(prh[port].HintDescriptor)) {
 193                         ret = prh[port].LowerBound * 0.50f + prh[port].UpperBound * 0.50f;
 194                         bounds_given = true;
 195                         sr_scaling = true;
 196                         earlier_hint = true;
 197                 }
 198                 else if (LADSPA_IS_HINT_DEFAULT_HIGH(prh[port].HintDescriptor)) {
 199                         ret = prh[port].LowerBound * 0.25f + prh[port].UpperBound * 0.75f;
 200                         bounds_given = true;
 201                         sr_scaling = true;
 202                         earlier_hint = true;
 203                 }
 204                 else if (LADSPA_IS_HINT_DEFAULT_MAXIMUM(prh[port].HintDescriptor)) {
 205                         ret = prh[port].UpperBound;
 206                         bounds_given = true;
 207                         sr_scaling = true;
 208                         earlier_hint = true;
 209                 }
 210                 else if (LADSPA_IS_HINT_DEFAULT_0(prh[port].HintDescriptor)) {
 211                         ret = 0.0f;
 212                         earlier_hint = true;
 213                 }
 214                 else if (LADSPA_IS_HINT_DEFAULT_1(prh[port].HintDescriptor)) {
 215                         ret = 1.0f;
 216                         earlier_hint = true;
 217                 }
 218                 else if (LADSPA_IS_HINT_DEFAULT_100(prh[port].HintDescriptor)) {
 219                         ret = 100.0f;
 220                         earlier_hint = true;
 221                 }
 222                 else if (LADSPA_IS_HINT_DEFAULT_440(prh[port].HintDescriptor)) {
 223                         ret = 440.0f;
 224                         earlier_hint = true;
 225                 }
 226                 else {
 227                         /* no hint found */
 228                         ret = 0.0f;
 229                 }
 230         }
 231
 232         /* defaults - case 2 */
 233         else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
 234                  !LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
 235
 236                 if (prh[port].LowerBound < 0) {
 237                         ret = 0.0f;
 238                 } else {
 239                         ret = prh[port].LowerBound;
 240                 }
 241
 242                 bounds_given = true;
 243                 sr_scaling = true;
 244         }
 245
 246         /* defaults - case 3 */
 247         else if (!LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
 248                  LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
 249
 250                 if (prh[port].UpperBound > 0) {
 251                         ret = 0.0f;
 252                 } else {
 253                         ret = prh[port].UpperBound;
 254                 }
 255
 256                 bounds_given = true;
 257                 sr_scaling = true;
 258         }
 259
 260         /* defaults - case 4 */
 261         else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
 262                  LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
 263
 264                 if (prh[port].LowerBound < 0 && prh[port].UpperBound > 0) {
 265                         ret = 0.0f;
 266                 } else if (prh[port].LowerBound < 0 && prh[port].UpperBound < 0) {
 267                         ret = prh[port].UpperBound;
 268                 } else {
 269                         ret = prh[port].LowerBound;
 270                 }
 271                 bounds_given = true;
 272                 sr_scaling = true;
 273         }
 274
 275         /* defaults - case 5 */
 276
 277         if (LADSPA_IS_HINT_SAMPLE_RATE(prh[port].HintDescriptor) && !earlier_hint) {
 278                 if (bounds_given) {
 279                         if (sr_scaling) {
 280                                 ret *= _sample_rate;
 281                         }
 282                 } else {
 283                         ret = _sample_rate;
 284                 }
 285         }
 286
 287         return ret;
 288 }
 289
 290 void
 291 LadspaPlugin::set_parameter (uint32_t which, float val)
 292 {
 293         if (which < _descriptor->PortCount) {
 294                 _shadow_data[which] = (LADSPA_Data) val;
 295 #if 0
 296                 ParameterChanged (Parameter(PluginAutomation, 0, which), val); /* EMIT SIGNAL */
 297
 298                 if (which < parameter_count() && controls[which]) {
 299                         controls[which]->Changed ();
 300                 }
 301 #endif
 302
 303         } else {
 304                 warning << string_compose (_("illegal parameter number used with plugin \"%1\". This may"
 305                                              "indicate a change in the plugin design, and presets may be"
 306                                              "invalid"), name())
 307                         << endmsg;
 308         }
 309 }
 310
 311 float
 312 LadspaPlugin::get_parameter (uint32_t which) const
 313 {
 314         if (LADSPA_IS_PORT_INPUT(port_descriptor (which))) {
 315                 return (float) _shadow_data[which];
 316         } else {
 317                 return (float) _control_data[which];
 318         }
 319 }
 320
 321 uint32_t
 322 LadspaPlugin::nth_parameter (uint32_t n, bool& ok) const
 323 {
 324         uint32_t x, c;
 325
 326         ok = false;
 327
 328         for (c = 0, x = 0; x < _descriptor->PortCount; ++x) {
 329                 if (LADSPA_IS_PORT_CONTROL (port_descriptor (x))) {
 330                         if (c++ == n) {
 331                                 ok = true;
 332                                 return x;
 333                         }
 334                 }
 335         }
 336         return 0;
 337 }
 338
 339 XMLNode&
 340 LadspaPlugin::get_state()
 341 {
 342         XMLNode *root = new XMLNode(state_node_name());
 343         XMLNode *child;
 344         char buf[16];
 345         LocaleGuard lg (X_("POSIX"));
 346
 347         for (uint32_t i = 0; i < parameter_count(); ++i){
 348
 349                 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
 350                     LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
 351
 352                         child = new XMLNode("Port");
 353                         snprintf(buf, sizeof(buf), "%u", i);
 354                         child->add_property("number", string(buf));
 355                         snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
 356                         child->add_property("value", string(buf));
 357                         root->add_child_nocopy (*child);
 358                 }
 359         }
 360
 361         return *root;
 362 }
 363
 364 bool
 365 LadspaPlugin::save_preset (string name)
 366 {
 367         return Plugin::save_preset (name, "ladspa");
 368 }
 369
 370 int
 371 LadspaPlugin::set_state(const XMLNode& node)
 372 {
 373         XMLNodeList nodes;
 374         XMLProperty *prop;
 375         XMLNodeConstIterator iter;
 376         XMLNode *child;
 377         const char *port;
 378         const char *data;
 379         uint32_t port_id;
 380         LocaleGuard lg (X_("POSIX"));
 381
 382         if (node.name() != state_node_name()) {
 383                 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
 384                 return -1;
 385         }
 386
 387         nodes = node.children ("Port");
 388
 389         for(iter = nodes.begin(); iter != nodes.end(); ++iter){
 390
 391                 child = *iter;
 392
 393                 if ((prop = child->property("number")) != 0) {
 394                         port = prop->value().c_str();
 395                 } else {
 396                         warning << _("LADSPA: no ladspa port number") << endmsg;
 397                         continue;
 398                 }
 399                 if ((prop = child->property("value")) != 0) {
 400                         data = prop->value().c_str();
 401                 } else {
 402                         warning << _("LADSPA: no ladspa port data") << endmsg;
 403                         continue;
 404                 }
 405
 406                 sscanf (port, "%" PRIu32, &port_id);
 407                 set_parameter (port_id, atof(data));
 408         }
 409
 410         latency_compute_run ();
 411
 412         return 0;
 413 }
 414
 415 int
 416 LadspaPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
 417 {
 418         LADSPA_PortRangeHint prh;
 419
 420         prh  = port_range_hints()[which];
 421
 422
 423         if (LADSPA_IS_HINT_BOUNDED_BELOW(prh.HintDescriptor)) {
 424                 desc.min_unbound = false;
 425                 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
 426                         desc.lower = prh.LowerBound * _session.frame_rate();
 427                 } else {
 428                         desc.lower = prh.LowerBound;
 429                 }
 430         } else {
 431                 desc.min_unbound = true;
 432                 desc.lower = 0;
 433         }
 434
 435
 436         if (LADSPA_IS_HINT_BOUNDED_ABOVE(prh.HintDescriptor)) {
 437                 desc.max_unbound = false;
 438                 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
 439                         desc.upper = prh.UpperBound * _session.frame_rate();
 440                 } else {
 441                         desc.upper = prh.UpperBound;
 442                 }
 443         } else {
 444                 desc.max_unbound = true;
 445                 desc.upper = 4; /* completely arbitrary */
 446         }
 447
 448         if (LADSPA_IS_HINT_INTEGER (prh.HintDescriptor)) {
 449                 desc.step = 1.0;
 450                 desc.smallstep = 0.1;
 451                 desc.largestep = 10.0;
 452         } else {
 453                 float delta = desc.upper - desc.lower;
 454                 desc.step = delta / 1000.0f;
 455                 desc.smallstep = delta / 10000.0f;
 456                 desc.largestep = delta/10.0f;
 457         }
 458
 459         desc.toggled = LADSPA_IS_HINT_TOGGLED (prh.HintDescriptor);
 460         desc.logarithmic = LADSPA_IS_HINT_LOGARITHMIC (prh.HintDescriptor);
 461         desc.sr_dependent = LADSPA_IS_HINT_SAMPLE_RATE (prh.HintDescriptor);
 462         desc.integer_step = LADSPA_IS_HINT_INTEGER (prh.HintDescriptor);
 463
 464         desc.label = port_names()[which];
 465
 466         return 0;
 467 }
 468
 469 string
 470 LadspaPlugin::describe_parameter (Evoral::Parameter which)
 471 {
 472         if (which.type() == PluginAutomation && which.id() < parameter_count()) {
 473                 return port_names()[which.id()];
 474         } else {
 475                 return "??";
 476         }
 477 }
 478
 479 ARDOUR::nframes_t
 480 LadspaPlugin::signal_latency () const
 481 {
 482         if (_user_latency) {
 483                 return _user_latency;
 484         }
 485
 486         if (_latency_control_port) {
 487                 return (nframes_t) floor (*_latency_control_port);
 488         } else {
 489                 return 0;
 490         }
 491 }
 492
 493 set<Evoral::Parameter>
 494 LadspaPlugin::automatable () const
 495 {
 496         set<Evoral::Parameter> ret;
 497
 498         for (uint32_t i = 0; i < parameter_count(); ++i){
 499                 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
 500                     LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
 501
 502                         ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
 503                 }
 504         }
 505
 506         return ret;
 507 }
 508
 509 int
 510 LadspaPlugin::connect_and_run (BufferSet& bufs,
 511                 ChanMapping in_map, ChanMapping out_map,
 512                 nframes_t nframes, nframes_t offset)
 513 {
 514         cycles_t now;
 515         cycles_t then = get_cycles ();
 516
 517         uint32_t audio_in_index  = 0;
 518         uint32_t audio_out_index = 0;
 519         for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
 520                 if (LADSPA_IS_PORT_AUDIO(port_descriptor(port_index))) {
 521                         if (LADSPA_IS_PORT_INPUT(port_descriptor(port_index))) {
 522                                 const uint32_t buf_index = in_map.get(DataType::AUDIO, audio_in_index++);
 523                                 connect_port(port_index, bufs.get_audio(buf_index).data(offset));
 524                         } else if (LADSPA_IS_PORT_OUTPUT(port_descriptor(port_index))) {
 525                                 const uint32_t buf_index = out_map.get(DataType::AUDIO, audio_out_index++);
 526                                 connect_port(port_index, bufs.get_audio(buf_index).data(offset));
 527                         }
 528                 }
 529         }
 530
 531         run_in_place (nframes);
 532         now = get_cycles ();
 533         set_cycles ((uint32_t) (now - then));
 534
 535         return 0;
 536 }
 537
 538 bool
 539 LadspaPlugin::parameter_is_control (uint32_t param) const
 540 {
 541         return LADSPA_IS_PORT_CONTROL(port_descriptor (param));
 542 }
 543
 544 bool
 545 LadspaPlugin::parameter_is_audio (uint32_t param) const
 546 {
 547         return LADSPA_IS_PORT_AUDIO(port_descriptor (param));
 548 }
 549
 550 bool
 551 LadspaPlugin::parameter_is_output (uint32_t param) const
 552 {
 553         return LADSPA_IS_PORT_OUTPUT(port_descriptor (param));
 554 }
 555
 556 bool
 557 LadspaPlugin::parameter_is_input (uint32_t param) const
 558 {
 559         return LADSPA_IS_PORT_INPUT(port_descriptor (param));
 560 }
 561
 562 void
 563 LadspaPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
 564 {
 565         if (buf && len) {
 566                 if (param < parameter_count()) {
 567                         snprintf (buf, len, "%.3f", get_parameter (param));
 568                 } else {
 569                         strcat (buf, "0");
 570                 }
 571         }
 572 }
 573
 574 void
 575 LadspaPlugin::run_in_place (nframes_t nframes)
 576 {
 577         for (uint32_t i = 0; i < parameter_count(); ++i) {
 578                 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) && LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
 579                         _control_data[i] = _shadow_data[i];
 580                 }
 581         }
 582         _descriptor->run (_handle, nframes);
 583 }
 584
 585 void
 586 LadspaPlugin::latency_compute_run ()
 587 {
 588         if (!_latency_control_port) {
 589                 return;
 590         }
 591
 592         /* we need to run the plugin so that it can set its latency
 593            parameter.
 594         */
 595
 596         activate ();
 597
 598         uint32_t port_index = 0;
 599         uint32_t in_index = 0;
 600         uint32_t out_index = 0;
 601         const nframes_t bufsize = 1024;
 602         LADSPA_Data buffer[bufsize];
 603
 604         memset(buffer,0,sizeof(LADSPA_Data)*bufsize);
 605
 606         /* Note that we've already required that plugins
 607            be able to handle in-place processing.
 608         */
 609
 610         port_index = 0;
 611
 612         while (port_index < parameter_count()) {
 613                 if (LADSPA_IS_PORT_AUDIO (port_descriptor (port_index))) {
 614                         if (LADSPA_IS_PORT_INPUT (port_descriptor (port_index))) {
 615                                 connect_port (port_index, buffer);
 616                                 in_index++;
 617                         } else if (LADSPA_IS_PORT_OUTPUT (port_descriptor (port_index))) {
 618                                 connect_port (port_index, buffer);
 619                                 out_index++;
 620                         }
 621                 }
 622                 port_index++;
 623         }
 624
 625         run_in_place (bufsize);
 626         deactivate ();
 627 }
 628
 629 PluginPtr
 630 LadspaPluginInfo::load (Session& session)
 631 {
 632         try {
 633                 PluginPtr plugin;
 634                 void *module;
 635
 636                 if ((module = dlopen (path.c_str(), RTLD_NOW)) == 0) {
 637                         error << string_compose(_("LADSPA: cannot load module from \"%1\""), path) << endmsg;
 638                         error << dlerror() << endmsg;
 639                 } else {
 640                         plugin.reset (new LadspaPlugin (module, session.engine(), session, index, session.frame_rate()));
 641                 }
 642
 643                 plugin->set_info(PluginInfoPtr(new LadspaPluginInfo(*this)));
 644                 return plugin;
 645         }
 646
 647         catch (failed_constructor &err) {
 648                 return PluginPtr ((Plugin*) 0);
 649         }
 650 }