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
|
/*
* Copyright (C) 2014-2017 Robin Gareus <robin@gareus.org>
* Copyright (C) 2014 David Robillard <d@drobilla.net>
*
* 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.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef __ardour_parameter_descriptor_h__
#define __ardour_parameter_descriptor_h__
#include "pbd/natsort.h"
#include "ardour/types.h"
#include "ardour/variant.h"
#include "evoral/Parameter.h"
#include "evoral/ParameterDescriptor.h"
namespace ARDOUR {
struct CompareNumericallyLess {
bool operator() (std::string const& a, std::string const& b) const {
return PBD::numerically_less (a.c_str(), b.c_str());
}
};
typedef std::map<const std::string, const float, CompareNumericallyLess> ScalePoints;
/** Descriptor of a parameter or control.
*
* Essentially a union of LADSPA, VST and LV2 info.
*/
struct LIBARDOUR_API ParameterDescriptor : public Evoral::ParameterDescriptor
{
enum Unit {
NONE, ///< No unit
DB, ///< Decibels
MIDI_NOTE, ///< MIDI note number
HZ, ///< Frequency in Hertz
};
static std::string midi_note_name (uint8_t, bool translate=true);
/** Dual of midi_note_name, convert a note name into its midi note number. */
typedef std::map<std::string, uint8_t> NameNumMap;
static std::string normalize_note_name(const std::string& name);
static NameNumMap build_midi_name2num();
static uint8_t midi_note_num (const std::string& name);
ParameterDescriptor(const Evoral::Parameter& parameter);
ParameterDescriptor();
/** control-value to normalized [0..1] range
*
* Convert given AutomationType from lower/upper range to [0..1]
* interface value, using settings from Evoral::ParameterDescriptor.
*
* default for AutomationControl::internal_to_interface ();
*
* @param v the control-value to convert
* @param rotary set to true if the GUI control is a rotary knob
* @return interface value in range 0..1
*/
float to_interface (float v, bool rotary = false) const;
/** normalized [0..1] to control-value range
*
* Convert [0..1] to the control's range of this AutomationType
* using settings from Evoral::ParameterDescriptor.
*
* default for AutomationControl::interface_to_internal ();
*
* @param v the value in range 0..1 to on convert
* @param rotary set to true if the GUI control is a rotary knob
* @return control-value in range lower..upper
*/
float from_interface (float v, bool rotary = false) const;
bool is_linear () const;
float compute_delta (float from, float to) const;
float apply_delta (float value, float delta) const;
/* find the closest scale-point, return the internal value of
* the prev/next scale-point (no wrap-around)
*
* If the given parameter is not en enum, the given val is returned.
*
* @param val internal (not interface) value
* @param prev if true, step to prev scale-point, otherwise next
* @return internal value, suitable for set_value()
*/
float step_enum (float val, bool prev) const;
/** Set step, smallstep, and largestep, based on current description. */
void update_steps();
std::string label;
std::string print_fmt; ///< format string for pretty printing
boost::shared_ptr<ScalePoints> scale_points;
uint32_t key; ///< for properties
Variant::Type datatype; ///< for properties
AutomationType type;
Unit unit;
float step;
float smallstep;
float largestep;
bool integer_step;
bool sr_dependent;
bool enumeration;
bool inline_ctrl;
};
} // namespace ARDOUR
#endif // __ardour_parameter_descriptor_h__
|
