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