aboutsummaryrefslogtreecommitdiffstats
path: root/al/effects/echo.cpp
blob: 98fa55411588dc917f3654fb4680dd1b2be650cf (plain)
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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302

#include "config.h"

#include "AL/al.h"
#include "AL/efx.h"

#include "alc/effects/base.h"
#include "effects.h"

#ifdef ALSOFT_EAX
#include "alnumeric.h"
#include "al/eax/exception.h"
#include "al/eax/utils.h"
#endif // ALSOFT_EAX


namespace {

static_assert(EchoMaxDelay >= AL_ECHO_MAX_DELAY, "Echo max delay too short");
static_assert(EchoMaxLRDelay >= AL_ECHO_MAX_LRDELAY, "Echo max left-right delay too short");

void Echo_setParami(EffectProps*, ALenum param, int)
{ throw effect_exception{AL_INVALID_ENUM, "Invalid echo integer property 0x%04x", param}; }
void Echo_setParamiv(EffectProps*, ALenum param, const int*)
{ throw effect_exception{AL_INVALID_ENUM, "Invalid echo integer-vector property 0x%04x", param}; }
void Echo_setParamf(EffectProps *props, ALenum param, float val)
{
    switch(param)
    {
    case AL_ECHO_DELAY:
        if(!(val >= AL_ECHO_MIN_DELAY && val <= AL_ECHO_MAX_DELAY))
            throw effect_exception{AL_INVALID_VALUE, "Echo delay out of range"};
        props->Echo.Delay = val;
        break;

    case AL_ECHO_LRDELAY:
        if(!(val >= AL_ECHO_MIN_LRDELAY && val <= AL_ECHO_MAX_LRDELAY))
            throw effect_exception{AL_INVALID_VALUE, "Echo LR delay out of range"};
        props->Echo.LRDelay = val;
        break;

    case AL_ECHO_DAMPING:
        if(!(val >= AL_ECHO_MIN_DAMPING && val <= AL_ECHO_MAX_DAMPING))
            throw effect_exception{AL_INVALID_VALUE, "Echo damping out of range"};
        props->Echo.Damping = val;
        break;

    case AL_ECHO_FEEDBACK:
        if(!(val >= AL_ECHO_MIN_FEEDBACK && val <= AL_ECHO_MAX_FEEDBACK))
            throw effect_exception{AL_INVALID_VALUE, "Echo feedback out of range"};
        props->Echo.Feedback = val;
        break;

    case AL_ECHO_SPREAD:
        if(!(val >= AL_ECHO_MIN_SPREAD && val <= AL_ECHO_MAX_SPREAD))
            throw effect_exception{AL_INVALID_VALUE, "Echo spread out of range"};
        props->Echo.Spread = val;
        break;

    default:
        throw effect_exception{AL_INVALID_ENUM, "Invalid echo float property 0x%04x", param};
    }
}
void Echo_setParamfv(EffectProps *props, ALenum param, const float *vals)
{ Echo_setParamf(props, param, vals[0]); }

void Echo_getParami(const EffectProps*, ALenum param, int*)
{ throw effect_exception{AL_INVALID_ENUM, "Invalid echo integer property 0x%04x", param}; }
void Echo_getParamiv(const EffectProps*, ALenum param, int*)
{ throw effect_exception{AL_INVALID_ENUM, "Invalid echo integer-vector property 0x%04x", param}; }
void Echo_getParamf(const EffectProps *props, ALenum param, float *val)
{
    switch(param)
    {
    case AL_ECHO_DELAY:
        *val = props->Echo.Delay;
        break;

    case AL_ECHO_LRDELAY:
        *val = props->Echo.LRDelay;
        break;

    case AL_ECHO_DAMPING:
        *val = props->Echo.Damping;
        break;

    case AL_ECHO_FEEDBACK:
        *val = props->Echo.Feedback;
        break;

    case AL_ECHO_SPREAD:
        *val = props->Echo.Spread;
        break;

    default:
        throw effect_exception{AL_INVALID_ENUM, "Invalid echo float property 0x%04x", param};
    }
}
void Echo_getParamfv(const EffectProps *props, ALenum param, float *vals)
{ Echo_getParamf(props, param, vals); }

EffectProps genDefaultProps() noexcept
{
    EffectProps props{};
    props.Echo.Delay    = AL_ECHO_DEFAULT_DELAY;
    props.Echo.LRDelay  = AL_ECHO_DEFAULT_LRDELAY;
    props.Echo.Damping  = AL_ECHO_DEFAULT_DAMPING;
    props.Echo.Feedback = AL_ECHO_DEFAULT_FEEDBACK;
    props.Echo.Spread   = AL_ECHO_DEFAULT_SPREAD;
    return props;
}

} // namespace

DEFINE_ALEFFECT_VTABLE(Echo);

const EffectProps EchoEffectProps{genDefaultProps()};

