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