QVideoFrame Class Reference

The QVideoFrame class provides a representation of a frame of video data. More...

#include <qvideoframe.h>

Public Types
enum	FieldType { ProgressiveFrame, TopField, BottomField, InterlacedFrame }
	Specifies the field an interlaced video frame belongs to. More...
enum	PixelFormat {   Format_Invalid, Format_ARGB32, Format_ARGB32_Premultiplied, Format_RGB32,   Format_RGB24, Format_RGB565, Format_RGB555, Format_ARGB8565_Premultiplied,   Format_BGRA32, Format_BGRA32_Premultiplied, Format_BGR32, Format_BGR24,   Format_BGR565, Format_BGR555, Format_BGRA5658_Premultiplied, Format_AYUV444,   Format_AYUV444_Premultiplied, Format_YUV444, Format_YUV420P, Format_YV12,   Format_UYVY, Format_YUYV, Format_NV12, Format_NV21,   Format_IMC1, Format_IMC2, Format_IMC3, Format_IMC4,   Format_Y8, Format_Y16, Format_User = 1000 }
	Enumerates video data types. More...

Public Functions
uchar *	bits ()
	Returns a pointer to the start of the frame data buffer. More...
const uchar *	bits () const
	Returns a pointer to the start of the frame data buffer. More...
int	bytesPerLine () const
	Returns the number of bytes in a scan line. More...
qint64	endTime () const
	Returns the presentation time when a frame should stop being displayed. More...
FieldType	fieldType () const
	Returns the field an interlaced video frame belongs to. More...
QVariant	handle () const
	Returns a type specific handle to a video frame's buffer. More...
QAbstractVideoBuffer::HandleType	handleType () const
	Returns the type of a video frame's handle. More...
int	height () const
	Returns the height of a video frame. More...
bool	isMapped () const
	Identifies if a video frame's contents are currently mapped to system memory. More...
bool	isReadable () const
	Identifies if the mapped contents of a video frame were read from the frame when it was mapped. More...
bool	isValid () const
	Identifies whether a video frame is valid. More...
bool	isWritable () const
	Identifies if the mapped contents of a video frame will be persisted when the frame is unmapped. More...
bool	map (QAbstractVideoBuffer::MapMode mode)
	Maps the contents of a video frame to memory. More...
QAbstractVideoBuffer::MapMode	mapMode () const
	Returns the mode a video frame was mapped to system memory in. More...
int	mappedBytes () const
	Returns the number of bytes occupied by the mapped frame data. More...
QVideoFrame &	operator= (const QVideoFrame &other)
	Assigns the contents of other to a video frame. More...
PixelFormat	pixelFormat () const
	Returns the color format of a video frame. More...
	QVideoFrame ()
	Constructs a null video frame. More...
	QVideoFrame (QAbstractVideoBuffer *buffer, const QSize &size, PixelFormat format)
	Constructs a video frame from a buffer of the given pixel format and size in pixels. More...
	QVideoFrame (int bytes, const QSize &size, int bytesPerLine, PixelFormat format)
	Constructs a video frame of the given pixel format and size in pixels. More...
	QVideoFrame (const QImage &image)
	Constructs a video frame from an image. More...
	QVideoFrame (const QVideoFrame &other)
	Constructs a copy of other. More...
void	setEndTime (qint64 time)
	Sets the presentation time when a frame should stop being displayed. More...
void	setFieldType (FieldType)
	Sets the field an interlaced video frame belongs to. More...
void	setStartTime (qint64 time)
	Sets the presentation time when the frame should be displayed. More...
QSize	size () const
	Returns the size of a video frame. More...
qint64	startTime () const
	Returns the presentation time when the frame should be displayed. More...
void	unmap ()
	Releases the memory mapped by the map() function. More...
int	width () const
	Returns the width of a video frame. More...
	~QVideoFrame ()
	Destroys a video frame. More...

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

Properties
QExplicitlySharedDataPointer< QVideoFramePrivate >	d

Detailed Description

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

Since

4.6

A 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 map() function. While mapped the video data can accessed using the bits() function which returns a pointer to a buffer, the total size of which is given by the mappedBytes(), and the size of each line is given by bytesPerLine(). The return value of the handle() function may be used to access frame data using the internal buffer's native APIs.

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

