diff --git a/gdk/wayland/gdkdisplay-wayland.c b/gdk/wayland/gdkdisplay-wayland.c index 85fa8de886..06e2c905b8 100644 --- a/gdk/wayland/gdkdisplay-wayland.c +++ b/gdk/wayland/gdkdisplay-wayland.c @@ -52,6 +52,7 @@ #include "gdkprofilerprivate.h" #include "gdkdihedralprivate.h" #include "gdktoplevel-wayland-private.h" +#include "gdkwaylandcolor-private.h" #include #include "tablet-unstable-v2-client-protocol.h" #include @@ -533,6 +534,10 @@ gdk_registry_handle_global (void *data, &wp_presentation_interface, MIN (version, 1)); } + else if (strcmp (interface, "xx_color_manager_v2") == 0) + { + display_wayland->color = gdk_wayland_color_new (registry, id, version); + } else if (strcmp (interface, wp_single_pixel_buffer_manager_v1_interface.name) == 0) { display_wayland->single_pixel_buffer = @@ -693,6 +698,12 @@ _gdk_wayland_display_open (const char *display_name) return NULL; } + if (display_wayland->color) + { + if (!gdk_wayland_color_prepare (display_wayland->color)) + g_clear_pointer (&display_wayland->color, gdk_wayland_color_free ); + } + gdk_display_emit_opened (display); return display; @@ -753,6 +764,7 @@ gdk_wayland_display_dispose (GObject *object) g_clear_pointer (&display_wayland->single_pixel_buffer, wp_single_pixel_buffer_manager_v1_destroy); g_clear_pointer (&display_wayland->linux_dmabuf, zwp_linux_dmabuf_v1_destroy); g_clear_pointer (&display_wayland->dmabuf_formats_info, dmabuf_formats_info_free); + g_clear_pointer (&display_wayland->color, gdk_wayland_color_free); g_clear_pointer (&display_wayland->shm, wl_shm_destroy); g_clear_pointer (&display_wayland->wl_registry, wl_registry_destroy); diff --git a/gdk/wayland/gdkdisplay-wayland.h b/gdk/wayland/gdkdisplay-wayland.h index d7d8828d07..9b23f54178 100644 --- a/gdk/wayland/gdkdisplay-wayland.h +++ b/gdk/wayland/gdkdisplay-wayland.h @@ -59,6 +59,7 @@ G_BEGIN_DECLS #define GDK_ZWP_POINTER_GESTURES_V1_VERSION 3 +typedef struct _GdkWaylandColor GdkWaylandColor; typedef struct _GdkWaylandSelection GdkWaylandSelection; typedef struct { @@ -123,6 +124,7 @@ struct _GdkWaylandDisplay struct wp_viewporter *viewporter; struct wp_presentation *presentation; struct wp_single_pixel_buffer_manager_v1 *single_pixel_buffer; + GdkWaylandColor *color; GList *async_roundtrips; diff --git a/gdk/wayland/gdksubsurface-wayland-private.h b/gdk/wayland/gdksubsurface-wayland-private.h index 9b8378ccc2..24cbc99b40 100644 --- a/gdk/wayland/gdksubsurface-wayland-private.h +++ b/gdk/wayland/gdksubsurface-wayland-private.h @@ -2,6 +2,7 @@ #include "gdksubsurfaceprivate.h" +#include "gdkwaylandcolor-private.h" #include "wayland-client-protocol.h" typedef struct _GdkWaylandSubsurface GdkWaylandSubsurface; @@ -20,6 +21,7 @@ struct _GdkWaylandSubsurface struct wl_surface *surface; struct wl_subsurface *subsurface; struct wp_viewport *viewport; + GdkWaylandColorSurface *color; GdkTexture *texture; cairo_rectangle_int_t dest; diff --git a/gdk/wayland/gdksubsurface-wayland.c b/gdk/wayland/gdksubsurface-wayland.c index 47db77f5d2..a32a95bbab 100644 --- a/gdk/wayland/gdksubsurface-wayland.c +++ b/gdk/wayland/gdksubsurface-wayland.c @@ -48,6 +48,7 @@ gdk_wayland_subsurface_finalize (GObject *object) g_clear_pointer (&self->frame_callback, wl_callback_destroy); g_clear_pointer (&self->opaque_region, wl_region_destroy); g_clear_pointer (&self->viewport, wp_viewport_destroy); + g_clear_pointer (&self->color, gdk_wayland_color_surface_free); g_clear_pointer (&self->subsurface, wl_subsurface_destroy); g_clear_pointer (&self->surface, wl_surface_destroy); g_clear_pointer (&self->bg_viewport, wp_viewport_destroy); @@ -411,6 +412,7 @@ gdk_wayland_subsurface_attach (GdkSubsurface *sub, gboolean needs_commit = FALSE; gboolean background_changed = FALSE; gboolean needs_bg_commit = FALSE; + gboolean color_state_changed = FALSE; if (sibling) will_be_above = sibling->above_parent; @@ -542,6 +544,14 @@ gdk_wayland_subsurface_attach (GdkSubsurface *sub, "[%p] 🗙 Texture has background, but no single-pixel buffer support", self); } + else if (self->color && + !gdk_wayland_color_surface_can_set_color_state (self->color, gdk_texture_get_color_state (texture))) + { + GDK_DISPLAY_DEBUG (gdk_surface_get_display (sub->parent), OFFLOAD, + "[%p] 🗙 Texture colorstate %s not supported", + self, + gdk_color_state_get_name (gdk_texture_get_color_state (texture))); + } else { gboolean was_transparent; @@ -551,6 +561,12 @@ gdk_wayland_subsurface_attach (GdkSubsurface *sub, else was_transparent = FALSE; + if (self->texture && texture) + color_state_changed = !gdk_color_state_equal (gdk_texture_get_color_state (self->texture), + gdk_texture_get_color_state (texture)); + else + color_state_changed = TRUE; + if (g_set_object (&self->texture, texture)) { buffer = get_wl_buffer (self, texture); @@ -568,7 +584,7 @@ gdk_wayland_subsurface_attach (GdkSubsurface *sub, } GDK_DISPLAY_DEBUG (gdk_surface_get_display (sub->parent), OFFLOAD, - "[%p] %s Attaching %s (%dx%d) at %d %d %d %d%s%s%s", + "[%p] %s Attaching %s (%dx%d, %s) at %d %d %d %d%s%s%s", self, G_OBJECT_TYPE_NAME (texture), will_be_above @@ -576,11 +592,12 @@ gdk_wayland_subsurface_attach (GdkSubsurface *sub, : (has_background ? "▼" : "▽"), gdk_texture_get_width (texture), gdk_texture_get_height (texture), + gdk_color_state_get_name (gdk_texture_get_color_state (texture)), self->dest.x, self->dest.y, self->dest.width, self->dest.height, transform != GDK_DIHEDRAL_NORMAL ? " (" : "", transform != GDK_DIHEDRAL_NORMAL ? gdk_dihedral_get_name (transform) : "", - transform != GDK_DIHEDRAL_NORMAL ? " )" : "" + transform != GDK_DIHEDRAL_NORMAL ? ")" : "" ); result = TRUE; } @@ -643,6 +660,10 @@ gdk_wayland_subsurface_attach (GdkSubsurface *sub, 0, 0, gdk_texture_get_width (texture), gdk_texture_get_height (texture)); + + if (self->color && color_state_changed) + gdk_wayland_color_surface_set_color_state (self->color, gdk_texture_get_color_state (texture)); + needs_commit = TRUE; } @@ -891,6 +912,9 @@ gdk_wayland_surface_create_subsurface (GdkSurface *surface) sub->subsurface = wl_subcompositor_get_subsurface (disp->subcompositor, sub->surface, impl->display_server.wl_surface); + if (disp->color) + sub->color = gdk_wayland_color_surface_new (disp->color, sub->surface, NULL, NULL); + sub->viewport = wp_viewporter_get_viewport (disp->viewporter, sub->surface); /* No input, please */ diff --git a/gdk/wayland/gdksurface-wayland-private.h b/gdk/wayland/gdksurface-wayland-private.h index b62e30f661..0433acd899 100644 --- a/gdk/wayland/gdksurface-wayland-private.h +++ b/gdk/wayland/gdksurface-wayland-private.h @@ -18,6 +18,7 @@ #pragma once #include "gdkprivate-wayland.h" +#include "gdkwaylandcolor-private.h" typedef enum _PopupState { @@ -39,6 +40,7 @@ struct _GdkWaylandSurface struct wl_egl_window *egl_window; struct wp_fractional_scale_v1 *fractional_scale; struct wp_viewport *viewport; + GdkWaylandColorSurface *color; } display_server; struct wl_event_queue *event_queue; diff --git a/gdk/wayland/gdksurface-wayland.c b/gdk/wayland/gdksurface-wayland.c index 4155766a3e..464d2a147b 100644 --- a/gdk/wayland/gdksurface-wayland.c +++ b/gdk/wayland/gdksurface-wayland.c @@ -56,7 +56,6 @@ #include "gsk/gskrectprivate.h" - /** * GdkWaylandSurface: * @@ -906,6 +905,14 @@ static const struct wl_surface_listener surface_listener = { surface_preferred_buffer_transform, }; +static void +preferred_changed (GdkWaylandColorSurface *color, + GdkColorState *color_state, + gpointer data) +{ + gdk_surface_set_color_state (GDK_SURFACE (data), color_state); +} + static void gdk_wayland_surface_create_wl_surface (GdkSurface *surface) { @@ -930,6 +937,12 @@ gdk_wayland_surface_create_wl_surface (GdkSurface *surface) wp_viewporter_get_viewport (display_wayland->viewporter, wl_surface); } + if (display_wayland->color) + self->display_server.color = gdk_wayland_color_surface_new (display_wayland->color, + wl_surface, + preferred_changed, + self); + self->display_server.wl_surface = wl_surface; } @@ -983,6 +996,7 @@ gdk_wayland_surface_destroy_wl_surface (GdkWaylandSurface *self) g_clear_pointer (&self->display_server.viewport, wp_viewport_destroy); g_clear_pointer (&self->display_server.fractional_scale, wp_fractional_scale_v1_destroy); + g_clear_pointer (&self->display_server.color, gdk_wayland_color_surface_free); g_clear_pointer (&self->display_server.wl_surface, wl_surface_destroy); diff --git a/gdk/wayland/gdkwaylandcolor-private.h b/gdk/wayland/gdkwaylandcolor-private.h new file mode 100644 index 0000000000..b0d0833b4a --- /dev/null +++ b/gdk/wayland/gdkwaylandcolor-private.h @@ -0,0 +1,37 @@ +#pragma once + +#include "gdkcolorstateprivate.h" +#include + +typedef struct _GdkWaylandColor GdkWaylandColor; + +GdkWaylandColor * gdk_wayland_color_new (struct wl_registry *registry, + uint32_t id, + uint32_t version); + +void gdk_wayland_color_free (GdkWaylandColor *color); + +gboolean gdk_wayland_color_prepare (GdkWaylandColor *color); + +struct wl_proxy * gdk_wayland_color_get_color_manager (GdkWaylandColor *color); + + +typedef struct _GdkWaylandColorSurface GdkWaylandColorSurface; + +typedef void (* GdkColorStateChanged) (GdkWaylandColorSurface *self, + GdkColorState *cs, + gpointer data); + +GdkWaylandColorSurface * + gdk_wayland_color_surface_new (GdkWaylandColor *color, + struct wl_surface *wl_surface, + GdkColorStateChanged callback, + gpointer data); + +void gdk_wayland_color_surface_free (GdkWaylandColorSurface *self); + +void gdk_wayland_color_surface_set_color_state (GdkWaylandColorSurface *self, + GdkColorState *cs); + +gboolean gdk_wayland_color_surface_can_set_color_state (GdkWaylandColorSurface *self, + GdkColorState *cs); diff --git a/gdk/wayland/gdkwaylandcolor.c b/gdk/wayland/gdkwaylandcolor.c new file mode 100644 index 0000000000..745489d42d --- /dev/null +++ b/gdk/wayland/gdkwaylandcolor.c @@ -0,0 +1,583 @@ +#include "config.h" + +#include "gdkwaylandcolor-private.h" +#include "gdksurface-wayland-private.h" +#include + + +struct _GdkWaylandColor +{ + struct xx_color_manager_v2 *color_manager; + struct { + unsigned int intents; + unsigned int features; + unsigned int transfers; + unsigned int primaries; + } color_manager_supported; + struct xx_image_description_v2 *srgb; + struct xx_image_description_v2 *srgb_linear; + struct xx_image_description_v2 *rec2100_pq; + struct xx_image_description_v2 *rec2100_linear; +}; + +static void +xx_color_manager_v2_supported_intent (void *data, + struct xx_color_manager_v2 *xx_color_manager_v2, + uint32_t render_intent) +{ + GdkWaylandColor *color = data; + + color->color_manager_supported.intents |= (1 << render_intent); +} + +static void +xx_color_manager_v2_supported_feature (void *data, + struct xx_color_manager_v2 *xx_color_manager_v2, + uint32_t feature) +{ + GdkWaylandColor *color = data; + + color->color_manager_supported.features |= (1 << feature); +} + +static void +xx_color_manager_v2_supported_tf_named (void *data, + struct xx_color_manager_v2 *xx_color_manager_v2, + uint32_t tf) +{ + GdkWaylandColor *color = data; + + color->color_manager_supported.transfers |= (1 << tf); +} + +static void +xx_color_manager_v2_supported_primaries_named (void *data, + struct xx_color_manager_v2 *xx_color_manager_v2, + uint32_t primaries) +{ + GdkWaylandColor *color = data; + + color->color_manager_supported.primaries |= (1 << primaries); +} + +static struct xx_color_manager_v2_listener color_manager_listener = { + xx_color_manager_v2_supported_intent, + xx_color_manager_v2_supported_feature, + xx_color_manager_v2_supported_tf_named, + xx_color_manager_v2_supported_primaries_named, +}; + +GdkWaylandColor * +gdk_wayland_color_new (struct wl_registry *registry, + uint32_t id, + uint32_t version) +{ + GdkWaylandColor *color; + + color = g_new0 (GdkWaylandColor, 1); + + color->color_manager = wl_registry_bind (registry, + id, + &xx_color_manager_v2_interface, + MIN (version, 2)); + + xx_color_manager_v2_add_listener (color->color_manager, + &color_manager_listener, + color); + + return color; +} + +void +gdk_wayland_color_free (GdkWaylandColor *color) +{ + g_clear_pointer (&color->color_manager, xx_color_manager_v2_destroy); + g_clear_pointer (&color->srgb, xx_image_description_v2_destroy); + g_clear_pointer (&color->srgb_linear, xx_image_description_v2_destroy); + g_clear_pointer (&color->rec2100_pq, xx_image_description_v2_destroy); + g_clear_pointer (&color->rec2100_linear, xx_image_description_v2_destroy); + g_free (color); +} + +struct wl_proxy * +gdk_wayland_color_get_color_manager (GdkWaylandColor *color) +{ + return (struct wl_proxy *) color->color_manager; +} + +static void +std_image_desc_failed (void *data, + struct xx_image_description_v2 *desc, + uint32_t cause, + const char *msg) +{ + g_warning ("Failed to get one of the standard image descriptions: %s", msg); + xx_image_description_v2_destroy (desc); +} + +static void +std_image_desc_ready (void *data, + struct xx_image_description_v2 *desc, + uint32_t identity) +{ + struct xx_image_description_v2 **ptr = data; + + *ptr = desc; +} + +static struct xx_image_description_v2_listener std_image_desc_listener = { + std_image_desc_failed, + std_image_desc_ready, +}; + +static void +create_image_desc (GdkWaylandColor *color, + uint32_t primaries, + uint32_t tf, + struct xx_image_description_v2 **out_desc) +{ + struct xx_image_description_creator_params_v2 *creator; + struct xx_image_description_v2 *desc; + + creator = xx_color_manager_v2_new_parametric_creator (color->color_manager); + + xx_image_description_creator_params_v2_set_primaries_named (creator, primaries); + xx_image_description_creator_params_v2_set_tf_named (creator, tf); + + desc = xx_image_description_creator_params_v2_create (creator); + + xx_image_description_v2_add_listener (desc, &std_image_desc_listener, out_desc); +} + +gboolean +gdk_wayland_color_prepare (GdkWaylandColor *color) +{ + if (color->color_manager) + { + const char *intents[] = { + "perceptual", "relative", "saturation", "absolute", "relative-bpc" + }; + const char *features[] = { + "icc-v2-v4", "parametric", "set-primaries", "set-tf-power", + "set-mastering-display-primaries", "extended-target-volume" + }; + const char *tf[] = { + "bt709", "gamma22", "gamma28", "st240", "linear", "log100", + "log316", "xvycc", "bt1361", "srgb", "ext-srgb", "pq", "st428", "hlg" + }; + const char *primaries[] = { + "srgb", "pal-m", "pal", "ntsc", "generic-film", "bt2020", "xyz", + "dci-p3", "display-p3", "adobe-rgb", + }; + + for (int i = 0; i < G_N_ELEMENTS (intents); i++) + { + GDK_DEBUG (MISC, "Rendering intent %d (%s): %s", + i, intents[i], color->color_manager_supported.intents & (1 << i) ? "✓" : "✗"); + } + + for (int i = 0; i < G_N_ELEMENTS (features); i++) + { + GDK_DEBUG (MISC, "Feature %d (%s): %s", + i, features[i], color->color_manager_supported.features & (1 << i) ? "✓" : "✗"); + } + + for (int i = 0; i < G_N_ELEMENTS (tf); i++) + { + GDK_DEBUG (MISC, "Transfer function %d (%s): %s", + i, tf[i], color->color_manager_supported.transfers & (1 << i) ? "✓" : "✗"); + } + + for (int i = 0; i < G_N_ELEMENTS (primaries); i++) + { + GDK_DEBUG (MISC, "Primaries %d (%s): %s", + i, primaries[i], color->color_manager_supported.primaries& (1 << i) ? "✓" : "✗"); + } + } + + if (color->color_manager && + !(color->color_manager_supported.intents & (1 << XX_COLOR_MANAGER_V2_RENDER_INTENT_PERCEPTUAL))) + { + GDK_DEBUG (MISC, "Not using color management: Missing perceptual render intent"); + g_clear_pointer (&color->color_manager, xx_color_manager_v2_destroy); + } + + if (color->color_manager && + (!(color->color_manager_supported.features & (1 << XX_COLOR_MANAGER_V2_FEATURE_PARAMETRIC)) || + !(color->color_manager_supported.transfers & (1 << XX_COLOR_MANAGER_V2_TRANSFER_FUNCTION_SRGB)) || + !(color->color_manager_supported.primaries & (1 << XX_COLOR_MANAGER_V2_PRIMARIES_SRGB)))) + + { + GDK_DEBUG (MISC, "Not using color management: Can't create srgb image description"); + g_clear_pointer (&color->color_manager, xx_color_manager_v2_destroy); + } + + if (color->color_manager) + { + create_image_desc (color, + XX_COLOR_MANAGER_V2_PRIMARIES_SRGB, + XX_COLOR_MANAGER_V2_TRANSFER_FUNCTION_SRGB, + &color->srgb); + + if (color->color_manager_supported.transfers & (1 << XX_COLOR_MANAGER_V2_TRANSFER_FUNCTION_LINEAR)) + create_image_desc (color, + XX_COLOR_MANAGER_V2_PRIMARIES_SRGB, + XX_COLOR_MANAGER_V2_TRANSFER_FUNCTION_LINEAR, + &color->srgb_linear); + + if (color->color_manager_supported.primaries & (1 << XX_COLOR_MANAGER_V2_PRIMARIES_BT2020)) + { + if (color->color_manager_supported.transfers & (1 << XX_COLOR_MANAGER_V2_TRANSFER_FUNCTION_ST2084_PQ)) + create_image_desc (color, + XX_COLOR_MANAGER_V2_PRIMARIES_BT2020, + XX_COLOR_MANAGER_V2_TRANSFER_FUNCTION_ST2084_PQ, + &color->rec2100_pq); + + if (color->color_manager_supported.transfers & (1 << XX_COLOR_MANAGER_V2_TRANSFER_FUNCTION_LINEAR)) + create_image_desc (color, + XX_COLOR_MANAGER_V2_PRIMARIES_BT2020, + XX_COLOR_MANAGER_V2_TRANSFER_FUNCTION_LINEAR, + &color->rec2100_linear); + } + } + + return color->color_manager != NULL; +} + +struct _GdkWaylandColorSurface +{ + GdkWaylandColor *color; + struct xx_color_management_surface_v2 *surface; + GdkColorStateChanged callback; + gpointer data; +}; + +typedef struct +{ + GdkWaylandColorSurface *surface; + + struct xx_image_description_v2 *image_desc; + struct xx_image_description_info_v2 *info; + + int32_t icc; + uint32_t icc_size; + uint32_t r_x, r_y, g_x, g_y, b_x, b_y, w_x, w_y; + uint32_t primaries; + uint32_t tf_power; + uint32_t tf_named; + uint32_t target_r_x, target_r_y, target_g_x, target_g_y, target_b_x, target_b_y, target_w_x, target_w_y; + uint32_t target_min_lum, target_max_lum; + uint32_t target_max_cll, target_max_fall; + + unsigned int has_icc : 1; + unsigned int has_primaries : 1; + unsigned int has_primaries_named : 1; + unsigned int has_tf_power : 1; + unsigned int has_tf_named : 1; + unsigned int has_target_primaries : 1; + unsigned int has_target_luminance : 1; + unsigned int has_target_max_cll : 1; + unsigned int has_target_max_fall : 1; +} ImageDescription; + +static GdkColorState * +gdk_color_state_from_image_description_bits (ImageDescription *desc) +{ + GdkColorState *cs = GDK_COLOR_STATE_SRGB; + + if (desc->has_primaries_named && desc->has_tf_named) + { + if (desc->primaries == XX_COLOR_MANAGER_V2_PRIMARIES_SRGB && + desc->tf_named == XX_COLOR_MANAGER_V2_TRANSFER_FUNCTION_SRGB) + { + cs = GDK_COLOR_STATE_SRGB; + } + else if (desc->primaries == XX_COLOR_MANAGER_V2_PRIMARIES_SRGB && + desc->tf_named == XX_COLOR_MANAGER_V2_TRANSFER_FUNCTION_LINEAR) + { + cs = GDK_COLOR_STATE_SRGB_LINEAR; + } + else if (desc->primaries == XX_COLOR_MANAGER_V2_PRIMARIES_BT2020 && + desc->tf_named == XX_COLOR_MANAGER_V2_TRANSFER_FUNCTION_ST2084_PQ) + { + cs = GDK_COLOR_STATE_REC2100_PQ; + } + else if (desc->primaries == XX_COLOR_MANAGER_V2_PRIMARIES_BT2020 && + desc->tf_named == XX_COLOR_MANAGER_V2_TRANSFER_FUNCTION_LINEAR) + { + cs = GDK_COLOR_STATE_REC2100_LINEAR; + } + } + + return cs; +} + +static void +image_desc_info_done (void *data, + struct xx_image_description_info_v2 *info) +{ + ImageDescription *desc = data; + GdkWaylandColorSurface *self = desc->surface; + GdkColorState *cs; + + cs = gdk_color_state_from_image_description_bits (desc); + + if (self->callback) + self->callback (desc->surface, cs, self->data); + + gdk_color_state_unref (cs); + + xx_image_description_v2_destroy (desc->image_desc); + xx_image_description_info_v2_destroy (desc->info); + g_free (desc); +} + +static void +image_desc_info_icc_file (void *data, + struct xx_image_description_info_v2 *info, + int32_t icc, + uint32_t icc_size) +{ + ImageDescription *desc = data; + + desc->icc = icc; + desc->icc_size = icc_size; + desc->has_icc = 1; +} + +static void +image_desc_info_primaries (void *data, + struct xx_image_description_info_v2 *info, + uint32_t r_x, uint32_t r_y, + uint32_t g_x, uint32_t g_y, + uint32_t b_x, uint32_t b_y, + uint32_t w_x, uint32_t w_y) +{ + ImageDescription *desc = data; + + desc->r_x = r_x; desc->r_y = r_y; + desc->g_x = g_x; desc->r_y = g_y; + desc->b_x = b_x; desc->r_y = b_y; + desc->w_x = w_x; desc->r_y = w_y; + desc->has_primaries = 1; +} + +static void +image_desc_info_primaries_named (void *data, + struct xx_image_description_info_v2 *info, + uint32_t primaries) +{ + ImageDescription *desc = data; + + desc->primaries = primaries; + desc->has_primaries_named = 1; +} + +static void +image_desc_info_tf_power (void *data, + struct xx_image_description_info_v2 *info, + uint32_t tf_power) +{ + ImageDescription *desc = data; + + desc->tf_power = tf_power; + desc->has_tf_power = 1; +} + +static void +image_desc_info_tf_named (void *data, + struct xx_image_description_info_v2 *info, + uint32_t tf) +{ + ImageDescription *desc = data; + + desc->tf_named = tf; + desc->has_tf_named = 1; +} + +static void +image_desc_info_target_primaries (void *data, + struct xx_image_description_info_v2 *info, + uint32_t r_x, uint32_t r_y, + uint32_t g_x, uint32_t g_y, + uint32_t b_x, uint32_t b_y, + uint32_t w_x, uint32_t w_y) +{ + ImageDescription *desc = data; + + desc->target_r_x = r_x; desc->target_r_y = r_y; + desc->target_g_x = g_x; desc->target_r_y = g_y; + desc->target_b_x = b_x; desc->target_r_y = b_y; + desc->target_w_x = w_x; desc->target_r_y = w_y; + desc->has_target_primaries = 1; +} + +static void +image_desc_info_target_luminance (void *data, + struct xx_image_description_info_v2 *info, + uint32_t min_lum, + uint32_t max_lum) +{ + ImageDescription *desc = data; + + desc->target_min_lum = min_lum; + desc->target_max_lum = max_lum; + desc->has_target_luminance = 1; +} + +static void +image_desc_info_target_max_cll (void *data, + struct xx_image_description_info_v2 *info, + uint32_t max_cll) +{ + ImageDescription *desc = data; + + desc->target_max_cll = max_cll; + desc->has_target_max_cll = 1; +} + +static void +image_desc_info_target_max_fall (void *data, + struct xx_image_description_info_v2 *info, + uint32_t max_fall) +{ + ImageDescription *desc = data; + + desc->target_max_fall = max_fall; + desc->has_target_max_fall = 1; +} + +static struct xx_image_description_info_v2_listener info_listener = { + image_desc_info_done, + image_desc_info_icc_file, + image_desc_info_primaries, + image_desc_info_primaries_named, + image_desc_info_tf_power, + image_desc_info_tf_named, + image_desc_info_target_primaries, + image_desc_info_target_luminance, + image_desc_info_target_max_cll, + image_desc_info_target_max_fall, +}; + +static void +image_desc_failed (void *data, + struct xx_image_description_v2 *image_desc, + uint32_t cause, + const char *msg) +{ + ImageDescription *desc = data; + GdkWaylandColorSurface *self = desc->surface; + + self->callback (self, GDK_COLOR_STATE_SRGB, self->data); + + xx_image_description_v2_destroy (desc->image_desc); + g_free (desc); +} + +static void +image_desc_ready (void *data, + struct xx_image_description_v2 *image_desc, + uint32_t identity) +{ + ImageDescription *desc = data; + + desc->info = xx_image_description_v2_get_information (image_desc); + + xx_image_description_info_v2_add_listener (desc->info, &info_listener, desc); +} + +static const struct xx_image_description_v2_listener image_desc_listener = { + image_desc_failed, + image_desc_ready +}; + +static void +preferred_changed (void *data, + struct xx_color_management_surface_v2 *color_mgmt_surface) +{ + GdkWaylandColorSurface *self = data; + ImageDescription *desc; + + desc = g_new0 (ImageDescription, 1); + + desc->surface = self; + + desc->image_desc = xx_color_management_surface_v2_get_preferred (self->surface); + + xx_image_description_v2_add_listener (desc->image_desc, &image_desc_listener, desc); +} + +static const struct xx_color_management_surface_v2_listener color_listener = { + preferred_changed, +}; + +GdkWaylandColorSurface * +gdk_wayland_color_surface_new (GdkWaylandColor *color, + struct wl_surface *wl_surface, + GdkColorStateChanged callback, + gpointer data) +{ + GdkWaylandColorSurface *self; + + self = g_new0 (GdkWaylandColorSurface, 1); + + self->color = color; + + self->surface = xx_color_manager_v2_get_surface (color->color_manager, wl_surface); + + self->callback = callback; + self->data = data; + + xx_color_management_surface_v2_add_listener (self->surface, &color_listener, self); + + return self; +} + +void +gdk_wayland_color_surface_free (GdkWaylandColorSurface *self) +{ + xx_color_management_surface_v2_destroy (self->surface); + + g_free (self); +} + + +static struct xx_image_description_v2 * +gdk_wayland_color_get_image_description (GdkWaylandColor *color, + GdkColorState *cs) +{ + if (gdk_color_state_equal (cs, GDK_COLOR_STATE_SRGB)) + return color->srgb; + else if (gdk_color_state_equal (cs, GDK_COLOR_STATE_SRGB_LINEAR)) + return color->srgb_linear; + else if (gdk_color_state_equal (cs, GDK_COLOR_STATE_REC2100_PQ)) + return color->rec2100_pq; + else if (gdk_color_state_equal (cs, GDK_COLOR_STATE_REC2100_LINEAR)) + return color->rec2100_linear; + else + return color->srgb; +} + +void +gdk_wayland_color_surface_set_color_state (GdkWaylandColorSurface *self, + GdkColorState *cs) +{ + struct xx_image_description_v2 *desc; + + desc = gdk_wayland_color_get_image_description (self->color, cs); + + if (desc) + xx_color_management_surface_v2_set_image_description (self->surface, + desc, + XX_COLOR_MANAGER_V2_RENDER_INTENT_PERCEPTUAL); + else + xx_color_management_surface_v2_unset_image_description (self->surface); +} + +gboolean +gdk_wayland_color_surface_can_set_color_state (GdkWaylandColorSurface *self, + GdkColorState *cs) +{ + return gdk_wayland_color_get_image_description (self->color, cs) != NULL; +} diff --git a/gdk/wayland/meson.build b/gdk/wayland/meson.build index e7561d43d7..6281c76cc0 100644 --- a/gdk/wayland/meson.build +++ b/gdk/wayland/meson.build @@ -23,6 +23,7 @@ gdk_wayland_sources = files([ 'gdktoplevel-wayland.c', 'gdkpopup-wayland.c', 'gdkvulkancontext-wayland.c', + 'gdkwaylandcolor.c', 'gdkwaylandpresentationtime.c', 'wm-button-layout-translation.c', ]) @@ -145,6 +146,11 @@ proto_sources = [ 'stability': 'staging', 'version': 1, }, + { + 'name': 'xx-color-management', + 'stability': 'private', + 'version': 2, + }, ] gdk_wayland_gen_headers = [] diff --git a/gdk/wayland/protocol/xx-color-management-v2.xml b/gdk/wayland/protocol/xx-color-management-v2.xml new file mode 100644 index 0000000000..fcd4107d10 --- /dev/null +++ b/gdk/wayland/protocol/xx-color-management-v2.xml @@ -0,0 +1,1233 @@ + + + + Copyright 2019 Sebastian Wick + Copyright 2019 Erwin Burema + Copyright 2020 AMD + Copyright 2020, 2022, 2023 Collabora, Ltd. + + 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_v2 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. + + + + 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. + + + + + 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 creates a new xx_color_management_output_v2 object for the + given wl_output. + + See the xx_color_management_output_v2 interface for more details. + + + + + + + + + This creates a new color xx_color_management_surface_v2 object for the + given wl_surface. + + See the xx_color_management_surface_v2 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_v2 object. + + This request can be used when the compositor advertises + xx_color_manager_v2.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_v2 object. + + This request can be used when the compositor advertises + xx_color_manager_v2.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_v2 describes the color properties of an + output. + + The xx_color_management_output_v2 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_v2 object inert. + + + + + Destroy the color xx_color_management_output_v2 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_v2 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_v2 object. + + The created xx_image_description_v2 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_v2.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_v2.failed event with the low_version cause. + + Otherwise the object shall immediately deliver the ready event. + + + + + + + + + A xx_color_management_surface_v2 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_v2 is + destroyed, the xx_color_management_surface_v2 object becomes inert. + + + + + Destroy the xx_color_management_surface_v2 object. + + When the last xx_color_management_surface_v2 object for a wl_surface + is destroyed, it does 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. + + 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_v2.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. + + + + + + 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 is not an initial event. + + 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. + + This creates a new xx_image_description_v2 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_surface_v2 object if + the client is capable of adapting to image descriptions. + + The created xx_image_description_v2 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_v2.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_v2 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_v2.failed event with the + 'unsupported' cause. If a valid image description was created from the + information, the xx_image_description_v2.ready event will eventually + be sent instead. + + This request destroys the xx_image_description_creator_icc_v2 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_v2.failed event on the + created xx_image_description_v2 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_v2 object + delivers either failed or ready event; or + - if create request was not issued, this + xx_image_description_creator_icc_v2 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'. + Violating these requirements will not result in a protocol error but + will eventually send the xx_image_description_v2.failed event on the + created xx_image_description_v2 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_v2 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: + - 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. + + 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_v2.failed event with the + 'unsupported' cause. If a valid image description was created from the + parameter set, the xx_image_description_v2.ready event will eventually + be sent instead. + + This request destroys the xx_image_description_creator_params_v2 + object. + + The resulting image description object does not allow get_information + request. + + + + + + + + Sets the transfer characteristic using explicitly enumerated named functions. + + Only names advertised with xx_color_manager_v2 + 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. + + 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_v2.feature.set_tf_power. Otherwise this request raises + the protocol error invalid_tf. + + + + + + + + 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_v2 + 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_v2.feature.set_primaries. Otherwise this request + raises the protocol error invalid_primaries. + + + + + + + + + + + + + + + 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_v2.feature.set_mastering_display_primaries. + Otherwise this request raises the protocol error invalid_mastering. + 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_v2.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. + + 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. + + 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_v2.set_image_description. A compositor can + use this information to decode pixel values into colorimetrically + meaningful quantities. + + Note, that the xx_image_description_v2 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_v2 + 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_v2 object has no side-effects, not + even if a xx_color_management_surface_v2.set_image_description has + not yet been followed by a wl_surface.commit. + + + + + + + + + + + + + + + + + + + + + + If creating a xx_image_description_v2 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_v2 object will + never become ready and it can only be destroyed. + + + + + + + + + Once this event has been sent, the xx_image_description_v2 object is + deemed "ready". Ready objects can be used to send requests and can be + used through other interfaces. + + Every ready xx_image_description_v2 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_v2 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_v2 object has delivered a 'done' event + it is automatically destroyed. + + Every xx_image_description_info_v2 created from the same + xx_image_description_v2 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 a + 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. + + + + + + + + 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/gtk/inspector/general.c b/gtk/inspector/general.c index e025557e59..38ed59a1b2 100644 --- a/gtk/inspector/general.c +++ b/gtk/inspector/general.c @@ -67,6 +67,7 @@ #include #include #include "wayland/gdkdisplay-wayland.h" +#include "wayland/gdkwaylandcolor-private.h" #endif #ifdef GDK_WINDOWING_BROADWAY @@ -695,6 +696,7 @@ add_wayland_protocols (GdkDisplay *display, append_wayland_protocol_row (gen, (struct wl_proxy *)d->viewporter); append_wayland_protocol_row (gen, (struct wl_proxy *)d->presentation); append_wayland_protocol_row (gen, (struct wl_proxy *)d->single_pixel_buffer); + append_wayland_protocol_row (gen, gdk_wayland_color_get_color_manager (d->color)); } } #endif