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