US2400: send_pan_azimuth lookup function (currently mb-only)
[ardour.git] / libs / ardour / ardour / route.h
index cf7ec90fd1dfe37d29d403fe25ba5b9dc1ecbea9..235ae2089b7c7c7ec1c5b1d1c71a764240380864 100644 (file)
@@ -14,7 +14,6 @@
     You should have received a copy of the GNU General Public License
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
 */
 
 #ifndef __ardour_route_h__
@@ -29,8 +28,6 @@
 
 #include <boost/shared_ptr.hpp>
 #include <boost/weak_ptr.hpp>
-#include <boost/dynamic_bitset.hpp>
-#include <boost/enable_shared_from_this.hpp>
 
 #include <glibmm/threads.h>
 #include "pbd/fastlog.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/monitorable.h"
+#include "ardour/muteable.h"
 #include "ardour/mute_master.h"
+#include "ardour/mute_control.h"
 #include "ardour/route_group_member.h"
+#include "ardour/stripable.h"
 #include "ardour/graphnode.h"
 #include "ardour/automatable.h"
 #include "ardour/unknown_processor.h"
+#include "ardour/soloable.h"
+#include "ardour/solo_control.h"
+#include "ardour/solo_safe_control.h"
+#include "ardour/slavable.h"
+
+class RoutePinWindowProxy;
+class PatchChangeGridDialog;
 
 namespace ARDOUR {
 
 class Amp;
 class DelayLine;
 class Delivery;
+class DiskReader;
+class DiskWriter;
 class IOProcessor;
 class Panner;
 class PannerShell;
 class PortSet;
 class Processor;
+class PluginInsert;
 class RouteGroup;
 class Send;
 class InternalReturn;
+class MonitorControl;
 class MonitorProcessor;
 class Pannable;
 class CapturingProcessor;
 class InternalSend;
-
-class LIBARDOUR_API Route : public SessionObject, public Automatable, public RouteGroupMember, public GraphNode, public boost::enable_shared_from_this<Route>
+class VCA;
+class SoloIsolateControl;
+class PhaseControl;
+class MonitorControl;
+
+class LIBARDOUR_API Route : public Stripable,
+                            public GraphNode,
+                            public Soloable,
+                            public Muteable,
+                            public Monitorable,
+                            public RouteGroupMember
 {
-  public:
+public:
 
        typedef std::list<boost::shared_ptr<Processor> > ProcessorList;
 
-       enum Flag {
-               Auditioner = 0x1,
-               MasterOut = 0x2,
-               MonitorOut = 0x4
-       };
-
-       Route (Session&, std::string name, Flag flags = Flag(0), DataType default_type = DataType::AUDIO);
+       Route (Session&, std::string name, PresentationInfo::Flag flags = PresentationInfo::Flag(0), DataType default_type = DataType::AUDIO);
        virtual ~Route();
 
        virtual int init ();
 
+       DataType data_type () const {
+               /* XXX ultimately nice to do away with this concept, but it is
+                  quite useful for coders and for users too.
+               */
+               return _default_type;
+       }
+
        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(); }
@@ -101,87 +127,58 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
        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 &);
-
-        uint32_t order_key () const;
-        bool has_order_key () const;
-       void set_order_key (uint32_t);
+       static void set_name_in_state (XMLNode &, const std::string &, bool rename_playlist = true);
 
-       bool is_auditioner() const { return _flags & Auditioner; }
-       bool is_master() const { return _flags & MasterOut; }
-       bool is_monitor() const { return _flags & MonitorOut; }
+       boost::shared_ptr<MonitorControl> monitoring_control() const { return _monitoring_control; }
 
-       virtual MonitorState monitoring_state () const;
+       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& need_butler);
+       virtual void filter_input (BufferSet &) {}
 
-       virtual int no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
-                            bool state_changing);
+       int roll (pframes_t nframes, samplepos_t start_sample, samplepos_t end_sample, int declick, bool& need_butler);
 
