SoundSubmixSend.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "CoreMinimal.h"
 
#include "Curves/CurveFloat.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
 
#include "SoundSubmixSend.generated.h"
 
 
// Forward Declarations
class USoundSubmixBase;
 
UENUM(BlueprintType)
enum class EAudioSpectrumBandPresetType: uint8
{
    KickDrum,
 
    SnareDrum,
 
    Voice,
 
    Cymbals 
};
 
USTRUCT(BlueprintType)
struct FSoundSubmixSpectralAnalysisBandSettings
{
    GENERATED_USTRUCT_BODY()
 
    // The frequency band for the magnitude to analyze
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = SubmixSpectralAnalysis, meta = (ClampMin = "10.0", ClampMax = "20000.0", UIMin = "10.0", UIMax = "10000.0"))
    float BandFrequency = 440.0f;
 
    // The attack time for the FFT band interpolation for delegate callback
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = SubmixSpectralAnalysis, meta = (ClampMin = "0.0", UIMin = "10.0", UIMax = "10000.0"))
    int32 AttackTimeMsec = 10;
 
    // The release time for the FFT band interpolation for delegate callback
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = SubmixSpectralAnalysis, meta = (ClampMin = "0.0", UIMin = "10.0", UIMax = "10000.0"))
    int32 ReleaseTimeMsec = 500;
 
    // The ratio of the bandwidth divided by the center frequency. Only used when the spectral analysis type is set to Constant Q.
    UPROPERTY(EditAnywhere, BlueprintReadWrite, AdvancedDisplay, Category = SubmixSpectralAnalysis, meta = (ClampMin = "0.001", UIMin = "0.1", UIMax = "100.0"))
    float QFactor = 10.0f;
};
 
DECLARE_DYNAMIC_DELEGATE_OneParam(FOnSubmixEnvelopeBP, const TArray<float>&, Envelope);
 
DECLARE_DYNAMIC_DELEGATE_OneParam(FOnSubmixSpectralAnalysisBP, const TArray<float>&, Magnitude);
 
UENUM(BlueprintType)
enum class EAudioRecordingExportType : uint8
{
    // Exports a USoundWave.
    SoundWave,
 
    // Exports a WAV file.
    WavFile
};
 
UENUM(BlueprintType)
enum class ESendLevelControlMethod : uint8
{
    // A send based on linear interpolation between a distance range and send-level range
    Linear,
 
    // A send based on a supplied curve
    CustomCurve,
 
    // A manual send level (Uses the specified constant send level value. Useful for 2D sounds.)
    Manual,
};
 
// Common set of settings that are uses as submix sends.
USTRUCT(BlueprintType)
struct FSoundSubmixSendInfoBase
{
    GENERATED_USTRUCT_BODY()
 
    ENGINE_API FSoundSubmixSendInfoBase();
 
    /*
        Manual: Use Send Level only
        Linear: Interpolate between Min and Max Send Levels based on listener distance (between Min/Max Send Distance)
        Custom Curve: Use the float curve to map Send Level to distance (0.0-1.0 on curve maps to Min/Max Send Distance)
    */
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = SubmixSend)
    ESendLevelControlMethod SendLevelControlMethod;
    
    // The Submix to send the audio to
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = SubmixSend)
    TObjectPtr<USoundSubmixBase> SoundSubmix;
 
    // Manually set the amount of audio to send
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = SubmixSend, meta = (DisplayName = "Manual Send Level", EditCondition = "SendLevelControlMethod == ESendLevelControlMethod::Manual", EditConditionHides))
    float SendLevel;
 
    // Whether to disable the internal 0-1 clamp for Manual Send Level control
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = SubmixSend, meta = (EditCondition = "SendLevelControlMethod == ESendLevelControlMethod::Manual", EditConditionHides))
    bool DisableManualSendClamp;
 
    // The amount to send to the Submix when sound is located at a distance less than or equal to value specified in the Min Send Distance
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = SubmixSend, meta = (EditCondition = "SendLevelControlMethod == ESendLevelControlMethod::Linear", EditConditionHides))
    float MinSendLevel;
 
    // The amount to send to the Submix when sound is located at a distance greater than or equal to value specified in the Max Send Distance
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = SubmixSend, meta = (EditCondition = "SendLevelControlMethod == ESendLevelControlMethod::Linear", EditConditionHides))
    float MaxSendLevel;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = SubmixSend, meta = (EditCondition = "SendLevelControlMethod != ESendLevelControlMethod::Manual", EditConditionHides))
    float MinSendDistance;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = SubmixSend, meta = (EditCondition = "SendLevelControlMethod != ESendLevelControlMethod::Manual", EditConditionHides))
    float MaxSendDistance;
 
    // The custom send curve to use for distance-based send level. (0.0-1.0 on the curve's X-axis maps to Min/Max Send Distance)
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = SubmixSend, meta = (EditCondition = "SendLevelControlMethod == ESendLevelControlMethod::CustomCurve", EditConditionHides))
    FRuntimeFloatCurve CustomSendLevelCurve;
};
 
UENUM(BlueprintType)
enum class ESubmixSendStage : uint8
{
    // Whether to do the send post distance attenuation
    PostDistanceAttenuation,
 
    // Whether to do the send pre distance attenuation
    PreDistanceAttenuation,
};
 
USTRUCT(BlueprintType)
struct FSoundSubmixSendInfo : public FSoundSubmixSendInfoBase
{
    GENERATED_BODY();
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = SubmixSend)
    ESubmixSendStage SendStage = ESubmixSendStage::PostDistanceAttenuation;
};