Load soundfont samples into an ALbuffer
[openal-soft.git] / OpenAL32 / Include / alMain.h
blob734f04949b9915a61cf230db3bb5ed27263c6efc
1 #ifndef AL_MAIN_H
2 #define AL_MAIN_H
4 #include <string.h>
5 #include <stdio.h>
6 #include <stdarg.h>
7 #include <assert.h>
8 #include <math.h>
9 #include <limits.h>
11 #ifdef HAVE_STRINGS_H
12 #include <strings.h>
13 #endif
15 #ifdef HAVE_FENV_H
16 #include <fenv.h>
17 #endif
19 #include "AL/al.h"
20 #include "AL/alc.h"
21 #include "AL/alext.h"
24 #if defined(_WIN64)
25 #define SZFMT "%I64u"
26 #elif defined(_WIN32)
27 #define SZFMT "%u"
28 #else
29 #define SZFMT "%zu"
30 #endif
33 #include "static_assert.h"
34 #include "align.h"
35 #include "atomic.h"
36 #include "uintmap.h"
37 #include "vector.h"
38 #include "alstring.h"
40 #ifndef ALC_SOFT_HRTF
41 #define ALC_SOFT_HRTF 1
42 #define ALC_HRTF_SOFT 0x1992
43 #endif
45 #ifndef ALC_SOFT_midi_interface
46 #define ALC_SOFT_midi_interface 1
47 #define AL_MIDI_CLOCK_SOFT 0x9999
48 #define AL_MIDI_STATE_SOFT 0x9986
49 #define AL_MIDI_GAIN_SOFT 0x9998
50 #define AL_MIDI_PRESET_SOFT 0x9997
51 #define AL_MIDI_BANK_SOFT 0x9996
52 #define AL_SOUNDFONTS_SIZE_SOFT 0x9995
53 #define AL_SOUNDFONTS_SOFT 0x9994
54 #define AL_PRESETS_SIZE_SOFT 0x9993
55 #define AL_PRESETS_SOFT 0x9992
56 #define AL_FONTSOUNDS_SIZE_SOFT 0x9991
57 #define AL_FONTSOUNDS_SOFT 0x9990
59 #define AL_SOURCE0_INPUT_SOFT 0x998F
60 #define AL_SOURCE0_TYPE_SOFT 0x998E
61 #define AL_SOURCE0_FORM_SOFT 0x998D
62 #define AL_SOURCE1_INPUT_SOFT 0x998C
63 #define AL_SOURCE1_TYPE_SOFT 0x998B
64 #define AL_SOURCE1_FORM_SOFT 0x998A
65 #define AL_AMOUNT_SOFT 0x9989
66 #define AL_TRANSFORM_OP_SOFT 0x9988
67 #define AL_DESTINATION_SOFT 0x9987
69 /* Sounce Input */
70 #define AL_ONE_SOFT 0x0080
71 #define AL_NOTEON_VELOCITY_SOFT 0x0082
72 #define AL_NOTEON_KEY_SOFT 0x0083
73 /* AL_KEYPRESSURE_SOFT */
74 /* AL_CHANNELPRESSURE_SOFT */
75 /* AL_PITCHBEND_SOFT */
76 #define AL_PITCHBEND_SENSITIVITY_SOFT 0x0090
77 /* CC 0...127 */
79 /* Source Type */
80 #define AL_UNORM_SOFT 0x0000
81 #define AL_UNORM_REV_SOFT 0x0100
82 #define AL_SNORM_SOFT 0x0200
83 #define AL_SNORM_REV_SOFT 0x0300
85 /* Source Form */
86 #define AL_LINEAR_SOFT 0x0000
87 #define AL_CONCAVE_SOFT 0x0400
88 #define AL_CONVEX_SOFT 0x0800
89 #define AL_SWITCH_SOFT 0x0C00
91 /* Transform op */
92 /* AL_LINEAR_SOFT */
93 #define AL_ABSOLUTE_SOFT 0x0002
95 #define AL_SAMPLE_START_SOFT 0x2000
96 #define AL_SAMPLE_END_SOFT 0x2001
97 #define AL_SAMPLE_LOOP_START_SOFT 0x2002
98 #define AL_SAMPLE_LOOP_END_SOFT 0x2003
99 #define AL_SAMPLE_RATE_SOFT 0x2004
100 #define AL_BASE_KEY_SOFT 0x2005
101 #define AL_KEY_CORRECTION_SOFT 0x2006
102 #define AL_SAMPLE_TYPE_SOFT 0x2007
103 #define AL_FONTSOUND_LINK_SOFT 0x2008
104 #define AL_MOD_LFO_TO_PITCH_SOFT 0x0005
105 #define AL_VIBRATO_LFO_TO_PITCH_SOFT 0x0006
106 #define AL_MOD_ENV_TO_PITCH_SOFT 0x0007
107 #define AL_FILTER_CUTOFF_SOFT 0x0008
108 #define AL_FILTER_RESONANCE_SOFT 0x0009
109 #define AL_MOD_LFO_TO_FILTER_CUTOFF_SOFT 0x000A
110 #define AL_MOD_ENV_TO_FILTER_CUTOFF_SOFT 0x000B
111 #define AL_MOD_LFO_TO_VOLUME_SOFT 0x000D
112 #define AL_CHORUS_SEND_SOFT 0x000F
113 #define AL_REVERB_SEND_SOFT 0x0010
114 #define AL_PAN_SOFT 0x0011
115 #define AL_MOD_LFO_DELAY_SOFT 0x0015
116 #define AL_MOD_LFO_FREQUENCY_SOFT 0x0016
117 #define AL_VIBRATO_LFO_DELAY_SOFT 0x0017
118 #define AL_VIBRATO_LFO_FREQUENCY_SOFT 0x0018
119 #define AL_MOD_ENV_DELAYTIME_SOFT 0x0019
120 #define AL_MOD_ENV_ATTACKTIME_SOFT 0x001A
121 #define AL_MOD_ENV_HOLDTIME_SOFT 0x001B
122 #define AL_MOD_ENV_DECAYTIME_SOFT 0x001C
123 #define AL_MOD_ENV_SUSTAINVOLUME_SOFT 0x001D
124 #define AL_MOD_ENV_RELEASETIME_SOFT 0x002E
125 #define AL_MOD_ENV_KEY_TO_HOLDTIME_SOFT 0x001F
126 #define AL_MOD_ENV_KEY_TO_DECAYTIME_SOFT 0x0020
127 #define AL_VOLUME_ENV_DELAYTIME_SOFT 0x0021
128 #define AL_VOLUME_ENV_ATTACKTIME_SOFT 0x0022
129 #define AL_VOLUME_ENV_HOLDTIME_SOFT 0x0023
130 #define AL_VOLUME_ENV_DECAYTIME_SOFT 0x0024
131 #define AL_VOLUME_ENV_SUSTAINVOLUME_SOFT 0x0025
132 #define AL_VOLUME_ENV_RELEASETIME_SOFT 0x0026
133 #define AL_VOLUME_ENV_KEY_TO_HOLDTIME_SOFT 0x0027
134 #define AL_VOLUME_ENV_KEY_TO_DECAYTIME_SOFT 0x0028
135 #define AL_KEY_RANGE_SOFT 0x002B
136 #define AL_VELOCITY_RANGE_SOFT 0x002C
137 #define AL_ATTENUATION_SOFT 0x0030
138 #define AL_TUNING_COARSE_SOFT 0x0033
139 #define AL_TUNING_FINE_SOFT 0x0034
140 #define AL_LOOP_MODE_SOFT 0x0036
141 #define AL_TUNING_SCALE_SOFT 0x0038
142 #define AL_EXCLUSIVE_CLASS_SOFT 0x0039
143 #define AL_LOOP_CONTINUOUS_SOFT 0x0001
144 #define AL_LOOP_UNTIL_RELEASE_SOFT 0x0003
145 #define AL_RIGHT_SOFT 0x0002
146 #define AL_LEFT_SOFT 0x0004
147 #define AL_FORMAT_TYPE_SOFT 0x1991
148 #define AL_NOTEOFF_SOFT 0x0080
149 #define AL_NOTEON_SOFT 0x0090
150 #define AL_KEYPRESSURE_SOFT 0x00A0
151 #define AL_CONTROLLERCHANGE_SOFT 0x00B0
152 #define AL_PROGRAMCHANGE_SOFT 0x00C0
153 #define AL_CHANNELPRESSURE_SOFT 0x00D0
154 #define AL_PITCHBEND_SOFT 0x00E0
155 typedef void (AL_APIENTRY*LPALGENSOUNDFONTSSOFT)(ALsizei n, ALuint *ids);
156 typedef void (AL_APIENTRY*LPALDELETESOUNDFONTSSOFT)(ALsizei n, const ALuint *ids);
157 typedef ALboolean (AL_APIENTRY*LPALISSOUNDFONTSOFT)(ALuint id);
158 typedef void (AL_APIENTRY*LPALGETSOUNDFONTIVSOFT)(ALuint id, ALenum param, ALint *values);
159 typedef void (AL_APIENTRY*LPALSOUNDFONTPRESETSSOFT)(ALuint id, ALsizei count, const ALuint *pids);
160 typedef void (AL_APIENTRY*LPALGENPRESETSSOFT)(ALsizei n, ALuint *ids);
161 typedef void (AL_APIENTRY*LPALDELETEPRESETSSOFT)(ALsizei n, const ALuint *ids);
162 typedef ALboolean (AL_APIENTRY*LPALISPRESETSOFT)(ALuint id);
163 typedef void (AL_APIENTRY*LPALPRESETISOFT)(ALuint id, ALenum param, ALint value);
164 typedef void (AL_APIENTRY*LPALPRESETIVSOFT)(ALuint id, ALenum param, const ALint *values);
165 typedef void (AL_APIENTRY*LPALPRESETFONTSOUNDSSOFT)(ALuint id, ALsizei count, const ALuint *fsids);
166 typedef void (AL_APIENTRY*LPALGETPRESETIVSOFT)(ALuint id, ALenum param, ALint *values);
167 typedef void (AL_APIENTRY*LPALGENFONTSOUNDSSOFT)(ALsizei n, ALuint *ids);
168 typedef void (AL_APIENTRY*LPALDELETEFONTSOUNDSSOFT)(ALsizei n, const ALuint *ids);
169 typedef ALboolean (AL_APIENTRY*LPALISFONTSOUNDSOFT)(ALuint id);
170 typedef void (AL_APIENTRY*LPALFONTSOUNDISOFT)(ALuint id, ALenum param, ALint value);
171 typedef void (AL_APIENTRY*LPALFONTSOUND2ISOFT)(ALuint id, ALenum param, ALint value1, ALint value2);
172 typedef void (AL_APIENTRY*LPALFONTSOUNDIVSOFT)(ALuint id, ALenum param, const ALint *values);
173 typedef void (AL_APIENTRY*LPALGETFONTSOUNDIVSOFT)(ALuint id, ALenum param, ALint *values);
174 typedef void (AL_APIENTRY*LPALFONTSOUNDMOFULATORISOFT)(ALuint id, ALsizei stage, ALenum param, ALint value);
175 typedef void (AL_APIENTRY*LPALGETFONTSOUNDMODULATORIVSOFT)(ALuint id, ALsizei stage, ALenum param, ALint *values);
176 typedef void (AL_APIENTRY*LPALMIDISOUNDFONTSOFT)(ALuint id);
177 typedef void (AL_APIENTRY*LPALMIDISOUNDFONTVSOFT)(ALsizei count, const ALuint *ids);
178 typedef void (AL_APIENTRY*LPALMIDIEVENTSOFT)(ALuint64SOFT time, ALenum event, ALsizei channel, ALsizei param1, ALsizei param2);
179 typedef void (AL_APIENTRY*LPALMIDISYSEXSOFT)(ALuint64SOFT time, const ALbyte *data, ALsizei size);
180 typedef void (AL_APIENTRY*LPALMIDIPLAYSOFT)(void);
181 typedef void (AL_APIENTRY*LPALMIDIPAUSESOFT)(void);
182 typedef void (AL_APIENTRY*LPALMIDISTOPSOFT)(void);
183 typedef void (AL_APIENTRY*LPALMIDIRESETSOFT)(void);
184 typedef void (AL_APIENTRY*LPALMIDIGAINSOFT)(ALfloat value);
185 typedef ALint64SOFT (AL_APIENTRY*LPALGETINTEGER64SOFT)(ALenum pname);
186 typedef void (AL_APIENTRY*LPALGETINTEGER64VSOFT)(ALenum pname, ALint64SOFT *values);
187 typedef void (AL_APIENTRY*LPALLOADSOUNDFONTSOFT)(ALuint id, size_t(*cb)(ALvoid*,size_t,ALvoid*), ALvoid *user);
188 #ifdef AL_ALEXT_PROTOTYPES
189 AL_API void AL_APIENTRY alGenSoundfontsSOFT(ALsizei n, ALuint *ids);
190 AL_API void AL_APIENTRY alDeleteSoundfontsSOFT(ALsizei n, const ALuint *ids);
191 AL_API ALboolean AL_APIENTRY alIsSoundfontSOFT(ALuint id);
192 AL_API void AL_APIENTRY alGetSoundfontivSOFT(ALuint id, ALenum param, ALint *values);
193 AL_API void AL_APIENTRY alSoundfontPresetsSOFT(ALuint id, ALsizei count, const ALuint *pids);
195 AL_API void AL_APIENTRY alGenPresetsSOFT(ALsizei n, ALuint *ids);
196 AL_API void AL_APIENTRY alDeletePresetsSOFT(ALsizei n, const ALuint *ids);
197 AL_API ALboolean AL_APIENTRY alIsPresetSOFT(ALuint id);
198 AL_API void AL_APIENTRY alPresetiSOFT(ALuint id, ALenum param, ALint value);
199 AL_API void AL_APIENTRY alPresetivSOFT(ALuint id, ALenum param, const ALint *values);
200 AL_API void AL_APIENTRY alGetPresetivSOFT(ALuint id, ALenum param, ALint *values);
201 AL_API void AL_APIENTRY alPresetFontsoundsSOFT(ALuint id, ALsizei count, const ALuint *fsids);
203 AL_API void AL_APIENTRY alGenFontsoundsSOFT(ALsizei n, ALuint *ids);
204 AL_API void AL_APIENTRY alDeleteFontsoundsSOFT(ALsizei n, const ALuint *ids);
205 AL_API ALboolean AL_APIENTRY alIsFontsoundSOFT(ALuint id);
206 AL_API void AL_APIENTRY alFontsoundiSOFT(ALuint id, ALenum param, ALint value);
207 AL_API void AL_APIENTRY alFontsound2iSOFT(ALuint id, ALenum param, ALint value1, ALint value2);
208 AL_API void AL_APIENTRY alFontsoundivSOFT(ALuint id, ALenum param, const ALint *values);
209 AL_API void AL_APIENTRY alGetFontsoundivSOFT(ALuint id, ALenum param, ALint *values);
210 AL_API void AL_APIENTRY alFontsoundModulatoriSOFT(ALuint id, ALsizei stage, ALenum param, ALint value);
211 AL_API void AL_APIENTRY alGetFontsoundModulatorivSOFT(ALuint id, ALsizei stage, ALenum param, ALint *values);
213 AL_API void AL_APIENTRY alMidiSoundfontSOFT(ALuint id);
214 AL_API void AL_APIENTRY alMidiSoundfontvSOFT(ALsizei count, const ALuint *ids);
215 AL_API void AL_APIENTRY alMidiEventSOFT(ALuint64SOFT time, ALenum event, ALsizei channel, ALsizei param1, ALsizei param2);
216 AL_API void AL_APIENTRY alMidiSysExSOFT(ALuint64SOFT time, const ALbyte *data, ALsizei size);
217 AL_API void AL_APIENTRY alMidiPlaySOFT(void);
218 AL_API void AL_APIENTRY alMidiPauseSOFT(void);
219 AL_API void AL_APIENTRY alMidiStopSOFT(void);
220 AL_API void AL_APIENTRY alMidiResetSOFT(void);
221 AL_API void AL_APIENTRY alMidiGainSOFT(ALfloat value);
222 AL_API ALint64SOFT AL_APIENTRY alGetInteger64SOFT(ALenum pname);
223 AL_API void AL_APIENTRY alGetInteger64vSOFT(ALenum pname, ALint64SOFT *values);
224 AL_API void AL_APIENTRY alLoadSoundfontSOFT(ALuint id, size_t(*cb)(ALvoid*,size_t,ALvoid*), ALvoid *user);
225 #endif
226 #endif
228 #ifndef ALC_SOFT_pause_device
229 #define ALC_SOFT_pause_device 1
230 typedef void (ALC_APIENTRY*LPALCDEVICEPAUSESOFT)(ALCdevice *device);
231 typedef void (ALC_APIENTRY*LPALCDEVICERESUMESOFT)(ALCdevice *device);
232 #ifdef AL_ALEXT_PROTOTYPES
233 ALC_API void ALC_APIENTRY alcDevicePauseSOFT(ALCdevice *device);
234 ALC_API void ALC_APIENTRY alcDeviceResumeSOFT(ALCdevice *device);
235 #endif
236 #endif
238 #ifndef ALC_SOFT_device_clock
239 #define ALC_SOFT_device_clock 1
240 typedef int64_t ALCint64SOFT;
241 typedef uint64_t ALCuint64SOFT;
242 #define ALC_DEVICE_CLOCK_SOFT 0x1600
243 typedef void (ALC_APIENTRY*LPALCGETINTEGER64VSOFT)(ALCdevice *device, ALCenum pname, ALsizei size, ALCint64SOFT *values);
244 #ifdef AL_ALEXT_PROTOTYPES
245 ALC_API void ALC_APIENTRY alcGetInteger64vSOFT(ALCdevice *device, ALCenum pname, ALsizei size, ALCint64SOFT *values);
246 #endif
247 #endif
249 #ifndef AL_SOFT_MSADPCM
250 #define AL_SOFT_MSADPCM 1
251 #define AL_FORMAT_MONO_MSADPCM_SOFT 0x1302
252 #define AL_FORMAT_STEREO_MSADPCM_SOFT 0x1303
253 #endif
256 #ifdef IN_IDE_PARSER
257 /* KDevelop's parser doesn't recognize the C99-standard restrict keyword, but
258 * recent versions (at least 4.5.1) do recognize GCC's __restrict. */
259 #define restrict __restrict
260 #endif
263 typedef ALint64SOFT ALint64;
264 typedef ALuint64SOFT ALuint64;
266 typedef ptrdiff_t ALintptrEXT;
267 typedef ptrdiff_t ALsizeiptrEXT;
269 #ifndef U64
270 #if defined(_MSC_VER)
271 #define U64(x) ((ALuint64)(x##ui64))
272 #elif SIZEOF_LONG == 8
273 #define U64(x) ((ALuint64)(x##ul))
274 #elif SIZEOF_LONG_LONG == 8
275 #define U64(x) ((ALuint64)(x##ull))
276 #endif
277 #endif
279 #ifndef UINT64_MAX
280 #define UINT64_MAX U64(18446744073709551615)
281 #endif
283 #ifndef UNUSED
284 #if defined(__cplusplus)
285 #define UNUSED(x)
286 #elif defined(__GNUC__)
287 #define UNUSED(x) UNUSED_##x __attribute__((unused))
288 #elif defined(__LCLINT__)
289 #define UNUSED(x) /*@unused@*/ x
290 #else
291 #define UNUSED(x) x
292 #endif
293 #endif
295 #ifdef __GNUC__
296 #define DECL_CONST __attribute__((const))
297 #define DECL_FORMAT(x, y, z) __attribute__((format(x, (y), (z))))
298 #else
299 #define DECL_CONST
300 #define DECL_FORMAT(x, y, z)
301 #endif
303 #if defined(__GNUC__) && defined(__i386__)
304 /* force_align_arg_pointer is required for proper function arguments aligning
305 * when SSE code is used. Some systems (Windows, QNX) do not guarantee our
306 * thread functions will be properly aligned on the stack, even though GCC may
307 * generate code with the assumption that it is. */
308 #define FORCE_ALIGN __attribute__((force_align_arg_pointer))
309 #else
310 #define FORCE_ALIGN
311 #endif
313 #ifdef HAVE_C99_VLA
314 #define DECL_VLA(T, _name, _size) T _name[(_size)]
315 #else
316 #define DECL_VLA(T, _name, _size) T *_name = alloca((_size) * sizeof(T))
317 #endif
319 #ifndef PATH_MAX
320 #ifdef MAX_PATH
321 #define PATH_MAX MAX_PATH
322 #else
323 #define PATH_MAX 4096
324 #endif
325 #endif
328 static const union {
329 ALuint u;
330 ALubyte b[sizeof(ALuint)];
331 } EndianTest = { 1 };
332 #define IS_LITTLE_ENDIAN (EndianTest.b[0] == 1)
334 #define COUNTOF(x) (sizeof((x))/sizeof((x)[0]))
337 #define DERIVE_FROM_TYPE(t) t t##_parent
338 #define STATIC_CAST(to, obj) (&(obj)->to##_parent)
339 #ifdef __GNUC__
340 #define STATIC_UPCAST(to, from, obj) __extension__({ \
341 static_assert(__builtin_types_compatible_p(from, __typeof(*(obj))), \
342 "Invalid upcast object from type"); \
343 (to*)((char*)(obj) - offsetof(to, from##_parent)); \
345 #else
346 #define STATIC_UPCAST(to, from, obj) ((to*)((char*)(obj) - offsetof(to, from##_parent)))
347 #endif
349 #define DECLARE_FORWARD(T1, T2, rettype, func) \
350 rettype T1##_##func(T1 *obj) \
351 { return T2##_##func(STATIC_CAST(T2, obj)); }
353 #define DECLARE_FORWARD1(T1, T2, rettype, func, argtype1) \
354 rettype T1##_##func(T1 *obj, argtype1 a) \
355 { return T2##_##func(STATIC_CAST(T2, obj), a); }
357 #define DECLARE_FORWARD2(T1, T2, rettype, func, argtype1, argtype2) \
358 rettype T1##_##func(T1 *obj, argtype1 a, argtype2 b) \
359 { return T2##_##func(STATIC_CAST(T2, obj), a, b); }
361 #define DECLARE_FORWARD3(T1, T2, rettype, func, argtype1, argtype2, argtype3) \
362 rettype T1##_##func(T1 *obj, argtype1 a, argtype2 b, argtype3 c) \
363 { return T2##_##func(STATIC_CAST(T2, obj), a, b, c); }
366 #define GET_VTABLE1(T1) (&(T1##_vtable))
367 #define GET_VTABLE2(T1, T2) (&(T1##_##T2##_vtable))
369 #define SET_VTABLE1(T1, obj) ((obj)->vtbl = GET_VTABLE1(T1))
370 #define SET_VTABLE2(T1, T2, obj) (STATIC_CAST(T2, obj)->vtbl = GET_VTABLE2(T1, T2))
372 #define DECLARE_THUNK(T1, T2, rettype, func) \
373 static rettype T1##_##T2##_##func(T2 *obj) \
374 { return T1##_##func(STATIC_UPCAST(T1, T2, obj)); }
376 #define DECLARE_THUNK1(T1, T2, rettype, func, argtype1) \
377 static rettype T1##_##T2##_##func(T2 *obj, argtype1 a) \
378 { return T1##_##func(STATIC_UPCAST(T1, T2, obj), a); }
380 #define DECLARE_THUNK2(T1, T2, rettype, func, argtype1, argtype2) \
381 static rettype T1##_##T2##_##func(T2 *obj, argtype1 a, argtype2 b) \
382 { return T1##_##func(STATIC_UPCAST(T1, T2, obj), a, b); }
384 #define DECLARE_THUNK3(T1, T2, rettype, func, argtype1, argtype2, argtype3) \
385 static rettype T1##_##T2##_##func(T2 *obj, argtype1 a, argtype2 b, argtype3 c) \
386 { return T1##_##func(STATIC_UPCAST(T1, T2, obj), a, b, c); }
388 #define DECLARE_DEFAULT_ALLOCATORS(T) \
389 static void* T##_New(size_t size) { return malloc(size); } \
390 static void T##_Delete(void *ptr) { free(ptr); }
392 /* Helper to extract an argument list for VCALL. Not used directly. */
393 #define EXTRACT_VCALL_ARGS(...) __VA_ARGS__))
395 /* Call a "virtual" method on an object, with arguments. */
396 #define V(obj, func) ((obj)->vtbl->func((obj), EXTRACT_VCALL_ARGS
397 /* Call a "virtual" method on an object, with no arguments. */
398 #define V0(obj, func) ((obj)->vtbl->func((obj) EXTRACT_VCALL_ARGS
400 #define DELETE_OBJ(obj) do { \
401 if((obj) != NULL) \
403 V0((obj),Destruct)(); \
404 V0((obj),Delete)(); \
406 } while(0)
409 #ifdef __cplusplus
410 extern "C" {
411 #endif
413 struct Hrtf;
416 #define DEFAULT_OUTPUT_RATE (44100)
417 #define MIN_OUTPUT_RATE (8000)
420 /* Find the next power-of-2 for non-power-of-2 numbers. */
421 inline ALuint NextPowerOf2(ALuint value)
423 if(value > 0)
425 value--;
426 value |= value>>1;
427 value |= value>>2;
428 value |= value>>4;
429 value |= value>>8;
430 value |= value>>16;
432 return value+1;
435 /* Fast float-to-int conversion. Assumes the FPU is already in round-to-zero
436 * mode. */
437 inline ALint fastf2i(ALfloat f)
439 #ifdef HAVE_LRINTF
440 return lrintf(f);
441 #elif defined(_MSC_VER) && defined(_M_IX86)
442 ALint i;
443 __asm fld f
444 __asm fistp i
445 return i;
446 #else
447 return (ALint)f;
448 #endif
451 /* Fast float-to-uint conversion. Assumes the FPU is already in round-to-zero
452 * mode. */
453 inline ALuint fastf2u(ALfloat f)
454 { return fastf2i(f); }
457 enum DevProbe {
458 ALL_DEVICE_PROBE,
459 CAPTURE_DEVICE_PROBE
462 typedef struct {
463 ALCenum (*OpenPlayback)(ALCdevice*, const ALCchar*);
464 void (*ClosePlayback)(ALCdevice*);
465 ALCboolean (*ResetPlayback)(ALCdevice*);
466 ALCboolean (*StartPlayback)(ALCdevice*);
467 void (*StopPlayback)(ALCdevice*);
469 ALCenum (*OpenCapture)(ALCdevice*, const ALCchar*);
470 void (*CloseCapture)(ALCdevice*);
471 void (*StartCapture)(ALCdevice*);
472 void (*StopCapture)(ALCdevice*);
473 ALCenum (*CaptureSamples)(ALCdevice*, void*, ALCuint);
474 ALCuint (*AvailableSamples)(ALCdevice*);
476 ALint64 (*GetLatency)(ALCdevice*);
477 } BackendFuncs;
479 ALCboolean alc_solaris_init(BackendFuncs *func_list);
480 void alc_solaris_deinit(void);
481 void alc_solaris_probe(enum DevProbe type);
482 ALCboolean alc_sndio_init(BackendFuncs *func_list);
483 void alc_sndio_deinit(void);
484 void alc_sndio_probe(enum DevProbe type);
485 ALCboolean alcWinMMInit(BackendFuncs *FuncList);
486 void alcWinMMDeinit(void);
487 void alcWinMMProbe(enum DevProbe type);
488 ALCboolean alc_pa_init(BackendFuncs *func_list);
489 void alc_pa_deinit(void);
490 void alc_pa_probe(enum DevProbe type);
491 ALCboolean alc_wave_init(BackendFuncs *func_list);
492 void alc_wave_deinit(void);
493 void alc_wave_probe(enum DevProbe type);
494 ALCboolean alc_ca_init(BackendFuncs *func_list);
495 void alc_ca_deinit(void);
496 void alc_ca_probe(enum DevProbe type);
497 ALCboolean alc_opensl_init(BackendFuncs *func_list);
498 void alc_opensl_deinit(void);
499 void alc_opensl_probe(enum DevProbe type);
500 ALCboolean alc_qsa_init(BackendFuncs *func_list);
501 void alc_qsa_deinit(void);
502 void alc_qsa_probe(enum DevProbe type);
504 struct ALCbackend;
507 enum DistanceModel {
508 InverseDistanceClamped = AL_INVERSE_DISTANCE_CLAMPED,
509 LinearDistanceClamped = AL_LINEAR_DISTANCE_CLAMPED,
510 ExponentDistanceClamped = AL_EXPONENT_DISTANCE_CLAMPED,
511 InverseDistance = AL_INVERSE_DISTANCE,
512 LinearDistance = AL_LINEAR_DISTANCE,
513 ExponentDistance = AL_EXPONENT_DISTANCE,
514 DisableDistance = AL_NONE,
516 DefaultDistanceModel = InverseDistanceClamped
519 enum Resampler {
520 PointResampler,
521 LinearResampler,
522 CubicResampler,
524 ResamplerMax,
527 enum Channel {
528 FrontLeft = 0,
529 FrontRight,
530 FrontCenter,
531 LFE,
532 BackLeft,
533 BackRight,
534 BackCenter,
535 SideLeft,
536 SideRight,
538 MaxChannels,
542 /* Device formats */
543 enum DevFmtType {
544 DevFmtByte = ALC_BYTE_SOFT,
545 DevFmtUByte = ALC_UNSIGNED_BYTE_SOFT,
546 DevFmtShort = ALC_SHORT_SOFT,
547 DevFmtUShort = ALC_UNSIGNED_SHORT_SOFT,
548 DevFmtInt = ALC_INT_SOFT,
549 DevFmtUInt = ALC_UNSIGNED_INT_SOFT,
550 DevFmtFloat = ALC_FLOAT_SOFT,
552 DevFmtTypeDefault = DevFmtFloat
554 enum DevFmtChannels {
555 DevFmtMono = ALC_MONO_SOFT,
556 DevFmtStereo = ALC_STEREO_SOFT,
557 DevFmtQuad = ALC_QUAD_SOFT,
558 DevFmtX51 = ALC_5POINT1_SOFT,
559 DevFmtX61 = ALC_6POINT1_SOFT,
560 DevFmtX71 = ALC_7POINT1_SOFT,
562 /* Similar to 5.1, except using the side channels instead of back */
563 DevFmtX51Side = 0x80000000,
565 DevFmtChannelsDefault = DevFmtStereo
568 ALuint BytesFromDevFmt(enum DevFmtType type) DECL_CONST;
569 ALuint ChannelsFromDevFmt(enum DevFmtChannels chans) DECL_CONST;
570 inline ALuint FrameSizeFromDevFmt(enum DevFmtChannels chans, enum DevFmtType type)
572 return ChannelsFromDevFmt(chans) * BytesFromDevFmt(type);
576 extern const struct EffectList {
577 const char *name;
578 int type;
579 const char *ename;
580 ALenum val;
581 } EffectList[];
584 enum DeviceType {
585 Playback,
586 Capture,
587 Loopback
591 /* Size for temporary storage of buffer data, in ALfloats. Larger values need
592 * more memory, while smaller values may need more iterations. The value needs
593 * to be a sensible size, however, as it constrains the max stepping value used
594 * for mixing, as well as the maximum number of samples per mixing iteration.
596 #define BUFFERSIZE (2048u)
599 struct ALCdevice_struct
601 RefCount ref;
603 ALCboolean Connected;
604 enum DeviceType Type;
606 ALuint Frequency;
607 ALuint UpdateSize;
608 ALuint NumUpdates;
609 enum DevFmtChannels FmtChans;
610 enum DevFmtType FmtType;
612 al_string DeviceName;
614 volatile ALCenum LastError;
616 // Maximum number of sources that can be created
617 ALuint MaxNoOfSources;
618 // Maximum number of slots that can be created
619 ALuint AuxiliaryEffectSlotMax;
621 ALCuint NumMonoSources;
622 ALCuint NumStereoSources;
623 ALuint NumAuxSends;
625 // Map of Buffers for this device
626 UIntMap BufferMap;
628 // Map of Effects for this device
629 UIntMap EffectMap;
631 // Map of Filters for this device
632 UIntMap FilterMap;
634 // Map of Soundfonts for this device
635 UIntMap SfontMap;
637 // Map of Presets for this device
638 UIntMap PresetMap;
640 // Map of Fontsounds for this device
641 UIntMap FontsoundMap;
643 /* Default soundfont (accessible as ID 0) */
644 struct ALsoundfont *DefaultSfont;
646 /* MIDI synth engine */
647 struct MidiSynth *Synth;
649 /* HRTF filter tables */
650 const struct Hrtf *Hrtf;
652 // Stereo-to-binaural filter
653 struct bs2b *Bs2b;
654 ALCint Bs2bLevel;
656 // Device flags
657 ALuint Flags;
659 ALuint ChannelOffsets[MaxChannels];
661 enum Channel Speaker2Chan[MaxChannels];
662 ALfloat SpeakerAngle[MaxChannels];
663 ALuint NumChan;
665 ALuint64 ClockBase;
666 ALuint SamplesDone;
668 /* Temp storage used for each source when mixing. */
669 alignas(16) ALfloat SourceData[BUFFERSIZE];
670 alignas(16) ALfloat ResampledData[BUFFERSIZE];
671 alignas(16) ALfloat FilteredData[BUFFERSIZE];
673 // Dry path buffer mix
674 alignas(16) ALfloat DryBuffer[MaxChannels][BUFFERSIZE];
676 /* Running count of the mixer invocations, in 31.1 fixed point. This
677 * actually increments *twice* when mixing, first at the start and then at
678 * the end, so the bottom bit indicates if the device is currently mixing
679 * and the upper bits indicates how many mixes have been done.
681 RefCount MixCount;
683 /* Default effect slot */
684 struct ALeffectslot *DefaultSlot;
686 // Contexts created on this device
687 ALCcontext *volatile ContextList;
689 struct ALCbackend *Backend;
691 void *ExtraData; // For the backend's use
693 ALCdevice *volatile next;
695 /* Memory space used by the default slot (Playback devices only) */
696 alignas(16) ALCbyte _slot_mem[];
699 // Frequency was requested by the app or config file
700 #define DEVICE_FREQUENCY_REQUEST (1<<1)
701 // Channel configuration was requested by the config file
702 #define DEVICE_CHANNELS_REQUEST (1<<2)
703 // Sample type was requested by the config file
704 #define DEVICE_SAMPLE_TYPE_REQUEST (1<<3)
705 // HRTF was requested by the app
706 #define DEVICE_HRTF_REQUEST (1<<4)
708 // Stereo sources cover 120-degree angles around +/-90
709 #define DEVICE_WIDE_STEREO (1<<16)
711 // Specifies if the DSP is paused at user request
712 #define DEVICE_PAUSED (1<<30)
714 // Specifies if the device is currently running
715 #define DEVICE_RUNNING (1<<31)
717 /* Invalid channel offset */
718 #define INVALID_OFFSET (~0u)
721 /* Nanosecond resolution for the device clock time. */
722 #define DEVICE_CLOCK_RES U64(1000000000)
725 /* Must be less than 15 characters (16 including terminating null) for
726 * compatibility with pthread_setname_np limitations. */
727 #define MIXER_THREAD_NAME "alsoft-mixer"
730 typedef struct ALeffectslot *ALeffectslotPtr;
731 DECL_VECTOR(ALeffectslotPtr)
734 struct ALCcontext_struct
736 RefCount ref;
738 struct ALlistener *Listener;
740 UIntMap SourceMap;
741 UIntMap EffectSlotMap;
743 volatile ALenum LastError;
745 volatile ALenum UpdateSources;
747 volatile enum DistanceModel DistanceModel;
748 volatile ALboolean SourceDistanceModel;
750 volatile ALfloat DopplerFactor;
751 volatile ALfloat DopplerVelocity;
752 volatile ALfloat SpeedOfSound;
753 volatile ALenum DeferUpdates;
755 struct ALactivesource **ActiveSources;
756 ALsizei ActiveSourceCount;
757 ALsizei MaxActiveSources;
759 vector_ALeffectslotPtr ActiveAuxSlots;
761 ALCdevice *Device;
762 const ALCchar *ExtensionList;
764 ALCcontext *volatile next;
766 /* Memory space used by the listener */
767 alignas(16) ALCbyte _listener_mem[];
770 ALCcontext *GetContextRef(void);
772 void ALCcontext_IncRef(ALCcontext *context);
773 void ALCcontext_DecRef(ALCcontext *context);
775 void AppendAllDevicesList(const ALCchar *name);
776 void AppendCaptureDeviceList(const ALCchar *name);
778 ALint64 ALCdevice_GetLatencyDefault(ALCdevice *device);
780 void ALCdevice_Lock(ALCdevice *device);
781 void ALCdevice_Unlock(ALCdevice *device);
782 ALint64 ALCdevice_GetLatency(ALCdevice *device);
784 inline void LockContext(ALCcontext *context)
785 { ALCdevice_Lock(context->Device); }
787 inline void UnlockContext(ALCcontext *context)
788 { ALCdevice_Unlock(context->Device); }
791 void *al_malloc(size_t alignment, size_t size);
792 void *al_calloc(size_t alignment, size_t size);
793 void al_free(void *ptr);
796 typedef struct {
797 #ifdef HAVE_FENV_H
798 DERIVE_FROM_TYPE(fenv_t);
799 #else
800 int state;
801 #endif
802 #ifdef HAVE_SSE
803 int sse_state;
804 #endif
805 } FPUCtl;
806 void SetMixerFPUMode(FPUCtl *ctl);
807 void RestoreFPUMode(const FPUCtl *ctl);
810 typedef struct RingBuffer RingBuffer;
811 RingBuffer *CreateRingBuffer(ALsizei frame_size, ALsizei length);
812 void DestroyRingBuffer(RingBuffer *ring);
813 ALsizei RingBufferSize(RingBuffer *ring);
814 void WriteRingBuffer(RingBuffer *ring, const ALubyte *data, ALsizei len);
815 void ReadRingBuffer(RingBuffer *ring, ALubyte *data, ALsizei len);
817 void ReadALConfig(void);
818 void FreeALConfig(void);
819 int ConfigValueExists(const char *blockName, const char *keyName);
820 const char *GetConfigValue(const char *blockName, const char *keyName, const char *def);
821 int GetConfigValueBool(const char *blockName, const char *keyName, int def);
822 int ConfigValueStr(const char *blockName, const char *keyName, const char **ret);
823 int ConfigValueInt(const char *blockName, const char *keyName, int *ret);
824 int ConfigValueUInt(const char *blockName, const char *keyName, unsigned int *ret);
825 int ConfigValueFloat(const char *blockName, const char *keyName, float *ret);
827 void SetRTPriority(void);
829 void SetDefaultChannelOrder(ALCdevice *device);
830 void SetDefaultWFXChannelOrder(ALCdevice *device);
832 const ALCchar *DevFmtTypeString(enum DevFmtType type) DECL_CONST;
833 const ALCchar *DevFmtChannelsString(enum DevFmtChannels chans) DECL_CONST;
836 extern FILE *LogFile;
838 #if defined(__GNUC__) && !defined(IN_IDE_PARSER)
839 #define AL_PRINT(T, MSG, ...) fprintf(LogFile, "AL lib: %s %s: "MSG, T, __FUNCTION__ , ## __VA_ARGS__)
840 #else
841 void al_print(const char *type, const char *func, const char *fmt, ...) DECL_FORMAT(printf, 3,4);
842 #define AL_PRINT(T, ...) al_print((T), __FUNCTION__, __VA_ARGS__)
843 #endif
845 enum LogLevel {
846 NoLog,
847 LogError,
848 LogWarning,
849 LogTrace,
850 LogRef
852 extern enum LogLevel LogLevel;
854 #define TRACEREF(...) do { \
855 if(LogLevel >= LogRef) \
856 AL_PRINT("(--)", __VA_ARGS__); \
857 } while(0)
859 #define TRACE(...) do { \
860 if(LogLevel >= LogTrace) \
861 AL_PRINT("(II)", __VA_ARGS__); \
862 } while(0)
864 #define WARN(...) do { \
865 if(LogLevel >= LogWarning) \
866 AL_PRINT("(WW)", __VA_ARGS__); \
867 } while(0)
869 #define ERR(...) do { \
870 if(LogLevel >= LogError) \
871 AL_PRINT("(EE)", __VA_ARGS__); \
872 } while(0)
875 extern ALint RTPrioLevel;
878 extern ALuint CPUCapFlags;
879 enum {
880 CPU_CAP_SSE = 1<<0,
881 CPU_CAP_SSE2 = 1<<1,
882 CPU_CAP_SSE4_1 = 1<<2,
883 CPU_CAP_NEON = 1<<3,
886 void FillCPUCaps(ALuint capfilter);
888 FILE *OpenDataFile(const char *fname, const char *subdir);
890 /* Small hack to use a pointer-to-array type as a normal argument type.
891 * Shouldn't be used directly. */
892 typedef ALfloat ALfloatBUFFERSIZE[BUFFERSIZE];
895 #ifdef __cplusplus
897 #endif
899 #endif