org.openimaj.audio.filters

Class EQFilter

java.lang.Object

org.openimaj.audio.Audio

org.openimaj.audio.AudioStream

org.openimaj.audio.processor.AudioProcessor

org.openimaj.audio.filters.EQFilter

All Implemented Interfaces:

Iterable<SampleChunk>

public class EQFilter
extends AudioProcessor

A class that encapsulates a bunch of different EQ-based filter algorithms that use a standard bi-quad filter (4th order Linkwitz-Riley filter).

Version:

$Author$, $Revision$, $Date$

Author:

David Dupplaw (dpd@ecs.soton.ac.uk)

See Also:

"http://musicdsp.org/showArchiveComment.php?ArchiveID=266"

Created:

19 Jul 2012

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EQFilter.EQType An enumerator for various audio filters.
static class	EQFilter.EQVars A class that represents the bi-quad coefficients for a filter.

Field Summary

Fields inherited from class org.openimaj.audio.Audio

format

Constructor Summary

Constructors

Constructor and Description
EQFilter(AudioStream as, EQFilter.EQType type, double f) Chainable constructor for stream processing.
EQFilter(EQFilter.EQType type, double f) Default constructor for ad-hoc processing.

Method Summary

Modifier and Type	Method and Description
SampleChunk	process(SampleChunk sample) Function that takes a sample chunk and processes the chunk.

Methods inherited from class org.openimaj.audio.processor.AudioProcessor

getLength, getUnderlyingStream, nextSampleChunk, process, processingComplete, reset, setUnderlyingStream

Methods inherited from class org.openimaj.audio.AudioStream

iterator, seek

Methods inherited from class org.openimaj.audio.Audio

getFormat, setFormat

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

EQFilter

public EQFilter(EQFilter.EQType type,
                double f)

Default constructor for ad-hoc processing.

Parameters:

type - The type of EQ

f - The frequency of the filter

EQFilter

public EQFilter(AudioStream as,
                EQFilter.EQType type,
                double f)

Chainable constructor for stream processing.

Parameters:

as - The audio stream to process

type - The type of EQ

f - The frequency of the filter

Method Detail

process

public SampleChunk process(SampleChunk sample)
                    throws Exception

Function that takes a sample chunk and processes the chunk. It should also return a sample chunk containing the processed data. If wished, the chunk may be side-affected and the input chunk returned. It should not be assumed that the input chunk will be side-affected, but it must be noted that it is possible that it could be. This process function may also return null. If null is returned it means that the rest of the audio stream is not required to be processed by this processing function. Whether the rest of the sample chunks are copied or ignored is up to the caller.

Specified by:

process in class AudioProcessor

Parameters:

sample - The sample chunk to process.

Returns:

A sample chunk containing processed data.

Throws:

Exception - If the processing could not take place

See Also:

AudioProcessor.process(org.openimaj.audio.SampleChunk)