/*
- Copyright (C) 2004 Paul Davis
+ Copyright (C) 2010 Paul Davis
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
*/
-#include <algorithm>
-#include <vector>
-#include <string>
-#include <cctype>
-
-#include <cstdlib>
-#include <cstdio> // so libraptor doesn't complain
-#include <cmath>
-#include <dirent.h>
-#include <cstring> // for memmove
-#include <sys/stat.h>
-#include <cerrno>
+#include <glib.h>
+#include <glib/gstdio.h>
+#include <glibmm/fileutils.h>
#include <glibmm/miscutils.h>
-#include <lrdf.h>
-#include <fst.h>
-
-#include "pbd/compose.h"
-#include "pbd/error.h"
+#include "pbd/floating.h"
+#include "pbd/locale_guard.h"
#include "pbd/pathscanner.h"
-#include "pbd/xml++.h"
-
-#include <fst.h>
+#include "ardour/vst_plugin.h"
+#include "ardour/vestige/aeffectx.h"
#include "ardour/session.h"
-#include "ardour/audioengine.h"
+#include "ardour/vst_types.h"
#include "ardour/filesystem_paths.h"
-#include "ardour/vst_plugin.h"
-#include "ardour/buffer_set.h"
#include "ardour/audio_buffer.h"
-#include "ardour/midi_buffer.h"
-
-#include "pbd/stl_delete.h"
#include "i18n.h"
-#include <locale.h>
using namespace std;
-using namespace ARDOUR;
using namespace PBD;
-using std::min;
-using std::max;
+using namespace ARDOUR;
-VSTPlugin::VSTPlugin (AudioEngine& e, Session& session, FSTHandle* h)
- : Plugin (e, session)
+VSTPlugin::VSTPlugin (AudioEngine& engine, Session& session, VSTHandle* handle)
+ : Plugin (engine, session)
+ , _handle (handle)
+ , _state (0)
+ , _plugin (0)
{
- handle = h;
+
+}
- if ((_fst = fst_instantiate (handle, Session::vst_callback, this)) == 0) {
- throw failed_constructor();
- }
+VSTPlugin::~VSTPlugin ()
+{
+
+}
- _plugin = _fst->plugin;
+void
+VSTPlugin::set_plugin (AEffect* e)
+{
+ _plugin = e;
_plugin->user = this;
/* set rate and blocksize */
- _plugin->dispatcher (_plugin, effSetSampleRate, 0, 0, NULL,
- (float) session.frame_rate());
- _plugin->dispatcher (_plugin, effSetBlockSize, 0,
- session.get_block_size(), NULL, 0.0f);
-
- /* set program to zero */
-
- _plugin->dispatcher (_plugin, effSetProgram, 0, 0, NULL, 0.0f);
-
- // Plugin::setup_controls ();
+ _plugin->dispatcher (_plugin, effSetSampleRate, 0, 0, NULL, (float) _session.frame_rate());
+ _plugin->dispatcher (_plugin, effSetBlockSize, 0, _session.get_block_size(), NULL, 0.0f);
}
-VSTPlugin::VSTPlugin (const VSTPlugin &other)
- : Plugin (other)
+void
+VSTPlugin::deactivate ()
{
- handle = other.handle;
-
- if ((_fst = fst_instantiate (handle, Session::vst_callback, this)) == 0) {
- throw failed_constructor();
- }
- _plugin = _fst->plugin;
-
- // Plugin::setup_controls ();
+ _plugin->dispatcher (_plugin, effMainsChanged, 0, 0, NULL, 0.0f);
}
-VSTPlugin::~VSTPlugin ()
+void
+VSTPlugin::activate ()
{
- deactivate ();
- fst_close (_fst);
+ _plugin->dispatcher (_plugin, effMainsChanged, 0, 1, NULL, 0.0f);
}
int
deactivate ();
_plugin->dispatcher (_plugin, effSetBlockSize, 0, nframes, NULL, 0.0f);
activate ();
- return 0;
+ return 0;
}
float
-VSTPlugin::default_value (uint32_t port)
+VSTPlugin::default_value (uint32_t)
{
return 0;
}
-void
-VSTPlugin::set_parameter (uint32_t which, float val)
+float
+VSTPlugin::get_parameter (uint32_t which) const
{
- _plugin->setParameter (_plugin, which, val);
- //ParameterChanged (which, val); /* EMIT SIGNAL */
+ return _plugin->getParameter (_plugin, which);
}
-float
-VSTPlugin::get_parameter (uint32_t which) const
+void
+VSTPlugin::set_parameter (uint32_t which, float newval)
{
- return _plugin->getParameter (_plugin, which);
+ float oldval = get_parameter (which);
+
+ if (PBD::floateq (oldval, newval, 1)) {
+ return;
+ }
+
+ _plugin->setParameter (_plugin, which, newval);
+
+ float curval = get_parameter (which);
+ if (!PBD::floateq (curval, oldval, 1)) {
+ /* value has changed, follow rest of the notification path */
+ Plugin::set_parameter (which, newval);
+ }
}
uint32_t
return n;
}
-XMLNode&
-VSTPlugin::get_state()
+/** Get VST chunk as base64-encoded data.
+ * @param single true for single program, false for all programs.
+ * @return 0-terminated base64-encoded data; must be passed to g_free () by caller.
+ */
+gchar *
+VSTPlugin::get_chunk (bool single) const
{
- XMLNode *root = new XMLNode (state_node_name());
- LocaleGuard lg (X_("POSIX"));
-
- if (_fst->current_program != -1) {
- char buf[32];
- snprintf (buf, sizeof (buf), "%d", _fst->current_program);
- root->add_property ("current-program", buf);
+ guchar* data;
+ int32_t data_size = _plugin->dispatcher (_plugin, 23 /* effGetChunk */, single ? 1 : 0, 0, &data, 0);
+ if (data_size == 0) {
+ return 0;
}
- if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
+ return g_base64_encode (data, data_size);
+}
- /* fetch the current chunk */
+/** Set VST chunk from base64-encoded data.
+ * @param 0-terminated base64-encoded data.
+ * @param single true for single program, false for all programs.
+ * @return 0 on success, non-0 on failure
+ */
+int
+VSTPlugin::set_chunk (gchar const * data, bool single)
+{
+ gsize size = 0;
+ guchar* raw_data = g_base64_decode (data, &size);
+ int const r = _plugin->dispatcher (_plugin, 24 /* effSetChunk */, single ? 1 : 0, size, raw_data, 0);
+ g_free (raw_data);
+ return r;
+}
+
+void
+VSTPlugin::add_state (XMLNode* root) const
+{
+ LocaleGuard lg (X_("POSIX"));
- guchar* data;
- int32_t data_size;
+ if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
- if ((data_size = _plugin->dispatcher (_plugin, 23 /* effGetChunk */, 0, 0, &data, false)) == 0) {
- return *root;
+ gchar* data = get_chunk (false);
+ if (data == 0) {
+ return;
}
/* store information */
XMLNode* chunk_node = new XMLNode (X_("chunk"));
- gchar * encoded_data = g_base64_encode (data, data_size);
- chunk_node->add_content (encoded_data);
- g_free (encoded_data);
+ chunk_node->add_content (data);
+ g_free (data);
root->add_child_nocopy (*chunk_node);
for (int32_t n = 0; n < _plugin->numParams; ++n) {
char index[64];
char val[32];
- snprintf (index, sizeof (index), "param_%ld", n);
+ snprintf (index, sizeof (index), "param-%d", n);
snprintf (val, sizeof (val), "%.12g", _plugin->getParameter (_plugin, n));
parameters->add_property (index, val);
}
root->add_child_nocopy (*parameters);
}
-
- return *root;
}
int
-VSTPlugin::set_state(const XMLNode& node, int)
+VSTPlugin::set_state (const XMLNode& node, int version)
{
LocaleGuard lg (X_("POSIX"));
+ int ret = -1;
if (node.name() != state_node_name()) {
error << _("Bad node sent to VSTPlugin::set_state") << endmsg;
return 0;
}
- const XMLProperty* prop;
-
- if ((prop = node.property ("current-program")) != 0) {
- _fst->current_program = atoi (prop->value().c_str());
- }
-
+#ifndef NO_PLUGIN_STATE
XMLNode* child;
- int ret = -1;
if ((child = find_named_node (node, X_("chunk"))) != 0) {
XMLPropertyList::const_iterator i;
XMLNodeList::const_iterator n;
- int ret = -1;
for (n = child->children ().begin (); n != child->children ().end (); ++n) {
if ((*n)->is_content ()) {
- gsize chunk_size = 0;
- guchar * data = g_base64_decode ((*n)->content ().c_str (), &chunk_size);
- //cerr << "Dispatch setChunk for " << name() << endl;
- ret = _plugin->dispatcher (_plugin, 24 /* effSetChunk */, 0, chunk_size, data, 0);
- g_free (data);
+ /* XXX: this may be dubious for the same reasons that we delay
+ execution of load_preset.
+ */
+ ret = set_chunk ((*n)->content().c_str(), false);
}
}
int32_t param;
float val;
- sscanf ((*i)->name().c_str(), "param_%d", ¶m);
+ sscanf ((*i)->name().c_str(), "param-%d", ¶m);
sscanf ((*i)->value().c_str(), "%f", &val);
_plugin->setParameter (_plugin, param, val);
}
- /* program number is not knowable */
-
- _fst->current_program = -1;
-
ret = 0;
}
+#endif
+ Plugin::set_state (node, version);
return ret;
}
+
int
VSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
{
if (_plugin->dispatcher (_plugin, effGetParameterProperties, which, 0, &prop, 0)) {
-#ifdef VESTIGE_COMPLETE
-
/* i have yet to find or hear of a VST plugin that uses this */
if (prop.flags & kVstParameterUsesIntegerMinMax) {
desc.logarithmic = false;
desc.sr_dependent = false;
desc.label = prop.label;
-#endif
} else {
/* old style */
char label[64];
- label[0] = '\0';
+ /* some VST plugins expect this buffer to be zero-filled */
+ memset (label, sizeof (label), 0);
_plugin->dispatcher (_plugin, effGetParamName, which, 0, label, 0);
-
+
desc.label = label;
desc.integer_step = false;
desc.lower = 0.0f;
}
bool
-VSTPlugin::load_preset (const string& name)
+VSTPlugin::load_preset (PresetRecord r)
{
- if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
- error << _("no support for presets using chunks at this time")
- << endmsg;
+ bool s;
+
+ if (r.user) {
+ s = load_user_preset (r);
+ } else {
+ s = load_plugin_preset (r);
+ }
+
+ if (s) {
+ Plugin::load_preset (r);
+ }
+
+ return s;
+}
+
+bool
+VSTPlugin::load_plugin_preset (PresetRecord r)
+{
+ /* This is a plugin-provided preset.
+ We can't dispatch directly here; too many plugins expects only one GUI thread.
+ */
+
+ /* Extract the index of this preset from the URI */
+ int id;
+ int index;
+#ifndef NDEBUG
+ int const p = sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
+ assert (p == 2);
+#else
+ sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
+#endif
+
+ _state->want_program = index;
+ return true;
+}
+
+bool
+VSTPlugin::load_user_preset (PresetRecord r)
+{
+ /* This is a user preset; we load it, and this code also knows about the
+ non-direct-dispatch thing.
+ */
+
+ boost::shared_ptr<XMLTree> t (presets_tree ());
+ if (t == 0) {
return false;
}
- return Plugin::load_preset (name);
+
+ XMLNode* root = t->root ();
+
+ for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
+ XMLProperty* label = (*i)->property (X_("label"));
+
+ assert (label);
+
+ if (label->value() != r.label) {
+ continue;
+ }
+
+ if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
+
+ /* Load a user preset chunk from our XML file and send it via a circuitous route to the plugin */
+
+ if (_state->wanted_chunk) {
+ g_free (_state->wanted_chunk);
+ }
+
+ for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
+ if ((*j)->is_content ()) {
+ /* we can't dispatch directly here; too many plugins expect only one GUI thread */
+ gsize size = 0;
+ guchar* raw_data = g_base64_decode ((*j)->content().c_str(), &size);
+ _state->wanted_chunk = raw_data;
+ _state->wanted_chunk_size = size;
+ _state->want_chunk = 1;
+ return true;
+ }
+ }
+
+ return false;
+
+ } else {
+
+ for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
+ if ((*j)->name() == X_("Parameter")) {
+ XMLProperty* index = (*j)->property (X_("index"));
+ XMLProperty* value = (*j)->property (X_("value"));
+
+ assert (index);
+ assert (value);
+
+ set_parameter (atoi (index->value().c_str()), atof (value->value().c_str ()));
+ }
+ }
+ return true;
+ }
+ }
+ return false;
}
-bool
-VSTPlugin::save_preset (string name)
+string
+VSTPlugin::do_save_preset (string name)
{
+ boost::shared_ptr<XMLTree> t (presets_tree ());
+ if (t == 0) {
+ return "";
+ }
+
+ XMLNode* p = 0;
+ /* XXX: use of _presets.size() + 1 for the unique ID here is dubious at best */
+ string const uri = string_compose (X_("VST:%1:%2"), unique_id (), _presets.size() + 1);
+
if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
- error << _("no support for presets using chunks at this time")
- << endmsg;
- return false;
+
+ p = new XMLNode (X_("ChunkPreset"));
+ p->add_property (X_("uri"), uri);
+ p->add_property (X_("label"), name);
+ gchar* data = get_chunk (true);
+ p->add_content (string (data));
+ g_free (data);
+
+ } else {
+
+ p = new XMLNode (X_("Preset"));
+ p->add_property (X_("uri"), uri);
+ p->add_property (X_("label"), name);
+
+ for (uint32_t i = 0; i < parameter_count(); ++i) {
+ if (parameter_is_input (i)) {
+ XMLNode* c = new XMLNode (X_("Parameter"));
+ c->add_property (X_("index"), string_compose ("%1", i));
+ c->add_property (X_("value"), string_compose ("%1", get_parameter (i)));
+ p->add_child_nocopy (*c);
+ }
+ }
+ }
+
+ t->root()->add_child_nocopy (*p);
+
+ std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
+ f = Glib::build_filename (f, presets_file ());
+
+ t->write (f);
+ return uri;
+}
+
+void
+VSTPlugin::do_remove_preset (string name)
+{
+ boost::shared_ptr<XMLTree> t (presets_tree ());
+ if (t == 0) {
+ return;
}
- return Plugin::save_preset (name, "vst");
+
+ t->root()->remove_nodes_and_delete (X_("label"), name);
+
+ std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
+ f = Glib::build_filename (f, presets_file ());
+
+ t->write (f);
}
-string
+string
VSTPlugin::describe_parameter (Evoral::Parameter param)
{
char name[64];
+ memset (name, sizeof (name), 0);
+
+ /* some VST plugins expect this buffer to be zero-filled */
+
_plugin->dispatcher (_plugin, effGetParamName, param.id(), 0, name, 0);
+
+ if (name[0] == '\0') {
+ strcpy (name, _("Unknown"));
+ }
+
return name;
}
-framecnt_t
+framecnt_t
VSTPlugin::signal_latency () const
{
if (_user_latency) {
return _user_latency;
}
-#ifdef VESTIGE_HEADER
- return *((framecnt_t *) (((char *) &_plugin->flags) + 12)); /* initialDelay */
-#else
- return _plugin->initial_delay;
-#endif
+ return *((int32_t *) (((char *) &_plugin->flags) + 12)); /* initialDelay */
}
-set<Evoral::Parameter>
+set<Evoral::Parameter>
VSTPlugin::automatable () const
{
set<Evoral::Parameter> ret;
- for (uint32_t i = 0; i < parameter_count(); ++i){
+ for (uint32_t i = 0; i < parameter_count(); ++i) {
ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
}
int
VSTPlugin::connect_and_run (BufferSet& bufs,
- ChanMapping in_map, ChanMapping out_map,
- pframes_t nframes, framecnt_t offset)
+ ChanMapping in_map, ChanMapping out_map,
+ pframes_t nframes, framecnt_t offset)
{
+ Plugin::connect_and_run (bufs, in_map, out_map, nframes, offset);
+
float *ins[_plugin->numInputs];
float *outs[_plugin->numOutputs];
int32_t i;
int out_index = 0;
for (i = 0; i < (int32_t) _plugin->numOutputs; ++i) {
outs[i] = bufs.get_audio(min((uint32_t) out_index, nbufs - 1)).data() + offset;
-
- /* unbelievably, several VST plugins still rely on Cubase
- behaviour and do not silence the buffer in processReplacing
- when they have no output.
- */
-
- // memset (outs[i], 0, sizeof (Sample) * nframes);
out_index++;
}
-
if (bufs.count().n_midi() > 0) {
VstEvents* v = bufs.get_vst_midi (0);
_plugin->dispatcher (_plugin, effProcessEvents, 0, 0, v, 0);
}
/* we already know it can support processReplacing */
-
_plugin->processReplacing (_plugin, ins, outs, nframes);
return 0;
}
-void
-VSTPlugin::deactivate ()
-{
- _plugin->dispatcher (_plugin, effMainsChanged, 0, 0, NULL, 0.0f);
-}
-
-void
-VSTPlugin::activate ()
-{
- _plugin->dispatcher (_plugin, effMainsChanged, 0, 1, NULL, 0.0f);
-}
-
-string
-VSTPlugin::unique_id() const
+string
+VSTPlugin::unique_id () const
{
char buf[32];
-#ifdef VESTIGE_HEADER
- snprintf (buf, sizeof (buf), "%d", *((int32_t*) &_plugin->unused_id));
-#else
- snprintf (buf, sizeof (buf), "%d", _plugin->uniqueID);
-#endif
- return string (buf);
+ snprintf (buf, sizeof (buf), "%d", _plugin->uniqueID);
+
+ return string (buf);
}
-const char *
+const char *
VSTPlugin::name () const
{
- return handle->name;
+ return _handle->name;
}
-const char *
+const char *
VSTPlugin::maker () const
{
- return "imadeit";
+ return _info->creator.c_str();
}
-const char *
+const char *
VSTPlugin::label () const
{
- return handle->name;
+ return _handle->name;
}
-uint32_t
-VSTPlugin::parameter_count() const
+uint32_t
+VSTPlugin::parameter_count () const
{
return _plugin->numParams;
}
-bool
+bool
VSTPlugin::has_editor () const
{
return _plugin->flags & effFlagsHasEditor;
}
-void
-VSTPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
+void
+VSTPlugin::print_parameter (uint32_t param, char *buf, uint32_t /*len*/) const
{
char *first_nonws;
while (*first_nonws && isspace (*first_nonws)) {
first_nonws++;
}
+
if (*first_nonws == '\0') {
return;
}
memmove (buf, first_nonws, strlen (buf) - (first_nonws - buf) + 1);
}
-PluginPtr
-VSTPluginInfo::load (Session& session)
+void
+VSTPlugin::find_presets ()
{
- try {
- PluginPtr plugin;
+ /* Built-in presets */
- if (Config->get_use_vst()) {
- FSTHandle* handle;
+ int const vst_version = _plugin->dispatcher (_plugin, effGetVstVersion, 0, 0, NULL, 0);
+ for (int i = 0; i < _plugin->numPrograms; ++i) {
+ PresetRecord r (string_compose (X_("VST:%1:%2"), unique_id (), i), "", -1, false);
- handle = fst_load(path.c_str());
-
- if ( (int)handle == -1) {
- error << string_compose(_("VST: cannot load module from \"%1\""), path) << endmsg;
+ if (vst_version >= 2) {
+ char buf[256];
+ if (_plugin->dispatcher (_plugin, 29, i, 0, buf, 0) == 1) {
+ r.label = buf;
} else {
- plugin.reset (new VSTPlugin (session.engine(), session, handle));
+ r.label = string_compose (_("Preset %1"), i);
}
} else {
- error << _("You asked ardour to not use any VST plugins") << endmsg;
- return PluginPtr ((Plugin*) 0);
+ r.label = string_compose (_("Preset %1"), i);
}
- plugin->set_info(PluginInfoPtr(new VSTPluginInfo(*this)));
- return plugin;
+ _presets.insert (make_pair (r.uri, r));
}
- catch (failed_constructor &err) {
- return PluginPtr ((Plugin*) 0);
+ /* User presets from our XML file */
+
+ boost::shared_ptr<XMLTree> t (presets_tree ());
+
+ if (t) {
+ XMLNode* root = t->root ();
+ for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
+
+ XMLProperty* uri = (*i)->property (X_("uri"));
+ XMLProperty* label = (*i)->property (X_("label"));
+
+ assert (uri);
+ assert (label);
+
+ PresetRecord r (uri->value(), label->value(), -1, true);
+ _presets.insert (make_pair (r.uri, r));
+ }
+ }
+
+}
+
+/** @return XMLTree with our user presets; could be a new one if no existing
+ * one was found, or 0 if one was present but badly-formatted.
+ */
+XMLTree *
+VSTPlugin::presets_tree () const
+{
+ XMLTree* t = new XMLTree;
+
+ std::string p = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
+
+ if (!Glib::file_test (p, Glib::FILE_TEST_IS_DIR)) {
+ if (g_mkdir_with_parents (p.c_str(), 0755) != 0) {
+ error << _("Unable to make VST presets directory") << endmsg;
+ };
+ }
+
+ p = Glib::build_filename (p, presets_file ());
+
+ if (!Glib::file_test (p, Glib::FILE_TEST_EXISTS)) {
+ t->set_root (new XMLNode (X_("VSTPresets")));
+ return t;
+ }
+
+ t->set_filename (p);
+ if (!t->read ()) {
+ delete t;
+ return 0;
}
+
+ return t;
}
-VSTPluginInfo::VSTPluginInfo()
+/** @return Index of the first user preset in our lists */
+int
+VSTPlugin::first_user_preset_index () const
{
- type = ARDOUR::VST;
+ return _plugin->numPrograms;
}
+
+string
+VSTPlugin::presets_file () const
+{
+ return string_compose ("vst-%1", unique_id ());
+}
+
projects / ardour.git / blobdiff