AuroraOpenALSoft/OpenAL32/Include/alAuxEffectSlot.h

#ifndef _AL_AUXEFFECTSLOT_H_
#define _AL_AUXEFFECTSLOT_H_

#include "alMain.h"
#include "alEffect.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct ALeffectState {
    ALvoid (*Destroy)(struct ALeffectState *State);
    ALboolean (*DeviceUpdate)(struct ALeffectState *State, ALCdevice *Device);
    ALvoid (*Update)(struct ALeffectState *State, ALCdevice *Device, const struct ALeffectslot *Slot);
    ALvoid (*Process)(struct ALeffectState *State, ALuint SamplesToDo, const ALfloat *RESTRICT SamplesIn, ALfloat (*RESTRICT SamplesOut)[BUFFERSIZE]);
} ALeffectState;


typedef struct ALeffectslot
{
    ALeffect effect;

    volatile ALfloat   Gain;
    volatile ALboolean AuxSendAuto;

    volatile ALenum NeedsUpdate;
    ALeffectState *EffectState;

    ALIGN(16) ALfloat WetBuffer[1][BUFFERSIZE];

    ALfloat ClickRemoval[1];
    ALfloat PendingClicks[1];

    RefCount ref;

    /* Self ID */
    ALuint id;
} ALeffectslot;


ALenum InitEffectSlot(ALeffectslot *slot);
ALvoid ReleaseALAuxiliaryEffectSlots(ALCcontext *Context);

ALeffectState *NoneCreate(void);
ALeffectState *ReverbCreate(void);
ALeffectState *EchoCreate(void);
ALeffectState *ModulatorCreate(void);
ALeffectState *DedicatedCreate(void);
ALeffectState *ChorusCreate(void);
ALeffectState *FlangerCreate(void);
ALeffectState *EqualizerCreate(void);
ALeffectState *DistortionCreate(void);

#define ALeffectState_Destroy(a)        ((a)->Destroy((a)))
#define ALeffectState_DeviceUpdate(a,b) ((a)->DeviceUpdate((a),(b)))
#define ALeffectState_Update(a,b,c)     ((a)->Update((a),(b),(c)))
#define ALeffectState_Process(a,b,c,d)  ((a)->Process((a),(b),(c),(d)))

ALenum InitializeEffect(ALCdevice *Device, ALeffectslot *EffectSlot, ALeffect *effect);

#ifdef __cplusplus
}
#endif

#endif
Add auxiliary effect slot function skeletons 2007-12-18 01:43:19 +00:00			`#ifndef _AL_AUXEFFECTSLOT_H_`
			`#define _AL_AUXEFFECTSLOT_H_`

Fix up some more header includes 2012-09-14 09:42:36 +00:00			`#include "alMain.h"`
Implement yet another low-pass filter This one using the Butterworth IIR filter design 2008-07-26 02:31:12 +00:00			`#include "alEffect.h"`
Add auxiliary effect slot function skeletons 2007-12-18 01:43:19 +00:00
			`#ifdef __cplusplus`
			`extern "C" {`
			`#endif`

Fix up some more header includes 2012-09-14 09:42:36 +00:00			`typedef struct ALeffectState {`
			`ALvoid (Destroy)(struct ALeffectState State);`
			`ALboolean (DeviceUpdate)(struct ALeffectState State, ALCdevice *Device);`
			`ALvoid (Update)(struct ALeffectState State, ALCdevice Device, const struct ALeffectslot Slot);`
Add the RESTRICT keyword to a function pointer definition's parameters 2012-10-25 21:52:09 +00:00			`ALvoid (Process)(struct ALeffectState State, ALuint SamplesToDo, const ALfloat RESTRICT SamplesIn, ALfloat (RESTRICT SamplesOut)[BUFFERSIZE]);`
Fix up some more header includes 2012-09-14 09:42:36 +00:00			`} ALeffectState;`

Don't expose effect-specific structures 2009-05-29 20:30:50 +00:00
Don't append _struct to the effect slot struct name 2008-01-16 00:01:27 +00:00			`typedef struct ALeffectslot`
Add auxiliary effect slot function skeletons 2007-12-18 01:43:19 +00:00			`{`
Implement AL_EFFECTSLOT_EFFECT property 2007-12-18 22:22:59 +00:00			`ALeffect effect;`

Avoid holding the context lock when setting auxiliary slot properties 2011-09-11 09:01:31 +00:00			`volatile ALfloat Gain;`
			`volatile ALboolean AuxSendAuto;`
