org.openimaj.audio

Class FrequencyAudioSource

java.lang.Object

org.openimaj.audio.Audio

org.openimaj.audio.AudioStream

org.openimaj.audio.processor.AudioProcessor

org.openimaj.audio.FrequencyAudioSource

All Implemented Interfaces:

Iterable<SampleChunk>, Runnable

public class FrequencyAudioSource
extends AudioProcessor
implements Runnable

AudioProcessor that provides frequency information.

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FrequencyAudioSource.Listener Interface for classes that listen to the frequency information extracted by the FrequencyAudioSource.

Field Summary

Fields inherited from class org.openimaj.audio.Audio

format

Constructor Summary

Constructors

Constructor and Description
FrequencyAudioSource(AudioStream stream) Construct on top of given stream

Method Summary

Modifier and Type	Method and Description
void	addFrequencyListener(FrequencyAudioSource.Listener l) Add a listener
void	addFrequencyListener(FrequencyAudioSource.Listener l, Pair<Integer> requestFrequencyRange) Add a listener
SampleChunk	process(SampleChunk sample) Function that takes a sample chunk and processes the chunk.
void	run()

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

FrequencyAudioSource

public FrequencyAudioSource(AudioStream stream)

Construct on top of given stream

Parameters:

stream - the stream

Method Detail

process

public SampleChunk process(SampleChunk sample)
                    throws Exception

Description copied from class: AudioProcessor

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

run

public void run()

Specified by:

run in interface Runnable

addFrequencyListener

public void addFrequencyListener(FrequencyAudioSource.Listener l)

Add a listener

Parameters:

l - the listener

addFrequencyListener

public void addFrequencyListener(FrequencyAudioSource.Listener l,
                                 Pair<Integer> requestFrequencyRange)

Add a listener

Parameters:

l - the listener

requestFrequencyRange - the range