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     ALboolean 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 ALboolean NullState::deviceUpdate(const ALCdevice* /*device*/)
  44 {
  45     return AL_TRUE;
  46 }
  47
  48 /* This updates the effect state with new properties. This is called any time
  49  * the effect is (re)loaded into a slot.
  50  */
  51 void NullState::update(const ALCcontext* /*context*/, const ALeffectslot* /*slot*/,
  52     const EffectProps* /*props*/, const EffectTarget /*target*/)
  53 {
  54 }
  55
  56 /* This processes the effect state, for the given number of samples from the
  57  * input to the output buffer. The result should be added to the output buffer,
  58  * not replace it.
  59  */
  60 void NullState::process(const size_t/*samplesToDo*/,
  61     const al::span<const FloatBufferLine> /*samplesIn*/,
  62     const al::span<FloatBufferLine> /*samplesOut*/)
  63 {
  64 }
  65
  66
  67 void NullEffect_setParami(EffectProps* /*props*/, ALCcontext *context, ALenum param, ALint /*val*/)
  68 {
  69     switch(param)
  70     {
  71     default:
  72         context->setError(AL_INVALID_ENUM, "Invalid null effect integer property 0x%04x", param);
  73     }
  74 }
  75 void NullEffect_setParamiv(EffectProps *props, ALCcontext *context, ALenum param, const ALint *vals)
  76 {
  77     switch(param)
  78     {
  79     default:
  80         NullEffect_setParami(props, context, param, vals[0]);
  81     }
  82 }
  83 void NullEffect_setParamf(EffectProps* /*props*/, ALCcontext *context, ALenum param, ALfloat /*val*/)
  84 {
  85     switch(param)
  86     {
  87     default:
  88         context->setError(AL_INVALID_ENUM, "Invalid null effect float property 0x%04x", param);
  89     }
  90 }
  91 void NullEffect_setParamfv(EffectProps *props, ALCcontext *context, ALenum param, const ALfloat *vals)
  92 {
  93     switch(param)
  94     {
  95     default:
  96         NullEffect_setParamf(props, context, param, vals[0]);
  97     }
  98 }
  99
 100 void NullEffect_getParami(const EffectProps* /*props*/, ALCcontext *context, ALenum param, ALint* /*val*/)
 101 {
 102     switch(param)
 103     {
 104     default:
 105         context->setError(AL_INVALID_ENUM, "Invalid null effect integer property 0x%04x", param);
 106     }
 107 }
 108 void NullEffect_getParamiv(const EffectProps *props, ALCcontext *context, ALenum param, ALint *vals)
 109 {
 110     switch(param)
 111     {
 112     default:
 113         NullEffect_getParami(props, context, param, vals);
 114     }
 115 }
 116 void NullEffect_getParamf(const EffectProps* /*props*/, ALCcontext *context, ALenum param, ALfloat* /*val*/)
 117 {
 118     switch(param)
 119     {
 120     default:
 121         context->setError(AL_INVALID_ENUM, "Invalid null effect float property 0x%04x", param);
 122     }
 123 }
 124 void NullEffect_getParamfv(const EffectProps *props, ALCcontext *context, ALenum param, ALfloat *vals)
 125 {
 126     switch(param)
 127     {
 128     default:
 129         NullEffect_getParamf(props, context, param, vals);
 130     }
 131 }
 132
 133 DEFINE_ALEFFECT_VTABLE(NullEffect);
 134
 135
 136 struct NullStateFactory final : public EffectStateFactory {
 137     EffectState *create() override;
 138     EffectProps getDefaultProps() const noexcept override;
 139     const EffectVtable *getEffectVtable() const noexcept override;
 140 };
 141
 142 /* Creates EffectState objects of the appropriate type. */
 143 EffectState *NullStateFactory::create()
 144 { return new NullState{}; }
 145
 146 /* Returns an ALeffectProps initialized with this effect type's default
 147  * property values.
 148  */
 149 EffectProps NullStateFactory::getDefaultProps() const noexcept
 150 {
 151     EffectProps props{};
 152     return props;
 153 }
 154
 155 /* Returns a pointer to this effect type's global set/get vtable. */
 156 const EffectVtable *NullStateFactory::getEffectVtable() const noexcept
 157 { return &NullEffect_vtable; }
 158
 159 } // namespace
 160
 161 EffectStateFactory *NullStateFactory_getFactory()
 162 {
 163     static NullStateFactory NullFactory{};
 164     return &NullFactory;
 165 }