-       virtual int silent_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
-                                bool& need_butler);
+       int no_roll (pframes_t nframes, samplepos_t start_sample, samplepos_t end_sample, bool state_changing);
+
+       int silent_roll (pframes_t nframes, samplepos_t start_sample, samplepos_t end_sample, bool& need_butler);
 
        virtual bool can_record() { return false; }
 
-       virtual void set_record_enabled (bool /*yn*/, void * /*src*/) {}
-       virtual bool record_enabled() const { return false; }
-       virtual void set_record_safe (bool yn, void *src) {}
-       virtual bool record_safe () const {return false; }
-       virtual void nonrealtime_handle_transport_stopped (bool abort, bool did_locate, bool flush_processors);
+       virtual void non_realtime_transport_stop (samplepos_t now, bool flush);
        virtual void realtime_handle_transport_stopped () {}
        virtual void realtime_locate () {}
-        virtual void non_realtime_locate (framepos_t);
+       virtual void non_realtime_locate (samplepos_t);
        virtual void set_pending_declick (int);
 
        /* end of vfunc-based API */
 
-       void shift (framepos_t, framecnt_t);
-
-       void set_gain (gain_t val, void *src);
-       void inc_gain (gain_t delta, void *src);
-
-       void set_trim (gain_t val, void *src);
-       void inc_trim (gain_t delta, void *src);
-
-       void set_mute_points (MuteMaster::MutePoint);
-       MuteMaster::MutePoint mute_points () const;
-
-       bool muted () const;
-       void set_mute (bool yn, void* src);
+       void shift (samplepos_t, samplecnt_t);
 
-       bool muted_by_others() const;
+       void set_trim (gain_t val, PBD::Controllable::GroupControlDisposition);
 
        /* controls use set_solo() to modify this route's solo state
         */
 
-       void set_solo (bool yn, void *src);
-       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);
-       bool solo_isolated() const;
-
-       void set_solo_safe (bool yn, void *src);
-       bool solo_safe() const;
+       bool soloed_by_others () const { return _solo_control->soloed_by_others(); }
+       bool soloed_by_others_upstream () const { return _solo_control->soloed_by_others_upstream(); }
+       bool soloed_by_others_downstream () const { return _solo_control->soloed_by_others_downstream(); }
+       bool self_soloed () const { return _solo_control->self_soloed(); }
+       bool soloed () const { return self_soloed () || soloed_by_others (); }
 
-       void set_listen (bool yn, void* src);
-       bool listening_via_monitor () const;
+       void push_solo_upstream (int32_t delta);
+       void push_solo_isolate_upstream (int32_t delta);
+       bool can_solo () const {
+               return !(is_master() || is_monitor() || is_auditioner());
+       }
+       bool is_safe () const {
+               return _solo_safe_control->get_value();
+       }
        void enable_monitor_send ();
 
-       void set_phase_invert (uint32_t, bool yn);
-       void set_phase_invert (boost::dynamic_bitset<>);
-       bool phase_invert (uint32_t) const;
-       boost::dynamic_bitset<> phase_invert () const;
-
        void set_denormal_protection (bool yn);
        bool denormal_protection() const;
 
@@ -193,14 +190,16 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
        void         set_meter_type (MeterType t) { _meter_type = t; }
        MeterType    meter_type() const { return _meter_type; }
 
