yukijoou/kwin
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

core/iccprofile: read colorimetry, BToA1 and BToA0 tags

Browse source
This commit is contained in:
Xaver Hugl 2023-10-09 16:40:26 +02:00
parent 286914133e
commit 1e4701309f
7 changed files with 425 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
src/CMakeLists.txt
View file

@ -43,6 +43,7 @@ target_sources(kwin PRIVATE
compositor_wayland.cpp
compositor_x11.cpp
core/colorlut.cpp
core/colorlut3d.cpp
core/colorpipelinestage.cpp
core/colortransformation.cpp
core/gbmgraphicsbufferallocator.cpp

45
src/core/colorlut3d.cpp Normal file
View file

@ -0,0 +1,45 @@
/*
KWin - the KDE window manager
This file is part of the KDE project.
SPDX-FileCopyrightText: 2023 Xaver Hugl <xaver.hugl@gmail.com>
SPDX-License-Identifier: GPL-2.0-or-later
*/
#include "colorlut3d.h"
#include "colortransformation.h"
#include <QVector3D>
namespace KWin
{
ColorLUT3D::ColorLUT3D(std::unique_ptr<ColorTransformation> &&transformation, size_t xSize, size_t ySize, size_t zSize)
: m_transformation(std::move(transformation))
, m_xSize(xSize)
, m_ySize(ySize)
, m_zSize(zSize)
{
}
size_t ColorLUT3D::xSize() const
{
return m_xSize;
}
size_t ColorLUT3D::ySize() const
{
return m_ySize;
}
size_t ColorLUT3D::zSize() const
{
return m_zSize;
}
QVector3D ColorLUT3D::sample(size_t x, size_t y, size_t z)
{
return m_transformation->transform(QVector3D(x / double(m_xSize - 1), y / double(m_ySize - 1), z / double(m_zSize - 1)));
}
}

41
src/core/colorlut3d.h Normal file
View file

@ -0,0 +1,41 @@
/*
KWin - the KDE window manager
This file is part of the KDE project.
SPDX-FileCopyrightText: 2023 Xaver Hugl <xaver.hugl@gmail.com>
SPDX-License-Identifier: GPL-2.0-or-later
*/
#pragma once
#include <QVector>
#include <memory>
#include "kwin_export.h"
class QVector3D;
namespace KWin
{
class ColorTransformation;
class KWIN_EXPORT ColorLUT3D
{
public:
ColorLUT3D(std::unique_ptr<ColorTransformation> &&transformation, size_t xSize, size_t ySize, size_t zSize);
size_t xSize() const;
size_t ySize() const;
size_t zSize() const;
QVector3D sample(size_t x, size_t y, size_t z);
private:
const std::unique_ptr<ColorTransformation> m_transformation;
const size_t m_xSize;
const size_t m_ySize;
const size_t m_zSize;
};
}

285
src/core/iccprofile.cpp
View file

@ -5,17 +5,30 @@
*/
#include "iccprofile.h"
#include "colorlut.h"
#include "colorlut3d.h"
#include "colorpipelinestage.h"
#include "colortransformation.h"
#include "utils/common.h"
#include <lcms2.h>
#include <span>
#include <tuple>
namespace KWin
{
IccProfile::IccProfile(cmsHPROFILE handle, const std::shared_ptr<ColorTransformation> &vcgt)
IccProfile::IccProfile(cmsHPROFILE handle, const Colorimetry &colorimetry, BToATagData &&bToATag, const std::shared_ptr<ColorTransformation> &vcgt)
: m_handle(handle)
, m_colorimetry(colorimetry)
, m_bToATag(std::move(bToATag))
, m_vcgt(vcgt)
{
}
IccProfile::IccProfile(cmsHPROFILE handle, const Colorimetry &colorimetry, const std::shared_ptr<ColorTransformation> &inverseEOTF, const std::shared_ptr<ColorTransformation> &vcgt)
: m_handle(handle)
, m_colorimetry(colorimetry)
, m_inverseEOTF(inverseEOTF)
, m_vcgt(vcgt)
{
}
@ -25,11 +38,174 @@ IccProfile::~IccProfile()
cmsCloseProfile(m_handle);
}
const Colorimetry &IccProfile::colorimetry() const
{
return m_colorimetry;
}
std::shared_ptr<ColorTransformation> IccProfile::inverseEOTF() const
{
return m_inverseEOTF;
}
std::shared_ptr<ColorTransformation> IccProfile::vcgt() const
{
return m_vcgt;
}
const IccProfile::BToATagData *IccProfile::BtToATag() const
{
return m_bToATag ? &m_bToATag.value() : nullptr;
}
static std::vector<uint8_t> readTagRaw(cmsHPROFILE profile, cmsTagSignature tag)
{
const auto numBytes = cmsReadRawTag(profile, tag, nullptr, 0);
std::vector<uint8_t> data(numBytes);
cmsReadRawTag(profile, tag, data.data(), numBytes);
return data;
}
template<typename T>
static T read(std::span<const uint8_t> data, size_t index)
{
// ICC profile data is big-endian
T ret;
for (size_t i = 0; i < sizeof(T); i++) {
*(reinterpret_cast<uint8_t *>(&ret) + i) = data[index + sizeof(T) - i - 1];
}
return ret;
}
static float readS15Fixed16(std::span<const uint8_t> data, size_t index)
{
return read<int32_t>(data, index) / 65536.0;
}
static std::optional<std::tuple<size_t, size_t, size_t>> parseBToACLUTSize(std::span<const uint8_t> data)
{
const uint32_t tagType = read<uint32_t>(data, 0);
const bool isLutTag = tagType == cmsSigLut8Type || tagType == cmsSigLut16Type;
if (isLutTag) {
const uint8_t size = data[10];
return std::make_tuple(size, size, size);
} else {
const uint32_t clutOffset = read<uint32_t>(data, 24);
if (data.size() < clutOffset + 19) {
qCWarning(KWIN_CORE, "CLut offset points to invalid position %u", clutOffset);
return std::nullopt;
}
return std::make_tuple(data[clutOffset + 0], data[clutOffset + 1], data[clutOffset + 2]);
}
}
static std::optional<QMatrix4x4> parseMatrix(std::span<const uint8_t> data, bool hasOffset)
{
const size_t matrixSize = hasOffset ? 12 : 9;
std::vector<float> floats;
floats.reserve(matrixSize);
for (size_t i = 0; i < matrixSize; i++) {
floats.push_back(readS15Fixed16(data, i * 4));
}
constexpr double xyzEncodingFactor = 65536.0 / (2 * 65535.0);
QMatrix4x4 ret;
ret(0, 0) = floats[0] * xyzEncodingFactor;
ret(0, 1) = floats[1] * xyzEncodingFactor;
ret(0, 2) = floats[2] * xyzEncodingFactor;
ret(1, 0) = floats[3] * xyzEncodingFactor;
ret(1, 1) = floats[4] * xyzEncodingFactor;
ret(1, 2) = floats[5] * xyzEncodingFactor;
ret(2, 0) = floats[6] * xyzEncodingFactor;
ret(2, 1) = floats[7] * xyzEncodingFactor;
ret(2, 2) = floats[8] * xyzEncodingFactor;
if (hasOffset) {
ret(0, 3) = floats[9] * xyzEncodingFactor;
ret(1, 3) = floats[10] * xyzEncodingFactor;
ret(2, 3) = floats[11] * xyzEncodingFactor;
}
return ret;
}
static std::optional<IccProfile::BToATagData> parseBToATag(cmsHPROFILE profile, cmsTagSignature tag)
{
cmsPipeline *bToAPipeline = static_cast<cmsPipeline *>(cmsReadTag(profile, tag));
if (!bToAPipeline) {
return std::nullopt;
}
IccProfile::BToATagData ret;
auto data = readTagRaw(profile, tag);
const uint32_t tagType = read<uint32_t>(data, 0);
switch (tagType) {
case cmsSigLut8Type:
case cmsSigLut16Type:
if (data.size() < 48) {
qCWarning(KWIN_CORE) << "ICC profile tag is too small" << data.size();
return std::nullopt;
}
break;
case cmsSigLutBtoAType:
if (data.size() < 32) {
qCWarning(KWIN_CORE) << "ICC profile tag is too small" << data.size();
return std::nullopt;
}
break;
default:
qCWarning(KWIN_CORE).nospace() << "unknown lut type " << (char)data[0] << (char)data[1] << (char)data[2] << (char)data[3];
return std::nullopt;
}
for (auto stage = cmsPipelineGetPtrToFirstStage(bToAPipeline); stage != nullptr; stage = cmsStageNext(stage)) {
switch (const cmsStageSignature stageType = cmsStageType(stage)) {
case cmsStageSignature::cmsSigCurveSetElemType: {
// TODO read the actual functions and apply them in the shader instead
// of using LUTs for more accuracy
std::vector<std::unique_ptr<ColorPipelineStage>> stages;
stages.push_back(std::make_unique<ColorPipelineStage>(cmsStageDup(stage)));
auto transformation = std::make_unique<ColorTransformation>(std::move(stages));
// the order of operations is fixed, so just sort the LUTs into the appropriate places
// depending on the stages that have already been added
if (!ret.matrix) {
ret.B = std::move(transformation);
} else if (!ret.CLut) {
ret.M = std::move(transformation);
} else if (!ret.A) {
ret.A = std::move(transformation);
} else {
qCWarning(KWIN_CORE, "unexpected amount of curve elements in BToA tag");
return std::nullopt;
}
} break;
case cmsStageSignature::cmsSigMatrixElemType: {
const bool isLutTag = tagType == cmsSigLut8Type || tagType == cmsSigLut16Type;
const uint32_t matrixOffset = isLutTag ? 12 : read<uint32_t>(data, 16);
const uint32_t matrixSize = isLutTag ? 9 : 12;
if (data.size() < matrixOffset + matrixSize * 4) {
qCWarning(KWIN_CORE, "matrix offset points to invalid position %u", matrixOffset);
return std::nullopt;
}
const auto mat = parseMatrix(std::span(data).subspan(matrixOffset), !isLutTag);
if (!mat) {
return std::nullopt;
}
ret.matrix = mat;
}; break;
case cmsStageSignature::cmsSigCLutElemType: {
const auto size = parseBToACLUTSize(data);
if (!size) {
return std::nullopt;
}
const auto [x, y, z] = *size;
std::vector<std::unique_ptr<ColorPipelineStage>> stages;
stages.push_back(std::make_unique<ColorPipelineStage>(cmsStageDup(stage)));
ret.CLut = std::make_unique<ColorLUT3D>(std::make_unique<ColorTransformation>(std::move(stages)), x, y, z);
} break;
default:
qCWarning(KWIN_CORE, "unknown stage type %u", stageType);
return std::nullopt;
}
}
return ret;
}
std::unique_ptr<IccProfile> IccProfile::load(const QString &path)
{
if (path.isEmpty()) {
@ -56,7 +232,7 @@ std::unique_ptr<IccProfile> IccProfile::load(const QString &path)
std::shared_ptr<ColorTransformation> vcgt;
cmsToneCurve **vcgtTag = static_cast<cmsToneCurve **>(cmsReadTag(handle, cmsSigVcgtTag));
if (!vcgtTag || !vcgtTag[0]) {
qCWarning(KWIN_CORE) << "Profile" << path << "has no VCGT tag";
qCDebug(KWIN_CORE) << "Profile" << path << "has no VCGT tag";
} else {
// Need to duplicate the VCGT tone curves as they are owned by the profile.
cmsToneCurve *toneCurves[] = {
@ -69,7 +245,110 @@ std::unique_ptr<IccProfile> IccProfile::load(const QString &path)
vcgt = std::make_shared<ColorTransformation>(std::move(stages));
}
return std::make_unique<IccProfile>(handle, vcgt);
const cmsCIEXYZ *whitepoint = static_cast<cmsCIEXYZ *>(cmsReadTag(handle, cmsSigMediaWhitePointTag));
if (!whitepoint) {
qCWarning(KWIN_CORE, "profile is missing the wtpt tag");
return nullptr;
}
QVector3D red;
QVector3D green;
QVector3D blue;
QVector3D white(whitepoint->X, whitepoint->Y, whitepoint->Z);
std::optional<QMatrix4x4> chromaticAdaptationMatrix;
if (cmsIsTag(handle, cmsSigChromaticAdaptationTag)) {
// the chromatic adaptation tag is a 3x3 matrix that converts from the actual whitepoint to D50
const auto data = readTagRaw(handle, cmsSigChromaticAdaptationTag);
const auto mat = parseMatrix(std::span(data).subspan(8), false);
if (!mat) {
qCWarning(KWIN_CORE, "Parsing chromatic adaptation matrix failed");
return nullptr;
}
bool invertable = false;
chromaticAdaptationMatrix = mat->inverted(&invertable);
if (!invertable) {
qCWarning(KWIN_CORE, "Inverting chromatic adaptation matrix failed");
return nullptr;
}
const QVector3D D50(0.9642, 1.0, 0.8249);
white = *chromaticAdaptationMatrix * D50;
}
if (cmsCIExyYTRIPLE *chrmTag = static_cast<cmsCIExyYTRIPLE *>(cmsReadTag(handle, cmsSigChromaticityTag))) {
red = Colorimetry::xyToXYZ(QVector2D(chrmTag->Red.x, chrmTag->Red.y)) * chrmTag->Red.Y;
green = Colorimetry::xyToXYZ(QVector2D(chrmTag->Green.x, chrmTag->Green.y)) * chrmTag->Green.Y;
blue = Colorimetry::xyToXYZ(QVector2D(chrmTag->Blue.x, chrmTag->Blue.y)) * chrmTag->Blue.Y;
} else {
const cmsCIEXYZ *r = static_cast<cmsCIEXYZ *>(cmsReadTag(handle, cmsSigRedColorantTag));
const cmsCIEXYZ *g = static_cast<cmsCIEXYZ *>(cmsReadTag(handle, cmsSigGreenColorantTag));
const cmsCIEXYZ *b = static_cast<cmsCIEXYZ *>(cmsReadTag(handle, cmsSigBlueColorantTag));
if (!r || !g || !b) {
qCWarning(KWIN_CORE, "rXYZ, gXYZ or bXYZ tag is missing");
return nullptr;
}
if (chromaticAdaptationMatrix) {
red = *chromaticAdaptationMatrix * QVector3D(r->X, r->Y, r->Z);
green = *chromaticAdaptationMatrix * QVector3D(g->X, g->Y, g->Z);
blue = *chromaticAdaptationMatrix * QVector3D(b->X, b->Y, b->Z);
} else {
// if the chromatic adaptation tag isn't available, fall back to using the media whitepoint instead
cmsCIEXYZ adaptedR{};
cmsCIEXYZ adaptedG{};
cmsCIEXYZ adaptedB{};
bool success = cmsAdaptToIlluminant(&adaptedR, cmsD50_XYZ(), whitepoint, r);
success &= cmsAdaptToIlluminant(&adaptedG, cmsD50_XYZ(), whitepoint, g);
success &= cmsAdaptToIlluminant(&adaptedB, cmsD50_XYZ(), whitepoint, b);
if (!success) {
return nullptr;
}
red = QVector3D(adaptedR.X, adaptedR.Y, adaptedR.Z);
green = QVector3D(adaptedG.X, adaptedG.Y, adaptedG.Z);
blue = QVector3D(adaptedB.X, adaptedB.Y, adaptedB.Z);
}
}
BToATagData lutData;
if (cmsIsTag(handle, cmsSigBToD1Tag) && !cmsIsTag(handle, cmsSigBToA1Tag) && !cmsIsTag(handle, cmsSigBToA0Tag)) {
qCWarning(KWIN_CORE, "Profiles with only BToD tags aren't supported yet");
return nullptr;
}
if (cmsIsTag(handle, cmsSigBToA1Tag)) {
// lut based profile, with relative colorimetric intent supported
auto data = parseBToATag(handle, cmsSigBToA1Tag);
if (data) {
return std::make_unique<IccProfile>(handle, Colorimetry::fromXYZ(red, green, blue, white), std::move(*data), vcgt);
} else {
qCWarning(KWIN_CORE, "Parsing BToA1 tag failed");
return nullptr;
}
}
if (cmsIsTag(handle, cmsSigBToA0Tag)) {
// lut based profile, with perceptual intent. The ICC docs say to use this as a fallback
auto data = parseBToATag(handle, cmsSigBToA0Tag);
if (data) {
return std::make_unique<IccProfile>(handle, Colorimetry::fromXYZ(red, green, blue, white), std::move(*data), vcgt);
} else {
qCWarning(KWIN_CORE, "Parsing BToA0 tag failed");
return nullptr;
}
}
// matrix based profile. The matrix is already read out for the colorimetry above
// All that's missing is the EOTF, which is stored in the rTRC, gTRC and bTRC tags
cmsToneCurve *r = static_cast<cmsToneCurve *>(cmsReadTag(handle, cmsSigRedTRCTag));
cmsToneCurve *g = static_cast<cmsToneCurve *>(cmsReadTag(handle, cmsSigGreenTRCTag));
cmsToneCurve *b = static_cast<cmsToneCurve *>(cmsReadTag(handle, cmsSigBlueTRCTag));
if (!r || !g || !b) {
qCWarning(KWIN_CORE) << "ICC profile is missing at least one TRC tag";
return nullptr;
}
cmsToneCurve *toneCurves[] = {
cmsReverseToneCurveEx(4096, r),
cmsReverseToneCurveEx(4096, g),
cmsReverseToneCurveEx(4096, b),
};
std::vector<std::unique_ptr<ColorPipelineStage>> stages;
stages.push_back(std::make_unique<ColorPipelineStage>(cmsStageAllocToneCurves(nullptr, 3, toneCurves)));
const auto inverseEOTF = std::make_shared<ColorTransformation>(std::move(stages));
return std::make_unique<IccProfile>(handle, Colorimetry::fromXYZ(red, green, blue, white), inverseEOTF, vcgt);
}
}

33
src/core/iccprofile.h
View file

@ -6,9 +6,12 @@
#pragma once
#include "kwin_export.h"
#include "libkwineffects/colorspace.h"
#include <QMatrix4x4>
#include <QString>
#include <memory>
#include <optional>
typedef void *cmsHPROFILE;
@ -16,19 +19,47 @@ namespace KWin
{
class ColorTransformation;
class ColorLUT3D;
class KWIN_EXPORT IccProfile
{
public:
explicit IccProfile(cmsHPROFILE handle, const std::shared_ptr<ColorTransformation> &vcgt);
struct BToATagData
{
std::unique_ptr<ColorTransformation> B;
std::optional<QMatrix4x4> matrix;
std::unique_ptr<ColorTransformation> M;
std::unique_ptr<ColorLUT3D> CLut;
std::unique_ptr<ColorTransformation> A;
};
explicit IccProfile(cmsHPROFILE handle, const Colorimetry &colorimetry, BToATagData &&bToATag, const std::shared_ptr<ColorTransformation> &vcgt);
explicit IccProfile(cmsHPROFILE handle, const Colorimetry &colorimetry, const std::shared_ptr<ColorTransformation> &inverseEOTF, const std::shared_ptr<ColorTransformation> &vcgt);
~IccProfile();
/**
* the BToA tag describes a transformation from XYZ with D50 whitepoint
* to the display color space. May be nullptr!
*/
const BToATagData *BtToATag() const;
/**
* Contains the inverse of the TRC tags. May be nullptr!
*/
std::shared_ptr<ColorTransformation> inverseEOTF() const;
/**
* The VCGT is a non-standard tag that needs to be applied before
* pixels are sent to the display. May be nullptr!
*/
std::shared_ptr<ColorTransformation> vcgt() const;
const Colorimetry &colorimetry() const;
static std::unique_ptr<IccProfile> load(const QString &path);
private:
cmsHPROFILE const m_handle;
const Colorimetry m_colorimetry;
const std::optional<BToATagData> m_bToATag;
const std::shared_ptr<ColorTransformation> m_inverseEOTF;
const std::shared_ptr<ColorTransformation> m_vcgt;
};

23
src/libkwineffects/colorspace.cpp
View file

@ -49,11 +49,17 @@ static QVector3D operator*(const QMatrix3x3 &mat, const QVector3D &v)
mat(2, 0) * v.x() + mat(2, 1) * v.y() + mat(2, 2) * v.z());
}
static QVector3D xyToXYZ(QVector2D xy)
QVector3D Colorimetry::xyToXYZ(QVector2D xy)
{
return QVector3D(xy.x() / xy.y(), 1, (1 - xy.x() - xy.y()) / xy.y());
}
QVector2D Colorimetry::xyzToXY(QVector3D xyz)
{
xyz /= xyz.y();
return QVector2D(xyz.x() / (xyz.x() + xyz.y() + xyz.z()), xyz.y() / (xyz.x() + xyz.y() + xyz.z()));
}
QMatrix3x3 Colorimetry::toXYZ() const
{
const auto r_xyz = xyToXYZ(red);
@ -75,7 +81,7 @@ bool Colorimetry::operator==(const Colorimetry &other) const
: (red == other.red && green == other.green && blue == other.blue && white == other.white);
}
constexpr Colorimetry Colorimetry::createFromName(NamedColorimetry name)
constexpr Colorimetry Colorimetry::fromName(NamedColorimetry name)
{
switch (name) {
case NamedColorimetry::BT709:
@ -98,6 +104,17 @@ constexpr Colorimetry Colorimetry::createFromName(NamedColorimetry name)
Q_UNREACHABLE();
}
Colorimetry Colorimetry::fromXYZ(QVector3D red, QVector3D green, QVector3D blue, QVector3D white)
{
return Colorimetry{
.red = xyzToXY(red),
.green = xyzToXY(green),
.blue = xyzToXY(blue),
.white = xyzToXY(white),
.name = std::nullopt,
};
}
const ColorDescription ColorDescription::sRGB = ColorDescription(NamedColorimetry::BT709, NamedTransferFunction::sRGB, 100, 0, 100, 100);
ColorDescription::ColorDescription(const Colorimetry &colorimety, NamedTransferFunction tf, double sdrBrightness, double minHdrBrightness, double maxFrameAverageBrightness, double maxHdrHighlightBrightness)
@ -111,7 +128,7 @@ ColorDescription::ColorDescription(const Colorimetry &colorimety, NamedTransferF
}
ColorDescription::ColorDescription(NamedColorimetry colorimetry, NamedTransferFunction tf, double sdrBrightness, double minHdrBrightness, double maxFrameAverageBrightness, double maxHdrHighlightBrightness)
: m_colorimetry(Colorimetry::createFromName(colorimetry))
: m_colorimetry(Colorimetry::fromName(colorimetry))
, m_transferFunction(tf)
, m_sdrBrightness(sdrBrightness)
, m_minHdrBrightness(minHdrBrightness)

5
src/libkwineffects/colorspace.h
View file

@ -27,7 +27,10 @@ enum class NamedColorimetry {
class KWIN_EXPORT Colorimetry
{
public:
static constexpr Colorimetry createFromName(NamedColorimetry name);
static constexpr Colorimetry fromName(NamedColorimetry name);
static Colorimetry fromXYZ(QVector3D red, QVector3D green, QVector3D blue, QVector3D white);
static QVector3D xyToXYZ(QVector2D xy);
static QVector2D xyzToXY(QVector3D xyz);
QMatrix3x3 toXYZ() const;
QMatrix3x3 toOther(const Colorimetry &colorimetry) const;