marytts.util.data

Interface DoubleDataSource

All Known Implementing Classes:

AudioDoubleDataSource, BaseDoubleDataSource, BlockwiseDoubleDataSource, BufferedDoubleDataSource, DatagramDoubleDataSource, DatagramOverlapDoubleDataSource, ESTTextfileDoubleDataSource, FIRFilter.FIROutput, FrameOverlapAddSource, FramewiseMerger, HTSVocoder.HTSVocoderDataProducer, LabelfileDoubleDataSource, MixerDoubleDataSource, NaiveVocoder, NoiseDoubleDataSource, PhaseVocoder, PraatTextfileDoubleDataSource, ProducingDoubleDataSource, Robotiser, SequenceDoubleDataSource, Signal2EnergyConverter, SilenceDoubleDataSource, SnackTextfileDoubleDataSource, TextReaderDoubleDataSource

public interface DoubleDataSource

Author:

Marc Schröder

Field Summary

Fields

Modifier and Type	Field and Description
static int	NOT_SPECIFIED

Method Summary

Methods

Modifier and Type	Method and Description
int	available() The number of doubles that can currently be read from this double data source without blocking.
double[]	getAllData() Get all the data that can be read from this data source, in a single double array.
int	getData(double[] target) Try to get as many double data from this DoubleDataSource as target can hold.
int	getData(double[] target, int targetPos, int length) Try to get length doubles from this DoubleDataSource, and copy them into target, starting from targetPos.
double[]	getData(int amount) Request to get the specified amount of data in a new double array.
long	getDataLength() Get the total length of the data in this data source, if available.
boolean	hasMoreData() Whether or not any more data can be read from this data source.

Field Detail

NOT_SPECIFIED

static final int NOT_SPECIFIED

See Also:

Constant Field Values

Method Detail

getData

double[] getData(int amount)

Request to get the specified amount of data in a new double array.

Parameters:

amount - the number of doubles requested

Returns:

a new double array; its length may be smaller than amount if not enough data could be obtained. If no data could be read, null is returned.

getData

int getData(double[] target)

Try to get as many double data from this DoubleDataSource as target can hold.

Parameters:

target - the double array in which to write the data

Returns:

the number of data items written into target. If the returned value is less than target.length, only that many data items have been copied into target; further calls will return 0 and not copy anything.

getData

int getData(double[] target,
          int targetPos,
          int length)

Try to get length doubles from this DoubleDataSource, and copy them into target, starting from targetPos.

Parameters:

target - the double array to write into

targetPos - position in target where to start writing

length - the amount of data requested

Returns:

the amount of data actually delivered. If the returned value is less than length, only that many data items have been copied into target; further calls will return 0 and not copy anything.

hasMoreData

boolean hasMoreData()

Whether or not any more data can be read from this data source.

Returns:

true if another call to getData() will return data, false otherwise.

available

int available()

The number of doubles that can currently be read from this double data source without blocking. This number can change over time.

Returns:

the number of doubles that can currently be read without blocking

getAllData

double[] getAllData()

Get all the data that can be read from this data source, in a single double array.

Returns:

a double array of exactly the length required to contain all the data that can be read from this source. Returns an array of length 0 if no data can be read from this source.

Throws:

OutOfMemoryError - if a sufficiently large double array cannot be created.

getDataLength

long getDataLength()

Get the total length of the data in this data source, if available.

Returns:

the number of doubles that can be read from this data source, or DoubleDataSource.NOT_SPECIFIED if unknown.