Route API to query all outputs (incl sends) and graph-feeds
[ardour.git] / libs / ardour / ardour / route.h
index 66464e4457daacae135adeb9fd7a016f6d77c6c9..5cda2f0d597f848fd7a9737fac5d0655d2b93607 100644 (file)
@@ -32,7 +32,7 @@
 #include <boost/dynamic_bitset.hpp>
 #include <boost/enable_shared_from_this.hpp>
 
-#include <glibmm/thread.h>
+#include <glibmm/threads.h>
 #include "pbd/fastlog.h"
 #include "pbd/xml++.h"
 #include "pbd/undo.h"
 #include "pbd/destructible.h"
 
 #include "ardour/ardour.h"
+#include "ardour/gain_control.h"
+#include "ardour/instrument_info.h"
 #include "ardour/io.h"
+#include "ardour/io_vector.h"
+#include "ardour/libardour_visibility.h"
 #include "ardour/types.h"
 #include "ardour/mute_master.h"
 #include "ardour/route_group_member.h"
@@ -52,6 +56,7 @@
 namespace ARDOUR {
 
 class Amp;
+class DelayLine;
 class Delivery;
 class IOProcessor;
 class Panner;
@@ -66,14 +71,14 @@ class Pannable;
 class CapturingProcessor;
 class InternalSend;
 
-class Route : public SessionObject, public Automatable, public RouteGroupMember, public GraphNode, public boost::enable_shared_from_this<Route>
+class LIBARDOUR_API Route : public SessionObject, public Automatable, public RouteGroupMember, public GraphNode, public boost::enable_shared_from_this<Route>
 {
   public:
 
        typedef std::list<boost::shared_ptr<Processor> > ProcessorList;
 
        enum Flag {
-               Hidden = 0x1,
+               Auditioner = 0x1,
                MasterOut = 0x2,
                MonitorOut = 0x4
        };
@@ -85,6 +90,8 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
 
        boost::shared_ptr<IO> input() const { return _input; }
        boost::shared_ptr<IO> output() const { return _output; }
+       IOVector all_inputs () const;
+       IOVector all_outputs () const;
 
        ChanCount n_inputs() const { return _input->n_ports(); }
        ChanCount n_outputs() const { return _output->n_ports(); }
@@ -98,67 +105,80 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        void set_comment (std::string str, void *src);
 
        bool set_name (const std::string& str);
+       static void set_name_in_state (XMLNode &, const std::string &, bool rename_playlist = true);
 
-       int32_t order_key (std::string const &) const;
-       void set_order_key (std::string const &, int32_t);
+        uint32_t order_key () const;
+        bool has_order_key () const;
+       void set_order_key (uint32_t);
 
-       bool is_hidden() const { return _flags & Hidden; }
+       bool is_auditioner() const { return _flags & Auditioner; }
        bool is_master() const { return _flags & MasterOut; }
        bool is_monitor() const { return _flags & MonitorOut; }
 
+       virtual MonitorState monitoring_state () const;
+       virtual MeterState metering_state () const;
+
        /* these are the core of the API of a Route. see the protected sections as well */
 
        virtual int roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
-                         int declick, bool can_record, bool& need_butler);
+                         int declick, bool& need_butler);
 
        virtual int no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
-                            bool state_changing, bool can_record);
+                            bool state_changing);
 
        virtual int silent_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
-                                bool can_record, bool& need_butler);
+                                bool& need_butler);
 
-       virtual void toggle_monitor_input ();
        virtual bool can_record() { return false; }
 
-       virtual void set_record_enabled (bool /*yn*/, void * /*src*/) {}
+       virtual void set_record_enabled (bool /*yn*/, PBD::Controllable::GroupControlDisposition) {}
        virtual bool record_enabled() const { return false; }
+       virtual void set_record_safe (bool /*yn*/, PBD::Controllable::GroupControlDisposition) {}
+       virtual bool record_safe () const {return false; }
        virtual void nonrealtime_handle_transport_stopped (bool abort, bool did_locate, bool flush_processors);
        virtual void realtime_handle_transport_stopped () {}
        virtual void realtime_locate () {}
+        virtual void non_realtime_locate (framepos_t);
        virtual void set_pending_declick (int);
 
        /* end of vfunc-based API */
 
