Remove some unused stuff.
[ardour.git] / libs / ardour / ardour / route.h
index e3c3a370a9c42f83e2db03775d0006f2a151d755..bc84fd947093c728016fb67256411ea1da1502b9 100644 (file)
@@ -29,6 +29,8 @@
 
 #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"
 #include "ardour/io.h"
 #include "ardour/types.h"
 #include "ardour/mute_master.h"
+#include "ardour/route_group_member.h"
+#include "ardour/graphnode.h"
+#include "ardour/automatable.h"
+#include "ardour/unknown_processor.h"
 
 namespace ARDOUR {
 
@@ -49,12 +55,18 @@ class Amp;
 class Delivery;
 class IOProcessor;
 class Panner;
+class PannerShell;
+class PortSet;
 class Processor;
 class RouteGroup;
 class Send;
 class InternalReturn;
+class MonitorProcessor;
+class Pannable;
+class CapturingProcessor;
+class InternalSend;
 
-class Route : public SessionObject, public AutomatableControls
+class Route : public SessionObject, public Automatable, public RouteGroupMember, public GraphNode, public boost::enable_shared_from_this<Route>
 {
   public:
 
@@ -63,13 +75,14 @@ class Route : public SessionObject, public AutomatableControls
        enum Flag {
                Hidden = 0x1,
                MasterOut = 0x2,
-               ControlOut = 0x4
+               MonitorOut = 0x4
        };
 
        Route (Session&, std::string name, Flag flags = Flag(0), DataType default_type = DataType::AUDIO);
-       Route (Session&, const XMLNode&, DataType default_type = DataType::AUDIO);
        virtual ~Route();
 
+       virtual int init ();
+
        boost::shared_ptr<IO> input() const { return _input; }
        boost::shared_ptr<IO> output() const { return _output; }
 
@@ -77,8 +90,7 @@ class Route : public SessionObject, public AutomatableControls
        ChanCount n_outputs() const { return _output->n_ports(); }
 
        bool active() const { return _active; }
-       void set_active (bool yn);
-
+       void set_active (bool yn, void *);
 
        static std::string ensure_track_or_route_name(std::string, Session &);
 
@@ -87,53 +99,58 @@ class Route : public SessionObject, public AutomatableControls
 
        bool set_name (const std::string& str);
 
-       long order_key (std::string const &) const;
-       void set_order_key (std::string const &, long);
+       int32_t order_key (std::string const &) const;
+       void set_order_key (std::string const &, int32_t);
 
        bool is_hidden() const { return _flags & Hidden; }
        bool is_master() const { return _flags & MasterOut; }
-       bool is_control() const { return _flags & ControlOut; }
+       bool is_monitor() const { return _flags & MonitorOut; }
 
        /* these are the core of the API of a Route. see the protected sections as well */
 
-       virtual int roll (nframes_t nframes, sframes_t start_frame, sframes_t end_frame,
-                       int declick, bool can_record, bool rec_monitors_input);
+       virtual int roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
+                         int declick, bool& need_butler);
 
-       virtual int no_roll (nframes_t nframes, sframes_t start_frame, sframes_t end_frame,
-                       bool state_changing, bool can_record, bool rec_monitors_input);
+       virtual int no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
+                            bool state_changing);
 
-       virtual int silent_roll (nframes_t nframes, sframes_t start_frame, sframes_t end_frame,
-                       bool can_record, bool rec_monitors_input);
+       virtual int silent_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
+                                bool& need_butler);
 
        virtual void toggle_monitor_input ();
        virtual bool can_record() { return false; }
 
-       virtual void set_record_enable (bool /*yn*/, void * /*src*/) {}
+       virtual void set_record_enabled (bool /*yn*/, void * /*src*/) {}
        virtual bool record_enabled() const { return false; }
-       virtual void handle_transport_stopped (bool abort, bool did_locate, bool flush_processors);
+       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 */
 
-       void shift (nframes64_t, nframes64_t);
+       void shift (framepos_t, framepos_t);
 
        void set_gain (gain_t val, void *src);
        void inc_gain (gain_t delta, void *src);
 
        void set_mute_points (MuteMaster::MutePoint);
