org.openimaj.vis.audio

Class AudioOverviewVisualisation.AudioOverviewGenerator

java.lang.Object

org.openimaj.audio.Audio

org.openimaj.audio.AudioStream

org.openimaj.audio.processor.AudioProcessor

org.openimaj.vis.audio.AudioOverviewVisualisation.AudioOverviewGenerator

All Implemented Interfaces:

Iterable<SampleChunk>

Enclosing class:

AudioOverviewVisualisation

public class AudioOverviewVisualisation.AudioOverviewGenerator
extends AudioProcessor

Generates an audio overview. This is a lower-resolution version of the audio waveform. It takes the maximum value from a set of values and stores this as the overview. By default the processor takes the maximum value from every 5000 samples. The method getAudioOverview(int, int) allows resampling of that overview.

Author:

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

Created:

21 Jul 2011

Field Summary

Fields inherited from class org.openimaj.audio.Audio

format

Constructor Summary

Constructors

Constructor and Description
AudioOverviewGenerator(int nSamplesPerBin, int nChannels) Constructor

Method Summary

Modifier and Type	Method and Description
gnu.trove.list.array.TFloatArrayList[]	getAudioOverview()
gnu.trove.list.array.TFloatArrayList	getAudioOverview(int channel, int nBins) Refactors the overview to given another overview.
Polygon	getChannelPolygon(int channel, boolean mirror, int width) Returns a polygon representing the channel overview.
SampleChunk	process(SampleChunk samples) 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

AudioOverviewGenerator

public AudioOverviewGenerator(int nSamplesPerBin,
                              int nChannels)

Constructor

Parameters:

nSamplesPerBin - The number of samples per bin

nChannels - The number of channels

Method Detail

process

public SampleChunk process(SampleChunk samples)

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:

samples - The sample chunk to process.

Returns:

A sample chunk containing processed data.

See Also:

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

getAudioOverview

public gnu.trove.list.array.TFloatArrayList[] getAudioOverview()

Returns:

Get the overview data.

getAudioOverview

public gnu.trove.list.array.TFloatArrayList getAudioOverview(int channel,
                                                             int nBins)

Refactors the overview to given another overview. If the number of bins specified an overview that's finer than the actual overview the original overview is returned. The output of this function will then only return an array list of nBins or less.

Parameters:

channel - The channel to get

nBins - The number of bins in the overview

Returns:

A refactors overview

getChannelPolygon

public Polygon getChannelPolygon(int channel,
                                 boolean mirror,
                                 int width)

Returns a polygon representing the channel overview.

Parameters:

channel - The channel to get the polygon for

mirror - whether to mirror the polygon

width - The width of the overview to return

Returns:

A polygon