core/effectslot.h

   1 #ifndef CORE_EFFECTSLOT_H
   2 #define CORE_EFFECTSLOT_H
   3
   4 #include <atomic>
   5
   6 #include "almalloc.h"
   7 #include "device.h"
   8 #include "effects/base.h"
   9 #include "intrusive_ptr.h"
  10
  11 struct EffectSlot;
  12 struct WetBuffer;
  13
  14 using EffectSlotArray = al::FlexArray<EffectSlot*>;
  15
  16
  17 enum class EffectSlotType : unsigned char {
  18     None,
  19     Reverb,
  20     Chorus,
  21     Distortion,
  22     Echo,
  23     Flanger,
  24     FrequencyShifter,
  25     VocalMorpher,
  26     PitchShifter,
  27     RingModulator,
  28     Autowah,
  29     Compressor,
  30     Equalizer,
  31     EAXReverb,
  32     DedicatedLFE,
  33     DedicatedDialog,
  34     Convolution
  35 };
  36
  37 struct EffectSlotProps {
  38     float Gain;
  39     bool  AuxSendAuto;
  40     EffectSlot *Target;
  41
  42     EffectSlotType Type;
  43     EffectProps Props;
  44
  45     al::intrusive_ptr<EffectState> State;
  46
  47     std::atomic<EffectSlotProps*> next;
  48
  49     DEF_NEWDEL(EffectSlotProps)
  50 };
  51
  52
  53 struct EffectSlot {
  54     std::atomic<EffectSlotProps*> Update{nullptr};
  55
  56     /* Wet buffer configuration is ACN channel order with N3D scaling.
  57      * Consequently, effects that only want to work with mono input can use
  58      * channel 0 by itself. Effects that want multichannel can process the
  59      * ambisonics signal and make a B-Format source pan.
  60      */
  61     MixParams Wet;
  62
  63     float Gain{1.0f};
  64     bool  AuxSendAuto{true};
  65     EffectSlot *Target{nullptr};
  66
  67     EffectSlotType EffectType{EffectSlotType::None};
  68     EffectProps mEffectProps{};
  69     EffectState *mEffectState{nullptr};
  70
  71     float RoomRolloff{0.0f}; /* Added to the source's room rolloff, not multiplied. */
  72     float DecayTime{0.0f};
  73     float DecayLFRatio{0.0f};
  74     float DecayHFRatio{0.0f};
  75     bool DecayHFLimit{false};
  76     float AirAbsorptionGainHF{1.0f};
  77
  78     /* Mixing buffer used by the Wet mix. */
  79     WetBuffer *mWetBuffer{nullptr};
  80
  81     ~EffectSlot();
  82
  83     static EffectSlotArray *CreatePtrArray(size_t count) noexcept;
  84
  85     DISABLE_ALLOC()
  86 };
  87
  88 #endif /* CORE_EFFECTSLOT_H */