The FrameGrabber stores frames that arrive from a surface capture, and is used to inspect captured frames in the tests. More...

#include <framegrabber_p.h>

Inheritance diagram for QtMultimediaTest::FrameGrabber:

Collaboration diagram for QtMultimediaTest::FrameGrabber:

Public Slots
void	stop ()
void	onCaptureActiveChanged (bool active)
	Starts tracking a new stream when the capture becomes active, so that tryWaitForFirstFrameInfo() waits for the first frame of it.
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Public Member Functions
	FrameGrabber ()
const std::vector< VideoFrameInfo > &	getFrameInfos () const
std::vector< VideoFrameInfo >	waitAndTakeFrameInfos (size_t minCount, std::optional< qreal > expectedFrameRate=std::nullopt, qint64 noOlderThanTime=0)
	Wait for at least minCount frames that are no older than noOlderThanTime.
std::vector< QVideoFrame >	waitAndTakeVideoFrames (size_t minCount, std::optional< qreal > expectedFrameRate=std::nullopt, qint64 noOlderThanTime=0)
	Same as waitAndTakeFrameInfos(), but returns the video frames themselves.
std::optional< VideoFrameInfo >	tryWaitForFirstFrameInfo ()
	Waits for the first frame of the current stream, and returns a copy of its info.
std::optional< QVideoFrame >	consumeFirstVideoFrame ()
	Same as tryWaitForFirstFrameInfo(), but returns the video frame itself, and consumes it.
void	setRetainFirstVideoFrame (bool retain)
std::optional< std::chrono::milliseconds >	durationBetweenFrames (qsizetype frameCount=1, std::optional< qreal > expectedFrameRate=std::nullopt)
	Measures the average duration between frameCount consecutive frames.
bool	isStopped () const
Public Member Functions inherited from QVideoSink
	QVideoSink (QObject *parent=nullptr)
	Constructs a new QVideoSink object with parent.
	~QVideoSink () override
	Destroys the object.
QRhi *	rhi () const
	Returns the QRhi instance being used to create texture data in the video frames.
void	setRhi (QRhi *rhi)
QSize	videoSize () const
QString	subtitleText () const
void	setSubtitleText (const QString &subtitle)
	Sets the current subtitle text.
void	setVideoFrame (const QVideoFrame &frame)
	\threadsafe
QVideoFrame	videoFrame () const
	\threadsafe
QPlatformVideoSink *	platformVideoSink () const
Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.
virtual	~QObject ()
	Destroys the object, deleting all its child objects.
virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.
virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.
QString	objectName () const
Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.
void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
QBindable< QString >	bindableObjectName ()
bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.
bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.
bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.
bool	isQmlExposed () const noexcept
	Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.
bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
QThread *	thread () const
	Returns the thread in which the object lives.
bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.
int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void	killTimer (int id)
	Kills the timer with timer identifier, id.
void	killTimer (Qt::TimerId id)
template<typename T>
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
template<typename T>
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
template<typename T>
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename T>
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const QObjectList &	children () const
	Returns a list of child objects.
void	setParent (QObject *parent)
	Makes the object a child of parent.
void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.
void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.
QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const
bool	disconnect (const QObject receiver, const char member=nullptr) const
void	dumpObjectTree () const
	Dumps a tree of children to the debug output.
void	dumpObjectInfo () const
	Dumps information about signal connections, etc.
bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.
bool	setProperty (const char *name, QVariant &&value)
QVariant	property (const char *name) const
	Returns the value of the object's name property.
QList< QByteArray >	dynamicPropertyNames () const
QBindingStorage *	bindingStorage ()
const QBindingStorage *	bindingStorage () const
QObject *	parent () const
	Returns a pointer to the parent object.
bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Additional Inherited Members
Signals inherited from QVideoSink
void	videoFrameChanged (const QVideoFrame &frame) QT6_ONLY(const)
	Signals when the video frame changes.
void	subtitleTextChanged (const QString &subtitleText) QT6_ONLY(const)
void	videoSizeChanged ()
Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.
Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe
static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe
static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)
static bool	disconnect (const QMetaObject::Connection &)
	Disconnects connection and resets it to \l{QMetaObject::Connection::operator bool()}{invalid}.
static bool	disconnect (QMetaObject::Connection &)
static bool	disconnect (QMetaObject::Connection &&conn)
	Disconnect a connection.
template<typename Func1, typename Func2>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)
template<typename Func1>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)
Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
int	senderSignalIndex () const
int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.
bool	isSignalConnected (const QMetaMethod &signal) const
virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.
virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.
virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	disconnectNotify (const QMetaMethod &signal)
	QObject (QObjectPrivate &dd, QObject *parent=nullptr)
Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr
Properties inherited from QVideoSink
QString	subtitleText
	Returns the current subtitle text.
QSize	videoSize
	Returns the size of the video currently being played back.
Properties inherited from QObject
QString	objectName
	the name of this object
Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()
template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()
	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

