/
foleys_ParameterAttachment.h
203 lines (166 loc) · 6.17 KB
/
foleys_ParameterAttachment.h
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
/*
==============================================================================
Copyright (c) 2019-2022 Foleys Finest Audio - Daniel Walz
All rights reserved.
License for non-commercial projects:
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.
License for commercial products:
To sell commercial products containing this module, you are required to buy a
License from https://foleysfinest.com/developer/pluginguimagic/
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
OF THE POSSIBILITY OF SUCH DAMAGE.
==============================================================================
*/
#pragma once
#include <juce_audio_processors/juce_audio_processors.h>
namespace foleys
{
/**
The ParameterAttachment is a class you can use to have a value synchronised with
an AudioProcessorParameter. It takes care of updating either way, keeps the value
thread safe in an atomic and allows setting lambdas to be executed when the value
changes.
*/
template<typename ValueType>
class ParameterAttachment : private juce::AudioProcessorParameter::Listener,
private juce::AsyncUpdater
{
public:
ParameterAttachment()
{
}
virtual ~ParameterAttachment() override
{
detachFromParameter();
}
/**
Thread safe way to read the current value.
*/
ValueType getValue() const
{
return value.load();
}
/**
Thread safe way to read the normalised value of the current value.
*/
ValueType getNormalisedValue() const
{
if (parameter)
return parameter->getNormalisableRange().convertTo0to1 (value.load());
return value.load();
}
/**
Set the value from a not normalised range.min..range.max value.
*/
void setValue (ValueType newValue)
{
if (parameter)
parameter->setValueNotifyingHost (parameter->getNormalisableRange().convertTo0to1 (newValue));
else
parameterValueChanged (0, juce::jlimit (0.0f, 1.0f, newValue));
}
/**
Set the value from a normalised 0..1 value.
*/
void setNormalisedValue (ValueType newValue)
{
if (parameter)
parameter->setValueNotifyingHost (newValue);
else
parameterValueChanged (0, juce::jlimit (0.0f, 1.0f, newValue));
}
/**
Make this value attached to the parameter with the supplied parameterID.
*/
void attachToParameter (juce::RangedAudioParameter* parameterToUse)
{
detachFromParameter();
if (parameterToUse)
{
parameter = parameterToUse;
initialUpdate();
parameter->addListener (this);
}
}
void detachFromParameter()
{
if (parameter)
parameter->removeListener (this);
}
/**
Make sure to call this before you send changes (e.g. from mouseDown of your UI widget),
otherwise the hosts automation will battle with your value changes.
*/
void beginGesture()
{
if (parameter)
parameter->beginChangeGesture();
}
/**
Make sure to call this after finishing your changes (e.g. from mouseDown of your UI widget),
this way the automation can take back control (like e.g. latch mode).
*/
void endGesture()
{
if (parameter)
parameter->endChangeGesture();
}
void parameterValueChanged (int parameterIndex, float newValue) override
{
juce::ignoreUnused (parameterIndex);
if (parameter)
value.store (ValueType (parameter->convertFrom0to1 (newValue)));
else
value.store (ValueType (newValue));
if (onParameterChanged)
onParameterChanged();
if (onParameterChangedAsync)
triggerAsyncUpdate();
}
void parameterGestureChanged (int parameterIndex, bool gestureIsStarting) override
{ juce::ignoreUnused (parameterIndex); juce::ignoreUnused (gestureIsStarting); }
void handleAsyncUpdate() override
{
if (onParameterChangedAsync)
onParameterChangedAsync();
}
/**
Set this lambda to be called from whatever thread is updating the parameter
*/
std::function<void()> onParameterChanged;
/**
Set this lambda to be called from the message thread via AsyncUpdater
*/
std::function<void()> onParameterChangedAsync;
private:
void initialUpdate()
{
if (parameter)
value.store (ValueType (parameter->convertFrom0to1 (parameter->getValue())));
else
value.store (ValueType());
if (onParameterChanged)
onParameterChanged();
}
juce::RangedAudioParameter* parameter = nullptr;
std::atomic<ValueType> value { ValueType() };
JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ParameterAttachment)
};
} // namespace foleys