Torque3D/Engine/lib/openal-soft/al/effects/equalizer.cpp

#include "config.h"

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

#include "alc/context.h"
#include "alnumeric.h"
#include "effects.h"

#if ALSOFT_EAX
#include "al/eax/effect.h"
#include "al/eax/exception.h"
#include "al/eax/utils.h"
#endif // ALSOFT_EAX


namespace {

constexpr EffectProps genDefaultProps() noexcept
{
    EqualizerProps props{};
    props.LowCutoff = AL_EQUALIZER_DEFAULT_LOW_CUTOFF;
    props.LowGain = AL_EQUALIZER_DEFAULT_LOW_GAIN;
    props.Mid1Center = AL_EQUALIZER_DEFAULT_MID1_CENTER;
    props.Mid1Gain = AL_EQUALIZER_DEFAULT_MID1_GAIN;
    props.Mid1Width = AL_EQUALIZER_DEFAULT_MID1_WIDTH;
    props.Mid2Center = AL_EQUALIZER_DEFAULT_MID2_CENTER;
    props.Mid2Gain = AL_EQUALIZER_DEFAULT_MID2_GAIN;
    props.Mid2Width = AL_EQUALIZER_DEFAULT_MID2_WIDTH;
    props.HighCutoff = AL_EQUALIZER_DEFAULT_HIGH_CUTOFF;
    props.HighGain = AL_EQUALIZER_DEFAULT_HIGH_GAIN;
    return props;
}

} // namespace

const EffectProps EqualizerEffectProps{genDefaultProps()};

void EqualizerEffectHandler::SetParami(ALCcontext *context, EqualizerProps&, ALenum param, int)
{ context->throw_error(AL_INVALID_ENUM, "Invalid equalizer integer property {:#04x}", as_unsigned(param)); }
void EqualizerEffectHandler::SetParamiv(ALCcontext *context, EqualizerProps&, ALenum param, const int*)
{ context->throw_error(AL_INVALID_ENUM, "Invalid equalizer integer-vector property {:#04x}", as_unsigned(param)); }
void EqualizerEffectHandler::SetParamf(ALCcontext *context, EqualizerProps &props, ALenum param, float val)
{
    switch(param)
    {
    case AL_EQUALIZER_LOW_GAIN:
        if(!(val >= AL_EQUALIZER_MIN_LOW_GAIN && val <= AL_EQUALIZER_MAX_LOW_GAIN))
            context->throw_error(AL_INVALID_VALUE, "Equalizer low-band gain out of range");
        props.LowGain = val;
        return;

    case AL_EQUALIZER_LOW_CUTOFF:
        if(!(val >= AL_EQUALIZER_MIN_LOW_CUTOFF && val <= AL_EQUALIZER_MAX_LOW_CUTOFF))
            context->throw_error(AL_INVALID_VALUE, "Equalizer low-band cutoff out of range");
        props.LowCutoff = val;
        return;

    case AL_EQUALIZER_MID1_GAIN:
        if(!(val >= AL_EQUALIZER_MIN_MID1_GAIN && val <= AL_EQUALIZER_MAX_MID1_GAIN))
            context->throw_error(AL_INVALID_VALUE, "Equalizer mid1-band gain out of range");
        props.Mid1Gain = val;
        return;

    case AL_EQUALIZER_MID1_CENTER:
        if(!(val >= AL_EQUALIZER_MIN_MID1_CENTER && val <= AL_EQUALIZER_MAX_MID1_CENTER))
            context->throw_error(AL_INVALID_VALUE, "Equalizer mid1-band center out of range");
        props.Mid1Center = val;
        return;

    case AL_EQUALIZER_MID1_WIDTH:
        if(!(val >= AL_EQUALIZER_MIN_MID1_WIDTH && val <= AL_EQUALIZER_MAX_MID1_WIDTH))
            context->throw_error(AL_INVALID_VALUE, "Equalizer mid1-band width out of range");
        props.Mid1Width = val;
        return;

    case AL_EQUALIZER_MID2_GAIN:
        if(!(val >= AL_EQUALIZER_MIN_MID2_GAIN && val <= AL_EQUALIZER_MAX_MID2_GAIN))
            context->throw_error(AL_INVALID_VALUE, "Equalizer mid2-band gain out of range");
        props.Mid2Gain = val;
        return;

    case AL_EQUALIZER_MID2_CENTER:
        if(!(val >= AL_EQUALIZER_MIN_MID2_CENTER && val <= AL_EQUALIZER_MAX_MID2_CENTER))
            context->throw_error(AL_INVALID_VALUE, "Equalizer mid2-band center out of range");
        props.Mid2Center = val;
        return;

    case AL_EQUALIZER_MID2_WIDTH:
        if(!(val >= AL_EQUALIZER_MIN_MID2_WIDTH && val <= AL_EQUALIZER_MAX_MID2_WIDTH))
            context->throw_error(AL_INVALID_VALUE, "Equalizer mid2-band width out of range");
        props.Mid2Width = val;
        return;

    case AL_EQUALIZER_HIGH_GAIN:
        if(!(val >= AL_EQUALIZER_MIN_HIGH_GAIN && val <= AL_EQUALIZER_MAX_HIGH_GAIN))
            context->throw_error(AL_INVALID_VALUE, "Equalizer high-band gain out of range");
        props.HighGain = val;
        return;

    case AL_EQUALIZER_HIGH_CUTOFF:
        if(!(val >= AL_EQUALIZER_MIN_HIGH_CUTOFF && val <= AL_EQUALIZER_MAX_HIGH_CUTOFF))
            context->throw_error(AL_INVALID_VALUE, "Equalizer high-band cutoff out of range");
        props.HighCutoff = val;
        return;
    }

    context->throw_error(AL_INVALID_ENUM, "Invalid equalizer float property {:#04x}",
        as_unsigned(param));
}
void EqualizerEffectHandler::SetParamfv(ALCcontext *context, EqualizerProps &props, ALenum param, const float *vals)
{ SetParamf(context, props, param, *vals); }

