US2400: send_pan_azimuth lookup function (currently mb-only)
[ardour.git] / libs / ardour / ardour / route.h
index ea783cadca88a5fb16a95cf159d2fede8efc3fd9..235ae2089b7c7c7ec1c5b1d1c71a764240380864 100644 (file)
@@ -28,7 +28,6 @@
 
 #include <boost/shared_ptr.hpp>
 #include <boost/weak_ptr.hpp>
-#include <boost/enable_shared_from_this.hpp>
 
 #include <glibmm/threads.h>
 #include "pbd/fastlog.h"
 #include "ardour/slavable.h"
 
 class RoutePinWindowProxy;
+class PatchChangeGridDialog;
 
 namespace ARDOUR {
 
 class Amp;
 class DelayLine;
 class Delivery;
+class DiskReader;
+class DiskWriter;
 class IOProcessor;
 class Panner;
 class PannerShell;
@@ -75,6 +77,7 @@ class PluginInsert;
 class RouteGroup;
 class Send;
 class InternalReturn;
+class MonitorControl;
 class MonitorProcessor;
 class Pannable;
 class CapturingProcessor;
@@ -89,9 +92,7 @@ class LIBARDOUR_API Route : public Stripable,
                             public Soloable,
                             public Muteable,
                             public Monitorable,
-                            public Automatable,
-                            public RouteGroupMember,
-                            public boost::enable_shared_from_this<Route>
+                            public RouteGroupMember
 {
 public:
 
@@ -102,6 +103,13 @@ public:
 
        virtual int init ();
 
+       DataType data_type () const {
+               /* XXX ultimately nice to do away with this concept, but it is
+                  quite useful for coders and for users too.
+               */
+               return _default_type;
+       }
+
        boost::shared_ptr<IO> input() const { return _input; }
        boost::shared_ptr<IO> output() const { return _output; }
        IOVector all_inputs () const;
@@ -121,31 +129,32 @@ public:
        bool set_name (const std::string& str);
        static void set_name_in_state (XMLNode &, const std::string &, bool rename_playlist = true);
 
+       boost::shared_ptr<MonitorControl> monitoring_control() const { return _monitoring_control; }
+
        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& need_butler);
+       virtual void filter_input (BufferSet &) {}
+
+       int roll (pframes_t nframes, samplepos_t start_sample, samplepos_t end_sample, int declick, bool& need_butler);
 
-       virtual int no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
-                            bool state_changing);
+       int no_roll (pframes_t nframes, samplepos_t start_sample, samplepos_t end_sample, bool state_changing);
 
-       virtual int silent_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
-                                bool& need_butler);
+       int silent_roll (pframes_t nframes, samplepos_t start_sample, samplepos_t end_sample, bool& need_butler);
 
        virtual bool can_record() { return false; }
 
-       virtual void nonrealtime_handle_transport_stopped (bool abort, bool did_locate, bool flush_processors);
+       virtual void non_realtime_transport_stop (samplepos_t now, bool flush);
        virtual void realtime_handle_transport_stopped () {}
        virtual void realtime_locate () {}
-       virtual void non_realtime_locate (framepos_t);
+       virtual void non_realtime_locate (samplepos_t);
        virtual void set_pending_declick (int);
 
        /* end of vfunc-based API */
 
-       void shift (framepos_t, framecnt_t);
+       void shift (samplepos_t, samplecnt_t);
 
        void set_trim (gain_t val, PBD::Controllable::GroupControlDisposition);
 
@@ -181,6 +190,9 @@ public:
        void         set_meter_type (MeterType t) { _meter_type = t; }
        MeterType    meter_type() const { return _meter_type; }
 
+       void set_disk_io_point (DiskIOPoint);
+       DiskIOPoint disk_io_point() const { return _disk_io_point; }
+
        /* Processors */
 
        boost::shared_ptr<Amp> amp() const  { return _amp; }
@@ -188,7 +200,6 @@ public:
        boost::shared_ptr<PeakMeter>       peak_meter()       { return _meter; }
        boost::shared_ptr<const PeakMeter> peak_meter() const { return _meter; }
        boost::shared_ptr<PeakMeter> shared_peak_meter() const { return _meter; }
