1 /* This file is part of Evoral.
2 * Copyright (C) 2008 David Robillard <http://drobilla.net>
3 * Copyright (C) 2000-2008 Paul Davis
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
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.
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
19 #ifndef EVORAL_CONTROL_HPP
20 #define EVORAL_CONTROL_HPP
24 #include <boost/shared_ptr.hpp>
25 #include "pbd/signals.h"
27 #include "evoral/visibility.h"
28 #include "evoral/Parameter.hpp"
29 #include "evoral/ParameterDescriptor.hpp"
34 class ParameterDescriptor;
38 /** Base class representing some kind of (automatable) control; a fader's gain,
39 * for example, or a compressor plugin's threshold.
41 * The class knows the Evoral::Parameter that it is controlling, and has
42 * a list of values for automation.
44 class LIBEVORAL_API Control
47 Control(const Parameter& parameter,
48 const ParameterDescriptor& desc,
49 boost::shared_ptr<ControlList> list);
53 virtual void set_double (double val, double frame=0, bool to_list=false);
54 virtual double get_double (bool from_list=false, double frame=0) const;
56 /** Get the latest user-set value
57 * (which may not equal get_value() when automation is playing back).
59 * Automation write/touch works by periodically sampling this value
60 * and adding it to the ControlList.
62 double user_double() const { return _user_value; }
64 void set_list(boost::shared_ptr<ControlList>);
66 boost::shared_ptr<ControlList> list() { return _list; }
67 boost::shared_ptr<const ControlList> list() const { return _list; }
69 inline const Parameter& parameter() const { return _parameter; }
71 /** Emitted when the our ControlList is marked dirty */
72 PBD::Signal0<void> ListMarkedDirty;
76 boost::shared_ptr<ControlList> _list;
78 PBD::ScopedConnection _list_marked_dirty_connection;
81 void list_marked_dirty ();
86 #endif // EVORAL_CONTROL_HPP