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

#include <qvideoframeformat.h>

Collaboration diagram for QVideoFrameFormat:

Public Types
enum	PixelFormat { Format_Invalid , Format_ARGB8888 , Format_ARGB8888_Premultiplied , Format_XRGB8888 , Format_BGRA8888 , Format_BGRA8888_Premultiplied , Format_BGRX8888 , Format_ABGR8888 , Format_XBGR8888 , Format_RGBA8888 , Format_RGBX8888 , Format_AYUV , Format_AYUV_Premultiplied , Format_YUV420P , Format_YUV422P , Format_YV12 , Format_UYVY , Format_YUYV , Format_NV12 , Format_NV21 , Format_IMC1 , Format_IMC2 , Format_IMC3 , Format_IMC4 , Format_Y8 , Format_Y16 , Format_P010 , Format_P016 , Format_SamplerExternalOES , Format_Jpeg , Format_SamplerRect , Format_YUV420P10 }
	Enumerates video data types. More...

enum	Direction { TopToBottom , BottomToTop }
	Enumerates the layout direction of video scan lines. More...

enum	ColorSpace { ColorSpace_Undefined = 0 , ColorSpace_BT601 = 1 , ColorSpace_BT709 = 2 , ColorSpace_AdobeRgb = 5 , ColorSpace_BT2020 = 6 }
	Enumerates the color space of video frames. More...

enum	ColorTransfer { ColorTransfer_Unknown , ColorTransfer_BT709 , ColorTransfer_BT601 , ColorTransfer_Linear , ColorTransfer_Gamma22 , ColorTransfer_Gamma28 , ColorTransfer_ST2084 , ColorTransfer_STD_B67 }
	\value ColorTransfer_Unknown The color transfer function is unknown. More...

enum	ColorRange { ColorRange_Unknown , ColorRange_Video , ColorRange_Full }
	Describes the color range used by the video data. More...

Public Member Functions
	QVideoFrameFormat ()
	Constructs a null video stream format.

	QVideoFrameFormat (const QSize &size, PixelFormat pixelFormat)
	Constructs a video stream with the given frame size and pixel format.

	QVideoFrameFormat (const QVideoFrameFormat &format)
	Constructs a copy of other.

	~QVideoFrameFormat ()
	Destroys a video stream description.

	QVideoFrameFormat (QVideoFrameFormat &&other) noexcept=default
	Constructs a QVideoFrameFormat by moving from other.

	QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_PURE_SWAP (QVideoFrameFormat)

void	swap (QVideoFrameFormat &other) noexcept
	Swaps the current video frame format with the other.

void	detach ()

QVideoFrameFormat &	operator= (const QVideoFrameFormat &format)
	Assigns the values of other to this object.

bool	operator== (const QVideoFrameFormat &format) const
	Returns true if other is the same as this video format, and false if they are different.

bool	operator!= (const QVideoFrameFormat &format) const
	Returns true if other is different to this video format, and false if they are the same.

bool	isValid () const
	Identifies if a video surface format has a valid pixel format and frame size.

QVideoFrameFormat::PixelFormat	pixelFormat () const
	Returns the pixel format of frames in a video stream.

QSize	frameSize () const
	Returns the dimensions of frames in a video stream.

void	setFrameSize (const QSize &size)
	Sets the size of frames in a video stream to size.

void	setFrameSize (int width, int height)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the width and height of frames in a video stream.

int	frameWidth () const
	Returns the width of frames in a video stream.

int	frameHeight () const
	Returns the height of frame in a video stream.

int	planeCount () const
	Returns the number of planes used.

QRect	viewport () const
	Returns the viewport of a video stream.

void	setViewport (const QRect &viewport)
	Sets the viewport of a video stream to viewport.

Direction	scanLineDirection () const
	Returns the direction of scan lines.

void	setScanLineDirection (Direction direction)
	Sets the direction of scan lines.

qreal	frameRate () const
	Returns the frame rate of a video stream in frames per second.

void	setFrameRate (qreal rate)
	Sets the frame rate of a video stream in frames per second.

ColorSpace	colorSpace () const
	Returns the color space of a video stream.