#ifdef ALSOFT_EAX
namespace {

using EchoCommitter = EaxCommitter<EaxEchoCommitter>;

struct DelayValidator {
    void operator()(float flDelay) const
    {
        eax_validate_range<EchoCommitter::Exception>(
            "Delay",
            flDelay,
            EAXECHO_MINDELAY,
            EAXECHO_MAXDELAY);
    }
}; // DelayValidator

struct LrDelayValidator {
    void operator()(float flLRDelay) const
    {
        eax_validate_range<EchoCommitter::Exception>(
            "LR Delay",
            flLRDelay,
            EAXECHO_MINLRDELAY,
            EAXECHO_MAXLRDELAY);
    }
}; // LrDelayValidator

struct DampingValidator {
    void operator()(float flDamping) const
    {
        eax_validate_range<EchoCommitter::Exception>(
            "Damping",
            flDamping,
            EAXECHO_MINDAMPING,
            EAXECHO_MAXDAMPING);
    }
}; // DampingValidator

struct FeedbackValidator {
    void operator()(float flFeedback) const
    {
        eax_validate_range<EchoCommitter::Exception>(
            "Feedback",
            flFeedback,
            EAXECHO_MINFEEDBACK,
            EAXECHO_MAXFEEDBACK);
    }
}; // FeedbackValidator

struct SpreadValidator {
    void operator()(float flSpread) const
    {
        eax_validate_range<EchoCommitter::Exception>(
            "Spread",
            flSpread,
            EAXECHO_MINSPREAD,
            EAXECHO_MAXSPREAD);
    }
}; // SpreadValidator

struct AllValidator {
    void operator()(const EAXECHOPROPERTIES& all) const
    {
        DelayValidator{}(all.flDelay);
        LrDelayValidator{}(all.flLRDelay);
        DampingValidator{}(all.flDamping);
        FeedbackValidator{}(all.flFeedback);
        SpreadValidator{}(all.flSpread);
    }
}; // AllValidator

} // namespace

template<>
struct EchoCommitter::Exception : public EaxException {
    explicit Exception(const char* message) : EaxException{"EAX_ECHO_EFFECT", message}
    { }
};

template<>
[[noreturn]] void EchoCommitter::fail(const char *message)
{
    throw Exception{message};
}

template<>
bool EchoCommitter::commit(const EaxEffectProps &props)
{
    const auto orig = props_;
    props_ = props;

    auto is_dirty = bool{orig.mType != props_.mType};
    if(props_.mEcho.flDelay != props.mEcho.flDelay)
    {
        is_dirty = true;
        al_effect_props_.Echo.Delay = clamp(
            props_.mEcho.flDelay,
            AL_ECHO_MIN_DELAY,
            AL_ECHO_MAX_DELAY);
    }

    if(props_.mEcho.flLRDelay != props.mEcho.flLRDelay)
    {
        is_dirty = true;
        al_effect_props_.Echo.LRDelay = clamp(
            props_.mEcho.flLRDelay,
            AL_ECHO_MIN_LRDELAY,
            AL_ECHO_MAX_LRDELAY);
    }

    if(props_.mEcho.flDamping != props.mEcho.flDamping)
    {
        is_dirty = true;
        al_effect_props_.Echo.Damping = clamp(
            props_.mEcho.flDamping,
            AL_ECHO_MIN_DAMPING,
            AL_ECHO_MAX_DAMPING);
    }

    if(props_.mEcho.flFeedback != props.mEcho.flFeedback)
    {
        is_dirty = true;
        al_effect_props_.Echo.Feedback = clamp(
            props_.mEcho.flFeedback,
            AL_ECHO_MIN_FEEDBACK,
            AL_ECHO_MAX_FEEDBACK);
    }

    if(props_.mEcho.flSpread != props.mEcho.flSpread)
    {
        is_dirty = true;
        al_effect_props_.Echo.Spread = clamp(
            props_.mEcho.flSpread,
            AL_ECHO_MIN_SPREAD,
            AL_ECHO_MAX_SPREAD);
    }

    return is_dirty;
}

template<>
void EchoCommitter::SetDefaults(EaxEffectProps &props)
{
    props.mType = EaxEffectType::Echo;
    props.mEcho.flDelay = EAXECHO_DEFAULTDELAY;
    props.mEcho.flLRDelay = EAXECHO_DEFAULTLRDELAY;
    props.mEcho.flDamping = EAXECHO_DEFAULTDAMPING;
    props.mEcho.flFeedback = EAXECHO_DEFAULTFEEDBACK;
    props.mEcho.flSpread = EAXECHO_DEFAULTSPREAD;
}

template<>
void EchoCommitter::Get(const EaxCall &call, const EaxEffectProps &props)
{
    switch(call.get_property_id())
    {
    case EAXECHO_NONE: break;
    case EAXECHO_ALLPARAMETERS: call.set_value<Exception>(props.mEcho); break;
    case EAXECHO_DELAY: call.set_value<Exception>(props.mEcho.flDelay); break;
    case EAXECHO_LRDELAY: call.set_value<Exception>(props.mEcho.flLRDelay); break;
    case EAXECHO_DAMPING: call.set_value<Exception>(props.mEcho.flDamping); break;
    case EAXECHO_FEEDBACK: call.set_value<Exception>(props.mEcho.flFeedback); break;
    case EAXECHO_SPREAD: call.set_value<Exception>(props.mEcho.flSpread); break;
    default: fail_unknown_property_id();
    }
}

template<>
void EchoCommitter::Set(const EaxCall &call, EaxEffectProps &props)
{
    switch(call.get_property_id())
    {
    case EAXECHO_NONE: break;
    case EAXECHO_ALLPARAMETERS: defer<AllValidator>(call, props.mEcho); break;
    case EAXECHO_DELAY: defer<DelayValidator>(call, props.mEcho.flDelay); break;
    case EAXECHO_LRDELAY: defer<LrDelayValidator>(call, props.mEcho.flLRDelay); break;
    case EAXECHO_DAMPING: defer<DampingValidator>(call, props.mEcho.flDamping); break;
    case EAXECHO_FEEDBACK: defer<FeedbackValidator>(call, props.mEcho.flFeedback); break;
    case EAXECHO_SPREAD: defer<SpreadValidator>(call, props.mEcho.flSpread); break;
    default: fail_unknown_property_id();
    }
}

#endif // ALSOFT_EAX