IAudioSpectrumProvider.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <PhosphorAudio/AudioDefaults.h>
#include <PhosphorAudio/phosphoraudio_export.h>
 
#include <QObject>
#include <QString>
#include <QVector>
 
namespace PhosphorAudio {
 
enum class ChannelMode {
    Stereo,
    MonoAverage,
    MonoLeft,
    MonoRight,
};
 
PHOSPHORAUDIO_EXPORT QString channelModeToString(ChannelMode mode);
PHOSPHORAUDIO_EXPORT ChannelMode channelModeFromString(const QString& mode);
 
inline double extraSmoothingFromPercent(int percent)
{
    return percent / 100.0;
}
inline QString inputMethodFromSetting(const QString& configured)
{
    return configured == QLatin1String("auto") ? QString() : configured;
}
 
struct PHOSPHORAUDIO_EXPORT SpectrumOptions
{
    int barCount = Defaults::DefaultBarCount;
    int framerate = Defaults::DefaultFramerate;
    bool autosens = Defaults::DefaultAutosens;
    int sensitivity = Defaults::DefaultSensitivity;
    int noiseReduction = Defaults::DefaultNoiseReduction;
    int lowerCutoffHz = Defaults::DefaultLowerCutoffHz;
    int higherCutoffHz = Defaults::DefaultHigherCutoffHz;
    bool monstercat = Defaults::DefaultMonstercat;
    bool waves = Defaults::DefaultWaves;
    ChannelMode channelMode = ChannelMode::Stereo;
    bool reverse = Defaults::DefaultReverse;
    double extraSmoothing = Defaults::DefaultExtraSmoothing;
    QString inputMethod;
    QString inputSource = QStringLiteral("auto");
 
    bool operator==(const SpectrumOptions& other) const = default;
};
 
class PHOSPHORAUDIO_EXPORT IAudioSpectrumProvider : public QObject
{
    Q_OBJECT
 
public:
    explicit IAudioSpectrumProvider(QObject* parent = nullptr)
        : QObject(parent)
    {
    }
 
    ~IAudioSpectrumProvider() override = default;
 
    virtual bool isAvailable() const = 0;
    virtual void start() = 0;
    virtual void stop() = 0;
    virtual bool isRunning() const = 0;
 
    virtual SpectrumOptions options() const = 0;
    virtual void setOptions(const SpectrumOptions& options) = 0;
 
    virtual QVector<float> spectrum() const = 0;
 
Q_SIGNALS:
    void spectrumUpdated(const QVector<float>& spectrum);
    void runningChanged(bool running);
    void errorOccurred(const QString& message);
};
 
} // namespace PhosphorAudio