void	setColorSpace (ColorSpace colorSpace)
	Sets the colorSpace of a video stream.

ColorTransfer	colorTransfer () const
	Returns the color transfer function that should be used to render the video stream.

void	setColorTransfer (ColorTransfer colorTransfer)
	Sets the color transfer function that should be used to render the video stream to colorTransfer.

ColorRange	colorRange () const
	Returns the color range that should be used to render the video stream.

void	setColorRange (ColorRange range)
	Sets the color transfer range that should be used to render the video stream to range.

bool	isMirrored () const
	Returns `true` if the surface is mirrored around its vertical axis.

void	setMirrored (bool mirrored)
	Sets if the surface is mirrored around its vertical axis.

QString	vertexShaderFileName () const

QString	fragmentShaderFileName () const

void	updateUniformData (QByteArray *dst, const QVideoFrame &frame, const QMatrix4x4 &transform, float opacity) const

float	maxLuminance () const

void	setMaxLuminance (float lum)
	Sets the maximum luminance to the given value, lum.

Static Public Member Functions
static PixelFormat	pixelFormatFromImageFormat (QImage::Format format)
	Returns a video pixel format equivalent to an image format.

static QImage::Format	imageFormatFromPixelFormat (PixelFormat format)
	Returns an image format equivalent to a video frame pixel format.

static QString	pixelFormatToString (QVideoFrameFormat::PixelFormat pixelFormat)
	Returns a string representation of the given pixelFormat.

Static Public Attributes
static constexpr int	NPixelFormats = Format_YUV420P10 + 1

Detailed Description

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

\inmodule QtMultimedia

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 set up 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().

Definition at line 26 of file qvideoframeformat.h.

Member Enumeration Documentation

◆ ColorRange

enum QVideoFrameFormat::ColorRange

Describes the color range used by the video data.

Video data usually comes in either full color range, where all values are being used, or a more limited range traditionally used in YUV video formats, where a subset of all values is being used.

\value ColorRange_Unknown The color range of the video is unknown.

\value ColorRange_Video

The color range traditionally used by most YUV video formats. For 8 bit formats, the Y component is limited to values between 16 and 235. The U and V components are limited to values between 16 and 240

For higher bit depths multiply these values with 2^(depth-8).

\value ColorRange_Full

Full color range. All values from 0 to 2^depth - 1 are valid.

Enumerator
ColorRange_Unknown
ColorRange_Video
ColorRange_Full

Definition at line 113 of file qvideoframeformat.h.

◆ ColorSpace

enum QVideoFrameFormat::ColorSpace

Enumerates the color space of video frames.

\value ColorSpace_Undefined No color space is specified.

\value ColorSpace_BT601 A 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 mostly by older videos that were targeting CRT displays.

\value ColorSpace_BT709 A color space defined by ITU-R BT.709 with the same values range as ColorSpace_BT601. The most commonly used color space today.

\value ColorSpace_AdobeRgb The full range YUV color space used in most JPEG files.

\value ColorSpace_BT2020 The color space defined by ITU-R BT.2020. Used mainly for HDR videos.

Enumerator
ColorSpace_Undefined
ColorSpace_BT601
ColorSpace_BT709
ColorSpace_AdobeRgb
ColorSpace_BT2020

Definition at line 92 of file qvideoframeformat.h.

◆ ColorTransfer

enum QVideoFrameFormat::ColorTransfer

\value ColorTransfer_Unknown The color transfer function is unknown.

\value ColorTransfer_BT709 Color values are encoded according to BT709. See also https://www.itu.int/rec/R-REC-BT.709/en. This is close to, but not identical to a gamma curve of 2.2, and the same transfer curve as is used in sRGB.

\value ColorTransfer_BT601 Color values are encoded according to BT601. See also https://www.itu.int/rec/R-REC-BT.601/en.

\value ColorTransfer_Linear Color values are linear

\value ColorTransfer_Gamma22 Color values are encoded with a gamma of 2.2

\value ColorTransfer_Gamma28 Color values are encoded with a gamma of 2.8

