1. Epic GamesDeveloper
  3. FMediaIOCoreTextureSampleBase

FMediaIOCoreTextureSampleBase

Implements the IMediaTextureSample/IMediaPoolable interface.

API > API/Plugins > API/Plugins/MediaIOCore

Inheritance Hierarchy

References

   
Module MediaIOCore
Header /Engine/Plugins/Media/MediaIOFramework/Source/MediaIOCore/Public/MediaIOCoreTextureSampleBase.h
Include #include "MediaIOCoreTextureSampleBase.h"

Syntax

class FMediaIOCoreTextureSampleBase :  
    public IMediaTextureSample ,  
    public IMediaPoolable ,  
    public IMediaTextureSampleColorConverter

Remarks

Implements the IMediaTextureSample/IMediaPoolable interface.

Variables

  Type Name Description
Protected variable bool bIsSRGBInput Whether the sample is in sRGB space and requires an explicit conversion to linear
Protected variable TArray< uint8, TAlignedHeapAllocator< 4096 > > Buffer Pointer to raw pixels
Protected variable UE::Color::FColorSpace ColorSpaceStruct Color space structure of the incoming texture. Used for retrieving chromaticities.
Protected variable UE::Color::EColorSpace ColorSpaceType Color space enum of the incoming texture.
Protected variable TSharedPtr< FMediaIOCoreTextureSampleConverter > Converter Custom converter that will be the one checking back with the player for just in time sample render purposes
Protected variable FTimespan Duration Duration for which the sample is valid.
Protected variable UE::Color::EEncoding Encoding Color encoding of the incoming texture.
Protected variable void * ExternalBuffer  
Protected variable std::atomic< uint64 > FrameNumber Which engine frame number this sample corresponds to.
Protected variable uint32 Height  
Protected variable TWeakPtr< FMediaIOCorePlayerBase > Player The player that created this sample
Protected variable EMediaTextureSampleFormat SampleFormat Sample format.
Protected variable uint32 Stride Image dimensions
Protected variable FTimespan Time Sample time.
Protected variable TOptional< FTimecode > Timecode Sample timecode.
Protected variable uint32 Width  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Protected function void Method that caches color conversion settings on Game thread.
Public function Virtual void Copies all neccessary data from a source sample to render JIT
Protected function Virtual void  
Public function Virtual Const UE::Color::EColorSpace Method that returns this sample's colorspace type.
Public function Const double Returns time evaluated on the game thread for JITR
Public function Virtual Const uint64  
Public function void *  
Public function Virtual void *

GetOrRequestBuffer ( uint32 InBufferSize
)

 Attemps to get the initialized buffer.
Public function EPixelFormat  
Public function Const TSharedPtr< FMediaIOCorePlayerBase > Returns the player that created this sample
Public function bool

Initialize ( const void* InVideoBuffer,
uint32 InBufferSize,
uint32 InStride,
uint32 InWidth,
uint32 InHeight,
EMediaTextureSampleFormat InSampleFormat,
FTimespan InTime,
const FFrameRate& InFrameRate,
const TOptional< FTimecode >& InTimecode,
const UE::MediaIOCore::FColorFormatArgs& InColorFormatArgs
)

 Initialize the sample.
Public function bool

Initialize ( TArray< uint8 >&& InVideoBuffer,
uint32 InStride,
uint32 InWidth,
uint32 InHeight,
EMediaTextureSampleFormat InSampleFormat,
FTimespan InTime,
const FFrameRate& InFrameRate,
const TOptional< FTimecode >& InTimecode,
const UE::MediaIOCore::FColorFormatArgs& InColorFormatArgs
)

 Initialize the sample.
Public function bool

Initialize ( const TArray< uint8 >& InVideoBuffer,
uint32 InStride,
uint32 InWidth,
uint32 InHeight,
EMediaTextureSampleFormat InSampleFormat,
FTimespan InTime,
const FFrameRate& InFrameRate,
const TOptional< FTimecode >& InTimecode,
const UE::MediaIOCore::FColorFormatArgs& InColorFormatArgs
)

 Initialize the sample.
Public function Virtual bool Configure this sample for JITR
Public function bool