-       boost::shared_ptr<DelayLine> delay_line() const  { return _delayline; }
 
        void flush_processors ();
 
@@ -223,6 +234,11 @@ public:
        RoutePinWindowProxy * pinmgr_proxy () const { return _pinmgr_proxy; }
        void set_pingmgr_proxy (RoutePinWindowProxy* wp) { _pinmgr_proxy = wp ; }
 
+       PatchChangeGridDialog* patch_selector_dialog () const { return _patch_selector_dialog; }
+       void set_patch_selector_dialog  (PatchChangeGridDialog* d) { _patch_selector_dialog = d; }
+
+       boost::shared_ptr<AutomationControl> automation_control_recurse (PBD::ID const & id) const;
+
        /* special processors */
 
        boost::shared_ptr<InternalSend>     monitor_send() const { return _monitor_send; }
@@ -279,6 +295,7 @@ public:
        void ab_plugins (bool forward);
        void clear_processors (Placement);
        void all_visible_processors_active (bool);
+       void move_instrument_down (bool postfader = false);
 
        bool strict_io () const { return _strict_io; }
        bool set_strict_io (bool);
@@ -320,19 +337,19 @@ public:
         */
        bool remove_sidechain (boost::shared_ptr<Processor> proc) { return add_remove_sidechain (proc, false); }
 
-       framecnt_t set_private_port_latencies (bool playback) const;
-       void       set_public_port_latencies (framecnt_t, bool playback) const;
+       samplecnt_t  update_signal_latency (bool apply_to_delayline = false);
+       virtual void apply_latency_compensation ();
 
-       framecnt_t   update_signal_latency();
-       virtual void set_latency_compensation (framecnt_t);
+       samplecnt_t  set_private_port_latencies (bool playback) const;
+       void         set_public_port_latencies (samplecnt_t, bool playback) const;
 
-       void set_user_latency (framecnt_t);
-       framecnt_t initial_delay() const { return _initial_delay; }
-       framecnt_t signal_latency() const { return _signal_latency; }
+       void set_user_latency (samplecnt_t);
+       samplecnt_t signal_latency() const { return _signal_latency; }
+       samplecnt_t playback_latency (bool incl_downstream = false) const;
 
-       PBD::Signal0<void>       active_changed;
-       PBD::Signal0<void>       denormal_protection_changed;
-       PBD::Signal0<void>       comment_changed;
+       PBD::Signal0<void> active_changed;
+       PBD::Signal0<void> denormal_protection_changed;
+       PBD::Signal0<void> comment_changed;
 
        /** track numbers - assigned by session
         * nubers > 0 indicate tracks (audio+midi)
@@ -359,28 +376,31 @@ public:
 
        /** the processors have changed; the parameter indicates what changed */
        PBD::Signal1<void,RouteProcessorChange> processors_changed;
+       PBD::Signal0<void> fan_out; // used to signal the GUI to fan-out (track-creation)
        PBD::Signal1<void,void*> record_enable_changed;
        PBD::Signal0<void> processor_latency_changed;
        /** the metering point has changed */
-       PBD::Signal0<void>       meter_change;
-       PBD::Signal0<void>       signal_latency_changed;
-       PBD::Signal0<void>       initial_delay_changed;
+       PBD::Signal0<void> meter_change;
+       /** a processor's latency has changed */
+       PBD::Signal0<void> signal_latency_changed;
+       /** route has updated its latency compensation */
+       PBD::Signal0<void> signal_latency_updated;
 
        /** Emitted with the process lock held */
        PBD::Signal0<void>       io_changed;
 
        /* stateful */
-
        XMLNode& get_state();
+       XMLNode& get_template();
        virtual int set_state (const XMLNode&, int version);
-       virtual XMLNode& get_template();
 
        XMLNode& get_processor_state ();
-       virtual void set_processor_state (const XMLNode&);
+       void set_processor_state (const XMLNode&);
+       virtual bool set_processor_state (XMLNode const & node, XMLProperty const* prop, ProcessorList& new_order, bool& must_configure);
 
        boost::weak_ptr<Route> weakroute ();
 
