ChaosVDRuntimeModule.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#if WITH_CHAOS_VISUAL_DEBUGGER
 
#include "ChaosVDRecordingDetails.h"
#include "Templates/SharedPointer.h"
#include "Modules/ModuleInterface.h"
#include "ProfilingDebugging/TraceAuxiliary.h"
#include "Containers/Ticker.h"
#include "Misc/ScopeRWLock.h"
#include "Misc/TransactionallySafeRWLock.h"
 
#define UE_API CHAOSVDRUNTIME_API
 
namespace Chaos::VD
{
    class FRelayTraceWriter;
}
 
struct FChaosVDRecording;
class FText;
 
/* Option flags that controls what should be recorded when doing a full capture **/
enum class EChaosVDFullCaptureFlags : int32
{
    Geometry = 1 << 0,
    Particles = 1 << 1,
};
ENUM_CLASS_FLAGS(EChaosVDFullCaptureFlags)
 
DECLARE_MULTICAST_DELEGATE(FChaosVDRecordingStateChangedDelegate)
DECLARE_MULTICAST_DELEGATE_OneParam(FChaosVDCaptureRequestDelegate, EChaosVDFullCaptureFlags)
DECLARE_MULTICAST_DELEGATE_OneParam(FChaosVDRecordingStartFailedDelegate, const FText&)
DECLARE_DELEGATE_OneParam(FChaosVDRelayTraceDataDelegate, Chaos::VD::FRelayTraceWriter&)
DECLARE_DELEGATE_RetVal(FChaosVDTraceDetails, FChaosVDExternalTraceStatusDelegate)
 
DECLARE_LOG_CATEGORY_EXTERN(LogChaosVDRuntime, Log, All)
 
class FChaosVDRuntimeModule : public IModuleInterface
{
public:
 
    static UE_API FChaosVDRuntimeModule& Get();
    static UE_API bool IsLoaded();
    
    UE_API virtual void StartupModule() override;
    UE_API virtual void ShutdownModule() override;
 
    UE_API void StartRecording(TConstArrayView<FString> Args);
 
    UE_API void StartRecording(const FChaosVDStartRecordingCommandMessage& InRecordingStartCommand);
    
    /* Stops an active recording */
    UE_API void StopRecording();
 
    bool IsRecording() const
    {
        return bIsRecording;
    }
 
    UE_API int32 GenerateUniqueID();
 
    static FDelegateHandle RegisterRecordingStartedCallback(const FChaosVDRecordingStateChangedDelegate::FDelegate& InCallback)
    {
        UE::TWriteScopeLock WriteLock(DelegatesRWLock);
        return RecordingStartedDelegate.Add(InCallback);
    }
 
    static FDelegateHandle RegisterPostRecordingStartedCallback(const FChaosVDRecordingStateChangedDelegate::FDelegate& InCallback)
    {
        UE::TWriteScopeLock WriteLock(DelegatesRWLock);
        return PostRecordingStartedDelegate.Add(InCallback);
    }
 
    static FDelegateHandle RegisterRecordingStopCallback(const FChaosVDRecordingStateChangedDelegate::FDelegate& InCallback)
    {
        UE::TWriteScopeLock WriteLock(DelegatesRWLock);
        return RecordingStopDelegate.Add(InCallback);
    }
 
    static FDelegateHandle RegisterRecordingStartFailedCallback(const FChaosVDRecordingStartFailedDelegate::FDelegate& InCallback)
    {
        UE::TWriteScopeLock WriteLock(DelegatesRWLock);
        return RecordingStartFailedDelegate.Add(InCallback);
    }
    
    static FDelegateHandle RegisterFullCaptureRequestedCallback(const FChaosVDCaptureRequestDelegate::FDelegate& InCallback)
    {
        UE::TWriteScopeLock WriteLock(DelegatesRWLock);
        return PerformFullCaptureDelegate.Add(InCallback);
    }
 
    static bool RemoveRecordingStartedCallback(const FDelegateHandle& InDelegateToRemove)
    {
        UE::TWriteScopeLock WriteLock(DelegatesRWLock);
        return RecordingStartedDelegate.Remove(InDelegateToRemove);
    }
    
    static bool RemovePostRecordingStartedCallback(const FDelegateHandle& InDelegateToRemove)
    {
        UE::TWriteScopeLock WriteLock(DelegatesRWLock);
        return PostRecordingStartedDelegate.Remove(InDelegateToRemove);
    }
 
