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)
51 VSTPlugin::~VSTPlugin ()
57 VSTPlugin::set_plugin (AEffect* e)
62 /* set rate and blocksize */
64 _plugin->dispatcher (_plugin, effSetSampleRate, 0, 0, NULL, (float) _session.frame_rate());
65 _plugin->dispatcher (_plugin, effSetBlockSize, 0, _session.get_block_size(), NULL, 0.0f);
69 VSTPlugin::deactivate ()
71 _plugin->dispatcher (_plugin, effMainsChanged, 0, 0, NULL, 0.0f);
75 VSTPlugin::activate ()
77 _plugin->dispatcher (_plugin, effMainsChanged, 0, 1, NULL, 0.0f);
81 VSTPlugin::set_block_size (pframes_t nframes)
84 _plugin->dispatcher (_plugin, effSetBlockSize, 0, nframes, NULL, 0.0f);
90 VSTPlugin::default_value (uint32_t)
96 VSTPlugin::get_parameter (uint32_t which) const
98 return _plugin->getParameter (_plugin, which);
102 VSTPlugin::set_parameter (uint32_t which, float newval)
104 float oldval = get_parameter (which);
106 if (PBD::floateq (oldval, newval, 1)) {
110 _plugin->setParameter (_plugin, which, newval);
112 float curval = get_parameter (which);
114 if (!PBD::floateq (curval, oldval, 1)) {
115 /* value has changed, follow rest of the notification path */
116 Plugin::set_parameter (which, newval);
121 VSTPlugin::set_parameter_automated (uint32_t which, float newval)
123 Plugin::set_parameter_automated (which, newval);
127 VSTPlugin::nth_parameter (uint32_t n, bool& ok) const
133 /** Get VST chunk as base64-encoded data.
134 * @param single true for single program, false for all programs.
135 * @return 0-terminated base64-encoded data; must be passed to g_free () by caller.
138 VSTPlugin::get_chunk (bool single) const
141 int32_t data_size = _plugin->dispatcher (_plugin, 23 /* effGetChunk */, single ? 1 : 0, 0, &data, 0);
142 if (data_size == 0) {
146 return g_base64_encode (data, data_size);
149 /** Set VST chunk from base64-encoded data.
150 * @param 0-terminated base64-encoded data.
151 * @param single true for single program, false for all programs.
152 * @return 0 on success, non-0 on failure
155 VSTPlugin::set_chunk (gchar const * data, bool single)
158 guchar* raw_data = g_base64_decode (data, &size);
159 int const r = _plugin->dispatcher (_plugin, 24 /* effSetChunk */, single ? 1 : 0, size, raw_data, 0);
165 VSTPlugin::add_state (XMLNode* root) const
167 LocaleGuard lg (X_("C"));
169 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
171 gchar* data = get_chunk (false);
176 /* store information */
178 XMLNode* chunk_node = new XMLNode (X_("chunk"));
180 chunk_node->add_content (data);
183 root->add_child_nocopy (*chunk_node);
187 XMLNode* parameters = new XMLNode ("parameters");
189 for (int32_t n = 0; n < _plugin->numParams; ++n) {
192 snprintf (index, sizeof (index), "param-%d", n);
193 snprintf (val, sizeof (val), "%.12g", _plugin->getParameter (_plugin, n));
194 parameters->add_property (index, val);
197 root->add_child_nocopy (*parameters);
202 VSTPlugin::set_state (const XMLNode& node, int version)
204 LocaleGuard lg (X_("C"));
207 if (node.name() != state_node_name()) {
208 error << _("Bad node sent to VSTPlugin::set_state") << endmsg;
212 #ifndef NO_PLUGIN_STATE
215 if ((child = find_named_node (node, X_("chunk"))) != 0) {
217 XMLPropertyList::const_iterator i;
218 XMLNodeList::const_iterator n;
220 for (n = child->children ().begin (); n != child->children ().end (); ++n) {
221 if ((*n)->is_content ()) {
222 /* XXX: this may be dubious for the same reasons that we delay
223 execution of load_preset.
225 ret = set_chunk ((*n)->content().c_str(), false);
229 } else if ((child = find_named_node (node, X_("parameters"))) != 0) {
231 XMLPropertyList::const_iterator i;
233 for (i = child->properties().begin(); i != child->properties().end(); ++i) {
237 sscanf ((*i)->name().c_str(), "param-%d", ¶m);
238 sscanf ((*i)->value().c_str(), "%f", &val);
240 _plugin->setParameter (_plugin, param, val);
248 Plugin::set_state (node, version);
254 VSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
256 VstParameterProperties prop;
258 memset (&prop, 0, sizeof (VstParameterProperties));
259 desc.min_unbound = false;
260 desc.max_unbound = false;
263 if (_plugin->dispatcher (_plugin, effGetParameterProperties, which, 0, &prop, 0)) {
265 /* i have yet to find or hear of a VST plugin that uses this */
266 /* RG: faust2vsti does use this :) */
268 if (prop.flags & kVstParameterUsesIntegerMinMax) {
269 desc.lower = prop.minInteger;
270 desc.upper = prop.maxInteger;
276 if (prop.flags & kVstParameterUsesIntStep) {
278 desc.step = prop.stepInteger;
279 desc.smallstep = prop.stepInteger;
280 desc.largestep = prop.stepInteger;
282 } else if (prop.flags & kVstParameterUsesFloatStep) {
284 desc.step = prop.stepFloat;
285 desc.smallstep = prop.smallStepFloat;
286 desc.largestep = prop.largeStepFloat;
290 float range = desc.upper - desc.lower;
292 desc.step = range / 100.0f;
293 desc.smallstep = desc.step / 2.0f;
294 desc.largestep = desc.step * 10.0f;
297 if (strlen(prop.label) == 0) {
298 _plugin->dispatcher (_plugin, effGetParamName, which, 0, prop.label, 0);
301 desc.toggled = prop.flags & kVstParameterIsSwitch;
302 desc.logarithmic = false;
303 desc.sr_dependent = false;
304 desc.label = prop.label;
311 /* some VST plugins expect this buffer to be zero-filled */
312 memset (label, 0, sizeof (label));
314 _plugin->dispatcher (_plugin, effGetParamName, which, 0, label, 0);
317 desc.integer_step = false;
321 desc.smallstep = 0.005f;
322 desc.largestep = 0.1f;
323 desc.toggled = false;
324 desc.logarithmic = false;
325 desc.sr_dependent = false;
332 VSTPlugin::load_preset (PresetRecord r)
337 s = load_user_preset (r);
339 s = load_plugin_preset (r);
343 Plugin::load_preset (r);
350 VSTPlugin::load_plugin_preset (PresetRecord r)
352 /* This is a plugin-provided preset.
353 We can't dispatch directly here; too many plugins expects only one GUI thread.
356 /* Extract the index of this preset from the URI */
360 int const p = sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
363 sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
365 _state->want_program = index;
370 VSTPlugin::load_user_preset (PresetRecord r)
372 /* This is a user preset; we load it, and this code also knows about the
373 non-direct-dispatch thing.
376 boost::shared_ptr<XMLTree> t (presets_tree ());
381 XMLNode* root = t->root ();
383 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
384 XMLProperty* label = (*i)->property (X_("label"));
388 if (label->value() != r.label) {
392 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
394 /* Load a user preset chunk from our XML file and send it via a circuitous route to the plugin */
396 if (_state->wanted_chunk) {
397 g_free (_state->wanted_chunk);
400 for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
401 if ((*j)->is_content ()) {
402 /* we can't dispatch directly here; too many plugins expect only one GUI thread */
404 guchar* raw_data = g_base64_decode ((*j)->content().c_str(), &size);
405 _state->wanted_chunk = raw_data;
406 _state->wanted_chunk_size = size;
407 _state->want_chunk = 1;
416 for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
417 if ((*j)->name() == X_("Parameter")) {
418 XMLProperty* index = (*j)->property (X_("index"));
419 XMLProperty* value = (*j)->property (X_("value"));
424 set_parameter (atoi (index->value().c_str()), atof (value->value().c_str ()));
434 VSTPlugin::do_save_preset (string name)
436 boost::shared_ptr<XMLTree> t (presets_tree ());
442 /* XXX: use of _presets.size() + 1 for the unique ID here is dubious at best */
443 string const uri = string_compose (X_("VST:%1:%2"), unique_id (), _presets.size() + 1);
445 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
447 p = new XMLNode (X_("ChunkPreset"));
448 p->add_property (X_("uri"), uri);
449 p->add_property (X_("label"), name);
450 gchar* data = get_chunk (true);
451 p->add_content (string (data));
456 p = new XMLNode (X_("Preset"));
457 p->add_property (X_("uri"), uri);
458 p->add_property (X_("label"), name);
460 for (uint32_t i = 0; i < parameter_count(); ++i) {
461 if (parameter_is_input (i)) {
462 XMLNode* c = new XMLNode (X_("Parameter"));
463 c->add_property (X_("index"), string_compose ("%1", i));
464 c->add_property (X_("value"), string_compose ("%1", get_parameter (i)));
465 p->add_child_nocopy (*c);
470 t->root()->add_child_nocopy (*p);
472 std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
473 f = Glib::build_filename (f, presets_file ());
480 VSTPlugin::do_remove_preset (string name)
482 boost::shared_ptr<XMLTree> t (presets_tree ());
487 t->root()->remove_nodes_and_delete (X_("label"), name);
489 std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
490 f = Glib::build_filename (f, presets_file ());
496 VSTPlugin::describe_parameter (Evoral::Parameter param)
499 memset (name, 0, sizeof (name));
501 /* some VST plugins expect this buffer to be zero-filled */
503 _plugin->dispatcher (_plugin, effGetParamName, param.id(), 0, name, 0);
505 if (name[0] == '\0') {
506 strcpy (name, _("Unknown"));
513 VSTPlugin::signal_latency () const
516 return _user_latency;
519 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) {
574 outs[i] = scratch_bufs.get_audio(i).data(offset);
577 if (bufs.count().n_midi() > 0) {
580 const uint32_t buf_index_in = in_map.get(DataType::MIDI, 0, &valid);
582 v = bufs.get_vst_midi (buf_index_in);
585 const uint32_t buf_index_out = out_map.get(DataType::MIDI, 0, &valid);
587 _midi_out_buf = &bufs.get_midi(buf_index_out);
588 _midi_out_buf->silence(0, 0);
593 _plugin->dispatcher (_plugin, effProcessEvents, 0, 0, v, 0);
597 /* we already know it can support processReplacing */
598 _plugin->processReplacing (_plugin, &ins[0], &outs[0], nframes);
602 for (i = 0; i < (int32_t) _plugin->numOutputs; ++i) {
605 index = out_map.get(DataType::AUDIO, out_index++, &valid);
609 copy_vector (bufs.get_audio(index).data(offset), outs[i], nframes);
615 VSTPlugin::unique_id () const
619 snprintf (buf, sizeof (buf), "%d", _plugin->uniqueID);
626 VSTPlugin::name () const
628 if (!_info->name.empty ()) {
629 return _info->name.c_str();
631 return _handle->name;
635 VSTPlugin::maker () const
637 return _info->creator.c_str();
641 VSTPlugin::label () const
643 return _handle->name;
647 VSTPlugin::parameter_count () const
649 return _plugin->numParams;
653 VSTPlugin::has_editor () const
655 return _plugin->flags & effFlagsHasEditor;
659 VSTPlugin::print_parameter (uint32_t param, char *buf, uint32_t /*len*/) const
663 _plugin->dispatcher (_plugin, 7 /* effGetParamDisplay */, param, 0, buf, 0);
665 if (buf[0] == '\0') {
670 while (*first_nonws && isspace (*first_nonws)) {
674 if (*first_nonws == '\0') {
678 memmove (buf, first_nonws, strlen (buf) - (first_nonws - buf) + 1);
682 VSTPlugin::find_presets ()
684 /* Built-in presets */
686 int const vst_version = _plugin->dispatcher (_plugin, effGetVstVersion, 0, 0, NULL, 0);
687 for (int i = 0; i < _plugin->numPrograms; ++i) {
688 PresetRecord r (string_compose (X_("VST:%1:%2"), unique_id (), i), "", -1, false);
690 if (vst_version >= 2) {
692 if (_plugin->dispatcher (_plugin, 29, i, 0, buf, 0) == 1) {
695 r.label = string_compose (_("Preset %1"), i);
698 r.label = string_compose (_("Preset %1"), i);
701 _presets.insert (make_pair (r.uri, r));
704 /* User presets from our XML file */
706 boost::shared_ptr<XMLTree> t (presets_tree ());
709 XMLNode* root = t->root ();
710 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
712 XMLProperty* uri = (*i)->property (X_("uri"));
713 XMLProperty* label = (*i)->property (X_("label"));
718 PresetRecord r (uri->value(), label->value(), -1, true);
719 _presets.insert (make_pair (r.uri, r));
725 /** @return XMLTree with our user presets; could be a new one if no existing
726 * one was found, or 0 if one was present but badly-formatted.
729 VSTPlugin::presets_tree () const
731 XMLTree* t = new XMLTree;
733 std::string p = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
735 if (!Glib::file_test (p, Glib::FILE_TEST_IS_DIR)) {
736 if (g_mkdir_with_parents (p.c_str(), 0755) != 0) {
737 error << _("Unable to make VST presets directory") << endmsg;
741 p = Glib::build_filename (p, presets_file ());
743 if (!Glib::file_test (p, Glib::FILE_TEST_EXISTS)) {
744 t->set_root (new XMLNode (X_("VSTPresets")));
757 /** @return Index of the first user preset in our lists */
759 VSTPlugin::first_user_preset_index () const
761 return _plugin->numPrograms;
765 VSTPlugin::presets_file () const
767 return string_compose ("vst-%1", unique_id ());