dynamic playback & capture buffer resizing (though transport is stopped first)
[ardour.git] / libs / ardour / ardour / route.h
index a2ad7165921fa8826b544d40c23a6d183a4f3c92..3d4f7f139a19287a4c9d025c2e62a7aedd92ed29 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000-2002 Paul Davis 
+    Copyright (C) 2000-2002 Paul Davis
 
     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
@@ -34,7 +34,7 @@
 #include "pbd/fastlog.h"
 #include "pbd/xml++.h"
 #include "pbd/undo.h"
-#include "pbd/stateful.h" 
+#include "pbd/stateful.h"
 #include "pbd/controllable.h"
 #include "pbd/destructible.h"
 
@@ -42,6 +42,8 @@
 #include "ardour/io.h"
 #include "ardour/types.h"
 #include "ardour/mute_master.h"
+#include "ardour/route_group_member.h"
+#include "ardour/graphnode.h"
 
 namespace ARDOUR {
 
@@ -52,8 +54,10 @@ class Panner;
 class Processor;
 class RouteGroup;
 class Send;
+class InternalReturn;
+class MonitorProcessor;
 
-class Route : public SessionObject, public AutomatableControls
+class Route : public SessionObject, public AutomatableControls, public RouteGroupMember, public GraphNode
 {
   public:
 
@@ -62,14 +66,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);
+       Route (Session&, std::string name, Flag flags = Flag(0), 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; }
 
@@ -79,7 +83,6 @@ class Route : public SessionObject, public AutomatableControls
        bool active() const { return _active; }
        void set_active (bool yn);
 
-
        static std::string ensure_track_or_route_name(std::string, Session &);
 
        std::string comment() { return _comment; }
@@ -87,28 +90,28 @@ class Route : public SessionObject, public AutomatableControls
 
        bool set_name (const std::string& str);
 
-       long order_key (const char* name) const;
-       void set_order_key (const char* name, long n);
+       long order_key (std::string const &) const;
+       void set_order_key (std::string const &, long);
 
        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 (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 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 (nframes_t nframes, sframes_t start_frame, sframes_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);
+       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 void toggle_monitor_input ();
        virtual bool can_record() { return false; }
 
-       virtual void set_record_enable (bool yn, void *src) {}
+       virtual void set_record_enable (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 set_pending_declick (int);
@@ -116,34 +119,44 @@ class Route : public SessionObject, public AutomatableControls
        /* end of vfunc-based API */
 
        void shift (nframes64_t, nframes64_t);
-       
+
        void set_gain (gain_t val, void *src);
        void inc_gain (gain_t delta, void *src);
 
-       void set_mute (bool yn, void* src);
+       void set_mute_points (MuteMaster::MutePoint);
+       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;
+       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_upstream () const { return _soloed_by_others_upstream; }
+       bool soloed_by_others_downstream () const { return _soloed_by_others_downstream; }
+       bool self_soloed () const { return _self_solo; }
+       
        void set_solo_isolated (bool yn, void *src);
        bool solo_isolated() const;
-       
-       void set_phase_invert (bool yn, void* src);
-       bool phase_invert() const;
 
-       void set_denormal_protection (bool yn, void* src);
-       bool denormal_protection() const;
+       void set_solo_safe (bool yn, void *src);
+       bool solo_safe() const;
 
-       void       set_edit_group (RouteGroup *, void *);
-       void       drop_edit_group (void *);
-       RouteGroup *edit_group () const { return _edit_group; }
+       void set_listen (bool yn, void* src);
+       bool listening () const;
 
-       void       set_mix_group (RouteGroup *, void *);
-       void       drop_mix_group (void *);
-       RouteGroup *mix_group () const { return _mix_group; }
+       void set_phase_invert (bool yn);
+       bool phase_invert() const;
 
-       virtual void set_meter_point (MeterPoint, void *src);
+       void set_denormal_protection (bool yn);
+       bool denormal_protection() const;
+
+       void         set_meter_point (MeterPoint);
+       void         infer_meter_point () const;
        MeterPoint   meter_point() const { return _meter_point; }
        void         meter ();
 
@@ -156,21 +169,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) {
                        method (boost::weak_ptr<Processor> (*i));
                }
        }
-       
-       void foreach_processor (Placement p, sigc::slot<void, boost::weak_ptr<Processor> > method) {
-               Glib::RWLock::ReaderLock lm (_processor_lock);
-               ProcessorList::iterator start, end;
-               placement_range(p, start, end);
-               for (ProcessorList::iterator i = start; i != end; ++i) {
-                       method (boost::weak_ptr<Processor> (*i));
-               }
-       }
 
        boost::shared_ptr<Processor> nth_processor (uint32_t n) {
                Glib::RWLock::ReaderLock lm (_processor_lock);
@@ -183,18 +187,26 @@ class Route : public SessionObject, public AutomatableControls
                }
        }
 
