Fix up confusion with relayering after movement drags in
[ardour.git] / libs / ardour / ardour / route.h
index defcc2c5c297322adbaeb88dff3e77eba1e39c48..3fab63bb9b0c3e99555dfe7b8e07c8ebb1edad6a 100644 (file)
@@ -30,6 +30,7 @@
 #include <boost/shared_ptr.hpp>
 #include <boost/weak_ptr.hpp>
 #include <boost/dynamic_bitset.hpp>
+#include <boost/enable_shared_from_this.hpp>
 
 #include <glibmm/thread.h>
 #include "pbd/fastlog.h"
@@ -63,8 +64,9 @@ class InternalReturn;
 class MonitorProcessor;
 class Pannable;
 class CapturingProcessor;
+class InternalSend;
 
-class Route : public SessionObject, public Automatable, public RouteGroupMember, public GraphNode
+class Route : public SessionObject, public Automatable, public RouteGroupMember, public GraphNode, public boost::enable_shared_from_this<Route>
 {
   public:
 
@@ -96,6 +98,7 @@ 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 &);
 
        int32_t order_key (std::string const &) const;
        void set_order_key (std::string const &, int32_t);
@@ -104,24 +107,27 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        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 rec_monitors_input, 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 rec_monitors_input);
+                            bool state_changing);
 
        virtual int silent_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
-                                 bool can_record, bool rec_monitors_input, 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 bool record_enabled() 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 set_pending_declick (int);
 
        /* end of vfunc-based API */
@@ -136,18 +142,18 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
 
        bool muted () const;
        void set_mute (bool yn, void* src);
-
+       
        /* 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 (); }
 
-        bool soloed_by_others () const { return _soloed_by_others_upstream||_soloed_by_others_downstream; }
+       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;
 
@@ -166,7 +172,6 @@ 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 ();
 
@@ -200,26 +205,26 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
                }
        }
 
+       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);
 
-       bool processor_is_prefader (boost::shared_ptr<Processor> p);
-
-        bool has_io_processor_named (const std::string&);
+       bool has_io_processor_named (const std::string&);
        ChanCount max_processor_streams () const { return processor_max_streams; }
 
        std::list<std::string> unknown_processors () const;
-       
+
        /* special processors */
 
-       boost::shared_ptr<Delivery>         monitor_send() const { return _monitor_send; }
+       boost::shared_ptr<InternalSend>     monitor_send() const { return _monitor_send; }
        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; }
        boost::shared_ptr<Send>             internal_send_for (boost::shared_ptr<const Route> target) const;
        void add_internal_return ();
-       BufferSet* get_return_buffer () const;
-       void release_return_buffer () const;
+       void add_send_to_internal_return (InternalSend *);
+       void remove_send_from_internal_return (InternalSend *);
        void listen_position_changed ();
        boost::shared_ptr<CapturingProcessor> add_export_point(/* Add some argument for placement later */);
 
@@ -233,7 +238,8 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
                ChanCount count; ///< Input requested of processor
        };
 
-       int add_processor (boost::shared_ptr<Processor>, Placement placement, ProcessorStreams* err = 0);
+       int add_processor (boost::shared_ptr<Processor>, Placement placement, ProcessorStreams* err = 0, bool activation_allowed = true);
+       int add_processor_by_index (boost::shared_ptr<Processor>, int, 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);
@@ -245,14 +251,17 @@ 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);
+
+       framecnt_t set_private_port_latencies (bool playback) const;
+       void       set_public_port_latencies (framecnt_t, bool playback) const;
+
+       framecnt_t   update_signal_latency();
+       virtual void set_latency_compensation (framecnt_t);
 
-        void set_latency_ranges (bool playback) const;
-       virtual framecnt_t update_total_latency();
-       void set_latency_delay (framecnt_t);
        void set_user_latency (framecnt_t);
        framecnt_t initial_delay() const { return _initial_delay; }
+       framecnt_t signal_latency() const { return _signal_latency; }
 
        PBD::Signal0<void>       active_changed;
        PBD::Signal0<void>       phase_invert_changed;
@@ -269,7 +278,7 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        PBD::Signal1<void,RouteProcessorChange> processors_changed;
        PBD::Signal1<void,void*> record_enable_changed;
        /** the metering point has changed */
-       PBD::Signal0<void>       meter_change; 
+       PBD::Signal0<void>       meter_change;
        PBD::Signal0<void>       signal_latency_changed;
        PBD::Signal0<void>       initial_delay_changed;
        PBD::Signal0<void>       order_key_changed;
@@ -284,7 +293,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 ();
@@ -298,58 +307,69 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        int listen_via (boost::shared_ptr<Route>, Placement p);
        void drop_listen (boost::shared_ptr<Route>);
 
