opendial.datastructs

Class SpeechData

java.lang.Object

java.io.InputStream

opendial.datastructs.SpeechData

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Comparable<Value>, Value

public class SpeechData
extends java.io.InputStream
implements Value

Representation of a stream of speech data (input or output). The stream can both be read (using the usual methods), but can also be modified by appending new data to the end of the stream.

The stream is allowed to change until it is marked as "final" (i.e. when the audio capture has finished recording).

Constructor Summary

Constructors

Constructor and Description
SpeechData(javax.sound.sampled.AudioFormat format) Creates a new, empty stream of data with a given audio format
SpeechData(byte[] data) Creates a stream of speech data based on a pre-existing byte array.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Value o) Returns the hashcode difference.
SpeechData	concatenate(Value value) Returns the concatenation of the two audio data.
boolean	contains(Value subvalue) Returns false
SpeechData	copy() Returns itself
javax.sound.sampled.AudioFormat	getFormat() Returns the format of the speech data
java.util.Collection<Value>	getSubValues() Returns an empty list
int	hashCode() Returns a fixed number (32).
boolean	isFinal() Returns true if the speech data is final, false otherwise
int	length() Returns the duration of the audio data (in milliseconds)
int	read() Reads one byte of the stream
int	read(byte[] buffer, int offset, int length) Reads a buffer of data from the stream
void	rewind() Resets the current position in the stream to 0.
void	setAsFinal() Marks the speech data as final (it won't be changed anymore)
byte[]	toByteArray() Returns the raw array of bytes
java.lang.String	toString() Returns a string representation of the data
void	write(byte[] buffer) Expands the current speech data by appending a new buffer of audio data
void	write(java.io.InputStream stream) Expands the current speech data by appending the data in the input stream.

Methods inherited from class java.io.InputStream

available, close, mark, markSupported, read, reset, skip

Methods inherited from class java.lang.Object

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

Methods inherited from interface opendial.bn.values.Value

equals

Constructor Detail

SpeechData

public SpeechData(javax.sound.sampled.AudioFormat format)

Creates a new, empty stream of data with a given audio format

Parameters:

format - the audio format to employ

SpeechData

public SpeechData(byte[] data)

Creates a stream of speech data based on a pre-existing byte array.

Parameters:

data - the byte array

Method Detail

setAsFinal

public void setAsFinal()

Marks the speech data as final (it won't be changed anymore)

write

public void write(byte[] buffer)

Expands the current speech data by appending a new buffer of audio data

Parameters:

buffer - the new audio data to insert

write

public void write(java.io.InputStream stream)

Expands the current speech data by appending the data in the input stream.

Parameters:

stream - the stream to add to the speech data

read

public int read()

Reads one byte of the stream

Specified by:

read in class java.io.InputStream

Returns:

the read byte

read

public int read(byte[] buffer,
                int offset,
                int length)

Reads a buffer of data from the stream

Overrides:

read in class java.io.InputStream

Parameters:

buffer - the buffer to fill

offset - the offset at which to start filling the buffer

length - the maximum number of bytes to read

rewind

public void rewind()

Resets the current position in the stream to 0.

length

public int length()

Returns the duration of the audio data (in milliseconds)

Specified by:

length in interface Value

Returns:

the duration of the audio data

isFinal

public boolean isFinal()

Returns true if the speech data is final, false otherwise

Returns:

true if the data is final, false otherwise

toByteArray

public byte[] toByteArray()

Returns the raw array of bytes

Returns:

the byte array

getFormat

public javax.sound.sampled.AudioFormat getFormat()

Returns the format of the speech data

Returns:

the audio format

compareTo

public int compareTo(Value o)

Returns the hashcode difference.

Specified by:

compareTo in interface java.lang.Comparable<Value>

hashCode

public int hashCode()

Returns a fixed number (32).

Specified by:

hashCode in interface Value

Overrides:

hashCode in class java.lang.Object

Returns:

32.

toString

public java.lang.String toString()

Returns a string representation of the data

Specified by:

toString in interface Value

Overrides:

toString in class java.lang.Object

Returns:

the string

copy

public SpeechData copy()

Returns itself

Specified by:

copy in interface Value

Returns:

the value

contains

public boolean contains(Value subvalue)

Returns false

Specified by:

contains in interface Value

Parameters:

subvalue - the value to check for inclusion

Returns:

true if the value is contained, false otherwise

getSubValues

public java.util.Collection<Value> getSubValues()

Returns an empty list

Specified by:

getSubValues in interface Value

Returns:

the collection of values inside the present value

concatenate

public SpeechData concatenate(Value value)

Returns the concatenation of the two audio data. If the values are not final, waits for them to be final.

Specified by:

concatenate in interface Value

Parameters:

value - the value to concatenate with the current one

Returns:

the concatenated result