Differential D19994 Diff 57234 src/qml/microphoneindicator.cpp

Changeset View

Standalone View

src/qml/microphoneindicator.cpp

This file was added.

1		/*
2		Copyright 2019 Kai Uwe Broulik <kde@privat.broulik.de>
3
4		This library is free software; you can redistribute it and/or
5		modify it under the terms of the GNU Lesser General Public
6		License as published by the Free Software Foundation; either
7		version 2.1 of the License, or (at your option) version 3, or any
8		later version accepted by the membership of KDE e.V. (or its
9		successor approved by the membership of KDE e.V.), which shall
10		act as a proxy defined in Section 6 of version 3 of the license.
11
12		This library is distributed in the hope that it will be useful,
13		but WITHOUT ANY WARRANTY; without even the implied warranty of
14		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15		Lesser General Public License for more details.
16
17		You should have received a copy of the GNU Lesser General Public
18		License along with this library. If not, see <http://www.gnu.org/licenses/>.
19		*/
20
21		#include "microphoneindicator.h"
22
23		#include <QAction>
24		#include <QIcon>
25		#include <QMenu>
26		#include <QTimer>
27
28		#include <KLocalizedString>
29		#include <KStatusNotifierItem>
30
31		#include <client.h>
32		#include <context.h>
33		#include <pulseaudio.h>
34		#include <source.h>
35
36		#include "volumeosd.h"
37
38		using namespace QPulseAudio;
39
40		MicrophoneIndicator::MicrophoneIndicator(QObject *parent)
41		: QObject(parent)
42		, m_sourceModel(new SourceModel(this))
43		, m_sourceOutputModel(new SourceOutputModel(this))
	droscaUnsubmitted Not Done Just ignore virtual streams? We only care about real devices here. drosca: Just ignore virtual streams? We only care about real devices here.
