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
qvideoframe.h
Go to the documentation of this file.
1// Copyright (C) 2016 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3
4#ifndef QVIDEOFRAME_H
5#define QVIDEOFRAME_H
6
7#include <QtMultimedia/qtmultimediaglobal.h>
8#include <QtMultimedia/qtvideo.h>
9#include <QtMultimedia/qvideoframeformat.h>
10
11#include <QtCore/qmetatype.h>
12#include <QtCore/qshareddata.h>
13#include <QtGui/qimage.h>
14
15QT_BEGIN_NAMESPACE
16
17class QSize;
18class QVideoFramePrivate;
19class QAbstractVideoBuffer;
20class QRhi;
21class QRhiResourceUpdateBatch;
22class QRhiTexture;
23
24QT_DECLARE_QESDP_SPECIALIZATION_DTOR_WITH_EXPORT(QVideoFramePrivate, Q_MULTIMEDIA_EXPORT)
25
26class Q_MULTIMEDIA_EXPORT QVideoFrame
27{
28 Q_GADGET
29public:
30
31 enum HandleType
32 {
33 NoHandle,
34 RhiTextureHandle
35 };
36
37 enum MapMode
38 {
39 NotMapped Q_DECL_ENUMERATOR_DEPRECATED_X("Use QtVideo::MapMode::NotMapped instead")
40 = static_cast<int>(QtVideo::MapMode::NotMapped),
41 ReadOnly Q_DECL_ENUMERATOR_DEPRECATED_X("Use QtVideo::MapMode::ReadOnly instead")
42 = static_cast<int>(QtVideo::MapMode::ReadOnly),
43 WriteOnly Q_DECL_ENUMERATOR_DEPRECATED_X("Use QtVideo::MapMode::WriteOnly instead")
44 = static_cast<int>(QtVideo::MapMode::WriteOnly),
45 ReadWrite Q_DECL_ENUMERATOR_DEPRECATED_X("Use QtVideo::MapMode::ReadWrite instead")
46 = static_cast<int>(QtVideo::MapMode::ReadWrite)
47 };
48
49#if QT_DEPRECATED_SINCE(6, 7)
50 enum RotationAngle
51 {
52 Rotation0 Q_DECL_ENUMERATOR_DEPRECATED_X("Use QtVideo::Rotation::None instead") = 0,
53 Rotation90 Q_DECL_ENUMERATOR_DEPRECATED_X("Use QtVideo::Rotation::Clockwise90 instead") = 90,
54 Rotation180 Q_DECL_ENUMERATOR_DEPRECATED_X("Use QtVideo::Rotation::Clockwise180 instead") = 180,
55 Rotation270 Q_DECL_ENUMERATOR_DEPRECATED_X("Use QtVideo::Rotation::Clockwise270 instead") = 270
56 };
57#endif
58
59 QVideoFrame();
60 QVideoFrame(const QVideoFrameFormat &format);
61 explicit QVideoFrame(const QImage &image);
62 explicit QVideoFrame(std::unique_ptr<QAbstractVideoBuffer> videoBuffer);
63 QVideoFrame(const QVideoFrame &other);
64 ~QVideoFrame();
65
66 QVideoFrame(QVideoFrame &&other) noexcept = default;
67 QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_PURE_SWAP(QVideoFrame)
68 void swap(QVideoFrame &other) noexcept
69 { d.swap(other.d); }
70
71
72 QVideoFrame &operator =(const QVideoFrame &other);
73 bool operator==(const QVideoFrame &other) const;
74 bool operator!=(const QVideoFrame &other) const;
75
76 bool isValid() const;
77
78 QVideoFrameFormat::PixelFormat pixelFormat() const;
79
80 QVideoFrameFormat surfaceFormat() const;
81 QVideoFrame::HandleType handleType() const;
82
83 QSize size() const;
84 int width() const;
85 int height() const;
86
87 bool isMapped() const;
88 bool isReadable() const;
89 bool isWritable() const;
90
91 QVideoFrame::MapMode mapMode() const;
92
93 bool map(QtVideo::MapMode mode);
94#if QT_DEPRECATED_SINCE(6, 8)
95 QT_DEPRECATED_VERSION_X_6_7("Use QVideoFrame::map(QtVideo::MapMode) instead")
96 bool map(QVideoFrame::MapMode mode);
97#endif
98 void unmap();
99
100 int bytesPerLine(int plane) const;
101
102 uchar *bits(int plane);
103 const uchar *bits(int plane) const;
104 int mappedBytes(int plane) const;
105 int planeCount() const;
106
107 qint64 startTime() const;
108 void setStartTime(qint64 time);
109
110 qint64 endTime() const;
111 void setEndTime(qint64 time);
112
113#if QT_DEPRECATED_SINCE(6, 7)
114 QT_DEPRECATED_VERSION_X_6_7("Use QVideoFrame::setRotation(QtVideo::Rotation) instead")
115 void setRotationAngle(RotationAngle angle) { setRotation(QtVideo::Rotation(angle)); }
116
117 QT_DEPRECATED_VERSION_X_6_7("Use QVideoFrame::rotation() instead")
118 RotationAngle rotationAngle() const { return RotationAngle(rotation()); }
119#endif
120
121 void setRotation(QtVideo::Rotation angle);
122 QtVideo::Rotation rotation() const;
123
124 void setMirrored(bool);
125 bool mirrored() const;
126
127 void setStreamFrameRate(qreal rate);
128 qreal streamFrameRate() const;
129
130 QImage toImage() const;
131
132 struct PaintOptions {
133 QColor backgroundColor = Qt::transparent;
134 Qt::AspectRatioMode aspectRatioMode = Qt::KeepAspectRatio;
135 enum PaintFlag {
136 DontDrawSubtitles = 0x1
137 };
138 Q_DECLARE_FLAGS(PaintFlags, PaintFlag)
139 PaintFlags paintFlags = {};
140 };
141
142 QString subtitleText() const;
143 void setSubtitleText(const QString &text);
144
145 void paint(QPainter *painter, const QRectF &rect, const PaintOptions &options);
146
147#if QT_DEPRECATED_SINCE(6, 8)
148 QT_DEPRECATED_VERSION_X_6_8("The constructor is internal and deprecated")
149 QVideoFrame(QAbstractVideoBuffer *buffer, const QVideoFrameFormat &format);
150
151 QT_DEPRECATED_VERSION_X_6_8("The method is internal and deprecated")
152 QAbstractVideoBuffer *videoBuffer() const;
153#endif
154private:
155 friend class QVideoFramePrivate;
156 QExplicitlySharedDataPointer<QVideoFramePrivate> d;
157};
158
159Q_DECLARE_SHARED(QVideoFrame)
160
161#ifndef QT_NO_DEBUG_STREAM
162Q_MULTIMEDIA_EXPORT QDebug operator<<(QDebug, const QVideoFrame&);
163Q_MULTIMEDIA_EXPORT QDebug operator<<(QDebug, QVideoFrame::HandleType);
164#endif
165
166QT_END_NAMESPACE
167
168Q_DECLARE_METATYPE(QVideoFrame)
169
170#endif
171
QAbstractVideoBuffer
The QAbstractVideoBuffer class is an abstraction for video data. \inmodule QtMultimedia.
Definition qabstractvideobuffer.h:14
QColor
The QColor class provides colors based on RGB, HSV or CMYK values.
Definition qcolor.h:31
QDebug
\inmodule QtCore
QImage
\inmodule QtGui
Definition qimage.h:37
QPainter
The QPainter class performs low-level painting on widgets and other paint devices.
Definition qpainter.h:46
QRectF
\inmodule QtCore\reentrant
Definition qrect.h:484
QRhiResourceUpdateBatch
\inmodule QtGui
Definition qrhi.h:1732
QRhiTexture
\inmodule QtGui
Definition qrhi.h:895
QRhi
\inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h
Definition qrhi.h:1805
QSize
\inmodule QtCore
Definition qsize.h:25
QString
\macro QT_RESTRICTED_CAST_FROM_ASCII
Definition qstring.h:129
QVideoFrameFormat
The QVideoFrameFormat class specifies the stream format of a video presentation surface.
Definition qvideoframeformat.h:28
QVideoFrameFormat::PixelFormat
PixelFormat
Enumerates video data types.
Definition qvideoframeformat.h:32
QVideoFrame
The QVideoFrame class represents a frame of video data.
Definition qvideoframe.h:27
QVideoFrame::QVideoFrame
QVideoFrame(const QVideoFrame &other)
Constructs a shallow copy of other.
QVideoFrame::HandleType
HandleType
Identifies the type of a video buffers handle.
Definition qvideoframe.h:32
QVideoFrame::~QVideoFrame
~QVideoFrame()
Destroys a video frame.
QVideoFrame::QVideoFrame
QVideoFrame(QVideoFrame &&other) noexcept=default
Constructs a QVideoFrame by moving from other.
map
QMap< QString, QString > map
[6]
Definition doc_src_containers.cpp:96
paint
QPainter paint
Definition doc_src_groups.cpp:25
text
QString text
Definition doc_src_properties.cpp:105
rect
rect
[4]
Definition doc_src_styles.cpp:43
QT_BEGIN_NAMESPACE
Combined button and popup list for selecting options.
Definition qstandardpaths_haiku.cpp:21
QT_END_NAMESPACE
Definition qsharedpointer.cpp:1590
QtVideo::MapMode
MapMode
Enumerates how a video buffer's data is mapped to system memory.
Definition qtvideo.h:25
Qt::AspectRatioMode
AspectRatioMode
Definition qnamespace.h:1190
Qt::KeepAspectRatio
@ KeepAspectRatio
Definition qnamespace.h:1192
Qt::transparent
@ transparent
Definition qnamespace.h:47
image
Definition image.cpp:4
startTime
qint64 startTime
Definition qavfsamplebufferdelegate.mm:118
Q_DECL_ENUMERATOR_DEPRECATED_X
#define Q_DECL_ENUMERATOR_DEPRECATED_X(x)
Definition qcompilerdetection.h:1004
operator!=
constexpr bool operator!=(const timespec &t1, const timespec &t2)
Definition qcore_unix_p.h:110
void
DBusConnection const char DBusError DBusBusType DBusError return DBusConnection DBusHandleMessageFunction void DBusFreeFunction return DBusConnection return DBusConnection return const char DBusError return DBusConnection DBusMessage dbus_uint32_t return DBusConnection dbus_bool_t DBusConnection DBusAddWatchFunction DBusRemoveWatchFunction DBusWatchToggledFunction void DBusFreeFunction return DBusConnection DBusDispatchStatusFunction void DBusFreeFunction DBusTimeout return DBusTimeout return DBusWatch return DBusWatch unsigned int return DBusError const DBusError return const DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessageIter int const void return DBusMessageIter DBusMessageIter return DBusMessageIter void DBusMessageIter void int return DBusMessage DBusMessageIter return DBusMessageIter return DBusMessageIter DBusMessageIter const char const char const char const char return DBusMessage return DBusMessage const char return DBusMessage dbus_bool_t return DBusMessage dbus_uint32_t return DBusMessage void
Definition qdbus_symbols_p.h:409
method
DBusConnection const char DBusError DBusBusType DBusError return DBusConnection DBusHandleMessageFunction void DBusFreeFunction return DBusConnection return DBusConnection return const char DBusError return DBusConnection DBusMessage dbus_uint32_t return DBusConnection dbus_bool_t DBusConnection DBusAddWatchFunction DBusRemoveWatchFunction DBusWatchToggledFunction void DBusFreeFunction return DBusConnection DBusDispatchStatusFunction void DBusFreeFunction DBusTimeout return DBusTimeout return DBusWatch return DBusWatch unsigned int return DBusError const DBusError return const DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessageIter int const void return DBusMessageIter DBusMessageIter return DBusMessageIter void DBusMessageIter void int return DBusMessage DBusMessageIter return DBusMessageIter return DBusMessageIter DBusMessageIter const char const char const char const char * method
Definition qdbus_symbols_p.h:356
Q_DECLARE_FLAGS
#define Q_DECLARE_FLAGS(Flags, Enum)
Definition qflags.h:174
Q_DECLARE_METATYPE
#define Q_DECLARE_METATYPE(TYPE)
Definition qmetatype.h:1526
mode
GLenum mode
Definition qopengles2ext.h:333
height
GLint GLsizei GLsizei height
Definition qopengles2ext.h:206
size
GLenum GLuint GLintptr GLsizeiptr size
[1]
Definition qopengles2ext.h:660
buffer
GLenum GLuint buffer
Definition qopengles2ext.h:659
width
GLint GLsizei width
Definition qopengles2ext.h:206
angle
GLfloat angle
Definition qopengles2ext.h:3231
handleType
GLuint64 GLenum handleType
Definition qopengles2ext.h:1558
format
GLint GLsizei GLsizei GLenum format
Definition qopengles2ext.h:206
rate
GLuint GLenum * rate
Definition qopenglext.h:11002
bits
GLenum GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const void * bits
Definition qopenglext.h:6904
operator==
bool operator==(const QRandomGenerator &rng1, const QRandomGenerator &rng2)
Definition qrandom.cpp:1220
QT_DECLARE_QESDP_SPECIALIZATION_DTOR_WITH_EXPORT
#define QT_DECLARE_QESDP_SPECIALIZATION_DTOR_WITH_EXPORT(Class, ExportMacro)
Definition qshareddata.h:289
QT_DEPRECATED_VERSION_X_6_8
#define QT_DEPRECATED_VERSION_X_6_8(text)
Definition qtdeprecationmarkers.h:170
QT_DEPRECATED_VERSION_X_6_7
#define QT_DEPRECATED_VERSION_X_6_7(text)
Definition qtdeprecationmarkers.h:162
Q_GADGET
#define Q_GADGET
Definition qtmetamacros.h:154
uchar
unsigned char uchar
Definition qtypes.h:32
qint64
long long qint64
Definition qtypes.h:60
qreal
double qreal
Definition qtypes.h:187
operator<<
Q_MULTIMEDIA_EXPORT QDebug operator<<(QDebug, const QVideoFrame &)
Definition qvideoframe.cpp:1053
d
double d
Definition src_corelib_text_qlocale.cpp:9
time
QTime time
[5]
Definition src_corelib_time_qdatetime.cpp:52
other
QSharedPointer< T > other(t)
[5]
swap
this swap(other)
painter
QPainter painter(this)
[7]