Fix broken whitespace. I'd apologize for the compile times if it was my fault :D
[ardour.git] / libs / ardour / ardour / route.h
index c4ea18095434c5ce92fd849d7cc91eabc5a9ae5c..3b12e4f6004d72c1e21f36cd8d872e16d91c9251 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"
@@ -46,6 +47,7 @@
 #include "ardour/route_group_member.h"
 #include "ardour/graphnode.h"
 #include "ardour/automatable.h"
+#include "ardour/unknown_processor.h"
 
 namespace ARDOUR {
 
@@ -53,13 +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 Automatable, public RouteGroupMember, public GraphNode
+class Route : public SessionObject, public Automatable, public RouteGroupMember, public GraphNode, public boost::enable_shared_from_this<Route>
 {
   public:
 
@@ -83,7 +90,7 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        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 &);
 
@@ -101,26 +108,28 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
 
        /* 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, bool& need_butler);
+       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);
 
-       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, bool can_record, bool rec_monitors_input);
 
-       virtual int silent_roll (nframes_t nframes, sframes_t start_frame, sframes_t end_frame,
-                                 bool can_record, bool rec_monitors_input, bool& need_butler);
+       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);
 
        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 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);
@@ -137,11 +146,11 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        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;
 
@@ -149,7 +158,7 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        bool solo_safe() const;
 
        void set_listen (bool yn, void* src);
-       bool listening () const;
+       bool listening_via_monitor () const;
 
        void set_phase_invert (uint32_t, bool yn);
        void set_phase_invert (boost::dynamic_bitset<>);
@@ -159,7 +168,7 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        void set_denormal_protection (bool yn);
        bool denormal_protection() const;
 
-       void         set_meter_point (MeterPoint);
+       void         set_meter_point (MeterPoint, bool force = false);
        void         infer_meter_point () const;
        MeterPoint   meter_point() const { return _meter_point; }
        void         meter ();
@@ -176,6 +185,9 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        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));
                }
        }
@@ -196,9 +208,11 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
 
        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; }
@@ -207,9 +221,10 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        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_monitor_send_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.
@@ -221,10 +236,9 @@ 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 (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);
@@ -237,10 +251,15 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        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; }
+       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;
@@ -257,10 +276,12 @@ 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;
+
+       /** Emitted with the process lock held */
        PBD::Signal0<void>       io_changed;
 
        /* gui's call this for their own purposes. */
@@ -280,61 +301,66 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
 
        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);
+       /**
+        * 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.
-        */
+       /**
+        * 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;
+       struct FeedRecord {
+               boost::weak_ptr<Route> r;
+               bool sends_only;
 
-            FeedRecord (boost::shared_ptr<Route> rp, bool sendsonly)
-                    : r (rp)
-                    , sends_only (sendsonly) {}
-        };
+               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;
-            }
-        };
+       struct FeedRecordCompare {
+               bool operator() (const FeedRecord& a, const FeedRecord& b) const {
+                       return a.r < b.r;
+               }
+       };
 
-        typedef std::set<FeedRecord,FeedRecordCompare> FedBy;
+       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(); }
+       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&);
+       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 {
@@ -354,10 +380,12 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
           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, bool notify_class_listeners = true);
@@ -382,28 +410,30 @@ 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 (sframes_t start_frame, sframes_t end_frame, nframes_t nframes);
-       virtual void set_block_size (nframes_t nframes);
+       void just_meter_input (framepos_t start_frame, framepos_t end_frame, pframes_t nframes);
+       virtual void set_block_size (pframes_t nframes);
 
   protected:
-       nframes_t check_initial_delay (nframes_t, nframes_t&);
+       framecnt_t check_initial_delay (framecnt_t, framecnt_t&);
 
-       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;
@@ -411,6 +441,7 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        boost::shared_ptr<Delivery> _monitor_send;
        boost::shared_ptr<InternalReturn> _intreturn;
        boost::shared_ptr<MonitorProcessor> _monitor_control;
+       boost::shared_ptr<Pannable> _pannable;
 
        Flag           _flags;
        int            _pending_declick;
@@ -430,32 +461,35 @@ 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;
-    
+
        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);
 
        int configure_processors (ProcessorStreams*);
 
-       void passthru_silence (sframes_t start_frame, sframes_t end_frame,
-                              nframes_t nframes, int declick);
+       void passthru_silence (framepos_t start_frame, framepos_t end_frame,
+                              pframes_t nframes, int declick);
 
-       void silence (nframes_t);
-       void silence_unlocked (nframes_t);
+       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 bool should_monitor () const;
+       virtual void maybe_declick (BufferSet&, framecnt_t, int);
+
        virtual int  _set_state (const XMLNode&, int, bool call_base);
 
        boost::shared_ptr<Amp>       _amp;
@@ -473,12 +507,15 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        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_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);
 
@@ -486,6 +523,41 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        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 ();
+
+       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