+       void set_disk_io_point (DiskIOPoint);
+       DiskIOPoint disk_io_point() const { return _disk_io_point; }
+
        /* 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>       peak_meter()       { return _meter; }
+       boost::shared_ptr<const PeakMeter> peak_meter() const { return _meter; }
        boost::shared_ptr<PeakMeter> shared_peak_meter() const { return _meter; }
-       boost::shared_ptr<DelayLine> delay_line() const  { return _delayline; }
 
        void flush_processors ();
 
@@ -224,17 +223,26 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
 
        boost::shared_ptr<Processor> processor_by_id (PBD::ID) const;
 
-       boost::shared_ptr<Processor> nth_plugin (uint32_t n);
-       boost::shared_ptr<Processor> nth_send (uint32_t n);
+       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; }
 
        std::list<std::string> unknown_processors () const;
 
+       RoutePinWindowProxy * pinmgr_proxy () const { return _pinmgr_proxy; }
+       void set_pingmgr_proxy (RoutePinWindowProxy* wp) { _pinmgr_proxy = wp ; }
+
+       PatchChangeGridDialog* patch_selector_dialog () const { return _patch_selector_dialog; }
+       void set_patch_selector_dialog  (PatchChangeGridDialog* d) { _patch_selector_dialog = d; }
+
+       boost::shared_ptr<AutomationControl> automation_control_recurse (PBD::ID const & id) const;
+
        /* special processors */
 
        boost::shared_ptr<InternalSend>     monitor_send() const { return _monitor_send; }
+       /** the signal processorat at end of the processing chain which produces output */
        boost::shared_ptr<Delivery>         main_outs() const { return _main_outs; }
        boost::shared_ptr<InternalReturn>   internal_return() const { return _intreturn; }
        boost::shared_ptr<MonitorProcessor> monitor_control() const { return _monitor_control; }
@@ -262,7 +270,22 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
        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);
+       /** remove plugin/processor
+        *
+        * @param proc processor to remove
+        * @param err error report (index where removal vailed, channel-count why it failed) may be nil
+        * @param need_process_lock if locking is required (set to true, unless called from RT context with lock)
+        * @returns 0 on success
+        */
+       int remove_processor (boost::shared_ptr<Processor> proc, ProcessorStreams* err = 0, bool need_process_lock = true);
+       /** replace plugin/processor with another
+        *
+        * @param old processor to remove
+        * @param sub processor to substitute the old one with
+        * @param err error report (index where removal vailed, channel-count why it failed) may be nil
+        * @returns 0 on success
+        */
+       int replace_processor (boost::shared_ptr<Processor> old, boost::shared_ptr<Processor> sub, 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);
@@ -272,27 +295,61 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
        void ab_plugins (bool forward);
        void clear_processors (Placement);
        void all_visible_processors_active (bool);
+       void move_instrument_down (bool postfader = false);
+
+       bool strict_io () const { return _strict_io; }
+       bool set_strict_io (bool);
+       /** reset plugin-insert configuration to default, disable customizations.
+        *
+        * This is equivalent to calling
+        * @code
+        * customize_plugin_insert (proc, 0, unused)
+        * @endcode
+        *
+        * @param proc Processor to reset
+        * @returns true if successful
+        */
+       bool reset_plugin_insert (boost::shared_ptr<Processor> proc);
+       /** enable custom plugin-insert configuration
+        * @param proc Processor to customize
+        * @param count number of plugin instances to use (if zero, reset to default)
+        * @param outs output port customization
+        * @param sinks input pins for variable-I/O plugins
+        * @returns true if successful
+        */
+       bool customize_plugin_insert (boost::shared_ptr<Processor> proc, uint32_t count, ChanCount outs, ChanCount sinks);
+       bool add_remove_sidechain (boost::shared_ptr<Processor> proc, bool);
+       bool plugin_preset_output (boost::shared_ptr<Processor> proc, ChanCount outs);
+
+       /* enable sidechain input for a given processor
+        *
+        * The sidechain itself is an IO port object with variable number of channels and configured independently.
+        * Adding/removing the port itself however requires reconfiguring the route and is hence
+        * not a plugin operation itself.
+        *
+        * @param proc the processor to add sidechain inputs to
+        * @returns true on success
+        */
+       bool add_sidechain (boost::shared_ptr<Processor> proc) { return add_remove_sidechain (proc, true); }
+       /* remove sidechain input from given processor
+        * @param proc the processor to remove the sidechain input from
+        * @returns true on success
+        */
+       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;
+       samplecnt_t  update_signal_latency (bool apply_to_delayline = false);
+       virtual void apply_latency_compensation ();
 
