Differential D14397 Diff 39289 src/notifybyaudio_canberra.cpp

Changeset View

Standalone View

View Options

src/notifybyaudio_canberra.cpp

  • This file was added.
1​/* This file is part of the KDE libraries
2​ Copyright (C) 2014-2015 by Martin Klapetek <mklapetek@kde.org>
3​ Copyright (C) 2018 Kai Uwe Broulik <kde@privat.broulik.de>
4​
5​ This library is free software; you can redistribute it and/or
6​ modify it under the terms of the GNU Lesser General Public
7​ License as published by the Free Software Foundation; either
8​ version 2.1 of the License, or (at your option) version 3, or any
9​ later version accepted by the membership of KDE e.V. (or its
10​ successor approved by the membership of KDE e.V.), which shall
11​ act as a proxy defined in Section 6 of version 3 of the license.
12​
13​ This library is distributed in the hope that it will be useful,
14​ but WITHOUT ANY WARRANTY; without even the implied warranty of
15​ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16​ Lesser General Public License for more details.
17​
18​ You should have received a copy of the GNU Lesser General Public
19​ License along with this library. If not, see <http://www.gnu.org/licenses/>.
20​
21​*/
22​
23​#include "notifybyaudio_canberra.h"
24​#include "debug_p.h"
25​
26​#include <QGuiApplication>
27​#include <QFile>
28​#include <QFileInfo>
29​#include <QIcon>
30​#include <QString>
31​
32​#include "knotifyconfig.h"
33​#include "knotification.h"
34​
35​#include <canberra.h>
36​
37​NotifyByAudio::NotifyByAudio(QObject *parent)
38​ : KNotificationPlugin(parent)
39​{
40​ qRegisterMetaType<uint32_t>("uint32_t");
41​
42​ int ret = ca_context_create(&m_context);
43​ if (ret != CA_SUCCESS) {
44​ qCWarning(LOG_KNOTIFICATIONS) << "Failed to initialize canberra context for audio notification:" << ca_strerror(ret);
45​ m_context = nullptr;
46​ return;
47​ }
48​
49​ ret = ca_context_change_props(m_context,
50​ CA_PROP_APPLICATION_NAME, qUtf8Printable(qApp->applicationDisplayName()),
51​ CA_PROP_APPLICATION_ID, qUtf8Printable(qApp->desktopFileName()),
52​ CA_PROP_APPLICATION_ICON_NAME, qUtf8Printable(qApp->windowIcon().name()),
53​ nullptr);
54​ if (ret != CA_SUCCESS) {
55​ qCWarning(LOG_KNOTIFICATIONS) << "Failed to set application properties on canberra context for audio notification:" << ca_strerror(ret);
56​ }
57​}
58​
59​NotifyByAudio::~NotifyByAudio()
60​{
61​ if (m_context) {
62​ ca_context_destroy(m_context);
63​ }
64​ m_context = nullptr;
65​}
66​
67​void NotifyByAudio::notify(KNotification *notification, KNotifyConfig *config)
68​{
69​ const QString soundFilename = config->readEntry(QStringLiteral("Sound"));
70​ if (soundFilename.isEmpty()) {
71​ qCWarning(LOG_KNOTIFICATIONS) << "Audio notification requested, but no sound file provided in notifyrc file, aborting audio notification";
72​
73​ finish(notification);
74​ return;
75​ }
76​
77​ QUrl soundURL;
78​ const auto dataLocations = QStandardPaths::standardLocations(QStandardPaths::GenericDataLocation);
79​ for (const QString &dataLocation : dataLocations) {
80​ soundURL = QUrl::fromUserInput(soundFilename,
81​ dataLocation + QStringLiteral("/sounds"),
82​ QUrl::AssumeLocalFile);
83​ if (soundURL.isLocalFile() && QFileInfo::exists(soundURL.toLocalFile())) {
84​ break;
85​ } else if (!soundURL.isLocalFile() && soundURL.isValid()) {
86​ break;
87​ }
88​ soundURL.clear();
89​ }
90​ if (soundURL.isEmpty()) {
91​ qCWarning(LOG_KNOTIFICATIONS) << "Audio notification requested, but sound file from notifyrc file was not found, aborting audio notification";
92​ finish(notification);
93​ return;
94​ }
95​
96​ // Looping happens in the finishCallback
97​ if (!playSound(m_currentId, soundURL)) {
98​ finish(notification);
99​ return;
100​ }
101​
102​ if (notification->flags() & KNotification::LoopSound) {
103​ m_loopSoundUrls.insert(m_currentId, soundURL);
104​ }
105​
106​ Q_ASSERT(!m_notifications.value(m_currentId));
107​ m_notifications.insert(m_currentId, notification);
108​
109​ ++m_currentId;
110​}
111​
112​bool NotifyByAudio::playSound(quint32 id, const QUrl &url)
113​{
sitterUnsubmitted
Not Done

Looks superfluous?

sitter: Looks superfluous?
114​ if (!m_context) {
115​ qCWarning(LOG_KNOTIFICATIONS) << "Cannot play notification sound without canberra context";
116​ return false;
117​ }
118​
119​ ca_proplist *props = nullptr;
sitterUnsubmitted
Not Done

This may benefit from an explicit Qt::QueuedConnection. I am not sure foreign-thread detection is 100% reliable with C call chains. Specifying it certainly is more explicit about the intent when reading the code though.

sitter: This may benefit from an explicit `Qt::QueuedConnection`. I am not sure foreign-thread…
rjvbbUnsubmitted
Not Done

That also corresponds to a Qt guideline.

rjvbb: That also corresponds to a Qt guideline.
120​ ca_proplist_create(&props);
121​
122​ // We'll also want this cached for a time. volatile makes sure the cache is
123​ // dropped after some time or when the cache is under pressure.
124​ ca_proplist_sets(props, CA_PROP_MEDIA_FILENAME, QFile::encodeName(url.toLocalFile()).constData());
125​ ca_proplist_sets(props, CA_PROP_CANBERRA_CACHE_CONTROL, "volatile");
126​
127​ int ret = ca_context_play_full(m_context, id, props, &ca_finish_callback, this);
128​
129​ ca_proplist_destroy(props);
130​
131​ if (ret != CA_SUCCESS) {
132​ qCWarning(LOG_KNOTIFICATIONS) << "Failed to play sound with canberra:" << ca_strerror(ret);
133​ return false;
134​ }
135​
136​ return true;
137​}
138​
139​void NotifyByAudio::ca_finish_callback(ca_context *c, uint32_t id, int error_code, void *userdata)
140​{
141​ Q_UNUSED(c);
142​ QMetaObject::invokeMethod(static_cast<NotifyByAudio*>(userdata),
143​ "finishCallback",
144​ Q_ARG(uint32_t, id),
145​ Q_ARG(int, error_code));
146​}
147​
148​void NotifyByAudio::finishCallback(uint32_t id, int error_code)
149​{
150​ KNotification *notification = m_notifications.value(id, nullptr);
151​
152​ if (error_code == CA_SUCCESS) {
153​ // Loop the sound now if we have one
154​ const QUrl soundUrl = m_loopSoundUrls.value(id);
155​ if (soundUrl.isValid()) {
156​ if (!playSound(id, soundUrl)) {
157​ finishNotification(notification, id);
158​ }
159​ return;
160​ }
161​ } else if (error_code != CA_ERROR_CANCELED) {
162​ qCWarning(LOG_KNOTIFICATIONS) << "Playing audio notification failed:" << ca_strerror(error_code);
163​ }
164​
165​ finishNotification(notification, id);
166​}
167​
168​void NotifyByAudio::close(KNotification *notification)
169​{
170​ if (!m_notifications.values().contains(notification)) {
171​ return;
172​ }
173​
174​ const auto id = m_notifications.key(notification);
175​ if (m_context) {
176​ int ret = ca_context_cancel(m_context, id);
177​ if (ret != CA_SUCCESS) {
178​ qCWarning(LOG_KNOTIFICATIONS) << "Failed to cancel canberra context for audio notification:" << ca_strerror(ret);
179​ return;
180​ }
181​ }
182​}
183​
184​
185​void NotifyByAudio::finishNotification(KNotification *notification, quint32 id)
186​{
187​ m_notifications.remove(id);
188​ m_loopSoundUrls.remove(id);
189​ finish(notification);
190​}