move ever close to working master/slave logic, this time with audio testing
[ardour.git] / libs / ardour / vst_plugin.cc
index ae5e4897f8642eb4aa48d63039f9b747daf95ccd..3b7f9776d0abb4563419df28c759e7e4f65cf937 100644 (file)
 
 */
 
+#include <glib.h>
+#include "pbd/gstdio_compat.h"
+
+#include <glibmm/fileutils.h>
+#include <glibmm/miscutils.h>
+
+#include "pbd/floating.h"
 #include "pbd/locale_guard.h"
-#include "pbd/pathscanner.h"
+
 #include "ardour/vst_plugin.h"
 #include "ardour/vestige/aeffectx.h"
 #include "ardour/session.h"
@@ -37,13 +44,15 @@ VSTPlugin::VSTPlugin (AudioEngine& engine, Session& session, VSTHandle* handle)
        , _handle (handle)
        , _state (0)
        , _plugin (0)
+       , _pi (0)
+       , _num (0)
 {
-       
+       memset (&_timeInfo, 0, sizeof(_timeInfo));
 }
 
 VSTPlugin::~VSTPlugin ()
 {
-       
+
 }
 
 void
@@ -56,10 +65,6 @@ VSTPlugin::set_plugin (AEffect* e)
 
        _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);
 }
 
 void
@@ -74,7 +79,7 @@ VSTPlugin::activate ()
        _plugin->dispatcher (_plugin, effMainsChanged, 0, 1, NULL, 0.0f);
 }
 
-int 
+int
 VSTPlugin::set_block_size (pframes_t nframes)
 {
        deactivate ();
@@ -89,24 +94,28 @@ VSTPlugin::default_value (uint32_t)
        return 0;
 }
 
-float 
+float
 VSTPlugin::get_parameter (uint32_t which) const
 {
        return _plugin->getParameter (_plugin, which);
 }
 
-void 
-VSTPlugin::set_parameter (uint32_t which, float val)
+void
+VSTPlugin::set_parameter (uint32_t which, float newval)
 {
-       _plugin->setParameter (_plugin, which, val);
-       
-       if (_state->want_program == -1 && _state->want_chunk == 0) {
-               /* Heinous hack: Plugin::set_parameter below updates the `modified' status of the
-                  current preset, but if _state->want_program is not -1 then there is a preset
-                  setup pending or in progress, which we don't want any `modified' updates
-                  to happen for.  So we only do this if _state->want_program is -1.
-               */
-               Plugin::set_parameter (which, val);
+       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);
        }
 }
 
@@ -151,13 +160,7 @@ VSTPlugin::set_chunk (gchar const * data, bool single)
 void
 VSTPlugin::add_state (XMLNode* root) const
 {
-       LocaleGuard lg (X_("POSIX"));
-
-       if (_state->current_program != -1) {
-               char buf[32];
-               snprintf (buf, sizeof (buf), "%d", _state->current_program);
-               root->add_property ("current-program", buf);
-       }
+       LocaleGuard lg;
 
        if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
 
@@ -194,21 +197,16 @@ VSTPlugin::add_state (XMLNode* root) const
 int
 VSTPlugin::set_state (const XMLNode& node, int version)
 {
-       LocaleGuard lg (X_("POSIX"));
+       LocaleGuard lg;
+       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) {
-               _state->want_program = atoi (prop->value().c_str());
-       }
-
+#ifndef NO_PLUGIN_STATE
        XMLNode* child;
-       int ret = -1;
 
        if ((child = find_named_node (node, X_("chunk"))) != 0) {
 
@@ -218,8 +216,8 @@ VSTPlugin::set_state (const XMLNode& node, int version)
                for (n = child->children ().begin (); n != child->children ().end (); ++n) {
                        if ((*n)->is_content ()) {
                                /* XXX: this may be dubious for the same reasons that we delay
-                                  execution of load_preset.
-                               */
+                                        execution of load_preset.
+                                        */
                                ret = set_chunk ((*n)->content().c_str(), false);
                        }
                }
@@ -238,13 +236,10 @@ VSTPlugin::set_state (const XMLNode& node, int version)
                        _plugin->setParameter (_plugin, param, val);
                }
 
-               /* program number is not knowable */
-
-               _state->current_program = -1;
-
                ret = 0;
 
        }
+#endif
 
        Plugin::set_state (node, version);
        return ret;
@@ -256,15 +251,15 @@ VSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc)
 {
        VstParameterProperties prop;
 
+       memset (&prop, 0, sizeof (VstParameterProperties));
        desc.min_unbound = false;
        desc.max_unbound = false;
        prop.flags = 0;
 
        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 */
+               /* RG: faust2vsti does use this :) */
 
                if (prop.flags & kVstParameterUsesIntegerMinMax) {
                        desc.lower = prop.minInteger;
@@ -295,18 +290,22 @@ VSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc)
                        desc.largestep = desc.step * 10.0f;
                }
 
