org.jdesktop.j3d.examples.sound.audio

Class JOALMixer

java.lang.Object

org.jogamp.java3d.audioengines.AudioEngine

org.jogamp.java3d.audioengines.AudioEngine3D

org.jogamp.java3d.audioengines.AudioEngine3DL2

org.jdesktop.j3d.examples.sound.audio.JOALMixer

All Implemented Interfaces:

AudioDevice, AudioDevice3D, AudioDevice3DL2

public class JOALMixer
extends AudioEngine3DL2
implements AudioDevice, AudioDevice3D, AudioDevice3DL2

This class is a concrete implementation of AudioEngine3DL2 that uses the JOAL/OpenAL sound library to provide rendering of the Sound nodes in Java3D.
Notes:
1. getChannelsAvailable, getNumberOfChannelsUsed and getTotalChannels have not been implemented yet and thus if you try to play more sounds than the system has then they will not play. I am still trying to find out exactly how to implement these functions, possibly there is no limit when rendering sound using software rendering. Also at the moment I think I have limited the implementation to 64 sounds.
2. This implementation only plays wav files.
3. Other functions not implemented have the comment 'NOT IMPLEMENTED' in their respective JavaDoc comment, otherwise the function has been implemented.
4. Webstart demos are available at http://www.dutchie.net/joal/default.htm
Usage:
1. You must have the OpenAL drivers installed on your machine, these can be downloaded for Windows, MacOS, Linux at http://www.openal.org/downloads.html
2. You must have JOAL installed which can be downloaded from https://joal.dev.java.net/ . This includes joal.zip and the native dll/so for your selected platform.
3. To use in your application you simply use:
java -Dj3d.audiodevice=org.jdesktop.j3d.audioengines.joal.JOALMixer [your_application_class] and call viewer.createAudioDevice(); as normal.

Author:

David Grace (dave@dutchie.net)

Field Summary

Fields inherited from interface org.jogamp.java3d.AudioDevice3D

BACKGROUND_SOUND, BUFFERED_AUDIO_DATA, CONE_SOUND, POINT_SOUND, STREAMING_AUDIO_DATA

Fields inherited from interface org.jogamp.java3d.AudioDevice

HEADPHONES, MONO_SPEAKER, STEREO_SPEAKERS

Constructor Summary

Constructors

Constructor and Description
JOALMixer(PhysicalEnvironment physicalEnvironment) Creates a new instance of JOALMixer

Method Summary