\value ColorTransfer_ST2084 Color values are encoded using STME ST 2084. This transfer function is the most common HDR transfer function and often called the 'perceptual quantizer'. See also https://www.itu.int/rec/R-REC-BT.2100 and https://en.wikipedia.org/wiki/Perceptual_quantizer.

\value ColorTransfer_STD_B67 Color values are encoded using ARIB STD B67. This transfer function is also often referred to as 'hybrid log gamma'. See also https://www.itu.int/rec/R-REC-BT.2100 and https://en.wikipedia.org/wiki/Hybrid_log–gamma.

Enumerator
ColorTransfer_Unknown
ColorTransfer_BT709
ColorTransfer_BT601
ColorTransfer_Linear
ColorTransfer_Gamma22
ColorTransfer_Gamma28
ColorTransfer_ST2084
ColorTransfer_STD_B67

Definition at line 101 of file qvideoframeformat.h.

◆ Direction

enum QVideoFrameFormat::Direction

Enumerates the layout direction of video scan lines.

\value TopToBottom Scan lines are arranged from the top of the frame to the bottom. \value BottomToTop Scan lines are arranged from the bottom of the frame to the top.

Enumerator
TopToBottom
BottomToTop

Definition at line 72 of file qvideoframeformat.h.

◆ PixelFormat

enum QVideoFrameFormat::PixelFormat

Enumerates video data types.

\value Format_Invalid The frame is invalid.

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

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

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

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

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

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

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

\value 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.

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

\value 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.

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

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

\value 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.

\value 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.

\value 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.

\value 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.

\value 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.

\value 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).

\value 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).

\value 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.

\value 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.

\value 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.

\value 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.

\value 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.

\value 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).

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

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

\value Format_Jpeg The frame is stored in compressed Jpeg format.

\value Format_SamplerExternalOES The frame is stored in external OES texture format. This is currently only being used on Android.

\value Format_SamplerRect The frame is stored in rectangle texture format (GL_TEXTURE_RECTANGLE). This is only being used on macOS with an OpenGL based Rendering Hardware interface. The underlying pixel format stored in the texture is Format_BRGA8888.

\value Format_YUV420P10 Similar to YUV420, but uses 16bits per component, 10 of those significant.

Enumerator
Format_Invalid
Format_ARGB8888
Format_ARGB8888_Premultiplied
Format_XRGB8888
Format_BGRA8888
Format_BGRA8888_Premultiplied
Format_BGRX8888
Format_ABGR8888
Format_XBGR8888
Format_RGBA8888
Format_RGBX8888
Format_AYUV
Format_AYUV_Premultiplied
Format_YUV420P
Format_YUV422P
Format_YV12
Format_UYVY
Format_YUYV
Format_NV12
Format_NV21
Format_IMC1
Format_IMC2
Format_IMC3
Format_IMC4
Format_Y8
Format_Y16
Format_P010
Format_P016
Format_SamplerExternalOES
Format_Jpeg
Format_SamplerRect
Format_YUV420P10

Definition at line 29 of file qvideoframeformat.h.

Constructor & Destructor Documentation

◆ QVideoFrameFormat() [1/4]

QVideoFrameFormat::QVideoFrameFormat ( )

Constructs a null video stream format.

Definition at line 348 of file qvideoframeformat.cpp.

References initResource().

Here is the call graph for this function:

◆ QVideoFrameFormat() [2/4]

QVideoFrameFormat::QVideoFrameFormat	(	const QSize &	size,
		QVideoFrameFormat::PixelFormat	format
	)

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

Definition at line 357 of file qvideoframeformat.cpp.

◆ QVideoFrameFormat() [3/4]

QVideoFrameFormat::QVideoFrameFormat ( const QVideoFrameFormat & format )

default

Constructs a copy of other.

◆ ~QVideoFrameFormat()

QVideoFrameFormat::~QVideoFrameFormat ( )

default

Destroys a video stream description.

◆ QVideoFrameFormat() [4/4]

QVideoFrameFormat::QVideoFrameFormat ( QVideoFrameFormat && other )

defaultnoexcept

Constructs a QVideoFrameFormat by moving from other.

Member Function Documentation

◆ colorRange()

QVideoFrameFormat::ColorRange QVideoFrameFormat::colorRange ( ) const

