ITimedDataInput.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "CoreMinimal.h"
#include "Delegates/Delegate.h"
#include "HAL/Platform.h"
#include "Internationalization/Text.h"
#include "Misc/FrameRate.h"
#include "Misc/FrameTime.h"
#include "Misc/QualifiedFrameTime.h"
#include "UObject/ObjectMacros.h"
 
#include "ITimedDataInput.generated.h"
 
class ITimedDataInput;
class ITimedDataInputChannel;
class SWidget;
struct FSlateBrush;
 
 
UENUM()
enum class ETimedDataInputEvaluationType : uint8
{
    None,
    Timecode,
    PlatformTime,
};
 
UENUM()
enum class ETimedDataInputState : uint8
{
    Connected,
    Unresponsive,
    Disconnected,
};
 
 
USTRUCT(BlueprintType)
struct FTimedDataChannelSampleTime
{
    GENERATED_BODY()
 
    FTimedDataChannelSampleTime() = default;
    FTimedDataChannelSampleTime(double InPlatformSeconds, const FQualifiedFrameTime& InTimecode)
        : PlatformSecond(InPlatformSeconds), Timecode(InTimecode)
    { }
    double PlatformSecond = 0.0;
    FQualifiedFrameTime Timecode;
 
    double AsSeconds(ETimedDataInputEvaluationType EvaluationType) const { return EvaluationType == ETimedDataInputEvaluationType::Timecode ? Timecode.AsSeconds() : PlatformSecond; }
};
 
 
USTRUCT(BlueprintType)
struct FTimedDataInputEvaluationData
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadWrite, Category = "Evaluation", meta=(Units=s))
    float DistanceToNewestSampleSeconds = 0.0f;
    
    UPROPERTY(BlueprintReadWrite, Category = "Evaluation", meta = (Units = s))
    float DistanceToOldestSampleSeconds = 0.0f;
};
 
 
class ITimedDataInput
{
public:
    static TIMEMANAGEMENT_API FFrameRate UnknownFrameRate;
    
    static TIMEMANAGEMENT_API double ConvertSecondOffsetInFrameOffset(double Seconds, FFrameRate Rate);
    static TIMEMANAGEMENT_API double ConvertFrameOffsetInSecondOffset(double Frames, FFrameRate Rate);
    
public:
    virtual ~ITimedDataInput() {}
    
    virtual FText GetDisplayName() const = 0;
 
    virtual TArray<ITimedDataInputChannel*> GetChannels() const = 0;
 
    virtual ETimedDataInputEvaluationType GetEvaluationType() const = 0;
 
    virtual void SetEvaluationType(ETimedDataInputEvaluationType Evaluation) = 0;
 
    virtual double GetEvaluationOffsetInSeconds() const = 0;
 
    virtual void SetEvaluationOffsetInSeconds(double Offset) = 0;
 
    virtual FFrameRate GetFrameRate() const = 0;
 
    virtual bool IsDataBufferSizeControlledByInput() const = 0;
 
    virtual int32 GetDataBufferSize() const { return 0; }
 
    virtual void SetDataBufferSize(int32 BufferSize) { }
    
    virtual void AddChannel(ITimedDataInputChannel* Channel) = 0;
 
    virtual void RemoveChannel(ITimedDataInputChannel* Channel) = 0;
 
    virtual bool SupportsSubFrames() const
    {
        return true;
    }
 
    TIMEMANAGEMENT_API double ConvertSecondOffsetInFrameOffset(double Seconds) const;
 
    TIMEMANAGEMENT_API double ConvertFrameOffsetInSecondOffset(double Frames) const;
 
#if WITH_EDITOR
    virtual const FSlateBrush* GetDisplayIcon() const = 0;
#endif
};
 
 
class ITimedDataInputChannel
{
public:
    virtual FText GetDisplayName() const = 0;
 
    virtual ETimedDataInputState GetState() const = 0;
 
    virtual FTimedDataChannelSampleTime GetOldestDataTime() const = 0;
 
    virtual FTimedDataChannelSampleTime GetNewestDataTime() const = 0;
 
    virtual TArray<FTimedDataChannelSampleTime> GetDataTimes() const = 0;
 
    virtual int32 GetNumberOfSamples() const = 0;
 
    virtual int32 GetDataBufferSize() const { return 0; }
 
    virtual void SetDataBufferSize(int32 BufferSize) {}
 
    virtual bool IsBufferStatsEnabled() const = 0;
 
    virtual void SetBufferStatsEnabled(bool bEnable) = 0;
    
    virtual int32 GetBufferUnderflowStat() const = 0;
 
    virtual int32 GetBufferOverflowStat() const = 0;
 
    virtual int32 GetFrameDroppedStat() const = 0;
 
    virtual void GetLastEvaluationData(FTimedDataInputEvaluationData& OutEvaluationData) const = 0;
 
    virtual void ResetBufferStats() = 0;
};