Unit KambiOpenAL

Check is appropriate variable (ALInited, ALUTInited) True, if not — raise EOpenALInitError with appropriate message. Actually these trivial procedures are implemented only because I wanted to place inside standard error messages for missing OpenAL functionality.

Exceptions raised

EOpenALInitError

If appropriate variable is False.

Reset OpenAL library.

In this unit's initialization, we link to OpenAL library, load all symbols, and initialize ALInited and ALUTInited. In this unit's finalization, we release library handles and set ALInited and ALUTInited back to False.

What this procedure does ? It behaves like finalizing this unit (releasing OpenAL library handles), then sleeping for some short amount, and initializing this unit again (loading OpenAL library symbols).

When is it needed ?

Unix OpenAL implementation seems to have a problem. It's reproduceable in "The Castle" code: When I want to switch from one OpenAL device to the other, I would like to call EndAL (this releases OpenAL context and device), change my device name, and call BeginAL (this allocates OpenAL context and device). But this causes problems under Linux: when user selects some non-working device (e.g. when I select esd device while Esound daemon is not running), OpenAL (correctly) doesn't let me initialize the device (returns nil). But then, after such failure, when I try to initialize *any* other device (that worked before, like alsa or waveout), the initialization of them also fails. I have to restart my program (to restart whole OpenAL library state) to be able to initialize any other backend.

Workaround that I found is to do such OpenALRestart. Release OpenAL library, wait some short time (I guess that otherwise some resources will still occupy the sound device ? In any case, this short sleep is needed...), then do OpenAL library initialization again. And things work correctly.

* OpenAL bool type.

* OpenAL 8bit signed byte.

* OpenAL 8bit unsigned byte.

* OpenAL 16bit signed short integer type.

* OpenAL 16bit unsigned short integer type.

* OpenAL 32bit unsigned integer type.

* OpenAL 32bit signed integer type.

* OpenAL 32bit floating point type.

* OpenAL 64bit double point type.

* OpenAL 32bit type.

* OpenAL enumerations.

* OpenAL bitfields.

* OpenAL clamped float.

* Openal clamped double.

TwoVectors type is useful for OpenAL's listener ORIENTATION property.

bad value

Boolean False.

* Boolean True.

* * Indicate the type of AL_SOURCE. * Sources can be spatialized

* Indicate Source has relative coordinates.

* * Directional source, inner cone angle, in degrees. * Range: [0-360] * Default: 360

* * Directional source, outer cone angle, in degrees. * Range: [0-360] * Default: 360

* * Specify the pitch to be applied, either at source, * or on mixer results, at listener. * Range: [0.5-2.0] * Default: 1.0

* * Specify the current location in three dimensional space. * OpenAL, like OpenGL, uses a right handed coordinate system, * where in a frontal default view X (thumb) points right, * Y points up (index finger), and Z points towards the * viewer/camera (middle finger). * To switch from a left handed coordinate system, flip the * sign on the Z coordinate. * Listener position is always in the world coordinate system.

* Specify the current direction.

* Specify the current velocity in three dimensional space.

* * Indicate whether source is looping. * Type: ALboolean? * Range: [AL_TRUE, AL_FALSE] * Default: FALSE.

* * Indicate whether source is meant to be streaming. * Type: ALboolean? * Range: [AL_TRUE, AL_FALSE] * Default: FALSE.

* * Indicate the buffer to provide sound samples. * Type: ALuint. * Range: any valid Buffer id.

* * Indicate the gain (volume amplification) applied. * Type: ALfloat. * Range: ]0.0- ] * A value of 1.0 means un-attenuated/unchanged. * Each division by 2 equals an attenuation of -6dB. * Each multiplicaton with 2 equals an amplification of +6dB. * A value of 0.0 is meaningless with respect to a logarithmic * scale; it is interpreted as zero volume - the channel * is effectively disabled.

byte offset into source (in canon format). -1 if source * is not playing. Don't set this, get this. * * Type: ALint * Range: -1 - +inf

* Indicate minimum source attenuation * Type: ALfloat * Range: [0.0 - 1.0] * * Logarthmic

* * Indicate maximum source attenuation * Type: ALfloat * Range: [0.0 - 1.0] * * Logarthmic

* * Indicate listener orientation. * * at/up

* * Source state information.

* * Buffer Queue params

* * Buffer states

* Sound samples: format specifier.

* * source specific reference distance * Type: ALfloat * Range: 0.0 - +inf * * At 0.0, no distance attenuation occurs. Default is * 1.0.

* * source specific rolloff factor * Type: ALfloat * Range: 0.0 - +inf *

* * Directional source, outer cone gain. * * Default: 0.0 * Range: [0.0 - 1.0] * Logarithmic

