File: powerdevilscreenbrightnessagent.cpp

package info (click to toggle)
powerdevil 4%3A6.5.4-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 10,680 kB
  • sloc: cpp: 13,284; xml: 1,911; python: 1,204; sh: 19; makefile: 10
file content (314 lines) | stat: -rw-r--r-- 13,471 bytes parent folder | download | duplicates (2)
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
/*
 *   SPDX-FileCopyrightText: 2010 Dario Freddi <drf@kde.org>
 *   SPDX-FileCopyrightText: 2024 Jakob Petsovits <jpetso@petsovits.org>
 *
 *   SPDX-License-Identifier: GPL-2.0-or-later
 */

#include "powerdevilscreenbrightnessagent.h"

#include <powerdevil_debug.h>
#include <screenbrightnessadaptor.h>
#include <screenbrightnessdisplayadaptor.h>

#include <QAction>
#include <QDBusConnection>
#include <QDBusMessage>
#include <QDBusPendingCall>
#include <QDebug>

#include <KActionCollection>
#include <KGlobalAccel>
#include <KLocalizedString>
#include <KScreen/Output>

using namespace Qt::Literals::StringLiterals;

static const QString DBUS_PROPERTIES_IFACE = u"org.freedesktop.DBus.Properties"_s;
static const QString SCREENBRIGHTNESS_PATH = u"/org/kde/ScreenBrightness"_s;
static const QString SCREENBRIGHTNESS_IFACE = u"org.kde.ScreenBrightness"_s;
static const QString SCREENBRIGHTNESS_DISPLAY_PATH_TEMPLATE = u"/org/kde/ScreenBrightness/%1"_s;
static const QString SCREENBRIGHTNESS_DISPLAY_DBUS_NAME_TEMPLATE = u"display%1"_s; // same as above, last path element only

