2 Copyright (C) 2004 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 /**********************************************************************/
21 /*Native linuxVST (LXVST) variant of vst_plugin.cc etc */
22 /**********************************************************************/
31 #include <cstdio> // so libraptor doesn't complain
34 #include <cstring> // for memmove
38 #include <glibmm/miscutils.h>
42 /*Include for the new native vst engine - vstfx.h*/
44 #include <ardour/vstfx.h>
46 #include "pbd/compose.h"
47 #include "pbd/error.h"
48 #include "pbd/pathscanner.h"
49 #include "pbd/xml++.h"
51 #include "ardour/session.h"
52 #include "ardour/audioengine.h"
53 #include "ardour/filesystem_paths.h"
54 #include "ardour/lxvst_plugin.h"
55 #include "ardour/buffer_set.h"
56 #include "ardour/audio_buffer.h"
57 #include "ardour/midi_buffer.h"
59 #include "pbd/stl_delete.h"
65 using namespace ARDOUR;
70 LXVSTPlugin::LXVSTPlugin (AudioEngine& e, Session& session, VSTFXHandle* h)
75 /*Instantiate the plugin and return a VSTFX* */
77 if ((_vstfx = vstfx_instantiate (handle, Session::lxvst_callback, this)) == 0)
79 throw failed_constructor();
82 /*Call into vstfx to get a pointer to the instance of the VST plugin*/
84 _plugin = _vstfx->plugin;
87 /* set rate and blocksize */
89 _plugin->dispatcher (_plugin, effSetSampleRate, 0, 0, NULL, (float) session.frame_rate());
91 _plugin->dispatcher (_plugin, effSetBlockSize, 0, session.get_block_size(), NULL, 0.0f);
93 /* set program to zero */
95 _plugin->dispatcher (_plugin, effSetProgram, 0, 0, NULL, 0.0f);
97 // Plugin::setup_controls ();
100 LXVSTPlugin::LXVSTPlugin (const LXVSTPlugin &other)
103 handle = other.handle;
105 if ((_vstfx = vstfx_instantiate (handle, Session::lxvst_callback, this)) == 0)
107 throw failed_constructor();
109 _plugin = _vstfx->plugin;
111 // Plugin::setup_controls ();
114 LXVSTPlugin::~LXVSTPlugin ()
117 vstfx_close (_vstfx);
120 int LXVSTPlugin::set_block_size (pframes_t nframes)
123 _plugin->dispatcher (_plugin, effSetBlockSize, 0, nframes, NULL, 0.0f);
128 float LXVSTPlugin::default_value (uint32_t port)
133 void LXVSTPlugin::set_parameter (uint32_t which, float val)
135 _plugin->setParameter (_plugin, which, val);
137 if (_vstfx->want_program == -1 && _vstfx->want_chunk == 0)
139 /* Heinous hack: Plugin::set_parameter below updates the `modified' status of the
140 current preset, but if _vstfx->want_program is not -1 then there is a preset
141 setup pending or in progress, which we don't want any `modified' updates
142 to happen for. So we only do this if _vstfx->want_program is -1.
144 Plugin::set_parameter (which, val);
148 float LXVSTPlugin::get_parameter (uint32_t which) const
150 return _plugin->getParameter (_plugin, which);
154 uint32_t LXVSTPlugin::nth_parameter (uint32_t n, bool& ok) const
160 /** Get VST chunk as base64-encoded data.
161 * @param single true for single program, false for all programs.
162 * @return 0-terminated base64-encoded data; must be passed to g_free () by caller.
164 gchar *LXVSTPlugin::get_chunk (bool single) const
167 int32_t data_size = _plugin->dispatcher (_plugin, 23 /* effGetChunk */, single ? 1 : 0, 0, &data, 0);
173 return g_base64_encode (data, data_size);
176 /** Set VST chunk from base64-encoded data.
177 * @param 0-terminated base64-encoded data.
178 * @param single true for single program, false for all programs.
179 * @return 0 on success, non-0 on failure
181 int LXVSTPlugin::set_chunk (gchar const * data, bool single)
184 guchar* raw_data = g_base64_decode (data, &size);
185 int const r = _plugin->dispatcher (_plugin, 24 /* effSetChunk */, single ? 1 : 0, size, raw_data, 0);
190 void LXVSTPlugin::add_state (XMLNode* root) const
192 LocaleGuard lg (X_("POSIX"));
194 if (_vstfx->current_program != -1)
197 snprintf (buf, sizeof (buf), "%d", _vstfx->current_program);
198 root->add_property ("current-program", buf);
201 if (_plugin->flags & 32 /* effFlagsProgramsChunks */)
203 gchar* data = get_chunk (false);
209 /* store information */
211 XMLNode* chunk_node = new XMLNode (X_("chunk"));
213 chunk_node->add_content (data);
216 root->add_child_nocopy (*chunk_node);
221 XMLNode* parameters = new XMLNode ("parameters");
223 for (int32_t n = 0; n < _plugin->numParams; ++n)
227 snprintf (index, sizeof (index), "param_%d", n);
228 snprintf (val, sizeof (val), "%.12g", _plugin->getParameter (_plugin, n));
229 parameters->add_property (index, val);
232 root->add_child_nocopy (*parameters);
236 int LXVSTPlugin::set_state (const XMLNode& node, int version)
238 LocaleGuard lg (X_("POSIX"));
240 if (node.name() != state_node_name())
242 error << _("Bad node sent to VSTPlugin::set_state") << endmsg;
246 const XMLProperty* prop;
248 if ((prop = node.property ("current-program")) != 0)
250 _vstfx->want_program = atoi (prop->value().c_str());
256 if ((child = find_named_node (node, X_("chunk"))) != 0)
258 XMLPropertyList::const_iterator i;
259 XMLNodeList::const_iterator n;
262 for (n = child->children ().begin (); n != child->children ().end (); ++n)
264 if ((*n)->is_content ())
266 /* XXX: this may be dubious for the same reasons that we delay
267 execution of load_preset.
269 ret = set_chunk ((*n)->content().c_str(), false);
274 else if ((child = find_named_node (node, X_("parameters"))) != 0)
276 XMLPropertyList::const_iterator i;
278 for (i = child->properties().begin(); i != child->properties().end(); ++i)
283 sscanf ((*i)->name().c_str(), "param-%d", ¶m); //This was param_%d (from vst_plugin) which caused all sorts of odd behaviour
284 sscanf ((*i)->value().c_str(), "%f", &val);
286 _plugin->setParameter (_plugin, param, val);
289 /* program number is not knowable */
291 _vstfx->current_program = -1;
296 Plugin::set_state (node, version);
300 int LXVSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
302 VstParameterProperties prop;
304 desc.min_unbound = false;
305 desc.max_unbound = false;
313 _plugin->dispatcher (_plugin, effGetParamName, which, 0, label, 0);
316 desc.integer_step = false;
320 desc.smallstep = 0.005f;
321 desc.largestep = 0.1f;
322 desc.toggled = false;
323 desc.logarithmic = false;
324 desc.sr_dependent = false;
329 bool LXVSTPlugin::load_preset (PresetRecord r)
335 s = load_user_preset (r);
339 s = load_plugin_preset (r);
344 Plugin::load_preset (r);
350 bool LXVSTPlugin::load_plugin_preset (PresetRecord r)
352 /* This is a plugin-provided preset.
353 We can't dispatch directly here; too many plugins expects only one GUI thread.
356 /* Extract the index of this preset from the URI */
359 int const p = sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
362 _vstfx->want_program = index;
366 bool LXVSTPlugin::load_user_preset (PresetRecord r)
368 /* This is a user preset; we load it, and this code also knows about the
369 non-direct-dispatch thing.
372 boost::shared_ptr<XMLTree> t (presets_tree ());
378 XMLNode* root = t->root ();
380 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i)
382 XMLProperty* uri = (*i)->property (X_("uri"));
383 XMLProperty* label = (*i)->property (X_("label"));
388 if (label->value() != r.label)
393 if (_plugin->flags & 32 /* effFlagsProgramsChunks */)
396 /* Load a user preset chunk from our XML file and send it via a circuitous route to the plugin */
398 if (_vstfx->wanted_chunk)
400 g_free (_vstfx->wanted_chunk);
403 for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j)
405 if ((*j)->is_content ())
407 /* we can't dispatch directly here; too many plugins expect only one GUI thread */
409 guchar* raw_data = g_base64_decode ((*j)->content().c_str(), &size);
410 _vstfx->wanted_chunk = raw_data;
411 _vstfx->wanted_chunk_size = size;
412 _vstfx->want_chunk = 1;
422 for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j)
424 if ((*j)->name() == X_("Parameter"))
426 XMLProperty* index = (*j)->property (X_("index"));
427 XMLProperty* value = (*j)->property (X_("value"));
432 set_parameter (atoi (index->value().c_str()), atof (value->value().c_str ()));
441 string LXVSTPlugin::do_save_preset (string name)
443 boost::shared_ptr<XMLTree> t (presets_tree ());
450 /* XXX: use of _presets.size() + 1 for the unique ID here is dubious at best */
451 string const uri = string_compose (X_("VST:%1:%2"), unique_id (), _presets.size() + 1);
453 if (_plugin->flags & 32 /* effFlagsProgramsChunks */)
456 p = new XMLNode (X_("ChunkPreset"));
457 p->add_property (X_("uri"), uri);
458 p->add_property (X_("label"), name);
459 gchar* data = get_chunk (true);
460 p->add_content (string (data));
467 p = new XMLNode (X_("Preset"));
468 p->add_property (X_("uri"), uri);
469 p->add_property (X_("label"), name);
471 for (uint32_t i = 0; i < parameter_count(); ++i)
473 if (parameter_is_input (i))
475 XMLNode* c = new XMLNode (X_("Parameter"));
476 c->add_property (X_("index"), string_compose ("%1", i));
477 c->add_property (X_("value"), string_compose ("%1", get_parameter (i)));
478 p->add_child_nocopy (*c);
483 t->root()->add_child_nocopy (*p);
485 sys::path f = ARDOUR::user_config_directory ();
487 f /= presets_file ();
489 t->write (f.to_string ());
493 void LXVSTPlugin::do_remove_preset (string name)
495 boost::shared_ptr<XMLTree> t (presets_tree ());
501 t->root()->remove_nodes_and_delete (X_("label"), name);
503 sys::path f = ARDOUR::user_config_directory ();
505 f /= presets_file ();
507 t->write (f.to_string ());
510 string LXVSTPlugin::describe_parameter (Evoral::Parameter param)
512 char name[64] = "Unkown";
513 _plugin->dispatcher (_plugin, effGetParamName, param.id(), 0, name, 0);
517 framecnt_t LXVSTPlugin::signal_latency () const
521 return _user_latency;
524 #ifdef VESTIGE_HEADER
525 return *((framecnt_t *) (((char *) &_plugin->flags) + 12)); /* initialDelay */
527 return _plugin->initial_delay;
531 set<Evoral::Parameter> LXVSTPlugin::automatable () const
533 set<Evoral::Parameter> ret;
535 for (uint32_t i = 0; i < parameter_count(); ++i)
537 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
543 int LXVSTPlugin::connect_and_run (BufferSet& bufs,
544 ChanMapping in_map, ChanMapping out_map,
545 pframes_t nframes, framecnt_t offset)
547 Plugin::connect_and_run (bufs, in_map, out_map, nframes, offset);
549 float *ins[_plugin->numInputs];
550 float *outs[_plugin->numOutputs];
553 const uint32_t nbufs = bufs.count().n_audio();
556 for (i = 0; i < (int32_t) _plugin->numInputs; ++i)
558 ins[i] = bufs.get_audio(min((uint32_t) in_index, nbufs - 1)).data() + offset;
563 for (i = 0; i < (int32_t) _plugin->numOutputs; ++i)
565 outs[i] = bufs.get_audio(min((uint32_t) out_index, nbufs - 1)).data() + offset;
569 if (bufs.count().n_midi() > 0)
571 VstEvents* v = bufs.get_vst_midi (0);
572 _plugin->dispatcher (_plugin, effProcessEvents, 0, 0, v, 0);
575 /* we already know it can support processReplacing */
578 _plugin->processReplacing (_plugin, ins, outs, nframes);
581 #if defined LXVST_64BIT && defined VESTIGE_HEADER
583 /*Vestige doesn't work for 64Bit - some of the AEffect struct member types
584 appear not to be correct which throws the data alignment. We have two choices
586 1) Fix Vestige - preferable from a technical standpoint, but perhaps
587 not viable without affecting its 'clean room' status
589 2) Correct for the alignment error - a bit of a kludge, but it can work,
590 assuming the following data types / sizes on x86-64
592 char 1Byte : Byte aligned
593 int 4Bytes : 4Byte aligned
594 long 8Bytes : 8Byte aligned
595 pointers 8Bytes : 8Byte aligned
597 This gives an offset of 8 Bytes - inclusive of padding
598 to translate to the correct address for processReplacing*/
600 ((AEffect*)(((char*)(_plugin)) + 8))->processReplacing(_plugin, ins, outs, nframes);
602 #elif defined LXVST_64BIT
604 _plugin->processReplacing(_plugin, ins, outs, nframes);
611 void LXVSTPlugin::deactivate ()
613 _plugin->dispatcher (_plugin, effMainsChanged, 0, 0, NULL, 0.0f);
616 void LXVSTPlugin::activate ()
618 _plugin->dispatcher (_plugin, effMainsChanged, 0, 1, NULL, 0.0f);
621 string LXVSTPlugin::unique_id() const
625 #if defined LXVST_64BIT && defined VESTIGE_HEADER
627 /*The vestige header appears not to have correct data
628 alignment in AEffect struct for 64Bit, possibly due
629 to incorrect data types - see previous comments*/
631 snprintf (buf, sizeof (buf), "%d", *((int32_t*) &((AEffect*)(((char*)(_plugin)) + 12))->unused_id));
633 #elif defined LXVST_32BIT && defined VESTIGE_HEADER
635 snprintf (buf, sizeof (buf), "%d", *((int32_t*) &_plugin->unused_id));
639 snprintf (buf, sizeof (buf), "%d", _plugin->uniqueID);
647 const char * LXVSTPlugin::name () const
652 const char * LXVSTPlugin::maker () const
654 return _info->creator.c_str();
657 const char * LXVSTPlugin::label () const
662 uint32_t LXVSTPlugin::parameter_count() const
664 return _plugin->numParams;
667 bool LXVSTPlugin::has_editor () const
669 return _plugin->flags & effFlagsHasEditor;
672 void LXVSTPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
676 _plugin->dispatcher (_plugin, 7 /* effGetParamDisplay */, param, 0, buf, 0);
684 while (*first_nonws && isspace (*first_nonws))
688 if (*first_nonws == '\0')
693 memmove (buf, first_nonws, strlen (buf) - (first_nonws - buf) + 1);
696 PluginPtr LXVSTPluginInfo::load (Session& session)
701 if (Config->get_use_lxvst())
705 handle = vstfx_load(path.c_str());
709 error << string_compose(_("LXVST: cannot load module from \"%1\""), path) << endmsg;
713 plugin.reset (new LXVSTPlugin (session.engine(), session, handle));
718 error << _("You asked ardour to not use any LXVST plugins") << endmsg;
719 return PluginPtr ((Plugin*) 0);
722 plugin->set_info(PluginInfoPtr(new LXVSTPluginInfo(*this)));
726 catch (failed_constructor &err)
728 return PluginPtr ((Plugin*) 0);
732 void LXVSTPlugin::find_presets ()
734 /* Built-in presets */
736 int const vst_version = _plugin->dispatcher (_plugin, effGetVstVersion, 0, 0, NULL, 0);
737 for (int i = 0; i < _plugin->numPrograms; ++i)
739 PresetRecord r (string_compose (X_("LXVST:%1:%2"), unique_id (), i), "", false);
741 if (vst_version >= 2)
744 if (_plugin->dispatcher (_plugin, 29, i, 0, buf, 0) == 1)
750 r.label = string_compose (_("Preset %1"), i);
755 r.label = string_compose (_("Preset %1"), i);
758 _presets.insert (make_pair (r.uri, r));
761 /* User presets from our XML file */
763 boost::shared_ptr<XMLTree> t (presets_tree ());
767 XMLNode* root = t->root ();
768 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i)
770 XMLProperty* uri = (*i)->property (X_("uri"));
771 XMLProperty* label = (*i)->property (X_("label"));
776 PresetRecord r (uri->value(), label->value(), true);
777 _presets.insert (make_pair (r.uri, r));
782 /** @return XMLTree with our user presets; could be a new one if no existing
783 * one was found, or 0 if one was present but badly-formatted.
785 XMLTree * LXVSTPlugin::presets_tree () const
787 XMLTree* t = new XMLTree;
789 sys::path p = ARDOUR::user_config_directory ();
792 if (!is_directory (p))
794 create_directory (p);
797 p /= presets_file ();
801 t->set_root (new XMLNode (X_("LXVSTPresets")));
805 t->set_filename (p.to_string ());
815 /** @return Index of the first user preset in our lists */
816 int LXVSTPlugin::first_user_preset_index () const
818 return _plugin->numPrograms;
821 string LXVSTPlugin::presets_file () const
823 return string_compose ("lxvst-%1", unique_id ());
826 LXVSTPluginInfo::LXVSTPluginInfo()
828 type = ARDOUR::LXVST;