route.h

Go to the documentation of this file.

/*
 * Copyright (C) 2000-2019 Paul Davis <paul@linuxaudiosystems.com>
 * Copyright (C) 2006-2014 David Robillard <d@drobilla.net>
 * Copyright (C) 2008-2012 Carl Hetherington <carl@carlh.net>
 * Copyright (C) 2013-2019 Robin Gareus <robin@gareus.org>
 * Copyright (C) 2015-2018 Ben Loftis <ben@harrisonconsoles.com>
 * Copyright (C) 2015-2018 Len Ovens <len@ovenwerks.net>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * 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.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#pragma once
 
#include <atomic>
#include <cmath>
#include <cstring>
#include <list>
#include <map>
#include <memory>
#include <set>
#include <string>
 
#include "pbd/fastlog.h"
#include "pbd/xml++.h"
#include "pbd/undo.h"
#include "pbd/mutex.h"
#include "pbd/stateful.h"
#include "pbd/controllable.h"
#include "pbd/destructible.h"
#include "pbd/rwlock.h"
 
#include "temporal/domain_swap.h"
#include "temporal/types.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/scale_provider.h"
#include "ardour/soloable.h"
#include "ardour/solo_control.h"
#include "ardour/solo_safe_control.h"
#include "ardour/slavable.h"
 
class RoutePinWindowProxy;
class PatchChangeGridDialog;
class RouteCommentEditor;
 
namespace ARDOUR {
 
class Amp;
class BeatBox;
class DelayLine;
class Delivery;
class DiskReader;
class DiskWriter;
class IOProcessor;
class Panner;
class PannerShell;
class PolarityProcessor;
class PortSet;
class Processor;
class PluginInsert;
class RouteGroup;
class Send;
class InternalReturn;
class Location;
class MonitorControl;
class MonitorProcessor;
class Pannable;
class CapturingProcessor;
class InternalSend;
class VCA;
class SoloIsolateControl;
class PhaseControl;
class MonitorControl;
class TriggerBox;
class SurroundReturn;
class SurroundSend;
 
class LIBARDOUR_API Route : public Stripable,
                            public GraphNode,
                            public Soloable,
                            public Muteable,
                            public Monitorable,
                            public RouteGroupMember,
                            public ScaleProvider
{
public:
 
        typedef std::list<std::shared_ptr<Processor> > ProcessorList;
 
        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;
        }
 
        uint32_t color () const;
 
        std::shared_ptr<IO> input() const { return _input; }
        std::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(); }
 
        bool active() const { return _active; }
        void set_active (bool yn, void *);
 
        std::string ensure_track_or_route_name (std::string) const;
 
        std::string comment() { return _comment; }
        void set_comment (std::string str, void *src);
 
        RouteCommentEditor* comment_editor () const { return _comment_editor_window; }
        void set_comment_editor (RouteCommentEditor* w) { _comment_editor_window = w; }
 
        bool set_name (const std::string& str);
        static void set_name_in_state (XMLNode &, const std::string &);
 
        std::shared_ptr<MonitorControl> monitoring_control() const { return _monitoring_control; }
        std::shared_ptr<SurroundSend> surround_send() const { return _surround_send; }
        std::shared_ptr<SurroundReturn> surround_return() const { return _surround_return; }
 
        MonitorState monitoring_state () const;
        virtual MonitorState get_input_monitoring_state (bool recording, bool talkback) const { return MonitoringSilence; }
 
        /* these are the core of the API of a Route. see the protected sections as well */
 
        virtual void filter_input (BufferSet &) {}
 
        int roll (pframes_t nframes, samplepos_t start_sample, samplepos_t end_sample, bool& need_butler);
 
        int no_roll (pframes_t nframes, samplepos_t start_sample, samplepos_t end_sample, bool state_changing);
 
        int silence (pframes_t);
 
        virtual bool declick_in_progress () const { return false; }
        virtual bool can_record() { return false; }
 
        void non_realtime_transport_stop (samplepos_t now, bool flush);
        virtual void realtime_handle_transport_stopped ();
 
        virtual void realtime_locate (bool) {}
        virtual void non_realtime_locate (samplepos_t);
        void set_loop (ARDOUR::Location *);
 
        /* end of vfunc-based API */
 
        void shift (timepos_t const &, timecnt_t const &);
        void cut_copy_section (timepos_t const& start, timepos_t const& end, timepos_t const& to, SectionOperation const op);
 
        /* controls use set_solo() to modify this route's solo state */
 
        void clear_all_solo_state ();
 
        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 push_solo_upstream (int32_t delta);
        void push_solo_isolate_upstream (int32_t delta);
        bool can_solo () const {
                return !(is_singleton() || is_auditioner() || is_foldbackbus());
        }
        bool is_safe () const {
                return _solo_safe_control->get_value();
        }
        bool can_monitor () const {
                return can_solo() || is_foldbackbus ();
        }
        void enable_monitor_send ();
        void enable_surround_send ();
 
        void set_denormal_protection (bool yn);
        bool denormal_protection() const;
 
        void         set_meter_point (MeterPoint);
        bool         apply_processor_changes_rt ();
        void         emit_pending_signals ();
        MeterPoint   meter_point() const { return _pending_meter_point; }
 
        void update_send_delaylines ();
 
        void         set_meter_type (MeterType t);
        MeterType    meter_type () const;
 
        void set_disk_io_point (DiskIOPoint);
        DiskIOPoint disk_io_point() const { return _disk_io_point; }
 
        void stop_triggers (bool now);
        void tempo_map_changed();
 
        /* Processors */
 
        std::shared_ptr<Amp> amp() const  { return _amp; }
        std::shared_ptr<Amp> trim() const { return _trim; }
        std::shared_ptr<PolarityProcessor> polarity() const { return _polarity; }
        std::shared_ptr<PeakMeter>       peak_meter()       { return _meter; }
        std::shared_ptr<const PeakMeter> peak_meter() const { return _meter; }
        std::shared_ptr<PeakMeter> shared_peak_meter() const { return _meter; }
        std::shared_ptr<TriggerBox> triggerbox() const { return _triggerbox; }
 
        void flush_processors ();
 
        void foreach_processor (std::function<void(std::weak_ptr<Processor>)> method) const {
                PBD::RWLock::ReaderLock lm (_processor_lock);
                for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
                        method (std::weak_ptr<Processor> (*i));
                }
        }
 
        std::shared_ptr<Processor> nth_processor (uint32_t n) {
                PBD::RWLock::ReaderLock lm (_processor_lock);
                ProcessorList::iterator i;
                for (i = _processors.begin(); i != _processors.end() && n; ++i, --n) {}
                if (i == _processors.end()) {
                        return std::shared_ptr<Processor> ();
                } else {
                        return *i;
                }
        }
 
        std::shared_ptr<Processor> processor_by_id (PBD::ID) const;
        std::shared_ptr<Processor> plugin_by_uri (std::string const&, int offset = 0) const;
 
        std::shared_ptr<Processor> nth_plugin (uint32_t n) const;
        std::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; }
 
        std::shared_ptr<AutomationControl> automation_control_recurse (PBD::ID const & id) const;
 
        void automatables (PBD::ControllableSet&) const;
 
        void queue_surround_processors_changed () {
                _pending_surround_send.store (1);
        }
 
        /* special processors */
 
        std::shared_ptr<InternalSend>     monitor_send() const { return _monitor_send; }
        std::shared_ptr<Delivery>         main_outs() const { return _main_outs; }
        std::shared_ptr<InternalReturn>   internal_return() const { return _intreturn; }
        std::shared_ptr<MonitorProcessor> monitor_control() const { return _monitor_control; }
        std::shared_ptr<Send>             internal_send_for (std::shared_ptr<const Route> target) const;
        void add_internal_return ();
        void add_send_to_internal_return (InternalSend *);
        void remove_send_from_internal_return (InternalSend *);
        void listen_position_changed ();
        std::shared_ptr<CapturingProcessor> add_export_point(/* Add some argument for placement later */);
 
        struct ProcessorStreams {
                ProcessorStreams(size_t i=0, ChanCount c=ChanCount()) : index(i), count(c) {}
 
                uint32_t  index; 
                ChanCount count; 
        };
 
        int add_processor (std::shared_ptr<Processor>, Placement placement, ProcessorStreams* err = 0, bool activation_allowed = true);
        int add_processor_by_index (std::shared_ptr<Processor>, int, ProcessorStreams* err = 0, bool activation_allowed = true);
        int add_processor (std::shared_ptr<Processor>, std::shared_ptr<Processor>, ProcessorStreams* err = 0, bool activation_allowed = true);
        int add_processors (const ProcessorList&, std::shared_ptr<Processor>, ProcessorStreams* err = 0);
        std::shared_ptr<Processor> before_processor_for_placement (Placement);
        std::shared_ptr<Processor> before_processor_for_index (int);
        bool processors_reorder_needs_configure (const ProcessorList& new_order);
        int remove_processor (std::shared_ptr<Processor> proc, ProcessorStreams* err = 0, bool need_process_lock = true);
        int replace_processor (std::shared_ptr<Processor> old, std::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);
        void disable_processors ();
        void disable_plugins (Placement);
        void disable_plugins ();
        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);
        bool reset_plugin_insert (std::shared_ptr<Processor> proc);
        bool customize_plugin_insert (std::shared_ptr<Processor> proc, uint32_t count, ChanCount outs, ChanCount sinks);
        bool add_remove_sidechain (std::shared_ptr<Processor> proc, bool);
        bool plugin_preset_output (std::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 (std::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 (std::shared_ptr<Processor> proc) { return add_remove_sidechain (proc, false); }
 
        samplecnt_t  update_signal_latency (bool apply_to_delayline = false, bool* delayline_update_needed = NULL);
        void apply_latency_compensation ();
 
        samplecnt_t  set_private_port_latencies (bool playback) const;
        void         set_public_port_latencies (samplecnt_t, bool playback, bool with_latcomp) const;
 
        samplecnt_t signal_latency() const { return _signal_latency; }
        samplecnt_t playback_latency (bool incl_downstream = false) const;
 
        PBD::Signal<void()> active_changed;
        PBD::Signal<void()> denormal_protection_changed;
        PBD::Signal<void()> comment_changed;
 
        bool is_track();
 
        PBD::Signal<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);
        }
 
        enum PluginSetupOptions {
                None = 0x0,
                CanReplace = 0x1,
                MultiOut = 0x2,
        };
 
        static PBD::Signal<int(std::shared_ptr<Route>, std::shared_ptr<PluginInsert>, PluginSetupOptions )> PluginSetup;
 
        static PBD::Signal<void(std::weak_ptr<Route> )> FanOut;
 
        PBD::Signal<void(RouteProcessorChange)> processors_changed;
        PBD::Signal<void(void*)> record_enable_changed;
        PBD::Signal<void()> processor_latency_changed;
        PBD::Signal<void()> meter_change;
 
        PBD::Signal<void()>       io_changed;
 
        /* stateful */
        XMLNode& get_state() const;
        XMLNode& get_template();
        virtual int set_state (const XMLNode&, int version);
        virtual int import_state (const XMLNode&, bool use_pbd_ids = true, bool processor_only = true);
 
        XMLNode& get_processor_state ();
        void set_processor_state (const XMLNode&, int version);
        virtual bool set_processor_state (XMLNode const & node, int version, XMLProperty const* prop, ProcessorList& new_order, bool& must_configure);
 
        std::weak_ptr<Route> weakroute ();
 
        int save_as_template (const std::string& path, const std::string& name, const std::string& description );
 
        PBD::Signal<void(void*)> SelectedChanged;
 
        int add_aux_send (std::shared_ptr<Route>, std::shared_ptr<Processor>);
        int add_foldback_send (std::shared_ptr<Route>, bool post_fader);
        void remove_monitor_send ();
        void remove_surround_send ();
 
        bool direct_feeds_according_to_reality (std::shared_ptr<GraphNode>, bool* via_send_only = 0);
 
        std::string graph_node_name () const {
                return name ();
        }
 
        bool direct_feeds_according_to_graph (std::shared_ptr<Route>, bool* via_send_only = 0);
 
        bool feeds (std::shared_ptr<Route>);
 
        std::set<std::shared_ptr<Route>> signal_sources (bool via_sends_only = false);
 
        bool output_effectively_connected () const;
 
        /* Controls (not all directly owned by the Route) */
 
        std::shared_ptr<AutomationControl> get_control (const Evoral::Parameter& param);
 
        std::shared_ptr<SoloControl> solo_control() const {
                return _solo_control;
        }
 
        std::shared_ptr<MuteControl> mute_control() const {
                return _mute_control;
        }
 
        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;
 
        std::shared_ptr<SoloIsolateControl> solo_isolate_control() const {
                return _solo_isolate_control;
        }
 
        std::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
           and to make UI code a bit simpler, we provide direct access to them
           here.
        */
 
        std::shared_ptr<Panner> panner() const;  /* may return null */
        std::shared_ptr<PannerShell> panner_shell() const;
        std::shared_ptr<Pannable> pannable() const;
 
        std::shared_ptr<GainControl> gain_control() const;
        std::shared_ptr<GainControl> trim_control() const;
        std::shared_ptr<GainControl> volume_control() const;
        std::shared_ptr<PhaseControl> phase_control() const;
 
        void set_volume_applies_to_output (bool);
 
        bool volume_applies_to_output () const {
                return _volume_applies_to_output;
        }
 
        std::shared_ptr<Processor> the_instrument() const;
        InstrumentInfo& instrument_info() { return _instrument_info; }
        bool instrument_fanned_out () const { return _instrument_fanned_out;}
 
 
        /* "well-known" controls.
         * Any or all of these may return NULL.
         */
 
        std::shared_ptr<AutomationControl> pan_azimuth_control() const;
        std::shared_ptr<AutomationControl> pan_elevation_control() const;
        std::shared_ptr<AutomationControl> pan_width_control() const;
        std::shared_ptr<AutomationControl> pan_frontback_control() const;
        std::shared_ptr<AutomationControl> pan_lfe_control() const;
 
        uint32_t eq_band_cnt () const;
        std::string eq_band_name (uint32_t) const;
 
        std::shared_ptr<AutomationControl> mapped_control (enum WellKnownCtrl, uint32_t band = 0) const;
        std::shared_ptr<ReadOnlyControl>   mapped_output (enum WellKnownData) const;
 
        std::shared_ptr<AutomationControl> send_level_controllable (uint32_t n, bool locked = false) const;
        std::shared_ptr<AutomationControl> send_enable_controllable (uint32_t n) const;
        std::shared_ptr<AutomationControl> send_pan_azimuth_controllable (uint32_t n) const;
        std::shared_ptr<AutomationControl> send_pan_azimuth_enable_controllable (uint32_t n) const;
 
        std::string send_name (uint32_t n) const;
 
        std::shared_ptr<AutomationControl> master_send_enable_controllable () const;
 
        void protect_automation ();
 
        bool has_external_redirects() const;
 
        /* 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);
 
        bool slaved_to (std::shared_ptr<VCA>) const;
        bool slaved () const;
 
        virtual void use_captured_sources (SourceList& srcs, CaptureInfos const &) {}
 
 
protected:
        friend class Session;
 
        void process ();
 
        void catch_up_on_solo_mute_override ();
        void set_listen (bool);
 
        virtual void set_block_size (pframes_t nframes);
 
        virtual int no_roll_unlocked (pframes_t nframes, samplepos_t start_sample, samplepos_t end_sample, bool session_state_changing);
 
        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&) {}
 
        void process_output_buffers (BufferSet& bufs,
                                     samplepos_t start_sample, samplepos_t end_sample,
                                     pframes_t nframes,
                                     bool gain_automation_ok,
                                     bool run_disk_processors);
 
        void flush_processor_buffers_locked (samplecnt_t nframes);
 
        virtual void bounce_process (BufferSet& bufs,
                                     samplepos_t start_sample, samplecnt_t nframes,
                                                                                                                         std::shared_ptr<Processor> endpoint, bool include_endpoint,
                                     bool for_export, bool for_freeze);
 
        samplecnt_t  bounce_get_latency (std::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export, bool for_freeze) const;
        ChanCount    bounce_get_output_streams (ChanCount &cc, std::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export, bool for_freeze) const;
 
        bool can_freeze_processor (std::shared_ptr<Processor>, bool allow_routing = false) const;
 
        bool           _active;
        samplecnt_t    _signal_latency;
        samplecnt_t    _output_latency;
 
        ProcessorList  _processors;
        mutable PBD::RWLock _processor_lock;
 
        std::shared_ptr<IO>               _input;
        std::shared_ptr<IO>               _output;
 
        std::shared_ptr<Delivery>         _main_outs;
        std::shared_ptr<InternalSend>     _monitor_send;
        std::shared_ptr<InternalReturn>   _intreturn;
        std::shared_ptr<MonitorProcessor> _monitor_control;
        std::shared_ptr<Pannable>         _pannable;
        std::shared_ptr<DiskReader>       _disk_reader;
        std::shared_ptr<DiskWriter>       _disk_writer;
#ifdef HAVE_BEATBOX
        std::shared_ptr<BeatBox>       _beatbox;
#endif
        std::shared_ptr<MonitorControl>   _monitoring_control;
        std::shared_ptr<SurroundSend>     _surround_send;
        std::shared_ptr<SurroundReturn>   _surround_return;
 
        DiskIOPoint _disk_io_point;
 
        enum {
                EmitNone = 0x00,
                EmitMeterChanged = 0x01,
                EmitMeterVisibilityChange = 0x02,
                EmitRtProcessorChange = 0x04,
                EmitSendReturnChange = 0x08
        };
 
        ProcessorList    _pending_processor_order;
        std::atomic<int> _pending_process_reorder;
        std::atomic<int> _pending_listen_change;
        std::atomic<int> _pending_surround_send;
        std::atomic<int> _pending_signals;
 
        MeterPoint     _meter_point;
        MeterPoint     _pending_meter_point;
 
        bool           _denormal_protection;
 
        bool _recordable : 1;
 
        std::shared_ptr<SoloControl> _solo_control;
        std::shared_ptr<MuteControl> _mute_control;
        std::shared_ptr<SoloIsolateControl> _solo_isolate_control;
        std::shared_ptr<SoloSafeControl> _solo_safe_control;
 
        std::string          _comment;
        RouteCommentEditor*  _comment_editor_window;
 
        bool           _have_internal_generator;
        DataType       _default_type;
        InstrumentInfo _instrument_info;
        bool           _instrument_fanned_out;
        Location*      _loop_location;
 
        virtual ChanCount input_streams () const;
 
        virtual XMLNode& state (bool save_template) const;
 
        int configure_processors (ProcessorStreams*);
 
        void silence_unlocked (pframes_t);
 
        ChanCount processor_max_streams;
        ChanCount processor_out_streams;
 
        uint32_t pans_required() const;
        ChanCount n_process_buffers ();
 
        std::shared_ptr<GainControl>  _gain_control;
        std::shared_ptr<GainControl>  _trim_control;
        std::shared_ptr<GainControl>  _volume_control;
        std::shared_ptr<PhaseControl> _phase_control;
        std::shared_ptr<Amp>               _amp;
        std::shared_ptr<Amp>               _trim;
        std::shared_ptr<Amp>               _volume;
        std::shared_ptr<PeakMeter>         _meter;
        std::shared_ptr<PolarityProcessor> _polarity;
        std::shared_ptr<TriggerBox>        _triggerbox;
 
        bool _volume_applies_to_output;
 
        std::shared_ptr<DelayLine> _delayline;
 
        bool is_internal_processor (std::shared_ptr<Processor>) const;
 
        std::shared_ptr<Processor> the_instrument_unlocked() const;
 
        SlavableAutomationControlList slavables () const;
 
        virtual void input_change_handler (IOChange);
 
private:
        /* no copy construction */
        Route (Route const &);
 
        int set_state_2X (const XMLNode&, int);
        void set_processor_state_2X (XMLNodeList const &, int);
 
        void output_change_handler (IOChange);
        void sidechain_change_handler (IOChange);
 
        void processor_selfdestruct (std::weak_ptr<Processor>);
        std::vector<std::weak_ptr<Processor> > selfdestruct_sequence;
        PBD::Mutex  selfdestruct_lock;
 
        int input_port_count_changing (ChanCount);
        int output_port_count_changing (ChanCount);
 
        bool output_effectively_connected_real () const;
        mutable std::map<Route*, bool> _connection_cache;
 
        int configure_processors_unlocked (ProcessorStreams*, PBD::RWLock::WriterLock*);
        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 *);
 
        bool add_processor_from_xml_2X (const XMLNode&, int);
 
        void placement_range (Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end);
 
        void set_self_solo (bool yn);
        void unpan ();
 
        void set_processor_positions ();
        samplecnt_t update_port_latencies (PortSet& ports, PortSet& feeders, bool playback, samplecnt_t) const;
 
        void setup_invisible_processors ();
 
        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, bool gain_automation_ok, bool run_disk_reader);
        void fill_buffers_with_input (BufferSet& bufs, std::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 (std::weak_ptr<Processor>, const std::string&);
 
        class ProcessorState {
        public:
                ProcessorState (Route* r)
                        : _route (r)
                        , _processors (r->_processors)
                        , _processor_max_streams (r->processor_max_streams)
                { }
 
                void restore () {
                        _route->_processors = _processors;
                        _route->processor_max_streams = _processor_max_streams;
                }
 
        private:
                /* this should perhaps be a shared_ptr, but ProcessorStates will
                   not hang around long enough for it to matter.
                */
                Route* _route;
                ProcessorList _processors;
                ChanCount _processor_max_streams;
        };
 
        friend class ProcessorState;
 
        std::shared_ptr<CapturingProcessor> _capturing_processor;
 
        int64_t _track_number;
        bool    _strict_io;
        bool    _in_configure_processors;
        bool    _initial_io_setup;
        bool    _in_sidechain_setup;
        gain_t  _monitor_gain;
 
        void add_well_known_ctrl (WellKnownCtrl, std::shared_ptr<PluginInsert>, int param);
        void add_well_known_ctrl (WellKnownCtrl);
 
        std::map<WellKnownCtrl, std::vector<std::weak_ptr<AutomationControl>>> _well_known_map;
 
        bool _custom_meter_position_noted;
        std::weak_ptr<Processor> _processor_after_last_custom_meter;
 
        RoutePinWindowProxy*   _pinmgr_proxy;
        PatchChangeGridDialog* _patch_selector_dialog;
};
 
} // namespace ARDOUR