triana.types.audio

Class AudioEffect16Bit

java.lang.Object

triana.types.audio.AudioEffect16Bit

Direct Known Subclasses:

AllPassEffect, BandPassEffect, CombDelayEffect, HighPassEffect, LowPassEffect, NotchFilterEffect, PeakEQEffect, SingleDelayEffect, VariableDelayEffect

public abstract class AudioEffect16Bit
extends java.lang.Object

This abstract class is a modification of the AudioEffect.java file created by Dr Ian Taylor of Cardiff University. This class is a base class for creating audio effects that work on chunks of data.This class is intended to make it convenient for operating on a chunk by chunk basis, and provides a forward memory buffer that can be initialised and use with a time delay based algorithm.

When new data arrives it is inserted into an array with the previous and forward data memory prepended and appended to it. By default the previous locations are filled with the previous data (i.e. the current data will be copied into it for the next iteration) and the forward data locations can either be added to the next data processed or multiplied to them. The default mode is to add the values to the next data set that arrives.

The AudioEffect class was modified (with the authors permission) to remove a redundant 'backbuffer' array, and to work using shorts (for 16bit data) instead of doubles.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ADD An identifier for adding the forward memory locations to the next data received by an AudioEffect.
static int	DO_NOTHING An identifier for ignoring the forward memory locations when receiving future inputs.
static int	MULTIPLY An identifier for multiplying the forward memory locations to the next data received by an AudioEffect.

Constructor Summary

Constructors

Constructor and Description
AudioEffect16Bit(int forwardMemSize) Creates an audio effect with a particular forward memory size.

Method Summary

Methods

Modifier and Type	Method and Description
short[]	getData() Gets data array
int	getStart() Gets the starting position of the current memory chunk with the previous and forward memory prepended and appended to it
void	initialiseForward(short val)
void	initialiseForward(short[] vals) Initializes the forward values to the values specified.
void	preProcess(short[] data) This function inserts the given data into an array which comprises of the given data and the forward data respectively.
void	setForwardMathOperation(int mode) An function setting the behaviour of how AudioEffect applies the forward memory locations to the next data received by an AudioEffect.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ADD

public static final int ADD

An identifier for adding the forward memory locations to the next data received by an AudioEffect. Use setForwardMathOperation to set the forward math mode.

See Also:

setForwardMathOperation(int), Constant Field Values

MULTIPLY

public static final int MULTIPLY

An identifier for multiplying the forward memory locations to the next data received by an AudioEffect. Use setForwardMathOperation to set the forward math mode.

See Also:

setForwardMathOperation(int), Constant Field Values

DO_NOTHING

public static final int DO_NOTHING

An identifier for ignoring the forward memory locations when receiving future inputs. Use setForwardMathOperation to set the forward math mode.

See Also:

setForwardMathOperation(int), Constant Field Values

Constructor Detail

AudioEffect16Bit

public AudioEffect16Bit(int forwardMemSize)

Creates an audio effect with a particular forward memory size. Enter 0 for no memory.

Method Detail

initialiseForward

public void initialiseForward(short val)

initialiseForward

public void initialiseForward(short[] vals)
                       throws IncompatibleSizeException

Initializes the forward values to the values specified. The array given must be the same size as the size of the previous memory array otherwise the memory will not be initialized and an exception will be thrown

Throws:

IncompatibleSizeException

setForwardMathOperation

public void setForwardMathOperation(int mode)

An function setting the behaviour of how AudioEffect applies the forward memory locations to the next data received by an AudioEffect. The default mode is ADD i.e. add them to the next data chunk but other can be specified e.g. MULTIPLY and DO_NOTHING

getStart

public int getStart()

Gets the starting position of the current memory chunk with the previous and forward memory prepended and appended to it

getData

public short[] getData()

Gets data array

preProcess

public void preProcess(short[] data)

This function inserts the given data into an array which comprises of the given data and the forward data respectively. To get a reference to the data use getData() and to get the starting point of the current data use getStart().