Navigation
API > API/Runtime > API/Runtime/SignalProcessing
Dynamic range compressor https://en.wikipedia.org/wiki/Dynamic_range_compression
| Name | FDynamicsProcessor |
| Type | class |
| Header File | /Engine/Source/Runtime/SignalProcessing/Public/DSP/DynamicsProcessor.h |
| Include Path | #include "DSP/DynamicsProcessor.h" |
Syntax
class FDynamicsProcessor
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDynamicsProcessor() |
DSP/DynamicsProcessor.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FDynamicsProcessor() |
DSP/DynamicsProcessor.h |
Structs
| Name | Remarks |
|---|---|
| FKneePoint | Points in the knee used for lagrangian interpolation. |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| MaxLookaheadMsec | float | DSP/DynamicsProcessor.h | |
| UpwardsCompressionMaxGain | float | DSP/DynamicsProcessor.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Denominator0Minus1 | float | For optimized LagrangianInterpolation on blocks... | DSP/DynamicsProcessor.h | |
| Denominator1Minus0 | float | For optimized LagrangianInterpolation on blocks... | DSP/DynamicsProcessor.h | |
| KneePoints | TArray< FKneePoint > | DSP/DynamicsProcessor.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 GetKeyNumChannels() |
DSP/DynamicsProcessor.h | ||
float GetMaxLookaheadMsec() |
DSP/DynamicsProcessor.h | ||
int32 GetNumChannels() |
DSP/DynamicsProcessor.h | ||
void Init
(
const float InSampleRate, |
DSP/DynamicsProcessor.h | ||
void ProcessAudio
(
const float*const*const InBuffers, |
For single channels of audio OR non-interleaved blocks of multichannel audio. | DSP/DynamicsProcessor.h | |
void ProcessAudio
(
const float* InBuffer, |
DSP/DynamicsProcessor.h | ||
void ProcessAudioFrame
(
const float* InFrame, |
DSP/DynamicsProcessor.h | ||
void ProcessAudioFrame
(
const float* InFrame, |
DSP/DynamicsProcessor.h | ||
void SetAnalogMode
(
const bool bInIsAnalogMode |
DSP/DynamicsProcessor.h | ||
void SetAttackTime
(
const float InAttackTimeMsec |
DSP/DynamicsProcessor.h | ||
void SetChannelLinkMode
(
const EDynamicsProcessorChannelLinkMode InLinkMode |
DSP/DynamicsProcessor.h | ||
void SetInputGain
(
const float InInputGainDb |
DSP/DynamicsProcessor.h | ||
void SetKeyAudition
(
const bool InAuditionEnabled |
DSP/DynamicsProcessor.h | ||
void SetKeyGain
(
const float InKeyGain |
DSP/DynamicsProcessor.h | ||
void SetKeyHighshelfCutoffFrequency
(
const float InCutoffFreq |
DSP/DynamicsProcessor.h | ||
void SetKeyHighshelfEnabled
(
const bool bInEnabled |
DSP/DynamicsProcessor.h | ||
void SetKeyHighshelfGain
(
const float InGainDb |
DSP/DynamicsProcessor.h | ||
void SetKeyLowshelfCutoffFrequency
(
const float InCutoffFreq |
DSP/DynamicsProcessor.h | ||
void SetKeyLowshelfEnabled
(
const bool bInEnabled |
DSP/DynamicsProcessor.h | ||
void SetKeyLowshelfGain
(
const float InGainDb |
DSP/DynamicsProcessor.h | ||
void SetKeyNumChannels
(
const int32 InNumChannels |
DSP/DynamicsProcessor.h | ||
void SetKneeBandwidth
(
const float InKneeBandwidthDb |
DSP/DynamicsProcessor.h | ||
void SetLookaheadMsec
(
const float InLookAheadMsec |
DSP/DynamicsProcessor.h | ||
void SetNumChannels
(
const int32 InNumChannels |
DSP/DynamicsProcessor.h | ||
void SetOutputGain
(
const float InOutputGainDb |
DSP/DynamicsProcessor.h | ||
void SetPeakMode
(
const EPeakMode::Type InEnvelopeFollowerModeType |
DSP/DynamicsProcessor.h | ||
void SetProcessingMode
(
const EDynamicsProcessingMode::Type ProcessingMode |
DSP/DynamicsProcessor.h | ||
void SetRatio
(
const float InCompressionRatio |
DSP/DynamicsProcessor.h | ||
void SetReleaseTime
(
const float InReleaseTimeMsec |
DSP/DynamicsProcessor.h | ||
void SetThreshold
(
const float InThresholdDb |
DSP/DynamicsProcessor.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
float ComputeGain
(
const float InEnvFollowerDb |
DSP/DynamicsProcessor.h | ||
void ComputeGains
(
float* InEnvFollowerDbOutGain, |
DSP/DynamicsProcessor.h | ||
bool IsInProcessingThreshold
(
const float InEnvFollowerDb |
DSP/DynamicsProcessor.h | ||
bool ProcessKeyFrame
(
const float* InKeyFrame, |
Process key frame, returning true if should continue processing (Returns false in audition mode and writes straight to output). | DSP/DynamicsProcessor.h |