AudioStreaming.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
AudioStreaming.h: Definitions of classes used for audio streaming.
=============================================================================*/
 
#pragma once
 
#include "Async/AsyncWork.h"
#include "CoreMinimal.h"
#include "ContentStreaming.h"
#include "HAL/ThreadSafeCounter.h"
 
class FSoundWaveProxy;
using FSoundWaveProxyPtr = TSharedPtr<FSoundWaveProxy, ESPMode::ThreadSafe>;
 
class FAsyncStreamDerivedChunkWorker : public FNonAbandonableTask
{
public:
    FAsyncStreamDerivedChunkWorker(
        const FString& InDerivedDataKey,
        void* InDestChunkData,
        int32 InChunkSize,
        FThreadSafeCounter* InThreadSafeCounter,
        TFunction<void(bool)> InOnLoadComplete
        );
    
    void DoWork();
 
    inline TStatId GetStatId() const
    {
        RETURN_QUICK_DECLARE_CYCLE_STAT(FAsyncStreamDerivedChunkWorker, STATGROUP_ThreadPoolAsyncTasks);
    }
 
    bool DidRequestFail() const
    {
        return bRequestFailed;
    }
 
private:
    FString DerivedDataKey;
    void* DestChunkData;
    int32 ExpectedChunkSize;
    bool bRequestFailed;
    FThreadSafeCounter* ThreadSafeCounter;
    TFunction<void(bool)> OnLoadCompleted;
};
 
typedef FAsyncTask<FAsyncStreamDerivedChunkWorker> FAsyncStreamDerivedChunkTask;
 
using FStreamingWaveData = void*;
struct UE_DEPRECATED(5.5, "this struct relies on deprecated / deleted types, and should not be used") FASyncAudioChunkLoadResult
{
    // Place to safely copy the ptr of a loaded audio chunk when load result is finished
    uint8* DataResults;
 
    // Actual storage of the loaded audio chunk, will be filled on audio thread.
    FStreamingWaveData* StreamingWaveData;
 
    // Loaded audio chunk index
    int32 LoadedAudioChunkIndex;
 
    FASyncAudioChunkLoadResult()
        : DataResults(nullptr)
        , StreamingWaveData(nullptr)
        , LoadedAudioChunkIndex(INDEX_NONE)
    {}
};