OpenAL32/Include/alMain.h

   1 #ifndef AL_MAIN_H
   2 #define AL_MAIN_H
   3
   4 #include <string.h>
   5 #include <stdio.h>
   6 #include <stdarg.h>
   7 #include <assert.h>
   8 #include <math.h>
   9 #include <limits.h>
  10
  11 #ifdef HAVE_STRINGS_H
  12 #include <strings.h>
  13 #endif
  14
  15 #ifdef HAVE_FENV_H
  16 #include <fenv.h>
  17 #endif
  18
  19 #include "AL/al.h"
  20 #include "AL/alc.h"
  21 #include "AL/alext.h"
  22
  23
  24 #if defined(_WIN64)
  25 #define SZFMT "%I64u"
  26 #elif defined(_WIN32)
  27 #define SZFMT "%u"
  28 #else
  29 #define SZFMT "%zu"
  30 #endif
  31
  32
  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"
  39 #include "almalloc.h"
  40 #include "threads.h"
  41
  42 #include "hrtf.h"
  43
  44 #ifndef ALC_SOFT_device_clock
  45 #define ALC_SOFT_device_clock 1
  46 typedef int64_t ALCint64SOFT;
  47 typedef uint64_t ALCuint64SOFT;
  48 #define ALC_DEVICE_CLOCK_SOFT                    0x1600
  49 #define ALC_DEVICE_LATENCY_SOFT                  0x1601
  50 #define ALC_DEVICE_CLOCK_LATENCY_SOFT            0x1602
  51 typedef void (ALC_APIENTRY*LPALCGETINTEGER64VSOFT)(ALCdevice *device, ALCenum pname, ALsizei size, ALCint64SOFT *values);
  52 #ifdef AL_ALEXT_PROTOTYPES
  53 ALC_API void ALC_APIENTRY alcGetInteger64vSOFT(ALCdevice *device, ALCenum pname, ALsizei size, ALCint64SOFT *values);
  54 #endif
  55 #endif
  56
  57 #ifndef AL_SOFT_buffer_samples2
  58 #define AL_SOFT_buffer_samples2 1
  59 /* Channel configurations */
  60 #define AL_MONO_SOFT                             0x1500
  61 #define AL_STEREO_SOFT                           0x1501
  62 #define AL_REAR_SOFT                             0x1502
  63 #define AL_QUAD_SOFT                             0x1503
  64 #define AL_5POINT1_SOFT                          0x1504
  65 #define AL_6POINT1_SOFT                          0x1505
  66 #define AL_7POINT1_SOFT                          0x1506
  67 #define AL_BFORMAT2D_SOFT                        0x1507
  68 #define AL_BFORMAT3D_SOFT                        0x1508
  69
  70 /* Sample types */
  71 #define AL_BYTE_SOFT                             0x1400
  72 #define AL_UNSIGNED_BYTE_SOFT                    0x1401
  73 #define AL_SHORT_SOFT                            0x1402
  74 #define AL_UNSIGNED_SHORT_SOFT                   0x1403
  75 #define AL_INT_SOFT                              0x1404
  76 #define AL_UNSIGNED_INT_SOFT                     0x1405
  77 #define AL_FLOAT_SOFT                            0x1406
  78 #define AL_DOUBLE_SOFT                           0x1407
  79 #define AL_BYTE3_SOFT                            0x1408
  80 #define AL_UNSIGNED_BYTE3_SOFT                   0x1409
  81 #define AL_MULAW_SOFT                            0x140A
  82
  83 /* Storage formats */
  84 #define AL_MONO8_SOFT                            0x1100
  85 #define AL_MONO16_SOFT                           0x1101
  86 #define AL_MONO32F_SOFT                          0x10010
  87 #define AL_STEREO8_SOFT                          0x1102
  88 #define AL_STEREO16_SOFT                         0x1103
  89 #define AL_STEREO32F_SOFT                        0x10011
  90 #define AL_QUAD8_SOFT                            0x1204
  91 #define AL_QUAD16_SOFT                           0x1205
  92 #define AL_QUAD32F_SOFT                          0x1206
  93 #define AL_REAR8_SOFT                            0x1207
  94 #define AL_REAR16_SOFT                           0x1208
  95 #define AL_REAR32F_SOFT                          0x1209
  96 #define AL_5POINT1_8_SOFT                        0x120A
  97 #define AL_5POINT1_16_SOFT                       0x120B
  98 #define AL_5POINT1_32F_SOFT                      0x120C
  99 #define AL_6POINT1_8_SOFT                        0x120D
 100 #define AL_6POINT1_16_SOFT                       0x120E
 101 #define AL_6POINT1_32F_SOFT                      0x120F
 102 #define AL_7POINT1_8_SOFT                        0x1210
 103 #define AL_7POINT1_16_SOFT                       0x1211
 104 #define AL_7POINT1_32F_SOFT                      0x1212
 105 #define AL_BFORMAT2D_8_SOFT                      0x20021
 106 #define AL_BFORMAT2D_16_SOFT                     0x20022
 107 #define AL_BFORMAT2D_32F_SOFT                    0x20023
 108 #define AL_BFORMAT3D_8_SOFT                      0x20031
 109 #define AL_BFORMAT3D_16_SOFT                     0x20032
 110 #define AL_BFORMAT3D_32F_SOFT                    0x20033
 111
 112 /* Buffer attributes */
 113 #define AL_INTERNAL_FORMAT_SOFT                  0x2008
 114 #define AL_BYTE_LENGTH_SOFT                      0x2009
 115 #define AL_SAMPLE_LENGTH_SOFT                    0x200A
 116 #define AL_SEC_LENGTH_SOFT                       0x200B
 117
 118 #if 0
 119 typedef void (AL_APIENTRY*LPALBUFFERSAMPLESSOFT)(ALuint,ALuint,ALenum,ALsizei,ALenum,ALenum,const ALvoid*);
 120 typedef void (AL_APIENTRY*LPALGETBUFFERSAMPLESSOFT)(ALuint,ALsizei,ALsizei,ALenum,ALenum,ALvoid*);
 121 typedef ALboolean (AL_APIENTRY*LPALISBUFFERFORMATSUPPORTEDSOFT)(ALenum);
 122 #ifdef AL_ALEXT_PROTOTYPES
 123 AL_API void AL_APIENTRY alBufferSamplesSOFT(ALuint buffer, ALuint samplerate, ALenum internalformat, ALsizei samples, ALenum channels, ALenum type, const ALvoid *data);
 124 AL_API void AL_APIENTRY alGetBufferSamplesSOFT(ALuint buffer, ALsizei offset, ALsizei samples, ALenum channels, ALenum type, ALvoid *data);
 125 AL_API ALboolean AL_APIENTRY alIsBufferFormatSupportedSOFT(ALenum format);
 126 #endif
 127 #endif
 128 #endif
 129
 130
 131 typedef ALint64SOFT ALint64;
 132 typedef ALuint64SOFT ALuint64;
 133
 134 #ifndef U64
 135 #if defined(_MSC_VER)
 136 #define U64(x) ((ALuint64)(x##ui64))
 137 #elif SIZEOF_LONG == 8
 138 #define U64(x) ((ALuint64)(x##ul))
 139 #elif SIZEOF_LONG_LONG == 8
 140 #define U64(x) ((ALuint64)(x##ull))
 141 #endif
 142 #endif
 143
 144 #ifndef UINT64_MAX
 145 #define UINT64_MAX U64(18446744073709551615)
 146 #endif
 147
 148 #ifndef UNUSED
 149 #if defined(__cplusplus)
 150 #define UNUSED(x)
 151 #elif defined(__GNUC__)
 152 #define UNUSED(x) UNUSED_##x __attribute__((unused))
 153 #elif defined(__LCLINT__)
 154 #define UNUSED(x) /*@unused@*/ x
 155 #else
 156 #define UNUSED(x) x
 157 #endif
 158 #endif
 159
 160 #ifdef __GNUC__
 161 #define DECL_CONST __attribute__((const))
 162 #define DECL_FORMAT(x, y, z) __attribute__((format(x, (y), (z))))
 163 #else
 164 #define DECL_CONST
 165 #define DECL_FORMAT(x, y, z)
 166 #endif
 167
 168 #if defined(__GNUC__) && defined(__i386__)
 169 /* force_align_arg_pointer is required for proper function arguments aligning
 170  * when SSE code is used. Some systems (Windows, QNX) do not guarantee our
 171  * thread functions will be properly aligned on the stack, even though GCC may
 172  * generate code with the assumption that it is. */
 173 #define FORCE_ALIGN __attribute__((force_align_arg_pointer))
 174 #else
 175 #define FORCE_ALIGN
 176 #endif
 177
 178 #ifdef HAVE_C99_VLA
 179 #define DECL_VLA(T, _name, _size)  T _name[(_size)]
 180 #else
 181 #define DECL_VLA(T, _name, _size)  T *_name = alloca((_size) * sizeof(T))
 182 #endif
 183
 184 #ifndef PATH_MAX
 185 #ifdef MAX_PATH
 186 #define PATH_MAX MAX_PATH
 187 #else
 188 #define PATH_MAX 4096
 189 #endif
 190 #endif
 191
 192
 193 static const union {
 194     ALuint u;
 195     ALubyte b[sizeof(ALuint)];
 196 } EndianTest = { 1 };
 197 #define IS_LITTLE_ENDIAN (EndianTest.b[0] == 1)
 198
 199 #define COUNTOF(x) (sizeof((x))/sizeof((x)[0]))
 200
 201
 202 #define DERIVE_FROM_TYPE(t)          t t##_parent
 203 #define STATIC_CAST(to, obj)         (&(obj)->to##_parent)
 204 #ifdef __GNUC__
 205 #define STATIC_UPCAST(to, from, obj) __extension__({                          \
 206     static_assert(__builtin_types_compatible_p(from, __typeof(*(obj))),       \
 207                   "Invalid upcast object from type");                         \
 208     (to*)((char*)(obj) - offsetof(to, from##_parent));                        \
 209 })
 210 #else
 211 #define STATIC_UPCAST(to, from, obj) ((to*)((char*)(obj) - offsetof(to, from##_parent)))
 212 #endif
 213
 214 #define DECLARE_FORWARD(T1, T2, rettype, func)                                \
 215 rettype T1##_##func(T1 *obj)                                                  \
 216 { return T2##_##func(STATIC_CAST(T2, obj)); }
 217
 218 #define DECLARE_FORWARD1(T1, T2, rettype, func, argtype1)                     \
 219 rettype T1##_##func(T1 *obj, argtype1 a)                                      \
 220 { return T2##_##func(STATIC_CAST(T2, obj), a); }
 221
 222 #define DECLARE_FORWARD2(T1, T2, rettype, func, argtype1, argtype2)           \
 223 rettype T1##_##func(T1 *obj, argtype1 a, argtype2 b)                          \
 224 { return T2##_##func(STATIC_CAST(T2, obj), a, b); }
 225
 226 #define DECLARE_FORWARD3(T1, T2, rettype, func, argtype1, argtype2, argtype3) \
 227 rettype T1##_##func(T1 *obj, argtype1 a, argtype2 b, argtype3 c)              \
 228 { return T2##_##func(STATIC_CAST(T2, obj), a, b, c); }
 229
 230
 231 #define GET_VTABLE1(T1)     (&(T1##_vtable))
 232 #define GET_VTABLE2(T1, T2) (&(T1##_##T2##_vtable))
 233
 234 #define SET_VTABLE1(T1, obj)     ((obj)->vtbl = GET_VTABLE1(T1))
 235 #define SET_VTABLE2(T1, T2, obj) (STATIC_CAST(T2, obj)->vtbl = GET_VTABLE2(T1, T2))
 236
 237 #define DECLARE_THUNK(T1, T2, rettype, func)                                  \
 238 static rettype T1##_##T2##_##func(T2 *obj)                                    \
 239 { return T1##_##func(STATIC_UPCAST(T1, T2, obj)); }
 240
 241 #define DECLARE_THUNK1(T1, T2, rettype, func, argtype1)                       \
 242 static rettype T1##_##T2##_##func(T2 *obj, argtype1 a)                        \
 243 { return T1##_##func(STATIC_UPCAST(T1, T2, obj), a); }
 244
 245 #define DECLARE_THUNK2(T1, T2, rettype, func, argtype1, argtype2)             \
 246 static rettype T1##_##T2##_##func(T2 *obj, argtype1 a, argtype2 b)            \
 247 { return T1##_##func(STATIC_UPCAST(T1, T2, obj), a, b); }
 248
 249 #define DECLARE_THUNK3(T1, T2, rettype, func, argtype1, argtype2, argtype3)   \
 250 static rettype T1##_##T2##_##func(T2 *obj, argtype1 a, argtype2 b, argtype3 c) \
 251 { return T1##_##func(STATIC_UPCAST(T1, T2, obj), a, b, c); }
 252
 253 #define DECLARE_THUNK4(T1, T2, rettype, func, argtype1, argtype2, argtype3, argtype4) \
 254 static rettype T1##_##T2##_##func(T2 *obj, argtype1 a, argtype2 b, argtype3 c, argtype4 d) \
 255 { return T1##_##func(STATIC_UPCAST(T1, T2, obj), a, b, c, d); }
 256
 257 #define DECLARE_DEFAULT_ALLOCATORS(T)                                         \
 258 static void* T##_New(size_t size) { return al_malloc(16, size); }             \
 259 static void T##_Delete(void *ptr) { al_free(ptr); }
 260
 261 /* Helper to extract an argument list for VCALL. Not used directly. */
 262 #define EXTRACT_VCALL_ARGS(...)  __VA_ARGS__))
 263
 264 /* Call a "virtual" method on an object, with arguments. */
 265 #define V(obj, func)  ((obj)->vtbl->func((obj), EXTRACT_VCALL_ARGS
 266 /* Call a "virtual" method on an object, with no arguments. */
 267 #define V0(obj, func) ((obj)->vtbl->func((obj) EXTRACT_VCALL_ARGS
 268
 269 #define DELETE_OBJ(obj) do {                                                  \
 270     if((obj) != NULL)                                                         \
 271     {                                                                         \
 272         V0((obj),Destruct)();                                                 \
 273         V0((obj),Delete)();                                                   \
 274     }                                                                         \
 275 } while(0)
 276
 277
 278 #define EXTRACT_NEW_ARGS(...)  __VA_ARGS__);                                  \
 279     }                                                                         \
 280 } while(0)
 281
 282 #define NEW_OBJ(_res, T) do {                                                 \
 283     _res = T##_New(sizeof(T));                                                \
 284     if(_res)                                                                  \
 285     {                                                                         \
 286         memset(_res, 0, sizeof(T));                                           \
 287         T##_Construct(_res, EXTRACT_NEW_ARGS
 288
 289
 290 #ifdef __cplusplus
 291 extern "C" {
 292 #endif
 293
 294 struct Hrtf;
 295
 296
 297 #define DEFAULT_OUTPUT_RATE  (44100)
 298 #define MIN_OUTPUT_RATE      (8000)
 299
 300
 301 /* Find the next power-of-2 for non-power-of-2 numbers. */
 302 inline ALuint NextPowerOf2(ALuint value)
 303 {
 304     if(value > 0)
 305     {
 306         value--;
 307         value |= value>>1;
 308         value |= value>>2;
 309         value |= value>>4;
 310         value |= value>>8;
 311         value |= value>>16;
 312     }
 313     return value+1;
 314 }
 315
 316 /* Fast float-to-int conversion. Assumes the FPU is already in round-to-zero
 317  * mode. */
 318 inline ALint fastf2i(ALfloat f)
 319 {
 320 #ifdef HAVE_LRINTF
 321     return lrintf(f);
 322 #elif defined(_MSC_VER) && defined(_M_IX86)
 323     ALint i;
 324     __asm fld f
 325     __asm fistp i
 326     return i;
 327 #else
 328     return (ALint)f;
 329 #endif
 330 }
 331
 332 /* Fast float-to-uint conversion. Assumes the FPU is already in round-to-zero
 333  * mode. */
 334 inline ALuint fastf2u(ALfloat f)
 335 { return fastf2i(f); }
 336
 337
 338 enum DevProbe {
 339     ALL_DEVICE_PROBE,
 340     CAPTURE_DEVICE_PROBE
 341 };
 342
 343 typedef struct {
 344     ALCenum (*OpenPlayback)(ALCdevice*, const ALCchar*);
 345     void (*ClosePlayback)(ALCdevice*);
 346     ALCboolean (*ResetPlayback)(ALCdevice*);
 347     ALCboolean (*StartPlayback)(ALCdevice*);
 348     void (*StopPlayback)(ALCdevice*);
 349
 350     ALCenum (*OpenCapture)(ALCdevice*, const ALCchar*);
 351     void (*CloseCapture)(ALCdevice*);
 352     void (*StartCapture)(ALCdevice*);
 353     void (*StopCapture)(ALCdevice*);
 354     ALCenum (*CaptureSamples)(ALCdevice*, void*, ALCuint);
 355     ALCuint (*AvailableSamples)(ALCdevice*);
 356 } BackendFuncs;
 357
 358 ALCboolean alc_sndio_init(BackendFuncs *func_list);
 359 void alc_sndio_deinit(void);
 360 void alc_sndio_probe(enum DevProbe type);
 361 ALCboolean alc_ca_init(BackendFuncs *func_list);
 362 void alc_ca_deinit(void);
 363 void alc_ca_probe(enum DevProbe type);
 364 ALCboolean alc_opensl_init(BackendFuncs *func_list);
 365 void alc_opensl_deinit(void);
 366 void alc_opensl_probe(enum DevProbe type);
 367 ALCboolean alc_qsa_init(BackendFuncs *func_list);
 368 void alc_qsa_deinit(void);
 369 void alc_qsa_probe(enum DevProbe type);
 370
 371 struct ALCbackend;
 372
 373
 374 enum DistanceModel {
 375     InverseDistanceClamped  = AL_INVERSE_DISTANCE_CLAMPED,
 376     LinearDistanceClamped   = AL_LINEAR_DISTANCE_CLAMPED,
 377     ExponentDistanceClamped = AL_EXPONENT_DISTANCE_CLAMPED,
 378     InverseDistance  = AL_INVERSE_DISTANCE,
 379     LinearDistance   = AL_LINEAR_DISTANCE,
 380     ExponentDistance = AL_EXPONENT_DISTANCE,
 381     DisableDistance  = AL_NONE,
 382
 383     DefaultDistanceModel = InverseDistanceClamped
 384 };
 385
 386 enum Channel {
 387     FrontLeft = 0,
 388     FrontRight,
 389     FrontCenter,
 390     LFE,
 391     BackLeft,
 392     BackRight,
 393     BackCenter,
 394     SideLeft,
 395     SideRight,
 396
 397     UpperFrontLeft,
 398     UpperFrontRight,
 399     UpperBackLeft,
 400     UpperBackRight,
 401     LowerFrontLeft,
 402     LowerFrontRight,
 403     LowerBackLeft,
 404     LowerBackRight,
 405
 406     Aux0,
 407     Aux1,
 408     Aux2,
 409     Aux3,
 410     Aux4,
 411     Aux5,
 412     Aux6,
 413     Aux7,
 414     Aux8,
 415     Aux9,
 416     Aux10,
 417     Aux11,
 418     Aux12,
 419     Aux13,
 420     Aux14,
 421     Aux15,
 422
 423     InvalidChannel
 424 };
 425
 426
 427 /* Device formats */
 428 enum DevFmtType {
 429     DevFmtByte   = ALC_BYTE_SOFT,
 430     DevFmtUByte  = ALC_UNSIGNED_BYTE_SOFT,
 431     DevFmtShort  = ALC_SHORT_SOFT,
 432     DevFmtUShort = ALC_UNSIGNED_SHORT_SOFT,
 433     DevFmtInt    = ALC_INT_SOFT,
 434     DevFmtUInt   = ALC_UNSIGNED_INT_SOFT,
 435     DevFmtFloat  = ALC_FLOAT_SOFT,
 436
 437     DevFmtTypeDefault = DevFmtFloat
 438 };
 439 enum DevFmtChannels {
 440     DevFmtMono   = ALC_MONO_SOFT,
 441     DevFmtStereo = ALC_STEREO_SOFT,
 442     DevFmtQuad   = ALC_QUAD_SOFT,
 443     DevFmtX51    = ALC_5POINT1_SOFT,
 444     DevFmtX61    = ALC_6POINT1_SOFT,
 445     DevFmtX71    = ALC_7POINT1_SOFT,
 446
 447     /* Similar to 5.1, except using rear channels instead of sides */
 448     DevFmtX51Rear = 0x80000000,
 449
 450     DevFmtBFormat3D,
 451
 452     DevFmtChannelsDefault = DevFmtStereo
 453 };
 454 #define MAX_OUTPUT_CHANNELS  (16)
 455
 456 ALuint BytesFromDevFmt(enum DevFmtType type) DECL_CONST;
 457 ALuint ChannelsFromDevFmt(enum DevFmtChannels chans) DECL_CONST;
 458 inline ALuint FrameSizeFromDevFmt(enum DevFmtChannels chans, enum DevFmtType type)
 459 {
 460     return ChannelsFromDevFmt(chans) * BytesFromDevFmt(type);
 461 }
 462
 463
 464 extern const struct EffectList {
 465     const char *name;
 466     int type;
 467     const char *ename;
 468     ALenum val;
 469 } EffectList[];
 470
 471
 472 enum DeviceType {
 473     Playback,
 474     Capture,
 475     Loopback
 476 };
 477
 478
 479 enum RenderMode {
 480     NormalRender,
 481     StereoPair,
 482     HrtfRender
 483 };
 484
 485
 486 /* The maximum number of Ambisonics coefficients. For a given order (o), the
 487  * size needed will be (o+1)**2, thus zero-order has 1, first-order has 4,
 488  * second-order has 9, third-order has 16, and fourth-order has 25. */
 489 #define MAX_AMBI_ORDER  3
 490 #define MAX_AMBI_COEFFS ((MAX_AMBI_ORDER+1) * (MAX_AMBI_ORDER+1))
 491
 492 /* A bitmask of ambisonic channels with height information. If none of these
 493  * channels are used/needed, there's no height (e.g. with most surround sound
 494  * speaker setups). This only specifies up to 4th order, which is the highest
 495  * order a 32-bit mask value can specify (a 64-bit mask could handle up to 7th
 496  * order). This is ACN ordering, with bit 0 being ACN 0, etc.
 497  */
 498 #define AMBI_PERIPHONIC_MASK (0xfe7ce4)
 499
 500
 501 typedef ALfloat ChannelConfig[MAX_AMBI_COEFFS];
 502 typedef struct BFChannelConfig {
 503     ALfloat Scale;
 504     ALuint Index;
 505 } BFChannelConfig;
 506
 507
 508 #define HRTF_HISTORY_BITS   (6)
 509 #define HRTF_HISTORY_LENGTH (1<<HRTF_HISTORY_BITS)
 510 #define HRTF_HISTORY_MASK   (HRTF_HISTORY_LENGTH-1)
 511
 512 typedef struct HrtfState {
 513     alignas(16) ALfloat History[HRTF_HISTORY_LENGTH];
 514     alignas(16) ALfloat Values[HRIR_LENGTH][2];
 515 } HrtfState;
 516
 517 typedef struct HrtfParams {
 518     alignas(16) ALfloat Coeffs[HRIR_LENGTH][2];
 519     ALuint Delay[2];
 520 } HrtfParams;
 521
 522
 523 /* Size for temporary storage of buffer data, in ALfloats. Larger values need
 524  * more memory, while smaller values may need more iterations. The value needs
 525  * to be a sensible size, however, as it constrains the max stepping value used
 526  * for mixing, as well as the maximum number of samples per mixing iteration.
 527  */
 528 #define BUFFERSIZE (2048u)
 529
 530 struct ALCdevice_struct
 531 {
 532     RefCount ref;
 533
 534     ALCboolean Connected;
 535     enum DeviceType Type;
 536
 537     ALuint Frequency;
 538     ALuint UpdateSize;
 539     ALuint NumUpdates;
 540     enum DevFmtChannels FmtChans;
 541     enum DevFmtType     FmtType;
 542     ALboolean IsHeadphones;
 543
 544     al_string DeviceName;
 545
 546     ATOMIC(ALCenum) LastError;
 547
 548     // Maximum number of sources that can be created
 549     ALuint SourcesMax;
 550     // Maximum number of slots that can be created
 551     ALuint AuxiliaryEffectSlotMax;
 552
 553     ALCuint NumMonoSources;
 554     ALCuint NumStereoSources;
 555     ALuint  NumAuxSends;
 556
 557     // Map of Buffers for this device
 558     UIntMap BufferMap;
 559
 560     // Map of Effects for this device
 561     UIntMap EffectMap;
 562
 563     // Map of Filters for this device
 564     UIntMap FilterMap;
 565
 566     /* HRTF filter tables */
 567     vector_HrtfEntry Hrtf_List;
 568     al_string Hrtf_Name;
 569     const struct Hrtf *Hrtf;
 570     ALCenum Hrtf_Status;
 571
 572     /* HRTF filter state for dry buffer content */
 573     HrtfState Hrtf_State[8];
 574     HrtfParams Hrtf_Params[8];
 575     ALuint Hrtf_Offset;
 576
 577     /* UHJ encoder state */
 578     struct Uhj2Encoder *Uhj_Encoder;
 579
 580     /* High quality Ambisonic decoder */
 581     struct BFormatDec *AmbiDecoder;
 582
 583     // Stereo-to-binaural filter
 584     struct bs2b *Bs2b;
 585
 586     /* Rendering mode. */
 587     enum RenderMode Render_Mode;
 588
 589     // Device flags
 590     ALuint Flags;
 591
 592     ALuint64 ClockBase;
 593     ALuint SamplesDone;
 594
 595     /* Temp storage used for each source when mixing. */
 596     alignas(16) ALfloat SourceData[BUFFERSIZE];
 597     alignas(16) ALfloat ResampledData[BUFFERSIZE];
 598     alignas(16) ALfloat FilteredData[BUFFERSIZE];
 599
 600     /* The "dry" path corresponds to the main output. */
 601     struct {
 602         union {
 603             /* Ambisonic coefficients for mixing to the dry buffer. */
 604             ChannelConfig Coeffs[MAX_OUTPUT_CHANNELS];
 605             /* Coefficient channel mapping for mixing to the dry buffer. */
 606             BFChannelConfig Map[MAX_OUTPUT_CHANNELS];
 607         } Ambi;
 608         /* Number of coefficients in each ChannelConfig to mix together (4 for
 609          * first-order, 9 for second-order, etc). If the count is 0, the
 610          * BFChannelConfig is used instead to map each output to a coefficient
 611          * index.
 612          */
 613         ALuint CoeffCount;
 614
 615         /* Dry buffer will be aliased by the virtual or real output. */
 616         ALfloat (*Buffer)[BUFFERSIZE];
 617         ALuint NumChannels;
 618     } Dry;
 619
 620     /* First-order ambisonics output, to be upsampled to the dry buffer if different. */
 621     struct {
 622         union {
 623             ChannelConfig Coeffs[MAX_OUTPUT_CHANNELS];
 624             BFChannelConfig Map[MAX_OUTPUT_CHANNELS];
 625         } Ambi;
 626         /* Will only be 4 or 0. */
 627         ALuint CoeffCount;
 628
 629         ALfloat (*Buffer)[BUFFERSIZE];
 630         ALuint NumChannels;
 631     } FOAOut;
 632
 633     /* Virtual output, to be post-processed to the real output. */
 634     struct {
 635         ALfloat (*Buffer)[BUFFERSIZE];
 636         ALuint NumChannels;
 637     } VirtOut;
 638     /* "Real" output, which will be written to the device buffer. */
 639     struct {
 640         enum Channel ChannelName[MAX_OUTPUT_CHANNELS];
 641
 642         ALfloat (*Buffer)[BUFFERSIZE];
 643         ALuint NumChannels;
 644     } RealOut;
 645
 646     /* Running count of the mixer invocations, in 31.1 fixed point. This
 647      * actually increments *twice* when mixing, first at the start and then at
 648      * the end, so the bottom bit indicates if the device is currently mixing
 649      * and the upper bits indicates how many mixes have been done.
 650      */
 651     RefCount MixCount;
 652
 653     /* Default effect slot */
 654     struct ALeffectslot *DefaultSlot;
 655
 656     // Contexts created on this device
 657     ATOMIC(ALCcontext*) ContextList;
 658
 659     almtx_t BackendLock;
 660     struct ALCbackend *Backend;
 661
 662     void *ExtraData; // For the backend's use
 663
 664     ALCdevice *volatile next;
 665
 666     /* Memory space used by the default slot (Playback devices only) */
 667     alignas(16) ALCbyte _slot_mem[];
 668 };
 669
 670 // Frequency was requested by the app or config file
 671 #define DEVICE_FREQUENCY_REQUEST                 (1<<1)
 672 // Channel configuration was requested by the config file
 673 #define DEVICE_CHANNELS_REQUEST                  (1<<2)
 674 // Sample type was requested by the config file
 675 #define DEVICE_SAMPLE_TYPE_REQUEST               (1<<3)
 676
 677 // Specifies if the DSP is paused at user request
 678 #define DEVICE_PAUSED                            (1<<30)
 679
 680 // Specifies if the device is currently running
 681 #define DEVICE_RUNNING                           (1<<31)
 682
 683
 684 /* Nanosecond resolution for the device clock time. */
 685 #define DEVICE_CLOCK_RES  U64(1000000000)
 686
 687
 688 /* Must be less than 15 characters (16 including terminating null) for
 689  * compatibility with pthread_setname_np limitations. */
 690 #define MIXER_THREAD_NAME "alsoft-mixer"
 691
 692 #define RECORD_THREAD_NAME "alsoft-record"
 693
 694
 695 struct ALCcontext_struct {
 696     RefCount ref;
 697
 698     struct ALlistener *Listener;
 699
 700     UIntMap SourceMap;
 701     UIntMap EffectSlotMap;
 702
 703     ATOMIC(ALenum) LastError;
 704
 705     volatile enum DistanceModel DistanceModel;
 706     volatile ALboolean SourceDistanceModel;
 707
 708     volatile ALfloat DopplerFactor;
 709     volatile ALfloat DopplerVelocity;
 710     volatile ALfloat SpeedOfSound;
 711     ATOMIC(ALenum) DeferUpdates;
 712
 713     RWLock PropLock;
 714
 715     /* Counter for the pre-mixing updates, in 31.1 fixed point (lowest bit
 716      * indicates if updates are currently happening).
 717      */
 718     RefCount UpdateCount;
 719     ATOMIC(ALenum) HoldUpdates;
 720
 721     struct ALvoice *Voices;
 722     ALsizei VoiceCount;
 723     ALsizei MaxVoices;
 724
 725     ATOMIC(struct ALeffectslot*) ActiveAuxSlotList;
 726
 727     ALCdevice  *Device;
 728     const ALCchar *ExtensionList;
 729
 730     ALCcontext *volatile next;
 731
 732     /* Memory space used by the listener */
 733     alignas(16) ALCbyte _listener_mem[];
 734 };
 735
 736 ALCcontext *GetContextRef(void);
 737
 738 void ALCcontext_IncRef(ALCcontext *context);
 739 void ALCcontext_DecRef(ALCcontext *context);
 740
 741 void AppendAllDevicesList(const ALCchar *name);
 742 void AppendCaptureDeviceList(const ALCchar *name);
 743
 744 void ALCdevice_Lock(ALCdevice *device);
 745 void ALCdevice_Unlock(ALCdevice *device);
 746
 747 void ALCcontext_DeferUpdates(ALCcontext *context);
 748 void ALCcontext_ProcessUpdates(ALCcontext *context);
 749
 750 inline void LockContext(ALCcontext *context)
 751 { ALCdevice_Lock(context->Device); }
 752
 753 inline void UnlockContext(ALCcontext *context)
 754 { ALCdevice_Unlock(context->Device); }
 755
 756
 757 typedef struct {
 758 #ifdef HAVE_FENV_H
 759     DERIVE_FROM_TYPE(fenv_t);
 760 #else
 761     int state;
 762 #endif
 763 #ifdef HAVE_SSE
 764     int sse_state;
 765 #endif
 766 } FPUCtl;
 767 void SetMixerFPUMode(FPUCtl *ctl);
 768 void RestoreFPUMode(const FPUCtl *ctl);
 769
 770
 771 typedef struct ll_ringbuffer ll_ringbuffer_t;
 772 typedef struct ll_ringbuffer_data {
 773     char *buf;
 774     size_t len;
 775 } ll_ringbuffer_data_t;
 776 ll_ringbuffer_t *ll_ringbuffer_create(size_t sz, size_t elem_sz);
 777 void ll_ringbuffer_free(ll_ringbuffer_t *rb);
 778 void ll_ringbuffer_get_read_vector(const ll_ringbuffer_t *rb, ll_ringbuffer_data_t *vec);
 779 void ll_ringbuffer_get_write_vector(const ll_ringbuffer_t *rb, ll_ringbuffer_data_t *vec);
 780 size_t ll_ringbuffer_read(ll_ringbuffer_t *rb, char *dest, size_t cnt);
 781 size_t ll_ringbuffer_peek(ll_ringbuffer_t *rb, char *dest, size_t cnt);
 782 void ll_ringbuffer_read_advance(ll_ringbuffer_t *rb, size_t cnt);
 783 size_t ll_ringbuffer_read_space(const ll_ringbuffer_t *rb);
 784 int ll_ringbuffer_mlock(ll_ringbuffer_t *rb);
 785 void ll_ringbuffer_reset(ll_ringbuffer_t *rb);
 786 size_t ll_ringbuffer_write(ll_ringbuffer_t *rb, const char *src, size_t cnt);
 787 void ll_ringbuffer_write_advance(ll_ringbuffer_t *rb, size_t cnt);
 788 size_t ll_ringbuffer_write_space(const ll_ringbuffer_t *rb);
 789
 790 void ReadALConfig(void);
 791 void FreeALConfig(void);
 792 int ConfigValueExists(const char *devName, const char *blockName, const char *keyName);
 793 const char *GetConfigValue(const char *devName, const char *blockName, const char *keyName, const char *def);
 794 int GetConfigValueBool(const char *devName, const char *blockName, const char *keyName, int def);
 795 int ConfigValueStr(const char *devName, const char *blockName, const char *keyName, const char **ret);
 796 int ConfigValueInt(const char *devName, const char *blockName, const char *keyName, int *ret);
 797 int ConfigValueUInt(const char *devName, const char *blockName, const char *keyName, unsigned int *ret);
 798 int ConfigValueFloat(const char *devName, const char *blockName, const char *keyName, float *ret);
 799 int ConfigValueBool(const char *devName, const char *blockName, const char *keyName, int *ret);
 800
 801 void SetRTPriority(void);
 802
 803 void SetDefaultChannelOrder(ALCdevice *device);
 804 void SetDefaultWFXChannelOrder(ALCdevice *device);
 805
 806 const ALCchar *DevFmtTypeString(enum DevFmtType type) DECL_CONST;
 807 const ALCchar *DevFmtChannelsString(enum DevFmtChannels chans) DECL_CONST;
 808
 809 /**
 810  * GetChannelIdxByName
 811  *
 812  * Returns the index for the given channel name (e.g. FrontCenter), or -1 if it
 813  * doesn't exist.
 814  */
 815 inline ALint GetChannelIndex(const enum Channel names[MAX_OUTPUT_CHANNELS], enum Channel chan)
 816 {
 817     ALint i;
 818     for(i = 0;i < MAX_OUTPUT_CHANNELS;i++)
 819     {
 820         if(names[i] == chan)
 821             return i;
 822     }
 823     return -1;
 824 }
 825 #define GetChannelIdxByName(x, c) GetChannelIndex((x).ChannelName, (c))
 826
 827 extern FILE *LogFile;
 828
 829 #if defined(__GNUC__) && !defined(_WIN32) && !defined(IN_IDE_PARSER)
 830 #define AL_PRINT(T, MSG, ...) fprintf(LogFile, "AL lib: %s %s: "MSG, T, __FUNCTION__ , ## __VA_ARGS__)
 831 #else
 832 void al_print(const char *type, const char *func, const char *fmt, ...) DECL_FORMAT(printf, 3,4);
 833 #define AL_PRINT(T, ...) al_print((T), __FUNCTION__, __VA_ARGS__)
 834 #endif
 835
 836 enum LogLevel {
 837     NoLog,
 838     LogError,
 839     LogWarning,
 840     LogTrace,
 841     LogRef
 842 };
 843 extern enum LogLevel LogLevel;
 844
 845 #define TRACEREF(...) do {                                                    \
 846     if(LogLevel >= LogRef)                                                    \
 847         AL_PRINT("(--)", __VA_ARGS__);                                        \
 848 } while(0)
 849
 850 #define TRACE(...) do {                                                       \
 851     if(LogLevel >= LogTrace)                                                  \
 852         AL_PRINT("(II)", __VA_ARGS__);                                        \
 853 } while(0)
 854
 855 #define WARN(...) do {                                                        \
 856     if(LogLevel >= LogWarning)                                                \
 857         AL_PRINT("(WW)", __VA_ARGS__);                                        \
 858 } while(0)
 859
 860 #define ERR(...) do {                                                         \
 861     if(LogLevel >= LogError)                                                  \
 862         AL_PRINT("(EE)", __VA_ARGS__);                                        \
 863 } while(0)
 864
 865
 866 extern ALint RTPrioLevel;
 867
 868
 869 extern ALuint CPUCapFlags;
 870 enum {
 871     CPU_CAP_SSE    = 1<<0,
 872     CPU_CAP_SSE2   = 1<<1,
 873     CPU_CAP_SSE3   = 1<<2,
 874     CPU_CAP_SSE4_1 = 1<<3,
 875     CPU_CAP_NEON   = 1<<4,
 876 };
 877
 878 void FillCPUCaps(ALuint capfilter);
 879
 880 vector_al_string SearchDataFiles(const char *match, const char *subdir);
 881
 882 /* Small hack to use a pointer-to-array type as a normal argument type.
 883  * Shouldn't be used directly. */
 884 typedef ALfloat ALfloatBUFFERSIZE[BUFFERSIZE];
 885
 886
 887 #ifdef __cplusplus
 888 }
 889 #endif
 890
 891 #endif