cont'd work on plugin-state templates - #6709
[ardour.git] / libs / ardour / ardour / route.h
index ff10c30ce18c59668957f312078708e842985b23..0ef063b29cf0d27339e0524037bc203cea523d98 100644 (file)
@@ -101,7 +101,7 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
        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 &);
+       static void set_name_in_state (XMLNode &, const std::string &, bool rename_playlist = true);
 
         uint32_t order_key () const;
         bool has_order_key () const;
@@ -113,7 +113,7 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
 
        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,
@@ -129,6 +129,8 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
 
        virtual void set_record_enabled (bool /*yn*/, void * /*src*/) {}
        virtual bool record_enabled() const { return false; }
+       virtual void set_record_safe (bool yn, void *src) {}
+       virtual bool record_safe () const {return false; }
        virtual void nonrealtime_handle_transport_stopped (bool abort, bool did_locate, bool flush_processors);
        virtual void realtime_handle_transport_stopped () {}
        virtual void realtime_locate () {}
@@ -142,18 +144,23 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
        void set_gain (gain_t val, void *src);
        void inc_gain (gain_t delta, void *src);
 
+       void set_trim (gain_t val, void *src);
+       void inc_trim (gain_t delta, void *src);
+
        void set_mute_points (MuteMaster::MutePoint);
        MuteMaster::MutePoint mute_points () const;
 
        bool muted () const;
        void set_mute (bool yn, void* src);
-       
+
+       bool muted_by_others() const;
+
        /* controls use set_solo() to modify this route's solo state
         */
 
-       void set_solo (bool yn, void *src);
+       void set_solo (bool yn, void *src, bool group_override = false);
        bool soloed () const { return self_soloed () || soloed_by_others (); }
-       void cancel_solo_after_disconnect (bool upstream);
+       void clear_all_solo_state ();
 
        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; }
@@ -166,7 +173,7 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
        void set_solo_safe (bool yn, void *src);
        bool solo_safe() const;
 
-       void set_listen (bool yn, void* src);
+       void set_listen (bool yn, void* src, bool group_override = false);
        bool listening_via_monitor () const;
        void enable_monitor_send ();
 
@@ -179,8 +186,9 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
        bool denormal_protection() const;
 
        void         set_meter_point (MeterPoint, bool force = false);
-       MeterPoint   meter_point() const { return _meter_point; }
-       void         meter ();
+       bool         apply_processor_changes_rt ();
+       void         emit_pending_signals ();
+       MeterPoint   meter_point() const { return _pending_meter_point; }
 
        void         set_meter_type (MeterType t) { _meter_type = t; }
        MeterType    meter_type() const { return _meter_type; }
@@ -199,9 +207,6 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
        void foreach_processor (boost::function<void(boost::weak_ptr<Processor>)> method) {
                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;
-                       }
                        method (boost::weak_ptr<Processor> (*i));
                }
        }
@@ -256,6 +261,7 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
        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);
+       bool processors_reorder_needs_configure (const ProcessorList& new_order);
        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);
@@ -280,8 +286,8 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
        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::Signal2<void,void*,bool> listen_changed;
+       PBD::Signal3<void,bool,void*,bool> solo_changed;
        PBD::Signal1<void,void*> solo_safe_changed;
        PBD::Signal1<void,void*> solo_isolated_changed;
        PBD::Signal1<void,void*> comment_changed;
@@ -383,6 +389,7 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
        public:
                SoloControllable (std::string name, boost::shared_ptr<Route>);
                void set_value (double);
+               void set_value_unchecked (double);
                double get_value () const;
 
        private:
@@ -393,6 +400,7 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
        public:
                MuteControllable (std::string name, boost::shared_ptr<Route>);
                void set_value (double);
+               void set_value_unchecked (double);
                double get_value () const;
 
                /* Pretend to change value, but do not affect actual route mute. */
@@ -402,6 +410,28 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
                boost::weak_ptr<Route> _route;
        };
 
+       class LIBARDOUR_API PhaseControllable : public AutomationControl {
+       public:
+               PhaseControllable (std::string name, boost::shared_ptr<Route>);
+               void set_value (double);
+               void set_channel (uint32_t);
+               double get_value () const;
+               uint32_t channel() const;
+
+       private:
+               boost::weak_ptr<Route> _route;
+               uint32_t _current_phase;
+       };
+
+       class LIBARDOUR_API GroupGainControllable : public AutomationControl {
+       public:
+               GroupGainControllable (std::string name, boost::shared_ptr<Route>);
+               void set_value (double);
+               double get_value () const;
+       private:
+               boost::weak_ptr<Route> _route;
+       };
+
        boost::shared_ptr<SoloControllable> solo_control() const {
                return _solo_control;
        }
@@ -414,6 +444,14 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
                return _mute_master;
        }
 
