com.tagtraum.jipes.audio

Class OLA

java.lang.Object

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

com.tagtraum.jipes.audio.OLA

All Implemented Interfaces:

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

public class OLA
extends AbstractSignalProcessor<AudioBuffer,AudioBuffer>

Overlap-Add combines multiple overlapping windows into non-overlapping ones by adding the overlapping parts. This is the counterpart of SlidingWindow.

Author:

Hendrik Schreiber

See Also:

SlidingWindow

Field Summary

Fields inherited from class com.tagtraum.jipes.AbstractSignalProcessor

lastOut, signalProcessorSupport

Constructor Summary

Constructors

Constructor and Description
OLA() Creates a processor with a window length of 2048 frames and 1024 hop size.
OLA(int sliceLengthInFrames) Produces windows with a given frame length.
OLA(int sliceLengthInFrames, int hopSizeInFrames) Produces windows of frames that don't overlap.

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 in) 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 input) Processes the given input and returns some output.
AudioBuffer	read() Provide the next chunk of output data.
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, reset, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

OLA

public OLA()

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

OLA

public OLA(int sliceLengthInFrames,
           int hopSizeInFrames)

Produces windows of frames that don't overlap.

Parameters:

sliceLengthInFrames - frames per window

hopSizeInFrames - number of frames two consecutive input windows overlap

OLA

public OLA(int sliceLengthInFrames)

Produces windows with a given frame length. The input 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)

processNext

protected AudioBuffer processNext(AudioBuffer input)
                           throws IOException

Description copied from class: AbstractSignalProcessor

Processes the given input and returns some output.

Specified by:

processNext in class AbstractSignalProcessor<AudioBuffer,AudioBuffer>

Parameters:

input - input guaranteed not to be null.

Returns:

output produced by this processor

Throws:

IOException - if an IO error occurs

process

public void process(AudioBuffer in)
             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:

in - data to process

Throws:

IOException - if a processing error occurs

See Also:

SignalProcessor.getConnectedProcessors()

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

read

public AudioBuffer read()
                 throws IOException

Description copied from interface: SignalSource

Provide the next chunk of output data. This method is called by a consumer of SignalSource data, typically an SignalPullProcessor.

Specified by:

read in interface SignalSource<AudioBuffer>

Overrides:

read in class AbstractSignalProcessor<AudioBuffer,AudioBuffer>

Returns:

output data - perhaps a float[] or even a more complex object like a AudioBuffer, null if no more data is available

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