Do a topological sort of the route list before passing it to
[ardour.git] / libs / ardour / vst_plugin.cc
index d805a2feec0fa9ff2b3c791d3cda9103e7ec24a4..869e5ad4f77c161f4227b7e77fa79e9d2cd79085 100644 (file)
@@ -106,8 +106,8 @@ VSTPlugin::~VSTPlugin ()
        fst_close (_fst);
 }
 
-int 
-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);
@@ -125,7 +125,15 @@ void
 VSTPlugin::set_parameter (uint32_t which, float val)
 {
        _plugin->setParameter (_plugin, which, val);
-       //ParameterChanged (which, val); /* EMIT SIGNAL */
+
+       if (_fst->want_program == -1 && _fst->want_chunk == 0) {
+               /* Heinous hack: Plugin::set_parameter below updates the `modified' status of the
+                  current preset, but if _fst->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 _fst->want_program is -1.
+               */
+               Plugin::set_parameter (which, val);
+       }
 }
 
 float
@@ -142,10 +150,40 @@ VSTPlugin::nth_parameter (uint32_t n, bool& ok) const
        return n;
 }
 
-XMLNode&
-VSTPlugin::get_state()
+/** 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) const
+{
+       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;
+}
+
+void
+VSTPlugin::add_state (XMLNode* root) const
 {
-       XMLNode *root = new XMLNode (state_node_name());
        LocaleGuard lg (X_("POSIX"));
 
        if (_fst->current_program != -1) {
@@ -156,22 +194,17 @@ VSTPlugin::get_state()
 
        if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
 
-               /* fetch the current chunk */
-
-               guchar* data;
-                int32_t data_size;
-
-               if ((data_size = _plugin->dispatcher (_plugin, 23 /* effGetChunk */, 0, 0, &data, false)) == 0) {
-                       return *root;
+               gchar* data = get_chunk (false);
+               if (data == 0) {
+                       return;
                }
 
                /* store information */
 
                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);
 
@@ -182,19 +215,17 @@ VSTPlugin::get_state()
                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);
                }
 
                root->add_child_nocopy (*parameters);
        }
-
-       return *root;
 }
 
 int
-VSTPlugin::set_state(const XMLNode& node, int)
+VSTPlugin::set_state (const XMLNode& node, int version)
 {
        LocaleGuard lg (X_("POSIX"));
 
@@ -206,7 +237,7 @@ VSTPlugin::set_state(const XMLNode& node, int)
        const XMLProperty* prop;
 
        if ((prop = node.property ("current-program")) != 0) {
-               _fst->current_program = atoi (prop->value().c_str());
+               _fst->want_program = atoi (prop->value().c_str());
        }
 
        XMLNode* child;
@@ -220,11 +251,10 @@ VSTPlugin::set_state(const XMLNode& node, int)
 
                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);
                        }
                }
 
@@ -250,6 +280,7 @@ VSTPlugin::set_state(const XMLNode& node, int)
 
        }
 
+       Plugin::set_state (node, version);
        return ret;
 }
 
@@ -328,25 +359,173 @@ VSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc)
 }
 
 bool
-VSTPlugin::load_preset (const string& name)
+VSTPlugin::load_preset (PresetRecord r)
 {
-       if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
-               error << _("no support for presets using chunks at this time")
-                     << endmsg;
-               return false;
+       bool s;
+
+       if (r.user) {
+               s = load_user_preset (r);
+       } else {
+               s = load_plugin_preset (r);
+       }
+
+       if (s) {
+               Plugin::load_preset (r);
        }
-       return Plugin::load_preset (name);
+
+       return s;
 }
 
 bool
