summaryrefslogtreecommitdiffstats
path: root/src/shared-main-lib/frametimer.h
blob: bd8f871433212fc87eeb3d191d2576d8e75def5d (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
/****************************************************************************
**
** Copyright (C) 2021 The Qt Company Ltd.
** Copyright (C) 2019 Luxoft Sweden AB
** Copyright (C) 2018 Pelagicore AG
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtApplicationManager module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL$
** 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 General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) 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.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-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#pragma once

#include <QElapsedTimer>
#include <QObject>
#include <QPointer>
#include <QTimer>
#include <QtAppManCommon/global.h>
#include <limits>

#if defined(AM_MULTI_PROCESS)
#  include <QtWaylandCompositor/QWaylandQuickSurface>
#endif

QT_BEGIN_NAMESPACE_AM

class FrameTimer : public QObject
{
    Q_OBJECT
    Q_CLASSINFO("AM-QmlType", "QtApplicationManager/FrameTimer 2.0")

    Q_PROPERTY(qreal averageFps READ averageFps NOTIFY updated)
    Q_PROPERTY(qreal minimumFps READ minimumFps NOTIFY updated)
    Q_PROPERTY(qreal maximumFps READ maximumFps NOTIFY updated)
    Q_PROPERTY(qreal jitterFps READ jitterFps NOTIFY updated)

    Q_PROPERTY(QObject* window READ window WRITE setWindow NOTIFY windowChanged)

    Q_PROPERTY(int interval READ interval WRITE setInterval NOTIFY intervalChanged)
    Q_PROPERTY(bool running READ running WRITE setRunning NOTIFY runningChanged)

    Q_PROPERTY(QStringList roleNames READ roleNames CONSTANT)

public:
    FrameTimer(QObject *parent = nullptr);

    QStringList roleNames() const;

    Q_INVOKABLE void update();

    qreal averageFps() const;
    qreal minimumFps() const;
    qreal maximumFps() const;
    qreal jitterFps() const;

    QObject *window() const;
    void setWindow(QObject *value);

    bool running() const;
    void setRunning(bool value);

    int interval() const;
    void setInterval(int value);

signals:
    void updated();
    void intervalChanged();
    void runningChanged();
    void windowChanged();

protected slots:
    void newFrame();

protected:
    virtual bool connectToAppManWindow();
    virtual void disconnectFromAppManWindow();

    QPointer<QObject> m_window;

private:
    void reset();
    bool connectToQuickWindow();

    int m_count = 0;
    int m_sum = 0;
    int m_min = std::numeric_limits<int>::max();
    int m_max = 0;
    qreal m_jitter = 0.0;

    QElapsedTimer m_timer;

    QTimer m_updateTimer;

    qreal m_averageFps;
    qreal m_minimumFps;
    qreal m_maximumFps;
    qreal m_jitterFps;

    static const int IdealFrameTime = 16667; // usec - could be made configurable via an env variable
    static const qreal MicrosInSec;
};

QT_END_NAMESPACE_AM