BandSplit (Jipes 0.9.17 API)

java.lang.Object
- com.tagtraum.jipes.audio.BandSplit<T>

All Implemented Interfaces:

SignalProcessor<T,AudioBuffer>, SignalSplit<T,AudioBuffer>
```
public class BandSplit<T extends AudioSpectrum>
extends Object
implements SignalSplit<T,AudioBuffer>
```
Takes the real values of a sequence of input spectra and creates new buffers for each frequency bin. These new buffers are then passed on to band-specific children. In other words, a number of real values with the index 0 are collected in one buffer and then sent to the child processor for band/channel 0. The same happens with magnitudes at index 1 and so on.

Author:

Hendrik Schreiber

Constructor Summary

Constructors
Constructor and Description

BandSplit(int windowLength)

Constructors
Constructor and Description
`BandSplit(int windowLength)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<O2> SignalProcessor<AudioBuffer,O2>`	`connectTo(int channel, SignalProcessor<AudioBuffer,O2> audioBufferSignalProcessor)` Registers a child processor for a specific channel.
`<O2> SignalProcessor<AudioBuffer,O2>`	`connectTo(SignalProcessor<AudioBuffer,O2> audioBufferSignalProcessor)` Connects this processor to another processor to forward processed data to.
`<O2> SignalProcessor<AudioBuffer,O2>`	`disconnectFrom(int channel, SignalProcessor<AudioBuffer,O2> audioBufferSignalProcessor)` Removes a child processor from a specific channel.
`<O2> SignalProcessor<AudioBuffer,O2>`	`disconnectFrom(SignalProcessor<AudioBuffer,O2> audioBufferSignalProcessor)` Disconnects a child processor.
`void`	`flush()` Asks to complete all pending operations.
`int`	`getChannelCount()` Number of channels the signal is split up into.
`SignalProcessor<AudioBuffer,?>[]`	`getConnectedProcessors()` Lists all connected processors.
`SignalProcessor<AudioBuffer,?>[]`	`getConnectedProcessors(int channel)` Lists all registered processors for a specific channel or band.
`Object`	`getId()` Arbitrary object to identify a processor.
`AudioBuffer`	`getOutput()` First calls `SignalProcessor.flush()`, then returns the pending output, should there be any.
`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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BandSplit
```
public BandSplit(int windowLength)
```
    Parameters:
    
    windowLength - the number of samples/magnitudes collected in each band to form the new (per) band buffer
- 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 AudioSpectrum,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 AudioSpectrum,AudioBuffer>
    
    Throws:
    
    IOException - if a processing error occurs
  - getOutput
```
public AudioBuffer 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 AudioSpectrum,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 AudioSpectrum,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()
  - getChannelCount
```
public int getChannelCount()
```
    Description copied from interface: SignalSplit
    
    Number of channels the signal is split up into.
    
    Specified by:
    
    getChannelCount in interface SignalSplit<T extends AudioSpectrum,AudioBuffer>
    
    Returns:
    
    number of channels the signal is split up into
  - connectTo
```
public <O2> SignalProcessor<AudioBuffer,O2> connectTo(int channel,
                                                      SignalProcessor<AudioBuffer,O2> audioBufferSignalProcessor)
```
    Description copied from interface: SignalSplit
    
    Registers a child processor for a specific channel.
    
    Specified by:
    
    connectTo in interface SignalSplit<T extends AudioSpectrum,AudioBuffer>
    
    Type Parameters:
    
    O2 - output type of the processor we want to connect to
    
    Parameters:
    
    channel - channel
    
    audioBufferSignalProcessor - processor
    
    Returns:
    
    the just added processor
    
    See Also:
    
    SignalProcessor.disconnectFrom(com.tagtraum.jipes.SignalProcessor), SignalProcessor.getConnectedProcessors()
  - disconnectFrom
```
public <O2> SignalProcessor<AudioBuffer,O2> disconnectFrom(int channel,
                                                           SignalProcessor<AudioBuffer,O2> audioBufferSignalProcessor)
```
    Description copied from interface: SignalSplit
    
    Removes a child processor from a specific channel.
    
    Specified by:
    
    disconnectFrom in interface SignalSplit<T extends AudioSpectrum,AudioBuffer>
    
    Type Parameters:
    
    O2 - output type of the processor we want to disconnect from
    
    Parameters:
    
    channel - channel
    
    audioBufferSignalProcessor - processor
    
    Returns:
    
    the processor, if it was indeed removed
    
    See Also:
    
    SignalProcessor.connectTo(com.tagtraum.jipes.SignalProcessor), SignalProcessor.getConnectedProcessors()
  - getConnectedProcessors
```
public SignalProcessor<AudioBuffer,?>[] getConnectedProcessors(int channel)
```
    Description copied from interface: SignalSplit
    
    Lists all registered processors for a specific channel or band.
    
    Specified by:
    
    getConnectedProcessors in interface SignalSplit<T extends AudioSpectrum,AudioBuffer>
    
    Parameters:
    
    channel - channel or band
    
    Returns:
    
    array of registered processors, never null
    
    See Also:
    
    SignalProcessor.disconnectFrom(com.tagtraum.jipes.SignalProcessor), SignalProcessor.connectTo(com.tagtraum.jipes.SignalProcessor)
  - connectTo
```
public <O2> SignalProcessor<AudioBuffer,O2> connectTo(SignalProcessor<AudioBuffer,O2> audioBufferSignalProcessor)
```
    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 AudioSpectrum,AudioBuffer>
    
    Type Parameters:
    
    O2 - output type of the processor we want to connect to
    
    Parameters:
    
    audioBufferSignalProcessor - processor
    
    Returns:
    
    the just added processor
    
    See Also:
    
    SignalProcessor.disconnectFrom(SignalProcessor), SignalProcessor.getConnectedProcessors(), SignalPipeline
  - disconnectFrom
```
public <O2> SignalProcessor<AudioBuffer,O2> disconnectFrom(SignalProcessor<AudioBuffer,O2> audioBufferSignalProcessor)
```
    Description copied from interface: SignalProcessor
    
    Disconnects a child processor.
    
    Specified by:
    
    disconnectFrom in interface SignalProcessor<T extends AudioSpectrum,AudioBuffer>
    
    Type Parameters:
    
    O2 - output type of the processor we want to disconnect from
    
    Parameters:
    
    audioBufferSignalProcessor - processor
    
    Returns:
    
    the processor, if it was indeed removed
    
    See Also:
    
    SignalProcessor.connectTo(SignalProcessor), SignalProcessor.getConnectedProcessors()
  - getConnectedProcessors
```
public SignalProcessor<AudioBuffer,?>[] getConnectedProcessors()
```
    Description copied from interface: SignalProcessor
    
    Lists all connected processors.
    
    Specified by:
    
    getConnectedProcessors in interface SignalProcessor<T extends AudioSpectrum,AudioBuffer>
    
    Returns:
    
    array of registered processors, never null
    
    See Also:
    
    SignalProcessor.disconnectFrom(SignalProcessor), SignalProcessor.connectTo(SignalProcessor)
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class BandSplit<T extends AudioSpectrum>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BandSplit

Method Detail

process

flush

getOutput

getId

getChannelCount

connectTo

disconnectFrom

getConnectedProcessors

connectTo

disconnectFrom

getConnectedProcessors

toString