re3/vendor/openal-soft/include/AL/alc.h

271 lines
9.6 KiB
C
Raw Normal View History

2020-05-04 18:06:14 +00:00
#ifndef AL_ALC_H
#define AL_ALC_H
#if defined(__cplusplus)
extern "C" {
#endif
#ifndef ALC_API
#if defined(AL_LIBTYPE_STATIC)
#define ALC_API
#elif defined(_WIN32)
#define ALC_API __declspec(dllimport)
#else
#define ALC_API extern
#endif
#endif
#if defined(_WIN32)
#define ALC_APIENTRY __cdecl
#else
#define ALC_APIENTRY
#endif
2021-01-25 16:49:29 +00:00
/* Deprecated macros. */
2020-05-04 18:06:14 +00:00
#define ALCAPI ALC_API
#define ALCAPIENTRY ALC_APIENTRY
#define ALC_INVALID 0
/** Supported ALC version? */
#define ALC_VERSION_0_1 1
/** Opaque device handle */
typedef struct ALCdevice ALCdevice;
/** Opaque context handle */
typedef struct ALCcontext ALCcontext;
/** 8-bit boolean */
typedef char ALCboolean;
/** character */
typedef char ALCchar;
/** signed 8-bit 2's complement integer */
typedef signed char ALCbyte;
/** unsigned 8-bit integer */
typedef unsigned char ALCubyte;
/** signed 16-bit 2's complement integer */
typedef short ALCshort;
/** unsigned 16-bit integer */
typedef unsigned short ALCushort;
/** signed 32-bit 2's complement integer */
typedef int ALCint;
/** unsigned 32-bit integer */
typedef unsigned int ALCuint;
/** non-negative 32-bit binary integer size */
typedef int ALCsizei;
/** enumerated 32-bit value */
typedef int ALCenum;
/** 32-bit IEEE754 floating-point */
typedef float ALCfloat;
/** 64-bit IEEE754 floating-point */
typedef double ALCdouble;
/** void type (for opaque pointers only) */
typedef void ALCvoid;
/* Enumerant values begin at column 50. No tabs. */
/** Boolean False. */
#define ALC_FALSE 0
/** Boolean True. */
#define ALC_TRUE 1
/** Context attribute: <int> Hz. */
#define ALC_FREQUENCY 0x1007
/** Context attribute: <int> Hz. */
#define ALC_REFRESH 0x1008
2021-01-25 16:49:29 +00:00
/** Context attribute: AL_TRUE or AL_FALSE synchronous context? */
2020-05-04 18:06:14 +00:00
#define ALC_SYNC 0x1009
/** Context attribute: <int> requested Mono (3D) Sources. */
#define ALC_MONO_SOURCES 0x1010
/** Context attribute: <int> requested Stereo Sources. */
#define ALC_STEREO_SOURCES 0x1011
/** No error. */
#define ALC_NO_ERROR 0
/** Invalid device handle. */
#define ALC_INVALID_DEVICE 0xA001
/** Invalid context handle. */
#define ALC_INVALID_CONTEXT 0xA002
/** Invalid enum parameter passed to an ALC call. */
#define ALC_INVALID_ENUM 0xA003
/** Invalid value parameter passed to an ALC call. */
#define ALC_INVALID_VALUE 0xA004
/** Out of memory. */
#define ALC_OUT_OF_MEMORY 0xA005
2021-01-25 16:49:29 +00:00
/** Runtime ALC major version. */
2020-05-04 18:06:14 +00:00
#define ALC_MAJOR_VERSION 0x1000
2021-01-25 16:49:29 +00:00
/** Runtime ALC minor version. */
2020-05-04 18:06:14 +00:00
#define ALC_MINOR_VERSION 0x1001
2021-01-25 16:49:29 +00:00
/** Context attribute list size. */
2020-05-04 18:06:14 +00:00
#define ALC_ATTRIBUTES_SIZE 0x1002
2021-01-25 16:49:29 +00:00
/** Context attribute list properties. */
2020-05-04 18:06:14 +00:00
#define ALC_ALL_ATTRIBUTES 0x1003
/** String for the default device specifier. */
#define ALC_DEFAULT_DEVICE_SPECIFIER 0x1004
/**
* String for the given device's specifier.
*
* If device handle is NULL, it is instead a null-char separated list of
* strings of known device specifiers (list ends with an empty string).
*/
#define ALC_DEVICE_SPECIFIER 0x1005
/** String for space-separated list of ALC extensions. */
#define ALC_EXTENSIONS 0x1006
/** Capture extension */
#define ALC_EXT_CAPTURE 1
/**
* String for the given capture device's specifier.
*
* If device handle is NULL, it is instead a null-char separated list of
* strings of known capture device specifiers (list ends with an empty string).
*/
#define ALC_CAPTURE_DEVICE_SPECIFIER 0x310
/** String for the default capture device specifier. */
#define ALC_CAPTURE_DEFAULT_DEVICE_SPECIFIER 0x311
/** Number of sample frames available for capture. */
#define ALC_CAPTURE_SAMPLES 0x312
/** Enumerate All extension */
#define ALC_ENUMERATE_ALL_EXT 1
/** String for the default extended device specifier. */
#define ALC_DEFAULT_ALL_DEVICES_SPECIFIER 0x1012
/**
* String for the given extended device's specifier.
*
* If device handle is NULL, it is instead a null-char separated list of
* strings of known extended device specifiers (list ends with an empty string).
*/
#define ALC_ALL_DEVICES_SPECIFIER 0x1013
2021-01-25 16:49:29 +00:00
/* Context management. */
/** Create and attach a context to the given device. */
ALC_API ALCcontext* ALC_APIENTRY alcCreateContext(ALCdevice *device, const ALCint *attrlist);
/**
* Makes the given context the active process-wide context. Passing NULL clears
* the active context.
*/
2020-05-04 18:06:14 +00:00
ALC_API ALCboolean ALC_APIENTRY alcMakeContextCurrent(ALCcontext *context);
2021-01-25 16:49:29 +00:00
/** Resumes processing updates for the given context. */
2020-05-04 18:06:14 +00:00
ALC_API void ALC_APIENTRY alcProcessContext(ALCcontext *context);
2021-01-25 16:49:29 +00:00
/** Suspends updates for the given context. */
2020-05-04 18:06:14 +00:00
ALC_API void ALC_APIENTRY alcSuspendContext(ALCcontext *context);
2021-01-25 16:49:29 +00:00
/** Remove a context from its device and destroys it. */
2020-05-04 18:06:14 +00:00
ALC_API void ALC_APIENTRY alcDestroyContext(ALCcontext *context);
2021-01-25 16:49:29 +00:00
/** Returns the currently active context. */
2020-05-04 18:06:14 +00:00
ALC_API ALCcontext* ALC_APIENTRY alcGetCurrentContext(void);
2021-01-25 16:49:29 +00:00
/** Returns the device that a particular context is attached to. */
2020-05-04 18:06:14 +00:00
ALC_API ALCdevice* ALC_APIENTRY alcGetContextsDevice(ALCcontext *context);
2021-01-25 16:49:29 +00:00
/* Device management. */
/** Opens the named playback device. */
2020-05-04 18:06:14 +00:00
ALC_API ALCdevice* ALC_APIENTRY alcOpenDevice(const ALCchar *devicename);
2021-01-25 16:49:29 +00:00
/** Closes the given playback device. */
2020-05-04 18:06:14 +00:00
ALC_API ALCboolean ALC_APIENTRY alcCloseDevice(ALCdevice *device);
2021-01-25 16:49:29 +00:00
/* Error support. */
2020-05-04 18:06:14 +00:00
2021-01-25 16:49:29 +00:00
/** Obtain the most recent Device error. */
2020-05-04 18:06:14 +00:00
ALC_API ALCenum ALC_APIENTRY alcGetError(ALCdevice *device);
2021-01-25 16:49:29 +00:00
/* Extension support. */
2020-05-04 18:06:14 +00:00
/**
2021-01-25 16:49:29 +00:00
* Query for the presence of an extension on the device. Pass a NULL device to
* query a device-inspecific extension.
2020-05-04 18:06:14 +00:00
*/
ALC_API ALCboolean ALC_APIENTRY alcIsExtensionPresent(ALCdevice *device, const ALCchar *extname);
2021-01-25 16:49:29 +00:00
/**
* Retrieve the address of a function. Given a non-NULL device, the returned
* function may be device-specific.
*/
ALC_API ALCvoid* ALC_APIENTRY alcGetProcAddress(ALCdevice *device, const ALCchar *funcname);
/**
* Retrieve the value of an enum. Given a non-NULL device, the returned value
* may be device-specific.
*/
2020-05-04 18:06:14 +00:00
ALC_API ALCenum ALC_APIENTRY alcGetEnumValue(ALCdevice *device, const ALCchar *enumname);
2021-01-25 16:49:29 +00:00
/* Query functions. */
/** Returns information about the device, and error strings. */
2020-05-04 18:06:14 +00:00
ALC_API const ALCchar* ALC_APIENTRY alcGetString(ALCdevice *device, ALCenum param);
2021-01-25 16:49:29 +00:00
/** Returns information about the device and the version of OpenAL. */
2020-05-04 18:06:14 +00:00
ALC_API void ALC_APIENTRY alcGetIntegerv(ALCdevice *device, ALCenum param, ALCsizei size, ALCint *values);
2021-01-25 16:49:29 +00:00
/* Capture functions. */
/**
* Opens the named capture device with the given frequency, format, and buffer
* size.
*/
2020-05-04 18:06:14 +00:00
ALC_API ALCdevice* ALC_APIENTRY alcCaptureOpenDevice(const ALCchar *devicename, ALCuint frequency, ALCenum format, ALCsizei buffersize);
2021-01-25 16:49:29 +00:00
/** Closes the given capture device. */
2020-05-04 18:06:14 +00:00
ALC_API ALCboolean ALC_APIENTRY alcCaptureCloseDevice(ALCdevice *device);
2021-01-25 16:49:29 +00:00
/** Starts capturing samples into the device buffer. */
2020-05-04 18:06:14 +00:00
ALC_API void ALC_APIENTRY alcCaptureStart(ALCdevice *device);
2021-01-25 16:49:29 +00:00
/** Stops capturing samples. Samples in the device buffer remain available. */
2020-05-04 18:06:14 +00:00
ALC_API void ALC_APIENTRY alcCaptureStop(ALCdevice *device);
2021-01-25 16:49:29 +00:00
/** Reads samples from the device buffer. */
2020-05-04 18:06:14 +00:00
ALC_API void ALC_APIENTRY alcCaptureSamples(ALCdevice *device, ALCvoid *buffer, ALCsizei samples);
2021-01-25 16:49:29 +00:00
/* Pointer-to-function type, useful for dynamically getting ALC entry points. */
2020-05-04 18:06:14 +00:00
typedef ALCcontext* (ALC_APIENTRY *LPALCCREATECONTEXT)(ALCdevice *device, const ALCint *attrlist);
typedef ALCboolean (ALC_APIENTRY *LPALCMAKECONTEXTCURRENT)(ALCcontext *context);
typedef void (ALC_APIENTRY *LPALCPROCESSCONTEXT)(ALCcontext *context);
typedef void (ALC_APIENTRY *LPALCSUSPENDCONTEXT)(ALCcontext *context);
typedef void (ALC_APIENTRY *LPALCDESTROYCONTEXT)(ALCcontext *context);
typedef ALCcontext* (ALC_APIENTRY *LPALCGETCURRENTCONTEXT)(void);
typedef ALCdevice* (ALC_APIENTRY *LPALCGETCONTEXTSDEVICE)(ALCcontext *context);
typedef ALCdevice* (ALC_APIENTRY *LPALCOPENDEVICE)(const ALCchar *devicename);
typedef ALCboolean (ALC_APIENTRY *LPALCCLOSEDEVICE)(ALCdevice *device);
typedef ALCenum (ALC_APIENTRY *LPALCGETERROR)(ALCdevice *device);
typedef ALCboolean (ALC_APIENTRY *LPALCISEXTENSIONPRESENT)(ALCdevice *device, const ALCchar *extname);
2021-01-25 16:49:29 +00:00
typedef ALCvoid* (ALC_APIENTRY *LPALCGETPROCADDRESS)(ALCdevice *device, const ALCchar *funcname);
2020-05-04 18:06:14 +00:00
typedef ALCenum (ALC_APIENTRY *LPALCGETENUMVALUE)(ALCdevice *device, const ALCchar *enumname);
typedef const ALCchar* (ALC_APIENTRY *LPALCGETSTRING)(ALCdevice *device, ALCenum param);
typedef void (ALC_APIENTRY *LPALCGETINTEGERV)(ALCdevice *device, ALCenum param, ALCsizei size, ALCint *values);
typedef ALCdevice* (ALC_APIENTRY *LPALCCAPTUREOPENDEVICE)(const ALCchar *devicename, ALCuint frequency, ALCenum format, ALCsizei buffersize);
typedef ALCboolean (ALC_APIENTRY *LPALCCAPTURECLOSEDEVICE)(ALCdevice *device);
typedef void (ALC_APIENTRY *LPALCCAPTURESTART)(ALCdevice *device);
typedef void (ALC_APIENTRY *LPALCCAPTURESTOP)(ALCdevice *device);
typedef void (ALC_APIENTRY *LPALCCAPTURESAMPLES)(ALCdevice *device, ALCvoid *buffer, ALCsizei samples);
#if defined(__cplusplus)
}
#endif
#endif /* AL_ALC_H */