add implicit mute state to MuteMaster and use when a master of a mute control is...
[ardour.git] / libs / ardour / ardour / automation_control.h
index aeee9dab30cdcf9be4ef88bafdd843fdf873767a..455e8891c108fc187c3f7b6ba021de4bc72e5ef7 100644 (file)
 #ifndef __ardour_automation_control_h__
 #define __ardour_automation_control_h__
 
+#include <map>
+
+#include <glibmm/threads.h>
+
 #include <boost/shared_ptr.hpp>
 #include <boost/enable_shared_from_this.hpp>
 
 #include "pbd/controllable.h"
+
+#include "evoral/types.hpp"
 #include "evoral/Control.hpp"
 
 #include "ardour/libardour_visibility.h"
 #include "ardour/automation_list.h"
+#include "ardour/parameter_descriptor.h"
 
 namespace ARDOUR {
 
@@ -38,15 +45,19 @@ class Automatable;
 
 /** A PBD::Controllable with associated automation data (AutomationList)
  */
-class LIBARDOUR_API AutomationControl : public PBD::Controllable, public Evoral::Control, public boost::enable_shared_from_this<AutomationControl>
+class LIBARDOUR_API AutomationControl
+       : public PBD::Controllable
+       , public Evoral::Control
+       , public boost::enable_shared_from_this<AutomationControl>
 {
 public:
        AutomationControl(ARDOUR::Session&,
-                         const Evoral::Parameter& parameter,
-                         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="");
 
-        ~AutomationControl ();
+       ~AutomationControl ();
 
        boost::shared_ptr<AutomationList> alist() const {
                return boost::dynamic_pointer_cast<AutomationList>(_list);
@@ -55,51 +66,101 @@ public:
        void set_list (boost::shared_ptr<Evoral::ControlList>);
 
        inline bool automation_playback() const {
-               return alist()->automation_playback();
+               return alist() ? alist()->automation_playback() : false;
        }
 
        inline bool automation_write() const {
-               return alist()->automation_write();
+               return alist() ? alist()->automation_write() : false;
        }
 
        inline AutoState automation_state() const {
-               return alist()->automation_state();
+               return alist() ? alist()->automation_state() : Off;
        }
 
        inline AutoStyle automation_style() const {
-               return alist()->automation_style();
+               return alist() ? alist()->automation_style() : Absolute;
        }
 
-        void set_automation_state(AutoState as);
-        void set_automation_style(AutoStyle as);
-        void start_touch (double when);
-        void stop_touch (bool mark, double when);
+       void set_automation_state(AutoState as);
+       void set_automation_style(AutoStyle as);
+       void start_touch(double when);
+       void stop_touch(bool mark, double when);
 
-       void set_value (double);
+       /* inherited from PBD::Controllable.
+        * Derived classes MUST call ::writable() to verify
+        * that writing to the parameter is legal at that time.
+        */
        double get_value () const;
+       /* inherited from PBD::Controllable.
+        * Derived classes MUST call ::writable() to verify
+        * that writing to the parameter is legal at that time.
+        */
+       void set_value (double value, PBD::Controllable::GroupControlDisposition group_override);
+       /* automation related value setting */
+       virtual bool writable () const;
+       /* Call to ::set_value() with no test for writable() because
+        * this is only used by automation playback. We would like
+        * to make it pure virtual
+        */
+       virtual void set_value_unchecked (double val) {}
+
+       double lower()   const { return _desc.lower; }
+       double upper()   const { return _desc.upper; }
+       double normal()  const { return _desc.normal; }
+       bool   toggled() const { return _desc.toggled; }
+
+       double internal_to_interface (double i) const;
+       double interface_to_internal (double i) const;
+
+       const ParameterDescriptor& desc() const { return _desc; }
 
-       virtual double internal_to_interface (double v) const {
-               return v;
-       }
-       
-       virtual double interface_to_internal (double v) const {
-               return v;
-       }
+       const ARDOUR::Session& session() const { return _session; }
+       void commit_transaction (bool did_write);
 
-       virtual double internal_to_user (double v) const {
-               return v;
-       }
+       void add_master (boost::shared_ptr<AutomationControl>);
+       void remove_master (boost::shared_ptr<AutomationControl>);
+       void clear_masters ();
+       bool slaved_to (boost::shared_ptr<AutomationControl>) const;
+       bool slaved () const;
+       std::vector<PBD::ID> masters () const;
 
-       double lower() const { return parameter().min(); }
-       double upper() const { return parameter().max(); }
-       double normal() const { return parameter().normal(); }
-       bool toggled() const { return parameter().toggled(); }
+       PBD::Signal0<void> MasterStatusChange;
 
-       const ARDOUR::Session& session() const { return _session; }
+  protected:
+       ARDOUR::Session& _session;
 
-protected:
+       const ParameterDescriptor _desc;
 
-       ARDOUR::Session& _session;
+
+       class MasterRecord {
+          public:
+               MasterRecord (boost::shared_ptr<AutomationControl> gc, double r)
+                       : _master (gc)
+                       , _ratio (r)
+               {}
+
+               boost::shared_ptr<AutomationControl> master() const { return _master; }
+               double ratio () const { return _ratio; }
+               void reset_ratio (double r) { _ratio = r; }
+
+               PBD::ScopedConnection connection;
+
+         private:
+               boost::shared_ptr<AutomationControl> _master;
+               double _ratio;
+
+       };
+
+       mutable Glib::Threads::RWLock master_lock;
+       typedef std::map<PBD::ID,MasterRecord> Masters;
+       Masters _masters;
+       PBD::ScopedConnectionList masters_connections;
+
+       virtual void master_changed (bool from_self, GroupControlDisposition gcd);
+       void master_going_away (boost::weak_ptr<AutomationControl>);
+       virtual void recompute_masters_ratios (double val) { /* do nothing by default */}
+       virtual double get_masters_value_locked () const;
+       double get_value_locked() const;
 };