mechanism to allow Track (or other Route-derived type) to add its own processors...
[ardour.git] / libs / ardour / route.cc
index 1b5c0579c19420896ad9ac7d1e4ac3cc38aa71b2..c1725c42586748e4e02d7e86fdab61b317b6d94d 100644 (file)
 
 #include "pbd/xml++.h"
 #include "pbd/enumwriter.h"
+#include "pbd/locale_guard.h"
 #include "pbd/memento_command.h"
 #include "pbd/stacktrace.h"
-#include "pbd/convert.h"
+#include "pbd/types_convert.h"
 #include "pbd/unwind.h"
 
 #include "ardour/amp.h"
@@ -71,6 +72,7 @@
 #include "ardour/session.h"
 #include "ardour/solo_control.h"
 #include "ardour/solo_isolate_control.h"
+#include "ardour/types_convert.h"
 #include "ardour/unknown_processor.h"
 #include "ardour/utils.h"
 #include "ardour/vca.h"
@@ -88,7 +90,6 @@ Route::Route (Session& sess, string name, PresentationInfo::Flag flag, DataType
        : Stripable (sess, name, PresentationInfo (flag))
        , GraphNode (sess._process_graph)
        , Muteable (sess, name)
-       , Automatable (sess)
        , _active (true)
        , _signal_latency (0)
        , _signal_latency_at_amp_position (0)
@@ -114,13 +115,14 @@ Route::Route (Session& sess, string name, PresentationInfo::Flag flag, DataType
        , _strict_io (false)
        , _custom_meter_position_noted (false)
        , _pinmgr_proxy (0)
+       , _patch_selector_dialog (0)
 {
        processor_max_streams.reset();
 }
 
 boost::weak_ptr<Route>
 Route::weakroute () {
-       return boost::weak_ptr<Route> (shared_from_this ());
+       return boost::weak_ptr<Route> (boost::dynamic_pointer_cast<Route> (shared_from_this ()));
 }
 
 int
@@ -139,10 +141,12 @@ Route::init ()
        /* add standard controls */
 
        _gain_control.reset (new GainControl (_session, GainAutomation));
-       add_control (_gain_control);
-
        _trim_control.reset (new GainControl (_session, TrimAutomation));
-       add_control (_trim_control);
+       /* While the route has-a gain-control for consistency with Stripable and VCA
+        * ownership is handed over to the Amp Processor which manages the
+        * state of the Control and AutomationList as part of its
+        * Automatable API. -- Don't call add_control () here.
+        */
 
        _solo_control.reset (new SoloControl (_session, X_("solo"), *this, *this));
        add_control (_solo_control);
@@ -235,6 +239,10 @@ Route::init ()
                _monitor_control->activate ();
        }
 
+       /* give derived classes a chance to add processors before we configure */
+
+       add_processors_oh_children_of_mine ();
+
        /* now that we have _meter, its safe to connect to this */
 
        {
@@ -319,7 +327,7 @@ Route::process_output_buffers (BufferSet& bufs,
                return;
        }
 
-       _mute_control->automation_run (start_frame, nframes);
+       automation_run (start_frame, nframes);
 
        /* figure out if we're going to use gain automation */
        if (gain_automation_ok) {
@@ -453,6 +461,7 @@ Route::process_output_buffers (BufferSet& bufs,
                                        _initial_delay + latency, longest_session_latency - latency);
                }
 
+               //cerr << name() << " run " << (*i)->name() << endl;
                (*i)->run (bufs, start_frame - latency, end_frame - latency, speed, nframes, *i != _processors.back());
                bufs.set_count ((*i)->output_streams());
 
@@ -876,7 +885,7 @@ Route::add_processor_from_xml_2X (const XMLNode& node, int version)
                //A2 uses the "active" flag in the toplevel redirect node, not in the child plugin/IO
                if (i != children.end()) {
                        if ((prop = (*i)->property (X_("active"))) != 0) {
-                               if ( string_is_affirmative (prop->value()) && (!_session.get_bypass_all_loaded_plugins () || !processor->display_to_user () ) )
+                               if ( string_to<bool> (prop->value()) && (!_session.get_bypass_all_loaded_plugins () || !processor->display_to_user () ) )
                                        processor->activate();
                                else
                                        processor->deactivate();
@@ -923,10 +932,6 @@ Route::add_processors (const ProcessorList& others, boost::shared_ptr<Processor>
                loc = _processors.end ();
        }
 
-       if (!AudioEngine::instance()->connected()) {
-               return 1;
-       }
-
        if (others.empty()) {
                return 0;
        }
@@ -969,7 +974,7 @@ Route::add_processors (const ProcessorList& others, boost::shared_ptr<Processor>
                flags &= mask;
 
                if (flags != None) {
-                       boost::optional<int> rv = PluginSetup (shared_from_this (), pi, flags);  /* EMIT SIGNAL */
+                       boost::optional<int> rv = PluginSetup (boost::dynamic_pointer_cast<Route>(shared_from_this ()), pi, flags);  /* EMIT SIGNAL */
                        int mode = rv.get_value_or (0);
                        switch (mode & 3) {
                                case 1:
@@ -1176,6 +1181,14 @@ Route::ab_plugins (bool forward)
                        if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
                                continue;
                        }
+                       if (!(*i)->display_to_user ()) {
+                               continue;
+                       }
+#ifdef MIXBUS
+                       if (boost::dynamic_pointer_cast<PluginInsert> (*i)->is_channelstrip()) {
+                               continue;
+                       }
+#endif
 
                        if ((*i)->enabled ()) {
                                (*i)->enable (false);
@@ -1190,10 +1203,17 @@ Route::ab_plugins (bool forward)
                /* backward = if the redirect was marked to go active on the next ab, do so */
 
                for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
-
                        if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
                                continue;
                        }
+                       if (!(*i)->display_to_user ()) {
+                               continue;
+                       }
+#ifdef MIXBUS
+                       if (boost::dynamic_pointer_cast<PluginInsert> (*i)->is_channelstrip()) {
+                               continue;
+                       }
+#endif
 
                        (*i)->enable ((*i)->get_next_ab_is_active ());
                }
@@ -1218,6 +1238,7 @@ Route::clear_processors (Placement p)
                _session.set_deletion_in_progress();
        }
 
+       ProcessorList old_list = _processors;
        {
                Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
                Glib::Threads::RWLock::WriterLock lm (_processor_lock);
@@ -1266,13 +1287,15 @@ Route::clear_processors (Placement p)
                _processors = new_list;
                configure_processors_unlocked (&err, &lm); // this can't fail
        }
+       /* drop references w/o process-lock (I/O procs may re-take it in ~IO() */
+       old_list.clear ();
 
        processor_max_streams.reset();
        _have_internal_generator = false;
-       processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
+       reset_instrument_info ();
        set_processor_positions ();
 
-       reset_instrument_info ();
+       processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
 
        if (!already_deleting) {
                _session.clear_deletion_in_progress();
@@ -1787,6 +1810,8 @@ Route::configure_processors_unlocked (ProcessorStreams* err, Glib::Threads::RWLo
        // TODO check for a potential ReaderLock after ReaderLock ??
        Glib::Threads::RWLock::ReaderLock lr (_processor_lock);
 
+       framecnt_t chain_latency = _input->latency ();
+
        list< pair<ChanCount,ChanCount> >::iterator c = configuration.begin();
        for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++c) {
 
@@ -1797,6 +1822,10 @@ Route::configure_processors_unlocked (ProcessorStreams* err, Glib::Threads::RWLo
                        lm->acquire ();
                        return -1;
                }
+
+               (*p)->set_input_latency (chain_latency);
+               chain_latency += (*p)->signal_latency ();
+
                processor_max_streams = ChanCount::max(processor_max_streams, c->first);
                processor_max_streams = ChanCount::max(processor_max_streams, c->second);
 
@@ -1863,6 +1892,14 @@ Route::all_visible_processors_active (bool state)
                if (!(*i)->display_to_user() || boost::dynamic_pointer_cast<Amp> (*i)) {
                        continue;
                }
+#ifdef MIXBUS
+               boost::shared_ptr<PluginInsert> pi;
+               if (0 != (pi = boost::dynamic_pointer_cast<PluginInsert>(*i))) {
+                       if (pi->is_channelstrip ()) {
+                               continue;
+                       }
+               }
+#endif
                (*i)->enable (state);
        }
 
@@ -2286,32 +2323,28 @@ Route::get_template()
 XMLNode&
 Route::state(bool full_state)
 {
-       LocaleGuard lg;
        if (!_session._template_state_dir.empty()) {
                foreach_processor (sigc::bind (sigc::mem_fun (*this, &Route::set_plugin_state_dir), _session._template_state_dir));
        }
 
        XMLNode *node = new XMLNode("Route");
        ProcessorList::iterator i;
-       char buf[32];
 
-       id().print (buf, sizeof (buf));
-       node->add_property("id", buf);
-       node->add_property ("name", _name);
-       node->add_property("default-type", _default_type.to_string());
-       node->add_property ("strict-io", _strict_io);
+       node->set_property ("id", id ());
+       node->set_property ("name", name());
+       node->set_property ("default-type", _default_type);
+       node->set_property ("strict-io", _strict_io);
 
        node->add_child_nocopy (_presentation_info.get_state());
 
-       node->add_property("active", _active?"yes":"no");
-       string p;
-       node->add_property("denormal-protection", _denormal_protection?"yes":"no");
-       node->add_property("meter-point", enum_2_string (_meter_point));
+       node->set_property ("active", _active);
+       node->set_property ("denormal-protection", _denormal_protection);
+       node->set_property ("meter-point", _meter_point);
 
-       node->add_property("meter-type", enum_2_string (_meter_type));
+       node->set_property ("meter-type", _meter_type);
 
        if (_route_group) {
-               node->add_property("route-group", _route_group->name());
+               node->set_property ("route-group", _route_group->name());
        }
 
        node->add_child_nocopy (_solo_control->get_state ());
@@ -2370,8 +2403,7 @@ Route::state(bool full_state)
        if (_custom_meter_position_noted) {
                boost::shared_ptr<Processor> after = _processor_after_last_custom_meter.lock ();
                if (after) {
-                       after->id().print (buf, sizeof (buf));
-                       node->add_property (X_("processor-after-last-custom-meter"), buf);
+                       node->set_property (X_("processor-after-last-custom-meter"), after->id());
                }
        }
 
@@ -2394,15 +2426,15 @@ Route::set_state (const XMLNode& node, int version)
        XMLNodeList nlist;
        XMLNodeConstIterator niter;
        XMLNode *child;
-       XMLProperty const * prop;
 
        if (node.name() != "Route"){
                error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
                return -1;
        }
 
-       if ((prop = node.property (X_("name"))) != 0) {
-               Route::set_name (prop->value());
+       std::string route_name;
+       if (node.get_property (X_("name"), route_name)) {
+               Route::set_name (route_name);
        }
 
        set_id (node);
@@ -2410,9 +2442,7 @@ Route::set_state (const XMLNode& node, int version)
 
        Stripable::set_state (node, version);
 
-       if ((prop = node.property (X_("strict-io"))) != 0) {
-               _strict_io = string_is_affirmative (prop->value());
-       }
+       node.get_property (X_("strict-io"), _strict_io);
 
        if (is_monitor()) {
                /* monitor bus does not get a panner, but if (re)created
@@ -2434,13 +2464,14 @@ Route::set_state (const XMLNode& node, int version)
                child = *niter;
 
                if (child->name() == IO::state_node_name) {
-                       if ((prop = child->property (X_("direction"))) == 0) {
+                       std::string direction;
+                       if (!child->get_property (X_("direction"), direction)) {
                                continue;
                        }
 
-                       if (prop->value() == "Input") {
+                       if (direction == "Input") {
                                _input->set_state (*child, version);
-                       } else if (prop->value() == "Output") {
+                       } else if (direction == "Output") {
                                _output->set_state (*child, version);
                        }
 
@@ -2457,17 +2488,15 @@ Route::set_state (const XMLNode& node, int version)
                }
        }
 
-       if ((prop = node.property (X_("meter-point"))) != 0) {
-               MeterPoint mp = MeterPoint (string_2_enum (prop->value (), _meter_point));
+       MeterPoint mp;
+       if (node.get_property (X_("meter-point"), mp)) {
                set_meter_point (mp, true);
                if (_meter) {
                        _meter->set_display_to_user (_meter_point == MeterCustom);
                }
        }
 
-       if ((prop = node.property (X_("meter-type"))) != 0) {
-               _meter_type = MeterType (string_2_enum (prop->value (), _meter_type));
-       }
+       node.get_property (X_("meter-type"), _meter_type);
 
        _initial_io_setup = false;
 
@@ -2476,17 +2505,25 @@ Route::set_state (const XMLNode& node, int version)
        // this looks up the internal instrument in processors
        reset_instrument_info();
 
-       if ((prop = node.property (X_("denormal-protection"))) != 0) {
-               set_denormal_protection (string_is_affirmative (prop->value()));
+       bool denormal_protection;
+       if (node.get_property (X_("denormal-protection"), denormal_protection)) {
+               set_denormal_protection (denormal_protection);
+       }
+
+       /* convert old 3001 state */
+       std::string phase_invert_str;
+       if (node.get_property (X_("phase-invert"), phase_invert_str)) {
+               _phase_control->set_phase_invert (boost::dynamic_bitset<> (phase_invert_str));
        }
 
-       if ((prop = node.property (X_("active"))) != 0) {
-               bool yn = string_is_affirmative (prop->value());
-               set_active (yn, this);
+       bool is_active;
+       if (node.get_property (X_("active"), is_active)) {
+               set_active (is_active, this);
        }
 
-       if ((prop = node.property (X_("processor-after-last-custom-meter"))) != 0) {
-               PBD::ID id (prop->value ());
+       std::string id_string;
+       if (node.get_property (X_("processor-after-last-custom-meter"), id_string)) {
+               PBD::ID id (id_string);
                Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
                ProcessorList::const_iterator i = _processors.begin ();
                while (i != _processors.end() && (*i)->id() != id) {
@@ -2510,24 +2547,23 @@ Route::set_state (const XMLNode& node, int version)
                        _comment = cmt->content();
 
                }  else if (child->name() == Controllable::xml_node_name) {
-                       if ((prop = child->property (X_("name"))) == 0) {
+                       std::string control_name;
+                       if (!child->get_property (X_("name"), control_name)) {
                                continue;
                        }
 
-                       if (prop->value() == _gain_control->name()) {
-                               _gain_control->set_state (*child, version);
-                       } else if (prop->value() == _solo_control->name()) {
+                       if (control_name == _solo_control->name()) {
                                _solo_control->set_state (*child, version);
-                       } else if (prop->value() == _solo_safe_control->name()) {
+                       } else if (control_name == _solo_safe_control->name()) {
                                _solo_safe_control->set_state (*child, version);
-                       } else if (prop->value() == _solo_isolate_control->name()) {
+                       } else if (control_name == _solo_isolate_control->name()) {
                                _solo_isolate_control->set_state (*child, version);
-                       } else if (prop->value() == _mute_control->name()) {
+                       } else if (control_name == _mute_control->name()) {
                                _mute_control->set_state (*child, version);
-                       } else if (prop->value() == _phase_control->name()) {
+                       } else if (control_name == _phase_control->name()) {
                                _phase_control->set_state (*child, version);
                        } else {
-                               Evoral::Parameter p = EventTypeMap::instance().from_symbol (prop->value());
+                               Evoral::Parameter p = EventTypeMap::instance().from_symbol (control_name);
                                if (p.type () >= MidiCCAutomation && p.type () < MidiSystemExclusiveAutomation) {
                                        boost::shared_ptr<AutomationControl> ac = automation_control (p, true);
                                        if (ac) {
@@ -2569,13 +2605,13 @@ Route::set_state_2X (const XMLNode& node, int version)
        Stripable::set_state (node, version);
 
        if ((prop = node.property (X_("denormal-protection"))) != 0) {
-               set_denormal_protection (string_is_affirmative (prop->value()));
+               set_denormal_protection (string_to<bool> (prop->value()));
        }
 
        if ((prop = node.property (X_("muted"))) != 0) {
 
                bool first = true;
-               bool muted = string_is_affirmative (prop->value());
+               bool muted = string_to<bool> (prop->value());
 
                if (muted) {
 
@@ -2583,7 +2619,7 @@ Route::set_state_2X (const XMLNode& node, int version)
 
                        if ((prop = node.property (X_("mute-affects-pre-fader"))) != 0) {
 
-                               if (string_is_affirmative (prop->value())){
+                               if (string_to<bool> (prop->value())){
                                        mute_point = mute_point + "PreFader";
                                        first = false;
                                }
@@ -2591,7 +2627,7 @@ Route::set_state_2X (const XMLNode& node, int version)
 
                        if ((prop = node.property (X_("mute-affects-post-fader"))) != 0) {
 
-                               if (string_is_affirmative (prop->value())){
+                               if (string_to<bool> (prop->value())){
 
                                        if (!first) {
                                                mute_point = mute_point + ",";
@@ -2604,7 +2640,7 @@ Route::set_state_2X (const XMLNode& node, int version)
 
                        if ((prop = node.property (X_("mute-affects-control-outs"))) != 0) {
 
-                               if (string_is_affirmative (prop->value())){
+                               if (string_to<bool> (prop->value())){
 
                                        if (!first) {
                                                mute_point = mute_point + ",";
@@ -2617,7 +2653,7 @@ Route::set_state_2X (const XMLNode& node, int version)
 
                        if ((prop = node.property (X_("mute-affects-main-outs"))) != 0) {
 
-                               if (string_is_affirmative (prop->value())){
+                               if (string_to<bool> (prop->value())){
 
                                        if (!first) {
                                                mute_point = mute_point + ",";
@@ -2659,7 +2695,7 @@ Route::set_state_2X (const XMLNode& node, int version)
                        set_id (*child);
 
                        if ((prop = child->property (X_("active"))) != 0) {
-                               bool yn = string_is_affirmative (prop->value());
+                               bool yn = string_to<bool> (prop->value());
                                _active = !yn; // force switch
                                set_active (yn, this);
                        }
@@ -2800,91 +2836,11 @@ Route::set_processor_state (const XMLNode& node)
                        /* CapturingProcessor should never be restored, it's always
                           added explicitly when needed */
                } else {
-                       ProcessorList::iterator o;
-
-                       for (o = _processors.begin(); o != _processors.end(); ++o) {
-                               XMLProperty const * id_prop = (*niter)->property(X_("id"));
-                               if (id_prop && (*o)->id() == id_prop->value()) {
-                                       (*o)->set_state (**niter, Stateful::current_state_version);
-                                       new_order.push_back (*o);
-                                       break;
-                               }
-                       }
-
-                       // If the processor (*niter) is not on the route then create it
-
-                       if (o == _processors.end()) {
-
-                               boost::shared_ptr<Processor> processor;
-
-                               if (prop->value() == "intsend") {
-
-                                       processor.reset (new InternalSend (_session, _pannable, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), boost::shared_ptr<Route>(), Delivery::Aux, true));
-
-                               } else if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
-                                          prop->value() == "lv2" ||
-                                          prop->value() == "windows-vst" ||
-                                          prop->value() == "mac-vst" ||
-                                          prop->value() == "lxvst" ||
-                                          prop->value() == "luaproc" ||
-                                          prop->value() == "audiounit") {
-
-                                       if (_session.get_disable_all_loaded_plugins ()) {
-                                               processor.reset (new UnknownProcessor (_session, **niter));
-                                       } else {
-                                               processor.reset (new PluginInsert (_session));
-                                               processor->set_owner (this);
-                                               if (_strict_io) {
-                                                       boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(processor);
-                                                       pi->set_strict_io (true);
-                                               }
-
-                                       }
-                               } else if (prop->value() == "port") {
-
-                                       processor.reset (new PortInsert (_session, _pannable, _mute_master));
-
-                               } else if (prop->value() == "send") {
-
-                                       processor.reset (new Send (_session, _pannable, _mute_master, Delivery::Send, true));
-                                       boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
-                                       send->SelfDestruct.connect_same_thread (*this,
-                                                       boost::bind (&Route::processor_selfdestruct, this, boost::weak_ptr<Processor> (processor)));
-
-                               } else {
-                                       error << string_compose(_("unknown Processor type \"%1\"; ignored"), prop->value()) << endmsg;
-                                       continue;
-                               }
-
-                               if (processor->set_state (**niter, Stateful::current_state_version) != 0) {
-                                       /* This processor could not be configured.  Turn it into a UnknownProcessor */
-                                       processor.reset (new UnknownProcessor (_session, **niter));
-                               }
-
-                               /* subscribe to Sidechain IO changes */
-                               boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (processor);
-                               if (pi && pi->has_sidechain ()) {
-                                       pi->sidechain_input ()->changed.connect_same_thread (*this, boost::bind (&Route::sidechain_change_handler, this, _1, _2));
-                               }
-
-                               /* we have to note the monitor send here, otherwise a new one will be created
-                                  and the state of this one will be lost.
-                               */
-                               boost::shared_ptr<InternalSend> isend = boost::dynamic_pointer_cast<InternalSend> (processor);
-                               if (isend && isend->role() == Delivery::Listen) {
-                                       _monitor_send = isend;
-                               }
-
-                               /* it doesn't matter if invisible processors are added here, as they
-                                  will be sorted out by setup_invisible_processors () shortly.
-                               */
-
-                               new_order.push_back (processor);
-                               must_configure = true;
-                       }
+                       set_processor_state (**niter, prop, new_order, must_configure);
                }
        }
 
+       ProcessorList old_list = _processors; // keep a copy
        {
                Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
                Glib::Threads::RWLock::WriterLock lm (_processor_lock);
@@ -2914,12 +2870,101 @@ Route::set_processor_state (const XMLNode& node)
                        }
                }
        }
+       /* drop references w/o process-lock (I/O procs may re-take it in ~IO() */
+       old_list.clear ();
 
        reset_instrument_info ();
        processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
        set_processor_positions ();
 }
 
+bool
+Route::set_processor_state (XMLNode const & node, XMLProperty const* prop, ProcessorList& new_order, bool& must_configure)
+{
+       ProcessorList::iterator o;
+
+       for (o = _processors.begin(); o != _processors.end(); ++o) {
+               XMLProperty const * id_prop = node.property(X_("id"));
+               if (id_prop && (*o)->id() == id_prop->value()) {
+                       (*o)->set_state (node, Stateful::current_state_version);
+                       new_order.push_back (*o);
+                       break;
+               }
+       }
+
+       // If the processor (node) is not on the route then create it
+
+       if (o == _processors.end()) {
+
+               boost::shared_ptr<Processor> processor;
+
+               if (prop->value() == "intsend") {
+
+                       processor.reset (new InternalSend (_session, _pannable, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), boost::shared_ptr<Route>(), Delivery::Aux, true));
+
+               } else if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
+                          prop->value() == "lv2" ||
+                          prop->value() == "windows-vst" ||
+                          prop->value() == "mac-vst" ||
+                          prop->value() == "lxvst" ||
+                          prop->value() == "luaproc" ||
+                          prop->value() == "audiounit") {
+
+                       if (_session.get_disable_all_loaded_plugins ()) {
+                               processor.reset (new UnknownProcessor (_session, node));
+                       } else {
+                               processor.reset (new PluginInsert (_session));
+                               processor->set_owner (this);
+                               if (_strict_io) {
+                                       boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(processor);
+                                       pi->set_strict_io (true);
+                               }
+
+                       }
+               } else if (prop->value() == "port") {
+
+                       processor.reset (new PortInsert (_session, _pannable, _mute_master));
+
+               } else if (prop->value() == "send") {
+
+                       processor.reset (new Send (_session, _pannable, _mute_master, Delivery::Send, true));
+                       boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
+                       send->SelfDestruct.connect_same_thread (*this,
+                                                               boost::bind (&Route::processor_selfdestruct, this, boost::weak_ptr<Processor> (processor)));
+
+               } else {
+                       return false;
+               }
+
+               if (processor->set_state (node, Stateful::current_state_version) != 0) {
+                       /* This processor could not be configured.  Turn it into a UnknownProcessor */
+                       processor.reset (new UnknownProcessor (_session, node));
+               }
+
+               /* subscribe to Sidechain IO changes */
+               boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (processor);
+               if (pi && pi->has_sidechain ()) {
+                       pi->sidechain_input ()->changed.connect_same_thread (*this, boost::bind (&Route::sidechain_change_handler, this, _1, _2));
+               }
+
+               /* we have to note the monitor send here, otherwise a new one will be created
+                  and the state of this one will be lost.
+               */
+               boost::shared_ptr<InternalSend> isend = boost::dynamic_pointer_cast<InternalSend> (processor);
+               if (isend && isend->role() == Delivery::Listen) {
+                       _monitor_send = isend;
+               }
+
+               /* it doesn't matter if invisible processors are added here, as they
+                  will be sorted out by setup_invisible_processors () shortly.
+               */
+
+               new_order.push_back (processor);
+               must_configure = true;
+       }
+       return true;
+}
+
 void
 Route::curve_reallocate ()
 {
@@ -2949,11 +2994,16 @@ Route::silence_unlocked (framecnt_t nframes)
 
                _output->silence (nframes);
 
+               // update owned automated controllables
+               automation_run (now, nframes);
+
                for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
                        boost::shared_ptr<PluginInsert> pi;
 
                        if (!_active && (pi = boost::dynamic_pointer_cast<PluginInsert> (*i)) != 0) {
-                               // skip plugins, they don't need anything when we're not active
+                               /* evaluate automated automation controls */
+                               pi->automation_run (now, nframes);
+                               /* skip plugins, they don't need anything when we're not active */
                                continue;
                        }
 
@@ -3257,33 +3307,31 @@ Route::direct_feeds_according_to_reality (boost::shared_ptr<Route> other, bool*
 bool
 Route::direct_feeds_according_to_graph (boost::shared_ptr<Route> other, bool* via_send_only)
 {
-       return _session._current_route_graph.has (shared_from_this (), other, via_send_only);
+       return _session._current_route_graph.has (boost::dynamic_pointer_cast<Route> (shared_from_this ()), other, via_send_only);
 }
 
 bool
 Route::feeds_according_to_graph (boost::shared_ptr<Route> other)
 {
-       return _session._current_route_graph.feeds (shared_from_this (), other);
+       return _session._current_route_graph.feeds (boost::dynamic_pointer_cast<Route> (shared_from_this ()), other);
 }
 
 /** Called from the (non-realtime) butler thread when the transport is stopped */
 void
-Route::nonrealtime_handle_transport_stopped (bool /*abort_ignored*/, bool /*did_locate*/, bool can_flush_processors)
+Route::non_realtime_transport_stop (framepos_t now, bool flush)
 {
-       framepos_t now = _session.transport_frame();
-
        {
                Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
 
-               Automatable::transport_stopped (now);
+               Automatable::non_realtime_transport_stop (now, flush);
 
                for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
 
-                       if (!_have_internal_generator && (Config->get_plugins_stop_with_transport() && can_flush_processors)) {
+                       if (!_have_internal_generator && (Config->get_plugins_stop_with_transport() && flush)) {
                                (*i)->flush ();
                        }
 
-                       (*i)->transport_stopped (now);
+                       (*i)->non_realtime_transport_stop (now, flush);
                }
        }
 
@@ -3312,7 +3360,7 @@ Route::input_change_handler (IOChange change, void * /*src*/)
                                        continue;
                                }
                                bool sends_only;
-                               bool does_feed = (*i)->direct_feeds_according_to_reality (shared_from_this(), &sends_only);
+                               bool does_feed = (*i)->direct_feeds_according_to_reality (boost::dynamic_pointer_cast<Route> (shared_from_this()), &sends_only);
                                if (does_feed && !sends_only) {
                                        if ((*i)->soloed()) {
                                                ++sbou;
@@ -3426,7 +3474,7 @@ Route::output_change_handler (IOChange change, void * /*src*/)
                                _solo_control->mod_solo_by_others_downstream (delta);
                                // Session::route_solo_changed() does not propagate indirect solo-changes
                                // propagate upstream to tracks
-                               boost::shared_ptr<Route> shared_this = shared_from_this();
+                               boost::shared_ptr<Route> shared_this = boost::dynamic_pointer_cast<Route> (shared_from_this());
                                for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
                                        if ((*i).get() == this || !can_solo()) {
                                                continue;
@@ -3488,11 +3536,7 @@ Route::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
                return 0;
        }
 
-       if (n_outputs().n_total() == 0) {
-               return 0;
-       }
-
-       if (!_active || n_inputs() == ChanCount::ZERO)  {
+       if (!_active) {
                silence_unlocked (nframes);
                return 0;
        }
@@ -3537,11 +3581,7 @@ Route::roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, in
                return 0;
        }
 
-       if (n_outputs().n_total() == 0) {
-               return 0;
-       }
-
-       if (!_active || n_inputs().n_total() == 0) {
+       if (!_active) {
                silence_unlocked (nframes);
                return 0;
        }
@@ -3580,10 +3620,6 @@ Route::silent_roll (pframes_t nframes, framepos_t /*start_frame*/, framepos_t /*
 void
 Route::flush_processors ()
 {
-       /* XXX shouldn't really try to take this lock, since
-          this is called from the RT audio thread.
-       */
-
        Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
 
        for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
@@ -3996,12 +4032,22 @@ Route::set_plugin_state_dir (boost::weak_ptr<Processor> p, const std::string& d)
 }
 
 int
-Route::save_as_template (const string& path, const string& name)
+Route::save_as_template (const string& path, const string& name, const string& description)
 {
        std::string state_dir = path.substr (0, path.find_last_of ('.')); // strip template_suffix
        PBD::Unwinder<std::string> uw (_session._template_state_dir, state_dir);
 
        XMLNode& node (state (false));
+       node.set_property (X_("name"), name);
+
+       node.remove_nodes (X_("description"));
+       if (!description.empty()) {
+               XMLNode* desc = new XMLNode(X_("description"));
+               XMLNode* desc_cont = new XMLNode(X_("content"), description);
+               desc->add_child_nocopy (*desc_cont);
+
+               node.add_child_nocopy (*desc);
+       }
 
        XMLTree tree;
 
@@ -4057,7 +4103,7 @@ Route::set_name (const string& str)
 void
 Route::set_name_in_state (XMLNode& node, string const & name, bool rename_playlist)
 {
-       node.add_property (X_("name"), name);
+       node.set_property (X_("name"), name);
 
        XMLNodeList children = node.children();
        for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
@@ -4068,17 +4114,17 @@ Route::set_name_in_state (XMLNode& node, string const & name, bool rename_playli
 
                } else if ((*i)->name() == X_("Processor")) {
 
-                       XMLProperty const * role = (*i)->property (X_("role"));
-                       if (role && role->value() == X_("Main")) {
-                               (*i)->add_property (X_("name"), name);
+                       std::string str;
+                       if ((*i)->get_property (X_("role"), str) && str == X_("Main")) {
+                               (*i)->set_property (X_("name"), name);
                        }
 
                } else if ((*i)->name() == X_("Diskstream")) {
 
                        if (rename_playlist) {
-                               (*i)->add_property (X_("playlist"), string_compose ("%1.1", name).c_str());
+                               (*i)->set_property (X_("playlist"), name + ".1");
                        }
-                       (*i)->add_property (X_("name"), name);
+                       (*i)->set_property (X_("name"), name);
 
                }
        }
@@ -4133,6 +4179,7 @@ Route::set_active (bool yn, void* src)
                _active = yn;
                _input->set_active (yn);
                _output->set_active (yn);
+               flush_processors ();
                active_changed (); // EMIT SIGNAL
                _session.set_dirty ();
        }
@@ -4606,6 +4653,8 @@ Route::setup_invisible_processors ()
                new_processors.push_front (_capturing_processor);
        }
 
+       setup_invisible_processors_oh_children_of_mine (new_processors);
+
        _processors = new_processors;
 
        for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
@@ -4751,8 +4800,10 @@ Route::the_instrument_unlocked () const
 void
 Route::non_realtime_locate (framepos_t pos)
 {
+       Automatable::non_realtime_locate (pos);
+
        if (_pannable) {
-               _pannable->transport_located (pos);
+               _pannable->non_realtime_locate (pos);
        }
 
        if (_delayline.get()) {
@@ -4764,7 +4815,7 @@ Route::non_realtime_locate (framepos_t pos)
                Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
 
                for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
-                       (*i)->transport_located (pos);
+                       (*i)->non_realtime_locate (pos);
                }
        }
        _roll_delay = _initial_delay;
@@ -4816,7 +4867,6 @@ Route::fill_buffers_with_input (BufferSet& bufs, boost::shared_ptr<IO> io, pfram
                boost::shared_ptr<AudioPort> source_port = io->audio (i);
                AudioBuffer& buf (bufs.get_audio (i%n_buffers));
 
-
                if (i < n_buffers) {
 
                        /* first time through just copy a channel into
@@ -4864,11 +4914,12 @@ boost::shared_ptr<AutomationControl>
 Route::pan_azimuth_control() const
 {
 #ifdef MIXBUS
+# undef MIXBUS_PORTS_H
+# include "../../gtk2_ardour/mixbus_ports.h"
        boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
        if (!plug) {
                return boost::shared_ptr<AutomationControl>();
        }
-       const uint32_t port_channel_post_pan = 2; // gtk2_ardour/mixbus_ports.h
        return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_channel_post_pan)));
 #else
        if (!_pannable || !panner()) {
@@ -4896,6 +4947,12 @@ Route::pan_elevation_control() const
 boost::shared_ptr<AutomationControl>
 Route::pan_width_control() const
 {
+#ifdef MIXBUS
+       if (mixbus() && _ch_pre) {
+               //mono blend
+               return boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(_ch_pre->control(Evoral::Parameter(PluginAutomation, 0, 5)));
+       }
+#endif
        if (Profile->get_mixbus() || !_pannable || !panner()) {
                return boost::shared_ptr<AutomationControl>();
        }
@@ -5021,10 +5078,10 @@ Route::eq_freq_controllable (uint32_t band) const
        uint32_t port_number;
 #ifdef MIXBUS32C
        switch (band) {
-               case 0: port_number = 13; break;
-               case 1: port_number = 11; break;
-               case 2: port_number = 9; break;
-               case 3: port_number = 7; break;
+               case 0: port_number = 13; break; // lo
+               case 1: port_number = 11; break; // lo mid
+               case 2: port_number = 9; break; // hi mid
+               case 3: port_number = 7; break; // hi
                default:
                        return boost::shared_ptr<AutomationControl>();
        }
@@ -5053,6 +5110,22 @@ Route::eq_q_controllable (uint32_t band) const
 boost::shared_ptr<AutomationControl>
 Route::eq_shape_controllable (uint32_t band) const
 {
+#ifdef MIXBUS32C
+       boost::shared_ptr<PluginInsert> eq = ch_eq();
+       if (is_master() || mixbus() || !eq) {
+               return boost::shared_ptr<AutomationControl>();
+       }
+       switch (band) {
+               case 0:
+                       return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 4))); // lo bell
+                       break;
+               case 3:
+                       return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 3))); // hi bell
+                       break;
+               default:
+                       break;
+       }
+#endif
        return boost::shared_ptr<AutomationControl>();
 }
 
@@ -5073,7 +5146,7 @@ Route::eq_enable_controllable () const
 }
 
 boost::shared_ptr<AutomationControl>
-Route::eq_hpf_controllable () const
+Route::filter_freq_controllable (bool hpf) const
 {
 #ifdef MIXBUS
        boost::shared_ptr<PluginInsert> eq = ch_eq();
@@ -5081,17 +5154,47 @@ Route::eq_hpf_controllable () const
        if (is_master() || mixbus() || !eq) {
                return boost::shared_ptr<AutomationControl>();
        }
+       if (hpf) {
 #ifdef MIXBUS32C
-       return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 3)));
+               return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 5))); // HPF freq
 #else
-       return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 2)));
+               return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 2)));
+#endif
+       } else {
+#ifdef MIXBUS32C
+               return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 6))); // LPF freq
+#else
+               return boost::shared_ptr<AutomationControl>();
 #endif
+       }
 
 #else
        return boost::shared_ptr<AutomationControl>();
 #endif
 }
 
+boost::shared_ptr<AutomationControl>
+Route::filter_slope_controllable (bool) const
+{
+       return boost::shared_ptr<AutomationControl>();
+}
+
+boost::shared_ptr<AutomationControl>
+Route::filter_enable_controllable (bool) const
+{
+#ifdef MIXBUS32C
+       boost::shared_ptr<PluginInsert> eq = ch_eq();
+
+       if (is_master() || mixbus() || !eq) {
+               return boost::shared_ptr<AutomationControl>();
+       }
+
+       return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 2)));
+#else
+       return boost::shared_ptr<AutomationControl>();
+#endif
+}
+
 string
 Route::eq_band_name (uint32_t band) const
 {
@@ -5197,20 +5300,23 @@ Route::comp_makeup_controllable () const
        return boost::shared_ptr<AutomationControl>();
 #endif
 }
-boost::shared_ptr<AutomationControl>
+boost::shared_ptr<ReadOnlyControl>
 Route::comp_redux_controllable () const
 {
 #ifdef MIXBUS
        boost::shared_ptr<PluginInsert> comp = ch_comp();
 
        if (!comp) {
-               return boost::shared_ptr<AutomationControl>();
+               return boost::shared_ptr<ReadOnlyControl>();
+       }
+       if (is_master()) {
+               return comp->control_output (2);
+       } else {
+               return comp->control_output (6);
        }
 
-       // XXX redux is an output-port, query via comp->plugin(0)->get_parameter (6)
-       return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 6)));
 #else
-       return boost::shared_ptr<AutomationControl>();
+       return boost::shared_ptr<ReadOnlyControl>();
 #endif
 }
 
@@ -5258,71 +5364,122 @@ boost::shared_ptr<AutomationControl>
 Route::send_level_controllable (uint32_t n) const
 {
 #ifdef  MIXBUS
+# undef MIXBUS_PORTS_H
+# include "../../gtk2_ardour/mixbus_ports.h"
        boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
-       if (!plug) {
-               return boost::shared_ptr<AutomationControl>();
-       }
+       if (plug && !mixbus()) {
+               uint32_t port_id = 0;
+               switch (n) {
+                       case  0: port_id = port_channel_post_aux1_level; break;
+                       case  1: port_id = port_channel_post_aux2_level; break;
+                       case  2: port_id = port_channel_post_aux3_level; break;
+                       case  3: port_id = port_channel_post_aux4_level; break;
+                       case  4: port_id = port_channel_post_aux5_level; break;
+                       case  5: port_id = port_channel_post_aux6_level; break;
+                       case  6: port_id = port_channel_post_aux7_level; break;
+                       case  7: port_id = port_channel_post_aux8_level; break;
+# ifdef MIXBUS32C
+                       case  8: port_id = port_channel_post_aux9_level; break;
+                       case  9: port_id = port_channel_post_aux10_level; break;
+                       case 10: port_id = port_channel_post_aux11_level; break;
+                       case 11: port_id = port_channel_post_aux12_level; break;
+# endif
+                       default:
+                               break;
+               }
 
-       if (n >= 8) {
-               /* no such bus */
-               return boost::shared_ptr<AutomationControl>();
+               if (port_id > 0) {
+                       return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_id)));
+               }
+# ifdef MIXBUS32C
+               assert (n > 11);
+               n -= 12;
+# else
+               assert (n > 7);
+               n -= 8;
+# endif
        }
-
-       const uint32_t port_id = port_channel_post_aux1_level + (2*n); // gtk2_ardour/mixbus_ports.h
-       return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_id)));
-#else
+#endif
        boost::shared_ptr<Send> s = boost::dynamic_pointer_cast<Send>(nth_send (n));
        if (!s) {
                return boost::shared_ptr<AutomationControl>();
        }
        return s->gain_control ();
-#endif
 }
 
 boost::shared_ptr<AutomationControl>
 Route::send_enable_controllable (uint32_t n) const
 {
 #ifdef  MIXBUS
+# undef MIXBUS_PORTS_H
+# include "../../gtk2_ardour/mixbus_ports.h"
        boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
-       if (!plug) {
-               return boost::shared_ptr<AutomationControl>();
-       }
+       if (plug && !mixbus()) {
+               uint32_t port_id = 0;
+               switch (n) {
+                       case  0: port_id = port_channel_post_aux1_asgn; break;
+                       case  1: port_id = port_channel_post_aux2_asgn; break;
+                       case  2: port_id = port_channel_post_aux3_asgn; break;
+                       case  3: port_id = port_channel_post_aux4_asgn; break;
+                       case  4: port_id = port_channel_post_aux5_asgn; break;
+                       case  5: port_id = port_channel_post_aux6_asgn; break;
+                       case  6: port_id = port_channel_post_aux7_asgn; break;
+                       case  7: port_id = port_channel_post_aux8_asgn; break;
+# ifdef MIXBUS32C
+                       case  8: port_id = port_channel_post_aux9_asgn; break;
+                       case  9: port_id = port_channel_post_aux10_asgn; break;
+                       case 10: port_id = port_channel_post_aux11_asgn; break;
+                       case 11: port_id = port_channel_post_aux12_asgn; break;
+# endif
+                       default:
+                               break;
+               }
 
-       if (n >= 8) {
-               /* no such bus */
-               return boost::shared_ptr<AutomationControl>();
+               if (port_id > 0) {
+                       return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_id)));
+               }
+# ifdef MIXBUS32C
+               assert (n > 11);
+               n -= 12;
+# else
+               assert (n > 7);
+               n -= 8;
+# endif
        }
-
-       const uint32_t port_id = port_channel_post_aux1_asgn + (2*n); // gtk2_ardour/mixbus_ports.h
-       return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_id)));
-#else
+#endif
        /* although Ardour sends have enable/disable as part of the Processor
-          API, it is not exposed as a controllable.
-
-          XXX: we should fix this.
-       */
+        * API, it is not exposed as a controllable.
+        *
+        * XXX: we should fix this (make it click-free, automatable enable-control)
+        */
        return boost::shared_ptr<AutomationControl>();
-#endif
 }
 
 string
 Route::send_name (uint32_t n) const
 {
 #ifdef MIXBUS
-       if (n >= 8) {
-               return string();
-       }
-       boost::shared_ptr<Route> r = _session.get_mixbus (n);
-       assert (r);
-       return r->name();
+       boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
+       if (plug && !mixbus()) {
+# ifdef MIXBUS32C
+               if (n < 12) {
+                       return _session.get_mixbus (n)->name();
+               }
+               n -= 12;
 #else
+               if (n < 8) {
+                       return _session.get_mixbus (n)->name();
+               }
+               n -= 8;
+# endif
+       }
+#endif
        boost::shared_ptr<Processor> p = nth_send (n);
        if (p) {
                return p->name();
        } else {
                return string();
        }
-#endif
 }
 
 boost::shared_ptr<AutomationControl>
@@ -5333,6 +5490,8 @@ Route::master_send_enable_controllable () const
        if (!plug) {
                return boost::shared_ptr<AutomationControl>();
        }
+# undef MIXBUS_PORTS_H
+# include "../../gtk2_ardour/mixbus_ports.h"
        return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_channel_post_mstr_assign)));
 #else
        return boost::shared_ptr<AutomationControl>();
@@ -5376,3 +5535,33 @@ Route::clear_all_solo_state ()
 {
        _solo_control->clear_all_solo_state ();
 }
+
+boost::shared_ptr<AutomationControl>
+Route::automation_control_recurse (PBD::ID const & id) const
+{
+       boost::shared_ptr<AutomationControl> ac = Automatable::automation_control (id);
+
+       if (ac) {
+               return ac;
+       }
+
+       Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
+
+       for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
+               if ((ac = (*i)->automation_control (id))) {
+                       return ac;
+               }
+       }
+
+       return boost::shared_ptr<AutomationControl> ();
+}
+
+SlavableControlList
+Route::slavables () const
+{
+       SlavableControlList rv;
+       rv.push_back (_gain_control);
+       rv.push_back (_mute_control);
+       rv.push_back (_solo_control);
+       return rv;
+}