com.tagtraum.jipes.audio

Class Decimate

java.lang.Object

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

com.tagtraum.jipes.audio.Decimate

All Implemented Interfaces:

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

public class Decimate
extends AbstractSignalProcessor<AudioBuffer,AudioBuffer>

Applies an appropriate low pass filter before dropping samples.

Author:

Hendrik Schreiber

See Also:

MultirateFilters.Decimator, Interpolate

Field Summary

Fields inherited from class com.tagtraum.jipes.AbstractSignalProcessor

lastOut, signalProcessorSupport

Constructor Summary

Constructors

Constructor and Description
Decimate() Creates a decimate processor that drops/keeps every second frame.
Decimate(float targetSampleRate) Creates a decimate processor that attempts to decimate AudioBuffers to the specified target sample rate.
Decimate(int factor) Keeps every nth frame, drops all other frames.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	getFactor()
float	getTargetSampleRate()
int	hashCode()
protected AudioBuffer	processNext(AudioBuffer buffer) Processes the given input and returns some output.
void	setFactor(int factor) Every factorth frame will be kept.
void	setTargetSampleRate(float targetSampleRate)
String	toString()

Methods inherited from class com.tagtraum.jipes.AbstractSignalProcessor

connectTo, connectTo, connectTo, disconnectFrom, flush, getConnectedProcessors, getConnectedSource, getId, getOutput, process, read, reset, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

Decimate

public Decimate(int factor)

Keeps every nth frame, drops all other frames.

Parameters:

factor - nth frame to keep

Decimate

public Decimate()

Creates a decimate processor that drops/keeps every second frame.

Decimate

public Decimate(float targetSampleRate)

Creates a decimate processor that attempts to decimate AudioBuffers to the specified target sample rate. Note that not all sample rates are supported. The ratio between sample rates should be an integer. If the target sample rate is not supported, an IOException is thrown when processing the first buffer.

Parameters:

targetSampleRate - target sample rate

Method Detail

getFactor

public int getFactor()

Returns:

frame to keep or 0, if only a target sample rate was set

See Also:

setFactor(int)

getTargetSampleRate

public float getTargetSampleRate()

Returns:

target sample rate or 0, if only a factor was set

setTargetSampleRate

public void setTargetSampleRate(float targetSampleRate)

Parameters:

targetSampleRate - target sample rate

setFactor

public void setFactor(int factor)

Every factorth frame will be kept. So if you specify 2, every 2nd frame will be kept. If you specify 3, every third frame will be kept - leading to a sample rate reduction of, e.g. 44100 to 44100/3 = 14700.

Parameters:

factor - frame to keep

Throws:

IllegalArgumentException - not all factors are supported

See Also:

com.tagtraum.jipes.math.MultirateFilters.Decimator#Decimator(int)

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

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