2 Copyright (C) 2004 Paul Davis
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.
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.
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.
26 #include <cstdio> // so libraptor doesn't complain
29 #include <cstring> // for memmove
33 #include <glibmm/ustring.h>
34 #include <glibmm/miscutils.h>
39 #include <pbd/compose.h>
40 #include <pbd/error.h>
41 #include <pbd/pathscanner.h>
42 #include <pbd/xml++.h>
44 #include <ardour/ardour.h>
45 #include <ardour/session.h>
46 #include <ardour/audioengine.h>
47 #include <ardour/vst_plugin.h>
49 #include <pbd/stl_delete.h>
54 using namespace ARDOUR;
59 VSTPlugin::VSTPlugin (AudioEngine& e, Session& session, FSTHandle* h)
64 if ((_fst = fst_instantiate (handle, Session::vst_callback, this)) == 0) {
65 throw failed_constructor();
68 _plugin = _fst->plugin;
71 /* set rate and blocksize */
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);
80 /* set program to zero */
82 //cerr << "Dispatch " << "effSetProgram" << " for " << name() << endl;
83 _plugin->dispatcher (_plugin, effSetProgram, 0, 0, NULL, 0.0f);
85 Plugin::setup_controls ();
88 VSTPlugin::VSTPlugin (const VSTPlugin &other)
91 handle = other.handle;
93 if ((_fst = fst_instantiate (handle, Session::vst_callback, this)) == 0) {
94 throw failed_constructor();
96 _plugin = _fst->plugin;
98 Plugin::setup_controls ();
101 VSTPlugin::~VSTPlugin ()
104 GoingAway (); /* EMIT SIGNAL */
109 VSTPlugin::set_block_size (nframes_t nframes)
112 //cerr << "Dispatch effSetBlockSize for " << name() << endl;
113 _plugin->dispatcher (_plugin, effSetBlockSize, 0, nframes, NULL, 0.0f);
118 VSTPlugin::default_value (uint32_t port)
124 VSTPlugin::set_parameter (uint32_t which, float val)
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";
134 VSTPlugin::get_parameter (uint32_t which) const
136 // cerr << "GetParameter for " << name() << endl;
137 return _plugin->getParameter (_plugin, which);
142 VSTPlugin::nth_parameter (uint32_t n, bool& ok) const
149 VSTPlugin::get_state()
151 XMLNode *root = new XMLNode (state_node_name());
152 LocaleGuard lg (X_("POSIX"));
154 if (_fst->current_program != -1) {
156 snprintf (buf, sizeof (buf), "%d", _fst->current_program);
157 root->add_property ("current-program", buf);
160 if (_plugin->flags & 32 /* effFlagsProgramChunks */) {
162 /* fetch the current chunk */
167 //cerr << "Dispatch getChunk for " << name() << endl;
168 if ((data_size = _plugin->dispatcher (_plugin, 23 /* effGetChunk */, 0, 0, &data, false)) == 0) {
172 /* store information */
174 XMLNode* chunk_node = new XMLNode (X_("chunk"));
175 gchar * encoded_data = g_base64_encode (data, data_size);
176 chunk_node->add_content (encoded_data);
177 g_free (encoded_data);
179 root->add_child_nocopy (*chunk_node);
182 XMLNode* parameters = new XMLNode ("parameters");
184 for (long n = 0; n < _plugin->numParams; ++n) {
187 snprintf (index, sizeof (index), "param_%ld", n);
188 snprintf (val, sizeof (val), "%.12g", _plugin->getParameter (_plugin, n));
189 parameters->add_property (index, val);
192 root->add_child_nocopy (*parameters);
200 VSTPlugin::set_state(const XMLNode& node)
202 LocaleGuard lg (X_("POSIX"));
203 const XMLProperty* prop;
205 if (node.name() != state_node_name()) {
206 error << _("Bad node sent to VSTPlugin::set_state") << endmsg;
210 if ((prop = node.property ("current-program")) != 0) {
211 _fst->current_program = atoi (prop->value());
217 if ((child = find_named_node (node, X_("chunk"))) != 0) {
219 XMLPropertyList::const_iterator i;
220 XMLNodeList::const_iterator n;
223 for (n = child->children ().begin (); n != child->children ().end (); ++n) {
224 if ((*n)->is_content ()) {
225 gsize chunk_size = 0;
226 guchar * data = g_base64_decode ((*n)->content ().c_str (), &chunk_size);
227 //cerr << "Dispatch setChunk for " << name() << endl;
228 ret = _plugin->dispatcher (_plugin, 24 /* effSetChunk */, 0, chunk_size, data, 0);
233 } else if ((child = find_named_node (node, X_("parameters"))) != 0) {
235 XMLPropertyList::const_iterator i;
237 for (i = child->properties().begin(); i != child->properties().end(); ++i) {
241 sscanf ((*i)->name().c_str(), "param_%ld", ¶m);
242 sscanf ((*i)->value().c_str(), "%f", &val);
244 // cerr << "2setParameter for " << name() << endl;
245 _plugin->setParameter (_plugin, param, val);
248 /* program number is not knowable */
250 _fst->current_program = -1;
261 VSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
263 VstParameterProperties prop;
265 desc.min_unbound = false;
266 desc.max_unbound = false;
269 //cerr << "Dispatch getParameterProperties for " << name() << endl;
270 if (_plugin->dispatcher (_plugin, effGetParameterProperties, which, 0, &prop, 0)) {
272 if (prop.flags & kVstParameterUsesIntegerMinMax) {
273 desc.lower = prop.minInteger;
274 desc.upper = prop.maxInteger;
280 if (prop.flags & kVstParameterUsesIntStep) {
282 desc.step = prop.stepInteger;
283 desc.smallstep = prop.stepInteger;
284 desc.largestep = prop.stepInteger;
286 } else if (prop.flags & kVstParameterUsesFloatStep) {
288 desc.step = prop.stepFloat;
289 desc.smallstep = prop.smallStepFloat;
290 desc.largestep = prop.largeStepFloat;
294 float range = desc.upper - desc.lower;
296 desc.step = range / 100.0f;
297 desc.smallstep = desc.step / 2.0f;
298 desc.largestep = desc.step * 10.0f;
301 desc.toggled = prop.flags & kVstParameterIsSwitch;
302 // cerr << "parameter " << which << " toggled = " << desc.toggled << " from " << std::hex << prop.flags << " vs. " << kVstParameterIsSwitch << std::dec << endl;
303 desc.logarithmic = false;
304 desc.sr_dependent = false;
305 desc.label = prop.label;
314 // cerr << "Dispatch paramName for " << name() << endl;
315 _plugin->dispatcher (_plugin, effGetParamName, which, 0, label, 0);
318 desc.integer_step = false;
322 desc.smallstep = 0.005f;
323 desc.largestep = 0.1f;
324 desc.toggled = false;
325 desc.logarithmic = false;
326 desc.sr_dependent = false;
333 VSTPlugin::load_preset (string name)
336 if (_plugin->flags & 32 /* effFlagsProgramChunks */) {
337 error << _("no support for presets using chunks at this time")
341 return Plugin::load_preset (name);
345 VSTPlugin::save_preset (string name)
347 if (_plugin->flags & 32 /* effFlagsProgramChunks */) {
348 error << _("no support for presets using chunks at this time")
353 return Plugin::save_preset (name, "vst");
357 VSTPlugin::describe_parameter (uint32_t param)
360 // cerr << "Dispatch effGetParamName for " << this->name() << endl;
361 _plugin->dispatcher (_plugin, effGetParamName, param, 0, name, 0);
366 VSTPlugin::latency () const
368 #ifdef VESTIGE_HEADER
369 return *((nframes_t *) (((char *) &_plugin->flags) + 12)); /* initialDelay */
376 VSTPlugin::automatable () const
380 for (uint32_t i = 0; i < parameter_count(); ++i){
381 ret.insert (ret.end(), i);
388 VSTPlugin::connect_and_run (vector<Sample*>& bufs, uint32_t maxbuf, int32_t& in_index, int32_t& out_index, nframes_t nframes, nframes_t offset)
390 float *ins[_plugin->numInputs];
391 float *outs[_plugin->numOutputs];
395 warning << _("VST plugin called with zero frames - please notify Ardour developers") << endmsg;
399 for (i = 0; i < (int32_t) _plugin->numInputs; ++i) {
400 ins[i] = bufs[min((uint32_t) in_index,maxbuf - 1)] + offset;
404 for (i = 0; i < (int32_t) _plugin->numOutputs; ++i) {
405 outs[i] = bufs[min((uint32_t) out_index,maxbuf - 1)] + offset;
407 /* unbelievably, several VST plugins still rely on Cubase
408 behaviour and do not silence the buffer in processReplacing
409 when they have no output.
412 // memset (outs[i], 0, sizeof (Sample) * nframes);
416 /* we already know it can support processReplacing */
418 // cerr << "!ProcessReplacing for " << name() << endl;
419 _plugin->processReplacing (_plugin, ins, outs, nframes);
425 VSTPlugin::deactivate ()
427 //cerr << "Dispatch effMainsChanged for " << name() << endl;
428 _plugin->dispatcher (_plugin, effMainsChanged, 0, 0, NULL, 0.0f);
432 VSTPlugin::activate ()
434 //cerr << "Dispatch effMainsChanged for " << name() << endl;
435 _plugin->dispatcher (_plugin, effMainsChanged, 0, 1, NULL, 0.0f);
439 VSTPlugin::unique_id() const
442 #ifdef VESTIGE_HEADER
443 snprintf (buf, sizeof (buf), "%d", *((int32_t*) &_plugin->unused_id));
445 snprintf (buf, sizeof (buf), "%d", _plugin->uniqueID);
452 VSTPlugin::name () const
458 VSTPlugin::maker () const
464 VSTPlugin::label () const
470 VSTPlugin::parameter_count() const
472 return _plugin->numParams;
476 VSTPlugin::has_editor () const
478 return _plugin->flags & effFlagsHasEditor;
482 VSTPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
486 //cerr << "Dispatch getParamDisplay for " << name() << endl;
487 _plugin->dispatcher (_plugin, 7 /* effGetParamDisplay */, param, 0, buf, 0);
489 if (buf[0] == '\0') {
494 while (*first_nonws && isspace (*first_nonws)) {
497 if (*first_nonws == '\0') {
501 memmove (buf, first_nonws, strlen (buf) - (first_nonws - buf) + 1);
505 VSTPluginInfo::load (Session& session)
510 if (Config->get_use_vst()) {
513 handle = fst_load(path.c_str());
515 if ( (int)handle == -1) {
516 error << string_compose(_("VST: cannot load module from \"%1\""), path) << endmsg;
518 plugin.reset (new VSTPlugin (session.engine(), session, handle));
521 error << _("You asked ardour to not use any VST plugins") << endmsg;
522 return PluginPtr ((Plugin*) 0);
525 plugin->set_info(PluginInfoPtr(new VSTPluginInfo(*this)));
529 catch (failed_constructor &err) {
530 return PluginPtr ((Plugin*) 0);