2 Copyright (C) 2000-2007 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #ifndef __pbd_controllable_h__
21 #define __pbd_controllable_h__
27 #include "pbd/libpbd_visibility.h"
28 #include "pbd/signals.h"
29 #include <glibmm/threads.h>
31 #include "pbd/statefuldestructible.h"
37 class LIBPBD_API Controllable : public PBD::StatefulDestructible {
44 Controllable (const std::string& name, Flag f = Flag (0));
45 virtual ~Controllable() { Destroyed (this); }
47 /* We express Controllable values in one of three ways:
48 * 1. `user' --- as presented to the user (e.g. dB, Hz, etc.)
49 * 2. `interface' --- as used in some cases for the UI representation
50 * (in order to make controls behave logarithmically).
51 * 3. `internal' --- as passed to a processor, track, plugin, or whatever.
53 * Note that in some cases user and processor may be the same
54 * (and interface different) e.g. frequency, which is presented
55 * to the user and passed to the processor in linear terms, but
56 * which needs log scaling in the interface.
58 * In other cases, user and interface may be the same (and processor different)
59 * e.g. gain, which is presented to the user in log terms (dB)
60 * but passed to the processor as a linear quantity.
63 /** Set `internal' value */
64 virtual void set_value (double) = 0;
65 /** @return `internal' value */
66 virtual double get_value (void) const = 0;
68 PBD::Signal0<void> LearningFinished;
69 static PBD::Signal3<void,PBD::Controllable*,int,int> CreateBinding;
70 static PBD::Signal1<void,PBD::Controllable*> DeleteBinding;
72 static PBD::Signal1<bool,PBD::Controllable*> StartLearning;
73 static PBD::Signal1<void,PBD::Controllable*> StopLearning;
75 static PBD::Signal1<void,Controllable*> Destroyed;
77 PBD::Signal0<void> Changed;
79 int set_state (const XMLNode&, int version);
80 XMLNode& get_state ();
82 std::string name() const { return _name; }
84 bool touching () const { return _touching; }
85 void set_touching (bool yn) { _touching = yn; }
87 bool is_toggle() const { return _flags & Toggle; }
88 bool is_gain_like() const { return _flags & GainLike; }
90 virtual double lower() const { return 0.0; }
91 virtual double upper() const { return 1.0; }
93 Flag flags() const { return _flags; }
94 void set_flags (Flag f);
96 static Controllable* by_id (const PBD::ID&);
97 static Controllable* by_name (const std::string&);
98 static const std::string xml_node_name;
105 static void add (Controllable&);
106 static void remove (Controllable*);
108 typedef std::set<PBD::Controllable*> Controllables;
109 static Glib::Threads::RWLock registry_lock;
110 static Controllables registry;
113 /* a utility class for the occasions when you need but do not have
117 class LIBPBD_API IgnorableControllable : public Controllable
120 IgnorableControllable () : PBD::Controllable ("ignoreMe") {}
121 ~IgnorableControllable () {}
123 void set_value (double /*v*/) {}
124 double get_value () const { return 0.0; }
129 #endif /* __pbd_controllable_h__ */