alc/effects/null.cpp

   1
   2 #include "config.h"
   3
   4 #include "AL/al.h"
   5 #include "AL/alc.h"
   6
   7 #include "al/auxeffectslot.h"
   8 #include "alcmain.h"
   9 #include "alcontext.h"
  10 #include "almalloc.h"
  11 #include "alspan.h"
  12 #include "effects/base.h"
  13
  14
  15 namespace {
  16
  17 struct NullState final : public EffectState {
  18     NullState();
  19     ~NullState() override;
  20
  21     void deviceUpdate(const ALCdevice *device) override;
  22     void update(const ALCcontext *context, const ALeffectslot *slot, const EffectProps *props, const EffectTarget target) override;
  23     void process(const size_t samplesToDo, const al::span<const FloatBufferLine> samplesIn, const al::span<FloatBufferLine> samplesOut) override;
  24
  25     DEF_NEWDEL(NullState)
  26 };
  27
  28 /* This constructs the effect state. It's called when the object is first
  29  * created.
  30  */
  31 NullState::NullState() = default;
  32
  33 /* This destructs the effect state. It's called only when the effect instance
  34  * is no longer used.
  35  */
  36 NullState::~NullState() = default;
  37
  38 /* This updates the device-dependant effect state. This is called on state
  39  * initialization and any time the device parameters (e.g. playback frequency,
  40  * format) have been changed. Will always be followed by a call to the update
  41  * method, if successful.
  42  */
  43 void NullState::deviceUpdate(const ALCdevice* /*device*/)
  44 {
  45 }
  46
  47 /* This updates the effect state with new properties. This is called any time
  48  * the effect is (re)loaded into a slot.
  49  */
  50 void NullState::update(const ALCcontext* /*context*/, const ALeffectslot* /*slot*/,
  51     const EffectProps* /*props*/, const EffectTarget /*target*/)
  52 {
  53 }
  54
  55 /* This processes the effect state, for the given number of samples from the
  56  * input to the output buffer. The result should be added to the output buffer,
  57  * not replace it.
  58  */
  59 void NullState::process(const size_t/*samplesToDo*/,
  60     const al::span<const FloatBufferLine> /*samplesIn*/,
  61     const al::span<FloatBufferLine> /*samplesOut*/)
  62 {
  63 }
  64
  65
  66 void NullEffect_setParami(EffectProps* /*props*/, ALenum param, int /*val*/)
  67 {
  68     switch(param)
  69     {
  70     default:
  71         throw effect_exception{AL_INVALID_ENUM, "Invalid null effect integer property 0x%04x",
  72             param};
  73     }
  74 }
  75 void NullEffect_setParamiv(EffectProps *props, ALenum param, const int *vals)
  76 {
  77     switch(param)
  78     {
  79     default:
  80         NullEffect_setParami(props, param, vals[0]);
  81     }
  82 }
  83 void NullEffect_setParamf(EffectProps* /*props*/, ALenum param, float /*val*/)
  84 {
  85     switch(param)
  86     {
  87     default:
  88         throw effect_exception{AL_INVALID_ENUM, "Invalid null effect float property 0x%04x",
  89             param};
  90     }
  91 }
  92 void NullEffect_setParamfv(EffectProps *props, ALenum param, const float *vals)
  93 {
  94     switch(param)
  95     {
  96     default:
  97         NullEffect_setParamf(props, param, vals[0]);
  98     }
  99 }
 100
 101 void NullEffect_getParami(const EffectProps* /*props*/, ALenum param, int* /*val*/)
 102 {
 103     switch(param)
 104     {
 105     default:
 106         throw effect_exception{AL_INVALID_ENUM, "Invalid null effect integer property 0x%04x",
 107             param};
 108     }
 109 }
 110 void NullEffect_getParamiv(const EffectProps *props, ALenum param, int *vals)
 111 {
 112     switch(param)
 113     {
 114     default:
 115         NullEffect_getParami(props, param, vals);
 116     }
 117 }
 118 void NullEffect_getParamf(const EffectProps* /*props*/, ALenum param, float* /*val*/)
 119 {
 120     switch(param)
 121     {
 122     default:
 123         throw effect_exception{AL_INVALID_ENUM, "Invalid null effect float property 0x%04x",
 124             param};
 125     }
 126 }
 127 void NullEffect_getParamfv(const EffectProps *props, ALenum param, float *vals)
 128 {
 129     switch(param)
 130     {
 131     default:
 132         NullEffect_getParamf(props, param, vals);
 133     }
 134 }
 135
 136 DEFINE_ALEFFECT_VTABLE(NullEffect);
 137
 138
 139 struct NullStateFactory final : public EffectStateFactory {
 140     EffectState *create() override;
 141     EffectProps getDefaultProps() const noexcept override;
 142     const EffectVtable *getEffectVtable() const noexcept override;
 143 };
 144
 145 /* Creates EffectState objects of the appropriate type. */
 146 EffectState *NullStateFactory::create()
 147 { return new NullState{}; }
 148
 149 /* Returns an ALeffectProps initialized with this effect type's default
 150  * property values.
 151  */
 152 EffectProps NullStateFactory::getDefaultProps() const noexcept
 153 {
 154     EffectProps props{};
 155     return props;
 156 }
 157
 158 /* Returns a pointer to this effect type's global set/get vtable. */
 159 const EffectVtable *NullStateFactory::getEffectVtable() const noexcept
 160 { return &NullEffect_vtable; }
 161
 162 } // namespace
 163
 164 EffectStateFactory *NullStateFactory_getFactory()
 165 {
 166     static NullStateFactory NullFactory{};
 167     return &NullFactory;
 168 }