aboutsummaryrefslogtreecommitdiffstats
path: root/al/effects/pshifter.cpp
blob: ef3fe5877ab2c45333c4900a74e934079e4ec417 (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

#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 {

void Pshifter_setParamf(EffectProps*, ALenum param, float)
{ throw effect_exception{AL_INVALID_ENUM, "Invalid pitch shifter float property 0x%04x", param}; }
void Pshifter_setParamfv(EffectProps*, ALenum param, const float*)
{
    throw effect_exception{AL_INVALID_ENUM, "Invalid pitch shifter float-vector property 0x%04x",
        param};
}

void Pshifter_setParami(EffectProps *props, ALenum param, int val)
{
    switch(param)
    {
    case AL_PITCH_SHIFTER_COARSE_TUNE:
        if(!(val >= AL_PITCH_SHIFTER_MIN_COARSE_TUNE && val <= AL_PITCH_SHIFTER_MAX_COARSE_TUNE))
            throw effect_exception{AL_INVALID_VALUE, "Pitch shifter coarse tune out of range"};
        props->Pshifter.CoarseTune = val;
        break;

    case AL_PITCH_SHIFTER_FINE_TUNE:
        if(!(val >= AL_PITCH_SHIFTER_MIN_FINE_TUNE && val <= AL_PITCH_SHIFTER_MAX_FINE_TUNE))
            throw effect_exception{AL_INVALID_VALUE, "Pitch shifter fine tune out of range"};
        props->Pshifter.FineTune = val;
        break;

    default:
        throw effect_exception{AL_INVALID_ENUM, "Invalid pitch shifter integer property 0x%04x",
            param};
    }
}
void Pshifter_setParamiv(EffectProps *props, ALenum param, const int *vals)
{ Pshifter_setParami(props, param, vals[0]); }

void Pshifter_getParami(const EffectProps *props, ALenum param, int *val)
{
    switch(param)
    {
    case AL_PITCH_SHIFTER_COARSE_TUNE:
        *val = props->Pshifter.CoarseTune;
        break;
    case AL_PITCH_SHIFTER_FINE_TUNE:
        *val = props->Pshifter.FineTune;
        break;

    default:
        throw effect_exception{AL_INVALID_ENUM, "Invalid pitch shifter integer property 0x%04x",
            param};
    }
}
void Pshifter_getParamiv(const EffectProps *props, ALenum param, int *vals)
{ Pshifter_getParami(props, param, vals); }

void Pshifter_getParamf(const EffectProps*, ALenum param, float*)
{ throw effect_exception{AL_INVALID_ENUM, "Invalid pitch shifter float property 0x%04x", param}; }
void Pshifter_getParamfv(const EffectProps*, ALenum param, float*)
{
    throw effect_exception{AL_INVALID_ENUM, "Invalid pitch shifter float vector-property 0x%04x",
        param};
}

EffectProps genDefaultProps() noexcept
{
    EffectProps props{};
    props.Pshifter.CoarseTune = AL_PITCH_SHIFTER_DEFAULT_COARSE_TUNE;
    props.Pshifter.FineTune   = AL_PITCH_SHIFTER_DEFAULT_FINE_TUNE;
    return props;
}

} // namespace

DEFINE_ALEFFECT_VTABLE(Pshifter);

const EffectProps PshifterEffectProps{genDefaultProps()};

#ifdef ALSOFT_EAX
namespace {

class EaxPitchShifterEffectException : public EaxException
{
public:
    explicit EaxPitchShifterEffectException(const char* message)
        : EaxException{"EAX_PITCH_SHIFTER_EFFECT", message}
    {}
}; // EaxPitchShifterEffectException

class EaxPitchShifterEffect final : public EaxEffect4<EaxPitchShifterEffectException> {
public:
    EaxPitchShifterEffect(int eax_version);

private:
    struct CoarseTuneValidator {
        void operator()(long lCoarseTune) const
        {
            eax_validate_range<Exception>(
                "Coarse Tune",
                lCoarseTune,
                EAXPITCHSHIFTER_MINCOARSETUNE,
                EAXPITCHSHIFTER_MAXCOARSETUNE);
        }
    }; // CoarseTuneValidator

