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 74b8a54aada8147bd84f4c6d82696936957c10c6..455e8891c108fc187c3f7b6ba021de4bc72e5ef7 100644 (file)
@@ -1,6 +1,6 @@
 /*
     Copyright (C) 2007 Paul Davis
-    Author: Dave Robillard
+    Author: David Robillard
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 #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 {
 
@@ -34,57 +45,122 @@ class Automatable;
 
 /** A PBD::Controllable with associated automation data (AutomationList)
  */
-class AutomationControl : public PBD::Controllable, public Evoral::Control
+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 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 ();
+
        boost::shared_ptr<AutomationList> alist() const {
                return boost::dynamic_pointer_cast<AutomationList>(_list);
        }
 
-       void set_list(boost::shared_ptr<Evoral::ControlList>);
+       void set_list (boost::shared_ptr<Evoral::ControlList>);
 
        inline bool automation_playback() const {
-               return ((ARDOUR::AutomationList*)_list.get())->automation_playback();
+               return alist() ? alist()->automation_playback() : false;
        }
-       
+
        inline bool automation_write() const {
-               return ((ARDOUR::AutomationList*)_list.get())->automation_write();
+               return alist() ? alist()->automation_write() : false;
        }
-       
+
        inline AutoState automation_state() const {
-               return ((ARDOUR::AutomationList*)_list.get())->automation_state();
-       }
-       
-       inline void set_automation_state(AutoState as) {
-               return ((ARDOUR::AutomationList*)_list.get())->set_automation_state(as);
+               return alist() ? alist()->automation_state() : Off;
        }
-       
-       inline void start_touch() {
-               set_touching (true);
-               return ((ARDOUR::AutomationList*)_list.get())->start_touch();
-       }
-       
-       inline void stop_touch() {
-               set_touching (false);
-               return ((ARDOUR::AutomationList*)_list.get())->stop_touch();
+
+       inline AutoStyle automation_style() const {
+               return alist() ? alist()->automation_style() : Absolute;
        }
 
-       /** Set the value and do the right thing based on automation state
-        * (e.g. record if necessary, etc.)
-        */
-       void set_value(float val);
+       void set_automation_state(AutoState as);
+       void set_automation_style(AutoStyle as);
+       void start_touch(double when);
+       void stop_touch(bool mark, double when);
 
-       /** Get the current effective value based on automation state.
+       /* 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
         */
-       float get_value() const;
+       virtual void set_value_unchecked (double val) {}
 
-protected:
+       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; }
+
+       const ARDOUR::Session& session() const { return _session; }
+       void commit_transaction (bool did_write);
+
+       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;
+
+       PBD::Signal0<void> MasterStatusChange;
+
+  protected:
        ARDOUR::Session& _session;
+
+       const ParameterDescriptor _desc;
+
+
+       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;
 };