QVideoFrameFormat

The QVideoFrameFormat class specifies the stream format of a video presentation surface. More

Inheritance diagram of PySide6.QtMultimedia.QVideoFrameFormat

New in version 6.1.

Synopsis

Functions

Static functions

Detailed Description

A video sink presents a stream of video frames. QVideoFrameFormat describes the type of the frames and determines how they should be presented.

The core properties of a video stream required to setup a video sink are the pixel format given by pixelFormat() , and the frame dimensions given by frameSize() .

The region of a frame that is actually displayed on a video surface is given by the viewport() . A stream may have a viewport less than the entire region of a frame to allow for videos smaller than the nearest optimal size of a video frame. For example the width of a frame may be extended so that the start of each scan line is eight byte aligned.

Other common properties are the scanLineDirection() , frameRate() and the yCrCbColorSpace().

class PySide6.QtMultimedia.QVideoFrameFormat

PySide6.QtMultimedia.QVideoFrameFormat(size, pixelFormat)

PySide6.QtMultimedia.QVideoFrameFormat(format)

Parameters

Constructs a null video frame format.

Constructs a video frame format with given frame size and pixel format.

PySide6.QtMultimedia.QVideoFrameFormat.PixelFormat

Enumerates video data types.

Constant

Description

QVideoFrameFormat.Format_Invalid

The frame is invalid.

QVideoFrameFormat.Format_ARGB8888

The frame is stored using a ARGB format with 8 bits per component.

QVideoFrameFormat.Format_ARGB8888_Premultiplied

The frame stored using a premultiplied ARGB format with 8 bits per component.

QVideoFrameFormat.Format_XRGB8888

The frame stored using a 32 bits per pixel RGB format (0xff, R, G, B).

QVideoFrameFormat.Format_BGRA8888

The frame is stored using a 32-bit BGRA format (0xBBGGRRAA).

QVideoFrameFormat.Format_BGRA8888_Premultiplied

The frame is stored using a premultiplied 32bit BGRA format.

QVideoFrameFormat.Format_ABGR8888

The frame is stored using a 32-bit ABGR format (0xAABBGGRR).

QVideoFrameFormat.Format_XBGR8888

The frame is stored using a 32-bit BGR format (0xffBBGGRR).

QVideoFrameFormat.Format_RGBA8888

The frame is stored in memory as the bytes R, G, B, A/X, with R at the lowest address and A/X at the highest address.

QVideoFrameFormat.Format_BGRX8888

The frame is stored in format 32-bit BGRx format, [31:0] B:G:R:x 8:8:8:8 little endian

QVideoFrameFormat.Format_RGBX8888

The frame is stored in memory as the bytes R, G, B, A/X, with R at the lowest address and A/X at the highest address.

QVideoFrameFormat.Format_AYUV

The frame is stored using a packed 32-bit AYUV format (0xAAYYUUVV).

QVideoFrameFormat.Format_AYUV_Premultiplied

The frame is stored using a packed premultiplied 32-bit AYUV format (0xAAYYUUVV).

QVideoFrameFormat.Format_YUV420P

The frame is stored using an 8-bit per component planar YUV format with the U and V planes horizontally and vertically sub-sampled, i.e. the height and width of the U and V planes are half that of the Y plane.

QVideoFrameFormat.Format_YUV422P

The frame is stored using an 8-bit per component planar YUV format with the U and V planes horizontally sub-sampled, i.e. the width of the U and V planes are half that of the Y plane, and height of U and V planes is the same as Y.

QVideoFrameFormat.Format_YV12

The frame is stored using an 8-bit per component planar YVU format with the V and U planes horizontally and vertically sub-sampled, i.e. the height and width of the V and U planes are half that of the Y plane.

QVideoFrameFormat.Format_UYVY

The frame is stored using an 8-bit per component packed YUV format with the U and V planes horizontally sub-sampled (U-Y-V-Y), i.e. two horizontally adjacent pixels are stored as a 32-bit macropixel which has a Y value for each pixel and common U and V values.

QVideoFrameFormat.Format_YUYV

The frame is stored using an 8-bit per component packed YUV format with the U and V planes horizontally sub-sampled (Y-U-Y-V), i.e. two horizontally adjacent pixels are stored as a 32-bit macropixel which has a Y value for each pixel and common U and V values.

QVideoFrameFormat.Format_NV12

The frame is stored using an 8-bit per component semi-planar YUV format with a Y plane (Y) followed by a horizontally and vertically sub-sampled, packed UV plane (U-V).

