1. Epic GamesDeveloper
  3. FDynamicsProcessor

FDynamicsProcessor

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

API > API/Runtime > API/Runtime/SignalProcessing > API/Runtime/SignalProcessing/DSP

References

   
Module SignalProcessing
Header /Engine/Source/Runtime/SignalProcessing/Public/DSP/DynamicsProcessor.h
Include #include "DSP/DynamicsProcessor.h"

Syntax

class FDynamicsProcessor

Remarks

Dynamic range compressor https://en.wikipedia.org/wiki/Dynamic_range_compression

Variables

  Type 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 EPeakMode::Type EnvelopeFollowerPeakMode Peak mode of envelope followers.
Protected variable TArray< FInlineEnvelopeFollower > 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< FVector2D > KneePoints Points in the knee used for lagrangian interpolation.
Protected variable EDynamicsProcessorChannelLinkMode 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 float OutputGain Amount of output gain.
Protected variable EDynamicsProcessingMode::Type 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 SampleRate Sample rate of both key and input (must match)
Protected variable float ThresholdDb Amplitude threshold above which gain will be reduced.

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Protected function float

ComputeGain ( const float InEnvFollowerDb
)

  
Public function Const int32  
Public function Const float  
Public function Const int32  
Public function void

Init ( const float InSampleRate,
const int32 InNumChannels
)

  
Protected function Const bool

IsInProcessingThreshold ( const float InEnvFollowerDb
)

  
Public function void

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

  
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

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

  
Protected function bool

ProcessKeyFrame ( const float* InKeyFrame,
float* OutFrame,
bool bKeyIsInput
)

 Process key frame, returning true if should continue processing (Returns false in audition mode and writes straight to output).
Public function void

SetAnalogMode ( const bool bInIsAnalogMode
)

  
Public function void

SetAttackTime ( const float InAttackTimeMsec
)

  
Public function void  
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

SetKeyNumChannels ( const int32 InNumChannels
)

  
Public function void

SetKneeBandwidth ( const float InKneeBandwidthDb
)

  
Public function void

SetLookaheadMsec ( const float InLookAheadMsec
)

  
Public function void

SetNumChannels ( const int32 InNumChannels
)

  
Public function void

SetOutputGain ( const float InOutputGainDb
)

  
Public function void

SetPeakMode ( const EPeakMode::Type InEnvelopeFollowerModeType
)

  
Public function void  
Public function void

SetRatio ( const float InCompressionRatio
)

  
Public function void

SetReleaseTime ( const float InReleaseTimeMsec
)

  
Public function void

SetThreshold ( const float InThresholdDb
)

  

Constants

Name Description
MaxLookaheadMsec  
UpwardsCompressionMaxGain  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page