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

Public Types
enum	Direction

enum	YCbCrColorSpace

Public Methods
	QVideoSurfaceFormat ()

	QVideoSurfaceFormat (const QSize &size, QVideoFrame::PixelFormat pixelFormat, QAbstractVideoBuffer::HandleType handleType=QAbstractVideoBuffer::NoHandle)

	QVideoSurfaceFormat (const QVideoSurfaceFormat &other)

	~QVideoSurfaceFormat ()

int	frameHeight () const

qreal	frameRate () const

QSize	frameSize () const

int	frameWidth () const

QAbstractVideoBuffer::HandleType	handleType () const

bool	isValid () const

bool	operator!= (const QVideoSurfaceFormat &other) const

QVideoSurfaceFormat &	operator= (const QVideoSurfaceFormat &other)

bool	operator== (const QVideoSurfaceFormat &other) const

QSize	pixelAspectRatio () const

QVideoFrame::PixelFormat	pixelFormat () const

QVariant	property (const QString &name) const

QList< QString >	propertyNames () const

Direction	scanLineDirection () const

void	setFrameRate (qreal rate)

void	setFrameSize (const QSize &size)

void	setFrameSize (int width, int height)

void	setPixelAspectRatio (const QSize &ratio)

void	setPixelAspectRatio (int horizontal, int vertical)

void	setProperty (QStringView name, const QVariant &value)

void	setScanLineDirection (Direction direction)

void	setViewport (const QRect &viewport)

void	setYCbCrColorSpace (YCbCrColorSpace colorSpace)

QSize	sizeHint () const

QRect	viewport () const

YCbCrColorSpace	yCbCrColorSpace () const

Detailed Description

The QVideoSurfaceFormat class specifies the stream format of a video presentation surface. A video surface presents a stream of video frames. The surface's format 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 surface are the pixel format given by pixelFormat(), and the frame dimensions given by frameSize(). If the surface is to present frames using a frame's handle a surface format will also include a handle type which is given by the handleType() method.

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 pixelAspectRatio(), scanLineDirection(), and frameRate(). Additionally a stream may have some additional type specific properties which are listed by the dynamicPropertyNames() method and can be accessed using the property(), and setProperty() methods.

See also: setFrameRate()

Member Enumeration Documentation

enum QVideoSurfaceFormat::Direction

Enumerates the layout direction of video scan lines.

Constant	Value	Description
`QVideoSurfaceFormat::TopToBottom`	`0`	Scan lines are arranged from the top of the frame to the bottom.
`QVideoSurfaceFormat::BottomToTop`	`1`	Scan lines are arranged from the bottom of the frame to the top.

enum QVideoSurfaceFormat::YCbCrColorSpace

Enumerates the Y'CbCr color space of video frames.

Constant	Value	Description
`QVideoSurfaceFormat::YCbCr_Undefined`	`0`	No color space is specified.
`QVideoSurfaceFormat::YCbCr_BT601`	`1`	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.
`QVideoSurfaceFormat::YCbCr_BT709`	`2`	A Y'CbCr color space defined by ITU-R BT.709 with the same values range as YCbCr_BT601. Used for HDTV.
`QVideoSurfaceFormat::YCbCr_xvYCC601`	`3`	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 wider colors range.
`QVideoSurfaceFormat::YCbCr_xvYCC709`	`4`	The BT.709 color space with the value range extended to 0 to 255.
`QVideoSurfaceFormat::YCbCr_JPEG`	`5`	The full range Y'CbCr color space used in JPEG files.

Constructor & Destructor Documentation

QVideoSurfaceFormat::QVideoSurfaceFormat ( )

Constructs a null video stream format.

QVideoSurfaceFormat::QVideoSurfaceFormat	(	const QSize &	size,
		QVideoFrame::PixelFormat	pixelFormat,
		QAbstractVideoBuffer::HandleType	handleType = `QAbstractVideoBuffer::NoHandle`
	)

Constructs a new QVideoSurfaceFormat from the given handleType, frame size, and pixelFormat.