QVideoFrameFormat.Format_NV21

The frame is stored using an 8-bit per component semi-planar YUV format with a Y plane (Y) followed by a horizontally and vertically sub-sampled, packed VU plane (V-U).

QVideoFrameFormat.Format_IMC1

The frame is stored using an 8-bit per component planar YUV format with the U and V planes horizontally and vertically sub-sampled. This is similar to the type, except that the bytes per line of the U and V planes are padded out to the same stride as the Y plane.

QVideoFrameFormat.Format_IMC2

The frame is stored using an 8-bit per component planar YUV format with the U and V planes horizontally and vertically sub-sampled. This is similar to the type, except that the lines of the U and V planes are interleaved, i.e. each line of U data is followed by a line of V data creating a single line of the same stride as the Y data.

QVideoFrameFormat.Format_IMC3

The frame is stored using an 8-bit per component planar YVU format with the V and U planes horizontally and vertically sub-sampled. This is similar to the type, except that the bytes per line of the V and U planes are padded out to the same stride as the Y plane.

QVideoFrameFormat.Format_IMC4

The frame is stored using an 8-bit per component planar YVU format with the V and U planes horizontally and vertically sub-sampled. This is similar to the type, except that the lines of the V and U planes are interleaved, i.e. each line of V data is followed by a line of U data creating a single line of the same stride as the Y data.

QVideoFrameFormat.Format_P010

The frame is stored using a 16bit per component semi-planar YUV format with a Y plane (Y) followed by a horizontally and vertically sub-sampled, packed UV plane (U-V). Only the 10 most significant bits of each component are being used.

QVideoFrameFormat.Format_P016

The frame is stored using a 16bit per component semi-planar YUV format with a Y plane (Y) followed by a horizontally and vertically sub-sampled, packed UV plane (U-V).

QVideoFrameFormat.Format_Y8

The frame is stored using an 8-bit greyscale format.

QVideoFrameFormat.Format_Y16

The frame is stored using a 16-bit linear greyscale format. Little endian.

QVideoFrameFormat.Format_Jpeg

The frame is stored in compressed Jpeg format.

QVideoFrameFormat.Format_SamplerExternalOES

The frame is stored in external OES texture format.

PySide6.QtMultimedia.QVideoFrameFormat.Direction

Enumerates the layout direction of video scan lines.

Constant

Description

QVideoFrameFormat.TopToBottom

Scan lines are arranged from the top of the frame to the bottom.

QVideoFrameFormat.BottomToTop

Scan lines are arranged from the bottom of the frame to the top.

PySide6.QtMultimedia.QVideoFrameFormat.YCbCrColorSpace

Enumerates the Y’CbCr color space of video frames.

Constant

Description

QVideoFrameFormat.YCbCr_Undefined

No color space is specified.

QVideoFrameFormat.YCbCr_BT601

A Y’CbCr color space defined by ITU-R recommendation BT.601 with Y value range from 16 to 235, and Cb/Cr range from 16 to 240. Used in standard definition video.

QVideoFrameFormat.YCbCr_BT709

A Y’CbCr color space defined by ITU-R BT.709 with the same values range as . Used for HDTV.

QVideoFrameFormat.YCbCr_xvYCC601

The BT.601 color space with the value range extended to 0 to 255. It is backward compatible with BT.601 and uses values outside BT.601 range to represent a wider range of colors.

QVideoFrameFormat.YCbCr_xvYCC709

The BT.709 color space with the value range extended to 0 to 255.

QVideoFrameFormat.YCbCr_JPEG

The full range Y’CbCr color space used in JPEG files.

PySide6.QtMultimedia.QVideoFrameFormat.NPixelFormats
PySide6.QtMultimedia.QVideoFrameFormat.fragmentShaderFileName()
Return type

str

PySide6.QtMultimedia.QVideoFrameFormat.frameHeight()
Return type

int

Returns the height of frame in a video stream.

PySide6.QtMultimedia.QVideoFrameFormat.frameRate()
Return type

float

Returns the frame rate of a video stream in frames per second.

See also

setFrameRate()

PySide6.QtMultimedia.QVideoFrameFormat.frameSize()
Return type

PySide6.QtCore.QSize

Returns the dimensions of frames in a video stream.

PySide6.QtMultimedia.QVideoFrameFormat.frameWidth()
Return type

int

Returns the width of frames in a video stream.

static PySide6.QtMultimedia.QVideoFrameFormat.imageFormatFromPixelFormat(format)
Parameters

formatPixelFormat