-       MuteMaster::MutePoint mute_points() const { return _mute_points; }
-       void set_mute (bool yn, void* src);
+       MuteMaster::MutePoint mute_points () const;
+
        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 () const { return self_soloed () || soloed_by_others (); }
 
-       bool soloed_by_others () const { return !_solo_isolated && _soloed_by_others; }
+       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;
 
@@ -141,19 +158,17 @@ class Route : public SessionObject, public AutomatableControls
        bool solo_safe() const;
 
        void set_listen (bool yn, void* src);
-       bool listening () const;
+       bool listening_via_monitor () const;
 
-       void set_phase_invert (bool yn);
-       bool phase_invert() const;
+       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;
 
-       void       set_route_group (RouteGroup *, void *);
-       void       drop_route_group (void *);
-       RouteGroup *route_group () const { return _route_group; }
-
-       virtual void set_meter_point (MeterPoint, void *src);
+       void         set_meter_point (MeterPoint, bool force = false);
        MeterPoint   meter_point() const { return _meter_point; }
        void         meter ();
 
@@ -166,9 +181,12 @@ class Route : public SessionObject, public AutomatableControls
 
        void flush_processors ();
 
-       void foreach_processor (sigc::slot<void, boost::weak_ptr<Processor> > method) {
+       void foreach_processor (boost::function<void(boost::weak_ptr<Processor>)> method) {
                Glib::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));
                }
        }
@@ -184,20 +202,26 @@ class Route : public SessionObject, public AutomatableControls
                }
        }
 
-       bool processor_is_prefader (boost::shared_ptr<Processor> p);
+       boost::shared_ptr<Processor> nth_plugin (uint32_t n);
+       boost::shared_ptr<Processor> nth_send (uint32_t n);
 
+       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>       control_outs() const { return _control_outs; }
-       boost::shared_ptr<Delivery>       main_outs() const { return _main_outs; }
-       boost::shared_ptr<InternalReturn> internal_return() const { return _intreturn; }
-       boost::shared_ptr<Send>           internal_send_for (boost::shared_ptr<const Route> target) const;
+       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 put_control_outs_at (Placement);
+       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 */);
 
        /** A record of the stream configuration at some point in the processor list.
         * Used to return where and why an processor list configuration request failed.
@@ -209,10 +233,10 @@ class Route : public SessionObject, public AutomatableControls
                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>, ProcessorList::iterator iter, 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 add_processors (const ProcessorList&, ProcessorList::iterator iter, ProcessorStreams* err = 0);
        int remove_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);
@@ -222,34 +246,44 @@ class Route : public SessionObject, public AutomatableControls
        void disable_plugins ();
        void ab_plugins (bool forward);
        void clear_processors (Placement);
-       void all_processors_flip();
        void all_processors_active (Placement, bool state);
 
-       virtual nframes_t update_total_latency();
-       void set_latency_delay (nframes_t);
-       void set_user_latency (nframes_t);
-       nframes_t initial_delay() const { return _initial_delay; }
-
-       sigc::signal<void>       active_changed;
-       sigc::signal<void>       phase_invert_changed;
-       sigc::signal<void>       denormal_protection_changed;
-       sigc::signal<void,void*> listen_changed;
-       sigc::signal<void,void*> solo_changed;
-       sigc::signal<void,void*> solo_safe_changed;
-       sigc::signal<void,void*> solo_isolated_changed;
-       sigc::signal<void,void*> comment_changed;
-       sigc::signal<void,void*> mute_changed;
-       sigc::signal<void>       mute_points_changed;
-       sigc::signal<void>       processors_changed;
-       sigc::signal<void,void*> record_enable_changed;
-       sigc::signal<void,void*> route_group_changed;
-       sigc::signal<void,void*> meter_change;
-       sigc::signal<void>       signal_latency_changed;
-       sigc::signal<void>       initial_delay_changed;
+       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_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;
+       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;
+
+       /** the processors have changed; the parameter indicates what changed */
+       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>       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;
 
        /* gui's call this for their own purposes. */
 