44		, m_updateTimer(new QTimer(this))
45		{
46
47		connect(m_sourceModel, &QAbstractItemModel::rowsInserted, this, &MicrophoneIndicator::scheduleUpdate);
48		connect(m_sourceModel, &QAbstractItemModel::rowsRemoved, this, &MicrophoneIndicator::scheduleUpdate);
49		connect(m_sourceModel, &QAbstractItemModel::dataChanged, this, &MicrophoneIndicator::scheduleUpdate);
50
51		connect(m_sourceOutputModel, &QAbstractItemModel::rowsInserted, this, &MicrophoneIndicator::scheduleUpdate);
52		connect(m_sourceOutputModel, &QAbstractItemModel::rowsRemoved, this, &MicrophoneIndicator::scheduleUpdate);
53
54		m_updateTimer->setInterval(0);
55		m_updateTimer->setSingleShot(true);
56		connect(m_updateTimer, &QTimer::timeout, this, &MicrophoneIndicator::update);
57		}
58
59		MicrophoneIndicator::~MicrophoneIndicator() = default;
60
61		void MicrophoneIndicator::init()
62		{
63		// does nothing, just prompts QML engine to create an instance of the singleton
64		}
65
66		void MicrophoneIndicator::scheduleUpdate()
67		{
68		if (!m_updateTimer->isActive()) {
69		m_updateTimer->start();
70		}
71		}
72
73		void MicrophoneIndicator::update()
74		{
75		if (m_sourceOutputModel->rowCount() == 0) {
76		m_showOsdOnUpdate = false;
77		delete m_sni;
78		m_sni = nullptr;
79		return;
80		}
81
82		if (!m_sni) {
83		m_sni = new KStatusNotifierItem(QStringLiteral("microphone"));
84		m_sni->setCategory(KStatusNotifierItem::Hardware);
85		// always Active since it is completely removed when microphone isn't in use
86		m_sni->setStatus(KStatusNotifierItem::Active);
87
88		// but also middle click to be consistent with volume icon
89		connect(m_sni, &KStatusNotifierItem::secondaryActivateRequested, this, &MicrophoneIndicator::toggleMuted);
90
91		connect(m_sni, &KStatusNotifierItem::scrollRequested, this, [this](int delta, Qt::Orientation orientation) {
92		if (orientation != Qt::Vertical) {
93		return;
94		}
95
96		m_wheelDelta += delta;
97
98		while (m_wheelDelta >= 120) {
99		m_wheelDelta -= 120;
100		adjustVolume(+1);
101		}
102		while (m_wheelDelta <= -120) {
103		m_wheelDelta += 120;
104		adjustVolume(-1);
105		}
106		});
107
108		QMenu *menu = m_sni->contextMenu();
109
110		m_muteAction = menu->addAction(QIcon::fromTheme(QStringLiteral("microphone-sensitivity-muted")), i18n("Mute"));
111		m_muteAction->setCheckable(true);
112		connect(m_muteAction.data(), &QAction::triggered, this, &MicrophoneIndicator::setMuted);
113
114		// don't let it quit plasmashell
115		m_sni->setStandardActionsEnabled(false);
116		}
117
118		const bool allMuted = muted();
119
120		QString iconName;
121		if (allMuted) {
122		iconName = QStringLiteral("microphone-sensitivity-muted");
123		} else {
124		if (Source *defaultSource = m_sourceModel->defaultSource()) {
125		const int percent = volumePercent(defaultSource);
126		iconName = QStringLiteral("microphone-sensitivity");
127		// it deliberately never shows the "muted" icon unless all microphones are muted
128		if (percent <= 25) {
129		iconName.append(QStringLiteral("-low"));
130		} else if (percent <= 75) {
131		iconName.append(QStringLiteral("-medium"));
132		} else {
133		iconName.append(QStringLiteral("-high"));
134		}
135		} else {
136		iconName = QStringLiteral("microphone-sensitivity-high");
137		}
138		}
139
140		QStringList names = appNames();
141		Q_ASSERT(!names.isEmpty());
142
143		m_sni->setTitle(i18n("Microphone"));
144		m_sni->setIconByName(iconName);
145
146		QString tooltip = i18nc("App is using mic", "%1 is using the microphone", names.constFirst());
147		if (names.count() > 1) {
148		tooltip = i18nc("List of apps is using mic", "%1 are using the microphone", names.join(i18nc("list separator", ", ")));
149		}
150
151		m_sni->setToolTip(QIcon::fromTheme(iconName), i18n("Microphone"), tooltip);
152
153		if (m_muteAction) {
154		m_muteAction->setChecked(allMuted);
155		}
156
157		if (m_showOsdOnUpdate) {
158		showOsd();
159		m_showOsdOnUpdate = false;
160		}
161		}
162
163		bool MicrophoneIndicator::muted() const
164		{
165		static const int s_mutedRole = m_sourceModel->role(QByteArrayLiteral("Muted"));
166		Q_ASSERT(s_mutedRole > -1);
167		static const int s_virtualStreamRole = m_sourceModel->role(QByteArrayLiteral("VirtualStream"));
168		Q_ASSERT(s_virtualStreamRole > -1);
169
170		for (int row = 0; row < m_sourceModel->rowCount(); ++row) {
171		const QModelIndex idx = m_sourceModel->index(row);
172		if (idx.data(s_virtualStreamRole).toBool()) {
173		qDebug() << "iggen virt";
174		continue;
175		}
176
177		if (!idx.data(s_mutedRole).toBool()) {
178		// this is deliberately checking if all microphones are muted rather than the preferred one
179		return false;
180		}
181		}
182
183		return true;
184		}
185
186		void MicrophoneIndicator::setMuted(bool muted)
187		{
188		static const int s_mutedRole = m_sourceModel->role(QByteArrayLiteral("Muted"));
189		Q_ASSERT(s_mutedRole > -1);
190		static const int s_virtualStreamRole = m_sourceModel->role(QByteArrayLiteral("VirtualStream"));
191		Q_ASSERT(s_virtualStreamRole > -1);
192
193		m_showOsdOnUpdate = true;
194
195		if (muted) {
196		for (int row = 0; row < m_sourceModel->rowCount(); ++row) {
197		const QModelIndex idx = m_sourceModel->index(row);
198		if (idx.data(s_virtualStreamRole).toBool()) {
199		qDebug() << "iggen virt set muted";
	droscaUnsubmitted Not Done newline drosca: newline
200		continue;
201		}
202
203		if (!idx.data(s_mutedRole).toBool()) {
	droscaUnsubmitted Not Done qAsConst(m_mutedIndices) drosca: qAsConst(m_mutedIndices)
204		m_sourceModel->setData(idx, true, s_mutedRole);
205		m_mutedIndices.append(QPersistentModelIndex(idx));
206		continue;
207		}
208		}
209		return;
210		}
211
212		// If we didn't mute it, unmute all
213		if (m_mutedIndices.isEmpty()) {
214		for (int i = 0; i < m_sourceModel->rowCount(); ++i) {
215		m_sourceModel->setData(m_sourceModel->index(i), false, s_mutedRole);
216		}
217		return;
218		}
219
220		// Otherwise unmute the devices we muted
221		for (auto &idx : qAsConst(m_mutedIndices)) {
222		if (!idx.isValid()) {
223		continue;
224		}
225		m_sourceModel->setData(idx, false, s_mutedRole);
226		}
227		m_mutedIndices.clear();
228
229		// no update() needed as the model signals a change
230		}
231
232		void MicrophoneIndicator::toggleMuted()
233		{
234		setMuted(!muted());
235		}
236
237		void MicrophoneIndicator::adjustVolume(int direction)
238		{
239		Source *source = m_sourceModel->defaultSource();
240		if (!source) {
241		return;
242		}
243
244		const int step = qRound(5 * Context::NormalVolume / 100.0);
245
246		const auto newVolume = qBound(Context::MinimalVolume,
247		source->volume() + direction * step,
248		Context::NormalVolume);
249
250		source->setVolume(newVolume);
251		source->setMuted(newVolume == Context::MinimalVolume);
252
253		m_showOsdOnUpdate = true;
254		}
	droscaUnsubmitted Not Done newline drosca: newline
