OpenAL32/Include/alAuxEffectSlot.h

   1 #ifndef _AL_AUXEFFECTSLOT_H_
   2 #define _AL_AUXEFFECTSLOT_H_
   3
   4 #include "alMain.h"
   5 #include "alEffect.h"
   6
   7 #include "almalloc.h"
   8 #include "atomic.h"
   9
  10
  11 struct ALeffectslot;
  12
  13
  14 struct EffectState {
  15     RefCount mRef{1u};
  16
  17     ALfloat (*mOutBuffer)[BUFFERSIZE]{nullptr};
  18     ALsizei mOutChannels{0};
  19
  20
  21     virtual ~EffectState() = default;
  22
  23     virtual ALboolean deviceUpdate(ALCdevice *device) = 0;
  24     virtual void update(const ALCcontext *context, const ALeffectslot *slot, const ALeffectProps *props) = 0;
  25     virtual void process(ALsizei samplesToDo, const ALfloat (*RESTRICT samplesIn)[BUFFERSIZE], ALfloat (*RESTRICT samplesOut)[BUFFERSIZE], ALsizei numChannels) = 0;
  26
  27     void IncRef() noexcept;
  28     void DecRef() noexcept;
  29 };
  30
  31
  32 struct EffectStateFactory {
  33     virtual ~EffectStateFactory() { }
  34
  35     virtual EffectState *create() = 0;
  36 };
  37
  38
  39 #define MAX_EFFECT_CHANNELS (4)
  40
  41
  42 struct ALeffectslotArray {
  43     ALsizei count;
  44     struct ALeffectslot *slot[];
  45 };
  46
  47
  48 struct ALeffectslotProps {
  49     ALfloat   Gain;
  50     ALboolean AuxSendAuto;
  51
  52     ALenum Type;
  53     ALeffectProps Props;
  54
  55     EffectState *State;
  56
  57     ATOMIC(struct ALeffectslotProps*) next;
  58 };
  59
  60
  61 struct ALeffectslot {
  62     ALfloat   Gain{1.0f};
  63     ALboolean AuxSendAuto{AL_TRUE};
  64
  65     struct {
  66         ALenum Type{AL_EFFECT_NULL};
  67         ALeffectProps Props{};
  68
  69         EffectState *State{nullptr};
  70     } Effect;
  71
  72     ATOMIC(ALenum) PropsClean{AL_TRUE};
  73
  74     RefCount ref{0u};
  75
  76     ATOMIC(struct ALeffectslotProps*) Update{nullptr};
  77
  78     struct {
  79         ALfloat   Gain{1.0f};
  80         ALboolean AuxSendAuto{AL_TRUE};
  81
  82         ALenum EffectType{AL_EFFECT_NULL};
  83         ALeffectProps EffectProps{};
  84         EffectState *EffectState{nullptr};
  85
  86         ALfloat RoomRolloff{0.0f}; /* Added to the source's room rolloff, not multiplied. */
  87         ALfloat DecayTime{0.0f};
  88         ALfloat DecayLFRatio{0.0f};
  89         ALfloat DecayHFRatio{0.0f};
  90         ALboolean DecayHFLimit{AL_FALSE};
  91         ALfloat AirAbsorptionGainHF{1.0f};
  92     } Params;
  93
  94     /* Self ID */
  95     ALuint id{};
  96
  97     ALsizei NumChannels{};
  98     BFChannelConfig ChanMap[MAX_EFFECT_CHANNELS];
  99     /* Wet buffer configuration is ACN channel order with N3D scaling:
 100      * * Channel 0 is the unattenuated mono signal.
 101      * * Channel 1 is OpenAL -X * sqrt(3)
 102      * * Channel 2 is OpenAL Y * sqrt(3)
 103      * * Channel 3 is OpenAL -Z * sqrt(3)
 104      * Consequently, effects that only want to work with mono input can use
 105      * channel 0 by itself. Effects that want multichannel can process the
 106      * ambisonics signal and make a B-Format source pan for first-order device
 107      * output (FOAOut).
 108      */
 109     alignas(16) ALfloat WetBuffer[MAX_EFFECT_CHANNELS][BUFFERSIZE];
 110
 111     ALeffectslot() = default;
 112     ALeffectslot(const ALeffectslot&) = delete;
 113     ALeffectslot& operator=(const ALeffectslot&) = delete;
 114     ~ALeffectslot();
 115
 116     DEF_NEWDEL(ALeffectslot)
 117 };
 118
 119 ALenum InitEffectSlot(ALeffectslot *slot);
 120 void UpdateEffectSlotProps(ALeffectslot *slot, ALCcontext *context);
 121 void UpdateAllEffectSlotProps(ALCcontext *context);
 122 ALvoid ReleaseALAuxiliaryEffectSlots(ALCcontext *Context);
 123
 124
 125 EffectStateFactory *NullStateFactory_getFactory(void);
 126 EffectStateFactory *ReverbStateFactory_getFactory(void);
 127 EffectStateFactory *AutowahStateFactory_getFactory(void);
 128 EffectStateFactory *ChorusStateFactory_getFactory(void);
 129 EffectStateFactory *CompressorStateFactory_getFactory(void);
 130 EffectStateFactory *DistortionStateFactory_getFactory(void);
 131 EffectStateFactory *EchoStateFactory_getFactory(void);
 132 EffectStateFactory *EqualizerStateFactory_getFactory(void);
 133 EffectStateFactory *FlangerStateFactory_getFactory(void);
 134 EffectStateFactory *FshifterStateFactory_getFactory(void);
 135 EffectStateFactory *ModulatorStateFactory_getFactory(void);
 136 EffectStateFactory *PshifterStateFactory_getFactory(void);
 137
 138 EffectStateFactory *DedicatedStateFactory_getFactory(void);
 139
 140
 141 ALenum InitializeEffect(ALCcontext *Context, ALeffectslot *EffectSlot, ALeffect *effect);
 142
 143 #endif