org.openimaj.audio.filters

Class MusicalNoteFilterBank

java.lang.Object

org.openimaj.audio.Audio

org.openimaj.audio.AudioStream

org.openimaj.audio.processor.AudioProcessor

org.openimaj.audio.filters.MusicalNoteFilterBank

All Implemented Interfaces:

Iterable<SampleChunk>

public class MusicalNoteFilterBank
extends AudioProcessor

A filter bank for musical note detection. Uses a set of comb filters tuned to the notes that are to be detected.

Version:

$Author$, $Revision$, $Date$

Author:

David Dupplaw

Created:

30 Apr 2012

Constructor Summary

Constructors

Constructor and Description
MusicalNoteFilterBank(AudioFormat af) Create a 12-deep filter bank for detecting notes between C4 and C5.
MusicalNoteFilterBank(int startOfRange, int endOfRange, AudioFormat af) Create a filter bank for detecting notes between the start note given and the end note given.

Method Summary

Modifier and Type	Method and Description
double	getOutputPower() Get the last calculated output power.
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

MusicalNoteFilterBank

public MusicalNoteFilterBank(AudioFormat af)

Create a 12-deep filter bank for detecting notes between C4 and C5. The audio format may be null if not known in advance; in this case, the filter bank will be setup lazily during the processing loop.

Parameters:

af - The audio format of the filter bank

MusicalNoteFilterBank

public MusicalNoteFilterBank(int startOfRange,
                             int endOfRange,
                             AudioFormat af)

Create a filter bank for detecting notes between the start note given and the end note given. The audio format may be null if not known in advance; in this case, the filter bank will be setup lazily during the processing loop.

Parameters:

startOfRange - The start MIDI note number to detect

endOfRange - The end MIDI note number to detect.

af - The format

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)

getOutputPower

public double getOutputPower()

Get the last calculated output power.

Returns:

The last calcualted output power