com.tagtraum.jipes.audio

Class SlidingWindow

java.lang.Object

com.tagtraum.jipes.AbstractSignalProcessor<AudioBuffer,AudioBuffer>

com.tagtraum.jipes.audio.SlidingWindow

All Implemented Interfaces:

SignalProcessor<AudioBuffer,AudioBuffer>, SignalPullProcessor<AudioBuffer,AudioBuffer>, SignalSource<AudioBuffer>

public class SlidingWindow
extends AbstractSignalProcessor<AudioBuffer,AudioBuffer>

Provides overlapping frame blocks (aka slices or windows or frames) of a defined size. This is the counterpart of SlidingWindow.
If no new data can be obtained the last few blocks/windows are zero padded until all data disappeared from the window. Only then read() returns null.
Note that the pull API makes heavy object re-use. Do not rely on returned buffers being immutable. If you need to keep a buffer around for longer than the call in which it was given to you, Object.clone() it.

Author:

Hendrik Schreiber

See Also:

OLA

Field Summary

Fields inherited from class com.tagtraum.jipes.AbstractSignalProcessor

lastOut, signalProcessorSupport

Constructor Summary

Constructors

Constructor and Description
SlidingWindow() Creates a processor with a window length of 2048 frames and 1024 hop size.
SlidingWindow(int sliceLengthInFrames) Produces windows with a given frame length.
SlidingWindow(int sliceLengthInFrames, int hopSizeInFrames) Produces windows of frames that overlap to a certain degree.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
void	flush() Flushes this processor and its kids.
int	getHopSizeInFrames()
int	getSliceLengthInFrames()
int	hashCode()
void	process(AudioBuffer buffer) Asks this processor to work on the provided data and pipe the output to the connected processors' own SignalProcessor.process(Object) method. Implementing methods must not modify or hold on to the provided data.
protected AudioBuffer	processNext(AudioBuffer buffer) Processes the given input and returns some output.
AudioBuffer	read() If no new data can be obtained the last few blocks/windows are zero padded until all data disappeared from the window.
void	reset() Calls SignalSource.reset(), if a source is set.
void	setHopSizeInFrames(int hopSizeInFrames)
void	setSliceLengthInFrames(int sliceLengthInFrames)
String	toString()

Methods inherited from class com.tagtraum.jipes.AbstractSignalProcessor

connectTo, connectTo, connectTo, disconnectFrom, getConnectedProcessors, getConnectedSource, getId, getOutput, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

SlidingWindow

public SlidingWindow()

Creates a processor with a window length of 2048 frames and 1024 hop size.

SlidingWindow

public SlidingWindow(int sliceLengthInFrames,
                     int hopSizeInFrames)

Produces windows of frames that overlap to a certain degree.

Parameters:

sliceLengthInFrames - frames per window

hopSizeInFrames - number of frames two consecutive windows overlap

SlidingWindow

public SlidingWindow(int sliceLengthInFrames)

Produces windows with a given frame length. The windows overlap by half their length.

Parameters:

sliceLengthInFrames - frames per window

Method Detail

getHopSizeInFrames

public int getHopSizeInFrames()

setHopSizeInFrames

public void setHopSizeInFrames(int hopSizeInFrames)

getSliceLengthInFrames

public int getSliceLengthInFrames()

setSliceLengthInFrames

public void setSliceLengthInFrames(int sliceLengthInFrames)

reset

public void reset()

Description copied from class: AbstractSignalProcessor

Calls SignalSource.reset(), if a source is set.

Specified by:

reset in interface SignalSource<AudioBuffer>

Overrides:

reset in class AbstractSignalProcessor<AudioBuffer,AudioBuffer>

processNext

protected AudioBuffer processNext(AudioBuffer buffer)
                           throws IOException

Description copied from class: AbstractSignalProcessor

Processes the given input and returns some output.

Specified by:

processNext in class AbstractSignalProcessor<AudioBuffer,AudioBuffer>

Parameters:

buffer - input guaranteed not to be null.

Returns:

output produced by this processor

Throws:

IOException - if an IO error occurs

flush

public void flush()
           throws IOException

Description copied from class: AbstractSignalProcessor

Flushes this processor and its kids.

Specified by:

flush in interface SignalProcessor<AudioBuffer,AudioBuffer>

Overrides:

flush in class AbstractSignalProcessor<AudioBuffer,AudioBuffer>

Throws:

IOException - if a processing error occurs

process

public void process(AudioBuffer buffer)
             throws IOException

Description copied from interface: SignalProcessor

Asks this processor to work on the provided data and pipe the output to the connected processors' own SignalProcessor.process(Object) method.
Implementing methods must not modify or hold on to the provided data. In other words: the provided object does not belong to you, its values are only guaranteed to be stable for the duration of the call.

If you need to hold on to data, create a copy of the provided data via a copy constructor or the Object.clone() method.

It is the responsibility of implementing classes to call the SignalProcessor.process(Object) method of any connected processors. To manage connected processors classes may want to use a SignalProcessorSupport instance.

Specified by:

process in interface SignalProcessor<AudioBuffer,AudioBuffer>

Overrides:

process in class AbstractSignalProcessor<AudioBuffer,AudioBuffer>

Parameters:

buffer - data to process

Throws:

IOException - if a processing error occurs

See Also:

SignalProcessor.getConnectedProcessors()

read

public AudioBuffer read()
                 throws IOException

If no new data can be obtained the last few blocks/windows are zero padded until all data disappeared from the window. Only then read() returns null.

Specified by:

read in interface SignalSource<AudioBuffer>

Overrides:

read in class AbstractSignalProcessor<AudioBuffer,AudioBuffer>

Returns:

sliding windowed view on the generator's data.

Throws:

IOException - if something goes wrong

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object