-       void shift (framepos_t, framepos_t);
+       void shift (framepos_t, framecnt_t);
+
+       void set_gain (gain_t val, PBD::Controllable::GroupControlDisposition);
+       void inc_gain (gain_t delta);
 
-       void set_gain (gain_t val, void *src);
-       void inc_gain (gain_t delta, void *src);
+       void set_trim (gain_t val, PBD::Controllable::GroupControlDisposition);
 
        void set_mute_points (MuteMaster::MutePoint);
        MuteMaster::MutePoint mute_points () const;
 
        bool muted () const;
-       void set_mute (bool yn, void* src);
+       void set_mute (bool yn, PBD::Controllable::GroupControlDisposition);
+
+       bool muted_by_others() const;
 
        /* controls use set_solo() to modify this route's solo state
         */
 
-       void set_solo (bool yn, void *src);
+       void set_solo (bool yn, PBD::Controllable::GroupControlDisposition group_override = PBD::Controllable::UseGroup);
        bool soloed () const { return self_soloed () || soloed_by_others (); }
+       void clear_all_solo_state ();
 
        bool soloed_by_others () const { return _soloed_by_others_upstream||_soloed_by_others_downstream; }
        bool soloed_by_others_upstream () const { return _soloed_by_others_upstream; }
        bool soloed_by_others_downstream () const { return _soloed_by_others_downstream; }
        bool self_soloed () const { return _self_solo; }
 
-       void set_solo_isolated (bool yn, void *src);
+       void set_solo_isolated (bool yn, PBD::Controllable::GroupControlDisposition group_override = PBD::Controllable::UseGroup);
        bool solo_isolated() const;
 
-       void set_solo_safe (bool yn, void *src);
+       void set_solo_safe (bool yn, PBD::Controllable::GroupControlDisposition group_override = PBD::Controllable::UseGroup);
        bool solo_safe() const;
 
-       void set_listen (bool yn, void* src);
+       void set_listen (bool yn, PBD::Controllable::GroupControlDisposition group_override = PBD::Controllable::UseGroup);
        bool listening_via_monitor () const;
+       void enable_monitor_send ();
 
        void set_phase_invert (uint32_t, bool yn);
        void set_phase_invert (boost::dynamic_bitset<>);
@@ -169,31 +189,33 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        bool denormal_protection() const;
 
        void         set_meter_point (MeterPoint, bool force = false);
-       void         infer_meter_point () const;
-       MeterPoint   meter_point() const { return _meter_point; }
-       void         meter ();
+       bool         apply_processor_changes_rt ();
+       void         emit_pending_signals ();
+       MeterPoint   meter_point() const { return _pending_meter_point; }
+
+       void         set_meter_type (MeterType t) { _meter_type = t; }
+       MeterType    meter_type() const { return _meter_type; }
 
        /* Processors */
 
        boost::shared_ptr<Amp> amp() const  { return _amp; }
+       boost::shared_ptr<Amp> trim() const { return _trim; }
        PeakMeter&       peak_meter()       { return *_meter.get(); }
        const PeakMeter& peak_meter() const { return *_meter.get(); }
        boost::shared_ptr<PeakMeter> shared_peak_meter() const { return _meter; }
+       boost::shared_ptr<DelayLine> delay_line() const  { return _delayline; }
 
        void flush_processors ();
 
        void foreach_processor (boost::function<void(boost::weak_ptr<Processor>)> method) {
-               Glib::RWLock::ReaderLock lm (_processor_lock);
+               Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
                for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
-                       if (boost::dynamic_pointer_cast<UnknownProcessor> (*i)) {
-                               break;
-                       }
                        method (boost::weak_ptr<Processor> (*i));
                }
        }
 
        boost::shared_ptr<Processor> nth_processor (uint32_t n) {
-               Glib::RWLock::ReaderLock lm (_processor_lock);
+               Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
                ProcessorList::iterator i;
                for (i = _processors.begin(); i != _processors.end() && n; ++i, --n) {}
                if (i == _processors.end()) {
@@ -203,10 +225,10 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
                }
        }
 
-       boost::shared_ptr<Processor> nth_plugin (uint32_t n);
-       boost::shared_ptr<Processor> nth_send (uint32_t n);
+       boost::shared_ptr<Processor> processor_by_id (PBD::ID) const;
 