namespace PowerDevil
{
ScreenBrightnessDisplay::ScreenBrightnessDisplay(QObject *parent, const QString &dbusName, ScreenBrightnessController *controller, const QString &displayId)
    : QObject(parent)
    , m_dbusName(dbusName)
    , m_displayId(displayId)
    , m_controller(controller)
{
    new ScreenBrightnessDisplayAdaptor(this);
    QDBusConnection::sessionBus().registerObject(dbusPath(), this);
}

ScreenBrightnessDisplay::~ScreenBrightnessDisplay()
{
    QDBusConnection::sessionBus().unregisterObject(dbusPath());
}

QString ScreenBrightnessDisplay::displayId() const
{
    return m_displayId;
}

QString ScreenBrightnessDisplay::DBusName() const
{
    return m_dbusName;
}

QString ScreenBrightnessDisplay::dbusPath() const
{
    return SCREENBRIGHTNESS_DISPLAY_PATH_TEMPLATE.arg(m_dbusName);
}

QString ScreenBrightnessDisplay::Label() const
{
    return m_controller->label(m_displayId);
}

bool ScreenBrightnessDisplay::IsInternal() const
{
    return m_controller->isInternal(m_displayId);
}

int ScreenBrightnessDisplay::Brightness() const
{
    return m_controller->brightness(m_displayId) - m_controller->minBrightness(m_displayId);
}

int ScreenBrightnessDisplay::MaxBrightness() const
{
    return m_controller->maxBrightness(m_displayId) - m_controller->minBrightness(m_displayId);
}

void ScreenBrightnessDisplay::SetBrightness(int value, uint flags)
{
    SetBrightnessWithContext(value, flags, QString());
}

void ScreenBrightnessDisplay::SetBrightnessWithContext(int value, uint flags, const QString &sourceClientContext)
{
    ScreenBrightnessController::IndicatorHint hint = flags & static_cast<uint>(SetBrightnessFlags::SuppressIndicator)
        ? ScreenBrightnessController::SuppressIndicator
        : ScreenBrightnessController::ShowIndicator;

    QString sourceClientName = message().service();

    m_controller->setBrightness(m_displayId, value + m_controller->minBrightness(m_displayId), sourceClientName, sourceClientContext, hint);
}

ScreenBrightnessAgent::ScreenBrightnessAgent(QObject *parent, ScreenBrightnessController *controller)
    : QObject(parent)
    , m_controller(controller)
{
    new ScreenBrightnessAdaptor(this);
    QDBusConnection::sessionBus().registerObject(u"/org/kde/ScreenBrightness"_s, this);

    connect(m_controller, &ScreenBrightnessController::brightnessChanged, this, &ScreenBrightnessAgent::onBrightnessChanged);
    // TODO: handle max brightness change via new ScreenBrightnessController::brightnessRangeChanged signal?

    connect(m_controller, &ScreenBrightnessController::displayAdded, this, [this](const QString &displayId) {
        const QString dbusName = insertDisplayChild(displayId);
        Q_EMIT DisplayAdded(dbusName);
    });
    connect(m_controller, &ScreenBrightnessController::displayRemoved, this, [this](const QString &displayId) {
        auto displayIt = m_displayChildren.find(displayId);
        if (displayIt == m_displayChildren.end()) {
            qCWarning(POWERDEVIL) << "onDisplayRemoved: Agent could not find display object for ID" << displayId;
            return;
        }
        const QString dbusName = displayIt->second->DBusName();

        m_displayChildren.erase(displayIt);
        Q_EMIT DisplayRemoved(dbusName);
    });

    const QStringList initialDisplayIds = m_controller->displayIds();
    std::ranges::for_each(initialDisplayIds, std::bind(&ScreenBrightnessAgent::insertDisplayChild, this, std::placeholders::_1));

    connect(m_controller, &ScreenBrightnessController::displayIdsChanged, this, [this](const QStringList &) {
        QDBusMessage signal = QDBusMessage::createSignal(SCREENBRIGHTNESS_PATH, DBUS_PROPERTIES_IFACE, u"PropertiesChanged"_s);
        signal << SCREENBRIGHTNESS_IFACE << QVariantMap() << QStringList({u"DisplaysDBusNames"_s});
        QDBusConnection::sessionBus().send(signal);
    });

    // shortcuts to increase/decrease brightness
    KActionCollection *actionCollection = new KActionCollection(this);
    actionCollection->setComponentDisplayName(i18nc("Name for powerdevil shortcuts category", "Power Management"));

    QAction *globalAction = actionCollection->addAction("Increase Screen Brightness"_L1);
    globalAction->setText(i18nc("@action:inmenu Global shortcut", "Increase Screen Brightness"));
    KGlobalAccel::setGlobalShortcut(globalAction, Qt::Key_MonBrightnessUp);
    connect(globalAction, &QAction::triggered, this, [this] {
        actOnBrightnessKey(BrightnessLogic::Increase);
    });

    globalAction = actionCollection->addAction("Increase Screen Brightness Small"_L1);
    globalAction->setText(i18nc("@action:inmenu Global shortcut", "Increase Screen Brightness by 1%"));
    KGlobalAccel::setGlobalShortcut(globalAction, Qt::ShiftModifier | Qt::Key_MonBrightnessUp);
    connect(globalAction, &QAction::triggered, this, [this] {
        actOnBrightnessKey(BrightnessLogic::IncreaseSmall);
    });

    globalAction = actionCollection->addAction("Decrease Screen Brightness"_L1);
    globalAction->setText(i18nc("@action:inmenu Global shortcut", "Decrease Screen Brightness"));
    KGlobalAccel::setGlobalShortcut(globalAction, Qt::Key_MonBrightnessDown);
    connect(globalAction, &QAction::triggered, this, [this] {
        actOnBrightnessKey(BrightnessLogic::Decrease);
    });

    globalAction = actionCollection->addAction("Decrease Screen Brightness Small"_L1);
    globalAction->setText(i18nc("@action:inmenu Global shortcut", "Decrease Screen Brightness by 1%"));
    KGlobalAccel::setGlobalShortcut(globalAction, Qt::ShiftModifier | Qt::Key_MonBrightnessDown);
    connect(globalAction, &QAction::triggered, this, [this] {
        actOnBrightnessKey(BrightnessLogic::DecreaseSmall);
    });
}

QString ScreenBrightnessAgent::insertDisplayChild(const QString &displayId)
{
    const size_t dbusDisplayIndex = m_nextDbusDisplayIndex;
    ++m_nextDbusDisplayIndex;

    const auto &[it, wasInserted] = m_displayChildren.insert_or_assign(
        displayId,
        std::make_unique<ScreenBrightnessDisplay>(nullptr, SCREENBRIGHTNESS_DISPLAY_DBUS_NAME_TEMPLATE.arg(dbusDisplayIndex), m_controller, displayId));

    return it->second->DBusName();
}

void ScreenBrightnessAgent::onBrightnessChanged(const QString &displayId,
                                                const BrightnessLogic::BrightnessInfo &info,
                                                const QString &sourceClientName,
                                                const QString &sourceClientContext,
                                                ScreenBrightnessController::IndicatorHint hint)
{
    auto displayIt = m_displayChildren.find(displayId);
    if (displayIt == m_displayChildren.end()) {
        qCWarning(POWERDEVIL) << "onBrightnessChanged: Agent could not find display object for ID" << displayId;
        return;
    }
    int newBrightness = info.value - info.valueMin;

    Q_EMIT BrightnessChanged(displayIt->second->DBusName(), newBrightness, sourceClientName, sourceClientContext);

    QDBusMessage signal = QDBusMessage::createSignal(displayIt->second->dbusPath(), DBUS_PROPERTIES_IFACE, u"PropertiesChanged"_s);
    QVariantMap changedProps = {{u"Brightness"_s, newBrightness}};
    signal << u"org.kde.ScreenBrightness.Display"_s << changedProps << QStringList();
    QDBusConnection::sessionBus().send(signal);

    if (hint == ScreenBrightnessController::ShowIndicator) {
        // Try to match the controller's display to a KScreen display for optimized OSD presentation.
        const KScreen::OutputPtr matchedOutput = m_controller->tryMatchKScreenOutput(displayId);

        QDBusMessage msg = QDBusMessage::createMethodCall(QStringLiteral("org.kde.plasmashell"),
                                                          QStringLiteral("/org/kde/osdService"),
                                                          QStringLiteral("org.kde.osdService"),
                                                          QLatin1String("screenBrightnessChanged"));
        msg << brightnessPercent(newBrightness, info.valueMax - info.valueMin) << (matchedOutput ? matchedOutput->name() : displayId)
            << m_controller->label(displayId) << static_cast<int>(m_controller->displayIds().indexOf(displayId))
            << (matchedOutput && matchedOutput->isPositionable() ? matchedOutput->geometry() : QRect());
        QDBusConnection::sessionBus().asyncCall(msg);
    }
}

void ScreenBrightnessAgent::onBrightnessRangeChanged(const QString &displayId, const BrightnessLogic::BrightnessInfo &info)
{
    auto displayIt = m_displayChildren.find(displayId);
    if (displayIt == m_displayChildren.end()) {
        qCWarning(POWERDEVIL) << "onBrightnessRangeChanged: Agent could not find display object for ID" << displayId;
        return;
    }

    int newBrightness = info.value - info.valueMin;
    int newMaxBrightness = info.valueMax - info.valueMin;

    Q_EMIT BrightnessRangeChanged(displayIt->second->DBusName(), newMaxBrightness, newBrightness);

    QDBusMessage signal = QDBusMessage::createSignal(displayIt->second->dbusPath(), DBUS_PROPERTIES_IFACE, u"PropertiesChanged"_s);
    QVariantMap changedProps = {{u"Brightness"_s, newBrightness}, {u"MaxBrightness"_s, newMaxBrightness}};
    signal << u"org.kde.ScreenBrightness.Display"_s << changedProps << QStringList();
    QDBusConnection::sessionBus().send(signal);
}

QStringList ScreenBrightnessAgent::DisplaysDBusNames() const
{
    QStringList names;
    std::ranges::transform(m_controller->displayIds(), std::back_inserter(names), [this](const QString &displayId) {
        if (auto it = m_displayChildren.find(displayId); it != m_displayChildren.end()) {
            return it->second->DBusName();
        } else {
            qCWarning(POWERDEVIL) << "DisplaysDBusNames: Agent could not find display object for ID" << displayId;
            return QString();
        }
    });
    return names;
}

void ScreenBrightnessAgent::AdjustBrightnessRatio(double delta, uint flags)
{
    AdjustBrightnessRatioWithContext(delta, flags, QString());
}

void ScreenBrightnessAgent::AdjustBrightnessRatioWithContext(double delta, uint flags, const QString &sourceClientContext)
{
    ScreenBrightnessController::IndicatorHint hint = flags & static_cast<uint>(AdjustBrightnessRatioFlags::SuppressIndicator)
        ? ScreenBrightnessController::SuppressIndicator
        : ScreenBrightnessController::ShowIndicator;

    QString sourceClientName = message().service();

    m_controller->adjustBrightnessRatio(delta, sourceClientName, sourceClientContext, hint);
}

void ScreenBrightnessAgent::AdjustBrightnessStep(uint stepAction, uint flags)
{
    AdjustBrightnessStepWithContext(stepAction, flags, QString());
}

void ScreenBrightnessAgent::AdjustBrightnessStepWithContext(uint stepAction, uint flags, const QString &sourceClientContext)
{
    BrightnessLogic::StepAdjustmentAction adjustment;
    switch (static_cast<AdjustBrightnessStepAction>(stepAction)) {
    case AdjustBrightnessStepAction::Increase:
        adjustment = BrightnessLogic::Increase;
        break;
    case AdjustBrightnessStepAction::Decrease:
        adjustment = BrightnessLogic::Decrease;
        break;
    case AdjustBrightnessStepAction::IncreaseSmall:
        adjustment = BrightnessLogic::IncreaseSmall;
        break;
    case AdjustBrightnessStepAction::DecreaseSmall:
        adjustment = BrightnessLogic::DecreaseSmall;
        break;
    default:
        qCDebug(POWERDEVIL) << "Adjust brightness step: Unknown step action:" << stepAction;
        return;
    }

    ScreenBrightnessController::IndicatorHint hint = flags & static_cast<uint>(AdjustBrightnessStepFlags::SuppressIndicator)
        ? ScreenBrightnessController::SuppressIndicator
        : ScreenBrightnessController::ShowIndicator;

    QString sourceClientName = message().service();

    m_controller->adjustBrightnessStep(adjustment, sourceClientName, sourceClientContext, hint);
}

int ScreenBrightnessAgent::brightnessPercent(double value, double max) const
{
    return max > 0 ? std::round(value / max * 100) : 0;
}

void ScreenBrightnessAgent::actOnBrightnessKey(BrightnessLogic::StepAdjustmentAction action)
{
    if (!m_controller->isSupported()) {
        return;
    }
    m_controller->adjustBrightnessStep(action, u"(internal)"_s, u"brightness_key"_s, ScreenBrightnessController::ShowIndicator);
}
}

#include "moc_powerdevilscreenbrightnessagent.cpp"