summaryrefslogtreecommitdiffstats
path: root/examples/multimedia/spectrum/spectrumanalyser.h
blob: 202e602fed9b2acc4efe0beea5c0ddf04d425cf4 (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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
// Copyright (C) 2017 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause

#ifndef SPECTRUMANALYSER_H
#define SPECTRUMANALYSER_H

#include "frequencyspectrum.h"
#include "spectrum.h"

#include <QByteArray>
#include <QList>
#include <QObject>

#ifdef DUMP_SPECTRUMANALYSER
#    include <QDir>
#    include <QFile>
#    include <QTextStream>
#endif

#ifndef DISABLE_FFT
#    include "FFTRealFixLenParam.h"
#endif

QT_FORWARD_DECLARE_CLASS(QAudioFormat)
QT_FORWARD_DECLARE_CLASS(QThread)

class FFTRealWrapper;

class SpectrumAnalyserThreadPrivate;

/**
 * Implementation of the spectrum analysis which can be run in a
 * separate thread.
 */
class SpectrumAnalyserThread : public QObject
{
    Q_OBJECT

public:
    SpectrumAnalyserThread(QObject *parent);
    ~SpectrumAnalyserThread();

public slots:
    void setWindowFunction(WindowFunction type);
    void calculateSpectrum(const QByteArray &buffer, int inputFrequency, int bytesPerSample);

signals:
    void calculationComplete(const FrequencySpectrum &spectrum);

private:
    void calculateWindow();

private:
#ifndef DISABLE_FFT
    FFTRealWrapper *m_fft;
#endif

    const int m_numSamples;

    WindowFunction m_windowFunction;

#ifdef DISABLE_FFT
    typedef qreal DataType;
#else
    typedef FFTRealFixLenParam::DataType DataType;
#endif
    QList<DataType> m_window;

    QList<DataType> m_input;
    QList<DataType> m_output;

    FrequencySpectrum m_spectrum;

#ifdef SPECTRUM_ANALYSER_SEPARATE_THREAD
    QThread *m_thread;
#endif
};

/**
 * Class which performs frequency spectrum analysis on a window of
 * audio samples, provided to it by the Engine.
 */
class SpectrumAnalyser : public QObject
{
    Q_OBJECT

public:
    SpectrumAnalyser(QObject *parent = nullptr);
    ~SpectrumAnalyser();

#ifdef DUMP_SPECTRUMANALYSER
    void setOutputPath(const QString &outputPath);
#endif

public:
    /*
     * Set the windowing function which is applied before calculating the FFT
     */
    void setWindowFunction(WindowFunction type);

    /*
     * Calculate a frequency spectrum
     *
     * \param buffer       Audio data
     * \param format       Format of audio data
     *
     * Frequency spectrum is calculated asynchronously.  The result is returned
     * via the spectrumChanged signal.
     *
     * An ongoing calculation can be cancelled by calling cancelCalculation().
     *
     */
    void calculate(const QByteArray &buffer, const QAudioFormat &format);

    /*
     * Check whether the object is ready to perform another calculation
     */
    bool isReady() const;

    /*
     * Cancel an ongoing calculation
     *
     * Note that cancelling is asynchronous.
     */
    void cancelCalculation();

signals:
    void spectrumChanged(const FrequencySpectrum &spectrum);

private slots:
    void calculationComplete(const FrequencySpectrum &spectrum);

private:
    void calculateWindow();

private:
    SpectrumAnalyserThread *m_thread;

    enum State { Idle, Busy, Cancelled };

    State m_state;

#ifdef DUMP_SPECTRUMANALYSER
    QDir m_outputDir;
    int m_count;
    QFile m_textFile;
    QTextStream m_textStream;
#endif
};

#endif // SPECTRUMANALYSER_H