Add a missing #define to our MSVC project (portaudio_backend)
[ardour.git] / libs / ardour / vst_plugin.cc
index df93250e180a5fdd39e8a6c2e7bc3d8d66df4d78..2b3a98d3c85c8292ab7addcb5a6c0807356a5bf2 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"
-#include "pbd/pathscanner.h"
 
 #include "ardour/vst_plugin.h"
 #include "ardour/vestige/aeffectx.h"
@@ -34,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;
@@ -45,13 +45,32 @@ 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)
 {
-       
+       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)
+{
+       memset (&_timeInfo, 0, sizeof(_timeInfo));
 }
 
 VSTPlugin::~VSTPlugin ()
 {
-       
+
 }
 
 void
@@ -78,7 +97,7 @@ VSTPlugin::activate ()
        _plugin->dispatcher (_plugin, effMainsChanged, 0, 1, NULL, 0.0f);
 }
 
-int 
+int
 VSTPlugin::set_block_size (pframes_t nframes)
 {
        deactivate ();
@@ -88,18 +107,18 @@ 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 
+float
 VSTPlugin::get_parameter (uint32_t which) const
 {
        return _plugin->getParameter (_plugin, which);
 }
 
-void 
+void
 VSTPlugin::set_parameter (uint32_t which, float newval)
 {
        float oldval = get_parameter (which);
@@ -109,7 +128,7 @@ VSTPlugin::set_parameter (uint32_t which, float newval)
        }
 
        _plugin->setParameter (_plugin, which, newval);
-       
+
        float curval = get_parameter (which);
 
        if (!PBD::floateq (curval, oldval, 1)) {
@@ -150,8 +169,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;
 }
@@ -159,7 +183,7 @@ VSTPlugin::set_chunk (gchar const * data, bool single)
 void
 VSTPlugin::add_state (XMLNode* root) const
 {
-       LocaleGuard lg (X_("POSIX"));
+       LocaleGuard lg;
 
        if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
 
@@ -196,7 +220,7 @@ 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()) {
@@ -215,8 +239,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);
                        }
                }
@@ -250,6 +274,7 @@ 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;
@@ -257,6 +282,7 @@ VSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc)
        if (_plugin->dispatcher (_plugin, effGetParameterProperties, which, 0, &prop, 0)) {
 
                /* 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;
@@ -287,10 +313,14 @@ 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;
+               desc.label = Glib::locale_to_utf8 (prop.label);
 
        } else {
 
@@ -301,8 +331,8 @@ VSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc)
                memset (label, 0, sizeof (label));
 
                _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;
@@ -314,6 +344,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;
 }
 
@@ -335,7 +370,7 @@ VSTPlugin::load_preset (PresetRecord r)
        return s;
 }
 
-bool 
+bool
 VSTPlugin::load_plugin_preset (PresetRecord r)
 {
        /* This is a plugin-provided preset.
@@ -348,15 +383,15 @@ 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;
+       LoadPresetProgram (); /* EMIT SIGNAL */ /* used for macvst */
        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
@@ -371,7 +406,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);
 
@@ -395,6 +430,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;
                                }
                        }
@@ -402,11 +438,11 @@ VSTPlugin::load_user_preset (PresetRecord r)
                        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"));
+                                               XMLProperty const * index = (*j)->property (X_("index"));
+                                               XMLProperty const * value = (*j)->property (X_("value"));
 
                                                assert (index);
                                                assert (value);
@@ -420,7 +456,9 @@ VSTPlugin::load_user_preset (PresetRecord r)
        return false;
 }
 
-string 
+#include "sha1.c"
+
+string
 VSTPlugin::do_save_preset (string name)
 {
        boost::shared_ptr<XMLTree> t (presets_tree ());
@@ -428,9 +466,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 */) {
 
@@ -466,7 +518,7 @@ VSTPlugin::do_save_preset (string name)
        return uri;
 }
 
-void 
+void
 VSTPlugin::do_remove_preset (string name)
 {
        boost::shared_ptr<XMLTree> t (presets_tree ());
@@ -482,11 +534,11 @@ VSTPlugin::do_remove_preset (string name)
        t->write (f);
 }
 
-string 
+string
 VSTPlugin::describe_parameter (Evoral::Parameter param)
 {
        char name[64];
-       memset (name, sizeof (name), 0);
+       memset (name, 0, sizeof (name));
 
        /* some VST plugins expect this buffer to be zero-filled */
 
@@ -499,17 +551,21 @@ VSTPlugin::describe_parameter (Evoral::Parameter param)
        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;
@@ -523,83 +579,139 @@ VSTPlugin::automatable () const
 
 int
 VSTPlugin::connect_and_run (BufferSet& bufs,
-                           ChanMapping in_map, ChanMapping out_map,
-                           pframes_t nframes, framecnt_t offset)
-{
-       Plugin::connect_and_run (bufs, in_map, out_map, nframes, offset);
+               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, 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);
+       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
+
+          typeName foo[variableDefiningSize];
+
+          Use alloca instead of dynamic array (rather than std::vector which
+          allocs on the heap) because this is realtime code.
+       */
 
-       // VC++ doesn't support this C99 extension. Use alloca instead of dynamic array (rather than std::vector which allocs on the heap)
        float** ins = (float**)alloca(_plugin->numInputs*sizeof(float*));
-       float** outs = (float**)alloca(_plugin->numInputs*sizeof(float*));
-       int32_t i;
+       float** outs = (float**)alloca(_plugin->numOutputs*sizeof(float*));
 
-       const uint32_t nbufs = bufs.count().n_audio();
+       int32_t i;
 
-       int in_index = 0;
+       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[0], &outs[0], nframes);
+       _midi_out_buf = 0;
 
+       pthread_mutex_unlock (&_state->state_lock);
        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;
@@ -629,7 +741,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];
@@ -653,13 +765,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));
                }
        }