al/auxeffectslot.h

   1 #ifndef AL_AUXEFFECTSLOT_H
   2 #define AL_AUXEFFECTSLOT_H
   3
   4 #include <atomic>
   5 #include <cstddef>
   6
   7 #include "AL/al.h"
   8 #include "AL/alc.h"
   9 #include "AL/efx.h"
  10
  11 #include "alc/device.h"
  12 #include "alc/effects/base.h"
  13 #include "almalloc.h"
  14 #include "atomic.h"
  15 #include "core/effectslot.h"
  16 #include "intrusive_ptr.h"
  17 #include "vector.h"
  18
  19 #ifdef ALSOFT_EAX
  20 #include <memory>
  21 #include "eax/call.h"
  22 #include "eax/effect.h"
  23 #include "eax/fx_slot_index.h"
  24 #endif // ALSOFT_EAX
  25
  26 struct ALbuffer;
  27 struct ALeffect;
  28 struct WetBuffer;
  29
  30
  31 enum class SlotState : ALenum {
  32     Initial = AL_INITIAL,
  33     Playing = AL_PLAYING,
  34     Stopped = AL_STOPPED,
  35 };
  36
  37 struct ALeffectslot {
  38     float Gain{1.0f};
  39     bool  AuxSendAuto{true};
  40     ALeffectslot *Target{nullptr};
  41     ALbuffer *Buffer{nullptr};
  42
  43     struct {
  44         EffectSlotType Type{EffectSlotType::None};
  45         EffectProps Props{};
  46
  47         al::intrusive_ptr<EffectState> State;
  48     } Effect;
  49
  50     bool mPropsDirty{true};
  51
  52     SlotState mState{SlotState::Initial};
  53
  54     RefCount ref{0u};
  55
  56     EffectSlot mSlot;
  57
  58     /* Self ID */
  59     ALuint id{};
  60
  61     ALeffectslot();
  62     ALeffectslot(const ALeffectslot&) = delete;
  63     ALeffectslot& operator=(const ALeffectslot&) = delete;
  64     ~ALeffectslot();
  65
  66     ALenum initEffect(ALenum effectType, const EffectProps &effectProps, ALCcontext *context);
  67     void updateProps(ALCcontext *context);
  68
  69     /* This can be new'd for the context's default effect slot. */
  70     DEF_NEWDEL(ALeffectslot)
  71
  72
  73 #ifdef ALSOFT_EAX
  74 public:
  75     void eax_initialize(
  76         const EaxCall& call,
  77         ALCcontext& al_context,
  78         EaxFxSlotIndexValue index);
  79
  80     const EAX50FXSLOTPROPERTIES& eax_get_eax_fx_slot() const noexcept;
  81
  82
  83     // [[nodiscard]]
  84     bool eax_dispatch(const EaxCall& call)
  85     { return call.is_get() ? eax_get(call) : eax_set(call); }
  86
  87
  88     void eax_unlock_legacy() noexcept;
  89
  90     void eax_commit() { eax_apply_deferred(); }
  91
  92 private:
  93     ALCcontext* eax_al_context_{};
  94
  95     EaxFxSlotIndexValue eax_fx_slot_index_{};
  96
  97     EAX50FXSLOTPROPERTIES eax_eax_fx_slot_{};
  98
  99     EaxEffectUPtr eax_effect_{};
 100     bool eax_is_locked_{};
 101
 102
 103     [[noreturn]]
 104     static void eax_fail(
 105         const char* message);
 106
 107
 108     GUID eax_get_eax_default_effect_guid() const noexcept;
 109     long eax_get_eax_default_lock() const noexcept;
 110
 111     void eax_set_eax_fx_slot_defaults();
 112
 113     void eax_initialize_eax();
 114
 115     void eax_initialize_lock();
 116
 117
 118     void eax_initialize_effects(const EaxCall& call);
 119
 120
 121     void eax_get_fx_slot_all(const EaxCall& call) const;
 122
 123     void eax_get_fx_slot(const EaxCall& call) const;
 124
 125     // [[nodiscard]]
 126     bool eax_get(const EaxCall& call);
 127
 128
 129     void eax_set_fx_slot_effect(const EaxCall& call, ALenum effect_type);
 130
 131     void eax_set_fx_slot_effect(const EaxCall& call);
 132
 133
 134     void eax_set_efx_effect_slot_gain();
 135
 136     void eax_set_fx_slot_volume();
 137
 138
 139     void eax_set_effect_slot_send_auto();
 140
 141     void eax_set_fx_slot_flags();
 142
 143
 144     void eax_ensure_is_unlocked() const;
 145
 146     void eax_validate_fx_slot_effect(const GUID& eax_effect_id);
 147     void eax_validate_fx_slot_volume(long eax_volume);
 148     void eax_validate_fx_slot_lock(long eax_lock);
 149     void eax_validate_fx_slot_flags(const EaxCall& call, unsigned long eax_flags);
 150     void eax_validate_fx_slot_occlusion(long eax_occlusion);
 151     void eax_validate_fx_slot_occlusion_lf_ratio(float eax_occlusion_lf_ratio);
 152     void eax_validate_fx_slot_all(const EaxCall& call, const EAX40FXSLOTPROPERTIES& fx_slot);
 153     void eax_validate_fx_slot_all(const EaxCall& call, const EAX50FXSLOTPROPERTIES& fx_slot);
 154
 155     void eax_set_fx_slot_effect(const EaxCall& call, const GUID& eax_effect_id);
 156
 157     void eax_set_fx_slot_volume(
 158         long eax_volume);
 159
 160     void eax_set_fx_slot_lock(
 161         long eax_lock);
 162
 163     void eax_set_fx_slot_flags(
 164         unsigned long eax_flags);
 165
 166     // [[nodiscard]]
 167     bool eax_set_fx_slot_occlusion(
 168         long eax_occlusion);
 169
 170     // [[nodiscard]]
 171     bool eax_set_fx_slot_occlusion_lf_ratio(
 172         float eax_occlusion_lf_ratio);
 173
 174     void eax_set_fx_slot_all(const EaxCall& call, const EAX40FXSLOTPROPERTIES& eax_fx_slot);
 175
 176     // [[nodiscard]]
 177     bool eax_set_fx_slot_all(const EaxCall& call, const EAX50FXSLOTPROPERTIES& eax_fx_slot);
 178
 179
 180     void eax_defer_fx_slot_effect(const EaxCall& call);
 181
 182     void eax_defer_fx_slot_volume(const EaxCall& call);
 183
 184     void eax_defer_fx_slot_lock(const EaxCall& call);
 185
 186     void eax_defer_fx_slot_flags(const EaxCall& call);
 187
 188     // [[nodiscard]]
 189     bool eax_defer_fx_slot_occlusion(const EaxCall& call);
 190
 191     // [[nodiscard]]
 192     bool eax_defer_fx_slot_occlusion_lf_ratio(const EaxCall& call);
 193
 194     // [[nodiscard]]
 195     bool eax_defer_fx_slot_all(const EaxCall& call);
 196
 197     bool eax_set_fx_slot(const EaxCall& call);
 198
 199     void eax_apply_deferred();
 200
 201     // [[nodiscard]]
 202     bool eax_set(const EaxCall& call);
 203
 204
 205     void eax_dispatch_effect(const EaxCall& call);
 206
 207
 208     // `alAuxiliaryEffectSloti(effect_slot, AL_EFFECTSLOT_EFFECT, effect)`
 209     void eax_set_effect_slot_effect(EaxEffect &effect);
 210
 211     // `alAuxiliaryEffectSloti(effect_slot, AL_EFFECTSLOT_AUXILIARY_SEND_AUTO, value)`
 212     void eax_set_effect_slot_send_auto(bool is_send_auto);
 213
 214     // `alAuxiliaryEffectSlotf(effect_slot, AL_EFFECTSLOT_GAIN, gain)`
 215     void eax_set_effect_slot_gain(ALfloat gain);
 216
 217 public:
 218     class EaxDeleter {
 219     public:
 220         void operator()(ALeffectslot *effect_slot);
 221     }; // EaxAlEffectSlotDeleter
 222 #endif // ALSOFT_EAX
 223 };
 224
 225 void UpdateAllEffectSlotProps(ALCcontext *context);
 226
 227 #ifdef ALSOFT_EAX
 228
 229 using EaxAlEffectSlotUPtr = std::unique_ptr<ALeffectslot, ALeffectslot::EaxDeleter>;
 230
 231
 232 EaxAlEffectSlotUPtr eax_create_al_effect_slot(
 233     ALCcontext& context);
 234
 235 void eax_delete_al_effect_slot(
 236     ALCcontext& context,
 237     ALeffectslot& effect_slot);
 238 #endif // ALSOFT_EAX
 239
 240 #endif