Package com.jogamp.openal.util

Class ALAudioSink

java.lang.Object

com.jogamp.openal.util.ALAudioSink

All Implemented Interfaces:

AudioSink

public final class ALAudioSink
extends Object
implements AudioSink

OpenAL AudioSink implementation.

Besides given AudioSink functionality, implementation is fully functional regarding AudioFormat and all OpenAL parameter.

• All OpenAL parameter can be queried
• Instance can be constructed with an OpenAL device and context, see #ALAudioSink(ALCdevice, ALCcontext)
• Initialization can be performed with OpenAL paramters, see #init(int, int, int, int, int, float, int, int, int)

Nested Class Summary

Nested classes/interfaces inherited from interface com.jogamp.common.av.AudioSink

AudioSink.AudioDataFrame, AudioSink.AudioFrame

Field Summary

Fields inherited from interface com.jogamp.common.av.AudioSink

DEBUG, DefaultFormat, DefaultFrameDuration, DefaultInitialQueueSize, DefaultQueueGrowAmount, DefaultQueueLimitAudioOnly, DefaultQueueLimitWithVideo

Constructor Summary

Constructors

Constructor	Description
ALAudioSink()	Create a new instance with a new default ALCdevice
ALAudioSink(Device alDevice)	Create a new instance with an optional given ALCdevice
ALAudioSink(String deviceName)	Create a new instance with a new named ALCdevice

Method Summary

Modifier and Type	Method	Description
void	destroy()
AudioSink.AudioFrame	enqueueData(int pts, ByteBuffer bytes, int byteCount)
void	flush()
static AL	getAL()	Return OpenAL global AL.
static ALC	getALC()	Return OpenAL global ALC.
int	getALChannelLayout()	Return this instance's OpenAL channel layout, set after #init(AudioFormat, float, int, int, int).
static ALExt	getALExt()	Return OpenAL global ALExt.
int	getALFormat()	Return this instance's OpenAL format, set after #init(AudioFormat, float, int, int, int).
int	getALSampleType()	Return this instance's OpenAL sample type, set after #init(AudioFormat, float, int, int, int).
float	getAvgFrameDuration()
AudioFormat	getChosenFormat()
Context	getContext()	Return this instance's OpenAL Context.
float	getDefaultLatency()
Device	getDevice()	Return this instance's OpenAL Device.
int	getEnqueuedFrameCount()
int	getFrameCount()
int	getFreeFrameCount()
float	getLatency()
AudioFormat	getNativeFormat()
String	getPerfString()
float	getPlaySpeed()
AudioFormat	getPreferredFormat()
int	getPTS()
int	getQueuedByteCount()
int	getQueuedFrameCount()
float	getQueuedTime()
Source	getSource()	Return this instance's OpenAL Source.
int	getSourceCount()
float	getVolume()
boolean	hasALCThreadLocalContext()	Return whether OpenAL extension ALC_EXT_thread_local_context is available.
boolean	hasEXTDouble()	Return whether OpenAL extension AL_EXT_DOUBLE is available.
boolean	hasEXTFloat32()	Return whether OpenAL extension AL_EXT_FLOAT32 is available.
boolean	hasEXTMcFormats()	Return whether OpenAL extension AL_EXT_MCFORMATS is available.
boolean	hasSOFTBufferSamples()	Return whether OpenAL extension AL_SOFT_buffer_samples is available.
boolean	init(int alChannelLayout, int alSampleType, int alFormat, int sampleRate, int sampleSize, int frameDurationHint, int initialQueueSize, int queueGrowAmount, int queueLimit)	Initializes the sink using the given OpenAL audio parameter and streaming details.
boolean	init(AudioFormat requestedFormat, int frameDuration, int initialQueueSize, int queueGrowAmount, int queueLimit)
boolean	isAvailable()
static boolean	isInitialized()	Returns true if OpenAL has been loaded and static fields ALC, AL and ALExt have been initialized successfully, otherwise false.
boolean	isPlaying()
boolean	isSupported(AudioFormat format)
boolean	makeCurrent(boolean throwException)
void	pause()
void	play()
boolean	release(boolean throwException)
void	setChannelLimit(int cc)
boolean	setPlaySpeed(float rate)
boolean	setVolume(float v)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ALAudioSink

