marytts.tools.voiceimport

Class TimelineWriter

java.lang.Object

marytts.tools.voiceimport.TimelineWriter

public class TimelineWriter
extends Object

The TimelineWriter class provides an interface to create or update a Timeline data file in Mary format, and to feed new datagrams to the timeline file.

Author:

sacha, marc

Field Summary

Fields

Modifier and Type	Field and Description
protected long	datagramsBytePos
protected TimelineReader.Index	idx
protected MaryHeader	maryHdr
protected long	numDatagrams
protected TimelineReader.ProcHeader	procHdr
protected RandomAccessFile	raf
protected int	sampleRate
protected long	timeIdxBytePos
protected long	timePtr

Constructor Summary

Constructors

Constructor and Description
TimelineWriter(String fileName, String procHdrString, int reqSampleRate, double setIdxIntervalInSeconds) Constructor to create a timeline.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Output the internally maintained indexes and close the file.
void	feed(Datagram[] dArray, int reqSampleTime) Write a series of datagrams to the timeline.
void	feed(Datagram d, int reqSampleRate) Write one datagram to the timeline.
long	getBytePointer() Get the current byte position in the file
long	getDatagramsBytePos() Returns the position of the datagram zone
TimelineReader.Index	getIndex()
long	getNumDatagrams() Returns the current number of datagrams in the timeline.
int	getSampleRate() Returns the sample rate of the timeline.
long	getTimePointer() Get the current time position in the file
protected long	scaleTime(int reqSampleRate, long targetTimeInSamples) Scales a discrete time to the timeline's sample rate.
protected void	setBytePointer(long bytePos) Set the current byte position in the file
protected void	setTimePointer(long timePosition) Set the current time position in the file
protected long	unScaleTime(int reqSampleRate, long timelineTimeInSamples) Unscales a discrete time from the timeline's sample rate.

Methods inherited from class java.lang.Object

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

Field Detail

raf

protected RandomAccessFile raf

maryHdr

protected MaryHeader maryHdr

procHdr

protected TimelineReader.ProcHeader procHdr

idx

protected TimelineReader.Index idx

sampleRate

protected int sampleRate

numDatagrams

protected long numDatagrams

datagramsBytePos

protected long datagramsBytePos

timeIdxBytePos

protected long timeIdxBytePos

timePtr

protected long timePtr

Constructor Detail

TimelineWriter

public TimelineWriter(String fileName,
              String procHdrString,
              int reqSampleRate,
              double setIdxIntervalInSeconds)

Constructor to create a timeline.

Parameters:

fileName - The file to read the timeline from.

procHdrString - the string to use as a processing header.

reqSampleRate - the sample rate requested to measure time in this timeline.

setIdxIntervalInSeconds - the interval between two index entries, in seconds

Method Detail

getBytePointer

public long getBytePointer()
                    throws IOException

Get the current byte position in the file

Returns:

raf.getFilePointer

Throws:

IOException - IOException

getTimePointer

public long getTimePointer()

Get the current time position in the file

Returns:

timePtr

setBytePointer

protected void setBytePointer(long bytePos)
                       throws IOException

Set the current byte position in the file

Parameters:

bytePos - bytePos

Throws:

IOException - IOException

setTimePointer

protected void setTimePointer(long timePosition)

Set the current time position in the file

Parameters:

timePosition - timePosition

scaleTime

protected long scaleTime(int reqSampleRate,
             long targetTimeInSamples)

Scales a discrete time to the timeline's sample rate.

Parameters:

reqSampleRate - the externally given sample rate.

targetTimeInSamples - a discrete time, with respect to the externally given sample rate.

Returns:

a discrete time, in samples with respect to the timeline's sample rate.

unScaleTime

protected long unScaleTime(int reqSampleRate,
               long timelineTimeInSamples)

Unscales a discrete time from the timeline's sample rate.

Parameters:

reqSampleRate - the externally given sample rate.

timelineTimeInSamples - a discrete time, with respect to the timeline sample rate.

Returns:

a discrete time, in samples with respect to the externally given sample rate.

getIndex

public TimelineReader.Index getIndex()

getDatagramsBytePos

public long getDatagramsBytePos()

Returns the position of the datagram zone

Returns:

datagramsBytePos

getNumDatagrams

public long getNumDatagrams()

Returns the current number of datagrams in the timeline.

Returns:

numDatagrams

getSampleRate

public int getSampleRate()

Returns the sample rate of the timeline.

Returns:

sampleRate

close

public void close()
           throws IOException

Output the internally maintained indexes and close the file.

Throws:

IOException - IOException

feed

public void feed(Datagram d,
        int reqSampleRate)
          throws IOException

Write one datagram to the timeline.

Parameters:

d - the datagram to write.

reqSampleRate - the sample rate at which the datagram duration is expressed.

Throws:

IOException - IOException

feed

public void feed(Datagram[] dArray,
        int reqSampleTime)
          throws IOException

Write a series of datagrams to the timeline.

Parameters:

dArray - an array of datagrams.

reqSampleTime - the sample rate at which the datagram durations are expressed.

Throws:

IOException - IOException