UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Namespaces | Macros | Functions | Variables
FloatArrayMath.cpp File Reference
#include "DSP/FloatArrayMath.h"
#include "CoreMinimal.h"
#include "SignalProcessingModule.h"
#include "ProfilingDebugging/CsvProfiler.h"
#include "DSP/Dsp.h"

Namespaces

namespace  Audio
 NO_LOGGING.
 
namespace  Audio::MathIntrinsics
 

Macros

#define AUDIO_FLOAT_ARRAY_MATH_ISPC_ENABLED_DEFAULT   1
 

Functions

 CSV_DEFINE_CATEGORY (Audio_Dsp, false)
 
void Audio::ArraySum (TArrayView< const float > InValues, float &OutSum)
 
void Audio::ArraySum (TArrayView< const float > InFloatBuffer1, TArrayView< const float > InFloatBuffer2, TArrayView< float > OutputBuffer)
 
void Audio::ArrayCumulativeSum (TArrayView< const float > InView, TArray< float > &OutData)
 
void Audio::ArrayMean (TArrayView< const float > InView, float &OutMean)
 
void Audio::ArrayMeanSquared (TArrayView< const float > InView, float &OutMean)
 
float Audio::ArrayGetMagnitude (TArrayView< const float > Buffer)
 
float Audio::ArrayGetAverageValue (TArrayView< const float > Buffer)
 
float Audio::ArrayGetAverageAbsValue (TArrayView< const float > Buffer)
 
void Audio::ArrayMeanFilter (TArrayView< const float > InView, int32 WindowSize, int32 WindowOrigin, TArray< float > &OutData)
 
void Audio::ArrayMaxFilter (TArrayView< const float > InView, int32 WindowSize, int32 WindowOrigin, TArray< float > &OutData)
 
void Audio::ArrayGetEuclideanNorm (TArrayView< const float > InView, float &OutEuclideanNorm)
 
void Audio::ArrayAbs (TArrayView< const float > InBuffer, TArrayView< float > OutBuffer)
 
void Audio::ArrayAbsInPlace (TArrayView< float > InView)
 
void Audio::ArrayClampMinInPlace (TArrayView< float > InView, float InMin)
 
void Audio::ArrayClampMaxInPlace (TArrayView< float > InView, float InMax)
 
void Audio::ArrayClampInPlace (TArrayView< float > InView, float InMin, float InMax)
 
void Audio::ArrayMinMaxNormalize (TArrayView< const float > InView, TArray< float > &OutArray)
 
void Audio::ArrayMax (const TArrayView< const float > &InView1, const TArrayView< const float > &InView2, const TArrayView< float > &OutView)
 
float Audio::ArrayMaxAbsValue (const TArrayView< const float > InView)
 
void Audio::ArrayMultiply (TArrayView< const float > InFloatBufferA, TArrayView< const float > InFloatBufferB, TArrayView< float > OutBuffer)
 
void Audio::ArrayMultiplyInPlace (TArrayView< const float > InFloatBuffer, TArrayView< float > BufferToMultiply)
 
void Audio::ArrayComplexMultiplyInPlace (TArrayView< const float > InValues1, TArrayView< float > InValues2)
 
void Audio::ArrayComplexMultiplyAdd (TArrayView< const float > InValues1, TArrayView< const float > InValues2, TArrayView< float > OutArray)
 
void Audio::ArrayMultiplyByConstant (TArrayView< const float > InFloatBuffer, float InValue, TArrayView< float > OutFloatBuffer)
 
void Audio::ArrayMultiplyByConstantInPlace (TArrayView< float > InOutBuffer, float InGain)
 
void Audio::ArrayAddInPlace (TArrayView< const float > InValues, TArrayView< float > InAccumulateValues)
 
void Audio::ArrayAddConstantInplace (TArrayView< float > InOutBuffer, float InConstant)
 
void Audio::ArrayMultiplyAddInPlace (TArrayView< const float > InValues, float InMultiplier, TArrayView< float > InAccumulateValues)
 
void Audio::ArrayLerpAddInPlace (TArrayView< const float > InValues, float InStartMultiplier, float InEndMultiplier, TArrayView< float > InAccumulateValues)
 
void Audio::ArraySubtract (TArrayView< const float > InMinuend, TArrayView< const float > InSubtrahend, TArrayView< float > OutBuffer)
 
void Audio::ArraySubtractInPlace1 (TArrayView< const float > InMinuend, TArrayView< float > InOutSubtrahend)
 
void Audio::ArraySubtractInPlace2 (TArrayView< float > InOutMinuend, TArrayView< const float > InSubtrahend)
 
void Audio::ArraySubtractByConstantInPlace (TArrayView< float > InValues, float InSubtrahend)
 
void Audio::ArraySquare (TArrayView< const float > InValues, TArrayView< float > OutValues)
 
void Audio::ArraySquareInPlace (TArrayView< float > InValues)
 
void Audio::ArraySqrtInPlace (TArrayView< float > InValues)
 
void Audio::ArrayComplexConjugate (TArrayView< const float > InValues, TArrayView< float > OutValues)
 
void Audio::ArrayComplexConjugateInPlace (TArrayView< float > InValues)
 
void Audio::ArrayMagnitudeToDecibelInPlace (TArrayView< float > InValues, float InMinimumDb)
 
void Audio::ArrayPowerToDecibelInPlace (TArrayView< float > InValues, float InMinimumDb)
 
void Audio::ArrayComplexToPower (TArrayView< const float > InComplexValues, TArrayView< float > OutPowerValues)
 
