AudioThread.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    AudioThread.h: Rendering thread definitions.
=============================================================================*/
 
#pragma once
 
#include "CoreMinimal.h"
#include "Stats/Stats.h"
 
#include "Tasks/Pipe.h"
 
// Audio thread API
// (the naming is outdated as the thread was replaced by piped tasks)
 
DECLARE_STATS_GROUP(TEXT("Audio Thread Commands"), STATGROUP_AudioThreadCommands, STATCAT_Advanced);
 
class FAudioThread
{
private:
    static bool bUseThreadedAudio;
 
    static TUniquePtr<UE::Tasks::FTaskEvent> ResumeEvent;
    static int32 SuspendCount;  // accessed only from GT
 
    // GC callback handles
    static FDelegateHandle PreGC;
    static FDelegateHandle PostGC;
    static FDelegateHandle PreGCDestroy;
    static FDelegateHandle PostGCDestroy;
 
    static TStatId CurrentAudioThreadStatId;
    static TStatId LongestAudioThreadStatId;
    static double LongestAudioThreadTimeMsec;
    static FCriticalSection CurrentAudioThreadStatIdCS;
 
    static void SetCurrentAudioThreadStatId(TStatId InStatId);
    static void SetLongestTimeAndId(TStatId NewLongestId, double LongestTimeMsec);
    static double GetCurrentLongestTime() { return LongestAudioThreadTimeMsec; }
 
    // a helper to apply stats and optional additional logging
    static TUniqueFunction<void()> GetCommandWrapper(TUniqueFunction<void()> InFunction, const TStatId InStatId);
 
public:
    static ENGINE_API void StartAudioThread();
 
    static ENGINE_API void StopAudioThread();
 
    static ENGINE_API void RunCommandOnAudioThread(TUniqueFunction<void()> InFunction, const TStatId InStatId = TStatId());
 
    static ENGINE_API void ProcessAllCommands();
 
    static ENGINE_API void RunCommandOnGameThread(TUniqueFunction<void()> InFunction, const TStatId InStatId = TStatId());
 
    static ENGINE_API void SetUseThreadedAudio(bool bInUseThreadedAudio);
    static ENGINE_API bool IsUsingThreadedAudio();
 
    static ENGINE_API void SuspendAudioThread();
    static ENGINE_API void ResumeAudioThread();
 
    static ENGINE_API FString GetCurrentAudioThreadStatId();
 
    static ENGINE_API void ResetAudioThreadTimers();
 
    static ENGINE_API void GetLongestTaskInfo(FString& OutLongestTask, double& OutLongestTaskTimeMs);
};
 
 
struct FAudioThreadSuspendContext
{
    FAudioThreadSuspendContext()
    {
        FAudioThread::SuspendAudioThread();
    }
 
    ~FAudioThreadSuspendContext()
    {
        FAudioThread::ResumeAudioThread();
    }
};
 
// Audio fences
 
class FAudioCommandFence
{
public:
    ENGINE_API ~FAudioCommandFence();
 
    ENGINE_API void BeginFence();
 
    ENGINE_API void Wait(bool bProcessGameThreadTasks = false) const;
 
    // return true if the fence is complete
    ENGINE_API bool IsFenceComplete() const;
 
private:
    mutable UE::Tasks::FTask Fence;
};