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