AudioAnalyzerNRT.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "IAudioAnalyzerNRTInterface.h"
#include "AudioAnalyzerAsset.h"
#include "Sound/SoundWave.h"
#include "AudioAnalyzerNRT.generated.h"
 
 
 
UCLASS(Abstract, EditInlineNew, BlueprintType, MinimalAPI)
class UAudioAnalyzerNRTSettings : public UAudioAnalyzerAssetBase
{
    GENERATED_BODY()
 
    public:
 
#if WITH_EDITOR
 
        FAnalyzeAudioDelegate AnalyzeAudioDelegate;
 
        AUDIOANALYZER_API void PostEditChangeProperty (struct FPropertyChangedEvent & PropertyChangedEvent) override;
 
        AUDIOANALYZER_API virtual bool ShouldEventTriggerAnalysis(struct FPropertyChangedEvent & PropertyChangeEvent);
#endif
 
};
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE(FOnAudioAnalyzerNRTAnalysisComplete);
 
UCLASS(Abstract, EditInlineNew, BlueprintType, MinimalAPI)
class UAudioAnalyzerNRT : public UAudioAnalyzerAssetBase
{
    GENERATED_BODY()
 
    public:
        typedef int32 FResultId;
 
        typedef TSharedPtr<Audio::IAnalyzerNRTResult, ESPMode::ThreadSafe> FResultSharedPtr;
 
        UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=AudioAnalyzer, meta=(DisallowedClasses="/Script/MetasoundEngine.MetaSoundSource, /Script/Engine.SoundSourceBus"))
        TObjectPtr<USoundWave> Sound;
 
        UPROPERTY(BlueprintReadOnly, Category=AudioAnalyzer)
        float DurationInSeconds;
 
#if WITH_EDITOR
        UFUNCTION(BlueprintCallable, Category="Audio Analyzer")
        AUDIOANALYZER_API void SetSound(USoundWave* InSound);
#endif
 
        template<class ResultType>
        TSharedPtr<ResultType, ESPMode::ThreadSafe> GetResult()
        {
            TSharedPtr<ResultType, ESPMode::ThreadSafe> ReturnedResult;
            {
                FScopeLock ResultLock(&ResultCriticalSection);
                ReturnedResult = StaticCastSharedPtr<ResultType>(Result); 
            }
            return ReturnedResult;
        }
 
        template<class ResultType>
        TSharedPtr<const ResultType, ESPMode::ThreadSafe> GetResult() const
        {
            TSharedPtr<const ResultType, ESPMode::ThreadSafe> ReturnedResult;
            {
                FScopeLock ResultLock(&ResultCriticalSection);
                ReturnedResult = StaticCastSharedPtr<const ResultType>(Result); 
            }
            return ReturnedResult;
        }
     
        AUDIOANALYZER_API virtual TUniquePtr<Audio::IAnalyzerNRTSettings> GetSettings(const float InSampleRate, const int32 InNumChannels) const;
 
        AUDIOANALYZER_API virtual void Serialize(FArchive& Ar) override;
 
#if WITH_EDITOR
 
        AUDIOANALYZER_API void SetResult(FResultSharedPtr NewResult);
 
        AUDIOANALYZER_API void SetResultIfLatest(FResultSharedPtr NewResult, FResultId InResultId);
 
        AUDIOANALYZER_API void PreEditChange(FProperty* PropertyAboutToChange) override;
 
        AUDIOANALYZER_API void PostEditChangeProperty (struct FPropertyChangedEvent & PropertyChangedEvent) override;
 
        AUDIOANALYZER_API virtual bool ShouldEventTriggerAnalysis(struct FPropertyChangedEvent & PropertyChangeEvent);
 
        UFUNCTION(BlueprintCallable, Category="Audio Analyzer")
        AUDIOANALYZER_API void AnalyzeAudio();
 
#endif
#if WITH_EDITORONLY_DATA
        UPROPERTY(BlueprintAssignable, Category="Audio Analyzer")
        FOnAudioAnalyzerNRTAnalysisComplete OnAnalysisComplete;
#endif
 
 
    protected:
 
#if WITH_EDITOR
 
        AUDIOANALYZER_API void SetSettingsDelegate(UAudioAnalyzerNRTSettings* InSettings);
 
        AUDIOANALYZER_API void RemoveSettingsDelegate(UAudioAnalyzerNRTSettings* InSettings);
#endif 
 
        /* Subclasses must override this method in order to inform this object which AnalyzerNRTFactory to use for analysis */
        virtual FName GetAnalyzerNRTFactoryName() const PURE_VIRTUAL(UAudioAnalyzerNRT::GetAnalyzerNRTFactoryName, return FName(););
 
    private:
 
        // Returns UAudioAnalyzerNRTSettings* if property points to a valid UAudioAnalyzerNRTSettings, otherwise returns nullptr.
        AUDIOANALYZER_API UAudioAnalyzerNRTSettings* GetSettingsFromProperty(FProperty* Property);
 
        TSharedPtr<Audio::IAnalyzerNRTResult, ESPMode::ThreadSafe> Result;
 
        // Critical section is mutable so it can still be locked within const methods.
        mutable FCriticalSection ResultCriticalSection;
 
        // Result id of the current result. 
        TAtomic<FResultId> CurrentResultId;
 
#if WITH_EDITOR
        TMap<UAudioAnalyzerNRTSettings*, FDelegateHandle> AnalyzeAudioDelegateHandles;
#endif 
};