-       sigc::signal<void,std::string,void*> gui_changed;
+       PBD::Signal2<void,std::string,void*> gui_changed;
 
        /* stateful */
 
@@ -262,24 +296,68 @@ class Route : public SessionObject, public AutomatableControls
 
        int save_as_template (const std::string& path, const std::string& name);
 
-       sigc::signal<void,void*> SelectedChanged;
+       PBD::Signal1<void,void*> SelectedChanged;
 
-       int listen_via (boost::shared_ptr<Route>, Placement p, bool active, bool aux);
+       int listen_via_monitor ();
+       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);
-       std::set<boost::shared_ptr<Route> > fed_by;
+
+       /**
+        * 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);
+
+       struct FeedRecord {
+               boost::weak_ptr<Route> r;
+               bool sends_only;
+
+               FeedRecord (boost::shared_ptr<Route> rp, bool sendsonly)
+               : r (rp)
+               , sends_only (sendsonly) {}
+       };
+
+       struct FeedRecordCompare {
+               bool operator() (const FeedRecord& a, const FeedRecord& b) const {
+                       return a.r < b.r;
+               }
+       };
+
+       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);
+       bool not_fed() const { return _fed_by.empty(); }
 
        /* 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&);
-               void set_value (float);
-               float get_value (void) const;
+       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;
 
-               Route& route;
+       private:
+               boost::weak_ptr<Route> _route;
        };
 
        boost::shared_ptr<AutomationControl> solo_control() const {
@@ -287,7 +365,7 @@ class Route : public SessionObject, public AutomatableControls
        }
 
        boost::shared_ptr<AutomationControl> mute_control() const {
-               return _mute_master;
+               return _mute_control;
        }
 
        boost::shared_ptr<MuteMaster> mute_master() const {
@@ -299,62 +377,76 @@ class Route : public SessionObject, public AutomatableControls
           here.
        */
 
-       boost::shared_ptr<Panner> panner() const;
+       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;
 
-       void automation_snapshot (nframes_t now, bool force=false);
+       void automation_snapshot (framepos_t now, bool force=false);
        void protect_automation ();
 
-       void set_remote_control_id (uint32_t id);
+       void set_remote_control_id (uint32_t id, bool notify_class_listeners = true);
        uint32_t remote_control_id () const;
-       sigc::signal<void> RemoteControlIDChanged;
+
+       /* for things concerned about *this* route's RID */
+
+       PBD::Signal0<void> RemoteControlIDChanged;
+
+       /* for things concerned about any route's RID changes */
+
+       static PBD::Signal0<void> RemoteControlIDChange;
 
        void sync_order_keys (std::string const &);
-       static sigc::signal<void, std::string const &> SyncOrderKeys;
+       static PBD::Signal1<void,std::string const &> SyncOrderKeys;
 
   protected:
        friend class Session;
 
        void catch_up_on_solo_mute_override ();
-       void mod_solo_by_others (int32_t);
-       void set_block_size (nframes_t nframes);
+       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 (sframes_t start_frame, sframes_t end_frame, nframes_t nframes);
+       virtual void set_block_size (pframes_t nframes);
 
   protected:
-       nframes_t check_initial_delay (nframes_t, nframes_t&);
+       virtual framecnt_t check_initial_delay (framecnt_t nframes, framecnt_t&) { return nframes; }
 
-       void passthru (sframes_t start_frame, sframes_t end_frame,
-                       nframes_t nframes, int declick);
+       void passthru (framepos_t start_frame, framepos_t end_frame,
+                       pframes_t nframes, int declick);
 
-       virtual void write_out_of_band_data (BufferSet& /* bufs */, sframes_t /* start_frame */, sframes_t /* end_frame */,
-                       nframes_t /* nframes */) {}
+       virtual void write_out_of_band_data (BufferSet& /* bufs */, framepos_t /* start_frame */, framepos_t /* end_frame */,
+                       framecnt_t /* nframes */) {}
 
        virtual void process_output_buffers (BufferSet& bufs,
-                       sframes_t start_frame, sframes_t end_frame,
-                       nframes_t nframes, bool with_processors, int declick);
+                                            framepos_t start_frame, framepos_t end_frame,
+                                            pframes_t nframes, bool with_processors, int declick,
+                                            bool gain_automation_ok);
 
        boost::shared_ptr<IO> _input;
        boost::shared_ptr<IO> _output;
 
        bool           _active;
