MovieSceneCapture.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
#include "UObject/ScriptInterface.h"
#include "MovieSceneCaptureProtocolBase.h"
#include "MovieSceneCaptureHandle.h"
#include "MovieSceneCaptureSettings.h"
#include "IMovieSceneCapture.h"
#include "Scalability.h"
#include "UObject/SoftObjectPath.h"
#include "MovieSceneCapture.generated.h"
 
class FJsonObject;
class FSceneViewport;
 
struct FCachedMetrics
{
    FCachedMetrics() : Width(0), Height(0), Frame(0), ElapsedSeconds(0.f), PreviousFrame(INDEX_NONE) {}
 
    int32 Width, Height;
    int32 Frame;
    float ElapsedSeconds;
    int32 PreviousFrame;
};
 
UCLASS(config=EditorPerProjectUserSettings, PerObjectConfig, BlueprintType, MinimalAPI)
class UMovieSceneCapture : public UObject, public IMovieSceneCaptureInterface, public ICaptureProtocolHost
{
public:
    MOVIESCENECAPTURE_API UMovieSceneCapture(const FObjectInitializer& Initializer);
 
    GENERATED_BODY()
 
    
    static MOVIESCENECAPTURE_API const FName MovieSceneCaptureUIName;
 
    MOVIESCENECAPTURE_API virtual void PostInitProperties() override;
 
public:
 
    // Begin IMovieSceneCaptureInterface
    MOVIESCENECAPTURE_API virtual void Initialize(TSharedPtr<FSceneViewport> InSceneViewport, int32 PIEInstance = -1) override;
    virtual void StartCapturing() { StartCapture(); }
    virtual void Close() override { Finalize(); }
    virtual FMovieSceneCaptureHandle GetHandle() const override { return Handle; }
    const FMovieSceneCaptureSettings& GetSettings() const override { return Settings; }
    const int32 GetFrameNumberOffset() const override { return FrameNumberOffset; }
    // End IMovieSceneCaptureInterface
 
    MOVIESCENECAPTURE_API virtual void LoadFromConfig();
    MOVIESCENECAPTURE_API virtual void SaveToConfig();
 
    MOVIESCENECAPTURE_API void SerializeJson(FJsonObject& Object);
 
    MOVIESCENECAPTURE_API void DeserializeJson(const FJsonObject& Object);
 
protected:
 
    virtual void SerializeAdditionalJson(FJsonObject& Object){}
 
    virtual void DeserializeAdditionalJson(const FJsonObject& Object){}
 
    MOVIESCENECAPTURE_API virtual bool IsAudioPassIfNeeded() const;
public:
 
    UPROPERTY(config, EditAnywhere, NoClear, Category=CaptureSettings, DisplayName="Image Output Format", meta=(MetaClass="/Script/MovieSceneCapture.MovieSceneImageCaptureProtocolBase", HideViewOptions, ShowDisplayNames))
    FSoftClassPath ImageCaptureProtocolType;
    
    UPROPERTY(config, EditAnywhere, NoClear, Category=CaptureSettings, DisplayName="Audio Output Format", meta=(MetaClass="/Script/MovieSceneCapture.MovieSceneAudioCaptureProtocolBase", HideViewOptions, ShowDisplayNames))
    FSoftClassPath AudioCaptureProtocolType;
 
    UPROPERTY(VisibleAnywhere, Category=CaptureSettings, Transient, Instanced)
    TObjectPtr<UMovieSceneImageCaptureProtocolBase> ImageCaptureProtocol;
    
    UPROPERTY(VisibleAnywhere, Category = CaptureSettings, Transient, Instanced)
    TObjectPtr<UMovieSceneAudioCaptureProtocolBase> AudioCaptureProtocol;
 
    UPROPERTY(config, EditAnywhere, BlueprintReadWrite, Category=CaptureSettings, meta=(ShowOnlyInnerProperties))
    FMovieSceneCaptureSettings Settings;
 
    UPROPERTY(config, EditAnywhere, BlueprintReadWrite, Category=General, AdvancedDisplay)
    bool bUseSeparateProcess;
 
    UPROPERTY(config, EditAnywhere, BlueprintReadWrite, Category=General, AdvancedDisplay, meta=(EditCondition=bUseSeparateProcess))
    bool bCloseEditorWhenCaptureStarts;
 
    UPROPERTY(config, EditAnywhere, BlueprintReadWrite, Category=General, AdvancedDisplay, meta=(EditCondition=bUseSeparateProcess))
    FString AdditionalCommandLineArguments;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, transient, Category=General, AdvancedDisplay, meta=(EditCondition=bUseSeparateProcess))
    FString InheritedCommandLineArguments;
 
    DECLARE_EVENT( UMovieSceneCapture, FOnCaptureFinished );
    FOnCaptureFinished& OnCaptureFinished() { return OnCaptureFinishedDelegate; }
 
