Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

wayland: Add color manager protocol support #11192

Merged
merged 1 commit into from
Feb 17, 2025
+2,022 −6
Merged

wayland: Add color manager protocol support #11192

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
224 changes: 224 additions & 0 deletions src/video/wayland/SDL_waylandcolor.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,224 @@
/*
Simple DirectMedia Layer
Copyright (C) 1997-2024 Sam Lantinga <slouken@libsdl.org>

This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.

Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:

1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
*/

#include "SDL_internal.h"

#ifdef SDL_VIDEO_DRIVER_WAYLAND

#include "SDL_waylandcolor.h"
#include "SDL_waylandvideo.h"
#include "SDL_waylandwindow.h"
#include "color-management-v1-client-protocol.h"

typedef struct Wayland_ColorInfoState
{
struct wp_image_description_v1 *wp_image_description;
struct wp_image_description_info_v1 *wp_image_description_info;
Wayland_ColorInfo *info;

bool result;
} Wayland_ColorInfoState;

static void image_description_info_handle_done(void *data,
struct wp_image_description_info_v1 *wp_image_description_info_v1)
{
Wayland_ColorInfoState *state = (Wayland_ColorInfoState *)data;

if (state->wp_image_description_info) {
wp_image_description_info_v1_destroy(state->wp_image_description_info);
state->wp_image_description_info = NULL;
}
if (state->wp_image_description) {
wp_image_description_v1_destroy(state->wp_image_description);
state->wp_image_description = NULL;
}

state->result = true;
}

static void image_description_info_handle_icc_file(void *data,
struct wp_image_description_info_v1 *wp_image_description_info_v1,
int32_t icc, uint32_t icc_size)
{
Wayland_ColorInfoState *state = (Wayland_ColorInfoState *)data;

state->info->icc_fd = icc;
state->info->icc_size = icc_size;
}

static void image_description_info_handle_primaries(void *data,
struct wp_image_description_info_v1 *wp_image_description_info_v1,
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)
{
// NOP
}

static void image_description_info_handle_primaries_named(void *data,
struct wp_image_description_info_v1 *wp_image_description_info_v1,
uint32_t primaries)
{
// NOP
}

static void image_description_info_handle_tf_power(void *data,
struct wp_image_description_info_v1 *wp_image_description_info_v1,
uint32_t eexp)
{
// NOP
}

static void image_description_info_handle_tf_named(void *data,
struct wp_image_description_info_v1 *wp_image_description_info_v1,
uint32_t tf)
{
// NOP
}

static void image_description_info_handle_luminances(void *data,
struct wp_image_description_info_v1 *wp_image_description_info_v1,
uint32_t min_lum,
uint32_t max_lum,
uint32_t reference_lum)
{
Wayland_ColorInfoState *state = (Wayland_ColorInfoState *)data;
state->info->HDR.HDR_headroom = (float)max_lum / (float)reference_lum;
}

static void image_description_info_handle_target_primaries(void *data,
struct wp_image_description_info_v1 *wp_image_description_info_v1,
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)
{
// NOP
}

static void image_description_info_handle_target_luminance(void *data,
struct wp_image_description_info_v1 *wp_image_description_info_v1,
uint32_t min_lum,
uint32_t max_lum)
{
// NOP
}

static void image_description_info_handle_target_max_cll(void *data,
struct wp_image_description_info_v1 *wp_image_description_info_v1,
uint32_t max_cll)
{
// NOP
}

static void image_description_info_handle_target_max_fall(void *data,
struct wp_image_description_info_v1 *wp_image_description_info_v1,
uint32_t max_fall)
{
// NOP
}

static const struct wp_image_description_info_v1_listener image_description_info_listener = {
image_description_info_handle_done,
image_description_info_handle_icc_file,
image_description_info_handle_primaries,
image_description_info_handle_primaries_named,
image_description_info_handle_tf_power,
image_description_info_handle_tf_named,
image_description_info_handle_luminances,
image_description_info_handle_target_primaries,
image_description_info_handle_target_luminance,
image_description_info_handle_target_max_cll,
image_description_info_handle_target_max_fall
};

static void PumpColorspaceEvents(Wayland_ColorInfoState *state)
{
SDL_VideoData *vid = SDL_GetVideoDevice()->internal;

// Run the image description sequence to completion in its own queue.
struct wl_event_queue *queue = WAYLAND_wl_display_create_queue(vid->display);
WAYLAND_wl_proxy_set_queue((struct wl_proxy *)state->wp_image_description, queue);

while (state->wp_image_description) {
WAYLAND_wl_display_dispatch_queue(vid->display, queue);
}

WAYLAND_wl_event_queue_destroy(queue);
}

static void image_description_handle_failed(void *data,
struct wp_image_description_v1 *wp_image_description_v1,
uint32_t cause,
const char *msg)
{
Wayland_ColorInfoState *state = (Wayland_ColorInfoState *)data;

wp_image_description_v1_destroy(state->wp_image_description);
state->wp_image_description = NULL;
}

static void image_description_handle_ready(void *data,
struct wp_image_description_v1 *wp_image_description_v1,
uint32_t identity)
{
Wayland_ColorInfoState *state = (Wayland_ColorInfoState *)data;

// This will inherit the queue of the factory image description object.
state->wp_image_description_info = wp_image_description_v1_get_information(state->wp_image_description);
wp_image_description_info_v1_add_listener(state->wp_image_description_info, &image_description_info_listener, data);
}

static const struct wp_image_description_v1_listener image_description_listener = {
image_description_handle_failed,
image_description_handle_ready
};

bool Wayland_GetColorInfoForWindow(SDL_WindowData *window_data, Wayland_ColorInfo *info)
{
Wayland_ColorInfoState state;
SDL_zero(state);
state.info = info;

state.wp_image_description = wp_color_management_surface_feedback_v1_get_preferred(window_data->wp_color_management_surface_feedback);
wp_image_description_v1_add_listener(state.wp_image_description, &image_description_listener, &state);

PumpColorspaceEvents(&state);

return state.result;
}

bool Wayland_GetColorInfoForOutput(SDL_DisplayData *display_data, Wayland_ColorInfo *info)
{
Wayland_ColorInfoState state;
SDL_zero(state);
state.info = info;

state.wp_image_description = wp_color_management_output_v1_get_image_description(display_data->wp_color_management_output);
wp_image_description_v1_add_listener(state.wp_image_description, &image_description_listener, &state);

PumpColorspaceEvents(&state);

return state.result;
}

#endif // SDL_VIDEO_DRIVER_WAYLAND
41 changes: 41 additions & 0 deletions src/video/wayland/SDL_waylandcolor.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
/*
Simple DirectMedia Layer
Copyright (C) 1997-2024 Sam Lantinga <slouken@libsdl.org>

This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.

Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:

1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
*/

#include "SDL_internal.h"

#ifndef SDL_waylandcolor_h_
#define SDL_waylandcolor_h_

#include "../SDL_sysvideo.h"

typedef struct Wayland_ColorInfo
{
SDL_HDROutputProperties HDR;

// The ICC fd is only valid if the size is non-zero.
int icc_fd;
Uint32 icc_size;
} Wayland_ColorInfo;

extern bool Wayland_GetColorInfoForWindow(SDL_WindowData *window_data, Wayland_ColorInfo *info);
extern bool Wayland_GetColorInfoForOutput(SDL_DisplayData *display_data, Wayland_ColorInfo *info);

#endif // SDL_waylandcolor_h_
Loading
Loading