Note

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

Definition at line 61 of file qvideoframe.h.

Enumerations

FieldType

enum QVideoFrame::FieldType

Specifies the field an interlaced video frame belongs to.

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

Enumerator
ProgressiveFrame
TopField
BottomField
InterlacedFrame

Definition at line 64 of file qvideoframe.h.

    {
        ProgressiveFrame,
        TopField,
        BottomField,
        InterlacedFrame
    };

PixelFormat

enum QVideoFrame::PixelFormat

Enumerates video data types.

• Format_Invalid The frame is invalid.

• Format_ARGB32 The frame is stored using a 32-bit ARGB format (0xAARRGGBB). This is equivalent to QImage::Format_ARGB32.

• Format_ARGB32_Premultiplied The frame stored using a premultiplied 32-bit ARGB format (0xAARRGGBB). This is equivalent to QImage::Format_ARGB32_Premultiplied.

• Format_RGB32 The frame stored using a 32-bit RGB format (0xffRRGGBB). This is equivalent to QImage::Format_RGB32

• Format_RGB24 The frame is stored using a 24-bit RGB format (8-8-8). This is equivalent to QImage::Format_RGB888

• Format_RGB565 The frame is stored using a 16-bit RGB format (5-6-5). This is equivalent to QImage::Format_RGB16.

• Format_RGB555 The frame is stored using a 16-bit RGB format (5-5-5). This is equivalent to QImage::Format_RGB555.

• Format_ARGB8565_Premultiplied The frame is stored using a 24-bit premultiplied ARGB format (8-6-6-5).

• Format_BGRA32 The frame is stored using a 32-bit ARGB format (0xBBGGRRAA).

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

• Format_BGR32 The frame is stored using a 32-bit BGR format (0xBBGGRRff).

• Format_BGR24 The frame is stored using a 24-bit BGR format (0xBBGGRR).

• Format_BGR565 The frame is stored using a 16-bit BGR format (5-6-5).

• Format_BGR555 The frame is stored using a 16-bit BGR format (5-5-5).

• Format_BGRA5658_Premultiplied The frame is stored using a 24-bit premultiplied BGRA format (5-6-5-8).

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

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

• Format_YUV444 The frame is stored using a 24-bit packed YUV format (8-8-8).

• 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.

• 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.

• 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.

• 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.

• 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).

• 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).

• 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.

• 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.

• 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.

• 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.

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

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

• Format_User Start value for user defined pixel formats.

Enumerator
Format_Invalid
Format_ARGB32
Format_ARGB32_Premultiplied
Format_RGB32
Format_RGB24
Format_RGB565
Format_RGB555
Format_ARGB8565_Premultiplied
Format_BGRA32
Format_BGRA32_Premultiplied
Format_BGR32
Format_BGR24
Format_BGR565
Format_BGR555
Format_BGRA5658_Premultiplied
Format_AYUV444
Format_AYUV444_Premultiplied
Format_YUV444
Format_YUV420P
Format_YV12
Format_UYVY
Format_YUYV
Format_NV12
Format_NV21
Format_IMC1
Format_IMC2
Format_IMC3
Format_IMC4
Format_Y8
Format_Y16
Format_User

Definition at line 72 of file qvideoframe.h.

    {
        Format_Invalid,
        Format_ARGB32,
        Format_ARGB32_Premultiplied,
        Format_RGB32,
        Format_RGB24,
        Format_RGB565,
        Format_RGB555,
        Format_ARGB8565_Premultiplied,
        Format_BGRA32,
        Format_BGRA32_Premultiplied,
        Format_BGR32,
        Format_BGR24,
        Format_BGR565,
        Format_BGR555,
        Format_BGRA5658_Premultiplied,

        Format_AYUV444,
        Format_AYUV444_Premultiplied,
        Format_YUV444,
        Format_YUV420P,
        Format_YV12,
        Format_UYVY,
        Format_YUYV,
        Format_NV12,
        Format_NV21,
        Format_IMC1,
        Format_IMC2,
        Format_IMC3,
        Format_IMC4,
        Format_Y8,
        Format_Y16,

        Format_User = 1000
    };

