com.tagtraum.jipes.audio

Class FrameNumberFilter

java.lang.Object

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

com.tagtraum.jipes.audio.FrameNumberFilter

All Implemented Interfaces:

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

public class FrameNumberFilter
extends AbstractSignalProcessor<AudioBuffer,AudioBuffer>

Allows to ignore AudioBuffers, if their first frame number as returned by AudioBuffer.getFrameNumber() does not fall into a specified range. Note, that the max frame number is exclusive.

If the end of the buffer is higher than max frames, it is still let through, if the beginning is lower.

Author:

Hendrik Schreiber

Field Summary

Fields inherited from class com.tagtraum.jipes.AbstractSignalProcessor

lastOut, signalProcessorSupport

Constructor Summary

Constructors

Constructor and Description
FrameNumberFilter(int minFrameNumber, int maxFrameNumber) Creates a 'gatekeeper' for buffers with certain frame numbers.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	getMaxFrameNumber()
int	getMinFrameNumber()
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() Provide the next chunk of output data.
void	setMaxFrameNumber(int maxFrameNumber)
void	setMinFrameNumber(int minFrameNumber)
String	toString()

Methods inherited from class com.tagtraum.jipes.AbstractSignalProcessor

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

Methods inherited from class java.lang.Object

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

Constructor Detail

FrameNumberFilter

public FrameNumberFilter(int minFrameNumber,
                         int maxFrameNumber)

Creates a 'gatekeeper' for buffers with certain frame numbers.

Parameters:

minFrameNumber - each buffer's first frame number has to be at least as big as this

maxFrameNumber - if a buffer's first frame number is equal or greater, the whole buffer will be ignored

Method Detail

getMinFrameNumber

public int getMinFrameNumber()

setMinFrameNumber

public void setMinFrameNumber(int minFrameNumber)

getMaxFrameNumber

public int getMaxFrameNumber()

setMaxFrameNumber

public void setMaxFrameNumber(int maxFrameNumber)

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

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

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()

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