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
Public Member Functions | List of all members
AVFVideoBuffer Class Reference

#include <avfvideobuffer_p.h>

+ Inheritance diagram for AVFVideoBuffer:
+ Collaboration diagram for AVFVideoBuffer:

Public Member Functions

 AVFVideoBuffer (AVFVideoSinkInterface *sink, CVImageBufferRef buffer)
 
 ~AVFVideoBuffer ()
 
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.
 
quint64 textureHandle (QRhi &, int plane) override
 
QVideoFrameFormat videoFormat () const
 
- Public Member Functions inherited from QHwVideoBuffer
 QHwVideoBuffer (QVideoFrame::HandleType type, QRhi *rhi=nullptr)
 
 ~QHwVideoBuffer () override
 
QVideoFrame::HandleType handleType () const
 
virtual QRhi * rhi () const
 
QVideoFrameFormat format () const override
 Gets \l QVideoFrameFormat of the underlying video buffer.
 
virtual QMatrix4x4 externalTextureMatrix () const
 
virtual QVideoFrameTexturesUPtr mapTextures (QRhi &, QVideoFrameTexturesUPtr &)
 
virtual void initTextureConverter (QRhi &)
 
- Public Member Functions inherited from QAbstractVideoBuffer
virtual ~QAbstractVideoBuffer ()
 \variable QAbstractVideoBuffer::MapData::planeCount
 
- Public Member Functions inherited from QVideoFrameTexturesHandles
virtual ~QVideoFrameTexturesHandles ()
 

Additional Inherited Members

- Protected Attributes inherited from QHwVideoBuffer
QVideoFrame::HandleType m_type
 
QRhi * m_rhi = nullptr
 

Detailed Description

Definition at line 33 of file avfvideobuffer_p.h.

Constructor & Destructor Documentation

◆ AVFVideoBuffer()

QT_USE_NAMESPACE AVFVideoBuffer::AVFVideoBuffer ( AVFVideoSinkInterface * sink,
CVImageBufferRef buffer )

Definition at line 21 of file avfvideobuffer.mm.

◆ ~AVFVideoBuffer()

AVFVideoBuffer::~AVFVideoBuffer ( )

Definition at line 37 of file avfvideobuffer.mm.

Member Function Documentation

◆ map()

AVFVideoBuffer::MapData AVFVideoBuffer::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 53 of file avfvideobuffer.mm.

◆ textureHandle()

quint64 AVFVideoBuffer::textureHandle ( QRhi & ,
int plane )
overridevirtual

Reimplemented from QVideoFrameTexturesHandles.

Definition at line 127 of file avfvideobuffer.mm.

◆ unmap()

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

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 86 of file avfvideobuffer.mm.

◆ videoFormat()

QVideoFrameFormat AVFVideoBuffer::videoFormat ( ) const
inline

Definition at line 44 of file avfvideobuffer_p.h.

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