Firelight Technologies FMOD Studio API
Parameter types for the FMOD_DSP_TYPE_COMPRESSOR unit.
This is a simple linked multichannel software limiter that is uniform across the whole spectrum.
typedef enum {
FMOD_DSP_COMPRESSOR_THRESHOLD,
FMOD_DSP_COMPRESSOR_RATIO,
FMOD_DSP_COMPRESSOR_ATTACK,
FMOD_DSP_COMPRESSOR_RELEASE,
FMOD_DSP_COMPRESSOR_GAINMAKEUP,
FMOD_DSP_COMPRESSOR_USESIDECHAIN
} FMOD_DSP_COMPRESSOR;
FMOD_DSP_COMPRESSOR_THRESHOLD
(Type:float) - Threshold level (dB) in the range from -80 through 0. The default value is 0.
FMOD_DSP_COMPRESSOR_RATIO
(Type:float) - Compression Ratio (dB/dB) in the range from 1 to 50. The default value is 2.5.
FMOD_DSP_COMPRESSOR_ATTACK
(Type:float) - Attack time (milliseconds), in the range from 0.1 through 1000. The default value is 20.
FMOD_DSP_COMPRESSOR_RELEASE
(Type:float) - Release time (milliseconds), in the range from 10 through 5000. The default value is 100
FMOD_DSP_COMPRESSOR_GAINMAKEUP
(Type:float) - Make-up gain (dB) applied after limiting, in the range from 0 through 30. The default value is 0.
FMOD_DSP_COMPRESSOR_USESIDECHAIN
(Type:bool) - Whether to analyse the sidechain signal instead of the input signal. The default value is false
The limiter is not guaranteed to catch every peak above the threshold level,
because it cannot apply gain reduction instantaneously - the time delay is
determined by the attack time. However setting the attack time too short will
distort the sound, so it is a compromise. High level peaks can be avoided by
using a short attack time - but not too short, and setting the threshold a few
decibels below the critical level.
Version 1.03.06 Built on Apr 17, 2014