SoundClass.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "CoreMinimal.h"
 
#include "AudioDefines.h"
#include "AudioDynamicParameter.h"
#include "IAudioExtensionPlugin.h"
#include "IAudioModulation.h"
#include "Interfaces/Interface_AssetUserData.h"
#include "Sound/AudioOutputTarget.h"
#include "Sound/SoundModulationDestination.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
 
#if WITH_EDITOR
#include "EdGraph/EdGraph.h"
#endif // WITH_EDITOR
#include "SoundWaveLoadingBehavior.h"
#include "UObject/PerPlatformProperties.h"
 
#include "SoundClass.generated.h"
 
class UAssetUserData;
 
USTRUCT()
struct FSoundClassEditorData
{
    GENERATED_USTRUCT_BODY()
 
    int32 NodePosX;
 
    int32 NodePosY;
 
 
    FSoundClassEditorData()
        : NodePosX(0)
        , NodePosY(0)
    {
    }
 
 
    friend FArchive& operator<<(FArchive& Ar,FSoundClassEditorData& MySoundClassEditorData)
    {
        return Ar << MySoundClassEditorData.NodePosX << MySoundClassEditorData.NodePosY;
    }
};
 
PRAGMA_DISABLE_DEPRECATION_WARNINGS
USTRUCT(BlueprintType)
struct FSoundClassProperties
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY(EditAnywhere, BlueprintReadOnly, meta = (ClampMin = "0.0"), Category = General)
    float Volume;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = General)
    float Pitch;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = General)
    float LowPassFilterFrequency;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = General)
    float AttenuationDistanceScale;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Routing, meta = (DisplayName = "LFE Bleed"))
    float LFEBleed;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Routing)
    float VoiceCenterChannelVolume;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, AdvancedDisplay, Category = Legacy)
    float RadioFilterVolume;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, AdvancedDisplay, Category = Legacy)
    float RadioFilterVolumeThreshold;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, AdvancedDisplay, Category = Legacy, meta = (DisplayName = "Output to Master EQ Submix"))
    uint8 bApplyEffects:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = General)
    uint8 bAlwaysPlay:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, AdvancedDisplay, Category = Legacy)
    uint8 bIsUISound:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, AdvancedDisplay, Category = Legacy)
    uint8 bIsMusic:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Routing)
    uint8 bCenterChannelOnly:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Routing)
    uint8 bApplyAmbientVolumes:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Submix, meta = (DisplayName = "Send to Master Reverb Submix"))
    uint8 bReverb:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Submix)
    float Default2DReverbSendAmount;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Modulation)
    FSoundModulationDefaultSettings ModulationSettings;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Legacy)
    TEnumAsByte<EAudioOutputTarget::Type> OutputTarget;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Loading, meta = (DisplayName = "Loading Behavior Override"), AssetRegistrySearchable)
    ESoundWaveLoadingBehavior LoadingBehavior;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(EditAnywhere, Category = Loading, meta = (UIMin = 0, UIMax = 10, EditCondition = "LoadingBehavior == ESoundWaveLoadingBehavior::RetainOnLoad || LoadingBehavior == ESoundWaveLoadingBehavior::PrimeOnLoad"), DisplayName="Size of First Audio Chunk (seconds)")
    FPerPlatformFloat SizeOfFirstAudioChunkInSeconds = 0.0f;
#endif //WITH_EDITORONLY_DATA
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Submix, meta = (EditCondition = "!bApplyEffects"))
    TObjectPtr<USoundSubmix> DefaultSubmix;
 
    FSoundClassProperties();
};
PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
struct FSoundClassDynamicProperties
{
    FDynamicParameter AttenuationScaleParam;
 
    FSoundClassDynamicProperties()
        : AttenuationScaleParam(1.0f)
    {
    }
};
 
USTRUCT(BlueprintType)
struct FPassiveSoundMixModifier
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=PassiveSoundMixModifier)
    TObjectPtr<class USoundMix> SoundMix;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=PassiveSoundMixModifier)
    float MinVolumeThreshold;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=PassiveSoundMixModifier)
    float MaxVolumeThreshold;
 
    FPassiveSoundMixModifier()
        : SoundMix(NULL)
        , MinVolumeThreshold(0.f)
        , MaxVolumeThreshold(10.f)
    {
    }
    
};
 
#if WITH_EDITOR
class USoundClass;
 
class ISoundClassAudioEditor
{
public:
    virtual ~ISoundClassAudioEditor() {}
 
    virtual void RefreshGraphLinks(UEdGraph* SoundClassGraph) = 0;
};
#endif
 
 
UCLASS(config = Engine, hidecategories = Object, editinlinenew, BlueprintType, MinimalAPI)
class USoundClass : public UObject, public IInterface_AssetUserData
{
    GENERATED_UCLASS_BODY()
 
public:
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = General, meta = (ShowOnlyInnerProperties))
    FSoundClassProperties Properties;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = General)
    TArray<TObjectPtr<USoundClass>> ChildClasses;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = General)
    TArray<FPassiveSoundMixModifier> PassiveSoundMixModifiers;
 
    UPROPERTY(BlueprintReadOnly, Category = General)
    TObjectPtr<USoundClass> ParentClass;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Instanced, Category = Advanced)
    TArray<TObjectPtr<UAssetUserData>> AssetUserData;
    
#if WITH_EDITORONLY_DATA
    TObjectPtr<class UEdGraph> SoundClassGraph;
#endif // WITH_EDITORONLY_DATA
 
protected:
 
    //~ Begin UObject Interface.
    ENGINE_API virtual void Serialize( FArchive& Ar ) override;
    ENGINE_API virtual FString GetDesc( void ) override;
    ENGINE_API virtual void BeginDestroy() override;
    ENGINE_API virtual void PostLoad() override;
#if WITH_EDITOR
    ENGINE_API virtual void PreEditChange(FProperty* PropertyAboutToChange) override;
    ENGINE_API virtual void PostEditChangeProperty(struct FPropertyChangedEvent& PropertyChangedEvent) override;
#endif
    //~ End UObject Interface.
 
public:
    ENGINE_API void Interpolate( float InterpValue, FSoundClassProperties& Current, const FSoundClassProperties& Start, const FSoundClassProperties& End );
 
    //~ Begin IInterface_AssetUserData Interface
    ENGINE_API virtual void AddAssetUserData(UAssetUserData* InUserData) override;
    ENGINE_API virtual void RemoveUserDataOfClass(TSubclassOf<UAssetUserData> InUserDataClass) override;
    ENGINE_API virtual UAssetUserData* GetAssetUserDataOfClass(TSubclassOf<UAssetUserData> InUserDataClass) override;
    ENGINE_API virtual const TArray<UAssetUserData*>* GetAssetUserDataArray() const override;
    //~ End IInterface_AssetUserData Interface
    
    // Sound Class Editor functionality
#if WITH_EDITOR
    ENGINE_API bool RecurseCheckChild( USoundClass* ChildSoundClass );
 
    ENGINE_API void SetParentClass( USoundClass* InParentClass );
 
    static ENGINE_API void AddReferencedObjects(UObject* InThis, FReferenceCollector& Collector);
 
    ENGINE_API void RefreshAllGraphs(bool bIgnoreThis);
 
    static ENGINE_API void SetSoundClassAudioEditor(TSharedPtr<ISoundClassAudioEditor> InSoundClassAudioEditor);
 
    static ENGINE_API TSharedPtr<ISoundClassAudioEditor> GetSoundClassAudioEditor();
    
private:
 
    static TSharedPtr<ISoundClassAudioEditor> SoundClassAudioEditor;
 
#endif
 
};