MediaRecorder.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Async/Future.h"
#include "Containers/UnrealString.h"
#include "CoreTypes.h"
#include "IImageWrapper.h"
#include "MediaSampleQueue.h"
#include "Misc/Timespan.h"
#include "Templates/SharedPointer.h"
 
class FMediaPlayerFacade;
class FMediaRecorderClockSink;
class IImageWriteQueue;
 
 
class FMediaRecorder
{
public:
 
    MEDIAUTILS_API FMediaRecorder();
 
public:
 
    enum class EMediaRecorderNumerationStyle
    {
        AppendFrameNumber,
        AppendSampleTime
    };
 
    struct FMediaRecorderData
    {
        TSharedRef<FMediaPlayerFacade, ESPMode::ThreadSafe> PlayerFacade;
        FString BaseFilename;
        EMediaRecorderNumerationStyle NumerationStyle;
        EImageFormat TargetImageFormat;
        bool bResetAlpha;
        int32 CompressionQuality;
 
        FMediaRecorderData(const TSharedRef<FMediaPlayerFacade, ESPMode::ThreadSafe>& InPlayerFacade, const FString& InBaseFilename)
            : PlayerFacade(InPlayerFacade)
            , BaseFilename(InBaseFilename)
            , NumerationStyle(EMediaRecorderNumerationStyle::AppendSampleTime)
            , TargetImageFormat(EImageFormat::EXR)
            , bResetAlpha(false)
            , CompressionQuality(0)
        {
        }
    };
 
public: 
 
    MEDIAUTILS_API void StartRecording(const FMediaRecorderData& InRecoderData);
 
    MEDIAUTILS_API void StopRecording();
 
    bool IsRecording() const { return bRecording; }
 
    MEDIAUTILS_API bool WaitPendingTasks(const FTimespan& InDuration);
 
protected:
 
    MEDIAUTILS_API void TickRecording();
 
private:
 
    friend class FMediaRecorderClockSink;
 
    TSharedPtr<FMediaRecorderClockSink, ESPMode::ThreadSafe> ClockSink;
 
    TSharedPtr<FMediaTextureSampleQueue, ESPMode::ThreadSafe> SampleQueue;
 
    bool bRecording;
 
    bool bUnsupportedWarningShowed;
 
    int32 FrameCount;
 
    FString BaseFilename;
    EMediaRecorderNumerationStyle NumerationStyle;
    EImageFormat TargetImageFormat;
    bool bSetAlpha;
    int32 CompressionQuality;
 
    IImageWriteQueue* ImageWriteQueue;
    TFuture<void> CompletedFence;
};