The FrameGrabber stores frames that arrive from a surface capture, and is used to inspect captured frames in the tests.

Definition at line 47 of file framegrabber_p.h.

Constructor & Destructor Documentation

◆ FrameGrabber()

QtMultimediaTest::FrameGrabber::FrameGrabber ( )

Definition at line 67 of file framegrabber.cpp.

Member Function Documentation

◆ consumeFirstVideoFrame()

std::optional< QVideoFrame > QtMultimediaTest::FrameGrabber::consumeFirstVideoFrame ( )

nodiscard

Same as tryWaitForFirstFrameInfo(), but returns the video frame itself, and consumes it.

The first frame of a stream is only kept alive if setRetainFirstVideoFrame() was enabled before the stream started, since holding on to frames can stall backends that use a fixed-size frame pool.

Definition at line 182 of file framegrabber.cpp.

◆ durationBetweenFrames()

std::optional< std::chrono::milliseconds > QtMultimediaTest::FrameGrabber::durationBetweenFrames	(	qsizetype	frameCount = 1,
		std::optional< qreal >	expectedFrameRate = std::nullopt )

nodiscard

Measures the average duration between frameCount consecutive frames.

If expectedFrameRate is given, a frame that takes significantly longer than the frame interval to arrive ends the wait early. The first frame is still allowed the global timeout, since backend initialization can delay it.

Returns std::nullopt if a frame stalled, or if not enough frames arrived.

Definition at line 208 of file framegrabber.cpp.

◆ getFrameInfos()

const std::vector< VideoFrameInfo > & QtMultimediaTest::FrameGrabber::getFrameInfos ( ) const

nodiscard

Definition at line 90 of file framegrabber.cpp.

◆ isStopped()

bool QtMultimediaTest::FrameGrabber::isStopped ( ) const

nodiscard

Definition at line 251 of file framegrabber.cpp.

◆ onCaptureActiveChanged

void QtMultimediaTest::FrameGrabber::onCaptureActiveChanged ( bool active )

slot

Starts tracking a new stream when the capture becomes active, so that tryWaitForFirstFrameInfo() waits for the first frame of it.

Definition at line 256 of file framegrabber.cpp.

◆ setRetainFirstVideoFrame()

void QtMultimediaTest::FrameGrabber::setRetainFirstVideoFrame ( bool retain )

Definition at line 195 of file framegrabber.cpp.

◆ stop

void QtMultimediaTest::FrameGrabber::stop ( )

slot

Definition at line 266 of file framegrabber.cpp.

◆ tryWaitForFirstFrameInfo()

std::optional< VideoFrameInfo > QtMultimediaTest::FrameGrabber::tryWaitForFirstFrameInfo ( )

nodiscard

Waits for the first frame of the current stream, and returns a copy of its info.

The capture becoming active marks the start of a new stream, so the next valid frame after it is the first frame of that stream. Calling this again within the same stream returns the same info.

Returns std::nullopt if no first frame arrived before the global timeout, or if the grabber was stopped. Can never return an invalid frame.

Definition at line 174 of file framegrabber.cpp.

◆ waitAndTakeFrameInfos()

std::vector< VideoFrameInfo > QtMultimediaTest::FrameGrabber::waitAndTakeFrameInfos	(	size_t	minCount,
		std::optional< qreal >	expectedFrameRate = std::nullopt,
		qint64	noOlderThanTime = 0 )

nodiscard

Wait for at least minCount frames that are no older than noOlderThanTime.

If expectedFrameRate is given, the timeout is extended by one frame interval per frame, rather than being a flat global timeout.

Returns empty if not enough frames arrived, or if grabber was stopped before global timeout elapsed.

Definition at line 95 of file framegrabber.cpp.

◆ waitAndTakeVideoFrames()

std::vector< QVideoFrame > QtMultimediaTest::FrameGrabber::waitAndTakeVideoFrames	(	size_t	minCount,
		std::optional< qreal >	expectedFrameRate = std::nullopt,
		qint64	noOlderThanTime = 0 )

nodiscard

Same as waitAndTakeFrameInfos(), but returns the video frames themselves.

Video frames are only retained for the duration of this call.

Definition at line 103 of file framegrabber.cpp.

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

qtmultimedia/src/multimediatestlib/framegrabber_p.h (316df624a55da48e16f84534e95e13992863317e)
qtmultimedia/src/multimediatestlib/framegrabber.cpp (316df624a55da48e16f84534e95e13992863317e)

Public Slots

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FrameGrabber()

Member Function Documentation

◆ consumeFirstVideoFrame()

◆ durationBetweenFrames()

◆ getFrameInfos()

◆ isStopped()

◆ onCaptureActiveChanged

◆ setRetainFirstVideoFrame()

◆ stop

◆ tryWaitForFirstFrameInfo()

◆ waitAndTakeFrameInfos()

◆ waitAndTakeVideoFrames()