UserDefinedCaptureProtocol.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "MovieSceneCaptureProtocolBase.h"
#include "FrameGrabber.h"
#include "ImageWriteStream.h"
#include "UserDefinedCaptureProtocol.generated.h"
 
enum class EDesiredImageFormat : uint8;
struct FImagePixelData;
struct FImageWriteOptions;
struct ICaptureProtocolHost;
class UTexture;
 
USTRUCT(BlueprintType)
struct FCapturedPixelsID
{
    GENERATED_BODY()
 
    
    FString ToString() const;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=Capture)
    TMap<FName, FName> Identifiers;
};
 
 
 
USTRUCT(BlueprintType)
struct FCapturedPixels
{
    GENERATED_BODY()
 
    TSharedPtr<FImagePixelData, ESPMode::ThreadSafe> ImageData;
};
 
UCLASS(Abstract, Blueprintable, meta=(DisplayName="Capture Protocol"), MinimalAPI)
class UUserDefinedCaptureProtocol
    : public UMovieSceneImageCaptureProtocolBase
{
public:
 
    GENERATED_BODY()
 
    MOVIESCENECAPTURE_API UUserDefinedCaptureProtocol(const FObjectInitializer& ObjInit);
 
protected:
 
    UFUNCTION(BlueprintImplementableEvent, Category=Capture)
    MOVIESCENECAPTURE_API void OnPreTick();
 
    UFUNCTION(BlueprintImplementableEvent, Category=Capture)
    MOVIESCENECAPTURE_API void OnTick();
 
    UFUNCTION(BlueprintNativeEvent, Category=Capture)
    MOVIESCENECAPTURE_API bool OnSetup();
    virtual bool OnSetup_Implementation() { return true; }
 
    UFUNCTION(BlueprintImplementableEvent, Category=Capture)
    MOVIESCENECAPTURE_API void OnWarmUp();
 
    UFUNCTION(BlueprintImplementableEvent, Category=Capture)
    MOVIESCENECAPTURE_API void OnStartCapture();
 
    UFUNCTION(BlueprintImplementableEvent, Category=Capture)
    MOVIESCENECAPTURE_API void OnCaptureFrame();
 
    UFUNCTION(BlueprintImplementableEvent, Category=Capture)
    MOVIESCENECAPTURE_API void OnPauseCapture();
 
    UFUNCTION(BlueprintImplementableEvent, Category=Capture)
    MOVIESCENECAPTURE_API void OnBeginFinalize();
 
 
    UFUNCTION(BlueprintNativeEvent, Category=Capture)
    MOVIESCENECAPTURE_API bool OnCanFinalize() const;
    virtual bool OnCanFinalize_Implementation() const { return true; }
 
 
    UFUNCTION(BlueprintImplementableEvent, Category=Capture)
    MOVIESCENECAPTURE_API void OnFinalize();
 
 
    UFUNCTION(BlueprintImplementableEvent, Category=Capture)
    MOVIESCENECAPTURE_API void OnPixelsReceived(const FCapturedPixels& Pixels, const FCapturedPixelsID& ID, FFrameMetrics FrameMetrics);
 
 
public:
 
    /*
     * Resolve the specified buffer and pass it directly to the specified handler when done (does not pass to any bound streams)
     * 
     * @param Buffer          The desired buffer to save
     * @param BufferID        The ID of this buffer that is passed to the pixel handler (e.g. a composition pass name).
     */
    UFUNCTION(BlueprintCallable, Category=Capture)
    MOVIESCENECAPTURE_API void ResolveBuffer(UTexture* Buffer, const FCapturedPixelsID& BufferID);
 
 
    UFUNCTION(BlueprintCallable, Category=Capture)
    MOVIESCENECAPTURE_API void StartCapturingFinalPixels(const FCapturedPixelsID& StreamID);
 
 
    UFUNCTION(BlueprintCallable, Category=Capture)
    MOVIESCENECAPTURE_API void StopCapturingFinalPixels();
 
 
    UFUNCTION(BlueprintCallable, Category=Capture)
    MOVIESCENECAPTURE_API virtual FString GenerateFilename(const FFrameMetrics& InFrameMetrics) const;
 
 
    UFUNCTION(BlueprintCallable, Category=Capture)
    FFrameMetrics GetCurrentFrameMetrics() const
    {
        return CachedFrameMetrics;
    }
 
public:
 
    MOVIESCENECAPTURE_API void OnPixelsReceivedImpl(const FCapturedPixels& Pixels, const FCapturedPixelsID& StreamID, FFrameMetrics FrameMetrics);
 
    MOVIESCENECAPTURE_API void ReportOutstandingWork(int32 NumNewOperations);
 
protected:
 
    MOVIESCENECAPTURE_API virtual void PreTickImpl() override;
    MOVIESCENECAPTURE_API virtual void TickImpl() override;
    MOVIESCENECAPTURE_API virtual bool SetupImpl() override;
    MOVIESCENECAPTURE_API virtual void WarmUpImpl() override;
    MOVIESCENECAPTURE_API virtual bool StartCaptureImpl() override;
    MOVIESCENECAPTURE_API virtual void CaptureFrameImpl(const FFrameMetrics& FrameMetrics) override;
    MOVIESCENECAPTURE_API virtual void BeginFinalizeImpl() override;
    MOVIESCENECAPTURE_API virtual bool HasFinishedProcessingImpl() const override;
    MOVIESCENECAPTURE_API virtual void FinalizeImpl() override;
    MOVIESCENECAPTURE_API virtual void AddFormatMappingsImpl(TMap<FString, FStringFormatArg>& FormatMappings) const override;
    virtual UWorld* GetWorld() const override { return World; }
protected:
 
    UPROPERTY(transient, BlueprintReadOnly, Category=Capture)
    TObjectPtr<UWorld> World;
 
protected:
 
    TUniquePtr<FFrameGrabber> FinalPixelsFrameGrabber;
 
    TAtomic<int32> NumOutstandingOperations;
 
    FFrameMetrics CachedFrameMetrics;
 
    FCapturedPixelsID FinalPixelsID;
 
    const FCapturedPixelsID* CurrentStreamID;
};
 
 
UCLASS(Abstract, config=EditorPerProjectUserSettings, Blueprintable, meta=(DisplayName="Capture Protocol"), MinimalAPI)
class UUserDefinedImageCaptureProtocol
    : public UUserDefinedCaptureProtocol
{
public:
 
    GENERATED_BODY()
 
    MOVIESCENECAPTURE_API UUserDefinedImageCaptureProtocol(const FObjectInitializer& ObjInit);
 
    UPROPERTY(config, BlueprintReadWrite, EditAnywhere, Category=Capture)
    EDesiredImageFormat Format;
 
    UPROPERTY(config, BlueprintReadWrite, EditAnywhere, Category=Capture, meta=(InlineEditConditionToggle))
    bool bEnableCompression;
 
    UPROPERTY(config, BlueprintReadWrite, EditAnywhere, Category=Capture, meta=(EditCondition=bEnableCompression))
    int32 CompressionQuality;
 
public:
 
 
    /*
     * Generate a filename for the specified buffer using this protocol's file name formatter
     * 
     * @param Buffer          The desired buffer to generate a filename for
     * @param StreamID        The ID of the stream for this buffer (e.g. a composition pass name)
     * @return A fully qualified file name
     */
    UFUNCTION(BlueprintCallable, Category=Capture)
    MOVIESCENECAPTURE_API FString GenerateFilenameForBuffer(UTexture* Buffer, const FCapturedPixelsID& StreamID);
 
 
    /*
     * Generate a filename for the current frame using this protocol's file name formatter
     * 
     * @return A fully qualified file name for the current frame number
     */
    UFUNCTION(BlueprintCallable, Category=Capture)
    MOVIESCENECAPTURE_API FString GenerateFilenameForCurrentFrame();
 
 
    /*
     * Generate a filename for the current frame using this protocol's file name formatter
     * 
     * @return A fully qualified file name for the current frame number
     */
    UFUNCTION(BlueprintCallable, Category=Capture)
    MOVIESCENECAPTURE_API void WriteImageToDisk(const FCapturedPixels& PixelData, const FCapturedPixelsID& StreamID, const FFrameMetrics& FrameMetrics, bool bCopyImageData = false);
 
protected:
 
    MOVIESCENECAPTURE_API virtual void OnReleaseConfigImpl(FMovieSceneCaptureSettings& InSettings) override;
    MOVIESCENECAPTURE_API virtual void OnLoadConfigImpl(FMovieSceneCaptureSettings& InSettings) override;
public:
 
    MOVIESCENECAPTURE_API void OnFileWritten();
 
private:
 
    MOVIESCENECAPTURE_API virtual FString GenerateFilename(const FFrameMetrics& InFrameMetrics) const override;
};