AudioSettings.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/PerPlatformProperties.h"
#include "UObject/SoftObjectPath.h"
#include "Engine/DeveloperSettings.h"
#include "AudioMixerTypes.h"
#include "AudioSettings.generated.h"
 
struct FPropertyChangedChainEvent;
 
class USoundClass;
class USoundConcurrency;
 
// Enumeration for what our options are for sample rates used for VOIP.
UENUM()
enum class EVoiceSampleRate : int32
{
    Low16000Hz = 16000,
    Normal24000Hz = 24000,
    /* High48000Hz = 48000 //TODO: 48k VOIP requires serious performance optimizations on encoding and decoding. */
};
 
// Enumeration defines what method of panning to use (for non-binaural audio) with the audio-mixer.
UENUM()
enum class EPanningMethod : int8
{
    // Linear panning maintains linear amplitude when panning between speakers.
    Linear,
 
    // Equal power panning maintains equal power when panning between speakers.
    EqualPower
};
 
// Enumeration defines how to treat mono 2D playback. Mono sounds need to upmixed to stereo when played back in 2D.
UENUM()
enum class EMonoChannelUpmixMethod : int8
{
    // The mono channel is split 0.5 left/right
    Linear,
 
    // The mono channel is split 0.707 left/right
    EqualPower,
 
    // The mono channel is split 1.0 left/right
    FullVolume
};
 
 
// The sound asset compression type to use for assets using the compression type "project defined".
UENUM()
enum class EDefaultAudioCompressionType : uint8
{
    // Perceptual-based codec which supports all features across all platforms.
    BinkAudio,
 
    // Will encode the asset using ADPCM, a time-domain codec that has fixed-sized quality and about ~4x compression ratio, but is relatively cheap to decode.
    ADPCM,
 
    // Uncompressed audio. Large memory usage (streamed chunks contain less audio per chunk) but extremely cheap to decode and supports all features. 
    PCM,
 
    // Opus is a highly versatile audio codec. It is primarily designed for interactive speech and music transmission over the Internet, but is also applicable to storage and streaming applications.
    Opus,
 
    // Encodes the asset to a platform specific format and will be different depending on the platform. It does not currently support seeking.
    PlatformSpecific,
 
    // As BinkAudio, except better quality. Comparable CPU usage on newer platforms, higher CPU on older platforms.
    RADAudio UMETA(DisplayName = "RAD Audio")
};
 
 
USTRUCT()
struct FAudioQualitySettings
{
    GENERATED_BODY()
 
    UPROPERTY(EditAnywhere, Category="Quality")
    FText DisplayName;
 
    // The number of audio channels that can be used at once
    // NOTE: Some platforms may cap this value to a lower setting regardless of what the settings request
    UPROPERTY(EditAnywhere, Category="Quality", meta=(ClampMin="1"))
    int32 MaxChannels;
 
    FAudioQualitySettings()
        : MaxChannels(32)
    {
    }
};
 
USTRUCT()
struct FSoundDebugEntry
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY(config, EditAnywhere, Category="Debug", meta=(DisplayName="Name"))
    FName DebugName;
 
    UPROPERTY(config, EditAnywhere, Category="Debug", meta=(AllowedClasses="/Script/Engine.SoundBase"))
    FSoftObjectPath Sound;
};
 
USTRUCT()
struct FDefaultAudioBusSettings
{
    GENERATED_BODY()
 
    
    UPROPERTY(EditAnywhere, Category = "Mix", meta = (AllowedClasses = "/Script/Engine.AudioBus"))
    FSoftObjectPath AudioBus;
};
 
UCLASS(config=Engine, defaultconfig, meta=(DisplayName="Audio"), MinimalAPI)
class UAudioSettings : public UDeveloperSettings
{
    GENERATED_UCLASS_BODY()
 
#if WITH_EDITOR
    ENGINE_API virtual void PreEditChange(FProperty* PropertyAboutToChange) override;
    ENGINE_API virtual void PostEditChangeChainProperty(FPropertyChangedChainEvent& PropertyChangedEvent) override;
 
    DECLARE_EVENT(UAudioSettings, FAudioSettingsChanged)
#endif // WITH_EDITOR
 
    UPROPERTY(config, EditAnywhere, Category="Audio", meta=(AllowedClasses="/Script/Engine.SoundClass", DisplayName="Default Sound Class"))
    FSoftObjectPath DefaultSoundClassName;
 
    UPROPERTY(config, EditAnywhere, Category = "Audio", meta = (AllowedClasses = "/Script/Engine.SoundClass", DisplayName = "Default Media Sound Class"))
    FSoftObjectPath DefaultMediaSoundClassName;
 
    UPROPERTY(config, EditAnywhere, Category = "Audio", meta = (AllowedClasses = "/Script/Engine.SoundConcurrency", DisplayName = "Default Sound Concurrency"))
    FSoftObjectPath DefaultSoundConcurrencyName;
 
    UPROPERTY(config, EditAnywhere, Category="Audio", meta=(AllowedClasses="/Script/Engine.SoundMix"))
    FSoftObjectPath DefaultBaseSoundMix;
 
    UPROPERTY(config, EditAnywhere, Category="Audio", meta=(AllowedClasses="/Script/Engine.SoundClass", DisplayName = "VOIP Sound Class"))
    FSoftObjectPath VoiPSoundClass;
 
    UPROPERTY(config, EditAnywhere, Category="Mix", meta=(AllowedClasses="/Script/Engine.SoundSubmix"))
    FSoftObjectPath MasterSubmix;
 
    UPROPERTY(config, EditAnywhere, Category = "Mix", meta = (AllowedClasses = "/Script/Engine.SoundSubmix"), AdvancedDisplay)
    FSoftObjectPath BaseDefaultSubmix;
 
