diff --git a/src/3rdparty/wayland/protocols/color-management/REUSE.toml b/src/3rdparty/wayland/protocols/color-management/REUSE.toml new file mode 100644 index 00000000000..c7b978663b1 --- /dev/null +++ b/src/3rdparty/wayland/protocols/color-management/REUSE.toml @@ -0,0 +1,11 @@ +version = 1 + +[[annotations]] +path = "xx-color-management-v4.xml" +precedence = "closest" +SPDX-FileCopyrightText = ["Copyright 2019 Sebastian Wick", + "Copyright 2019 Erwin Burema", + "Copyright 2020 AMD", + "Copyright 2020-2024 Collabora, Ltd.", + "Copyright 2024 Xaver Hugl"] +SPDX-License-Identifier = "MIT" diff --git a/src/3rdparty/wayland/protocols/color-management/qt_attribution.json b/src/3rdparty/wayland/protocols/color-management/qt_attribution.json new file mode 100644 index 00000000000..246e9df70fa --- /dev/null +++ b/src/3rdparty/wayland/protocols/color-management/qt_attribution.json @@ -0,0 +1,18 @@ +[ + { + "Id": "wayland-color-management-protocol", + "Name": "Wayland Color Management Protocol", + "QDocModule": "qtwaylandcompositor", + "QtUsage": "Used in the Qt Wayland platform plugin.", + "Files": "xx-color-management-v4.xml", + + "Description": "An extension to use different colorspaces from sRGB", + "Homepage": "https://wayland.freedesktop.org", + "Version": "experimental v4", + "DownloadLocation": "https://gitlab.freedesktop.org/swick/wayland-protocols/-/blob/708a8b4119d4072820158a115166598733d378f4/staging/color-management/xx-color-management-v4.xml", + "LicenseId": "MIT", + "License": "MIT License", + "LicenseFile": "../MIT_LICENSE.txt", + "Copyright": "Copyright 2019 Sebastian Wick\nCopyright 2019 Erwin Burema\nCopyright 2020 AMD\nCopyright 2020-2024 Collabora, Ltd.\nCopyright 2024 Xaver Hugl" + } +] diff --git a/src/3rdparty/wayland/protocols/color-management/xx-color-management-v4.xml b/src/3rdparty/wayland/protocols/color-management/xx-color-management-v4.xml new file mode 100644 index 00000000000..eab84dfd992 --- /dev/null +++ b/src/3rdparty/wayland/protocols/color-management/xx-color-management-v4.xml @@ -0,0 +1,1453 @@ + + + + Copyright 2019 Sebastian Wick + Copyright 2019 Erwin Burema + Copyright 2020 AMD + Copyright 2020-2024 Collabora, Ltd. + Copyright 2024 Xaver Hugl + + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and associated documentation files (the "Software"), + to deal in the Software without restriction, including without limitation + the rights to use, copy, modify, merge, publish, distribute, sublicense, + and/or sell copies of the Software, and to permit persons to whom the + Software is furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice (including the next + paragraph) shall be included in all copies or substantial portions of the + Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL + THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + DEALINGS IN THE SOFTWARE. + + + + The aim of the color management extension is to allow clients to know + the color properties of outputs, and to tell the compositor about the color + properties of their content on surfaces. Doing this enables a compositor + to perform automatic color management of content for different outputs + according to how content is intended to look like. + + The color properties are represented as an image description object which + is immutable after it has been created. A wl_output always has an + associated image description that clients can observe. A wl_surface + always has an associated preferred image description as a hint chosen by + the compositor that clients can also observe. Clients can set an image + description on a wl_surface to denote the color characteristics of the + surface contents. + + An image description includes SDR and HDR colorimetry and encoding, HDR + metadata, and viewing environment parameters. An image description does + not include the properties set through color-representation extension. + It is expected that the color-representation extension is used in + conjunction with the color management extension when necessary, + particularly with the YUV family of pixel formats. + + Recommendation ITU-T H.273 + "Coding-independent code points for video signal type identification" + shall be referred to as simply H.273 here. + + The color-and-hdr repository + (https://gitlab.freedesktop.org/pq/color-and-hdr) contains + background information on the protocol design and legacy color management. + It also contains a glossary, learning resources for digital color, tools, + samples and more. + + The terminology used in this protocol is based on common color science and + color encoding terminology where possible. The glossary in the color-and-hdr + repository shall be the authority on the definition of terms in this + protocol. + + + + + A global interface used for getting color management extensions for + wl_surface and wl_output objects, and for creating client defined image + description objects. The extension interfaces allow + getting the image description of outputs and setting the image + description of surfaces. + + + + + Destroy the xx_color_manager_v4 object. This does not affect any other + objects in any way. + + + + + + + + + + + See the ICC.1:2022 specification from the International Color Consortium + for more details about rendering intents. + + The principles of ICC defined rendering intents apply with all types of + image descriptions, not only those with ICC file profiles. + + Compositors must support the perceptual rendering intent. Other + rendering intents are optional. + + + + + + + + + + + + + + + + + + + + The compositor supports set_mastering_display_primaries request with a + target color volume fully contained inside the primary color volume. + + + + + The compositor additionally supports target color volumes that + extend outside of the primary color volume. + + This can only be advertised if feature set_mastering_display_primaries + is supported as well. + + + + + + + Named color primaries used to encode well-known sets of primaries. H.273 + is the authority, when it comes to the exact values of primaries and + authoritative specifications, where an equivalent code point exists. + + Descriptions do list the specifications for convenience. + + + + + Color primaries as defined by + - Rec. ITU-R BT.709-6 + - Rec. ITU-R BT.1361-0 conventional colour gamut system and extended + colour gamut system (historical) + - IEC 61966-2-1 sRGB or sYCC + - IEC 61966-2-4 + - Society of Motion Picture and Television Engineers (SMPTE) RP 177 + (1993) Annex B + Equivalent to H.273 ColourPrimaries code point 1. + + + + + Color primaries as defined by + - Rec. ITU-R BT.470-6 System M (historical) + - United States National Television System Committee 1953 + Recommendation for transmission standards for color television + - United States Federal Communications Commission (2003) Title 47 Code + of Federal Regulations 73.682 (a)(20) + Equivalent to H.273 ColourPrimaries code point 4. + + + + + Color primaries as defined by + - Rec. ITU-R BT.470-6 System B, G (historical) + - Rec. ITU-R BT.601-7 625 + - Rec. ITU-R BT.1358-0 625 (historical) + - Rec. ITU-R BT.1700-0 625 PAL and 625 SECAM + Equivalent to H.273 ColourPrimaries code point 5. + + + + + Color primaries as defined by + - Rec. ITU-R BT.601-7 525 + - Rec. ITU-R BT.1358-1 525 or 625 (historical) + - Rec. ITU-R BT.1700-0 NTSC + - SMPTE 170M (2004) + - SMPTE 240M (1999) (historical) + Equivalent to H.273 ColourPrimaries code point 6 and 7. + + + + + Color primaries as defined by H.273 for generic film. + Equivalent to H.273 ColourPrimaries code point 8. + + + + + Color primaries as defined by + - Rec. ITU-R BT.2020-2 + - Rec. ITU-R BT.2100-0 + Equivalent to H.273 ColourPrimaries code point 9. + + + + + Color primaries as defined as the maximum of the CIE 1931 XYZ color + space by + - SMPTE ST 428-1 + - (CIE 1931 XYZ as in ISO 11664-1) + Equivalent to H.273 ColourPrimaries code point 10. + + + + + Color primaries as defined by Digital Cinema System and published in + SMPTE RP 431-2 (2011). Equivalent to H.273 ColourPrimaries code point + 11. + + + + + Color primaries as defined by Digital Cinema System and published in + SMPTE EG 432-1 (2010). + Equivalent to H.273 ColourPrimaries code point 12. + + + + + Color primaries as defined by Adobe as "Adobe RGB" and later published + by ISO 12640-4 (2011). + + + + + + + Named transfer functions used to encode well-known transfer + characteristics. H.273 is the authority, when it comes to the exact + formulas and authoritative specifications, where an equivalent code + point exists. + + Descriptions do list the specifications for convenience. + + + + + Transfer characteristics as defined by + - Rec. ITU-R BT.709-6 + - Rec. ITU-R BT.1361-0 conventional colour gamut system (historical) + Equivalent to H.273 TransferCharacteristics code point 1, 6, 14, 15. + + + + + Transfer characteristics as defined by + - Rec. ITU-R BT.470-6 System M (historical) + - United States National Television System Committee 1953 + Recommendation for transmission standards for color television + - United States Federal Communications Commission (2003) Title 47 Code + of Federal Regulations 73.682 (a) (20) + - Rec. ITU-R BT.1700-0 625 PAL and 625 SECAM + Equivalent to H.273 TransferCharacteristics code point 4. + + + + + Transfer characteristics as defined by + - Rec. ITU-R BT.470-6 System B, G (historical) + Equivalent to H.273 TransferCharacteristics code point 5. + + + + + Transfer characteristics as defined by + - SMPTE ST 240 (1999) + Equivalent to H.273 TransferCharacteristics code point 7. + + + + + Linear transfer characteristics. + Equivalent to H.273 TransferCharacteristics code point 8. + + + + + Logarithmic transfer characteristic (100:1 range). + Equivalent to H.273 TransferCharacteristics code point 9. + + + + + Logarithmic transfer characteristic (100 * Sqrt(10) : 1 range). + Equivalent to H.273 TransferCharacteristics code point 10. + + + + + Transfer characteristics as defined by + - IEC 61966-2-4 + Equivalent to H.273 TransferCharacteristics code point 11. + + + + + Transfer characteristics as defined by + - Rec. ITU-R BT.1361-0 extended colour gamut system (historical) + Equivalent to H.273 TransferCharacteristics code point 12. + + + + + Transfer characteristics as defined by + - IEC 61966-2-1 sRGB + Equivalent to H.273 TransferCharacteristics code point 13 with + MatrixCoefficients set to 0. + + + + + Transfer characteristics as defined by + - IEC 61966-2-1 sYCC + Equivalent to H.273 TransferCharacteristics code point 13 with + MatrixCoefficients set to anything but 0. + + + + + Transfer characteristics as defined by + - SMPTE ST 2084 (2014) for 10-, 12-, 14- and 16-bit systems + - Rec. ITU-R BT.2100-2 perceptual quantization (PQ) system + Equivalent to H.273 TransferCharacteristics code point 16. + + This TF implies these default luminances + - primary color volume minimum: 0.005 cd/m² + - primary color volume maximum: 10000 cd/m² + - reference white: 203 cd/m² + + + + + Transfer characteristics as defined by + - SMPTE ST 428-1 (2019) + Equivalent to H.273 TransferCharacteristics code point 17. + + + + + Transfer characteristics as defined by + - ARIB STD-B67 (2015) + - Rec. ITU-R BT.2100-2 hybrid log-gamma (HLG) system + Equivalent to H.273 TransferCharacteristics code point 18. + + This TF implies these default luminances + - primary color volume minimum: 0.005 cd/m² + - primary color volume maximum: 1000 cd/m² + - reference white: 203 cd/m² + Note: HLG is a scene referred signal. All absolute luminance values + used here for HLG assume a 1000 cd/m² display. + + + + + + + This creates a new xx_color_management_output_v4 object for the + given wl_output. + + See the xx_color_management_output_v4 interface for more details. + + + + + + + + + If a xx_color_management_surface_v4 object already exists for the given + wl_surface, the protocol error surface_exists is raised. + + This creates a new color xx_color_management_surface_v4 object for the + given wl_surface. + + See the xx_color_management_surface_v4 interface for more details. + + + + + + + + + This creates a new color xx_color_management_feedback_surface_v4 object + for the given wl_surface. + + See the xx_color_management_feedback_surface_v4 interface for more + details. + + + + + + + + + Makes a new ICC-based image description creator object with all + properties initially unset. The client can then use the object's + interface to define all the required properties for an image description + and finally create a xx_image_description_v4 object. + + This request can be used when the compositor advertises + xx_color_manager_v4.feature.icc_v2_v4. + Otherwise this request raises the protocol error unsupported_feature. + + + + + + + + Makes a new parametric image description creator object with all + properties initially unset. The client can then use the object's + interface to define all the required properties for an image description + and finally create a xx_image_description_v4 object. + + This request can be used when the compositor advertises + xx_color_manager_v4.feature.parametric. + Otherwise this request raises the protocol error unsupported_feature. + + + + + + + + When this object is created, it shall immediately send this event once + for each rendering intent the compositor supports. + + + + + + + + When this object is created, it shall immediately send this event once + for each compositor supported feature listed in the enumeration. + + + + + + + + When this object is created, it shall immediately send this event once + for each named transfer function the compositor supports with the + parametric image description creator. + + + + + + + + When this object is created, it shall immediately send this event once + for each named set of primaries the compositor supports with the + parametric image description creator. + + + + + + + + + A xx_color_management_output_v4 describes the color properties of an + output. + + The xx_color_management_output_v4 is associated with the wl_output global + underlying the wl_output object. Therefore the client destroying the + wl_output object has no impact, but the compositor removing the output + global makes the xx_color_management_output_v4 object inert. + + + + + Destroy the color xx_color_management_output_v4 object. This does not + affect any remaining protocol objects. + + + + + + This event is sent whenever the image description of the output changed, + followed by one wl_output.done event common to output events across all + extensions. + + If the client wants to use the updated image description, it needs to do + get_image_description again, because image description objects are + immutable. + + + + + + This creates a new xx_image_description_v4 object for the current image + description of the output. There always is exactly one image description + active for an output so the client should destroy the image description + created by earlier invocations of this request. This request is usually + sent as a reaction to the image_description_changed event or when + creating a xx_color_management_output_v4 object. + + The image description of an output represents the color encoding the + output expects. There might be performance and power advantages, as well + as improved color reproduction, if a content update matches the image + description of the output it is being shown on. If a content update is + shown on any other output than the one it matches the image description + of, then the color reproduction on those outputs might be considerably + worse. + + The created xx_image_description_v4 object preserves the image + description of the output from the time the object was created. + + The resulting image description object allows get_information request. + + If this protocol object is inert, the resulting image description object + shall immediately deliver the xx_image_description_v4.failed event with + the no_output cause. + + If the interface version is inadequate for the output's image + description, meaning that the client does not support all the events + needed to deliver the crucial information, the resulting image + description object shall immediately deliver the + xx_image_description_v4.failed event with the low_version cause. + + Otherwise the object shall immediately deliver the ready event. + + + + + + + + + A xx_color_management_surface_v4 allows the client to set the color + space and HDR properties of a surface. + + If the wl_surface associated with the xx_color_management_surface_v4 is + destroyed, the xx_color_management_surface_v4 object becomes inert. + + + + + Destroy the xx_color_management_surface_v4 object and do the same as + unset_image_description. + + + + + + + + + + + + Set the image description of the underlying surface. The image + description and rendering intent are double-buffered state, see + wl_surface.commit. + + It is the client's responsibility to understand the image description + it sets on a surface, and to provide content that matches that image + description. Compositors might convert images to match their own or any + other image descriptions. + + Image description whose creation gracefully failed (received + xx_image_description_v4.failed) are forbidden in this request, and in + such case the protocol error image_description is raised. + + All image descriptions whose creation succeeded (received + xx_image_description_v4.ready) are allowed and must always be accepted + by the compositor. + + A rendering intent provides the client's preference on how content + colors should be mapped to each output. The render_intent value must + be one advertised by the compositor with + xx_color_manager_v4.render_intent event, otherwise the protocol error + render_intent is raised. + + By default, a surface does not have an associated image description + nor a rendering intent. The handling of color on such surfaces is + compositor implementation defined. Compositors should handle such + surfaces as sRGB but may handle them differently if they have specific + requirements. + + + + + + + + + This request removes any image description from the surface. See + set_image_description for how a compositor handles a surface without + an image description. This is double-buffered state, see + wl_surface.commit. + + + + + + + A xx_color_management_feedback_surface_v4 allows the client to get the + preferred color description of a surface. + + If the wl_surface associated with this object is destroyed, the + xx_color_management_feedback_surface_v4 object becomes inert. + + + + + Destroy the xx_color_management_feedback_surface_v4 object. + + + + + + + + + + + The preferred image description is the one which likely has the most + performance and/or quality benefits for the compositor if used by the + client for its wl_surface contents. This event is sent whenever the + compositor changes the wl_surface's preferred image description. + + This event is merely a notification. When the client wants to know + what the preferred image description is, it shall use the get_preferred + request. + + The preferred image description is not automatically used for anything. + It is only a hint, and clients may set any valid image description with + set_image_description but there might be performance and color accuracy + improvements by providing the wl_surface contents in the preferred + image description. Therefore clients that can, should render according + to the preferred image description + + + + + + If this protocol object is inert, the protocol error inert is raised. + + The preferred image description represents the compositor's preferred + color encoding for this wl_surface at the current time. There might be + performance and power advantages, as well as improved color + reproduction, if the image description of a content update matches the + preferred image description. + + This creates a new xx_image_description_v4 object for the currently + preferred image description for the wl_surface. The client should + stop using and destroy the image descriptions created by earlier + invocations of this request for the associated wl_surface. + This request is usually sent as a reaction to the preferred_changed + event or when creating a xx_color_management_feedback_surface_v4 object + if the client is capable of adapting to image descriptions. + + The created xx_image_description_v4 object preserves the preferred image + description of the wl_surface from the time the object was created. + + The resulting image description object allows get_information request. + + If the interface version is inadequate for the preferred image + description, meaning that the client does not support all the + events needed to deliver the crucial information, the resulting image + description object shall immediately deliver the + xx_image_description_v4.failed event with the low_version cause, + otherwise the object shall immediately deliver the ready event. + + + + + + + + + This type of object is used for collecting all the information required + to create a xx_image_description_v4 object from an ICC file. A complete + set of required parameters consists of these properties: + - ICC file + + Each required property must be set exactly once if the client is to create + an image description. The set requests verify that a property was not + already set. The create request verifies that all required properties are + set. There may be several alternative requests for setting each property, + and in that case the client must choose one of them. + + Once all properties have been set, the create request must be used to + create the image description object, destroying the creator in the + process. + + + + + + + + + + + + + + + Create an image description object based on the ICC information + previously set on this object. A compositor must parse the ICC data in + some undefined but finite amount of time. + + The completeness of the parameter set is verified. If the set is not + complete, the protocol error incomplete_set is raised. For the + definition of a complete set, see the description of this interface. + + If the particular combination of the information is not supported + by the compositor, the resulting image description object shall + immediately deliver the xx_image_description_v4.failed event with the + 'unsupported' cause. If a valid image description was created from the + information, the xx_image_description_v4.ready event will eventually + be sent instead. + + This request destroys the xx_image_description_creator_icc_v4 object. + + The resulting image description object does not allow get_information + request. + + + + + + + + Sets the ICC profile file to be used as the basis of the image + description. + + The data shall be found through the given fd at the given offset, having + the given length. The fd must seekable and readable. Violating these + requirements raises the bad_fd protocol error. + + If reading the data fails due to an error independent of the client, the + compositor shall send the xx_image_description_v4.failed event on the + created xx_image_description_v4 with the 'operating_system' cause. + + The maximum size of the ICC profile is 4 MB. If length is greater than + that or zero, the protocol error bad_size is raised. If offset + length + exceeds the file size, the protocol error out_of_file is raised. + + A compositor may read the file at any time starting from this request + and only until whichever happens first: + - If create request was issued, the xx_image_description_v4 object + delivers either failed or ready event; or + - if create request was not issued, this + xx_image_description_creator_icc_v4 object is destroyed. + + A compositor shall not modify the contents of the file, and the fd may + be sealed for writes and size changes. The client must ensure to its + best ability that the data does not change while the compositor is + reading it. + + The data must represent a valid ICC profile. The ICC profile version + must be 2 or 4, it must be a 3 channel profile and the class must be + Display or ColorSpace. Violating these requirements will not result in a + protocol error but will eventually send the + xx_image_description_v4.failed event on the created + xx_image_description_v4 with the 'unsupported' cause. + + See the International Color Consortium specification ICC.1:2022 for more + details about ICC profiles. + + If ICC file has already been set on this object, the protocol error + already_set is raised. + + + + + + + + + + + This type of object is used for collecting all the parameters required + to create a xx_image_description_v4 object. A complete set of required + parameters consists of these properties: + - transfer characteristic function (tf) + - chromaticities of primaries and white point (primary color volume) + + The following properties are optional and have a well-defined default + if not explicitly set: + - primary color volume luminance range + - reference white luminance level + - mastering display primaries and white point (target color volume) + - mastering luminance range + - maximum content light level + - maximum frame-average light level + + Each required property must be set exactly once if the client is to create + an image description. The set requests verify that a property was not + already set. The create request verifies that all required properties are + set. There may be several alternative requests for setting each property, + and in that case the client must choose one of them. + + Once all properties have been set, the create request must be used to + create the image description object, destroying the creator in the + process. + + + + + + + + + + + + + + + + + + Create an image description object based on the parameters previously + set on this object. + + The completeness of the parameter set is verified. If the set is not + complete, the protocol error incomplete_set is raised. For the + definition of a complete set, see the description of this interface. + + Also, the combination of the parameter set is verified. If the set is + not consistent, the protocol error inconsistent_set is raised. + + If the particular combination of the parameter set is not supported + by the compositor, the resulting image description object shall + immediately deliver the xx_image_description_v4.failed event with the + 'unsupported' cause. If a valid image description was created from the + parameter set, the xx_image_description_v4.ready event will eventually + be sent instead. + + This request destroys the xx_image_description_creator_params_v4 + object. + + The resulting image description object does not allow get_information + request. + + + + + + + + Sets the transfer characteristic using explicitly enumerated named + functions. + + When the resulting image description is attached to an image, the + content should be encoded and decoded according to the industry standard + practices for the transfer characteristic. + + Only names advertised with xx_color_manager_v4 event supported_tf_named + are allowed. Other values shall raise the protocol error invalid_tf. + + If transfer characteristic has already been set on this object, the + protocol error already_set is raised. + + + + + + + + Sets the color component transfer characteristic to a power curve with + the given exponent. This curve represents the conversion from electrical + to optical pixel or color values. + + When the resulting image description is attached to an image, the + content should be encoded with the inverse of the power curve. + + The curve exponent shall be multiplied by 10000 to get the argument eexp + value to carry the precision of 4 decimals. + + The curve exponent must be at least 1.0 and at most 10.0. Otherwise the + protocol error invalid_tf is raised. + + If transfer characteristic has already been set on this object, the + protocol error already_set is raised. + + This request can be used when the compositor advertises + xx_color_manager_v4.feature.set_tf_power. Otherwise this request raises + the protocol error unsupported_feature. + + + + + + + + Sets the color primaries and white point using explicitly named sets. + This describes the primary color volume which is the basis for color + value encoding. + + Only names advertised with xx_color_manager_v4 event + supported_primaries_named are allowed. Other values shall raise the + protocol error invalid_primaries. + + If primaries have already been set on this object, the protocol error + already_set is raised. + + + + + + + + Sets the color primaries and white point using CIE 1931 xy chromaticity + coordinates. This describes the primary color volume which is the basis + for color value encoding. + + Each coordinate value is multiplied by 10000 to get the argument value + to carry precision of 4 decimals. + + If primaries have already been set on this object, the protocol error + already_set is raised. + + This request can be used if the compositor advertises + xx_color_manager_v4.feature.set_primaries. Otherwise this request raises + the protocol error unsupported_feature. + + + + + + + + + + + + + + + Sets the primary color volume luminance range and the reference white + luminance level. + + The default luminances are + - primary color volume minimum: 0.2 cd/m² + - primary color volume maximum: 80 cd/m² + - reference white: 80 cd/m² + + Setting a named transfer characteristic can imply other default + luminances. + + The default luminances get overwritten when this request is used. + + 'min_lum' and 'max_lum' specify the minimum and maximum luminances of + the primary color volume as reproduced by the targeted display. + + 'reference_lum' specifies the luminance of the reference white as + reproduced by the targeted display, and reflects the targeted viewing + environment. + + Compositors should make sure that all content is anchored, meaning that + an input signal level of 'reference_lum' on one image description and + another input signal level of 'reference_lum' on another image + description should produce the same output level, even though the + 'reference_lum' on both image representations can be different. + + If 'max_lum' is less than the 'reference_lum', or 'reference_lum' is + less than or equal to 'min_lum', the protocol error invalid_luminance is + raised. + + The minimum luminance is multiplied by 10000 to get the argument + 'min_lum' value and carries precision of 4 decimals. The maximum + luminance and reference white luminance values are unscaled. + + If the primary color volume luminance range and the reference white + luminance level have already been set on this object, the protocol error + already_set is raised. + + This request can be used if the compositor advertises + xx_color_manager_v4.feature.set_luminances. Otherwise this request + raises the protocol error unsupported_feature. + + + + + + + + + + Provides the color primaries and white point of the mastering display + using CIE 1931 xy chromaticity coordinates. This is compatible with the + SMPTE ST 2086 definition of HDR static metadata. + + The mastering display primaries define the target color volume. + + If mastering display primaries are not explicitly set, the target color + volume is assumed to be equal to the primary color volume. + + The target color volume is defined by all tristimulus values between 0.0 + and 1.0 (inclusive) of the color space defined by the given mastering + display primaries and white point. The colorimetry is identical between + the container color space and the mastering display color space, + including that no chromatic adaptation is applied even if the white + points differ. + + The target color volume can exceed the primary color volume to allow for + a greater color volume with an existing color space definition (for + example scRGB). It can be smaller than the primary color volume to + minimize gamut and tone mapping distances for big color spaces (HDR + metadata). + + To make use of the entire target color volume a suitable pixel format + has to be chosen (e.g. floating point to exceed the primary color + volume, or abusing limited quantization range as with xvYCC). + + Each coordinate value is multiplied by 10000 to get the argument value + to carry precision of 4 decimals. + + If mastering display primaries have already been set on this object, the + protocol error already_set is raised. + + This request can be used if the compositor advertises + xx_color_manager_v4.feature.set_mastering_display_primaries. Otherwise + this request raises the protocol error unsupported_feature. The + advertisement implies support only for target color volumes fully + contained within the primary color volume. + + If a compositor additionally supports target color volume exceeding the + primary color volume, it must advertise + xx_color_manager_v4.feature.extended_target_volume. If a client uses + target color volume exceeding the primary color volume and the + compositor does not support it, the result is implementation defined. + Compositors are recommended to detect this case and fail the image + description gracefully, but it may as well result in color artifacts. + + + + + + + + + + + + + + + Sets the luminance range that was used during the content mastering + process as the minimum and maximum absolute luminance L. This is + compatible with the SMPTE ST 2086 definition of HDR static metadata. + + The mastering luminance range is undefined by default. + + If max L is less than or equal to min L, the protocol error + invalid_luminance is raised. + + Min L value is multiplied by 10000 to get the argument min_lum value + and carry precision of 4 decimals. Max L value is unscaled for max_lum. + + + + + + + + + Sets the maximum content light level (max_cll) as defined by CTA-861-H. + + This can only be set when set_tf_cicp is used to set the transfer + characteristic to Rec. ITU-R BT.2100-2 perceptual quantization system. + Otherwise, 'create' request shall raise inconsistent_set protocol + error. + + max_cll is undefined by default. + + + + + + + + Sets the maximum frame-average light level (max_fall) as defined by + CTA-861-H. + + This can only be set when set_tf_cicp is used to set the transfer + characteristic to Rec. ITU-R BT.2100-2 perceptual quantization system. + Otherwise, 'create' request shall raise inconsistent_set protocol error. + + max_fall is undefined by default. + + + + + + + + + An image description carries information about the color encoding used on + a surface when attached to a wl_surface via + xx_color_management_surface_v4.set_image_description. A compositor can use + this information to decode pixel values into colorimetrically meaningful + quantities. + + Note, that the xx_image_description_v4 object is not ready to be used + immediately after creation. The object eventually delivers either the + 'ready' or the 'failed' event, specified in all requests creating it. The + object is deemed "ready" after receiving the 'ready' event. + + An object which is not ready is illegal to use, it can only be destroyed. + Any other request in this interface shall result in the 'not_ready' + protocol error. Attempts to use an object which is not ready through other + interfaces shall raise protocol errors defined there. + + Once created and regardless of how it was created, a + xx_image_description_v4 object always refers to one fixed image + description. It cannot change after creation. + + + + + Destroy this object. It is safe to destroy an object which is not ready. + + Destroying a xx_image_description_v4 object has no side-effects, not + even if a xx_color_management_surface_v4.set_image_description has not + yet been followed by a wl_surface.commit. + + + + + + + + + + + + + + + + + + + + + + If creating a xx_image_description_v4 object fails for a reason that is + not defined as a protocol error, this event is sent. + + The requests that create image description objects define whether and + when this can occur. Only such creation requests can trigger this event. + This event cannot be triggered after the image description was + successfully formed. + + Once this event has been sent, the xx_image_description_v4 object will + never become ready and it can only be destroyed. + + + + + + + + + Once this event has been sent, the xx_image_description_v4 object is + deemed "ready". Ready objects can be used to send requests and can be + used through other interfaces. + + Every ready xx_image_description_v4 protocol object refers to an + underlying image description record in the compositor. Multiple protocol + objects may end up referring to the same record. Clients may identify + these "copies" by comparing their id numbers: if the numbers from two + protocol objects are identical, the protocol objects refer to the same + image description record. Two different image description records + cannot have the same id number simultaneously. The id number does not + change during the lifetime of the image description record. + + The id number is valid only as long as the protocol object is alive. If + all protocol objects referring to the same image description record are + destroyed, the id number may be recycled for a different image + description record. + + Image description id number is not a protocol object id. Zero is + reserved as an invalid id number. It shall not be possible for a client + to refer to an image description by its id number in protocol. The id + numbers might not be portable between Wayland connections. + + This identity allows clients to de-duplicate image description records + and avoid get_information request if they already have the image + description information. + + + + + + + + Creates a xx_image_description_info_v4 object which delivers the + information that makes up the image description. + + Not all image description protocol objects allow get_information + request. Whether it is allowed or not is defined by the request that + created the object. If get_information is not allowed, the protocol + error no_information is raised. + + + + + + + + + Sends all matching events describing an image description object exactly + once and finally sends the 'done' event. + + Once a xx_image_description_info_v4 object has delivered a 'done' event it + is automatically destroyed. + + Every xx_image_description_info_v4 created from the same + xx_image_description_v4 shall always return the exact same data. + + + + + Signals the end of information events and destroys the object. + + + + + + The icc argument provides a file descriptor to the client which may be + memory-mapped to provide the ICC profile matching the image description. + The fd is read-only, and if mapped then it must be mapped with + MAP_PRIVATE by the client. + + The ICC profile version and other details are determined by the + compositor. There is no provision for a client to ask for a specific + kind of a profile. + + + + + + + + + + Delivers the primary color volume primaries and white point using CIE + 1931 xy chromaticity coordinates. + + Each coordinate value is multiplied by 10000 to get the argument value + to carry precision of 4 decimals. + + + + + + + + + + + + + + + Delivers the primary color volume primaries and white point using an + explicitly enumerated named set. + + + + + + + + The color component transfer characteristic of this image description is + a pure power curve. This event provides the exponent of the power + function. This curve represents the conversion from electrical to + optical pixel or color values. + + The curve exponent has been multiplied by 10000 to get the argument eexp + value to carry the precision of 4 decimals. + + + + + + + + Delivers the transfer characteristic using an explicitly enumerated + named function. + + + + + + + + Delivers the primary color volume luminance range and the reference + white luminance level. + + The minimum luminance is multiplied by 10000 to get the argument + 'min_lum' value and carries precision of 4 decimals. The maximum + luminance and reference white luminance values are unscaled. + + + + + + + + + + Provides the color primaries and white point of the target color volume + using CIE 1931 xy chromaticity coordinates. This is compatible with the + SMPTE ST 2086 definition of HDR static metadata for mastering displays. + + While primary color volume is about how color is encoded, the target + color volume is the actually displayable color volume. If target color + volume is equal to the primary color volume, then this event is not + sent. + + Each coordinate value is multiplied by 10000 to get the argument value + to carry precision of 4 decimals. + + + + + + + + + + + + + + + Provides the luminance range that the image description is targeting as + the minimum and maximum absolute luminance L. This is compatible with + the SMPTE ST 2086 definition of HDR static metadata. + + This luminance range is only theoretical and may not correspond to the + luminance of light emitted on an actual display. + + Min L value is multiplied by 10000 to get the argument min_lum value and + carry precision of 4 decimals. Max L value is unscaled for max_lum. + + + + + + + + + Provides the targeted max_cll of the image description. max_cll is + defined by CTA-861-H. + + This luminance is only theoretical and may not correspond to the + luminance of light emitted on an actual display. + + + + + + + + Provides the targeted max_fall of the image description. max_fall is + defined by CTA-861-H. + + This luminance is only theoretical and may not correspond to the + luminance of light emitted on an actual display. + + + + + + diff --git a/src/plugins/platforms/wayland/CMakeLists.txt b/src/plugins/platforms/wayland/CMakeLists.txt index 9b1c84f7414..4c62dc78ca2 100644 --- a/src/plugins/platforms/wayland/CMakeLists.txt +++ b/src/plugins/platforms/wayland/CMakeLists.txt @@ -28,6 +28,7 @@ qt_internal_add_module(WaylandClient qwaylandabstractdecoration.cpp qwaylandabstractdecoration_p.h qwaylandappmenu.cpp qwaylandappmenu_p.h qwaylandbuffer.cpp qwaylandbuffer_p.h + qwaylandcolormanagement.cpp qwaylandcolormanagement_p.h qwaylanddatacontrolv1.cpp qwaylanddatacontrolv1_p.h qwaylanddecorationfactory.cpp qwaylanddecorationfactory_p.h qwaylanddecorationplugin.cpp qwaylanddecorationplugin_p.h @@ -121,6 +122,7 @@ qt6_generate_wayland_protocol_client_sources(WaylandClient ${CMAKE_CURRENT_SOURCE_DIR}/../extensions/touch-extension.xml ${CMAKE_CURRENT_SOURCE_DIR}/hardwareintegration/../../extensions/hardware-integration.xml ${CMAKE_CURRENT_SOURCE_DIR}/hardwareintegration/../../extensions/server-buffer-extension.xml + ${CMAKE_CURRENT_SOURCE_DIR}/../3rdparty/protocol/color-management/xx-color-management-v4.xml ) #### Keys ignored in scope 1:.:.:client.pro:: diff --git a/src/plugins/platforms/wayland/qwaylandcolormanagement.cpp b/src/plugins/platforms/wayland/qwaylandcolormanagement.cpp new file mode 100644 index 00000000000..f0e9bd9a21d --- /dev/null +++ b/src/plugins/platforms/wayland/qwaylandcolormanagement.cpp @@ -0,0 +1,252 @@ +// Copyright (C) 2024 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only + +#include "qwaylandcolormanagement_p.h" +#include "qwaylanddisplay_p.h" + +#include + +QT_BEGIN_NAMESPACE + +namespace QtWaylandClient { + +ColorManager::ColorManager(struct ::wl_registry *registry, uint32_t id, int version) + : QtWayland::xx_color_manager_v4(registry, id, version) +{ +} + +ColorManager::~ColorManager() +{ + destroy(); +} + +void ColorManager::xx_color_manager_v4_supported_feature(uint32_t feature) +{ + switch (feature) { + case feature_icc_v2_v4: + mFeatures |= Feature::ICC; + break; + case feature_parametric: + mFeatures |= Feature::Parametric; + break; + case feature_set_primaries: + mFeatures |= Feature::SetPrimaries; + break; + case feature_set_tf_power: + mFeatures |= Feature::PowerTransferFunction; + break; + case feature_set_luminances: + mFeatures |= Feature::SetLuminances; + break; + case feature_set_mastering_display_primaries: + mFeatures |= Feature::SetMasteringDisplayPrimaries; + break; + case feature_extended_target_volume: + mFeatures |= Feature::ExtendedTargetVolume; + break; + } +} + +void ColorManager::xx_color_manager_v4_supported_primaries_named(uint32_t primaries) +{ + mPrimaries.push_back(QtWayland::xx_color_manager_v4::primaries(primaries)); +} + +void ColorManager::xx_color_manager_v4_supported_tf_named(uint32_t transferFunction) +{ + mTransferFunctions.push_back(QtWayland::xx_color_manager_v4::transfer_function(transferFunction)); +} + +ColorManager::Features ColorManager::supportedFeatures() const +{ + return mFeatures; +} + +bool ColorManager::supportsNamedPrimary(QtWayland::xx_color_manager_v4::primaries primaries) const +{ + return mPrimaries.contains(primaries); +} + +bool ColorManager::supportsTransferFunction(QtWayland::xx_color_manager_v4::transfer_function transferFunction) const +{ + return mTransferFunctions.contains(transferFunction); +} + +std::unique_ptr ColorManager::createImageDescription(const QColorSpace &colorspace) +{ + if (!(mFeatures & Feature::Parametric)) + return nullptr; + + constexpr std::array primaryMapping = { + std::make_pair(QColorSpace::Primaries::SRgb, primaries_srgb), + std::make_pair(QColorSpace::Primaries::AdobeRgb, primaries_adobe_rgb), + std::make_pair(QColorSpace::Primaries::DciP3D65, primaries_display_p3), + std::make_pair(QColorSpace::Primaries::Bt2020, primaries_bt2020), + }; + const auto primary = std::find_if(primaryMapping.begin(), primaryMapping.end(), [&colorspace](const auto &pair) { + return pair.first == colorspace.primaries(); + }); + if (!(supportedFeatures() & Feature::SetPrimaries) && (primary != primaryMapping.end() || !supportsNamedPrimary(primary->second))) + return nullptr; + + constexpr std::array tfMapping = { + std::make_pair(QColorSpace::TransferFunction::Linear, transfer_function_linear), + std::make_pair(QColorSpace::TransferFunction::SRgb, transfer_function_srgb), + std::make_pair(QColorSpace::TransferFunction::St2084, transfer_function_st2084_pq), + std::make_pair(QColorSpace::TransferFunction::Hlg, transfer_function_hlg), + }; + const auto tfIt = std::find_if(tfMapping.begin(), tfMapping.end(), [&colorspace](const auto &pair) { + return pair.first == colorspace.transferFunction(); + }); + auto transferFunction = tfIt == tfMapping.end() ? std::nullopt : std::make_optional(tfIt->second); + if (colorspace.transferFunction() == QColorSpace::TransferFunction::Gamma) { + if (qFuzzyCompare(colorspace.gamma(), 2.2f) && supportsTransferFunction(transfer_function_gamma22)) + transferFunction = transfer_function_gamma22; + else if (qFuzzyCompare(colorspace.gamma(), 2.8f) && supportsTransferFunction(transfer_function_gamma28)) + transferFunction = transfer_function_gamma28; + if (!transferFunction && !(mFeatures & Feature::PowerTransferFunction)) + return nullptr; + } else if (!transferFunction) { + return nullptr; + } + + auto creator = new_parametric_creator(); + if (primary != primaryMapping.end()) { + xx_image_description_creator_params_v4_set_primaries_named(creator, primary->second); + } else { + const auto primaries = colorspace.primaryPoints(); + xx_image_description_creator_params_v4_set_primaries(creator, + std::round(10'000 * primaries.redPoint.x()), std::round(10'000 * primaries.redPoint.y()), + std::round(10'000 * primaries.greenPoint.x()), std::round(10'000 * primaries.greenPoint.y()), + std::round(10'000 * primaries.bluePoint.x()), std::round(10'000 * primaries.bluePoint.y()), + std::round(10'000 * primaries.whitePoint.x()), std::round(10'000 * primaries.whitePoint.y()) + ); + } + if (transferFunction) { + xx_image_description_creator_params_v4_set_tf_named(creator, *transferFunction); + } else { + Q_ASSERT(colorspace.transferFunction() == QColorSpace::TransferFunction::Gamma); + xx_image_description_creator_params_v4_set_tf_power(creator, std::round(colorspace.gamma() * 10'000)); + } + return std::make_unique(xx_image_description_creator_params_v4_create(creator)); +} + +ImageDescriptionInfo::ImageDescriptionInfo(ImageDescription *descr) + : QtWayland::xx_image_description_info_v4(descr->get_information()) +{ +} + +ImageDescriptionInfo::~ImageDescriptionInfo() +{ + xx_image_description_info_v4_destroy(object()); +} + +void ImageDescriptionInfo::xx_image_description_info_v4_done() +{ + Q_EMIT done(); +} + +void ImageDescriptionInfo::xx_image_description_info_v4_primaries(int32_t r_x, int32_t r_y, int32_t g_x, int32_t g_y, int32_t b_x, int32_t b_y, int32_t w_x, int32_t w_y) +{ + mContainerRed = QPointF(r_x, r_y) / 10'000.0; + mContainerGreen = QPointF(g_x, g_y) / 10'000.0; + mContainerBlue = QPointF(b_x, b_y) / 10'000.0; + mContainerWhite = QPointF(w_x, w_y) / 10'000.0; +} + +void ImageDescriptionInfo::xx_image_description_info_v4_tf_named(uint32_t transferFunction) +{ + mTransferFunction = transferFunction; +} + +void ImageDescriptionInfo::xx_image_description_info_v4_luminances(uint32_t min_lum, uint32_t max_lum, uint32_t reference_lum) +{ + mMinLuminance = min_lum / 10'000.0; + mMaxLuminance = max_lum; + mReferenceLuminance = reference_lum; +} + +void ImageDescriptionInfo::xx_image_description_info_v4_target_primaries(int32_t r_x, int32_t r_y, int32_t g_x, int32_t g_y, int32_t b_x, int32_t b_y, int32_t w_x, int32_t w_y) +{ + mTargetRed = QPointF(r_x, r_y) / 10'000.0; + mTargetGreen = QPointF(g_x, g_y) / 10'000.0; + mTargetBlue = QPointF(b_x, b_y) / 10'000.0; + mTargetWhite = QPointF(w_x, w_y) / 10'000.0; +} + +void ImageDescriptionInfo::xx_image_description_info_v4_target_luminance(uint32_t min_lum, uint32_t max_lum) +{ + mTargetMinLuminance = min_lum / 10'000.0; + mTargetMaxLuminance = max_lum; +} + +ImageDescription::ImageDescription(::xx_image_description_v4 *descr) + : QtWayland::xx_image_description_v4(descr) +{ +} + +ImageDescription::~ImageDescription() +{ + xx_image_description_v4_destroy(object()); +} + +void ImageDescription::xx_image_description_v4_failed(uint32_t cause, const QString &msg) +{ + Q_UNUSED(cause); + qCWarning(lcQpaWayland) << "image description failed!" << msg; + // TODO handle this, somehow + // maybe fall back to the previous or preferred image description +} + +void ImageDescription::xx_image_description_v4_ready(uint32_t identity) +{ + Q_UNUSED(identity); + Q_EMIT ready(); +} + +ColorManagementFeedback::ColorManagementFeedback(::xx_color_management_feedback_surface_v4 *obj) + : QtWayland::xx_color_management_feedback_surface_v4(obj) + , mPreferred(std::make_unique(get_preferred())) +{ +} + +ColorManagementFeedback::~ColorManagementFeedback() +{ + xx_color_management_feedback_surface_v4_destroy(object()); +} + +void ColorManagementFeedback::xx_color_management_feedback_surface_v4_preferred_changed() +{ + mPreferred = std::make_unique(get_preferred()); + mPendingPreferredInfo = std::make_unique(mPreferred.get()); + connect(mPendingPreferredInfo.get(), &ImageDescriptionInfo::done, this, &ColorManagementFeedback::preferredChanged); +} + +void ColorManagementFeedback::handlePreferredDone() +{ + mPreferredInfo = std::move(mPendingPreferredInfo); +} + +ColorManagementSurface::ColorManagementSurface(::xx_color_management_surface_v4 *obj) + : QtWayland::xx_color_management_surface_v4(obj) +{ +} + +ColorManagementSurface::~ColorManagementSurface() +{ + xx_color_management_surface_v4_destroy(object()); +} + +void ColorManagementSurface::setImageDescription(ImageDescription *descr) +{ + if (descr) + xx_color_management_surface_v4_set_image_description(object(), descr->object(), QtWayland::xx_color_manager_v4::render_intent::render_intent_perceptual); + else + xx_color_management_surface_v4_unset_image_description(object()); +} + +} + +QT_END_NAMESPACE + +#include "moc_qwaylandcolormanagement_p.cpp" diff --git a/src/plugins/platforms/wayland/qwaylandcolormanagement_p.h b/src/plugins/platforms/wayland/qwaylandcolormanagement_p.h new file mode 100644 index 00000000000..752cbc27f1e --- /dev/null +++ b/src/plugins/platforms/wayland/qwaylandcolormanagement_p.h @@ -0,0 +1,147 @@ +// Copyright (C) 2024 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only + +#ifndef QWAYLANDCOLORMANAGEMENT_H +#define QWAYLANDCOLORMANAGEMENT_H + +// +// W A R N I N G +// ------------- +// +// This file is not part of the Qt API. It exists purely as an +// implementation detail. This header file may change from version to +// version without notice, or even be removed. +// +// We mean it. +// + +#include +#include +#include +#include + +#include "qwayland-xx-color-management-v4.h" + +QT_BEGIN_NAMESPACE + +namespace QtWaylandClient { + +class ImageDescription; + +class ColorManager : public QObject, public QtWayland::xx_color_manager_v4 +{ + Q_OBJECT +public: + enum class Feature { + ICC = 1 << 0, + Parametric = 1 << 1, + SetPrimaries = 1 << 2, + PowerTransferFunction = 1 << 3, + SetLuminances = 1 << 4, + SetMasteringDisplayPrimaries = 1 << 5, + ExtendedTargetVolume = 1 << 6, + }; + Q_ENUM(Feature); + Q_DECLARE_FLAGS(Features, Feature); + + explicit ColorManager(struct ::wl_registry *registry, uint32_t id, int version); + ~ColorManager() override; + + Features supportedFeatures() const; + bool supportsNamedPrimary(QtWayland::xx_color_manager_v4::primaries primaries) const; + bool supportsTransferFunction(QtWayland::xx_color_manager_v4::transfer_function transferFunction) const; + + std::unique_ptr createImageDescription(const QColorSpace &colorspace); + +private: + void xx_color_manager_v4_supported_feature(uint32_t feature) override; + void xx_color_manager_v4_supported_primaries_named(uint32_t primaries) override; + void xx_color_manager_v4_supported_tf_named(uint32_t transferFunction) override; + + Features mFeatures; + QList mPrimaries; + QList mTransferFunctions; +}; + +class ImageDescriptionInfo : public QObject, public QtWayland::xx_image_description_info_v4 +{ + Q_OBJECT +public: + explicit ImageDescriptionInfo(ImageDescription *descr); + ~ImageDescriptionInfo(); + + Q_SIGNAL void done(); + + uint32_t mTransferFunction = 0; + QPointF mContainerRed; + QPointF mContainerGreen; + QPointF mContainerBlue; + QPointF mContainerWhite; + QPointF mTargetRed; + QPointF mTargetGreen; + QPointF mTargetBlue; + QPointF mTargetWhite; + double mMinLuminance; + double mMaxLuminance; + double mReferenceLuminance; + double mTargetMinLuminance; + double mTargetMaxLuminance; + +private: + void xx_image_description_info_v4_done() override; + void xx_image_description_info_v4_primaries(int32_t r_x, int32_t r_y, int32_t g_x, int32_t g_y, int32_t b_x, int32_t b_y, int32_t w_x, int32_t w_y) override; + void xx_image_description_info_v4_tf_named(uint32_t transferFunction) override; + void xx_image_description_info_v4_luminances(uint32_t min_lum, uint32_t max_lum, uint32_t reference_lum) override; + void xx_image_description_info_v4_target_primaries(int32_t r_x, int32_t r_y, int32_t g_x, int32_t g_y, int32_t b_x, int32_t b_y, int32_t w_x, int32_t w_y) override; + void xx_image_description_info_v4_target_luminance(uint32_t min_lum, uint32_t max_lum) override; +}; + +class ImageDescription : public QObject, public QtWayland::xx_image_description_v4 +{ + Q_OBJECT +public: + explicit ImageDescription(::xx_image_description_v4 *descr); + ~ImageDescription(); + + Q_SIGNAL void ready(); + +private: + void xx_image_description_v4_failed(uint32_t cause, const QString &msg) override; + void xx_image_description_v4_ready(uint32_t identity) override; +}; + +class ColorManagementFeedback : public QObject, public QtWayland::xx_color_management_feedback_surface_v4 +{ + Q_OBJECT +public: + explicit ColorManagementFeedback(::xx_color_management_feedback_surface_v4 *obj); + ~ColorManagementFeedback(); + + Q_SIGNAL void preferredChanged(); + + std::unique_ptr mPreferredInfo; + +private: + void xx_color_management_feedback_surface_v4_preferred_changed() override; + void handlePreferredDone(); + + std::unique_ptr mPreferred; + std::unique_ptr mPendingPreferredInfo; + +}; + +class ColorManagementSurface : public QObject, public QtWayland::xx_color_management_surface_v4 +{ + Q_OBJECT +public: + explicit ColorManagementSurface(::xx_color_management_surface_v4 *obj); + ~ColorManagementSurface(); + + void setImageDescription(ImageDescription *descr); +}; + +} + +QT_END_NAMESPACE + +#endif diff --git a/src/plugins/platforms/wayland/qwaylanddisplay.cpp b/src/plugins/platforms/wayland/qwaylanddisplay.cpp index d7a5920afbf..ae773ed2b04 100644 --- a/src/plugins/platforms/wayland/qwaylanddisplay.cpp +++ b/src/plugins/platforms/wayland/qwaylanddisplay.cpp @@ -45,6 +45,8 @@ #endif #include "qwaylandqtkey_p.h" +#include "qwaylandcolormanagement_p.h" + #include #include #include @@ -813,6 +815,10 @@ void QWaylandDisplay::registry_global(uint32_t id, const QString &interface, uin inputDevice->setDataControlDevice(mGlobals.dataControlManager->createDevice(inputDevice)); } #endif + } else if (interface == QLatin1String(QtWayland::xx_color_manager_v4::interface()->name)) { + mGlobals.colorManager = std::make_unique(registry, id, 1); + // we need a roundtrip to receive the features the compositor supports + forceRoundTrip(); } mRegistryGlobals.append(RegistryGlobal(id, interface, version, registry)); diff --git a/src/plugins/platforms/wayland/qwaylanddisplay_p.h b/src/plugins/platforms/wayland/qwaylanddisplay_p.h index 1a6a5ba8e91..2cad24dd6a2 100644 --- a/src/plugins/platforms/wayland/qwaylanddisplay_p.h +++ b/src/plugins/platforms/wayland/qwaylanddisplay_p.h @@ -92,6 +92,7 @@ class QWaylandShellIntegration; class QWaylandCursor; class QWaylandCursorTheme; class EventThread; +class ColorManager; typedef void (*RegistryListener)(void *data, struct wl_registry *registry, @@ -226,6 +227,10 @@ public: { return mGlobals.appMenuManager.get(); } + ColorManager *colorManager() const + { + return mGlobals.colorManager.get(); + } struct RegistryGlobal { uint32_t id; @@ -363,6 +368,7 @@ private: std::unique_ptr xdgToplevelDragManager; std::unique_ptr windowManagerIntegration; std::unique_ptr appMenuManager; + std::unique_ptr colorManager; } mGlobals; int mFd = -1; diff --git a/src/plugins/platforms/wayland/qwaylandwindow.cpp b/src/plugins/platforms/wayland/qwaylandwindow.cpp index f9acfa76fd1..963a87ba4d1 100644 --- a/src/plugins/platforms/wayland/qwaylandwindow.cpp +++ b/src/plugins/platforms/wayland/qwaylandwindow.cpp @@ -19,6 +19,7 @@ #include "qwaylandshmbackingstore_p.h" #include "qwaylandshellintegration_p.h" #include "qwaylandviewport_p.h" +#include "qwaylandcolormanagement_p.h" #include #include @@ -213,6 +214,11 @@ void QWaylandWindow::initWindow() mSurface->commit(); } +void QWaylandWindow::setPendingImageDescription() +{ + mColorManagementSurface->setImageDescription(mPendingImageDescription.get()); +} + void QWaylandWindow::initializeWlSurface() { Q_ASSERT(!mSurface); @@ -240,6 +246,27 @@ void QWaylandWindow::initializeWlSurface() if (display()->viewporter() && display()->fractionalScaleManager()) { mViewport.reset(new QWaylandViewport(display()->createViewport(this))); } + + QColorSpace requestedColorSpace = window()->requestedFormat().colorSpace(); + if (requestedColorSpace != QColorSpace{} && mDisplay->colorManager()) { + // TODO try a similar (same primaries + supported transfer function) color space if this fails? + mPendingImageDescription = mDisplay->colorManager()->createImageDescription(requestedColorSpace); + if (mPendingImageDescription) { + if (!mColorManagementSurface) + mColorManagementSurface = std::make_unique(mDisplay->colorManager()->get_surface(surface())); + connect(mPendingImageDescription.get(), &ImageDescription::ready, this, &QWaylandWindow::setPendingImageDescription, Qt::SingleShotConnection); + mSurfaceFormat.setColorSpace(requestedColorSpace); + } else { + qCWarning(lcQpaWayland) << "couldn't create image description for requested color space" << requestedColorSpace; + } + } +} + +void QWaylandWindow::setFormat(const QSurfaceFormat &format) +{ + const auto colorSpace = mSurfaceFormat.colorSpace(); + mSurfaceFormat = format; + mSurfaceFormat.setColorSpace(colorSpace); } void QWaylandWindow::setShellIntegration(QWaylandShellIntegration *shellIntegration) @@ -297,6 +324,8 @@ void QWaylandWindow::reset() mSurface.reset(); mViewport.reset(); mFractionalScale.reset(); + mColorManagementSurface.reset(); + mPendingImageDescription.reset(); } emit wlSurfaceDestroyed(); } @@ -1851,6 +1880,11 @@ bool QWaylandWindow::windowEvent(QEvent *event) return QPlatformWindow::windowEvent(event); } +QSurfaceFormat QWaylandWindow::format() const +{ + return mSurfaceFormat; +} + } QT_END_NAMESPACE diff --git a/src/plugins/platforms/wayland/qwaylandwindow_p.h b/src/plugins/platforms/wayland/qwaylandwindow_p.h index a1ac7a2d08c..8e0843d89eb 100644 --- a/src/plugins/platforms/wayland/qwaylandwindow_p.h +++ b/src/plugins/platforms/wayland/qwaylandwindow_p.h @@ -60,6 +60,8 @@ class QWaylandPointerGesturePinchEvent; class QWaylandSurface; class QWaylandFractionalScale; class QWaylandViewport; +class ColorManagementSurface; +class ImageDescription; class Q_WAYLANDCLIENT_EXPORT QWaylandWindow : public QNativeInterface::Private::QWaylandWindow, public QPlatformWindow @@ -246,6 +248,8 @@ public: bool windowEvent(QEvent *event) override; + QSurfaceFormat format() const override; + public Q_SLOTS: void applyConfigure(); @@ -256,6 +260,7 @@ Q_SIGNALS: protected: virtual void doHandleFrameCallback(); virtual QRect defaultGeometry() const; + void setFormat(const QSurfaceFormat &format); // this should be called directly for buffer size changes only // use updateExposure for anything affecting the on/off state @@ -345,6 +350,9 @@ protected: Qt::ScreenOrientation mLastReportedContentOrientation = Qt::PrimaryOrientation; + std::unique_ptr mColorManagementSurface; + QSurfaceFormat mSurfaceFormat; + private: void setGeometry_helper(const QRect &rect); void initWindow(); @@ -357,6 +365,7 @@ private: void updateInputRegion(); void updateViewport(); bool calculateExposure() const; + void setPendingImageDescription(); void handleMouseEventWithDecoration(QWaylandInputDevice *inputDevice, const QWaylandPointerEvent &e); void handleScreensChanged(); @@ -370,6 +379,7 @@ private: bool mInResizeFromApplyConfigure = false; bool lastVisible = false; QRect mLastExposeGeometry; + std::unique_ptr mPendingImageDescription; static const wl_callback_listener callbackListener; void handleFrameCallback(struct ::wl_callback* callback);