255
256		int MicrophoneIndicator::volumePercent(Source *source)
257		{
258		return source->isMuted() ? 0 : qRound(source->volume() / static_cast<qreal>(Context::NormalVolume) * 100);
259		}
260
261		void MicrophoneIndicator::showOsd()
262		{
263		if (!m_osd) {
264		m_osd = new VolumeOSD(this);
265		}
266
267		auto *preferredSource = m_sourceModel->defaultSource();
268		if (!preferredSource) {
269		return;
270		}
271
272		m_osd->showMicrophone(volumePercent(preferredSource));
273
274		}
275
	droscaUnsubmitted Not Done Yes, this should never be empty. drosca: Yes, this should never be empty.
276		QStringList MicrophoneIndicator::appNames() const
277		{
278		static const int s_nameRole = m_sourceOutputModel->role(QByteArrayLiteral("Name"));
279		Q_ASSERT(s_nameRole > -1);
280		static const int s_clientRole = m_sourceOutputModel->role(QByteArrayLiteral("Client"));
281		Q_ASSERT(s_clientRole > -1);
282
283		QStringList names;
284		names.reserve(m_sourceOutputModel->rowCount());
285
286		for (int i = 0; i < m_sourceOutputModel->rowCount(); ++i) {
287		const QModelIndex idx = m_sourceOutputModel->index(i);
288
289		Client client = qobject_cast<Client >(idx.data(s_clientRole).value<QObject *>());
290
291		if (client) {
292		names.append(client->name());
293		} else {
294		names.append(idx.data(s_nameRole).toString());
295		}
296		}
297
298		return names;
299		}