summaryrefslogtreecommitdiffstats
path: root/src/shared-main-lib/frametimer.h
blob: 0604d4e071e31abc7846486028313336f31d3d93 (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
// Copyright (C) 2023 The Qt Company Ltd.
// Copyright (C) 2019 Luxoft Sweden AB
// Copyright (C) 2018 Pelagicore AG
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only

#pragma once

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


QT_BEGIN_NAMESPACE_AM

class FrameTimerImpl;

class FrameTimer : public QObject
{
    Q_OBJECT
    Q_PROPERTY(qreal averageFps READ averageFps NOTIFY updated FINAL)
    Q_PROPERTY(qreal minimumFps READ minimumFps NOTIFY updated FINAL)
    Q_PROPERTY(qreal maximumFps READ maximumFps NOTIFY updated FINAL)
    Q_PROPERTY(qreal jitterFps READ jitterFps NOTIFY updated FINAL)

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

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

    Q_PROPERTY(QStringList roleNames READ roleNames CONSTANT FINAL)

public:
    FrameTimer(QObject *parent = nullptr);
    ~FrameTimer() override;

    QStringList roleNames() const;

    Q_INVOKABLE void update();
    Q_SIGNAL void updated();

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

    QObject *window() const;
    void setWindow(QObject *window);
    Q_SIGNAL void windowChanged();

    bool running() const;
    void setRunning(bool running);
    Q_SIGNAL void runningChanged();

    int interval() const;
    void setInterval(int interval);
    Q_SIGNAL void intervalChanged();

    void reportFrameSwap();

    FrameTimerImpl *implementation();

protected:
    std::unique_ptr<FrameTimerImpl> m_impl;

private:
    QPointer<QObject> m_window;

    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 = 0.0;
    qreal m_minimumFps = 0.0;
    qreal m_maximumFps = 0.0;
    qreal m_jitterFps = 0.0;

    QMetaObject::Connection m_frameSwapConnection;

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

QT_END_NAMESPACE_AM