Frog color management

experimental color management protocol

The aim of this color management extension is to get HDR games working quickly, and have an easy way to test implementations in the wild before the upstream protocol is ready to be merged. For that purpose it's intentionally limited and cut down and does not serve all uses cases.

color management factory

The color management factory singleton creates color managed surface objects.

get_color_managed_surface(surface: object<wl_surface>, callback: new_id<frog_color_managed_surface>)
Argument
Type
Description
surfaceobject<wl_surface>
target surface
callbacknew_id<frog_color_managed_surface>
new color managed surface object
create color management interface for surface

color managed surface

Interface for changing surface color management and HDR state.

An implementation must: support every part of the version of the frog_color_managed_surface interface it exposes. Including all known enums associated with a given version.

destroy()
destroy color managed surface

Destroying the color managed surface resets all known color state for the surface back to 'undefined' implementation-specific values.

Argument
Type
Description
transfer_functionuint<frog_color_managed_surface.transfer_function>
transfer function for the surface
sets a known transfer function for a surface
set_known_container_color_volume(primaries: uint<frog_color_managed_surface.primaries>)
Argument
Type
Description
primariesuint<frog_color_managed_surface.primaries>
primaries for the surface
sets the container color volume (primaries) for a surface
Argument
Type
Description
render_intentuint<frog_color_managed_surface.render_intent>
render intent for the surface
sets the render intent for a surface

NOTE: On a surface with "perceptual" (default) render intent, handling of the container's color volume is implementation-specific, and may differ between different transfer functions it is paired with: ie. sRGB + 709 rendering may have it's primaries widened to more of the available display's gamut to be be more pleasing for the viewer. Compared to scRGB Linear + 709 being treated faithfully as 709 (including utilizing negatives out of the 709 gamut triangle)

Argument
Type
Description
mastering_display_primary_red_xuint
red primary x coordinate

Mastering Red Color Primary X Coordinate of the Data.

Coded as unsigned 16-bit values in units of 0.00002, where 0x0000 represents zero and 0xC350 represents 1.0000.

mastering_display_primary_red_yuint
red primary y coordinate

Mastering Red Color Primary Y Coordinate of the Data.

Coded as unsigned 16-bit values in units of 0.00002, where 0x0000 represents zero and 0xC350 represents 1.0000.

mastering_display_primary_green_xuint
green primary x coordinate

Mastering Green Color Primary X Coordinate of the Data.

Coded as unsigned 16-bit values in units of 0.00002, where 0x0000 represents zero and 0xC350 represents 1.0000.

mastering_display_primary_green_yuint
green primary y coordinate

Mastering Green Color Primary Y Coordinate of the Data.

Coded as unsigned 16-bit values in units of 0.00002, where 0x0000 represents zero and 0xC350 represents 1.0000.

mastering_display_primary_blue_xuint
blue primary x coordinate

Mastering Blue Color Primary X Coordinate of the Data.

Coded as unsigned 16-bit values in units of 0.00002, where 0x0000 represents zero and 0xC350 represents 1.0000.

mastering_display_primary_blue_yuint
blue primary y coordinate

Mastering Blue Color Primary Y Coordinate of the Data.

Coded as unsigned 16-bit values in units of 0.00002, where 0x0000 represents zero and 0xC350 represents 1.0000.

mastering_white_point_xuint
white point x coordinate

Mastering White Point X Coordinate of the Data.

These are coded as unsigned 16-bit values in units of 0.00002, where 0x0000 represents zero and 0xC350 represents 1.0000.

mastering_white_point_yuint
white point y coordinate

Mastering White Point Y Coordinate of the Data.

These are coded as unsigned 16-bit values in units of 0.00002, where 0x0000 represents zero and 0xC350 represents 1.0000.

max_display_mastering_luminanceuint
max display mastering luminance

Max Mastering Display Luminance. This value is coded as an unsigned 16-bit value in units of 1 cd/m2, where 0x0001 represents 1 cd/m2 and 0xFFFF represents 65535 cd/m2.

min_display_mastering_luminanceuint
min display mastering luminance

Min Mastering Display Luminance. This value is coded as an unsigned 16-bit value in units of 0.0001 cd/m2, where 0x0001 represents 0.0001 cd/m2 and 0xFFFF represents 6.5535 cd/m2.

max_clluint
max content light level

Max Content Light Level. This value is coded as an unsigned 16-bit value in units of 1 cd/m2, where 0x0001 represents 1 cd/m2 and 0xFFFF represents 65535 cd/m2.

max_falluint
max frame average light level

Max Frame Average Light Level. This value is coded as an unsigned 16-bit value in units of 1 cd/m2, where 0x0001 represents 1 cd/m2 and 0xFFFF represents 65535 cd/m2.

set HDR metadata for a surface

Forwards HDR metadata from the client to the compositor.

HDR Metadata Infoframe as per CTA 861.G spec.

Usage of this HDR metadata is implementation specific and outside of the scope of this protocol.

Argument
Type
Description
transfer_functionuint<frog_color_managed_surface.transfer_function>
output's current transfer function

Specifies a known transfer function that corresponds to the output the surface is targeting.

output_display_primary_red_xuint
red primary x coordinate

Output Red Color Primary X Coordinate of the Data.

