com.tagtraum.jipes.audio

Class Zeropad<T extends AudioBuffer>

java.lang.Object

com.tagtraum.jipes.audio.Zeropad<T>

All Implemented Interfaces:

SignalProcessor<T,T>

public class Zeropad<T extends AudioBuffer>
extends Object
implements SignalProcessor<T,T>

Zeropads AudioBuffers at a given Zeropad.Position, so that a desired total size is reached.

Author:

Hendrik Schreiber

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Zeropad.Position

Constructor Summary

Constructors

Constructor and Description
Zeropad(Object id, Zeropad.Position position, int sizeAfterPadding)
Zeropad(Zeropad.Position position, int sizeAfterPadding)

Method Summary

Modifier and Type	Method and Description
<O2> SignalProcessor<T,O2>	connectTo(SignalProcessor<T,O2> signalProcessor) Connects this processor to another processor to forward processed data to.
<O2> SignalProcessor<T,O2>	disconnectFrom(SignalProcessor<T,O2> signalProcessor) Disconnects a child processor.
boolean	equals(Object o)
void	flush() Asks to complete all pending operations.
SignalProcessor<T,?>[]	getConnectedProcessors() Lists all connected processors.
Object	getId() Arbitrary object to identify a processor.
T	getOutput() First calls SignalProcessor.flush(), then returns the pending output, should there be any.
int	hashCode()
void	process(T 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.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Zeropad

public Zeropad(Object id,
               Zeropad.Position position,
               int sizeAfterPadding)

Zeropad

public Zeropad(Zeropad.Position position,
               int sizeAfterPadding)

Method Detail

process

public void process(T 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<T extends AudioBuffer,T extends AudioBuffer>

Parameters:

buffer - data to process

Throws:

IOException - if a processing error occurs

See Also:

SignalProcessor.getConnectedProcessors()

flush

public void flush()
           throws IOException

Description copied from interface: SignalProcessor

Asks to complete all pending operations. This method may be called multiple times without any adverse effects. It's the implementation's responsibility to call its kids' SignalProcessor.flush() method.

Specified by:

flush in interface SignalProcessor<T extends AudioBuffer,T extends AudioBuffer>

Throws:

IOException - if a processing error occurs

getOutput

public T getOutput()
            throws IOException

Description copied from interface: SignalProcessor

First calls SignalProcessor.flush(), then returns the pending output, should there be any. Note that this call may only succeed once to preserve memory.

Specified by:

getOutput in interface SignalProcessor<T extends AudioBuffer,T extends AudioBuffer>

Returns:

output, if available. If not, null is returned

Throws:

IOException - if a processing error occurs

getId

public Object getId()

Description copied from interface: SignalProcessor

Arbitrary object to identify a processor. This is useful for associating with results provided by SignalProcessor.getOutput().

Specified by:

getId in interface SignalProcessor<T extends AudioBuffer,T extends AudioBuffer>

Returns:

arbitrary non-null object. If this method returns null, potential results will not be associated with an identifier and potentially dropped

See Also:

SignalPump.pump()

connectTo

public <O2> SignalProcessor<T,O2> connectTo(SignalProcessor<T,O2> signalProcessor)

Description copied from interface: SignalProcessor

Connects this processor to another processor to forward processed data to. This method returns its parameter and therefore encourages method chaining to build processing chains/pipelines.

Specified by:

connectTo in interface SignalProcessor<T extends AudioBuffer,T extends AudioBuffer>

Type Parameters:

O2 - output type of the processor we want to connect to

Parameters:

signalProcessor - processor

Returns:

the just added processor

See Also:

SignalProcessor.disconnectFrom(SignalProcessor), SignalProcessor.getConnectedProcessors(), SignalPipeline

disconnectFrom

public <O2> SignalProcessor<T,O2> disconnectFrom(SignalProcessor<T,O2> signalProcessor)

Description copied from interface: SignalProcessor

Disconnects a child processor.

Specified by:

disconnectFrom in interface SignalProcessor<T extends AudioBuffer,T extends AudioBuffer>

Type Parameters:

O2 - output type of the processor we want to disconnect from

Parameters:

signalProcessor - processor

Returns:

the processor, if it was indeed removed

See Also:

SignalProcessor.connectTo(SignalProcessor), SignalProcessor.getConnectedProcessors()

getConnectedProcessors

public SignalProcessor<T,?>[] getConnectedProcessors()

Description copied from interface: SignalProcessor

Lists all connected processors.

Specified by:

getConnectedProcessors in interface SignalProcessor<T extends AudioBuffer,T extends AudioBuffer>

Returns:

array of registered processors, never null

See Also:

SignalProcessor.disconnectFrom(SignalProcessor), SignalProcessor.connectTo(SignalProcessor)

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