those who can't spell need to push thrice.

[ardour.git] / libs / evoral / evoral / Control.hpp

diff --git a/libs/evoral/evoral/Control.hpp b/libs/evoral/evoral/Control.hpp
index bcb9acb78a87cffbcb1829f70b388cdd8eef7585..490abf00b6f5341ae2e915043dac845177f00f1f 100644 (file)
--- a/libs/evoral/evoral/Control.hpp
+++ b/libs/evoral/evoral/Control.hpp
@@ -1,5 +1,5 @@
 /* This file is part of Evoral.
- * Copyright (C) 2008 Dave Robillard <http://drobilla.net>
+ * Copyright (C) 2008 David Robillard <http://drobilla.net>
  * Copyright (C) 2000-2008 Paul Davis
  *
  * Evoral is free software; you can redistribute it and/or modify it under the
@@ -23,23 +23,35 @@
 #include <map>
 #include <boost/shared_ptr.hpp>
 #include "pbd/signals.h"
-#include "evoral/types.hpp"
+
+#include "evoral/visibility.h"
 #include "evoral/Parameter.hpp"
+#include "evoral/ParameterDescriptor.hpp"
 
 namespace Evoral {
 
 class ControlList;
+class ParameterDescriptor;
 class Transport;
+class TypeMap;
 
-class Control
+/** Base class representing some kind of (automatable) control; a fader's gain,
+ *  for example, or a compressor plugin's threshold.
+ *
+ *  The class knows the Evoral::Parameter that it is controlling, and has
+ *  a list of values for automation.
+ */
+class LIBEVORAL_API Control
 {
 public:
-       Control(const Parameter& parameter, boost::shared_ptr<ControlList>);
-       virtual ~Control() {}
+       Control(const Parameter&               parameter,
+               const ParameterDescriptor&     desc,
+               boost::shared_ptr<ControlList> list);
 
-       virtual void   set_double(double val, bool to_list=false, double frame=0);
-       virtual double get_double(bool from_list=false, double frame=0) const;
+       virtual ~Control() {}
 
+       virtual void   set_double (double val, double frame=0, bool to_list=false);
+       virtual double get_double (bool from_list=false, double frame=0) const;
 
        /** Get the latest user-set value
         * (which may not equal get_value() when automation is playing back).
@@ -47,11 +59,10 @@ public:
         * Automation write/touch works by periodically sampling this value
         * and adding it to the ControlList.
         */
-        double user_double() const { return _user_value; }
+       double user_double() const { return _user_value; }
 
        void set_list(boost::shared_ptr<ControlList>);
 
-
        boost::shared_ptr<ControlList>       list()       { return _list; }
        boost::shared_ptr<const ControlList> list() const { return _list; }
 
@@ -63,7 +74,7 @@ public:
 protected:
        Parameter                      _parameter;
        boost::shared_ptr<ControlList> _list;
-        double                         _user_value;
+       double                         _user_value;
        PBD::ScopedConnection          _list_marked_dirty_connection;
 
 private: