2 Copyright (C) 2010 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.
21 #include "pbd/gstdio_compat.h"
23 #include <glibmm/fileutils.h>
24 #include <glibmm/miscutils.h>
26 #include "pbd/floating.h"
27 #include "pbd/locale_guard.h"
29 #include "ardour/vst_plugin.h"
30 #include "ardour/vestige/aeffectx.h"
31 #include "ardour/session.h"
32 #include "ardour/vst_types.h"
33 #include "ardour/filesystem_paths.h"
34 #include "ardour/audio_buffer.h"
40 using namespace ARDOUR;
42 VSTPlugin::VSTPlugin (AudioEngine& engine, Session& session, VSTHandle* handle)
43 : Plugin (engine, session)
50 memset (&_timeInfo, 0, sizeof(_timeInfo));
53 VSTPlugin::~VSTPlugin ()
59 VSTPlugin::set_plugin (AEffect* e)
64 /* set rate and blocksize */
66 _plugin->dispatcher (_plugin, effSetSampleRate, 0, 0, NULL, (float) _session.frame_rate());
67 _plugin->dispatcher (_plugin, effSetBlockSize, 0, _session.get_block_size(), NULL, 0.0f);
71 VSTPlugin::deactivate ()
73 _plugin->dispatcher (_plugin, effMainsChanged, 0, 0, NULL, 0.0f);
77 VSTPlugin::activate ()
79 _plugin->dispatcher (_plugin, effMainsChanged, 0, 1, NULL, 0.0f);
83 VSTPlugin::set_block_size (pframes_t nframes)
86 _plugin->dispatcher (_plugin, effSetBlockSize, 0, nframes, NULL, 0.0f);
92 VSTPlugin::default_value (uint32_t)
98 VSTPlugin::get_parameter (uint32_t which) const
100 return _plugin->getParameter (_plugin, which);
104 VSTPlugin::set_parameter (uint32_t which, float newval)
106 float oldval = get_parameter (which);
108 if (PBD::floateq (oldval, newval, 1)) {
112 _plugin->setParameter (_plugin, which, newval);
114 float curval = get_parameter (which);
116 if (!PBD::floateq (curval, oldval, 1)) {
117 /* value has changed, follow rest of the notification path */
118 Plugin::set_parameter (which, newval);
123 VSTPlugin::nth_parameter (uint32_t n, bool& ok) const
129 /** Get VST chunk as base64-encoded data.
130 * @param single true for single program, false for all programs.
131 * @return 0-terminated base64-encoded data; must be passed to g_free () by caller.
134 VSTPlugin::get_chunk (bool single) const
137 int32_t data_size = _plugin->dispatcher (_plugin, 23 /* effGetChunk */, single ? 1 : 0, 0, &data, 0);
138 if (data_size == 0) {
142 return g_base64_encode (data, data_size);
145 /** Set VST chunk from base64-encoded data.
146 * @param 0-terminated base64-encoded data.
147 * @param single true for single program, false for all programs.
148 * @return 0 on success, non-0 on failure
151 VSTPlugin::set_chunk (gchar const * data, bool single)
154 guchar* raw_data = g_base64_decode (data, &size);
155 int const r = _plugin->dispatcher (_plugin, 24 /* effSetChunk */, single ? 1 : 0, size, raw_data, 0);
161 VSTPlugin::add_state (XMLNode* root) const
165 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
167 gchar* data = get_chunk (false);
172 /* store information */
174 XMLNode* chunk_node = new XMLNode (X_("chunk"));
176 chunk_node->add_content (data);
179 root->add_child_nocopy (*chunk_node);
183 XMLNode* parameters = new XMLNode ("parameters");
185 for (int32_t n = 0; n < _plugin->numParams; ++n) {
188 snprintf (index, sizeof (index), "param-%d", n);
189 snprintf (val, sizeof (val), "%.12g", _plugin->getParameter (_plugin, n));
190 parameters->add_property (index, val);
193 root->add_child_nocopy (*parameters);
198 VSTPlugin::set_state (const XMLNode& node, int version)
203 if (node.name() != state_node_name()) {
204 error << _("Bad node sent to VSTPlugin::set_state") << endmsg;
208 #ifndef NO_PLUGIN_STATE
211 if ((child = find_named_node (node, X_("chunk"))) != 0) {
213 XMLPropertyList::const_iterator i;
214 XMLNodeList::const_iterator n;
216 for (n = child->children ().begin (); n != child->children ().end (); ++n) {
217 if ((*n)->is_content ()) {
218 /* XXX: this may be dubious for the same reasons that we delay
219 execution of load_preset.
221 ret = set_chunk ((*n)->content().c_str(), false);
225 } else if ((child = find_named_node (node, X_("parameters"))) != 0) {
227 XMLPropertyList::const_iterator i;
229 for (i = child->properties().begin(); i != child->properties().end(); ++i) {
233 sscanf ((*i)->name().c_str(), "param-%d", ¶m);
234 sscanf ((*i)->value().c_str(), "%f", &val);
236 _plugin->setParameter (_plugin, param, val);
244 Plugin::set_state (node, version);
250 VSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
252 VstParameterProperties prop;
254 memset (&prop, 0, sizeof (VstParameterProperties));
255 desc.min_unbound = false;
256 desc.max_unbound = false;
259 if (_plugin->dispatcher (_plugin, effGetParameterProperties, which, 0, &prop, 0)) {
261 /* i have yet to find or hear of a VST plugin that uses this */
262 /* RG: faust2vsti does use this :) */
264 if (prop.flags & kVstParameterUsesIntegerMinMax) {
265 desc.lower = prop.minInteger;
266 desc.upper = prop.maxInteger;
272 if (prop.flags & kVstParameterUsesIntStep) {
274 desc.step = prop.stepInteger;
275 desc.smallstep = prop.stepInteger;
276 desc.largestep = prop.stepInteger;
278 } else if (prop.flags & kVstParameterUsesFloatStep) {
280 desc.step = prop.stepFloat;
281 desc.smallstep = prop.smallStepFloat;
282 desc.largestep = prop.largeStepFloat;
286 float range = desc.upper - desc.lower;
288 desc.step = range / 100.0f;
289 desc.smallstep = desc.step / 2.0f;
290 desc.largestep = desc.step * 10.0f;
293 if (strlen(prop.label) == 0) {
294 _plugin->dispatcher (_plugin, effGetParamName, which, 0, prop.label, 0);
297 desc.toggled = prop.flags & kVstParameterIsSwitch;
298 desc.logarithmic = false;
299 desc.sr_dependent = false;
300 desc.label = prop.label;
307 /* some VST plugins expect this buffer to be zero-filled */
308 memset (label, 0, sizeof (label));
310 _plugin->dispatcher (_plugin, effGetParamName, which, 0, label, 0);
313 desc.integer_step = false;
317 desc.smallstep = 0.005f;
318 desc.largestep = 0.1f;
319 desc.toggled = false;
320 desc.logarithmic = false;
321 desc.sr_dependent = false;
328 VSTPlugin::load_preset (PresetRecord r)
333 s = load_user_preset (r);
335 s = load_plugin_preset (r);
339 Plugin::load_preset (r);
346 VSTPlugin::load_plugin_preset (PresetRecord r)
348 /* This is a plugin-provided preset.
349 We can't dispatch directly here; too many plugins expects only one GUI thread.
352 /* Extract the index of this preset from the URI */
356 int const p = sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
359 sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
361 _state->want_program = index;
366 VSTPlugin::load_user_preset (PresetRecord r)
368 /* This is a user preset; we load it, and this code also knows about the
369 non-direct-dispatch thing.
372 boost::shared_ptr<XMLTree> t (presets_tree ());
377 XMLNode* root = t->root ();
379 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
380 XMLProperty const * label = (*i)->property (X_("label"));
384 if (label->value() != r.label) {
388 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
390 /* Load a user preset chunk from our XML file and send it via a circuitous route to the plugin */
392 if (_state->wanted_chunk) {
393 g_free (_state->wanted_chunk);
396 for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
397 if ((*j)->is_content ()) {
398 /* we can't dispatch directly here; too many plugins expect only one GUI thread */
400 guchar* raw_data = g_base64_decode ((*j)->content().c_str(), &size);
401 _state->wanted_chunk = raw_data;
402 _state->wanted_chunk_size = size;
403 _state->want_chunk = 1;
412 for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
413 if ((*j)->name() == X_("Parameter")) {
414 XMLProperty const * index = (*j)->property (X_("index"));
415 XMLProperty const * value = (*j)->property (X_("value"));
420 set_parameter (atoi (index->value().c_str()), atof (value->value().c_str ()));
430 VSTPlugin::do_save_preset (string name)
432 boost::shared_ptr<XMLTree> t (presets_tree ());
438 /* XXX: use of _presets.size() + 1 for the unique ID here is dubious at best */
439 string const uri = string_compose (X_("VST:%1:%2"), unique_id (), _presets.size() + 1);
441 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
443 p = new XMLNode (X_("ChunkPreset"));
444 p->add_property (X_("uri"), uri);
445 p->add_property (X_("label"), name);
446 gchar* data = get_chunk (true);
447 p->add_content (string (data));
452 p = new XMLNode (X_("Preset"));
453 p->add_property (X_("uri"), uri);
454 p->add_property (X_("label"), name);
456 for (uint32_t i = 0; i < parameter_count(); ++i) {
457 if (parameter_is_input (i)) {
458 XMLNode* c = new XMLNode (X_("Parameter"));
459 c->add_property (X_("index"), string_compose ("%1", i));
460 c->add_property (X_("value"), string_compose ("%1", get_parameter (i)));
461 p->add_child_nocopy (*c);
466 t->root()->add_child_nocopy (*p);
468 std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
469 f = Glib::build_filename (f, presets_file ());
476 VSTPlugin::do_remove_preset (string name)
478 boost::shared_ptr<XMLTree> t (presets_tree ());
483 t->root()->remove_nodes_and_delete (X_("label"), name);
485 std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
486 f = Glib::build_filename (f, presets_file ());
492 VSTPlugin::describe_parameter (Evoral::Parameter param)
495 memset (name, 0, sizeof (name));
497 /* some VST plugins expect this buffer to be zero-filled */
499 _plugin->dispatcher (_plugin, effGetParamName, param.id(), 0, name, 0);
501 if (name[0] == '\0') {
502 strcpy (name, _("Unknown"));
509 VSTPlugin::signal_latency () const
512 return _user_latency;
515 #if ( defined(__x86_64__) || defined(_M_X64) )
516 return *((int32_t *) (((char *) &_plugin->flags) + 24)); /* initialDelay */
518 return *((int32_t *) (((char *) &_plugin->flags) + 12)); /* initialDelay */
522 set<Evoral::Parameter>
523 VSTPlugin::automatable () const
525 set<Evoral::Parameter> ret;
527 for (uint32_t i = 0; i < parameter_count(); ++i) {
528 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
535 VSTPlugin::connect_and_run (BufferSet& bufs,
536 ChanMapping in_map, ChanMapping out_map,
537 pframes_t nframes, framecnt_t offset)
539 Plugin::connect_and_run (bufs, in_map, out_map, nframes, offset);
541 ChanCount bufs_count;
542 bufs_count.set(DataType::AUDIO, 1);
543 bufs_count.set(DataType::MIDI, 1);
546 BufferSet& silent_bufs = _session.get_silent_buffers(bufs_count);
547 BufferSet& scratch_bufs = _session.get_scratch_buffers(bufs_count);
549 /* VC++ doesn't support the C99 extension that allows
551 typeName foo[variableDefiningSize];
553 Use alloca instead of dynamic array (rather than std::vector which
554 allocs on the heap) because this is realtime code.
557 float** ins = (float**)alloca(_plugin->numInputs*sizeof(float*));
558 float** outs = (float**)alloca(_plugin->numOutputs*sizeof(float*));
562 uint32_t in_index = 0;
563 for (i = 0; i < (int32_t) _plugin->numInputs; ++i) {
566 index = in_map.get(DataType::AUDIO, in_index++, &valid);
568 ? bufs.get_audio(index).data(offset)
569 : silent_bufs.get_audio(0).data(offset);
572 uint32_t out_index = 0;
573 for (i = 0; i < (int32_t) _plugin->numOutputs; ++i) {
576 index = out_map.get(DataType::AUDIO, out_index++, &valid);
578 ? bufs.get_audio(index).data(offset)
579 : scratch_bufs.get_audio(0).data(offset);
582 if (bufs.count().n_midi() > 0) {
585 const uint32_t buf_index_in = in_map.get(DataType::MIDI, 0, &valid);
587 v = bufs.get_vst_midi (buf_index_in);
590 const uint32_t buf_index_out = out_map.get(DataType::MIDI, 0, &valid);
592 _midi_out_buf = &bufs.get_midi(buf_index_out);
593 _midi_out_buf->silence(0, 0);
598 _plugin->dispatcher (_plugin, effProcessEvents, 0, 0, v, 0);
602 /* we already know it can support processReplacing */
603 _plugin->processReplacing (_plugin, &ins[0], &outs[0], nframes);
610 VSTPlugin::unique_id () const
614 snprintf (buf, sizeof (buf), "%d", _plugin->uniqueID);
621 VSTPlugin::name () const
623 if (!_info->name.empty ()) {
624 return _info->name.c_str();
626 return _handle->name;
630 VSTPlugin::maker () const
632 return _info->creator.c_str();
636 VSTPlugin::label () const
638 return _handle->name;
642 VSTPlugin::parameter_count () const
644 return _plugin->numParams;
648 VSTPlugin::has_editor () const
650 return _plugin->flags & effFlagsHasEditor;
654 VSTPlugin::print_parameter (uint32_t param, char *buf, uint32_t /*len*/) const
658 _plugin->dispatcher (_plugin, 7 /* effGetParamDisplay */, param, 0, buf, 0);
660 if (buf[0] == '\0') {
665 while (*first_nonws && isspace (*first_nonws)) {
669 if (*first_nonws == '\0') {
673 memmove (buf, first_nonws, strlen (buf) - (first_nonws - buf) + 1);
677 VSTPlugin::find_presets ()
679 /* Built-in presets */
681 int const vst_version = _plugin->dispatcher (_plugin, effGetVstVersion, 0, 0, NULL, 0);
682 for (int i = 0; i < _plugin->numPrograms; ++i) {
683 PresetRecord r (string_compose (X_("VST:%1:%2"), unique_id (), i), "", false);
685 if (vst_version >= 2) {
687 if (_plugin->dispatcher (_plugin, 29, i, 0, buf, 0) == 1) {
690 r.label = string_compose (_("Preset %1"), i);
693 r.label = string_compose (_("Preset %1"), i);
696 _presets.insert (make_pair (r.uri, r));
699 /* User presets from our XML file */
701 boost::shared_ptr<XMLTree> t (presets_tree ());
704 XMLNode* root = t->root ();
705 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
707 XMLProperty const * uri = (*i)->property (X_("uri"));
708 XMLProperty const * label = (*i)->property (X_("label"));
713 PresetRecord r (uri->value(), label->value(), true);
714 _presets.insert (make_pair (r.uri, r));
720 /** @return XMLTree with our user presets; could be a new one if no existing
721 * one was found, or 0 if one was present but badly-formatted.
724 VSTPlugin::presets_tree () const
726 XMLTree* t = new XMLTree;
728 std::string p = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
730 if (!Glib::file_test (p, Glib::FILE_TEST_IS_DIR)) {
731 if (g_mkdir_with_parents (p.c_str(), 0755) != 0) {
732 error << _("Unable to make VST presets directory") << endmsg;
736 p = Glib::build_filename (p, presets_file ());
738 if (!Glib::file_test (p, Glib::FILE_TEST_EXISTS)) {
739 t->set_root (new XMLNode (X_("VSTPresets")));
752 /** @return Index of the first user preset in our lists */
754 VSTPlugin::first_user_preset_index () const
756 return _plugin->numPrograms;
760 VSTPlugin::presets_file () const
762 return string_compose ("vst-%1", unique_id ());