Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QGstVideoBuffer Class Referencefinal

#include <qgstvideobuffer_p.h>

+ Inheritance diagram for QGstVideoBuffer:
+ Collaboration diagram for QGstVideoBuffer:

Public Member Functions

 QGstVideoBuffer (QGstBufferHandle buffer, const GstVideoInfo &info, QGstreamerVideoSink *sink, const QVideoFrameFormat &frameFormat, QGstCaps::MemoryFormat format)
 
 ~QGstVideoBuffer ()
 
QVideoFrame::MapMode mapMode () const override
 
MapData map (QVideoFrame::MapMode mode) override
 Independently maps the planes of a video buffer to memory.
 
void unmap () override
 Releases the memory mapped by the map() function.
 
std::unique_ptr< QVideoFrameTexturesmapTextures (QRhi *) override
 
- Public Member Functions inherited from QAbstractVideoBuffer
 QAbstractVideoBuffer (QVideoFrame::HandleType type, QRhi *rhi=nullptr)
 Constructs an abstract video buffer of the given type.
 
virtual ~QAbstractVideoBuffer ()
 Destroys an abstract video buffer.
 
QVideoFrame::HandleType handleType () const
 Returns the type of a video buffer's handle.
 
QRhirhi () const
 Returns the QRhi instance.
 
virtual quint64 textureHandle (QRhi *, int) const
 Returns a texture handle to the data buffer.
 
virtual QMatrix4x4 externalTextureMatrix () const
 
virtual QByteArray underlyingByteArray (int) const
 

Additional Inherited Members

- Protected Attributes inherited from QAbstractVideoBuffer
QVideoFrame::HandleType m_type
 
QRhim_rhi = nullptr
 

Detailed Description

Definition at line 30 of file qgstvideobuffer_p.h.

Constructor & Destructor Documentation

◆ QGstVideoBuffer()

QGstVideoBuffer::QGstVideoBuffer ( QGstBufferHandle buffer,
const GstVideoInfo & info,
QGstreamerVideoSink * sink,
const QVideoFrameFormat & frameFormat,
QGstCaps::MemoryFormat format )

Definition at line 54 of file qgstvideobuffer.cpp.

References Q_UNUSED.

◆ ~QGstVideoBuffer()

QGstVideoBuffer::~QGstVideoBuffer ( )

Definition at line 77 of file qgstvideobuffer.cpp.

References unmap().

+ Here is the call graph for this function:

Member Function Documentation

◆ map()

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

Independently maps the planes of a video buffer to memory.

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 be sure to call the unmap() function to release the mapped memory and possibly update the buffer contents.

Returns the number of planes in the mapped video data. For each plane the line stride of that plane will be returned in bytesPerLine, and a pointer to the plane data will be returned in data. The accumulative size of the mapped data is returned in numBytes.

Not all buffer implementations will map more than the first plane, if this returns a single plane for a planar format the additional planes will have to be calculated from the line stride of the first plane and the frame height. Mapping a buffer with QVideoFrame will do this for you.

To implement this function create a derivative of QAbstractPlanarVideoBuffer and implement its map function instance instead.

Since
5.4

Implements QAbstractVideoBuffer.

Definition at line 88 of file qgstvideobuffer.cpp.

References QGstImpl::QSharedHandle< HandleTraits >::get(), i, mapData(), QVideoFrame::NotMapped, QVideoFrame::ReadOnly, and QVideoFrame::WriteOnly.

+ Here is the call graph for this function:

◆ mapMode()

QVideoFrame::MapMode QGstVideoBuffer::mapMode ( ) const
overridevirtual

Implements QAbstractVideoBuffer.

Definition at line 83 of file qgstvideobuffer.cpp.

◆ mapTextures()

std::unique_ptr< QVideoFrameTextures > QGstVideoBuffer::mapTextures ( QRhi * rhi)
overridevirtual

Reimplemented from QAbstractVideoBuffer.

Definition at line 375 of file qgstvideobuffer.cpp.

References QGstCaps::DMABuf, QGstCaps::GLTexture, QVideoFrameFormat::pixelFormat(), and QAbstractVideoBuffer::rhi().

+ Here is the call graph for this function:

◆ unmap()

void QGstVideoBuffer::unmap ( )
overridevirtual

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.

See also
map()

Implements QAbstractVideoBuffer.

Definition at line 120 of file qgstvideobuffer.cpp.

References QGstImpl::QSharedHandle< HandleTraits >::get(), and QVideoFrame::NotMapped.

Referenced by ~QGstVideoBuffer().

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

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