Add a null check to ports when loading an export channel from xml + fix indentation...
[ardour.git] / libs / ardour / plugin_insert.cc
index 1fff176713f2dac97e1dcd00c7797ca177ba922b..25c885f5a676357c4b0aa3d512dbf6f3655c6728 100644 (file)
 
 #include <string>
 
-#include <sigc++/bind.h>
 
 #include "pbd/failed_constructor.h"
 #include "pbd/xml++.h"
+#include "pbd/convert.h"
 
 #include "ardour/audio_buffer.h"
 #include "ardour/automation_list.h"
@@ -63,39 +63,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()));
        }
@@ -116,7 +93,7 @@ PluginInsert::set_count (uint32_t num)
                uint32_t diff = num - _plugins.size();
 
                for (uint32_t n = 0; n < diff; ++n) {
-                       _plugins.push_back (plugin_factory (_plugins[0]));
+                       add_plugin_with_activation (_plugins[0]);
 
                        if (require_state) {
                                /* XXX do something */
@@ -133,27 +110,20 @@ PluginInsert::set_count (uint32_t num)
        return true;
 }
 
-void
-PluginInsert::init ()
-{
-       set_automatable ();
-}
-
 PluginInsert::~PluginInsert ()
 {
-       GoingAway (); /* EMIT SIGNAL */
 }
 
 void
-PluginInsert::auto_state_changed (Evoral::Parameter which)
+PluginInsert::control_list_automation_state_changed (Evoral::Parameter which, AutoState s)
 {
        if (which.type() != PluginAutomation)
                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) {
+       if (c && s != Off) {
                _plugins[0]->set_parameter (which.id(), c->list()->eval (_session.transport_frame()));
        }
 }
@@ -217,12 +187,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()), desc.toggled);
+                       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)));
                }
        }
 }
@@ -245,22 +222,26 @@ PluginInsert::parameter_changed (Evoral::Parameter which, float val)
        }
 }
 
-void
-PluginInsert::set_block_size (nframes_t nframes)
+int
+PluginInsert::set_block_size (pframes_t nframes)
 {
+        int ret = 0;
        for (Plugins::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
-               (*i)->set_block_size (nframes);
+               if ((*i)->set_block_size (nframes) != 0) {
+                        ret = -1;
+                }
        }
+        return ret;
 }
 
 void
 PluginInsert::activate ()
 {
-       Processor::activate ();
-
        for (Plugins::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
                (*i)->activate ();
        }
+       
+       Processor::activate ();
 }
 
 void
@@ -274,11 +255,19 @@ PluginInsert::deactivate ()
 }
 
 void
-PluginInsert::connect_and_run (BufferSet& bufs, nframes_t nframes, nframes_t offset, bool with_auto, nframes_t now)
+PluginInsert::flush ()
+{
+        for (vector<boost::shared_ptr<Plugin> >::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
+                (*i)->flush ();
+        }
+}
+
+void
+PluginInsert::connect_and_run (BufferSet& bufs, pframes_t nframes, framecnt_t offset, bool with_auto, framepos_t now)
 {
        // Calculate if, and how many frames we need to collect for analysis
-       nframes_t collect_signal_nframes = (_signal_analysis_collect_nframes_max -
-                                            _signal_analysis_collected_nframes);
+       framecnt_t collect_signal_nframes = (_signal_analysis_collect_nframes_max -
+                                            _signal_analysis_collected_nframes);
        if (nframes < collect_signal_nframes) { // we might not get all frames now
                collect_signal_nframes = nframes;
        }
@@ -294,7 +283,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);
@@ -366,7 +355,7 @@ PluginInsert::connect_and_run (BufferSet& bufs, nframes_t nframes, nframes_t off
 }
 
 void
