org.openimaj.audio.conversion

Class AudioConverter

java.lang.Object

org.openimaj.audio.Audio

org.openimaj.audio.AudioStream

org.openimaj.audio.processor.AudioProcessor

org.openimaj.audio.conversion.AudioConverter

All Implemented Interfaces:

Iterable<SampleChunk>

public class AudioConverter
extends AudioProcessor

A class that will work out which processors to instantiate to provide with a complete conversion from one audio format to another.

Author:

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

Created:

13 May 2013

Field Summary

Fields inherited from class org.openimaj.audio.Audio

format

Constructor Summary

Constructors

Constructor and Description
AudioConverter(AudioFormat input, AudioFormat output) Constructor that takes the input and output formats.
AudioConverter(AudioStream stream, AudioFormat output) Chainable constructor that takes the stream to chain and the output format to convert the stream to.

Method Summary

Modifier and Type	Method and Description
static AudioProcessor	calculateProcess(AudioFormat input, AudioFormat output) Calculates the chain of processors that will convert from one format to the other and will return the first in the chain.
AudioFormat	getOutputFormat() Same as Audio.getFormat() for this class - returns the output format.
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

AudioConverter

public AudioConverter(AudioStream stream,
                      AudioFormat output)

Chainable constructor that takes the stream to chain and the output format to convert the stream to.

Parameters:

stream - The stream to chain to

output - The required output format

AudioConverter

public AudioConverter(AudioFormat input,
                      AudioFormat output)

Constructor that takes the input and output formats.

Parameters:

input - The input format

output - The output format

Method Detail

calculateProcess

public static AudioProcessor calculateProcess(AudioFormat input,
                                              AudioFormat output)

Calculates the chain of processors that will convert from one format to the other and will return the first in the chain. If there is no processing to be done the method will return null.

Parameters:

input - The input format

output - The output format.

Returns:

The first processor in the stream.

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

getOutputFormat

public AudioFormat getOutputFormat()

Same as Audio.getFormat() for this class - returns the output format.

Returns:

The output format.