-       bool processor_is_prefader (boost::shared_ptr<Processor> p);
+       boost::shared_ptr<Processor> nth_plugin (uint32_t n) const;
+       boost::shared_ptr<Processor> nth_send (uint32_t n) const;
 
        bool has_io_processor_named (const std::string&);
        ChanCount max_processor_streams () const { return processor_max_streams; }
@@ -237,9 +259,14 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        };
 
        int add_processor (boost::shared_ptr<Processor>, Placement placement, ProcessorStreams* err = 0, bool activation_allowed = true);
-       int add_processor (boost::shared_ptr<Processor>, ProcessorList::iterator iter, ProcessorStreams* err = 0, bool activation_allowed = true);
-       int add_processors (const ProcessorList&, boost::shared_ptr<Processor> before, ProcessorStreams* err = 0);
-       int remove_processor (boost::shared_ptr<Processor>, ProcessorStreams* err = 0);
+       int add_processor_by_index (boost::shared_ptr<Processor>, int, ProcessorStreams* err = 0, bool activation_allowed = true);
+       int add_processor (boost::shared_ptr<Processor>, boost::shared_ptr<Processor>, ProcessorStreams* err = 0, bool activation_allowed = true);
+       int add_processors (const ProcessorList&, boost::shared_ptr<Processor>, ProcessorStreams* err = 0);
+       boost::shared_ptr<Processor> before_processor_for_placement (Placement);
+       boost::shared_ptr<Processor> before_processor_for_index (int);
+       bool processors_reorder_needs_configure (const ProcessorList& new_order);
+       int remove_processor (boost::shared_ptr<Processor>, ProcessorStreams* err = 0, bool need_process_lock = true);
+       int replace_processor (boost::shared_ptr<Processor>, boost::shared_ptr<Processor>, ProcessorStreams* err = 0);
        int remove_processors (const ProcessorList&, ProcessorStreams* err = 0);
        int reorder_processors (const ProcessorList& new_order, ProcessorStreams* err = 0);
        void disable_processors (Placement);
@@ -248,8 +275,15 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        void disable_plugins ();
        void ab_plugins (bool forward);
        void clear_processors (Placement);
-       void all_processors_flip();
-       void all_processors_active (Placement, bool state);
+       void all_visible_processors_active (bool);
+
+       bool strict_io () const { return _strict_io; }
+       bool set_strict_io (bool);
+       bool reset_plugin_insert (boost::shared_ptr<Processor> proc);
+       bool customize_plugin_insert (boost::shared_ptr<Processor> proc, uint32_t count, ChanCount outs);
+       bool add_remove_sidechain (boost::shared_ptr<Processor> proc, bool);
+       bool add_sidechain (boost::shared_ptr<Processor> proc) { return add_remove_sidechain (proc, true); }
+       bool remove_sidechain (boost::shared_ptr<Processor> proc) { return add_remove_sidechain (proc, false); }
 
        framecnt_t set_private_port_latencies (bool playback) const;
        void       set_public_port_latencies (framecnt_t, bool playback) const;
@@ -264,14 +298,29 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        PBD::Signal0<void>       active_changed;
        PBD::Signal0<void>       phase_invert_changed;
        PBD::Signal0<void>       denormal_protection_changed;
-       PBD::Signal1<void,void*> listen_changed;
-       PBD::Signal2<void,bool,void*> solo_changed;
-       PBD::Signal1<void,void*> solo_safe_changed;
-       PBD::Signal1<void,void*> solo_isolated_changed;
-       PBD::Signal1<void,void*> comment_changed;
-       PBD::Signal1<void,void*> mute_changed;
+       PBD::Signal1<void,PBD::Controllable::GroupControlDisposition>  listen_changed;
+       PBD::Signal2<void,bool,PBD::Controllable::GroupControlDisposition>  solo_changed;
+       PBD::Signal0<void>       solo_safe_changed;
+       PBD::Signal0<void>       solo_isolated_changed;
+       PBD::Signal0<void>       comment_changed;
+       PBD::Signal0<void>       mute_changed;
        PBD::Signal0<void>       mute_points_changed;
 
