FrameProvider (MaryTTS 5.2 API)

java.lang.Object
- marytts.signalproc.process.FrameProvider

Direct Known Subclasses:

FrameBasedAnalyser, PitchFrameProvider
```
public class FrameProvider
extends Object
```
Cut frames out of a given signal, and provide them one by one, optionally applying a processor to the frame. This base implementation provides frames of a fixed length with a fixed shift.

Author:

Marc Schröder

See Also:
PitchFrameProvider

Field Summary

Fields
Modifier and Type	Field and Description
`protected double[]`	`frame`
`protected int`	`frameLength`
`protected int`	`frameShift`
`protected long`	`frameStart` The start time of the currently analysed frame.
`protected long`	`nextFrameStart`
`protected InlineDataProcessor`	`processor`
`protected int`	`samplingRate` The sampling rate.
`protected DoubleDataSource`	`signal`
`protected int`	`totalRead`
`protected int`	`validSamplesInFrame`

Constructor Summary

Constructors
Constructor and Description
`FrameProvider(DoubleDataSource signal, InlineDataProcessor processor, int frameLength, int frameShift, int samplingRate, boolean stopWhenTouchingEnd)` Initialise a FrameProvider.

Method Summary

Methods
Modifier and Type	Method and Description
`double[]`	`getCurrentFrame()`
`protected int`	`getData(int nPrefilled)` Read data from input signal into current frame.
`int`	`getFrameLengthSamples()` The number of samples in the current frame.
`double`	`getFrameLengthTime()` The time length of a frame.
`int`	`getFrameShiftSamples()` The number of samples by which one frame is shifted against the next.
`double`	`getFrameShiftTime()` The amount of time by which one frame is shifted against the next.
`long`	`getFrameStartSamples()` Start position of current frame, in samples
`double`	`getFrameStartTime()` Start position of current frame, in seconds
`double[]`	`getNextFrame()` Fill the internal double array with the next frame of data.
`int`	`getSamplingRate()`
`boolean`	`hasMoreData()` Whether or not this frameprovider can provide another frame.
`static void`	`main(String[] args)`
`void`	`resetInternalTimer()` Reset the internal time stamp to 0.
`boolean`	`stopWhenTouchingEnd()` Whether or not this frame provider stops when the first frame touches the last input sample.
`int`	`validSamplesInFrame()` This tells how many valid samples have been read into the current frame (before applying the optional data processor!).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - signal
```
protected DoubleDataSource signal
```
  - processor
```
protected InlineDataProcessor processor
```
  - samplingRate
```
protected int samplingRate
```
    The sampling rate.
  - frameStart
```
protected long frameStart
```
    The start time of the currently analysed frame.
  - nextFrameStart
```
protected long nextFrameStart
```
  - totalRead
```
protected int totalRead
```
  - frame
```
protected double[] frame
```
  - validSamplesInFrame
```
protected int validSamplesInFrame
```
  - frameShift
```
protected int frameShift
```
  - frameLength
```
protected int frameLength
```
- Constructor Detail
  - FrameProvider
```
public FrameProvider(DoubleDataSource signal,
             InlineDataProcessor processor,
             int frameLength,
             int frameShift,
             int samplingRate,
             boolean stopWhenTouchingEnd)
```
    Initialise a FrameProvider.
    
    Parameters:
    signal - the signal source to read from
    processor - an optional data processor to apply to the source signal. If null, the original data will be returned.
    frameLength - the number of samples in one frame.
    frameShift - the number of samples by which to shift the window from one frame analysis to the next; if this is smaller than window.getLength(), frames will overlap.
    samplingRate - the number of samples in one second.
    stopWhenTouchingEnd - whether or not this frame provider stops when the first frame touches the last input sample. When this is set to true, the last frame will be the first one including the last sample; when this is set to false, the last frame will be the last that still contains any data.
- Method Detail
  - getFrameStartTime
```
public double getFrameStartTime()
```
    Start position of current frame, in seconds
    
    Returns:
    the start time of the last frame returned by getNextFrame(), or a small negative number if no frame has been served yet.
  - getFrameStartSamples
```
public long getFrameStartSamples()
```
    Start position of current frame, in samples
    
    Returns:
    the start position of the last frame returned by getNextFrame(), or -1 if no frame has been served yet.
  - getSamplingRate
```
public int getSamplingRate()
```
  - getFrameShiftTime
```
public double getFrameShiftTime()
```
    The amount of time by which one frame is shifted against the next.
    
    Returns:
    frameShift / samplingRate
  - getFrameShiftSamples
```
public int getFrameShiftSamples()
```
    The number of samples by which one frame is shifted against the next.
    
    Returns:
    frameShift
  - getFrameLengthTime
```
public double getFrameLengthTime()
```
    The time length of a frame.
    
    Returns:
    getFrameLengthSamples / samplingRate
  - getFrameLengthSamples
```
public int getFrameLengthSamples()
```
    The number of samples in the current frame.
    
    Returns:
    frameLength
  - stopWhenTouchingEnd
```
public boolean stopWhenTouchingEnd()
```
    Whether or not this frame provider stops when the first frame touches the last input sample. When this returns true, the last frame will be the first one including the last sample; when this returns false, the last frame will be the last that still contains any data. Defaults to true.
    
    Returns:
    stopWhenTouchingEnd
  - hasMoreData
```
public boolean hasMoreData()
```
    Whether or not this frameprovider can provide another frame.
    
    Returns:
    signal.hasMoreData() or different from stopWhenTouchingEnd and memoryFilled and posInMemory < memory.length
  - validSamplesInFrame
```
public int validSamplesInFrame()
```
    This tells how many valid samples have been read into the current frame (before applying the optional data processor!).
    
    Returns:
    validSamplesInFrame
  - getNextFrame
```
public double[] getNextFrame()
```
    Fill the internal double array with the next frame of data. The last frame, if only partially filled with the rest of the signal, is filled up with zeroes. If stopWhenTouchingEnd() returns true, this method will provide not more than a single zero-padded frame at the end of the signal.
    
    Returns:
    the next frame on success, null on failure.
  - getCurrentFrame
```
public double[] getCurrentFrame()
```
  - getData
```
protected int getData(int nPrefilled)
```
    Read data from input signal into current frame. This base implementation will attempt to fill the frame from the position given in nPrefilled onwards.
    
    Parameters:
    nPrefilled - number of valid values at the beginning of frame. These should not be lost or overwritten.
    
    Returns:
    the number of new values read into frame at position nPrefilled.
  - resetInternalTimer
```
public void resetInternalTimer()
```
    Reset the internal time stamp to 0.
  - main
```
public static void main(String[] args)
                 throws Exception
```
    Throws:
    
    Exception

Class FrameProvider

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

signal

processor

samplingRate

frameStart

nextFrameStart

totalRead

frame

validSamplesInFrame

frameShift

frameLength

Constructor Detail

FrameProvider

Method Detail

getFrameStartTime

getFrameStartSamples

getSamplingRate

getFrameShiftTime

getFrameShiftSamples

getFrameLengthTime

getFrameLengthSamples

stopWhenTouchingEnd

hasMoreData

validSamplesInFrame

getNextFrame

getCurrentFrame

getData

resetInternalTimer

main