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 #include <inttypes.h>
  21
  22 #include <vector>
  23 #include <string>
  24
  25 #include <cstdlib>
  26 #include <cstdio> // so libraptor doesn't complain
  27 #include <cmath>
  28 #include <dirent.h>
  29 #include <sys/stat.h>
  30 #include <cerrno>
  31
  32 #include <lrdf.h>
  33
  34 #include "pbd/compose.h"
  35 #include "pbd/error.h"
  36 #include "pbd/xml++.h"
  37
  38 #include "midi++/manager.h"
  39
  40 #include "ardour/ardour.h"
  41 #include "ardour/session.h"
  42 #include "ardour/audioengine.h"
  43 #include "ardour/ladspa_plugin.h"
  44 #include "ardour/buffer_set.h"
  45 #include "ardour/audio_buffer.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, framecnt_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, framecnt_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         /* XXX who should close a plugin? */
 147
 148         // dlclose (module);
 149
 150         delete [] _control_data;
 151         delete [] _shadow_data;
 152 }
 153
 154 string
 155 LadspaPlugin::unique_id() const
 156 {
 157         char buf[32];
 158         snprintf (buf, sizeof (buf), "%lu", _descriptor->UniqueID);
 159         return string (buf);
 160 }
 161
 162 float
 163 LadspaPlugin::default_value (uint32_t port)
 164 {
 165         const LADSPA_PortRangeHint *prh = port_range_hints();
 166         float ret = 0.0f;
 167         bool bounds_given = false;
 168         bool sr_scaling = false;
 169         bool earlier_hint = false;
 170
 171         /* defaults - case 1 */
 172
 173         if (LADSPA_IS_HINT_HAS_DEFAULT(prh[port].HintDescriptor)) {
 174                 if (LADSPA_IS_HINT_DEFAULT_MINIMUM(prh[port].HintDescriptor)) {
 175                         ret = prh[port].LowerBound;
 176                         bounds_given = true;
 177                         sr_scaling = true;
 178                 }
 179
 180                 else if (LADSPA_IS_HINT_DEFAULT_LOW(prh[port].HintDescriptor)) {
 181                         if (LADSPA_IS_HINT_LOGARITHMIC(prh[port].HintDescriptor)) {
 182                                 ret = exp(log(prh[port].LowerBound) * 0.75f + log(prh[port].UpperBound) * 0.25f);
 183                         }
 184                         else {
 185                                 ret = prh[port].LowerBound * 0.75f + prh[port].UpperBound * 0.25f;
 186                         }
 187                         bounds_given = true;
 188                         sr_scaling = true;
 189                 }
 190                 else if (LADSPA_IS_HINT_DEFAULT_MIDDLE(prh[port].HintDescriptor)) {
 191                         if (LADSPA_IS_HINT_LOGARITHMIC(prh[port].HintDescriptor)) {
 192                                 ret = exp(log(prh[port].LowerBound) * 0.5f + log(prh[port].UpperBound) * 0.5f);
 193                         }
 194                         else {
 195                                 ret = prh[port].LowerBound * 0.5f + prh[port].UpperBound * 0.5f;
 196                         }
 197                         bounds_given = true;
 198                         sr_scaling = true;
 199                 }
 200                 else if (LADSPA_IS_HINT_DEFAULT_HIGH(prh[port].HintDescriptor)) {
 201                         if (LADSPA_IS_HINT_LOGARITHMIC(prh[port].HintDescriptor)) {
 202                                 ret = exp(log(prh[port].LowerBound) * 0.25f + log(prh[port].UpperBound) * 0.75f);
 203                         }
 204                         else {
 205                                 ret = prh[port].LowerBound * 0.25f + prh[port].UpperBound * 0.75f;
 206                         }
 207                         bounds_given = true;
 208                         sr_scaling = true;
 209                 }
 210                 else if (LADSPA_IS_HINT_DEFAULT_MAXIMUM(prh[port].HintDescriptor)) {
 211                         ret = prh[port].UpperBound;
 212                         bounds_given = true;
 213                         sr_scaling = true;
 214                 }
 215                 else if (LADSPA_IS_HINT_DEFAULT_0(prh[port].HintDescriptor)) {
 216                         ret = 0.0f;
 217                         earlier_hint = true;
 218                 }
 219                 else if (LADSPA_IS_HINT_DEFAULT_1(prh[port].HintDescriptor)) {
 220                         ret = 1.0f;
 221                         earlier_hint = true;
 222                 }
 223                 else if (LADSPA_IS_HINT_DEFAULT_100(prh[port].HintDescriptor)) {
 224                         ret = 100.0f;
 225                         earlier_hint = true;
 226                 }
 227                 else if (LADSPA_IS_HINT_DEFAULT_440(prh[port].HintDescriptor)) {
 228                         ret = 440.0f;
 229                         earlier_hint = true;
 230                 }
 231                 else {
 232                         /* no hint found */
 233                         ret = 0.0f;
 234                 }
 235         }
 236
 237         /* defaults - case 2 */
 238         else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
 239                  !LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
 240
 241                 if (prh[port].LowerBound < 0) {
 242                         ret = 0.0f;
 243                 } else {
 244                         ret = prh[port].LowerBound;
 245                 }
 246
 247                 bounds_given = true;
 248                 sr_scaling = true;
 249         }
 250
 251         /* defaults - case 3 */
 252         else if (!LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
 253                  LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
 254
 255                 if (prh[port].UpperBound > 0) {
 256                         ret = 0.0f;
 257                 } else {
 258                         ret = prh[port].UpperBound;
 259                 }
 260
 261                 bounds_given = true;
 262                 sr_scaling = true;
 263         }
 264
 265         /* defaults - case 4 */
 266         else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
 267                  LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
 268
 269                 if (prh[port].LowerBound < 0 && prh[port].UpperBound > 0) {
 270                         ret = 0.0f;
 271                 } else if (prh[port].LowerBound < 0 && prh[port].UpperBound < 0) {
 272                         ret = prh[port].UpperBound;
 273                 } else {
 274                         ret = prh[port].LowerBound;
 275                 }
 276                 bounds_given = true;
 277                 sr_scaling = true;
 278         }
 279
 280         /* defaults - case 5 */
 281
 282         if (LADSPA_IS_HINT_SAMPLE_RATE(prh[port].HintDescriptor) && !earlier_hint) {
 283                 if (bounds_given) {
 284                         if (sr_scaling) {
 285                                 ret *= _sample_rate;
 286                         }
 287                 } else {
 288                         ret = _sample_rate;
 289                 }
 290         }
 291
 292         return ret;
 293 }
 294
 295 void
 296 LadspaPlugin::set_parameter (uint32_t which, float val)
 297 {
 298         if (which < _descriptor->PortCount) {
 299                 _shadow_data[which] = (LADSPA_Data) val;
 300 #if 0
 301                 ParameterChanged (Parameter(PluginAutomation, 0, which), val); /* EMIT SIGNAL */
 302
 303                 if (which < parameter_count() && controls[which]) {
 304                         controls[which]->Changed ();
 305                 }
 306 #endif
 307
 308         } else {
 309                 warning << string_compose (_("illegal parameter number used with plugin \"%1\". This may"
 310                                              "indicate a change in the plugin design, and presets may be"
 311                                              "invalid"), name())
 312                         << endmsg;
 313         }
 314 }
 315
 316 float
 317 LadspaPlugin::get_parameter (uint32_t which) const
 318 {
 319         if (LADSPA_IS_PORT_INPUT(port_descriptor (which))) {
 320                 return (float) _shadow_data[which];
 321         } else {
 322                 return (float) _control_data[which];
 323         }
 324 }
 325
 326 uint32_t
 327 LadspaPlugin::nth_parameter (uint32_t n, bool& ok) const
 328 {
 329         uint32_t x, c;
 330
 331         ok = false;
 332
 333         for (c = 0, x = 0; x < _descriptor->PortCount; ++x) {
 334                 if (LADSPA_IS_PORT_CONTROL (port_descriptor (x))) {
 335                         if (c++ == n) {
 336                                 ok = true;
 337                                 return x;
 338                         }
 339                 }
 340         }
 341         return 0;
 342 }
 343
 344 XMLNode&
 345 LadspaPlugin::get_state()
 346 {
 347         XMLNode *root = new XMLNode(state_node_name());
 348         XMLNode *child;
 349         char buf[16];
 350         LocaleGuard lg (X_("POSIX"));
 351
 352         for (uint32_t i = 0; i < parameter_count(); ++i){
 353
 354                 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
 355                     LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
 356
 357                         child = new XMLNode("Port");
 358                         snprintf(buf, sizeof(buf), "%u", i);
 359                         child->add_property("number", string(buf));
 360                         snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
 361                         child->add_property("value", string(buf));
 362                         root->add_child_nocopy (*child);
 363                 }
 364         }
 365
 366         return *root;
 367 }
 368
 369 int
 370 LadspaPlugin::set_state (const XMLNode& node, int version)
 371 {
 372         if (version < 3000) {
 373                 return set_state_2X (node, version);
 374         }
 375
 376         XMLNodeList nodes;
 377         XMLProperty *prop;
 378         XMLNodeConstIterator iter;
 379         XMLNode *child;
 380         const char *port;
 381         const char *data;
 382         uint32_t port_id;
 383         LocaleGuard lg (X_("POSIX"));
 384
 385         if (node.name() != state_node_name()) {
 386                 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
 387                 return -1;
 388         }
 389
 390         nodes = node.children ("Port");
 391
 392         for(iter = nodes.begin(); iter != nodes.end(); ++iter){
 393
 394                 child = *iter;
 395
 396                 if ((prop = child->property("number")) != 0) {
 397                         port = prop->value().c_str();
 398                 } else {
 399                         warning << _("LADSPA: no ladspa port number") << endmsg;
 400                         continue;
 401                 }
 402                 if ((prop = child->property("value")) != 0) {
 403                         data = prop->value().c_str();
 404                 } else {
 405                         warning << _("LADSPA: no ladspa port data") << endmsg;
 406                         continue;
 407                 }
 408
 409                 sscanf (port, "%" PRIu32, &port_id);
 410                 set_parameter (port_id, atof(data));
 411         }
 412
 413         latency_compute_run ();
 414
 415         return 0;
 416 }
 417
 418 int
 419 LadspaPlugin::set_state_2X (const XMLNode& node, int /* version */)
 420 {
 421         XMLNodeList nodes;
 422         XMLProperty *prop;
 423         XMLNodeConstIterator iter;
 424         XMLNode *child;
 425         const char *port;
 426         const char *data;
 427         uint32_t port_id;
 428         LocaleGuard lg (X_("POSIX"));
 429
 430         if (node.name() != state_node_name()) {
 431                 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
 432                 return -1;
 433         }
 434
 435         nodes = node.children ("port");
 436
 437         for(iter = nodes.begin(); iter != nodes.end(); ++iter){
 438
 439                 child = *iter;
 440
 441                 if ((prop = child->property("number")) != 0) {
 442                         port = prop->value().c_str();
 443                 } else {
 444                         warning << _("LADSPA: no ladspa port number") << endmsg;
 445                         continue;
 446                 }
 447                 if ((prop = child->property("value")) != 0) {
 448                         data = prop->value().c_str();
 449                 } else {
 450                         warning << _("LADSPA: no ladspa port data") << endmsg;
 451                         continue;
 452                 }
 453
 454                 sscanf (port, "%" PRIu32, &port_id);
 455                 set_parameter (port_id, atof(data));
 456         }
 457
 458         latency_compute_run ();
 459
 460         return 0;
 461 }
 462
 463 int
 464 LadspaPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
 465 {
 466         LADSPA_PortRangeHint prh;
 467
 468         prh  = port_range_hints()[which];
 469
 470
 471         if (LADSPA_IS_HINT_BOUNDED_BELOW(prh.HintDescriptor)) {
 472                 desc.min_unbound = false;
 473                 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
 474                         desc.lower = prh.LowerBound * _session.frame_rate();
 475                 } else {
 476                         desc.lower = prh.LowerBound;
 477                 }
 478         } else {
 479                 desc.min_unbound = true;
 480                 desc.lower = 0;
 481         }
 482
 483
 484         if (LADSPA_IS_HINT_BOUNDED_ABOVE(prh.HintDescriptor)) {
 485                 desc.max_unbound = false;
 486                 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
 487                         desc.upper = prh.UpperBound * _session.frame_rate();
 488                 } else {
 489                         desc.upper = prh.UpperBound;
 490                 }
 491         } else {
 492                 desc.max_unbound = true;
 493                 desc.upper = 4; /* completely arbitrary */
 494         }
 495
 496         if (LADSPA_IS_HINT_INTEGER (prh.HintDescriptor)) {
 497                 desc.step = 1.0;
 498                 desc.smallstep = 0.1;
 499                 desc.largestep = 10.0;
 500         } else {
 501                 float delta = desc.upper - desc.lower;
 502                 desc.step = delta / 1000.0f;
 503                 desc.smallstep = delta / 10000.0f;
 504                 desc.largestep = delta/10.0f;
 505         }
 506
 507         desc.toggled = LADSPA_IS_HINT_TOGGLED (prh.HintDescriptor);
 508         desc.logarithmic = LADSPA_IS_HINT_LOGARITHMIC (prh.HintDescriptor);
 509         desc.sr_dependent = LADSPA_IS_HINT_SAMPLE_RATE (prh.HintDescriptor);
 510         desc.integer_step = LADSPA_IS_HINT_INTEGER (prh.HintDescriptor);
 511
 512         desc.label = port_names()[which];
 513
 514         return 0;
 515 }
 516
 517 string
 518 LadspaPlugin::describe_parameter (Evoral::Parameter which)
 519 {
 520         if (which.type() == PluginAutomation && which.id() < parameter_count()) {
 521                 return port_names()[which.id()];
 522         } else {
 523                 return "??";
 524         }
 525 }
 526
 527 ARDOUR::framecnt_t
 528 LadspaPlugin::signal_latency () const
 529 {
 530         if (_user_latency) {
 531                 return _user_latency;
 532         }
 533
 534         if (_latency_control_port) {
 535                 return (framecnt_t) floor (*_latency_control_port);
 536         } else {
 537                 return 0;
 538         }
 539 }
 540
 541 set<Evoral::Parameter>
 542 LadspaPlugin::automatable () const
 543 {
 544         set<Evoral::Parameter> ret;
 545
 546         for (uint32_t i = 0; i < parameter_count(); ++i){
 547                 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
 548                     LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
 549
 550                         ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
 551                 }
 552         }
 553
 554         return ret;
 555 }
 556
 557 int
 558 LadspaPlugin::connect_and_run (BufferSet& bufs,
 559                 ChanMapping in_map, ChanMapping out_map,
 560                 pframes_t nframes, framecnt_t offset)
 561 {
 562         Plugin::connect_and_run (bufs, in_map, out_map, nframes, offset);
 563
 564         cycles_t now;
 565         cycles_t then = get_cycles ();
 566
 567         uint32_t audio_in_index  = 0;
 568         uint32_t audio_out_index = 0;
 569         for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
 570                 if (LADSPA_IS_PORT_AUDIO(port_descriptor(port_index))) {
 571                         if (LADSPA_IS_PORT_INPUT(port_descriptor(port_index))) {
 572                                 const uint32_t buf_index = in_map.get(DataType::AUDIO, audio_in_index++);
 573                                 connect_port(port_index, bufs.get_audio(buf_index).data(offset));
 574                         } else if (LADSPA_IS_PORT_OUTPUT(port_descriptor(port_index))) {
 575                                 const uint32_t buf_index = out_map.get(DataType::AUDIO, audio_out_index++);
 576                                 connect_port(port_index, bufs.get_audio(buf_index).data(offset));
 577                         }
 578                 }
 579         }
 580
 581         run_in_place (nframes);
 582         now = get_cycles ();
 583         set_cycles ((uint32_t) (now - then));
 584
 585         return 0;
 586 }
 587
 588 bool
 589 LadspaPlugin::parameter_is_control (uint32_t param) const
 590 {
 591         return LADSPA_IS_PORT_CONTROL(port_descriptor (param));
 592 }
 593
 594 bool
 595 LadspaPlugin::parameter_is_audio (uint32_t param) const
 596 {
 597         return LADSPA_IS_PORT_AUDIO(port_descriptor (param));
 598 }
 599
 600 bool
 601 LadspaPlugin::parameter_is_output (uint32_t param) const
 602 {
 603         return LADSPA_IS_PORT_OUTPUT(port_descriptor (param));
 604 }
 605
 606 bool
 607 LadspaPlugin::parameter_is_input (uint32_t param) const
 608 {
 609         return LADSPA_IS_PORT_INPUT(port_descriptor (param));
 610 }
 611
 612 void
 613 LadspaPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
 614 {
 615         if (buf && len) {
 616                 if (param < parameter_count()) {
 617                         snprintf (buf, len, "%.3f", get_parameter (param));
 618                 } else {
 619                         strcat (buf, "0");
 620                 }
 621         }
 622 }
 623
 624 void
 625 LadspaPlugin::run_in_place (pframes_t nframes)
 626 {
 627         for (uint32_t i = 0; i < parameter_count(); ++i) {
 628                 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) && LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
 629                         _control_data[i] = _shadow_data[i];
 630                 }
 631         }
 632
 633         assert (_was_activated);
 634
 635         _descriptor->run (_handle, nframes);
 636 }
 637
 638 void
 639 LadspaPlugin::latency_compute_run ()
 640 {
 641         if (!_latency_control_port) {
 642                 return;
 643         }
 644
 645         /* we need to run the plugin so that it can set its latency
 646            parameter.
 647         */
 648
 649         activate ();
 650
 651         uint32_t port_index = 0;
 652         uint32_t in_index = 0;
 653         uint32_t out_index = 0;
 654         const framecnt_t bufsize = 1024;
 655         LADSPA_Data buffer[bufsize];
 656
 657         memset(buffer,0,sizeof(LADSPA_Data)*bufsize);
 658
 659         /* Note that we've already required that plugins
 660            be able to handle in-place processing.
 661         */
 662
 663         port_index = 0;
 664
 665         while (port_index < parameter_count()) {
 666                 if (LADSPA_IS_PORT_AUDIO (port_descriptor (port_index))) {
 667                         if (LADSPA_IS_PORT_INPUT (port_descriptor (port_index))) {
 668                                 connect_port (port_index, buffer);
 669                                 in_index++;
 670                         } else if (LADSPA_IS_PORT_OUTPUT (port_descriptor (port_index))) {
 671                                 connect_port (port_index, buffer);
 672                                 out_index++;
 673                         }
 674                 }
 675                 port_index++;
 676         }
 677
 678         run_in_place (bufsize);
 679         deactivate ();
 680 }
 681
 682 PluginPtr
 683 LadspaPluginInfo::load (Session& session)
 684 {
 685         try {
 686                 PluginPtr plugin;
 687                 void *module;
 688
 689                 if ((module = dlopen (path.c_str(), RTLD_NOW)) == 0) {
 690                         error << string_compose(_("LADSPA: cannot load module from \"%1\""), path) << endmsg;
 691                         error << dlerror() << endmsg;
 692                         return PluginPtr ((Plugin*) 0);
 693                 } else {
 694                         plugin.reset (new LadspaPlugin (module, session.engine(), session, index, session.frame_rate()));
 695                 }
 696
 697                 plugin->set_info(PluginInfoPtr(new LadspaPluginInfo(*this)));
 698                 return plugin;
 699         }
 700
 701         catch (failed_constructor &err) {
 702                 return PluginPtr ((Plugin*) 0);
 703         }
 704 }
 705
 706 LadspaPluginInfo::LadspaPluginInfo()
 707 {
 708        type = ARDOUR::LADSPA;
 709 }
 710
 711
 712 vector<Plugin::PresetRecord>
 713 LadspaPlugin::get_presets ()
 714 {
 715         vector<PresetRecord> result;
 716         uint32_t id;
 717         std::string unique (unique_id());
 718
 719         if (!isdigit (unique[0])) {
 720                 return result;
 721         }
 722
 723         id = atol (unique.c_str());
 724
 725         lrdf_uris* set_uris = lrdf_get_setting_uris(id);
 726
 727         if (set_uris) {
 728                 for (uint32_t i = 0; i < (uint32_t) set_uris->count; ++i) {
 729                         if (char* label = lrdf_get_label(set_uris->items[i])) {
 730                                 PresetRecord rec(set_uris->items[i], label);
 731                                 result.push_back(rec);
 732                                 _presets.insert (make_pair (set_uris->items[i], rec));
 733                         }
 734                 }
 735                 lrdf_free_uris(set_uris);
 736         }
 737
 738         return result;
 739 }
 740
 741
 742 bool
 743 LadspaPlugin::load_preset (const string& preset_uri)
 744 {
 745         lrdf_defaults* defs = lrdf_get_setting_values(preset_uri.c_str());
 746
 747         if (defs) {
 748                 for (uint32_t i = 0; i < (uint32_t) defs->count; ++i) {
 749                         // The defs->items[i].pid < defs->count check is to work around
 750                         // a bug in liblrdf that saves invalid values into the presets file.
 751                         if (((uint32_t) defs->items[i].pid < (uint32_t) defs->count) && parameter_is_input (defs->items[i].pid)) {
 752                                 set_parameter(defs->items[i].pid, defs->items[i].value);
 753                         }
 754                 }
 755                 lrdf_free_setting_values(defs);
 756         }
 757
 758         return true;
 759 }
 760
 761 /* XXX: should be in liblrdf */
 762 static void
 763 lrdf_remove_preset (const char *source, const char *setting_uri)
 764 {
 765         lrdf_statement p;
 766         lrdf_statement *q;
 767         lrdf_statement *i;
 768         char setting_uri_copy[64];
 769         char buf[64];
 770
 771         strncpy(setting_uri_copy, setting_uri, sizeof(setting_uri_copy));
 772
 773         p.subject = setting_uri_copy;
 774         strncpy(buf, LADSPA_BASE "hasPortValue", sizeof(buf));
 775         p.predicate = buf;
 776         p.object = NULL;
 777         q = lrdf_matches(&p);
 778
 779         p.predicate = NULL;
 780         p.object = NULL;
 781         for (i = q; i; i = i->next) {
 782                 p.subject = i->object;
 783                 lrdf_remove_matches(&p);
 784         }
 785
 786         lrdf_free_statements(q);
 787
 788         p.subject = NULL;
 789         strncpy(buf, LADSPA_BASE "hasSetting", sizeof(buf));
 790         p.predicate = buf;
 791         p.object = setting_uri_copy;
 792         lrdf_remove_matches(&p);
 793
 794         p.subject = setting_uri_copy;
 795         p.predicate = NULL;
 796         p.object = NULL;
 797         lrdf_remove_matches (&p);
 798 }
 799
 800 void
 801 LadspaPlugin::do_remove_preset (string name)
 802 {
 803         string const envvar = preset_envvar ();
 804         if (envvar.empty()) {
 805                 warning << _("Could not locate HOME.  Preset not removed.") << endmsg;
 806                 return;
 807         }
 808
 809         Plugin::PresetRecord const * p = preset_by_label (name);
 810         if (!p) {
 811                 return;
 812         }
 813
 814         string const source = preset_source (envvar);
 815         lrdf_remove_preset (source.c_str(), p->uri.c_str ());
 816
 817         write_preset_file (envvar);
 818 }
 819
 820 string
 821 LadspaPlugin::preset_envvar () const
 822 {
 823         char* envvar;
 824         if ((envvar = getenv ("HOME")) == 0) {
 825                 return "";
 826         }
 827
 828         return envvar;
 829 }
 830
 831 string
 832 LadspaPlugin::preset_source (string envvar) const
 833 {
 834         return string_compose ("file:%1/.ladspa/rdf/ardour-presets.n3", envvar);
 835 }
 836
 837 bool
 838 LadspaPlugin::write_preset_file (string envvar)
 839 {
 840         string path = string_compose("%1/.ladspa", envvar);
 841         if (g_mkdir_with_parents (path.c_str(), 0775)) {
 842                 warning << string_compose(_("Could not create %1.  Preset not saved. (%2)"), path, strerror(errno)) << endmsg;
 843                 return false;
 844         }
 845
 846         path += "/rdf";
 847         if (g_mkdir_with_parents (path.c_str(), 0775)) {
 848                 warning << string_compose(_("Could not create %1.  Preset not saved. (%2)"), path, strerror(errno)) << endmsg;
 849                 return false;
 850         }
 851
 852         string const source = preset_source (envvar);
 853
 854         if (lrdf_export_by_source (source.c_str(), source.substr(5).c_str())) {
 855                 warning << string_compose(_("Error saving presets file %1."), source) << endmsg;
 856                 return false;
 857         }
 858
 859         return true;
 860 }
 861
 862 string
 863 LadspaPlugin::do_save_preset (string name)
 864 {
 865         lrdf_portvalue portvalues[parameter_count()];
 866         lrdf_defaults defaults;
 867         std::string unique (unique_id());
 868
 869         if (!isdigit (unique[0])) {
 870                 return false;
 871         }
 872
 873         uint32_t const id = atol (unique.c_str());
 874
 875         defaults.count = parameter_count();
 876         defaults.items = portvalues;
 877
 878         for (uint32_t i = 0; i < parameter_count(); ++i) {
 879                 if (parameter_is_input (i)) {
 880                         portvalues[i].pid = i;
 881                         portvalues[i].value = get_parameter(i);
 882                 }
 883         }
 884
 885         string const envvar = preset_envvar ();
 886         if (envvar.empty()) {
 887                 warning << _("Could not locate HOME.  Preset not saved.") << endmsg;
 888                 return false;
 889         }
 890
 891         string const source = preset_source (envvar);
 892
 893         char* uri_char = lrdf_add_preset (source.c_str(), name.c_str(), id, &defaults);
 894         string uri (uri_char);
 895         free (uri_char);
 896
 897         if (!write_preset_file (envvar)) {
 898                 return "";
 899         }
 900
 901         return uri;
 902 }
 903