-VSTPlugin::save_preset (string name)
+VSTPlugin::load_plugin_preset (PresetRecord r)
 {
-       if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
-               error << _("no support for presets using chunks at this time")
-                     << endmsg;
+       /* This is a plugin-provided preset.
+          We can't dispatch directly here; too many plugins expects only one GUI thread.
+       */
+
+       /* Extract the index of this preset from the URI */
+       int id;
+       int index;
+       int const p = sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
+       assert (p == 2);
+
+       _fst->want_program = index;
+       return true;
+}
+
+bool
+VSTPlugin::load_user_preset (PresetRecord r)
+{
+       /* This is a user preset; we load it, and this code also knows about the
+          non-direct-dispatch thing.
+       */
+
+       boost::shared_ptr<XMLTree> t (presets_tree ());
+       if (t == 0) {
                return false;
        }
-       return Plugin::save_preset (name, "vst");
+
+       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"));
+
+               assert (uri);
+               assert (label);
+
+               if (label->value() != r.label) {
+                       continue;
+               }
+
+               if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
+
+                       /* Load a user preset chunk from our XML file and send it via a circuitous route to the plugin */
+
+                       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;
+
+               } 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"));
+
+                                               assert (index);
+                                               assert (value);
+
+                                               set_parameter (atoi (index->value().c_str()), atof (value->value().c_str ()));
+                               }
+                       }
+
+                       return true;
+               }
+       }
+
+       return false;
+}
+
+string
+VSTPlugin::do_save_preset (string name)
+{
+       boost::shared_ptr<XMLTree> t (presets_tree ());
+       if (t == 0) {
+               return "";
+       }
+
+       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);
+
+       if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
+
+               p = new XMLNode (X_("ChunkPreset"));
+               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);
+
+       } else {
+
+               p = new XMLNode (X_("Preset"));
+               p->add_property (X_("uri"), uri);
+               p->add_property (X_("label"), name);
+
+               for (uint32_t i = 0; i < parameter_count(); ++i) {
+                       if (parameter_is_input (i)) {
+                               XMLNode* c = new XMLNode (X_("Parameter"));
+                               c->add_property (X_("index"), string_compose ("%1", i));
+                               c->add_property (X_("value"), string_compose ("%1", get_parameter (i)));
+                               p->add_child_nocopy (*c);
+                       }
+               }
+
+       }
+
+       t->root()->add_child_nocopy (*p);
+
+       sys::path f = ARDOUR::user_config_directory ();
+       f /= "presets";
+       f /= presets_file ();
+
+       t->write (f.to_string ());
+       return uri;
+}
+
+void
+VSTPlugin::do_remove_preset (string name)
+{
+       boost::shared_ptr<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 /= presets_file ();
+
+       t->write (f.to_string ());
 }
 
 string
@@ -357,7 +536,7 @@ VSTPlugin::describe_parameter (Evoral::Parameter param)
        return name;
 }
 
-nframes_t
+framecnt_t
 VSTPlugin::signal_latency () const
 {
        if (_user_latency) {
@@ -365,7 +544,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
@@ -386,8 +565,10 @@ 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;
@@ -420,7 +601,6 @@ VSTPlugin::connect_and_run (BufferSet& bufs,
        }
 
        /* we already know it can support processReplacing */
-
        _plugin->processReplacing (_plugin, ins, outs, nframes);
 
        return 0;
@@ -461,7 +641,7 @@ VSTPlugin::name () const
 const char *
 VSTPlugin::maker () const
 {
-       return "imadeit";
+       return _info->creator.c_str();
 }
 
 const char *
@@ -534,7 +714,96 @@ VSTPluginInfo::load (Session& session)
        }
 }
 
+void
+VSTPlugin::find_presets ()
+{
+       /* 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), "", false);
+
+               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);
+               }
+
+               _presets.insert (make_pair (r.uri, r));
+       }
+
+       /* User presets from our XML file */
+
+       boost::shared_ptr<XMLTree> t (presets_tree ());
+
+       if (t) {
+               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"));
+
+                       assert (uri);
+                       assert (label);
+
+                       PresetRecord r (uri->value(), label->value(), true);
+                       _presets.insert (make_pair (r.uri, r));
+               }
+       }
+
+}
+
+/** @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 /= presets_file ();
+
+       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;
+}
+
+string
+VSTPlugin::presets_file () const
+{
+       return string_compose ("vst-%1", unique_id ());
+}
+
 VSTPluginInfo::VSTPluginInfo()
 {
        type = ARDOUR::VST;
 }
+