proper display name for Monitor Processor
[ardour.git] / libs / ardour / ardour / automation_control.h
index 2d22b9e661255d53a923b24fcc3223581fc3b636..b26d781e2fd98b739895d750d48deeeebba2db04 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
 #define __ardour_automation_control_h__
 
 #include <boost/shared_ptr.hpp>
+#include <boost/enable_shared_from_this.hpp>
+
+#include "evoral/types.hpp"
 #include "pbd/controllable.h"
 #include "evoral/Control.hpp"
+
+#include "ardour/libardour_visibility.h"
 #include "ardour/automation_list.h"
+#include "ardour/parameter_descriptor.h"
 
 namespace ARDOUR {
 
@@ -34,60 +40,80 @@ 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 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 ();
 
        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();
+               return alist() ? alist()->automation_state() : Off;
        }
 
-       inline void set_automation_state(AutoState as) {
-               return ((ARDOUR::AutomationList*)_list.get())->set_automation_state(as);
+       inline AutoStyle automation_style() const {
+               return alist() ? alist()->automation_style() : Absolute;
        }
 
-       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();
-       }
+       void set_automation_state(AutoState as);
+       void set_automation_style(AutoStyle as);
+       void start_touch(double when);
+       void stop_touch(bool mark, double when);
 
-       /** Set the value and do the right thing based on automation state
-        * (e.g. record if necessary, etc.)
+       /* 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 val);
-
-       /** Get the current effective value based on automation state.
+       void set_value (double);
+       double get_value () const;
+
+       /* 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 
         */
-       double get_value() const;
+       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;
 
-        double lower() const { return parameter().min(); }
-        double upper() const { return parameter().max(); }
+       const ParameterDescriptor& desc() const { return _desc; }
+
+       const ARDOUR::Session& session() const { return _session; }
+       void commit_transaction (bool did_write);
 
 protected:
+
        ARDOUR::Session& _session;
+
+       const ParameterDescriptor _desc;
 };