Firelight Technologies FMOD Studio API

FMOD_DSP_COMPRESSOR

Parameter types for the FMOD_DSP_TYPE_COMPRESSOR unit. This is a multichannel software limiter that is uniform across the whole spectrum.

C/C++ Syntax

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_LINKED
} FMOD_DSP_COMPRESSOR;

JavaScript Syntax

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_LINKED

Values

FMOD_DSP_COMPRESSOR_THRESHOLD

(Type:float) - Threshold level (dB) in the range from -80 through 0. Default = 0.

FMOD_DSP_COMPRESSOR_RATIO

(Type:float) - Compression Ratio (dB/dB) in the range from 1 to 50. Default = 2.5.

FMOD_DSP_COMPRESSOR_ATTACK

(Type:float) - Attack time (milliseconds), in the range from 0.1 through 1000. Default value is 20.

FMOD_DSP_COMPRESSOR_RELEASE

(Type:float) - Release time (milliseconds), in the range from 10 through 5000. Default value is 100

FMOD_DSP_COMPRESSOR_GAINMAKEUP

(Type:float) - Make-up gain (dB) applied after limiting, in the range from 0 through 30. Default = 0.

FMOD_DSP_COMPRESSOR_USESIDECHAIN

(Type:data) - Data of type FMOD_DSP_PARAMETER_SIDECHAIN. Whether to analyse the sidechain signal instead of the input signal. Default is { false }

FMOD_DSP_COMPRESSOR_LINKED

(Type:bool) - FALSE = Independent (compressor per channel), TRUE = Linked. Default = TRUE.

Remarks

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.

See Also

• DSP::setParameterFloat
• DSP::getParameterFloat
• DSP::setParameterBool
• DSP::getParameterBool
• FMOD_DSP_TYPE

Version 1.10.03 Built on Feb 1, 2018