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)
53 memset (&_timeInfo, 0, sizeof(_timeInfo));
56 VSTPlugin::VSTPlugin (const VSTPlugin& other)
58 , _handle (other._handle)
59 , _state (other._state)
60 , _plugin (other._plugin)
63 , _midi_out_buf (other._midi_out_buf)
64 , _transport_frame (0)
65 , _transport_speed (0.f)
66 , _parameter_defaults (other._parameter_defaults)
68 memset (&_timeInfo, 0, sizeof(_timeInfo));
71 VSTPlugin::~VSTPlugin ()
77 VSTPlugin::set_plugin (AEffect* e)
82 /* set rate and blocksize */
84 _plugin->dispatcher (_plugin, effSetSampleRate, 0, 0, NULL, (float) _session.frame_rate());
85 _plugin->dispatcher (_plugin, effSetBlockSize, 0, _session.get_block_size(), NULL, 0.0f);
89 VSTPlugin::deactivate ()
91 _plugin->dispatcher (_plugin, effMainsChanged, 0, 0, NULL, 0.0f);
95 VSTPlugin::activate ()
97 _plugin->dispatcher (_plugin, effMainsChanged, 0, 1, NULL, 0.0f);
101 VSTPlugin::set_block_size (pframes_t nframes)
104 _plugin->dispatcher (_plugin, effSetBlockSize, 0, nframes, NULL, 0.0f);
110 VSTPlugin::default_value (uint32_t which)
112 return _parameter_defaults[which];
116 VSTPlugin::get_parameter (uint32_t which) const
118 return _plugin->getParameter (_plugin, which);
122 VSTPlugin::set_parameter (uint32_t which, float newval)
124 float oldval = get_parameter (which);
126 if (PBD::floateq (oldval, newval, 1)) {
130 _plugin->setParameter (_plugin, which, newval);
132 float curval = get_parameter (which);
134 if (!PBD::floateq (curval, oldval, 1)) {
135 /* value has changed, follow rest of the notification path */
136 Plugin::set_parameter (which, newval);
141 VSTPlugin::nth_parameter (uint32_t n, bool& ok) const
147 /** Get VST chunk as base64-encoded data.
148 * @param single true for single program, false for all programs.
149 * @return 0-terminated base64-encoded data; must be passed to g_free () by caller.
152 VSTPlugin::get_chunk (bool single) const
155 int32_t data_size = _plugin->dispatcher (_plugin, 23 /* effGetChunk */, single ? 1 : 0, 0, &data, 0);
156 if (data_size == 0) {
160 return g_base64_encode (data, data_size);
163 /** Set VST chunk from base64-encoded data.
164 * @param 0-terminated base64-encoded data.
165 * @param single true for single program, false for all programs.
166 * @return 0 on success, non-0 on failure
169 VSTPlugin::set_chunk (gchar const * data, bool single)
173 guchar* raw_data = g_base64_decode (data, &size);
175 Glib::Threads::Mutex::Lock lm (_lock);
176 r = _plugin->dispatcher (_plugin, 24 /* effSetChunk */, single ? 1 : 0, size, raw_data, 0);
183 VSTPlugin::add_state (XMLNode* root) const
187 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
189 gchar* data = get_chunk (false);
194 /* store information */
196 XMLNode* chunk_node = new XMLNode (X_("chunk"));
198 chunk_node->add_content (data);
201 root->add_child_nocopy (*chunk_node);
205 XMLNode* parameters = new XMLNode ("parameters");
207 for (int32_t n = 0; n < _plugin->numParams; ++n) {
210 snprintf (index, sizeof (index), "param-%d", n);
211 snprintf (val, sizeof (val), "%.12g", _plugin->getParameter (_plugin, n));
212 parameters->add_property (index, val);
215 root->add_child_nocopy (*parameters);
220 VSTPlugin::set_state (const XMLNode& node, int version)
225 if (node.name() != state_node_name()) {
226 error << _("Bad node sent to VSTPlugin::set_state") << endmsg;
230 #ifndef NO_PLUGIN_STATE
233 if ((child = find_named_node (node, X_("chunk"))) != 0) {
235 XMLPropertyList::const_iterator i;
236 XMLNodeList::const_iterator n;
238 for (n = child->children ().begin (); n != child->children ().end (); ++n) {
239 if ((*n)->is_content ()) {
240 /* XXX: this may be dubious for the same reasons that we delay
241 execution of load_preset.
243 ret = set_chunk ((*n)->content().c_str(), false);
247 } else if ((child = find_named_node (node, X_("parameters"))) != 0) {
249 XMLPropertyList::const_iterator i;
251 for (i = child->properties().begin(); i != child->properties().end(); ++i) {
255 sscanf ((*i)->name().c_str(), "param-%d", ¶m);
256 sscanf ((*i)->value().c_str(), "%f", &val);
258 _plugin->setParameter (_plugin, param, val);
266 Plugin::set_state (node, version);
272 VSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
274 VstParameterProperties prop;
276 memset (&prop, 0, sizeof (VstParameterProperties));
277 desc.min_unbound = false;
278 desc.max_unbound = false;
281 if (_plugin->dispatcher (_plugin, effGetParameterProperties, which, 0, &prop, 0)) {
283 /* i have yet to find or hear of a VST plugin that uses this */
284 /* RG: faust2vsti does use this :) */
286 if (prop.flags & kVstParameterUsesIntegerMinMax) {
287 desc.lower = prop.minInteger;
288 desc.upper = prop.maxInteger;
294 if (prop.flags & kVstParameterUsesIntStep) {
296 desc.step = prop.stepInteger;
297 desc.smallstep = prop.stepInteger;
298 desc.largestep = prop.stepInteger;
300 } else if (prop.flags & kVstParameterUsesFloatStep) {
302 desc.step = prop.stepFloat;
303 desc.smallstep = prop.smallStepFloat;
304 desc.largestep = prop.largeStepFloat;
308 float range = desc.upper - desc.lower;
310 desc.step = range / 100.0f;
311 desc.smallstep = desc.step / 2.0f;
312 desc.largestep = desc.step * 10.0f;
315 if (strlen(prop.label) == 0) {
316 _plugin->dispatcher (_plugin, effGetParamName, which, 0, prop.label, 0);
319 desc.toggled = prop.flags & kVstParameterIsSwitch;
320 desc.logarithmic = false;
321 desc.sr_dependent = false;
322 desc.label = Glib::locale_to_utf8 (prop.label);
329 /* some VST plugins expect this buffer to be zero-filled */
330 memset (label, 0, sizeof (label));
332 _plugin->dispatcher (_plugin, effGetParamName, which, 0, label, 0);
334 desc.label = Glib::locale_to_utf8 (label);
335 desc.integer_step = false;
339 desc.smallstep = 0.005f;
340 desc.largestep = 0.1f;
341 desc.toggled = false;
342 desc.logarithmic = false;
343 desc.sr_dependent = false;
346 desc.normal = get_parameter (which);
347 if (_parameter_defaults.find (which) == _parameter_defaults.end ()) {
348 _parameter_defaults[which] = desc.normal;
355 VSTPlugin::load_preset (PresetRecord r)
360 s = load_user_preset (r);
362 s = load_plugin_preset (r);
366 Plugin::load_preset (r);
373 VSTPlugin::load_plugin_preset (PresetRecord r)
375 /* This is a plugin-provided preset.
376 We can't dispatch directly here; too many plugins expects only one GUI thread.
379 /* Extract the index of this preset from the URI */
383 int const p = sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
386 sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
388 _state->want_program = index;
393 VSTPlugin::load_user_preset (PresetRecord r)
395 /* This is a user preset; we load it, and this code also knows about the
396 non-direct-dispatch thing.
399 boost::shared_ptr<XMLTree> t (presets_tree ());
404 XMLNode* root = t->root ();
406 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
407 XMLProperty const * label = (*i)->property (X_("label"));
411 if (label->value() != r.label) {
415 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
417 /* Load a user preset chunk from our XML file and send it via a circuitous route to the plugin */
419 if (_state->wanted_chunk) {
420 g_free (_state->wanted_chunk);
423 for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
424 if ((*j)->is_content ()) {
425 /* we can't dispatch directly here; too many plugins expect only one GUI thread */
427 guchar* raw_data = g_base64_decode ((*j)->content().c_str(), &size);
428 _state->wanted_chunk = raw_data;
429 _state->wanted_chunk_size = size;
430 _state->want_chunk = 1;
439 for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
440 if ((*j)->name() == X_("Parameter")) {
441 XMLProperty const * index = (*j)->property (X_("index"));
442 XMLProperty const * value = (*j)->property (X_("value"));
447 set_parameter (atoi (index->value().c_str()), atof (value->value().c_str ()));
457 VSTPlugin::do_save_preset (string name)
459 boost::shared_ptr<XMLTree> t (presets_tree ());
465 /* XXX: use of _presets.size() + 1 for the unique ID here is dubious at best */
466 string const uri = string_compose (X_("VST:%1:%2"), unique_id (), _presets.size() + 1);
468 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
470 p = new XMLNode (X_("ChunkPreset"));
471 p->add_property (X_("uri"), uri);
472 p->add_property (X_("label"), name);
473 gchar* data = get_chunk (true);
474 p->add_content (string (data));
479 p = new XMLNode (X_("Preset"));
480 p->add_property (X_("uri"), uri);
481 p->add_property (X_("label"), name);
483 for (uint32_t i = 0; i < parameter_count(); ++i) {
484 if (parameter_is_input (i)) {
485 XMLNode* c = new XMLNode (X_("Parameter"));
486 c->add_property (X_("index"), string_compose ("%1", i));
487 c->add_property (X_("value"), string_compose ("%1", get_parameter (i)));
488 p->add_child_nocopy (*c);
493 t->root()->add_child_nocopy (*p);
495 std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
496 f = Glib::build_filename (f, presets_file ());
503 VSTPlugin::do_remove_preset (string name)
505 boost::shared_ptr<XMLTree> t (presets_tree ());
510 t->root()->remove_nodes_and_delete (X_("label"), name);
512 std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
513 f = Glib::build_filename (f, presets_file ());
519 VSTPlugin::describe_parameter (Evoral::Parameter param)
522 memset (name, 0, sizeof (name));
524 /* some VST plugins expect this buffer to be zero-filled */
526 _plugin->dispatcher (_plugin, effGetParamName, param.id(), 0, name, 0);
528 if (name[0] == '\0') {
529 strcpy (name, _("Unknown"));
536 VSTPlugin::signal_latency () const
539 return _user_latency;
542 #if ( defined(__x86_64__) || defined(_M_X64) )
543 return *((int32_t *) (((char *) &_plugin->flags) + 24)); /* initialDelay */
545 return *((int32_t *) (((char *) &_plugin->flags) + 12)); /* initialDelay */
549 set<Evoral::Parameter>
550 VSTPlugin::automatable () const
552 set<Evoral::Parameter> ret;
554 for (uint32_t i = 0; i < parameter_count(); ++i) {
555 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
562 VSTPlugin::connect_and_run (BufferSet& bufs,
563 framepos_t start, framepos_t end, double speed,
564 ChanMapping in_map, ChanMapping out_map,
565 pframes_t nframes, framecnt_t offset)
567 Plugin::connect_and_run(bufs, start, end, speed, in_map, out_map, nframes, offset);
569 Glib::Threads::Mutex::Lock lm (_state_lock, Glib::Threads::TRY_LOCK);
571 /* by convention 'effSetChunk' should not be called while processing
572 * http://www.reaper.fm/sdk/vst/vst_ext.php
574 * All VSTs don't use in-place, PluginInsert::connect_and_run()
575 * does clear output buffers, so we can just return.
580 _transport_frame = start;
581 _transport_speed = speed;
583 ChanCount bufs_count;
584 bufs_count.set(DataType::AUDIO, 1);
585 bufs_count.set(DataType::MIDI, 1);
588 BufferSet& silent_bufs = _session.get_silent_buffers(bufs_count);
589 BufferSet& scratch_bufs = _session.get_scratch_buffers(bufs_count);
591 /* VC++ doesn't support the C99 extension that allows
593 typeName foo[variableDefiningSize];
595 Use alloca instead of dynamic array (rather than std::vector which
596 allocs on the heap) because this is realtime code.
599 float** ins = (float**)alloca(_plugin->numInputs*sizeof(float*));
600 float** outs = (float**)alloca(_plugin->numOutputs*sizeof(float*));
604 uint32_t in_index = 0;
605 for (i = 0; i < (int32_t) _plugin->numInputs; ++i) {
608 index = in_map.get(DataType::AUDIO, in_index++, &valid);
610 ? bufs.get_audio(index).data(offset)
611 : silent_bufs.get_audio(0).data(offset);
614 uint32_t out_index = 0;
615 for (i = 0; i < (int32_t) _plugin->numOutputs; ++i) {
618 index = out_map.get(DataType::AUDIO, out_index++, &valid);
620 ? bufs.get_audio(index).data(offset)
621 : scratch_bufs.get_audio(0).data(offset);
624 if (bufs.count().n_midi() > 0) {
627 const uint32_t buf_index_in = in_map.get(DataType::MIDI, 0, &valid);
629 v = bufs.get_vst_midi (buf_index_in);
632 const uint32_t buf_index_out = out_map.get(DataType::MIDI, 0, &valid);
634 _midi_out_buf = &bufs.get_midi(buf_index_out);
635 _midi_out_buf->silence(0, 0);
640 _plugin->dispatcher (_plugin, effProcessEvents, 0, 0, v, 0);
644 /* we already know it can support processReplacing */
645 _plugin->processReplacing (_plugin, &ins[0], &outs[0], nframes);
652 VSTPlugin::unique_id () const
656 snprintf (buf, sizeof (buf), "%d", _plugin->uniqueID);
663 VSTPlugin::name () const
665 if (!_info->name.empty ()) {
666 return _info->name.c_str();
668 return _handle->name;
672 VSTPlugin::maker () const
674 return _info->creator.c_str();
678 VSTPlugin::label () const
680 return _handle->name;
684 VSTPlugin::parameter_count () const
686 return _plugin->numParams;
690 VSTPlugin::has_editor () const
692 return _plugin->flags & effFlagsHasEditor;
696 VSTPlugin::print_parameter (uint32_t param, char *buf, uint32_t /*len*/) const
700 _plugin->dispatcher (_plugin, 7 /* effGetParamDisplay */, param, 0, buf, 0);
702 if (buf[0] == '\0') {
707 while (*first_nonws && isspace (*first_nonws)) {
711 if (*first_nonws == '\0') {
715 memmove (buf, first_nonws, strlen (buf) - (first_nonws - buf) + 1);
719 VSTPlugin::find_presets ()
721 /* Built-in presets */
723 int const vst_version = _plugin->dispatcher (_plugin, effGetVstVersion, 0, 0, NULL, 0);
724 for (int i = 0; i < _plugin->numPrograms; ++i) {
725 PresetRecord r (string_compose (X_("VST:%1:%2"), unique_id (), i), "", false);
727 if (vst_version >= 2) {
729 if (_plugin->dispatcher (_plugin, 29, i, 0, buf, 0) == 1) {
732 r.label = string_compose (_("Preset %1"), i);
735 r.label = string_compose (_("Preset %1"), i);
738 _presets.insert (make_pair (r.uri, r));
741 /* User presets from our XML file */
743 boost::shared_ptr<XMLTree> t (presets_tree ());
746 XMLNode* root = t->root ();
747 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
749 XMLProperty const * uri = (*i)->property (X_("uri"));
750 XMLProperty const * label = (*i)->property (X_("label"));
755 PresetRecord r (uri->value(), label->value(), true);
756 _presets.insert (make_pair (r.uri, r));
762 /** @return XMLTree with our user presets; could be a new one if no existing
763 * one was found, or 0 if one was present but badly-formatted.
766 VSTPlugin::presets_tree () const
768 XMLTree* t = new XMLTree;
770 std::string p = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
772 if (!Glib::file_test (p, Glib::FILE_TEST_IS_DIR)) {
773 if (g_mkdir_with_parents (p.c_str(), 0755) != 0) {
774 error << _("Unable to make VST presets directory") << endmsg;
778 p = Glib::build_filename (p, presets_file ());
780 if (!Glib::file_test (p, Glib::FILE_TEST_EXISTS)) {
781 t->set_root (new XMLNode (X_("VSTPresets")));
794 /** @return Index of the first user preset in our lists */
796 VSTPlugin::first_user_preset_index () const
798 return _plugin->numPrograms;
802 VSTPlugin::presets_file () const
804 return string_compose ("vst-%1", unique_id ());