Coded as unsigned 16-bit values in units of 0.00002, where 0x0000 represents zero and 0xC350 represents 1.0000.

output_display_primary_red_yuint
red primary y coordinate

Output Red Color Primary Y Coordinate of the Data.

Coded as unsigned 16-bit values in units of 0.00002, where 0x0000 represents zero and 0xC350 represents 1.0000.

output_display_primary_green_xuint
green primary x coordinate

Output Green Color Primary X Coordinate of the Data.

Coded as unsigned 16-bit values in units of 0.00002, where 0x0000 represents zero and 0xC350 represents 1.0000.

output_display_primary_green_yuint
green primary y coordinate

Output Green Color Primary Y Coordinate of the Data.

Coded as unsigned 16-bit values in units of 0.00002, where 0x0000 represents zero and 0xC350 represents 1.0000.

output_display_primary_blue_xuint
blue primary x coordinate

Output Blue Color Primary X Coordinate of the Data.

Coded as unsigned 16-bit values in units of 0.00002, where 0x0000 represents zero and 0xC350 represents 1.0000.

output_display_primary_blue_yuint
blue primary y coordinate

Output Blue Color Primary Y Coordinate of the Data.

Coded as unsigned 16-bit values in units of 0.00002, where 0x0000 represents zero and 0xC350 represents 1.0000.

output_white_point_xuint
white point x coordinate

Output White Point X Coordinate of the Data.

These are coded as unsigned 16-bit values in units of 0.00002, where 0x0000 represents zero and 0xC350 represents 1.0000.

output_white_point_yuint
white point y coordinate

Output White Point Y Coordinate of the Data.

These are coded as unsigned 16-bit values in units of 0.00002, where 0x0000 represents zero and 0xC350 represents 1.0000.

max_luminanceuint
maximum luminance

Max Output Luminance The max luminance in nits that the output is capable of rendering in small areas. Content should: not exceed this value to avoid clipping.

This value is coded as an unsigned 16-bit value in units of 1 cd/m2, where 0x0001 represents 1 cd/m2 and 0xFFFF represents 65535 cd/m2.

min_luminanceuint
minimum luminance

Min Output Luminance The min luminance that the output is capable of rendering. Content should: not exceed this value to avoid clipping.

This value is coded as an unsigned 16-bit value in units of 0.0001 cd/m2, where 0x0001 represents 0.0001 cd/m2 and 0xFFFF represents 6.5535 cd/m2.

max_full_frame_luminanceuint
maximum full frame luminance

Max Full Frame Luminance The max luminance in nits that the output is capable of rendering for the full frame sustained.

This value is coded as an unsigned 16-bit value in units of 1 cd/m2, where 0x0001 represents 1 cd/m2 and 0xFFFF represents 65535 cd/m2.

preferred metadata for a surface

Current preferred metadata for a surface. The application should use this information to tone-map its buffers to this target before committing.

This metadata does not necessarily correspond to any physical output, but rather what the compositor thinks would be best for a given surface.

transfer_function { undefined, srgb, gamma_22, st2084_pq, scrgb_linear } 
Argument
Value
Description
undefined0
specifies undefined, implementation-specific handling of the surface's transfer function.
srgb1
specifies the sRGB non-linear EOTF. An implementation may: display this as Gamma 2.2 for the purposes of being consistent with content rendering across displays, rendering_intent and user expectations.
gamma_222
specifies gamma 2.2 power curve as the EOTF
st2084_pq3
specifies the SMPTE ST2084 Perceptual Quantizer (PQ) EOTF
scrgb_linear4
specifies the scRGB (extended sRGB) linear EOTF. Note: Primaries outside the gamut triangle specified can be expressed with negative values for this transfer function.
known transfer functions

Extended information on the transfer functions described here can be found in the Khronos Data Format specification:

https://registry.khronos.org/DataFormat/specs/1.3/dataformat.1.3.html

primaries { undefined, rec709, rec2020 } 
Argument
Value
Description
undefined0
specifies undefined, implementation-specific handling
rec7091
specifies Rec.709/sRGB primaries with D65 white point
rec20202
specifies Rec.2020/HDR10 primaries with D65 white point
known primaries
render_intent { perceptual } 
Argument
Value
Description
perceptual0
perceptual
known render intents

Extended information on render intents described here can be found in ICC.1:2022:

https://www.color.org/specification/ICC.1-2022-05.pdf


Compositor Support

frog_color_management_factory_v1↓
Compositors
CageCage0.3.0
x
COSMICCOSMIC1.11.0
x
flakewm3.0.5
x
GameScopeGameScope3.17.0
x
HyprlandHyprland0.57.2
x
Jay1.14.0
x
KWinKWin6.7
1
LabwcLabwc0.20.2
x
LouvreLouvre2.14.1
x
MangoMango0.16.3
x
MirMir2.26
x
MuffinMuffin6.7.4
x
MutterMutter51
x
niriniri26.04
x
phocphoc0.55
x
Pila0.5.1
x
QtileQtile0.37.1
x
riverriver0.5.0
x
SwaySway1.11
x
TreelandTreeland0.8.0
x
WayfireWayfire0.9.0
x
WestonWeston15.0.1
x

Copyright © 2023 Joshua Ashton for Valve Software Copyright © 2023 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.