overte/interface/src/ui/Stats.h

//
//  Created by Bradley Austin Davis 2015/06/17
//  Copyright 2013 High Fidelity, Inc.
//
//  Distributed under the Apache License, Version 2.0.
//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//

#ifndef hifi_Stats_h
#define hifi_Stats_h

#include <OffscreenQmlElement.h>
#include <RenderArgs.h>
#include <QVector3D>
#include <AudioIOStats.h>

#define STATS_PROPERTY(type, name, initialValue) \
    Q_PROPERTY(type name READ name NOTIFY name##Changed) \
public: \
    type name() { return _##name; }; \
private: \
    type _##name{ initialValue }; 


class Stats : public QQuickItem {
    Q_OBJECT
    HIFI_QML_DECL
    Q_PROPERTY(bool expanded READ isExpanded WRITE setExpanded NOTIFY expandedChanged)
    Q_PROPERTY(bool timingExpanded READ isTimingExpanded NOTIFY timingExpandedChanged)
    Q_PROPERTY(QString monospaceFont READ monospaceFont CONSTANT)
    Q_PROPERTY(float audioPacketlossUpstream READ getAudioPacketLossUpstream)
    Q_PROPERTY(float audioPacketlossDownstream READ getAudioPacketLossDownstream)
    Q_PROPERTY(bool showAcuity READ getShowAcuity WRITE setShowAcuity NOTIFY showAcuityChanged)

    STATS_PROPERTY(int, serverCount, 0)
    STATS_PROPERTY(int, renderrate, 0)
    STATS_PROPERTY(int, presentrate, 0)
    STATS_PROPERTY(int, simrate, 0)
    STATS_PROPERTY(int, avatarSimrate, 0)
    STATS_PROPERTY(int, avatarCount, 0)
    STATS_PROPERTY(int, packetInCount, 0)
    STATS_PROPERTY(int, packetOutCount, 0)
    STATS_PROPERTY(float, mbpsIn, 0)
    STATS_PROPERTY(float, mbpsOut, 0)
    STATS_PROPERTY(int, audioPing, 0)
    STATS_PROPERTY(int, avatarPing, 0)
    STATS_PROPERTY(int, entitiesPing, 0)
    STATS_PROPERTY(int, assetPing, 0)
    STATS_PROPERTY(QVector3D, position, QVector3D(0, 0, 0) )
    STATS_PROPERTY(float, velocity, 0)
    STATS_PROPERTY(float, yaw, 0)
    STATS_PROPERTY(int, avatarMixerInKbps, 0)
    STATS_PROPERTY(int, avatarMixerInPps, 0)
    STATS_PROPERTY(int, avatarMixerOutKbps, 0)
    STATS_PROPERTY(int, avatarMixerOutPps, 0)
    STATS_PROPERTY(int, audioMixerKbps, 0)
    STATS_PROPERTY(int, audioMixerPps, 0)
    STATS_PROPERTY(int, downloads, 0)
    STATS_PROPERTY(int, downloadsPending, 0)
    STATS_PROPERTY(int, triangles, 0)
    STATS_PROPERTY(int, quads, 0)
    STATS_PROPERTY(int, materialSwitches, 0)
    STATS_PROPERTY(int, opaqueConsidered, 0)
    STATS_PROPERTY(int, opaqueOutOfView, 0)
    STATS_PROPERTY(int, opaqueTooSmall, 0)
    STATS_PROPERTY(int, opaqueRendered, 0)
    STATS_PROPERTY(int, translucentConsidered, 0)
    STATS_PROPERTY(int, translucentOutOfView, 0)
    STATS_PROPERTY(int, translucentTooSmall, 0)
    STATS_PROPERTY(int, translucentRendered, 0)
    STATS_PROPERTY(int, otherConsidered, 0)
    STATS_PROPERTY(int, otherOutOfView, 0)
    STATS_PROPERTY(int, otherTooSmall, 0)
    STATS_PROPERTY(int, otherRendered, 0)
    STATS_PROPERTY(QString, sendingMode, QString())
    STATS_PROPERTY(QString, packetStats, QString())
    STATS_PROPERTY(QString, lodStatus, QString())
    STATS_PROPERTY(QString, timingStats, QString())
    STATS_PROPERTY(QString, lodStatsRenderText, QString())
    STATS_PROPERTY(int, serverElements, 0)
    STATS_PROPERTY(int, serverInternal, 0)
    STATS_PROPERTY(int, serverLeaves, 0)
    STATS_PROPERTY(int, localElements, 0)
    STATS_PROPERTY(int, localInternal, 0)
    STATS_PROPERTY(int, localLeaves, 0)

public:
    static Stats* getInstance();

    Stats(QQuickItem* parent = nullptr);
    bool includeTimingRecord(const QString& name);
    void setRenderDetails(const RenderDetails& details);
    const QString& monospaceFont() {
        return _monospaceFont;
    }

    float getAudioPacketLossUpstream() { return _audioStats->getMixerAvatarStreamStats()._packetStreamStats.getLostRate(); }
    float getAudioPacketLossDownstream() { return _audioStats->getMixerDownstreamStats()._packetStreamStats.getLostRate(); }

    void updateStats(bool force = false);

    bool isExpanded() { return _expanded; }
    bool isTimingExpanded() { return _timingExpanded; }

    void setExpanded(bool expanded) {
        if (_expanded != expanded) {
            _expanded = expanded;
            emit expandedChanged();
        }
    }
    bool getShowAcuity() { return _showAcuity; }
    void setShowAcuity(bool newValue) { _showAcuity = newValue; }

public slots:
    void forceUpdateStats() { updateStats(true); }

signals:
    void expandedChanged();
    void showAcuityChanged();
    void timingExpandedChanged();
    void serverCountChanged();
    void renderrateChanged();
    void presentrateChanged();
    void simrateChanged();
    void avatarSimrateChanged();
    void avatarCountChanged();
    void lodStatsRenderTextChanged();
    void packetInCountChanged();
    void packetOutCountChanged();
    void mbpsInChanged();
    void mbpsOutChanged();
    void audioPingChanged();
    void avatarPingChanged();
    void entitiesPingChanged();
    void assetPingChanged();
    void positionChanged();
    void velocityChanged();
    void yawChanged();
    void avatarMixerInKbpsChanged();
    void avatarMixerInPpsChanged();
    void avatarMixerOutKbpsChanged();
    void avatarMixerOutPpsChanged();
    void audioMixerKbpsChanged();
    void audioMixerPpsChanged();
    void downloadsChanged();
    void downloadsPendingChanged();
    void trianglesChanged();
    void quadsChanged();
    void materialSwitchesChanged();
    void opaqueConsideredChanged();
    void opaqueOutOfViewChanged();
    void opaqueTooSmallChanged();
    void opaqueRenderedChanged();
    void translucentConsideredChanged();
    void translucentOutOfViewChanged();
    void translucentTooSmallChanged();
    void translucentRenderedChanged();
    void otherConsideredChanged();
    void otherOutOfViewChanged();
    void otherTooSmallChanged();
    void otherRenderedChanged();
    void sendingModeChanged();
    void packetStatsChanged();
    void lodStatusChanged();
    void serverElementsChanged();
    void serverInternalChanged();
    void serverLeavesChanged();
    void localElementsChanged();
    void localInternalChanged();
    void localLeavesChanged();
    void timingStatsChanged();

private:
    int _recentMaxPackets{ 0 } ; // recent max incoming voxel packets to process
    bool _resetRecentMaxPacketsSoon{ true };
    bool _expanded{ false };
    bool _showAcuity{ false };
    bool _timingExpanded{ false };
    QString _monospaceFont;
    const AudioIOStats* _audioStats;
};

#endif // hifi_Stats_h