AbstractSignalProcessor (Jipes 0.9.17 API)

java.lang.Object
- com.tagtraum.jipes.AbstractSignalProcessor<I,O>

Type Parameters:

I - type of the input values

O - type of the output values

All Implemented Interfaces:

SignalProcessor<I,O>, SignalPullProcessor<I,O>, SignalSource<O>

Direct Known Subclasses:

Aggregate, Channel, ConstantQTransform, DCT, Decimate, Downsample, FFT, FrameNumberFilter, IFFT, Interpolate, Mapping, Mel, Mono, MultiBand, NoopSignalProcessor, Novelty, OLA, Resample, SlidingWindow, Upsample
```
public abstract class AbstractSignalProcessor<I,O>
extends Object
implements SignalPullProcessor<I,O>, SignalProcessor<I,O>
```
Convenience super class for both SignalPullProcessor and SignalProcessor.

This class is a good starting point for processors that do not change the flow of data, i.e. don't collect data before they forward it. In other words, each processing step has one input and one output value.

Author:

Hendrik Schreiber

Field Summary

Fields
Modifier and Type Field and Description

protected O lastOut

protected SignalProcessorSupport<O> signalProcessorSupport

Fields
Modifier and Type	Field and Description
`protected O`	`lastOut`
`protected SignalProcessorSupport<O>`	`signalProcessorSupport`

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractSignalProcessor()

protected AbstractSignalProcessor(Object id)

Constructors
Modifier	Constructor and Description
`protected`	`AbstractSignalProcessor()`
`protected`	`AbstractSignalProcessor(Object id)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`<O2> SignalProcessor<O,O2>`	`connectTo(SignalProcessor<O,O2> signalProcessor)` Connects this processor to another processor to forward processed data to.
`<O2> SignalPullProcessor<O2,I>`	`connectTo(SignalPullProcessor<O2,I> source)` Sets the source to use for this `SignalPullProcessor`.
`void`	`connectTo(SignalSource<I> source)` Sets the source to use for this `SignalPullProcessor`.
`<O2> SignalProcessor<O,O2>`	`disconnectFrom(SignalProcessor<O,O2> signalProcessor)` Disconnects a child processor.
`void`	`flush()` Flushes this processor and its kids.
`SignalProcessor<O,?>[]`	`getConnectedProcessors()` Lists all connected processors.
`SignalSource<I>`	`getConnectedSource()` Get the current source/generator.
`Object`	`getId()` If no explicit id is set, this simply calls `Object.toString()`.
`O`	`getOutput()` The last object created by this processor.
`void`	`process(I 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 abstract O`	`processNext(I input)` Processes the given input and returns some output.
`O`	`read()` Provide the next chunk of output data.
`void`	`reset()` Calls `SignalSource.reset()`, if a source is set.
`void`	`setId(Object id)` Lets you provide an id.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - lastOut
```
protected O lastOut
```
  - signalProcessorSupport
```
protected SignalProcessorSupport<O> signalProcessorSupport
```
- Constructor Detail
  - AbstractSignalProcessor
```
protected AbstractSignalProcessor()
```
  - AbstractSignalProcessor
```
protected AbstractSignalProcessor(Object id)
```
    Parameters:
    
    id - id to retrieve the last output
    
    See Also:
    
    SignalProcessor.getId()
- Method Detail
  - flush
```
public void flush()
           throws IOException
```
    Flushes this processor and its kids.
    
    Specified by:
    
    flush in interface SignalProcessor<I,O>
    
    Throws:
    
    IOException
  - getOutput
```
public O getOutput()
            throws IOException
```
    The last object created by this processor.
    
    Specified by:
    
    getOutput in interface SignalProcessor<I,O>
    
    Returns:
    
    last object
    
    Throws:
    
    IOException
  - getId
```
public Object getId()
```
    If no explicit id is set, this simply calls Object.toString().
    
    Specified by:
    
    getId in interface SignalProcessor<I,O>
    
    Returns:
    
    id
    
    See Also:
    
    setId(Object)
  - setId
```
public void setId(Object id)
```
    Lets you provide an id.
    
    Parameters:
    
    id - some identifier
  - connectTo
```
public <O2> SignalProcessor<O,O2> connectTo(SignalProcessor<O,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<I,O>
    
    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<O,O2> disconnectFrom(SignalProcessor<O,O2> signalProcessor)
```
    Description copied from interface: SignalProcessor
    
    Disconnects a child processor.
    
    Specified by:
    
    disconnectFrom in interface SignalProcessor<I,O>
    
    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<O,?>[] getConnectedProcessors()
```
    Description copied from interface: SignalProcessor
    
    Lists all connected processors.
    
    Specified by:
    
    getConnectedProcessors in interface SignalProcessor<I,O>
    
    Returns:
    
    array of registered processors, never null
    
    See Also:
    
    SignalProcessor.disconnectFrom(SignalProcessor), SignalProcessor.connectTo(SignalProcessor)
  - connectTo
```
public <O2> SignalPullProcessor<O2,I> connectTo(SignalPullProcessor<O2,I> source)
```
    Description copied from interface: SignalPullProcessor
    
    Sets the source to use for this SignalPullProcessor.
    Because the method returns its parameter, it encourages method chaining to build processing chains/pipelines.
    
    Specified by:
    
    connectTo in interface SignalPullProcessor<I,O>
    
    Type Parameters:
    
    O2 - input type of the source processor
    
    Parameters:
    
    source - source
    
    Returns:
    
    the just set source, if it is a SignalPullProcessor
  - connectTo
```
public void connectTo(SignalSource<I> source)
```
    Description copied from interface: SignalPullProcessor
    
    Sets the source to use for this SignalPullProcessor.
    
    Specified by:
    
    connectTo in interface SignalPullProcessor<I,O>
    
    Parameters:
    
    source - source
  - getConnectedSource
```
public SignalSource<I> getConnectedSource()
```
    Description copied from interface: SignalPullProcessor
    
    Get the current source/generator.
    
    Specified by:
    
    getConnectedSource in interface SignalPullProcessor<I,O>
    
    Returns:
    
    source
  - reset
```
public void reset()
```
    Calls SignalSource.reset(), if a source is set.
    
    Specified by:
    
    reset in interface SignalSource<O>
  - read
```
public O 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<O>
    
    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(I 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<I,O>
    
    Parameters:
    
    in - data to process
    
    Throws:
    
    IOException - if a processing error occurs
    
    See Also:
    
    SignalProcessor.getConnectedProcessors()
  - processNext
```
protected abstract O processNext(I input)
                          throws IOException
```
    Processes the given input and returns some output.
    
    Parameters:
    
    input - input guaranteed not to be null.
    
    Returns:
    
    output produced by this processor
    
    Throws:
    
    IOException - if an IO error occurs

Class AbstractSignalProcessor<I,O>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

lastOut

signalProcessorSupport

Constructor Detail

AbstractSignalProcessor

AbstractSignalProcessor

Method Detail

flush

getOutput

getId

setId

connectTo

disconnectFrom

getConnectedProcessors

connectTo

connectTo

getConnectedSource

reset

read

process

processNext