public:
 
    const FCachedMetrics& GetMetrics() const { return CachedMetrics; }
 
    UFUNCTION(BlueprintCallable, Category=Capture)
    UMovieSceneCaptureProtocolBase* GetImageCaptureProtocol() { return ImageCaptureProtocol; }
    UFUNCTION(BlueprintCallable, Category=Capture)
    UMovieSceneCaptureProtocolBase* GetAudioCaptureProtocol() { return AudioCaptureProtocol; }
    
    
    UFUNCTION(BlueprintCallable, Category=Capture)
    MOVIESCENECAPTURE_API void SetImageCaptureProtocolType(TSubclassOf<UMovieSceneCaptureProtocolBase> ProtocolType);
    UFUNCTION(BlueprintCallable, Category=Capture)
    MOVIESCENECAPTURE_API void SetAudioCaptureProtocolType(TSubclassOf<UMovieSceneCaptureProtocolBase> ProtocolType);
 
public:
 
    MOVIESCENECAPTURE_API void StartWarmup();
 
    MOVIESCENECAPTURE_API void StartCapture();
 
    MOVIESCENECAPTURE_API void CaptureThisFrame(float DeltaSeconds);
 
    MOVIESCENECAPTURE_API void FinalizeWhenReady();
 
    MOVIESCENECAPTURE_API bool ShouldFinalize() const;
 
    MOVIESCENECAPTURE_API void Finalize();
 
public:
 
    MOVIESCENECAPTURE_API void Tick(float DeltaSeconds);
 
    // ICaptureProtocolHost interface
    MOVIESCENECAPTURE_API FString ResolveFileFormat(const FString& Format, const FFrameMetrics& FrameMetrics) const;
 
    double GetEstimatedCaptureDurationSeconds() const { return 0.0; }
 
 
    virtual FFrameRate GetCaptureFrameRate() const { return Settings.GetFrameRate(); }
    virtual const ICaptureStrategy& GetCaptureStrategy() const { return *CaptureStrategy; }
    // ~ICaptureProtocolHost interface
 
protected:
    virtual void AddFormatMappings(TMap<FString, FStringFormatArg>& OutFormatMappings, const FFrameMetrics& FrameMetrics) const {}
 
 
    MOVIESCENECAPTURE_API void InitializeCaptureProtocols();
    
    MOVIESCENECAPTURE_API void ForciblyReinitializeCaptureProtocols();
 
    virtual void OnTick(float DeltaSeconds) { CaptureThisFrame(DeltaSeconds); }
protected:
 
#if WITH_EDITOR
    MOVIESCENECAPTURE_API virtual void PostEditChangeProperty( struct FPropertyChangedEvent& PropertyChangedEvent) override;
#endif
 
protected:
    TSharedPtr<ICaptureStrategy> CaptureStrategy;
    TOptional<FCaptureProtocolInitSettings> InitSettings;
    bool bFinalizeWhenReady;
    FMovieSceneCaptureHandle Handle;
    FCachedMetrics CachedMetrics;
    TMap<FString, FStringFormatArg> FormatMappings;
    bool bCapturing;
    bool bIsAudioCapturePass;
 
    int32 FrameNumberOffset;
    FOnCaptureFinished OnCaptureFinishedDelegate;
    Scalability::FQualityLevels CachedQualityLevels;
};
 
struct FFixedTimeStepCaptureStrategy : ICaptureStrategy
{
    MOVIESCENECAPTURE_API FFixedTimeStepCaptureStrategy(FFrameRate InFrameRate);
 
    MOVIESCENECAPTURE_API virtual void OnInitialize() override;
    MOVIESCENECAPTURE_API virtual void OnStop() override;
    MOVIESCENECAPTURE_API virtual bool ShouldPresent(double CurrentTimeSeconds, uint32 FrameIndex) const override;
    MOVIESCENECAPTURE_API virtual int32 GetDroppedFrames(double CurrentTimeSeconds, uint32 FrameIndex) const override;
 
private:
    FFrameRate FrameRate;
};
 
struct FRealTimeCaptureStrategy : ICaptureStrategy
{
    MOVIESCENECAPTURE_API FRealTimeCaptureStrategy(FFrameRate InFrameRate);
 
    MOVIESCENECAPTURE_API virtual void OnInitialize() override;
    MOVIESCENECAPTURE_API virtual void OnStop() override;
    virtual bool ShouldSynchronizeFrames() const override { return false; }
    MOVIESCENECAPTURE_API virtual bool ShouldPresent(double CurrentTimeSeconds, uint32 FrameIndex) const override;
    MOVIESCENECAPTURE_API virtual int32 GetDroppedFrames(double CurrentTimeSeconds, uint32 FrameIndex) const override;
 
private:
    double NextPresentTimeS, FrameLength;
};