Class JoalAudioSource
- java.lang.Object
-
- jmri.implementation.AbstractNamedBean
-
- jmri.implementation.AbstractAudio
-
- jmri.jmrit.audio.AbstractAudioSource
-
- jmri.jmrit.audio.JoalAudioSource
-
- All Implemented Interfaces:
java.lang.Comparable<NamedBean>,Audio,PropertyChangeProvider,AudioSource,NamedBean
public class JoalAudioSource extends AbstractAudioSource
JOAL implementation of the Audio Source sub-class.For now, no system-specific implementations are forseen - this will remain internal-only
This software is based on or using the JOAL Library available from http://jogamp.org/joal/www/
JOAL is released under the BSD license. The full license terms follow:
Copyright (c) 2003-2006 Sun Microsystems, Inc. All Rights Reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistribution of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistribution in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of Sun Microsystems, Inc. or the names of contributors may be used to endorse or promote products derived from this software without specific prior written permission.
This software is provided "AS IS," without a warranty of any kind. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
You acknowledge that this software is not designed or intended for use in the design, construction, operation or maintenance of any nuclear facility.
This file is part of JMRI.JMRI is free software; you can redistribute it and/or modify it under the terms of version 2 of the GNU General Public License as published by the Free Software Foundation. See the "COPYING" file for a copy of this license.
JMRI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class jmri.jmrit.audio.AbstractAudioSource
AbstractAudioSource.AudioSourceFadeThread, AbstractAudioSource.AudioSourceMoveThread
-
Nested classes/interfaces inherited from interface jmri.NamedBean
NamedBean.BadNameException, NamedBean.BadSystemNameException, NamedBean.BadUserNameException, NamedBean.DisplayOptions, NamedBean.DuplicateSystemNameException
-
-
Field Summary
-
Fields inherited from class jmri.implementation.AbstractNamedBean
listenerRefs, mSystemName, register
-
Fields inherited from interface jmri.Audio
AT, BUFFER, CMD_BIND_BUFFER, CMD_FADE_IN, CMD_FADE_OUT, CMD_INIT_FACTORY, CMD_LOAD_SOUND, CMD_PAUSE, CMD_PAUSE_TOGGLE, CMD_PLAY, CMD_PLAY_TOGGLE, CMD_QUEUE_BUFFERS, CMD_RESET_POSITION, CMD_RESUME, CMD_REWIND, CMD_STOP, CMD_UNQUEUE_BUFFERS, DECIMAL_PLACES, FADE_IN, FADE_NONE, FADE_OUT, LISTENER, MAX_DISTANCE, SOURCE, STATE_EMPTY, STATE_INITIAL, STATE_LOADED, STATE_MOVING, STATE_PLAYING, STATE_POSITIONED, STATE_STOPPED, UP
-
Fields inherited from interface jmri.jmrit.audio.AudioSource
LOOP_CONTINUOUS, LOOP_NONE
-
Fields inherited from interface jmri.NamedBean
DISPLAY_NAME_FORMAT, INCONSISTENT, PROPERTY_COMMENT, PROPERTY_ENABLED, PROPERTY_KNOWN_STATE, PROPERTY_STATE, PROPERTY_USERNAME, QUOTED_NAME_FORMAT, UNKNOWN
-
-
Constructor Summary
Constructors Constructor Description JoalAudioSource(java.lang.String systemName)Constructor for new JoalAudioSource with system nameJoalAudioSource(java.lang.String systemName, java.lang.String userName)Constructor for new JoalAudioSource with system name and user name
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intattachSourcesToEffects()Method to attach sources to effects(package private) booleanbindAudioBuffer(AudioBuffer audioBuffer)Binds this AudioSource with the specified AudioBuffer.protected voidcalculateGain()Calculate the gain of this AudioSource based on distance from listener and fade levels.protected voidchangePosition(javax.vecmath.Vector3f pos)Change the current position of this source.protected voidcleanup()Abstract method that concrete classes will implement to perform necessary cleanup routines.intdetachSourcesToEffects()Method to detach sources to effectsprotected voiddoFadeIn()Fade in then play this AudioSource.protected voiddoFadeOut()Fade out then stop this AudioSource.protected voiddoPause()Stop playing the clip but retain the current position.protected voiddoPlay()Play the clip from the beginning.protected voiddoResume()Play the clip from the current position.protected voiddoRewind()Rewind clip to the beginning.protected voiddoStop()Stop playing the clip and rewind to the beginning.intgetState()Provide generic access to internal state.intnumProcessedBuffers()intnumQueuedBuffers()Report the number of AudioBuffers queued to this source.booleanqueueAudioBuffer(AudioBuffer audioBuffer)Queue a single AudioBuffer on this source.booleanqueueAudioBuffers(java.util.Queue<AudioBuffer> audioBuffers)Queue a list of AudioBuffers on this source.voidsetGain(float gain)Set the gain of this AudioSource objectvoidsetMaximumDistance(float maximumDistance)Set the current maximum distance setting.voidsetOffset(long offset)Set the offset in which to start playback of this AudioSource.voidsetPitch(float pitch)Set the pitch of this AudioSource objectvoidsetPositionRelative(boolean relative)Sets the position of this AudioSource object to be relative to the position of the AudioListener object or absolute.voidsetReferenceDistance(float referenceDistance)Set the reference distance of this AudioSource object.voidsetRollOffFactor(float rollOffFactor)Set the roll-off factor of this AudioSource object.voidsetVelocity(javax.vecmath.Vector3f vel)Sets the velocity of this AudioSource objectvoidstateChanged(int oldState)Method used to update the current state of the Audio objectbooleanunqueueAudioBuffers()Remove all processed AudioBuffers from this Source.-
Methods inherited from class jmri.jmrit.audio.AbstractAudioSource
calculateCurrentPosition, calculateFades, calculateLoops, doResetCurrentPosition, doTogglePause, doTogglePlay, fadeIn, fadeOut, getAssignedBuffer, getAssignedBufferName, getCurrentPosition, getDebugString, getFadeGain, getFadeIn, getFadeOut, getFading, getGain, getLastNumLoops, getMaximumDistance, getMaxLoops, getMinLoops, getNumLoops, getOffset, getPitch, getPosition, getQueuedBuffers, getReferenceDistance, getRollOffFactor, getSubType, getVelocity, isAudioAlive, isBound, isLooped, isPositionRelative, isQueued, pause, play, queueBuffer, queueBuffers, resetCurrentPosition, resume, rewind, setAssignedBuffer, setAssignedBuffer, setBound, setFadeIn, setFadeOut, setLooped, setMaxLoops, setMinLoops, setPosition, setPosition, setPosition, setQueued, stop, togglePause, togglePlay, unqueueBuffers
-
Methods inherited from class jmri.implementation.AbstractAudio
dispose, getBeanType, getUsageReport, roundDecimal, roundDecimal, setState
-
Methods inherited from class jmri.implementation.AbstractNamedBean
addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, describeState, equals, firePropertyChange, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeListenersByReference, getPropertyKeys, getSystemName, getUserName, hashCode, removeProperty, removePropertyChangeListener, removePropertyChangeListener, setComment, setProperty, setUserName, toString, toStringSuffix, updateListenerRef, vetoableChange
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface jmri.NamedBean
addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, compareTo, describeState, dispose, getBeanType, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListenersByReference, getPropertyKeys, getRecommendedToolTip, getSystemName, getUsageReport, getUserName, removeProperty, setComment, setProperty, setState, setUserName, toString, updateListenerRef, vetoableChange
-
Methods inherited from interface jmri.beans.PropertyChangeProvider
addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener
-
-
-
-
Constructor Detail
-
JoalAudioSource
public JoalAudioSource(java.lang.String systemName)
Constructor for new JoalAudioSource with system name- Parameters:
systemName- AudioSource object system name (e.g. IAS1)
-
JoalAudioSource
public JoalAudioSource(java.lang.String systemName, java.lang.String userName)
Constructor for new JoalAudioSource with system name and user name- Parameters:
systemName- AudioSource object system name (e.g. IAS1)userName- AudioSource object user name
-
-
Method Detail
-
queueAudioBuffer
public boolean queueAudioBuffer(AudioBuffer audioBuffer)
Queue a single AudioBuffer on this source. (called from DefaultAudioFactory command queue)- Overrides:
queueAudioBufferin classAbstractAudioSource- Parameters:
audioBuffer- AudioBuffer to queue- Returns:
- True if successfully queued.
-
queueAudioBuffers
public boolean queueAudioBuffers(java.util.Queue<AudioBuffer> audioBuffers)
Queue a list of AudioBuffers on this source. (called from DefaultAudioFactory command queue)- Overrides:
queueAudioBuffersin classAbstractAudioSource- Parameters:
audioBuffers- AudioBuffers to queue- Returns:
- True if successfully queued.
-
unqueueAudioBuffers
public boolean unqueueAudioBuffers()
Remove all processed AudioBuffers from this Source.- Overrides:
unqueueAudioBuffersin classAbstractAudioSource- Returns:
- True if successful.
-
numProcessedBuffers
public int numProcessedBuffers()
- Specified by:
numProcessedBuffersin interfaceAudioSource- Overrides:
numProcessedBuffersin classAbstractAudioSource
-
numQueuedBuffers
public int numQueuedBuffers()
Report the number of AudioBuffers queued to this source.- Specified by:
numQueuedBuffersin interfaceAudioSource- Overrides:
numQueuedBuffersin classAbstractAudioSource- Returns:
- number of queued buffers.
-
bindAudioBuffer
boolean bindAudioBuffer(AudioBuffer audioBuffer)
Description copied from class:AbstractAudioSourceBinds this AudioSource with the specified AudioBuffer.Applies only to sub-types:
- Source
- Specified by:
bindAudioBufferin classAbstractAudioSource- Parameters:
audioBuffer- The AudioBuffer to bind to this AudioSource- Returns:
- true if successful
-
changePosition
protected void changePosition(javax.vecmath.Vector3f pos)
Description copied from class:AbstractAudioSourceChange the current position of this source.- Specified by:
changePositionin classAbstractAudioSource- Parameters:
pos- new position
-
setPositionRelative
public void setPositionRelative(boolean relative)
Description copied from interface:AudioSourceSets the position of this AudioSource object to be relative to the position of the AudioListener object or absolute.Applies only to sub-types:
- Source
- Specified by:
setPositionRelativein interfaceAudioSource- Overrides:
setPositionRelativein classAbstractAudioSource- Parameters:
relative- position relative or absolute
-
setVelocity
public void setVelocity(javax.vecmath.Vector3f vel)
Description copied from interface:AudioSourceSets the velocity of this AudioSource objectApplies only to sub-types:
- Listener
- Source
- Specified by:
setVelocityin interfaceAudioSource- Overrides:
setVelocityin classAbstractAudioSource- Parameters:
vel- 3d velocity vector
-
setGain
public void setGain(float gain)
Description copied from interface:AudioSourceSet the gain of this AudioSource objectDefault value = 1.0f
Applies only to sub-types:
- Listener
- Source
- Specified by:
setGainin interfaceAudioSource- Overrides:
setGainin classAbstractAudioSource- Parameters:
gain- the gain of this AudioSource
-
setPitch
public void setPitch(float pitch)
Description copied from interface:AudioSourceSet the pitch of this AudioSource objectValues are restricted from 0.5f to 2.0f, i.e. half to double
Default value = 1.0f
Applies only to sub-types:
- Source
- Specified by:
setPitchin interfaceAudioSource- Overrides:
setPitchin classAbstractAudioSource- Parameters:
pitch- the pitch of this AudioSource
-
setReferenceDistance
public void setReferenceDistance(float referenceDistance)
Description copied from interface:AudioSourceSet the reference distance of this AudioSource object.Default value = 1.0f
The Reference Distance is one of the main parameters you have for controlling the way that sounds attenuate with distance. A Source with Reference Distance set to 5 (meters) will be at maximum volume while it is within 5 metere of the listener, and start to fade out as it moves further away. At 10 meters it will be at half volume, and at 20 meters at a quarter volume, etc ...
Applies only to sub-types:
- Source
- Specified by:
setReferenceDistancein interfaceAudioSource- Overrides:
setReferenceDistancein classAbstractAudioSource- Parameters:
referenceDistance- the Reference Distance for this AudioSource
-
setOffset
public void setOffset(long offset)
Description copied from interface:AudioSourceSet the offset in which to start playback of this AudioSource.Default value = 0
Value is clamped between 0 and length of attached AudioBuffer
Applies only to sub-types:
- Source
- Specified by:
setOffsetin interfaceAudioSource- Overrides:
setOffsetin classAbstractAudioSource- Parameters:
offset- the offset in samples marking the point to commence playback
-
setMaximumDistance
public void setMaximumDistance(float maximumDistance)
Description copied from interface:AudioSourceSet the current maximum distance setting.Default value = Audio.MAX_DISTANCE
The maximum distance is that where the volume of the sound would normally be zero.
Applies only to sub-types:
- Source
- Specified by:
setMaximumDistancein interfaceAudioSource- Overrides:
setMaximumDistancein classAbstractAudioSource- Parameters:
maximumDistance- maximum distance of this source
-
setRollOffFactor
public void setRollOffFactor(float rollOffFactor)
Description copied from interface:AudioSourceSet the roll-off factor of this AudioSource object.Default value = 1.0f
Applies only to sub-types:
- Source
- Specified by:
setRollOffFactorin interfaceAudioSource- Overrides:
setRollOffFactorin classAbstractAudioSource- Parameters:
rollOffFactor- roll-off factor
-
getState
public int getState()
Description copied from interface:NamedBeanProvide generic access to internal state.This generally shouldn't be used by Java code; use the class-specific form instead (e.g. getCommandedState in Turnout). This is provided to make scripts easier to read.
- Specified by:
getStatein interfaceNamedBean- Overrides:
getStatein classAbstractAudio- Returns:
- the state
-
stateChanged
public void stateChanged(int oldState)
Description copied from interface:AudioMethod used to update the current state of the Audio object- Specified by:
stateChangedin interfaceAudio- Overrides:
stateChangedin classAbstractAudioSource- Parameters:
oldState- the former state
-
attachSourcesToEffects
public int attachSourcesToEffects()
Description copied from interface:AudioSourceMethod to attach sources to effects- Specified by:
attachSourcesToEffectsin interfaceAudioSource- Overrides:
attachSourcesToEffectsin classAbstractAudioSource- Returns:
- a number code
-
detachSourcesToEffects
public int detachSourcesToEffects()
Description copied from interface:AudioSourceMethod to detach sources to effects- Specified by:
detachSourcesToEffectsin interfaceAudioSource- Overrides:
detachSourcesToEffectsin classAbstractAudioSource- Returns:
- a number code
-
doPlay
protected void doPlay()
Description copied from class:AbstractAudioSourcePlay the clip from the beginning. If looped, start looping.- Specified by:
doPlayin classAbstractAudioSource
-
doStop
protected void doStop()
Description copied from class:AbstractAudioSourceStop playing the clip and rewind to the beginning.- Specified by:
doStopin classAbstractAudioSource
-
doPause
protected void doPause()
Description copied from class:AbstractAudioSourceStop playing the clip but retain the current position.- Specified by:
doPausein classAbstractAudioSource
-
doResume
protected void doResume()
Description copied from class:AbstractAudioSourcePlay the clip from the current position.- Specified by:
doResumein classAbstractAudioSource
-
doRewind
protected void doRewind()
Description copied from class:AbstractAudioSourceRewind clip to the beginning.- Specified by:
doRewindin classAbstractAudioSource
-
doFadeIn
protected void doFadeIn()
Description copied from class:AbstractAudioSourceFade in then play this AudioSource.- Specified by:
doFadeInin classAbstractAudioSource
-
doFadeOut
protected void doFadeOut()
Description copied from class:AbstractAudioSourceFade out then stop this AudioSource.- Specified by:
doFadeOutin classAbstractAudioSource
-
cleanup
protected void cleanup()
Description copied from class:AbstractAudioAbstract method that concrete classes will implement to perform necessary cleanup routines.This method is now included in dispose(). The caller can call dispose() to cleanup and deregister an audio object.
- Specified by:
cleanupin classAbstractAudio
-
calculateGain
protected void calculateGain()
Description copied from class:AbstractAudioSourceCalculate the gain of this AudioSource based on distance from listener and fade levels.- Specified by:
calculateGainin classAbstractAudioSource
-
-