kwin/plugins/platforms/virtual/virtual_backend.h
Roman Gilg 82d2860469 [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 10:58:40 +01:00

119 lines
3.2 KiB
C++

/********************************************************************
KWin - the KDE window manager
This file is part of the KDE project.
Copyright (C) 2015 Martin Gräßlin <mgraesslin@kde.org>
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_VIRTUAL_BACKEND_H
#define KWIN_VIRTUAL_BACKEND_H
#include "platform.h"
#include <kwin_export.h>
#include <QObject>
#include <QSize>
class QTemporaryDir;
struct gbm_device;
namespace KWin
{
namespace ColorCorrect {
class Manager;
struct GammaRamp;
}
class KWIN_EXPORT VirtualBackend : public Platform
{
Q_OBJECT
Q_INTERFACES(KWin::Platform)
Q_PLUGIN_METADATA(IID "org.kde.kwin.Platform" FILE "virtual.json")
Q_PROPERTY(QSize size READ size NOTIFY sizeChanged)
public:
VirtualBackend(QObject *parent = nullptr);
virtual ~VirtualBackend();
void init() override;
QSize size() const {
return m_size;
}
int outputCount() const {
return m_outputCount;
}
qreal outputScale() const {
return m_outputScale;
}
bool saveFrames() const {
return !m_screenshotDir.isNull();
}
QString screenshotDirPath() const;
Screens *createScreens(QObject *parent = nullptr) override;
QPainterBackend* createQPainterBackend() override;
OpenGLBackend *createOpenGLBackend() override;
Q_INVOKABLE void setOutputCount(int count) {
m_outputCount = count;
m_gammaSizes = QVector<int>(count, 200);
m_gammaResults = QVector<bool>(count, true);
}
Q_INVOKABLE void setOutputScale(qreal scale) {
m_outputScale = scale;
}
int drmFd() const {
return m_drmFd;
}
void setDrmFd(int fd) {
m_drmFd = fd;
}
gbm_device *gbmDevice() const {
return m_gbmDevice;
}
void setGbmDevice(gbm_device *device) {
m_gbmDevice = device;
}
virtual int gammaRampSize(int screen) const override;
virtual bool setGammaRamp(int screen, ColorCorrect::GammaRamp &gamma) override;
QVector<CompositingType> supportedCompositors() const override {
return QVector<CompositingType>{OpenGLCompositing, QPainterCompositing};
}
Q_SIGNALS:
void sizeChanged();
void outputGeometriesChanged(const QVector<QRect> &geometries);
private:
QSize m_size;
int m_outputCount = 1;
qreal m_outputScale = 1;
QScopedPointer<QTemporaryDir> m_screenshotDir;
int m_drmFd = -1;
gbm_device *m_gbmDevice = nullptr;
QVector<int> m_gammaSizes = QVector<int>(1, 200);
QVector<bool> m_gammaResults = QVector<bool>(1, true);
};
}
#endif