public ALAudioSink()
            throws ALException

Create a new instance with a new default ALCdevice

Throws:

ALException - if the default ALCdevice couldn't be fully created including its context.

ALAudioSink

public ALAudioSink(String deviceName)
            throws ALException

Create a new instance with a new named ALCdevice

Parameters:

deviceName - name of

Throws:

ALException - if the default ALCdevice couldn't be fully created including its context.

ALAudioSink

public ALAudioSink(Device alDevice)
            throws ALException

Create a new instance with an optional given ALCdevice

Parameters:

alDevice - optional OpenAL Device, a default device is opened if null.

Throws:

ALException - if the default ALCdevice couldn't be fully created including its context.

Method Detail

isInitialized

public static boolean isInitialized()

Returns true if OpenAL has been loaded and static fields ALC, AL and ALExt have been initialized successfully, otherwise false.

getAL

public static final AL getAL()

Return OpenAL global AL.

getALC

public static final ALC getALC()

Return OpenAL global ALC.

getALExt

public static final ALExt getALExt()

Return OpenAL global ALExt.

getDevice

public final Device getDevice()

Return this instance's OpenAL Device.

getContext

public final Context getContext()

Return this instance's OpenAL Context.

getSource

public final Source getSource()

Return this instance's OpenAL Source.

hasSOFTBufferSamples

public final boolean hasSOFTBufferSamples()

Return whether OpenAL extension AL_SOFT_buffer_samples is available.

hasEXTMcFormats

public final boolean hasEXTMcFormats()

Return whether OpenAL extension AL_EXT_MCFORMATS is available.

hasEXTFloat32

public final boolean hasEXTFloat32()

Return whether OpenAL extension AL_EXT_FLOAT32 is available.

hasEXTDouble

public final boolean hasEXTDouble()

Return whether OpenAL extension AL_EXT_DOUBLE is available.

hasALCThreadLocalContext

public final boolean hasALCThreadLocalContext()

Return whether OpenAL extension ALC_EXT_thread_local_context is available.

getALChannelLayout

public final int getALChannelLayout()

Return this instance's OpenAL channel layout, set after #init(AudioFormat, float, int, int, int).

getALSampleType

public final int getALSampleType()

Return this instance's OpenAL sample type, set after #init(AudioFormat, float, int, int, int).

getALFormat

public final int getALFormat()

Return this instance's OpenAL format, set after #init(AudioFormat, float, int, int, int).

makeCurrent

public final boolean makeCurrent(boolean throwException)

Specified by:

makeCurrent in interface AudioSink

release

public final boolean release(boolean throwException)

Specified by:

release in interface AudioSink

toString

public final String toString()

Overrides:

toString in class Object

getPerfString

public final String getPerfString()

getSourceCount

public int getSourceCount()

Specified by:

getSourceCount in interface AudioSink

getDefaultLatency

public float getDefaultLatency()

Specified by:

getDefaultLatency in interface AudioSink

getLatency

public float getLatency()

Specified by:

getLatency in interface AudioSink

getNativeFormat

public final AudioFormat getNativeFormat()

Specified by:

getNativeFormat in interface AudioSink

getPreferredFormat

public final AudioFormat getPreferredFormat()

Specified by:

getPreferredFormat in interface AudioSink

setChannelLimit

public final void setChannelLimit(int cc)

Specified by:

setChannelLimit in interface AudioSink

isSupported

public final boolean isSupported(AudioFormat format)

Specified by:

isSupported in interface AudioSink

init

public final boolean init(AudioFormat requestedFormat,
                          int frameDuration,
                          int initialQueueSize,
                          int queueGrowAmount,
                          int queueLimit)

Specified by:

init in interface AudioSink

init

