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