Use ID::to_s() in libpbd instead of ID::print()
[ardour.git] / libs / ardour / vst_plugin.cc
index daf096e80ea204c1a7248a1b5fb06efe054d91a8..95a661c40c67f0e69a0f93736b9ff8b78707da92 100644 (file)
 */
 
 #include <glib.h>
-#include <glib/gstdio.h>
+#include "pbd/gstdio_compat.h"
 
 #include <glibmm/fileutils.h>
 #include <glibmm/miscutils.h>
+#include <glibmm/convert.h>
 
 #include "pbd/floating.h"
 #include "pbd/locale_guard.h"
@@ -33,7 +34,7 @@
 #include "ardour/filesystem_paths.h"
 #include "ardour/audio_buffer.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace std;
 using namespace PBD;
@@ -44,8 +45,29 @@ VSTPlugin::VSTPlugin (AudioEngine& engine, Session& session, VSTHandle* handle)
        , _handle (handle)
        , _state (0)
        , _plugin (0)
+       , _pi (0)
+       , _num (0)
+       , _transport_frame (0)
+       , _transport_speed (0.f)
+       , _eff_bypassed (false)
 {
+       memset (&_timeInfo, 0, sizeof(_timeInfo));
+}
 
+VSTPlugin::VSTPlugin (const VSTPlugin& other)
+       : Plugin (other)
+       , _handle (other._handle)
+       , _state (other._state)
+       , _plugin (other._plugin)
+       , _pi (other._pi)
+       , _num (other._num)
+       , _midi_out_buf (other._midi_out_buf)
+       , _transport_frame (0)
+       , _transport_speed (0.f)
+       , _parameter_defaults (other._parameter_defaults)
+       , _eff_bypassed (other._eff_bypassed)
+{
+       memset (&_timeInfo, 0, sizeof(_timeInfo));
 }
 
 VSTPlugin::~VSTPlugin ()
@@ -54,17 +76,48 @@ VSTPlugin::~VSTPlugin ()
 }
 
 void
-VSTPlugin::set_plugin (AEffect* e)
+VSTPlugin::open_plugin ()
 {
-       _plugin = e;
+       _plugin = _state->plugin;
+       assert (_plugin->user == this); // should have been set by {mac_vst|fst|lxvst}_instantiate
        _plugin->user = this;
+       _state->plugin->dispatcher (_plugin, effOpen, 0, 0, 0, 0);
+       _state->vst_version = _plugin->dispatcher (_plugin, effGetVstVersion, 0, 0, 0, 0);
+}
 
+void
+VSTPlugin::init_plugin ()
+{
        /* 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);
 }
 
+
+uint32_t
+VSTPlugin::designated_bypass_port ()
+{
+       if (_plugin->dispatcher (_plugin, effCanDo, 0, 0, const_cast<char*> ("bypass"), 0.0f) != 0) {
+#ifdef ALLOW_VST_BYPASS_TO_FAIL // yet unused, see also plugin_insert.cc
+               return UINT32_MAX - 1; // emulate a port
+#else
+               /* check if plugin actually supports it,
+                * e.g. u-he Presswerk  CanDo "bypass"  but calling effSetBypass is a NO-OP.
+                * (presumably the plugin-author thinks hard-bypassing is a bad idea,
+                * particularly since the plugin itself provides a bypass-port)
+                */
+               intptr_t value = 0; // not bypassed
+               if (0 != _plugin->dispatcher (_plugin, 44 /*effSetBypass*/, 0, value, NULL, 0)) {
+                       cerr << "Emulate VST Bypass Port for " << name() << endl; // XXX DEBUG
+                       return UINT32_MAX - 1; // emulate a port
+               } else {
+                       cerr << "Do *not* Emulate VST Bypass Port for " << name() << endl; // XXX DEBUG
+               }
+#endif
+       }
+       return UINT32_MAX;
+}
+
 void
 VSTPlugin::deactivate ()
 {
@@ -87,20 +140,40 @@ VSTPlugin::set_block_size (pframes_t nframes)
 }
 
 float
