libs/ardour/vst_plugin.cc

   1 /*
   2   Copyright (C) 2004 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 <algorithm>
  21 #include <vector>
  22 #include <string>
  23 #include <cctype>
  24
  25 #include <cstdlib>
  26 #include <cstdio> // so libraptor doesn't complain
  27 #include <cmath>
  28 #include <dirent.h>
  29 #include <cstring> // for memmove
  30 #include <sys/stat.h>
  31 #include <cerrno>
  32
  33 #include <glibmm/ustring.h>
  34 #include <glibmm/miscutils.h>
  35
  36 #include <lrdf.h>
  37 #include <fst.h>
  38
  39 #include <pbd/compose.h>
  40 #include <pbd/error.h>
  41 #include <pbd/pathscanner.h>
  42 #include <pbd/xml++.h>
  43
  44 #include <ardour/ardour.h>
  45 #include <ardour/session.h>
  46 #include <ardour/audioengine.h>
  47 #include <ardour/vst_plugin.h>
  48
  49 #include <pbd/stl_delete.h>
  50
  51 #include "i18n.h"
  52 #include <locale.h>
  53
  54 using namespace ARDOUR;
  55 using namespace PBD;
  56 using std::min;
  57 using std::max;
  58
  59 VSTPlugin::VSTPlugin (AudioEngine& e, Session& session, FSTHandle* h)
  60         : Plugin (e, session)
  61 {
  62         handle = h;
  63
  64         if ((_fst = fst_instantiate (handle, Session::vst_callback, this)) == 0) {
  65                 throw failed_constructor();
  66         }
  67
  68         _plugin = _fst->plugin;
  69         _plugin->user = this;
  70
  71         /* set rate and blocksize */
  72
  73         //cerr << "Dispatch " <<  "effSetSampleRate" << " for " << name() << endl;
  74         _plugin->dispatcher (_plugin, effSetSampleRate, 0, 0, NULL,
  75                              (float) session.frame_rate());
  76         //cerr << "Dispatch " << "effSetBlockSize" << " for " << name() << endl;
  77         _plugin->dispatcher (_plugin, effSetBlockSize, 0,
  78                              session.get_block_size(), NULL, 0.0f);
  79
  80         /* set program to zero */
  81
  82         //cerr << "Dispatch " << "effSetProgram" << " for " << name() << endl;
  83         _plugin->dispatcher (_plugin, effSetProgram, 0, 0, NULL, 0.0f);
  84
  85         Plugin::setup_controls ();
  86 }
  87
  88 VSTPlugin::VSTPlugin (const VSTPlugin &other)
  89         : Plugin (other)
  90 {
  91         handle = other.handle;
  92
  93         if ((_fst = fst_instantiate (handle, Session::vst_callback, this)) == 0) {
  94                 throw failed_constructor();
  95         }
  96         _plugin = _fst->plugin;
  97
  98         Plugin::setup_controls ();
  99 }
 100
 101 VSTPlugin::~VSTPlugin ()
 102 {
 103         deactivate ();
 104         GoingAway (); /* EMIT SIGNAL */
 105         fst_close (_fst);
 106 }
 107
 108 void
 109 VSTPlugin::set_block_size (nframes_t nframes)
 110 {
 111         deactivate ();
 112         //cerr << "Dispatch effSetBlockSize for " << name() << endl;
 113         _plugin->dispatcher (_plugin, effSetBlockSize, 0, nframes, NULL, 0.0f);
 114         activate ();
 115 }
 116
 117 float
 118 VSTPlugin::default_value (uint32_t port)
 119 {
 120         return 0;
 121 }
 122
 123 void
 124 VSTPlugin::set_parameter (uint32_t which, float val)
 125 {
 126         // cerr << "1SetParameter for " << name() << endl;
 127         _plugin->setParameter (_plugin, which, val);
 128         // cerr << "signal param change\n";
 129         ParameterChanged (which, val); /* EMIT SIGNAL */
 130         // cerr << "change done\n";
 131 }
 132
 133 float
 134 VSTPlugin::get_parameter (uint32_t which) const
 135 {
 136         // cerr << "GetParameter for " << name() << endl;
 137         return _plugin->getParameter (_plugin, which);
 138
 139 }
 140
 141 uint32_t
 142 VSTPlugin::nth_parameter (uint32_t n, bool& ok) const
 143 {
 144         ok = true;
 145         return n;
 146 }
 147
 148 XMLNode&
 149 VSTPlugin::get_state()
 150 {
 151         XMLNode *root = new XMLNode (state_node_name());
 152         LocaleGuard lg (X_("POSIX"));
 153
 154         if (_plugin->flags & 32 /* effFlagsProgramChunks */) {
 155
 156                 /* fetch the current chunk */
 157
 158                 guchar* data;
 159                 long  data_size;
 160
 161                 //cerr << "Dispatch getChunk for " << name() << endl;
 162                 if ((data_size = _plugin->dispatcher (_plugin, 23 /* effGetChunk */, 0, 0, &data, false)) == 0) {
 163                         return *root;
 164                 }
 165
 166                 /* store information */
 167
 168                 XMLNode* chunk_node = new XMLNode (X_("chunk"));
 169                 gchar * encoded_data = g_base64_encode (data, data_size);
 170                 chunk_node->add_content (encoded_data);
 171                 g_free (encoded_data);
 172
 173                 root->add_child_nocopy (*chunk_node);
 174         } else {
 175
 176                 XMLNode* parameters = new XMLNode ("parameters");
 177
 178                 for (long n = 0; n < _plugin->numParams; ++n) {
 179                         char index[64];
 180                         char val[32];
 181                         snprintf (index, sizeof (index), "param_%ld", n);
 182                         snprintf (val, sizeof (val), "%.12g", _plugin->getParameter (_plugin, n));
 183                         parameters->add_property (index, val);
 184                 }
 185
 186                 root->add_child_nocopy (*parameters);
 187
 188         }
 189
 190         return *root;
 191 }
 192
 193 int
 194 VSTPlugin::set_state(const XMLNode& node)
 195 {
 196         LocaleGuard lg (X_("POSIX"));
 197
 198         if (node.name() != state_node_name()) {
 199                 error << _("Bad node sent to VSTPlugin::set_state") << endmsg;
 200                 return 0;
 201         }
 202
 203         XMLNode* child;
 204
 205         if ((child = find_named_node (node, X_("chunk"))) != 0) {
 206
 207                 XMLPropertyList::const_iterator i;
 208
 209                 XMLNodeList::const_iterator n;
 210                 for (n = child->children ().begin (); n != child->children ().end (); ++n) {
 211                         if ((*n)->is_content ()) {
 212                                 gsize chunk_size = 0;
 213                                 guchar * data = g_base64_decode ((*n)->content ().c_str (), &chunk_size);
 214                                 //cerr << "Dispatch setChunk for " << name() << endl;
 215                                 if (_plugin->dispatcher (_plugin, 24 /* effSetChunk */, 0, chunk_size, data, 0) == 0) {
 216                                         g_free (data);
 217                                         return 0;
 218                                 } else {
 219                                         g_free (data);
 220                                         return -1;
 221                                 }
 222                         }
 223                 }
 224
 225                 return 0;
 226         } else if ((child = find_named_node (node, X_("parameters"))) != 0) {
 227
 228                 XMLPropertyList::const_iterator i;
 229
 230                 for (i = child->properties().begin(); i != child->properties().end(); ++i) {
 231                         long param;
 232                         float val;
 233
 234                         sscanf ((*i)->name().c_str(), "param_%ld", &param);
 235                         sscanf ((*i)->value().c_str(), "%f", &val);
 236
 237                         // cerr << "2setParameter for " << name() << endl;
 238                         _plugin->setParameter (_plugin, param, val);
 239                 }
 240
 241                 return 0;
 242         }
 243
 244         return -1;
 245 }
 246
 247 int
 248 VSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
 249 {
 250         VstParameterProperties prop;
 251
 252         desc.min_unbound = false;
 253         desc.max_unbound = false;
 254         prop.flags = 0;
 255
 256         //cerr << "Dispatch getParameterProperties for " << name() << endl;
 257         if (_plugin->dispatcher (_plugin, effGetParameterProperties, which, 0, &prop, 0)) {
 258
 259                 if (prop.flags & kVstParameterUsesIntegerMinMax) {
 260                         desc.lower = prop.minInteger;
 261                         desc.upper = prop.maxInteger;
 262                 } else {
 263                         desc.lower = 0;
 264                         desc.upper = 1.0;
 265                 }
 266
 267                 if (prop.flags & kVstParameterUsesIntStep) {
 268
 269                         desc.step = prop.stepInteger;
 270                         desc.smallstep = prop.stepInteger;
 271                         desc.largestep = prop.stepInteger;
 272
 273                 } else if (prop.flags & kVstParameterUsesFloatStep) {
 274
 275                         desc.step = prop.stepFloat;
 276                         desc.smallstep = prop.smallStepFloat;
 277                         desc.largestep = prop.largeStepFloat;
 278
 279                 } else {
 280
 281                         float range = desc.upper - desc.lower;
 282
 283                         desc.step = range / 100.0f;
 284                         desc.smallstep = desc.step / 2.0f;
 285                         desc.largestep = desc.step * 10.0f;
 286                 }
 287
 288                 desc.toggled = prop.flags & kVstParameterIsSwitch;
 289                 // cerr << "parameter " << which << " toggled = " << desc.toggled << " from " << std::hex << prop.flags << " vs. " << kVstParameterIsSwitch << std::dec << endl;
 290                 desc.logarithmic = false;
 291                 desc.sr_dependent = false;
 292                 desc.label = prop.label;
 293
 294         } else {
 295
 296                 /* old style */
 297
 298                 char label[64];
 299                 label[0] = '\0';
 300
 301                 // cerr << "Dispatch paramName for " << name() << endl;
 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 (string name)
 321 {
 322
 323         if (_plugin->flags & 32 /* effFlagsProgramChunks */) {
 324                 error << _("no support for presets using chunks at this time")
 325                       << endmsg;
 326                 return false;
 327         }
 328         return Plugin::load_preset (name);
 329 }
 330
 331 bool
 332 VSTPlugin::save_preset (string name)
 333 {
 334         if (_plugin->flags & 32 /* effFlagsProgramChunks */) {
 335                 error << _("no support for presets using chunks at this time")
 336                       << endmsg;
 337                 return false;
 338         }
 339
 340         return Plugin::save_preset (name, "vst");
 341 }
 342
 343 string
 344 VSTPlugin::describe_parameter (uint32_t param)
 345 {
 346         char name[64];
 347         // cerr << "Dispatch effGetParamName for " << this->name() << endl;
 348         _plugin->dispatcher (_plugin, effGetParamName, param, 0, name, 0);
 349         return name;
 350 }
 351
 352 nframes_t
 353 VSTPlugin::latency () const
 354 {
 355 #ifdef VESTIGE_HEADER
 356         return *((nframes_t *) (((char *) &_plugin->flags) + 12)); /* initialDelay */
 357 #else
 358         return 0;
 359 #endif
 360 }
 361
 362 set<uint32_t>
 363 VSTPlugin::automatable () const
 364 {
 365         set<uint32_t> ret;
 366
 367         for (uint32_t i = 0; i < parameter_count(); ++i){
 368                 ret.insert (ret.end(), i);
 369         }
 370
 371         return ret;
 372 }
 373
 374 int
 375 VSTPlugin::connect_and_run (vector<Sample*>& bufs, uint32_t maxbuf, int32_t& in_index, int32_t& out_index, nframes_t nframes, nframes_t offset)
 376 {
 377         float *ins[_plugin->numInputs];
 378         float *outs[_plugin->numOutputs];
 379         int32_t i;
 380
 381         if (nframes == 0) {
 382                 warning << _("VST plugin called with zero frames - please notify Ardour developers") << endmsg;
 383                 return 0;
 384         }
 385
 386         for (i = 0; i < (int32_t) _plugin->numInputs; ++i) {
 387                 ins[i] = bufs[min((uint32_t) in_index,maxbuf - 1)] + offset;
 388                 in_index++;
 389         }
 390
 391         for (i = 0; i < (int32_t) _plugin->numOutputs; ++i) {
 392                 outs[i] = bufs[min((uint32_t) out_index,maxbuf - 1)] + offset;
 393
 394                 /* unbelievably, several VST plugins still rely on Cubase
 395                    behaviour and do not silence the buffer in processReplacing
 396                    when they have no output.
 397                 */
 398
 399                 // memset (outs[i], 0, sizeof (Sample) * nframes);
 400                 out_index++;
 401         }
 402
 403         /* we already know it can support processReplacing */
 404
 405         // cerr << "!ProcessReplacing for " << name() << endl;
 406         _plugin->processReplacing (_plugin, ins, outs, nframes);
 407
 408         return 0;
 409 }
 410
 411 void
 412 VSTPlugin::deactivate ()
 413 {
 414         //cerr << "Dispatch effMainsChanged for " << name() << endl;
 415         _plugin->dispatcher (_plugin, effMainsChanged, 0, 0, NULL, 0.0f);
 416 }
 417
 418 void
 419 VSTPlugin::activate ()
 420 {
 421         //cerr << "Dispatch effMainsChanged for " << name() << endl;
 422         _plugin->dispatcher (_plugin, effMainsChanged, 0, 1, NULL, 0.0f);
 423 }
 424
 425 string
 426 VSTPlugin::unique_id() const
 427 {
 428         char buf[32];
 429 #ifdef VESTIGE_HEADER
 430         snprintf (buf, sizeof (buf), "%d", *((int32_t*) &_plugin->unused_id));
 431 #else
 432         snprintf (buf, sizeof (buf), "%d", _plugin->uniqueID);
 433 #endif
 434         return string (buf);
 435 }
 436
 437
 438 const char *
 439 VSTPlugin::name () const
 440 {
 441         return handle->name;
 442 }
 443
 444 const char *
 445 VSTPlugin::maker () const
 446 {
 447         return "imadeit";
 448 }
 449
 450 const char *
 451 VSTPlugin::label () const
 452 {
 453         return handle->name;
 454 }
 455
 456 uint32_t
 457 VSTPlugin::parameter_count() const
 458 {
 459         return _plugin->numParams;
 460 }
 461
 462 bool
 463 VSTPlugin::has_editor () const
 464 {
 465         return _plugin->flags & effFlagsHasEditor;
 466 }
 467
 468 void
 469 VSTPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
 470 {
 471         char *first_nonws;
 472
 473         //cerr << "Dispatch getParamDisplay for " << name() << endl;
 474         _plugin->dispatcher (_plugin, 7 /* effGetParamDisplay */, param, 0, buf, 0);
 475
 476         if (buf[0] == '\0') {
 477                 return;
 478         }
 479
 480         first_nonws = buf;
 481         while (*first_nonws && isspace (*first_nonws)) {
 482                 first_nonws++;
 483         }
 484         if (*first_nonws == '\0') {
 485                 return;
 486         }
 487
 488         memmove (buf, first_nonws, strlen (buf) - (first_nonws - buf) + 1);
 489 }
 490
 491 PluginPtr
 492 VSTPluginInfo::load (Session& session)
 493 {
 494         try {
 495                 PluginPtr plugin;
 496
 497                 if (Config->get_use_vst()) {
 498                         FSTHandle* handle;
 499
 500                         handle = fst_load(path.c_str());
 501
 502                         if ( (int)handle == -1) {
 503                                 error << string_compose(_("VST: cannot load module from \"%1\""), path) << endmsg;
 504                         } else {
 505                                 plugin.reset (new VSTPlugin (session.engine(), session, handle));
 506                         }
 507                 } else {
 508                         error << _("You asked ardour to not use any VST plugins") << endmsg;
 509                         return PluginPtr ((Plugin*) 0);
 510                 }
 511
 512                 plugin->set_info(PluginInfoPtr(new VSTPluginInfo(*this)));
 513                 return plugin;
 514         }
 515
 516         catch (failed_constructor &err) {
 517                 return PluginPtr ((Plugin*) 0);
 518         }
 519 }