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 ()
61 VSTPlugin::set_plugin (AEffect* e)
66 /* set rate and blocksize */
68 _plugin->dispatcher (_plugin, effSetSampleRate, 0, 0, NULL, (float) _session.frame_rate());
69 _plugin->dispatcher (_plugin, effSetBlockSize, 0, _session.get_block_size(), NULL, 0.0f);
73 VSTPlugin::deactivate ()
75 _plugin->dispatcher (_plugin, effMainsChanged, 0, 0, NULL, 0.0f);
79 VSTPlugin::activate ()
81 _plugin->dispatcher (_plugin, effMainsChanged, 0, 1, NULL, 0.0f);
85 VSTPlugin::set_block_size (pframes_t nframes)
88 _plugin->dispatcher (_plugin, effSetBlockSize, 0, nframes, NULL, 0.0f);
94 VSTPlugin::default_value (uint32_t)
100 VSTPlugin::get_parameter (uint32_t which) const
102 return _plugin->getParameter (_plugin, which);
106 VSTPlugin::set_parameter (uint32_t which, float newval)
108 float oldval = get_parameter (which);
110 if (PBD::floateq (oldval, newval, 1)) {
114 _plugin->setParameter (_plugin, which, newval);
116 float curval = get_parameter (which);
118 if (!PBD::floateq (curval, oldval, 1)) {
119 /* value has changed, follow rest of the notification path */
120 Plugin::set_parameter (which, newval);
125 VSTPlugin::nth_parameter (uint32_t n, bool& ok) const
131 /** Get VST chunk as base64-encoded data.
132 * @param single true for single program, false for all programs.
133 * @return 0-terminated base64-encoded data; must be passed to g_free () by caller.
136 VSTPlugin::get_chunk (bool single) const
139 int32_t data_size = _plugin->dispatcher (_plugin, 23 /* effGetChunk */, single ? 1 : 0, 0, &data, 0);
140 if (data_size == 0) {
144 return g_base64_encode (data, data_size);
147 /** Set VST chunk from base64-encoded data.
148 * @param 0-terminated base64-encoded data.
149 * @param single true for single program, false for all programs.
150 * @return 0 on success, non-0 on failure
153 VSTPlugin::set_chunk (gchar const * data, bool single)
156 guchar* raw_data = g_base64_decode (data, &size);
157 int const r = _plugin->dispatcher (_plugin, 24 /* effSetChunk */, single ? 1 : 0, size, raw_data, 0);
163 VSTPlugin::add_state (XMLNode* root) const
167 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
169 gchar* data = get_chunk (false);
174 /* store information */
176 XMLNode* chunk_node = new XMLNode (X_("chunk"));
178 chunk_node->add_content (data);
181 root->add_child_nocopy (*chunk_node);
185 XMLNode* parameters = new XMLNode ("parameters");
187 for (int32_t n = 0; n < _plugin->numParams; ++n) {
190 snprintf (index, sizeof (index), "param-%d", n);
191 snprintf (val, sizeof (val), "%.12g", _plugin->getParameter (_plugin, n));
192 parameters->add_property (index, val);
195 root->add_child_nocopy (*parameters);
200 VSTPlugin::set_state (const XMLNode& node, int version)
205 if (node.name() != state_node_name()) {
206 error << _("Bad node sent to VSTPlugin::set_state") << endmsg;
210 #ifndef NO_PLUGIN_STATE
213 if ((child = find_named_node (node, X_("chunk"))) != 0) {
215 XMLPropertyList::const_iterator i;
216 XMLNodeList::const_iterator n;
218 for (n = child->children ().begin (); n != child->children ().end (); ++n) {
219 if ((*n)->is_content ()) {
220 /* XXX: this may be dubious for the same reasons that we delay
221 execution of load_preset.
223 ret = set_chunk ((*n)->content().c_str(), false);
227 } else if ((child = find_named_node (node, X_("parameters"))) != 0) {
229 XMLPropertyList::const_iterator i;
231 for (i = child->properties().begin(); i != child->properties().end(); ++i) {
235 sscanf ((*i)->name().c_str(), "param-%d", ¶m);
236 sscanf ((*i)->value().c_str(), "%f", &val);
238 _plugin->setParameter (_plugin, param, val);
246 Plugin::set_state (node, version);
252 VSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
254 VstParameterProperties prop;
256 memset (&prop, 0, sizeof (VstParameterProperties));
257 desc.min_unbound = false;
258 desc.max_unbound = false;
261 if (_plugin->dispatcher (_plugin, effGetParameterProperties, which, 0, &prop, 0)) {
263 /* i have yet to find or hear of a VST plugin that uses this */
264 /* RG: faust2vsti does use this :) */
266 if (prop.flags & kVstParameterUsesIntegerMinMax) {
267 desc.lower = prop.minInteger;
268 desc.upper = prop.maxInteger;
274 if (prop.flags & kVstParameterUsesIntStep) {
276 desc.step = prop.stepInteger;
277 desc.smallstep = prop.stepInteger;
278 desc.largestep = prop.stepInteger;
280 } else if (prop.flags & kVstParameterUsesFloatStep) {
282 desc.step = prop.stepFloat;
283 desc.smallstep = prop.smallStepFloat;
284 desc.largestep = prop.largeStepFloat;
288 float range = desc.upper - desc.lower;
290 desc.step = range / 100.0f;
291 desc.smallstep = desc.step / 2.0f;
292 desc.largestep = desc.step * 10.0f;
295 if (strlen(prop.label) == 0) {
296 _plugin->dispatcher (_plugin, effGetParamName, which, 0, prop.label, 0);
299 desc.toggled = prop.flags & kVstParameterIsSwitch;
300 desc.logarithmic = false;
301 desc.sr_dependent = false;
302 desc.label = prop.label;
309 /* some VST plugins expect this buffer to be zero-filled */
310 memset (label, 0, sizeof (label));
312 _plugin->dispatcher (_plugin, effGetParamName, which, 0, label, 0);
315 desc.integer_step = false;
319 desc.smallstep = 0.005f;
320 desc.largestep = 0.1f;
321 desc.toggled = false;
322 desc.logarithmic = false;
323 desc.sr_dependent = false;
330 VSTPlugin::load_preset (PresetRecord r)
335 s = load_user_preset (r);
337 s = load_plugin_preset (r);
341 Plugin::load_preset (r);
348 VSTPlugin::load_plugin_preset (PresetRecord r)
350 /* This is a plugin-provided preset.
351 We can't dispatch directly here; too many plugins expects only one GUI thread.
354 /* Extract the index of this preset from the URI */
358 int const p = sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
361 sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
363 _state->want_program = index;
368 VSTPlugin::load_user_preset (PresetRecord r)
370 /* This is a user preset; we load it, and this code also knows about the
371 non-direct-dispatch thing.
374 boost::shared_ptr<XMLTree> t (presets_tree ());
379 XMLNode* root = t->root ();
381 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
382 XMLProperty const * label = (*i)->property (X_("label"));
386 if (label->value() != r.label) {
390 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
392 /* Load a user preset chunk from our XML file and send it via a circuitous route to the plugin */
394 if (_state->wanted_chunk) {
395 g_free (_state->wanted_chunk);
398 for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
399 if ((*j)->is_content ()) {
400 /* we can't dispatch directly here; too many plugins expect only one GUI thread */
402 guchar* raw_data = g_base64_decode ((*j)->content().c_str(), &size);
403 _state->wanted_chunk = raw_data;
404 _state->wanted_chunk_size = size;
405 _state->want_chunk = 1;
414 for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
415 if ((*j)->name() == X_("Parameter")) {
416 XMLProperty const * index = (*j)->property (X_("index"));
417 XMLProperty const * value = (*j)->property (X_("value"));
422 set_parameter (atoi (index->value().c_str()), atof (value->value().c_str ()));
432 VSTPlugin::do_save_preset (string name)
434 boost::shared_ptr<XMLTree> t (presets_tree ());
440 /* XXX: use of _presets.size() + 1 for the unique ID here is dubious at best */
441 string const uri = string_compose (X_("VST:%1:%2"), unique_id (), _presets.size() + 1);
443 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
445 p = new XMLNode (X_("ChunkPreset"));
446 p->add_property (X_("uri"), uri);
447 p->add_property (X_("label"), name);
448 gchar* data = get_chunk (true);
449 p->add_content (string (data));
454 p = new XMLNode (X_("Preset"));
455 p->add_property (X_("uri"), uri);
456 p->add_property (X_("label"), name);
458 for (uint32_t i = 0; i < parameter_count(); ++i) {
459 if (parameter_is_input (i)) {
460 XMLNode* c = new XMLNode (X_("Parameter"));
461 c->add_property (X_("index"), string_compose ("%1", i));
462 c->add_property (X_("value"), string_compose ("%1", get_parameter (i)));
463 p->add_child_nocopy (*c);
468 t->root()->add_child_nocopy (*p);
470 std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
471 f = Glib::build_filename (f, presets_file ());
478 VSTPlugin::do_remove_preset (string name)
480 boost::shared_ptr<XMLTree> t (presets_tree ());
485 t->root()->remove_nodes_and_delete (X_("label"), name);
487 std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
488 f = Glib::build_filename (f, presets_file ());
494 VSTPlugin::describe_parameter (Evoral::Parameter param)
497 memset (name, 0, sizeof (name));
499 /* some VST plugins expect this buffer to be zero-filled */
501 _plugin->dispatcher (_plugin, effGetParamName, param.id(), 0, name, 0);
503 if (name[0] == '\0') {
504 strcpy (name, _("Unknown"));
511 VSTPlugin::signal_latency () const
514 return _user_latency;
517 #if ( defined(__x86_64__) || defined(_M_X64) )
518 return *((int32_t *) (((char *) &_plugin->flags) + 24)); /* initialDelay */
520 return *((int32_t *) (((char *) &_plugin->flags) + 12)); /* initialDelay */
524 set<Evoral::Parameter>
525 VSTPlugin::automatable () const
527 set<Evoral::Parameter> ret;
529 for (uint32_t i = 0; i < parameter_count(); ++i) {
530 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
537 VSTPlugin::connect_and_run (BufferSet& bufs,
538 framepos_t start, framepos_t end, double speed,
539 ChanMapping in_map, ChanMapping out_map,
540 pframes_t nframes, framecnt_t offset)
542 Plugin::connect_and_run(bufs, start, end, speed, in_map, out_map, nframes, offset);
544 _transport_frame = start;
545 _transport_speed = speed;
547 ChanCount bufs_count;
548 bufs_count.set(DataType::AUDIO, 1);
549 bufs_count.set(DataType::MIDI, 1);
552 BufferSet& silent_bufs = _session.get_silent_buffers(bufs_count);
553 BufferSet& scratch_bufs = _session.get_scratch_buffers(bufs_count);
555 /* VC++ doesn't support the C99 extension that allows
557 typeName foo[variableDefiningSize];
559 Use alloca instead of dynamic array (rather than std::vector which
560 allocs on the heap) because this is realtime code.
563 float** ins = (float**)alloca(_plugin->numInputs*sizeof(float*));
564 float** outs = (float**)alloca(_plugin->numOutputs*sizeof(float*));
568 uint32_t in_index = 0;
569 for (i = 0; i < (int32_t) _plugin->numInputs; ++i) {
572 index = in_map.get(DataType::AUDIO, in_index++, &valid);
574 ? bufs.get_audio(index).data(offset)
575 : silent_bufs.get_audio(0).data(offset);
578 uint32_t out_index = 0;
579 for (i = 0; i < (int32_t) _plugin->numOutputs; ++i) {
582 index = out_map.get(DataType::AUDIO, out_index++, &valid);
584 ? bufs.get_audio(index).data(offset)
585 : scratch_bufs.get_audio(0).data(offset);
588 if (bufs.count().n_midi() > 0) {
591 const uint32_t buf_index_in = in_map.get(DataType::MIDI, 0, &valid);
593 v = bufs.get_vst_midi (buf_index_in);
596 const uint32_t buf_index_out = out_map.get(DataType::MIDI, 0, &valid);
598 _midi_out_buf = &bufs.get_midi(buf_index_out);
599 _midi_out_buf->silence(0, 0);
604 _plugin->dispatcher (_plugin, effProcessEvents, 0, 0, v, 0);
608 /* we already know it can support processReplacing */
609 _plugin->processReplacing (_plugin, &ins[0], &outs[0], nframes);
616 VSTPlugin::unique_id () const
620 snprintf (buf, sizeof (buf), "%d", _plugin->uniqueID);
627 VSTPlugin::name () const
629 if (!_info->name.empty ()) {
630 return _info->name.c_str();
632 return _handle->name;
636 VSTPlugin::maker () const
638 return _info->creator.c_str();
642 VSTPlugin::label () const
644 return _handle->name;
648 VSTPlugin::parameter_count () const
650 return _plugin->numParams;
654 VSTPlugin::has_editor () const
656 return _plugin->flags & effFlagsHasEditor;
660 VSTPlugin::print_parameter (uint32_t param, char *buf, uint32_t /*len*/) const
664 _plugin->dispatcher (_plugin, 7 /* effGetParamDisplay */, param, 0, buf, 0);
666 if (buf[0] == '\0') {
671 while (*first_nonws && isspace (*first_nonws)) {
675 if (*first_nonws == '\0') {
679 memmove (buf, first_nonws, strlen (buf) - (first_nonws - buf) + 1);
683 VSTPlugin::find_presets ()
685 /* Built-in presets */
687 int const vst_version = _plugin->dispatcher (_plugin, effGetVstVersion, 0, 0, NULL, 0);
688 for (int i = 0; i < _plugin->numPrograms; ++i) {
689 PresetRecord r (string_compose (X_("VST:%1:%2"), unique_id (), i), "", false);
691 if (vst_version >= 2) {
693 if (_plugin->dispatcher (_plugin, 29, i, 0, buf, 0) == 1) {
696 r.label = string_compose (_("Preset %1"), i);
699 r.label = string_compose (_("Preset %1"), i);
702 _presets.insert (make_pair (r.uri, r));
705 /* User presets from our XML file */
707 boost::shared_ptr<XMLTree> t (presets_tree ());
710 XMLNode* root = t->root ();
711 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
713 XMLProperty const * uri = (*i)->property (X_("uri"));
714 XMLProperty const * label = (*i)->property (X_("label"));
719 PresetRecord r (uri->value(), label->value(), true);
720 _presets.insert (make_pair (r.uri, r));
726 /** @return XMLTree with our user presets; could be a new one if no existing
727 * one was found, or 0 if one was present but badly-formatted.
730 VSTPlugin::presets_tree () const
732 XMLTree* t = new XMLTree;
734 std::string p = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
736 if (!Glib::file_test (p, Glib::FILE_TEST_IS_DIR)) {
737 if (g_mkdir_with_parents (p.c_str(), 0755) != 0) {
738 error << _("Unable to make VST presets directory") << endmsg;
742 p = Glib::build_filename (p, presets_file ());
744 if (!Glib::file_test (p, Glib::FILE_TEST_EXISTS)) {
745 t->set_root (new XMLNode (X_("VSTPresets")));
758 /** @return Index of the first user preset in our lists */
760 VSTPlugin::first_user_preset_index () const
762 return _plugin->numPrograms;
766 VSTPlugin::presets_file () const
768 return string_compose ("vst-%1", unique_id ());