-       framecnt_t   update_signal_latency();
-       virtual void set_latency_compensation (framecnt_t);
+       samplecnt_t  set_private_port_latencies (bool playback) const;
+       void         set_public_port_latencies (samplecnt_t, bool playback) const;
 
-       void set_user_latency (framecnt_t);
-       framecnt_t initial_delay() const { return _initial_delay; }
-       framecnt_t signal_latency() const { return _signal_latency; }
+       void set_user_latency (samplecnt_t);
+       samplecnt_t signal_latency() const { return _signal_latency; }
+       samplecnt_t playback_latency (bool incl_downstream = false) const;
 
-       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::Signal0<void>       mute_points_changed;
+       PBD::Signal0<void> active_changed;
+       PBD::Signal0<void> denormal_protection_changed;
+       PBD::Signal0<void> comment_changed;
 
        /** track numbers - assigned by session
         * nubers > 0 indicate tracks (audio+midi)
@@ -309,31 +366,41 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
                PropertyChanged (ARDOUR::Properties::name);
        }
 
+       enum PluginSetupOptions {
+               None = 0x0,
+               CanReplace = 0x1,
+               MultiOut = 0x2,
+       };
+
+       static PBD::Signal3<int,boost::shared_ptr<Route>, boost::shared_ptr<PluginInsert>, PluginSetupOptions > PluginSetup;
+
        /** the processors have changed; the parameter indicates what changed */
        PBD::Signal1<void,RouteProcessorChange> processors_changed;
+       PBD::Signal0<void> fan_out; // used to signal the GUI to fan-out (track-creation)
        PBD::Signal1<void,void*> record_enable_changed;
+       PBD::Signal0<void> processor_latency_changed;
        /** the metering point has changed */
-       PBD::Signal0<void>       meter_change;
-       PBD::Signal0<void>       signal_latency_changed;
-       PBD::Signal0<void>       initial_delay_changed;
+       PBD::Signal0<void> meter_change;
+       /** a processor's latency has changed */
+       PBD::Signal0<void> signal_latency_changed;
+       /** route has updated its latency compensation */
+       PBD::Signal0<void> signal_latency_updated;
 
        /** Emitted with the process lock held */
        PBD::Signal0<void>       io_changed;
 
-       /* gui's call this for their own purposes. */
-
-       PBD::Signal2<void,std::string,void*> gui_changed;
-
        /* stateful */
-
        XMLNode& get_state();
+       XMLNode& get_template();
        virtual int set_state (const XMLNode&, int version);
-       virtual XMLNode& get_template();
 
        XMLNode& get_processor_state ();
-       virtual void set_processor_state (const XMLNode&);
+       void set_processor_state (const XMLNode&);
+       virtual bool set_processor_state (XMLNode const & node, XMLProperty const* prop, ProcessorList& new_order, bool& must_configure);
 
-       int save_as_template (const std::string& path, const std::string& name);
+       boost::weak_ptr<Route> weakroute ();
+
+       int save_as_template (const std::string& path, const std::string& name, const std::string& description );
 
        PBD::Signal1<void,void*> SelectedChanged;
 
@@ -360,6 +427,8 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
         */
        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;
                bool sends_only;
@@ -381,43 +450,30 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
        void clear_fed_by ();
        bool add_fed_by (boost::shared_ptr<Route>, bool sends_only);
 
