switch to using boost::signals2 instead of sigc++, at least for libardour. not finish...
[ardour.git] / libs / ardour / plugin_insert.cc
index 8f7eae58493cb2d1dcc12d6597c33e086ee289e9..c2bf7f3562728389ecb773b73ee9b7fa55bc1e59 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000 Paul Davis 
+    Copyright (C) 2000 Paul Davis
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -23,7 +23,6 @@
 
 #include <string>
 
-#include <sigc++/bind.h>
 
 #include "pbd/failed_constructor.h"
 #include "pbd/xml++.h"
@@ -70,8 +69,7 @@ PluginInsert::PluginInsert (Session& s, boost::shared_ptr<Plugin> plug)
        /* the first is the master */
 
        _plugins.push_back (plug);
-
-       init ();
+       set_automatable ();
 
        {
                Glib::Mutex::Lock em (_session.engine().process_lock());
@@ -86,14 +84,11 @@ PluginInsert::PluginInsert (Session& s, const XMLNode& node)
           _signal_analysis_collected_nframes(0),
           _signal_analysis_collect_nframes_max(0)
 {
-       if (set_state (node)) {
+       if (set_state (node, Stateful::loading_state_version)) {
                throw failed_constructor();
        }
 
-       // XXX: This would dump all automation, which has already been loaded by
-       //      Processor. But this could also have been related to the Parameter change..
-       //      will look into this later.
-       //set_automatable ();
+       _pending_active = _active;
 
        {
                Glib::Mutex::Lock em (_session.engine().process_lock());
@@ -107,10 +102,10 @@ PluginInsert::set_count (uint32_t num)
        bool require_state = !_plugins.empty();
 
        /* this is a bad idea.... we shouldn't do this while active.
-          only a route holding their redirect_lock should be calling this 
+          only a route holding their redirect_lock should be calling this
        */
 
-       if (num == 0) { 
+       if (num == 0) {
                return false;
        } else if (num > _plugins.size()) {
                uint32_t diff = num - _plugins.size();
@@ -133,15 +128,9 @@ PluginInsert::set_count (uint32_t num)
        return true;
 }
 
-void
-PluginInsert::init ()
-{
-       set_automatable ();
-}
-
 PluginInsert::~PluginInsert ()
 {
-       GoingAway (); /* EMIT SIGNAL */
+       drop_references ();
 }
 
 void
@@ -176,7 +165,7 @@ ChanCount
 PluginInsert::input_streams() const
 {
        ChanCount in = _plugins[0]->get_info()->n_inputs;
-       
+
        if (in == ChanCount::INFINITE) {
                return _plugins[0]->input_streams ();
        } else {
@@ -256,6 +245,8 @@ PluginInsert::set_block_size (nframes_t nframes)
 void
 PluginInsert::activate ()
 {
+       Processor::activate ();
+
        for (Plugins::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
                (*i)->activate ();
        }
@@ -264,6 +255,8 @@ PluginInsert::activate ()
 void
 PluginInsert::deactivate ()
 {
+       Processor::deactivate ();
+
        for (Plugins::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
                (*i)->deactivate ();
        }
@@ -289,22 +282,22 @@ PluginInsert::connect_and_run (BufferSet& bufs, nframes_t nframes, nframes_t off
        if (with_auto) {
 
                uint32_t n = 0;
-               
+
                for (Controls::iterator li = data().controls().begin(); li != data().controls().end(); ++li, ++n) {
-                       
+
                        boost::shared_ptr<AutomationControl> c
                                = boost::dynamic_pointer_cast<AutomationControl>(li->second);
 
                        if (c->parameter().type() == PluginAutomation && c->automation_playback()) {
                                bool valid;
 
-                               const float val = c->list()->rt_safe_eval (now, valid);                         
+                               const float val = c->list()->rt_safe_eval (now, valid);
 
                                if (valid) {
                                        c->set_value(val);
                                }
 
-                       } 
+                       }
                }
        }
 
@@ -322,7 +315,7 @@ PluginInsert::connect_and_run (BufferSet& bufs, nframes_t nframes, nframes_t off
                                collect_signal_nframes,
                                _signal_analysis_collected_nframes); // offset is for target buffer
                }
-               
+
        }
 
        for (Plugins::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
@@ -342,8 +335,8 @@ PluginInsert::connect_and_run (BufferSet& bufs, nframes_t nframes, nframes_t off
 
                for (uint32_t i = 0; i < output_streams().n_audio(); ++i) {
                        _signal_analysis_outputs.get_audio(i).read_from(
-                               bufs.get_audio(i), 
-                               collect_signal_nframes, 
+                               bufs.get_audio(i),
+                               collect_signal_nframes,
                                _signal_analysis_collected_nframes); // offset is for target buffer
                }
 
@@ -354,7 +347,7 @@ PluginInsert::connect_and_run (BufferSet& bufs, nframes_t nframes, nframes_t off
                        _signal_analysis_collect_nframes_max = 0;
                        _signal_analysis_collected_nframes   = 0;
 
-                       AnalysisDataGathered(&_signal_analysis_inputs, 
+                       AnalysisDataGathered(&_signal_analysis_inputs,
                                             &_signal_analysis_outputs);
                }
        }
@@ -373,9 +366,9 @@ PluginInsert::silence (nframes_t nframes)
                }
        }
 }
-       
+
 void
-PluginInsert::run (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nframes_t nframes)
+PluginInsert::run (BufferSet& bufs, sframes_t /*start_frame*/, sframes_t /*end_frame*/, nframes_t nframes, bool)
 {
        if (_active || _pending_active) {
 
@@ -395,7 +388,7 @@ PluginInsert::run (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame,
                if (out > in) {
 
                        /* not active, but something has make up for any channel count increase */
-                       
+
                        for (uint32_t n = out - in; n < out; ++n) {
                                memcpy (bufs.get_audio(n).data(), bufs.get_audio(in - 1).data(), sizeof (Sample) * nframes);
                        }
@@ -416,10 +409,10 @@ PluginInsert::set_parameter (Evoral::Parameter param, float val)
        /* the others will be set from the event triggered by this */
 
        _plugins[0]->set_parameter (param.id(), val);
-       
+
        boost::shared_ptr<AutomationControl> ac
                        = boost::dynamic_pointer_cast<AutomationControl>(data().control(param));
-       
+
        if (ac) {
                ac->set_value(val);
        } else {
@@ -454,36 +447,36 @@ PluginInsert::automation_run (BufferSet& bufs, nframes_t nframes)
                connect_and_run (bufs, nframes, offset, false);
                return;
        }
-       
+
        if (!data().find_next_event (now, end, next_event)) {
-               
-               /* no events have a time within the relevant range */
-               
-               connect_and_run (bufs, nframes, offset, true, now);
-               return;
-       }
-       
-       while (nframes) {
+
+               /* no events have a time within the relevant range */
+
+               connect_and_run (bufs, nframes, offset, true, now);
+               return;
+       }
+
+       while (nframes) {
 
                nframes_t cnt = min (((nframes_t) ceil (next_event.when) - now), nframes);
-  
-               connect_and_run (bufs, cnt, offset, true, now);
-               
-               nframes -= cnt;
-               offset += cnt;
+
+               connect_and_run (bufs, cnt, offset, true, now);
+
+               nframes -= cnt;
+               offset += cnt;
                now += cnt;
 
                if (!data().find_next_event (now, end, next_event)) {
                        break;
                }
-       }
-  
-       /* cleanup anything that is left to do */
-  
-       if (nframes) {
-               connect_and_run (bufs, nframes, offset, true, now);
-       }
-}      
+       }
+
+       /* cleanup anything that is left to do */
+
+       if (nframes) {
+               connect_and_run (bufs, nframes, offset, true, now);
+       }
+}
 
 float
 PluginInsert::default_parameter_value (const Evoral::Parameter& param)
@@ -557,11 +550,11 @@ PluginInsert::configure_io (ChanCount in, ChanCount out)
 
        // we don't know the analysis window size, so we must work with the
        // current buffer size here. each request for data fills in these
-       // buffers and the analyser makes sure it gets enough data for the 
+       // buffers and the analyser makes sure it gets enough data for the
        // analysis window
        session().ensure_buffer_set (_signal_analysis_inputs, in);
        //_signal_analysis_inputs.set_count (in);
-       
+
        session().ensure_buffer_set (_signal_analysis_outputs, out);
        //_signal_analysis_outputs.set_count (out);
 
@@ -601,12 +594,12 @@ PluginInsert::can_support_io_configuration (const ChanCount& in, ChanCount& out)
                } else if (inputs.get(*t) >= in.get(*t)) {
                        can_replicate = false;
                        break;
-               
+
                // Plugin inputs is not a factor of requested inputs, can not replicate
                } else if (inputs.get(*t) == 0 || in.get(*t) % inputs.get(*t) != 0) {
                        can_replicate = false;
                        break;
-               
+
                // Potential factor not set yet
                } else if (f == 0) {
                        f = in.get(*t) / inputs.get(*t);;
@@ -633,7 +626,7 @@ PluginInsert::can_support_io_configuration (const ChanCount& in, ChanCount& out)
  * (private helper)
  */
 int32_t
-PluginInsert::count_for_configuration (ChanCount in, ChanCount out) const
+PluginInsert::count_for_configuration (ChanCount in, ChanCount /*out*/) const
 {
        if (_plugins.front()->reconfigurable_io()) {
                /* plugin has flexible I/O, so the answer is always 1 */
@@ -642,7 +635,7 @@ PluginInsert::count_for_configuration (ChanCount in, ChanCount out) const
        }
 
        // FIXME: take 'out' into consideration
-       
+
        ChanCount outputs = _plugins[0]->get_info()->n_outputs;
        ChanCount inputs = _plugins[0]->get_info()->n_inputs;
 
@@ -691,9 +684,9 @@ PluginInsert::state (bool full)
        node.add_child_nocopy (_plugins[0]->get_state());
 
        /* add port automation state */
-       //XMLNode *autonode = new XMLNode(port_automation_node_name);
+       XMLNode *autonode = new XMLNode(port_automation_node_name);
        set<Evoral::Parameter> automatable = _plugins[0]->automatable();
-       
+
        for (set<Evoral::Parameter>::iterator x = automatable.begin(); x != automatable.end(); ++x) {
                
                /*XMLNode* child = new XMLNode("port");
@@ -703,16 +696,16 @@ PluginInsert::state (bool full)
                child->add_child_nocopy (automation_list (*x).state (full));
                autonode->add_child_nocopy (*child);
                */
-               //autonode->add_child_nocopy (((AutomationList*)data().control(*x)->list().get())->state (full));
+               autonode->add_child_nocopy (((AutomationList*)data().control(*x)->list().get())->state (full));
        }
 
-       //node.add_child_nocopy (*autonode);
-       
+       node.add_child_nocopy (*autonode);
+
        return node;
 }
 
 int
-PluginInsert::set_state(const XMLNode& node)
+PluginInsert::set_state(const XMLNode& node, int version)
 {
        XMLNodeList nlist = node.children();
        XMLNodeIterator niter;
@@ -721,7 +714,7 @@ PluginInsert::set_state(const XMLNode& node)
        ARDOUR::PluginType type;
 
        if ((prop = node.property ("type")) == 0) {
-               error << _("XML node describing insert is missing the `type' field") << endmsg;
+               error << _("XML node describing plugin is missing the `type' field") << endmsg;
                return -1;
        }
 
@@ -731,65 +724,166 @@ PluginInsert::set_state(const XMLNode& node)
                type = ARDOUR::LV2;
        } else if (prop->value() == X_("vst")) {
                type = ARDOUR::VST;
+       } else if (prop->value() == X_("audiounit")) {
+               type = ARDOUR::AudioUnit;
        } else {
                error << string_compose (_("unknown plugin type %1 in plugin insert state"),
                                  prop->value())
                      << endmsg;
                return -1;
        }
-       
+
        prop = node.property ("unique-id");
+
        if (prop == 0) {
-               error << _("Plugin has no unique ID field") << endmsg;
-               return -1;
+#ifdef VST_SUPPORT
+               /* older sessions contain VST plugins with only an "id" field.
+                */
+               
+               if (type == ARDOUR::VST) {
+                       prop = node.property ("id");
+               }
+#endif         
+               /* recheck  */
+
+               if (prop == 0) {
+                       error << _("Plugin has no unique ID field") << endmsg;
+                       return -1;
+               }
        }
 
        boost::shared_ptr<Plugin> plugin;
-       
-       plugin = find_plugin (_session, prop->value(), type);   
+
+       plugin = find_plugin (_session, prop->value(), type);
 
        if (plugin == 0) {
                error << string_compose(_("Found a reference to a plugin (\"%1\") that is unknown.\n"
-                                  "Perhaps it was removed or moved since it was last used."), prop->value()) 
+                                  "Perhaps it was removed or moved since it was last used."), prop->value())
                      << endmsg;
                return -1;
        }
 
        uint32_t count = 1;
+       bool need_automatables = true;
+
+       if (_plugins.empty()) {
+               /* if we are adding the first plugin, we will need to set
+                  up automatable controls.
+               */
+               need_automatables = true;
+       }
 
        if ((prop = node.property ("count")) != 0) {
                sscanf (prop->value().c_str(), "%u", &count);
        }
 
        if (_plugins.size() != count) {
-               
+
                _plugins.push_back (plugin);
-               
-               for (uint32_t n=1; n < count; ++n) {
+
+               for (uint32_t n = 1; n < count; ++n) {
                        _plugins.push_back (plugin_factory (plugin));
                }
        }
-       
+
+       if (need_automatables) {
+               set_automatable ();
+       }
+
        for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
                if ((*niter)->name() == plugin->state_node_name()) {
                        for (Plugins::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
-                               (*i)->set_state (**niter);
+                               (*i)->set_state (**niter, version);
                        }
                        break;
                }
-       } 
+       }
 
-       const XMLNode* insert_node = &node;
+       if (version < 3000) {
+               for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
+                       if ((*niter)->name() == "Redirect") {
+                               /* XXX do we need to tackle placement? i think not (pd; oct 16 2009) */
+                               Processor::set_state (**niter, version);
+                               break;
+                       }
+               }
+               set_parameter_state_2X (node, version);
+       } else {
+               Processor::set_state (node, version);
+               set_parameter_state (node, version);
+       }
+
+       // The name of the PluginInsert comes from the plugin, nothing else
+       _name = plugin->get_info()->name;
+
+       return 0;
+}
+
+void
+PluginInsert::set_parameter_state (const XMLNode& node, int version)
+{
+       XMLNodeList nlist = node.children();
+       XMLNodeIterator niter;
 
-       // legacy sessions: search for child IOProcessor node
        for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
-               if ((*niter)->name() == "IOProcessor") {
-                       insert_node = *niter;
-                       break;
+               
+               if ((*niter)->name() != port_automation_node_name) {
+                       continue;
                }
+               
+               XMLNodeList cnodes;
+               XMLProperty *cprop;
+               XMLNodeConstIterator iter;
+               XMLNode *child;
+               const char *port;
+               uint32_t port_id;
+
+               cnodes = (*niter)->children ("AutomationList");
+
+               for (iter = cnodes.begin(); iter != cnodes.end(); ++iter) {
+
+                       child = *iter;
+
+                       /* XXX this code knows way too much about the internal details of an AutomationList state node */
+
+                       if ((cprop = child->property("automation-id")) != 0) {
+                               port = cprop->value().c_str();
+                       } else {
+                               warning << _("PluginInsert: Auto: no plugin parameter number seen") << endmsg;
+                               continue;
+                       }
+
+                       if (sscanf (port, "parameter-%" PRIu32, &port_id) != 1) {
+                               warning << _("PluginInsert: Auto: no parameter number found") << endmsg;
+                               continue;
+                       }
+
+                       if (port_id >= _plugins[0]->parameter_count()) {
+                               warning << _("PluginInsert: Auto: plugin parameter out of range") << endmsg;
+                               continue;
+                       }
+
+                       boost::shared_ptr<AutomationControl> c = boost::dynamic_pointer_cast<AutomationControl>(
+                                       data().control(Evoral::Parameter(PluginAutomation, 0, port_id), true));
+
+                       if (c) {
+                               c->alist()->set_state (*child, version);
+                       } else {
+                               error << string_compose (_("PluginInsert: automatable control %1 not found - ignored"), port_id) << endmsg;
+                       }
+               }
+
+               /* done */
+               
+               break;
        }
-       
-       Processor::set_state (*insert_node);
+}
+
+void
+PluginInsert::set_parameter_state_2X (const XMLNode& node, int version)
+{
+       XMLNodeList nlist = node.children();
+       XMLNodeIterator niter;
 
        /* look for port automation node */
        
@@ -806,16 +900,16 @@ PluginInsert::set_state(const XMLNode& node)
                const char *port;
                uint32_t port_id;
                
-               cnodes = (*niter)->children ("Port");
+               cnodes = (*niter)->children ("port");
                
-               for (iter = cnodes.begin(); iter != cnodes.end(); ++iter) {
+               for(iter = cnodes.begin(); iter != cnodes.end(); ++iter){
                        
                        child = *iter;
                        
                        if ((cprop = child->property("number")) != 0) {
                                port = cprop->value().c_str();
                        } else {
-                               warning << _("PluginInsert: Auto: no plugin port number") << endmsg;
+                               warning << _("PluginInsert: Auto: no ladspa port number") << endmsg;
                                continue;
                        }
                        
@@ -829,38 +923,22 @@ PluginInsert::set_state(const XMLNode& node)
                        boost::shared_ptr<AutomationControl> c = boost::dynamic_pointer_cast<AutomationControl>(
                                        data().control(Evoral::Parameter(PluginAutomation, 0, port_id), true));
 
-                       if (!child->children().empty()) {
-                               c->alist()->set_state (*child->children().front());
-                       } else {
-                               if ((cprop = child->property("auto")) != 0) {
-                                       
-                                       /* old school */
-
-                                       int x;
-                                       sscanf (cprop->value().c_str(), "0x%x", &x);
-                                       c->alist()->set_automation_state (AutoState (x));
-
-                               } else {
-                                       
-                                       /* missing */
-                                       
-                                       c->alist()->set_automation_state (Off);
+                       if (c) {
+                               if (!child->children().empty()) {
+                                       c->alist()->set_state (*child->children().front(), version);
                                }
+                       } else {
+                               error << string_compose (_("PluginInsert: automatable control %1 not found - ignored"), port_id) << endmsg;
                        }
-
                }
-
+               
                /* done */
-
+               
                break;
        } 
-
-       // The name of the PluginInsert comes from the plugin, nothing else
-       _name = plugin->get_info()->name;
-       
-       return 0;
 }
 
+
 string
 PluginInsert::describe_parameter (Evoral::Parameter param)
 {
@@ -870,7 +948,7 @@ PluginInsert::describe_parameter (Evoral::Parameter param)
        return _plugins[0]->describe_parameter (param);
 }
 
-ARDOUR::nframes_t 
+ARDOUR::nframes_t
 PluginInsert::signal_latency() const
 {
        if (_user_latency) {
@@ -890,7 +968,7 @@ PluginInsert::type ()
 #ifdef HAVE_AUDIOUNITS
        boost::shared_ptr<AUPlugin> ap;
 #endif
-       
+
        PluginPtr other = plugin ();
 
        if ((lp = boost::dynamic_pointer_cast<LadspaPlugin> (other)) != 0) {
@@ -918,12 +996,12 @@ PluginInsert::PluginControl::PluginControl (PluginInsert* p, const Evoral::Param
        _logarithmic = desc.logarithmic;
        _toggled = desc.toggled;
 }
-        
+
 void
 PluginInsert::PluginControl::set_value (float val)
 {
        /* FIXME: probably should be taking out some lock here.. */
-       
+
        if (_toggled) {
                if (val > 0.5) {
                        val = 1.0;
@@ -931,7 +1009,7 @@ PluginInsert::PluginControl::set_value (float val)
                        val = 0.0;
                }
        } else {
-                       
+
                /*const float range = _list->get_max_y() - _list->get_min_y();
                const float lower = _list->get_min_y();
 
@@ -965,21 +1043,21 @@ float
 PluginInsert::PluginControl::get_value (void) const
 {
        /* FIXME: probably should be taking out some lock here.. */
-       
+
        float val = _plugin->get_parameter (_list->parameter());
 
        return val;
 
        /*if (_toggled) {
-               
+
                return val;
-               
+
        } else {
-               
+
                if (_logarithmic) {
                        val = log(val);
                }
-               
+
                return ((val - lower) / range);
        }*/
 }
@@ -1003,10 +1081,10 @@ PluginInsert::collect_signal_for_analysis(nframes_t nframes)
 {
        // called from outside the audio thread, so this should be safe
        // only do audio as analysis is (currently) only for audio plugins
-       _signal_analysis_inputs.ensure_buffers(  DataType::AUDIO, input_streams().n_audio(),  nframes); 
-       _signal_analysis_outputs.ensure_buffers( DataType::AUDIO, output_streams().n_audio(), nframes); 
+       _signal_analysis_inputs.ensure_buffers(  DataType::AUDIO, input_streams().n_audio(),  nframes);
+       _signal_analysis_outputs.ensure_buffers( DataType::AUDIO, output_streams().n_audio(), nframes);
 
        _signal_analysis_collected_nframes   = 0;
-       _signal_analysis_collect_nframes_max = nframes; 
+       _signal_analysis_collect_nframes_max = nframes;
 }