1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QABSTRACTVIDEOSURFACE_H
41#define QABSTRACTVIDEOSURFACE_H
42
43#include <QtCore/qobject.h>
44#include <QtMultimedia/qvideoframe.h>
45
46QT_BEGIN_NAMESPACE
47
48class QRectF;
49class QVideoSurfaceFormat;
50
51class QAbstractVideoSurfacePrivate;
52
53class Q_MULTIMEDIA_EXPORT QAbstractVideoSurface : public QObject
54{
55 Q_OBJECT
56 Q_PROPERTY(QSize nativeResolution READ nativeResolution NOTIFY nativeResolutionChanged)
57public:
58 enum Error
59 {
60 NoError,
61 UnsupportedFormatError,
62 IncorrectFormatError,
63 StoppedError,
64 ResourceError
65 };
66
67 explicit QAbstractVideoSurface(QObject *parent = nullptr);
68 ~QAbstractVideoSurface();
69
70 virtual QList<QVideoFrame::PixelFormat> supportedPixelFormats(
71 QAbstractVideoBuffer::HandleType type = QAbstractVideoBuffer::NoHandle) const = 0;
72 virtual bool isFormatSupported(const QVideoSurfaceFormat &format) const;
73 virtual QVideoSurfaceFormat nearestFormat(const QVideoSurfaceFormat &format) const;
74
75 QVideoSurfaceFormat surfaceFormat() const;
76
77 QSize nativeResolution() const;
78
79 virtual bool start(const QVideoSurfaceFormat &format);
80 virtual void stop();
81
82 bool isActive() const;
83
84 virtual bool present(const QVideoFrame &frame) = 0;
85
86 Error error() const;
87
88Q_SIGNALS:
89 void activeChanged(bool active);
90 void surfaceFormatChanged(const QVideoSurfaceFormat &format);
91 void supportedFormatsChanged();
92 void nativeResolutionChanged(const QSize &resolution);
93
94protected:
95 void setError(Error error);
96 void setNativeResolution(const QSize &resolution);
97
98private:
99 Q_DECLARE_PRIVATE(QAbstractVideoSurface)
100 QScopedPointer<QAbstractVideoSurfacePrivate> d_ptr;
101};
102
103#ifndef QT_NO_DEBUG_STREAM
104Q_MULTIMEDIA_EXPORT QDebug operator<<(QDebug, const QAbstractVideoSurface::Error &);
105#endif
106
107QT_END_NAMESPACE
108
109Q_DECLARE_METATYPE(QAbstractVideoSurface*)
110Q_DECLARE_METATYPE(QAbstractVideoSurface::Error)
111
112#endif
113