Alc/effects/modulator.c

   1 /**
   2  * OpenAL cross platform audio library
   3  * Copyright (C) 2009 by Chris Robinson.
   4  * This library is free software; you can redistribute it and/or
   5  *  modify it under the terms of the GNU Library General Public
   6  *  License as published by the Free Software Foundation; either
   7  *  version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  *  Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  *  License along with this library; if not, write to the
  16  *  Free Software Foundation, Inc.,
  17  *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18  * Or go to http://www.gnu.org/copyleft/lgpl.html
  19  */
  20
  21 #include "config.h"
  22
  23 #include <math.h>
  24 #include <stdlib.h>
  25
  26 #include "alMain.h"
  27 #include "alFilter.h"
  28 #include "alAuxEffectSlot.h"
  29 #include "alError.h"
  30 #include "alu.h"
  31
  32
  33 typedef struct ALmodulatorState {
  34     DERIVE_FROM_TYPE(ALeffectState);
  35
  36     enum {
  37         SINUSOID,
  38         SAWTOOTH,
  39         SQUARE
  40     } Waveform;
  41
  42     ALuint index;
  43     ALuint step;
  44
  45     ALfloat Gain[MAX_OUTPUT_CHANNELS];
  46
  47     ALfilterState Filter;
  48 } ALmodulatorState;
  49
  50 #define WAVEFORM_FRACBITS  24
  51 #define WAVEFORM_FRACONE   (1<<WAVEFORM_FRACBITS)
  52 #define WAVEFORM_FRACMASK  (WAVEFORM_FRACONE-1)
  53
  54 static inline ALfloat Sin(ALuint index)
  55 {
  56     return sinf(index*(F_2PI/WAVEFORM_FRACONE) - F_PI)*0.5f + 0.5f;
  57 }
  58
  59 static inline ALfloat Saw(ALuint index)
  60 {
  61     return (ALfloat)index / WAVEFORM_FRACONE;
  62 }
  63
  64 static inline ALfloat Square(ALuint index)
  65 {
  66     return (ALfloat)((index >> (WAVEFORM_FRACBITS - 1)) & 1);
  67 }
  68
  69 #define DECL_TEMPLATE(func)                                                   \
  70 static void Process##func(ALmodulatorState *state, ALuint SamplesToDo,        \
  71   const ALfloat *restrict SamplesIn,                                          \
  72   ALfloat (*restrict SamplesOut)[BUFFERSIZE], ALuint NumChannels)             \
  73 {                                                                             \
  74     const ALuint step = state->step;                                          \
  75     ALuint index = state->index;                                              \
  76     ALuint base;                                                              \
  77                                                                               \
  78     for(base = 0;base < SamplesToDo;)                                         \
  79     {                                                                         \
  80         ALfloat temps[256];                                                   \
  81         ALuint td = minu(256, SamplesToDo-base);                              \
  82         ALuint i, k;                                                          \
  83                                                                               \
  84         for(i = 0;i < td;i++)                                                 \
  85         {                                                                     \
  86             ALfloat samp;                                                     \
  87             samp = SamplesIn[base+i];                                         \
  88             samp = ALfilterState_processSingle(&state->Filter, samp);         \
  89                                                                               \
  90             index += step;                                                    \
  91             index &= WAVEFORM_FRACMASK;                                       \
  92             temps[i] = samp * func(index);                                    \
  93         }                                                                     \
  94                                                                               \
  95         for(k = 0;k < NumChannels;k++)                                        \
  96         {                                                                     \
  97             ALfloat gain = state->Gain[k];                                    \
  98             if(!(fabsf(gain) > GAIN_SILENCE_THRESHOLD))                       \
  99                 continue;                                                     \
 100                                                                               \
 101             for(i = 0;i < td;i++)                                             \
 102                 SamplesOut[k][base+i] += gain * temps[i];                     \
 103         }                                                                     \
 104                                                                               \
 105         base += td;                                                           \
 106     }                                                                         \
 107     state->index = index;                                                     \
 108 }
 109
 110 DECL_TEMPLATE(Sin)
 111 DECL_TEMPLATE(Saw)
 112 DECL_TEMPLATE(Square)
 113
 114 #undef DECL_TEMPLATE
 115
 116
 117 static ALvoid ALmodulatorState_Destruct(ALmodulatorState *UNUSED(state))
 118 {
 119 }
 120
 121 static ALboolean ALmodulatorState_deviceUpdate(ALmodulatorState *UNUSED(state), ALCdevice *UNUSED(device))
 122 {
 123     return AL_TRUE;
 124 }
 125
 126 static ALvoid ALmodulatorState_update(ALmodulatorState *state, ALCdevice *Device, const ALeffectslot *Slot)
 127 {
 128     ALfloat cw, a;
 129
 130     if(Slot->EffectProps.Modulator.Waveform == AL_RING_MODULATOR_SINUSOID)
 131         state->Waveform = SINUSOID;
 132     else if(Slot->EffectProps.Modulator.Waveform == AL_RING_MODULATOR_SAWTOOTH)
 133         state->Waveform = SAWTOOTH;
 134     else if(Slot->EffectProps.Modulator.Waveform == AL_RING_MODULATOR_SQUARE)
 135         state->Waveform = SQUARE;
 136
 137     state->step = fastf2u(Slot->EffectProps.Modulator.Frequency*WAVEFORM_FRACONE /
 138                           Device->Frequency);
 139     if(state->step == 0) state->step = 1;
 140
 141     /* Custom filter coeffs, which match the old version instead of a low-shelf. */
 142     cw = cosf(F_2PI * Slot->EffectProps.Modulator.HighPassCutoff / Device->Frequency);
 143     a = (2.0f-cw) - sqrtf(powf(2.0f-cw, 2.0f) - 1.0f);
 144
 145     state->Filter.b[0] = a;
 146     state->Filter.b[1] = -a;
 147     state->Filter.b[2] = 0.0f;
 148     state->Filter.a[0] = 1.0f;
 149     state->Filter.a[1] = -a;
 150     state->Filter.a[2] = 0.0f;
 151
 152     ComputeAmbientGains(Device, Slot->Gain, state->Gain);
 153 }
 154
 155 static ALvoid ALmodulatorState_process(ALmodulatorState *state, ALuint SamplesToDo, const ALfloat *restrict SamplesIn, ALfloat (*restrict SamplesOut)[BUFFERSIZE], ALuint NumChannels)
 156 {
 157     switch(state->Waveform)
 158     {
 159         case SINUSOID:
 160             ProcessSin(state, SamplesToDo, SamplesIn, SamplesOut, NumChannels);
 161             break;
 162
 163         case SAWTOOTH:
 164             ProcessSaw(state, SamplesToDo, SamplesIn, SamplesOut, NumChannels);
 165             break;
 166
 167         case SQUARE:
 168             ProcessSquare(state, SamplesToDo, SamplesIn, SamplesOut, NumChannels);
 169             break;
 170     }
 171 }
 172
 173 DECLARE_DEFAULT_ALLOCATORS(ALmodulatorState)
 174
 175 DEFINE_ALEFFECTSTATE_VTABLE(ALmodulatorState);
 176
 177
 178 typedef struct ALmodulatorStateFactory {
 179     DERIVE_FROM_TYPE(ALeffectStateFactory);
 180 } ALmodulatorStateFactory;
 181
 182 static ALeffectState *ALmodulatorStateFactory_create(ALmodulatorStateFactory *UNUSED(factory))
 183 {
 184     ALmodulatorState *state;
 185
 186     state = ALmodulatorState_New(sizeof(*state));
 187     if(!state) return NULL;
 188     SET_VTABLE2(ALmodulatorState, ALeffectState, state);
 189
 190     state->index = 0;
 191     state->step = 1;
 192
 193     ALfilterState_clear(&state->Filter);
 194
 195     return STATIC_CAST(ALeffectState, state);
 196 }
 197
 198 DEFINE_ALEFFECTSTATEFACTORY_VTABLE(ALmodulatorStateFactory);
 199
 200 ALeffectStateFactory *ALmodulatorStateFactory_getFactory(void)
 201 {
 202     static ALmodulatorStateFactory ModulatorFactory = { { GET_VTABLE2(ALmodulatorStateFactory, ALeffectStateFactory) } };
 203
 204     return STATIC_CAST(ALeffectStateFactory, &ModulatorFactory);
 205 }
 206
 207
 208 void ALmodulator_setParamf(ALeffect *effect, ALCcontext *context, ALenum param, ALfloat val)
 209 {
 210     ALeffectProps *props = &effect->Props;
 211     switch(param)
 212     {
 213         case AL_RING_MODULATOR_FREQUENCY:
 214             if(!(val >= AL_RING_MODULATOR_MIN_FREQUENCY && val <= AL_RING_MODULATOR_MAX_FREQUENCY))
 215                 SET_ERROR_AND_RETURN(context, AL_INVALID_VALUE);
 216             props->Modulator.Frequency = val;
 217             break;
 218
 219         case AL_RING_MODULATOR_HIGHPASS_CUTOFF:
 220             if(!(val >= AL_RING_MODULATOR_MIN_HIGHPASS_CUTOFF && val <= AL_RING_MODULATOR_MAX_HIGHPASS_CUTOFF))
 221                 SET_ERROR_AND_RETURN(context, AL_INVALID_VALUE);
 222             props->Modulator.HighPassCutoff = val;
 223             break;
 224
 225         default:
 226             SET_ERROR_AND_RETURN(context, AL_INVALID_ENUM);
 227     }
 228 }
 229 void ALmodulator_setParamfv(ALeffect *effect, ALCcontext *context, ALenum param, const ALfloat *vals)
 230 {
 231     ALmodulator_setParamf(effect, context, param, vals[0]);
 232 }
 233 void ALmodulator_setParami(ALeffect *effect, ALCcontext *context, ALenum param, ALint val)
 234 {
 235     ALeffectProps *props = &effect->Props;
 236     switch(param)
 237     {
 238         case AL_RING_MODULATOR_FREQUENCY:
 239         case AL_RING_MODULATOR_HIGHPASS_CUTOFF:
 240             ALmodulator_setParamf(effect, context, param, (ALfloat)val);
 241             break;
 242
 243         case AL_RING_MODULATOR_WAVEFORM:
 244             if(!(val >= AL_RING_MODULATOR_MIN_WAVEFORM && val <= AL_RING_MODULATOR_MAX_WAVEFORM))
 245                 SET_ERROR_AND_RETURN(context, AL_INVALID_VALUE);
 246             props->Modulator.Waveform = val;
 247             break;
 248
 249         default:
 250             SET_ERROR_AND_RETURN(context, AL_INVALID_ENUM);
 251     }
 252 }
 253 void ALmodulator_setParamiv(ALeffect *effect, ALCcontext *context, ALenum param, const ALint *vals)
 254 {
 255     ALmodulator_setParami(effect, context, param, vals[0]);
 256 }
 257
 258 void ALmodulator_getParami(const ALeffect *effect, ALCcontext *context, ALenum param, ALint *val)
 259 {
 260     const ALeffectProps *props = &effect->Props;
 261     switch(param)
 262     {
 263         case AL_RING_MODULATOR_FREQUENCY:
 264             *val = (ALint)props->Modulator.Frequency;
 265             break;
 266         case AL_RING_MODULATOR_HIGHPASS_CUTOFF:
 267             *val = (ALint)props->Modulator.HighPassCutoff;
 268             break;
 269         case AL_RING_MODULATOR_WAVEFORM:
 270             *val = props->Modulator.Waveform;
 271             break;
 272
 273         default:
 274             SET_ERROR_AND_RETURN(context, AL_INVALID_ENUM);
 275     }
 276 }
 277 void ALmodulator_getParamiv(const ALeffect *effect, ALCcontext *context, ALenum param, ALint *vals)
 278 {
 279     ALmodulator_getParami(effect, context, param, vals);
 280 }
 281 void ALmodulator_getParamf(const ALeffect *effect, ALCcontext *context, ALenum param, ALfloat *val)
 282 {
 283     const ALeffectProps *props = &effect->Props;
 284     switch(param)
 285     {
 286         case AL_RING_MODULATOR_FREQUENCY:
 287             *val = props->Modulator.Frequency;
 288             break;
 289         case AL_RING_MODULATOR_HIGHPASS_CUTOFF:
 290             *val = props->Modulator.HighPassCutoff;
 291             break;
 292
 293         default:
 294             SET_ERROR_AND_RETURN(context, AL_INVALID_ENUM);
 295     }
 296 }
 297 void ALmodulator_getParamfv(const ALeffect *effect, ALCcontext *context, ALenum param, ALfloat *vals)
 298 {
 299     ALmodulator_getParamf(effect, context, param, vals);
 300 }
 301
 302 DEFINE_ALEFFECT_VTABLE(ALmodulator);