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.
20 #include "pbd/locale_guard.h"
21 #include "pbd/pathscanner.h"
22 #include "ardour/vst_plugin.h"
23 #include "ardour/vestige/aeffectx.h"
24 #include "ardour/session.h"
25 #include "ardour/vst_types.h"
26 #include "ardour/filesystem_paths.h"
27 #include "ardour/audio_buffer.h"
33 using namespace ARDOUR;
35 VSTPlugin::VSTPlugin (AudioEngine& engine, Session& session, VSTHandle* handle)
36 : Plugin (engine, session)
44 VSTPlugin::~VSTPlugin ()
50 VSTPlugin::set_plugin (AEffect* e)
55 /* set rate and blocksize */
57 _plugin->dispatcher (_plugin, effSetSampleRate, 0, 0, NULL, (float) _session.frame_rate());
58 _plugin->dispatcher (_plugin, effSetBlockSize, 0, _session.get_block_size(), NULL, 0.0f);
62 VSTPlugin::deactivate ()
64 _plugin->dispatcher (_plugin, effMainsChanged, 0, 0, NULL, 0.0f);
68 VSTPlugin::activate ()
70 _plugin->dispatcher (_plugin, effMainsChanged, 0, 1, NULL, 0.0f);
74 VSTPlugin::set_block_size (pframes_t nframes)
77 _plugin->dispatcher (_plugin, effSetBlockSize, 0, nframes, NULL, 0.0f);
83 VSTPlugin::default_value (uint32_t)
89 VSTPlugin::get_parameter (uint32_t which) const
91 return _plugin->getParameter (_plugin, which);
95 VSTPlugin::set_parameter (uint32_t which, float val)
97 _plugin->setParameter (_plugin, which, val);
98 Plugin::set_parameter (which, val);
102 VSTPlugin::nth_parameter (uint32_t n, bool& ok) const
108 /** Get VST chunk as base64-encoded data.
109 * @param single true for single program, false for all programs.
110 * @return 0-terminated base64-encoded data; must be passed to g_free () by caller.
113 VSTPlugin::get_chunk (bool single) const
116 int32_t data_size = _plugin->dispatcher (_plugin, 23 /* effGetChunk */, single ? 1 : 0, 0, &data, 0);
117 if (data_size == 0) {
121 return g_base64_encode (data, data_size);
124 /** Set VST chunk from base64-encoded data.
125 * @param 0-terminated base64-encoded data.
126 * @param single true for single program, false for all programs.
127 * @return 0 on success, non-0 on failure
130 VSTPlugin::set_chunk (gchar const * data, bool single)
133 guchar* raw_data = g_base64_decode (data, &size);
134 int const r = _plugin->dispatcher (_plugin, 24 /* effSetChunk */, single ? 1 : 0, size, raw_data, 0);
140 VSTPlugin::add_state (XMLNode* root) const
142 LocaleGuard lg (X_("POSIX"));
144 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
146 gchar* data = get_chunk (false);
151 /* store information */
153 XMLNode* chunk_node = new XMLNode (X_("chunk"));
155 chunk_node->add_content (data);
158 root->add_child_nocopy (*chunk_node);
162 XMLNode* parameters = new XMLNode ("parameters");
164 for (int32_t n = 0; n < _plugin->numParams; ++n) {
167 snprintf (index, sizeof (index), "param-%d", n);
168 snprintf (val, sizeof (val), "%.12g", _plugin->getParameter (_plugin, n));
169 parameters->add_property (index, val);
172 root->add_child_nocopy (*parameters);
177 VSTPlugin::set_state (const XMLNode& node, int version)
179 LocaleGuard lg (X_("POSIX"));
181 if (node.name() != state_node_name()) {
182 error << _("Bad node sent to VSTPlugin::set_state") << endmsg;
189 if ((child = find_named_node (node, X_("chunk"))) != 0) {
191 XMLPropertyList::const_iterator i;
192 XMLNodeList::const_iterator n;
194 for (n = child->children ().begin (); n != child->children ().end (); ++n) {
195 if ((*n)->is_content ()) {
196 /* XXX: this may be dubious for the same reasons that we delay
197 execution of load_preset.
199 ret = set_chunk ((*n)->content().c_str(), false);
203 } else if ((child = find_named_node (node, X_("parameters"))) != 0) {
205 XMLPropertyList::const_iterator i;
207 for (i = child->properties().begin(); i != child->properties().end(); ++i) {
211 sscanf ((*i)->name().c_str(), "param-%d", ¶m);
212 sscanf ((*i)->value().c_str(), "%f", &val);
214 _plugin->setParameter (_plugin, param, val);
221 Plugin::set_state (node, version);
227 VSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
229 VstParameterProperties prop;
231 desc.min_unbound = false;
232 desc.max_unbound = false;
235 if (_plugin->dispatcher (_plugin, effGetParameterProperties, which, 0, &prop, 0)) {
237 /* i have yet to find or hear of a VST plugin that uses this */
239 if (prop.flags & kVstParameterUsesIntegerMinMax) {
240 desc.lower = prop.minInteger;
241 desc.upper = prop.maxInteger;
247 if (prop.flags & kVstParameterUsesIntStep) {
249 desc.step = prop.stepInteger;
250 desc.smallstep = prop.stepInteger;
251 desc.largestep = prop.stepInteger;
253 } else if (prop.flags & kVstParameterUsesFloatStep) {
255 desc.step = prop.stepFloat;
256 desc.smallstep = prop.smallStepFloat;
257 desc.largestep = prop.largeStepFloat;
261 float range = desc.upper - desc.lower;
263 desc.step = range / 100.0f;
264 desc.smallstep = desc.step / 2.0f;
265 desc.largestep = desc.step * 10.0f;
268 desc.toggled = prop.flags & kVstParameterIsSwitch;
269 desc.logarithmic = false;
270 desc.sr_dependent = false;
271 desc.label = prop.label;
280 _plugin->dispatcher (_plugin, effGetParamName, which, 0, label, 0);
283 desc.integer_step = false;
287 desc.smallstep = 0.005f;
288 desc.largestep = 0.1f;
289 desc.toggled = false;
290 desc.logarithmic = false;
291 desc.sr_dependent = false;
298 VSTPlugin::load_preset (PresetRecord r)
303 s = load_user_preset (r);
305 s = load_plugin_preset (r);
309 Plugin::load_preset (r);
316 VSTPlugin::load_plugin_preset (PresetRecord r)
318 /* This is a plugin-provided preset.
319 We can't dispatch directly here; too many plugins expects only one GUI thread.
322 /* Extract the index of this preset from the URI */
326 int const p = sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
329 sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
332 _state->want_program = index;
337 VSTPlugin::load_user_preset (PresetRecord r)
339 /* This is a user preset; we load it, and this code also knows about the
340 non-direct-dispatch thing.
343 boost::shared_ptr<XMLTree> t (presets_tree ());
348 XMLNode* root = t->root ();
350 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
351 XMLProperty* label = (*i)->property (X_("label"));
355 if (label->value() != r.label) {
359 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
361 /* Load a user preset chunk from our XML file and send it via a circuitous route to the plugin */
363 if (_state->wanted_chunk) {
364 g_free (_state->wanted_chunk);
367 for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
368 if ((*j)->is_content ()) {
369 /* we can't dispatch directly here; too many plugins expect only one GUI thread */
371 guchar* raw_data = g_base64_decode ((*j)->content().c_str(), &size);
372 _state->wanted_chunk = raw_data;
373 _state->wanted_chunk_size = size;
374 _state->want_chunk = 1;
383 for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
384 if ((*j)->name() == X_("Parameter")) {
385 XMLProperty* index = (*j)->property (X_("index"));
386 XMLProperty* value = (*j)->property (X_("value"));
391 set_parameter (atoi (index->value().c_str()), atof (value->value().c_str ()));
401 VSTPlugin::do_save_preset (string name)
403 boost::shared_ptr<XMLTree> t (presets_tree ());
409 /* XXX: use of _presets.size() + 1 for the unique ID here is dubious at best */
410 string const uri = string_compose (X_("VST:%1:%2"), unique_id (), _presets.size() + 1);
412 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
414 p = new XMLNode (X_("ChunkPreset"));
415 p->add_property (X_("uri"), uri);
416 p->add_property (X_("label"), name);
417 gchar* data = get_chunk (true);
418 p->add_content (string (data));
423 p = new XMLNode (X_("Preset"));
424 p->add_property (X_("uri"), uri);
425 p->add_property (X_("label"), name);
427 for (uint32_t i = 0; i < parameter_count(); ++i) {
428 if (parameter_is_input (i)) {
429 XMLNode* c = new XMLNode (X_("Parameter"));
430 c->add_property (X_("index"), string_compose ("%1", i));
431 c->add_property (X_("value"), string_compose ("%1", get_parameter (i)));
432 p->add_child_nocopy (*c);
437 t->root()->add_child_nocopy (*p);
439 sys::path f = ARDOUR::user_config_directory ();
441 f /= presets_file ();
443 t->write (f.to_string ());
448 VSTPlugin::do_remove_preset (string name)
450 boost::shared_ptr<XMLTree> t (presets_tree ());
455 t->root()->remove_nodes_and_delete (X_("label"), name);
457 sys::path f = ARDOUR::user_config_directory ();
459 f /= presets_file ();
461 t->write (f.to_string ());
465 VSTPlugin::describe_parameter (Evoral::Parameter param)
467 char name[64] = "Unkown";
468 _plugin->dispatcher (_plugin, effGetParamName, param.id(), 0, name, 0);
473 VSTPlugin::signal_latency () const
476 return _user_latency;
479 return *((int32_t *) (((char *) &_plugin->flags) + 12)); /* initialDelay */
482 set<Evoral::Parameter>
483 VSTPlugin::automatable () const
485 set<Evoral::Parameter> ret;
487 for (uint32_t i = 0; i < parameter_count(); ++i) {
488 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
495 VSTPlugin::connect_and_run (BufferSet& bufs,
496 ChanMapping in_map, ChanMapping out_map,
497 pframes_t nframes, framecnt_t offset)
499 Plugin::connect_and_run (bufs, in_map, out_map, nframes, offset);
501 float *ins[_plugin->numInputs];
502 float *outs[_plugin->numOutputs];
505 const uint32_t nbufs = bufs.count().n_audio();
508 for (i = 0; i < (int32_t) _plugin->numInputs; ++i) {
509 ins[i] = bufs.get_audio(min((uint32_t) in_index, nbufs - 1)).data() + offset;
514 for (i = 0; i < (int32_t) _plugin->numOutputs; ++i) {
515 outs[i] = bufs.get_audio(min((uint32_t) out_index, nbufs - 1)).data() + offset;
519 if (bufs.count().n_midi() > 0) {
520 VstEvents* v = bufs.get_vst_midi (0);
521 _plugin->dispatcher (_plugin, effProcessEvents, 0, 0, v, 0);
524 /* we already know it can support processReplacing */
525 _plugin->processReplacing (_plugin, ins, outs, nframes);
531 VSTPlugin::unique_id () const
535 snprintf (buf, sizeof (buf), "%d", _plugin->uniqueID);
542 VSTPlugin::name () const
544 return _handle->name;
548 VSTPlugin::maker () const
550 return _info->creator.c_str();
554 VSTPlugin::label () const
556 return _handle->name;
560 VSTPlugin::parameter_count () const
562 return _plugin->numParams;
566 VSTPlugin::has_editor () const
568 return _plugin->flags & effFlagsHasEditor;
572 VSTPlugin::print_parameter (uint32_t param, char *buf, uint32_t /*len*/) const
576 _plugin->dispatcher (_plugin, 7 /* effGetParamDisplay */, param, 0, buf, 0);
578 if (buf[0] == '\0') {
583 while (*first_nonws && isspace (*first_nonws)) {
587 if (*first_nonws == '\0') {
591 memmove (buf, first_nonws, strlen (buf) - (first_nonws - buf) + 1);
595 VSTPlugin::find_presets ()
597 /* Built-in presets */
599 int const vst_version = _plugin->dispatcher (_plugin, effGetVstVersion, 0, 0, NULL, 0);
600 for (int i = 0; i < _plugin->numPrograms; ++i) {
601 PresetRecord r (string_compose (X_("VST:%1:%2"), unique_id (), i), "", false);
603 if (vst_version >= 2) {
605 if (_plugin->dispatcher (_plugin, 29, i, 0, buf, 0) == 1) {
608 r.label = string_compose (_("Preset %1"), i);
611 r.label = string_compose (_("Preset %1"), i);
614 _presets.insert (make_pair (r.uri, r));
617 /* User presets from our XML file */
619 boost::shared_ptr<XMLTree> t (presets_tree ());
622 XMLNode* root = t->root ();
623 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
625 XMLProperty* uri = (*i)->property (X_("uri"));
626 XMLProperty* label = (*i)->property (X_("label"));
631 PresetRecord r (uri->value(), label->value(), true);
632 _presets.insert (make_pair (r.uri, r));
638 /** @return XMLTree with our user presets; could be a new one if no existing
639 * one was found, or 0 if one was present but badly-formatted.
642 VSTPlugin::presets_tree () const
644 XMLTree* t = new XMLTree;
646 sys::path p = ARDOUR::user_config_directory ();
649 if (!is_directory (p)) {
650 create_directory (p);
653 p /= presets_file ();
656 t->set_root (new XMLNode (X_("VSTPresets")));
660 t->set_filename (p.to_string ());
669 /** @return Index of the first user preset in our lists */
671 VSTPlugin::first_user_preset_index () const
673 return _plugin->numPrograms;
677 VSTPlugin::presets_file () const
679 return string_compose ("vst-%1", unique_id ());