Implement slaved boolean automation and update mute special-case
[ardour.git] / libs / ardour / ardour / slavable_automation_control.h
index 5e95cba22b64ec21f4124b0a683c82ea722ed994..ceafc79193fb950ff4287aac75dbeeb8be31a4c5 100644 (file)
 #define __ardour_slavable_automation_control_h__
 
 #include "ardour/automation_control.h"
+#include "ardour/libardour_visibility.h"
 
 namespace ARDOUR {
 
-class SlavableAutomationControl : public AutomationControl
+class LIBARDOUR_API SlavableAutomationControl : public AutomationControl
 {
-    public:
+public:
        SlavableAutomationControl(ARDOUR::Session&,
-                         const Evoral::Parameter&                  parameter,
-                         const ParameterDescriptor&                desc,
-                         boost::shared_ptr<ARDOUR::AutomationList> l=boost::shared_ptr<ARDOUR::AutomationList>(),
-                         const std::string&                        name="");
+                                 const Evoral::Parameter&                  parameter,
+                                 const ParameterDescriptor&                desc,
+                                 boost::shared_ptr<ARDOUR::AutomationList> l=boost::shared_ptr<ARDOUR::AutomationList>(),
+                                 const std::string&                        name="",
+                                 PBD::Controllable::Flag                   flags=PBD::Controllable::Flag (0)
+               );
+
+       virtual ~SlavableAutomationControl ();
 
        double get_value () const;
 
-       void add_master (boost::shared_ptr<AutomationControl>);
+       void add_master (boost::shared_ptr<AutomationControl>, bool loading);
        void remove_master (boost::shared_ptr<AutomationControl>);
        void clear_masters ();
        bool slaved_to (boost::shared_ptr<AutomationControl>) const;
@@ -45,17 +50,43 @@ class SlavableAutomationControl : public AutomationControl
                return get_masters_value_locked ();
        }
 
+       bool get_masters_curve (framepos_t s, framepos_t e, float* v, framecnt_t l) const {
+               Glib::Threads::RWLock::ReaderLock lm (master_lock);
+               return get_masters_curve_locked (s, e, v, l);
+       }
+       virtual bool get_masters_curve_locked (framepos_t, framepos_t, float*, framecnt_t) const;
+
+       bool masters_curve_multiply (framepos_t, framepos_t, float*, framecnt_t) const;
+
+       /* for toggled/boolean controls, returns a count of the number of
+          masters currently enabled. For other controls, returns zero.
+       */
+       int32_t   get_boolean_masters () const;
+
        std::vector<PBD::ID> masters () const;
 
        PBD::Signal0<void> MasterStatusChange;
 
-    protected:
+       void use_saved_master_ratios ();
+
+       int set_state (XMLNode const&, int);
+       XMLNode& get_state();
+
+       bool find_next_event (double n, double e, Evoral::ControlEvent& ev) const
+       {
+               Glib::Threads::RWLock::ReaderLock lm (master_lock);
+               return find_next_event_locked (n, e, ev);
+       }
+
+       bool find_next_event_locked (double now, double end, Evoral::ControlEvent& next_event) const;
+
+protected:
 
        class MasterRecord {
-          public:
+       public:
                MasterRecord (boost::shared_ptr<AutomationControl> gc, double r)
                        : _master (gc)
-                       , _ratio (r)
+                       , _yn (false)
                {}
 
                boost::shared_ptr<AutomationControl> master() const { return _master; }
@@ -68,43 +99,34 @@ class SlavableAutomationControl : public AutomationControl
                bool yn() const { return _yn; }
                void set_yn (bool yn) { _yn = yn; }
 
-               /* for non-boolean/non-toggled controls, we store a ratio that
-                * connects the value of the master with the value of this
-                * slave. See comments in the source for more details on how
-                * this is computed and used.
-                */
-
-               double ratio () const { return _ratio; }
-               void reset_ratio (double r) { _ratio = r; }
-
                PBD::ScopedConnection connection;
 
-         private:
+  private:
                boost::shared_ptr<AutomationControl> _master;
-               union {
-                       double _ratio;
-                       bool   _yn;
-               };
+               /* holds most recently seen master value for boolean/toggle controls */
+               bool   _yn;
        };
 
        mutable Glib::Threads::RWLock master_lock;
        typedef std::map<PBD::ID,MasterRecord> Masters;
        Masters _masters;
-       PBD::ScopedConnectionList masters_connections;
+       std::map<boost::weak_ptr<AutomationControl>, PBD::ScopedConnection> masters_connections;
 
        void   master_going_away (boost::weak_ptr<AutomationControl>);
        double get_value_locked() const;
-       void   actually_set_value (double val, PBD::Controllable::GroupControlDisposition group_override);
+       void   actually_set_value (double value, PBD::Controllable::GroupControlDisposition);
        void   update_boolean_masters_records (boost::shared_ptr<AutomationControl>);
-       int32_t   get_boolean_masters () const;
+
+       virtual bool handle_master_change (boost::shared_ptr<AutomationControl>);
+       virtual bool boolean_automation_run_locked (framepos_t start, pframes_t len);
+       bool boolean_automation_run (framepos_t start, pframes_t len);
 
        virtual void   master_changed (bool from_self, GroupControlDisposition gcd, boost::shared_ptr<AutomationControl>);
-       virtual void   recompute_masters_ratios (double val) { /* do nothing by default */}
        virtual double get_masters_value_locked () const;
        virtual void   pre_remove_master (boost::shared_ptr<AutomationControl>) {}
        virtual void   post_add_master (boost::shared_ptr<AutomationControl>) {}
 
-
+       XMLNode* _masters_node; /* used to store master ratios in ::set_state() for later use */
 };
 
 } // namespace ARDOUR