libs/ardour/vst_plugin.cc

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