Modifier and Type	Method and Description
void	clearSound(int index) Clear Sound.
boolean	close() NOT IMPLEMENTED Code to close the device
static void	exitOpenAL() Unused code for to release resources created with the function above.
float	getAngleOffsetToSpeaker() Get Angle Offset To Speaker returns value set as angle between vector to speaker and Z head axis
int	getAudioPlaybackType() Get Type of Audio Playback Output Device returns audio playback type to which sound is currently output
float	getCenterEarToSpeaker() Get Distance from Ear to Speaker returns value set as distance from listener's ear to speaker
int	getChannelsAvailable() NOT IMPLEMENTED Query number of channels currently available for use by the returns number of sound channels currently available (number not being used by active sounds).
int	getChannelsUsedForSound(Sound sound) Deprecated. This method is now part of the Sound class
int	getNumberOfChannelsUsed(int index) NOT IMPLEMENTED Get number of channels used by a particular sample on the audio device.
int	getNumberOfChannelsUsed(int index, boolean muteFlag) NOT IMPLEMENTED Get number of channels that would be used by a particular sample on the audio device given the mute flag passed in as a parameter.
long	getSampleDuration(int index) Get length of time a sample would play if allowed to play to completion.
long	getStartTime(int index) NOT IMPLEMENTED Get time this sample begun playing on the audio device.
int	getTotalChannels() NOT IMPLEMENTED Query total number of channels available for sound rendering for this audio device.
boolean	initialize() Code to initialize the device
void	muteSample(int index) Mute sample.
void	pause() NOT IMPLEMENTED Pauses audio device engine without closing the device and associated threads.
void	pauseSample(int index) Pause sample.
int	prepareSound(int soundType, MediaContainer soundData) Prepare Sound in device Makes sound assessible to device - in this case attempts to load sound Stores sound type and data.
void	resume() NOT IMPLEMENTED Resumes audio device engine (if previously paused) without reinitializing the device.
void	setAngleOffsetToSpeaker(float angle) Set Angle Offset To Speaker
void	setAngularAttenuation(int index, int filterType, double[] angle, float[] attenuationScaleFactor, float[] filterCutoff) Set angular attenuation arrays affecting angular amplitude attenuation and angular distance filtering Angular attenuation in OpenAL/JOAL is determined by AL_CONE_INNER_ANGLE, AL_CONE_OUTER_ANGLE and AL_CONE_OUTER_GAIN The region inside and AL_CONE_OUTER_ANGLE has its gain unchanged (AL_GAIN), the region inside AL_CONE_INNER_ANGLE and AL_CONE_OUTER_ANGLE has its gain between AL_GAIN and AL_CONE_OUTER_GAIN, and the region outside AL_CONE_OUTER_ANGLE has gain of AL_CONE_OUTER_GAIN This function calculates the AL_CONE_INNER_ANGLE, AL_CONE_OUTER_ANGLE and AL_CONE_OUTER_GAIN from the given angular attenuation data from Java3D.
void	setAudioPlaybackType(int type) Set Type of Audio Playback physical transducer(s) sound is output to Valid types are HEADPHONE, MONO_SPEAKER, STEREO_SPEAKERS
void	setCenterEarToSpeaker(float distance) Set Distance from the Center Ear to a Speaker
void	setDecayFilter(float frequencyCutoff) NOT IMPLEMENTED Set reverb decay filter This provides for frequencies above the given cutoff frequency to be attenuated during reverb decay at a different rate than frequencies below this value Thus, defining a different reverb decay curve for frequencies above the cutoff value.
void	setDecayTime(float time) NOT IMPLEMENTED Set reverb decay time Defines the reverberation decay curve.
void	setDensity(float density) NOT IMPLEMENTED Set reverb density This defines the modal density (also referred to as 'spectral coloration') The value of this parameter is expressed as a percent of the audio device's minimum-to-maximum values for this reverb parameter.
void	setDiffusion(float diffusion) NOT IMPLEMENTED Set reverb diffusion This defines the echo dispersement (also referred to as 'echo density') The value of this reverb parameter is expressed as a percent of the audio device's minimum-to-maximum values.
void	setDirection(int index, Vector3d direction) Set direction vector of sample.
void	setDistanceFilter(int filterType, double[] distance, float[] dist) NOT IMPLEMENTED Set distance filter for current aural attribute applied to all samples.
void	setDistanceGain(int index, double[] frontDistance, float[] frontAttenuationScaleFactor, double[] backDistance, float[] backAttenuationScaleFactor) Set elliptical distance attenuation arrays applied to sample amplitude OPENAL/JOAL calculates the distance attenuation using its default model which is the inverse distance clamped model (equivalent to the IASIG I3DL2 distance model) This is: distance = max(distance, AL_REFERENCE_DISTANCE); distance = max(distance, AL_MAX_DISTANCE); gain = AL_REFERENCE_DISTANCE / (AL_REFERENCE_DISTANCE + AL_ROLLOFF_FACTOR * (distance - AL_REFERENCE_DISTANCE)); This function calculates the AL_REFERENCE_DISTANCE, AL_MAX_DISTANCE and AL_ROLLOFF_FACTOR from the given distance attenuation data from Java3D.
void	setFrequencyScaleFactor(float frequencyScaleFactor) NOT IMPLEMENTED Set frequency scale factor for current aural attribute applied to all samples.
void	setGain(float scaleFactor) Set overall gain control of all sounds playing on the audio device.
void	setLoop(int index, int count) NOT IMPLEMENTED COMPLETELY Set number of times sample is looped Works for values 0 (no loop) and (-1) infinite loop but not for a fix number of loops (>1)
void	setObstructionFilter(int index, float frequencyCutoff) NOT IMPLEMENTED Set the obstruction filter control This provides for frequencies above the given cutoff frequency to be attenuated, during while the gain of an obstruction signal is being calculated, at a different rate than frequencies below this value.
void	setObstructionGain(int index, float scaleFactor) NOT IMPLEMENTED Set the obstruction gain control This method allows for attenuating sound waves traveling between the sound source and the listener obstructed by objects Direct sound signals/waves for obstructed sound source are attenuated but not indirect (reflected) waves.
void	setOcclusionFilter(int index, float frequencyCutoff) NOT IMPLEMENTED Set the occlusion filter control This provides for frequencies above the given cutoff frequency to be attenuated, during while the gain of an occluded signal is being calculated, at a different rate than frequencies below this value There is no corresponding Core AuralAttributes method at this time.
void	setOcclusionGain(int index, float scaleFactor) NOT IMPLEMENTED Set the occlusion gain control This method allows for attenuating sound waves traveling between the sound source and the listener occluded by objects Both direct and indirect sound signals/waves for occluded sound sources are attenuated There is no corresponding Core AuralAttributes method at this time.
void	setPosition(int index, Point3d position) Set location of sample.
void	setRateScaleFactor(int index, float scaleFactor) Set scale factor applied to sample playback rate for a particular sound associated with the audio device Changing the device sample rate affects both the pitch and speed.
void	setReflectionCoefficient(float coefficient) NOT IMPLEMENTED Set reverberation surface reflection coefficient value for current aural attribute applied to all samples.
void	setReflectionDelay(float reflectionDelay) NOT IMPLEMENTED Sets the early reflection delay time In this form, the parameter specifies the delay time between each order of reflection (while reverberation is being rendered) explicitly given in milliseconds.
void	setReverbCoefficient(float coefficient) NOT IMPLEMENTED Set late reflection (referred to as 'reverb') attenuation.
void	setReverbDelay(float reverbDelay) NOT IMPLEMENTED Set reverberation delay time for current aural attribute applied to all samples.
void	setReverbOrder(int reverbOrder) NOT IMPLEMENTED Set reverberation order for current aural attribute applied to all samples.
void	setRolloff(float rolloff) NOT IMPLEMENTED Set rolloff value for current aural attribute applied to all samples.
void	setSampleGain(int index, float scaleFactor) Set gain scale factor applied to sample.
void	setVelocityScaleFactor(float velocityScaleFactor) NOT IMPLEMENTED Set velocity scale factor for current aural attribute applied to all samples when Doppler is calculated.
void	setView(View reference) Save a reference to the current View object.
void	setVworldXfrm(int index, Transform3D trans) DOES NOTHING - does not need to do anything special for JOAL Set the transform for local to virtual world coordinate space
int	startSample(int index) Start sample playing on audio device
int	stopSample(int index) Stop sample playing on audio device
void	unmuteSample(int index) Unmute sample.
void	unpauseSample(int index) Unpause sample.
void	updateSample(int index) DOES NOTHING - not really needed when using JOAL Update sample Implies that some parameters affecting rendering have been modified.