-       ProcessorList::iterator prefader_iterator();
-       
+       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&);
        ChanCount max_processor_streams () const { return processor_max_streams; }
-       ChanCount pre_fader_streams() 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<Send> send_for (boost::shared_ptr<const IO> target) const;
-       
+       boost::shared_ptr<Delivery>         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_monitor_send_at (Placement);
+
        /** 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.
         */
@@ -206,11 +218,12 @@ class Route : public SessionObject, public AutomatableControls
        };
 
        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_processors (const ProcessorList&, Placement placement, ProcessorStreams* err = 0);
+       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 reorder_processors (const ProcessorList& new_order, Placement placement, 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);
@@ -225,46 +238,78 @@ class Route : public SessionObject, public AutomatableControls
        void set_user_latency (nframes_t);
        nframes_t initial_delay() const { return _initial_delay; }
 
-       sigc::signal<void>       active_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,void*> pre_fader_changed;
-       sigc::signal<void,void*> post_fader_changed;
-       sigc::signal<void,void*> control_outs_changed;
-       sigc::signal<void,void*> main_outs_changed;
-       sigc::signal<void>       processors_changed;
-       sigc::signal<void,void*> record_enable_changed;
-       sigc::signal<void,void*> edit_group_changed;
-       sigc::signal<void,void*> mix_group_changed;
-       sigc::signal<void,void*> meter_change;
-       sigc::signal<void>       signal_latency_changed;
-       sigc::signal<void>       initial_delay_changed;
+       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;
 
        /* 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 */
 
        XMLNode& get_state();
-       int set_state(const XMLNode& node);
+       int set_state (const XMLNode&, int version);
        virtual XMLNode& get_template();
 
        XMLNode& get_processor_state ();
        virtual void set_processor_state (const XMLNode&);
-       
+
        int save_as_template (const std::string& path, const std::string& name);
 
-       sigc::signal<void,void*> SelectedChanged;
-       
-       int listen_via (boost::shared_ptr<IO>, const std::string& name);
-       void drop_listen (boost::shared_ptr<IO>);
+       PBD::Signal1<void,void*> SelectedChanged;
+
+       int listen_via (boost::shared_ptr<Route>, Placement p, bool active, bool aux);
+       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 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;
 
-       bool feeds (boost::shared_ptr<IO>);
-       std::set<boost::shared_ptr<Route> > fed_by;
+        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 */
 
@@ -274,7 +319,15 @@ class Route : public SessionObject, public AutomatableControls
                SoloControllable (std::string name, Route&);
                void set_value (float);
                float get_value (void) const;
-               
+
+               Route& route;
+       };
+
+       struct MuteControllable : public AutomationControl {
+               MuteControllable (std::string name, Route&);
+               void set_value (float);
+               float get_value (void) const;
+
                Route& route;
        };
 
