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