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