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 "alAuxEffectSlot.h"
  28 #include "alError.h"
  29 #include "alu.h"
  30 #include "filters/defs.h"
  31
  32
  33 #define MAX_UPDATE_SAMPLES 128
  34
  35 typedef struct ALmodulatorState {
  36     DERIVE_FROM_TYPE(ALeffectState);
  37
  38     void (*GetSamples)(ALfloat*, ALsizei, const ALsizei, ALsizei);
  39
  40     ALsizei index;
  41     ALsizei step;
  42
  43     alignas(16) ALfloat ModSamples[MAX_UPDATE_SAMPLES];
  44
  45     struct {
  46         ALfilterState Filter;
  47
  48         ALfloat CurrentGains[MAX_OUTPUT_CHANNELS];
  49         ALfloat TargetGains[MAX_OUTPUT_CHANNELS];
  50     } Chans[MAX_EFFECT_CHANNELS];
  51 } ALmodulatorState;
  52
  53 static ALvoid ALmodulatorState_Destruct(ALmodulatorState *state);
  54 static ALboolean ALmodulatorState_deviceUpdate(ALmodulatorState *state, ALCdevice *device);
  55 static ALvoid ALmodulatorState_update(ALmodulatorState *state, const ALCcontext *context, const ALeffectslot *slot, const ALeffectProps *props);
  56 static ALvoid ALmodulatorState_process(ALmodulatorState *state, ALsizei SamplesToDo, const ALfloat (*restrict SamplesIn)[BUFFERSIZE], ALfloat (*restrict SamplesOut)[BUFFERSIZE], ALsizei NumChannels);
  57 DECLARE_DEFAULT_ALLOCATORS(ALmodulatorState)
  58
  59 DEFINE_ALEFFECTSTATE_VTABLE(ALmodulatorState);
  60
  61
  62 #define WAVEFORM_FRACBITS  24
  63 #define WAVEFORM_FRACONE   (1<<WAVEFORM_FRACBITS)
  64 #define WAVEFORM_FRACMASK  (WAVEFORM_FRACONE-1)
  65
  66 static inline ALfloat Sin(ALsizei index)
  67 {
  68     return sinf(index*(F_TAU/WAVEFORM_FRACONE) - F_PI)*0.5f + 0.5f;
  69 }
  70
  71 static inline ALfloat Saw(ALsizei index)
  72 {
  73     return (ALfloat)index / WAVEFORM_FRACONE;
  74 }
  75
  76 static inline ALfloat Square(ALsizei index)
  77 {
  78     return (ALfloat)((index >> (WAVEFORM_FRACBITS - 1)) & 1);
  79 }
  80
  81 #define DECL_TEMPLATE(func)                                                   \
  82 static void Modulate##func(ALfloat *restrict dst, ALsizei index,              \
  83                            const ALsizei step, ALsizei todo)                  \
  84 {                                                                             \
  85     ALsizei i;                                                                \
  86     for(i = 0;i < todo;i++)                                                   \
  87     {                                                                         \
  88         index += step;                                                        \
  89         index &= WAVEFORM_FRACMASK;                                           \
  90         dst[i] = func(index);                                                 \
  91     }                                                                         \
  92 }
  93
  94 DECL_TEMPLATE(Sin)
  95 DECL_TEMPLATE(Saw)
  96 DECL_TEMPLATE(Square)
  97
  98 #undef DECL_TEMPLATE
  99
 100
 101 static void ALmodulatorState_Construct(ALmodulatorState *state)
 102 {
 103     ALeffectState_Construct(STATIC_CAST(ALeffectState, state));
 104     SET_VTABLE2(ALmodulatorState, ALeffectState, state);
 105
 106     state->index = 0;
 107     state->step = 1;
 108 }
 109
 110 static ALvoid ALmodulatorState_Destruct(ALmodulatorState *state)
 111 {
 112     ALeffectState_Destruct(STATIC_CAST(ALeffectState,state));
 113 }
 114
 115 static ALboolean ALmodulatorState_deviceUpdate(ALmodulatorState *state, ALCdevice *UNUSED(device))
 116 {
 117     ALsizei i, j;
 118     for(i = 0;i < MAX_EFFECT_CHANNELS;i++)
 119     {
 120         ALfilterState_clear(&state->Chans[i].Filter);
 121         for(j = 0;j < MAX_OUTPUT_CHANNELS;j++)
 122             state->Chans[i].CurrentGains[j] = 0.0f;
 123     }
 124     return AL_TRUE;
 125 }
 126
 127 static ALvoid ALmodulatorState_update(ALmodulatorState *state, const ALCcontext *context, const ALeffectslot *slot, const ALeffectProps *props)
 128 {
 129     const ALCdevice *device = context->Device;
 130     ALfloat cw, a;
 131     ALsizei i;
 132
 133     if(props->Modulator.Waveform == AL_RING_MODULATOR_SINUSOID)
 134         state->GetSamples = ModulateSin;
 135     else if(props->Modulator.Waveform == AL_RING_MODULATOR_SAWTOOTH)
 136         state->GetSamples = ModulateSaw;
 137     else /*if(Slot->Params.EffectProps.Modulator.Waveform == AL_RING_MODULATOR_SQUARE)*/
 138         state->GetSamples = ModulateSquare;
 139
 140     state->step = fastf2i(props->Modulator.Frequency*WAVEFORM_FRACONE /
 141                           device->Frequency);
 142     state->step = clampi(state->step, 1, WAVEFORM_FRACONE-1);
 143
 144     /* Custom filter coeffs, which match the old version instead of a low-shelf. */
 145     cw = cosf(F_TAU * props->Modulator.HighPassCutoff / device->Frequency);
 146     a = (2.0f-cw) - sqrtf(powf(2.0f-cw, 2.0f) - 1.0f);
 147
 148     state->Chans[0].Filter.b0 = a;
 149     state->Chans[0].Filter.b1 = -a;
 150     state->Chans[0].Filter.b2 = 0.0f;
 151     state->Chans[0].Filter.a1 = -a;
 152     state->Chans[0].Filter.a2 = 0.0f;
 153     for(i = 1;i < MAX_EFFECT_CHANNELS;i++)
 154         ALfilterState_copyParams(&state->Chans[i].Filter, &state->Chans[0].Filter);
 155
 156     STATIC_CAST(ALeffectState,state)->OutBuffer = device->FOAOut.Buffer;
 157     STATIC_CAST(ALeffectState,state)->OutChannels = device->FOAOut.NumChannels;
 158     for(i = 0;i < MAX_EFFECT_CHANNELS;i++)
 159         ComputeFirstOrderGains(&device->FOAOut, IdentityMatrixf.m[i],
 160                                slot->Params.Gain, state->Chans[i].TargetGains);
 161 }
 162
 163 static ALvoid ALmodulatorState_process(ALmodulatorState *state, ALsizei SamplesToDo, const ALfloat (*restrict SamplesIn)[BUFFERSIZE], ALfloat (*restrict SamplesOut)[BUFFERSIZE], ALsizei NumChannels)
 164 {
 165     ALfloat *restrict modsamples = ASSUME_ALIGNED(state->ModSamples, 16);
 166     const ALsizei step = state->step;
 167     ALsizei base;
 168
 169     for(base = 0;base < SamplesToDo;)
 170     {
 171         alignas(16) ALfloat temps[2][MAX_UPDATE_SAMPLES];
 172         ALsizei td = mini(MAX_UPDATE_SAMPLES, SamplesToDo-base);
 173         ALsizei c, i;
 174
 175         state->GetSamples(modsamples, state->index, step, td);
 176         state->index += (step*td) & WAVEFORM_FRACMASK;
 177         state->index &= WAVEFORM_FRACMASK;
 178
 179         for(c = 0;c < MAX_EFFECT_CHANNELS;c++)
 180         {
 181             ALfilterState_process(&state->Chans[c].Filter, temps[0], &SamplesIn[c][base], td);
 182             for(i = 0;i < td;i++)
 183                 temps[1][i] = temps[0][i] * modsamples[i];
 184
 185             MixSamples(temps[1], NumChannels, SamplesOut, state->Chans[c].CurrentGains,
 186                        state->Chans[c].TargetGains, SamplesToDo-base, base, td);
 187         }
 188
 189         base += td;
 190     }
 191 }
 192
 193
 194 typedef struct ModulatorStateFactory {
 195     DERIVE_FROM_TYPE(EffectStateFactory);
 196 } ModulatorStateFactory;
 197
 198 static ALeffectState *ModulatorStateFactory_create(ModulatorStateFactory *UNUSED(factory))
 199 {
 200     ALmodulatorState *state;
 201
 202     NEW_OBJ0(state, ALmodulatorState)();
 203     if(!state) return NULL;
 204
 205     return STATIC_CAST(ALeffectState, state);
 206 }
 207
 208 DEFINE_EFFECTSTATEFACTORY_VTABLE(ModulatorStateFactory);
 209
 210 EffectStateFactory *ModulatorStateFactory_getFactory(void)
 211 {
 212     static ModulatorStateFactory ModulatorFactory = { { GET_VTABLE2(ModulatorStateFactory, EffectStateFactory) } };
 213
 214     return STATIC_CAST(EffectStateFactory, &ModulatorFactory);
 215 }
 216
 217
 218 void ALmodulator_setParamf(ALeffect *effect, ALCcontext *context, ALenum param, ALfloat val)
 219 {
 220     ALeffectProps *props = &effect->Props;
 221     switch(param)
 222     {
 223         case AL_RING_MODULATOR_FREQUENCY:
 224             if(!(val >= AL_RING_MODULATOR_MIN_FREQUENCY && val <= AL_RING_MODULATOR_MAX_FREQUENCY))
 225                 SETERR_RETURN(context, AL_INVALID_VALUE,, "Modulator frequency out of range");
 226             props->Modulator.Frequency = val;
 227             break;
 228
 229         case AL_RING_MODULATOR_HIGHPASS_CUTOFF:
 230             if(!(val >= AL_RING_MODULATOR_MIN_HIGHPASS_CUTOFF && val <= AL_RING_MODULATOR_MAX_HIGHPASS_CUTOFF))
 231                 SETERR_RETURN(context, AL_INVALID_VALUE,, "Modulator high-pass cutoff out of range");
 232             props->Modulator.HighPassCutoff = val;
 233             break;
 234
 235         default:
 236             alSetError(context, AL_INVALID_ENUM, "Invalid modulator float property 0x%04x", param);
 237     }
 238 }
 239 void ALmodulator_setParamfv(ALeffect *effect, ALCcontext *context, ALenum param, const ALfloat *vals)
 240 { ALmodulator_setParamf(effect, context, param, vals[0]); }
 241 void ALmodulator_setParami(ALeffect *effect, ALCcontext *context, ALenum param, ALint val)
 242 {
 243     ALeffectProps *props = &effect->Props;
 244     switch(param)
 245     {
 246         case AL_RING_MODULATOR_FREQUENCY:
 247         case AL_RING_MODULATOR_HIGHPASS_CUTOFF:
 248             ALmodulator_setParamf(effect, context, param, (ALfloat)val);
 249             break;
 250
 251         case AL_RING_MODULATOR_WAVEFORM:
 252             if(!(val >= AL_RING_MODULATOR_MIN_WAVEFORM && val <= AL_RING_MODULATOR_MAX_WAVEFORM))
 253                 SETERR_RETURN(context, AL_INVALID_VALUE,, "Invalid modulator waveform");
 254             props->Modulator.Waveform = val;
 255             break;
 256
 257         default:
 258             alSetError(context, AL_INVALID_ENUM, "Invalid modulator integer property 0x%04x", param);
 259     }
 260 }
 261 void ALmodulator_setParamiv(ALeffect *effect, ALCcontext *context, ALenum param, const ALint *vals)
 262 { ALmodulator_setParami(effect, context, param, vals[0]); }
 263
 264 void ALmodulator_getParami(const ALeffect *effect, ALCcontext *context, ALenum param, ALint *val)
 265 {
 266     const ALeffectProps *props = &effect->Props;
 267     switch(param)
 268     {
 269         case AL_RING_MODULATOR_FREQUENCY:
 270             *val = (ALint)props->Modulator.Frequency;
 271             break;
 272         case AL_RING_MODULATOR_HIGHPASS_CUTOFF:
 273             *val = (ALint)props->Modulator.HighPassCutoff;
 274             break;
 275         case AL_RING_MODULATOR_WAVEFORM:
 276             *val = props->Modulator.Waveform;
 277             break;
 278
 279         default:
 280             alSetError(context, AL_INVALID_ENUM, "Invalid modulator integer property 0x%04x", param);
 281     }
 282 }
 283 void ALmodulator_getParamiv(const ALeffect *effect, ALCcontext *context, ALenum param, ALint *vals)
 284 { ALmodulator_getParami(effect, context, param, vals); }
 285 void ALmodulator_getParamf(const ALeffect *effect, ALCcontext *context, ALenum param, ALfloat *val)
 286 {
 287     const ALeffectProps *props = &effect->Props;
 288     switch(param)
 289     {
 290         case AL_RING_MODULATOR_FREQUENCY:
 291             *val = props->Modulator.Frequency;
 292             break;
 293         case AL_RING_MODULATOR_HIGHPASS_CUTOFF:
 294             *val = props->Modulator.HighPassCutoff;
 295             break;
 296
 297         default:
 298             alSetError(context, AL_INVALID_ENUM, "Invalid modulator float property 0x%04x", param);
 299     }
 300 }
 301 void ALmodulator_getParamfv(const ALeffect *effect, ALCcontext *context, ALenum param, ALfloat *vals)
 302 { ALmodulator_getParamf(effect, context, param, vals); }
 303
 304 DEFINE_ALEFFECT_VTABLE(ALmodulator);