DefaultGameMoviePlayer.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "HAL/ThreadSafeCounter.h"
#include "Stats/Stats.h"
#include "Types/SlateStructs.h"
#include "Layout/Visibility.h"
#include "Input/Reply.h"
#include "Rendering/SlateRenderer.h"
#include "Widgets/SWidget.h"
#include "Widgets/SWindow.h"
#include "Widgets/Layout/SBorder.h"
#include "MoviePlayer.h"
#include "MoviePlayerProxyServer.h"
#include "TickableObjectRenderThread.h"
 
#include "Misc/CoreDelegates.h"
 
class FWidgetRenderer;
class SVirtualWindow;
 
class FMoviePlayerWidgetRenderer
{
public:
    FMoviePlayerWidgetRenderer(TSharedPtr<SWindow> InMainWindow, TSharedPtr<SVirtualWindow> InVirtualRenderWindowWindow, FSlateRenderer* InRenderer);
 
    void EnableDPIScale(bool bShouldEnable);
    void DrawWindow(float DeltaTime);
 
private:
    SWindow* MainWindow;
 
    TSharedRef<class SVirtualWindow> VirtualRenderWindow;
 
    TSharedPtr<FHittestGrid> HittestGrid;
 
    FSlateRenderer* SlateRenderer;
 
    FViewportRHIRef ViewportRHI;
 
    bool bIsDPIScaleEnabled;
};
 
