Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
IAudioSpectrumProvider.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: 2026 fuddlesworth
2// SPDX-License-Identifier: LGPL-2.1-or-later
3
4#pragma once
5
7#include <PhosphorAudio/phosphoraudio_export.h>
8
9#include <QObject>
10#include <QString>
11#include <QVector>
12
13namespace PhosphorAudio {
14
24
31PHOSPHORAUDIO_EXPORT QString channelModeToString(ChannelMode mode);
32PHOSPHORAUDIO_EXPORT ChannelMode channelModeFromString(const QString& mode);
33
37inline double extraSmoothingFromPercent(int percent)
38{
39 return percent / 100.0;
40}
41inline QString inputMethodFromSetting(const QString& configured)
42{
43 return configured == QLatin1String("auto") ? QString() : configured;
44}
45
84
85class PHOSPHORAUDIO_EXPORT IAudioSpectrumProvider : public QObject
86{
87 Q_OBJECT
88
89public:
90 explicit IAudioSpectrumProvider(QObject* parent = nullptr)
91 : QObject(parent)
92 {
93 }
94
95 ~IAudioSpectrumProvider() override = default;
96
97 virtual bool isAvailable() const = 0;
98 virtual void start() = 0;
99 virtual void stop() = 0;
100 virtual bool isRunning() const = 0;
101
103 virtual SpectrumOptions options() const = 0;
107 virtual void setOptions(const SpectrumOptions& options) = 0;
108
109 virtual QVector<float> spectrum() const = 0;
110
111Q_SIGNALS:
112 void spectrumUpdated(const QVector<float>& spectrum);
113 void runningChanged(bool running);
114 void errorOccurred(const QString& message);
115};
116
117} // namespace PhosphorAudio
virtual QVector< float > spectrum() const =0
void spectrumUpdated(const QVector< float > &spectrum)
virtual SpectrumOptions options() const =0
The provider's current (normalized) parameter set.
virtual bool isRunning() const =0
~IAudioSpectrumProvider() override=default
void errorOccurred(const QString &message)
virtual void setOptions(const SpectrumOptions &options)=0
Apply a full parameter set.
virtual bool isAvailable() const =0
IAudioSpectrumProvider(QObject *parent=nullptr)
Definition IAudioSpectrumProvider.h:90
constexpr bool DefaultReverse
Definition AudioDefaults.h:37
constexpr bool DefaultWaves
Definition AudioDefaults.h:36
constexpr int DefaultFramerate
Definition AudioDefaults.h:12
constexpr int DefaultLowerCutoffHz
Definition AudioDefaults.h:29
constexpr int DefaultBarCount
Definition AudioDefaults.h:11
constexpr int DefaultHigherCutoffHz
Definition AudioDefaults.h:32
constexpr double DefaultExtraSmoothing
Definition AudioDefaults.h:41
constexpr bool DefaultMonstercat
Definition AudioDefaults.h:35
constexpr int DefaultSensitivity
Definition AudioDefaults.h:20
constexpr bool DefaultAutosens
Definition AudioDefaults.h:19
constexpr int DefaultNoiseReduction
Definition AudioDefaults.h:23
Definition AudioDefaults.h:6
PHOSPHORAUDIO_EXPORT QString channelModeToString(ChannelMode mode)
Canonical config-string forms ("stereo", "mono-average", "mono-left", "mono-right") for persisting a ...
double extraSmoothingFromPercent(int percent)
Conversions between the persisted settings representation and the SpectrumOptions field values,...
Definition IAudioSpectrumProvider.h:37
QString inputMethodFromSetting(const QString &configured)
Definition IAudioSpectrumProvider.h:41
ChannelMode
How the analyzed channels map onto the emitted bar vector.
Definition IAudioSpectrumProvider.h:18
@ MonoLeft
Definition IAudioSpectrumProvider.h:21
@ MonoRight
Definition IAudioSpectrumProvider.h:22
@ MonoAverage
Definition IAudioSpectrumProvider.h:20
@ Stereo
Definition IAudioSpectrumProvider.h:19
PHOSPHORAUDIO_EXPORT ChannelMode channelModeFromString(const QString &mode)
Full analysis parameter set for a spectrum provider.
Definition IAudioSpectrumProvider.h:52
double extraSmoothing
Provider-side EMA on top of noiseReduction: fraction of the previous frame retained per update (0 = o...
Definition IAudioSpectrumProvider.h:76
bool waves
Wave-style spread filter.
Definition IAudioSpectrumProvider.h:70
int noiseReduction
Primary smoothing knob (cava's [smoothing] noise_reduction, 0-100): 0 = fast and twitchy,...
Definition IAudioSpectrumProvider.h:62
int framerate
Definition IAudioSpectrumProvider.h:54
QString inputMethod
Capture backend override ("pipewire", "pulse", ...). Empty = detect.
Definition IAudioSpectrumProvider.h:78
ChannelMode channelMode
Definition IAudioSpectrumProvider.h:71
bool monstercat
Monstercat-style neighbor spread filter.
Definition IAudioSpectrumProvider.h:68
QString inputSource
Capture device/source for the backend. "auto" = the backend default.
Definition IAudioSpectrumProvider.h:80
int barCount
Definition IAudioSpectrumProvider.h:53
bool autosens
Automatic gain: the analyzer self-scales so output fills 0..1.
Definition IAudioSpectrumProvider.h:56
int lowerCutoffHz
Analyzed frequency band.
Definition IAudioSpectrumProvider.h:65
int higherCutoffHz
Definition IAudioSpectrumProvider.h:66
int sensitivity
Percent gain (100 = unity).
Definition IAudioSpectrumProvider.h:59
bool operator==(const SpectrumOptions &other) const =default
bool reverse
Reverse the frequency order of the emitted bars.
Definition IAudioSpectrumProvider.h:73