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