Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
AndroidTextureVideoBuffer Class Reference
Inheritance diagram for AndroidTextureVideoBuffer:
Collaboration diagram for AndroidTextureVideoBuffer:

Public Member Functions

 AndroidTextureVideoBuffer (std::shared_ptr< QRhi > rhi, std::shared_ptr< AndroidTextureThread > thread, std::unique_ptr< QRhiTexture > tex, const QSize &size)
MapData map (QVideoFrame::MapMode mode) override
 Maps the planes of a video buffer to memory.
void unmap () override
 Releases the memory mapped by the map() function.
QVideoFrameTexturesUPtr mapTextures (QRhi &rhi, QVideoFrameTexturesUPtr &) override
 AndroidTextureVideoBuffer (std::shared_ptr< QRhi > rhi, std::shared_ptr< AndroidTextureThread > thread, std::unique_ptr< QRhiTexture > tex, const QSize &size)
MapData map (QVideoFrame::MapMode mode) override
 Maps the planes of a video buffer to memory.
void unmap () override
 Releases the memory mapped by the map() function.
QVideoFrameTexturesUPtr mapTextures (QRhi &rhi, QVideoFrameTexturesUPtr &) override
Public Member Functions inherited from QRhiWithThreadGuard
 QRhiWithThreadGuard (std::shared_ptr< QRhi > r, std::shared_ptr< AndroidTextureThread > t)
 ~QRhiWithThreadGuard ()
 QRhiWithThreadGuard (std::shared_ptr< QRhi > r, std::shared_ptr< AndroidTextureThread > t)
 ~QRhiWithThreadGuard ()
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< QStringbindableObjectName ()
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 isQmlObjectType () const
 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).
QThreadthread () 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>
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>
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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const
QBindingStoragebindingStorage ()
const QBindingStoragebindingStorage () const
QObjectparent () 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.
Public Member Functions inherited from QHwVideoBuffer
 QHwVideoBuffer (QVideoFrame::HandleType type, QRhi *rhi=nullptr)
 ~QHwVideoBuffer () override
QVideoFrame::HandleType handleType () const
virtual QRhirhi () const
QVideoFrameFormat format () const override
 Gets \l QVideoFrameFormat of the underlying video buffer.
virtual QMatrix4x4 externalTextureMatrix () const
virtual void initTextureConverter (QRhi &)
virtual bool isDmaBuf () const
Public Member Functions inherited from QAbstractVideoBuffer
virtual ~QAbstractVideoBuffer ()
 \variable QAbstractVideoBuffer::MapData::planeCount
Public Member Functions inherited from QVideoFrameTexturesHandles
virtual ~QVideoFrameTexturesHandles ()
virtual quint64 textureHandle (QRhi &, int)

Additional Inherited Members

Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
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 &)
 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
QObjectsender () 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 QRhiWithThreadGuard
std::shared_ptr< QRhim_guardRhi
Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
Protected Attributes inherited from QHwVideoBuffer
QVideoFrame::HandleType m_type
QRhim_rhi = nullptr
Properties inherited from QObject
QString objectName
 the name of this object

Detailed Description

Definition at line 53 of file qandroidvideooutput.cpp.

Constructor & Destructor Documentation

◆ AndroidTextureVideoBuffer() [1/2]

AndroidTextureVideoBuffer::AndroidTextureVideoBuffer ( std::shared_ptr< QRhi > rhi,
std::shared_ptr< AndroidTextureThread > thread,
std::unique_ptr< QRhiTexture > tex,
const QSize & size )
inline

Definition at line 56 of file qandroidvideooutput.cpp.

References AndroidTextureVideoBuffer().

Referenced by AndroidTextureVideoBuffer().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ AndroidTextureVideoBuffer() [2/2]

AndroidTextureVideoBuffer::AndroidTextureVideoBuffer ( std::shared_ptr< QRhi > rhi,
std::shared_ptr< AndroidTextureThread > thread,
std::unique_ptr< QRhiTexture > tex,
const QSize & size )
inline

Definition at line 56 of file qandroidvideooutput.cpp.

Member Function Documentation

