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/types.hpp"
  29 #include "evoral/Parameter.hpp"
  30
  31 namespace Evoral {
  32
  33 class ControlList;
  34 class Transport;
  35
  36 /** Base class representing some kind of (automatable) control; a fader's gain,
  37  *  for example, or a compressor plugin's threshold.
  38  *
  39  *  The class knows the Evoral::Parameter that it is controlling, and has
  40  *  a list of values for automation.
  41  */
  42
  43 class LIBEVORAL_API Control
  44 {
  45 public:
  46         Control(const Parameter& parameter, boost::shared_ptr<ControlList>);
  47         virtual ~Control() {}
  48
  49         virtual void   set_double (double val, double frame=0, bool to_list=false);
  50         virtual double get_double (bool from_list=false, double frame=0) const;
  51
  52         /** Get the latest user-set value
  53          * (which may not equal get_value() when automation is playing back).
  54          *
  55          * Automation write/touch works by periodically sampling this value
  56          * and adding it to the ControlList.
  57          */
  58         double user_double() const { return _user_value; }
  59
  60         void set_list(boost::shared_ptr<ControlList>);
  61
  62         boost::shared_ptr<ControlList>       list()       { return _list; }
  63         boost::shared_ptr<const ControlList> list() const { return _list; }
  64
  65         inline const Parameter& parameter() const { return _parameter; }
  66
  67         /** Emitted when the our ControlList is marked dirty */
  68         PBD::Signal0<void> ListMarkedDirty;
  69
  70 protected:
  71         Parameter                      _parameter;
  72         boost::shared_ptr<ControlList> _list;
  73         double                         _user_value;
  74         PBD::ScopedConnection          _list_marked_dirty_connection;
  75
  76 private:
  77         void list_marked_dirty ();
  78 };
  79
  80 } // namespace Evoral
  81
  82 #endif // EVORAL_CONTROL_HPP