Return type

Format

Returns an image format equivalent to a video frame pixel format. If there is no equivalent format Format_Invalid is returned instead.

Note

In general QImage does not handle YUV formats.

PySide6.QtMultimedia.QVideoFrameFormat.isMirrored()
Return type

bool

Returns true if the surface is mirrored around its vertical axis. This is typically needed for video frames coming from a front camera of a mobile device.

Note

The mirroring here differs from mirrored , as a vertically mirrored QImage will be mirrored around its x-axis.

PySide6.QtMultimedia.QVideoFrameFormat.isValid()
Return type

bool

Identifies if a video surface format has a valid pixel format and frame size.

Returns true if the format is valid, and false otherwise.

PySide6.QtMultimedia.QVideoFrameFormat.__ne__(format)
Parameters

formatPySide6.QtMultimedia.QVideoFrameFormat

Return type

bool

Returns true if other is different to this video format, and false if they are the same.

PySide6.QtMultimedia.QVideoFrameFormat.__eq__(format)
Parameters

formatPySide6.QtMultimedia.QVideoFrameFormat

Return type

bool

Returns true if other is the same as this video format, and false if they are different.

PySide6.QtMultimedia.QVideoFrameFormat.pixelFormat()
Return type

PixelFormat

Returns the pixel format of frames in a video stream.

static PySide6.QtMultimedia.QVideoFrameFormat.pixelFormatFromImageFormat(format)
Parameters

formatFormat

Return type

PixelFormat

Returns a video pixel format equivalent to an image format. If there is no equivalent format Format_Invalid is returned instead.

Note

In general QImage does not handle YUV formats.

PySide6.QtMultimedia.QVideoFrameFormat.planeCount()
Return type

int

Returns the number of planes used. This number is depending on the pixel format and is 1 for RGB based formats, and a number between 1 and 3 for YUV based formats.

PySide6.QtMultimedia.QVideoFrameFormat.scanLineDirection()
Return type

Direction

Returns the direction of scan lines.

PySide6.QtMultimedia.QVideoFrameFormat.setFrameRate(rate)
Parameters

rate – float

Sets the frame rate of a video stream in frames per second.

See also

frameRate()

PySide6.QtMultimedia.QVideoFrameFormat.setFrameSize(size)
Parameters

sizePySide6.QtCore.QSize

Sets the size of frames in a video stream to size.

This will reset the viewport() to fill the entire frame.

See also

frameSize()

PySide6.QtMultimedia.QVideoFrameFormat.setFrameSize(width, height)
Parameters
  • width – int

  • height – int

This is an overloaded function.

Sets the width and height of frames in a video stream.

This will reset the viewport() to fill the entire frame.

PySide6.QtMultimedia.QVideoFrameFormat.setMirrored(mirrored)
Parameters

mirrored – bool

Sets if the surface is mirrored around its vertical axis. This is typically needed for video frames coming from a front camera of a mobile device. Default value is false.

Note

The mirroring here differs from mirrored , as a vertically mirrored QImage will be mirrored around its x-axis.

See also

isMirrored()

PySide6.QtMultimedia.QVideoFrameFormat.setScanLineDirection(direction)
Parameters

directionDirection

Sets the direction of scan lines.

PySide6.QtMultimedia.QVideoFrameFormat.setViewport(viewport)
Parameters

viewportPySide6.QtCore.QRect

Sets the viewport of a video stream to viewport.

See also

viewport()

PySide6.QtMultimedia.QVideoFrameFormat.setYCbCrColorSpace(colorSpace)
Parameters

colorSpaceYCbCrColorSpace

Sets the Y’CbCr color space of a video stream. It is only used with raw YUV frame types.

PySide6.QtMultimedia.QVideoFrameFormat.swap(other)
Parameters

otherPySide6.QtMultimedia.QVideoFrameFormat

PySide6.QtMultimedia.QVideoFrameFormat.updateUniformData(dst, frame, transform, opacity)
Parameters
PySide6.QtMultimedia.QVideoFrameFormat.vertexShaderFileName()
Return type

str

PySide6.QtMultimedia.QVideoFrameFormat.viewport()
Return type

PySide6.QtCore.QRect

Returns the viewport of a video stream.

The viewport is the region of a video frame that is actually displayed.

By default the viewport covers an entire frame.

See also

setViewport()

PySide6.QtMultimedia.QVideoFrameFormat.yCbCrColorSpace()
Return type

YCbCrColorSpace

Returns the Y’CbCr color space of a video stream.