Returns the color range that should be used to render the video stream.

Definition at line 622 of file qvideoframeformat.cpp.

References QVideoFrameFormatPrivate::colorRange.

◆ colorSpace()

QVideoFrameFormat::ColorSpace QVideoFrameFormat::colorSpace ( ) const

Returns the color space of a video stream.

Definition at line 585 of file qvideoframeformat.cpp.

References QVideoFrameFormatPrivate::colorSpace.

Referenced by setColorSpace().

Here is the caller graph for this function:

◆ colorTransfer()

QVideoFrameFormat::ColorTransfer QVideoFrameFormat::colorTransfer ( ) const

Returns the color transfer function that should be used to render the video stream.

Definition at line 603 of file qvideoframeformat.cpp.

References QVideoFrameFormatPrivate::colorTransfer.

Referenced by setColorTransfer().

Here is the caller graph for this function:

◆ detach()

void QVideoFrameFormat::detach ( )

Definition at line 425 of file qvideoframeformat.cpp.

References QExplicitlySharedDataPointer< T >::detach().

Referenced by setColorRange(), setColorSpace(), setColorTransfer(), setFrameRate(), setFrameSize(), setFrameSize(), setMaxLuminance(), setMirrored(), setScanLineDirection(), and setViewport().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fragmentShaderFileName()

QString QVideoFrameFormat::fragmentShaderFileName ( ) const

Definition at line 678 of file qvideoframeformat.cpp.

References QVideoTextureHelper::fragmentShaderFileName().

Referenced by QSGVideoMaterialRhiShader::QSGVideoMaterialRhiShader().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ frameHeight()

int QVideoFrameFormat::frameHeight ( ) const

Returns the height of frame in a video stream.

Definition at line 461 of file qvideoframeformat.cpp.

References QVideoFrameFormatPrivate::frameSize, and QSize::height().

Here is the call graph for this function:

◆ frameRate()

qreal QVideoFrameFormat::frameRate ( ) const

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

Definition at line 544 of file qvideoframeformat.cpp.

References QVideoFrameFormatPrivate::frameRate.

◆ frameSize()

QSize QVideoFrameFormat::frameSize ( ) const

Returns the dimensions of frames in a video stream.

See also: frameWidth(), frameHeight()

Definition at line 443 of file qvideoframeformat.cpp.

References QVideoFrameFormatPrivate::frameSize.

Referenced by QVideoFrame::size().

Here is the caller graph for this function:

◆ frameWidth()

int QVideoFrameFormat::frameWidth ( ) const

Returns the width of frames in a video stream.

See also: frameSize(), frameHeight()

Definition at line 453 of file qvideoframeformat.cpp.

References QVideoFrameFormatPrivate::frameSize, and QSize::width().

Referenced by QWasmVideoOutput::videoFrameCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ imageFormatFromPixelFormat()

QImage::Format QVideoFrameFormat::imageFormatFromPixelFormat ( QVideoFrameFormat::PixelFormat format )

static

Returns an image format equivalent to a video frame pixel format.

If there is no equivalent format QImage::Format_Invalid is returned instead.

Note: In general \l QImage does not handle YUV formats.

Definition at line 765 of file qvideoframeformat.cpp.

References Format_ABGR8888, QImage::Format_ARGB32, QImage::Format_ARGB32_Premultiplied, Format_ARGB8888, Format_ARGB8888_Premultiplied, Format_AYUV, Format_AYUV_Premultiplied, Format_BGRA8888, Format_BGRA8888_Premultiplied, Format_BGRX8888, QImage::Format_Grayscale16, QImage::Format_Grayscale8, Format_IMC1, Format_IMC2, Format_IMC3, Format_IMC4, QImage::Format_Invalid, Format_Invalid, Format_Jpeg, Format_NV12, Format_NV21, Format_P010, Format_P016, QImage::Format_RGB32, QImage::Format_RGBA8888, Format_RGBA8888, QImage::Format_RGBX8888, Format_RGBX8888, Format_SamplerExternalOES, Format_SamplerRect, Format_UYVY, Format_XBGR8888, Format_XRGB8888, Format_Y16, Format_Y8, Format_YUV420P, Format_YUV420P10, Format_YUV422P, Format_YUYV, and Format_YV12.