public final boolean init(int alChannelLayout,
                          int alSampleType,
                          int alFormat,
                          int sampleRate,
                          int sampleSize,
                          int frameDurationHint,
                          int initialQueueSize,
                          int queueGrowAmount,
                          int queueLimit)

Initializes the sink using the given OpenAL audio parameter and streaming details.

Parameters:

alChannelLayout - OpenAL channel layout

alSampleType - OpenAL sample type

alFormat - OpenAL format

sampleRate - sample rate, e.g. 44100

sampleSize - sample size in bits, e.g. 16

frameDurationHint - average AudioSink.AudioFrame duration hint in milliseconds. Assists to shape the AudioSink.AudioFrame initial queue size using `initialQueueSize`. Assists to adjust latency of the backend, as currently used for JOAL's ALAudioSink. A value below 30ms or AudioSink.DefaultFrameDuration may increase the audio processing load. Assumed as AudioSink.DefaultFrameDuration, if frameDuration < 1 ms.

initialQueueSize - initial queue size in milliseconds, see AudioSink.DefaultInitialQueueSize. Uses `frameDurationHint` to determine initial AudioSink.AudioFrame queue size.

queueGrowAmount - queue grow size in milliseconds if queue is full, see AudioSink.DefaultQueueGrowAmount. Uses getAvgFrameDuration() to determine AudioSink.AudioFrame queue growth amount.

queueLimit - maximum time in milliseconds the queue can hold (and grow), see AudioSink.DefaultQueueLimitWithVideo and AudioSink.DefaultQueueLimitAudioOnly. Uses getAvgFrameDuration() to determine AudioSink.AudioFrame queue limit.

Returns:

true if successful, otherwise false

See Also:

enqueueData(int, ByteBuffer, int), getAvgFrameDuration(), ALHelpers.getAudioFormat(int, int, int, int, int), #init(AudioFormat, float, int, int, int)

getChosenFormat

public final AudioFormat getChosenFormat()

Specified by:

getChosenFormat in interface AudioSink

destroy

public final void destroy()

Specified by:

destroy in interface AudioSink

isAvailable

public final boolean isAvailable()

Specified by:

isAvailable in interface AudioSink

enqueueData

public final AudioSink.AudioFrame enqueueData(int pts,
                                              ByteBuffer bytes,
                                              int byteCount)

Specified by:

enqueueData in interface AudioSink

isPlaying

public final boolean isPlaying()

Specified by:

isPlaying in interface AudioSink

play

public final void play()

Specified by:

play in interface AudioSink

pause

public final void pause()

Specified by:

pause in interface AudioSink

getPlaySpeed

public final float getPlaySpeed()

Specified by:

getPlaySpeed in interface AudioSink

setPlaySpeed

public final boolean setPlaySpeed(float rate)

Specified by:

setPlaySpeed in interface AudioSink

getVolume

public final float getVolume()

Specified by:

getVolume in interface AudioSink

setVolume

public final boolean setVolume(float v)

Specified by:

setVolume in interface AudioSink

flush

public final void flush()

Specified by:

flush in interface AudioSink

getEnqueuedFrameCount

public final int getEnqueuedFrameCount()

Specified by:

getEnqueuedFrameCount in interface AudioSink

getFrameCount

public final int getFrameCount()

Specified by:

getFrameCount in interface AudioSink

getQueuedFrameCount

public final int getQueuedFrameCount()

Specified by:

getQueuedFrameCount in interface AudioSink

getFreeFrameCount

public final int getFreeFrameCount()

Specified by:

getFreeFrameCount in interface AudioSink

getQueuedByteCount

public final int getQueuedByteCount()

Specified by:

getQueuedByteCount in interface AudioSink

getQueuedTime

public final float getQueuedTime()

Specified by:

getQueuedTime in interface AudioSink

getAvgFrameDuration

public float getAvgFrameDuration()

Specified by:

getAvgFrameDuration in interface AudioSink

getPTS

public final int getPTS()

Specified by:

getPTS in interface AudioSink