-       /** 
-        * return true if this route feeds the first argument via at least one
-        * (arbitrarily long) signal pathway.
-        */
-        bool feeds (boost::shared_ptr<Route>, bool* via_send_only = 0);
+       /**
+        * return true if this route feeds the first argument via at least one
+        * (arbitrarily long) signal pathway.
+        */
+       bool feeds (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.
-        */
-       bool direct_feeds (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.  This is checked by the actual
+        * connections, rather than by what the graph is currently doing.
+        */
+       bool direct_feeds_according_to_reality (boost::shared_ptr<Route>, bool* via_send_only = 0);
 
-        struct FeedRecord {
-            boost::weak_ptr<Route> r;
-            bool sends_only;
+       /**
+        * 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);
 
-            FeedRecord (boost::shared_ptr<Route> rp, bool sendsonly)
-                    : r (rp)
-                    , sends_only (sendsonly) {}
-        };
+       struct FeedRecord {
+               boost::weak_ptr<Route> r;
+               bool sends_only;
 
-        struct FeedRecordCompare {
-            bool operator() (const FeedRecord& a, const FeedRecord& b) const {
-                    return a.r < b.r;
-            }
-        };
+               FeedRecord (boost::shared_ptr<Route> rp, bool sendsonly)
+               : r (rp)
+               , sends_only (sendsonly) {}
+       };
 
-        typedef std::set<FeedRecord,FeedRecordCompare> FedBy;
+       struct FeedRecordCompare {
+               bool operator() (const FeedRecord& a, const FeedRecord& b) const {
+                       return a.r < b.r;
+               }
+       };
 
-        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(); }
+       typedef std::set<FeedRecord,FeedRecordCompare> FedBy;
+
+       const FedBy& fed_by() const { return _fed_by; }
+       void clear_fed_by ();
+       bool add_fed_by (boost::shared_ptr<Route>, bool sends_only);
 
        /* Controls (not all directly owned by the Route */
 
        boost::shared_ptr<AutomationControl> get_control (const Evoral::Parameter& param);
 
-       struct SoloControllable : public AutomationControl {
-               SoloControllable (std::string name, Route&);
+       class SoloControllable : public AutomationControl {
+       public:
+               SoloControllable (std::string name, boost::shared_ptr<Route>);
                void set_value (double);
-               double get_value (void) const;
+               double get_value () const;
 
-               Route& route;
+       private:
+               boost::weak_ptr<Route> _route;
        };
 
        struct MuteControllable : public AutomationControl {
-               MuteControllable (std::string name, Route&);
+       public:
+               MuteControllable (std::string name, boost::shared_ptr<Route>);
                void set_value (double);
-               double get_value (void) const;
+               double get_value () const;
 
-               Route& route;
+       private:
+               boost::weak_ptr<Route> _route;
        };
 
        boost::shared_ptr<AutomationControl> solo_control() const {
@@ -372,7 +392,7 @@ 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<Pannable> pannable() const;
+       boost::shared_ptr<Pannable> pannable() const;
 
        void automation_snapshot (framepos_t now, bool force=false);
        void protect_automation ();
@@ -399,11 +419,10 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        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:
-       framecnt_t check_initial_delay (framecnt_t, framecnt_t&);
+       virtual framecnt_t check_initial_delay (framecnt_t nframes, framecnt_t&) { return nframes; }
 
        void passthru (framepos_t start_frame, framepos_t end_frame,
                        pframes_t nframes, int declick);
@@ -412,24 +431,25 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
                        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, 
-                                             bool gain_automation_ok);
+                                            framepos_t start_frame, framepos_t end_frame,
+                                            pframes_t nframes, int declick,
+                                            bool gain_automation_ok);
 
        boost::shared_ptr<IO> _input;
        boost::shared_ptr<IO> _output;
 
        bool           _active;
+       framecnt_t     _signal_latency;
        framecnt_t     _initial_delay;
        framecnt_t     _roll_delay;
 
        ProcessorList  _processors;
        mutable Glib::RWLock   _processor_lock;
        boost::shared_ptr<Delivery> _main_outs;
-       boost::shared_ptr<Delivery> _monitor_send;
+       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;
 
        Flag           _flags;
        int            _pending_declick;
@@ -449,14 +469,16 @@ 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;
-    
+
+       virtual void act_on_mute () {}
+
        std::string    _comment;
        bool           _have_internal_generator;
        bool           _solo_safe;
        DataType       _default_type;
-        FedBy          _fed_by;
+       FedBy          _fed_by;
 
-        virtual ChanCount input_streams () const;
+       virtual ChanCount input_streams () const;
 
   protected:
        virtual XMLNode& state(bool);
@@ -474,14 +496,14 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
 
        uint32_t pans_required() const;
        ChanCount n_process_buffers ();
-       
-       virtual int  _set_state (const XMLNode&, int, bool call_base);
+
+       virtual void maybe_declick (BufferSet&, framecnt_t, int);
 
        boost::shared_ptr<Amp>       _amp;
        boost::shared_ptr<PeakMeter> _meter;
 
   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;
@@ -508,9 +530,10 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        void set_mute_master_solo ();
 
        void set_processor_positions ();
-        void update_port_latencies (const PortSet& ports, const PortSet& feeders, bool playback, framecnt_t) const;
+       framecnt_t update_port_latencies (PortSet& ports, PortSet& feeders, bool playback, framecnt_t) const;
 
        void setup_invisible_processors ();
+       void unpan ();
 
        boost::shared_ptr<CapturingProcessor> _capturing_processor;
 
@@ -543,6 +566,17 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
 
        /* 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;
+       /** true if the last custom meter position was at the end of the processor list */
+       bool _last_custom_meter_was_at_end;
 };
 
 } // namespace ARDOUR