◆ isMirrored()

bool QVideoFrameFormat::isMirrored ( ) const

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 QImage::mirrored, as a vertically mirrored QImage will be mirrored around its x-axis.

Since: 5.11

Definition at line 646 of file qvideoframeformat.cpp.

References QVideoFrameFormatPrivate::mirrored.

◆ isValid()

bool QVideoFrameFormat::isValid ( ) const

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

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

Definition at line 401 of file qvideoframeformat.cpp.

References Format_Invalid, QVideoFrameFormatPrivate::frameSize, QSize::isValid(), and QVideoFrameFormatPrivate::pixelFormat.

Referenced by QFFmpegScreenCaptureDxgi::Grabber::format(), and EVRCustomPresenter::presentSample().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ maxLuminance()

float QVideoFrameFormat::maxLuminance ( ) const

The maximum luminence in nits as set by the HDR metadata. If the video doesn't have meta data, the returned value depends on the maximum that can be encoded by the transfer function.

Definition at line 697 of file qvideoframeformat.cpp.

References QVideoFrameFormatPrivate::colorTransfer, ColorTransfer_ST2084, ColorTransfer_STD_B67, and QVideoFrameFormatPrivate::maxLuminance.

◆ operator!=()

bool QVideoFrameFormat::operator!= ( const QVideoFrameFormat & format ) const

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

Definition at line 417 of file qvideoframeformat.cpp.

References other().

Here is the call graph for this function:

◆ operator=()

QVideoFrameFormat & QVideoFrameFormat::operator= ( const QVideoFrameFormat & format )

default

Assigns the values of other to this object.

Moves other into this QVideoFrameFormat.

◆ operator==()

bool QVideoFrameFormat::operator== ( const QVideoFrameFormat & format ) const

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

Definition at line 409 of file qvideoframeformat.cpp.

References other().

Here is the call graph for this function:

◆ pixelFormat()

QVideoFrameFormat::PixelFormat QVideoFrameFormat::pixelFormat ( ) const

Returns the pixel format of frames in a video stream.

Definition at line 433 of file qvideoframeformat.cpp.

References QVideoFrameFormatPrivate::pixelFormat.

Referenced by QVideoFrame::isValid(), QVideoFrame::map(), QGstVideoBuffer::mapTextures(), QVideoFrame::pixelFormat(), QSGVideoNode::pixelFormat(), QSGVivanteVideoNode::pixelFormat(), pixelFormatToString(), ActiveCamera::setFormat(), AVFVideoBuffer::textureHandle(), QSGVideoMaterial::type(), and QWasmVideoOutput::videoFrameCallback().

Here is the caller graph for this function:

◆ pixelFormatFromImageFormat()

QVideoFrameFormat::PixelFormat QVideoFrameFormat::pixelFormatFromImageFormat ( QImage::Format format )

static

Returns a video pixel format equivalent to an image format.

If there is no equivalent format QVideoFrameFormat::Format_Invalid is returned instead.

Note: In general \l QImage does not handle YUV formats.

Definition at line 725 of file qvideoframeformat.cpp.

References QImage::Format_ARGB32, QImage::Format_ARGB32_Premultiplied, Format_ARGB8888, Format_ARGB8888_Premultiplied, Format_BGRA8888, Format_BGRA8888_Premultiplied, Format_BGRX8888, QImage::Format_Grayscale16, QImage::Format_Grayscale8, Format_Invalid, QImage::Format_RGB32, QImage::Format_RGBA8888, Format_RGBA8888, QImage::Format_RGBA8888_Premultiplied, QImage::Format_RGBX8888, Format_RGBX8888, Format_XRGB8888, Format_Y16, and Format_Y8.

Referenced by QGrabWindowSurfaceCapture::Grabber::grabFrame(), and Q_LOGGING_CATEGORY().

Here is the caller graph for this function:

◆ pixelFormatToString()

QString QVideoFrameFormat::pixelFormatToString ( QVideoFrameFormat::PixelFormat pixelFormat )

static

Returns a string representation of the given pixelFormat.