+               if (strlen(prop.label) == 0) {
+                       _plugin->dispatcher (_plugin, effGetParamName, which, 0, prop.label, 0);
+               }
+
                desc.toggled = prop.flags & kVstParameterIsSwitch;
                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, 0, sizeof (label));
 
                _plugin->dispatcher (_plugin, effGetParamName, which, 0, label, 0);
 
@@ -343,7 +342,7 @@ VSTPlugin::load_preset (PresetRecord r)
        return s;
 }
 
-bool 
+bool
 VSTPlugin::load_plugin_preset (PresetRecord r)
 {
        /* This is a plugin-provided preset.
@@ -356,15 +355,14 @@ VSTPlugin::load_plugin_preset (PresetRecord r)
 #ifndef NDEBUG
        int const p = sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
        assert (p == 2);
-#else 
+#else
        sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
 #endif
-       
        _state->want_program = index;
        return true;
 }
 
-bool 
+bool
 VSTPlugin::load_user_preset (PresetRecord r)
 {
        /* This is a user preset; we load it, and this code also knows about the
@@ -379,7 +377,7 @@ VSTPlugin::load_user_preset (PresetRecord r)
        XMLNode* root = t->root ();
 
        for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
-               XMLProperty* label = (*i)->property (X_("label"));
+               XMLProperty const * label = (*i)->property (X_("label"));
 
                assert (label);
 
@@ -409,12 +407,12 @@ VSTPlugin::load_user_preset (PresetRecord r)
 
                        return false;
 
-               }
-               else {
+               } 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"));
+                                               XMLProperty const * index = (*j)->property (X_("index"));
+                                               XMLProperty const * value = (*j)->property (X_("value"));
 
                                                assert (index);
                                                assert (value);
@@ -428,7 +426,7 @@ VSTPlugin::load_user_preset (PresetRecord r)
        return false;
 }
 
-string 
+string
 VSTPlugin::do_save_preset (string name)
 {
        boost::shared_ptr<XMLTree> t (presets_tree ());
@@ -449,8 +447,7 @@ VSTPlugin::do_save_preset (string name)
                p->add_content (string (data));
                g_free (data);
 
-       }
-       else {
+       } else {
 
                p = new XMLNode (X_("Preset"));
                p->add_property (X_("uri"), uri);
@@ -468,15 +465,14 @@ VSTPlugin::do_save_preset (string name)
 
        t->root()->add_child_nocopy (*p);
 
-       sys::path f = ARDOUR::user_config_directory ();
-       f /= "presets";
-       f /= presets_file ();
+       std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
+       f = Glib::build_filename (f, presets_file ());
 
-       t->write (f.to_string ());
+       t->write (f);
        return uri;
 }
 
-void 
+void
 VSTPlugin::do_remove_preset (string name)
 {
        boost::shared_ptr<XMLTree> t (presets_tree ());
@@ -486,32 +482,44 @@ VSTPlugin::do_remove_preset (string name)
 
        t->root()->remove_nodes_and_delete (X_("label"), name);
 
-       sys::path f = ARDOUR::user_config_directory ();
-       f /= "presets";
-       f /= presets_file ();
+       std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
+       f = Glib::build_filename (f, presets_file ());
 
-       t->write (f.to_string ());
+       t->write (f);
 }
 
-string 
+string
 VSTPlugin::describe_parameter (Evoral::Parameter param)
 {
-       char name[64] = "Unkown";
+       char name[64];
+       memset (name, 0, sizeof (name));
+
+       /* 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;
        }
 
+#if ( defined(__x86_64__) || defined(_M_X64) )
+       return *((int32_t *) (((char *) &_plugin->flags) + 24)); /* initialDelay */
+#else
        return *((int32_t *) (((char *) &_plugin->flags) + 12)); /* initialDelay */
+#endif
 }
 