Methods inherited from class org.jogamp.java3d.audioengines.AudioEngine3D

getAuralParameters, getSample, getSampleListSize, getView

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JOALMixer

public JOALMixer(PhysicalEnvironment physicalEnvironment)

Creates a new instance of JOALMixer

Method Detail

setGain

public void setGain(float scaleFactor)

Set overall gain control of all sounds playing on the audio device.

Specified by:

setGain in interface AudioDevice3DL2

Specified by:

setGain in class AudioEngine3DL2

Parameters:

scaleFactor - scale factor applied to calculated amplitudes for all sounds playing on this device

resume

public void resume()

NOT IMPLEMENTED
Resumes audio device engine (if previously paused) without reinitializing the device. Causes all paused cached sounds to be resumed and all streaming sounds restarted.

Specified by:

resume in interface AudioDevice3DL2

Specified by:

resume in class AudioEngine3DL2

pause

public void pause()

NOT IMPLEMENTED
Pauses audio device engine without closing the device and associated threads. Causes all cached sounds to be paused and all streaming sounds to be stopped.

Specified by:

pause in interface AudioDevice3DL2

Specified by:

pause in class AudioEngine3DL2

setView

public void setView(View reference)

Save a reference to the current View object.

Specified by:

setView in interface AudioDevice3D

Overrides:

setView in class AudioEngine3D

Parameters:

reference - to current view object

prepareSound

public int prepareSound(int soundType,
                        MediaContainer soundData)

Prepare Sound in device
Makes sound assessible to device - in this case attempts to load sound Stores sound type and data.

Specified by:

prepareSound in interface AudioDevice3D

Overrides:

prepareSound in class AudioEngine3D

Parameters:

soundType - denotes type of sound: Background, Point or Cone

soundData - descrition of sound source data

Returns:

index into sample vector of Sample object for sound

clearSound

public void clearSound(int index)

Clear Sound. Removes/clears associated sound data with this sound source node

Specified by:

clearSound in interface AudioDevice3D

Specified by:

clearSound in class AudioEngine3D

Parameters:

index - device specific reference number to device driver sample

getSampleDuration

public long getSampleDuration(int index)

Get length of time a sample would play if allowed to play to completion.

Specified by:

getSampleDuration in interface AudioDevice3D

Overrides:

getSampleDuration in class AudioEngine3D

Parameters:

index - device specific reference number to device driver sample

Returns:

length of sample in milliseconds

getNumberOfChannelsUsed

public int getNumberOfChannelsUsed(int index)

NOT IMPLEMENTED
Get number of channels used by a particular sample on the audio device.

Specified by:

getNumberOfChannelsUsed in interface AudioDevice3D

Overrides:

getNumberOfChannelsUsed in class AudioEngine3D

Parameters:

index - device specific reference number to device driver sample

Returns:

number of channels currently being used by this sample.

getNumberOfChannelsUsed

public int getNumberOfChannelsUsed(int index,
                                   boolean muteFlag)

NOT IMPLEMENTED
Get number of channels that would be used by a particular sample on the audio device given the mute flag passed in as a parameter.

Specified by:

getNumberOfChannelsUsed in interface AudioDevice3D

Overrides:

getNumberOfChannelsUsed in class AudioEngine3D

Parameters:

index - device specific reference number to device driver sample

muteFlag - denotes the mute state to assume while executing this query. This mute value does not have to match the current mute state of the sample.

Returns:

number of channels that would be used by this sample if it were playing.

startSample

public int startSample(int index)

Start sample playing on audio device

Specified by:

startSample in interface AudioDevice3D

Specified by:

startSample in class AudioEngine3D

Parameters:

index - device specific reference number to device driver sample

Returns:

status: < 0 denotes an error

getStartTime

public long getStartTime(int index)

NOT IMPLEMENTED
Get time this sample begun playing on the audio device.

Specified by:

getStartTime in interface AudioDevice3D

Overrides:

getStartTime in class AudioEngine3D

Parameters:

index - device specific reference number to device driver sample

Returns:

system clock time sample started

stopSample

public int stopSample(int index)

Stop sample playing on audio device

Specified by:

stopSample in interface AudioDevice3D

Specified by:

stopSample in class AudioEngine3D

Parameters:

index - device specific reference number to device driver sample

Returns:

status: < 0 denotes an error

setSampleGain

public void setSampleGain(int index,
                          float scaleFactor)

Set gain scale factor applied to sample.

Specified by:

setSampleGain in interface AudioDevice3D

Overrides:

setSampleGain in class AudioEngine3D

Parameters:

index - device specific reference number to device driver sample

scaleFactor - floating point multiplier applied to sample amplitude

setLoop

public void setLoop(int index,
                    int count)

NOT IMPLEMENTED COMPLETELY
Set number of times sample is looped
Works for values 0 (no loop) and (-1) infinite loop but not for a fix number of loops (>1)

Specified by:

setLoop in interface AudioDevice3D

Overrides:

setLoop in class AudioEngine3D

Parameters:

index - device specific reference number to device driver sample

count - number of times sample is repeated

See Also:

Sound.setLoop(int)

setVworldXfrm

public void setVworldXfrm(int index,
                          Transform3D trans)

DOES NOTHING - does not need to do anything special for JOAL
Set the transform for local to virtual world coordinate space

Specified by:

setVworldXfrm in interface AudioDevice3D

Overrides:

setVworldXfrm in class AudioEngine3D

Parameters:

index - device specific reference number to device driver sample

trans - is a reference to virtual world composite transform

setPosition

public void setPosition(int index,
                        Point3d position)

Set location of sample.

Specified by:

setPosition in interface AudioDevice3D

Overrides:

setPosition in class AudioEngine3D

Parameters:

index - device specific reference number to device driver sample

position - point location in virtual world coordinate of sample

See Also:

PointSound.setPosition(float x, float y, float z), PointSound.setPosition(Point3f position)

setDistanceGain

public void setDistanceGain(int index,
                            double[] frontDistance,
                            float[] frontAttenuationScaleFactor,
                            double[] backDistance,
                            float[] backAttenuationScaleFactor)

Set elliptical distance attenuation arrays applied to sample amplitude
OPENAL/JOAL calculates the distance attenuation using its default model which is the inverse distance clamped model (equivalent to the IASIG I3DL2 distance model)
This is:
distance = max(distance, AL_REFERENCE_DISTANCE);
distance = max(distance, AL_MAX_DISTANCE);
gain = AL_REFERENCE_DISTANCE / (AL_REFERENCE_DISTANCE + AL_ROLLOFF_FACTOR * (distance - AL_REFERENCE_DISTANCE));
This function calculates the AL_REFERENCE_DISTANCE, AL_MAX_DISTANCE and AL_ROLLOFF_FACTOR from the given distance attenuation data from Java3D.

