uk.org.toot.audio.filter
Interface Filter

All Known Implementing Classes:
AbstractFilter, BiQuadFilter, FIRFilter

public interface Filter


Nested Class Summary
static interface Filter.State
           
static class Filter.Type
          Classic filter types
 
Method Summary
 void clear()
          Clear the filter's states (i.e.
 void close()
          Close this Filter, release resources, deleteObservers etc.
 void filter(float[] source, float[] dest, int length, int chan, boolean mix)
          Filter the source signal to the destination signal.
 void open()
          Open this Filter, acquire resources, addObservers etc.
 void setSampleRate(int sampleRate)
          Called when the sample rate changes.
 

Method Detail

open

void open()
Open this Filter, acquire resources, addObservers etc.


close

void close()
Close this Filter, release resources, deleteObservers etc.


filter

void filter(float[] source,
            float[] dest,
            int length,
            int chan,
            boolean mix)
Filter the source signal to the destination signal. If the source and dest are the same a simple in-place filter should result. If the source and destination are different the Filter should add (or subtract) a portion of the source to the destination. This portion should represent the contribution to an equaliser comprising multiple such filters.

Parameters:
chan - permits the Filter to use different States for different logical filter channels.

clear

void clear()
Clear the filter's states (i.e. the delay taps). This is to avoid glitches in non-contiguous filtering.


setSampleRate

void setSampleRate(int sampleRate)
Called when the sample rate changes.



Copyright © 2004, 2005, 2006, 2007 Steve Taylor. All Rights Reserved.