Do a topological sort of the route list before passing it to
[ardour.git] / libs / ardour / vst_plugin.cc
index 8f30ff98e929ff560b41467c5a91081f56d5b50d..869e5ad4f77c161f4227b7e77fa79e9d2cd79085 100644 (file)
@@ -63,7 +63,6 @@ using std::max;
 
 VSTPlugin::VSTPlugin (AudioEngine& e, Session& session, FSTHandle* h)
        : Plugin (e, session)
-       , _have_pending_stop_events (false)
 {
        handle = h;
 
@@ -90,7 +89,6 @@ VSTPlugin::VSTPlugin (AudioEngine& e, Session& session, FSTHandle* h)
 
 VSTPlugin::VSTPlugin (const VSTPlugin &other)
        : Plugin (other)
-       , _have_pending_stop_events (false)
 {
        handle = other.handle;
 
@@ -108,7 +106,7 @@ VSTPlugin::~VSTPlugin ()
        fst_close (_fst);
 }
 
-int 
+int
 VSTPlugin::set_block_size (pframes_t nframes)
 {
        deactivate ();
@@ -127,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
@@ -149,14 +155,14 @@ VSTPlugin::nth_parameter (uint32_t n, bool& ok) const
  *  @return 0-terminated base64-encoded data; must be passed to g_free () by caller.
  */
 gchar *
-VSTPlugin::get_chunk (bool single)
+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);
 }
 
@@ -175,10 +181,9 @@ VSTPlugin::set_chunk (gchar const * data, bool single)
        return r;
 }
 
-XMLNode&
-VSTPlugin::get_state()
+void
+VSTPlugin::add_state (XMLNode* root) const
 {
-       XMLNode *root = new XMLNode (state_node_name());
        LocaleGuard lg (X_("POSIX"));
 
        if (_fst->current_program != -1) {
@@ -191,7 +196,7 @@ VSTPlugin::get_state()
 
                gchar* data = get_chunk (false);
                if (data == 0) {
-                       return *root;
+                       return;
                }
 
                /* store information */
@@ -217,12 +222,10 @@ VSTPlugin::get_state()
 
                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"));
 
@@ -234,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;
@@ -277,6 +280,7 @@ VSTPlugin::set_state(const XMLNode& node, int)
 
        }
 
+       Plugin::set_state (node, version);
        return ret;
 }
 
@@ -355,99 +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 */) {
+       bool s;
 
-               XMLTree* t = presets_tree ();
-               if (t == 0) {
-                       return false;
-               }
+       if (r.user) {
+               s = load_user_preset (r);
+       } else {
+               s = load_plugin_preset (r);
+       }
 
-               XMLNode* root = t->root ();
+       if (s) {
+               Plugin::load_preset (r);
+       }
 
-               /* 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"));
+       return s;
+}
 
-                       assert (uri);
-                       assert (label);
+bool
+VSTPlugin::load_plugin_preset (PresetRecord r)
+{
+       /* This is a plugin-provided preset.
+          We can't dispatch directly here; too many plugins expects only one GUI thread.
+       */
 
-                       if (label->value() == name) {
+       /* 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);
 
-                               if (_fst->wanted_chunk) {
-                                       g_free (_fst->wanted_chunk);
+       _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;
+       }
+
+       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;
                                }
-                               
-                               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;
        }
 
-       return true;
+       return false;
 }
 
 string
 VSTPlugin::do_save_preset (string name)
 {
-       if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
+       boost::shared_ptr<XMLTree> t (presets_tree ());
+       if (t == 0) {
+               return "";
+       }
 
-               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);
 
-               /* Add a chunk to our XML file of user presets */
+       if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
 
-               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 = 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);
-               t->root()->add_child_nocopy (*p);
 
-               sys::path f = ARDOUR::user_config_directory ();
-               f /= "presets";
-               f /= "vst";
+       } 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->write (f.to_string ());
-               delete t;
-               return uri;
        }
 
-       return "";
+       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)
 {
-       if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
-
-               /* XXX: TODO */
-               
-               error << _("no support for presets using chunks at this time")
-                     << endmsg;
+       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
@@ -489,6 +567,8 @@ 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);
+
        float *ins[_plugin->numInputs];
        float *outs[_plugin->numOutputs];
        int32_t i;
@@ -516,24 +596,11 @@ VSTPlugin::connect_and_run (BufferSet& bufs,
 
 
        if (bufs.count().n_midi() > 0) {
-
-               /* Track notes that we are sending to the plugin */
-               MidiBuffer& b = bufs.get_midi (0);
-               bool looped;
-               _tracker.track (b.begin(), b.end(), looped);
-               
-               if (_have_pending_stop_events) {
-                       /* Transmit note-offs that are pending from the last transport stop */
-                       bufs.merge_from (_pending_stop_events, 0);
-                       _have_pending_stop_events = false;
-               }
-               
                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);
 
        return 0;
@@ -647,54 +714,48 @@ VSTPluginInfo::load (Session& session)
        }
 }
 
-vector<Plugin::PresetRecord>
-VSTPlugin::get_presets ()
+void
+VSTPlugin::find_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), "");
-               
+               PresetRecord r (string_compose (X_("VST:%1:%2"), unique_id (), i), "", false);
+
                if (vst_version >= 2) {
                        char buf[256];
-                       _plugin->dispatcher (_plugin, 29, i, 0, buf, 0);
-                       r.label = buf;
+                       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 ();
+       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) {
 
-                       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);
+                       PresetRecord r (uri->value(), label->value(), true);
                        _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
@@ -712,13 +773,13 @@ VSTPlugin::presets_tree () const
                create_directory (p);
        }
 
-       p /= "vst";
+       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;
@@ -735,20 +796,14 @@ VSTPlugin::first_user_preset_index () const
        return _plugin->numPrograms;
 }
 
-void
-VSTPlugin::realtime_handle_transport_stopped ()
+string
+VSTPlugin::presets_file () const
 {
-       /* Create note-offs for any active notes and put them in _pending_stop_events, to be picked
-          up on the next call to connect_and_run ().
-       */
-       
-       _pending_stop_events.ensure_buffers (DataType::MIDI, 1, 4096);
-       _pending_stop_events.get_midi(0).clear ();
-       _tracker.resolve_notes (_pending_stop_events.get_midi (0), 0);
-       _have_pending_stop_events = true;
+       return string_compose ("vst-%1", unique_id ());
 }
 
 VSTPluginInfo::VSTPluginInfo()
 {
        type = ARDOUR::VST;
 }
+