Detailed Description

FVID2 video buffer format specification.

Defines the format capabilities of the buffer like dataformat, scanFormat, width, height etc. Used during Fvid2_create() by some drivers. Used as parameter to Fvid2_setFormat(), Fvid2_getFormat() by some drivers.

Data Fields
uint32_t	chNum

uint32_t	width

uint32_t	height

uint32_t	pitch [FVID2_MAX_PLANES]

uint32_t	fieldMerged [FVID2_MAX_PLANES_PER_FIELD]

uint32_t	dataFormat

uint32_t	scanFormat

uint32_t	ccsFormat

Field Documentation

◆ chNum

uint32_t Fvid2_Format::chNum

Channel Number to which this format belongs to.

◆ width

uint32_t Fvid2_Format::width

Width of the video frame or field in pixels.

◆ height

uint32_t Fvid2_Format::height

Height of the video frame or field in lines.

◆ pitch

uint32_t Fvid2_Format::pitch[FVID2_MAX_PLANES]

Pitch in bytes for each of the sub-buffers. This represents the difference between two consecutive line addresses in bytes. This is irrespective of whether the video is interlaced or progressive and whether the fields are merged or separated for interlaced video.

◆ fieldMerged

uint32_t Fvid2_Format::fieldMerged[FVID2_MAX_PLANES_PER_FIELD]

This field tells whether both the fields have to be merged, i.e line interleaved or not. Used only for interlaced format. The effective pitch is calculated based on this information along with pitch parameter. If fields are merged, effective pitch = pitch * 2 else effective pitch = pitch.

◆ dataFormat

uint32_t Fvid2_Format::dataFormat

Frame data Format. For valid values see Fvid2_DataFormat.

◆ scanFormat

uint32_t Fvid2_Format::scanFormat

Scan Format. For valid values see Fvid2_ScanFormat.

◆ ccsFormat

uint32_t Fvid2_Format::ccsFormat

Color Component Storage format. For valid values see Fvid2_ColorCompStorageFmt.