-VSTPlugin::default_value (uint32_t)
+VSTPlugin::default_value (uint32_t which)
 {
-       return 0;
+       return _parameter_defaults[which];
 }
 
 float
 VSTPlugin::get_parameter (uint32_t which) const
 {
+       if (which == UINT32_MAX - 1) {
+               // ardour uses enable-semantics: 1: enabled, 0: bypassed
+               return _eff_bypassed ? 0.f : 1.f;
+       }
        return _plugin->getParameter (_plugin, which);
 }
 
 void
 VSTPlugin::set_parameter (uint32_t which, float newval)
 {
+       if (which == UINT32_MAX - 1) {
+               // ardour uses enable-semantics: 1: enabled, 0: bypassed
+               intptr_t value = (newval <= 0.f) ? 1 : 0;
+               cerr << "effSetBypass " << value << endl; // XXX DEBUG
+               int rv = _plugin->dispatcher (_plugin, 44 /*effSetBypass*/, 0, value, NULL, 0);
+               if (0 != rv) {
+                       _eff_bypassed = (value == 1);
+               } else {
+                       cerr << "effSetBypass failed rv=" << rv << endl; // XXX DEBUG
+#ifdef ALLOW_VST_BYPASS_TO_FAIL // yet unused, see also vst_plugin.cc
+                       // emit signal.. hard un/bypass from here?!
+#endif
+               }
+               return;
+       }
+
        float oldval = get_parameter (which);
 
        if (PBD::floateq (oldval, newval, 1)) {
@@ -117,6 +190,14 @@ VSTPlugin::set_parameter (uint32_t which, float newval)
        }
 }
 
+void
+VSTPlugin::parameter_changed_externally (uint32_t which, float value )
+{
+       ParameterChangedExternally (which, value); /* EMIT SIGNAL */
+       Plugin::set_parameter (which, value);
+}
+
+
 uint32_t
 VSTPlugin::nth_parameter (uint32_t n, bool& ok) const
 {
@@ -149,8 +230,13 @@ int
 VSTPlugin::set_chunk (gchar const * data, bool single)
 {
        gsize size = 0;
+       int r = 0;
        guchar* raw_data = g_base64_decode (data, &size);
-       int const r = _plugin->dispatcher (_plugin, 24 /* effSetChunk */, single ? 1 : 0, size, raw_data, 0);
+       {
+               pthread_mutex_lock (&_state->state_lock);
+               r = _plugin->dispatcher (_plugin, 24 /* effSetChunk */, single ? 1 : 0, size, raw_data, 0);
+               pthread_mutex_unlock (&_state->state_lock);
+       }
        g_free (raw_data);
        return r;
 }
@@ -158,7 +244,7 @@ VSTPlugin::set_chunk (gchar const * data, bool single)
 void
 VSTPlugin::add_state (XMLNode* root) const
 {
-       LocaleGuard lg (X_("C"));
+       LocaleGuard lg;
 
        if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
 
@@ -195,7 +281,7 @@ VSTPlugin::add_state (XMLNode* root) const
 int
 VSTPlugin::set_state (const XMLNode& node, int version)
 {
-       LocaleGuard lg (X_("C"));
+       LocaleGuard lg;
        int ret = -1;
 
        if (node.name() != state_node_name()) {
@@ -295,7 +381,7 @@ VSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc)
                desc.toggled = prop.flags & kVstParameterIsSwitch;
                desc.logarithmic = false;
                desc.sr_dependent = false;
-               desc.label = prop.label;
+               desc.label = Glib::locale_to_utf8 (prop.label);
 
        } else {
 
@@ -307,7 +393,7 @@ VSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc)
 
                _plugin->dispatcher (_plugin, effGetParamName, which, 0, label, 0);
 
-               desc.label = label;
+               desc.label = Glib::locale_to_utf8 (label);
                desc.integer_step = false;
                desc.lower = 0.0f;
                desc.upper = 1.0f;
@@ -319,6 +405,11 @@ VSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc)
                desc.sr_dependent = false;
        }
 
+       desc.normal = get_parameter (which);
+       if (_parameter_defaults.find (which) == _parameter_defaults.end ()) {
+               _parameter_defaults[which] = desc.normal;
+       }
+
        return 0;
 }
 
@@ -357,6 +448,7 @@ VSTPlugin::load_plugin_preset (PresetRecord r)
        sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
 #endif
        _state->want_program = index;
+       LoadPresetProgram (); /* EMIT SIGNAL */ /* used for macvst */
        return true;
 }
 
@@ -375,7 +467,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);
 
@@ -399,6 +491,7 @@ VSTPlugin::load_user_preset (PresetRecord r)
                                        _state->wanted_chunk = raw_data;
                                        _state->wanted_chunk_size = size;
                                        _state->want_chunk = 1;