+       /** track numbers - assigned by session
+        * nubers > 0 indicate tracks (audio+midi)
+        * nubers < 0 indicate busses
+        * zero is reserved for unnumbered special busses.
+        * */
+       PBD::Signal0<void> track_number_changed;
+       int64_t track_number() const { return _track_number; }
+
+       void set_track_number(int64_t tn) {
+               if (tn == _track_number) { return; }
+               _track_number = tn;
+               track_number_changed();
+               PropertyChanged (ARDOUR::Properties::name);
+       }
+
        /** the processors have changed; the parameter indicates what changed */
        PBD::Signal1<void,RouteProcessorChange> processors_changed;
        PBD::Signal1<void,void*> record_enable_changed;
@@ -279,7 +328,6 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        PBD::Signal0<void>       meter_change;
        PBD::Signal0<void>       signal_latency_changed;
        PBD::Signal0<void>       initial_delay_changed;
-       PBD::Signal0<void>       order_key_changed;
 
        /** Emitted with the process lock held */
        PBD::Signal0<void>       io_changed;
@@ -291,7 +339,7 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        /* stateful */
 
        XMLNode& get_state();
-       int set_state (const XMLNode&, int version);
+       virtual int set_state (const XMLNode&, int version);
        virtual XMLNode& get_template();
 
        XMLNode& get_processor_state ();
@@ -301,9 +349,8 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
 
        PBD::Signal1<void,void*> SelectedChanged;
 
-       int listen_via_monitor ();
-       int listen_via (boost::shared_ptr<Route>, Placement p);
-       void drop_listen (boost::shared_ptr<Route>);
+       int add_aux_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>);
+       void remove_aux_or_listen (boost::shared_ptr<Route>);
 
        /**
         * return true if this route feeds the first argument via at least one
@@ -313,9 +360,19 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
 
        /**
         * return true if this route feeds the first argument directly, via
-        * either its main outs or a send.
+        * either its main outs or a send.  This is checked by the actual
+        * connections, rather than by what the graph is currently doing.
         */
