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
|
/* This file is part of Evoral.
* Copyright (C) 2008 David Robillard <http://drobilla.net>
* Copyright (C) 2000-2008 Paul Davis
*
* Evoral 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.
*
* Evoral 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 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.,
* 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef EVORAL_PARAMETER_HPP
#define EVORAL_PARAMETER_HPP
#include <string>
#include <map>
#include <stdint.h>
#include <boost/shared_ptr.hpp>
#include "evoral/visibility.h"
#include "evoral/types.hpp"
namespace Evoral {
/** ID of a [play|record|automate]able parameter.
*
* A parameter is defined by (type, id, channel). Type is an integer which
* can be used in any way by the application (e.g. cast to a custom enum,
* map to/from a URI, etc). ID is type specific (e.g. MIDI controller #).
*
* This class defines a < operator which is a strict weak ordering, so
* Parameter may be stored in a std::set, used as a std::map key, etc.
*/
class LIBEVORAL_API Parameter
{
public:
inline Parameter(ParameterType type, uint8_t channel=0, uint32_t id=0)
: _type(type), _id(id), _channel(channel)
{}
inline ParameterType type() const { return _type; }
inline uint8_t channel() const { return _channel; }
inline uint32_t id() const { return _id; }
/** Equivalence operator
* It is obvious from the definition that this operator
* is transitive, as required by stict weak ordering
* (see: http://www.sgi.com/tech/stl/StrictWeakOrdering.html)
*/
inline bool operator==(const Parameter& id) const {
return (_type == id._type && _channel == id._channel && _id == id._id );
}
inline bool operator!=(const Parameter& id) const {
return !operator==(id);
}
/** Strict weak ordering
* See: http://www.sgi.com/tech/stl/StrictWeakOrdering.html
* Sort Parameters first according to type then to channel and lastly to ID.
*/
inline bool operator<(const Parameter& other) const {
if (_type < other._type) {
return true;
} else if (_type == other._type && _channel < other._channel) {
return true;
} else if (_type == other._type && _channel == other._channel && _id < other._id ) {
return true;
}
return false;
}
inline operator bool() const { return (_type != 0); }
private:
ParameterType _type;
uint32_t _id;
uint8_t _channel;
};
} // namespace Evoral
#endif // EVORAL_PARAMETER_HPP
|