    struct FineTuneValidator {
        void operator()(long lFineTune) const
        {
            eax_validate_range<Exception>(
                "Fine Tune",
                lFineTune,
                EAXPITCHSHIFTER_MINFINETUNE,
                EAXPITCHSHIFTER_MAXFINETUNE);
        }
    }; // FineTuneValidator

    struct AllValidator {
        void operator()(const EAXPITCHSHIFTERPROPERTIES& all) const
        {
            CoarseTuneValidator{}(all.lCoarseTune);
            FineTuneValidator{}(all.lFineTune);
        }
    }; // AllValidator

    void set_defaults(Props4& props) override;

    void set_efx_coarse_tune() noexcept;
    void set_efx_fine_tune() noexcept;
    void set_efx_defaults() override;

    void get(const EaxCall& call, const Props4& props) override;
    void set(const EaxCall& call, Props4& props) override;
    bool commit_props(const Props4& old_i) override;
}; // EaxPitchShifterEffect

EaxPitchShifterEffect::EaxPitchShifterEffect(int eax_version)
    : EaxEffect4{AL_EFFECT_PITCH_SHIFTER, eax_version}
{}

void EaxPitchShifterEffect::set_defaults(Props4& props)
{
    props.mPitchShifter.lCoarseTune = EAXPITCHSHIFTER_DEFAULTCOARSETUNE;
    props.mPitchShifter.lFineTune = EAXPITCHSHIFTER_DEFAULTFINETUNE;
}

void EaxPitchShifterEffect::set_efx_coarse_tune() noexcept
{
    al_effect_props_.Pshifter.CoarseTune = clamp(
        static_cast<ALint>(props_.mPitchShifter.lCoarseTune),
        AL_PITCH_SHIFTER_MIN_COARSE_TUNE,
        AL_PITCH_SHIFTER_MAX_COARSE_TUNE);
}

void EaxPitchShifterEffect::set_efx_fine_tune() noexcept
{
    al_effect_props_.Pshifter.FineTune = clamp(
        static_cast<ALint>(props_.mPitchShifter.lFineTune),
        AL_PITCH_SHIFTER_MIN_FINE_TUNE,
        AL_PITCH_SHIFTER_MAX_FINE_TUNE);
}

void EaxPitchShifterEffect::set_efx_defaults()
{
    set_efx_coarse_tune();
    set_efx_fine_tune();
}

void EaxPitchShifterEffect::get(const EaxCall& call, const Props4& props)
{
    switch(call.get_property_id())
    {
        case EAXPITCHSHIFTER_NONE: break;
        case EAXPITCHSHIFTER_ALLPARAMETERS: call.set_value<Exception>(props.mPitchShifter); break;
        case EAXPITCHSHIFTER_COARSETUNE: call.set_value<Exception>(props.mPitchShifter.lCoarseTune); break;
        case EAXPITCHSHIFTER_FINETUNE: call.set_value<Exception>(props.mPitchShifter.lFineTune); break;
        default: fail_unknown_property_id();
    }
}

void EaxPitchShifterEffect::set(const EaxCall& call, Props4& props)
{
    switch(call.get_property_id())
    {
        case EAXPITCHSHIFTER_NONE: break;
        case EAXPITCHSHIFTER_ALLPARAMETERS: defer<AllValidator>(call, props.mPitchShifter); break;
        case EAXPITCHSHIFTER_COARSETUNE: defer<CoarseTuneValidator>(call, props.mPitchShifter.lCoarseTune); break;
        case EAXPITCHSHIFTER_FINETUNE: defer<FineTuneValidator>(call, props.mPitchShifter.lFineTune); break;
        default: fail_unknown_property_id();
    }
}

bool EaxPitchShifterEffect::commit_props(const Props4& props)
{
    auto is_dirty = false;

    if (props_.mPitchShifter.lCoarseTune != props.mPitchShifter.lCoarseTune)
    {
        is_dirty = true;
        set_efx_coarse_tune();
    }

    if (props_.mPitchShifter.lFineTune != props.mPitchShifter.lFineTune)
    {
        is_dirty = true;
        set_efx_fine_tune();
    }

    return is_dirty;
}

} // namespace

EaxEffectUPtr eax_create_eax_pitch_shifter_effect(int eax_version)
{
    return eax_create_eax4_effect<EaxPitchShifterEffect>(eax_version);
}

#endif // ALSOFT_EAX