com.tagtraum.jipes

Class SignalPump<I>

java.lang.Object

com.tagtraum.jipes.SignalPump<I>

Type Parameters:

I - type of the input values from the associated SignalSource

public class SignalPump<I>
extends Object

Pumps a signal from a SignalSource through a graph of SignalProcessors, also known as processing pipelines and lets you collect the results in a Map. After being added to this pump, the pipelines are optimized to avoid redundant processing, if at all possible.

To use a pump,

1. Set a SignalSource.
2. Then add(com.tagtraum.jipes.SignalProcessor) one or more already configured processors or pipelines.
3. Call pump().
4. Collect the results in the form of an id/output map.

Author:

Hendrik Schreiber

Constructor Summary

Constructors

Constructor and Description
SignalPump()
SignalPump(SignalSource<I> signalSource)

Method Summary

Modifier and Type	Method and Description
void	add(SignalProcessor<I,?> signalProcessor) Lets you add a SignalProcessor-pipeline (that is a processor and its kids) to this pump.
void	cancel() Cancels pump().
String	getDescription() Produces a readable ASCII description of this pump and its pipelines.
Set<SignalProcessor<I,?>>	getEffectiveProcessorGraphs() Returns the currently effective processing graphs.
SignalSource<I>	getSignalSource() Returns the currently set signal source.
boolean	isCancelled() Indicates, whether a pump operation has been cancelled.
Map<Object,Object>	pump() 'Pumps' the provided SignalSource until it's dry and pushes the produced data into the configured SignalProcessors.
void	setSignalSource(SignalSource<I> signalSource) Lets you set the SignalSource that this pump will use as source.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SignalPump

public SignalPump(SignalSource<I> signalSource)

SignalPump

public SignalPump()

Method Detail

getSignalSource

public SignalSource<I> getSignalSource()

Returns the currently set signal source.

Returns:

signal source

setSignalSource

public void setSignalSource(SignalSource<I> signalSource)

Lets you set the SignalSource that this pump will use as source.

Parameters:

signalSource - signal source

add

public void add(SignalProcessor<I,?> signalProcessor)

Lets you add a SignalProcessor-pipeline (that is a processor and its kids) to this pump. To be of any use, most processors will have one or more children to execute multiple processing steps. Internally, pipelines are optimized (i.e. re-organized) to drop redundant steps. This implies, that you must never change the state of a processor or the makeup of a pipeline/graph, after it has been added to the pipeline: results would be unpredictable.
Insertion order is preserved. This means SignalProcessor.process(Object), and SignalProcessor.flush() are called on processors in the order they were added.

Parameters:

signalProcessor - ready to use processor with kids (a.k.a. pipeline)

pump

public Map<Object,Object> pump()
                        throws IOException,
                               IllegalStateException

'Pumps' the provided SignalSource until it's dry and pushes the produced data into the configured SignalProcessors. Then collects the output by calling SignalProcessor.getOutput() of all registered processors (and their children).

Note that every output/result id in all pipelines must be unique, if you actually want to be certain that it is from the one processor you are interested in. Standard ids are not unique (see AbstractSignalProcessor.getId()).

Returns:

a map of ids (see SignalProcessor.getId()}) and their associated output (see SignalProcessor.getOutput())

Throws:

IOException - if any IO problems occur

IllegalStateException - if the SignalSource is not set

See Also:

AbstractSignalProcessor, AudioSignalSource

cancel

public void cancel()

Cancels pump(). May be called from another thread.

isCancelled

public boolean isCancelled()

Indicates, whether a pump operation has been cancelled.

Returns:

true or false

See Also:

cancel()

getEffectiveProcessorGraphs

public Set<SignalProcessor<I,?>> getEffectiveProcessorGraphs()

Returns the currently effective processing graphs. Due to optimizations, this may not be the same as the pipelines added via add(com.tagtraum.jipes.SignalProcessor).

This graph is read-only. Do not modify it.

Returns:

set of processing graphs

getDescription

public String getDescription()

Produces a readable ASCII description of this pump and its pipelines.

Returns:

multi-line description

toString

public String toString()

Overrides:

toString in class Object