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)
49 , _transport_frame (0)
50 , _transport_speed (0.f)
52 memset (&_timeInfo, 0, sizeof(_timeInfo));
55 VSTPlugin::VSTPlugin (const VSTPlugin& other)
57 , _handle (other._handle)
58 , _state (other._state)
59 , _plugin (other._plugin)
62 , _midi_out_buf (other._midi_out_buf)
63 , _transport_frame (0)
64 , _transport_speed (0.f)
65 , _parameter_defaults (other._parameter_defaults)
67 memset (&_timeInfo, 0, sizeof(_timeInfo));
70 VSTPlugin::~VSTPlugin ()
76 VSTPlugin::set_plugin (AEffect* e)
81 /* set rate and blocksize */
83 _plugin->dispatcher (_plugin, effSetSampleRate, 0, 0, NULL, (float) _session.frame_rate());
84 _plugin->dispatcher (_plugin, effSetBlockSize, 0, _session.get_block_size(), NULL, 0.0f);
88 VSTPlugin::deactivate ()
90 _plugin->dispatcher (_plugin, effMainsChanged, 0, 0, NULL, 0.0f);
94 VSTPlugin::activate ()
96 _plugin->dispatcher (_plugin, effMainsChanged, 0, 1, NULL, 0.0f);
100 VSTPlugin::set_block_size (pframes_t nframes)
103 _plugin->dispatcher (_plugin, effSetBlockSize, 0, nframes, NULL, 0.0f);
109 VSTPlugin::default_value (uint32_t which)
111 return _parameter_defaults[which];
115 VSTPlugin::get_parameter (uint32_t which) const
117 return _plugin->getParameter (_plugin, which);
121 VSTPlugin::set_parameter (uint32_t which, float newval)
123 float oldval = get_parameter (which);
125 if (PBD::floateq (oldval, newval, 1)) {
129 _plugin->setParameter (_plugin, which, newval);
131 float curval = get_parameter (which);
133 if (!PBD::floateq (curval, oldval, 1)) {
134 /* value has changed, follow rest of the notification path */
135 Plugin::set_parameter (which, newval);
140 VSTPlugin::nth_parameter (uint32_t n, bool& ok) const
146 /** Get VST chunk as base64-encoded data.
147 * @param single true for single program, false for all programs.
148 * @return 0-terminated base64-encoded data; must be passed to g_free () by caller.
151 VSTPlugin::get_chunk (bool single) const
154 int32_t data_size = _plugin->dispatcher (_plugin, 23 /* effGetChunk */, single ? 1 : 0, 0, &data, 0);
155 if (data_size == 0) {
159 return g_base64_encode (data, data_size);
162 /** Set VST chunk from base64-encoded data.
163 * @param 0-terminated base64-encoded data.
164 * @param single true for single program, false for all programs.
165 * @return 0 on success, non-0 on failure
168 VSTPlugin::set_chunk (gchar const * data, bool single)
172 guchar* raw_data = g_base64_decode (data, &size);
174 Glib::Threads::Mutex::Lock lm (_lock);
175 r = _plugin->dispatcher (_plugin, 24 /* effSetChunk */, single ? 1 : 0, size, raw_data, 0);
182 VSTPlugin::add_state (XMLNode* root) const
186 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
188 gchar* data = get_chunk (false);
193 /* store information */
195 XMLNode* chunk_node = new XMLNode (X_("chunk"));
197 chunk_node->add_content (data);
200 root->add_child_nocopy (*chunk_node);
204 XMLNode* parameters = new XMLNode ("parameters");
206 for (int32_t n = 0; n < _plugin->numParams; ++n) {
209 snprintf (index, sizeof (index), "param-%d", n);
210 snprintf (val, sizeof (val), "%.12g", _plugin->getParameter (_plugin, n));
211 parameters->add_property (index, val);
214 root->add_child_nocopy (*parameters);
219 VSTPlugin::set_state (const XMLNode& node, int version)
224 if (node.name() != state_node_name()) {
225 error << _("Bad node sent to VSTPlugin::set_state") << endmsg;
229 #ifndef NO_PLUGIN_STATE
232 if ((child = find_named_node (node, X_("chunk"))) != 0) {
234 XMLPropertyList::const_iterator i;
235 XMLNodeList::const_iterator n;
237 for (n = child->children ().begin (); n != child->children ().end (); ++n) {
238 if ((*n)->is_content ()) {
239 /* XXX: this may be dubious for the same reasons that we delay
240 execution of load_preset.
242 ret = set_chunk ((*n)->content().c_str(), false);
246 } else if ((child = find_named_node (node, X_("parameters"))) != 0) {
248 XMLPropertyList::const_iterator i;
250 for (i = child->properties().begin(); i != child->properties().end(); ++i) {
254 sscanf ((*i)->name().c_str(), "param-%d", ¶m);
255 sscanf ((*i)->value().c_str(), "%f", &val);
257 _plugin->setParameter (_plugin, param, val);
265 Plugin::set_state (node, version);
271 VSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
273 VstParameterProperties prop;
275 memset (&prop, 0, sizeof (VstParameterProperties));
276 desc.min_unbound = false;
277 desc.max_unbound = false;
280 if (_plugin->dispatcher (_plugin, effGetParameterProperties, which, 0, &prop, 0)) {
282 /* i have yet to find or hear of a VST plugin that uses this */
283 /* RG: faust2vsti does use this :) */
285 if (prop.flags & kVstParameterUsesIntegerMinMax) {
286 desc.lower = prop.minInteger;
287 desc.upper = prop.maxInteger;
293 if (prop.flags & kVstParameterUsesIntStep) {
295 desc.step = prop.stepInteger;
296 desc.smallstep = prop.stepInteger;
297 desc.largestep = prop.stepInteger;
299 } else if (prop.flags & kVstParameterUsesFloatStep) {
301 desc.step = prop.stepFloat;
302 desc.smallstep = prop.smallStepFloat;
303 desc.largestep = prop.largeStepFloat;
307 float range = desc.upper - desc.lower;
309 desc.step = range / 100.0f;
310 desc.smallstep = desc.step / 2.0f;
311 desc.largestep = desc.step * 10.0f;
314 if (strlen(prop.label) == 0) {
315 _plugin->dispatcher (_plugin, effGetParamName, which, 0, prop.label, 0);
318 desc.toggled = prop.flags & kVstParameterIsSwitch;
319 desc.logarithmic = false;
320 desc.sr_dependent = false;
321 desc.label = Glib::locale_to_utf8 (prop.label);
328 /* some VST plugins expect this buffer to be zero-filled */
329 memset (label, 0, sizeof (label));
331 _plugin->dispatcher (_plugin, effGetParamName, which, 0, label, 0);
333 desc.label = Glib::locale_to_utf8 (label);
334 desc.integer_step = false;
338 desc.smallstep = 0.005f;
339 desc.largestep = 0.1f;
340 desc.toggled = false;
341 desc.logarithmic = false;
342 desc.sr_dependent = false;
345 desc.normal = get_parameter (which);
346 _parameter_defaults[which] = desc.normal;
352 VSTPlugin::load_preset (PresetRecord r)
357 s = load_user_preset (r);
359 s = load_plugin_preset (r);
363 Plugin::load_preset (r);
370 VSTPlugin::load_plugin_preset (PresetRecord r)
372 /* This is a plugin-provided preset.
373 We can't dispatch directly here; too many plugins expects only one GUI thread.
376 /* Extract the index of this preset from the URI */
380 int const p = sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
383 sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
385 _state->want_program = index;
390 VSTPlugin::load_user_preset (PresetRecord r)
392 /* This is a user preset; we load it, and this code also knows about the
393 non-direct-dispatch thing.
396 boost::shared_ptr<XMLTree> t (presets_tree ());
401 XMLNode* root = t->root ();
403 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
404 XMLProperty const * label = (*i)->property (X_("label"));
408 if (label->value() != r.label) {
412 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
414 /* Load a user preset chunk from our XML file and send it via a circuitous route to the plugin */
416 if (_state->wanted_chunk) {
417 g_free (_state->wanted_chunk);
420 for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
421 if ((*j)->is_content ()) {
422 /* we can't dispatch directly here; too many plugins expect only one GUI thread */
424 guchar* raw_data = g_base64_decode ((*j)->content().c_str(), &size);
425 _state->wanted_chunk = raw_data;
426 _state->wanted_chunk_size = size;
427 _state->want_chunk = 1;
436 for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
437 if ((*j)->name() == X_("Parameter")) {
438 XMLProperty const * index = (*j)->property (X_("index"));
439 XMLProperty const * value = (*j)->property (X_("value"));
444 set_parameter (atoi (index->value().c_str()), atof (value->value().c_str ()));
454 VSTPlugin::do_save_preset (string name)
456 boost::shared_ptr<XMLTree> t (presets_tree ());
462 /* XXX: use of _presets.size() + 1 for the unique ID here is dubious at best */
463 string const uri = string_compose (X_("VST:%1:%2"), unique_id (), _presets.size() + 1);
465 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
467 p = new XMLNode (X_("ChunkPreset"));
468 p->add_property (X_("uri"), uri);
469 p->add_property (X_("label"), name);
470 gchar* data = get_chunk (true);
471 p->add_content (string (data));
476 p = new XMLNode (X_("Preset"));
477 p->add_property (X_("uri"), uri);
478 p->add_property (X_("label"), name);
480 for (uint32_t i = 0; i < parameter_count(); ++i) {
481 if (parameter_is_input (i)) {
482 XMLNode* c = new XMLNode (X_("Parameter"));
483 c->add_property (X_("index"), string_compose ("%1", i));
484 c->add_property (X_("value"), string_compose ("%1", get_parameter (i)));
485 p->add_child_nocopy (*c);
490 t->root()->add_child_nocopy (*p);
492 std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
493 f = Glib::build_filename (f, presets_file ());
500 VSTPlugin::do_remove_preset (string name)
502 boost::shared_ptr<XMLTree> t (presets_tree ());
507 t->root()->remove_nodes_and_delete (X_("label"), name);
509 std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
510 f = Glib::build_filename (f, presets_file ());
516 VSTPlugin::describe_parameter (Evoral::Parameter param)
519 memset (name, 0, sizeof (name));
521 /* some VST plugins expect this buffer to be zero-filled */
523 _plugin->dispatcher (_plugin, effGetParamName, param.id(), 0, name, 0);
525 if (name[0] == '\0') {
526 strcpy (name, _("Unknown"));
533 VSTPlugin::signal_latency () const
536 return _user_latency;
539 #if ( defined(__x86_64__) || defined(_M_X64) )
540 return *((int32_t *) (((char *) &_plugin->flags) + 24)); /* initialDelay */
542 return *((int32_t *) (((char *) &_plugin->flags) + 12)); /* initialDelay */
546 set<Evoral::Parameter>
547 VSTPlugin::automatable () const
549 set<Evoral::Parameter> ret;
551 for (uint32_t i = 0; i < parameter_count(); ++i) {
552 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
559 VSTPlugin::connect_and_run (BufferSet& bufs,
560 framepos_t start, framepos_t end, double speed,
561 ChanMapping in_map, ChanMapping out_map,
562 pframes_t nframes, framecnt_t offset)
564 Plugin::connect_and_run(bufs, start, end, speed, in_map, out_map, nframes, offset);
566 Glib::Threads::Mutex::Lock lm (_state_lock, Glib::Threads::TRY_LOCK);
568 /* by convention 'effSetChunk' should not be called while processing
569 * http://www.reaper.fm/sdk/vst/vst_ext.php
571 * All VSTs don't use in-place, PluginInsert::connect_and_run()
572 * does clear output buffers, so we can just return.
577 _transport_frame = start;
578 _transport_speed = speed;
580 ChanCount bufs_count;
581 bufs_count.set(DataType::AUDIO, 1);
582 bufs_count.set(DataType::MIDI, 1);
585 BufferSet& silent_bufs = _session.get_silent_buffers(bufs_count);
586 BufferSet& scratch_bufs = _session.get_scratch_buffers(bufs_count);
588 /* VC++ doesn't support the C99 extension that allows
590 typeName foo[variableDefiningSize];
592 Use alloca instead of dynamic array (rather than std::vector which
593 allocs on the heap) because this is realtime code.
596 float** ins = (float**)alloca(_plugin->numInputs*sizeof(float*));
597 float** outs = (float**)alloca(_plugin->numOutputs*sizeof(float*));
601 uint32_t in_index = 0;
602 for (i = 0; i < (int32_t) _plugin->numInputs; ++i) {
605 index = in_map.get(DataType::AUDIO, in_index++, &valid);
607 ? bufs.get_audio(index).data(offset)
608 : silent_bufs.get_audio(0).data(offset);
611 uint32_t out_index = 0;
612 for (i = 0; i < (int32_t) _plugin->numOutputs; ++i) {
615 index = out_map.get(DataType::AUDIO, out_index++, &valid);
617 ? bufs.get_audio(index).data(offset)
618 : scratch_bufs.get_audio(0).data(offset);
621 if (bufs.count().n_midi() > 0) {
624 const uint32_t buf_index_in = in_map.get(DataType::MIDI, 0, &valid);
626 v = bufs.get_vst_midi (buf_index_in);
629 const uint32_t buf_index_out = out_map.get(DataType::MIDI, 0, &valid);
631 _midi_out_buf = &bufs.get_midi(buf_index_out);
632 _midi_out_buf->silence(0, 0);
637 _plugin->dispatcher (_plugin, effProcessEvents, 0, 0, v, 0);
641 /* we already know it can support processReplacing */
642 _plugin->processReplacing (_plugin, &ins[0], &outs[0], nframes);
649 VSTPlugin::unique_id () const
653 snprintf (buf, sizeof (buf), "%d", _plugin->uniqueID);
660 VSTPlugin::name () const
662 if (!_info->name.empty ()) {
663 return _info->name.c_str();
665 return _handle->name;
669 VSTPlugin::maker () const
671 return _info->creator.c_str();
675 VSTPlugin::label () const
677 return _handle->name;
681 VSTPlugin::parameter_count () const
683 return _plugin->numParams;
687 VSTPlugin::has_editor () const
689 return _plugin->flags & effFlagsHasEditor;
693 VSTPlugin::print_parameter (uint32_t param, char *buf, uint32_t /*len*/) const
697 _plugin->dispatcher (_plugin, 7 /* effGetParamDisplay */, param, 0, buf, 0);
699 if (buf[0] == '\0') {
704 while (*first_nonws && isspace (*first_nonws)) {
708 if (*first_nonws == '\0') {
712 memmove (buf, first_nonws, strlen (buf) - (first_nonws - buf) + 1);
716 VSTPlugin::find_presets ()
718 /* Built-in presets */
720 int const vst_version = _plugin->dispatcher (_plugin, effGetVstVersion, 0, 0, NULL, 0);
721 for (int i = 0; i < _plugin->numPrograms; ++i) {
722 PresetRecord r (string_compose (X_("VST:%1:%2"), unique_id (), i), "", false);
724 if (vst_version >= 2) {
726 if (_plugin->dispatcher (_plugin, 29, i, 0, buf, 0) == 1) {
729 r.label = string_compose (_("Preset %1"), i);
732 r.label = string_compose (_("Preset %1"), i);
735 _presets.insert (make_pair (r.uri, r));
738 /* User presets from our XML file */
740 boost::shared_ptr<XMLTree> t (presets_tree ());
743 XMLNode* root = t->root ();
744 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
746 XMLProperty const * uri = (*i)->property (X_("uri"));
747 XMLProperty const * label = (*i)->property (X_("label"));
752 PresetRecord r (uri->value(), label->value(), true);
753 _presets.insert (make_pair (r.uri, r));
759 /** @return XMLTree with our user presets; could be a new one if no existing
760 * one was found, or 0 if one was present but badly-formatted.
763 VSTPlugin::presets_tree () const
765 XMLTree* t = new XMLTree;
767 std::string p = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
769 if (!Glib::file_test (p, Glib::FILE_TEST_IS_DIR)) {
770 if (g_mkdir_with_parents (p.c_str(), 0755) != 0) {
771 error << _("Unable to make VST presets directory") << endmsg;
775 p = Glib::build_filename (p, presets_file ());
777 if (!Glib::file_test (p, Glib::FILE_TEST_EXISTS)) {
778 t->set_root (new XMLNode (X_("VSTPresets")));
791 /** @return Index of the first user preset in our lists */
793 VSTPlugin::first_user_preset_index () const
795 return _plugin->numPrograms;
799 VSTPlugin::presets_file () const
801 return string_compose ("vst-%1", unique_id ());