SubtitleManager.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Engine/EngineTypes.h"
#include "UObject/ObjectKey.h"
 
#define SUBTITLE_SCREEN_DEPTH_FOR_3D 0.1f
 
class FCanvas;
 
DECLARE_MULTICAST_DELEGATE_OneParam(FSubtitleManagerSetSubtitleText, const FText& /* SubtitleText */)
 
 
class FActiveSubtitle
{
public:
 
    FActiveSubtitle(int32 InIndex, float InPriority, bool InbSplit, bool InbSingleLine, TArray<FSubtitleCue> InSubtitles)
        : Index(InIndex)
        , Priority(InPriority)
        , bSplit(InbSplit)
        , bSingleLine(InbSingleLine)
        , Subtitles(MoveTemp(InSubtitles))
    { }
 
    int32 Index;
 
    float Priority;
    
    bool bSplit;
    
    bool bSingleLine;
    
    TArray<FSubtitleCue>    Subtitles;
};
 
 
struct FQueueSubtitleParams
{
    FQueueSubtitleParams(const TArray<FSubtitleCue>& InSubtitles)
        : Subtitles(InSubtitles)
    { }
 
    uint64 AudioComponentID;
    TWeakObjectPtr<UWorld> WorldPtr;
    PTRINT WaveInstance;
    float SubtitlePriority;
    float Duration;
    uint8 bManualWordWrap : 1;
    uint8 bSingleLine : 1;
    const TArray<FSubtitleCue>& Subtitles;
    float RequestedStartTime;
};
 
 
class FSubtitleManager
{
public:
 
    void KillAllSubtitles(void);
 
    void KillSubtitles(PTRINT SubtitleID);
 
    void TrimRegionToSafeZone(FCanvas* Canvas, FIntRect& InOutSubtitleRegion);
 
    void SplitLinesToSafeZone(FCanvas* Canvas, FIntRect & SubtitleRegion);
 
    PTRINT FindHighestPrioritySubtitle(float CurrentTime);
 
    ENGINE_API void QueueSubtitles(PTRINT SubtitleID, float Priority, bool bManualWordWrap, bool bSingleLine, float SoundDuration, const TArray<FSubtitleCue>& Subtitles, float InStartTime, float InCurrentTime);
 
    static void QueueSubtitles(const FQueueSubtitleParams& QueueSubtitlesParams);
 
    void DisplaySubtitle(FCanvas* Canvas, FActiveSubtitle* Subtitle, FIntRect & Parms, const FLinearColor& Color);
 
    ENGINE_API void DisplaySubtitles(FCanvas* InCanvas, FIntRect & SubtitleRegion, float InAudioTimeSeconds);
 
    bool HasSubtitles() 
    { 
        return (ActiveSubtitles.Num() > 0); 
    }
 
    float GetCurrentSubtitlesHeight()
    {
        return CurrentSubtitleHeight;
    }
 
    ENGINE_API static FSubtitleManager* GetSubtitleManager();
 
    FSubtitleManagerSetSubtitleText&  OnSetSubtitleText() { return OnSetSubtitleTextDelegate; }
 
    void ENGINE_API SetMovieSubtitle(UObject* SubtitleOwner, const TArray<FString>& Subtitles);
 
private:
 
    void DisplaySubtitle_ToDisplays(FActiveSubtitle* Subtitle);
 
    FString SubtitleCuesToString(FActiveSubtitle* Subtitle);
 
private:
 
    FSubtitleManagerSetSubtitleText OnSetSubtitleTextDelegate;
 
    TMap<PTRINT, FActiveSubtitle> ActiveSubtitles;
 
    float CurrentSubtitleHeight = 0;
 
    TMap<FObjectKey, TSharedPtr<FActiveSubtitle>> ActiveMovieSubtitles;
};