Make MIDI region `automation' respect the automation mode so that it is
[ardour.git] / libs / ardour / plugin_insert.cc
index 1fff176713f2dac97e1dcd00c7797ca177ba922b..f50483beaf2e143f18424c439d5543f34766b67e 100644 (file)
@@ -23,7 +23,6 @@
 
 #include <string>
 
-#include <sigc++/bind.h>
 
 #include "pbd/failed_constructor.h"
 #include "pbd/xml++.h"
@@ -63,39 +62,16 @@ using namespace PBD;
 const string PluginInsert::port_automation_node_name = "PortAutomation";
 
 PluginInsert::PluginInsert (Session& s, boost::shared_ptr<Plugin> plug)
-       : Processor (s, plug->name())
+       : Processor (s, (plug ? plug->name() : string ("toBeRenamed")))
        , _signal_analysis_collected_nframes(0)
        , _signal_analysis_collect_nframes_max(0)
 {
        /* the first is the master */
 
-       _plugins.push_back (plug);
+        if (plug) {
+                _plugins.push_back (plug);
+                set_automatable ();
 
-       init ();
-
-       {
-               Glib::Mutex::Lock em (_session.engine().process_lock());
-               IO::PortCountChanged (max(input_streams(), output_streams()));
-       }
-
-       ProcessorCreated (this); /* EMIT SIGNAL */
-}
-
-PluginInsert::PluginInsert (Session& s, const XMLNode& node)
-       : Processor (s, "unnamed plugin insert"),
-          _signal_analysis_collected_nframes(0),
-          _signal_analysis_collect_nframes_max(0)
-{
-       if (set_state (node)) {
-               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 ();
-
-       {
                Glib::Mutex::Lock em (_session.engine().process_lock());
                IO::PortCountChanged (max(input_streams(), output_streams()));
        }
@@ -133,15 +109,8 @@ PluginInsert::set_count (uint32_t num)
        return true;
 }
 
-void
-PluginInsert::init ()
-{
-       set_automatable ();
-}
-
 PluginInsert::~PluginInsert ()
 {
-       GoingAway (); /* EMIT SIGNAL */
 }
 
 void
@@ -151,7 +120,7 @@ PluginInsert::auto_state_changed (Evoral::Parameter which)
                return;
 
        boost::shared_ptr<AutomationControl> c
-                       = boost::dynamic_pointer_cast<AutomationControl>(data().control (which));
+                       = boost::dynamic_pointer_cast<AutomationControl>(control (which));
 
        if (c && ((AutomationList*)c->list().get())->automation_state() != Off) {
                _plugins[0]->set_parameter (which.id(), c->list()->eval (_session.transport_frame()));
@@ -217,12 +186,19 @@ PluginInsert::set_automatable ()
 
        for (set<Evoral::Parameter>::iterator i = a.begin(); i != a.end(); ++i) {
                if (i->type() == PluginAutomation) {
-                       can_automate (*i);
-                       _plugins.front()->get_parameter_descriptor(i->id(), desc);
+
                        Evoral::Parameter param(*i);
-                       param.set_range(desc.lower, desc.upper, _plugins.front()->default_value(i->id()));
+
+                       _plugins.front()->get_parameter_descriptor(i->id(), desc);
+                       
+                       /* the Parameter belonging to the actual plugin doesn't have its range set
+                          but we want the Controllable related to this Parameter to have those limits.
+                       */
+
+                       param.set_range (desc.lower, desc.upper, _plugins.front()->default_value(i->id()));
+                       can_automate (param);
                        boost::shared_ptr<AutomationList> list(new AutomationList(param));
-                       add_control(boost::shared_ptr<AutomationControl>(new PluginControl(this, *i, list)));
+                       add_control (boost::shared_ptr<AutomationControl>(new PluginControl(this, param, list)));
                }
        }
 }
@@ -294,7 +270,7 @@ PluginInsert::connect_and_run (BufferSet& bufs, nframes_t nframes, nframes_t off
 
                uint32_t n = 0;
 
-               for (Controls::iterator li = data().controls().begin(); li != data().controls().end(); ++li, ++n) {
+               for (Controls::iterator li = controls().begin(); li != controls().end(); ++li, ++n) {
 
                        boost::shared_ptr<AutomationControl> c
                                = boost::dynamic_pointer_cast<AutomationControl>(li->second);
@@ -379,7 +355,7 @@ 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) {
 
@@ -422,7 +398,7 @@ PluginInsert::set_parameter (Evoral::Parameter param, float val)
        _plugins[0]->set_parameter (param.id(), val);
 
        boost::shared_ptr<AutomationControl> ac
-                       = boost::dynamic_pointer_cast<AutomationControl>(data().control(param));
+                       = boost::dynamic_pointer_cast<AutomationControl>(control(param));
 
        if (ac) {
                ac->set_value(val);
@@ -437,11 +413,12 @@ PluginInsert::set_parameter (Evoral::Parameter param, float val)
 float
 PluginInsert::get_parameter (Evoral::Parameter param)
 {
-       if (param.type() != PluginAutomation)
+       if (param.type() != PluginAutomation) {
                return 0.0;
-       else
-               return
-               _plugins[0]->get_parameter (param.id());
+       } else {
+               assert (!_plugins.empty ());
+               return _plugins[0]->get_parameter (param.id());
+       }
 }
 
 void
@@ -452,14 +429,14 @@ PluginInsert::automation_run (BufferSet& bufs, nframes_t nframes)
        nframes_t end = now + nframes;
        nframes_t offset = 0;
 
-       Glib::Mutex::Lock lm (data().control_lock(), Glib::TRY_LOCK);
+       Glib::Mutex::Lock lm (control_lock(), Glib::TRY_LOCK);
 
        if (!lm.locked()) {
                connect_and_run (bufs, nframes, offset, false);
                return;
        }
 
-       if (!data().find_next_event (now, end, next_event)) {
+       if (!find_next_event (now, end, next_event)) {
 
                /* no events have a time within the relevant range */
 
@@ -477,7 +454,7 @@ PluginInsert::automation_run (BufferSet& bufs, nframes_t nframes)
                offset += cnt;
                now += cnt;
 
-               if (!data().find_next_event (now, end, next_event)) {
+               if (!find_next_event (now, end, next_event)) {
                        break;
                }
        }
@@ -695,28 +672,29 @@ 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");
                snprintf(buf, sizeof(buf), "%" PRIu32, *x);
                child->add_property("number", string(buf));
-
+               
                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));
+               AutomationList* list = dynamic_cast<AutomationList*>(control(*x)->list().get());
+               autonode->add_child_nocopy (list->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;
@@ -725,7 +703,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;
        }
 
@@ -735,6 +713,8 @@ 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())
@@ -743,9 +723,22 @@ PluginInsert::set_state(const XMLNode& node)
        }
 
        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;
@@ -760,6 +753,14 @@ PluginInsert::set_state(const XMLNode& node)
        }
 
        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);
@@ -769,40 +770,71 @@ PluginInsert::set_state(const XMLNode& node)
 
                _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 ();
+       }
+
+       /* Handle the node list for this Processor (or Insert if an A2 session) */
        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;
+        Processor::set_state (node, version);
 
-       // legacy sessions: search for child IOProcessor node
-       for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
-               if ((*niter)->name() == "IOProcessor") {
-                       insert_node = *niter;
-                       break;
+       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 {
+
+               set_parameter_state (node, version);
        }
 
-       Processor::set_state (*insert_node);
+       // The name of the PluginInsert comes from the plugin, nothing else
+       _name = plugin->get_info()->name;
 
-       /* look for port automation node */
+        /* catch up on I/O */
 
-       for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
+       {
+               Glib::Mutex::Lock em (_session.engine().process_lock());
+               IO::PortCountChanged (max(input_streams(), output_streams()));
+       }
 
+       return 0;
+}
+
+void
+PluginInsert::set_parameter_state (const XMLNode& node, int version)
+{
+       XMLNodeList nlist = node.children();
+       XMLNodeIterator niter;
+
+       for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
+               
                if ((*niter)->name() != port_automation_node_name) {
                        continue;
                }
-
+               
                XMLNodeList cnodes;
                XMLProperty *cprop;
                XMLNodeConstIterator iter;
@@ -810,61 +842,107 @@ PluginInsert::set_state(const XMLNode& node)
                const char *port;
                uint32_t port_id;
 
-               cnodes = (*niter)->children ("Port");
+               cnodes = (*niter)->children ("AutomationList");
 
                for (iter = cnodes.begin(); iter != cnodes.end(); ++iter) {
 
                        child = *iter;
 
-                       if ((cprop = child->property("number")) != 0) {
+                       /* 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 port number") << endmsg;
+                               warning << _("PluginInsert: Auto: no plugin parameter number seen") << endmsg;
                                continue;
                        }
 
-                       sscanf (port, "%" PRIu32, &port_id);
+                       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: port id out of range") << endmsg;
+                               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));
+                                       control(Evoral::Parameter(PluginAutomation, 0, port_id), true));
 
-                       if (!child->children().empty()) {
-                               c->alist()->set_state (*child->children().front());
+                       if (c) {
+                               c->alist()->set_state (*child, version);
                        } else {
-                               if ((cprop = child->property("auto")) != 0) {
+                               error << string_compose (_("PluginInsert: automatable control %1 not found - ignored"), port_id) << endmsg;
+                       }
+               }
 
-                                       /* old school */
+               /* done */
+               
+               break;
+       }
+}
 
-                                       int x;
-                                       sscanf (cprop->value().c_str(), "0x%x", &x);
-                                       c->alist()->set_automation_state (AutoState (x));
+void
+PluginInsert::set_parameter_state_2X (const XMLNode& node, int version)
+{
+       XMLNodeList nlist = node.children();
+       XMLNodeIterator niter;
 
-                               } else {
+       /* look for port automation node */
+       
+       for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 
-                                       /* missing */
+               if ((*niter)->name() != port_automation_node_name) {
+                       continue;
+               }
 
-                                       c->alist()->set_automation_state (Off);
-                               }
+               XMLNodeList cnodes;
+               XMLProperty *cprop;
+               XMLNodeConstIterator iter;
+               XMLNode *child;
+               const char *port;
+               uint32_t port_id;
+               
+               cnodes = (*niter)->children ("port");
+               
+               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 ladspa port number") << endmsg;
+                               continue;
+                       }
+                       
+                       sscanf (port, "%" PRIu32, &port_id);
+                       
+                       if (port_id >= _plugins[0]->parameter_count()) {
+                               warning << _("PluginInsert: Auto: port id out of range") << endmsg;
+                               continue;
                        }
 
-               }
+                       boost::shared_ptr<AutomationControl> c = boost::dynamic_pointer_cast<AutomationControl>(
+                                       control(Evoral::Parameter(PluginAutomation, 0, port_id), true));
 
+                       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)
 {
@@ -887,30 +965,7 @@ PluginInsert::signal_latency() const
 ARDOUR::PluginType
 PluginInsert::type ()
 {
-       boost::shared_ptr<LadspaPlugin> lp;
-#ifdef VST_SUPPORT
-       boost::shared_ptr<VSTPlugin> vp;
-#endif
-#ifdef HAVE_AUDIOUNITS
-       boost::shared_ptr<AUPlugin> ap;
-#endif
-
-       PluginPtr other = plugin ();
-
-       if ((lp = boost::dynamic_pointer_cast<LadspaPlugin> (other)) != 0) {
-               return ARDOUR::LADSPA;
-#ifdef VST_SUPPORT
-       } else if ((vp = boost::dynamic_pointer_cast<VSTPlugin> (other)) != 0) {
-               return ARDOUR::VST;
-#endif
-#ifdef HAVE_AUDIOUNITS
-       } else if ((ap = boost::dynamic_pointer_cast<AUPlugin> (other)) != 0) {
-               return ARDOUR::AudioUnit;
-#endif
-       } else {
-               /* NOT REACHED */
-               return (ARDOUR::PluginType) 0;
-       }
+       return plugin()->get_info()->type;
 }
 
 PluginInsert::PluginControl::PluginControl (PluginInsert* p, const Evoral::Parameter &param, boost::shared_ptr<AutomationList> list)