-       nframes_t      _initial_delay;
-       nframes_t      _roll_delay;
+       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> _control_outs;
+       boost::shared_ptr<InternalSend> _monitor_send;
        boost::shared_ptr<InternalReturn> _intreturn;
+       boost::shared_ptr<MonitorProcessor> _monitor_control;
+       boost::shared_ptr<Pannable> _pannable;
 
        Flag           _flags;
        int            _pending_declick;
        MeterPoint     _meter_point;
-       uint32_t       _phase_invert;
+       boost::dynamic_bitset<> _phase_invert;
        bool           _self_solo;
-       uint32_t       _soloed_by_others;
-       bool           _solo_isolated;
+       uint32_t       _soloed_by_others_upstream;
+       uint32_t       _soloed_by_others_downstream;
+       uint32_t       _solo_isolated;
 
        bool           _denormal_protection;
 
@@ -363,40 +455,43 @@ class Route : public SessionObject, public AutomatableControls
        bool _declickable : 1;
 
        boost::shared_ptr<SoloControllable> _solo_control;
+       boost::shared_ptr<MuteControllable> _mute_control;
        boost::shared_ptr<MuteMaster> _mute_master;
-       MuteMaster::MutePoint _mute_points;
 
-       RouteGroup*    _route_group;
        std::string    _comment;
        bool           _have_internal_generator;
        bool           _solo_safe;
        DataType       _default_type;
+       FedBy          _fed_by;
 
-  protected:
+       virtual ChanCount input_streams () const;
 
+  protected:
        virtual XMLNode& state(bool);
 
-       void passthru_silence (sframes_t start_frame, sframes_t end_frame,
-                              nframes_t nframes, int declick);
+       int configure_processors (ProcessorStreams*);
 
-       void silence (nframes_t nframes);
+       void passthru_silence (framepos_t start_frame, framepos_t end_frame,
+                              pframes_t nframes, int declick);
 
-       sigc::connection input_signal_connection;
+       void silence (framecnt_t);
+       void silence_unlocked (framecnt_t);
 
        ChanCount processor_max_streams;
        uint32_t _remote_control_id;
 
        uint32_t pans_required() const;
        ChanCount n_process_buffers ();
-       
-       virtual int  _set_state (const XMLNode&, int, bool call_base);
+
+       virtual bool should_monitor () const;
+       virtual void maybe_declick (BufferSet&, framecnt_t, int);
+
+       virtual int  _set_state (const XMLNode&, int);
 
        boost::shared_ptr<Amp>       _amp;
        boost::shared_ptr<PeakMeter> _meter;
-       sigc::connection _meter_connection;
 
   private:
-       void init ();
        int _set_state_2X (const XMLNode&, int);
        void set_processor_state_2X (XMLNodeList const &, int);
 
@@ -408,18 +503,58 @@ class Route : public SessionObject, public AutomatableControls
        void input_change_handler (IOChange, void *src);
        void output_change_handler (IOChange, void *src);
 
+       bool input_port_count_changing (ChanCount);
+
        bool _in_configure_processors;
 
-       int configure_processors (ProcessorStreams*);
        int configure_processors_unlocked (ProcessorStreams*);
+       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 (const XMLNode&, ProcessorList::iterator iter);     
-       bool add_processor_from_xml_2X (const XMLNode&, int, ProcessorList::iterator iter);     
+       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 set_delivery_solo ();
+       void set_mute_master_solo ();
+
+       void set_processor_positions ();
+       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;
+
+       /** A handy class to keep processor state while we attempt a reconfiguration
+        *  that may fail.
+        */
+       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;
+
+       /* no copy construction */
+       Route (Route const &);
 };
 
 } // namespace ARDOUR