-set<Evoral::Parameter> 
+set<Evoral::Parameter>
 VSTPlugin::automatable () const
 {
        set<Evoral::Parameter> ret;
@@ -525,82 +533,124 @@ VSTPlugin::automatable () const
 
 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;
+       ChanCount bufs_count;
+       bufs_count.set(DataType::AUDIO, 1);
+       bufs_count.set(DataType::MIDI, 1);
+       _midi_out_buf = 0;
+
+       BufferSet& silent_bufs  = _session.get_silent_buffers(bufs_count);
+       BufferSet& scratch_bufs = _session.get_scratch_buffers(bufs_count);
+
+       /* VC++ doesn't support the C99 extension that allows
 
-       const uint32_t nbufs = bufs.count().n_audio();
+          typeName foo[variableDefiningSize];
 
-       int in_index = 0;
+          Use alloca instead of dynamic array (rather than std::vector which
+          allocs on the heap) because this is realtime code.
+       */
+
+       float** ins = (float**)alloca(_plugin->numInputs*sizeof(float*));
+       float** outs = (float**)alloca(_plugin->numOutputs*sizeof(float*));
+
+       int32_t i;
+
+       uint32_t in_index = 0;
        for (i = 0; i < (int32_t) _plugin->numInputs; ++i) {
-               ins[i] = bufs.get_audio(min((uint32_t) in_index, nbufs - 1)).data() + offset;
-               in_index++;
+               uint32_t  index;
+               bool      valid = false;
+               index = in_map.get(DataType::AUDIO, in_index++, &valid);
+               ins[i] = (valid)
+                                       ? bufs.get_audio(index).data(offset)
+                                       : silent_bufs.get_audio(0).data(offset);
        }
 
-       int out_index = 0;
+       uint32_t 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;
-               out_index++;
+               uint32_t  index;
+               bool      valid = false;
+               index = out_map.get(DataType::AUDIO, out_index++, &valid);
+               outs[i] = (valid)
+                       ? bufs.get_audio(index).data(offset)
+                       : scratch_bufs.get_audio(0).data(offset);
        }
 
        if (bufs.count().n_midi() > 0) {
-               VstEvents* v = bufs.get_vst_midi (0);
-               _plugin->dispatcher (_plugin, effProcessEvents, 0, 0, v, 0);
+               VstEvents* v = 0;
+               bool valid = false;
+               const uint32_t buf_index_in = in_map.get(DataType::MIDI, 0, &valid);
+               if (valid) {
+                       v = bufs.get_vst_midi (buf_index_in);
+               }
+               valid = false;
+               const uint32_t buf_index_out = out_map.get(DataType::MIDI, 0, &valid);
+               if (valid) {
+                       _midi_out_buf = &bufs.get_midi(buf_index_out);
+                       _midi_out_buf->silence(0, 0);
+               } else {
+                       _midi_out_buf = 0;
+               }
+               if (v) {
+                       _plugin->dispatcher (_plugin, effProcessEvents, 0, 0, v, 0);
+               }
        }
 
        /* we already know it can support processReplacing */
-       _plugin->processReplacing (_plugin, ins, outs, nframes);
+       _plugin->processReplacing (_plugin, &ins[0], &outs[0], nframes);
+       _midi_out_buf = 0;
 
        return 0;
 }
 
-string 
+string
 VSTPlugin::unique_id () const
 {
        char buf[32];
 
        snprintf (buf, sizeof (buf), "%d", _plugin->uniqueID);
-       
+
        return string (buf);
 }
 
 
-const char * 
+const char *
 VSTPlugin::name () const
 {
+       if (!_info->name.empty ()) {
+               return _info->name.c_str();
+       }
        return _handle->name;
 }
 
-const char * 
+const char *
 VSTPlugin::maker () const
 {
        return _info->creator.c_str();
 }
 
-const char * 
+const char *
 VSTPlugin::label () const
 {
        return _handle->name;
 }
 
-uint32_t 
+uint32_t
 VSTPlugin::parameter_count () const
 {
        return _plugin->numParams;
 }
 
-bool 
+bool
 VSTPlugin::has_editor () const
 {
        return _plugin->flags & effFlagsHasEditor;
 }
 
-void 
+void
 VSTPlugin::print_parameter (uint32_t param, char *buf, uint32_t /*len*/) const
 {
        char *first_nonws;
@@ -654,8 +704,8 @@ VSTPlugin::find_presets ()
                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"));
+                       XMLProperty const * uri = (*i)->property (X_("uri"));
+                       XMLProperty const * label = (*i)->property (X_("label"));
 
                        assert (uri);
                        assert (label);
@@ -675,21 +725,22 @@ VSTPlugin::presets_tree () const
 {
        XMLTree* t = new XMLTree;
 
-       sys::path p = ARDOUR::user_config_directory ();
-       p /= "presets";
+       std::string p = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
 
-       if (!is_directory (p)) {
-               create_directory (p);
+       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 /= presets_file ();
+       p = Glib::build_filename (p, presets_file ());
 
-       if (!exists (p)) {
+       if (!Glib::file_test (p, Glib::FILE_TEST_EXISTS)) {
                t->set_root (new XMLNode (X_("VSTPresets")));
                return t;
        }
 
-       t->set_filename (p.to_string ());
+       t->set_filename (p);
        if (!t->read ()) {
                delete t;
                return 0;