RepoMirrors
/
mpv
mirror of https://github.com/mpv-player/mpv
1
0
Fork 0
Code Issues Releases Wiki Activity

wayland: add support for xx-color-management-v4 for vo_dmabuf_wayland 

Although this protocol isn't official yet, several compositors are known
to support it to some extent and this lets users actually view HDR with
less hacks/workarounds. The actual protocol here is simply copy and
pasted from the upstream fork* where these are developed. There is also
icc profile support in the protocol, but this is omitted for now in
favor of setting colorspaces and signalling hdr metadata. However for
mpv, this only actually has any practical use with vo_dmabuf_wayland so
this is the only VO that will make use of the protocol. When using
vulkan, this is already handled via vulkan extensions by compositors and
vo_gpu_next. So actually we don't want to use the wayland protocol in
that case since it will just get in the way. The only known limitation
on that front is driver support for hdr vulkan surfaces but as soon as
that is available it should just work with no code changes. For opengl,
hdr support there is a whole other mess with a lot of unknowns but
simply using this protocol isn't good enough and would require changes
elsewhere. vo_wlshm is currently too stupid to pick any format besides
bgr0 or 0rgb, so any color management there is meaningless at this
stage.

So this means that only vo_dmabuf_wayland can actually use this
protocol. But that's perfectly fine. Without this, vo_dmabuf_wayland has
a very bad limitation in that it cannot communicate colorspaces at all
and compositors have to guess. Using xx-color-management-v4 fixes this.
For the other VOs, merely having the common protocol setup stuff in the
common code does no harm and later if they get smarter, it's easy for
them to use the stuff since it is written generically anyway.

*: https://gitlab.freedesktop.org/swick/wayland-protocols/-/tree/color-xx/staging/color-management
This commit is contained in:
Dudemanguy 2024-09-26 17:28:35 -05:00
parent ff64d87bb4
commit 187fffd0f5
5 changed files with 1758 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
video/out/meson.build
View File

@ -6,8 +6,9 @@ protocols = [[wl_protocol_dir, 'stable/presentation-time/presentation-time.xml']
[wl_protocol_dir, 'unstable/linux-dmabuf/linux-dmabuf-unstable-v1.xml'],
[wl_protocol_dir, 'unstable/xdg-decoration/xdg-decoration-unstable-v1.xml'],
[wl_protocol_dir, 'staging/content-type/content-type-v1.xml'],
[wl_protocol_dir, 'staging/fractional-scale/fractional-scale-v1.xml'],
[wl_protocol_dir, 'staging/single-pixel-buffer/single-pixel-buffer-v1.xml'],
[wl_protocol_dir, 'staging/fractional-scale/fractional-scale-v1.xml']]
['protocols', 'xx-color-management-v4.xml']]
wl_protocols_source = []
wl_protocols_headers = []

1453
video/out/protocols/xx-color-management-v4.xml Normal file
View File

File diff suppressed because it is too large Load Diff

20
video/out/vo_dmabuf_wayland.c
View File

