ALLoader.hpp

Go to the documentation of this file.

//
//  CeresEngine - A game development framework
//
//  Created by Rogiel Sulzbach.
//  Copyright (c) 2018-2022 Rogiel Sulzbach. All rights reserved.
//
 
#pragma once
 
#include "CeresEngine/DataTypes.hpp"
#include "CeresEngine/Macros.hpp"
 
#include "CeresEngine/Foundation/DynamicLibrary.hpp"
 
#define AL_NO_PROTOTYPES
 
#if CE_PLATFORM_APPLE
#include <OpenAL/al.h>
#include <OpenAL/alc.h>
#else
#include <al.h>
#include <alc.h>
#endif
 
namespace CeresEngine {
 
    /*
     * Context Management
     */
    extern LPALCCREATECONTEXT alcCreateContext;
    extern LPALCMAKECONTEXTCURRENT alcMakeContextCurrent;
    extern LPALCPROCESSCONTEXT alcProcessContext;
    extern LPALCSUSPENDCONTEXT alcSuspendContext;
    extern LPALCDESTROYCONTEXT alcDestroyContext;
    extern LPALCGETCURRENTCONTEXT alcGetCurrentContext;
    extern LPALCGETCONTEXTSDEVICE alcGetContextsDevice;
 
    /*
     * Device Management
     */
    extern LPALCOPENDEVICE alcOpenDevice;
    extern LPALCCLOSEDEVICE alcCloseDevice;
 
    /*
     * Error support.
     * Obtain the most recent Context error
     */
    extern LPALCGETERROR alcGetError;
 
    /*
     * Extension support.
     * Query for the presence of an extension, and obtain any appropriate
     * function pointers and enum values.
     */
    extern LPALCISEXTENSIONPRESENT alcIsExtensionPresent;
    extern LPALCGETPROCADDRESS alcGetProcAddress;
    extern LPALCGETENUMVALUE alcGetEnumValue;
 
    /*
     * Query functions
     */
    extern LPALCGETSTRING alcGetString;
    extern LPALCGETINTEGERV alcGetIntegerv;
 
    /*
     * Capture functions
     */
    extern LPALCCAPTUREOPENDEVICE alcCaptureOpenDevice;
    extern LPALCCAPTURECLOSEDEVICE alcCaptureCloseDevice;
    extern LPALCCAPTURESTART alcCaptureStart;
    extern LPALCCAPTURESTOP alcCaptureStop;
    extern LPALCCAPTURESAMPLES alcCaptureSamples;
 
    // ---------------------------------------------------------------------------------------------
 
    /*
     * Renderer State management
     */
    extern LPALENABLE alEnable;
    extern LPALDISABLE alDisable;
    extern LPALISENABLED alIsEnabled;
 
    /*
     * State retrieval
     */
    extern LPALGETSTRING alGetString;
    extern LPALGETBOOLEANV alGetBooleanv;
    extern LPALGETINTEGERV alGetIntegerv;
    extern LPALGETFLOATV alGetFloatv;
    extern LPALGETDOUBLEV alGetDoublev;
    extern LPALGETBOOLEAN alGetBoolean;
    extern LPALGETINTEGER alGetInteger;
    extern LPALGETFLOAT alGetFloat;
    extern LPALGETDOUBLE alGetDouble;
 
    /*
     * Error support.
     * Obtain the most recent error generated in the AL state machine.
     */
    extern LPALGETERROR alGetError;
 
    /*
     * Extension support.
     * Query for the presence of an extension, and obtain any appropriate
     * function pointers and enum values.
     */
    extern LPALISEXTENSIONPRESENT alIsExtensionPresent;
    extern LPALGETPROCADDRESS alGetProcAddress;
    extern LPALGETENUMVALUE alGetEnumValue;
 
    /*
     * LISTENER
     * Listener represents the location and orientation of the
     * 'user' in 3D-space.
     *
     * Properties include: -
     *
     * Gain         AL_GAIN         ALfloat
     * Position     AL_POSITION     ALfloat[3]
     * Velocity     AL_VELOCITY     ALfloat[3]
     * Orientation  AL_ORIENTATION  ALfloat[6] (Forward then Up vectors)
     */
 
    /*
     * Set Listener parameters
     */
    extern LPALLISTENERF alListenerf;
    extern LPALLISTENER3F alListener3f;
    extern LPALLISTENERFV alListenerfv;
    extern LPALLISTENERI alListeneri;
    extern LPALLISTENER3I alListener3i;
    extern LPALLISTENERIV alListeneriv;
 
    /*
     * Get Listener parameters
     */
    extern LPALGETLISTENERF alGetListenerf;
    extern LPALGETLISTENER3F alGetListener3f;
    extern LPALGETLISTENERFV alGetListenerfv;
    extern LPALGETLISTENERI alGetListeneri;
    extern LPALGETLISTENER3I alGetListener3i;
    extern LPALGETLISTENERIV alGetListeneriv;
 
