More complete (but still incomplete) LV2 persist implementation.
[ardour.git] / libs / ardour / vst_plugin.cc
index ee3ebd2ee3f2d83f2949152176781529cbebe4ce..e77fc483ed0fd2e6155c1718fe76f2c08622b8f7 100644 (file)
@@ -30,7 +30,6 @@
 #include <sys/stat.h>
 #include <cerrno>
 
-#include <glibmm/ustring.h>
 #include <glibmm/miscutils.h>
 
 #include <lrdf.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;
@@ -102,16 +103,16 @@ VSTPlugin::VSTPlugin (const VSTPlugin &other)
 VSTPlugin::~VSTPlugin ()
 {
        deactivate ();
-       drop_references ();
        fst_close (_fst);
 }
 
-void
-VSTPlugin::set_block_size (nframes_t nframes)
+int 
+VSTPlugin::set_block_size (pframes_t nframes)
 {
        deactivate ();
        _plugin->dispatcher (_plugin, effSetBlockSize, 0, nframes, NULL, 0.0f);
        activate ();
+        return 0;
 }
 
 float
@@ -141,6 +142,37 @@ VSTPlugin::nth_parameter (uint32_t n, bool& ok) const
        return n;
 }
 
+/** 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)
+{
+       guchar* data;
+       int32_t data_size = _plugin->dispatcher (_plugin, 23 /* effGetChunk */, single ? 1 : 0, 0, &data, 0);
+       if (data_size == 0) {
+               return 0;
+       }
+       
+       return g_base64_encode (data, data_size);
+}
+
+/** 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;
+}
+
 XMLNode&
 VSTPlugin::get_state()
 {
@@ -155,12 +187,8 @@ VSTPlugin::get_state()
 
        if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
 
-               /* fetch the current chunk */
-
-               guchar* data;
-               long  data_size;
-
-               if ((data_size = _plugin->dispatcher (_plugin, 23 /* effGetChunk */, 0, 0, &data, false)) == 0) {
+               gchar* data = get_chunk (false);
+               if (data == 0) {
                        return *root;
                }
 
@@ -168,9 +196,8 @@ VSTPlugin::get_state()
 
                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);
 
@@ -178,10 +205,10 @@ VSTPlugin::get_state()
 
                XMLNode* parameters = new XMLNode ("parameters");
 
-               for (long n = 0; n < _plugin->numParams; ++n) {
+               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);
                }
@@ -193,7 +220,7 @@ VSTPlugin::get_state()
 }
 
 int
-VSTPlugin::set_state(const XMLNode& node)
+VSTPlugin::set_state(const XMLNode& node, int)
 {
        LocaleGuard lg (X_("POSIX"));
 
@@ -205,7 +232,7 @@ VSTPlugin::set_state(const XMLNode& node)
        const XMLProperty* prop;
 
        if ((prop = node.property ("current-program")) != 0) {
-               _fst->current_program = atoi (prop->value());
+               _fst->current_program = atoi (prop->value().c_str());
        }
 
        XMLNode* child;
@@ -219,11 +246,10 @@ VSTPlugin::set_state(const XMLNode& node)
 
                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);
                        }
                }
 
@@ -232,10 +258,10 @@ VSTPlugin::set_state(const XMLNode& node)
                XMLPropertyList::const_iterator i;
 
                for (i = child->properties().begin(); i != child->properties().end(); ++i) {
-                       long param;
+                       int32_t param;
                        float val;
 
-                       sscanf ((*i)->name().c_str(), "param_%ld", &param);
+                       sscanf ((*i)->name().c_str(), "param_%d", &param);
                        sscanf ((*i)->value().c_str(), "%f", &val);
 
                        _plugin->setParameter (_plugin, param, val);
@@ -327,25 +353,107 @@ VSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc)
 }
 
 bool
-VSTPlugin::load_preset (string name)
+VSTPlugin::load_preset (const string& name)
 {
        if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
-               error << _("no support for presets using chunks at this time")
-                     << endmsg;
+
+               XMLTree* t = presets_tree ();
+               if (t == 0) {
+                       return false;
+               }
+
+               XMLNode* root = t->root ();
+
+               /* Load a user preset chunk from our XML file and send it via a circuitous route to the plugin */
+               
+               for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
+                       assert ((*i)->name() == X_("ChunkPreset"));
+                       
+                       XMLProperty* uri = (*i)->property (X_("uri"));
+                       XMLProperty* label = (*i)->property (X_("label"));
+
+                       assert (uri);
+                       assert (label);
+
+                       if (label->value() == name) {
+
+                               if (_fst->wanted_chunk) {
+                                       g_free (_fst->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);
+                                               _fst->wanted_chunk = raw_data;
+                                               _fst->wanted_chunk_size = size;
+                                               _fst->want_chunk = 1;
+                                               return true;
+                                       }
+                               }
+                       }
+               }
+               
                return false;
        }
-       return Plugin::load_preset (name);
+
+       return true;
 }
 