+       boost::shared_ptr<PhaseControllable> phase_control() const {
+               return _phase_control;
+       }
+
+       boost::shared_ptr<GroupGainControllable> group_gain_control() const {
+               return _group_gain_control;
+       }
+
        /* 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.
@@ -423,6 +461,7 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
        boost::shared_ptr<PannerShell> panner_shell() const;
        boost::shared_ptr<AutomationControl> gain_control() const;
        boost::shared_ptr<Pannable> pannable() const;
+       boost::shared_ptr<AutomationControl> trim_control() const;
 
        /**
           Return the first processor that accepts has at least one MIDI input
@@ -434,9 +473,53 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
        boost::shared_ptr<Processor> the_instrument() const;
         InstrumentInfo& instrument_info() { return _instrument_info; }
 
+        /* "well-known" controls for panning. Any or all of these may return
+         * null.
+         */
+
+        boost::shared_ptr<AutomationControl> pan_azimuth_control() const;
+        boost::shared_ptr<AutomationControl> pan_elevation_control() const;
+        boost::shared_ptr<AutomationControl> pan_width_control() const;
+        boost::shared_ptr<AutomationControl> pan_frontback_control() const;
+        boost::shared_ptr<AutomationControl> pan_lfe_control() const;
+
+        /* "well-known" controls for an EQ in this route. Any or all may
+         * be null. eq_band_cnt() must return 0 if there is no EQ present.
+         * Passing an @param band value >= eq_band_cnt() will guarantee the
+         * return of a null ptr (or an empty string for eq_band_name()).
+         */
+        uint32_t eq_band_cnt () const;
+        std::string eq_band_name (uint32_t) 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;
+
+        /* "well-known" controls for a compressor in this route. Any or all may
+         * be null.
+         */
+        boost::shared_ptr<AutomationControl> comp_enable_controllable () const;
+        boost::shared_ptr<AutomationControl> comp_threshold_controllable () const;
+        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;
+
+        /* @param mode must be supplied by the comp_mode_controllable(). All other values
+         * result in undefined behaviour
+         */
+        std::string comp_mode_name (uint32_t mode) const;
+        /* @param mode - as for comp mode name. This returns the name for the
+         * parameter/control accessed via comp_speed_controllable(), which can
+         * be mode dependent.
+         */
+        std::string comp_speed_name (uint32_t mode) const;
+
        void protect_automation ();
 
-       enum { 
+       enum {
                /* These numbers are taken from MIDI Machine Control,
                   which can only control up to 317 tracks without
                   doing sysex segmentation.
@@ -505,6 +588,7 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
        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;
 
@@ -516,15 +600,30 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
        boost::shared_ptr<MonitorProcessor> _monitor_control;
        boost::shared_ptr<Pannable> _pannable;
 
+       enum {
+               EmitNone = 0x00,
+               EmitMeterChanged = 0x01,
+               EmitMeterVisibilityChange = 0x02,
+               EmitRtProcessorChange = 0x04
+       };
+
+       ProcessorList  _pending_processor_order;
+       gint           _pending_process_reorder; // atomic
+       gint           _pending_signals; // atomic
+
        Flag           _flags;
        int            _pending_declick;
        MeterPoint     _meter_point;
+       MeterPoint     _pending_meter_point;
        MeterType      _meter_type;
        boost::dynamic_bitset<> _phase_invert;
        bool           _self_solo;
        uint32_t       _soloed_by_others_upstream;
        uint32_t       _soloed_by_others_downstream;
-       uint32_t       _solo_isolated;
+       bool           _solo_isolated;
+       uint32_t       _solo_isolated_by_upstream;
+
+       void mod_solo_isolated_by_upstream (bool, void*);
 
        bool           _denormal_protection;
 
@@ -535,6 +634,8 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
        boost::shared_ptr<SoloControllable> _solo_control;
        boost::shared_ptr<MuteControllable> _mute_control;
        boost::shared_ptr<MuteMaster> _mute_master;
+       boost::shared_ptr<PhaseControllable> _phase_control;
+       boost::shared_ptr<GroupGainControllable> _group_gain_control;
 
        virtual void act_on_mute () {}
 
@@ -594,6 +695,9 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
        bool _initial_io_setup;
 
        int configure_processors_unlocked (ProcessorStreams*);
+       bool set_meter_point_unlocked ();
+       void apply_processor_order (const ProcessorList& new_order);
+
        std::list<std::pair<ChanCount, ChanCount> > try_configure_processors (ChanCount, ProcessorStreams *);
        std::list<std::pair<ChanCount, ChanCount> > try_configure_processors_unlocked (ChanCount, ProcessorStreams *);
 
@@ -610,6 +714,8 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
        void setup_invisible_processors ();
        void unpan ();
 
+       void set_plugin_state_dir (boost::weak_ptr<Processor>, const std::string&);
+
        boost::shared_ptr<CapturingProcessor> _capturing_processor;
 
        /** A handy class to keep processor state while we attempt a reconfiguration
@@ -643,15 +749,13 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
        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 ();