-       int save_as_template (const std::string& path, const std::string& name);
+       int save_as_template (const std::string& path, const std::string& name, const std::string& description );
 
        PBD::Signal1<void,void*> SelectedChanged;
 
@@ -456,13 +476,6 @@ public:
                return _solo_safe_control;
        }
 
-       boost::shared_ptr<MonitorControl> monitoring_control() const {
-               /* tracks override this to provide actual monitoring control;
-                  busses have no possible choices except input monitoring.
-               */
-               return boost::shared_ptr<MonitorControl> ();
-       }
-
        /* Route doesn't own these items, but sub-objects that it does own have them
           and to make UI code a bit simpler, we provide direct access to them
           here.
@@ -503,12 +516,17 @@ public:
         */
        uint32_t eq_band_cnt () const;
        std::string eq_band_name (uint32_t) const;
+       boost::shared_ptr<AutomationControl> eq_enable_controllable () const;
        boost::shared_ptr<AutomationControl> eq_gain_controllable (uint32_t band) const;
        boost::shared_ptr<AutomationControl> eq_freq_controllable (uint32_t band) const;
        boost::shared_ptr<AutomationControl> eq_q_controllable (uint32_t band) const;
        boost::shared_ptr<AutomationControl> eq_shape_controllable (uint32_t band) const;
-       boost::shared_ptr<AutomationControl> eq_enable_controllable () const;
-       boost::shared_ptr<AutomationControl> eq_hpf_controllable () const;
+
+       //additional HP/LP filters
+       boost::shared_ptr<AutomationControl> filter_freq_controllable (bool hpf) const;
+       boost::shared_ptr<AutomationControl> filter_slope_controllable (bool) const;
+       boost::shared_ptr<AutomationControl> filter_enable_controllable (bool) const;
+
 
        /* "well-known" controls for a compressor in this route. Any or all may
         * be null.
@@ -518,7 +536,7 @@ public:
        boost::shared_ptr<AutomationControl> comp_speed_controllable () const;
        boost::shared_ptr<AutomationControl> comp_mode_controllable () const;
        boost::shared_ptr<AutomationControl> comp_makeup_controllable () const;
-       boost::shared_ptr<AutomationControl> comp_redux_controllable () const;
+       boost::shared_ptr<ReadOnlyControl>   comp_redux_controllable () const;
 
        /* @param mode must be supplied by the comp_mode_controllable(). All other values
         * result in undefined behaviour
@@ -539,6 +557,7 @@ public:
         */
        boost::shared_ptr<AutomationControl> send_level_controllable (uint32_t n) const;
        boost::shared_ptr<AutomationControl> send_enable_controllable (uint32_t n) const;
+       boost::shared_ptr<AutomationControl> send_pan_azi_controllable (uint32_t n) const;
        /* for the same value of @param n, this returns the name of the send
         * associated with the pair of controllables returned by the above two methods.
         */
@@ -559,14 +578,16 @@ public:
        /* 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,
+       void monitor_run (samplepos_t start_sample, samplepos_t end_sample,
                        pframes_t nframes, int declick);
 
-        bool slaved_to (boost::shared_ptr<VCA>) const;
-        bool slaved () const;
+       bool slaved_to (boost::shared_ptr<VCA>) const;
+       bool slaved () const;
 
-  protected:
-        friend class Session;
+       virtual void use_captured_sources (SourceList& srcs, CaptureInfos const &) {}
+
+protected:
+       friend class Session;
 
        void catch_up_on_solo_mute_override ();
        void set_listen (bool);
@@ -574,49 +595,48 @@ public:
        void curve_reallocate ();
        virtual void set_block_size (pframes_t nframes);
 
-  protected:
-        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 (BufferSet&, framepos_t start_frame, framepos_t end_frame,
-                       pframes_t nframes, int declick);
+       virtual int no_roll_unlocked (pframes_t nframes, samplepos_t start_sample, samplepos_t end_sample, bool session_state_changing);
 
-       virtual void write_out_of_band_data (BufferSet& /* bufs */, framepos_t /* start_frame */, framepos_t /* end_frame */,
-                                            framecnt_t /* nframes */) {}
+       virtual void snapshot_out_of_band_data (samplecnt_t /* nframes */) {}
+       virtual void write_out_of_band_data (BufferSet&, samplecnt_t /* nframes */) const {}
+       virtual void update_controls (BufferSet const&) {}
 
