s/ParamID/Parameter/
[ardour.git] / libs / ardour / ardour / route.h
index 5686dfc9081937c02c6a62d9bbf0db23f39fb5ac..1fd6eff0f8917e34c4a04ba00691e57de2ce6f6e 100644 (file)
@@ -15,7 +15,6 @@
     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__
 #include <map>
 #include <string>
 
+#include <boost/shared_ptr.hpp>
+
 #include <pbd/fastlog.h>
 #include <glibmm/thread.h>
 #include <pbd/xml++.h>
 #include <pbd/undo.h>
-#include <midi++/controllable.h>
+#include <pbd/stateful.h> 
+#include <pbd/controllable.h>
+#include <pbd/destructible.h>
 
 #include <ardour/ardour.h>
-#include <ardour/stateful.h>
 #include <ardour/io.h>
 #include <ardour/session.h>
-#include <ardour/redirect.h>
+#include <ardour/io_processor.h>
+#include <ardour/types.h>
 
 namespace ARDOUR {
 
-class Insert;
+class Processor;
 class Send;
 class RouteGroup;
 
@@ -56,46 +59,48 @@ class Route : public IO
 {
   protected:
 
-        typedef list<Redirect *> RedirectList;
+       typedef list<boost::shared_ptr<Processor> > ProcessorList;
+
   public:
 
        enum Flag {
                Hidden = 0x1,
                MasterOut = 0x2,
-               ControlOut = 0x4,
+               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, int input_min, int input_max, int output_min, int output_max,
+              Flag flags = Flag(0), DataType default_type = DataType::AUDIO);
+       Route (Session&, const XMLNode&, DataType default_type = DataType::AUDIO);
        virtual ~Route();
 
        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);
+       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 (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  roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame, 
+                          nframes_t offset, int declick, 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  no_roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame, 
+                             nframes_t offset, bool state_changing, 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 int  silent_roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame, 
+                                 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 */
@@ -116,13 +121,11 @@ class Route : public IO
 
        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; }
@@ -134,43 +137,59 @@ class Route : public IO
        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) {
+       template<class T> void foreach_processor (T *obj, void (T::*func)(boost::shared_ptr<Processor>)) {
+               Glib::RWLock::ReaderLock lm (_processor_lock);
+               for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
                        (obj->*func) (*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<IOProcessor> ();
                } else {
                        return *i;
                }
        }
        
-       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);
+       ChanCount max_processor_outs () const { return processor_max_outs; }
+       ChanCount pre_fader_streams() const;
+       
+       /** 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) {}
+
+               size_t    index; ///< Index of processor where configuration failed
+               ChanCount count; ///< Input requested of processor
+       };
+
+       int add_processor (boost::shared_ptr<Processor>, ProcessorStreams* err = 0);
+       int add_processors (const ProcessorList&, ProcessorStreams* err = 0);
+       int remove_processor (boost::shared_ptr<Processor>, ProcessorStreams* err = 0);
+       int copy_processors (const Route&, Placement, ProcessorStreams* err = 0);
+       int sort_processors (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 +199,14 @@ 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,49 +218,40 @@ 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);
+       sigc::signal<void,void*> SelectedChanged;
 
        int set_control_outs (const vector<std::string>& ports);
        IO* control_outs() { return _control_outs; }
 
-       bool feeds (Route *);
-       set<Route *> fed_by;
-
-       struct MIDIToggleControl : public MIDI::Controllable {
-               enum ToggleType {
-                       MuteControl = 0,
-                       SoloControl
-               };
-               
-               MIDIToggleControl (Route&, ToggleType, MIDI::Port *);
-               void set_value (float);
-               void send_feedback (bool);
-               MIDI::byte* write_feedback (MIDI::byte* buf, int32_t& bufsize, bool val, bool force = false);
-
-               Route& route;
-               ToggleType type;
-               bool setting;
-               bool last_written;
+       bool feeds (boost::shared_ptr<Route>);
+       set<boost::shared_ptr<Route> > fed_by;
+
+       struct ToggleControllable : public PBD::Controllable {
+           enum ToggleType {
+                   MuteControl = 0,
+                   SoloControl
+           };
+           
+           ToggleControllable (std::string name, Route&, ToggleType);
+           void set_value (float);
+           float get_value (void) const;
+
+           Route& route;
+           ToggleType type;
        };
 
-       MIDI::Controllable& midi_solo_control() {
-               return _midi_solo_control;
+       boost::shared_ptr<PBD::Controllable> solo_control() {
+               return _solo_control;
        }
-       MIDI::Controllable& midi_mute_control() {
-               return _midi_mute_control;
+
+       boost::shared_ptr<PBD::Controllable> mute_control() {
+               return _mute_control;
        }
        
-       virtual void reset_midi_control (MIDI::Port*, bool);
-       virtual void send_all_midi_feedback ();
-       virtual MIDI::byte* write_midi_feedback (MIDI::byte*, int32_t& bufsize);
-
-       void automation_snapshot (jack_nframes_t now);
-
+       void automation_snapshot (nframes_t now);
        void protect_automation ();
        
        void set_remote_control_id (uint32_t id);
@@ -252,12 +262,12 @@ class Route : public IO
        friend class Session;
 
        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;
+       Flag _flags;
 
        /* tight cache-line access here is more important than sheer speed of
           access.
@@ -265,9 +275,7 @@ class Route : public IO
 
        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;
@@ -285,79 +293,92 @@ class Route : public IO
        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;
-
-       MIDIToggleControl _midi_solo_control;
-       MIDIToggleControl _midi_mute_control;
+
+
+       nframes_t           _initial_delay;
+       nframes_t           _roll_delay;
+       ProcessorList       _processors;
+       Glib::RWLock        _processor_lock;
+       IO                 *_control_outs;
+       Glib::Mutex         _control_outs_lock;
+       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;
+       
+       nframes_t check_initial_delay (nframes_t, nframes_t&, nframes_t&);
        
-       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);
+       void passthru (nframes_t start_frame, nframes_t end_frame, 
+                      nframes_t nframes, nframes_t offset, int declick, bool meter_inputs);
 
-       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,
+       virtual void process_output_buffers (BufferSet& bufs,
+                                    nframes_t start_frame, nframes_t end_frame,
+                                    nframes_t nframes, nframes_t offset, bool with_processors, int declick,
                                     bool meter);
 
   protected:
-       /* for derived classes */
 
        virtual XMLNode& state(bool);
 
