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_plugin.h"
31 #include "ardour/vestige/aeffectx.h"
32 #include "ardour/session.h"
33 #include "ardour/vst_types.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_frame (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_frame (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->user == 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.frame_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::default_value (uint32_t which)
145 return _parameter_defaults[which];
149 VSTPlugin::get_parameter (uint32_t which) const
151 if (which == UINT32_MAX - 1) {
152 // ardour uses enable-semantics: 1: enabled, 0: bypassed
153 return _eff_bypassed ? 0.f : 1.f;
155 return _plugin->getParameter (_plugin, which);
159 VSTPlugin::set_parameter (uint32_t which, float newval)
161 if (which == UINT32_MAX - 1) {
162 // ardour uses enable-semantics: 1: enabled, 0: bypassed
163 intptr_t value = (newval <= 0.f) ? 1 : 0;
164 cerr << "effSetBypass " << value << endl; // XXX DEBUG
165 int rv = _plugin->dispatcher (_plugin, 44 /*effSetBypass*/, 0, value, NULL, 0);
167 _eff_bypassed = (value == 1);
169 cerr << "effSetBypass failed rv=" << rv << endl; // XXX DEBUG
170 #ifdef ALLOW_VST_BYPASS_TO_FAIL // yet unused, see also vst_plugin.cc
171 // emit signal.. hard un/bypass from here?!
177 float oldval = get_parameter (which);
179 if (PBD::floateq (oldval, newval, 1)) {
183 _plugin->setParameter (_plugin, which, newval);
185 float curval = get_parameter (which);
187 if (!PBD::floateq (curval, oldval, 1)) {
188 /* value has changed, follow rest of the notification path */
189 Plugin::set_parameter (which, newval);
194 VSTPlugin::parameter_changed_externally (uint32_t which, float value )
196 ParameterChangedExternally (which, value); /* EMIT SIGNAL */
197 Plugin::set_parameter (which, value);
202 VSTPlugin::nth_parameter (uint32_t n, bool& ok) const
208 /** Get VST chunk as base64-encoded data.
209 * @param single true for single program, false for all programs.
210 * @return 0-terminated base64-encoded data; must be passed to g_free () by caller.
213 VSTPlugin::get_chunk (bool single) const
216 int32_t data_size = _plugin->dispatcher (_plugin, 23 /* effGetChunk */, single ? 1 : 0, 0, &data, 0);
217 if (data_size == 0) {
221 return g_base64_encode (data, data_size);
224 /** Set VST chunk from base64-encoded data.
225 * @param 0-terminated base64-encoded data.
226 * @param single true for single program, false for all programs.
227 * @return 0 on success, non-0 on failure
230 VSTPlugin::set_chunk (gchar const * data, bool single)
234 guchar* raw_data = g_base64_decode (data, &size);
236 pthread_mutex_lock (&_state->state_lock);
237 r = _plugin->dispatcher (_plugin, 24 /* effSetChunk */, single ? 1 : 0, size, raw_data, 0);
238 pthread_mutex_unlock (&_state->state_lock);
245 VSTPlugin::add_state (XMLNode* root) const
249 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
251 gchar* data = get_chunk (false);
256 /* store information */
258 XMLNode* chunk_node = new XMLNode (X_("chunk"));
260 chunk_node->add_content (data);
263 root->add_child_nocopy (*chunk_node);
267 XMLNode* parameters = new XMLNode ("parameters");
269 for (int32_t n = 0; n < _plugin->numParams; ++n) {
272 snprintf (index, sizeof (index), "param-%d", n);
273 snprintf (val, sizeof (val), "%.12g", _plugin->getParameter (_plugin, n));
274 parameters->add_property (index, val);
277 root->add_child_nocopy (*parameters);
282 VSTPlugin::set_state (const XMLNode& node, int version)
287 if (node.name() != state_node_name()) {
288 error << _("Bad node sent to VSTPlugin::set_state") << endmsg;
292 #ifndef NO_PLUGIN_STATE
295 if ((child = find_named_node (node, X_("chunk"))) != 0) {
297 XMLPropertyList::const_iterator i;
298 XMLNodeList::const_iterator n;
300 for (n = child->children ().begin (); n != child->children ().end (); ++n) {
301 if ((*n)->is_content ()) {
302 /* XXX: this may be dubious for the same reasons that we delay
303 execution of load_preset.
305 ret = set_chunk ((*n)->content().c_str(), false);
309 } else if ((child = find_named_node (node, X_("parameters"))) != 0) {
311 XMLPropertyList::const_iterator i;
313 for (i = child->properties().begin(); i != child->properties().end(); ++i) {
317 sscanf ((*i)->name().c_str(), "param-%d", ¶m);
318 sscanf ((*i)->value().c_str(), "%f", &val);
320 _plugin->setParameter (_plugin, param, val);
328 Plugin::set_state (node, version);
334 VSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
336 VstParameterProperties prop;
338 memset (&prop, 0, sizeof (VstParameterProperties));
339 desc.min_unbound = false;
340 desc.max_unbound = false;
343 if (_plugin->dispatcher (_plugin, effGetParameterProperties, which, 0, &prop, 0)) {
345 /* i have yet to find or hear of a VST plugin that uses this */
346 /* RG: faust2vsti does use this :) */
348 if (prop.flags & kVstParameterUsesIntegerMinMax) {
349 desc.lower = prop.minInteger;
350 desc.upper = prop.maxInteger;
356 if (prop.flags & kVstParameterUsesIntStep) {
358 desc.step = prop.stepInteger;
359 desc.smallstep = prop.stepInteger;
360 desc.largestep = prop.stepInteger;
362 } else if (prop.flags & kVstParameterUsesFloatStep) {
364 desc.step = prop.stepFloat;
365 desc.smallstep = prop.smallStepFloat;
366 desc.largestep = prop.largeStepFloat;
370 float range = desc.upper - desc.lower;
372 desc.step = range / 100.0f;
373 desc.smallstep = desc.step / 2.0f;
374 desc.largestep = desc.step * 10.0f;
377 if (strlen(prop.label) == 0) {
378 _plugin->dispatcher (_plugin, effGetParamName, which, 0, prop.label, 0);
381 desc.toggled = prop.flags & kVstParameterIsSwitch;
382 desc.logarithmic = false;
383 desc.sr_dependent = false;
384 desc.label = Glib::locale_to_utf8 (prop.label);
391 /* some VST plugins expect this buffer to be zero-filled */
392 memset (label, 0, sizeof (label));
394 _plugin->dispatcher (_plugin, effGetParamName, which, 0, label, 0);
396 desc.label = Glib::locale_to_utf8 (label);
397 desc.integer_step = false;
401 desc.smallstep = 0.005f;
402 desc.largestep = 0.1f;
403 desc.toggled = false;
404 desc.logarithmic = false;
405 desc.sr_dependent = false;
408 desc.normal = get_parameter (which);
409 if (_parameter_defaults.find (which) == _parameter_defaults.end ()) {
410 _parameter_defaults[which] = desc.normal;
417 VSTPlugin::load_preset (PresetRecord r)
422 s = load_user_preset (r);
424 s = load_plugin_preset (r);
428 Plugin::load_preset (r);
435 VSTPlugin::load_plugin_preset (PresetRecord r)
437 /* This is a plugin-provided preset.
438 We can't dispatch directly here; too many plugins expects only one GUI thread.
441 /* Extract the index of this preset from the URI */
445 int const p = sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
448 sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
450 _state->want_program = index;
451 LoadPresetProgram (); /* EMIT SIGNAL */ /* used for macvst */
456 VSTPlugin::load_user_preset (PresetRecord r)
458 /* This is a user preset; we load it, and this code also knows about the
459 non-direct-dispatch thing.
462 boost::shared_ptr<XMLTree> t (presets_tree ());
467 XMLNode* root = t->root ();
469 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
470 XMLProperty const * label = (*i)->property (X_("label"));
474 if (label->value() != r.label) {
478 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
480 /* Load a user preset chunk from our XML file and send it via a circuitous route to the plugin */
482 if (_state->wanted_chunk) {
483 g_free (_state->wanted_chunk);
486 for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
487 if ((*j)->is_content ()) {
488 /* we can't dispatch directly here; too many plugins expect only one GUI thread */
490 guchar* raw_data = g_base64_decode ((*j)->content().c_str(), &size);
491 _state->wanted_chunk = raw_data;
492 _state->wanted_chunk_size = size;
493 _state->want_chunk = 1;
494 LoadPresetProgram (); /* EMIT SIGNAL */ /* used for macvst */
503 for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
504 if ((*j)->name() == X_("Parameter")) {
505 XMLProperty const * index = (*j)->property (X_("index"));
506 XMLProperty const * value = (*j)->property (X_("value"));
510 const uint32_t p = atoi (index->value().c_str());
511 const float v = atof (value->value().c_str ());
512 set_parameter (p, v);
513 PresetPortSetValue (p, v); /* EMIT SIGNAL */
525 VSTPlugin::do_save_preset (string name)
527 boost::shared_ptr<XMLTree> t (presets_tree ());
532 // prevent dups -- just in case
533 t->root()->remove_nodes_and_delete (X_("label"), name);
538 snprintf (tmp, 31, "%ld", _presets.size() + 1);
544 sha1_write (&s, (const uint8_t *) name.c_str(), name.size ());
545 sha1_write (&s, (const uint8_t *) tmp, strlen(tmp));
546 sha1_result_hash (&s, hash);
548 string const uri = string_compose (X_("VST:%1:x%2"), unique_id (), hash);
550 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
552 p = new XMLNode (X_("ChunkPreset"));
553 p->add_property (X_("uri"), uri);
554 p->add_property (X_("label"), name);
555 gchar* data = get_chunk (true);
556 p->add_content (string (data));
561 p = new XMLNode (X_("Preset"));
562 p->add_property (X_("uri"), uri);
563 p->add_property (X_("label"), name);
565 for (uint32_t i = 0; i < parameter_count(); ++i) {
566 if (parameter_is_input (i)) {
567 XMLNode* c = new XMLNode (X_("Parameter"));
568 c->add_property (X_("index"), string_compose ("%1", i));
569 c->add_property (X_("value"), string_compose ("%1", get_parameter (i)));
570 p->add_child_nocopy (*c);
575 t->root()->add_child_nocopy (*p);
577 std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
578 f = Glib::build_filename (f, presets_file ());
585 VSTPlugin::do_remove_preset (string name)
587 boost::shared_ptr<XMLTree> t (presets_tree ());
592 t->root()->remove_nodes_and_delete (X_("label"), name);
594 std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
595 f = Glib::build_filename (f, presets_file ());
601 VSTPlugin::describe_parameter (Evoral::Parameter param)
604 if (param.id() == UINT32_MAX - 1) {
605 strcpy (name, _("Plugin Enable"));
609 memset (name, 0, sizeof (name));
611 /* some VST plugins expect this buffer to be zero-filled */
613 _plugin->dispatcher (_plugin, effGetParamName, param.id(), 0, name, 0);
615 if (name[0] == '\0') {
616 strcpy (name, _("Unknown"));
623 VSTPlugin::signal_latency () const
626 return _user_latency;
629 #if ( defined(__x86_64__) || defined(_M_X64) )
630 return *((int32_t *) (((char *) &_plugin->flags) + 24)); /* initialDelay */
632 return *((int32_t *) (((char *) &_plugin->flags) + 12)); /* initialDelay */
636 set<Evoral::Parameter>
637 VSTPlugin::automatable () const
639 set<Evoral::Parameter> ret;
641 for (uint32_t i = 0; i < parameter_count(); ++i) {
642 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
649 VSTPlugin::connect_and_run (BufferSet& bufs,
650 framepos_t start, framepos_t end, double speed,
651 ChanMapping in_map, ChanMapping out_map,
652 pframes_t nframes, framecnt_t offset)
654 Plugin::connect_and_run(bufs, start, end, speed, in_map, out_map, nframes, offset);
656 if (pthread_mutex_trylock (&_state->state_lock)) {
657 /* by convention 'effSetChunk' should not be called while processing
658 * http://www.reaper.fm/sdk/vst/vst_ext.php
660 * All VSTs don't use in-place, PluginInsert::connect_and_run()
661 * does clear output buffers, so we can just return.
666 _transport_frame = start;
667 _transport_speed = speed;
669 ChanCount bufs_count;
670 bufs_count.set(DataType::AUDIO, 1);
671 bufs_count.set(DataType::MIDI, 1);
674 BufferSet& silent_bufs = _session.get_silent_buffers(bufs_count);
675 BufferSet& scratch_bufs = _session.get_scratch_buffers(bufs_count);
677 /* VC++ doesn't support the C99 extension that allows
679 typeName foo[variableDefiningSize];
681 Use alloca instead of dynamic array (rather than std::vector which
682 allocs on the heap) because this is realtime code.
685 float** ins = (float**)alloca(_plugin->numInputs*sizeof(float*));
686 float** outs = (float**)alloca(_plugin->numOutputs*sizeof(float*));
690 uint32_t in_index = 0;
691 for (i = 0; i < (int32_t) _plugin->numInputs; ++i) {
694 index = in_map.get(DataType::AUDIO, in_index++, &valid);
696 ? bufs.get_audio(index).data(offset)
697 : silent_bufs.get_audio(0).data(offset);
700 uint32_t out_index = 0;
701 for (i = 0; i < (int32_t) _plugin->numOutputs; ++i) {
704 index = out_map.get(DataType::AUDIO, out_index++, &valid);
706 ? bufs.get_audio(index).data(offset)
707 : scratch_bufs.get_audio(0).data(offset);
710 if (bufs.count().n_midi() > 0) {
713 const uint32_t buf_index_in = in_map.get(DataType::MIDI, 0, &valid);
715 v = bufs.get_vst_midi (buf_index_in);
718 const uint32_t buf_index_out = out_map.get(DataType::MIDI, 0, &valid);
720 _midi_out_buf = &bufs.get_midi(buf_index_out);
721 _midi_out_buf->silence(0, 0);
726 _plugin->dispatcher (_plugin, effProcessEvents, 0, 0, v, 0);
730 /* we already know it can support processReplacing */
731 _plugin->processReplacing (_plugin, &ins[0], &outs[0], nframes);
734 pthread_mutex_unlock (&_state->state_lock);
739 VSTPlugin::unique_id () const
743 snprintf (buf, sizeof (buf), "%d", _plugin->uniqueID);
750 VSTPlugin::name () const
752 if (!_info->name.empty ()) {
753 return _info->name.c_str();
755 return _handle->name;
759 VSTPlugin::maker () const
761 return _info->creator.c_str();
765 VSTPlugin::label () const
767 return _handle->name;
771 VSTPlugin::parameter_count () const
773 return _plugin->numParams;
777 VSTPlugin::has_editor () const
779 return _plugin->flags & effFlagsHasEditor;
783 VSTPlugin::print_parameter (uint32_t param, char *buf, uint32_t /*len*/) const
787 _plugin->dispatcher (_plugin, 7 /* effGetParamDisplay */, param, 0, buf, 0);
789 if (buf[0] == '\0') {
794 while (*first_nonws && isspace (*first_nonws)) {
798 if (*first_nonws == '\0') {
802 memmove (buf, first_nonws, strlen (buf) - (first_nonws - buf) + 1);
806 VSTPlugin::find_presets ()
808 /* Built-in presets */
810 int const vst_version = _plugin->dispatcher (_plugin, effGetVstVersion, 0, 0, NULL, 0);
811 for (int i = 0; i < _plugin->numPrograms; ++i) {
812 PresetRecord r (string_compose (X_("VST:%1:%2"), unique_id (), i), "", false);
814 if (vst_version >= 2) {
816 if (_plugin->dispatcher (_plugin, 29, i, 0, buf, 0) == 1) {
819 r.label = string_compose (_("Preset %1"), i);
822 r.label = string_compose (_("Preset %1"), i);
825 _presets.insert (make_pair (r.uri, r));
828 /* User presets from our XML file */
830 boost::shared_ptr<XMLTree> t (presets_tree ());
833 XMLNode* root = t->root ();
834 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
836 XMLProperty const * uri = (*i)->property (X_("uri"));
837 XMLProperty const * label = (*i)->property (X_("label"));
842 PresetRecord r (uri->value(), label->value(), true);
843 _presets.insert (make_pair (r.uri, r));
849 /** @return XMLTree with our user presets; could be a new one if no existing
850 * one was found, or 0 if one was present but badly-formatted.
853 VSTPlugin::presets_tree () const
855 XMLTree* t = new XMLTree;
857 std::string p = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
859 if (!Glib::file_test (p, Glib::FILE_TEST_IS_DIR)) {
860 if (g_mkdir_with_parents (p.c_str(), 0755) != 0) {
861 error << _("Unable to make VST presets directory") << endmsg;
865 p = Glib::build_filename (p, presets_file ());
867 if (!Glib::file_test (p, Glib::FILE_TEST_EXISTS)) {
868 t->set_root (new XMLNode (X_("VSTPresets")));
881 /** @return Index of the first user preset in our lists */
883 VSTPlugin::first_user_preset_index () const
885 return _plugin->numPrograms;
889 VSTPlugin::presets_file () const
891 return string_compose ("vst-%1", unique_id ());