75% (?) of the way towards making mixer strips control bus sends. lots more to do
[ardour.git] / libs / ardour / ardour / route.h
index 8e4a094082b70bcd6f1b11e8a6c8b39c5fa6dc50..10aec0446e8ff6a3b7fce9123f996a88fd6e3af3 100644 (file)
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
-    $Id$
 */
 
 #ifndef __ardour_route_h__
 #define __ardour_route_h__
 
 #include <cmath>
+#include <cstring>
 #include <list>
-#include <set>
 #include <map>
+#include <set>
 #include <string>
 
-#include <pbd/fastlog.h>
+#include <boost/shared_ptr.hpp>
+#include <boost/weak_ptr.hpp>
+
 #include <glibmm/thread.h>
-#include <pbd/xml++.h>
-#include <pbd/undo.h>
-#include <pbd/stateful.h> 
-#include <pbd/controllable.h>
+#include "pbd/fastlog.h"
+#include "pbd/xml++.h"
+#include "pbd/undo.h"
+#include "pbd/stateful.h" 
+#include "pbd/controllable.h"
+#include "pbd/destructible.h"
 
-#include <ardour/ardour.h>
-#include <ardour/io.h>
-#include <ardour/session.h>
-#include <ardour/redirect.h>
+#include "ardour/ardour.h"
+#include "ardour/io.h"
+#include "ardour/types.h"
 
 namespace ARDOUR {
 
-class Insert;
-class Send;
+class Amp;
+class Delivery;
+class IOProcessor;
+class Processor;
 class RouteGroup;
+class Send;
 
 enum mute_type {
     PRE_FADER =    0x1,
@@ -54,75 +60,75 @@ enum mute_type {
 
 class Route : public IO
 {
-  protected:
-
-        typedef list<Redirect *> RedirectList;
   public:
 
+       typedef std::list<boost::shared_ptr<Processor> > ProcessorList;
+
        enum Flag {
                Hidden = 0x1,
                MasterOut = 0x2,
                ControlOut = 0x4
        };
 
-
-       Route (Session&, std::string name, int input_min, int input_max, int output_min, int output_max, Flag flags = Flag(0));
-       Route (Session&, const XMLNode&);
+       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();
 
+       static std::string ensure_track_or_route_name(std::string, Session &);
+
        std::string comment() { return _comment; }
        void set_comment (std::string str, void *src);
 
-       long order_key(std::string name) const;
-       void set_order_key (std::string name, long n);
+       bool set_name (const std::string& str);
+
+       long order_key (const char* name) const;
+       void set_order_key (const char* name, long n);
 
-       bool hidden() const { return _flags & Hidden; }
-       bool master() const { return _flags & MasterOut; }
-       bool control() const { return _flags & ControlOut; }
+       bool is_hidden() const { return _flags & Hidden; }
+       bool is_master() const { return _flags & MasterOut; }
+       bool is_control() const { return _flags & ControlOut; }
 
        /* 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 (jack_nframes_t nframes, jack_nframes_t start_frame, jack_nframes_t end_frame, 
-                          jack_nframes_t offset, int declick, 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  no_roll (jack_nframes_t nframes, jack_nframes_t start_frame, jack_nframes_t end_frame, 
-                             jack_nframes_t offset, 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 (jack_nframes_t nframes, jack_nframes_t start_frame, jack_nframes_t end_frame, 
-                                 jack_nframes_t offset, bool can_record, bool rec_monitors_input);
        virtual void toggle_monitor_input ();
-       virtual bool can_record() const { return false; }
+       virtual bool can_record() { return false; }
        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_redirects);
+       virtual void handle_transport_stopped (bool abort, bool did_locate, bool flush_processors);
        virtual void set_pending_declick (int);
 
        /* end of vfunc-based API */
 
+       void shift (nframes64_t, nframes64_t);
+
        /* override IO::set_gain() to provide group control */
 
        void set_gain (gain_t val, void *src);
        void inc_gain (gain_t delta, void *src);
-
-       bool active() const { return _active; }
-       void set_active (bool yn);
-
+       
        void set_solo (bool yn, void *src);
        bool soloed() const { return _soloed; }
 
        void set_solo_safe (bool yn, void *src);
        bool solo_safe() const { return _solo_safe; }
-
+       
        void set_mute (bool yn, void *src);
        bool muted() const { return _muted; }
+       bool solo_muted() const { return desired_solo_gain == 0.0; }
 
        void set_mute_config (mute_type, bool, void *src);
        bool get_mute_config (mute_type);
 
-       void set_phase_invert (bool yn, void *src);
-       bool phase_invert() const { return _phase_invert; }
-       
        void       set_edit_group (RouteGroup *, void *);
        void       drop_edit_group (void *);
        RouteGroup *edit_group () { return _edit_group; }
@@ -131,46 +137,81 @@ class Route : public IO
        void       drop_mix_group (void *);
        RouteGroup *mix_group () { return _mix_group; }
 
-       virtual void  set_meter_point (MeterPoint, void *src);
-       MeterPoint  meter_point() const { return _meter_point; }
+       virtual void set_meter_point (MeterPoint, void *src);
+       MeterPoint   meter_point() const { return _meter_point; }
 
-       /* Redirects */
+       /* Processors */
 
-       void flush_redirects ();
+       void flush_processors ();
 
-       template<class T> void foreach_redirect (T *obj, void (T::*func)(Redirect *)) {
-               Glib::RWLock::ReaderLock lm (redirect_lock);
-               for (RedirectList::iterator i = _redirects.begin(); i != _redirects.end(); ++i) {
-                       (obj->*func) (*i);
+       void foreach_processor (sigc::slot<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));
                }
        }
 
-       Redirect *nth_redirect (uint32_t n) {
-               Glib::RWLock::ReaderLock lm (redirect_lock);
-               RedirectList::iterator i;
-               for (i = _redirects.begin(); i != _redirects.end() && n; ++i, --n);
-               if (i == _redirects.end()) {
-                       return 0;
+       boost::shared_ptr<Processor> nth_processor (uint32_t n) {
+               Glib::RWLock::ReaderLock lm (_processor_lock);
+               ProcessorList::iterator i;
+               for (i = _processors.begin(); i != _processors.end() && n; ++i, --n) {}
+               if (i == _processors.end()) {
+                       return boost::shared_ptr<Processor> ();
                } else {
                        return *i;
                }
        }
+
+       ProcessorList::iterator prefader_iterator();
+       
+       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<IO> send_io_for (boost::shared_ptr<const IO> target) const;
        
-       uint32_t max_redirect_outs () const { return redirect_max_outs; }
-               
-       int add_redirect (Redirect *, void *src, uint32_t* err_streams = 0);
-       int add_redirects (const RedirectList&, void *src, uint32_t* err_streams = 0);
-       int remove_redirect (Redirect *, void *src, uint32_t* err_streams = 0);
-       int copy_redirects (const Route&, Placement, uint32_t* err_streams = 0);
-       int sort_redirects (uint32_t* err_streams = 0);
-
-       void clear_redirects (void *src);
-       void all_redirects_flip();
-       void all_redirects_active (bool state);
-
-       virtual jack_nframes_t update_total_latency();
-       jack_nframes_t signal_latency() const { return _own_latency; }
-       virtual void set_latency_delay (jack_nframes_t);
+       /** 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.
+        */
+       struct ProcessorStreams {
+               ProcessorStreams(size_t i=0, ChanCount c=ChanCount()) : index(i), count(c) {}
+
+               uint32_t  index; ///< Index of processor where configuration failed
+               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_processors (const ProcessorList&, Placement placement, 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);
+       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_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,void*> solo_changed;
        sigc::signal<void,void*> solo_safe_changed;
@@ -180,14 +221,13 @@ class Route : public IO
        sigc::signal<void,void*> post_fader_changed;
        sigc::signal<void,void*> control_outs_changed;
        sigc::signal<void,void*> main_outs_changed;
-       sigc::signal<void,void*> redirects_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>       active_changed;
        sigc::signal<void,void*> meter_change;
-
-       sigc::signal<void> GoingAway;
+       sigc::signal<void>       signal_latency_changed;
+       sigc::signal<void>       initial_delay_changed;
 
        /* gui's call this for their own purposes. */
 
@@ -199,18 +239,18 @@ class Route : public IO
        int set_state(const XMLNode& node);
        virtual XMLNode& get_template();
 
-       sigc::signal<void,void*> SelectedChanged;
-
-       /* undo */
+       XMLNode& get_processor_state ();
+       int set_processor_state (const XMLNode&);
 
-       UndoAction get_memento() const;
-       void set_state (state_id_t);
+       int save_as_template (const std::string& path, const std::string& name);
 
-       int set_control_outs (const vector<std::string>& ports);
-       IO* control_outs() { return _control_outs; }
+       sigc::signal<void,void*> SelectedChanged;
+       
+       int listen_via (boost::shared_ptr<IO>, const std::string& name);
+       void drop_listen (boost::shared_ptr<IO>);
 
-       bool feeds (Route *);
-       set<Route *> fed_by;
+       bool feeds (boost::shared_ptr<IO>);
+       std::set<boost::shared_ptr<Route> > fed_by;
 
        struct ToggleControllable : public PBD::Controllable {
            enum ToggleType {
@@ -218,7 +258,7 @@ class Route : public IO
                    SoloControl
            };
            
-           ToggleControllable (Route&, ToggleType);
+           ToggleControllable (std::string name, Route&, ToggleType);
            void set_value (float);
            float get_value (void) const;
 
@@ -226,130 +266,132 @@ class Route : public IO
            ToggleType type;
        };
 
-       PBD::Controllable& solo_control() {
+       boost::shared_ptr<PBD::Controllable> solo_control() {
                return _solo_control;
        }
 
-       PBD::Controllable& mute_control() {
+       boost::shared_ptr<PBD::Controllable> mute_control() {
                return _mute_control;
        }
        
-       void automation_snapshot (jack_nframes_t now);
-
+       void automation_snapshot (nframes_t now, bool force=false);
        void protect_automation ();
        
        void set_remote_control_id (uint32_t id);
        uint32_t remote_control_id () const;
        sigc::signal<void> RemoteControlIDChanged;
 
+       void sync_order_keys (const char* base);
+       static sigc::signal<void,const char*> SyncOrderKeys;
+
   protected:
        friend class Session;
 
+       void catch_up_on_solo_mute_override ();
        void set_solo_mute (bool yn);
-       void set_block_size (jack_nframes_t nframes);
+       void set_block_size (nframes_t nframes);
        bool has_external_redirects() const;
        void curve_reallocate ();
 
   protected:
-       unsigned char _flags;
-
-       /* tight cache-line access here is more important than sheer speed of
-          access.
-       */
+       nframes_t check_initial_delay (nframes_t, nframes_t&);
+       
+       void passthru (sframes_t start_frame, sframes_t end_frame,
+                      nframes_t nframes, int declick);
 
-       bool                     _muted : 1;
-       bool                     _soloed : 1;
-       bool                     _solo_muted : 1;
-       bool                     _solo_safe : 1;
-       bool                     _phase_invert : 1;
-       bool                     _recordable : 1;
-       bool                     _active : 1;
-       bool                     _mute_affects_pre_fader : 1;
-       bool                     _mute_affects_post_fader : 1;
-       bool                     _mute_affects_control_outs : 1;
-       bool                     _mute_affects_main_outs : 1;
-       bool                     _silent : 1;
-       bool                     _declickable : 1;
-       int                      _pending_declick;
+       virtual void process_output_buffers (BufferSet& bufs,
+                                            sframes_t start_frame, sframes_t end_frame,
+                                            nframes_t nframes, bool with_processors, int declick);
        
-       MeterPoint               _meter_point;
-
-       gain_t                    solo_gain;
-       gain_t                    mute_gain;
-       gain_t                    desired_solo_gain;
-       gain_t                    desired_mute_gain;
-
-       jack_nframes_t            check_initial_delay (jack_nframes_t, jack_nframes_t&, jack_nframes_t&);
-
-       jack_nframes_t           _initial_delay;
-       jack_nframes_t           _roll_delay;
-       jack_nframes_t           _own_latency;
-       RedirectList             _redirects;
-       Glib::RWLock      redirect_lock;
-       IO                      *_control_outs;
-       Glib::Mutex      control_outs_lock;
-       RouteGroup              *_edit_group;
-       RouteGroup              *_mix_group;
-       std::string              _comment;
-       bool                     _have_internal_generator;
-
-       ToggleControllable _solo_control;
-       ToggleControllable _mute_control;
+       Flag           _flags;
+       int            _pending_declick;
+       MeterPoint     _meter_point;
+
+       gain_t          solo_gain;
+       gain_t          mute_gain;
+       gain_t          desired_solo_gain;
+       gain_t          desired_mute_gain;
        
-       void passthru (jack_nframes_t start_frame, jack_nframes_t end_frame, 
-                      jack_nframes_t nframes, jack_nframes_t offset, int declick, bool meter_inputs);
+       nframes_t      _initial_delay;
+       nframes_t      _roll_delay;
+       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
+       RouteGroup    *_edit_group;
+       RouteGroup    *_mix_group;
+       std::string    _comment;
+       bool           _have_internal_generator;
+       
+       boost::shared_ptr<ToggleControllable> _solo_control;
+       boost::shared_ptr<ToggleControllable> _mute_control;
+
+       /* tight cache-line access here is more important than sheer speed of access.
+          keep these after things that should be aligned
+       */
 
-       void process_output_buffers (vector<Sample*>& bufs, uint32_t nbufs,
-                                    jack_nframes_t start_frame, jack_nframes_t end_frame,
-                                    jack_nframes_t nframes, jack_nframes_t offset, bool with_redirects, int declick,
-                                    bool meter);
+       bool _muted : 1;
+       bool _soloed : 1;
+       bool _solo_safe : 1;
+       bool _recordable : 1;
+       bool _mute_affects_pre_fader : 1;
+       bool _mute_affects_post_fader : 1;
+       bool _mute_affects_control_outs : 1;
+       bool _mute_affects_main_outs : 1;
+       bool _silent : 1;
+       bool _declickable : 1;
 
   protected:
-       /* for derived classes */
 
        virtual XMLNode& state(bool);
 
-       void silence (jack_nframes_t nframes, jack_nframes_t offset);
+       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;
 
-       state_id_t _current_state_id;
-       uint32_t redirect_max_outs;
+       ChanCount processor_max_streams;
        uint32_t _remote_control_id;
 
        uint32_t pans_required() const;
-       uint32_t n_process_buffers ();
+       ChanCount n_process_buffers ();
+       
+       void setup_peak_meters ();
+
+       virtual int  _set_state (const XMLNode&, bool call_base);
+       virtual void _set_processor_states (const XMLNodeList&);
+
+       boost::shared_ptr<Delivery> add_listener (boost::shared_ptr<IO>, const std::string&);
 
   private:
        void init ();
 
        static uint32_t order_key_cnt;
-       typedef std::map<std::string,long> OrderKeys;
+
+       struct ltstr {
+           bool operator()(const char* s1, const char* s2) const {
+                   return strcmp(s1, s2) < 0;
+           }
+       };
+
+       typedef std::map<const char*,long,ltstr> OrderKeys;
        OrderKeys order_keys;
 
        void input_change_handler (IOChange, void *src);
        void output_change_handler (IOChange, void *src);
 
-       bool legal_redirect (Redirect&);
-       int reset_plugin_counts (uint32_t*); /* locked */
-       int _reset_plugin_counts (uint32_t*); /* unlocked */
-
-       /* plugin count handling */
-
-       struct InsertCount {
-           ARDOUR::Insert& insert;
-           int32_t cnt;
-           int32_t in;
-           int32_t out;
+       bool _in_configure_processors;
 
-           InsertCount (ARDOUR::Insert& ins) : insert (ins), cnt (-1) {}
-       };
+       int configure_processors (ProcessorStreams*);
+       int configure_processors_unlocked (ProcessorStreams*);
        
-       int32_t apply_some_plugin_counts (std::list<InsertCount>& iclist);
-       int32_t check_some_plugin_counts (std::list<InsertCount>& iclist, int32_t required_inputs, uint32_t* err_streams);
-
        void set_deferred_state ();
-       void add_redirect_from_xml (const XMLNode&);
-       void redirect_active_proxy (Redirect*, void*);
+       bool add_processor_from_xml (const XMLNode&, Placement);
+       bool add_processor_from_xml (const XMLNode&, ProcessorList::iterator iter);     
+
+       void placement_range (Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end);
 };
 
 } // namespace ARDOUR