triana.types.audio

Class MultipleAudio

java.lang.Object

triana.types.TrianaType

triana.types.GraphType

triana.types.MultipleChannel

triana.types.audio.MultipleAudio

All Implemented Interfaces:

java.io.Serializable, Arithmetic, AsciiComm, SequenceInterface

public class MultipleAudio
extends MultipleChannel
implements AsciiComm

MutipleAudio stores many channels of sampled data.Each channel can have its own particular audio format of the data e.g. the encoding, such as MU_LAW, PCM and number of bits used to record the data. This is essential for performing sound transformations and writing audio data.

See Also:

ChannelFormat, AudioChannelFormat, MultipleChannel, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTINUOUS_PROCESSING The identifier for continuous processing.
static int	FIXED_LENGTH_PROCESSING The identifier for fixed length processing e.g.
int	processingMode

Fields inherited from class triana.types.MultipleChannel

channelFormat

Fields inherited from class triana.types.TrianaType

NOT_CONNECTED, NOT_READY, OUT_OF_RANGE

Constructor Summary

Constructors

Constructor and Description
MultipleAudio() Creates an empty MultipleAudio Object with no channels added.
MultipleAudio(int channels) Creates a MultipleAudio object with a specific number of channels

Method Summary

Methods

Modifier and Type	Method and Description
ChannelFormat	createChannelFormatFrom(java.lang.String line) This function creates a ChannelFormat object from the given String using the toString and setFromString() functions with a ChannelFormat
boolean	equals(TrianaType obj) Determines whether the argument TrianaType is equal to the current MultipleAudio.
AudioChannelFormat	getAudioChannelFormat(int channelNo)
javax.sound.sampled.AudioFormat	getAudioFormat() Gets a Javax.sound.sampled AudioFormat Object for this multiple audio object.
static int	getNumberOfBitsToStore(double[] dataIn) Finds the range for the given data and works out what sampling resolution it will fit into, e.g. CD quality (16-bit resolution).
boolean	isCompatible(TrianaType obj) Tests the argument object to determine if it makes sense to perform arithmetic operations between it and the current object.
void	setDefaultAxisLabelling() Added by I.
void	setProcessingMode(int mode) A function to set the type of processing mode that this data should be subjected to.

Methods inherited from class triana.types.MultipleChannel

copyMe, copyParameters, getChannel, getChannelFormat, getChannelFormatContainer, getChannelImag, getChannelLength, getChannelLengthImag, getChannels, inputFromStream, outputToStream, setChannel, setChannel, setChannel, setChannel, setChannel, setChannelImag, setChannelImag, setChannelImag, setChannelImag, setChannelImag, setDimensions

Methods inherited from class triana.types.GraphType

add, addToTitle, convertDependentDataArraysToBytes, convertDependentDataArraysToDoubles, convertDependentDataArraysToFloats, convertDependentDataArraysToInts, convertDependentDataArraysToLongs, convertDependentDataArraysToShorts, copyData, copyLabels, divide, equals, getDataArrayClass, getDataArrayImag, getDataArrayImag, getDataArrayImagAsBytes, getDataArrayImagAsDoubles, getDataArrayImagAsFloats, getDataArrayImagAsInts, getDataArrayImagAsLongs, getDataArrayImagAsShorts, getDataArrayReal, getDataArrayReal, getDataArrayRealAsBytes, getDataArrayRealAsDoubles, getDataArrayRealAsFloats, getDataArrayRealAsInts, getDataArrayRealAsLongs, getDataArrayRealAsShorts, getDataArrayTypeNames, getDependentLabels, getDependentVariableDimensions, getDependentVariables, getDimensionLengths, getDimensionLengths, getGraphArrayImag, getGraphArrayImagLog10, getGraphArrayReal, getGraphArrayRealLog10, getIndependentArrayImag, getIndependentArrayReal, getIndependentLabels, getIndependentScaleImag, getIndependentScaleImagLog10, getIndependentScaleReal, getIndependentScaleRealLog10, getIndependentTriplet, getIndependentVariables, getLabels, getLabelsColumn, getTitle, isArithmeticArray, isArithmeticData, isCompatible, isDependentComplex, isIndependentComplex, isPrimitiveArray, isPrimitiveData, isTriplet, isUniform, maxDependentGraphingValuesImag, maxDependentGraphingValuesReal, maxDependentVariablesImag, maxDependentVariablesReal, maxIndependentScalesImag, maxIndependentScalesReal, maxIndependentVariablesImag, maxIndependentVariablesReal, minDependentGraphingValuesImag, minDependentGraphingValuesReal, minDependentVariablesImag, minDependentVariablesReal, minIndependentScalesImag, minIndependentScalesReal, minIndependentVariablesImag, minIndependentVariablesReal, multiply, resetDependent, resetIndependent, restrictToSubdomain, restrictToSubdomain, setDataArrayImag, setDataArrayReal, setDependentLabels, setDependentVariableDimensions, setDimensionLengths, setDimensionLengths, setIndependentArrayImag, setIndependentArrayReal, setIndependentLabels, setIndependentTriplet, setIndependentTriplet, setLabels, setTitle, subtract, testDataModel

