LiveLinkVirtualSubject.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "CoreTypes.h"
#include "HAL/CriticalSection.h"
#include "ILiveLinkSubject.h"
#include "LiveLinkFrameTranslator.h"
#include "LiveLinkTypes.h"
#include "Templates/SubclassOf.h"
#include "UObject/NameTypes.h"
#include "UObject/Object.h"
#include "UObject/ObjectMacros.h"
#include "UObject/ObjectPtr.h"
#include "UObject/UObjectGlobals.h"
 
#include "LiveLinkVirtualSubject.generated.h"
 
class ILiveLinkClient;
class ULiveLinkRole;
 
 
 
// A Virtual subject is made up of one or more real subjects from a source
UCLASS(Abstract, MinimalAPI)
class ULiveLinkVirtualSubject : public UObject, public ILiveLinkSubject
{
    GENERATED_BODY()
 
    //~ Begin ILiveLinkSubject Interface
public:
    LIVELINKINTERFACE_API virtual void Initialize(FLiveLinkSubjectKey SubjectKey, TSubclassOf<ULiveLinkRole> Role, ILiveLinkClient* LiveLinkClient) override;
    LIVELINKINTERFACE_API virtual void Update() override;
    LIVELINKINTERFACE_API virtual bool EvaluateFrame(TSubclassOf<ULiveLinkRole> InDesiredRole, FLiveLinkSubjectFrameData& OutFrame) override;
    LIVELINKINTERFACE_API virtual void ClearFrames() override;
    virtual FLiveLinkSubjectKey GetSubjectKey() const override { return SubjectKey; }
    virtual TSubclassOf<ULiveLinkRole> GetRole() const override { return Role; }
    LIVELINKINTERFACE_API virtual bool HasValidFrameSnapshot() const override;
    virtual FLiveLinkStaticDataStruct& GetStaticData(bool bGetOverrideData=true) override { return CurrentFrameSnapshot.StaticData; }
    virtual const FLiveLinkStaticDataStruct& GetStaticData() const override { return CurrentFrameSnapshot.StaticData; }
    virtual const TArray<ULiveLinkFrameTranslator::FWorkerSharedPtr> GetFrameTranslators() const override { return CurrentFrameTranslators; }
    virtual const ULiveLinkSubjectRemapper::FWorkerSharedPtr GetFrameRemapper() const override { return CurrentSubjectRemapper; }
    LIVELINKINTERFACE_API virtual TArray<FLiveLinkTime> GetFrameTimes() const override;
    virtual bool IsRebroadcasted() const override { return bRebroadcastSubject; }
    virtual bool HasStaticDataBeenRebroadcasted() const override { return bHasStaticDataBeenRebroadcast; }
    virtual void SetStaticDataAsRebroadcasted(const bool bInSent) override { bHasStaticDataBeenRebroadcast = bInSent; }
    LIVELINKINTERFACE_API virtual bool IsPaused() const override;
    LIVELINKINTERFACE_API virtual void PauseSubject() override;
    LIVELINKINTERFACE_API virtual void UnpauseSubject() override;
 
protected:
    virtual const FLiveLinkSubjectFrameData& GetFrameSnapshot() const override { return CurrentFrameSnapshot; }
    //~ End ILiveLinkSubject Interface
 
    LIVELINKINTERFACE_API bool HasValidStaticData() const;
 
    LIVELINKINTERFACE_API bool HasValidFrameData() const;
 
public:
    //~ Begin UObject interface
#if WITH_EDITOR
    LIVELINKINTERFACE_API virtual void PostEditChangeProperty(struct FPropertyChangedEvent& PropertyChangedEvent) override;
#endif
    //~ End UObject interface
 
    ILiveLinkClient* GetClient() const { return LiveLinkClient; }
 
    const TArray<FLiveLinkSubjectName>& GetSubjects() const { return Subjects; }
 
    const TArray<ULiveLinkFrameTranslator*>& GetTranslators() const { return FrameTranslators; }
 
    const FLiveLinkFrameDataStruct& GetFrameData() const { return CurrentFrameSnapshot.FrameData; }
 
    LIVELINKINTERFACE_API virtual bool DependsOnSubject(FName SubjectName) const;
    
    virtual FText GetDisplayName() const
    {
        return FText::FromName(SubjectKey.SubjectName);
    }
 
    virtual FName GetRebroadcastName() const
    {
        return SubjectKey.SubjectName;
    }
 
public:
    UPROPERTY(EditAnywhere, Category = "LiveLink")
    FLiveLinkSubjectName SyncSubject;
 
protected:
 
    LIVELINKINTERFACE_API void UpdateTranslatorsForThisFrame();
 
    LIVELINKINTERFACE_API void UpdateStaticDataSnapshot(FLiveLinkStaticDataStruct&& NewStaticData);
 
    LIVELINKINTERFACE_API void UpdateFrameDataSnapshot(FLiveLinkFrameDataStruct&& NewFrameData);
 
    LIVELINKINTERFACE_API void InvalidateStaticData();
 
    LIVELINKINTERFACE_API void InvalidateFrameData();
 
protected:
    UPROPERTY()
    TSubclassOf<ULiveLinkRole> Role;
 
    UPROPERTY(EditAnywhere, Category = "LiveLink")
    TArray<FLiveLinkSubjectName> Subjects;
 
    UPROPERTY(EditAnywhere, Instanced, Category = "LiveLink", meta=(DisplayName="Translators"))
    TArray<TObjectPtr<ULiveLinkFrameTranslator>> FrameTranslators;
 
    UPROPERTY(EditAnywhere, Category = "LiveLink")
    bool bRebroadcastSubject = false;
 
    ILiveLinkClient* LiveLinkClient;
 
    UE_DEPRECATED(4.27, "VirtualSubject FrameSnapshot is now private to have thread safe accesses. Please use UpdateStaticDataSnapshot or UpdateFrameDataSnapshot to update its value")
    FLiveLinkSubjectFrameData FrameSnapshot;
 
    FLiveLinkSubjectKey SubjectKey;
    
    bool bHasStaticDataBeenRebroadcast = false;
 
    mutable FCriticalSection SnapshotAccessCriticalSection;
 
private:
    bool ValidateTranslators();
 
private:
    TArray<ULiveLinkFrameTranslator::FWorkerSharedPtr> CurrentFrameTranslators;
    ULiveLinkSubjectRemapper::FWorkerSharedPtr CurrentSubjectRemapper;
 
    FLiveLinkSubjectFrameData CurrentFrameSnapshot;
 
    std::atomic<bool> bPaused = false;
};