1/****************************************************************************
2**
3** Copyright (C) 2017 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the examples of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:BSD$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** BSD License Usage
18** Alternatively, you may use this file under the terms of the BSD license
19** as follows:
20**
21** "Redistribution and use in source and binary forms, with or without
22** modification, are permitted provided that the following conditions are
23** met:
24** * Redistributions of source code must retain the above copyright
25** notice, this list of conditions and the following disclaimer.
26** * Redistributions in binary form must reproduce the above copyright
27** notice, this list of conditions and the following disclaimer in
28** the documentation and/or other materials provided with the
29** distribution.
30** * Neither the name of The Qt Company Ltd nor the names of its
31** contributors may be used to endorse or promote products derived
32** from this software without specific prior written permission.
33**
34**
35** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
36** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
37** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
38** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
39** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
42** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
43** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
44** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
45** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
46**
47** $QT_END_LICENSE$
48**
49****************************************************************************/
50
51#ifndef FREQUENCYSPECTRUM_H
52#define FREQUENCYSPECTRUM_H
53
54#include <QtCore/QVector>
55
56/**
57 * Represents a frequency spectrum as a series of elements, each of which
58 * consists of a frequency, an amplitude and a phase.
59 */
60class FrequencySpectrum {
61public:
62 FrequencySpectrum(int numPoints = 0);
63
64 struct Element {
65 Element()
66 : frequency(0.0), amplitude(0.0), phase(0.0), clipped(false)
67 { }
68
69 /**
70 * Frequency in Hertz
71 */
72 qreal frequency;
73
74 /**
75 * Amplitude in range [0.0, 1.0]
76 */
77 qreal amplitude;
78
79 /**
80 * Phase in range [0.0, 2*PI]
81 */
82 qreal phase;
83
84 /**
85 * Indicates whether value has been clipped during spectrum analysis
86 */
87 bool clipped;
88 };
89
90 typedef QVector<Element>::iterator iterator;
91 typedef QVector<Element>::const_iterator const_iterator;
92
93 void reset();
94
95 int count() const;
96 Element& operator[](int index);
97 const Element& operator[](int index) const;
98 iterator begin();
99 iterator end();
100 const_iterator begin() const;
101 const_iterator end() const;
102
103private:
104 QVector<Element> m_elements;
105
106};
107
108#endif // FREQUENCYSPECTRUM_H
109

source code of qtmultimedia/examples/multimedia/spectrum/app/frequencyspectrum.h