libs/ardour/lxvst_plugin.cc

   1 /*
   2     Copyright (C) 2004 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 /**********************************************************************/
  21 /*Native linuxVST (LXVST) variant of vst_plugin.cc etc                */
  22 /**********************************************************************/
  23
  24
  25 #include <algorithm>
  26 #include <vector>
  27 #include <string>
  28 #include <cctype>
  29
  30 #include <cstdlib>
  31 #include <cstdio> // so libraptor doesn't complain
  32 #include <cmath>
  33 #include <dirent.h>
  34 #include <cstring> // for memmove
  35 #include <sys/stat.h>
  36 #include <cerrno>
  37
  38 #include <glibmm/miscutils.h>
  39
  40 #include <lrdf.h>
  41
  42 /*Include for the new native vst engine - vstfx.h*/
  43 #include <stdint.h>
  44 #include <ardour/vstfx.h>
  45
  46 #include "pbd/compose.h"
  47 #include "pbd/error.h"
  48 #include "pbd/pathscanner.h"
  49 #include "pbd/xml++.h"
  50
  51 #include "ardour/session.h"
  52 #include "ardour/audioengine.h"
  53 #include "ardour/filesystem_paths.h"
  54 #include "ardour/lxvst_plugin.h"
  55 #include "ardour/buffer_set.h"
  56 #include "ardour/audio_buffer.h"
  57 #include "ardour/midi_buffer.h"
  58
  59 #include "pbd/stl_delete.h"
  60
  61 #include "i18n.h"
  62 #include <locale.h>
  63
  64 using namespace std;
  65 using namespace ARDOUR;
  66 using namespace PBD;
  67 using std::min;
  68 using std::max;
  69
  70 LXVSTPlugin::LXVSTPlugin (AudioEngine& e, Session& session, VSTFXHandle* h)
  71         : Plugin (e, session)
  72 {
  73         handle = h;
  74
  75         /*Instantiate the plugin and return a VSTFX* */
  76
  77         if ((_vstfx = vstfx_instantiate (handle, Session::lxvst_callback, this)) == 0) {
  78                 throw failed_constructor();
  79         }
  80
  81         /* Call into vstfx to get a pointer to the instance of the VST plugin*/
  82
  83         _plugin = _vstfx->plugin;
  84         _plugin->user = this;
  85
  86         /* set rate and blocksize */
  87
  88         _plugin->dispatcher (_plugin, effSetSampleRate, 0, 0, NULL, (float) session.frame_rate());
  89
  90         _plugin->dispatcher (_plugin, effSetBlockSize, 0, session.get_block_size(), NULL, 0.0f);
  91
  92         /* set program to zero */
  93
  94         _plugin->dispatcher (_plugin, effSetProgram, 0, 0, NULL, 0.0f);
  95
  96         // Plugin::setup_controls ();
  97 }
  98
  99 LXVSTPlugin::LXVSTPlugin (const LXVSTPlugin &other)
 100         : Plugin (other)
 101 {
 102         handle = other.handle;
 103
 104         if ((_vstfx = vstfx_instantiate (handle, Session::lxvst_callback, this)) == 0) {
 105                 throw failed_constructor();
 106         }
 107         _plugin = _vstfx->plugin;
 108
 109         // Plugin::setup_controls ();
 110 }
 111
 112 LXVSTPlugin::~LXVSTPlugin ()
 113 {
 114         deactivate ();
 115         vstfx_close (_vstfx);
 116 }
 117
 118 int
 119 LXVSTPlugin::set_block_size (pframes_t nframes)
 120 {
 121         deactivate ();
 122         _plugin->dispatcher (_plugin, effSetBlockSize, 0, nframes, NULL, 0.0f);
 123         activate ();
 124         return 0;
 125 }
 126
 127 float
 128 LXVSTPlugin::default_value (uint32_t)
 129 {
 130         return 0;
 131 }
 132
 133 void
 134 LXVSTPlugin::set_parameter (uint32_t which, float val)
 135 {
 136         _plugin->setParameter (_plugin, which, val);
 137
 138         if (_vstfx->want_program == -1 && _vstfx->want_chunk == 0) {
 139                 /* Heinous hack: Plugin::set_parameter below updates the `modified' status of the
 140                    current preset, but if _vstfx->want_program is not -1 then there is a preset
 141                    setup pending or in progress, which we don't want any `modified' updates
 142                    to happen for.  So we only do this if _vstfx->want_program is -1.
 143                 */
 144                 Plugin::set_parameter (which, val);
 145         }
 146 }
 147
 148 float
 149 LXVSTPlugin::get_parameter (uint32_t which) const
 150 {
 151         return _plugin->getParameter (_plugin, which);
 152
 153 }
 154
 155 uint32_t
 156 LXVSTPlugin::nth_parameter (uint32_t n, bool& ok) const
 157 {
 158         ok = true;
 159         return n;
 160 }
 161
 162 /** Get VST chunk as base64-encoded data.
 163  *  @param single true for single program, false for all programs.
 164  *  @return 0-terminated base64-encoded data; must be passed to g_free () by caller.
 165  */
 166 gchar *LXVSTPlugin::get_chunk (bool single) const
 167 {
 168         guchar* data;
 169         int32_t data_size = _plugin->dispatcher (_plugin, 23 /* effGetChunk */, single ? 1 : 0, 0, &data, 0);
 170
 171         if (data_size == 0) {
 172                 return 0;
 173         }
 174
 175         return g_base64_encode (data, data_size);
 176 }
 177
 178 /** Set VST chunk from base64-encoded data.
 179  *  @param 0-terminated base64-encoded data.
 180  *  @param single true for single program, false for all programs.
 181  *  @return 0 on success, non-0 on failure
 182  */
 183 int
 184 LXVSTPlugin::set_chunk (gchar const * data, bool single)
 185 {
 186         gsize size = 0;
 187         guchar* raw_data = g_base64_decode (data, &size);
 188         int const r = _plugin->dispatcher (_plugin, 24 /* effSetChunk */, single ? 1 : 0, size, raw_data, 0);
 189         g_free (raw_data);
 190         return r;
 191 }
 192
 193 void
 194 LXVSTPlugin::add_state (XMLNode* root) const
 195 {
 196         LocaleGuard lg (X_("POSIX"));
 197
 198         if (_vstfx->current_program != -1) {
 199                 char buf[32];
 200                 snprintf (buf, sizeof (buf), "%d", _vstfx->current_program);
 201                 root->add_property ("current-program", buf);
 202         }
 203
 204         if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
 205                 gchar* data = get_chunk (false);
 206
 207                 if (data == 0) {
 208                         return;
 209                 }
 210
 211                 /* store information */
 212
 213                 XMLNode* chunk_node = new XMLNode (X_("chunk"));
 214
 215                 chunk_node->add_content (data);
 216                 g_free (data);
 217
 218                 root->add_child_nocopy (*chunk_node);
 219
 220         } else {
 221                 XMLNode* parameters = new XMLNode ("parameters");
 222
 223                 for (int32_t n = 0; n < _plugin->numParams; ++n) {
 224                         char index[64];
 225                         char val[32];
 226                         snprintf (index, sizeof (index), "param_%d", n);
 227                         snprintf (val, sizeof (val), "%.12g", _plugin->getParameter (_plugin, n));
 228                         parameters->add_property (index, val);
 229                 }
 230
 231                 root->add_child_nocopy (*parameters);
 232         }
 233 }
 234
 235 int
 236 LXVSTPlugin::set_state (const XMLNode& node, int version)
 237 {
 238         LocaleGuard lg (X_("POSIX"));
 239
 240         if (node.name() != state_node_name()) {
 241                 error << _("Bad node sent to VSTPlugin::set_state") << endmsg;
 242                 return 0;
 243         }
 244
 245         const XMLProperty* prop;
 246
 247         if ((prop = node.property ("current-program")) != 0) {
 248                 _vstfx->want_program = atoi (prop->value().c_str());
 249         }
 250
 251         XMLNode* child;
 252         int ret = -1;
 253
 254         if ((child = find_named_node (node, X_("chunk"))) != 0) {
 255                 XMLPropertyList::const_iterator i;
 256                 XMLNodeList::const_iterator n;
 257
 258                 for (n = child->children ().begin (); n != child->children ().end (); ++n) {
 259                         if ((*n)->is_content ()) {
 260                                 /* XXX: this may be dubious for the same reasons that we delay
 261                                    execution of load_preset.
 262                                 */
 263                                 ret = set_chunk ((*n)->content().c_str(), false);
 264                         }
 265                 }
 266
 267         } else if ((child = find_named_node (node, X_("parameters"))) != 0) {
 268                 XMLPropertyList::const_iterator i;
 269
 270                 for (i = child->properties().begin(); i != child->properties().end(); ++i) {
 271                         int32_t param;
 272                         float val;
 273
 274                         sscanf ((*i)->name().c_str(), "param-%d", &param); //This was param_%d (from vst_plugin) which caused all sorts of odd behaviour
 275                         sscanf ((*i)->value().c_str(), "%f", &val);
 276
 277                         _plugin->setParameter (_plugin, param, val);
 278                 }
 279
 280                 /* program number is not knowable */
 281
 282                 _vstfx->current_program = -1;
 283
 284                 ret = 0;
 285         }
 286
 287         Plugin::set_state (node, version);
 288         return ret;
 289 }
 290
 291 int
 292 LXVSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
 293 {
 294         desc.min_unbound = false;
 295         desc.max_unbound = false;
 296
 297         /* old style */
 298
 299         char label[64];
 300         label[0] = '\0';
 301
 302         _plugin->dispatcher (_plugin, effGetParamName, which, 0, label, 0);
 303
 304         desc.label = label;
 305         desc.integer_step = false;
 306         desc.lower = 0.0f;
 307         desc.upper = 1.0f;
 308         desc.step = 0.01f;
 309         desc.smallstep = 0.005f;
 310         desc.largestep = 0.1f;
 311         desc.toggled = false;
 312         desc.logarithmic = false;
 313         desc.sr_dependent = false;
 314
 315         return 0;
 316 }
 317
 318 bool
 319 LXVSTPlugin::load_preset (PresetRecord r)
 320 {
 321         bool s;
 322
 323         if (r.user) {
 324                 s = load_user_preset (r);
 325         }
 326         else {
 327                 s = load_plugin_preset (r);
 328         }
 329
 330         if (s) {
 331                 Plugin::load_preset (r);
 332         }
 333
 334         return s;
 335 }
 336
 337 bool
 338 LXVSTPlugin::load_plugin_preset (PresetRecord r)
 339 {
 340         /* This is a plugin-provided preset.
 341            We can't dispatch directly here; too many plugins expects only one GUI thread.
 342         */
 343
 344         /* Extract the index of this preset from the URI */
 345         int id;
 346         int index;
 347         int const p = sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
 348         assert (p == 2);
 349
 350         _vstfx->want_program = index;
 351         return true;
 352 }
 353
 354 bool
 355 LXVSTPlugin::load_user_preset (PresetRecord r)
 356 {
 357         /* This is a user preset; we load it, and this code also knows about the
 358            non-direct-dispatch thing.
 359         */
 360
 361         boost::shared_ptr<XMLTree> t (presets_tree ());
 362         if (t == 0) {
 363                 return false;
 364         }
 365
 366         XMLNode* root = t->root ();
 367
 368         for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
 369                 XMLProperty* label = (*i)->property (X_("label"));
 370
 371                 assert (label);
 372
 373                 if (label->value() != r.label) {
 374                         continue;
 375                 }
 376
 377                 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
 378
 379                         /* Load a user preset chunk from our XML file and send it via a circuitous route to the plugin */
 380
 381                         if (_vstfx->wanted_chunk) {
 382                                 g_free (_vstfx->wanted_chunk);
 383                         }
 384
 385                         for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
 386                                 if ((*j)->is_content ()) {
 387                                         /* we can't dispatch directly here; too many plugins expect only one GUI thread */
 388                                         gsize size = 0;
 389                                         guchar* raw_data = g_base64_decode ((*j)->content().c_str(), &size);
 390                                         _vstfx->wanted_chunk = raw_data;
 391                                         _vstfx->wanted_chunk_size = size;
 392                                         _vstfx->want_chunk = 1;
 393                                         return true;
 394                                 }
 395                         }
 396
 397                         return false;
 398
 399                 }
 400                 else {
 401                         for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
 402                                 if ((*j)->name() == X_("Parameter")) {
 403                                                 XMLProperty* index = (*j)->property (X_("index"));
 404                                                 XMLProperty* value = (*j)->property (X_("value"));
 405
 406                                                 assert (index);
 407                                                 assert (value);
 408
 409                                                 set_parameter (atoi (index->value().c_str()), atof (value->value().c_str ()));
 410                                 }
 411                         }
 412                         return true;
 413                 }
 414         }
 415         return false;
 416 }
 417
 418 string
 419 LXVSTPlugin::do_save_preset (string name)
 420 {
 421         boost::shared_ptr<XMLTree> t (presets_tree ());
 422         if (t == 0) {
 423                 return "";
 424         }
 425
 426         XMLNode* p = 0;
 427         /* XXX: use of _presets.size() + 1 for the unique ID here is dubious at best */
 428         string const uri = string_compose (X_("VST:%1:%2"), unique_id (), _presets.size() + 1);
 429
 430         if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
 431
 432                 p = new XMLNode (X_("ChunkPreset"));
 433                 p->add_property (X_("uri"), uri);
 434                 p->add_property (X_("label"), name);
 435                 gchar* data = get_chunk (true);
 436                 p->add_content (string (data));
 437                 g_free (data);
 438
 439         }
 440         else {
 441
 442                 p = new XMLNode (X_("Preset"));
 443                 p->add_property (X_("uri"), uri);
 444                 p->add_property (X_("label"), name);
 445
 446                 for (uint32_t i = 0; i < parameter_count(); ++i) {
 447                         if (parameter_is_input (i)) {
 448                                 XMLNode* c = new XMLNode (X_("Parameter"));
 449                                 c->add_property (X_("index"), string_compose ("%1", i));
 450                                 c->add_property (X_("value"), string_compose ("%1", get_parameter (i)));
 451                                 p->add_child_nocopy (*c);
 452                         }
 453                 }
 454         }
 455
 456         t->root()->add_child_nocopy (*p);
 457
 458         sys::path f = ARDOUR::user_config_directory ();
 459         f /= "presets";
 460         f /= presets_file ();
 461
 462         t->write (f.to_string ());
 463         return uri;
 464 }
 465
 466 void
 467 LXVSTPlugin::do_remove_preset (string name)
 468 {
 469         boost::shared_ptr<XMLTree> t (presets_tree ());
 470         if (t == 0) {
 471                 return;
 472         }
 473
 474         t->root()->remove_nodes_and_delete (X_("label"), name);
 475
 476         sys::path f = ARDOUR::user_config_directory ();
 477         f /= "presets";
 478         f /= presets_file ();
 479
 480         t->write (f.to_string ());
 481 }
 482
 483 string
 484 LXVSTPlugin::describe_parameter (Evoral::Parameter param)
 485 {
 486         char name[64] = "Unkown";
 487         _plugin->dispatcher (_plugin, effGetParamName, param.id(), 0, name, 0);
 488         return name;
 489 }
 490
 491 framecnt_t
 492 LXVSTPlugin::signal_latency () const
 493 {
 494         if (_user_latency) {
 495                 return _user_latency;
 496         }
 497
 498 #ifdef VESTIGE_HEADER
 499         return *((int32_t *) (((char *) &_plugin->flags) + 12)); /* initialDelay */
 500 #else
 501         return _plugin->initial_delay;
 502 #endif
 503 }
 504
 505 set<Evoral::Parameter>
 506 LXVSTPlugin::automatable () const
 507 {
 508         set<Evoral::Parameter> ret;
 509
 510         for (uint32_t i = 0; i < parameter_count(); ++i) {
 511                 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
 512         }
 513
 514         return ret;
 515 }
 516
 517 int
 518 LXVSTPlugin::connect_and_run (BufferSet& bufs,
 519                               ChanMapping in_map, ChanMapping out_map,
 520                               pframes_t nframes, framecnt_t offset)
 521 {
 522         Plugin::connect_and_run (bufs, in_map, out_map, nframes, offset);
 523
 524         float *ins[_plugin->numInputs];
 525         float *outs[_plugin->numOutputs];
 526         int32_t i;
 527
 528         const uint32_t nbufs = bufs.count().n_audio();
 529
 530         int in_index = 0;
 531         for (i = 0; i < (int32_t) _plugin->numInputs; ++i) {
 532                 ins[i] = bufs.get_audio(min((uint32_t) in_index, nbufs - 1)).data() + offset;
 533                 in_index++;
 534         }
 535
 536         int out_index = 0;
 537         for (i = 0; i < (int32_t) _plugin->numOutputs; ++i) {
 538                 outs[i] = bufs.get_audio(min((uint32_t) out_index, nbufs - 1)).data() + offset;
 539                 out_index++;
 540         }
 541
 542         if (bufs.count().n_midi() > 0) {
 543                 VstEvents* v = bufs.get_vst_midi (0);
 544                 _plugin->dispatcher (_plugin, effProcessEvents, 0, 0, v, 0);
 545         }
 546
 547         /* we already know it can support processReplacing */
 548
 549         _plugin->processReplacing (_plugin, ins, outs, nframes);
 550
 551         return 0;
 552 }
 553
 554 void
 555 LXVSTPlugin::deactivate ()
 556 {
 557         _plugin->dispatcher (_plugin, effMainsChanged, 0, 0, NULL, 0.0f);
 558 }
 559
 560 void
 561 LXVSTPlugin::activate ()
 562 {
 563         _plugin->dispatcher (_plugin, effMainsChanged, 0, 1, NULL, 0.0f);
 564 }
 565
 566 string
 567 LXVSTPlugin::unique_id() const
 568 {
 569         char buf[32];
 570
 571
 572         snprintf (buf, sizeof (buf), "%d", _plugin->uniqueID);
 573
 574
 575         return string (buf);
 576 }
 577
 578
 579 const char *
 580 LXVSTPlugin::name () const
 581 {
 582         return handle->name;
 583 }
 584
 585 const char *
 586 LXVSTPlugin::maker () const
 587 {
 588         return _info->creator.c_str();
 589 }
 590
 591 const char *
 592 LXVSTPlugin::label () const
 593 {
 594         return handle->name;
 595 }
 596
 597 uint32_t
 598 LXVSTPlugin::parameter_count() const
 599 {
 600         return _plugin->numParams;
 601 }
 602
 603 bool
 604 LXVSTPlugin::has_editor () const
 605 {
 606         return _plugin->flags & effFlagsHasEditor;
 607 }
 608
 609 void
 610 LXVSTPlugin::print_parameter (uint32_t param, char *buf, uint32_t /*len*/) const
 611 {
 612         char *first_nonws;
 613
 614         _plugin->dispatcher (_plugin, 7 /* effGetParamDisplay */, param, 0, buf, 0);
 615
 616         if (buf[0] == '\0') {
 617                 return;
 618         }
 619
 620         first_nonws = buf;
 621         while (*first_nonws && isspace (*first_nonws)) {
 622                 first_nonws++;
 623         }
 624
 625         if (*first_nonws == '\0') {
 626                 return;
 627         }
 628
 629         memmove (buf, first_nonws, strlen (buf) - (first_nonws - buf) + 1);
 630 }
 631
 632 PluginPtr
 633 LXVSTPluginInfo::load (Session& session)
 634 {
 635         try {
 636                 PluginPtr plugin;
 637
 638                 if (Config->get_use_lxvst()) {
 639                         VSTFXHandle* handle;
 640
 641                         handle = vstfx_load(path.c_str());
 642
 643                         if (handle == NULL) {
 644                                 error << string_compose(_("LXVST: cannot load module from \"%1\""), path) << endmsg;
 645                         }
 646                         else {
 647                                 plugin.reset (new LXVSTPlugin (session.engine(), session, handle));
 648                         }
 649                 }
 650                 else {
 651                         error << _("You asked ardour to not use any LXVST plugins") << endmsg;
 652                         return PluginPtr ((Plugin*) 0);
 653                 }
 654
 655                 plugin->set_info(PluginInfoPtr(new LXVSTPluginInfo(*this)));
 656                 return plugin;
 657         }
 658
 659         catch (failed_constructor &err) {
 660                 return PluginPtr ((Plugin*) 0);
 661         }
 662 }
 663
 664 void
 665 LXVSTPlugin::find_presets ()
 666 {
 667         /* Built-in presets */
 668
 669         int const vst_version = _plugin->dispatcher (_plugin, effGetVstVersion, 0, 0, NULL, 0);
 670
 671         for (int i = 0; i < _plugin->numPrograms; ++i) {
 672                 PresetRecord r (string_compose (X_("LXVST:%1:%2"), unique_id (), i), "", false);
 673
 674                 if (vst_version >= 2) {
 675                         char buf[256];
 676                         if (_plugin->dispatcher (_plugin, 29, i, 0, buf, 0) == 1) {
 677                                 r.label = buf;
 678                         } else {
 679                                 r.label = string_compose (_("Preset %1"), i);
 680                         }
 681                 } else {
 682                         r.label = string_compose (_("Preset %1"), i);
 683                 }
 684
 685                 _presets.insert (make_pair (r.uri, r));
 686         }
 687
 688         /* User presets from our XML file */
 689
 690         boost::shared_ptr<XMLTree> t (presets_tree ());
 691
 692         if (t) {
 693                 XMLNode* root = t->root ();
 694                 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
 695                         XMLProperty* uri = (*i)->property (X_("uri"));
 696                         XMLProperty* label = (*i)->property (X_("label"));
 697
 698                         assert (uri);
 699                         assert (label);
 700
 701                         PresetRecord r (uri->value(), label->value(), true);
 702                         _presets.insert (make_pair (r.uri, r));
 703                 }
 704         }
 705 }
 706
 707 /** @return XMLTree with our user presets; could be a new one if no existing
 708  *  one was found, or 0 if one was present but badly-formatted.
 709  */
 710 XMLTree *
 711 LXVSTPlugin::presets_tree () const
 712 {
 713         XMLTree* t = new XMLTree;
 714
 715         sys::path p = ARDOUR::user_config_directory ();
 716         p /= "presets";
 717
 718         if (!is_directory (p)) {
 719                 create_directory (p);
 720         }
 721
 722         p /= presets_file ();
 723
 724         if (!exists (p)) {
 725                 t->set_root (new XMLNode (X_("LXVSTPresets")));
 726                 return t;
 727         }
 728
 729         t->set_filename (p.to_string ());
 730         if (!t->read ()) {
 731                 delete t;
 732                 return 0;
 733         }
 734
 735         return t;
 736 }
 737
 738 /** @return Index of the first user preset in our lists */
 739 int
 740 LXVSTPlugin::first_user_preset_index () const
 741 {
 742         return _plugin->numPrograms;
 743 }
 744
 745 string LXVSTPlugin::presets_file () const
 746 {
 747         return string_compose ("lxvst-%1", unique_id ());
 748 }
 749
 750 LXVSTPluginInfo::LXVSTPluginInfo()
 751 {
 752        type = ARDOUR::LXVST;
 753 }
 754