* * Indicate distance above which sources are not * attenuated using the inverse clamped distance model. * * Default: +inf * Type: ALfloat * Range: 0.0 - +inf

* * Sound samples: frequency, in units of Hertz [Hz]. * This is the number of samples per second. Half of the * sample frequency marks the maximum significant * frequency component.

* * Buffer state. * * Not supported for public use (yet).

* Errors: No Error.

* * Invalid Name paramater passed to AL call.

* * Invalid parameter passed to AL call.

* * Invalid enum parameter value.

* * Illegal call.

* * No mojo.

* Context strings: Vendor Name.

* * Doppler scale. Default 1.0

* * Tweaks speed of propagation.

* * Distance scaling

* * Distance models * * used in conjunction with DistanceModel * * implicit: NONE, which disances distance attenuation.

* * Parameter: IASIG ROOM blah * Type: intgeger * Range: [-10000, 0] * Default: -10000

* * Parameter: IASIG ROOM_HIGH_FREQUENCY * Type: integer * Range: [-10000, 0] * Default: 0

* * Parameter: IASIG ROOM_ROLLOFF_FACTOR * Type: float * Range: [0.0, 10.0] * Default: 0.0

* * Parameter: IASIG DECAY_TIME * Type: float * Range: [0.1, 20.0] * Default: 1.0

* * Parameter: IASIG DECAY_HIGH_FREQUENCY_RATIO * Type: float * Range: [0.1, 2.0] * Default: 0.5

* * Parameter: IASIG REFLECTIONS * Type: integer * Range: [-10000, 1000] * Default: -10000

* * Parameter: IASIG REFLECTIONS_DELAY * Type: float * Range: [0.0, 0.3] * Default: 0.02

* * Parameter: IASIG REVERB * Type: integer * Range: [-10000,2000] * Default: -10000

* * Parameter: IASIG REVERB_DELAY * Type: float * Range: [0.0, 0.1] * Default: 0.04

* * Parameter: IASIG DIFFUSION * Type: float * Range: [0.0, 100.0] * Default: 100.0

* * Parameter: IASIG DENSITY * Type: float * Range: [0.0, 100.0] * Default: 100.0

* * Parameter: IASIG HIGH_FREQUENCY_REFERENCE * Type: float * Range: [20.0, 20000.0] * Default: 5000.0

MP3 format. See http://icculus.org/alextreg/index.php?operation=op_showext&extname=AL_EXT_mp3

Ogg Vorbis format. See http://icculus.org/alextreg/index.php?operation=op_showext&extname=AL_EXT_vorbis

bad value

No error.

No device.

Invalid context ID.

Bad enum.

Bad value.

Out of memory.

The Specifier string for default device.

State retrieval.

State retrieval.

State retrieval.

State retrieval.

State retrieval.

State retrieval through return value ( for compatibility ).

Error support. Obtain the most recent error generated in the AL state machine.

Extension support. Obtain the address of a function (usually an extension) with the name fname. All addresses are context-independent.

Extension support. Obtain the address of a function (usually an extension) with the name fname. All addresses are context-independent.

Extension support. Obtain the integer value of an enumeration (usually an extension) with the name ename.

Listener Gain: default 1.0f.

Retrieve listener information.

Create Source objects.

Delete Source objects.

Verify a handle is a valid Source.

Set an integer parameter for a Source object.

Get an integer parameter for a Source object.

Warning: this symbol is deprecated.

Deprecated, included for Win compatibility.

Activate a source, start replay.

Pause a source, temporarily remove it from the mixer list.

Rewind a source, set the source to play at the beginning.

Stop a source, temporarily remove it from the mixer list, and reset its internal state to pre-Play. To remove a Source completely, it has to be deleted following Stop, or before Play.

Buffer object generation.

Specify the data to be filled into a buffer.

Allocate n environment ids and store them in the array environs. Returns the number of environments actually allocated.

Perform processing on a synced context, non-op on a asynchronous context.

Suspend processing on an asynchronous context, non-op on a synced context.

translation of AL/alut.h

ALInited means that functions alXxx and alcXxx are loaded, i.e. their pointers in this module are initialized from appropriate library. Jezeli not ALInited to zawsze wszystkie pointery na funkcje alXxx i alcXxx beda rowne nil.

ALUTInited means that functions alutXxx are loaded (their pointers are loaded from appropriate library) AND that ALInited is true. I.e. it is not posiible to have (ALUTInited = true and ALInited = false). This may look like a simplification of a real situation because _if_ ever (under some OS) alutXxx functions will be loaded from different library than alXxx functions than it _is_ theoretically possible to have alutXxx functions available but alXxx functions. But the truth is that alutXxx functions are treated by me as COMPLETELY UNUSABLE if alXxx functions are not available. So if ALInited = false, we will never even check for alutXxx functions - if ALInited = false we will always set ALUTInited to false too.