-       /* 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 {
-       public:
-               SoloControllable (std::string name, boost::shared_ptr<Route>);
-               void set_value (double);
-               double get_value () const;
-
-       private:
-               boost::weak_ptr<Route> _route;
-       };
-
-       struct MuteControllable : public AutomationControl {
-       public:
-               MuteControllable (std::string name, boost::shared_ptr<Route>);
-               void set_value (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;
-       };
-
-       boost::shared_ptr<SoloControllable> solo_control() const {
+       boost::shared_ptr<SoloControl> solo_control() const {
                return _solo_control;
        }
 
-       boost::shared_ptr<MuteControllable> mute_control() const {
+       boost::shared_ptr<MuteControl> mute_control() const {
                return _mute_control;
        }
 
-       boost::shared_ptr<MuteMaster> mute_master() const {
-               return _mute_master;
+       bool can_be_muted_by_others () const { return can_solo(); }
+       bool muted () const { return _mute_control->muted(); }
+       bool muted_by_masters () const { return _mute_control->muted_by_masters(); }
+       bool muted_by_self () const { return _mute_control->muted_by_self(); }
+       bool muted_by_others_soloing () const;
+
+       boost::shared_ptr<SoloIsolateControl> solo_isolate_control() const {
+               return _solo_isolate_control;
+       }
+
+       boost::shared_ptr<SoloSafeControl> solo_safe_control() const {
+               return _solo_safe_control;
        }
 
        /* Route doesn't own these items, but sub-objects that it does own have them
@@ -427,9 +483,12 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
 
        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<Pannable> pannable() const;
 
+       boost::shared_ptr<GainControl> gain_control() const;
+       boost::shared_ptr<GainControl> trim_control() const;
+       boost::shared_ptr<PhaseControl> 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
@@ -438,90 +497,146 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
           special case not covered by this utility function.
        */
        boost::shared_ptr<Processor> the_instrument() const;
-        InstrumentInfo& instrument_info() { return _instrument_info; }
+       InstrumentInfo& instrument_info() { return _instrument_info; }
 
-       void protect_automation ();
+       /* "well-known" controls for panning. Any or all of these may return
+        * null.
+        */
 
-       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,
-       };
+       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;
 
-       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);
+       /* "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_enable_controllable () 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;
+
+       //additional HP/LP filters
+       boost::shared_ptr<AutomationControl> filter_freq_controllable (bool hpf) const;
+       boost::shared_ptr<AutomationControl> filter_slope_controllable (bool) const;
+       boost::shared_ptr<AutomationControl> filter_enable_controllable (bool) 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<ReadOnlyControl>   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;
+       boost::shared_ptr<AutomationControl> send_pan_azi_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;
 
-       /* for things concerned about *this* route's RID */
+       /* 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;
 
-       PBD::Signal0<void> RemoteControlIDChanged;
+       void protect_automation ();
 
-       /* for things concerned about *any* route's RID changes */
+       bool has_external_redirects() const;
 
-       static PBD::Signal0<void> RemoteControlIDChange;
-       static PBD::Signal0<void> SyncOrderKeys;
+       /* can only be executed by a route for which is_monitor() is true
+        *       (i.e. the monitor out)
+        */
+       void monitor_run (samplepos_t start_sample, samplepos_t end_sample,
+                       pframes_t nframes, int declick);
 
-       bool has_external_redirects() const;
+       bool slaved_to (boost::shared_ptr<VCA>) const;
+       bool slaved () const;
 
-        /* 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);
+       virtual void use_captured_sources (SourceList& srcs, CaptureInfos const &) {}
 
-  protected:
+protected:
        friend class Session;
 
        void catch_up_on_solo_mute_override ();
-       void mod_solo_by_others_upstream (int32_t);
-       void mod_solo_by_others_downstream (int32_t);
+       void set_listen (bool);
+
        void curve_reallocate ();
        virtual void set_block_size (pframes_t nframes);
 
-  protected:
-       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);
+       virtual int no_roll_unlocked (pframes_t nframes, samplepos_t start_sample, samplepos_t end_sample, bool session_state_changing);
 
-        void passthru (BufferSet&, framepos_t start_frame, framepos_t end_frame,
-                       pframes_t nframes, int declick);
+       virtual void snapshot_out_of_band_data (samplecnt_t /* nframes */) {}
+       virtual void write_out_of_band_data (BufferSet&, samplecnt_t /* nframes */) const {}
+       virtual void update_controls (BufferSet const&) {}
 