-PluginInsert::silence (nframes_t nframes)
+PluginInsert::silence (framecnt_t nframes)
 {
        ChanMapping in_map(input_streams());
        ChanMapping out_map(output_streams());
@@ -379,9 +368,10 @@ 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, framepos_t /*start_frame*/, framepos_t /*end_frame*/, pframes_t nframes, bool)
 {
-       if (_active || _pending_active) {
+       if (_pending_active) {
+               /* run as normal if we are active or moving from inactive to active */
 
                if (_session.transport_rolling()) {
                        automation_run (bufs, nframes);
@@ -414,15 +404,16 @@ PluginInsert::run (BufferSet& bufs, sframes_t /*start_frame*/, sframes_t /*end_f
 void
 PluginInsert::set_parameter (Evoral::Parameter param, float val)
 {
-       if (param.type() != PluginAutomation)
+       if (param.type() != PluginAutomation) {
                return;
+        }
 
        /* 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));
+                       = boost::dynamic_pointer_cast<AutomationControl>(control(param));
 
        if (ac) {
                ac->set_value(val);
@@ -437,29 +428,30 @@ 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
-PluginInsert::automation_run (BufferSet& bufs, nframes_t nframes)
+PluginInsert::automation_run (BufferSet& bufs, pframes_t nframes)
 {
        Evoral::ControlEvent next_event (0, 0.0f);
-       nframes_t now = _session.transport_frame ();
-       nframes_t end = now + nframes;
-       nframes_t offset = 0;
+       framepos_t now = _session.transport_frame ();
+       framepos_t end = now + nframes;
+       framecnt_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) || requires_fixed_sized_buffers()) {
 
                /* no events have a time within the relevant range */
 
@@ -469,7 +461,7 @@ PluginInsert::automation_run (BufferSet& bufs, nframes_t nframes)
 
        while (nframes) {
 
-               nframes_t cnt = min (((nframes_t) ceil (next_event.when) - now), nframes);
+               framecnt_t cnt = min (((framecnt_t) ceil (next_event.when) - now), (framecnt_t) nframes);
 
                connect_and_run (bufs, cnt, offset, true, now);
 
@@ -477,7 +469,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;
                }
        }
@@ -694,29 +686,43 @@ PluginInsert::state (bool full)
        node.add_property("count", string_compose("%1", _plugins.size()));
        node.add_child_nocopy (_plugins[0]->get_state());
 
-       /* add port automation state */
-       //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));
-       }
-
-       //node.add_child_nocopy (*autonode);
+       for (Controls::iterator c = controls().begin(); c != controls().end(); ++c) {
+                boost::shared_ptr<AutomationControl> ac = boost::dynamic_pointer_cast<AutomationControl> ((*c).second);
+                if (ac) {
+                        node.add_child_nocopy (ac->get_state());
+                }
+        }
 
        return node;
 }
 
+void
+PluginInsert::set_control_ids (const XMLNode& node, int version)
+{
+        const XMLNodeList& nlist = node.children();
+        XMLNodeConstIterator iter;
+        set<Evoral::Parameter>::const_iterator p;
+
+        for (iter = nlist.begin(); iter != nlist.end(); ++iter) {
+                if ((*iter)->name() == Controllable::xml_node_name) {
+                        const XMLProperty* prop;
+
+                        if ((prop = (*iter)->property (X_("parameter"))) != 0) {
+                                uint32_t p = atoi (prop->value());
+                                boost::shared_ptr<Evoral::Control> c = control (Evoral::Parameter (PluginAutomation, 0, p));
+                                if (!c) {
+                                        continue;
+                                }
+                                boost::shared_ptr<AutomationControl> ac = boost::dynamic_pointer_cast<AutomationControl> (c);
+                                if (ac) {
+                                        ac->set_state (**iter, version);
+                                }
+                        }
+                }
+        }
+}
 int
-PluginInsert::set_state(const XMLNode& node)
+PluginInsert::set_state(const XMLNode& node, int version)
 {
        XMLNodeList nlist = node.children();
        XMLNodeIterator niter;
@@ -725,7 +731,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 +741,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 +751,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 +781,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);
@@ -767,36 +796,70 @@ PluginInsert::set_state(const XMLNode& node)
 
        if (_plugins.size() != count) {
 
-               _plugins.push_back (plugin);
+               add_plugin_with_activation (plugin);
 
-               for (uint32_t n=1; n < count; ++n) {
-                       _plugins.push_back (plugin_factory (plugin));
+               for (uint32_t n = 1; n < count; ++n) {
+                       add_plugin_with_activation (plugin_factory (plugin));
                }
        }
 
+       if (need_automatables) {
+               set_automatable ();
+                set_control_ids (node, version);
+       }
+
+       /* 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) {
+
+                /* Only 2.X sessions need a call to set_parameter_state() - in 3.X and above
+                   this is all handled by Automatable
+                */
+
+               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);
        }
 
-       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 */
+
+       {
+               Glib::Mutex::Lock em (_session.engine().process_lock());
+               IO::PortCountChanged (max(input_streams(), output_streams()));
+       }
+
+       return 0;
+}
+
+void
+PluginInsert::set_parameter_state_2X (const XMLNode& node, int version)
+{
+       XMLNodeList nlist = node.children();
+       XMLNodeIterator niter;
 
+       /* look for port automation node */
+       
        for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 
                if ((*niter)->name() != port_automation_node_name) {
@@ -809,72 +872,57 @@ PluginInsert::set_state(const XMLNode& node)
                XMLNode *child;
                const char *port;
                uint32_t port_id;
-
-               cnodes = (*niter)->children ("Port");
-
-               for (iter = cnodes.begin(); iter != cnodes.end(); ++iter) {
-
+               
+               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 plugin port number") << endmsg;
+                               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>(
-                                       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) {
+                                       control(Evoral::Parameter(PluginAutomation, 0, port_id), true));
 
-                                       /* 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)
 {
-       if (param.type() != PluginAutomation)
+       if (param.type() != PluginAutomation) {
                return Automatable::describe_parameter(param);
+        }
 
        return _plugins[0]->describe_parameter (param);
 }
 
-ARDOUR::nframes_t
+ARDOUR::framecnt_t
 PluginInsert::signal_latency() const
 {
        if (_user_latency) {
@@ -887,30 +935,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)
@@ -924,7 +949,7 @@ PluginInsert::PluginControl::PluginControl (PluginInsert* p, const Evoral::Param
 }
 
 void
-PluginInsert::PluginControl::set_value (float val)
+PluginInsert::PluginControl::set_value (double val)
 {
        /* FIXME: probably should be taking out some lock here.. */
 
@@ -965,12 +990,24 @@ PluginInsert::PluginControl::set_value (float val)
        AutomationControl::set_value(val);
 }
 
-float
+XMLNode&
+PluginInsert::PluginControl::get_state ()
+{
+        stringstream ss;
+
+        XMLNode& node (AutomationControl::get_state());
+        ss << parameter().id();
+        node.add_property (X_("parameter"), ss.str());
+
+        return node;
+}
+
+double
 PluginInsert::PluginControl::get_value (void) const
 {
        /* FIXME: probably should be taking out some lock here.. */
 
-       float val = _plugin->get_parameter (_list->parameter());
+       double val = _plugin->get_parameter (_list->parameter());
 
        return val;
 
@@ -1003,7 +1040,7 @@ PluginInsert::get_impulse_analysis_plugin()
 }
 
 void
-PluginInsert::collect_signal_for_analysis(nframes_t nframes)
+PluginInsert::collect_signal_for_analysis (framecnt_t nframes)
 {
        // called from outside the audio thread, so this should be safe
        // only do audio as analysis is (currently) only for audio plugins
@@ -1014,3 +1051,20 @@ PluginInsert::collect_signal_for_analysis(nframes_t nframes)
        _signal_analysis_collect_nframes_max = nframes;
 }
 
+/** Add a plugin to our list and activate it if we have already been activated */
+void
+PluginInsert::add_plugin_with_activation (boost::shared_ptr<Plugin> plugin)
+{
+       _plugins.push_back (plugin);
+       if (active()) {
+               plugin->activate ();
+       }
+}
+
+void
+PluginInsert::realtime_handle_transport_stopped ()
+{
+       for (Plugins::iterator i = _plugins.begin(); i != _plugins.end(); ++i) {
+               (*i)->realtime_handle_transport_stopped ();
+       }
+}