File indexing completed on 2024-05-19 05:31:55

 /*
     KWin - the KDE window manager
     This file is part of the KDE project.
 
     SPDX-FileCopyrightText: 2006-2007 Rivo Laks <rivolaks@hot.ee>
     SPDX-FileCopyrightText: 2010, 2011 Martin Gräßlin <mgraesslin@kde.org>
     SPDX-FileCopyrightText: 2023 Xaver Hugl <xaver.hugl@kde.org>
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 #include "glshader.h"
 #include "glplatform.h"
 #include "glutils.h"
 #include "utils/common.h"
 
 #include <QFile>
 
 namespace KWin
 {
 
 GLShader::GLShader(unsigned int flags)
     : m_valid(false)
     , m_locationsResolved(false)
     , m_explicitLinking(flags & ExplicitLinking)
 {
     m_program = glCreateProgram();
 }
 
 GLShader::GLShader(const QString &vertexfile, const QString &fragmentfile, unsigned int flags)
     : m_valid(false)
     , m_locationsResolved(false)
     , m_explicitLinking(flags & ExplicitLinking)
 {
     m_program = glCreateProgram();
     loadFromFiles(vertexfile, fragmentfile);
 }
 
 GLShader::~GLShader()
 {
     if (m_program) {
         glDeleteProgram(m_program);
     }
 }
 
 bool GLShader::loadFromFiles(const QString &vertexFile, const QString &fragmentFile)
 {
     QFile vf(vertexFile);
     if (!vf.open(QIODevice::ReadOnly)) {
         qCCritical(KWIN_OPENGL) << "Couldn't open" << vertexFile << "for reading!";
         return false;
     }
     const QByteArray vertexSource = vf.readAll();
 
     QFile ff(fragmentFile);
     if (!ff.open(QIODevice::ReadOnly)) {
         qCCritical(KWIN_OPENGL) << "Couldn't open" << fragmentFile << "for reading!";
         return false;
     }
     const QByteArray fragmentSource = ff.readAll();
 
     return load(vertexSource, fragmentSource);
 }
 
 bool GLShader::link()
 {
     // Be optimistic
     m_valid = true;
 
     glLinkProgram(m_program);
 
     // Get the program info log
     int maxLength, length;
     glGetProgramiv(m_program, GL_INFO_LOG_LENGTH, &maxLength);
 
     QByteArray log(maxLength, 0);
     glGetProgramInfoLog(m_program, maxLength, &length, log.data());
 
     // Make sure the program linked successfully
     int status;
     glGetProgramiv(m_program, GL_LINK_STATUS, &status);
 
     if (status == 0) {
         qCCritical(KWIN_OPENGL) << "Failed to link shader:"
                                 << "\n"
                                 << log;
         m_valid = false;
     } else if (length > 0) {
         qCDebug(KWIN_OPENGL) << "Shader link log:" << log;
     }
 
     return m_valid;
 }
 
 const QByteArray GLShader::prepareSource(GLenum shaderType, const QByteArray &source) const
 {
     // Prepare the source code
     QByteArray ba;
     if (GLPlatform::instance()->isGLES() && GLPlatform::instance()->glslVersion() < Version(3, 0)) {
         ba.append("precision highp float;\n");
     }
     ba.append(source);
     if (GLPlatform::instance()->isGLES() && GLPlatform::instance()->glslVersion() >= Version(3, 0)) {
         ba.replace("#version 140", "#version 300 es\n\nprecision highp float;\n");
     }
 
     return ba;
 }
 
 bool GLShader::compile(GLuint program, GLenum shaderType, const QByteArray &source) const
 {
     GLuint shader = glCreateShader(shaderType);
 
     QByteArray preparedSource = prepareSource(shaderType, source);
     const char *src = preparedSource.constData();
     glShaderSource(shader, 1, &src, nullptr);
 
     // Compile the shader
     glCompileShader(shader);
 
     // Get the shader info log
     int maxLength, length;
     glGetShaderiv(shader, GL_INFO_LOG_LENGTH, &maxLength);
 
     QByteArray log(maxLength, 0);
     glGetShaderInfoLog(shader, maxLength, &length, log.data());
 
     // Check the status
     int status;
     glGetShaderiv(shader, GL_COMPILE_STATUS, &status);
 
     if (status == 0) {
         const char *typeName = (shaderType == GL_VERTEX_SHADER ? "vertex" : "fragment");
         qCCritical(KWIN_OPENGL) << "Failed to compile" << typeName << "shader:"
                                 << "\n"
                                 << log;
         size_t line = 0;
         const auto split = source.split('\n');
         for (const auto &l : split) {
             qCCritical(KWIN_OPENGL).nospace() << "line " << line++ << ":" << l;
         }
     } else if (length > 0) {
         qCDebug(KWIN_OPENGL) << "Shader compile log:" << log;
     }
 
     if (status != 0) {
         glAttachShader(program, shader);
     }
 
     glDeleteShader(shader);
     return status != 0;
 }
 
 bool GLShader::load(const QByteArray &vertexSource, const QByteArray &fragmentSource)
 {
     m_valid = false;
 
     // Compile the vertex shader
     if (!vertexSource.isEmpty()) {
         bool success = compile(m_program, GL_VERTEX_SHADER, vertexSource);
 
         if (!success) {
             return false;
         }
     }
 
     // Compile the fragment shader
     if (!fragmentSource.isEmpty()) {
         bool success = compile(m_program, GL_FRAGMENT_SHADER, fragmentSource);
 
         if (!success) {
             return false;
         }
     }
 
     if (m_explicitLinking) {
         return true;
     }
 
     // link() sets mValid
     return link();
 }
 
 void GLShader::bindAttributeLocation(const char *name, int index)
 {
     glBindAttribLocation(m_program, index, name);
 }
 
 void GLShader::bindFragDataLocation(const char *name, int index)
 {
     if (!GLPlatform::instance()->isGLES() && (hasGLVersion(3, 0) || hasGLExtension(QByteArrayLiteral("GL_EXT_gpu_shader4")))) {
         glBindFragDataLocation(m_program, index, name);
     }
 }
 
 void GLShader::bind()
 {
     glUseProgram(m_program);
 }
 
 void GLShader::unbind()
 {
     glUseProgram(0);
 }
 
 void GLShader::resolveLocations()
 {
     if (m_locationsResolved) {
         return;
     }
 
     m_matrix4Locations[Mat4Uniform::TextureMatrix] = uniformLocation("textureMatrix");
     m_matrix4Locations[Mat4Uniform::ProjectionMatrix] = uniformLocation("projection");
     m_matrix4Locations[Mat4Uniform::ModelViewMatrix] = uniformLocation("modelview");
     m_matrix4Locations[Mat4Uniform::ModelViewProjectionMatrix] = uniformLocation("modelViewProjectionMatrix");
     m_matrix4Locations[Mat4Uniform::WindowTransformation] = uniformLocation("windowTransformation");
     m_matrix4Locations[Mat4Uniform::ScreenTransformation] = uniformLocation("screenTransformation");
     m_matrix4Locations[Mat4Uniform::ColorimetryTransformation] = uniformLocation("colorimetryTransform");
 
     m_vec2Locations[Vec2Uniform::Offset] = uniformLocation("offset");
 
     m_vec3Locations[Vec3Uniform::PrimaryBrightness] = uniformLocation("primaryBrightness");
 
     m_vec4Locations[Vec4Uniform::ModulationConstant] = uniformLocation("modulation");
 
     m_floatLocations[FloatUniform::Saturation] = uniformLocation("saturation");
     m_floatLocations[FloatUniform::MaxHdrBrightness] = uniformLocation("maxHdrBrightness");
     m_floatLocations[FloatUniform::SdrBrightness] = uniformLocation("sdrBrightness");
 
     m_colorLocations[ColorUniform::Color] = uniformLocation("geometryColor");
 
     m_intLocations[IntUniform::TextureWidth] = uniformLocation("textureWidth");
     m_intLocations[IntUniform::TextureHeight] = uniformLocation("textureHeight");
     m_intLocations[IntUniform::Sampler] = uniformLocation("sampler");
     m_intLocations[IntUniform::Sampler1] = uniformLocation("sampler1");
     m_intLocations[IntUniform::SourceNamedTransferFunction] = uniformLocation("sourceNamedTransferFunction");
     m_intLocations[IntUniform::DestinationNamedTransferFunction] = uniformLocation("destinationNamedTransferFunction");
 
     m_locationsResolved = true;
 }
 
 int GLShader::uniformLocation(const char *name)
 {
     const int location = glGetUniformLocation(m_program, name);
     return location;
 }
 
 bool GLShader::setUniform(Mat3Uniform uniform, const QMatrix3x3 &value)
 {
     resolveLocations();
     return setUniform(m_matrix3Locations[uniform], value);
 }
 
 bool GLShader::setUniform(Mat4Uniform uniform, const QMatrix4x4 &matrix)
 {
     resolveLocations();
     return setUniform(m_matrix4Locations[uniform], matrix);
 }
 
 bool GLShader::setUniform(Vec2Uniform uniform, const QVector2D &value)
 {
     resolveLocations();
     return setUniform(m_vec2Locations[uniform], value);
 }
 
 bool GLShader::setUniform(Vec3Uniform uniform, const QVector3D &value)
 {
     resolveLocations();
     return setUniform(m_vec3Locations[uniform], value);
 }
 
 bool GLShader::setUniform(Vec4Uniform uniform, const QVector4D &value)
 {
     resolveLocations();
     return setUniform(m_vec4Locations[uniform], value);
 }
 
 bool GLShader::setUniform(FloatUniform uniform, float value)
 {
     resolveLocations();
     return setUniform(m_floatLocations[uniform], value);
 }
 
 bool GLShader::setUniform(IntUniform uniform, int value)
 {
     resolveLocations();
     return setUniform(m_intLocations[uniform], value);
 }
 
 bool GLShader::setUniform(ColorUniform uniform, const QVector4D &value)
 {
     resolveLocations();
     return setUniform(m_colorLocations[uniform], value);
 }
 
 bool GLShader::setUniform(ColorUniform uniform, const QColor &value)
 {
     resolveLocations();
     return setUniform(m_colorLocations[uniform], value);
 }
 
 bool GLShader::setUniform(const char *name, float value)
 {
     const int location = uniformLocation(name);
     return setUniform(location, value);
 }
 
 bool GLShader::setUniform(const char *name, int value)
 {
     const int location = uniformLocation(name);
     return setUniform(location, value);
 }
 
 bool GLShader::setUniform(const char *name, const QVector2D &value)
 {
     const int location = uniformLocation(name);
     return setUniform(location, value);
 }
 
 bool GLShader::setUniform(const char *name, const QVector3D &value)
 {
     const int location = uniformLocation(name);
     return setUniform(location, value);
 }
 
 bool GLShader::setUniform(const char *name, const QVector4D &value)
 {
     const int location = uniformLocation(name);
     return setUniform(location, value);
 }
 
 bool GLShader::setUniform(const char *name, const QMatrix4x4 &value)
 {
     const int location = uniformLocation(name);
     return setUniform(location, value);
 }
 
 bool GLShader::setUniform(const char *name, const QColor &color)
 {
     const int location = uniformLocation(name);
     return setUniform(location, color);
 }
 
 bool GLShader::setUniform(int location, float value)
 {
     if (location >= 0) {
         glUniform1f(location, value);
     }
     return (location >= 0);
 }
 
 bool GLShader::setUniform(int location, int value)
 {
     if (location >= 0) {
         glUniform1i(location, value);
     }
     return (location >= 0);
 }
 
 bool GLShader::setUniform(int location, int xValue, int yValue, int zValue)
 {
     if (location >= 0) {
         glUniform3i(location, xValue, yValue, zValue);
     }
     return location >= 0;
 }
 
 bool GLShader::setUniform(int location, const QVector2D &value)
 {
     if (location >= 0) {
         glUniform2fv(location, 1, (const GLfloat *)&value);
     }
     return (location >= 0);
 }
 
 bool GLShader::setUniform(int location, const QVector3D &value)
 {
     if (location >= 0) {
         glUniform3fv(location, 1, (const GLfloat *)&value);
     }
     return (location >= 0);
 }
 
 bool GLShader::setUniform(int location, const QVector4D &value)
 {
     if (location >= 0) {
         glUniform4fv(location, 1, (const GLfloat *)&value);
     }
     return (location >= 0);
 }
 
 bool GLShader::setUniform(int location, const QMatrix3x3 &value)
 {
     if (location >= 0) {
         glUniformMatrix3fv(location, 1, GL_FALSE, value.constData());
     }
     return location >= 0;
 }
 
 bool GLShader::setUniform(int location, const QMatrix4x4 &value)
 {
     if (location >= 0) {
         glUniformMatrix4fv(location, 1, GL_FALSE, value.constData());
     }
     return (location >= 0);
 }
 
 bool GLShader::setUniform(int location, const QColor &color)
 {
     if (location >= 0) {
         glUniform4f(location, color.redF(), color.greenF(), color.blueF(), color.alphaF());
     }
     return (location >= 0);
 }
 
 int GLShader::attributeLocation(const char *name)
 {
     int location = glGetAttribLocation(m_program, name);
     return location;
 }
 
 bool GLShader::setAttribute(const char *name, float value)
 {
     int location = attributeLocation(name);
     if (location >= 0) {
         glVertexAttrib1f(location, value);
     }
     return (location >= 0);
 }
 
 QMatrix4x4 GLShader::getUniformMatrix4x4(const char *name)
 {
     int location = uniformLocation(name);
     if (location >= 0) {
         GLfloat m[16];
         glGetnUniformfv(m_program, location, sizeof(m), m);
         QMatrix4x4 matrix(m[0], m[4], m[8], m[12],
                           m[1], m[5], m[9], m[13],
                           m[2], m[6], m[10], m[14],
                           m[3], m[7], m[11], m[15]);
         matrix.optimize();
         return matrix;
     } else {
         return QMatrix4x4();
     }
 }
 
 bool GLShader::setColorspaceUniforms(const ColorDescription &src, const ColorDescription &dst)
 {
     const auto &srcColorimetry = src.colorimetry() == NamedColorimetry::BT709 ? dst.sdrColorimetry() : src.colorimetry();
     return setUniform(GLShader::Mat4Uniform::ColorimetryTransformation, srcColorimetry.toOther(dst.colorimetry()))
         && setUniform(GLShader::IntUniform::SourceNamedTransferFunction, int(src.transferFunction()))
         && setUniform(GLShader::IntUniform::DestinationNamedTransferFunction, int(dst.transferFunction()))
         && setUniform(FloatUniform::SdrBrightness, dst.sdrBrightness())
         && setUniform(FloatUniform::MaxHdrBrightness, dst.maxHdrHighlightBrightness());
 }
 
 bool GLShader::setColorspaceUniformsFromSRGB(const ColorDescription &dst)
 {
     return setColorspaceUniforms(ColorDescription::sRGB, dst);
 }
 
 bool GLShader::setColorspaceUniformsToSRGB(const ColorDescription &src)
 {
     return setUniform(GLShader::Mat4Uniform::ColorimetryTransformation, src.colorimetry().toOther(src.sdrColorimetry()))
         && setUniform(GLShader::IntUniform::SourceNamedTransferFunction, int(src.transferFunction()))
         && setUniform(GLShader::IntUniform::DestinationNamedTransferFunction, int(NamedTransferFunction::gamma22))
         && setUniform(FloatUniform::SdrBrightness, src.sdrBrightness())
         && setUniform(FloatUniform::MaxHdrBrightness, src.sdrBrightness());
 }
 }