allow to include solo,mute buttons on meterbridge
[ardour.git] / libs / ardour / ardour / route.h
index 1d8c39a21eb2e6dd411f7f32d195e75dda4a4cc3..2e44d00984f018df7b13ce097a8974c520b9d9b2 100644 (file)
@@ -32,7 +32,7 @@
 #include <boost/dynamic_bitset.hpp>
 #include <boost/enable_shared_from_this.hpp>
 
-#include <glibmm/thread.h>
+#include <glibmm/threads.h>
 #include "pbd/fastlog.h"
 #include "pbd/xml++.h"
 #include "pbd/undo.h"
@@ -41,6 +41,7 @@
 #include "pbd/destructible.h"
 
 #include "ardour/ardour.h"
+#include "ardour/instrument_info.h"
 #include "ardour/io.h"
 #include "ardour/types.h"
 #include "ardour/mute_master.h"
@@ -73,7 +74,7 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        typedef std::list<boost::shared_ptr<Processor> > ProcessorList;
 
        enum Flag {
-               Hidden = 0x1,
+               Auditioner = 0x1,
                MasterOut = 0x2,
                MonitorOut = 0x4
        };
@@ -98,26 +99,31 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        void set_comment (std::string str, void *src);
 
        bool set_name (const std::string& str);
+       static void set_name_in_state (XMLNode &, const std::string &);
 
-       int32_t order_key (std::string const &) const;
-       void set_order_key (std::string const &, int32_t);
+        uint32_t order_key (RouteSortOrderKey) const;
+        bool has_order_key (RouteSortOrderKey) const;
+       void set_order_key (RouteSortOrderKey, uint32_t);
+        void sync_order_keys (RouteSortOrderKey);
 
-       bool is_hidden() const { return _flags & Hidden; }
+       bool is_auditioner() const { return _flags & Auditioner; }
        bool is_master() const { return _flags & MasterOut; }
        bool is_monitor() const { return _flags & MonitorOut; }
 
+       virtual MonitorState monitoring_state () const;
+       virtual MeterState metering_state () const;
+       
        /* these are the core of the API of a Route. see the protected sections as well */
 
        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);
+                         int declick, bool& need_butler);
 
        virtual int no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
-                            bool state_changing, bool can_record);
+                            bool state_changing);
 
        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);
+                                bool& need_butler);
 
-       virtual void toggle_monitor_input ();
        virtual bool can_record() { return false; }
 
        virtual void set_record_enabled (bool /*yn*/, void * /*src*/) {}
@@ -125,11 +131,12 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        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 non_realtime_locate (framepos_t);
        virtual void set_pending_declick (int);
 
        /* end of vfunc-based API */
 
-       void shift (framepos_t, framepos_t);
+       void shift (framepos_t, framecnt_t);
 
        void set_gain (gain_t val, void *src);
        void inc_gain (gain_t delta, void *src);
@@ -139,12 +146,13 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
 
        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 (); }
+       void cancel_solo_after_disconnect (bool upstream);
 
        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; }
@@ -159,6 +167,7 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
 
        void set_listen (bool yn, void* src);
        bool listening_via_monitor () const;
+       void enable_monitor_send ();
 
        void set_phase_invert (uint32_t, bool yn);
        void set_phase_invert (boost::dynamic_bitset<>);
@@ -169,10 +178,12 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        bool denormal_protection() const;
 
        void         set_meter_point (MeterPoint, bool force = false);
-       void         infer_meter_point () const;
        MeterPoint   meter_point() const { return _meter_point; }
        void         meter ();
 
+       void         set_meter_type (MeterType t) { _meter_type = t; }
+       MeterType    meter_type() const { return _meter_type; }
+
        /* Processors */
 
        boost::shared_ptr<Amp> amp() const  { return _amp; }
@@ -183,7 +194,7 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        void flush_processors ();
 
        void foreach_processor (boost::function<void(boost::weak_ptr<Processor>)> method) {
-               Glib::RWLock::ReaderLock lm (_processor_lock);
+               Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
                for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
                        if (boost::dynamic_pointer_cast<UnknownProcessor> (*i)) {
                                break;
@@ -193,7 +204,7 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        }
 
        boost::shared_ptr<Processor> nth_processor (uint32_t n) {
-               Glib::RWLock::ReaderLock lm (_processor_lock);
+               Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
                ProcessorList::iterator i;
                for (i = _processors.begin(); i != _processors.end() && n; ++i, --n) {}
                if (i == _processors.end()) {
@@ -203,11 +214,11 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
                }
        }
 
+       boost::shared_ptr<Processor> processor_by_id (PBD::ID) const;
+
        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; }
 