Specified by:

setDistanceGain in interface AudioDevice3D

Overrides:

setDistanceGain in class AudioEngine3D

Parameters:

index - device specific reference number to device driver sample

frontDistance - defines an array of distance along the position axis thru which ellipses pass

frontAttenuationScaleFactor - gain scale factors

backDistance - defines an array of distance along the negative axis thru which ellipses pass

backAttenuationScaleFactor - gain scale factors

See Also:

ConeSound.setDistanceGain(float[] frontDistance, float[] frontGain, float[] backDistance, float[] backGain), ConeSound.setDistanceGain(Point2f[] frontAttenuation, Point2f[] backAttenuation)

setDirection

public void setDirection(int index,
                         Vector3d direction)

Set direction vector of sample.

Specified by:

setDirection in interface AudioDevice3D

Overrides:

setDirection in class AudioEngine3D

Parameters:

index - device specific reference number to device driver sample

direction - vector in virtual world coordinate.

See Also:

ConeSound.setDirection(float x, float y, float z), ConeSound.setDirection(Vector3f direction)

setAngularAttenuation

public void setAngularAttenuation(int index,
                                  int filterType,
                                  double[] angle,
                                  float[] attenuationScaleFactor,
                                  float[] filterCutoff)

Set angular attenuation arrays affecting angular amplitude attenuation and angular distance filtering
Angular attenuation in OpenAL/JOAL is determined by AL_CONE_INNER_ANGLE, AL_CONE_OUTER_ANGLE and AL_CONE_OUTER_GAIN
The region inside and AL_CONE_OUTER_ANGLE has its gain unchanged (AL_GAIN), the region inside AL_CONE_INNER_ANGLE and AL_CONE_OUTER_ANGLE has its gain between AL_GAIN and AL_CONE_OUTER_GAIN, and the region outside AL_CONE_OUTER_ANGLE has gain of AL_CONE_OUTER_GAIN
This function calculates the AL_CONE_INNER_ANGLE, AL_CONE_OUTER_ANGLE and AL_CONE_OUTER_GAIN from the given angular attenuation data from Java3D.

Specified by:

setAngularAttenuation in interface AudioDevice3D

Overrides:

setAngularAttenuation in class AudioEngine3D

Parameters:

index - device specific reference number to device driver sample

filterType - denotes type of filtering (on no filtering) applied to sample.

angle - array containing angular distances from sound axis

attenuationScaleFactor - array containing gain scale factor

filterCutoff - array containing filter cutoff frequencies. The filter values for each tuples can be set to Sound.NO_FILTER.

See Also:

ConeSound.setAngularAttenuation(float[] distance, float[] gain, float[] filter), ConeSound.setAngularAttenuation(Point3f[] attenuation), ConeSound.setAngularAttenuation(Point2f[] attenuation)

setRolloff

public void setRolloff(float rolloff)

NOT IMPLEMENTED
Set rolloff value for current aural attribute applied to all samples.

Specified by:

setRolloff in interface AudioDevice3D

Overrides:

setRolloff in class AudioEngine3D

Parameters:

rolloff - scale factor applied to standard speed of sound.

See Also:

AuralAttributes.setRolloff(float)

setReflectionCoefficient

public void setReflectionCoefficient(float coefficient)

NOT IMPLEMENTED
Set reverberation surface reflection coefficient value for current aural attribute applied to all samples.

Specified by:

setReflectionCoefficient in interface AudioDevice3D

Overrides:

setReflectionCoefficient in class AudioEngine3D

Parameters:

coefficient - applied to amplitude of reverbation added at each iteration of reverb processing.

See Also:

AuralAttributes.setReflectionCoefficient(float)

setReverbDelay

public void setReverbDelay(float reverbDelay)

NOT IMPLEMENTED
Set reverberation delay time for current aural attribute applied to all samples.

Specified by:

setReverbDelay in interface AudioDevice3D

Overrides:

setReverbDelay in class AudioEngine3D

Parameters:

reverbDelay - amount of time in millisecond between each iteration of reverb processing.

See Also:

AuralAttributes.setReverbDelay(float reverbDelay)

setReverbOrder

public void setReverbOrder(int reverbOrder)

NOT IMPLEMENTED
Set reverberation order for current aural attribute applied to all samples.

Specified by:

setReverbOrder in interface AudioDevice3D

