audio.output

Class Play

java.lang.Object

org.trianacode.taskgraph.Unit

audio.output.Play

public class Play
extends Unit

A Unit class to support the playback of (chunked/nonchunked) audio. A seperate thread is used for playback to boost CPU efficiency, which the toByteArray method converts the audio from a short array to a byte array in a seperate thread. Created by Dr. Ian Taylor and modified by Eddie Al-Shakarchi Contact e.alshakarchi@cs.cf.ac.uk

See Also:

AudioPlayer

Field Summary

Fields

Modifier and Type	Field and Description
static long	filt

Fields inherited from class org.trianacode.taskgraph.Unit

CLONE_ALL_OUTPUT, CLONE_MULTIPLE_OUTPUT, COPY_OUTPUT, ESSENTIAL, ESSENTIAL_IF_CONNECTED, IMMEDIATE_UPDATE, INTERNAL, LATE_INITIALIZE, NO_UPDATE, ON_TASK_INSTANTATION, ON_USER_ACCESS, OPTIONAL, PROCESS_UPDATE, TRANSIENT, TRANSIENT_ACCESSIBLE, USER_ACCESSIBLE

Constructor Summary

Constructors

Constructor and Description
Play()

Method Summary

Methods

Modifier and Type	Method and Description
void	dispose() Called when the unit is disposed of.
java.lang.String[]	getInputTypes() This method should return an array of the data types accepted by nodes not specified in getNodeInputTypes (e.g.
java.lang.String[]	getOutputTypes() This method should return an array of the data types output by nodes not specified in getNodeOutputTypes() (e.g.
void	init() Called when the unit is created.
void	parameterUpdate(java.lang.String paramname, java.lang.Object value) Called a parameters is updated (e.g.
void	process() **************************************************************************************** This is the main processing method.
void	reset() Called when the unit is reset.
void	setUpPlayer(javax.sound.sampled.AudioFormat audioFormat) This method sets up the player, and is only called IF there is a change in the format of the incoming audio.
void	stopDeMusicMan()
byte[]	toByteArray(MultipleAudio input) ********************************************************************** This method converts the multiple audio input to a specific byte array,* taking into account the bit depth of the audio file.

Methods inherited from class org.trianacode.taskgraph.Unit

debug, debug, defineParameter, extractClipInState, getClipIn, getClipIn, getControlInterface, getDefaultInputNodes, getDefaultNodeRequirement, getDefaultOutputNodes, getDisplayName, getDisplayPackage, getGUIBuilderV2Info, getHelpFileLocation, getInputAtNode, getInputNodeCount, getMaximumInputNodes, getMaximumOutputNodes, getMinimumInputNodes, getMinimumOutputNodes, getNodeInputTypes, getNodeOutputTypes, getOutputNodeCount, getOutputPolicy, getPackageName, getParameter, getParameterPanelClass, getParameterPanelInstantiate, getParameterType, getParameterUpdatePolicy, getPopUpDescription, getRunnableInterface, getTask, getTaskGraphContext, getToolName, getToolPackage, getToolTable, getVersion, hideParameterPanel, isClipInName, isInputAtNode, isOutputSent, isParameter, log, log, notifyError, notifyError, output, outputAtNode, outputAtNode, parameterUpdated, putClipIn, removeClipIn, removeParameter, restoreClipInState, setDefaultInputNodes, setDefaultNodeRequirement, setDefaultOutputNodes, setDisplayName, setDisplayPackage, setGUIBuilderV2Info, setHelpFileLocation, setMaximumInputNodes, setMaximumOutputNodes, setMinimumInputNodes, setMinimumOutputNodes, setOutputPolicy, setParameter, setParameterPanelClass, setParameterPanelInstantiate, setParameterUpdatePolicy, setPopUpDescription, setRunnableInterface, setToolName, setToolPackage, setVersion, showParameterPanel, stopping

Methods inherited from class java.lang.Object

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

Field Detail

filt

public static final long filt

Constructor Detail

Play

public Play()

Method Detail

process

public void process()
             throws java.lang.Exception

**************************************************************************************** This is the main processing method. Called whenever there is data for the unit to process *****************************************************************************************

Specified by:

process in class Unit

Throws:

java.lang.Exception

setUpPlayer

public void setUpPlayer(javax.sound.sampled.AudioFormat audioFormat)

This method sets up the player, and is only called IF there is a change in the format of the incoming audio. The SourceDataLine is opened and then started - it's written to in the AudioPlayer

toByteArray

public byte[] toByteArray(MultipleAudio input)
                   throws java.lang.Exception

********************************************************************** This method converts the multiple audio input to a specific byte array,* taking into account the bit depth of the audio file. * ***********************************************************************

Throws:

java.lang.Exception

init

public void init()

Called when the unit is created. Initialises the unit's properties and parameters.

Overrides:

init in class Unit

stopDeMusicMan

public void stopDeMusicMan()

reset

public void reset()

Called when the unit is reset. Restores the unit's variables to values specified by the parameters.

Overrides:

reset in class Unit

dispose

public void dispose()

Called when the unit is disposed of.

Overrides:

dispose in class Unit

parameterUpdate

public void parameterUpdate(java.lang.String paramname,
                   java.lang.Object value)

Called a parameters is updated (e.g. by the GUI)

Overrides:

parameterUpdate in class Unit

getInputTypes

public java.lang.String[] getInputTypes()

Description copied from class: Unit

This method should return an array of the data types accepted by nodes not specified in getNodeInputTypes (e.g. triana.types.VectorType). If no package is specified then triana.types is assumed.

Specified by:

getInputTypes in class Unit

Returns:

an array of the input types for StringGen

getOutputTypes

public java.lang.String[] getOutputTypes()

Description copied from class: Unit

This method should return an array of the data types output by nodes not specified in getNodeOutputTypes() (e.g. triana.types.VectorType). If no package is specified then triana.types is assumed.

Specified by:

getOutputTypes in class Unit

Returns:

an array of the output types for StringGen