org.openimaj.audio.conversion

Class MultichannelToMonoProcessor

java.lang.Object

org.openimaj.audio.Audio

org.openimaj.audio.AudioStream

org.openimaj.audio.processor.AudioProcessor

org.openimaj.audio.conversion.MultichannelToMonoProcessor

All Implemented Interfaces:

Iterable<SampleChunk>

public class MultichannelToMonoProcessor
extends AudioProcessor

Converts a stereo audio stream into a mono one by averaging the channels' samples and creating a mono sample set. The audio format of the stream is changed. The process() method creates new SampleChunks with a new format.

Author:

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

Created:

10 Jun 2011

Field Summary

Fields inherited from class org.openimaj.audio.Audio

format

Constructor Summary

Constructors

Constructor and Description
MultichannelToMonoProcessor() Create a processor to process chunks.
MultichannelToMonoProcessor(AudioStream a) Create a processor for the given audio stream.

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

MultichannelToMonoProcessor

public MultichannelToMonoProcessor()

Create a processor to process chunks.

MultichannelToMonoProcessor

public MultichannelToMonoProcessor(AudioStream a)

Create a processor for the given audio stream. The output of this audio stream will be a mono stream.

Parameters:

a - The audio stream to process.

Method Detail

process

public SampleChunk process(SampleChunk sample)

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.

See Also:

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