Methods inherited from class triana.types.TrianaType

containerSize, dataExists, deleteFromContainer, getDataContainer, getFromContainer, getSequenceNumber, insertIntoContainer, inspectDataContainer, setDataContainer, setSequenceNumber, updateObsoletePointers

Methods inherited from class java.lang.Object

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

Methods inherited from interface triana.types.AsciiComm

inputFromStream, outputToStream

Field Detail

CONTINUOUS_PROCESSING

public static final int CONTINUOUS_PROCESSING

The identifier for continuous processing. This helps units determine what kind of data they are dealing with and therefore in this case what previous and forward memory bufferes they require for processing the current data. Continuous processing is when the data stream is split into smaller chunks for processing continuous streams of audio.

See Also:

Constant Field Values

FIXED_LENGTH_PROCESSING

public static final int FIXED_LENGTH_PROCESSING

The identifier for fixed length processing e.g. a whole song or entire audio part. This is the default.

See Also:

Constant Field Values

processingMode

public int processingMode

Constructor Detail

MultipleAudio

public MultipleAudio()

Creates an empty MultipleAudio Object with no channels added.

MultipleAudio

public MultipleAudio(int channels)

Creates a MultipleAudio object with a specific number of channels

Method Detail

setDefaultAxisLabelling

public void setDefaultAxisLabelling()

Added by I. Taylor, August 2001 : This function sets the default labeling scheme used for all GraphTypes. Default values are 'X' for the X-axis and 'Y' for the Y axis. The various subclasses can override this function with their specific axis-labelling conventions.

Overrides:

setDefaultAxisLabelling in class GraphType

getAudioChannelFormat

public AudioChannelFormat getAudioChannelFormat(int channelNo)

Returns:

the format of the data at the requested channel.

getAudioFormat

public javax.sound.sampled.AudioFormat getAudioFormat()

Gets a Javax.sound.sampled AudioFormat Object for this multiple audio object. This returns an approximation to the audio format object used to describe the contents of this audio object containing many channels. For stereo audio , for example, this works fine as each channel has the same parameters i.e. sampling rate etc but for more compilcated sounds this will fail.

setProcessingMode

public void setProcessingMode(int mode)

A function to set the type of processing mode that this data should be subjected to. there are 2 choice : CONTINUOUS_PROCESSING is set when the data stream is split into smaller chunks for processing continuous streams of audio and FIXED_LENGTH_PROCESSING is set when the entire audio part is available for processing in one chunk. This helps units determine how to treat the audio.

getNumberOfBitsToStore

public static int getNumberOfBitsToStore(double[] dataIn)

Finds the range for the given data and works out what sampling resolution it will fit into, e.g. CD quality (16-bit resolution). Allowed return values are 8, 16, and 32 bits.

Parameters:

dataIn - The input data being examined

Returns:

int The number of bits of resolution needed to store the input adequately

createChannelFormatFrom

public ChannelFormat createChannelFormatFrom(java.lang.String line)

This function creates a ChannelFormat object from the given String using the toString and setFromString() functions with a ChannelFormat

Specified by:

createChannelFormatFrom in class MultipleChannel

isCompatible

public boolean isCompatible(TrianaType obj)

Tests the argument object to determine if it makes sense to perform arithmetic operations between it and the current object.

In Mutiple Audio, this method first tests for compatibility with superior classes, and then (if the input object is a Mutiple Audio) tests that the input has the same channel count.

Classes derived from this should over-ride this method with further tests as appropriate. The over-riding method should normally have the first lines

 boolean test = super.isCompatible( obj ); 

followed by other tests. If other types not subclassed from GraphType or Const should be allowed to be compatible then other tests must be implemented.

Overrides:

isCompatible in class MultipleChannel

Parameters:

obj - The data object to be compared with the current one

Returns:

True if the object can be combined with the current one

equals

public boolean equals(TrianaType obj)

Determines whether the argument TrianaType is equal to the current MultipleAudio. They are equal if the argument is a MultipleAudio with the same size, parameters, and data.

This method must be over-ridden in derived types. In a derived type called xxx the method should begin

 if ( !( obj instanceof xxx ) ) return false; if
 ( !isCompatible( obj ) ) return false; 

followed by tests that are specific to type xxx (testing its own parameters) and then as a last line

 return super.equals( obj ); 

This line invokes the other equals methods up the chain to GraphType. Each superior object tests its own parameters.

Overrides:

equals in class MultipleChannel

Parameters:

obj - The object being tested

Returns:

true if they are equal or false otherwise