-       virtual void process_output_buffers (BufferSet& bufs,
-                                            framepos_t start_frame, framepos_t end_frame,
-                                            pframes_t nframes, int declick,
-                                            bool gain_automation_ok);
+       void process_output_buffers (BufferSet& bufs,
+                                    samplepos_t start_sample, samplepos_t end_sample,
+                                    pframes_t nframes, int declick,
+                                    bool gain_automation_ok,
+                                    bool run_disk_processors);
 
-       void flush_processor_buffers_locked (framecnt_t nframes);
+       void flush_processor_buffers_locked (samplecnt_t nframes);
 
        virtual void bounce_process (BufferSet& bufs,
-                                    framepos_t start_frame, framecnt_t nframes,
+                                    samplepos_t start_sample, samplecnt_t nframes,
                                                                                                                         boost::shared_ptr<Processor> endpoint, bool include_endpoint,
                                     bool for_export, bool for_freeze);
 
-       framecnt_t   bounce_get_latency (boost::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export, bool for_freeze) const;
+       samplecnt_t  bounce_get_latency (boost::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export, bool for_freeze) const;
        ChanCount    bounce_get_output_streams (ChanCount &cc, boost::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export, bool for_freeze) const;
 
-       boost::shared_ptr<IO> _input;
-       boost::shared_ptr<IO> _output;
-
        bool           _active;
-       framecnt_t     _signal_latency;
-       framecnt_t     _signal_latency_at_amp_position;
-       framecnt_t     _signal_latency_at_trim_position;
-       framecnt_t     _initial_delay;
-       framecnt_t     _roll_delay;
+       samplecnt_t    _signal_latency;
 
        ProcessorList  _processors;
-       mutable Glib::Threads::RWLock   _processor_lock;
-       boost::shared_ptr<Delivery> _main_outs;
-       boost::shared_ptr<InternalSend> _monitor_send;
-       boost::shared_ptr<InternalReturn> _intreturn;
+       mutable Glib::Threads::RWLock _processor_lock;
+
+       boost::shared_ptr<IO>               _input;
+       boost::shared_ptr<IO>               _output;
+
+       boost::shared_ptr<Delivery>         _main_outs;
+       boost::shared_ptr<InternalSend>     _monitor_send;
+       boost::shared_ptr<InternalReturn>   _intreturn;
        boost::shared_ptr<MonitorProcessor> _monitor_control;