+                                       LoadPresetProgram (); /* EMIT SIGNAL */ /* used for macvst */
                                        return true;
                                }
                        }
@@ -409,13 +502,15 @@ VSTPlugin::load_user_preset (PresetRecord r)
 
                        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);
-
-                                               set_parameter (atoi (index->value().c_str()), atof (value->value().c_str ()));
+                                               const uint32_t p = atoi (index->value().c_str());
+                                               const float v = atof (value->value().c_str ());
+                                               set_parameter (p, v);
+                                               PresetPortSetValue (p, v); /* EMIT SIGNAL */
                                }
                        }
                        return true;
@@ -424,6 +519,8 @@ VSTPlugin::load_user_preset (PresetRecord r)
        return false;
 }
 
+#include "sha1.c"
+
 string
 VSTPlugin::do_save_preset (string name)
 {
@@ -432,9 +529,23 @@ VSTPlugin::do_save_preset (string name)
                return "";
        }
 
+       // prevent dups -- just in case
+       t->root()->remove_nodes_and_delete (X_("label"), name);
+
        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);
+
+       char tmp[32];
+       snprintf (tmp, 31, "%ld", _presets.size() + 1);
+       tmp[31] = 0;
+
+       char hash[41];
+       Sha1Digest s;
+       sha1_init (&s);
+       sha1_write (&s, (const uint8_t *) name.c_str(), name.size ());
+       sha1_write (&s, (const uint8_t *) tmp, strlen(tmp));
+       sha1_result_hash (&s, hash);
+
+       string const uri = string_compose (X_("VST:%1:x%2"), unique_id (), hash);
 
        if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
 
@@ -490,6 +601,11 @@ string
 VSTPlugin::describe_parameter (Evoral::Parameter param)
 {
        char name[64];
+       if (param.id() == UINT32_MAX - 1) {
+               strcpy (name, _("Plugin Enable"));
+               return name;
+       }
+
        memset (name, 0, sizeof (name));
 
        /* some VST plugins expect this buffer to be zero-filled */
@@ -510,7 +626,11 @@ VSTPlugin::signal_latency () const
                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>
@@ -527,10 +647,24 @@ VSTPlugin::automatable () const
 
 int
 VSTPlugin::connect_and_run (BufferSet& bufs,
+               framepos_t start, framepos_t end, double speed,
                ChanMapping in_map, ChanMapping out_map,
                pframes_t nframes, framecnt_t offset)
 {
-       Plugin::connect_and_run (bufs, in_map, out_map, nframes, offset);
+       Plugin::connect_and_run(bufs, start, end, speed, in_map, out_map, nframes, offset);
+
+       if (pthread_mutex_trylock (&_state->state_lock)) {
+               /* by convention 'effSetChunk' should not be called while processing
+                * http://www.reaper.fm/sdk/vst/vst_ext.php
+                *
+                * All VSTs don't use in-place, PluginInsert::connect_and_run()
+                * does clear output buffers, so we can just return.
+                */
+               return 0;
+       }
+
+       _transport_frame = start;
+       _transport_speed = speed;
 
        ChanCount bufs_count;
        bufs_count.set(DataType::AUDIO, 1);
@@ -569,8 +703,8 @@ VSTPlugin::connect_and_run (BufferSet& bufs,
                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);
+                       ? bufs.get_audio(index).data(offset)
+                       : scratch_bufs.get_audio(0).data(offset);
        }
 
        if (bufs.count().n_midi() > 0) {
@@ -597,6 +731,7 @@ VSTPlugin::connect_and_run (BufferSet& bufs,
        _plugin->processReplacing (_plugin, &ins[0], &outs[0], nframes);
        _midi_out_buf = 0;
 
+       pthread_mutex_unlock (&_state->state_lock);
        return 0;
 }
 
@@ -674,7 +809,7 @@ VSTPlugin::find_presets ()
 
        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);
+               PresetRecord r (string_compose (X_("VST:%1:%2"), unique_id (), i), "", false);
 
                if (vst_version >= 2) {
                        char buf[256];
@@ -698,13 +833,13 @@ 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);
 
-                       PresetRecord r (uri->value(), label->value(), -1, true);
+                       PresetRecord r (uri->value(), label->value(), true);
                        _presets.insert (make_pair (r.uri, r));
                }
        }