class FDefaultGameMoviePlayer : public FTickableObjectRenderThread, public IGameMoviePlayer,
    public IMoviePlayerProxyServer, public TSharedFromThis<FDefaultGameMoviePlayer>
{
public:
    static void Create()
    {
        check(IsInGameThread() && !IsInSlateThread());
        check(!MoviePlayer.IsValid());
 
        MoviePlayer = MakeShareable(new FDefaultGameMoviePlayer);
    }
 
    static void Destroy()
    {
        check(IsInGameThread() && !IsInSlateThread());
        MoviePlayer.Reset();
    }
 
    static FDefaultGameMoviePlayer* Get();
    ~FDefaultGameMoviePlayer();
 
    virtual void RegisterMovieStreamer(TSharedPtr<IMovieStreamer, ESPMode::ThreadSafe> InMovieStreamer) override;
    virtual void Initialize(FSlateRenderer& InSlateRenderer, TSharedPtr<SWindow> TargetRenderWindow = nullptr) override;
    virtual void Shutdown() override;
    virtual void PassLoadingScreenWindowBackToGame() const override;
    virtual void SetupLoadingScreen(const FLoadingScreenAttributes& LoadingScreenAttributes) override;
    virtual bool HasEarlyStartupMovie() const override;
    virtual bool PlayEarlyStartupMovies() override;
    virtual bool PlayMovie() override;
    virtual void StopMovie() override;
    virtual void WaitForMovieToFinish(bool bAllowEngineTick = false) override;
    virtual bool IsLoadingFinished() const override;
    virtual bool IsMovieCurrentlyPlaying() const override;
    virtual bool LoadingScreenIsPrepared() const override;
    virtual void SetupLoadingScreenFromIni() override;
    virtual void SetViewportDPIScale(float InViewportDPIScale) override;
    
    bool IsInitialized() const override { return bInitialized; }
 
    virtual bool IsStartupMoviePlaying() const override { return IsMoviePlaying; };
 
    virtual FOnPrepareLoadingScreen& OnPrepareLoadingScreen() override { return OnPrepareLoadingScreenDelegate; }
    virtual FOnMoviePlaybackStarted& OnMoviePlaybackStarted() override { return OnMoviePlaybackStartedDelegate; }
    virtual FOnMoviePlaybackTick& OnMoviePlaybackTick() override { return OnMoviePlaybackTickDelegate; }
    virtual FOnMoviePlaybackFinished& OnMoviePlaybackFinished() override { return OnMoviePlaybackFinishedDelegate; }
    virtual FOnMovieClipFinished& OnMovieClipFinished() override { return OnMovieClipFinishedDelegate; }
    
    virtual void BlockingStarted() override;
    virtual void BlockingTick() override;
    virtual void BlockingFinished() override;
    virtual void SetIsSlateThreadAllowed(bool bInIsSlateThreadAllowed) override;
 
    virtual void Tick( FRHICommandListImmediate& RHICmdList, float DeltaTime ) override;
    virtual TStatId GetStatId() const override;
    virtual bool IsTickable() const override;
    
    FReply OnLoadingScreenMouseButtonDown(const FGeometry& Geometry, const FPointerEvent& PointerEvent);
    FReply OnLoadingScreenKeyDown(const FGeometry& Geometry, const FKeyEvent& KeyEvent);
 
    virtual void SetSlateOverlayWidget(TSharedPtr<SWidget> NewOverlayWidget) override;
 
    virtual bool WillAutoCompleteWhenLoadFinishes() override;
 
    virtual FString GetMovieName() override;
    virtual bool IsLastMovieInPlaylist() override;
 
    virtual void ForceCompletion() override;
    virtual void Suspend() override;
    virtual void Resume() override;
 
    virtual void SetIsPlayOnBlockingEnabled(bool bIsEnabled) override;
 
    float GetViewportDPIScale() const;
 
    void OnMainWindowClosed(const TSharedRef<SWindow>& Window);
 
private:
 
    void TickStreamer(FRHICommandListImmediate& RHICmdList, float DeltaTime);
 
    bool MovieStreamingIsPrepared() const;
 
    bool IsMovieStreamingFinished() const;
 
    FVector2D GetMovieSize() const;
    FOptionalSize GetMovieWidth() const;
    FOptionalSize GetMovieHeight() const;
    EVisibility GetSlateBackgroundVisibility() const;
    EVisibility GetViewportVisibility() const;  
    
    void OnPreLoadMap(const FString& LevelName);
 
    void OnPostLoadMap(UWorld* LoadedWorld);
 
    bool CanPlayMovie() const;
private:
    FDefaultGameMoviePlayer();
 
    FReply OnAnyDown();
    
    TArray<TSharedPtr<IMovieStreamer, ESPMode::ThreadSafe>> MovieStreamers;
    TSharedPtr<IMovieStreamer, ESPMode::ThreadSafe> ActiveMovieStreamer;
 
    TWeakPtr<class SWindow> MainWindow;
    TSharedPtr<class SWidget> LoadingScreenContents;
    TSharedPtr<class SBorder> UserWidgetHolder;
    TSharedPtr<class SVirtualWindow> VirtualRenderWindow;
    TWeakPtr<class SViewport> MovieViewportWeakPtr;
 
    class FSlateLoadingSynchronizationMechanism* SyncMechanism;
 
    FThreadSafeCounter MovieStreamingIsDone;
 
    FThreadSafeCounter LoadingIsDone;
 
    bool IsMoviePlaying;
 
    bool bUserCalledFinish;
    
    TAtomic<bool> bMainWindowClosed;
 
    FLoadingScreenAttributes LoadingScreenAttributes;
 
    FOnPrepareLoadingScreen OnPrepareLoadingScreenDelegate;
    
    FOnMoviePlaybackStarted OnMoviePlaybackStartedDelegate;
 
    FOnMoviePlaybackTick OnMoviePlaybackTickDelegate;
 
    FOnMoviePlaybackFinished OnMoviePlaybackFinishedDelegate;
 
    FOnMovieClipFinished OnMovieClipFinishedDelegate;
 
    double LastPlayTime;
 
    bool bInitialized;
 
    bool bIsPlayOnBlockingEnabled;
    bool bIsSlateThreadAllowed;
 
    FCriticalSection SyncMechanismCriticalSection;
 
    TSharedPtr<FMoviePlayerWidgetRenderer, ESPMode::ThreadSafe> WidgetRenderer;
 
    TSharedPtr<class SDPIScaler> UserWidgetDPIScaler;
 
    float ViewportDPIScale;
 
    int32 BlockingRefCount;
    double LastBlockingTickTime;
    FDelegateHandle OnAsyncLoadingFlushUpdateDelegateHandle;
 
private:
    static TSharedPtr<FDefaultGameMoviePlayer> MoviePlayer;
};