    UPROPERTY(config, EditAnywhere, Category="Mix", meta=(AllowedClasses="/Script/Engine.SoundSubmix"))
    FSoftObjectPath ReverbSubmix;
 
    UPROPERTY(config, EditAnywhere, Category="Mix", meta=(AllowedClasses="/Script/Engine.SoundSubmix", DisplayName = "EQ Submix (Legacy)"), AdvancedDisplay)
    FSoftObjectPath EQSubmix;
 
    UPROPERTY(config, EditAnywhere, Category = "Audio", meta = (DisplayName = "VOIP Sample Rate"))
    EVoiceSampleRate VoiPSampleRate;
 
    UPROPERTY(config, EditAnywhere, Category = "Audio")
    EDefaultAudioCompressionType DefaultAudioCompressionType;
 
    UPROPERTY(config, EditAnywhere, Category = Occlusion)
    FPerPlatformFloat DefaultOcclusionCheckInterval = .1f;
 
    UPROPERTY(config)
    int32 DefaultCompressionQuality_DEPRECATED = 80;
 
    UPROPERTY(config)
    float DefaultReverbSendLevel_DEPRECATED;
 
    UPROPERTY(config, EditAnywhere, Category="Audio", meta=(ClampMin=0))
    int32 MaximumConcurrentStreams;
 
    UPROPERTY(config, EditAnywhere, Category = "Audio", meta = (ClampMin = 0.001, UIMin = 0.001, UIMax = 4.0))
    float GlobalMinPitchScale;
 
    UPROPERTY(config, EditAnywhere, Category = "Audio", meta = (ClampMin = 0.001, UIMin = 0.001, UIMax = 4.0))
    float GlobalMaxPitchScale;
 
    UPROPERTY(config, EditAnywhere, Category="Quality")
    TArray<FAudioQualitySettings> QualityLevels;
 
    UPROPERTY(config, EditAnywhere, Category = "Audio", AdvancedDisplay)
    uint32 bAllowPlayWhenSilent:1;
 
    UPROPERTY(config, EditAnywhere, Category = "Mix", AdvancedDisplay)
    uint32 bDisableMasterEQ : 1;
 
    UPROPERTY(config, EditAnywhere, Category = "Panning", AdvancedDisplay)
    uint32 bAllowCenterChannel3DPanning : 1;
 
    UPROPERTY(config, EditAnywhere, Category = "Audio", AdvancedDisplay)
    uint32 NumStoppingSources;
 
    UPROPERTY(config, EditAnywhere, Category = "Panning", AdvancedDisplay)
    EPanningMethod PanningMethod;
 
    UPROPERTY(config, EditAnywhere, Category = "Mix", AdvancedDisplay)
    EMonoChannelUpmixMethod MonoChannelUpmixMethod;
 
    UPROPERTY(config, EditAnywhere, Category="Dialogue")
    FString DialogueFilenameFormat;
 
    UPROPERTY(config, EditAnywhere, Category = "Debug")
    TArray<FSoundDebugEntry> DebugSounds;
 
    UPROPERTY(config, EditAnywhere, Category="Mix")
    TArray<FDefaultAudioBusSettings> DefaultAudioBuses;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(config, EditAnywhere, Category="Audio", AdvancedDisplay)
    bool bEnableLegacyAssetTypes = false;
#endif // WITH_EDITORONLY_DATA
 
#if WITH_EDITOR
    FAudioSettingsChanged AudioSettingsChanged;
#endif // WITH_EDITOR
 
private:
    UPROPERTY(Transient)
    TObjectPtr<USoundClass> DefaultSoundClass;
 
    UPROPERTY(Transient)
    TObjectPtr<USoundClass> DefaultMediaSoundClass;
 
    UPROPERTY(Transient)
    TObjectPtr<USoundConcurrency> DefaultSoundConcurrency;
 
public:
    // Loads default object instances from soft object path properties
    ENGINE_API void LoadDefaultObjects();
 
    ENGINE_API USoundClass* GetDefaultSoundClass() const;
    ENGINE_API USoundClass* GetDefaultMediaSoundClass() const;
    ENGINE_API USoundConcurrency* GetDefaultSoundConcurrency() const;
 
    // Registers Parameter Interfaces defined by the engine module.
    // Called on engine start-up. Can be called when engine is not
    // initialized as well by consuming plugins (ex. on cook by plugins
    // requiring interface system to be loaded).
    ENGINE_API void RegisterParameterInterfaces();
 
    // Get the quality level settings at the provided level index
    ENGINE_API const FAudioQualitySettings& GetQualityLevelSettings(int32 QualityLevel) const;
 
    UE_DEPRECATED(5.5, "Default Compression Quality has moved to SoundWave class defaults")
    ENGINE_API int32 GetDefaultCompressionQuality() const;
    
    // Get the quality name level for a given index
    ENGINE_API FString FindQualityNameByIndex(int32 Index) const;
 
    // Get the total number of quality level settings
    ENGINE_API int32 GetQualityLevelSettingsNum() const;
 
    ENGINE_API int32 GetHighestMaxChannels() const;
 
#if WITH_EDITOR
    FAudioSettingsChanged& OnAudioSettingsChanged() { return AudioSettingsChanged; }
#endif // WITH_EDITOR
 
private:
#if WITH_EDITOR
    TArray<FAudioQualitySettings> CachedQualityLevels;
    FSoftObjectPath CachedAmbisonicSubmix;
    FSoftObjectPath CachedMasterSubmix;
    FSoftObjectPath CachedSoundClass;
#endif // WITH_EDITOR
 
    ENGINE_API void AddDefaultSettings();
 
    bool bParameterInterfacesRegistered;
};