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     $Id$
  19 */
  20
  21 #include <algorithm>
  22 #include <vector>
  23 #include <string>
  24 #include <ctype.h>
  25
  26 #include <cstdlib>
  27 #include <cstdio> // so libraptor doesn't complain
  28 #include <cmath>
  29 #include <dirent.h>
  30 #include <string.h> // for memmove
  31 #include <sys/stat.h>
  32 #include <cerrno>
  33
  34 #include <lrdf.h>
  35 #include <fst.h>
  36
  37 #include <pbd/compose.h>
  38 #include <pbd/error.h>
  39 #include <pbd/pathscanner.h>
  40 #include <pbd/xml++.h>
  41
  42 #include <vst/aeffectx.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         _plugin->dispatcher (_plugin, effSetSampleRate, 0, 0, NULL,
  74                              (float) session.frame_rate());
  75         _plugin->dispatcher (_plugin, effSetBlockSize, 0,
  76                              session.get_block_size(), NULL, 0.0f);
  77
  78         /* set program to zero */
  79
  80         _plugin->dispatcher (_plugin, effSetProgram, 0, 0, NULL, 0.0f);
  81
  82         Plugin::setup_controls ();
  83 }
  84
  85 VSTPlugin::VSTPlugin (const VSTPlugin &other)
  86         : Plugin (other)
  87 {
  88         handle = other.handle;
  89
  90         if ((_fst = fst_instantiate (handle, Session::vst_callback, this)) == 0) {
  91                 throw failed_constructor();
  92         }
  93         _plugin = _fst->plugin;
  94
  95         Plugin::setup_controls ();
  96 }
  97
  98 VSTPlugin::~VSTPlugin ()
  99 {
 100         deactivate ();
 101         GoingAway (); /* EMIT SIGNAL */
 102         fst_close (_fst);
 103 }
 104
 105 void
 106 VSTPlugin::set_block_size (nframes_t nframes)
 107 {
 108         deactivate ();
 109         _plugin->dispatcher (_plugin, effSetBlockSize, 0, nframes, NULL, 0.0f);
 110         activate ();
 111 }
 112
 113 float
 114 VSTPlugin::default_value (uint32_t port)
 115 {
 116         return 0;
 117 }
 118
 119 void
 120 VSTPlugin::set_parameter (uint32_t which, float val)
 121 {
 122         _plugin->setParameter (_plugin, which, val);
 123         ParameterChanged (which, val); /* EMIT SIGNAL */
 124 }
 125
 126 float
 127 VSTPlugin::get_parameter (uint32_t which) const
 128 {
 129         return _plugin->getParameter (_plugin, which);
 130
 131 }
 132
 133 uint32_t
 134 VSTPlugin::nth_parameter (uint32_t n, bool& ok) const
 135 {
 136         ok = true;
 137         return n;
 138 }
 139
 140 XMLNode&
 141 VSTPlugin::get_state()
 142 {
 143         XMLNode *root = new XMLNode (state_node_name());
 144         LocaleGuard lg (X_("POSIX"));
 145
 146         if (_plugin->flags & effFlagsProgramChunks) {
 147
 148                 /* fetch the current chunk */
 149
 150                 void* data;
 151                 long  data_size;
 152
 153                 if ((data_size = _plugin->dispatcher (_plugin, effGetChunk, 0, 0, &data, false)) == 0) {
 154                         return *root;
 155                 }
 156
 157                 /* save it to a file */
 158
 159                 string path;
 160                 struct stat sbuf;
 161
 162                 path = getenv ("HOME");
 163                 path += "/.ardour/vst";
 164
 165                 if (stat (path.c_str(), &sbuf)) {
 166                         if (errno == ENOENT) {
 167                                 if (g_mkdir_with_parents (path.c_str(), 0600)) {
 168                                         error << string_compose (_("cannot create VST chunk directory: %1"),
 169                                                                  strerror (errno))
 170                                               << endmsg;
 171                                         return *root;
 172                                 }
 173
 174                         } else {
 175
 176                                 error << string_compose (_("cannot check VST chunk directory: %1"),
 177                                                   strerror (errno))
 178                                       << endmsg;
 179                                 return *root;
 180                         }
 181
 182                 } else if (!S_ISDIR (sbuf.st_mode)) {
 183                         error << string_compose (_("%1 exists but is not a directory"), path)
 184                               << endmsg;
 185                         return *root;
 186                 }
 187
 188                 path += "something";
 189
 190                 /* store information */
 191
 192                 XMLNode* chunk_node = new XMLNode (X_("chunk"));
 193                 chunk_node->add_property ("path", path);
 194
 195                 root->add_child_nocopy (*chunk_node);
 196
 197         } else {
 198
 199                 XMLNode* parameters = new XMLNode ("parameters");
 200
 201                 for (long n = 0; n < _plugin->numParams; ++n) {
 202                         char index[64];
 203                         char val[32];
 204                         snprintf (index, sizeof (index), "param_%ld", n);
 205                         snprintf (val, sizeof (val), "%.12g", _plugin->getParameter (_plugin, n));
 206                         parameters->add_property (index, val);
 207                 }
 208
 209                 root->add_child_nocopy (*parameters);
 210         }
 211
 212         return *root;
 213 }
 214
 215 int
 216 VSTPlugin::set_state(const XMLNode& node)
 217 {
 218         LocaleGuard lg (X_("POSIX"));
 219
 220         if (node.name() != state_node_name()) {
 221                 error << _("Bad node sent to VSTPlugin::set_state") << endmsg;
 222                 return 0;
 223         }
 224
 225         XMLNode* child;
 226
 227         if ((child = find_named_node (node, X_("chunks"))) != 0) {
 228
 229                 return 0;
 230
 231         } else if ((child = find_named_node (node, X_("parameters"))) != 0) {
 232
 233                 XMLPropertyList::const_iterator i;
 234
 235                 for (i = child->properties().begin(); i != child->properties().end(); ++i) {
 236                         long param;
 237                         float val;
 238
 239                         sscanf ((*i)->name().c_str(), "param_%ld", &param);
 240                         sscanf ((*i)->value().c_str(), "%f", &val);
 241
 242                         _plugin->setParameter (_plugin, param, val);
 243                 }
 244
 245                 return 0;
 246         }
 247
 248         return -1;
 249 }
 250
 251 int
 252 VSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
 253 {
 254         VstParameterProperties prop;
 255
 256         desc.min_unbound = false;
 257         desc.max_unbound = false;
 258
 259         if (_plugin->dispatcher (_plugin, effGetParameterProperties, which, 0, &prop, 0)) {
 260
 261                 /* i have yet to find or hear of a VST plugin that uses this */
 262
 263                 if (prop.flags & kVstParameterUsesIntegerMinMax) {
 264                         desc.lower = prop.minInteger;
 265                         desc.upper = prop.maxInteger;
 266                 } else {
 267                         desc.lower = 0;
 268                         desc.upper = 1.0;
 269                 }
 270
 271                 if (prop.flags & kVstParameterUsesIntStep) {
 272
 273                         desc.step = prop.stepInteger;
 274                         desc.smallstep = prop.stepInteger;
 275                         desc.largestep = prop.stepInteger;
 276
 277                 } else if (prop.flags & kVstParameterUsesFloatStep) {
 278
 279                         desc.step = prop.stepFloat;
 280                         desc.smallstep = prop.smallStepFloat;
 281                         desc.largestep = prop.largeStepFloat;
 282
 283                 } else {
 284
 285                         float range = desc.upper - desc.lower;
 286
 287                         desc.step = range / 100.0f;
 288                         desc.smallstep = desc.step / 2.0f;
 289                         desc.largestep = desc.step * 10.0f;
 290                 }
 291
 292                 desc.toggled = prop.flags & kVstParameterIsSwitch;
 293                 desc.logarithmic = false;
 294                 desc.sr_dependent = false;
 295                 desc.label = prop.label;
 296
 297         } else {
 298
 299                 /* old style */
 300
 301                 char label[64];
 302                 label[0] = '\0';
 303
 304                 _plugin->dispatcher (_plugin, effGetParamName, which, 0, label, 0);
 305
 306                 desc.label = label;
 307                 desc.integer_step = false;
 308                 desc.lower = 0.0f;
 309                 desc.upper = 1.0f;
 310                 desc.step = 0.01f;
 311                 desc.smallstep = 0.005f;
 312                 desc.largestep = 0.1f;
 313                 desc.toggled = false;
 314                 desc.logarithmic = false;
 315                 desc.sr_dependent = false;
 316         }
 317
 318         return 0;
 319 }
 320
 321 bool
 322 VSTPlugin::load_preset (string name)
 323 {
 324         if (_plugin->flags & effFlagsProgramChunks) {
 325                 error << _("no support for presets using chunks at this time")
 326                       << endmsg;
 327                 return false;
 328         }
 329         return Plugin::load_preset (name);
 330 }
 331
 332 bool
 333 VSTPlugin::save_preset (string name)
 334 {
 335         if (_plugin->flags & effFlagsProgramChunks) {
 336                 error << _("no support for presets using chunks at this time")
 337                       << endmsg;
 338                 return false;
 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         _plugin->dispatcher (_plugin, effGetParamName, param, 0, name, 0);
 348         return name;
 349 }
 350
 351 nframes_t
 352 VSTPlugin::latency () const
 353 {
 354         return _plugin->initialDelay;
 355 }
 356
 357 set<uint32_t>
 358 VSTPlugin::automatable () const
 359 {
 360         set<uint32_t> ret;
 361
 362         for (uint32_t i = 0; i < parameter_count(); ++i){
 363                 ret.insert (ret.end(), i);
 364         }
 365
 366         return ret;
 367 }
 368
 369 int
 370 VSTPlugin::connect_and_run (vector<Sample*>& bufs, uint32_t maxbuf, int32_t& in_index, int32_t& out_index, nframes_t nframes, nframes_t offset)
 371 {
 372         float *ins[_plugin->numInputs];
 373         float *outs[_plugin->numOutputs];
 374         int32_t i;
 375
 376         for (i = 0; i < (int32_t) _plugin->numInputs; ++i) {
 377                 ins[i] = bufs[min((uint32_t) in_index,maxbuf - 1)] + offset;
 378                 in_index++;
 379         }
 380
 381         for (i = 0; i < (int32_t) _plugin->numOutputs; ++i) {
 382                 outs[i] = bufs[min((uint32_t) out_index,maxbuf - 1)] + offset;
 383
 384                 /* unbelievably, several VST plugins still rely on Cubase
 385                    behaviour and do not silence the buffer in processReplacing
 386                    when they have no output.
 387                 */
 388
 389                 // memset (outs[i], 0, sizeof (Sample) * nframes);
 390                 out_index++;
 391         }
 392
 393
 394         /* we already know it can support processReplacing */
 395
 396         _plugin->processReplacing (_plugin, ins, outs, nframes);
 397
 398         return 0;
 399 }
 400
 401 void
 402 VSTPlugin::deactivate ()
 403 {
 404         _plugin->dispatcher (_plugin, effMainsChanged, 0, 0, NULL, 0.0f);
 405 }
 406
 407 void
 408 VSTPlugin::activate ()
 409 {
 410         _plugin->dispatcher (_plugin, effMainsChanged, 0, 1, NULL, 0.0f);
 411 }
 412
 413 uint32_t
 414 VSTPlugin::unique_id() const
 415 {
 416         return _plugin->uniqueID;
 417 }
 418
 419
 420 const char *
 421 VSTPlugin::name () const
 422 {
 423         return handle->name;
 424 }
 425
 426 const char *
 427 VSTPlugin::maker () const
 428 {
 429         return "imadeit";
 430 }
 431
 432 const char *
 433 VSTPlugin::label () const
 434 {
 435         return handle->name;
 436 }
 437
 438 uint32_t
 439 VSTPlugin::parameter_count() const
 440 {
 441         return _plugin->numParams;
 442 }
 443
 444 bool
 445 VSTPlugin::has_editor () const
 446 {
 447         return _plugin->flags & effFlagsHasEditor;
 448 }
 449
 450 void
 451 VSTPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
 452 {
 453         char lab[9];
 454         char *first_nonws;
 455
 456         _plugin->dispatcher (_plugin, effGetParamLabel, param, 0, lab, 0);
 457         _plugin->dispatcher (_plugin, effGetParamDisplay, param, 0, buf, 0);
 458
 459         if (buf[0] == '\0') {
 460                 return;
 461         }
 462
 463         first_nonws = buf;
 464         while (*first_nonws && isspace (*first_nonws)) {
 465                 first_nonws++;
 466         }
 467         if (*first_nonws == '\0') {
 468                 return;
 469         }
 470
 471         memmove (buf, first_nonws, strlen (buf) - (first_nonws - buf) + 1);
 472 }
 473
 474 PluginPtr
 475 VSTPluginInfo::load (Session& session)
 476 {
 477         try {
 478                 PluginPtr plugin;
 479
 480                 if (Config->get_use_vst()) {
 481                         FSTHandle* handle;
 482
 483                         handle = fst_load(path.c_str());
 484
 485                         if ( (int)handle == -1) {
 486                                 error << string_compose(_("VST: cannot load module from \"%1\""), path) << endmsg;
 487                         } else {
 488                                 plugin.reset (new VSTPlugin (session.engine(), session, handle));
 489                         }
 490                 } else {
 491                         error << _("You asked ardour to not use any VST plugins") << endmsg;
 492                         return PluginPtr ((Plugin*) 0);
 493                 }
 494
 495                 plugin->set_info(PluginInfoPtr(new VSTPluginInfo(*this)));
 496                 return plugin;
 497         }
 498
 499         catch (failed_constructor &err) {
 500                 return PluginPtr ((Plugin*) 0);
 501         }
 502 }