@@ -237,9 +248,12 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        };
 
        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 remove_processor (boost::shared_ptr<Processor>, ProcessorStreams* err = 0);
+       int add_processor_by_index (boost::shared_ptr<Processor>, int, ProcessorStreams* err = 0, bool activation_allowed = true);
+       int add_processor (boost::shared_ptr<Processor>, boost::shared_ptr<Processor>, ProcessorStreams* err = 0, bool activation_allowed = true);
+       int add_processors (const ProcessorList&, boost::shared_ptr<Processor>, ProcessorStreams* err = 0);
+       boost::shared_ptr<Processor> before_processor_for_placement (Placement);
+       boost::shared_ptr<Processor> before_processor_for_index (int);
+       int remove_processor (boost::shared_ptr<Processor>, ProcessorStreams* err = 0, bool need_process_lock = true);
        int remove_processors (const ProcessorList&, ProcessorStreams* err = 0);
        int reorder_processors (const ProcessorList& new_order, ProcessorStreams* err = 0);
        void disable_processors (Placement);
@@ -248,8 +262,7 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        void disable_plugins ();
        void ab_plugins (bool forward);
        void clear_processors (Placement);
-       void all_processors_flip();
-       void all_processors_active (Placement, bool state);
+       void all_visible_processors_active (bool);
 
        framecnt_t set_private_port_latencies (bool playback) const;
        void       set_public_port_latencies (framecnt_t, bool playback) const;
@@ -279,7 +292,6 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        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;
@@ -291,7 +303,7 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        /* stateful */
 
        XMLNode& get_state();
-       int set_state (const XMLNode&, int version);
+       virtual int set_state (const XMLNode&, int version);
        virtual XMLNode& get_template();
 
        XMLNode& get_processor_state ();
@@ -301,9 +313,8 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
 
        PBD::Signal1<void,void*> SelectedChanged;
 
