AudioEffect.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    AudioEffect.h: Unreal base audio.
=============================================================================*/
 
#pragma once
 
//#include "AudioDevice.h"
#include "CoreMinimal.h"
#include "Sound/AudioVolume.h"
#include "Sound/ReverbSettings.h"
#include "Sound/SoundMix.h"
#include "UObject/Object.h"
#include "UObject/ObjectMacros.h"
 
#include "AudioEffect.generated.h"
 
class FAudioDevice;
class FSoundSource;
class UReverbEffect;
 
 
USTRUCT()
struct FAudioReverbEffect : public FAudioEffectParameters
{
    GENERATED_BODY()
 
public:
    ENGINE_API FAudioReverbEffect();
 
    ENGINE_API FAudioReverbEffect
    (
        float InRoom,
        float InRoomHF,
        float InRoomRolloffFactor,
        float InDecayTime,
        float InDecayHFRatio,
        float InReflections,
        float InReflectionsDelay,
        float InReverb,
        float InReverbDelay,
        float InDiffusion,
        float InDensity,
        float InAirAbsorption,
        bool bInBypassEarlyReflections,
        bool bInBypassLateReflections
    );
 
    ENGINE_API FAudioReverbEffect& operator=(class UReverbEffect* InReverbEffect);
 
    ENGINE_API bool Interpolate(const FAudioEffectParameters& InStart, const FAudioEffectParameters& InEnd);
 
    ENGINE_API void PrintSettings() const override;
 
    double      Time;
 
    float       Volume;                 // 0.0 to 1.0
 
 
    float       Density;                // 0.0 < 1.0 < 1.0
    float       Diffusion;              // 0.0 < 1.0 < 1.0
    float       Gain;                   // 0.0 < 0.32 < 1.0 
    float       GainHF;                 // 0.0 < 0.89 < 1.0
    float       DecayTime;              // 0.1 < 1.49 < 20.0    Seconds
    float       DecayHFRatio;           // 0.1 < 0.83 < 2.0
    float       ReflectionsGain;        // 0.0 < 0.05 < 3.16
    float       ReflectionsDelay;       // 0.0 < 0.007 < 0.3    Seconds
    float       LateGain;               // 0.0 < 1.26 < 10.0
    float       LateDelay;              // 0.0 < 0.011 < 0.1    Seconds
    float       AirAbsorptionGainHF;    // 0.892 < 0.994 < 1.0
    float       RoomRolloffFactor;      // 0.0 < 0.0 < 10.0
 
    bool bBypassEarlyReflections;
    bool bBypassLateReflections;
};
 
class FAudioRadioEffect : public FAudioEffectParameters
{
public:
    FAudioRadioEffect(void)
    {
    }
};
 
class FAudioEffectsManager
{
public:
    ENGINE_API FAudioEffectsManager( FAudioDevice* Device );
 
    virtual ~FAudioEffectsManager( void ) 
    {
    }
 
    void AddReferencedObjects( FReferenceCollector& Collector );
 
    void Update( void );
 
    void SetReverbSettings(const FReverbSettings& ReverbSettings, bool bForce = false);
 
    void SetMixSettings(USoundMix* Mix, bool bIgnorePriority = false, bool bForce = false);
 
    void ClearMixSettings();
 
    virtual void SetReverbEffectParameters(const FAudioEffectParameters& InEffectParameters)
    {
    }
 
    virtual void SetEQEffectParameters(const FAudioEffectParameters& InEffectParameters)
    {
    }
 
    virtual void SetRadioEffectParameters(const FAudioEffectParameters& InEffectParameters)
    {
    }
 
    virtual void* InitEffect( FSoundSource* Source )
    {
        return( NULL ); 
    }
 
    virtual void* UpdateEffect( class FSoundSource* Source ) 
    { 
        return( NULL ); 
    }
 
    void DestroyEffect( FSoundSource* Source )
    {
    }
 
    ENGINE_API int64 VolumeToDeciBels( float Volume );
 
    ENGINE_API int64 VolumeToMilliBels( float Volume, int32 MaxMilliBels );
 
    void ResetInterpolation( void );
 
    USoundMix* GetCurrentEQMix() const
    {
        return CurrentEQMix;
    }
 
    UReverbEffect* GetCurrentReverbEffect() const
    {
        return CurrentReverbAsset;
    }
 
protected:
 
    void InitAudioEffects( void );
 
    FAudioDevice*           AudioDevice;
    bool                    bEffectsInitialised;
 
    TObjectPtr<UReverbEffect>           CurrentReverbAsset;
 
    FAudioReverbEffect  SourceReverbEffect;
    FAudioReverbEffect  CurrentReverbEffect;
    FAudioReverbEffect  PrevReverbEffect;
    FAudioReverbEffect  DestinationReverbEffect;
 
    FReverbSettings         CurrentReverbSettings;
 
    USoundMix*              CurrentEQMix;
 
    FAudioEQEffect          SourceEQEffect;
    FAudioEQEffect          CurrentEQEffect;
    FAudioEQEffect          DestinationEQEffect;
 
    bool bReverbActive;
    bool bEQActive;
    bool bReverbChanged;
    bool bEQChanged;
};
 
// end