QVideoFrame¶

Synopsis¶

Functions¶

def bits ()
def bytesPerLine ()
def endTime ()
def fieldType ()
def handle ()
def handleType ()
def height ()
def isMapped ()
def isReadable ()
def isValid ()
def isWritable ()
def map (mode)
def mapMode ()
def mappedBytes ()
def pixelFormat ()
def setEndTime (time)
def setFieldType (arg__1)
def setStartTime (time)
def size ()
def startTime ()
def unmap ()
def width ()

Static functions¶

def imageFormatFromPixelFormat (format)
def pixelFormatFromImageFormat (format)

Detailed Description¶

The PySide.QtMultimedia.QVideoFrame class provides a representation of a frame of video data.

A PySide.QtMultimedia.QVideoFrame encapsulates the data of a video frame, and information about the frame.

The contents of a video frame can be mapped to memory using the PySide.QtMultimedia.QVideoFrame.map() function. While mapped the video data can accessed using the PySide.QtMultimedia.QVideoFrame.bits() function which returns a pointer to a buffer, the total size of which is given by the PySide.QtMultimedia.QVideoFrame.mappedBytes() , and the size of each line is given by PySide.QtMultimedia.QVideoFrame.bytesPerLine() . The return value of the PySide.QtMultimedia.QVideoFrame.handle() function may be used to access frame data using the internal buffer’s native APIs.

The video data in a PySide.QtMultimedia.QVideoFrame is encapsulated in a PySide.QtMultimedia.QAbstractVideoBuffer . A PySide.QtMultimedia.QVideoFrame may be constructed from any buffer type by subclassing the PySide.QtMultimedia.QAbstractVideoBuffer class.

Note

PySide.QtMultimedia.QVideoFrame is explicitly shared, any change made to video frame will also apply to any copies.

class PySide.QtMultimedia.QVideoFrame¶

class PySide.QtMultimedia.QVideoFrame(buffer, size, format)

class PySide.QtMultimedia.QVideoFrame(image)

class PySide.QtMultimedia.QVideoFrame(other)

class PySide.QtMultimedia.QVideoFrame(bytes, size, bytesPerLine, format)

Parameters:	size – `PySide.QtCore.QSize` bytes – `PySide.QtCore.int` format – `PySide.QtMultimedia.QVideoFrame.PixelFormat` image – `PySide.QtGui.QImage` other – `PySide.QtMultimedia.QVideoFrame` bytesPerLine – `PySide.QtCore.int` buffer – `PySide.QtMultimedia.QAbstractVideoBuffer`

Constructs a null video frame.

Constructs a video frame from a buffer of the given pixel format and size in pixels.

Note

This doesn’t increment the reference count of the video buffer.

Constructs a video frame from an image .

Note

This will construct an invalid video frame if there is no frame type equivalent to the image format.

Constructs a copy of other .

Constructs a video frame of the given pixel format and size in pixels.

The bytesPerLine (stride) is the length of each scan line in bytes, and bytes is the total number of bytes that must be allocated for the frame.

PySide.QtMultimedia.QVideoFrame.FieldType¶

Specifies the field an interlaced video frame belongs to.

Constant	Description
QVideoFrame.ProgressiveFrame	The frame is not interlaced.
QVideoFrame.TopField	The frame contains a top field.
QVideoFrame.BottomField	The frame contains a bottom field.
QVideoFrame.InterlacedFrame	The frame contains a merged top and bottom field.

PySide.QtMultimedia.QVideoFrame.PixelFormat¶

Enumerates video data types.

