libs/evoral/evoral/Control.hpp

   1 /* This file is part of Evoral.
   2  * Copyright (C) 2008 David Robillard <http://drobilla.net>
   3  * Copyright (C) 2000-2008 Paul Davis
   4  *
   5  * Evoral is free software; you can redistribute it and/or modify it under the
   6  * terms of the GNU General Public License as published by the Free Software
   7  * Foundation; either version 2 of the License, or (at your option) any later
   8  * version.
   9  *
  10  * Evoral is distributed in the hope that it will be useful, but WITHOUT ANY
  11  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  12  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  17  */
  18
  19 #ifndef EVORAL_CONTROL_HPP
  20 #define EVORAL_CONTROL_HPP
  21
  22 #include <set>
  23 #include <map>
  24 #include <boost/shared_ptr.hpp>
  25 #include "pbd/signals.h"
  26
  27 #include "evoral/visibility.h"
  28 #include "evoral/Parameter.hpp"
  29
  30 namespace Evoral {
  31
  32 class ControlList;
  33 class Transport;
  34
  35 /** Base class representing some kind of (automatable) control; a fader's gain,
  36  *  for example, or a compressor plugin's threshold.
  37  *
  38  *  The class knows the Evoral::Parameter that it is controlling, and has
  39  *  a list of values for automation.
  40  */
  41
  42 class LIBEVORAL_API Control
  43 {
  44 public:
  45         Control(const Parameter& parameter, boost::shared_ptr<ControlList>);
  46         virtual ~Control() {}
  47
  48         virtual void   set_double (double val, double frame=0, bool to_list=false);
  49         virtual double get_double (bool from_list=false, double frame=0) const;
  50
  51         /** Get the latest user-set value
  52          * (which may not equal get_value() when automation is playing back).
  53          *
  54          * Automation write/touch works by periodically sampling this value
  55          * and adding it to the ControlList.
  56          */
  57         double user_double() const { return _user_value; }
  58
  59         void set_list(boost::shared_ptr<ControlList>);
  60
  61         boost::shared_ptr<ControlList>       list()       { return _list; }
  62         boost::shared_ptr<const ControlList> list() const { return _list; }
  63
  64         inline const Parameter& parameter() const { return _parameter; }
  65
  66         /** Emitted when the our ControlList is marked dirty */
  67         PBD::Signal0<void> ListMarkedDirty;
  68
  69 protected:
  70         Parameter                      _parameter;
  71         boost::shared_ptr<ControlList> _list;
  72         double                         _user_value;
  73         PBD::ScopedConnection          _list_marked_dirty_connection;
  74
  75 private:
  76         void list_marked_dirty ();
  77 };
  78
  79 } // namespace Evoral
  80
  81 #endif // EVORAL_CONTROL_HPP