libs/evoral/evoral/Control.hpp

   1 /* This file is part of Evoral.
   2  * Copyright (C) 2008 Dave 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 "evoral/types.hpp"
  26 #include "evoral/Parameter.hpp"
  27
  28 namespace Evoral {
  29
  30 class ControlList;
  31 class Transport;
  32
  33 class Control
  34 {
  35 public:
  36         Control(const Parameter& parameter, boost::shared_ptr<ControlList>);
  37         virtual ~Control() {}
  38
  39         virtual void  set_float(float val, bool to_list=false, FrameTime frame=0);
  40         virtual float get_float(bool from_list=false, FrameTime frame=0) const;
  41
  42
  43         /** Get the latest user-set value
  44          * (which may not equal get_value() when automation is playing back).
  45          *
  46          * Automation write/touch works by periodically sampling this value
  47          * and adding it to the ControlList.
  48          */
  49         float user_float() const { return _user_value; }
  50
  51         void set_list(boost::shared_ptr<ControlList>);
  52
  53         boost::shared_ptr<ControlList>       list()       { return _list; }
  54         boost::shared_ptr<const ControlList> list() const { return _list; }
  55
  56         inline const Parameter& parameter() const { return _parameter; }
  57
  58 protected:
  59         Parameter                      _parameter;
  60         boost::shared_ptr<ControlList> _list;
  61         float                          _user_value;
  62 };
  63
  64 } // namespace Evoral
  65
  66 #endif // EVORAL_CONTROL_HPP