    static bool RemoveRecordingStopCallback(const FDelegateHandle& InDelegateToRemove)
    {
        UE::TWriteScopeLock WriteLock(DelegatesRWLock);
        return RecordingStopDelegate.Remove(InDelegateToRemove);
    }
 
    static bool RemoveRecordingStartFailedCallback(const FDelegateHandle& InDelegateToRemove)
    {
        UE::TWriteScopeLock WriteLock(DelegatesRWLock);
        return RecordingStartFailedDelegate.Remove(InDelegateToRemove);
    }
    
    static bool RemoveFullCaptureRequestedCallback(const FDelegateHandle& InDelegateToRemove)
    {
        UE::TWriteScopeLock WriteLock(DelegatesRWLock);
        return PerformFullCaptureDelegate.Remove(InDelegateToRemove);
    }
 
    float GetAccumulatedRecordingTime() const
    {
        return AccumulatedRecordingTime;
    }
 
    UE_DEPRECATED(5.7, "This method is no longer used. Use GetCurrentTraceSessionDetails")
    UE_API FString GetLastRecordingFileNamePath() const;
 
    UE_API FChaosVDTraceDetails GetCurrentTraceSessionDetails() const;
 
    EChaosVDRecordingMode GetCurrentRecordingMode() const
    {
        return CurrentRecordingMode;
    }
 
    UE_API void GenerateRecordingFileName(FString& OutFileName);
 
    UE_API void RegisterExternalRelayExecutor(const FChaosVDRelayTraceDataDelegate& InExternalRelayExecutor);
 
    UE_API void UnregisterCurrentExternalRelayExecutor();
 
    UE_API void RegisterExternalTraceStatusProvider(const FChaosVDExternalTraceStatusDelegate& InExternalTraceStatusCallback);
 
    UE_API void UnregisterExternalTraceStatusProvider();
 
    FSimpleMulticastDelegate& OnTraceConnectionDetailsUpdated()
    {
        return TraceConnectionDetailsUpdatedDelegate;
    }
 
private:
 
    void RelayTraceData();
 
    void SetupRelayDataPumpDelegates();
    void ClearRelayDataPumpDelegates();
 
    UE_API void StopTrace();
 
    UE_API bool RequestFullCapture(float DeltaTime);
 
    UE_API bool RecordingTimerTick(float DeltaTime);
    
    void HandleTraceConnectionEstablished();
 
    UE_API void HandleTraceStopRequest(FTraceAuxiliary::EConnectionType TraceType, const FString& TraceDestination);
 
    UE_API bool WaitForTraceSessionDisconnect();
 
    UE_API void EnableRequiredTraceChannels();
    UE_API void SaveAndDisabledCurrentEnabledTraceChannels();
    UE_API void RestoreTraceChannelsToPreRecordingState();
 
    bool bIsRecording = false;
    bool bRequestedStop = false;
 
    float AccumulatedRecordingTime = 0.0f;
 
    FTSTicker::FDelegateHandle FullCaptureRequesterHandle;
    FTSTicker::FDelegateHandle RecordingTimerHandle;
    FTSTicker::FDelegateHandle RelayExecutorTickerHandle;
 
    FDelegateHandle OnConnectionDelegateHandle;
    FDelegateHandle OnTraceStoppedDelegateHandle;
 
    static UE_API FChaosVDRecordingStateChangedDelegate RecordingStartedDelegate;
    static UE_API FChaosVDRecordingStateChangedDelegate PostRecordingStartedDelegate;
    static UE_API FChaosVDRecordingStateChangedDelegate RecordingStopDelegate;
    static UE_API FChaosVDRecordingStartFailedDelegate RecordingStartFailedDelegate;
    static UE_API FChaosVDCaptureRequestDelegate PerformFullCaptureDelegate;
 
    std::atomic<int32> LastGeneratedID;
 
    TMap<FString, bool> OriginalTraceChannelsState;
 
    EChaosVDRecordingMode CurrentRecordingMode = EChaosVDRecordingMode::Invalid;
    EChaosVDTransportMode CurrentTransportMode = EChaosVDTransportMode::Invalid;
 
    TUniquePtr<Chaos::VD::FRelayTraceWriter> RelayWriter;
    FChaosVDRelayTraceDataDelegate ExternalRelayExecutorDelegate;
 
    static UE_API FTransactionallySafeRWLock DelegatesRWLock;
 
    FChaosVDExternalTraceStatusDelegate ExternalTraceStatusDelegate;
 
    FSimpleMulticastDelegate TraceConnectionDetailsUpdatedDelegate;
};
#endif
 
#undef UE_API