◆ map() [1/2]

QAbstractVideoBuffer::MapData AndroidTextureVideoBuffer::map ( QVideoFrame::MapMode mode)
overridevirtual

Maps the planes of a video buffer to memory.

Returns a \l MapData structure that contains information about the plane layout of the mapped current video data. If the mapping fails, the method returns the default structure. For CPU memory buffers, the data is considered as already mapped, so the function just returns the plane layout of the preallocated underlying data.

The map mode indicates whether the contents of the mapped memory should be read from and/or written to the buffer. If the map mode includes the QVideoFrame::ReadOnly flag the mapped memory will be populated with the content of the buffer when initially mapped. If the map mode includes the QVideoFrame::WriteOnly flag the content of the possibly modified mapped memory will be written back to the buffer when unmapped.

When access to the data is no longer needed, the \l unmap function is called to release the mapped memory and possibly update the buffer contents.

If the format of the video data is multiplanar, the method may map the whole pixel data as a single plane. In this case, mapping a buffer with \l QVideoFrame will calculate additional planes from the specified line stride of the first plane, the frame height, and the data size.

Implements QAbstractVideoBuffer.

Definition at line 103 of file qandroidvideooutput.cpp.

◆ map() [2/2]

MapData AndroidTextureVideoBuffer::map ( QVideoFrame::MapMode mode)
overridevirtual

Maps the planes of a video buffer to memory.

Returns a \l MapData structure that contains information about the plane layout of the mapped current video data. If the mapping fails, the method returns the default structure. For CPU memory buffers, the data is considered as already mapped, so the function just returns the plane layout of the preallocated underlying data.

The map mode indicates whether the contents of the mapped memory should be read from and/or written to the buffer. If the map mode includes the QVideoFrame::ReadOnly flag the mapped memory will be populated with the content of the buffer when initially mapped. If the map mode includes the QVideoFrame::WriteOnly flag the content of the possibly modified mapped memory will be written back to the buffer when unmapped.

When access to the data is no longer needed, the \l unmap function is called to release the mapped memory and possibly update the buffer contents.

If the format of the video data is multiplanar, the method may map the whole pixel data as a single plane. In this case, mapping a buffer with \l QVideoFrame will calculate additional planes from the specified line stride of the first plane, the frame height, and the data size.

Implements QAbstractVideoBuffer.

◆ mapTextures() [1/2]

QVideoFrameTexturesUPtr AndroidTextureVideoBuffer::mapTextures ( QRhi & rhi,
QVideoFrameTexturesUPtr &  )
inlineoverridevirtual

Reimplemented from QHwVideoBuffer.

Definition at line 73 of file qandroidvideooutput.cpp.

◆ mapTextures() [2/2]

QVideoFrameTexturesUPtr AndroidTextureVideoBuffer::mapTextures ( QRhi & rhi,
QVideoFrameTexturesUPtr &  )
inlineoverridevirtual

Reimplemented from QHwVideoBuffer.

Definition at line 73 of file qandroidvideooutput.cpp.

◆ unmap() [1/2]

void AndroidTextureVideoBuffer::unmap ( )
inlineoverridevirtual

Releases the memory mapped by the map() function.

If the \l {QVideoFrame::MapMode}{MapMode} included the QVideoFrame::WriteOnly flag this will write the current content of the mapped memory back to the video frame.

For CPU video buffers, the function may be not overridden. The default implementation of unmap does nothing.

See also
map()

Reimplemented from QAbstractVideoBuffer.

Definition at line 67 of file qandroidvideooutput.cpp.

◆ unmap() [2/2]

void AndroidTextureVideoBuffer::unmap ( )
inlineoverridevirtual

Releases the memory mapped by the map() function.

If the \l {QVideoFrame::MapMode}{MapMode} included the QVideoFrame::WriteOnly flag this will write the current content of the mapped memory back to the video frame.

For CPU video buffers, the function may be not overridden. The default implementation of unmap does nothing.

See also
map()

Reimplemented from QAbstractVideoBuffer.

Definition at line 67 of file qandroidvideooutput.cpp.


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