core/effectslot.h

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