summaryrefslogtreecommitdiffstats
path: root/src/multimedia/video/qvideosink.h
blob: ec89c425df2d2a9bed288e3fd675142b3239211d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QABSTRACTVIDEOSINK_H
#define QABSTRACTVIDEOSINK_H

#include <QtMultimedia/qtmultimediaglobal.h>
#include <QtCore/qobject.h>
#include <QtGui/qwindowdefs.h>

QT_BEGIN_NAMESPACE

class QRectF;
class QVideoSurfaceFormat;
class QVideoFrame;

class QVideoSinkPrivate;
class QPlatformVideoSink;

class Q_MULTIMEDIA_EXPORT QVideoSink : public QObject
{
    Q_OBJECT
public:
    enum GraphicsType
    {
        Memory,
        NativeWindow,
        NativeTexture,
        OpenGL,
        Metal,
        Direct3D11,
        Vulkan
    };

    QVideoSink(QObject *parent = nullptr);
    ~QVideoSink();

    GraphicsType graphicsType() const;
    void setGraphicsType(GraphicsType type);

    static bool isGraphicsTypeSupported(GraphicsType type);

    // setter sets graphics type to NativeWindow
    WId nativeWindowId() const;
    void setNativeWindowId(WId id);

    void setFullScreen(bool fullscreen);
    bool isFullscreen() const;

    Qt::AspectRatioMode aspectRatioMode() const;
    void setAspectRatioMode(Qt::AspectRatioMode mode);

    QRectF targetRect() const;
    void setTargetRect(const QRectF &rect);

    int brightness() const;
    void setBrightness(int brightness);

    int contrast() const;
    void setContrast(int contrast);

    int hue() const;
    void setHue(int hue);

    int saturation() const;
    void setSaturation(int saturation);

    // ignored in windowed mode (GraphicsType == NativeWindow)
    QMatrix4x4 transform() const;
    void setTransform(const QMatrix4x4 &transform);

    // ignored in windowed mode?
    float opacity() const;
    void setOpacity(float opacity);

    Qt::BGMode backgroundMode() const;
    void setBackgroundMode(Qt::BGMode mode);

    // Thread safe
    void render(const QVideoFrame &frame);

    void paint(QPainter *painter, const QVideoFrame &frame);

    QPlatformVideoSink *platformVideoSink();

Q_SIGNALS:
    // would never get called in windowed mode
    QVideoFrame newVideoFrame(const QVideoFrame &frame) const;

private:
    QVideoSinkPrivate *d = nullptr;
};

QT_END_NAMESPACE

#endif