-       int listen_via_monitor ();
-       int listen_via (boost::shared_ptr<Route>, Placement p);
-       void drop_listen (boost::shared_ptr<Route>);
+       int add_aux_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>);
+       void remove_aux_or_listen (boost::shared_ptr<Route>);
 
        /**
         * return true if this route feeds the first argument via at least one
@@ -313,9 +324,17 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
 
        /**
         * return true if this route feeds the first argument directly, via
-        * either its main outs or a send.
+        * either its main outs or a send.  This is checked by the actual
+        * connections, rather than by what the graph is currently doing.
+        */
+       bool direct_feeds_according_to_reality (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, according to the graph that
+        * is currently being processed.
         */
-       bool direct_feeds (boost::shared_ptr<Route>, bool* via_send_only = 0);
+       bool direct_feeds_according_to_graph (boost::shared_ptr<Route>, bool* via_send_only = 0);
 
        struct FeedRecord {
                boost::weak_ptr<Route> r;
@@ -337,7 +356,6 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        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 */
 
@@ -385,22 +403,47 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        boost::shared_ptr<AutomationControl> gain_control() const;
        boost::shared_ptr<Pannable> pannable() const;
 
-       void automation_snapshot (framepos_t now, bool force=false);
+       /**
+          Return the first processor that accepts has at least one MIDI input
+          and at least one audio output. In the vast majority of cases, this
+          will be "the instrument". This does not preclude other MIDI->audio
+          processors later in the processing chain, but that would be a
+          special case not covered by this utility function.
+       */
+       boost::shared_ptr<Processor> the_instrument() const;
+        InstrumentInfo& instrument_info() { return _instrument_info; }
+
        void protect_automation ();
 
-       void set_remote_control_id (uint32_t id, bool notify_class_listeners = true);
+       enum { 
+               /* These numbers are taken from MIDI Machine Control,
+                  which can only control up to 317 tracks without
+                  doing sysex segmentation.
+               */
+               MasterBusRemoteControlID = 318,
+               MonitorBusRemoteControlID = 319,
+       };
+
+       void     set_remote_control_id (uint32_t id, bool notify_class_listeners = true);
        uint32_t remote_control_id () const;
+        void     set_remote_control_id_from_order_key (RouteSortOrderKey, uint32_t order_key);
 
        /* for things concerned about *this* route's RID */
 
        PBD::Signal0<void> RemoteControlIDChanged;
 
-       /* for things concerned about any route's RID changes */
+       /* for things concerned about *any* route's RID changes */
 
        static PBD::Signal0<void> RemoteControlIDChange;
+       static PBD::Signal1<void,RouteSortOrderKey> SyncOrderKeys;
 
-       void sync_order_keys (std::string const &);
-       static PBD::Signal1<void,std::string const &> SyncOrderKeys;
+       bool has_external_redirects() const;
+
+        /* can only be executed by a route for which is_monitor() is true
+          (i.e. the monitor out)
+        */
+        void monitor_run (framepos_t start_frame, framepos_t end_frame,
+                         pframes_t nframes, int declick);
 
   protected:
        friend class Session;
@@ -408,23 +451,23 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        void catch_up_on_solo_mute_override ();
        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 (framepos_t start_frame, framepos_t end_frame, pframes_t nframes);
        virtual void set_block_size (pframes_t nframes);
 
   protected:
-       framecnt_t check_initial_delay (framecnt_t, framecnt_t&);
+       virtual framecnt_t check_initial_delay (framecnt_t nframes, framepos_t&) { return nframes; }
+
+        void fill_buffers_with_input (BufferSet& bufs, boost::shared_ptr<IO> io, pframes_t nframes);
 
-       void passthru (framepos_t start_frame, framepos_t end_frame,
+        void passthru (BufferSet&, framepos_t start_frame, framepos_t end_frame,
                        pframes_t nframes, int declick);
 
        virtual void write_out_of_band_data (BufferSet& /* bufs */, framepos_t /* start_frame */, framepos_t /* end_frame */,
-                       framecnt_t /* nframes */) {}
+                                            framecnt_t /* nframes */) {}
 
        virtual void process_output_buffers (BufferSet& bufs,
                                             framepos_t start_frame, framepos_t end_frame,
-                                            pframes_t nframes, bool with_processors, int declick,
+                                            pframes_t nframes, int declick,
                                             bool gain_automation_ok);
 
        boost::shared_ptr<IO> _input;
@@ -436,7 +479,7 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        framecnt_t     _roll_delay;
 
        ProcessorList  _processors;
-       mutable Glib::RWLock   _processor_lock;
+       mutable Glib::Threads::RWLock   _processor_lock;
        boost::shared_ptr<Delivery> _main_outs;
        boost::shared_ptr<InternalSend> _monitor_send;
        boost::shared_ptr<InternalReturn> _intreturn;
@@ -446,6 +489,7 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        Flag           _flags;
        int            _pending_declick;
        MeterPoint     _meter_point;
+       MeterType      _meter_type;
        boost::dynamic_bitset<> _phase_invert;
        bool           _self_solo;
        uint32_t       _soloed_by_others_upstream;
@@ -462,12 +506,16 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        boost::shared_ptr<MuteControllable> _mute_control;
        boost::shared_ptr<MuteMaster> _mute_master;
 
+       virtual void act_on_mute () {}
+
        std::string    _comment;
        bool           _have_internal_generator;
        bool           _solo_safe;
        DataType       _default_type;
        FedBy          _fed_by;
 
+        InstrumentInfo _instrument_info;
+
        virtual ChanCount input_streams () const;
 
   protected:
@@ -482,27 +530,24 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
        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;
        boost::shared_ptr<PeakMeter> _meter;
 
+       boost::shared_ptr<Processor> the_instrument_unlocked() const;
+
   private:
-       int _set_state_2X (const XMLNode&, int);
+       int set_state_2X (const XMLNode&, int);
        void set_processor_state_2X (XMLNodeList const &, int);
 
-       static uint32_t order_key_cnt;
-
-       typedef std::map<std::string, long> OrderKeys;
-       OrderKeys order_keys;
+       typedef std::map<RouteSortOrderKey,uint32_t> OrderKeys;
+       OrderKeys order_keys;
+        uint32_t _remote_control_id;
 
        void input_change_handler (IOChange, void *src);
        void output_change_handler (IOChange, void *src);
@@ -559,6 +604,21 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
 
        /* no copy construction */
        Route (Route const &);
+
+       void maybe_note_meter_position ();
+       
+       /** true if we've made a note of a custom meter position in these variables */
+       bool _custom_meter_position_noted;
+       /** the processor that came after the meter when it was last set to a custom position,
+           or 0.
+       */
+       boost::weak_ptr<Processor> _processor_after_last_custom_meter;
+       /** true if the last custom meter position was at the end of the processor list */
+       bool _last_custom_meter_was_at_end;
+
+        void reset_instrument_info ();
+
+        void set_remote_control_id_internal (uint32_t id, bool notify_class_listeners = true);
 };
 
 } // namespace ARDOUR