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