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