org.openimaj.audio.conversion

Class BitDepthConverter

java.lang.Object

org.openimaj.audio.Audio

org.openimaj.audio.AudioStream

org.openimaj.audio.processor.AudioProcessor

org.openimaj.audio.conversion.BitDepthConverter

All Implemented Interfaces:

Iterable<SampleChunk>

public class BitDepthConverter
extends AudioProcessor

An audio processor that converts the bit-depth of an audio stream. The algorithm used to provide the conversion is enumerated within the BitDepthConverter.BitDepthConversionAlgorithm enum, a public inner class within this class. The class supports chainable and direct processing, like all audio processors should.

To use the class on an audio stream, use something like the following:

                BitDepthConverter bdc = new BitDepthConverter(
                        audioStream,
                        BitDepthConversionAlgorithm.NEAREST,
                        new AudioFormat( 8, 44.1, 1 ) );
        

The constructors take an output format which must match the audio format of the incoming stream in all respects other than the bit-depth. If the input and output formats differ, an IllegalArgumentException will be thrown. If the input and output formats are identical in every respect, the processor does nothing.

For the NEAREST algorithm, the conversion of the bit-depth is mainly provided through the SampleBuffer class.

Author:

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

Created:

18 Jun 2012

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BitDepthConverter.BitDepthConversionAlgorithm An enumerator of the different bit-depth conversion algorithms available.

Field Summary

Fields inherited from class org.openimaj.audio.Audio

format

Constructor Summary

Constructors

Constructor and Description
BitDepthConverter(AudioStream as, BitDepthConverter.BitDepthConversionAlgorithm converter, AudioFormat outputFormat) Chainable constructor.
BitDepthConverter(BitDepthConverter.BitDepthConversionAlgorithm converter, AudioFormat outputFormat) Default constructor that takes the input conversion

Method Summary

Modifier and Type	Method and Description
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

BitDepthConverter

public BitDepthConverter(BitDepthConverter.BitDepthConversionAlgorithm converter,
                         AudioFormat outputFormat)

Default constructor that takes the input conversion

Parameters:

converter - The converter to use

outputFormat - The output format to convert to

BitDepthConverter

public BitDepthConverter(AudioStream as,
                         BitDepthConverter.BitDepthConversionAlgorithm converter,
                         AudioFormat outputFormat)

Chainable constructor.

Parameters:

as - The audio stream to process

converter - The converter to use

outputFormat - The output format to convert to

Method Detail

process

public SampleChunk process(SampleChunk sample)
                    throws Exception

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

See Also:

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