TimecodeRegressionProvider.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Engine/TimecodeProvider.h"
#include "Estimation/TimecodeEstimator.h"
#include "TimecodeRegressionProvider.generated.h"
 
#define UE_API TIMEMANAGEMENT_API
 
class UEngineCustomTimeStep;
 
UCLASS(MinimalAPI)
class UTimecodeRegressionProvider : public UTimecodeProvider
{
    GENERATED_BODY()
public:
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Settings", meta = (ClampMin = 1, ClampMax = 65536, UIMin = 1, UIMax = 65536))
    int32 NumSampledFrames = 60;
 
    static UE_API bool SupportsTimestep(UEngineCustomTimeStep* InTimestep);
 
    UE_API void SetTimecodeImplementation(UTimecodeProvider* InTimecodeImpl);
 
    UE_API TOptional<FQualifiedFrameTime> GetLastSampledFrameTime() const;
 
    UTimecodeProvider* GetUnderlyingTimecodeProvider() const
    {
        return TimecodeImpl;
    }
 
    //~ Begin UTimecodeProvider Interface
    virtual bool FetchTimecode(FQualifiedFrameTime& OutFrameTime) override
    {
        return TimecodeImpl->FetchTimecode(OutFrameTime);
    }
    UE_API virtual void FetchAndUpdate() override;
    UE_API virtual FQualifiedFrameTime GetQualifiedFrameTime() const override;
    UE_API virtual ETimecodeProviderSynchronizationState GetSynchronizationState() const override;
    UE_API virtual bool Initialize(UEngine* InEngine) override;
    UE_API virtual void Shutdown(UEngine* InEngine) override;
    virtual bool SupportsAutoDetected() const override
    {
        return TimecodeImpl->SupportsAutoDetected();
    }
    virtual void SetIsAutoDetected(bool bInIsAutoDetected) override
    {
        TimecodeImpl->SetIsAutoDetected(bInIsAutoDetected);
    }
    virtual bool IsAutoDetected() const override
    {
        return TimecodeImpl->IsAutoDetected();
    }
    //~ End UTimecodeProvider Interface
 
private:
 
    UPROPERTY()
    TObjectPtr<UEngine> OwningEngine;
    UPROPERTY()
    TObjectPtr<UTimecodeProvider> TimecodeImpl;
 
    struct FTimecodeEstimationState
    {
        UE::TimeManagement::TimecodeEstimation::FTimecodeEstimator TimecodeEstimator;
 
        TOptional<UE::TimeManagement::TimecodeEstimation::FFetchAndUpdateStats> LastUpdateStats;
 
        explicit FTimecodeEstimationState(
            SIZE_T InNumSamples, UTimecodeProvider& InTimecode UE_LIFETIMEBOUND, IClockedTimeStep& InEngineCustomTimeStep UE_LIFETIMEBOUND
            )
            : TimecodeEstimator(InNumSamples, InTimecode, InEngineCustomTimeStep)
        {}
    };
    TOptional<FTimecodeEstimationState> EstimationState;
 
    bool IsInitialized() const
    {
        return OwningEngine != nullptr;
    }
 
    void OnCustomTimeStepChanged() { ReinitRegressionBuffer(); }
 
    UE_API void ReinitRegressionBuffer();
};
 
#undef UE_API