void EqualizerEffectHandler::GetParami(ALCcontext *context, const EqualizerProps&, ALenum param, int*)
{ context->throw_error(AL_INVALID_ENUM, "Invalid equalizer integer property {:#04x}", as_unsigned(param)); }
void EqualizerEffectHandler::GetParamiv(ALCcontext *context, const EqualizerProps&, ALenum param, int*)
{ context->throw_error(AL_INVALID_ENUM, "Invalid equalizer integer-vector property {:#04x}", as_unsigned(param)); }
void EqualizerEffectHandler::GetParamf(ALCcontext *context, const EqualizerProps &props, ALenum param, float *val)
{
    switch(param)
    {
    case AL_EQUALIZER_LOW_GAIN: *val = props.LowGain; return;
    case AL_EQUALIZER_LOW_CUTOFF: *val = props.LowCutoff; return;
    case AL_EQUALIZER_MID1_GAIN: *val = props.Mid1Gain; return;
    case AL_EQUALIZER_MID1_CENTER: *val = props.Mid1Center; return;
    case AL_EQUALIZER_MID1_WIDTH: *val = props.Mid1Width; return;
    case AL_EQUALIZER_MID2_GAIN: *val = props.Mid2Gain; return;
    case AL_EQUALIZER_MID2_CENTER: *val = props.Mid2Center; return;
    case AL_EQUALIZER_MID2_WIDTH: *val = props.Mid2Width; return;
    case AL_EQUALIZER_HIGH_GAIN: *val = props.HighGain; return;
    case AL_EQUALIZER_HIGH_CUTOFF: *val = props.HighCutoff; return;
    }

    context->throw_error(AL_INVALID_ENUM, "Invalid equalizer float property {:#04x}",
        as_unsigned(param));
}
void EqualizerEffectHandler::GetParamfv(ALCcontext *context, const EqualizerProps &props, ALenum param, float *vals)
{ GetParamf(context, props, param, vals); }