Constant	Description
QVideoFrame.Format_Invalid	The frame is invalid.
QVideoFrame.Format_ARGB32	The frame is stored using a 32-bit ARGB format (0xAARRGGBB). This is equivalent to `QImage.Format_ARGB32` .
QVideoFrame.Format_ARGB32_Premultiplied	The frame stored using a premultiplied 32-bit ARGB format (0xAARRGGBB). This is equivalent to `QImage.Format_ARGB32_Premultiplied` .
QVideoFrame.Format_RGB32	The frame stored using a 32-bit RGB format (0xffRRGGBB). This is equivalent to `QImage.Format_RGB32`
QVideoFrame.Format_RGB24	The frame is stored using a 24-bit RGB format (8-8-8). This is equivalent to `QImage.Format_RGB888`
QVideoFrame.Format_RGB565	The frame is stored using a 16-bit RGB format (5-6-5). This is equivalent to `QImage.Format_RGB16` .
QVideoFrame.Format_RGB555	The frame is stored using a 16-bit RGB format (5-5-5). This is equivalent to `QImage.Format_RGB555` .
QVideoFrame.Format_ARGB8565_Premultiplied	The frame is stored using a 24-bit premultiplied ARGB format (8-6-6-5).
QVideoFrame.Format_BGRA32	The frame is stored using a 32-bit ARGB format (0xBBGGRRAA).
QVideoFrame.Format_BGRA32_Premultiplied	The frame is stored using a premultiplied 32bit BGRA format.
QVideoFrame.Format_BGR32	The frame is stored using a 32-bit BGR format (0xBBGGRRff).
QVideoFrame.Format_BGR24	The frame is stored using a 24-bit BGR format (0xBBGGRR).
QVideoFrame.Format_BGR565	The frame is stored using a 16-bit BGR format (5-6-5).
QVideoFrame.Format_BGR555	The frame is stored using a 16-bit BGR format (5-5-5).
QVideoFrame.Format_BGRA5658_Premultiplied	The frame is stored using a 24-bit premultiplied BGRA format (5-6-5-8).
QVideoFrame.Format_AYUV444	The frame is stored using a packed 32-bit AYUV format (0xAAYYUUVV).
QVideoFrame.Format_AYUV444_Premultiplied	The frame is stored using a packed premultiplied 32-bit AYUV format (0xAAYYUUVV).
QVideoFrame.Format_YUV444	The frame is stored using a 24-bit packed YUV format (8-8-8).
QVideoFrame.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.
QVideoFrame.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.
QVideoFrame.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.
QVideoFrame.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.
QVideoFrame.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).
QVideoFrame.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).
QVideoFrame.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 `Format_YUV420P` type, except that the bytes per line of the U and V planes are padded out to the same stride as the Y plane.
QVideoFrame.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 `Format_YUV420P` 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.
QVideoFrame.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 `Format_YV12` type, except that the bytes per line of the V and U planes are padded out to the same stride as the Y plane.
QVideoFrame.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 `Format_YV12` 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.
QVideoFrame.Format_Y8	The frame is stored using an 8-bit greyscale format.
QVideoFrame.Format_Y16	The frame is stored using a 16-bit linear greyscale format. Little endian.
QVideoFrame.Format_User	Start value for user defined pixel formats.

PySide.QtMultimedia.QVideoFrame.bits()¶

Return type:	`PySide.QtCore.uchar`

Returns a pointer to the start of the frame data buffer.

This value is only valid while the frame data is mapped .

PySide.QtMultimedia.QVideoFrame.bytesPerLine()¶

Return type:	`PySide.QtCore.int`

Returns the number of bytes in a scan line.

Note

This is the bytes per line of the first plane only. The bytes per line of subsequent planes should be calculated as per the frame type.

This value is only valid while the frame data is mapped .

PySide.QtMultimedia.QVideoFrame.endTime()¶

Return type:	`PySide.QtCore.qint64`

Returns the presentation time when a frame should stop being displayed.

PySide.QtMultimedia.QVideoFrame.fieldType()¶

Return type:	`PySide.QtMultimedia.QVideoFrame.FieldType`

Returns the field an interlaced video frame belongs to.

If the video is not interlaced this will return WholeFrame.

PySide.QtMultimedia.QVideoFrame.handle()¶

Return type:	object

Returns a type specific handle to a video frame’s buffer.

For an OpenGL texture this would be the texture ID.

See also

QAbstractVideoBuffer.handle()

PySide.QtMultimedia.QVideoFrame.handleType()¶

Return type:	`PySide.QtMultimedia.QAbstractVideoBuffer.HandleType`

Returns the type of a video frame’s handle.

PySide.QtMultimedia.QVideoFrame.height()¶

Return type:	`PySide.QtCore.int`

Returns the height of a video frame.

static PySide.QtMultimedia.QVideoFrame.imageFormatFromPixelFormat(format)¶

Parameters:	format – `PySide.QtMultimedia.QVideoFrame.PixelFormat`
Return type:	`PySide.QtGui.QImage.Format`

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

PySide.QtMultimedia.QVideoFrame.isMapped()¶

Return type:	`PySide.QtCore.bool`

Identifies if a video frame’s contents are currently mapped to system memory.

This is a convenience function which checks that the QAbstractVideoBuffer.MapMode of the frame is not equal to QAbstractVideoBuffer.NotMapped .

Returns true if the contents of the video frame are mapped to system memory, and false otherwise.

See also

PySide.QtMultimedia.QVideoFrame.mapMode() QAbstractVideoBuffer.MapMode

