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>
25 #include <glibmm/convert.h>
27 #include "pbd/floating.h"
28 #include "pbd/locale_guard.h"
30 #include "ardour/vst_types.h"
31 #include "ardour/vst_plugin.h"
32 #include "ardour/vestige/vestige.h"
33 #include "ardour/session.h"
34 #include "ardour/filesystem_paths.h"
35 #include "ardour/audio_buffer.h"
41 using namespace ARDOUR;
43 VSTPlugin::VSTPlugin (AudioEngine& engine, Session& session, VSTHandle* handle)
44 : Plugin (engine, session)
50 , _transport_sample (0)
51 , _transport_speed (0.f)
52 , _eff_bypassed (false)
54 memset (&_timeInfo, 0, sizeof(_timeInfo));
57 VSTPlugin::VSTPlugin (const VSTPlugin& other)
59 , _handle (other._handle)
60 , _state (other._state)
61 , _plugin (other._plugin)
64 , _midi_out_buf (other._midi_out_buf)
65 , _transport_sample (0)
66 , _transport_speed (0.f)
67 , _parameter_defaults (other._parameter_defaults)
68 , _eff_bypassed (other._eff_bypassed)
70 memset (&_timeInfo, 0, sizeof(_timeInfo));
73 VSTPlugin::~VSTPlugin ()
79 VSTPlugin::open_plugin ()
81 _plugin = _state->plugin;
82 assert (_plugin->ptr1 == this); // should have been set by {mac_vst|fst|lxvst}_instantiate
84 _state->plugin->dispatcher (_plugin, effOpen, 0, 0, 0, 0);
85 _state->vst_version = _plugin->dispatcher (_plugin, effGetVstVersion, 0, 0, 0, 0);
89 VSTPlugin::init_plugin ()
91 /* set rate and blocksize */
92 _plugin->dispatcher (_plugin, effSetSampleRate, 0, 0, NULL, (float) _session.sample_rate());
93 _plugin->dispatcher (_plugin, effSetBlockSize, 0, _session.get_block_size(), NULL, 0.0f);
98 VSTPlugin::designated_bypass_port ()
100 if (_plugin->dispatcher (_plugin, effCanDo, 0, 0, const_cast<char*> ("bypass"), 0.0f) != 0) {
101 #ifdef ALLOW_VST_BYPASS_TO_FAIL // yet unused, see also plugin_insert.cc
102 return UINT32_MAX - 1; // emulate a port
104 /* check if plugin actually supports it,
105 * e.g. u-he Presswerk CanDo "bypass" but calling effSetBypass is a NO-OP.
106 * (presumably the plugin-author thinks hard-bypassing is a bad idea,
107 * particularly since the plugin itself provides a bypass-port)
109 intptr_t value = 0; // not bypassed
110 if (0 != _plugin->dispatcher (_plugin, 44 /*effSetBypass*/, 0, value, NULL, 0)) {
111 cerr << "Emulate VST Bypass Port for " << name() << endl; // XXX DEBUG
112 return UINT32_MAX - 1; // emulate a port
114 cerr << "Do *not* Emulate VST Bypass Port for " << name() << endl; // XXX DEBUG
122 VSTPlugin::deactivate ()
124 _plugin->dispatcher (_plugin, effMainsChanged, 0, 0, NULL, 0.0f);
128 VSTPlugin::activate ()
130 _plugin->dispatcher (_plugin, effMainsChanged, 0, 1, NULL, 0.0f);
134 VSTPlugin::set_block_size (pframes_t nframes)
137 _plugin->dispatcher (_plugin, effSetBlockSize, 0, nframes, NULL, 0.0f);
143 VSTPlugin::requires_fixed_sized_buffers () const
145 /* This controls if Ardour will split the plugin's run()
146 * on automation events in order to pass sample-accurate automation
147 * via standard control-ports.
149 * When returning true Ardour will *not* sub-divide the process-cycle.
150 * Automation events that happen between cycle-start and cycle-end will be
151 * ignored (ctrl values are interpolated to cycle-start).
153 * Note: This does not guarantee a fixed block-size.
154 * e.g The process cycle may be split when looping, also
155 * the period-size may change any time: see set_block_size()
157 if (get_info()->n_inputs.n_midi() > 0) {
158 /* we don't yet implement midi buffer offsets (for split cycles).
159 * Also session_vst callbacls uses _session.transport_sample() directly
160 * (for BBT) which is not offset for plugin cycle split.
168 VSTPlugin::default_value (uint32_t which)
170 return _parameter_defaults[which];
174 VSTPlugin::get_parameter (uint32_t which) const
176 if (which == UINT32_MAX - 1) {
177 // ardour uses enable-semantics: 1: enabled, 0: bypassed
178 return _eff_bypassed ? 0.f : 1.f;
180 return _plugin->getParameter (_plugin, which);
184 VSTPlugin::set_parameter (uint32_t which, float newval)
186 if (which == UINT32_MAX - 1) {
187 // ardour uses enable-semantics: 1: enabled, 0: bypassed
188 intptr_t value = (newval <= 0.f) ? 1 : 0;
189 cerr << "effSetBypass " << value << endl; // XXX DEBUG
190 int rv = _plugin->dispatcher (_plugin, 44 /*effSetBypass*/, 0, value, NULL, 0);
192 _eff_bypassed = (value == 1);
194 cerr << "effSetBypass failed rv=" << rv << endl; // XXX DEBUG
195 #ifdef ALLOW_VST_BYPASS_TO_FAIL // yet unused, see also vst_plugin.cc
196 // emit signal.. hard un/bypass from here?!
202 float oldval = get_parameter (which);
204 if (PBD::floateq (oldval, newval, 1)) {
208 _plugin->setParameter (_plugin, which, newval);
210 float curval = get_parameter (which);
212 if (!PBD::floateq (curval, oldval, 1)) {
213 /* value has changed, follow rest of the notification path */
214 Plugin::set_parameter (which, newval);
219 VSTPlugin::parameter_changed_externally (uint32_t which, float value )
221 ParameterChangedExternally (which, value); /* EMIT SIGNAL */
222 Plugin::set_parameter (which, value);
227 VSTPlugin::nth_parameter (uint32_t n, bool& ok) const
233 /** Get VST chunk as base64-encoded data.
234 * @param single true for single program, false for all programs.
235 * @return 0-terminated base64-encoded data; must be passed to g_free () by caller.
238 VSTPlugin::get_chunk (bool single) const
241 int32_t data_size = _plugin->dispatcher (_plugin, 23 /* effGetChunk */, single ? 1 : 0, 0, &data, 0);
242 if (data_size == 0) {
246 return g_base64_encode (data, data_size);
249 /** Set VST chunk from base64-encoded data.
250 * @param 0-terminated base64-encoded data.
251 * @param single true for single program, false for all programs.
252 * @return 0 on success, non-0 on failure
255 VSTPlugin::set_chunk (gchar const * data, bool single)
259 guchar* raw_data = g_base64_decode (data, &size);
261 pthread_mutex_lock (&_state->state_lock);
262 r = _plugin->dispatcher (_plugin, 24 /* effSetChunk */, single ? 1 : 0, size, raw_data, 0);
263 pthread_mutex_unlock (&_state->state_lock);
270 VSTPlugin::add_state (XMLNode* root) const
274 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
276 gchar* data = get_chunk (false);
281 /* store information */
283 XMLNode* chunk_node = new XMLNode (X_("chunk"));
285 chunk_node->add_content (data);
288 chunk_node->set_property ("program", (int) _plugin->dispatcher (_plugin, effGetProgram, 0, 0, NULL, 0));
290 root->add_child_nocopy (*chunk_node);
294 XMLNode* parameters = new XMLNode ("parameters");
296 for (int32_t n = 0; n < _plugin->numParams; ++n) {
298 snprintf (index, sizeof (index), "param-%d", n);
299 parameters->set_property (index, _plugin->getParameter (_plugin, n));
302 root->add_child_nocopy (*parameters);
307 VSTPlugin::set_state (const XMLNode& node, int version)
312 #ifndef NO_PLUGIN_STATE
315 if ((child = find_named_node (node, X_("chunk"))) != 0) {
318 if (child->get_property (X_("program"), pgm)) {
319 _plugin->dispatcher (_plugin, effSetProgram, 0, pgm, NULL, 0);
322 XMLPropertyList::const_iterator i;
323 XMLNodeList::const_iterator n;
325 for (n = child->children ().begin (); n != child->children ().end (); ++n) {
326 if ((*n)->is_content ()) {
327 /* XXX: this may be dubious for the same reasons that we delay
328 execution of load_preset.
330 ret = set_chunk ((*n)->content().c_str(), false);
334 } else if ((child = find_named_node (node, X_("parameters"))) != 0) {
336 XMLPropertyList::const_iterator i;
338 for (i = child->properties().begin(); i != child->properties().end(); ++i) {
341 sscanf ((*i)->name().c_str(), "param-%d", ¶m);
342 float value = string_to<float>((*i)->value());
344 _plugin->setParameter (_plugin, param, value);
352 Plugin::set_state (node, version);
357 VSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
359 VstParameterProperties prop;
361 memset (&prop, 0, sizeof (VstParameterProperties));
364 if (_plugin->dispatcher (_plugin, effGetParameterProperties, which, 0, &prop, 0)) {
366 /* i have yet to find or hear of a VST plugin that uses this */
367 /* RG: faust2vsti does use this :) */
369 if (prop.flags & kVstParameterUsesIntegerMinMax) {
370 desc.lower = prop.minInteger;
371 desc.upper = prop.maxInteger;
377 const float range = desc.upper - desc.lower;
379 if (prop.flags & kVstParameterUsesIntStep && prop.stepInteger < range) {
380 desc.step = prop.stepInteger;
381 desc.smallstep = prop.stepInteger;
382 desc.largestep = prop.stepInteger;
383 desc.integer_step = true;
384 desc.rangesteps = 1 + ceilf (range / desc.step);
385 } else if (prop.flags & kVstParameterUsesFloatStep && prop.stepFloat < range) {
386 desc.step = prop.stepFloat;
387 desc.smallstep = prop.smallStepFloat;
388 desc.largestep = prop.largeStepFloat;
389 desc.rangesteps = 1 + ceilf (range / desc.step);
391 desc.smallstep = desc.step = range / 300.0f;
392 desc.largestep = range / 30.0f;
395 if (strlen(prop.label) == 0) {
396 _plugin->dispatcher (_plugin, effGetParamName, which, 0, prop.label, 0);
399 desc.toggled = prop.flags & kVstParameterIsSwitch;
400 desc.label = Glib::locale_to_utf8 (prop.label);
406 char label[VestigeMaxLabelLen];
407 /* some VST plugins expect this buffer to be zero-filled */
408 memset (label, 0, sizeof (label));
410 _plugin->dispatcher (_plugin, effGetParamName, which, 0, label, 0);
412 desc.label = Glib::locale_to_utf8 (label);
415 desc.smallstep = desc.step = 1.f / 300.f;
416 desc.largestep = 1.f / 30.f;
419 /* TODO we should really call
420 * desc.update_steps ()
421 * instead of manually assigning steps. Yet, VST prop is (again)
422 * the odd one out compared to other plugin formats.
425 if (_parameter_defaults.find (which) == _parameter_defaults.end ()) {
426 _parameter_defaults[which] = get_parameter (which);
428 desc.normal = _parameter_defaults[which];
435 VSTPlugin::load_preset (PresetRecord r)
440 s = load_user_preset (r);
442 s = load_plugin_preset (r);
446 Plugin::load_preset (r);
453 VSTPlugin::load_plugin_preset (PresetRecord r)
455 /* This is a plugin-provided preset.
456 We can't dispatch directly here; too many plugins expects only one GUI thread.
459 /* Extract the index of this preset from the URI */
463 int const p = sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
466 sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
468 _state->want_program = index;
469 LoadPresetProgram (); /* EMIT SIGNAL */ /* used for macvst */
474 VSTPlugin::load_user_preset (PresetRecord r)
476 /* This is a user preset; we load it, and this code also knows about the
477 non-direct-dispatch thing.
480 boost::shared_ptr<XMLTree> t (presets_tree ());
485 XMLNode* root = t->root ();
487 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
489 (*i)->get_property (X_("label"), label);
491 if (label != r.label) {
495 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
497 /* Load a user preset chunk from our XML file and send it via a circuitous route to the plugin */
499 if (_state->wanted_chunk) {
500 g_free (_state->wanted_chunk);
503 for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
504 if ((*j)->is_content ()) {
505 /* we can't dispatch directly here; too many plugins expect only one GUI thread */
507 guchar* raw_data = g_base64_decode ((*j)->content().c_str(), &size);
508 _state->wanted_chunk = raw_data;
509 _state->wanted_chunk_size = size;
510 _state->want_chunk = 1;
511 LoadPresetProgram (); /* EMIT SIGNAL */ /* used for macvst */
520 for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
521 if ((*j)->name() == X_("Parameter")) {
525 if (!(*j)->get_property (X_("index"), index) ||
526 !(*j)->get_property (X_("value"), value)) {
527 // flag error and continue?
531 set_parameter (index, value);
532 PresetPortSetValue (index, value); /* EMIT SIGNAL */
544 VSTPlugin::do_save_preset (string name)
546 boost::shared_ptr<XMLTree> t (presets_tree ());
551 // prevent dups -- just in case
552 t->root()->remove_nodes_and_delete (X_("label"), name);
557 snprintf (tmp, 31, "%ld", _presets.size() + 1);
563 sha1_write (&s, (const uint8_t *) name.c_str(), name.size ());
564 sha1_write (&s, (const uint8_t *) tmp, strlen(tmp));
565 sha1_result_hash (&s, hash);
567 string const uri = string_compose (X_("VST:%1:x%2"), unique_id (), hash);
569 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
570 p = new XMLNode (X_("ChunkPreset"));
572 p = new XMLNode (X_("Preset"));
575 p->set_property (X_("uri"), uri);
576 p->set_property (X_("version"), version ());
577 p->set_property (X_("label"), name);
578 p->set_property (X_("numParams"), parameter_count ());
580 if (_plugin->flags & 32) {
582 gchar* data = get_chunk (true);
583 p->add_content (string (data));
588 for (uint32_t i = 0; i < parameter_count(); ++i) {
589 if (parameter_is_input (i)) {
590 XMLNode* c = new XMLNode (X_("Parameter"));
591 c->set_property (X_("index"), i);
592 c->set_property (X_("value"), get_parameter (i));
593 p->add_child_nocopy (*c);
598 t->root()->add_child_nocopy (*p);
600 std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
601 f = Glib::build_filename (f, presets_file ());
608 VSTPlugin::do_remove_preset (string name)
610 boost::shared_ptr<XMLTree> t (presets_tree ());
615 t->root()->remove_nodes_and_delete (X_("label"), name);
617 std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
618 f = Glib::build_filename (f, presets_file ());
624 VSTPlugin::describe_parameter (Evoral::Parameter param)
626 char name[VestigeMaxLabelLen];
627 if (param.id() == UINT32_MAX - 1) {
628 strcpy (name, _("Plugin Enable"));
632 memset (name, 0, sizeof (name));
634 /* some VST plugins expect this buffer to be zero-filled */
636 _plugin->dispatcher (_plugin, effGetParamName, param.id(), 0, name, 0);
638 if (name[0] == '\0') {
639 strcpy (name, _("Unknown"));
646 VSTPlugin::signal_latency () const
649 return _user_latency;
652 #if ( defined(__x86_64__) || defined(_M_X64) )
653 return *((int32_t *) (((char *) &_plugin->flags) + 24)); /* initialDelay */
655 return *((int32_t *) (((char *) &_plugin->flags) + 12)); /* initialDelay */
659 set<Evoral::Parameter>
660 VSTPlugin::automatable () const
662 set<Evoral::Parameter> ret;
664 for (uint32_t i = 0; i < parameter_count(); ++i) {
665 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
672 VSTPlugin::connect_and_run (BufferSet& bufs,
673 samplepos_t start, samplepos_t end, double speed,
674 ChanMapping const& in_map, ChanMapping const& out_map,
675 pframes_t nframes, samplecnt_t offset)
677 Plugin::connect_and_run(bufs, start, end, speed, in_map, out_map, nframes, offset);
679 if (pthread_mutex_trylock (&_state->state_lock)) {
680 /* by convention 'effSetChunk' should not be called while processing
681 * http://www.reaper.fm/sdk/vst/vst_ext.php
683 * All VSTs don't use in-place, PluginInsert::connect_and_run()
684 * does clear output buffers, so we can just return.
689 _transport_sample = start;
690 _transport_speed = speed;
692 ChanCount bufs_count;
693 bufs_count.set(DataType::AUDIO, 1);
694 bufs_count.set(DataType::MIDI, 1);
697 BufferSet& silent_bufs = _session.get_silent_buffers(bufs_count);
698 BufferSet& scratch_bufs = _session.get_scratch_buffers(bufs_count);
700 /* VC++ doesn't support the C99 extension that allows
702 typeName foo[variableDefiningSize];
704 Use alloca instead of dynamic array (rather than std::vector which
705 allocs on the heap) because this is realtime code.
708 float** ins = (float**)alloca(_plugin->numInputs*sizeof(float*));
709 float** outs = (float**)alloca(_plugin->numOutputs*sizeof(float*));
713 uint32_t in_index = 0;
714 for (i = 0; i < (int32_t) _plugin->numInputs; ++i) {
717 index = in_map.get(DataType::AUDIO, in_index++, &valid);
719 ? bufs.get_audio(index).data(offset)
720 : silent_bufs.get_audio(0).data(offset);
723 uint32_t out_index = 0;
724 for (i = 0; i < (int32_t) _plugin->numOutputs; ++i) {
727 index = out_map.get(DataType::AUDIO, out_index++, &valid);
729 ? bufs.get_audio(index).data(offset)
730 : scratch_bufs.get_audio(0).data(offset);
733 if (bufs.count().n_midi() > 0) {
736 const uint32_t buf_index_in = in_map.get(DataType::MIDI, 0, &valid);
737 /* TODO: apply offset to MIDI buffer and trim at nframes */
739 v = bufs.get_vst_midi (buf_index_in);
742 const uint32_t buf_index_out = out_map.get(DataType::MIDI, 0, &valid);
744 _midi_out_buf = &bufs.get_midi(buf_index_out);
745 /* TODO: apply offset to MIDI buffer and trim at nframes */
746 _midi_out_buf->silence(nframes, offset);
751 _plugin->dispatcher (_plugin, effProcessEvents, 0, 0, v, 0);
755 /* we already know it can support processReplacing */
756 _plugin->processReplacing (_plugin, &ins[0], &outs[0], nframes);
759 pthread_mutex_unlock (&_state->state_lock);
764 VSTPlugin::unique_id () const
768 snprintf (buf, sizeof (buf), "%d", _plugin->uniqueID);
775 VSTPlugin::name () const
777 if (!_info->name.empty ()) {
778 return _info->name.c_str();
780 return _handle->name;
784 VSTPlugin::maker () const
786 return _info->creator.c_str();
790 VSTPlugin::label () const
792 return _handle->name;
796 VSTPlugin::version () const
798 return _plugin->version;
802 VSTPlugin::parameter_count () const
804 return _plugin->numParams;
808 VSTPlugin::has_editor () const
810 return _plugin->flags & effFlagsHasEditor;
814 VSTPlugin::print_parameter (uint32_t param, char *buf, uint32_t /*len*/) const
818 _plugin->dispatcher (_plugin, 7 /* effGetParamDisplay */, param, 0, buf, 0);
820 if (buf[0] == '\0') {
825 while (*first_nonws && isspace (*first_nonws)) {
829 if (*first_nonws == '\0') {
833 memmove (buf, first_nonws, strlen (buf) - (first_nonws - buf) + 1);
837 VSTPlugin::find_presets ()
839 /* Built-in presets */
841 int const vst_version = _plugin->dispatcher (_plugin, effGetVstVersion, 0, 0, NULL, 0);
842 for (int i = 0; i < _plugin->numPrograms; ++i) {
844 PresetRecord r (string_compose (X_("VST:%1:%2"), unique_id (), std::setw(4), std::setfill('0'), i), "", false);
846 if (vst_version >= 2) {
848 if (_plugin->dispatcher (_plugin, 29, i, 0, buf, 0) == 1) {
851 r.label = string_compose (_("Preset %1"), i);
854 r.label = string_compose (_("Preset %1"), i);
857 _presets.insert (make_pair (r.uri, r));
860 /* User presets from our XML file */
862 boost::shared_ptr<XMLTree> t (presets_tree ());
865 XMLNode* root = t->root ();
866 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
870 if (!(*i)->get_property (X_("uri"), uri) || !(*i)->get_property (X_("label"), label)) {
874 PresetRecord r (uri, label, true);
875 _presets.insert (make_pair (r.uri, r));
881 /** @return XMLTree with our user presets; could be a new one if no existing
882 * one was found, or 0 if one was present but badly-formatted.
885 VSTPlugin::presets_tree () const
887 XMLTree* t = new XMLTree;
889 std::string p = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
891 if (!Glib::file_test (p, Glib::FILE_TEST_IS_DIR)) {
892 if (g_mkdir_with_parents (p.c_str(), 0755) != 0) {
893 error << _("Unable to make VST presets directory") << endmsg;
897 p = Glib::build_filename (p, presets_file ());
899 if (!Glib::file_test (p, Glib::FILE_TEST_EXISTS)) {
900 t->set_root (new XMLNode (X_("VSTPresets")));
913 /** @return Index of the first user preset in our lists */
915 VSTPlugin::first_user_preset_index () const
917 return _plugin->numPrograms;
921 VSTPlugin::presets_file () const
923 return string("vst-") + unique_id ();
927 VSTPluginInfo::VSTPluginInfo (VSTInfo* nfo)
931 snprintf (buf, sizeof (buf), "%d", nfo->UniqueID);
937 creator = nfo->creator;
938 n_inputs.set_audio (nfo->numInputs);
939 n_outputs.set_audio (nfo->numOutputs);
940 n_inputs.set_midi ((nfo->wantMidi & 1) ? 1 : 0);
941 n_outputs.set_midi ((nfo->wantMidi & 2) ? 1 : 0);
943 _is_instrument = nfo->isInstrument;
947 VSTPluginInfo::is_instrument () const
949 if (_is_instrument) {
952 return PluginInfo::is_instrument ();