org.openimaj.audio.filters

Class VolumeAdjustProcessor

java.lang.Object

org.openimaj.audio.Audio

org.openimaj.audio.AudioStream

org.openimaj.audio.processor.AudioProcessor

org.openimaj.audio.filters.VolumeAdjustProcessor

All Implemented Interfaces:

Iterable<SampleChunk>

public class VolumeAdjustProcessor
extends AudioProcessor

A processor that processes the audio file by adjusting the volume by a given factor.

Author:

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

Created:

8 Jun 2011

Field Summary

Fields inherited from class org.openimaj.audio.Audio

format

Constructor Summary

Constructors

Constructor and Description
VolumeAdjustProcessor(double factor) Default constructor that takes the volume adjustment factor as a double.
VolumeAdjustProcessor(double factor, AudioStream a) Constructor that takes the volume adjustment factor to apply to the given 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

VolumeAdjustProcessor

public VolumeAdjustProcessor(double factor)

Default constructor that takes the volume adjustment factor as a double.

Parameters:

factor -

VolumeAdjustProcessor

public VolumeAdjustProcessor(double factor,
                             AudioStream a)

Constructor that takes the volume adjustment factor to apply to the given stream. This allows this processor to be chainable.

Parameters:

factor - the factor to apply

a - The audio stream to apply the factor to

Method Detail

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

See Also:

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