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