change Controllable::set_value() API to include grouped control consideration.
[ardour.git] / libs / ardour / ardour / route.h
index 7e428ed6e2c3fc29edfa0a6b94ff47d7cc7f507c..2086f32119840f2ea20ffac823ccf0debfe70f91 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;
@@ -383,23 +383,44 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
 
        /* Controls (not all directly owned by the Route */
 
+       class RouteAutomationControl : public AutomationControl {
+       public:
+               RouteAutomationControl (const std::string& name,
+                                       AutomationType atype,
+                                       boost::shared_ptr<AutomationList> alist,
+                                       boost::shared_ptr<Route> route);
+
+               void set_value (double val, PBD::Controllable::GroupControlDisposition group_override) {
+                       boost::shared_ptr<Route> r = _route.lock();
+                       if (r) {
+                               r->set_control (*this, val, group_override);
+                       }
+               }
+
+       protected:
+               friend class Route;
+
+               void route_set_value (double val) {
+                       AutomationControl::set_value (val, Controllable::NoGroup);
+               }
+
+               boost::weak_ptr<Route> _route;
+       };
+
        boost::shared_ptr<AutomationControl> get_control (const Evoral::Parameter& param);
 
-       class SoloControllable : public AutomationControl {
+       class SoloControllable : public RouteAutomationControl {
        public:
                SoloControllable (std::string name, boost::shared_ptr<Route>);
-               void set_value (double);
+               void set_value (double, PBD::Controllable::GroupControlDisposition group_override);
                void set_value_unchecked (double);
                double get_value () const;
-
-       private:
-               boost::weak_ptr<Route> _route;
        };
 
-       struct MuteControllable : public AutomationControl {
+       struct MuteControllable : public RouteAutomationControl {
        public:
                MuteControllable (std::string name, boost::shared_ptr<Route>);
-               void set_value (double);
+               void set_value (double, PBD::Controllable::GroupControlDisposition group_override);
                void set_value_unchecked (double);
                double get_value () const;
 
@@ -410,19 +431,18 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
                boost::weak_ptr<Route> _route;
        };
 
-       class LIBARDOUR_API PhaseControllable : public AutomationControl {
+       class LIBARDOUR_API PhaseControllable : public RouteAutomationControl {
        public:
                PhaseControllable (std::string name, boost::shared_ptr<Route>);
-               void set_value (double);
+               void set_value (double, PBD::Controllable::GroupControlDisposition group_override);
                void set_channel (uint32_t);
                double get_value () const;
                uint32_t channel() const;
-
        private:
-               boost::weak_ptr<Route> _route;
                uint32_t _current_phase;
        };
 
+       void set_control (RouteAutomationControl&, double val, PBD::Controllable::GroupControlDisposition group_override);
 
        boost::shared_ptr<SoloControllable> solo_control() const {
                return _solo_control;
@@ -461,6 +481,50 @@ 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 {
@@ -488,7 +552,7 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
        bool has_external_redirects() const;
 
         /* can only be executed by a route for which is_monitor() is true
-          (i.e. the monitor out)
+          (i.e. the monitor out)
         */
         void monitor_run (framepos_t start_frame, framepos_t end_frame,
                          pframes_t nframes, int declick);
@@ -622,7 +686,7 @@ class LIBARDOUR_API Route : public SessionObject, public Automatable, public Rou
        int set_state_2X (const XMLNode&, int);
        void set_processor_state_2X (XMLNodeList const &, int);
 
-       uint32_t _order_key;
+       uint32_t _order_key;
        bool _has_order_key;
         uint32_t _remote_control_id;
 
@@ -657,6 +721,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