org.openimaj.audio.util

Class MemoryAudioSource

java.lang.Object

org.openimaj.audio.Audio

org.openimaj.audio.AudioStream

org.openimaj.audio.util.MemoryAudioSource

All Implemented Interfaces:

Iterable<SampleChunk>

public class MemoryAudioSource
extends AudioStream

Provides a buffered audio source such that the audio can be reset and re-read as many times as needed without the need for redecoding. You should pass your audio stream through this method if you need to do certain complete-source calculations on the data (such as finding peak or means) prior to some other processing. Clearly, the limitation to how long an audio source you can store with this class is the memory of your machine, and remember that the audio samples are stored uncompressed, so they take up a lot of room! If you're planning on performing complete-source calculations on large audio data, it is recommended to stream the data multiple times.

Version:

$Author$, $Revision$, $Date$

Author:

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

Created:

4 Mar 2013

Field Summary

Fields inherited from class org.openimaj.audio.Audio

format

Constructor Summary

Constructors

Constructor and Description
MemoryAudioSource(AudioStream as) Constructor that takes the audio stream to buffer.

Method Summary

Modifier and Type	Method and Description
long	getLength() For live streams, returns the length of the buffered audio, otherwise returns the length of the original stream.
SampleChunk	nextSampleChunk() Retrieve the next SampleChunk from the audio stream.
void	reset() Reset the audio stream.

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

MemoryAudioSource

public MemoryAudioSource(AudioStream as)

Constructor that takes the audio stream to buffer.

Parameters:

as - The audio stream

Method Detail

nextSampleChunk

public SampleChunk nextSampleChunk()

Retrieve the next SampleChunk from the audio stream.

Specified by:

nextSampleChunk in class AudioStream

Returns:

The next sample chunk in the audio stream.

See Also:

AudioStream.nextSampleChunk()

reset

public void reset()

Reset the audio stream.

Specified by:

reset in class AudioStream

See Also:

AudioStream.reset()

getLength

public long getLength()

For live streams, returns the length of the buffered audio, otherwise returns the length of the original stream.

Specified by:

getLength in class AudioStream

Returns:

The length in milliseconds, or -1

See Also:

AudioStream.getLength()