Definition at line 829 of file qvideoframeformat.cpp.

References Format_ABGR8888, Format_ARGB8888, Format_ARGB8888_Premultiplied, Format_AYUV, Format_AYUV_Premultiplied, Format_BGRA8888, Format_BGRA8888_Premultiplied, Format_BGRX8888, Format_IMC1, Format_IMC2, Format_IMC3, Format_IMC4, Format_Invalid, Format_Jpeg, Format_NV12, Format_NV21, Format_P010, Format_P016, Format_RGBA8888, Format_RGBX8888, Format_SamplerExternalOES, Format_SamplerRect, Format_UYVY, Format_XBGR8888, Format_XRGB8888, Format_Y16, Format_Y8, Format_YUV420P, Format_YUV420P10, Format_YUV422P, Format_YUYV, Format_YV12, pixelFormat(), and QStringLiteral.

Referenced by operator<<().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ planeCount()

int QVideoFrameFormat::planeCount ( ) const

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.

Definition at line 472 of file qvideoframeformat.cpp.

References QVideoTextureHelper::TextureDescription::nplanes, QVideoFrameFormatPrivate::pixelFormat, and QVideoTextureHelper::textureDescription().

Referenced by QVideoFrame::planeCount().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_PURE_SWAP()

QVideoFrameFormat::QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_PURE_SWAP ( QVideoFrameFormat )

◆ scanLineDirection()

QVideoFrameFormat::Direction QVideoFrameFormat::scanLineDirection ( ) const

Returns the direction of scan lines.

Definition at line 527 of file qvideoframeformat.cpp.

References QVideoFrameFormatPrivate::scanLineDirection.

◆ setColorRange()

void QVideoFrameFormat::setColorRange ( ColorRange range )

Sets the color transfer range that should be used to render the video stream to range.

Definition at line 631 of file qvideoframeformat.cpp.

References QVideoFrameFormatPrivate::colorRange, and detach().

Here is the call graph for this function:

◆ setColorSpace()

void QVideoFrameFormat::setColorSpace ( ColorSpace colorSpace )

Sets the colorSpace of a video stream.

Definition at line 593 of file qvideoframeformat.cpp.

References QVideoFrameFormatPrivate::colorSpace, colorSpace(), and detach().

Here is the call graph for this function:

◆ setColorTransfer()

void QVideoFrameFormat::setColorTransfer ( ColorTransfer colorTransfer )

Sets the color transfer function that should be used to render the video stream to colorTransfer.

Definition at line 612 of file qvideoframeformat.cpp.

References QVideoFrameFormatPrivate::colorTransfer, colorTransfer(), and detach().

Here is the call graph for this function:

◆ setFrameRate()

void QVideoFrameFormat::setFrameRate ( qreal rate )

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

Definition at line 552 of file qvideoframeformat.cpp.

References detach(), and QVideoFrameFormatPrivate::frameRate.

Referenced by QFFmpegScreenCaptureDxgi::Grabber::run(), and QFFmpegWindowCaptureUwp::setActiveInternal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setFrameSize() [1/2]

void QVideoFrameFormat::setFrameSize ( const QSize & size )

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

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

Definition at line 482 of file qvideoframeformat.cpp.

References detach(), QVideoFrameFormatPrivate::frameSize, and QVideoFrameFormatPrivate::viewport.

Here is the call graph for this function:

◆ setFrameSize() [2/2]

