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