Navigation
API > API/Plugins > API/Plugins/TmvMedia
Defines the layout and format of a video frame memory plane.
A memory plane is one contiguous memory region that can contain more than one component. Ex: NV12 has a packed UV plane (semi-planar formats), or IMC2 has interleaved U and V scan lines in a single memory plane.
A "sample" is an element of the current plane (interleaved or not).
No start offset is provided, we assume the valid pixels start at offset 0 in the plane. The stride is the offset between the start of 2 scan lines, includes padding and interleaved components.
If there is padding between planes, it is included in the extra lines (see NumLines). It is assumed those extra lines are at the end of the plane buffer.
| Name | FTmvMediaFramePlaneInfo |
| Type | struct |
| Header File | /Engine/Plugins/Media/TmvMedia/Source/TmvMedia/Public/TmvMediaFrameInfo.h |
| Include Path | #include "TmvMediaFrameInfo.h" |
Syntax
struct FTmvMediaFramePlaneInfo
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BitDepth | uint8 | Number of bits per component of this plane. | TmvMediaFrameInfo.h | |
| ComponentLayout | ETmvMediaFrameComponentLayout | Defines the component layout within the plane. | TmvMediaFrameInfo.h | |
| Height | uint32 | Number of vertical samples in this plane. | TmvMediaFrameInfo.h | |
| HeightRatio | int8 | Height ratio defined as Frame Height / Plane Height. | TmvMediaFrameInfo.h | |
| NumComponents | uint8 | Number of components packed per sample in this plane. | TmvMediaFrameInfo.h | |
| NumLines | uint32 | Number of scan lines in this plane. | TmvMediaFrameInfo.h | |
| Stride | uint32 | Number of memory bytes per scan line of this memory plane. | TmvMediaFrameInfo.h | |
| Type | ETmvMediaFrameComponentType | Defines the components data type. Used by the sampler converter. | TmvMediaFrameInfo.h | |
| Width | uint32 | Number of horizontal samples in this plane. | TmvMediaFrameInfo.h | |
| WidthRatio | int8 | Width ratio defined as Frame Width / Plane Width. | TmvMediaFrameInfo.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
uint32 GetBytesPerComponent () |
Returns the number of bytes per component for this memory plane. | TmvMediaFrameInfo.h | |
SIZE_T GetMemorySizeInBytes() |
Returns the memory size in bytes of this memory plane. | TmvMediaFrameInfo.h | |
uint32 GetStartComponentOffsetInBytes
(
int32 InComponentIndexInPlane |
Computes the offset, in bytes, to the start of the given component in the plane buffer. | TmvMediaFrameInfo.h |