org.openimaj.audio

Class AudioMixer

java.lang.Object

org.openimaj.audio.Audio

org.openimaj.audio.AudioStream

org.openimaj.audio.AudioMixer

All Implemented Interfaces:

Iterable<SampleChunk>

Direct Known Subclasses:

PolyphonicSynthesizer

public class AudioMixer
extends AudioStream

A basic audio mixer that takes a number of AudioStreams and mixes then with some gain compensation into a single audio stream.

Author:

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

Created:

23rd November 2011

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AudioMixer.MixEventListener A listener for objects that wish to be informed of a mix event.

Field Summary

Fields inherited from class org.openimaj.audio.Audio

format

Constructor Summary

Constructors

Constructor and Description
AudioMixer(AudioFormat af) Default constructor that takes the format for the samples.

Method Summary

Modifier and Type	Method and Description
void	addMixEventListener(AudioMixer.MixEventListener mel) Add a mix event listener to this AudioMixer.
void	addStream(AudioStream as, float defaultGain) Add an AudioStream to this mixer.
long	getLength() Returns the length of the audio stream in milliseconds.
SampleChunk	nextSampleChunk() Retrieve the next SampleChunk from the audio stream.
void	removeMixEventListener(AudioMixer.MixEventListener mel) Remove the given AudioMixer.MixEventListener from this mixer.
void	removeStream(AudioStream as) Remove the given audio stream from the mixer.
void	reset() Reset the audio stream.
void	setAlwaysRun(boolean alwaysRun) Whether to run the mixer when there are no audio streams to mix.
void	setBufferSize(int bufferSize) Set the size of the buffer that the mixer will mix.
void	setMixEvents(boolean tf) Whether to fire mix events or not (default is that the mixer doesn't)
void	setTimecodeObject(AudioTimecode tc) The timecode object

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

AudioMixer

public AudioMixer(AudioFormat af)

Default constructor that takes the format for the samples. All streams added to this mixer must conform to that sample format.

Parameters:

af - The AudioFormat

Method Detail

setTimecodeObject

public void setTimecodeObject(AudioTimecode tc)

The timecode object

Parameters:

tc - The timecode object.

addStream

public void addStream(AudioStream as,
                      float defaultGain)

Add an AudioStream to this mixer. It must conform to the same format as this mixer. If not, an IllegalArgumentException will be thrown.

Parameters:

as - The AudioStream to add to this mixer.

defaultGain - The default gain of this stream.

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()

setBufferSize

public void setBufferSize(int bufferSize)

Set the size of the buffer that the mixer will mix. Note that this must be done before any streams are added to the mixer.

Parameters:

bufferSize - The buffer size in samples per channel.

setAlwaysRun

public void setAlwaysRun(boolean alwaysRun)

Whether to run the mixer when there are no audio streams to mix.

Parameters:

alwaysRun - TRUE to make the mixer always run.

addMixEventListener

public void addMixEventListener(AudioMixer.MixEventListener mel)

Add a mix event listener to this AudioMixer.

Parameters:

mel - The AudioMixer.MixEventListener to add

removeMixEventListener

public void removeMixEventListener(AudioMixer.MixEventListener mel)

Remove the given AudioMixer.MixEventListener from this mixer.

Parameters:

mel - The AudioMixer.MixEventListener to remove

getLength

public long getLength()

Returns the length of the audio stream in milliseconds. If the length is unknown (for a live stream for example), then this method should return -1.

Specified by:

getLength in class AudioStream

Returns:

The length in milliseconds, or -1

See Also:

AudioStream.getLength()

setMixEvents

public void setMixEvents(boolean tf)

Whether to fire mix events or not (default is that the mixer doesn't)

Parameters:

tf - TRUE to fire mix events.

removeStream

public void removeStream(AudioStream as)

Remove the given audio stream from the mixer.

Parameters:

as - The audio stream to remove