InitializeWithEvenOddLine ( bool bUseEvenLine,
const void* InVideoBuffer,
uint32 InBufferSize,
uint32 InStride,
uint32 InWidth,
uint32 InHeight,
EMediaTextureSampleFormat InSampleFormat,
FTimespan InTime,
const FFrameRate& InFrameRate,
const TOptional< FTimecode >& InTimecode,
const UE::MediaIOCore::FColorFormatArgs& InColorFormatArgs
)

 Initialize the sample with half it's original height and take only the odd or even line.
Public function Const bool Returns whether it's ready for GPUDirect texture transfer
Public function Virtual void *

RequestBuffer ( uint32 InBufferSize
)

 Request an uninitialized sample buffer.
Public function void

SetAwaitingForGPUTransfer ( bool bIsAwaitingGPUTransfer
)

 Marks this sample as one that is ready and awaiting for fast GPUDirect texture transfer
Public function bool

SetBuffer ( TArray< uint8 >&& InVideoBuffer
)

 Set the sample buffer.
Public function bool

SetBuffer ( const TArray< uint8 >& InVideoBuffer
)

 Set the sample buffer.
Public function bool

SetBuffer ( const void* InVideoBuffer,
uint32 InBufferSize
)

 Initialize the sample.
Public function void

SetBuffer ( void* InBuffer
)

  
Public function bool

SetBufferWithEvenOddLine ( bool bUseEvenLine,
const void* InVideoBuffer,
uint32 InBufferSize,
uint32 InStride,
uint32 InHeight
)

 Set the sample buffer with half it's original height and take only the odd or even line.
Public function void Set the OCIO settings used for color conversion.
Public function void

SetDestructionCallback ( TFunction< void(TRefCountPtr< FRHITexture >)> InDestructionCallback
)

  
Public function Virtual void

SetFrameNumber ( uint32 InFrameNumber
)

  
Public function bool

SetProperties ( uint32 InStride,
uint32 InWidth,
uint32 InHeight,
EMediaTextureSampleFormat InSampleFormat,
FTimespan InTime,
const FFrameRate& InFrameRate,
const TOptional< FTimecode >& InTimecode,
const UE::MediaIOCore::FColorFormatArgs& InColorFormatArgs
)

 Set the sample properties.
Public function void

SetTexture ( TRefCountPtr< FRHITexture > InRHITexture
)

  
Public function Virtual void

SetTime ( const FTimespan& InTime
)

  

Overridden from IMediaTextureSample

  Type Name Description
Public function Virtual const void * Get the sample's frame buffer.
Public function Virtual Const FIntPoint

GetDim ()

 Get the width and height of the sample.
Public function Virtual Const FTimespan Get the amount of time for which the sample is valid.
Public function Virtual Const UE::Color::EEncoding Get EOTF / "Gamma" / encoding type of data
Public function Virtual Const EMediaTextureSampleFormat Get the texture sample format.
Public function Virtual Const float Get factor to normalize data from nits to scene color values
Public function Virtual Const FIntPoint Get the sample's desired output width and height.
Public function Virtual Const const UE::Color::FColorSpace & Get sample source color space (defaults to the sRGB/Rec709 gamut)
Public function Virtual Const uint32 Get the horizontal stride (aka. pitch) of the sample's frame buffer.
Public function Virtual Const FMediaTimeStamp

GetTime ()

 Get the sample time (in the player's local clock).
Public function Virtual Const TOptional< FTimecode > Get the sample timecode if available.
Protected function Virtual Const const FMatrix & Get YUV to RGB conversion matrix
Public function Virtual Const bool Whether the sample can be held in a cache.
Public function Virtual Const bool Whether the output of the sample is in sRGB color space.

Overridden from IMediaPoolable

  Type Name Description
Public function Virtual void Called when the object added to the pool.

Overridden from IMediaTextureSampleColorConverter

  Type Name Description
Public function Virtual bool

ApplyColorConversion ( FRHICommandListImmediate& RHICmdList,
FTextureRHIRef& InSrcTexture,
FTextureRHIRef& InDstTexture
)

 Apply a color conversion on the input and store the result in the destination texture.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page