PySide.QtMultimedia.QVideoFrame.isReadable()¶

Return type:	`PySide.QtCore.bool`

Identifies if the mapped contents of a video frame were read from the frame when it was mapped.

This is a convenience function which checks if the QAbstractVideoBuffer.MapMode contains the QAbstractVideoBuffer.WriteOnly flag.

Returns true if the contents of the mapped memory were read from the video frame, and false otherwise.

See also

PySide.QtMultimedia.QVideoFrame.mapMode() QAbstractVideoBuffer.MapMode

PySide.QtMultimedia.QVideoFrame.isValid()¶

Return type:	`PySide.QtCore.bool`

Identifies whether a video frame is valid.

An invalid frame has no video buffer associated with it.

Returns true if the frame is valid, and false if it is not.

PySide.QtMultimedia.QVideoFrame.isWritable()¶

Return type:	`PySide.QtCore.bool`

Identifies if the mapped contents of a video frame will be persisted when the frame is unmapped.

This is a convenience function which checks if the QAbstractVideoBuffer.MapMode contains the QAbstractVideoBuffer.WriteOnly flag.

Returns true if the video frame will be updated when unmapped, and false otherwise.

Note

The result of altering the data of a frame that is mapped in read-only mode is undefined. Depending on the buffer implementation the changes may be persisted, or worse alter a shared buffer.

See also

PySide.QtMultimedia.QVideoFrame.mapMode() QAbstractVideoBuffer.MapMode

PySide.QtMultimedia.QVideoFrame.map(mode)¶

Parameters:	mode – `PySide.QtMultimedia.QAbstractVideoBuffer.MapMode`
Return type:	`PySide.QtCore.bool`

PySide.QtMultimedia.QVideoFrame.mapMode()¶

Return type:	`PySide.QtMultimedia.QAbstractVideoBuffer.MapMode`

Returns the mode a video frame was mapped to system memory in.

See also

PySide.QtMultimedia.QVideoFrame.map() QAbstractVideoBuffer.MapMode

PySide.QtMultimedia.QVideoFrame.mappedBytes()¶

Return type:	`PySide.QtCore.int`

Returns the number of bytes occupied by the mapped frame data.

This value is only valid while the frame data is mapped .

See also

PySide.QtMultimedia.QVideoFrame.map()

PySide.QtMultimedia.QVideoFrame.pixelFormat()¶

Return type:	`PySide.QtMultimedia.QVideoFrame.PixelFormat`

Returns the color format of a video frame.

static PySide.QtMultimedia.QVideoFrame.pixelFormatFromImageFormat(format)¶

Parameters:	format – `PySide.QtGui.QImage.Format`
Return type:	`PySide.QtMultimedia.QVideoFrame.PixelFormat`

PySide.QtMultimedia.QVideoFrame.setEndTime(time)¶

Parameters:	time – `PySide.QtCore.qint64`

Sets the presentation time when a frame should stop being displayed.

PySide.QtMultimedia.QVideoFrame.setFieldType(arg__1)¶

Parameters:	arg__1 – `PySide.QtMultimedia.QVideoFrame.FieldType`

Sets the field an interlaced video frame belongs to.

PySide.QtMultimedia.QVideoFrame.setStartTime(time)¶

Parameters:	time – `PySide.QtCore.qint64`

Sets the presentation time when the frame should be displayed.

PySide.QtMultimedia.QVideoFrame.size()¶

Return type:	`PySide.QtCore.QSize`

Returns the size of a video frame.

PySide.QtMultimedia.QVideoFrame.startTime()¶

Return type:	`PySide.QtCore.qint64`

Returns the presentation time when the frame should be displayed.

PySide.QtMultimedia.QVideoFrame.unmap()¶

Releases the memory mapped by the PySide.QtMultimedia.QVideoFrame.map() function.

If the QAbstractVideoBuffer.MapMode included the QAbstractVideoBuffer.WriteOnly flag this will persist the current content of the mapped memory to the video frame.

See also

PySide.QtMultimedia.QVideoFrame.map()

PySide.QtMultimedia.QVideoFrame.width()¶

Return type:	`PySide.QtCore.int`

Returns the width of a video frame.

Table Of Contents

Previous topic

Next topic

QVideoFrame¶

Synopsis¶

Functions¶

Static functions¶

Detailed Description¶

Table Of Contents

Previous topic

Next topic

Quick search

QVideoFrame¶

Synopsis¶

Functions¶

Static functions¶

Detailed Description¶