-bool
-VSTPlugin::save_preset (string name)
+string
+VSTPlugin::do_save_preset (string name)
 {
        if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
-               error << _("no support for presets using chunks at this time")
-                     << endmsg;
-               return false;
+
+               XMLTree* t = presets_tree ();
+               if (t == 0) {
+                       return "";
+               }
+
+               /* Add a chunk to our XML file of user presets */
+
+               XMLNode* p = new XMLNode (X_("ChunkPreset"));
+               /* 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);
+               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);
+               t->root()->add_child_nocopy (*p);
+
+               sys::path f = ARDOUR::user_config_directory ();
+               f /= "presets";
+               f /= "vst";
+
+               t->write (f.to_string ());
+               delete t;
+               return uri;
+       }
+
+       return "";
+}
+
+void
+VSTPlugin::do_remove_preset (string name)
+{
+       if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
+
+               XMLTree* t = presets_tree ();
+               if (t == 0) {
+                       return;
+               }
+
+               t->root()->remove_nodes_and_delete (X_("label"), name);
+
+               sys::path f = ARDOUR::user_config_directory ();
+               f /= "presets";
+               f /= "vst";
+
+               t->write (f.to_string ());
+               delete t;
        }
-       return Plugin::save_preset (name, "vst");
 }
 
 string
@@ -356,7 +464,7 @@ VSTPlugin::describe_parameter (Evoral::Parameter param)
        return name;
 }
 
-nframes_t
+framecnt_t
 VSTPlugin::signal_latency () const
 {
        if (_user_latency) {
@@ -364,7 +472,7 @@ VSTPlugin::signal_latency () const
        }
 
 #ifdef VESTIGE_HEADER
-        return *((nframes_t *) (((char *) &_plugin->flags) + 12)); /* initialDelay */
+        return *((framecnt_t *) (((char *) &_plugin->flags) + 12)); /* initialDelay */
 #else
        return _plugin->initial_delay;
 #endif
@@ -385,19 +493,23 @@ VSTPlugin::automatable () const
 int
 VSTPlugin::connect_and_run (BufferSet& bufs,
                ChanMapping in_map, ChanMapping out_map,
-               nframes_t nframes, nframes_t offset)
+               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;
 
        const uint32_t nbufs = bufs.count().n_audio();
 
+       int 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++;
        }
 
+       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;
 
@@ -411,6 +523,11 @@ VSTPlugin::connect_and_run (BufferSet& bufs,
        }
 
 
+       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);
@@ -453,7 +570,7 @@ VSTPlugin::name () const
 const char *
 VSTPlugin::maker () const
 {
-       return "imadeit";
+       return _info->creator.c_str();
 }
 
 const char *
@@ -525,3 +642,99 @@ VSTPluginInfo::load (Session& session)
                return PluginPtr ((Plugin*) 0);
        }
 }
+
+vector<Plugin::PresetRecord>
+VSTPlugin::get_presets ()
+{
+       vector<PresetRecord> p;
+
+       /* Built-in 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), "");
+               
+               if (vst_version >= 2) {
+                       char buf[256];
+                       if (_plugin->dispatcher (_plugin, 29, i, 0, buf, 0) == 1) {
+                               r.label = buf;
+                       } else {
+                               r.label = string_compose (_("Preset %1"), i);
+                       }
+               } else {
+                       r.label = string_compose (_("Preset %1"), i);
+               }
+
+               p.push_back (r);
+               _presets.insert (make_pair (r.uri, r));
+       }
+
+       /* User presets from our XML file */
+
+       XMLTree* t = presets_tree ();
+
+       if (t) {
+               XMLNode* root = t->root ();
+               for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
+
+                       assert ((*i)->name() == X_("ChunkPreset"));
+                       
+                       XMLProperty* uri = (*i)->property (X_("uri"));
+                       XMLProperty* label = (*i)->property (X_("label"));
+
+                       assert (uri);
+                       assert (label);
+
+                       PresetRecord r (uri->value(), label->value());
+                       p.push_back (r);
+                       _presets.insert (make_pair (r.uri, r));
+               }
+       }
+
+       delete t;
+               
+       return p;
+}
+
+/** @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;
+
+       sys::path p = ARDOUR::user_config_directory ();
+       p /= "presets";
+
+       if (!is_directory (p)) {
+               create_directory (p);
+       }
+
+       p /= "vst";
+
+       if (!exists (p)) {
+               t->set_root (new XMLNode (X_("VSTPresets")));
+               return t;
+       }
+       
+       t->set_filename (p.to_string ());
+       if (!t->read ()) {
+               delete t;
+               return 0;
+       }
+
+       return t;
+}
+
+/** @return Index of the first user preset in our lists */
+int
+VSTPlugin::first_user_preset_index () const
+{
+       return _plugin->numPrograms;
+}
+
+VSTPluginInfo::VSTPluginInfo()
+{
+       type = ARDOUR::VST;
+}