Constructors and Destructors

QVideoFrame() [1/5]

QVideoFrame::QVideoFrame

(

)

Constructs a null video frame.

Definition at line 271 of file qvideoframe.cpp.

    : d(new QVideoFramePrivate)
{
}

QVideoFrame() [2/5]

QVideoFrame::QVideoFrame	(	QAbstractVideoBuffer *	buffer,
		const QSize &	size,
		PixelFormat	format
	)

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.

Definition at line 282 of file qvideoframe.cpp.

    : d(new QVideoFramePrivate(size, format))
{
    d->buffer = buffer;
}

QVideoFrame() [3/5]

QVideoFrame::QVideoFrame	(	int	bytes,
		const QSize &	size,
		int	bytesPerLine,
		PixelFormat	format
	)

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.

Definition at line 296 of file qvideoframe.cpp.

    : d(new QVideoFramePrivate(size, format))
{
    if (bytes > 0) {
        QByteArray data;
        data.resize(bytes);

        // Check the memory was successfully allocated.
        if (!data.isEmpty())
            d->buffer = new QMemoryVideoBuffer(data, bytesPerLine);
    }
}

QVideoFrame() [4/5]

QVideoFrame::QVideoFrame

(

const QImage &

image

)

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.

See also

pixelFormatFromImageFormat()

Definition at line 318 of file qvideoframe.cpp.

    : d(new QVideoFramePrivate(
            image.size(), pixelFormatFromImageFormat(image.format())))
{
    if (d->pixelFormat != Format_Invalid)
        d->buffer = new QImageVideoBuffer(image);
}

QVideoFrame() [5/5]

QVideoFrame::QVideoFrame

(

const QVideoFrame &

other

)

Constructs a copy of other.

Definition at line 330 of file qvideoframe.cpp.

    : d(other.d)
{
}

~QVideoFrame()

QVideoFrame::~QVideoFrame

(

)

Destroys a video frame.

Definition at line 350 of file qvideoframe.cpp.

{
}

Functions

bits() [1/2]

uchar * QVideoFrame::bits

(

)

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

This value is only valid while the frame data is map(){mapped}.

See also

map(), mappedBytes(), bytesPerLine()

Definition at line 575 of file qvideoframe.cpp.

{
    return d->data;
}

bits() [2/2]

const uchar * QVideoFrame::bits

(

)

const

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

This value is only valid while the frame data is map(){mapped}.

See also

map(), mappedBytes(), bytesPerLine()

Definition at line 588 of file qvideoframe.cpp.

{
    return d->data;
}

bytesPerLine()

int QVideoFrame::bytesPerLine

(

)

const

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 map(){mapped}.

See also

bits(), map(), mappedBytes()

Definition at line 562 of file qvideoframe.cpp.

{
    return d->bytesPerLine;
}

endTime()

qint64 QVideoFrame::endTime

(

)

const

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

Definition at line 641 of file qvideoframe.cpp.

{
    return d->endTime;
}

fieldType()

QVideoFrame::FieldType QVideoFrame::fieldType

(

)

const

Returns the field an interlaced video frame belongs to.

If the video is not interlaced this will return WholeFrame.

Definition at line 418 of file qvideoframe.cpp.

{
    return d->fieldType;
}

handle()

QVariant QVideoFrame::handle

(

)

const

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()

Definition at line 614 of file qvideoframe.cpp.

{
    return d->buffer != 0 ? d->buffer->handle() : QVariant();
}

handleType()

QAbstractVideoBuffer::HandleType QVideoFrame::handleType

(

)

const

Returns the type of a video frame's handle.

Definition at line 380 of file qvideoframe.cpp.

{
    return d->buffer ? d->buffer->handleType() : QAbstractVideoBuffer::NoHandle;
}

height()

int QVideoFrame::height

(

)

const

Returns the height of a video frame.

Definition at line 407 of file qvideoframe.cpp.

{
    return d->size.height();
}

imageFormatFromPixelFormat()