#if ALSOFT_EAX
namespace {

using EqualizerCommitter = EaxCommitter<EaxEqualizerCommitter>;

struct LowGainValidator {
    void operator()(long lLowGain) const
    {
        eax_validate_range<EqualizerCommitter::Exception>(
            "Low Gain",
            lLowGain,
            EAXEQUALIZER_MINLOWGAIN,
            EAXEQUALIZER_MAXLOWGAIN);
    }
}; // LowGainValidator

struct LowCutOffValidator {
    void operator()(float flLowCutOff) const
    {
        eax_validate_range<EqualizerCommitter::Exception>(
            "Low Cutoff",
            flLowCutOff,
            EAXEQUALIZER_MINLOWCUTOFF,
            EAXEQUALIZER_MAXLOWCUTOFF);
    }
}; // LowCutOffValidator

struct Mid1GainValidator {
    void operator()(long lMid1Gain) const
    {
        eax_validate_range<EqualizerCommitter::Exception>(
            "Mid1 Gain",
            lMid1Gain,
            EAXEQUALIZER_MINMID1GAIN,
            EAXEQUALIZER_MAXMID1GAIN);
    }
}; // Mid1GainValidator

struct Mid1CenterValidator {
    void operator()(float flMid1Center) const
    {
        eax_validate_range<EqualizerCommitter::Exception>(
            "Mid1 Center",
            flMid1Center,
            EAXEQUALIZER_MINMID1CENTER,
            EAXEQUALIZER_MAXMID1CENTER);
    }
}; // Mid1CenterValidator

struct Mid1WidthValidator {
    void operator()(float flMid1Width) const
    {
        eax_validate_range<EqualizerCommitter::Exception>(
            "Mid1 Width",
            flMid1Width,
            EAXEQUALIZER_MINMID1WIDTH,
            EAXEQUALIZER_MAXMID1WIDTH);
    }
}; // Mid1WidthValidator

struct Mid2GainValidator {
    void operator()(long lMid2Gain) const
    {
        eax_validate_range<EqualizerCommitter::Exception>(
            "Mid2 Gain",
            lMid2Gain,
            EAXEQUALIZER_MINMID2GAIN,
            EAXEQUALIZER_MAXMID2GAIN);
    }
}; // Mid2GainValidator

struct Mid2CenterValidator {
    void operator()(float flMid2Center) const
    {
        eax_validate_range<EqualizerCommitter::Exception>(
            "Mid2 Center",
            flMid2Center,
            EAXEQUALIZER_MINMID2CENTER,
            EAXEQUALIZER_MAXMID2CENTER);
    }
}; // Mid2CenterValidator

struct Mid2WidthValidator {
    void operator()(float flMid2Width) const
    {
        eax_validate_range<EqualizerCommitter::Exception>(
            "Mid2 Width",
            flMid2Width,
            EAXEQUALIZER_MINMID2WIDTH,
            EAXEQUALIZER_MAXMID2WIDTH);
    }
}; // Mid2WidthValidator

struct HighGainValidator {
    void operator()(long lHighGain) const
    {
        eax_validate_range<EqualizerCommitter::Exception>(
            "High Gain",
            lHighGain,
            EAXEQUALIZER_MINHIGHGAIN,
            EAXEQUALIZER_MAXHIGHGAIN);
    }
}; // HighGainValidator

struct HighCutOffValidator {
    void operator()(float flHighCutOff) const
    {
        eax_validate_range<EqualizerCommitter::Exception>(
            "High Cutoff",
            flHighCutOff,
            EAXEQUALIZER_MINHIGHCUTOFF,
            EAXEQUALIZER_MAXHIGHCUTOFF);
    }
}; // HighCutOffValidator

struct AllValidator {
    void operator()(const EAXEQUALIZERPROPERTIES& all) const
    {
        LowGainValidator{}(all.lLowGain);
        LowCutOffValidator{}(all.flLowCutOff);
        Mid1GainValidator{}(all.lMid1Gain);
        Mid1CenterValidator{}(all.flMid1Center);
        Mid1WidthValidator{}(all.flMid1Width);
        Mid2GainValidator{}(all.lMid2Gain);
        Mid2CenterValidator{}(all.flMid2Center);
        Mid2WidthValidator{}(all.flMid2Width);
        HighGainValidator{}(all.lHighGain);
        HighCutOffValidator{}(all.flHighCutOff);
    }
}; // AllValidator

} // namespace

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

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

bool EaxEqualizerCommitter::commit(const EAXEQUALIZERPROPERTIES &props)
{
    if(auto *cur = std::get_if<EAXEQUALIZERPROPERTIES>(&mEaxProps); cur && *cur == props)
        return false;

    mEaxProps = props;
    mAlProps = [&]{
        EqualizerProps ret{};
        ret.LowGain = level_mb_to_gain(static_cast<float>(props.lLowGain));
        ret.LowCutoff = props.flLowCutOff;
        ret.Mid1Gain = level_mb_to_gain(static_cast<float>(props.lMid1Gain));
        ret.Mid1Center = props.flMid1Center;
        ret.Mid1Width = props.flMid1Width;
        ret.Mid2Gain = level_mb_to_gain(static_cast<float>(props.lMid2Gain));
        ret.Mid2Center = props.flMid2Center;
        ret.Mid2Width = props.flMid2Width;
        ret.HighGain = level_mb_to_gain(static_cast<float>(props.lHighGain));
        ret.HighCutoff = props.flHighCutOff;
        return ret;
    }();

    return true;
}