-       void silence (jack_nframes_t nframes, jack_nframes_t offset);
+       void passthru_silence (nframes_t start_frame, nframes_t end_frame,
+                              nframes_t nframes, nframes_t offset, int declick,
+                              bool meter);
+       
+       void silence (nframes_t nframes, nframes_t offset);
+       
        sigc::connection input_signal_connection;
 
-       state_id_t _current_state_id;
-       uint32_t redirect_max_outs;
+       ChanCount processor_max_outs;
        uint32_t _remote_control_id;
 
        uint32_t pans_required() const;
-       uint32_t n_process_buffers ();
+       ChanCount n_process_buffers ();
+
+       virtual int  _set_state (const XMLNode&, bool call_base);
+       virtual void _set_processor_states (const XMLNodeList&);
 
   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 */
+       int reset_plugin_counts (ProcessorStreams*); /* locked */
+       int _reset_plugin_counts (ProcessorStreams*); /* unlocked */
 
-       /* plugin count handling */
+       /* processor I/O channels and plugin count handling */
 
-       struct InsertCount {
-           ARDOUR::Insert& insert;
-           int32_t cnt;
-           int32_t in;
-           int32_t out;
+       struct ProcessorCount {
+           boost::shared_ptr<ARDOUR::Processor> processor;
+           ChanCount in;
+           ChanCount out;
 
-           InsertCount (ARDOUR::Insert& ins) : insert (ins), cnt (-1) {}
+           ProcessorCount (boost::shared_ptr<ARDOUR::Processor> ins) : processor(ins) {}
        };
        
-       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);
+       int32_t apply_some_plugin_counts (std::list<ProcessorCount>& iclist);
+       bool    check_some_plugin_counts (std::list<ProcessorCount>& iclist, ChanCount required_inputs, ProcessorStreams* err_streams);
 
        void set_deferred_state ();
-       void add_redirect_from_xml (const XMLNode&);
-       void redirect_active_proxy (Redirect*, void*);
+       void add_processor_from_xml (const XMLNode&);
 };
 
-}; /* namespace ARDOUR*/
+} // namespace ARDOUR
 
 #endif /* __ardour_route_h__ */