-       virtual void write_out_of_band_data (BufferSet& /* bufs */, framepos_t /* start_frame */, framepos_t /* end_frame */,
-                                            framecnt_t /* nframes */) {}
+       void process_output_buffers (BufferSet& bufs,
+                                    samplepos_t start_sample, samplepos_t end_sample,
+                                    pframes_t nframes, int declick,
+                                    bool gain_automation_ok,
+                                    bool run_disk_processors);
 
-       virtual void process_output_buffers (BufferSet& bufs,
-                                            framepos_t start_frame, framepos_t end_frame,
-                                            pframes_t nframes, int declick,
-                                            bool gain_automation_ok);
+       void flush_processor_buffers_locked (samplecnt_t nframes);
 
        virtual void bounce_process (BufferSet& bufs,
-                                    framepos_t start_frame, framecnt_t nframes,
+                                    samplepos_t start_sample, samplecnt_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;
+       samplecnt_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;
+       samplecnt_t    _signal_latency;
 
        ProcessorList  _processors;
-       mutable Glib::Threads::RWLock   _processor_lock;
-       boost::shared_ptr<Delivery> _main_outs;
-       boost::shared_ptr<InternalSend> _monitor_send;
-       boost::shared_ptr<InternalReturn> _intreturn;
+       mutable Glib::Threads::RWLock _processor_lock;
+
+       boost::shared_ptr<IO>               _input;
+       boost::shared_ptr<IO>               _output;
+
+       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;
+       boost::shared_ptr<Pannable>         _pannable;
+       boost::shared_ptr<DiskReader>       _disk_reader;
+       boost::shared_ptr<DiskWriter>       _disk_writer;
+
+       boost::shared_ptr<MonitorControl>   _monitoring_control;
+
+       DiskIOPoint _disk_io_point;
 
        enum {
                EmitNone = 0x00,
@@ -534,52 +649,37 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
        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;
-       bool           _solo_isolated;
-       uint32_t       _solo_isolated_by_upstream;
-
-       void mod_solo_isolated_by_upstream (bool, void*);
 
        bool           _denormal_protection;
 
        bool _recordable : 1;
-       bool _silent : 1;
        bool _declickable : 1;
 
-       boost::shared_ptr<SoloControllable> _solo_control;
-       boost::shared_ptr<MuteControllable> _mute_control;
-       boost::shared_ptr<MuteMaster> _mute_master;
-
-       virtual void act_on_mute () {}
+       boost::shared_ptr<SoloControl> _solo_control;
+       boost::shared_ptr<MuteControl> _mute_control;
+       boost::shared_ptr<PhaseControl> _phase_control;
+       boost::shared_ptr<SoloIsolateControl> _solo_isolate_control;
+       boost::shared_ptr<SoloSafeControl> _solo_safe_control;
 
        std::string    _comment;
        bool           _have_internal_generator;
-       bool           _solo_safe;
        DataType       _default_type;
        FedBy          _fed_by;
 
-        InstrumentInfo _instrument_info;
+       InstrumentInfo _instrument_info;
 
        virtual ChanCount input_streams () const;
 
-  protected:
-       virtual XMLNode& state(bool);
+       virtual XMLNode& state (bool save_template);
 
        int configure_processors (ProcessorStreams*);
 
-       void passthru_silence (framepos_t start_frame, framepos_t end_frame,
-                              pframes_t nframes, int declick);
-
-       void silence (framecnt_t);
-       void silence_unlocked (framecnt_t);
+       void silence (samplecnt_t);
+       void silence_unlocked (samplecnt_t);
 
        ChanCount processor_max_streams;
        ChanCount processor_out_streams;
@@ -587,35 +687,41 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
        uint32_t pans_required() const;
        ChanCount n_process_buffers ();
 
-       virtual void maybe_declick (BufferSet&, framecnt_t, int);
+       virtual void maybe_declick (BufferSet&, samplecnt_t, int);
 
+       boost::shared_ptr<GainControl> _gain_control;
        boost::shared_ptr<Amp>       _amp;
+       boost::shared_ptr<GainControl> _trim_control;
        boost::shared_ptr<Amp>       _trim;
        boost::shared_ptr<PeakMeter> _meter;
+
        boost::shared_ptr<DelayLine> _delayline;
 
+       bool is_internal_processor (boost::shared_ptr<Processor>) const;
+
        boost::shared_ptr<Processor> the_instrument_unlocked() const;
 
-  private:
-       int set_state_2X (const XMLNode&, int);
-       void set_processor_state_2X (XMLNodeList const &, int);
+       SlavableControlList slavables () const;
 
-       uint32_t _order_key;
-       bool _has_order_key;
-        uint32_t _remote_control_id;
+private:
+       /* no copy construction */
+       Route (Route const &);
 
-       int64_t _track_number;
+       int set_state_2X (const XMLNode&, int);
+       void set_processor_state_2X (XMLNodeList const &, int);
 
        void input_change_handler (IOChange, void *src);
        void output_change_handler (IOChange, void *src);
+       void sidechain_change_handler (IOChange, void *src);
+
+       void processor_selfdestruct (boost::weak_ptr<Processor>);
+       std::vector<boost::weak_ptr<Processor> > selfdestruct_sequence;
+       Glib::Threads::Mutex  selfdestruct_lock;
 
        bool input_port_count_changing (ChanCount);
        bool output_port_count_changing (ChanCount);
 
-       bool _in_configure_processors;
-       bool _initial_io_setup;
-
-       int configure_processors_unlocked (ProcessorStreams*);
+       int configure_processors_unlocked (ProcessorStreams*, Glib::Threads::RWLock::WriterLock*);
        bool set_meter_point_unlocked ();
        void apply_processor_order (const ProcessorList& new_order);
 
@@ -627,15 +733,23 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
        void placement_range (Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end);
 
        void set_self_solo (bool yn);
-       void set_mute_master_solo ();
+       void unpan ();
 
        void set_processor_positions ();
-       framecnt_t update_port_latencies (PortSet& ports, PortSet& feeders, bool playback, framecnt_t) const;
+       samplecnt_t update_port_latencies (PortSet& ports, PortSet& feeders, bool playback, samplecnt_t) const;
 
        void setup_invisible_processors ();
-       void unpan ();
 
-       boost::shared_ptr<CapturingProcessor> _capturing_processor;
+       pframes_t latency_preroll (pframes_t nframes, samplepos_t& start_sample, samplepos_t& end_sample);
+
+       void run_route (samplepos_t start_sample, samplepos_t end_sample, pframes_t nframes, int declick, bool gain_automation_ok, bool run_disk_reader);
+       void fill_buffers_with_input (BufferSet& bufs, boost::shared_ptr<IO> io, pframes_t nframes);
+
+       void reset_instrument_info ();
+       void solo_control_changed (bool self, PBD::Controllable::GroupControlDisposition);
+       void maybe_note_meter_position ();
+
+       void set_plugin_state_dir (boost::weak_ptr<Processor>, const std::string&);
 
        /** A handy class to keep processor state while we attempt a reconfiguration
         *  that may fail.
@@ -664,10 +778,13 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
 
        friend class ProcessorState;
 
-       /* no copy construction */
-       Route (Route const &);
+       boost::shared_ptr<CapturingProcessor> _capturing_processor;
 
-       void maybe_note_meter_position ();
+       int64_t _track_number;
+       bool    _strict_io;
+       bool    _in_configure_processors;
+       bool    _initial_io_setup;
+       bool    _in_sidechain_setup;
 
        /** true if we've made a note of a custom meter position in these variables */
        bool _custom_meter_position_noted;
@@ -676,9 +793,8 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
        */
        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);
+       RoutePinWindowProxy*   _pinmgr_proxy;
+       PatchChangeGridDialog* _patch_selector_dialog;
 };
 
 } // namespace ARDOUR