Implement AL_EFFECTSLOT_GAIN property 2007-12-18 23:47:24 +00:00
Avoid holding the context lock when setting auxiliary slot properties 2011-09-11 09:01:31 +00:00			`volatile ALenum NeedsUpdate;`
Don't expose effect-specific structures 2009-05-29 20:30:50 +00:00			`ALeffectState *EffectState;`
Implement AL_EFFECT_REVERB Here is a quick description of how the reverb effect works: +--->---+(4) \| V new sample +-----+---+---+ \| \|extra\|ltr\|ref\| <- +(1) +-----+---+---+ (3,5)\| \|(2) +-->\| V out sample 1) Apply master reverb gain to incoming sample and place it at the head of the buffer. The master reverb gainhf was already applied when the source was initially mixed. 2) Copy the delayed reflection sample to an output sample and apply the reflection gain. 3) Apply the late reverb gain to the late reverb sample 4) Copy the end of the buffer, applying a decay gain and the decay hf ratio, and add to the late reverb. 5) Copy the late reverb sample, adding to the output sample. Then the head and sampling points are shifted forward, and done again for each new sample. The extra buffer length is determined by the Reverb Density property. A value of 0 gives a length of 0.1 seconds (long, with fairly distinct echos) , and 1 gives 0.075 seconds (short, indistinct echos). The decay gain is calculated such that after a number of loops to satisfy the Decay Time, a sample will be 1/32768th as powerful (virtually insignificant to the resulting output, and only getting further reduced). It is calculated as: DecayGain = pow(1.0f/32768.0f, 1.0/(DecayTime/ExtraLength)); Things to note: Reverb Diffusion is not currently handled, nor is Decay HF Limit. Decay HF Ratios above 1 probably give incorrect results. Also, this method likely sucks, but it's the best I can come up with before release. :) 2008-01-19 05:25:40 +00:00
Explicitly give the wet buffer 1 channel 2012-09-16 15:27:50 +00:00			`ALIGN(16) ALfloat WetBuffer[1][BUFFERSIZE];`
Move the WetBuffer into the effect slot object This should make it easier to support multiple slots 2009-04-12 00:04:55 +00:00
Add click removal for wet sends 2010-08-15 21:52:12 +00:00			`ALfloat ClickRemoval[1];`
Handle clicks by watching changes between updates 2010-08-16 21:53:21 +00:00			`ALfloat PendingClicks[1];`
Add click removal for wet sends 2010-08-15 21:52:12 +00:00
Use the reference counting functions for the buffer and auxiliary slot refs 2011-08-30 06:05:47 +00:00			`RefCount ref;`
Keep track of references to effect slots, so they aren't deleted while in use 2008-01-16 21:20:09 +00:00
Use a consistent name for the self-id field 2012-04-20 05:28:01 +00:00			`/* Self ID */`
			`ALuint id;`
Add auxiliary effect slot function skeletons 2007-12-18 01:43:19 +00:00			`} ALeffectslot;`


Avoid duplicating some initialization code 2012-01-21 00:23:15 +00:00			`ALenum InitEffectSlot(ALeffectslot *slot);`
Store effect slots in the context 2008-01-16 00:22:39 +00:00			`ALvoid ReleaseALAuxiliaryEffectSlots(ALCcontext *Context);`
Add auxiliary effect slot function skeletons 2007-12-18 01:43:19 +00:00
Handle NULL effect objects as AL_EFFECT_NULL effects 2009-11-06 04:50:56 +00:00			`ALeffectState *NoneCreate(void);`
Combine the reverb effects Updating and processing still differs depending on whether standard or EAX reverb is used or not. The only functional difference should be that the allocated buffer (and subsequent offsets) take into account the modulation and echo times. 2011-09-02 03:06:51 +00:00			`ALeffectState *ReverbCreate(void);`
Be context-agnostic in the effect Create functions This allows the effect Update functions to handle the playback frequency being changed. By default the effects assume a maximum frequency of 192khz, however, it can go higher at the cost of the sample buffers being cleared and the risk of an abort() if reallocation fails 2009-10-19 14:46:53 +00:00			`ALeffectState *EchoCreate(void);`
Implement a skeleton Ring Modulator effect 2010-04-08 15:54:28 +00:00			`ALeffectState *ModulatorCreate(void);`
Combine the dedicated (dialog/LFE) effects 2011-09-02 01:01:14 +00:00			`ALeffectState *DedicatedCreate(void);`
Add Chorus and Flanger effects Code provided by Mike Gorchak 2013-03-14 06:31:12 +00:00			`ALeffectState *ChorusCreate(void);`
			`ALeffectState *FlangerCreate(void);`
Implement distortion and equalizer effects Code provided by Mike Gorchak 2013-05-18 08:33:01 +00:00			`ALeffectState *EqualizerCreate(void);`
			`ALeffectState *DistortionCreate(void);`
Don't expose effect-specific structures 2009-05-29 20:30:50 +00:00
Rename the ALEffect_ macros to ALeffectState_ to reflect what they work on 2011-09-12 12:59:23 +00:00			`#define ALeffectState_Destroy(a) ((a)->Destroy((a)))`
			`#define ALeffectState_DeviceUpdate(a,b) ((a)->DeviceUpdate((a),(b)))`
			`#define ALeffectState_Update(a,b,c) ((a)->Update((a),(b),(c)))`
			`#define ALeffectState_Process(a,b,c,d) ((a)->Process((a),(b),(c),(d)))`
Don't expose effect-specific structures 2009-05-29 20:30:50 +00:00
Pass the device to InitializeEffect and return the error enum from it 2012-03-13 21:58:34 +00:00			`ALenum InitializeEffect(ALCdevice Device, ALeffectslot EffectSlot, ALeffect *effect);`
Don't expose effect-specific structures 2009-05-29 20:30:50 +00:00
Add auxiliary effect slot function skeletons 2007-12-18 01:43:19 +00:00			`#ifdef __cplusplus`
			`}`
			`#endif`

			`#endif`