libs/ardour/vst_plugin.cc

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