Update copyright headers
[qt:qt.git] / demos / spectrum / app / levelmeter.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the examples of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:BSD$
9 ** You may use this file under the terms of the BSD license as follows:
10 **
11 ** "Redistribution and use in source and binary forms, with or without
12 ** modification, are permitted provided that the following conditions are
13 ** met:
14 **   * Redistributions of source code must retain the above copyright
15 **     notice, this list of conditions and the following disclaimer.
16 **   * Redistributions in binary form must reproduce the above copyright
17 **     notice, this list of conditions and the following disclaimer in
18 **     the documentation and/or other materials provided with the
19 **     distribution.
20 **   * Neither the name of The Qt Company Ltd nor the names of its
21 **     contributors may be used to endorse or promote products derived
22 **     from this software without specific prior written permission.
23 **
24 **
25 ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 ** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 ** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 ** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 ** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 ** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 ** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 ** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 ** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
36 **
37 ** $QT_END_LICENSE$
38 **
39 ****************************************************************************/
40
41 #ifndef LEVELMETER_H
42 #define LEVELMETER_H
43
44 #include <QTime>
45 #include <QWidget>
46
47 /**
48  * Widget which displays a vertical audio level meter, indicating the
49  * RMS and peak levels of the window of audio samples most recently analyzed
50  * by the Engine.
51  */
52 class LevelMeter : public QWidget {
53     Q_OBJECT
54 public:
55     LevelMeter(QWidget *parent = 0);
56     ~LevelMeter();
57
58     void paintEvent(QPaintEvent *event);
59
60 public slots:
61     void reset();
62     void levelChanged(qreal rmsLevel, qreal peakLevel, int numSamples);
63
64 private slots:
65     void redrawTimerExpired();
66
67 private:
68     /**
69      * Height of RMS level bar.
70      * Range 0.0 - 1.0.
71      */
72     qreal m_rmsLevel;
73
74     /**
75      * Most recent peak level.
76      * Range 0.0 - 1.0.
77      */
78     qreal m_peakLevel;
79
80     /**
81      * Height of peak level bar.
82      * This is calculated by decaying m_peakLevel depending on the
83      * elapsed time since m_peakLevelChanged, and the value of m_decayRate.
84      */
85     qreal m_decayedPeakLevel;
86
87     /**
88      * Time at which m_peakLevel was last changed.
89      */
90     QTime m_peakLevelChanged;
91
92     /**
93      * Rate at which peak level bar decays.
94      * Expressed in level units / millisecond.
95      */
96     qreal m_peakDecayRate;
97
98     /**
99      * High watermark of peak level.
100      * Range 0.0 - 1.0.
101      */
102     qreal m_peakHoldLevel;
103
104     /**
105      * Time at which m_peakHoldLevel was last changed.
106      */
107     QTime m_peakHoldLevelChanged;
108
109     QTimer *m_redrawTimer;
110
111     QColor m_rmsColor;
112     QColor m_peakColor;
113
114 };
115
116 #endif // LEVELMETER_H