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