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