Overrides:

setReverbOrder in class AudioEngine3D

Parameters:

reverbOrder - number of times reverb process loop is iterated.

See Also:

AuralAttributes.setReverbOrder(int)

setDistanceFilter

public void setDistanceFilter(int filterType,
                              double[] distance,
                              float[] dist)

NOT IMPLEMENTED
Set distance filter for current aural attribute applied to all samples.

Specified by:

setDistanceFilter in interface AudioDevice3D

Overrides:

setDistanceFilter in class AudioEngine3D

Parameters:

filterType - denotes type of filtering (on no filtering) applied to all sample based on distance between listener and sound.

dist - is an attenuation array of distance and low-pass filter values.

distance - is an attenuation array of distance and low-pass filter values.

See Also:

AuralAttributes.setDistanceFilter(float[] distance, float[] frequencyCutoff), AuralAttributes.setDistanceFilter(Point2f[] attenuation)

setFrequencyScaleFactor

public void setFrequencyScaleFactor(float frequencyScaleFactor)

NOT IMPLEMENTED
Set frequency scale factor for current aural attribute applied to all samples.

Specified by:

setFrequencyScaleFactor in interface AudioDevice3D

Overrides:

setFrequencyScaleFactor in class AudioEngine3D

Parameters:

frequencyScaleFactor - frequency scale factor applied to samples normal playback rate.

See Also:

AuralAttributes.setFrequencyScaleFactor(float)

setVelocityScaleFactor

public void setVelocityScaleFactor(float velocityScaleFactor)

NOT IMPLEMENTED
Set velocity scale factor for current aural attribute applied to all samples when Doppler is calculated.

Specified by:

setVelocityScaleFactor in interface AudioDevice3D

Overrides:

setVelocityScaleFactor in class AudioEngine3D

Parameters:

velocityScaleFactor - scale factor applied to postional samples' listener-to-soundSource velocity. playback rate.

See Also:

AuralAttributes.setVelocityScaleFactor(float)

muteSample

public void muteSample(int index)

Mute sample.

Specified by:

muteSample in interface AudioDevice3D

Specified by:

muteSample in class AudioEngine3D

Parameters:

index - device specific reference number to device driver sample

unmuteSample

public void unmuteSample(int index)

Unmute sample.

Specified by:

unmuteSample in interface AudioDevice3D

Specified by:

unmuteSample in class AudioEngine3D

Parameters:

index - device specific reference number to device driver sample

pauseSample

public void pauseSample(int index)

Pause sample.

Specified by:

pauseSample in interface AudioDevice3D

Specified by:

pauseSample in class AudioEngine3D

Parameters:

index - device specific reference number to device driver sample

unpauseSample

public void unpauseSample(int index)

Unpause sample.

Specified by:

unpauseSample in interface AudioDevice3D

Specified by:

unpauseSample in class AudioEngine3D

Parameters:

index - device specific reference number to device driver sample

updateSample

public void updateSample(int index)

DOES NOTHING - not really needed when using JOAL
Update sample Implies that some parameters affecting rendering have been modified.

Specified by:

updateSample in interface AudioDevice3D

Specified by:

updateSample in class AudioEngine3D

Parameters:

index - device specific reference number to device driver sample

initialize

public boolean initialize()

Code to initialize the device

Specified by:

initialize in interface AudioDevice

Specified by:

initialize in class AudioEngine

Returns:

flag: true is initialized sucessfully, false if error

close

public boolean close()

NOT IMPLEMENTED
Code to close the device

Specified by:

close in interface AudioDevice

Specified by:

close in class AudioEngine

Returns:

flag: true is closed sucessfully, false if error

setAudioPlaybackType

public void setAudioPlaybackType(int type)

Set Type of Audio Playback physical transducer(s) sound is output to
Valid types are HEADPHONE, MONO_SPEAKER, STEREO_SPEAKERS

Specified by:

setAudioPlaybackType in interface AudioDevice

Overrides:

setAudioPlaybackType in class AudioEngine

Parameters:

type - of audio output device

getAudioPlaybackType

public int getAudioPlaybackType()

Get Type of Audio Playback Output Device returns audio playback type to which sound is currently output

Specified by:

getAudioPlaybackType in interface AudioDevice

Overrides:

getAudioPlaybackType in class AudioEngine

Returns:

audio playback type

setCenterEarToSpeaker

public void setCenterEarToSpeaker(float distance)

Set Distance from the Center Ear to a Speaker

Specified by:

setCenterEarToSpeaker in interface AudioDevice

Overrides:

setCenterEarToSpeaker in class AudioEngine

Parameters:

distance - from the center ear and to the speaker

getCenterEarToSpeaker

public float getCenterEarToSpeaker()

Get Distance from Ear to Speaker returns value set as distance from listener's ear to speaker

Specified by:

getCenterEarToSpeaker in interface AudioDevice

Overrides:

getCenterEarToSpeaker in class AudioEngine

Returns:

distance from interaural midpoint between the ears to closest speaker

setAngleOffsetToSpeaker

public void setAngleOffsetToSpeaker(float angle)

Set Angle Offset To Speaker

Specified by:

setAngleOffsetToSpeaker in interface AudioDevice

Overrides:

setAngleOffsetToSpeaker in class AudioEngine

Parameters:

angle - in radian between head coordinate Z axis and vector to speaker

getAngleOffsetToSpeaker

public float getAngleOffsetToSpeaker()

Get Angle Offset To Speaker returns value set as angle between vector to speaker and Z head axis

Specified by:

getAngleOffsetToSpeaker in interface AudioDevice

Overrides:

getAngleOffsetToSpeaker in class AudioEngine

Returns:

angle in radians from head Z axis and vector from center ear to speaker

getTotalChannels

public int getTotalChannels()

NOT IMPLEMENTED
Query total number of channels available for sound rendering for this audio device. returns number of maximum sound channels you can run with this library/device-driver.

Specified by:

getTotalChannels in interface AudioDevice

Overrides:

getTotalChannels in class AudioEngine

Returns:

total number of channels that can be used for this audio device

getChannelsAvailable

public int getChannelsAvailable()

NOT IMPLEMENTED
Query number of channels currently available for use by the returns number of sound channels currently available (number not being used by active sounds).

Specified by:

getChannelsAvailable in interface AudioDevice

Overrides:

getChannelsAvailable in class AudioEngine

Returns:

total number of channels current available

getChannelsUsedForSound

public int getChannelsUsedForSound(Sound sound)

Deprecated. This method is now part of the Sound class

Query number of channels that would be used to render a particular sound node.

Specified by:

getChannelsUsedForSound in interface AudioDevice

Overrides:

getChannelsUsedForSound in class AudioEngine

Parameters:

sound - refenence to sound node that query to be performed on returns number of sound channels used by a specific Sound node

Returns:

number of channels a particular Sound node is using or would used if enabled and activated (rendered).

setRateScaleFactor

public void setRateScaleFactor(int index,
                               float scaleFactor)

Set scale factor applied to sample playback rate for a particular sound associated with the audio device
Changing the device sample rate affects both the pitch and speed. This scale factor is applied to ALL sound types
Changes (scales) the playback rate of a sound independent of Doppler rate changes.

Specified by:

setRateScaleFactor in interface AudioDevice3DL2

Overrides:

setRateScaleFactor in class AudioEngine3DL2

Parameters:

index - device specific reference to device driver sample

scaleFactor - non-negative factor applied to calculated amplitudes for all sounds playing on this device

See Also:

Sound.setRateScaleFactor(float)

setReverbCoefficient

public void setReverbCoefficient(float coefficient)

NOT IMPLEMENTED
Set late reflection (referred to as 'reverb') attenuation. This scale factor is applied to iterative, indistinguishable late reflections that constitute the tail of reverberated sound in the aural environment
This parameter, along with the early reflection coefficient, defines the reflective/absorptive characteristic of the surfaces in the current listening region.

Specified by:

setReverbCoefficient in interface AudioDevice3DL2

Overrides:

setReverbCoefficient in class AudioEngine3DL2

Parameters:

coefficient - late reflection attenuation factor

See Also:

AuralAttributes.setReverbCoefficient(float)

setReflectionDelay

public void setReflectionDelay(float reflectionDelay)

NOT IMPLEMENTED Sets the early reflection delay time
In this form, the parameter specifies the delay time between each order of reflection (while reverberation is being rendered) explicitly given in milliseconds.

Specified by:

setReflectionDelay in interface AudioDevice3DL2

Overrides:

setReflectionDelay in class AudioEngine3DL2

Parameters:

reflectionDelay - time between each order of early reflection

See Also:

AuralAttributes.setReflectionDelay(float)

setDecayTime

public void setDecayTime(float time)

NOT IMPLEMENTED
Set reverb decay time
Defines the reverberation decay curve.

Specified by:

setDecayTime in interface AudioDevice3DL2

