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 <glib/gstdio.h>
23 #include <glibmm/fileutils.h>
24 #include <glibmm/miscutils.h>
26 #include "pbd/locale_guard.h"
27 #include "pbd/pathscanner.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)
51 VSTPlugin::~VSTPlugin ()
57 VSTPlugin::set_plugin (AEffect* e)
62 /* set rate and blocksize */
64 _plugin->dispatcher (_plugin, effSetSampleRate, 0, 0, NULL, (float) _session.frame_rate());
65 _plugin->dispatcher (_plugin, effSetBlockSize, 0, _session.get_block_size(), NULL, 0.0f);
69 VSTPlugin::deactivate ()
71 _plugin->dispatcher (_plugin, effMainsChanged, 0, 0, NULL, 0.0f);
75 VSTPlugin::activate ()
77 _plugin->dispatcher (_plugin, effMainsChanged, 0, 1, NULL, 0.0f);
81 VSTPlugin::set_block_size (pframes_t nframes)
84 _plugin->dispatcher (_plugin, effSetBlockSize, 0, nframes, NULL, 0.0f);
90 VSTPlugin::default_value (uint32_t)
96 VSTPlugin::get_parameter (uint32_t which) const
98 return _plugin->getParameter (_plugin, which);
102 VSTPlugin::set_parameter (uint32_t which, float val)
104 if (get_parameter (which) == val) {
108 _plugin->setParameter (_plugin, which, val);
109 Plugin::set_parameter (which, val);
113 VSTPlugin::nth_parameter (uint32_t n, bool& ok) const
119 /** Get VST chunk as base64-encoded data.
120 * @param single true for single program, false for all programs.
121 * @return 0-terminated base64-encoded data; must be passed to g_free () by caller.
124 VSTPlugin::get_chunk (bool single) const
127 int32_t data_size = _plugin->dispatcher (_plugin, 23 /* effGetChunk */, single ? 1 : 0, 0, &data, 0);
128 if (data_size == 0) {
132 return g_base64_encode (data, data_size);
135 /** Set VST chunk from base64-encoded data.
136 * @param 0-terminated base64-encoded data.
137 * @param single true for single program, false for all programs.
138 * @return 0 on success, non-0 on failure
141 VSTPlugin::set_chunk (gchar const * data, bool single)
144 guchar* raw_data = g_base64_decode (data, &size);
145 int const r = _plugin->dispatcher (_plugin, 24 /* effSetChunk */, single ? 1 : 0, size, raw_data, 0);
151 VSTPlugin::add_state (XMLNode* root) const
153 LocaleGuard lg (X_("POSIX"));
155 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
157 gchar* data = get_chunk (false);
162 /* store information */
164 XMLNode* chunk_node = new XMLNode (X_("chunk"));
166 chunk_node->add_content (data);
169 root->add_child_nocopy (*chunk_node);
173 XMLNode* parameters = new XMLNode ("parameters");
175 for (int32_t n = 0; n < _plugin->numParams; ++n) {
178 snprintf (index, sizeof (index), "param-%d", n);
179 snprintf (val, sizeof (val), "%.12g", _plugin->getParameter (_plugin, n));
180 parameters->add_property (index, val);
183 root->add_child_nocopy (*parameters);
188 VSTPlugin::set_state (const XMLNode& node, int version)
190 LocaleGuard lg (X_("POSIX"));
192 if (node.name() != state_node_name()) {
193 error << _("Bad node sent to VSTPlugin::set_state") << endmsg;
200 if ((child = find_named_node (node, X_("chunk"))) != 0) {
202 XMLPropertyList::const_iterator i;
203 XMLNodeList::const_iterator n;
205 for (n = child->children ().begin (); n != child->children ().end (); ++n) {
206 if ((*n)->is_content ()) {
207 /* XXX: this may be dubious for the same reasons that we delay
208 execution of load_preset.
210 ret = set_chunk ((*n)->content().c_str(), false);
214 } else if ((child = find_named_node (node, X_("parameters"))) != 0) {
216 XMLPropertyList::const_iterator i;
218 for (i = child->properties().begin(); i != child->properties().end(); ++i) {
222 sscanf ((*i)->name().c_str(), "param-%d", ¶m);
223 sscanf ((*i)->value().c_str(), "%f", &val);
225 _plugin->setParameter (_plugin, param, val);
232 Plugin::set_state (node, version);
238 VSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
240 VstParameterProperties prop;
242 desc.min_unbound = false;
243 desc.max_unbound = false;
246 if (_plugin->dispatcher (_plugin, effGetParameterProperties, which, 0, &prop, 0)) {
248 /* i have yet to find or hear of a VST plugin that uses this */
250 if (prop.flags & kVstParameterUsesIntegerMinMax) {
251 desc.lower = prop.minInteger;
252 desc.upper = prop.maxInteger;
258 if (prop.flags & kVstParameterUsesIntStep) {
260 desc.step = prop.stepInteger;
261 desc.smallstep = prop.stepInteger;
262 desc.largestep = prop.stepInteger;
264 } else if (prop.flags & kVstParameterUsesFloatStep) {
266 desc.step = prop.stepFloat;
267 desc.smallstep = prop.smallStepFloat;
268 desc.largestep = prop.largeStepFloat;
272 float range = desc.upper - desc.lower;
274 desc.step = range / 100.0f;
275 desc.smallstep = desc.step / 2.0f;
276 desc.largestep = desc.step * 10.0f;
279 desc.toggled = prop.flags & kVstParameterIsSwitch;
280 desc.logarithmic = false;
281 desc.sr_dependent = false;
282 desc.label = prop.label;
291 _plugin->dispatcher (_plugin, effGetParamName, which, 0, label, 0);
294 desc.integer_step = false;
298 desc.smallstep = 0.005f;
299 desc.largestep = 0.1f;
300 desc.toggled = false;
301 desc.logarithmic = false;
302 desc.sr_dependent = false;
309 VSTPlugin::load_preset (PresetRecord r)
314 s = load_user_preset (r);
316 s = load_plugin_preset (r);
320 Plugin::load_preset (r);
327 VSTPlugin::load_plugin_preset (PresetRecord r)
329 /* This is a plugin-provided preset.
330 We can't dispatch directly here; too many plugins expects only one GUI thread.
333 /* Extract the index of this preset from the URI */
337 int const p = sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
340 sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
343 _state->want_program = index;
348 VSTPlugin::load_user_preset (PresetRecord r)
350 /* This is a user preset; we load it, and this code also knows about the
351 non-direct-dispatch thing.
354 boost::shared_ptr<XMLTree> t (presets_tree ());
359 XMLNode* root = t->root ();
361 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
362 XMLProperty* label = (*i)->property (X_("label"));
366 if (label->value() != r.label) {
370 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
372 /* Load a user preset chunk from our XML file and send it via a circuitous route to the plugin */
374 if (_state->wanted_chunk) {
375 g_free (_state->wanted_chunk);
378 for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
379 if ((*j)->is_content ()) {
380 /* we can't dispatch directly here; too many plugins expect only one GUI thread */
382 guchar* raw_data = g_base64_decode ((*j)->content().c_str(), &size);
383 _state->wanted_chunk = raw_data;
384 _state->wanted_chunk_size = size;
385 _state->want_chunk = 1;
394 for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
395 if ((*j)->name() == X_("Parameter")) {
396 XMLProperty* index = (*j)->property (X_("index"));
397 XMLProperty* value = (*j)->property (X_("value"));
402 set_parameter (atoi (index->value().c_str()), atof (value->value().c_str ()));
412 VSTPlugin::do_save_preset (string name)
414 boost::shared_ptr<XMLTree> t (presets_tree ());
420 /* XXX: use of _presets.size() + 1 for the unique ID here is dubious at best */
421 string const uri = string_compose (X_("VST:%1:%2"), unique_id (), _presets.size() + 1);
423 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
425 p = new XMLNode (X_("ChunkPreset"));
426 p->add_property (X_("uri"), uri);
427 p->add_property (X_("label"), name);
428 gchar* data = get_chunk (true);
429 p->add_content (string (data));
434 p = new XMLNode (X_("Preset"));
435 p->add_property (X_("uri"), uri);
436 p->add_property (X_("label"), name);
438 for (uint32_t i = 0; i < parameter_count(); ++i) {
439 if (parameter_is_input (i)) {
440 XMLNode* c = new XMLNode (X_("Parameter"));
441 c->add_property (X_("index"), string_compose ("%1", i));
442 c->add_property (X_("value"), string_compose ("%1", get_parameter (i)));
443 p->add_child_nocopy (*c);
448 t->root()->add_child_nocopy (*p);
450 std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
451 f = Glib::build_filename (f, presets_file ());
458 VSTPlugin::do_remove_preset (string name)
460 boost::shared_ptr<XMLTree> t (presets_tree ());
465 t->root()->remove_nodes_and_delete (X_("label"), name);
467 std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
468 f = Glib::build_filename (f, presets_file ());
474 VSTPlugin::describe_parameter (Evoral::Parameter param)
476 char name[64] = "Unkown";
477 _plugin->dispatcher (_plugin, effGetParamName, param.id(), 0, name, 0);
482 VSTPlugin::signal_latency () const
485 return _user_latency;
488 return *((int32_t *) (((char *) &_plugin->flags) + 12)); /* initialDelay */
491 set<Evoral::Parameter>
492 VSTPlugin::automatable () const
494 set<Evoral::Parameter> ret;
496 for (uint32_t i = 0; i < parameter_count(); ++i) {
497 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
504 VSTPlugin::connect_and_run (BufferSet& bufs,
505 ChanMapping in_map, ChanMapping out_map,
506 pframes_t nframes, framecnt_t offset)
508 Plugin::connect_and_run (bufs, in_map, out_map, nframes, offset);
510 float *ins[_plugin->numInputs];
511 float *outs[_plugin->numOutputs];
514 const uint32_t nbufs = bufs.count().n_audio();
517 for (i = 0; i < (int32_t) _plugin->numInputs; ++i) {
518 ins[i] = bufs.get_audio(min((uint32_t) in_index, nbufs - 1)).data() + offset;
523 for (i = 0; i < (int32_t) _plugin->numOutputs; ++i) {
524 outs[i] = bufs.get_audio(min((uint32_t) out_index, nbufs - 1)).data() + offset;
528 if (bufs.count().n_midi() > 0) {
529 VstEvents* v = bufs.get_vst_midi (0);
530 _plugin->dispatcher (_plugin, effProcessEvents, 0, 0, v, 0);
533 /* we already know it can support processReplacing */
534 _plugin->processReplacing (_plugin, ins, outs, nframes);
540 VSTPlugin::unique_id () const
544 snprintf (buf, sizeof (buf), "%d", _plugin->uniqueID);
551 VSTPlugin::name () const
553 return _handle->name;
557 VSTPlugin::maker () const
559 return _info->creator.c_str();
563 VSTPlugin::label () const
565 return _handle->name;
569 VSTPlugin::parameter_count () const
571 return _plugin->numParams;
575 VSTPlugin::has_editor () const
577 return _plugin->flags & effFlagsHasEditor;
581 VSTPlugin::print_parameter (uint32_t param, char *buf, uint32_t /*len*/) const
585 _plugin->dispatcher (_plugin, 7 /* effGetParamDisplay */, param, 0, buf, 0);
587 if (buf[0] == '\0') {
592 while (*first_nonws && isspace (*first_nonws)) {
596 if (*first_nonws == '\0') {
600 memmove (buf, first_nonws, strlen (buf) - (first_nonws - buf) + 1);
604 VSTPlugin::find_presets ()
606 /* Built-in presets */
608 int const vst_version = _plugin->dispatcher (_plugin, effGetVstVersion, 0, 0, NULL, 0);
609 for (int i = 0; i < _plugin->numPrograms; ++i) {
610 PresetRecord r (string_compose (X_("VST:%1:%2"), unique_id (), i), "", -1, false);
612 if (vst_version >= 2) {
614 if (_plugin->dispatcher (_plugin, 29, i, 0, buf, 0) == 1) {
617 r.label = string_compose (_("Preset %1"), i);
620 r.label = string_compose (_("Preset %1"), i);
623 _presets.insert (make_pair (r.uri, r));
626 /* User presets from our XML file */
628 boost::shared_ptr<XMLTree> t (presets_tree ());
631 XMLNode* root = t->root ();
632 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
634 XMLProperty* uri = (*i)->property (X_("uri"));
635 XMLProperty* label = (*i)->property (X_("label"));
640 PresetRecord r (uri->value(), label->value(), -1, true);
641 _presets.insert (make_pair (r.uri, r));
647 /** @return XMLTree with our user presets; could be a new one if no existing
648 * one was found, or 0 if one was present but badly-formatted.
651 VSTPlugin::presets_tree () const
653 XMLTree* t = new XMLTree;
655 std::string p = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
657 if (!Glib::file_test (p, Glib::FILE_TEST_IS_DIR)) {
658 if (g_mkdir_with_parents (p.c_str(), 0755) != 0) {
659 error << _("Unable to make VST presets directory") << endmsg;
663 p = Glib::build_filename (p, presets_file ());
665 if (!Glib::file_test (p, Glib::FILE_TEST_EXISTS)) {
666 t->set_root (new XMLNode (X_("VSTPresets")));
679 /** @return Index of the first user preset in our lists */
681 VSTPlugin::first_user_preset_index () const
683 return _plugin->numPrograms;
687 VSTPlugin::presets_file () const
689 return string_compose ("vst-%1", unique_id ());