void QVideoFrameFormat::setFrameSize	(	int	width,
		int	height
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the width and height of frames in a video stream.

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

Definition at line 496 of file qvideoframeformat.cpp.

References detach(), QVideoFrameFormatPrivate::frameSize, and QVideoFrameFormatPrivate::viewport.

Here is the call graph for this function:

◆ setMaxLuminance()

void QVideoFrameFormat::setMaxLuminance ( float lum )

Sets the maximum luminance to the given value, lum.

Definition at line 711 of file qvideoframeformat.cpp.

References detach(), and QVideoFrameFormatPrivate::maxLuminance.

Here is the call graph for this function:

◆ setMirrored()

void QVideoFrameFormat::setMirrored ( bool mirrored )

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 QImage::mirrored, as a vertically mirrored QImage will be mirrored around its x-axis.

Since: 5.11

Definition at line 661 of file qvideoframeformat.cpp.

References detach(), and QVideoFrameFormatPrivate::mirrored.

Here is the call graph for this function:

◆ setScanLineDirection()

void QVideoFrameFormat::setScanLineDirection ( Direction direction )

Sets the direction of scan lines.

Definition at line 535 of file qvideoframeformat.cpp.

References detach(), direction, and QVideoFrameFormatPrivate::scanLineDirection.

Here is the call graph for this function:

◆ setViewport()

void QVideoFrameFormat::setViewport ( const QRect & viewport )

Sets the viewport of a video stream to viewport.

Definition at line 518 of file qvideoframeformat.cpp.

References detach(), QVideoFrameFormatPrivate::viewport, and viewport().

Here is the call graph for this function:

◆ swap()

void QVideoFrameFormat::swap ( QVideoFrameFormat & other )

inlinenoexcept

Swaps the current video frame format with the other.

Definition at line 127 of file qvideoframeformat.h.

References d, and other().

Here is the call graph for this function:

◆ updateUniformData()

void QVideoFrameFormat::updateUniformData	(	QByteArray *	dst,
		const QVideoFrame &	frame,
		const QMatrix4x4 &	transform,
		float	opacity
	)		const

Definition at line 686 of file qvideoframeformat.cpp.

References frame, and QVideoTextureHelper::updateUniformData().

Referenced by QSGVideoMaterialRhiShader::updateUniformData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ vertexShaderFileName()

QString QVideoFrameFormat::vertexShaderFileName ( ) const

Definition at line 670 of file qvideoframeformat.cpp.

References QVideoTextureHelper::vertexShaderFileName().

Referenced by QSGVideoMaterialRhiShader::QSGVideoMaterialRhiShader().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ viewport()

QRect QVideoFrameFormat::viewport ( ) const

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.

Definition at line 510 of file qvideoframeformat.cpp.

References QVideoFrameFormatPrivate::viewport.

Referenced by setViewport().

Here is the caller graph for this function:

Member Data Documentation

◆ NPixelFormats

constexpr int QVideoFrameFormat::NPixelFormats = Format_YUV420P10 + 1

staticconstexpr

Definition at line 69 of file qvideoframeformat.h.

Referenced by EVRCustomPresenter::supportedFormatsChanged(), QT_BEGIN_NAMESPACE::MediaStream::supportedFormatsChanged(), and QSGVideoMaterial::type().

The documentation for this class was generated from the following files:

qtmultimedia/src/multimedia/video/qvideoframeformat.h
qtmultimedia/src/multimedia/video/qvideoframeformat.cpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Enumeration Documentation

◆ ColorRange

◆ ColorSpace

◆ ColorTransfer

◆ Direction

◆ PixelFormat

Constructor & Destructor Documentation

◆ QVideoFrameFormat() [1/4]

◆ QVideoFrameFormat() [2/4]

◆ QVideoFrameFormat() [3/4]

◆ ~QVideoFrameFormat()

◆ QVideoFrameFormat() [4/4]

Member Function Documentation

◆ colorRange()

◆ colorSpace()

◆ colorTransfer()

◆ detach()

◆ fragmentShaderFileName()

◆ frameHeight()

◆ frameRate()

◆ frameSize()

◆ frameWidth()

◆ imageFormatFromPixelFormat()

◆ isMirrored()

◆ isValid()

◆ maxLuminance()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ pixelFormat()

◆ pixelFormatFromImageFormat()

◆ pixelFormatToString()

◆ planeCount()

◆ QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_PURE_SWAP()

◆ scanLineDirection()

◆ setColorRange()

◆ setColorSpace()

◆ setColorTransfer()

◆ setFrameRate()

◆ setFrameSize() [1/2]

◆ setFrameSize() [2/2]

◆ setMaxLuminance()

◆ setMirrored()

◆ setScanLineDirection()

◆ setViewport()

◆ swap()

◆ updateUniformData()

◆ vertexShaderFileName()

◆ viewport()

Member Data Documentation

◆ NPixelFormats