Overrides:

setDecayTime in class AudioEngine3DL2

Parameters:

time - decay time in milliseconds

See Also:

AuralAttributes.setDecayTime(float)

setDecayFilter

public void setDecayFilter(float frequencyCutoff)

NOT IMPLEMENTED
Set reverb decay filter
This provides for frequencies above the given cutoff frequency to be attenuated during reverb decay at a different rate than frequencies below this value
Thus, defining a different reverb decay curve for frequencies above the cutoff value.

Specified by:

setDecayFilter in interface AudioDevice3DL2

Overrides:

setDecayFilter in class AudioEngine3DL2

Parameters:

frequencyCutoff - value of frequencies in Hertz above which a low-pass filter is applied.

See Also:

AuralAttributes.setDecayFilter(float)

setDiffusion

public void setDiffusion(float diffusion)

NOT IMPLEMENTED
Set reverb diffusion
This defines the echo dispersement (also referred to as 'echo density')
The value of this reverb parameter is expressed as a percent of the audio device's minimum-to-maximum values.

Specified by:

setDiffusion in interface AudioDevice3DL2

Overrides:

setDiffusion in class AudioEngine3DL2

Parameters:

diffusion - percentage expressed within the range of 0.0 and 1.0

See Also:

AuralAttributes.setDiffusion(float)

setDensity

public void setDensity(float density)

NOT IMPLEMENTED
Set reverb density
This defines the modal density (also referred to as 'spectral coloration')
The value of this parameter is expressed as a percent of the audio device's minimum-to-maximum values for this reverb parameter.

Specified by:

setDensity in interface AudioDevice3DL2

Overrides:

setDensity in class AudioEngine3DL2

Parameters:

density - reverb density expressed as a percentage, within the range of 0.0 and 1.0

See Also:

AuralAttributes.setDensity(float)

setObstructionGain

public void setObstructionGain(int index,
                               float scaleFactor)

NOT IMPLEMENTED
Set the obstruction gain control
This method allows for attenuating sound waves traveling between the sound source and the listener obstructed by objects
Direct sound signals/waves for obstructed sound source are attenuated but not indirect (reflected) waves. There is no corresponding Core AuralAttributes method at this time.

Specified by:

setObstructionGain in interface AudioDevice3DL2

Overrides:

setObstructionGain in class AudioEngine3DL2

Parameters:

index - device specific reference to device driver sample

scaleFactor - non-negative factor applied to direct sound gain

setObstructionFilter

public void setObstructionFilter(int index,
                                 float frequencyCutoff)

NOT IMPLEMENTED
Set the obstruction filter control
This provides for frequencies above the given cutoff frequency to be attenuated, during while the gain of an obstruction signal is being calculated, at a different rate than frequencies below this value. There is no corresponding Core AuralAttributes method at this time.

Specified by:

setObstructionFilter in interface AudioDevice3DL2

Overrides:

setObstructionFilter in class AudioEngine3DL2

Parameters:

index - device specific reference to device driver sample

frequencyCutoff - value of frequencies in Hertz above which a low-pass filter is applied.

setOcclusionGain

public void setOcclusionGain(int index,
                             float scaleFactor)

NOT IMPLEMENTED
Set the occlusion gain control
This method allows for attenuating sound waves traveling between the sound source and the listener occluded by objects
Both direct and indirect sound signals/waves for occluded sound sources are attenuated
There is no corresponding Core AuralAttributes method at this time.

Specified by:

setOcclusionGain in interface AudioDevice3DL2

Overrides:

setOcclusionGain in class AudioEngine3DL2

Parameters:

index - device specific reference to device driver sample

scaleFactor - non-negative factor applied to direct sound gain

setOcclusionFilter

public void setOcclusionFilter(int index,
                               float frequencyCutoff)

NOT IMPLEMENTED
Set the occlusion filter control
This provides for frequencies above the given cutoff frequency to be attenuated, during while the gain of an occluded signal is being calculated, at a different rate than frequencies below this value
There is no corresponding Core AuralAttributes method at this time.

Specified by:

setOcclusionFilter in interface AudioDevice3DL2

Overrides:

setOcclusionFilter in class AudioEngine3DL2

Parameters:

index - device specific reference to device driver sample

frequencyCutoff - value of frequencies in Hertz above which a low-pass filter is applied.

exitOpenAL

public static void exitOpenAL()

Unused code for to release resources created with the function above. Maybe useful later if the option of selecting which device on the machine is used. This would be used to close device.