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 QABSTRACTVIDEOBUFFER_H
41#define QABSTRACTVIDEOBUFFER_H
42
43#include <QtMultimedia/qtmultimediaglobal.h>
44#include <QtMultimedia/qmultimedia.h>
45
46
47#include <QtCore/qmetatype.h>
48
49QT_BEGIN_NAMESPACE
50
51
52class QVariant;
53
54class QAbstractVideoBufferPrivate;
55
56class Q_MULTIMEDIA_EXPORT QAbstractVideoBuffer
57{
58public:
59 enum HandleType
60 {
61 NoHandle,
62 GLTextureHandle,
63 XvShmImageHandle,
64 CoreImageHandle,
65 QPixmapHandle,
66 EGLImageHandle,
67 UserHandle = 1000
68 };
69
70 enum MapMode
71 {
72 NotMapped = 0x00,
73 ReadOnly = 0x01,
74 WriteOnly = 0x02,
75 ReadWrite = ReadOnly | WriteOnly
76 };
77
78 QAbstractVideoBuffer(HandleType type);
79 virtual ~QAbstractVideoBuffer();
80 virtual void release();
81
82 HandleType handleType() const;
83
84 virtual MapMode mapMode() const = 0;
85
86 virtual uchar *map(MapMode mode, int *numBytes, int *bytesPerLine) = 0;
87 int mapPlanes(MapMode mode, int *numBytes, int bytesPerLine[4], uchar *data[4]);
88 virtual void unmap() = 0;
89
90 virtual QVariant handle() const;
91
92protected:
93 QAbstractVideoBuffer(QAbstractVideoBufferPrivate &dd, HandleType type);
94
95 QAbstractVideoBufferPrivate *d_ptr; // For expansion, not used currently
96 HandleType m_type;
97
98private:
99 Q_DECLARE_PRIVATE(QAbstractVideoBuffer)
100 Q_DISABLE_COPY(QAbstractVideoBuffer)
101};
102
103class QAbstractPlanarVideoBufferPrivate;
104class Q_MULTIMEDIA_EXPORT QAbstractPlanarVideoBuffer : public QAbstractVideoBuffer
105{
106public:
107 QAbstractPlanarVideoBuffer(HandleType type);
108 virtual ~QAbstractPlanarVideoBuffer();
109
110 uchar *map(MapMode mode, int *numBytes, int *bytesPerLine) override;
111 virtual int map(MapMode mode, int *numBytes, int bytesPerLine[4], uchar *data[4]) = 0;
112
113protected:
114 QAbstractPlanarVideoBuffer(QAbstractPlanarVideoBufferPrivate &dd, HandleType type);
115
116private:
117 Q_DISABLE_COPY(QAbstractPlanarVideoBuffer)
118};
119
120#ifndef QT_NO_DEBUG_STREAM
121Q_MULTIMEDIA_EXPORT QDebug operator<<(QDebug, QAbstractVideoBuffer::HandleType);
122Q_MULTIMEDIA_EXPORT QDebug operator<<(QDebug, QAbstractVideoBuffer::MapMode);
123#endif
124
125QT_END_NAMESPACE
126
127Q_DECLARE_METATYPE(QAbstractVideoBuffer::HandleType)
128Q_DECLARE_METATYPE(QAbstractVideoBuffer::MapMode)
129
130#endif
131