QVideoSurfaceFormat::QVideoSurfaceFormat ( const QVideoSurfaceFormat & other )

Copy constructs a new QVideoSurfaceFormat from other.

QVideoSurfaceFormat::~QVideoSurfaceFormat ( )

Destroys a video stream description.

Method Documentation

int QVideoSurfaceFormat::frameHeight ( ) const

Returns the height of frame in a video stream.

qreal QVideoSurfaceFormat::frameRate ( ) const

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

See also: setFrameRate()

QSize QVideoSurfaceFormat::frameSize ( ) const

Returns the size of frames in a video stream.

See also: setFrameSize(), frameWidth(), frameHeight()

int QVideoSurfaceFormat::frameWidth ( ) const

Returns the width of frames in a video stream.

See also: frameSize(), frameHeight()

QAbstractVideoBuffer::HandleType QVideoSurfaceFormat::handleType ( ) const

Returns the type of handle the surface uses to present the frame data.

If the handle type is QAbstractVideoBuffer::NoHandle buffers with any handle type are valid provided they can be mapped with the QAbstractVideoBuffer::ReadOnly flag. If the handleType() is not QAbstractVideoBuffer::NoHandle then the handle type of the buffer be the same as that of the surface format.

bool QVideoSurfaceFormat::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.

bool QVideoSurfaceFormat::operator!= ( const QVideoSurfaceFormat & other ) const

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

QVideoSurfaceFormat & QVideoSurfaceFormat::operator= ( const QVideoSurfaceFormat & other )

Copy assigns from other and returns a reference to this object.

bool QVideoSurfaceFormat::operator== ( const QVideoSurfaceFormat & other ) const

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

QSize QVideoSurfaceFormat::pixelAspectRatio ( ) const

Returns a video stream's pixel aspect ratio.

See also: setPixelAspectRatio()

QVideoFrame::PixelFormat QVideoSurfaceFormat::pixelFormat ( ) const

Returns the pixel format of frames in a video stream.

QVariant QVideoSurfaceFormat::property ( const QString & name ) const

Returns the value of the video format's name property.

See also: setProperty()

QList< QString > QVideoSurfaceFormat::propertyNames ( ) const

Returns a list of video format dynamic property names.

Direction QVideoSurfaceFormat::scanLineDirection ( ) const

Returns the direction of scan lines.

See also: setScanLineDirection()

void QVideoSurfaceFormat::setFrameRate ( qreal rate )

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

See also: frameRate()

void QVideoSurfaceFormat::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.

See also: frameSize()

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

Sets the width and height of frames in a video stream. This will reset the viewport() to fill the entire frame.

void QVideoSurfaceFormat::setPixelAspectRatio ( const QSize & ratio )

Sets a video stream's pixel aspect ratio.

See also: pixelAspectRatio()

void QVideoSurfaceFormat::setPixelAspectRatio	(	int	horizontal,
		int	vertical
	)

Sets the horizontal and vertical elements of a video stream's pixel aspect ratio.

void QVideoSurfaceFormat::setProperty	(	QStringView	name,
		const QVariant &	value
	)

Sets the video format's name property to value.

See also: property()

void QVideoSurfaceFormat::setScanLineDirection ( Direction direction )

Sets the direction of scan lines.

See also: scanLineDirection()

void QVideoSurfaceFormat::setViewport ( const QRect & viewport )

Sets the viewport of a video stream to viewport.

See also: viewport()

void QVideoSurfaceFormat::setYCbCrColorSpace ( YCbCrColorSpace colorSpace )

Sets the Y'CbCr colorSpace of a video stream. It is only used with raw YUV frame types.

See also: yCbCrColorSpace()

QSize QVideoSurfaceFormat::sizeHint ( ) const

Returns a suggested size in pixels for the video stream. This is the size of the viewport scaled according to the pixel aspect ratio.

QRect QVideoSurfaceFormat::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.

See also: setViewport()

YCbCrColorSpace QVideoSurfaceFormat::yCbCrColorSpace ( ) const

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

See also: setYCbCrColorSpace()

Public Types

Public Methods

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Method Documentation