void EaxEqualizerCommitter::SetDefaults(EaxEffectProps &props)
{
    static constexpr EAXEQUALIZERPROPERTIES defprops{[]
    {
        EAXEQUALIZERPROPERTIES ret{};
        ret.lLowGain = EAXEQUALIZER_DEFAULTLOWGAIN;
        ret.flLowCutOff = EAXEQUALIZER_DEFAULTLOWCUTOFF;
        ret.lMid1Gain = EAXEQUALIZER_DEFAULTMID1GAIN;
        ret.flMid1Center = EAXEQUALIZER_DEFAULTMID1CENTER;
        ret.flMid1Width = EAXEQUALIZER_DEFAULTMID1WIDTH;
        ret.lMid2Gain = EAXEQUALIZER_DEFAULTMID2GAIN;
        ret.flMid2Center = EAXEQUALIZER_DEFAULTMID2CENTER;
        ret.flMid2Width = EAXEQUALIZER_DEFAULTMID2WIDTH;
        ret.lHighGain = EAXEQUALIZER_DEFAULTHIGHGAIN;
        ret.flHighCutOff = EAXEQUALIZER_DEFAULTHIGHCUTOFF;
        return ret;
    }()};
    props = defprops;
}

void EaxEqualizerCommitter::Get(const EaxCall &call, const EAXEQUALIZERPROPERTIES &props)
{
    switch(call.get_property_id())
    {
    case EAXEQUALIZER_NONE: break;
    case EAXEQUALIZER_ALLPARAMETERS: call.set_value<Exception>(props); break;
    case EAXEQUALIZER_LOWGAIN: call.set_value<Exception>(props.lLowGain); break;
    case EAXEQUALIZER_LOWCUTOFF: call.set_value<Exception>(props.flLowCutOff); break;
    case EAXEQUALIZER_MID1GAIN: call.set_value<Exception>(props.lMid1Gain); break;
    case EAXEQUALIZER_MID1CENTER: call.set_value<Exception>(props.flMid1Center); break;
    case EAXEQUALIZER_MID1WIDTH: call.set_value<Exception>(props.flMid1Width); break;
    case EAXEQUALIZER_MID2GAIN: call.set_value<Exception>(props.lMid2Gain); break;
    case EAXEQUALIZER_MID2CENTER: call.set_value<Exception>(props.flMid2Center); break;
    case EAXEQUALIZER_MID2WIDTH: call.set_value<Exception>(props.flMid2Width); break;
    case EAXEQUALIZER_HIGHGAIN: call.set_value<Exception>(props.lHighGain); break;
    case EAXEQUALIZER_HIGHCUTOFF: call.set_value<Exception>(props.flHighCutOff); break;
    default: fail_unknown_property_id();
    }
}

void EaxEqualizerCommitter::Set(const EaxCall &call, EAXEQUALIZERPROPERTIES &props)
{
    switch(call.get_property_id())
    {
    case EAXEQUALIZER_NONE: break;
    case EAXEQUALIZER_ALLPARAMETERS: defer<AllValidator>(call, props); break;
    case EAXEQUALIZER_LOWGAIN: defer<LowGainValidator>(call, props.lLowGain); break;
    case EAXEQUALIZER_LOWCUTOFF: defer<LowCutOffValidator>(call, props.flLowCutOff); break;
    case EAXEQUALIZER_MID1GAIN: defer<Mid1GainValidator>(call, props.lMid1Gain); break;
    case EAXEQUALIZER_MID1CENTER: defer<Mid1CenterValidator>(call, props.flMid1Center); break;
    case EAXEQUALIZER_MID1WIDTH: defer<Mid1WidthValidator>(call, props.flMid1Width); break;
    case EAXEQUALIZER_MID2GAIN: defer<Mid2GainValidator>(call, props.lMid2Gain); break;
    case EAXEQUALIZER_MID2CENTER: defer<Mid2CenterValidator>(call, props.flMid2Center); break;
    case EAXEQUALIZER_MID2WIDTH: defer<Mid2WidthValidator>(call, props.flMid2Width); break;
    case EAXEQUALIZER_HIGHGAIN: defer<HighGainValidator>(call, props.lHighGain); break;
    case EAXEQUALIZER_HIGHCUTOFF: defer<HighCutOffValidator>(call, props.flHighCutOff); break;
    default: fail_unknown_property_id();
    }
}

#endif // ALSOFT_EAX