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         Plugin::setup_controls ();
 140
 141         latency_compute_run ();
 142 }
 143
 144 LadspaPlugin::~LadspaPlugin ()
 145 {
 146         deactivate ();
 147         cleanup ();
 148
 149         GoingAway (); /* EMIT SIGNAL */
 150
 151         /* XXX who should close a plugin? */
 152
 153         // dlclose (module);
 154
 155         if (control_data) {
 156                 delete [] control_data;
 157         }
 158
 159         if (shadow_data) {
 160                 delete [] shadow_data;
 161         }
 162 }
 163
 164 void
 165 LadspaPlugin::store_state (PluginState& state)
 166 {
 167         state.parameters.clear ();
 168
 169         for (uint32_t i = 0; i < parameter_count(); ++i){
 170
 171                 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
 172                     LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
 173                         pair<uint32_t,float> datum;
 174
 175                         datum.first = i;
 176                         datum.second = shadow_data[i];
 177
 178                         state.parameters.insert (datum);
 179                 }
 180         }
 181 }
 182
 183 void
 184 LadspaPlugin::restore_state (PluginState& state)
 185 {
 186         for (map<uint32_t,float>::iterator i = state.parameters.begin(); i != state.parameters.end(); ++i) {
 187                 set_parameter (i->first, i->second);
 188         }
 189 }
 190
 191 float
 192 LadspaPlugin::default_value (uint32_t port)
 193 {
 194         const LADSPA_PortRangeHint *prh = port_range_hints();
 195         float ret = 0.0f;
 196         bool bounds_given = false;
 197         bool sr_scaling = false;
 198         bool earlier_hint = false;
 199
 200         /* defaults - case 1 */
 201
 202         if (LADSPA_IS_HINT_HAS_DEFAULT(prh[port].HintDescriptor)) {
 203                 if (LADSPA_IS_HINT_DEFAULT_MINIMUM(prh[port].HintDescriptor)) {
 204                         ret = prh[port].LowerBound;
 205                         bounds_given = true;
 206                         sr_scaling = true;
 207                         earlier_hint = true;
 208                 }
 209
 210                 /* FIXME: add support for logarithmic defaults */
 211
 212                 else if (LADSPA_IS_HINT_DEFAULT_LOW(prh[port].HintDescriptor)) {
 213                         ret = prh[port].LowerBound * 0.75f + prh[port].UpperBound * 0.25f;
 214                         bounds_given = true;
 215                         sr_scaling = true;
 216                         earlier_hint = true;
 217                 }
 218                 else if (LADSPA_IS_HINT_DEFAULT_MIDDLE(prh[port].HintDescriptor)) {
 219                         ret = prh[port].LowerBound * 0.50f + prh[port].UpperBound * 0.50f;
 220                         bounds_given = true;
 221                         sr_scaling = true;
 222                         earlier_hint = true;
 223                 }
 224                 else if (LADSPA_IS_HINT_DEFAULT_HIGH(prh[port].HintDescriptor)) {
 225                         ret = prh[port].LowerBound * 0.25f + prh[port].UpperBound * 0.75f;
 226                         bounds_given = true;
 227                         sr_scaling = true;
 228                         earlier_hint = true;
 229                 }
 230                 else if (LADSPA_IS_HINT_DEFAULT_MAXIMUM(prh[port].HintDescriptor)) {
 231                         ret = prh[port].UpperBound;
 232                         bounds_given = true;
 233                         sr_scaling = true;
 234                         earlier_hint = true;
 235                 }
 236                 else if (LADSPA_IS_HINT_DEFAULT_0(prh[port].HintDescriptor)) {
 237                         ret = 0.0f;
 238                         earlier_hint = true;
 239                 }
 240                 else if (LADSPA_IS_HINT_DEFAULT_1(prh[port].HintDescriptor)) {
 241                         ret = 1.0f;
 242                         earlier_hint = true;
 243                 }
 244                 else if (LADSPA_IS_HINT_DEFAULT_100(prh[port].HintDescriptor)) {
 245                         ret = 100.0f;
 246                         earlier_hint = true;
 247                 }
 248                 else if (LADSPA_IS_HINT_DEFAULT_440(prh[port].HintDescriptor)) {
 249                         ret = 440.0f;
 250                         earlier_hint = true;
 251                 }
 252                 else {
 253                         /* no hint found */
 254                         ret = 0.0f;
 255                 }
 256         }
 257
 258         /* defaults - case 2 */
 259         else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
 260                  !LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
 261
 262                 if (prh[port].LowerBound < 0) {
 263                         ret = 0.0f;
 264                 } else {
 265                         ret = prh[port].LowerBound;
 266                 }
 267
 268                 bounds_given = true;
 269                 sr_scaling = true;
 270         }
 271
 272         /* defaults - case 3 */
 273         else if (!LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
 274                  LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
 275
 276                 if (prh[port].UpperBound > 0) {
 277                         ret = 0.0f;
 278                 } else {
 279                         ret = prh[port].UpperBound;
 280                 }
 281
 282                 bounds_given = true;
 283                 sr_scaling = true;
 284         }
 285
 286         /* defaults - case 4 */
 287         else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
 288                  LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
 289
 290                 if (prh[port].LowerBound < 0 && prh[port].UpperBound > 0) {
 291                         ret = 0.0f;
 292                 } else if (prh[port].LowerBound < 0 && prh[port].UpperBound < 0) {
 293                         ret = prh[port].UpperBound;
 294                 } else {
 295                         ret = prh[port].LowerBound;
 296                 }
 297                 bounds_given = true;
 298                 sr_scaling = true;
 299         }
 300
 301         /* defaults - case 5 */
 302
 303         if (LADSPA_IS_HINT_SAMPLE_RATE(prh[port].HintDescriptor) && !earlier_hint) {
 304                 if (bounds_given) {
 305                         if (sr_scaling) {
 306                                 ret *= sample_rate;
 307                         }
 308                 } else {
 309                         ret = sample_rate;
 310                 }
 311         }
 312
 313         return ret;
 314 }
 315
 316 void
 317 LadspaPlugin::set_parameter (uint32_t which, float val)
 318 {
 319         if (which < descriptor->PortCount) {
 320                 shadow_data[which] = (LADSPA_Data) val;
 321                 ParameterChanged (which, val); /* EMIT SIGNAL */
 322
 323                 if (which < parameter_count() && controls[which]) {
 324                         controls[which]->Changed ();
 325                 }
 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
 495 string
 496 LadspaPlugin::describe_parameter (uint32_t which)
 497 {
 498         if (which < parameter_count()) {
 499                 return port_names()[which];
 500         } else {
 501                 return "??";
 502         }
 503 }
 504
 505 ARDOUR::nframes_t
 506 LadspaPlugin::latency () const
 507 {
 508         if (latency_control_port) {
 509                 return (nframes_t) floor (*latency_control_port);
 510         } else {
 511                 return 0;
 512         }
 513 }
 514
 515 set<uint32_t>
 516 LadspaPlugin::automatable () const
 517 {
 518         set<uint32_t> ret;
 519
 520         for (uint32_t i = 0; i < parameter_count(); ++i){
 521                 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
 522                     LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
 523
 524                         ret.insert (ret.end(), i);
 525                 }
 526         }
 527
 528         return ret;
 529 }
 530
 531 int
 532 LadspaPlugin::connect_and_run (BufferSet& bufs, uint32_t& in_index, uint32_t& out_index, nframes_t nframes, nframes_t offset)
 533 {
 534         uint32_t port_index = 0;
 535         cycles_t then, now;
 536
 537         then = get_cycles ();
 538
 539         const uint32_t nbufs = bufs.count().n_audio();
 540
 541         while (port_index < parameter_count()) {
 542                 if (LADSPA_IS_PORT_AUDIO (port_descriptor(port_index))) {
 543                         if (LADSPA_IS_PORT_INPUT (port_descriptor(port_index))) {
 544                                 const size_t index = min(in_index, nbufs - 1);
 545                                 connect_port (port_index, bufs.get_audio(index).data(nframes, offset));
 546                                 //cerr << this << ' ' << name() << " @ " << offset << " inport " << in_index << " = buf "
 547                                 //     << min((uint32_t)in_index,nbufs) << " = " << &bufs[min((uint32_t)in_index,nbufs)][offset] << endl;
 548                                 in_index++;
 549
 550
 551                         } else if (LADSPA_IS_PORT_OUTPUT (port_descriptor (port_index))) {
 552                                 const size_t index = min(out_index,nbufs - 1);
 553                                 connect_port (port_index, bufs.get_audio(index).data(nframes, offset));
 554                                 // cerr << this << ' ' << name() << " @ " << offset << " outport " << out_index << " = buf "
 555                                 //     << min((uint32_t)out_index,nbufs) << " = " << &bufs[min((uint32_t)out_index,nbufs)][offset] << endl;
 556                                 out_index++;
 557                         }
 558                 }
 559                 port_index++;
 560         }
 561
 562         run (nframes);
 563         now = get_cycles ();
 564         set_cycles ((uint32_t) (now - then));
 565
 566         return 0;
 567 }
 568
 569 bool
 570 LadspaPlugin::parameter_is_control (uint32_t param) const
 571 {
 572         return LADSPA_IS_PORT_CONTROL(port_descriptor (param));
 573 }
 574
 575 bool
 576 LadspaPlugin::parameter_is_audio (uint32_t param) const
 577 {
 578         return LADSPA_IS_PORT_AUDIO(port_descriptor (param));
 579 }
 580
 581 bool
 582 LadspaPlugin::parameter_is_output (uint32_t param) const
 583 {
 584         return LADSPA_IS_PORT_OUTPUT(port_descriptor (param));
 585 }
 586
 587 bool
 588 LadspaPlugin::parameter_is_input (uint32_t param) const
 589 {
 590         return LADSPA_IS_PORT_INPUT(port_descriptor (param));
 591 }
 592
 593 void
 594 LadspaPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
 595 {
 596         if (buf && len) {
 597                 if (param < parameter_count()) {
 598                         snprintf (buf, len, "%.3f", get_parameter (param));
 599                 } else {
 600                         strcat (buf, "0");
 601                 }
 602         }
 603 }
 604
 605 void
 606 LadspaPlugin::run (nframes_t nframes)
 607 {
 608         for (uint32_t i = 0; i < parameter_count(); ++i) {
 609                 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) && LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
 610                         control_data[i] = shadow_data[i];
 611                 }
 612         }
 613         descriptor->run (handle, nframes);
 614 }
 615
 616 void
 617 LadspaPlugin::latency_compute_run ()
 618 {
 619         if (!latency_control_port) {
 620                 return;
 621         }
 622
 623         /* we need to run the plugin so that it can set its latency
 624            parameter.
 625         */
 626
 627         activate ();
 628
 629         uint32_t port_index = 0;
 630         uint32_t in_index = 0;
 631         uint32_t out_index = 0;
 632         const nframes_t bufsize = 1024;
 633         LADSPA_Data buffer[bufsize];
 634
 635         memset(buffer,0,sizeof(LADSPA_Data)*bufsize);
 636
 637         /* Note that we've already required that plugins
 638            be able to handle in-place processing.
 639         */
 640
 641         port_index = 0;
 642
 643         while (port_index < parameter_count()) {
 644                 if (LADSPA_IS_PORT_AUDIO (port_descriptor (port_index))) {
 645                         if (LADSPA_IS_PORT_INPUT (port_descriptor (port_index))) {
 646                                 connect_port (port_index, buffer);
 647                                 in_index++;
 648                         } else if (LADSPA_IS_PORT_OUTPUT (port_descriptor (port_index))) {
 649                                 connect_port (port_index, buffer);
 650                                 out_index++;
 651                         }
 652                 }
 653                 port_index++;
 654         }
 655
 656         run (bufsize);
 657         deactivate ();
 658 }
 659
 660 PluginPtr
 661 LadspaPluginInfo::load (Session& session)
 662 {
 663         try {
 664                 PluginPtr plugin;
 665                 void *module;
 666
 667                 if ((module = dlopen (path.c_str(), RTLD_NOW)) == 0) {
 668                         error << string_compose(_("LADSPA: cannot load module from \"%1\""), path) << endmsg;
 669                         error << dlerror() << endmsg;
 670                 } else {
 671                         plugin.reset (new LadspaPlugin (module, session.engine(), session, index, session.frame_rate()));
 672                 }
 673
 674                 plugin->set_info(PluginInfoPtr(new LadspaPluginInfo(*this)));
 675                 return plugin;
 676         }
 677
 678         catch (failed_constructor &err) {
 679                 return PluginPtr ((Plugin*) 0);
 680         }
 681 }