void Audio::ArrayComplexToPower (TArrayView< const float > InRealSamples, TArrayView< const float > InImaginarySamples, TArrayView< float > OutPowerSamples)
 
void Audio::ArrayUnderflowClamp (TArrayView< float > InOutValues)
 
void Audio::ArrayRangeClamp (TArrayView< float > InOutBuffer, float InMinValue, float InMaxValue)
 
void Audio::ArraySetToConstantInplace (TArrayView< float > InOutBuffer, float InConstant)
 
void Audio::ArrayWeightedSum (TArrayView< const float > InBuffer1, float InGain1, TArrayView< const float > InBuffer2, float InGain2, TArrayView< float > OutBuffer)
 
void Audio::ArrayWeightedSum (TArrayView< const float > InBuffer1, float InGain1, TArrayView< const float > InBuffer2, TArrayView< float > OutBuffer)
 
void Audio::ArrayFade (TArrayView< float > InOutBuffer, const float StartValue, const float EndValue)
 
void Audio::ArrayFade (TArrayView< const float > InBuffer, const float InStartValue, const float InEndValue, TArrayView< float > OutBuffer)
 
void Audio::ArrayMixIn (TArrayView< const float > InFloatBuffer, TArrayView< float > BufferToSumTo, const float Gain)
 
void Audio::ArrayMixIn (TArrayView< const float > InFloatBuffer, TArrayView< float > BufferToSumTo)
 
void Audio::ArrayMixIn (TArrayView< const float > InFloatBuffer, TArrayView< float > BufferToSumTo, const float StartGain, const float EndGain)
 
void Audio::ArrayMixIn (TArrayView< const int16 > InPcm16Buffer, TArrayView< float > BufferToSumTo, const float Gain)
 
void Audio::ArrayFloatToPcm16 (TArrayView< const float > InView, TArrayView< int16 > OutView)
 
void Audio::ArrayPcm16ToFloat (TArrayView< const int16 > InView, TArrayView< float > OutView)
 
constexpr int Audio::CreateByteMask (uint32 A, uint32 B, uint32 C, uint32 D)
 
void Audio::ArrayFloatToPcm24 (TArrayView< const float > InView, TArrayView< int8 > OutView)
 
void Audio::ArrayFloatToPcm32 (TArrayView< const float > InView, TArrayView< int32 > OutView)
 
void Audio::ArrayFloatToPcmDouble (TArrayView< const float > InView, TArrayView< double > OutView)
 
void Audio::ArrayInterleave (const TArray< FAlignedFloatBuffer > &InBuffers, FAlignedFloatBuffer &OutBuffer)
 
void Audio::ArrayInterleave (const float *const *RESTRICT InBuffers, float *RESTRICT OutBuffer, const int32 InFrames, const int32 InChannels)
 
void Audio::ArrayDeinterleave (const FAlignedFloatBuffer &InBuffer, TArray< FAlignedFloatBuffer > &OutBuffers, const int32 InChannels)
 
void Audio::ArrayDeinterleave (const TArrayView< const float > InView, TArray< FAlignedFloatBuffer > &OutBuffers, const int32 InChannels)
 
void Audio::ArrayDeinterleave (const float *RESTRICT InBuffer, float *const *RESTRICT OutBuffers, const int32 InFrames, const int32 InChannels)
 
void Audio::ArrayInterpolate (const float *InBuffer, float *OutBuffer, const int32 NumInSamples, const int32 NumOutSamples)
 
void Audio::ArrayInt16SwapBytes (TArrayView< int16 > InView)
 
void Audio::ArrayInt24SwapBytes (TArrayView< int8 > InView)
 
void Audio::ArrayInt32SwapBytes (TArrayView< int32 > InView)
 
void Audio::ArrayFloatSwapBytes (TArrayView< float > InView)
 
void Audio::ArrayDoubleSwapBytes (TArrayView< double > InView)
 
void Audio::ArrayAPFLongDelayProcess (const float *InSamples, const float *InDelaySamples, const int32 InNum, float *OutSamples, float *OutDelaySamples, const float Gain)
 
void Audio::ArrayLerpFractionalDelay (const float *InSamples, const float *InDelays, const float *DelayData, const int *IntegerDelays, int *UpperDelayPos, int *LowerDelayPos, const int32 InNum, float *OutSamples, const float MaxDelay)
 
void Audio::ArrayScaledComplexConjugate (const float *RESTRICT InValues, const int32 Num, float *RESTRICT OutValues, const float Scale)
 

Variables

const float Audio::MathIntrinsics::Loge10 = FMath::Loge(10.f)
 
const int32 Audio::MathIntrinsics::SimdMask = 0xFFFFFFFC
 
const int32 Audio::MathIntrinsics::NotSimdMask = 0x00000003
 
const int32 Audio::MathIntrinsics::Simd8Mask = 0xFFFFFFF8
 
const int32 Audio::MathIntrinsics::NotSimd8Mask = 0x00000007
 
const int32 Audio::MathIntrinsics::Simd16Mask = 0xFFFFFFF0
 
const int32 Audio::MathIntrinsics::NotSimd16Mask = 0x0000000F
 

Macro Definition Documentation

◆ AUDIO_FLOAT_ARRAY_MATH_ISPC_ENABLED_DEFAULT

#define AUDIO_FLOAT_ARRAY_MATH_ISPC_ENABLED_DEFAULT   1

Function Documentation

◆ CSV_DEFINE_CATEGORY()

CSV_DEFINE_CATEGORY ( Audio_Dsp  ,
false   
)