QImage::Format QVideoFrame::imageFormatFromPixelFormat ( 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.

Definition at line 701 of file qvideoframe.cpp.

{
    switch (format) {
    case Format_Invalid:
        return QImage::Format_Invalid;
    case Format_ARGB32:
        return QImage::Format_ARGB32;
    case Format_ARGB32_Premultiplied:
        return QImage::Format_ARGB32_Premultiplied;
    case Format_RGB32:
        return QImage::Format_RGB32;
    case Format_RGB24:
        return QImage::Format_RGB888;
    case Format_RGB565:
        return QImage::Format_RGB16;
    case Format_RGB555:
        return QImage::Format_RGB555;
    case Format_ARGB8565_Premultiplied:
        return QImage::Format_ARGB8565_Premultiplied;
    case Format_BGRA32:
    case Format_BGRA32_Premultiplied:
    case Format_BGR32:
    case Format_BGR24:
        return QImage::Format_Invalid;
    case Format_BGR565:
    case Format_BGR555:
    case Format_BGRA5658_Premultiplied:
    case Format_AYUV444:
    case Format_AYUV444_Premultiplied:
    case Format_YUV444:
    case Format_YUV420P:
    case Format_YV12:
    case Format_UYVY:
    case Format_YUYV:
    case Format_NV12:
    case Format_NV21:
    case Format_IMC1:
    case Format_IMC2:
    case Format_IMC3:
    case Format_IMC4:
    case Format_Y8:
    case Format_Y16:
        return QImage::Format_Invalid;
    case Format_User:
        return QImage::Format_Invalid;
    }
    return QImage::Format_Invalid;
}

isMapped()

bool QVideoFrame::isMapped

(

)

const

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

This is a convenience function which checks that the QAbstractVideoBuffer::MapMode{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

mapMode() QAbstractVideoBuffer::MapMode

Definition at line 444 of file qvideoframe.cpp.

{
    return d->buffer != 0 && d->buffer->mapMode() != QAbstractVideoBuffer::NotMapped;
}

isReadable()

bool QVideoFrame::isReadable

(

)

const

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{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

mapMode(), QAbstractVideoBuffer::MapMode

Definition at line 481 of file qvideoframe.cpp.

{
    return d->buffer != 0 && (d->buffer->mapMode() & QAbstractVideoBuffer::ReadOnly);
}

isValid()

bool QVideoFrame::isValid

(

)

const

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.

Definition at line 362 of file qvideoframe.cpp.

{
    return d->buffer != 0;
}

isWritable()

bool QVideoFrame::isWritable

(

)

const

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{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

mapMode(), QAbstractVideoBuffer::MapMode

Definition at line 464 of file qvideoframe.cpp.

{
    return d->buffer != 0 && (d->buffer->mapMode() & QAbstractVideoBuffer::WriteOnly);
}

map()

bool QVideoFrame::map

(

QAbstractVideoBuffer::MapMode

mode

)

Maps the contents of a video frame to memory.

The map mode indicates whether the contents of the mapped memory should be read from and/or written to the frame. If the map mode includes the QAbstractVideoBuffer::ReadOnly flag the mapped memory will be populated with the content of the video frame when mapped. If the map mode inclues the QAbstractVideoBuffer::WriteOnly flag the content of the mapped memory will be persisted in the frame when unmapped.

While mapped the contents of a video frame can be accessed directly through the pointer returned by the bits() function.

When access to the data is no longer needed be sure to call the unmap() function to release the mapped memory.

Returns true if the buffer was mapped to memory in the given mode and false otherwise.

See also

unmap(), mapMode(), bits()

Definition at line 517 of file qvideoframe.cpp.

{
    if (d->buffer != 0 && d->data == 0) {
        Q_ASSERT(d->bytesPerLine == 0);
        Q_ASSERT(d->mappedBytes == 0);

        d->data = d->buffer->map(mode, &d->mappedBytes, &d->bytesPerLine);

        return d->data != 0;
    }

    return false;
}

mapMode()

QAbstractVideoBuffer::MapMode QVideoFrame::mapMode

(

)

const

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

See also

map(), QAbstractVideoBuffer::MapMode

Definition at line 492 of file qvideoframe.cpp.

{
    return d->buffer != 0 ? d->buffer->mapMode() : QAbstractVideoBuffer::NotMapped;
}

mappedBytes()

int QVideoFrame::mappedBytes

(

)

const

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

This value is only valid while the frame data is map(){mapped}.

See also

map()

Definition at line 601 of file qvideoframe.cpp.

{
    return d->mappedBytes;
}

operator=()

QVideoFrame & QVideoFrame::operator=

(

const QVideoFrame &

other

)

Assigns the contents of other to a video frame.

Definition at line 339 of file qvideoframe.cpp.

{
    d = other.d;

    return *this;
}

pixelFormat()

QVideoFrame::PixelFormat QVideoFrame::pixelFormat

(

)

const

Returns the color format of a video frame.

Definition at line 371 of file qvideoframe.cpp.

{
    return d->pixelFormat;
}

pixelFormatFromImageFormat()

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

static

Returns an video pixel format equivalent to an image format.

If there is no equivalent format QVideoFrame::InvalidType is returned instead.

Definition at line 660 of file qvideoframe.cpp.

{
    switch (format) {
    case QImage::Format_Invalid:
    case QImage::Format_Mono:
    case QImage::Format_MonoLSB:
    case QImage::Format_Indexed8:
        return Format_Invalid;
    case QImage::Format_RGB32:
        return Format_RGB32;
    case QImage::Format_ARGB32:
        return Format_ARGB32;
    case QImage::Format_ARGB32_Premultiplied:
        return Format_ARGB32_Premultiplied;
    case QImage::Format_RGB16:
        return Format_RGB565;
    case QImage::Format_ARGB8565_Premultiplied:
        return Format_ARGB8565_Premultiplied;
    case QImage::Format_RGB666:
    case QImage::Format_ARGB6666_Premultiplied:
        return Format_Invalid;
    case QImage::Format_RGB555:
        return Format_RGB555;
    case QImage::Format_ARGB8555_Premultiplied:
        return Format_Invalid;
    case QImage::Format_RGB888:
        return Format_RGB24;
    case QImage::Format_RGB444:
    case QImage::Format_ARGB4444_Premultiplied:
        return Format_Invalid;
    case QImage::NImageFormats:
        return Format_Invalid;
    }
    return Format_Invalid;
}

setEndTime()

void QVideoFrame::setEndTime

(

qint64

time

)

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

Definition at line 650 of file qvideoframe.cpp.

{
    d->endTime = time;
}

setFieldType()

void QVideoFrame::setFieldType

(

QVideoFrame::FieldType

field

)

Sets the field an interlaced video frame belongs to.

Definition at line 427 of file qvideoframe.cpp.

{
    d->fieldType = field;
}

setStartTime()

void QVideoFrame::setStartTime

(

qint64

time

)

Sets the presentation time when the frame should be displayed.

Definition at line 632 of file qvideoframe.cpp.

{
    d->startTime = time;
}

size()

QSize QVideoFrame::size

(

)

const

Returns the size of a video frame.

Definition at line 389 of file qvideoframe.cpp.

{
    return d->size;
}

startTime()

qint64 QVideoFrame::startTime

(

)

const

Returns the presentation time when the frame should be displayed.

Definition at line 623 of file qvideoframe.cpp.

{
    return d->startTime;
}

unmap()

void QVideoFrame::unmap

(

)

Releases the memory mapped by the map() function.

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

See also

map()

Definition at line 540 of file qvideoframe.cpp.

{
    if (d->data != 0) {
        d->mappedBytes = 0;
        d->bytesPerLine = 0;
        d->data = 0;

        d->buffer->unmap();
    }
}

width()

int QVideoFrame::width

(

)

const

Returns the width of a video frame.

Definition at line 398 of file qvideoframe.cpp.

{
    return d->size.width();
}

Properties

d

QExplicitlySharedDataPointer<QVideoFramePrivate> QVideoFrame::d

private

Definition at line 158 of file qvideoframe.h.

Referenced by bits(), bytesPerLine(), endTime(), fieldType(), handle(), handleType(), height(), isMapped(), isReadable(), isValid(), isWritable(), map(), mapMode(), mappedBytes(), operator=(), pixelFormat(), QVideoFrame(), setEndTime(), setFieldType(), setStartTime(), size(), startTime(), unmap(), and width().

---

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

• /src/multimedia/video/qvideoframe.h
• /src/multimedia/video/qvideoframe.cpp