FDynamicsProcessor

Dynamic range compressor [https://en.wikipedia.org/wiki/Dynamic_range_compression](https://en.wikipedia.org/wiki/Dynamic_range_compression)

Windows
MacOS
Linux

References

Module

SignalProcessing

Header

/Engine/Source/Runtime/SignalProcessing/Public/DSP/DynamicsProcessor.h

Include

#include "DSP/DynamicsProcessor.h"

Syntax

class FDynamicsProcessor

Remarks

Variables

Name Description

Protected variable

float

 

AttackTimeMsec

The period of which the compressor decreases gain to the level determined by the compression ratio.

Protected variable

bool

 

bIsAnalogMode

Whether or not we're in analog mode.

Protected variable

bool

 

bKeyAuditionEnabled

Whether or not to bypass processor and only output key modulator.

Protected variable

bool

 

bKeyHighshelfEnabled

Whether or not key high-pass filter is enabled.

Protected variable

bool

 

bKeyLowshelfEnabled

Whether or not key low-pass filter is enabled.

Protected variable

TArray< float >

 

DetectorOuts

Channel values of cached detector sample.

Protected variable

TArray< FEnvelo...

 

EnvFollower

Envelope followers.

Protected variable

TArray< float >

 

Gain

Channel values of cached gain sample.

Protected variable

float

 

HalfKneeBandwidthDb

Defines how hard or soft the gain reduction blends from no gain reduction to gain reduction (determined by the ratio)

Protected variable

float

 

InputGain

Amount of input gain.

Protected variable

FBiquadFilter

 

InputHighshelfFilter

(Optional) High-pass filter for input signal

Protected variable

FBiquadFilter

 

InputLowshelfFilter

(Optional) Low-pass filter for input signal

Protected variable

float

 

KeyGain

Gain of key detector signal in dB.

Protected variable

TArray< FVector...

 

KneePoints

Points in the knee used for lagrangian interpolation.

Protected variable

EDynamicsProces...

 

LinkMode

Whether or not input channels are linked, and if so, how to calculate gain.

Protected variable

TArray< FDelay ...

 

LookaheadDelay

Lookahead delay lines.

Protected variable

float

 

LookaheedDelayMsec

How far ahead to look in the audio.

Protected variable

int32

 

NumChannels

Number of channels to use for the dynamics processor.

Protected variable

float

 

OutputGain

Amount of output gain.

Protected variable

EDynamicsProces...

 

ProcessingMode

Protected variable

float

 

Ratio

Amount of gain reduction.

Protected variable

float

 

ReleaseTimeMsec

The period of which the compressor increases gain to 0 dB once level has fallen below the threshold.

Protected variable

float

 

ThresholdDb

Amplitude threshold above which gain will be reduced.

Constructors

Name Description

Public function

FDynamicsProcessor()

Destructors

Name Description

Public function

~FDynamicsProcessor()

Functions

Name Description

Protected function

float

 

ComputeGain

(
    const float InEnvFollowerDb
)

Public function

void

 

Init

(
    const float SampleRate,
    const int32 NumChannels
)

Public function

void

 

ProcessAudio

(
    const float* InBuffer,
    const int32 InNumSamples,
    float* OutBuffer,
    const float* InKeyBuffer
)

Public function

void

 

ProcessAudioFrame

(
    const float* InFrame,
    float* OutFrame,
    const float* InKeyFrame
)

Public function

void

 

SetAnalogMode

(
    const bool bInIsAnalogMode
)

Public function

void

 

SetAttackTime

(
    const float InAttackTimeMsec
)

Public function

void

 

SetChannelLinkMode

(
    const EDynamicsProcessorChannelLink...
)

Public function

void

 

SetInputGain

(
    const float InInputGainDb
)

Public function

void

 

SetKeyAudition

(
    const bool InAuditionEnabled
)

Public function

void

 

SetKeyGain

(
    const float InKeyGain
)

Public function

void

 

SetKeyHighshelfCutoffFrequency

(
    const float InCutoffFreq
)

Public function

void

 

SetKeyHighshelfEnabled

(
    const bool bInEnabled
)

Public function

void

 

SetKeyHighshelfGain

(
    const float InGainDb
)

Public function

void

 

SetKeyLowshelfCutoffFrequency

(
    const float InCutoffFreq
)

Public function

void

 

SetKeyLowshelfEnabled

(
    const bool bInEnabled
)

Public function

void

 

SetKeyLowshelfGain

(
    const float InGainDb
)

Public function

void

 

SetKneeBandwidth

(
    const float InKneeBandwidthDb
)

Public function

void

 

SetLookaheadMsec

(
    const float InLookAheadMsec
)

Public function

void

 

SetOutputGain

(
    const float InOutputGainDb
)

Public function

void

 

SetPeakMode

(
    const EPeakMode::Type InEnvelopeFol...
)

Public function

void

 

SetProcessingMode

(
    const EDynamicsProcessingMode::Type...
)

Public function

void

 

SetRatio

(
    const float InCompressionRatio
)

Public function

void

 

SetReleaseTime

(
    const float InReleaseTimeMsec
)

Public function

void

 

SetThreshold

(
    const float InThresholdDb
)
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss