1 | /* -*- mode: C; tab-width:8; c-basic-offset:8 -*- |
---|
2 | * vi:set ts=8: |
---|
3 | * |
---|
4 | * al_filter.h |
---|
5 | * |
---|
6 | * Prototypes, macros and definitions related to the application of filters. |
---|
7 | * |
---|
8 | */ |
---|
9 | #ifndef _AL_FILTER_H_ |
---|
10 | #define _AL_FILTER_H_ |
---|
11 | |
---|
12 | #include "al_siteconfig.h" |
---|
13 | |
---|
14 | #include <AL/al.h> |
---|
15 | |
---|
16 | #include "al_types.h" |
---|
17 | |
---|
18 | /* |
---|
19 | * Initialize data structures needed for the management of time-domain |
---|
20 | * filters. |
---|
21 | */ |
---|
22 | void _alInitTimeFilters( time_filter_set *tf_ptr_ref ); |
---|
23 | |
---|
24 | /* |
---|
25 | * Apply all filters for the source specified by sid in the context specified |
---|
26 | * by cid. |
---|
27 | */ |
---|
28 | void _alApplyFilters( ALuint cid, ALuint sid ); |
---|
29 | |
---|
30 | /* |
---|
31 | * Destroy all filter data structures allocated. |
---|
32 | */ |
---|
33 | void _alDestroyFilters( void ); |
---|
34 | |
---|
35 | /* |
---|
36 | * time domain filters |
---|
37 | */ |
---|
38 | |
---|
39 | /* |
---|
40 | * Reverb filter. Not well defined. |
---|
41 | */ |
---|
42 | time_filter alf_reverb; |
---|
43 | |
---|
44 | /* |
---|
45 | * Coning filter. Carries out the coning attenuation specified by |
---|
46 | * AL_CONE_INNER_ANGLE, AL_CONE_OUTER_ANGLE, and AL_CONE_OUTER_GAIN. Closely |
---|
47 | * related to alf_da ( the distance attenuation filter ), but they are |
---|
48 | * mutually exclusive. |
---|
49 | */ |
---|
50 | time_filter alf_coning; |
---|
51 | |
---|
52 | /* |
---|
53 | * Distance attenuation filter. Applies distance-model specific attenuation |
---|
54 | * to a source. |
---|
55 | */ |
---|
56 | time_filter alf_da; |
---|
57 | |
---|
58 | /* |
---|
59 | * Pitch filter. Applies a pitch shift ( in the time domain ) to a source. |
---|
60 | */ |
---|
61 | time_filter alf_tpitch; |
---|
62 | |
---|
63 | /* |
---|
64 | * Doppler filter. Applies a doppler shift ( in the time domain ) to a source. |
---|
65 | */ |
---|
66 | time_filter alf_tdoppler; |
---|
67 | |
---|
68 | /* |
---|
69 | * Clamps a source at its min/max gain settings, specified by AL_MIN_GAIN and |
---|
70 | * AL_MAX_GAIN. |
---|
71 | */ |
---|
72 | time_filter alf_minmax; |
---|
73 | |
---|
74 | /* |
---|
75 | * Panning filter. |
---|
76 | */ |
---|
77 | time_filter alf_panning; |
---|
78 | |
---|
79 | /* |
---|
80 | * Applies the listener gain to a source. |
---|
81 | */ |
---|
82 | time_filter alf_listenergain; |
---|
83 | |
---|
84 | /* macros */ |
---|
85 | #define _alDCApplyFilters(s) _alApplyFilters(_alcCCId, s) |
---|
86 | |
---|
87 | #endif /* AL_FILTER_H_ */ |
---|