Update copyright headers
[qt:qt.git] / demos / spectrum / app / spectrograph.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 SPECTROGRAPH_H
42 #define SPECTROGRAPH_H
43
44 #include <QWidget>
45 #include "frequencyspectrum.h"
46
47 QT_FORWARD_DECLARE_CLASS(QMouseEvent)
48
49 /**
50  * Widget which displays a spectrograph showing the frequency spectrum
51  * of the window of audio samples most recently analyzed by the Engine.
52  */
53 class Spectrograph : public QWidget {
54     Q_OBJECT
55 public:
56     Spectrograph(QWidget *parent = 0);
57     ~Spectrograph();
58
59     void setParams(int numBars, qreal lowFreq, qreal highFreq);
60
61     // QObject
62     void timerEvent(QTimerEvent *event);
63
64     // QWidget
65     void paintEvent(QPaintEvent *event);
66     void mousePressEvent(QMouseEvent *event);
67
68 signals:
69     void infoMessage(const QString &message, int intervalMs);
70
71 public slots:
72     void reset();
73     void spectrumChanged(const FrequencySpectrum &spectrum);
74
75 private:
76     int barIndex(qreal frequency) const;
77     QPair<qreal, qreal> barRange(int barIndex) const;
78     void updateBars();
79
80     void selectBar(int index);
81
82 private:
83     struct Bar {
84         Bar() : value(0.0), clipped(false) { }
85         qreal   value;
86         bool    clipped;
87     };
88
89     QVector<Bar>        m_bars;
90     int                 m_barSelected;
91     int                 m_timerId;
92     qreal               m_lowFreq;
93     qreal               m_highFreq;
94     FrequencySpectrum   m_spectrum;
95
96
97 };
98
99 #endif // SPECTROGRAPH_H