MediaTextureResource.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Containers/Queue.h"
#include "Math/Color.h"
#include "MediaSampleSource.h"
#include "Misc/Guid.h"
#include "Misc/Timespan.h"
#include "Templates/RefCounting.h"
#include "Templates/SharedPointer.h"
#include "TextureResource.h"
#include "UnrealClient.h"
#include "IMediaTimeSource.h"
#include "RHIResources.h"
#include "Async/Async.h"
#include "RenderingThread.h"
#include "RendererInterface.h"
#include "ColorManagement/ColorSpace.h"
 
class FMediaPlayerFacade;
class IMediaPlayer;
class IMediaTextureSample;
class UMediaTexture;
struct FGenerateMipsStruct;
struct FPriorSamples;
 
enum class EMediaTextureSinkFormat;
enum class EMediaTextureSinkMode;
 
namespace UE::MediaTexture::Private
{
    uint8 ClampNumMips(uint8 InNumMips, const FIntPoint& InDim);
 
    uint8 CalcGeneratedNumMips(const IMediaTextureSample& InSample, bool bInEnableGenMips);
 
    uint8 CalcTextureNumMips(const IMediaTextureSample& InSample, bool bInEnableGenMips);
}
 
class FMediaTextureResource
    : public FRenderTarget
    , public FTextureResource
{
public:
 
    MEDIAASSETS_API FMediaTextureResource(UMediaTexture& InOwner, FIntPoint& InOwnerDim, SIZE_T& InOwnerSize, FLinearColor InClearColor, FGuid InTextureGuid, bool bEnableGenMips, uint8 InNumMips, UE::Color::EColorSpace OverrideColorSpaceType);
 
    virtual ~FMediaTextureResource() 
    {
    }
 
public:
 
    struct FRenderParams
    {
        PRAGMA_DISABLE_DEPRECATION_WARNINGS
        FRenderParams() = default;
        FRenderParams(const FRenderParams& InOther) = default;
        FRenderParams(FRenderParams&& InOther) = default;
        FRenderParams& operator=(const FRenderParams&) = default;
        FRenderParams& operator=(FRenderParams&&) = default;
        PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
        bool CanClear;
 
        FLinearColor ClearColor;
 
        FGuid CurrentGuid;
 
        FGuid PreviousGuid;
 
        float Rate;
 
        TWeakPtr<FMediaTextureSampleSource, ESPMode::ThreadSafe> SampleSource;
 
        UE_DEPRECATED(5.6, "Unused since UMediaTexture NumMips is now deprecated.")
        uint8 NumMips;
 
        FMediaTimeStamp Time;
 
        TSharedPtr<IMediaTextureSample, ESPMode::ThreadSafe> TextureSample;
    };
 
    void Render(const FRenderParams& Params);
 
    void FlushPendingData();
 
    void SetJustInTimeRenderParams(const FRenderParams& InJustInTimeRenderParams);
 
    void ResetJustInTimeRenderParams();
 
    void JustInTimeRender();
    
public:
 
    //~ FRenderTarget interface
 
    virtual FIntPoint GetSizeXY() const override;
 
public:
 
    //~ FTextureResource interface
 
    virtual FString GetFriendlyName() const override;
    virtual uint32 GetSizeX() const override;
    virtual uint32 GetSizeY() const override;
    virtual void InitRHI(FRHICommandListBase& RHICmdList) override;
    virtual void ReleaseRHI() override;
 
protected:
 
    void ClearTexture(FRHICommandListImmediate& RHICmdList, const FLinearColor& ClearColor, bool SrgbOutput);
 
    void ConvertSample(FRHICommandListImmediate& RHICmdList, const TSharedPtr<IMediaTextureSample, ESPMode::ThreadSafe>& Sample, const FLinearColor& ClearColor, uint8 InTargetNumMips);
 
    void ConvertTextureToOutput(FRHICommandListImmediate& RHICmdList, FRHITexture* InputTexture, const TSharedPtr<IMediaTextureSample, ESPMode::ThreadSafe>& Sample);
 
    void CopySample(FRHICommandListImmediate& RHICmdList, const TSharedPtr<IMediaTextureSample, ESPMode::ThreadSafe>& Sample, const FLinearColor& ClearColor, uint8 InTargetNumMips, const FGuid & TextureGUID);
 
    void UpdateResourceSize();
 
    void UpdateTextureReference(FRHICommandListImmediate& RHICmdList, FRHITexture* NewTexture);
 
    void CreateIntermediateRenderTarget(FRHICommandListImmediate& RHICmdList, const FIntPoint & InDim, EPixelFormat InPixelFormat, bool bInSRGB, const FLinearColor & InClearColor, uint8 InNumMips, bool bNeedsUAVSupport);
    
    void CacheNextAvailableSampleTime(const TSharedPtr<FMediaTextureSampleSource, ESPMode::ThreadSafe>& InSampleQueue) const;
 
    void SetupSampler();
 
    void CopyFromExternalTexture(FRHICommandListImmediate& RHICmdList, const TSharedPtr <IMediaTextureSample, ESPMode::ThreadSafe>& Sample, const FGuid & TextureGUID);
 
    bool RequiresConversion(const TSharedPtr<IMediaTextureSample, ESPMode::ThreadSafe>& Sample, uint8 InTargetNumMips) const;
    bool RequiresConversion(const FTextureRHIRef& SampleTexture, const FIntPoint & OutputDim, uint8 InTargetNumMips) const;
 
    void GetColorSpaceConversionMatrixForSample(const TSharedPtr<IMediaTextureSample, ESPMode::ThreadSafe> Sample, FMatrix44f& ColorSpaceMtx);
 
private:
 
    bool bUsesImageExternal;
 
    bool Cleared;
 
    FLinearColor CurrentClearColor;
 
    FGuid InitialTextureGuid;
 
    TRefCountPtr<FRHITexture> InputTarget;
 
    TRefCountPtr<FRHITexture> IntermediateTarget;
 
    TRefCountPtr<FRHITexture> OutputTarget;
 
    UMediaTexture& Owner;
 
    FIntPoint& OwnerDim;
 
    SIZE_T& OwnerSize;
 
    bool bEnableGenMips;
 
    uint8 CurrentNumMips;
 
    ESamplerFilter CurrentSamplerFilter;
 
    float CurrentMipMapBias;
 
    TWeakPtr<FMediaPlayerFacade, ESPMode::ThreadSafe> PlayerFacadePtr;
 
    TSharedPtr<IMediaTextureSample, ESPMode::ThreadSafe> CurrentSample;
 
    TSharedRef<FPriorSamples, ESPMode::ThreadSafe> PriorSamples;
    FCriticalSection PriorSamplesCS;
 
    TRefCountPtr<IPooledRenderTarget> MipGenerationCache;
 
    TUniquePtr<FRenderParams> JustInTimeRenderParams;
 
    TUniquePtr<UE::Color::FColorSpace> OverrideColorSpace;
 
    bool bRecreateOutputTarget = false;
};