-       bool direct_feeds (boost::shared_ptr<Route>, bool* via_send_only = 0);
+       bool direct_feeds_according_to_reality (boost::shared_ptr<Route>, bool* via_send_only = 0);
+
+       /**
+        * return true if this route feeds the first argument directly, via
+        * either its main outs or a send, according to the graph that
+        * is currently being processed.
+        */
+       bool direct_feeds_according_to_graph (boost::shared_ptr<Route>, bool* via_send_only = 0);
+
+       bool feeds_according_to_graph (boost::shared_ptr<Route>);
 
        struct FeedRecord {
                boost::weak_ptr<Route> r;
@@ -337,37 +394,116 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        const FedBy& fed_by() const { return _fed_by; }
        void clear_fed_by ();
        bool add_fed_by (boost::shared_ptr<Route>, bool sends_only);
-       bool not_fed() const { return _fed_by.empty(); }
 
-       /* Controls (not all directly owned by the Route */
+       /* Controls (not all directly owned by the Route) */
 
        boost::shared_ptr<AutomationControl> get_control (const Evoral::Parameter& param);
 
-       class SoloControllable : public AutomationControl {
+       class RouteAutomationControl : public AutomationControl {
+       public:
+               RouteAutomationControl (const std::string& name,
+                                       AutomationType atype,
+                                       boost::shared_ptr<AutomationList> alist,
+                                       boost::shared_ptr<Route> route);
+       protected:
+               friend class Route;
+
+               void route_set_value (double val) {
+                       AutomationControl::set_value (val, Controllable::NoGroup);
+               }
+
+               boost::weak_ptr<Route> _route;
+       };
+
+       class GainControllable : public GainControl  {
+       public:
+               GainControllable (Session& session,
+                                 AutomationType type,
+                                 boost::shared_ptr<Route> route);
+
+               void set_value (double val, PBD::Controllable::GroupControlDisposition group_override) {
+                       boost::shared_ptr<Route> r = _route.lock();
+                       if (r) {
+                               /* Route must mediate group control */
+                               r->set_control ((AutomationType) parameter().type(), val, group_override);
+                       }
+               }
+
+       protected:
+               friend class Route;
+
+               void route_set_value (double val) {
+                       GainControl::set_value (val, Controllable::NoGroup);
+               }
+
+               boost::weak_ptr<Route> _route;
+       };
+
+       class SoloControllable : public RouteAutomationControl {
        public:
                SoloControllable (std::string name, boost::shared_ptr<Route>);
-               void set_value (double);
+               void set_value (double, PBD::Controllable::GroupControlDisposition group_override);
+               void set_value_unchecked (double);
                double get_value () const;
-
        private:
-               boost::weak_ptr<Route> _route;
+               void _set_value (double, PBD::Controllable::GroupControlDisposition group_override);
        };
 
-       struct MuteControllable : public AutomationControl {
+       struct MuteControllable : public RouteAutomationControl {
        public:
                MuteControllable (std::string name, boost::shared_ptr<Route>);
-               void set_value (double);
+               void set_value (double, PBD::Controllable::GroupControlDisposition group_override);
+               void set_value_unchecked (double);
                double get_value () const;
 
+               /* Pretend to change value, but do not affect actual route mute. */
+               void set_superficial_value(bool muted);
+
        private:
                boost::weak_ptr<Route> _route;
+               void _set_value (double, PBD::Controllable::GroupControlDisposition group_override);
+       };
+
+       class LIBARDOUR_API PhaseControllable : public RouteAutomationControl {
+       public:
+               PhaseControllable (std::string name, boost::shared_ptr<Route>);
+               void set_value (double, PBD::Controllable::GroupControlDisposition group_override);
+               /* currently no automation, so no need for set_value_unchecked() */
+               void set_channel (uint32_t);
+               double get_value () const;
+               uint32_t channel() const;
+       private:
+               uint32_t _current_phase;
+               void _set_value (double, PBD::Controllable::GroupControlDisposition group_override);
+       };
+
+       class LIBARDOUR_API SoloIsolateControllable : public RouteAutomationControl {
+       public:
+               SoloIsolateControllable (std::string name, boost::shared_ptr<Route>);
+               void set_value (double, PBD::Controllable::GroupControlDisposition group_override);
+               /* currently no automation, so no need for set_value_unchecked() */
+               double get_value () const;
+       private:
+               void _set_value (double, PBD::Controllable::GroupControlDisposition group_override);
+       };
+
+       class LIBARDOUR_API SoloSafeControllable : public RouteAutomationControl {
+       public:
+               SoloSafeControllable (std::string name, boost::shared_ptr<Route>);
+               void set_value (double, PBD::Controllable::GroupControlDisposition group_override);
+               /* currently no automation, so no need for set_value_unchecked() */
+               double get_value () const;
+       private:
+               void _set_value (double, PBD::Controllable::GroupControlDisposition group_override);
        };
 
-       boost::shared_ptr<AutomationControl> solo_control() const {
+       void set_control (AutomationType, double val, PBD::Controllable::GroupControlDisposition group_override);
+
+       boost::shared_ptr<SoloControllable> solo_control() const {
                return _solo_control;
        }
 
-       boost::shared_ptr<AutomationControl> mute_control() const {
+       boost::shared_ptr<MuteControllable> mute_control() const {
                return _mute_control;
        }
 
@@ -375,6 +511,21 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
                return _mute_master;
        }
 
+       boost::shared_ptr<SoloIsolateControllable> solo_isolate_control() const {
+               return _solo_isolate_control;
+       }
+
+       boost::shared_ptr<SoloSafeControllable> solo_safe_control() const {
+               return _solo_safe_control;
+       }
+
+       boost::shared_ptr<AutomationControl> monitoring_control() const {
+               /* tracks override this to provide actual monitoring control;
+                  busses have no possible choices except input monitoring.
+               */
+               return boost::shared_ptr<AutomationControl> ();
+       }
+
        /* Route doesn't own these items, but sub-objects that it does own have them
           and to make UI code a bit simpler, we provide direct access to them
           here.
@@ -382,25 +533,119 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
 
        boost::shared_ptr<Panner> panner() const;  /* may return null */
        boost::shared_ptr<PannerShell> panner_shell() const;
-       boost::shared_ptr<AutomationControl> gain_control() const;
+       boost::shared_ptr<GainControl> gain_control() const;
        boost::shared_ptr<Pannable> pannable() const;
+       boost::shared_ptr<GainControl> trim_control() const;
 
-       void automation_snapshot (framepos_t now, bool force=false);
-       void protect_automation ();
+       boost::shared_ptr<PhaseControllable> phase_control() const;
+
+       /**
+          Return the first processor that accepts has at least one MIDI input
+          and at least one audio output. In the vast majority of cases, this
+          will be "the instrument". This does not preclude other MIDI->audio
+          processors later in the processing chain, but that would be a
+          special case not covered by this utility function.
+       */
+       boost::shared_ptr<Processor> the_instrument() const;
+        InstrumentInfo& instrument_info() { return _instrument_info; }
+
+        /* "well-known" controls for panning. Any or all of these may return
+         * null.
+         */
+
+        boost::shared_ptr<AutomationControl> pan_azimuth_control() const;
+        boost::shared_ptr<AutomationControl> pan_elevation_control() const;
+        boost::shared_ptr<AutomationControl> pan_width_control() const;
+        boost::shared_ptr<AutomationControl> pan_frontback_control() const;
+        boost::shared_ptr<AutomationControl> pan_lfe_control() const;
+
+        /* "well-known" controls for an EQ in this route. Any or all may
+         * be null. eq_band_cnt() must return 0 if there is no EQ present.
+         * Passing an @param band value >= eq_band_cnt() will guarantee the
+         * return of a null ptr (or an empty string for eq_band_name()).
+         */
+        uint32_t eq_band_cnt () const;
+        std::string eq_band_name (uint32_t) const;
+        boost::shared_ptr<AutomationControl> eq_gain_controllable (uint32_t band) const;
+        boost::shared_ptr<AutomationControl> eq_freq_controllable (uint32_t band) const;
+        boost::shared_ptr<AutomationControl> eq_q_controllable (uint32_t band) const;
+        boost::shared_ptr<AutomationControl> eq_shape_controllable (uint32_t band) const;
+        boost::shared_ptr<AutomationControl> eq_enable_controllable () const;
+        boost::shared_ptr<AutomationControl> eq_hpf_controllable () const;
+
+        /* "well-known" controls for a compressor in this route. Any or all may
+         * be null.
+         */
+        boost::shared_ptr<AutomationControl> comp_enable_controllable () const;
+        boost::shared_ptr<AutomationControl> comp_threshold_controllable () const;
+        boost::shared_ptr<AutomationControl> comp_speed_controllable () const;
+        boost::shared_ptr<AutomationControl> comp_mode_controllable () const;
+        boost::shared_ptr<AutomationControl> comp_makeup_controllable () const;
+        boost::shared_ptr<AutomationControl> comp_redux_controllable () const;
+
+        /* @param mode must be supplied by the comp_mode_controllable(). All other values
+         * result in undefined behaviour
+         */
+        std::string comp_mode_name (uint32_t mode) const;
+        /* @param mode - as for comp mode name. This returns the name for the
+         * parameter/control accessed via comp_speed_controllable(), which can
+         * be mode dependent.
+         */
+        std::string comp_speed_name (uint32_t mode) const;
+
+        /* "well-known" controls for sends to well-known busses in this route. Any or all may
+         * be null.
+         *
+         * In Mixbus, these are the sends that connect to the mixbusses.
+         * In Ardour, these are user-created sends that connect to user-created
+         * Aux busses.
+         */
+        boost::shared_ptr<AutomationControl> send_level_controllable (uint32_t n) const;
+        boost::shared_ptr<AutomationControl> send_enable_controllable (uint32_t n) const;
+        /* for the same value of @param n, this returns the name of the send
+         * associated with the pair of controllables returned by the above two methods.
+         */
+        std::string send_name (uint32_t n) const;
+
+        /* well known control that enables/disables sending to the master bus.
+         *
+         * In Ardour, this returns null.
+         * In Mixbus, it will return a suitable control, or null depending on
+         * the route.
+         */
+        boost::shared_ptr<AutomationControl> master_send_enable_controllable () const;
+
+        void protect_automation ();
+
+       enum {
+               /* These numbers are taken from MIDI Machine Control,
+                  which can only control up to 317 tracks without
+                  doing sysex segmentation.
+               */
+               MasterBusRemoteControlID = 318,
+               MonitorBusRemoteControlID = 319,
+       };
 
-       void set_remote_control_id (uint32_t id, bool notify_class_listeners = true);
+       void     set_remote_control_id (uint32_t id, bool notify_class_listeners = true);
        uint32_t remote_control_id () const;
+        void     set_remote_control_id_explicit (uint32_t order_key);
 
        /* for things concerned about *this* route's RID */
 
        PBD::Signal0<void> RemoteControlIDChanged;
 
-       /* for things concerned about any route's RID changes */
+       /* for things concerned about *any* route's RID changes */
 
        static PBD::Signal0<void> RemoteControlIDChange;
+       static PBD::Signal0<void> SyncOrderKeys;
+
+       bool has_external_redirects() const;
 
-       void sync_order_keys (std::string const &);
-       static PBD::Signal1<void,std::string const &> SyncOrderKeys;
+        /* can only be executed by a route for which is_monitor() is true
+          (i.e. the monitor out)
+        */
+        void monitor_run (framepos_t start_frame, framepos_t end_frame,
+                         pframes_t nframes, int declick);
 
   protected:
        friend class Session;
@@ -408,49 +653,75 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        void catch_up_on_solo_mute_override ();
        void mod_solo_by_others_upstream (int32_t);
        void mod_solo_by_others_downstream (int32_t);
-       bool has_external_redirects() const;
        void curve_reallocate ();
-       void just_meter_input (framepos_t start_frame, framepos_t end_frame, pframes_t nframes);
        virtual void set_block_size (pframes_t nframes);
 
   protected:
-       virtual framecnt_t check_initial_delay (framecnt_t nframes, framecnt_t&) { return nframes; }
+       virtual framecnt_t check_initial_delay (framecnt_t nframes, framepos_t&) { return nframes; }
+
+        void fill_buffers_with_input (BufferSet& bufs, boost::shared_ptr<IO> io, pframes_t nframes);
 
-       void passthru (framepos_t start_frame, framepos_t end_frame,
+        void passthru (BufferSet&, framepos_t start_frame, framepos_t end_frame,
                        pframes_t nframes, int declick);
 
        virtual void write_out_of_band_data (BufferSet& /* bufs */, framepos_t /* start_frame */, framepos_t /* end_frame */,
-                       framecnt_t /* nframes */) {}
+                                            framecnt_t /* nframes */) {}
 
        virtual void process_output_buffers (BufferSet& bufs,
                                             framepos_t start_frame, framepos_t end_frame,
-                                            pframes_t nframes, bool with_processors, int declick,
+                                            pframes_t nframes, int declick,
                                             bool gain_automation_ok);
 
+       virtual void bounce_process (BufferSet& bufs,
+                                    framepos_t start_frame, framecnt_t nframes,
+                                                                                                                        boost::shared_ptr<Processor> endpoint, bool include_endpoint,
+                                    bool for_export, bool for_freeze);
+
+       framecnt_t   bounce_get_latency (boost::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export, bool for_freeze) const;
+       ChanCount    bounce_get_output_streams (ChanCount &cc, boost::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export, bool for_freeze) const;
+
        boost::shared_ptr<IO> _input;
        boost::shared_ptr<IO> _output;
 
        bool           _active;
        framecnt_t     _signal_latency;
+       framecnt_t     _signal_latency_at_amp_position;
+       framecnt_t     _signal_latency_at_trim_position;
        framecnt_t     _initial_delay;
        framecnt_t     _roll_delay;
 
        ProcessorList  _processors;
-       mutable Glib::RWLock   _processor_lock;
+       mutable Glib::Threads::RWLock   _processor_lock;
        boost::shared_ptr<Delivery> _main_outs;
        boost::shared_ptr<InternalSend> _monitor_send;
        boost::shared_ptr<InternalReturn> _intreturn;
        boost::shared_ptr<MonitorProcessor> _monitor_control;
        boost::shared_ptr<Pannable> _pannable;
 
+       enum {
+               EmitNone = 0x00,
+               EmitMeterChanged = 0x01,
+               EmitMeterVisibilityChange = 0x02,
+               EmitRtProcessorChange = 0x04
+       };
+
+       ProcessorList  _pending_processor_order;
+       gint           _pending_process_reorder; // atomic
+       gint           _pending_signals; // atomic
+
        Flag           _flags;
        int            _pending_declick;
        MeterPoint     _meter_point;
+       MeterPoint     _pending_meter_point;
+       MeterType      _meter_type;
        boost::dynamic_bitset<> _phase_invert;
        bool           _self_solo;
        uint32_t       _soloed_by_others_upstream;
        uint32_t       _soloed_by_others_downstream;
-       uint32_t       _solo_isolated;
+       bool           _solo_isolated;
+       uint32_t       _solo_isolated_by_upstream;
+
+       void mod_solo_isolated_by_upstream (bool);
 
        bool           _denormal_protection;
 
@@ -461,6 +732,11 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        boost::shared_ptr<SoloControllable> _solo_control;
        boost::shared_ptr<MuteControllable> _mute_control;
        boost::shared_ptr<MuteMaster> _mute_master;
+       boost::shared_ptr<PhaseControllable> _phase_control;
+       boost::shared_ptr<SoloIsolateControllable> _solo_isolate_control;
+       boost::shared_ptr<SoloSafeControllable> _solo_safe_control;
+
+       virtual void act_on_mute () {}
 
        std::string    _comment;
        bool           _have_internal_generator;
@@ -468,6 +744,8 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        DataType       _default_type;
        FedBy          _fed_by;
 
+        InstrumentInfo _instrument_info;
+
        virtual ChanCount input_streams () const;
 
   protected:
@@ -482,36 +760,47 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        void silence_unlocked (framecnt_t);
 
        ChanCount processor_max_streams;
-       uint32_t _remote_control_id;
+       ChanCount processor_out_streams;
 
        uint32_t pans_required() const;
        ChanCount n_process_buffers ();
 
-       virtual bool should_monitor () const;
        virtual void maybe_declick (BufferSet&, framecnt_t, int);
 
-       virtual int  _set_state (const XMLNode&, int, bool call_base);
-
+       boost::shared_ptr<GainControllable> _gain_control;
        boost::shared_ptr<Amp>       _amp;
+       boost::shared_ptr<GainControllable> _trim_control;
+       boost::shared_ptr<Amp>       _trim;
        boost::shared_ptr<PeakMeter> _meter;
+       boost::shared_ptr<DelayLine> _delayline;
+
+       boost::shared_ptr<Processor> the_instrument_unlocked() const;
 
   private:
-       int _set_state_2X (const XMLNode&, int);
+       int set_state_2X (const XMLNode&, int);
        void set_processor_state_2X (XMLNodeList const &, int);
 
-       static uint32_t order_key_cnt;
+       uint32_t _order_key;
+       bool _has_order_key;
+        uint32_t _remote_control_id;
 
-       typedef std::map<std::string, long> OrderKeys;
-       OrderKeys order_keys;
+       int64_t _track_number;
 
        void input_change_handler (IOChange, void *src);
        void output_change_handler (IOChange, void *src);
+       void sidechain_change_handler (IOChange, void *src);
 
        bool input_port_count_changing (ChanCount);
+       bool output_port_count_changing (ChanCount);
 
        bool _in_configure_processors;
+       bool _initial_io_setup;
+       bool _in_sidechain_setup;
 
        int configure_processors_unlocked (ProcessorStreams*);
+       bool set_meter_point_unlocked ();
+       void apply_processor_order (const ProcessorList& new_order);
+
        std::list<std::pair<ChanCount, ChanCount> > try_configure_processors (ChanCount, ProcessorStreams *);
        std::list<std::pair<ChanCount, ChanCount> > try_configure_processors_unlocked (ChanCount, ProcessorStreams *);
 
@@ -528,6 +817,8 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        void setup_invisible_processors ();
        void unpan ();
 
+       void set_plugin_state_dir (boost::weak_ptr<Processor>, const std::string&);
+
        boost::shared_ptr<CapturingProcessor> _capturing_processor;
 
        /** A handy class to keep processor state while we attempt a reconfiguration
@@ -557,8 +848,23 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
 
        friend class ProcessorState;
 
+       bool _strict_io;
+
        /* no copy construction */
        Route (Route const &);
+
+       void maybe_note_meter_position ();
+
+       /** true if we've made a note of a custom meter position in these variables */
+       bool _custom_meter_position_noted;
+       /** the processor that came after the meter when it was last set to a custom position,
+           or 0.
+       */
+       boost::weak_ptr<Processor> _processor_after_last_custom_meter;
+
+        void reset_instrument_info ();
+
+        void set_remote_control_id_internal (uint32_t id, bool notify_class_listeners = true);
 };
 
 } // namespace ARDOUR