org.openimaj.audio.filters

Class MusicalNoteOnsetDetector

java.lang.Object

org.openimaj.audio.Audio

org.openimaj.audio.AudioStream

org.openimaj.audio.processor.AudioProcessor

org.openimaj.audio.filters.MusicalNoteOnsetDetector

All Implemented Interfaces:

Iterable<SampleChunk>

public class MusicalNoteOnsetDetector
extends AudioProcessor

Uses a MusicalNoteFilterBank to determine the power output of the notes of a western scale over the frame. It calculates the power difference between successive frames to determine whether a new note has been detected.

Version:

$Author$, $Revision$, $Date$

Author:

David Dupplaw

Created:

22 May 2012

Field Summary

Fields inherited from class org.openimaj.audio.Audio

format

Constructor Summary

Constructors

Constructor and Description
MusicalNoteOnsetDetector()

Method Summary

Modifier and Type	Method and Description
boolean	hasOnsetBeenDetected() Returns whether an onset was detected during the last processing cycle.
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

MusicalNoteOnsetDetector

public MusicalNoteOnsetDetector()

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)

hasOnsetBeenDetected

public boolean hasOnsetBeenDetected()

Returns whether an onset was detected during the last processing cycle.

Returns:

TRUE if an onset was detected during the last processing cycle; FALSE otherwise.