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/pathscanner.h>
  38 #include <pbd/xml++.h>
  39
  40 #include <midi++/manager.h>
  41
  42 #include <ardour/ardour.h>
  43 #include <ardour/session.h>
  44 #include <ardour/audioengine.h>
  45 #include <ardour/ladspa_plugin.h>
  46 #include <ardour/buffer_set.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         if (control_data) {
 154                 delete [] control_data;
 155         }
 156
 157         if (shadow_data) {
 158                 delete [] shadow_data;
 159         }
 160 }
 161
 162 void
 163 LadspaPlugin::store_state (PluginState& state)
 164 {
 165         state.parameters.clear ();
 166
 167         for (uint32_t i = 0; i < parameter_count(); ++i){
 168
 169                 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
 170                     LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
 171                         pair<uint32_t,float> datum;
 172
 173                         datum.first = i;
 174                         datum.second = shadow_data[i];
 175
 176                         state.parameters.insert (datum);
 177                 }
 178         }
 179 }
 180
 181 void
 182 LadspaPlugin::restore_state (PluginState& state)
 183 {
 184         for (map<uint32_t,float>::iterator i = state.parameters.begin(); i != state.parameters.end(); ++i) {
 185                 set_parameter (i->first, i->second);
 186         }
 187 }
 188
 189 float
 190 LadspaPlugin::default_value (uint32_t port)
 191 {
 192         const LADSPA_PortRangeHint *prh = port_range_hints();
 193         float ret = 0.0f;
 194         bool bounds_given = false;
 195         bool sr_scaling = false;
 196         bool earlier_hint = false;
 197
 198         /* defaults - case 1 */
 199
 200         if (LADSPA_IS_HINT_HAS_DEFAULT(prh[port].HintDescriptor)) {
 201                 if (LADSPA_IS_HINT_DEFAULT_MINIMUM(prh[port].HintDescriptor)) {
 202                         ret = prh[port].LowerBound;
 203                         bounds_given = true;
 204                         sr_scaling = true;
 205                         earlier_hint = true;
 206                 }
 207
 208                 /* FIXME: add support for logarithmic defaults */
 209
 210                 else if (LADSPA_IS_HINT_DEFAULT_LOW(prh[port].HintDescriptor)) {
 211                         ret = prh[port].LowerBound * 0.75f + prh[port].UpperBound * 0.25f;
 212                         bounds_given = true;
 213                         sr_scaling = true;
 214                         earlier_hint = true;
 215                 }
 216                 else if (LADSPA_IS_HINT_DEFAULT_MIDDLE(prh[port].HintDescriptor)) {
 217                         ret = prh[port].LowerBound * 0.50f + prh[port].UpperBound * 0.50f;
 218                         bounds_given = true;
 219                         sr_scaling = true;
 220                         earlier_hint = true;
 221                 }
 222                 else if (LADSPA_IS_HINT_DEFAULT_HIGH(prh[port].HintDescriptor)) {
 223                         ret = prh[port].LowerBound * 0.25f + prh[port].UpperBound * 0.75f;
 224                         bounds_given = true;
 225                         sr_scaling = true;
 226                         earlier_hint = true;
 227                 }
 228                 else if (LADSPA_IS_HINT_DEFAULT_MAXIMUM(prh[port].HintDescriptor)) {
 229                         ret = prh[port].UpperBound;
 230                         bounds_given = true;
 231                         sr_scaling = true;
 232                         earlier_hint = true;
 233                 }
 234                 else if (LADSPA_IS_HINT_DEFAULT_0(prh[port].HintDescriptor)) {
 235                         ret = 0.0f;
 236                         earlier_hint = true;
 237                 }
 238                 else if (LADSPA_IS_HINT_DEFAULT_1(prh[port].HintDescriptor)) {
 239                         ret = 1.0f;
 240                         earlier_hint = true;
 241                 }
 242                 else if (LADSPA_IS_HINT_DEFAULT_100(prh[port].HintDescriptor)) {
 243                         ret = 100.0f;
 244                         earlier_hint = true;
 245                 }
 246                 else if (LADSPA_IS_HINT_DEFAULT_440(prh[port].HintDescriptor)) {
 247                         ret = 440.0f;
 248                         earlier_hint = true;
 249                 }
 250                 else {
 251                         /* no hint found */
 252                         ret = 0.0f;
 253                 }
 254         }
 255
 256         /* defaults - case 2 */
 257         else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
 258                  !LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
 259
 260                 if (prh[port].LowerBound < 0) {
 261                         ret = 0.0f;
 262                 } else {
 263                         ret = prh[port].LowerBound;
 264                 }
 265
 266                 bounds_given = true;
 267                 sr_scaling = true;
 268         }
 269
 270         /* defaults - case 3 */
 271         else if (!LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
 272                  LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
 273
 274                 if (prh[port].UpperBound > 0) {
 275                         ret = 0.0f;
 276                 } else {
 277                         ret = prh[port].UpperBound;
 278                 }
 279
 280                 bounds_given = true;
 281                 sr_scaling = true;
 282         }
 283
 284         /* defaults - case 4 */
 285         else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
 286                  LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
 287
 288                 if (prh[port].LowerBound < 0 && prh[port].UpperBound > 0) {
 289                         ret = 0.0f;
 290                 } else if (prh[port].LowerBound < 0 && prh[port].UpperBound < 0) {
 291                         ret = prh[port].UpperBound;
 292                 } else {
 293                         ret = prh[port].LowerBound;
 294                 }
 295                 bounds_given = true;
 296                 sr_scaling = true;
 297         }
 298
 299         /* defaults - case 5 */
 300
 301         if (LADSPA_IS_HINT_SAMPLE_RATE(prh[port].HintDescriptor) && !earlier_hint) {
 302                 if (bounds_given) {
 303                         if (sr_scaling) {
 304                                 ret *= sample_rate;
 305                         }
 306                 } else {
 307                         ret = sample_rate;
 308                 }
 309         }
 310
 311         return ret;
 312 }
 313
 314 void
 315 LadspaPlugin::set_parameter (uint32_t which, float val)
 316 {
 317         if (which < descriptor->PortCount) {
 318                 shadow_data[which] = (LADSPA_Data) val;
 319 #if 0
 320                 ParameterChanged (Parameter(PluginAutomation, which), val); /* EMIT SIGNAL */
 321
 322                 if (which < parameter_count() && controls[which]) {
 323                         controls[which]->Changed ();
 324                 }
 325 #endif
 326
 327         } else {
 328                 warning << string_compose (_("illegal parameter number used with plugin \"%1\". This may"
 329                                              "indicate a change in the plugin design, and presets may be"
 330                                              "invalid"), name())
 331                         << endmsg;
 332         }
 333 }
 334
 335 float
 336 LadspaPlugin::get_parameter (uint32_t which) const
 337 {
 338         if (LADSPA_IS_PORT_INPUT(port_descriptor (which))) {
 339                 return (float) shadow_data[which];
 340         } else {
 341                 return (float) control_data[which];
 342         }
 343 }
 344
 345 uint32_t
 346 LadspaPlugin::nth_parameter (uint32_t n, bool& ok) const
 347 {
 348         uint32_t x, c;
 349
 350         ok = false;
 351
 352         for (c = 0, x = 0; x < descriptor->PortCount; ++x) {
 353                 if (LADSPA_IS_PORT_CONTROL (port_descriptor (x))) {
 354                         if (c++ == n) {
 355                                 ok = true;
 356                                 return x;
 357                         }
 358                 }
 359         }
 360         return 0;
 361 }
 362
 363 XMLNode&
 364 LadspaPlugin::get_state()
 365 {
 366         XMLNode *root = new XMLNode(state_node_name());
 367         XMLNode *child;
 368         char buf[16];
 369         LocaleGuard lg (X_("POSIX"));
 370
 371         for (uint32_t i = 0; i < parameter_count(); ++i){
 372
 373                 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
 374                     LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
 375
 376                         child = new XMLNode("port");
 377                         snprintf(buf, sizeof(buf), "%u", i);
 378                         child->add_property("number", string(buf));
 379                         snprintf(buf, sizeof(buf), "%+f", shadow_data[i]);
 380                         child->add_property("value", string(buf));
 381                         root->add_child_nocopy (*child);
 382                 }
 383         }
 384
 385         return *root;
 386 }
 387
 388 bool
 389 LadspaPlugin::save_preset (string name)
 390 {
 391         return Plugin::save_preset (name, "ladspa");
 392 }
 393
 394 int
 395 LadspaPlugin::set_state(const XMLNode& node)
 396 {
 397         XMLNodeList nodes;
 398         XMLProperty *prop;
 399         XMLNodeConstIterator iter;
 400         XMLNode *child;
 401         const char *port;
 402         const char *data;
 403         uint32_t port_id;
 404         LocaleGuard lg (X_("POSIX"));
 405
 406         if (node.name() != state_node_name()) {
 407                 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
 408                 return -1;
 409         }
 410
 411         nodes = node.children ("port");
 412
 413         for(iter = nodes.begin(); iter != nodes.end(); ++iter){
 414
 415                 child = *iter;
 416
 417                 if ((prop = child->property("number")) != 0) {
 418                         port = prop->value().c_str();
 419                 } else {
 420                         warning << _("LADSPA: no ladspa port number") << endmsg;
 421                         continue;
 422                 }
 423                 if ((prop = child->property("value")) != 0) {
 424                         data = prop->value().c_str();
 425                 } else {
 426                         warning << _("LADSPA: no ladspa port data") << endmsg;
 427                         continue;
 428                 }
 429
 430                 sscanf (port, "%" PRIu32, &port_id);
 431                 set_parameter (port_id, atof(data));
 432         }
 433
 434         latency_compute_run ();
 435
 436         return 0;
 437 }
 438
 439 int
 440 LadspaPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
 441 {
 442         LADSPA_PortRangeHint prh;
 443
 444         prh  = port_range_hints()[which];
 445
 446
 447         if (LADSPA_IS_HINT_BOUNDED_BELOW(prh.HintDescriptor)) {
 448                 desc.min_unbound = false;
 449                 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
 450                         desc.lower = prh.LowerBound * _session.frame_rate();
 451                 } else {
 452                         desc.lower = prh.LowerBound;
 453                 }
 454         } else {
 455                 desc.min_unbound = true;
 456                 desc.lower = 0;
 457         }
 458
 459
 460         if (LADSPA_IS_HINT_BOUNDED_ABOVE(prh.HintDescriptor)) {
 461                 desc.max_unbound = false;
 462                 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
 463                         desc.upper = prh.UpperBound * _session.frame_rate();
 464                 } else {
 465                         desc.upper = prh.UpperBound;
 466                 }
 467         } else {
 468                 desc.max_unbound = true;
 469                 desc.upper = 4; /* completely arbitrary */
 470         }
 471
 472         if (LADSPA_IS_HINT_INTEGER (prh.HintDescriptor)) {
 473                 desc.step = 1.0;
 474                 desc.smallstep = 0.1;
 475                 desc.largestep = 10.0;
 476         } else {
 477                 float delta = desc.upper - desc.lower;
 478                 desc.step = delta / 1000.0f;
 479                 desc.smallstep = delta / 10000.0f;
 480                 desc.largestep = delta/10.0f;
 481         }
 482
 483         desc.toggled = LADSPA_IS_HINT_TOGGLED (prh.HintDescriptor);
 484         desc.logarithmic = LADSPA_IS_HINT_LOGARITHMIC (prh.HintDescriptor);
 485         desc.sr_dependent = LADSPA_IS_HINT_SAMPLE_RATE (prh.HintDescriptor);
 486         desc.integer_step = LADSPA_IS_HINT_INTEGER (prh.HintDescriptor);
 487
 488         desc.label = port_names()[which];
 489
 490
 491         return 0;
 492 }
 493
 494 string
 495 LadspaPlugin::describe_parameter (Parameter which)
 496 {
 497         if (which.type() == PluginAutomation && which.id() < parameter_count()) {
 498                 return port_names()[which.id()];
 499         } else {
 500                 return "??";
 501         }
 502 }
 503
 504 ARDOUR::nframes_t
 505 LadspaPlugin::signal_latency () const
 506 {
 507         if (_user_latency) {
 508                 return _user_latency;
 509         }
 510
 511         if (latency_control_port) {
 512                 return (nframes_t) floor (*latency_control_port);
 513         } else {
 514                 return 0;
 515         }
 516 }
 517
 518 set<Parameter>
 519 LadspaPlugin::automatable () const
 520 {
 521         set<Parameter> ret;
 522
 523         for (uint32_t i = 0; i < parameter_count(); ++i){
 524                 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
 525                     LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
 526
 527                         ret.insert (ret.end(), Parameter(PluginAutomation, i));
 528                 }
 529         }
 530
 531         return ret;
 532 }
 533
 534 int
 535 LadspaPlugin::connect_and_run (BufferSet& bufs, uint32_t& in_index, uint32_t& out_index, nframes_t nframes, nframes_t offset)
 536 {
 537         uint32_t port_index = 0;
 538         cycles_t then, now;
 539
 540         then = get_cycles ();
 541
 542         const uint32_t nbufs = bufs.count().n_audio();
 543
 544         while (port_index < parameter_count()) {
 545                 if (LADSPA_IS_PORT_AUDIO (port_descriptor(port_index))) {
 546                         if (LADSPA_IS_PORT_INPUT (port_descriptor(port_index))) {
 547                                 const size_t index = min(in_index, nbufs - 1);
 548                                 connect_port (port_index, bufs.get_audio(index).data(nframes, offset));
 549                                 //cerr << this << ' ' << name() << " @ " << offset << " inport " << in_index << " = buf "
 550                                 //     << min((uint32_t)in_index,nbufs) << " = " << &bufs[min((uint32_t)in_index,nbufs)][offset] << endl;
 551                                 in_index++;
 552
 553
 554                         } else if (LADSPA_IS_PORT_OUTPUT (port_descriptor (port_index))) {
 555                                 const size_t index = min(out_index,nbufs - 1);
 556                                 connect_port (port_index, bufs.get_audio(index).data(nframes, offset));
 557                                 // cerr << this << ' ' << name() << " @ " << offset << " outport " << out_index << " = buf "
 558                                 //     << min((uint32_t)out_index,nbufs) << " = " << &bufs[min((uint32_t)out_index,nbufs)][offset] << endl;
 559                                 out_index++;
 560                         }
 561                 }
 562                 port_index++;
 563         }
 564
 565         run (nframes);
 566         now = get_cycles ();
 567         set_cycles ((uint32_t) (now - then));
 568
 569         return 0;
 570 }
 571
 572 bool
 573 LadspaPlugin::parameter_is_control (uint32_t param) const
 574 {
 575         return LADSPA_IS_PORT_CONTROL(port_descriptor (param));
 576 }
 577
 578 bool
 579 LadspaPlugin::parameter_is_audio (uint32_t param) const
 580 {
 581         return LADSPA_IS_PORT_AUDIO(port_descriptor (param));
 582 }
 583
 584 bool
 585 LadspaPlugin::parameter_is_output (uint32_t param) const
 586 {
 587         return LADSPA_IS_PORT_OUTPUT(port_descriptor (param));
 588 }
 589
 590 bool
 591 LadspaPlugin::parameter_is_input (uint32_t param) const
 592 {
 593         return LADSPA_IS_PORT_INPUT(port_descriptor (param));
 594 }
 595
 596 void
 597 LadspaPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
 598 {
 599         if (buf && len) {
 600                 if (param < parameter_count()) {
 601                         snprintf (buf, len, "%.3f", get_parameter (param));
 602                 } else {
 603                         strcat (buf, "0");
 604                 }
 605         }
 606 }
 607
 608 void
 609 LadspaPlugin::run (nframes_t nframes)
 610 {
 611         for (uint32_t i = 0; i < parameter_count(); ++i) {
 612                 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) && LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
 613                         control_data[i] = shadow_data[i];
 614                 }
 615         }
 616         descriptor->run (handle, nframes);
 617 }
 618
 619 void
 620 LadspaPlugin::latency_compute_run ()
 621 {
 622         if (!latency_control_port) {
 623                 return;
 624         }
 625
 626         /* we need to run the plugin so that it can set its latency
 627            parameter.
 628         */
 629
 630         activate ();
 631
 632         uint32_t port_index = 0;
 633         uint32_t in_index = 0;
 634         uint32_t out_index = 0;
 635         const nframes_t bufsize = 1024;
 636         LADSPA_Data buffer[bufsize];
 637
 638         memset(buffer,0,sizeof(LADSPA_Data)*bufsize);
 639
 640         /* Note that we've already required that plugins
 641            be able to handle in-place processing.
 642         */
 643
 644         port_index = 0;
 645
 646         while (port_index < parameter_count()) {
 647                 if (LADSPA_IS_PORT_AUDIO (port_descriptor (port_index))) {
 648                         if (LADSPA_IS_PORT_INPUT (port_descriptor (port_index))) {
 649                                 connect_port (port_index, buffer);
 650                                 in_index++;
 651                         } else if (LADSPA_IS_PORT_OUTPUT (port_descriptor (port_index))) {
 652                                 connect_port (port_index, buffer);
 653                                 out_index++;
 654                         }
 655                 }
 656                 port_index++;
 657         }
 658
 659         run (bufsize);
 660         deactivate ();
 661 }
 662
 663 PluginPtr
 664 LadspaPluginInfo::load (Session& session)
 665 {
 666         try {
 667                 PluginPtr plugin;
 668                 void *module;
 669
 670                 if ((module = dlopen (path.c_str(), RTLD_NOW)) == 0) {
 671                         error << string_compose(_("LADSPA: cannot load module from \"%1\""), path) << endmsg;
 672                         error << dlerror() << endmsg;
 673                 } else {
 674                         plugin.reset (new LadspaPlugin (module, session.engine(), session, index, session.frame_rate()));
 675                 }
 676
 677                 plugin->set_info(PluginInfoPtr(new LadspaPluginInfo(*this)));
 678                 return plugin;
 679         }
 680
 681         catch (failed_constructor &err) {
 682                 return PluginPtr ((Plugin*) 0);
 683         }
 684 }