[colorcorrection] Night Color - blue light filter at nighttime
With Wayland KWin needs to provide certain services, which were provided
before that by the Xserver. One of these is gamma correction, which includes
the - by many people beloved - functionality to reduce the blue light at
nighttime. This patch provides the KWin part of that. It is self contained,
but in the end will work in tandem with a lib in Plasma Workspace and a KCM
in Plasma Desktop, which can be used to configure Night Color.
* Three modi:
** Automatic: The location and sun timings are determined automatically
(location data updates will be provided by the workspace)
** Location: The sun timings are determined by fixed location data
** Timings: The sun timings are set manually by the user
* Color temperature value changes are smoothly applied:
** Configuration changes, which lead to other current values are changed
in a quick way over a few seconds
** Changes on sunrise and sunset are applied slowly over the course of few
minutes till several hours depending on the configuration
* The current color value is set immediately at startup or after suspend
phases and VT switches. There is no flickering.
* All configuration is done via a DBus interface, changed values are tested
on correctness and applied atomically
* Self contained mechanism, speaks directly to the hardware by setting the
gamma ramps on the CRTC
* Currently working on DRM backend, extensible to other platform backends in
the future
* The code is written in a way to make the classes later easily extendable to
also provide normal color correction, as it's currently done by KGamma on X
Test Plan:
Manually with the workspace parts and added integration tests in KWin using
the virtual backend.
BUG:371494
Reviewers: #kwin, graesslin
Subscribers: kwin, plasma-devel, #kwin
Tags: #kwin
Differential Revision: https://phabricator.kde.org/D5928
2017-12-11 12:43:12 +03:00
|
|
|
/********************************************************************
|
|
|
|
KWin - the KDE window manager
|
|
|
|
This file is part of the KDE project.
|
|
|
|
|
|
|
|
Copyright 2017 Roman Gilg <subdiff@gmail.com>
|
|
|
|
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
|
|
it under the terms of the GNU General Public License as published by
|
|
|
|
the Free Software Foundation; either version 2 of the License, or
|
|
|
|
(at your option) any later version.
|
|
|
|
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
GNU General Public License for more details.
|
|
|
|
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*********************************************************************/
|
|
|
|
|
|
|
|
#ifndef KWIN_NIGHTCOLOR_DBUS_INTERFACE_H
|
|
|
|
#define KWIN_NIGHTCOLOR_DBUS_INTERFACE_H
|
|
|
|
|
|
|
|
#include <QObject>
|
2018-06-05 13:52:57 +03:00
|
|
|
#include <QtDBus>
|
[colorcorrection] Night Color - blue light filter at nighttime
With Wayland KWin needs to provide certain services, which were provided
before that by the Xserver. One of these is gamma correction, which includes
the - by many people beloved - functionality to reduce the blue light at
nighttime. This patch provides the KWin part of that. It is self contained,
but in the end will work in tandem with a lib in Plasma Workspace and a KCM
in Plasma Desktop, which can be used to configure Night Color.
* Three modi:
** Automatic: The location and sun timings are determined automatically
(location data updates will be provided by the workspace)
** Location: The sun timings are determined by fixed location data
** Timings: The sun timings are set manually by the user
* Color temperature value changes are smoothly applied:
** Configuration changes, which lead to other current values are changed
in a quick way over a few seconds
** Changes on sunrise and sunset are applied slowly over the course of few
minutes till several hours depending on the configuration
* The current color value is set immediately at startup or after suspend
phases and VT switches. There is no flickering.
* All configuration is done via a DBus interface, changed values are tested
on correctness and applied atomically
* Self contained mechanism, speaks directly to the hardware by setting the
gamma ramps on the CRTC
* Currently working on DRM backend, extensible to other platform backends in
the future
* The code is written in a way to make the classes later easily extendable to
also provide normal color correction, as it's currently done by KGamma on X
Test Plan:
Manually with the workspace parts and added integration tests in KWin using
the virtual backend.
BUG:371494
Reviewers: #kwin, graesslin
Subscribers: kwin, plasma-devel, #kwin
Tags: #kwin
Differential Revision: https://phabricator.kde.org/D5928
2017-12-11 12:43:12 +03:00
|
|
|
|
|
|
|
namespace KWin
|
|
|
|
{
|
|
|
|
|
|
|
|
namespace ColorCorrect
|
|
|
|
{
|
|
|
|
|
|
|
|
class Manager;
|
|
|
|
|
|
|
|
class ColorCorrectDBusInterface : public QObject
|
|
|
|
{
|
|
|
|
Q_OBJECT
|
|
|
|
Q_CLASSINFO("D-Bus Interface", "org.kde.kwin.ColorCorrect")
|
|
|
|
|
|
|
|
public:
|
|
|
|
explicit ColorCorrectDBusInterface(Manager *parent);
|
|
|
|
virtual ~ColorCorrectDBusInterface() = default;
|
|
|
|
|
|
|
|
public Q_SLOTS:
|
|
|
|
/**
|
|
|
|
* @brief Gives information about the current state of Night Color.
|
|
|
|
*
|
|
|
|
* The returned variant hash has always the fields:
|
|
|
|
* - ActiveEnabled
|
|
|
|
* - Active
|
|
|
|
* - Mode
|
|
|
|
* - NightTemperatureEnabled
|
|
|
|
* - NightTemperature
|
|
|
|
* - Running
|
|
|
|
* - CurrentColorTemperature
|
|
|
|
* - LatitudeAuto
|
|
|
|
* - LongitudeAuto
|
|
|
|
* - LocationEnabled
|
|
|
|
* - LatitudeFixed
|
|
|
|
* - LongitudeFixed
|
|
|
|
* - TimingsEnabled
|
|
|
|
* - MorningBeginFixed
|
|
|
|
* - EveningBeginFixed
|
|
|
|
* - TransitionTime
|
|
|
|
*
|
|
|
|
* @return QHash<QString, QVariant>
|
|
|
|
* @see nightColorConfigChange
|
|
|
|
* @see signalNightColorConfigChange
|
|
|
|
* @since 5.12
|
|
|
|
**/
|
|
|
|
QHash<QString, QVariant> nightColorInfo();
|
|
|
|
/**
|
|
|
|
* @brief Allows changing the Night Color configuration.
|
|
|
|
*
|
|
|
|
* The provided variant hash can have the following fields:
|
|
|
|
* - Active
|
|
|
|
* - Mode
|
|
|
|
* - NightTemperature
|
|
|
|
* - LatitudeAuto
|
|
|
|
* - LongitudeAuto
|
|
|
|
* - LatitudeFixed
|
|
|
|
* - LongitudeFixed
|
|
|
|
* - MorningBeginFixed
|
|
|
|
* - EveningBeginFixed
|
|
|
|
* - TransitionTime
|
|
|
|
*
|
2018-08-29 21:02:16 +03:00
|
|
|
* It returns true if the configuration change was successful, otherwise false.
|
[colorcorrection] Night Color - blue light filter at nighttime
With Wayland KWin needs to provide certain services, which were provided
before that by the Xserver. One of these is gamma correction, which includes
the - by many people beloved - functionality to reduce the blue light at
nighttime. This patch provides the KWin part of that. It is self contained,
but in the end will work in tandem with a lib in Plasma Workspace and a KCM
in Plasma Desktop, which can be used to configure Night Color.
* Three modi:
** Automatic: The location and sun timings are determined automatically
(location data updates will be provided by the workspace)
** Location: The sun timings are determined by fixed location data
** Timings: The sun timings are set manually by the user
* Color temperature value changes are smoothly applied:
** Configuration changes, which lead to other current values are changed
in a quick way over a few seconds
** Changes on sunrise and sunset are applied slowly over the course of few
minutes till several hours depending on the configuration
* The current color value is set immediately at startup or after suspend
phases and VT switches. There is no flickering.
* All configuration is done via a DBus interface, changed values are tested
on correctness and applied atomically
* Self contained mechanism, speaks directly to the hardware by setting the
gamma ramps on the CRTC
* Currently working on DRM backend, extensible to other platform backends in
the future
* The code is written in a way to make the classes later easily extendable to
also provide normal color correction, as it's currently done by KGamma on X
Test Plan:
Manually with the workspace parts and added integration tests in KWin using
the virtual backend.
BUG:371494
Reviewers: #kwin, graesslin
Subscribers: kwin, plasma-devel, #kwin
Tags: #kwin
Differential Revision: https://phabricator.kde.org/D5928
2017-12-11 12:43:12 +03:00
|
|
|
* A change request for the location or timings needs to provide all relevant fields at the same time
|
2018-08-29 21:02:16 +03:00
|
|
|
* to be successful. Otherwise the whole change request will get ignored. A change request will be ignored
|
|
|
|
* as a whole as well, if one of the provided information has been sent in a wrong format.
|
[colorcorrection] Night Color - blue light filter at nighttime
With Wayland KWin needs to provide certain services, which were provided
before that by the Xserver. One of these is gamma correction, which includes
the - by many people beloved - functionality to reduce the blue light at
nighttime. This patch provides the KWin part of that. It is self contained,
but in the end will work in tandem with a lib in Plasma Workspace and a KCM
in Plasma Desktop, which can be used to configure Night Color.
* Three modi:
** Automatic: The location and sun timings are determined automatically
(location data updates will be provided by the workspace)
** Location: The sun timings are determined by fixed location data
** Timings: The sun timings are set manually by the user
* Color temperature value changes are smoothly applied:
** Configuration changes, which lead to other current values are changed
in a quick way over a few seconds
** Changes on sunrise and sunset are applied slowly over the course of few
minutes till several hours depending on the configuration
* The current color value is set immediately at startup or after suspend
phases and VT switches. There is no flickering.
* All configuration is done via a DBus interface, changed values are tested
on correctness and applied atomically
* Self contained mechanism, speaks directly to the hardware by setting the
gamma ramps on the CRTC
* Currently working on DRM backend, extensible to other platform backends in
the future
* The code is written in a way to make the classes later easily extendable to
also provide normal color correction, as it's currently done by KGamma on X
Test Plan:
Manually with the workspace parts and added integration tests in KWin using
the virtual backend.
BUG:371494
Reviewers: #kwin, graesslin
Subscribers: kwin, plasma-devel, #kwin
Tags: #kwin
Differential Revision: https://phabricator.kde.org/D5928
2017-12-11 12:43:12 +03:00
|
|
|
*
|
|
|
|
* @return bool
|
|
|
|
* @see nightColorInfo
|
|
|
|
* @see signalNightColorConfigChange
|
|
|
|
* @since 5.12
|
|
|
|
**/
|
|
|
|
bool setNightColorConfig(QHash<QString, QVariant> data);
|
|
|
|
/**
|
|
|
|
* @brief For receiving auto location updates, primarily through the KDE Daemon
|
|
|
|
* @return void
|
|
|
|
* @since 5.12
|
|
|
|
**/
|
|
|
|
void nightColorAutoLocationUpdate(double latitude, double longitude);
|
|
|
|
|
|
|
|
Q_SIGNALS:
|
|
|
|
/**
|
|
|
|
* @brief Emits that the Night Color configuration has been changed.
|
|
|
|
*
|
|
|
|
* The provided variant hash provides the same fields as @link nightColorInfo
|
|
|
|
*
|
|
|
|
* @return void
|
|
|
|
* @see nightColorInfo
|
|
|
|
* @see nightColorConfigChange
|
|
|
|
* @since 5.12
|
|
|
|
**/
|
|
|
|
void nightColorConfigChanged(QHash<QString, QVariant> data);
|
|
|
|
|
|
|
|
private:
|
|
|
|
Manager *m_manager;
|
|
|
|
};
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
#endif // KWIN_NIGHTCOLOR_DBUS_INTERFACE_H
|