@@ -283,11 +336,11 @@ 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 { 
-               return _mute_master; 
+       boost::shared_ptr<MuteMaster> mute_master() const {
+               return _mute_master;
        }
 
        /* Route doesn't own these items, but sub-objects that it does own have them
@@ -300,34 +353,45 @@ class Route : public SessionObject, public AutomatableControls
 
        void automation_snapshot (nframes_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;
 
-       void sync_order_keys (const char* base);
-       static sigc::signal<void,const char*> SyncOrderKeys;
+       /* 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 PBD::Signal1<void,std::string const &> SyncOrderKeys;
 
   protected:
        friend class Session;
 
        void catch_up_on_solo_mute_override ();
-       void mod_solo_level (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 (nframes_t nframes);
 
   protected:
        nframes_t check_initial_delay (nframes_t, nframes_t&);
-       
+
        void passthru (sframes_t start_frame, sframes_t end_frame,
-                      nframes_t nframes, int declick);
+                       nframes_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 process_output_buffers (BufferSet& bufs,
-                                            sframes_t start_frame, sframes_t end_frame,
-                                            nframes_t nframes, bool with_processors, int declick);
-       
+                       sframes_t start_frame, sframes_t end_frame,
+                       nframes_t nframes, bool with_processors, int declick);
+
        boost::shared_ptr<IO> _input;
        boost::shared_ptr<IO> _output;
 
@@ -338,38 +402,47 @@ class Route : public SessionObject, public AutomatableControls
        ProcessorList  _processors;
        mutable Glib::RWLock   _processor_lock;
        boost::shared_ptr<Delivery> _main_outs;
-       boost::shared_ptr<Delivery> _control_outs; // XXX to be removed/generalized by listen points
+       boost::shared_ptr<Delivery> _monitor_send;
+       boost::shared_ptr<InternalReturn> _intreturn;
+       boost::shared_ptr<MonitorProcessor> _monitor_control;
 
        Flag           _flags;
        int            _pending_declick;
        MeterPoint     _meter_point;
        uint32_t       _phase_invert;
+       bool           _self_solo;
+       uint32_t       _soloed_by_others_upstream;
+       uint32_t       _soloed_by_others_downstream;
+       uint32_t       _solo_isolated;
+
        bool           _denormal_protection;
-       
+
        bool _recordable : 1;
        bool _silent : 1;
        bool _declickable : 1;
 
        boost::shared_ptr<SoloControllable> _solo_control;
+       boost::shared_ptr<MuteControllable> _mute_control;
        boost::shared_ptr<MuteMaster> _mute_master;
-
-       RouteGroup*    _edit_group;
-       RouteGroup*    _mix_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);
 
+       int configure_processors (ProcessorStreams*);
+
        void passthru_silence (sframes_t start_frame, sframes_t end_frame,
                               nframes_t nframes, int declick);
-       
-       void silence (nframes_t nframes);
-       
-       sigc::connection input_signal_connection;
+
+       void silence (nframes_t);
+       void silence_unlocked (nframes_t);
 
        ChanCount processor_max_streams;
        uint32_t _remote_control_id;
@@ -377,26 +450,18 @@ class Route : public SessionObject, public AutomatableControls
        uint32_t pans_required() const;
        ChanCount n_process_buffers ();
        
-       virtual int  _set_state (const XMLNode&, bool call_base);
-
-       boost::shared_ptr<Delivery> add_listener (boost::shared_ptr<IO>, const std::string&);
+       virtual int  _set_state (const XMLNode&, int, bool call_base);
 
        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);
 
        static uint32_t order_key_cnt;
 
-       struct ltstr {
-           bool operator()(const char* s1, const char* s2) const {
-                   return strcmp(s1, s2) < 0;
-           }
-       };
-
-       typedef std::map<const char*,long,ltstr> OrderKeys;
+       typedef std::map<std::string, long> OrderKeys;
        OrderKeys order_keys;
 
        void input_change_handler (IOChange, void *src);
@@ -404,13 +469,17 @@ class Route : public SessionObject, public AutomatableControls
 
        bool _in_configure_processors;
 
-       int configure_processors (ProcessorStreams*);
        int configure_processors_unlocked (ProcessorStreams*);
 
-       bool add_processor_from_xml (const XMLNode&, Placement);
        bool add_processor_from_xml (const XMLNode&, ProcessorList::iterator iter);     
+       bool add_processor_from_xml_2X (const XMLNode&, int, ProcessorList::iterator iter);     
 
        void placement_range (Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end);
+
+       void set_self_solo (bool yn);
+       void set_mute_master_solo ();
+
+       void set_processor_positions ();
 };
 
 } // namespace ARDOUR