-       boost::shared_ptr<Pannable> _pannable;
+       boost::shared_ptr<Pannable>         _pannable;
+       boost::shared_ptr<DiskReader>       _disk_reader;
+       boost::shared_ptr<DiskWriter>       _disk_writer;
+
+       boost::shared_ptr<MonitorControl>   _monitoring_control;
+
+       DiskIOPoint _disk_io_point;
 
        enum {
                EmitNone = 0x00,
@@ -637,7 +657,6 @@ public:
        bool           _denormal_protection;
 
        bool _recordable : 1;
-       bool _silent : 1;
        bool _declickable : 1;
 
        boost::shared_ptr<SoloControl> _solo_control;
@@ -655,16 +674,12 @@ public:
 
        virtual ChanCount input_streams () const;
 
-protected:
-       virtual XMLNode& state(bool);
+       virtual XMLNode& state (bool save_template);
 
        int configure_processors (ProcessorStreams*);
 
-       void passthru_silence (framepos_t start_frame, framepos_t end_frame,
-                              pframes_t nframes, int declick);
-
-       void silence (framecnt_t);
-       void silence_unlocked (framecnt_t);
+       void silence (samplecnt_t);
+       void silence_unlocked (samplecnt_t);
 
        ChanCount processor_max_streams;
        ChanCount processor_out_streams;
@@ -672,19 +687,25 @@ protected:
        uint32_t pans_required() const;
        ChanCount n_process_buffers ();
 
-       virtual void maybe_declick (BufferSet&, framecnt_t, int);
+       virtual void maybe_declick (BufferSet&, samplecnt_t, int);
 
        boost::shared_ptr<GainControl> _gain_control;
        boost::shared_ptr<Amp>       _amp;
        boost::shared_ptr<GainControl> _trim_control;
        boost::shared_ptr<Amp>       _trim;
        boost::shared_ptr<PeakMeter> _meter;
+
        boost::shared_ptr<DelayLine> _delayline;
 
+       bool is_internal_processor (boost::shared_ptr<Processor>) const;
+
        boost::shared_ptr<Processor> the_instrument_unlocked() const;
 
-  private:
-       int64_t _track_number;
+       SlavableControlList slavables () const;
+
+private:
+       /* no copy construction */
+       Route (Route const &);
 
        int set_state_2X (const XMLNode&, int);
        void set_processor_state_2X (XMLNodeList const &, int);
@@ -700,10 +721,6 @@ protected:
        bool input_port_count_changing (ChanCount);
        bool output_port_count_changing (ChanCount);
 
-       bool _in_configure_processors;
-       bool _initial_io_setup;
-       bool _in_sidechain_setup;
-
        int configure_processors_unlocked (ProcessorStreams*, Glib::Threads::RWLock::WriterLock*);
        bool set_meter_point_unlocked ();
        void apply_processor_order (const ProcessorList& new_order);
@@ -716,16 +733,23 @@ protected:
        void placement_range (Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end);
 
        void set_self_solo (bool yn);
+       void unpan ();
 
        void set_processor_positions ();
-       framecnt_t update_port_latencies (PortSet& ports, PortSet& feeders, bool playback, framecnt_t) const;
+       samplecnt_t update_port_latencies (PortSet& ports, PortSet& feeders, bool playback, samplecnt_t) const;
 
        void setup_invisible_processors ();
-       void unpan ();
 
-       void set_plugin_state_dir (boost::weak_ptr<Processor>, const std::string&);
+       pframes_t latency_preroll (pframes_t nframes, samplepos_t& start_sample, samplepos_t& end_sample);
 
-       boost::shared_ptr<CapturingProcessor> _capturing_processor;
+       void run_route (samplepos_t start_sample, samplepos_t end_sample, pframes_t nframes, int declick, bool gain_automation_ok, bool run_disk_reader);
+       void fill_buffers_with_input (BufferSet& bufs, boost::shared_ptr<IO> io, pframes_t nframes);
+
+       void reset_instrument_info ();
+       void solo_control_changed (bool self, PBD::Controllable::GroupControlDisposition);
+       void maybe_note_meter_position ();
+
+       void set_plugin_state_dir (boost::weak_ptr<Processor>, const std::string&);
 
        /** A handy class to keep processor state while we attempt a reconfiguration
         *  that may fail.
@@ -754,12 +778,13 @@ protected:
 
        friend class ProcessorState;
 
-       bool _strict_io;
-
-       /* no copy construction */
-       Route (Route const &);
+       boost::shared_ptr<CapturingProcessor> _capturing_processor;
 
-       void maybe_note_meter_position ();
+       int64_t _track_number;
+       bool    _strict_io;
+       bool    _in_configure_processors;
+       bool    _initial_io_setup;
+       bool    _in_sidechain_setup;
 
        /** true if we've made a note of a custom meter position in these variables */
        bool _custom_meter_position_noted;
@@ -767,11 +792,9 @@ protected:
            or 0.
        */
        boost::weak_ptr<Processor> _processor_after_last_custom_meter;
-       RoutePinWindowProxy *_pinmgr_proxy;
-
-       void reset_instrument_info ();
 
-        void solo_control_changed (bool self, PBD::Controllable::GroupControlDisposition);
+       RoutePinWindowProxy*   _pinmgr_proxy;
+       PatchChangeGridDialog* _patch_selector_dialog;
 };
 
 } // namespace ARDOUR