@ -100,6 +100,8 @@ struct priv {
bool destroy_buffers;
bool force_window;
enum hwdec_type hwdec_type;
struct mp_image_params target_params;
uint32_t drm_format;
uint64_t drm_modifier;
};
@ -538,6 +540,12 @@ static void resize(struct vo *vo)
lround(vo->dheight / wl->scaling_factor));
wl_subsurface_set_position(wl->osd_subsurface, lround((0 - dst.x0) / wl->scaling_factor), lround((0 - dst.y0) / wl->scaling_factor));
set_viewport_source(vo, src);
mp_mutex_lock(&vo->params_mutex);
vo->target_params->w = mp_rect_w(dst);
vo->target_params->h = mp_rect_h(dst);
vo->target_params->rotate = (vo->params->rotate % 90) * 90;
mp_mutex_unlock(&vo->params_mutex);
}
static bool draw_osd(struct vo *vo, struct mp_image *cur, double pts)
@ -612,6 +620,7 @@ static void draw_frame(struct vo *vo, struct vo_frame *frame)
buf = buffer_get(vo, frame);
if (buf && buf->frame) {
vo_wayland_handle_color(wl);
struct mp_image *image = buf->frame->current;
wl_surface_attach(wl->video_surface, buf->buffer, 0, 0);
wl_surface_damage_buffer(wl->video_surface, 0, 0, image->w,
@ -691,6 +700,17 @@ done:
if (!vo_wayland_reconfig(vo))
return VO_ERROR;
mp_mutex_lock(&vo->params_mutex);
p->target_params = img->params;
// Restore fallback layer parameters if available.
mp_image_params_restore_dovi_mapping(&p->target_params);
// Strip metadata that is not understood anyway.
struct pl_hdr_metadata *hdr = &p->target_params.color.hdr;
hdr->scene_max[0] = hdr->scene_max[1] = hdr->scene_max[2] = 0;
hdr->scene_avg = hdr->max_pq_y = hdr->avg_pq_y = 0;
vo->target_params = &p->target_params;
mp_mutex_unlock(&vo->params_mutex);
wl_surface_set_buffer_transform(vo->wl->video_surface, img->params.rotate / 90);
// Immediately destroy all buffers if params change.

266
video/out/wayland_common.c
View File

@ -46,6 +46,9 @@
#include "single-pixel-buffer-v1.h"
#include "fractional-scale-v1.h"
// Vendored protocols
#include "xx-color-management-v4.h"
#if HAVE_DRM
#include <drm_fourcc.h>
#include <xf86drm.h>
@ -71,6 +74,9 @@
// From the fractional scale protocol
#define WAYLAND_SCALE_FACTOR 120.0
// From the xx color management protocol
#define WAYLAND_COLOR_FACTOR 10000
enum resizing_constraint {
MP_WIDTH_CONSTRAINT = 1,
@ -232,6 +238,7 @@ static void get_planar_drm_formats(struct vo_wayland_state *wl);
static void get_shape_device(struct vo_wayland_state *wl, struct vo_wayland_seat *s);
static void guess_focus(struct vo_wayland_state *wl);
static void handle_key_input(struct vo_wayland_seat *s, uint32_t key, uint32_t state, bool no_emit);
static void initialize_color_maps(struct vo_wayland_state *wl);
static void prepare_resize(struct vo_wayland_state *wl);
static void remove_feedback(struct vo_wayland_feedback_pool *fback_pool,
struct wp_presentation_feedback *fback);
@ -1241,6 +1248,136 @@ static const struct wp_fractional_scale_v1_listener fractional_scale_listener =
preferred_scale,
};
static void supported_intent(void *data, struct xx_color_manager_v4 *color_manager,
uint32_t render_intent)
{
}
static void supported_feature(void *data, struct xx_color_manager_v4 *color_manager,
uint32_t feature)
{
struct vo_wayland_state *wl = data;
switch (feature) {
case XX_COLOR_MANAGER_V4_FEATURE_ICC_V2_V4:
MP_VERBOSE(wl, "Compositor supports ICC creator requests.\n");
wl->supports_icc = true; // TODO: actually implement
break;
case XX_COLOR_MANAGER_V4_FEATURE_PARAMETRIC:
MP_VERBOSE(wl, "Compositor supports parametric image description creator.\n");
wl->supports_parametric = true;
break;
case XX_COLOR_MANAGER_V4_FEATURE_SET_PRIMARIES:
MP_VERBOSE(wl, "Compositor supports setting primaries.\n");
wl->supports_primaries = true;
break;
case XX_COLOR_MANAGER_V4_FEATURE_SET_TF_POWER:
MP_VERBOSE(wl, "Compositor supports setting transfer functions.\n");
wl->supports_tf_power = true;
break;
case XX_COLOR_MANAGER_V4_FEATURE_SET_LUMINANCES:
MP_VERBOSE(wl, "Compositor supports setting luminances.\n");
wl->supports_luminances = true;
break;
case XX_COLOR_MANAGER_V4_FEATURE_SET_MASTERING_DISPLAY_PRIMARIES:
MP_VERBOSE(wl, "Compositor supports setting mastering display primaries.\n");
wl->supports_display_primaries = true;
break;
}
}
static void supported_tf_named(void *data, struct xx_color_manager_v4 *color_manager,
uint32_t tf)
{
struct vo_wayland_state *wl = data;
switch (tf) {
case XX_COLOR_MANAGER_V4_TRANSFER_FUNCTION_SRGB:
wl->transfer_map[PL_COLOR_TRC_SRGB] = XX_COLOR_MANAGER_V4_TRANSFER_FUNCTION_SRGB;
break;
case XX_COLOR_MANAGER_V4_TRANSFER_FUNCTION_LINEAR:
wl->transfer_map[PL_COLOR_TRC_LINEAR] = XX_COLOR_MANAGER_V4_TRANSFER_FUNCTION_LINEAR;
break;
case XX_COLOR_MANAGER_V4_TRANSFER_FUNCTION_GAMMA22:
wl->transfer_map[PL_COLOR_TRC_GAMMA22] = XX_COLOR_MANAGER_V4_TRANSFER_FUNCTION_GAMMA22;
break;
case XX_COLOR_MANAGER_V4_TRANSFER_FUNCTION_GAMMA28:
wl->transfer_map[PL_COLOR_TRC_GAMMA28] = XX_COLOR_MANAGER_V4_TRANSFER_FUNCTION_GAMMA28;
break;
case XX_COLOR_MANAGER_V4_TRANSFER_FUNCTION_ST428:
wl->transfer_map[PL_COLOR_TRC_ST428] = XX_COLOR_MANAGER_V4_TRANSFER_FUNCTION_ST428;
break;
case XX_COLOR_MANAGER_V4_TRANSFER_FUNCTION_ST2084_PQ:
wl->transfer_map[PL_COLOR_TRC_PQ] = XX_COLOR_MANAGER_V4_TRANSFER_FUNCTION_ST2084_PQ;
break;
case XX_COLOR_MANAGER_V4_TRANSFER_FUNCTION_HLG:
wl->transfer_map[PL_COLOR_TRC_HLG] = XX_COLOR_MANAGER_V4_TRANSFER_FUNCTION_HLG;
break;
}
}
static void supported_primaries_named(void *data, struct xx_color_manager_v4 *color_manager,
uint32_t primaries)
{
struct vo_wayland_state *wl = data;
switch (primaries) {
case XX_COLOR_MANAGER_V4_PRIMARIES_PAL:
wl->primaries_map[PL_COLOR_PRIM_BT_601_525] = XX_COLOR_MANAGER_V4_PRIMARIES_PAL;
break;
case XX_COLOR_MANAGER_V4_PRIMARIES_NTSC:
wl->primaries_map[PL_COLOR_PRIM_BT_601_625] = XX_COLOR_MANAGER_V4_PRIMARIES_NTSC;
break;
case XX_COLOR_MANAGER_V4_PRIMARIES_SRGB:
wl->primaries_map[PL_COLOR_PRIM_BT_709] = XX_COLOR_MANAGER_V4_PRIMARIES_SRGB;
break;
case XX_COLOR_MANAGER_V4_PRIMARIES_PAL_M:
wl->primaries_map[PL_COLOR_PRIM_BT_470M] = XX_COLOR_MANAGER_V4_PRIMARIES_PAL_M;
break;
case XX_COLOR_MANAGER_V4_PRIMARIES_BT2020:
wl->primaries_map[PL_COLOR_PRIM_BT_2020] = XX_COLOR_MANAGER_V4_PRIMARIES_BT2020;
break;
case XX_COLOR_MANAGER_V4_PRIMARIES_ADOBE_RGB:
wl->primaries_map[PL_COLOR_PRIM_ADOBE] = XX_COLOR_MANAGER_V4_PRIMARIES_ADOBE_RGB;
break;
case XX_COLOR_MANAGER_V4_PRIMARIES_DCI_P3:
wl->primaries_map[PL_COLOR_PRIM_DCI_P3] = XX_COLOR_MANAGER_V4_PRIMARIES_DCI_P3;
break;
case XX_COLOR_MANAGER_V4_PRIMARIES_DISPLAY_P3:
wl->primaries_map[PL_COLOR_PRIM_DISPLAY_P3] = XX_COLOR_MANAGER_V4_PRIMARIES_DISPLAY_P3;
break;
case XX_COLOR_MANAGER_V4_PRIMARIES_GENERIC_FILM:
wl->primaries_map[PL_COLOR_PRIM_FILM_C] = XX_COLOR_MANAGER_V4_PRIMARIES_GENERIC_FILM;
break;
}
}
static const struct xx_color_manager_v4_listener color_manager_listener = {
supported_intent,
supported_feature,
supported_tf_named,
supported_primaries_named,
};
static void image_description_failed(void *data, struct xx_image_description_v4 *image_description,
uint32_t cause, const char *msg)
{
struct vo_wayland_state *wl = data;
MP_VERBOSE(wl, "Image description failed: %d, %s\n", cause, msg);
}
static void image_description_ready(void *data, struct xx_image_description_v4 *image_description,
uint32_t identity)
{
struct vo_wayland_state *wl = data;
xx_color_management_surface_v4_set_image_description(wl->color_surface, wl->image_description, 0);
}
static const struct xx_image_description_v4_listener image_description_listener = {
image_description_failed,
image_description_ready,
};
static const char *zxdg_decoration_mode_to_str(const uint32_t mode)
{
switch (mode) {
@ -1503,6 +1640,8 @@ static void registry_handle_add(void *data, struct wl_registry *reg, uint32_t id
wl->surface = wl_compositor_create_surface(wl->compositor);
wl->video_surface = wl_compositor_create_surface(wl->compositor);
wl->osd_surface = wl_compositor_create_surface(wl->compositor);
wl->callback_surface = !strcmp(wl->vo->driver->name, "dmabuf-wayland") ?
wl->video_surface : wl->surface;
/* never accept input events on anything besides the main surface */
struct wl_region *region = wl_compositor_create_region(wl->compositor);
@ -1602,6 +1741,13 @@ static void registry_handle_add(void *data, struct wl_registry *reg, uint32_t id
xdg_wm_base_add_listener(wl->wm_base, &xdg_wm_base_listener, wl);
}
if (!strcmp(interface, xx_color_manager_v4_interface.name) && found++) {
ver = 1;
initialize_color_maps(wl);
wl->color_manager = wl_registry_bind(reg, id, &xx_color_manager_v4_interface, ver);
xx_color_manager_v4_add_listener(wl->color_manager, &color_manager_listener, wl);
}
if (!strcmp(interface, zxdg_decoration_manager_v1_interface.name) && found++) {
ver = 1;
wl->xdg_decoration_manager = wl_registry_bind(reg, id, &zxdg_decoration_manager_v1_interface, ver);
@ -2149,6 +2295,15 @@ static int handle_round(int scale, int n)
return (scale * n + WAYLAND_SCALE_FACTOR / 2) / WAYLAND_SCALE_FACTOR;
}
static void initialize_color_maps(struct vo_wayland_state *wl)
{
// -1 indicates unsupported
for (int i = 0; i < PL_COLOR_PRIM_COUNT; i++)
wl->primaries_map[i] = -1;
for (int i = 0; i < PL_COLOR_TRC_COUNT; i++)
wl->transfer_map[i] = -1;
}
static void prepare_resize(struct vo_wayland_state *wl)
{
int32_t width = mp_rect_w(wl->geometry) / wl->scaling_factor;
@ -2243,6 +2398,75 @@ static void remove_seat(struct vo_wayland_seat *seat)
return;
}
static void reset_color_management(struct vo_wayland_state *wl)
{
if (!wl->color_surface)
return;
if (wl->image_creator_params)
xx_image_description_creator_params_v4_destroy(wl->image_creator_params);
if (wl->image_description) {
xx_color_management_surface_v4_unset_image_description(wl->color_surface);
xx_image_description_v4_destroy(wl->image_description);
wl->image_description = NULL;
}
wl->image_creator_params = xx_color_manager_v4_new_parametric_creator(wl->color_manager);
wl->unsupported_colorspace = false;
}
static int set_colorspace(struct vo_wayland_state *wl)
{
struct pl_color_space color = wl->vo->target_params->color;
int xx_primaries = wl->primaries_map[color.primaries];
int xx_transfer = wl->transfer_map[color.transfer];
if (xx_primaries == -1)
MP_VERBOSE(wl, "Compositor does not support color primary: %s\n", pl_color_primaries_name(color.primaries));
if (xx_transfer == -1)
MP_VERBOSE(wl, "Compositor does not support transfer function: %s\n", pl_color_transfer_name(color.transfer));
if (xx_primaries == -1 || xx_transfer == -1) {
wl->unsupported_colorspace = true;
return -1;
}
xx_image_description_creator_params_v4_set_primaries_named(wl->image_creator_params, xx_primaries);
xx_image_description_creator_params_v4_set_tf_named(wl->image_creator_params, xx_transfer);
return 0;
}
static void set_color_management(struct vo_wayland_state *wl)
{
struct pl_color_space color = wl->vo->target_params->color;
if (!wl->color_surface || wl->unsupported_colorspace || pl_color_space_equal(&color, &wl->target_params.color))
return;
wl->target_params = *wl->vo->target_params;
reset_color_management(wl);
if (set_colorspace(wl))
return;
struct pl_hdr_metadata hdr = wl->vo->target_params->color.hdr;
if (wl->supports_display_primaries) {
xx_image_description_creator_params_v4_set_mastering_display_primaries(wl->image_creator_params,
hdr.prim.red.x * WAYLAND_COLOR_FACTOR, hdr.prim.red.y * WAYLAND_COLOR_FACTOR, hdr.prim.green.x * WAYLAND_COLOR_FACTOR,
hdr.prim.green.y * WAYLAND_COLOR_FACTOR, hdr.prim.blue.x * WAYLAND_COLOR_FACTOR, hdr.prim.blue.y * WAYLAND_COLOR_FACTOR,
hdr.prim.white.x * WAYLAND_COLOR_FACTOR, hdr.prim.white.y * WAYLAND_COLOR_FACTOR);
// No clear enum in the protocol to indicate if these are supposed
// to work or not so just hope they do if setting display
// primaries is supported.
xx_image_description_creator_params_v4_set_mastering_luminance(wl->image_creator_params, hdr.min_luma * WAYLAND_COLOR_FACTOR, hdr.max_luma);
xx_image_description_creator_params_v4_set_max_cll(wl->image_creator_params, hdr.max_cll);
xx_image_description_creator_params_v4_set_max_fall(wl->image_creator_params, hdr.max_fall);
}
wl->image_description = xx_image_description_creator_params_v4_create(wl->image_creator_params);
wl->image_creator_params = NULL;
xx_image_description_v4_add_listener(wl->image_description, &image_description_listener, wl);
}
static void set_content_type(struct vo_wayland_state *wl)
{
if (!wl->content_type_manager)
@ -2767,6 +2991,15 @@ int vo_wayland_control(struct vo *vo, int *events, int request, void *arg)
return VO_NOTIMPL;
}
void vo_wayland_handle_color(struct vo_wayland_state *wl)
{
if (!wl->vo->target_params)
return;
set_color_management(wl);
}
void vo_wayland_handle_scale(struct vo_wayland_state *wl)
{
wp_viewport_set_destination(wl->viewport, lround(mp_rect_w(wl->geometry) / wl->scaling_factor),
@ -2825,7 +3058,6 @@ bool vo_wayland_init(struct vo *vo)
.opts_cache = m_config_cache_alloc(wl, vo->global, &vo_sub_opts),
};
wl->opts = wl->opts_cache->opts;
bool using_dmabuf_wayland = !strcmp(wl->vo->driver->name, "dmabuf-wayland");
wl_list_init(&wl->output_list);
wl_list_init(&wl->seat_list);
@ -2879,6 +3111,14 @@ bool vo_wayland_init(struct vo *vo)
wl->video_subsurface = wl_subcompositor_get_subsurface(wl->subcompositor, wl->video_surface, wl->surface);
}
// Only bind to vo_dmabuf_wayland for now to avoid conflicting with VK_hdr_layer
if (wl->color_manager && !strcmp(wl->vo->driver->name, "dmabuf-wayland")) {
wl->color_surface = xx_color_manager_v4_get_surface(wl->color_manager, wl->callback_surface);
} else {
MP_VERBOSE(wl, "Compositor doesn't support the %s protocol!\n",
xx_color_manager_v4_interface.name);
}
if (wl->content_type_manager) {
wl->content_type = wp_content_type_manager_v1_get_surface_content_type(wl->content_type_manager, wl->surface);
} else {
@ -2954,7 +3194,6 @@ bool vo_wayland_init(struct vo *vo)
update_app_id(wl);
mp_make_wakeup_pipe(wl->wakeup_pipe);
wl->callback_surface = using_dmabuf_wayland ? wl->video_surface : wl->surface;
wl->frame_callback = wl_surface_frame(wl->callback_surface);
wl_callback_add_listener(wl->frame_callback, &frame_listener, wl);
wl_surface_commit(wl->surface);
@ -2963,6 +3202,15 @@ bool vo_wayland_init(struct vo *vo)
* before mpv does anything else. */
wl_display_roundtrip(wl->display);
// The compositor needs to at least support parametric otherwise
// the protocol is useless for us.
// TODO: Use the icc stuff.
if (wl->color_manager && !wl->supports_parametric) {
MP_VERBOSE(wl, "Compositor does not support parametic image descriptions!\n");
xx_color_management_surface_v4_destroy(wl->color_surface);
wl->color_surface = NULL;
}
return true;
err:
@ -2976,6 +3224,8 @@ bool vo_wayland_reconfig(struct vo *vo)
MP_VERBOSE(wl, "Reconfiguring!\n");
reset_color_management(wl);
if (!wl->current_output) {
wl->current_output = find_output(wl);
if (!wl->current_output)
@ -3060,6 +3310,18 @@ void vo_wayland_uninit(struct vo *vo)
if (wl->cursor_theme)
wl_cursor_theme_destroy(wl->cursor_theme);
if (wl->color_manager)
xx_color_manager_v4_destroy(wl->color_manager);
if (wl->color_surface)
xx_color_management_surface_v4_destroy(wl->color_surface);
if (wl->image_creator_params)
xx_image_description_creator_params_v4_destroy(wl->image_creator_params);
if (wl->image_description)
xx_image_description_v4_destroy(wl->image_description);
if (wl->content_type)
wp_content_type_v1_destroy(wl->content_type);

19
video/out/wayland_common.h
View File

@ -19,7 +19,9 @@
#define MPLAYER_WAYLAND_COMMON_H
#include <wayland-client.h>
#include "input/event.h"
#include "video/mp_image.h"
#include "vo.h"
struct compositor_format;
@ -85,6 +87,22 @@ struct vo_wayland_state {
int timeout_count;
int wakeup_pipe[2];
/* color-management */
struct xx_color_manager_v4 *color_manager;
struct xx_color_management_surface_v4 *color_surface;
struct xx_image_description_v4 *image_description;
struct xx_image_description_creator_params_v4 *image_creator_params;
struct mp_image_params target_params;
bool supports_icc;
bool supports_parametric;
bool supports_primaries;
bool supports_tf_power;
bool supports_luminances;
bool supports_display_primaries;
bool unsupported_colorspace;
int primaries_map[PL_COLOR_PRIM_COUNT];
int transfer_map[PL_COLOR_TRC_COUNT];
/* content-type */
struct wp_content_type_manager_v1 *content_type_manager;
struct wp_content_type_v1 *content_type;
@ -167,6 +185,7 @@ bool vo_wayland_reconfig(struct vo *vo);
int vo_wayland_allocate_memfd(struct vo *vo, size_t size);
int vo_wayland_control(struct vo *vo, int *events, int request, void *arg);
void vo_wayland_handle_color(struct vo_wayland_state *wl);
void vo_wayland_handle_scale(struct vo_wayland_state *wl);
void vo_wayland_set_opaque_region(struct vo_wayland_state *wl, bool alpha);
void vo_wayland_sync_swap(struct vo_wayland_state *wl);