org.jouvieje.fmodex.enumerations
Class FMOD_DSP_NORMALIZE

java.lang.Object
  org.jouvieje.fmodex.enumerations.FMOD_DSP_NORMALIZE

All Implemented Interfaces:

java.lang.Comparable, org.jouvieje.fmodex.enumerations.Enumeration

public class FMOD_DSP_NORMALIZE

extends java.lang.Object

implements org.jouvieje.fmodex.enumerations.Enumeration, java.lang.Comparable

Parameter types for the FMOD_DSP_TYPE_NORMALIZE filter.

Remarks

Normalize amplifies the sound based on the maximum peaks within the signal.
For example if the maximum peaks in the signal were 50% of the bandwidth, it would scale the whole sound by 2.
The lower threshold value makes the normalizer ignores peaks below a certain point, to avoid over-amplification if a loud signal suddenly came in, and also to avoid amplifying to maximum things like background hiss.
Because FMOD is a realtime audio processor, it doesn't have the luxury of knowing the peak for the whole sound (ie it can't see into the future), so it has to process data as it comes in.
To avoid very sudden changes in volume level based on small samples of new data, fmod fades towards the desired amplification which makes for smooth gain control. The fadetime parameter can control this.

Platforms Supported

Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation 2, PlayStation Portable, PlayStation 3, Wii, Solaris, iPhone

See Also

DSP::setParameter
DSP::getParameter
FMOD_DSP_TYPE

Field Summary

static FMOD_DSP_NORMALIZE	FMOD_DSP_NORMALIZE_FADETIME
static FMOD_DSP_NORMALIZE	FMOD_DSP_NORMALIZE_MAXAMP
static FMOD_DSP_NORMALIZE	FMOD_DSP_NORMALIZE_THRESHHOLD

Method Summary

int	asInt()
int	compareTo(java.lang.Object object)
boolean	equals(java.lang.Object object)
static FMOD_DSP_NORMALIZE	get(int nativeValue) Retrieve a FMOD_DSP_NORMALIZE enum field with his integer value
static FMOD_DSP_NORMALIZE	get(Pointer pointer) Retrieve a FMOD_DSP_NORMALIZE enum field from a Pointer
static java.util.Iterator	iterator()
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

FMOD_DSP_NORMALIZE_FADETIME

public static final FMOD_DSP_NORMALIZE FMOD_DSP_NORMALIZE_FADETIME

FMOD_DSP_NORMALIZE_THRESHHOLD

public static final FMOD_DSP_NORMALIZE FMOD_DSP_NORMALIZE_THRESHHOLD

FMOD_DSP_NORMALIZE_MAXAMP

public static final FMOD_DSP_NORMALIZE FMOD_DSP_NORMALIZE_MAXAMP

Method Detail

asInt

public int asInt()

Specified by:

asInt in interface org.jouvieje.fmodex.enumerations.Enumeration

Returns:

the integer value of the enumeration constant.

toString

public java.lang.String toString()

equals

public boolean equals(java.lang.Object object)

compareTo

public int compareTo(java.lang.Object object)

Specified by:

compareTo in interface java.lang.Comparable

get

public static FMOD_DSP_NORMALIZE get(int nativeValue)

Retrieve a FMOD_DSP_NORMALIZE enum field with his integer value

Parameters:

nativeValue - the integer value of the field to retrieve

Returns:

the FMOD_DSP_NORMALIZE enum field that correspond to the integer value

get

public static FMOD_DSP_NORMALIZE get(Pointer pointer)

Retrieve a FMOD_DSP_NORMALIZE enum field from a Pointer

Parameters:

pointer - a pointer holding an FMOD_DSP_NORMALIZE enum field

Returns:

the FMOD_DSP_NORMALIZE enum field that correspond to the enum field in the pointer

iterator

public static java.util.Iterator iterator()

Returns:

an Iterator over the elements in this enumeration.
Can be cast to Iterator in Java 1.5.