    /*
     * SOURCE
     * Sources represent individual sound objects in 3D-space.
     * Sources take the PCM data provided in the specified Buffer,
     * apply Source-specific modifications, and then
     * submit them to be mixed according to spatial arrangement etc.
     *
     * Properties include: -
     *
     * Gain                              AL_GAIN                 ALfloat
     * Min Gain                          AL_MIN_GAIN             ALfloat
     * Max Gain                          AL_MAX_GAIN             ALfloat
     * Position                          AL_POSITION             ALfloat[3]
     * Velocity                          AL_VELOCITY             ALfloat[3]
     * Direction                         AL_DIRECTION            ALfloat[3]
     * Head Relative Mode                AL_SOURCE_RELATIVE      ALint (AL_TRUE
     * or AL_FALSE) Reference Distance                AL_REFERENCE_DISTANCE
     * ALfloat Max Distance                      AL_MAX_DISTANCE         ALfloat
     * RollOff Factor                    AL_ROLLOFF_FACTOR       ALfloat
     * Inner Angle                       AL_CONE_INNER_ANGLE     ALint or
     * ALfloat Outer Angle                       AL_CONE_OUTER_ANGLE     ALint
     * or ALfloat Cone Outer Gain                   AL_CONE_OUTER_GAIN ALint or
     * ALfloat Pitch                             AL_PITCH                ALfloat
     * Looping                           AL_LOOPING              ALint (AL_TRUE
     * or AL_FALSE) MS Offset                         AL_MSEC_OFFSET ALint or
     * ALfloat Byte Offset                       AL_BYTE_OFFSET          ALint
     * or ALfloat Sample Offset                     AL_SAMPLE_OFFSET ALint or
     * ALfloat Attached Buffer                   AL_BUFFER               ALint
     * State (Query only)                AL_SOURCE_STATE         ALint
     * Buffers Queued (Query only)       AL_BUFFERS_QUEUED       ALint
     * Buffers Processed (Query only)    AL_BUFFERS_PROCESSED    ALint
     */
 
    extern LPALGENSOURCES alGenSources;
    extern LPALDELETESOURCES alDeleteSources;
    extern LPALISSOURCE alIsSource;
    extern LPALSOURCEF alSourcef;
    extern LPALSOURCE3F alSource3f;
    extern LPALSOURCEFV alSourcefv;
    extern LPALSOURCEI alSourcei;
    extern LPALSOURCE3I alSource3i;
    extern LPALSOURCEIV alSourceiv;
    extern LPALGETSOURCEF alGetSourcef;
    extern LPALGETSOURCE3F alGetSource3f;
    extern LPALGETSOURCEFV alGetSourcefv;
    extern LPALGETSOURCEI alGetSourcei;
    extern LPALGETSOURCE3I alGetSource3i;
    extern LPALGETSOURCEIV alGetSourceiv;
    extern LPALSOURCEPLAYV alSourcePlayv;
    extern LPALSOURCESTOPV alSourceStopv;
    extern LPALSOURCEREWINDV alSourceRewindv;
    extern LPALSOURCEPAUSEV alSourcePausev;
    extern LPALSOURCEPLAY alSourcePlay;
    extern LPALSOURCESTOP alSourceStop;
    extern LPALSOURCEREWIND alSourceRewind;
    extern LPALSOURCEPAUSE alSourcePause;
    extern LPALSOURCEQUEUEBUFFERS alSourceQueueBuffers;
    extern LPALSOURCEUNQUEUEBUFFERS alSourceUnqueueBuffers;
 
    /*
     * BUFFER
     * Buffer objects are storage space for sample data.
     * Buffers are referred to by Sources. One Buffer can be used
     * by multiple Sources.
     *
     * Properties include: -
     *
     * Frequency (Query only)    AL_FREQUENCY      ALint
     * Size (Query only)         AL_SIZE           ALint
     * Bits (Query only)         AL_BITS           ALint
     * Channels (Query only)     AL_CHANNELS       ALint
     */
 
    extern LPALGENBUFFERS alGenBuffers;
    extern LPALDELETEBUFFERS alDeleteBuffers;
    extern LPALISBUFFER alIsBuffer;
    extern LPALBUFFERDATA alBufferData;
    extern LPALBUFFERF alBufferf;
    extern LPALBUFFER3F alBuffer3f;
    extern LPALBUFFERFV alBufferfv;
    extern LPALBUFFERI alBufferi;
    extern LPALBUFFER3I alBuffer3i;
    extern LPALBUFFERIV alBufferiv;
    extern LPALGETBUFFERF alGetBufferf;
    extern LPALGETBUFFER3F alGetBuffer3f;
    extern LPALGETBUFFERFV alGetBufferfv;
    extern LPALGETBUFFERI alGetBufferi;
    extern LPALGETBUFFER3I alGetBuffer3i;
    extern LPALGETBUFFERIV alGetBufferiv;
 
    /*
     * Global Parameters
     */
    extern LPALDOPPLERFACTOR alDopplerFactor;
    extern LPALDOPPLERVELOCITY alDopplerVelocity;
    extern LPALSPEEDOFSOUND alSpeedOfSound;
    extern LPALDISTANCEMODEL alDistanceModel;
 
    void ALLoad(const DynamicLibrary& library) noexcept;
 
} // namespace CeresEngine