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
  22 #include "eax_eax_call.h"
  23 #include "eax_effect.h"
  24 #include "eax_fx_slot_index.h"
  25 #endif // ALSOFT_EAX
  26
  27 struct ALbuffer;
  28 struct ALeffect;
  29 struct WetBuffer;
  30
  31
  32 enum class SlotState : ALenum {
  33     Initial = AL_INITIAL,
  34     Playing = AL_PLAYING,
  35     Stopped = AL_STOPPED,
  36 };
  37
  38 struct ALeffectslot {
  39     float Gain{1.0f};
  40     bool  AuxSendAuto{true};
  41     ALeffectslot *Target{nullptr};
  42     ALbuffer *Buffer{nullptr};
  43
  44     struct {
  45         EffectSlotType Type{EffectSlotType::None};
  46         EffectProps Props{};
  47
  48         al::intrusive_ptr<EffectState> State;
  49     } Effect;
  50
  51     bool mPropsDirty{true};
  52
  53     SlotState mState{SlotState::Initial};
  54
  55     RefCount ref{0u};
  56
  57     EffectSlot mSlot;
  58
  59     /* Self ID */
  60     ALuint id{};
  61
  62     ALeffectslot();
  63     ALeffectslot(const ALeffectslot&) = delete;
  64     ALeffectslot& operator=(const ALeffectslot&) = delete;
  65     ~ALeffectslot();
  66
  67     ALenum initEffect(ALenum effectType, const EffectProps &effectProps, ALCcontext *context);
  68     void updateProps(ALCcontext *context);
  69
  70     /* This can be new'd for the context's default effect slot. */
  71     DEF_NEWDEL(ALeffectslot)
  72
  73
  74 #ifdef ALSOFT_EAX
  75 public:
  76     void eax_initialize(
  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 EaxEaxCall& eax_call)
  85     { return eax_call.is_get() ? eax_get(eax_call) : eax_set(eax_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();
 119
 120
 121     void eax_get_fx_slot_all(
 122         const EaxEaxCall& eax_call) const;
 123
 124     void eax_get_fx_slot(
 125         const EaxEaxCall& eax_call) const;
 126
 127     // [[nodiscard]]
 128     bool eax_get(
 129         const EaxEaxCall& eax_call);
 130
 131
 132     void eax_set_fx_slot_effect(
 133         ALenum effect_type);
 134
 135     void eax_set_fx_slot_effect();
 136
 137
 138     void eax_set_efx_effect_slot_gain();
 139
 140     void eax_set_fx_slot_volume();
 141
 142
 143     void eax_set_effect_slot_send_auto();
 144
 145     void eax_set_fx_slot_flags();
 146
 147
 148     void eax_ensure_is_unlocked() const;
 149
 150
 151     void eax_validate_fx_slot_effect(
 152         const GUID& eax_effect_id);
 153
 154     void eax_validate_fx_slot_volume(
 155         long eax_volume);
 156
 157     void eax_validate_fx_slot_lock(
 158         long eax_lock);
 159
 160     void eax_validate_fx_slot_flags(
 161         unsigned long eax_flags,
 162         int eax_version);
 163
 164     void eax_validate_fx_slot_occlusion(
 165         long eax_occlusion);
 166
 167     void eax_validate_fx_slot_occlusion_lf_ratio(
 168         float eax_occlusion_lf_ratio);
 169
 170     void eax_validate_fx_slot_all(
 171         const EAX40FXSLOTPROPERTIES& fx_slot,
 172         int eax_version);
 173
 174     void eax_validate_fx_slot_all(
 175         const EAX50FXSLOTPROPERTIES& fx_slot,
 176         int eax_version);
 177
 178
 179     void eax_set_fx_slot_effect(
 180         const GUID& eax_effect_id);
 181
 182     void eax_set_fx_slot_volume(
 183         long eax_volume);
 184
 185     void eax_set_fx_slot_lock(
 186         long eax_lock);
 187
 188     void eax_set_fx_slot_flags(
 189         unsigned long eax_flags);
 190
 191     // [[nodiscard]]
 192     bool eax_set_fx_slot_occlusion(
 193         long eax_occlusion);
 194
 195     // [[nodiscard]]
 196     bool eax_set_fx_slot_occlusion_lf_ratio(
 197         float eax_occlusion_lf_ratio);
 198
 199     void eax_set_fx_slot_all(
 200         const EAX40FXSLOTPROPERTIES& eax_fx_slot);
 201
 202     // [[nodiscard]]
 203     bool eax_set_fx_slot_all(
 204         const EAX50FXSLOTPROPERTIES& eax_fx_slot);
 205
 206
 207     void eax_set_fx_slot_effect(
 208         const EaxEaxCall& eax_call);
 209
 210     void eax_set_fx_slot_volume(
 211         const EaxEaxCall& eax_call);
 212
 213     void eax_set_fx_slot_lock(
 214         const EaxEaxCall& eax_call);
 215
 216     void eax_set_fx_slot_flags(
 217         const EaxEaxCall& eax_call);
 218
 219     // [[nodiscard]]
 220     bool eax_set_fx_slot_occlusion(
 221         const EaxEaxCall& eax_call);
 222
 223     // [[nodiscard]]
 224     bool eax_set_fx_slot_occlusion_lf_ratio(
 225         const EaxEaxCall& eax_call);
 226
 227     // [[nodiscard]]
 228     bool eax_set_fx_slot_all(
 229         const EaxEaxCall& eax_call);
 230
 231     bool eax_set_fx_slot(
 232         const EaxEaxCall& eax_call);
 233
 234     void eax_apply_deferred();
 235
 236     // [[nodiscard]]
 237     bool eax_set(
 238         const EaxEaxCall& eax_call);
 239
 240
 241     void eax_dispatch_effect(
 242         const EaxEaxCall& eax_call);
 243
 244
 245     // `alAuxiliaryEffectSloti(effect_slot, AL_EFFECTSLOT_EFFECT, effect)`
 246     void eax_set_effect_slot_effect(EaxEffect &effect);
 247
 248     // `alAuxiliaryEffectSloti(effect_slot, AL_EFFECTSLOT_AUXILIARY_SEND_AUTO, value)`
 249     void eax_set_effect_slot_send_auto(bool is_send_auto);
 250
 251     // `alAuxiliaryEffectSlotf(effect_slot, AL_EFFECTSLOT_GAIN, gain)`
 252     void eax_set_effect_slot_gain(ALfloat gain);
 253
 254 public:
 255     class EaxDeleter {
 256     public:
 257         void operator()(ALeffectslot *effect_slot);
 258     }; // EaxAlEffectSlotDeleter
 259 #endif // ALSOFT_EAX
 260 };
 261
 262 void UpdateAllEffectSlotProps(ALCcontext *context);
 263
 264 #ifdef ALSOFT_EAX
 265
 266 using EaxAlEffectSlotUPtr = std::unique_ptr<ALeffectslot, ALeffectslot::EaxDeleter>;
 267
 268
 269 EaxAlEffectSlotUPtr eax_create_al_effect_slot(
 270     ALCcontext& context);
 271
 272 void eax_delete_al_effect_slot(
 273     ALCcontext& context,
 274     ALeffectslot& effect_slot);
 275 #endif // ALSOFT_EAX
 276
 277 #endif