presentation-time: add protocol implementation

5 files changed, 297 insertions, 16 deletions

diff --git a/include/wlr/types/meson.build b/include/wlr/types/meson.build
index 6a8955c3..7a02c3da 100644
--- a/include/wlr/types/meson.build
+++ b/include/wlr/types/meson.build
@@ -5,10 +5,10 @@ install_headers(
 	'wlr_cursor.h',
 	'wlr_data_device.h',
 	'wlr_export_dmabuf_v1.h',
-	'wlr_gamma_control.h',
 	'wlr_gamma_control_v1.h',
-	'wlr_idle.h',
+	'wlr_gamma_control.h',
 	'wlr_idle_inhibit_v1.h',
+	'wlr_idle.h',
 	'wlr_input_device.h',
 	'wlr_input_inhibitor.h',
 	'wlr_keyboard.h',
@@ -16,10 +16,11 @@ install_headers(
 	'wlr_linux_dmabuf_v1.h',
 	'wlr_list.h',
 	'wlr_matrix.h',
-	'wlr_output.h',
 	'wlr_output_damage.h',
 	'wlr_output_layout.h',
+	'wlr_output.h',
 	'wlr_pointer.h',
+	'wlr_presentation_time.h',
 	'wlr_primary_selection.h',
 	'wlr_region.h',
 	'wlr_screencopy_v1.h',
@@ -36,7 +37,7 @@ install_headers(
 	'wlr_xcursor_manager.h',
 	'wlr_xdg_decoration_v1.h',
 	'wlr_xdg_output_v1.h',
-	'wlr_xdg_shell.h',
 	'wlr_xdg_shell_v6.h',
+	'wlr_xdg_shell.h',
 	subdir: 'wlr/types',
 )
diff --git a/include/wlr/types/wlr_presentation_time.h b/include/wlr/types/wlr_presentation_time.h
new file mode 100644
index 00000000..71bf5977
--- /dev/null
+++ b/include/wlr/types/wlr_presentation_time.h
@@ -0,0 +1,56 @@
+/*
+ * This an unstable interface of wlroots. No guarantees are made regarding the
+ * future consistency of this API.
+ */
+#ifndef WLR_USE_UNSTABLE
+#error "Add -DWLR_USE_UNSTABLE to enable unstable wlroots features"
+#endif
+
+#ifndef WLR_TYPES_WLR_PRESENTATION_TIME_H
+#define WLR_TYPES_WLR_PRESENTATION_TIME_H
+
+#include <stdbool.h>
+#include <stddef.h>
+#include <time.h>
+#include <wayland-server.h>
+
+struct wlr_presentation {
+	struct wl_global *global;
+	struct wl_list resources; // wl_resource_get_link
+	struct wl_list feedbacks; // wlr_presentation_feedback::link
+	clockid_t clock;
+
+	struct {
+		struct wl_signal destroy;
+	} events;
+
+	struct wl_listener display_destroy;
+};
+
+struct wlr_presentation_feedback {
+	struct wl_resource *resource;
+	struct wlr_presentation *presentation;
+	struct wlr_surface *surface;
+	bool committed;
+	struct wl_list link; // wlr_presentation::feedbacks
+
+	struct wl_listener surface_commit;
+	struct wl_listener surface_destroy;
+};
+
+struct wlr_presentation_event {
+	struct wlr_output *output;
+	uint64_t tv_sec;
+	uint32_t tv_nsec;
+	uint32_t refresh;
+	uint64_t seq;
+	uint32_t flags; // wp_presentation_feedback_kind
+};
+
+struct wlr_presentation *wlr_presentation_create(struct wl_display *display);
+void wlr_presentation_destroy(struct wlr_presentation *presentation);
+void wlr_presentation_send_surface_presented(
+	struct wlr_presentation *presentation, struct wlr_surface *surface,
+	struct wlr_presentation_event *event);
+
+#endif
diff --git a/protocol/meson.build b/protocol/meson.build
index e03b88e8..82131ff6 100644
--- a/protocol/meson.build
+++ b/protocol/meson.build
@@ -11,6 +11,7 @@ else
 endif
 
 protocols = [
+	[wl_protocol_dir, 'stable/presentation-time/presentation-time.xml'],
 	[wl_protocol_dir, 'stable/xdg-shell/xdg-shell.xml'],
 	[wl_protocol_dir, 'unstable/idle-inhibit/idle-inhibit-unstable-v1.xml'],
 	[wl_protocol_dir, 'unstable/linux-dmabuf/linux-dmabuf-unstable-v1.xml'],
diff --git a/types/meson.build b/types/meson.build
index 038f7de4..9e2e74a8 100644
--- a/types/meson.build
+++ b/types/meson.build
@@ -9,23 +9,27 @@ lib_wlr_types = static_library(
 		'seat/wlr_seat_pointer.c',
 		'seat/wlr_seat_touch.c',
 		'seat/wlr_seat.c',
-		'xdg_shell/wlr_xdg_popup.c',
-		'xdg_shell/wlr_xdg_positioner.c',
-		'xdg_shell/wlr_xdg_shell.c',
-		'xdg_shell/wlr_xdg_surface.c',
-		'xdg_shell/wlr_xdg_toplevel.c',
+		'tablet_v2/wlr_tablet_v2_pad.c',
+		'tablet_v2/wlr_tablet_v2_tablet.c',
+		'tablet_v2/wlr_tablet_v2_tool.c',
+		'tablet_v2/wlr_tablet_v2.c',
 		'xdg_shell_v6/wlr_xdg_popup_v6.c',
 		'xdg_shell_v6/wlr_xdg_positioner_v6.c',
 		'xdg_shell_v6/wlr_xdg_shell_v6.c',
 		'xdg_shell_v6/wlr_xdg_surface_v6.c',
 		'xdg_shell_v6/wlr_xdg_toplevel_v6.c',
+		'xdg_shell/wlr_xdg_popup.c',
+		'xdg_shell/wlr_xdg_positioner.c',
+		'xdg_shell/wlr_xdg_shell.c',
+		'xdg_shell/wlr_xdg_surface.c',
+		'xdg_shell/wlr_xdg_toplevel.c',
 		'wlr_box.c',
 		'wlr_buffer.c',
 		'wlr_compositor.c',
 		'wlr_cursor.c',
 		'wlr_export_dmabuf_v1.c',
-		'wlr_gamma_control.c',
 		'wlr_gamma_control_v1.c',
+		'wlr_gamma_control.c',
 		'wlr_idle_inhibit_v1.c',
 		'wlr_idle.c',
 		'wlr_input_device.c',
@@ -38,17 +42,15 @@ lib_wlr_types = static_library(
 		'wlr_output_damage.c',
 		'wlr_output_layout.c',
 		'wlr_output.c',
-		'wlr_pointer.c',
 		'wlr_pointer_constraints_v1.c',
+		'wlr_pointer.c',
+		'wlr_presentation_time.c',
 		'wlr_primary_selection.c',
 		'wlr_region.c',
+		'wlr_screencopy_v1.c',
 		'wlr_screenshooter.c',
 		'wlr_server_decoration.c',
 		'wlr_surface.c',
-		'tablet_v2/wlr_tablet_v2.c',
-		'tablet_v2/wlr_tablet_v2_pad.c',
-		'tablet_v2/wlr_tablet_v2_tablet.c',
-		'tablet_v2/wlr_tablet_v2_tool.c',
 		'wlr_tablet_pad.c',
 		'wlr_tablet_tool.c',
 		'wlr_touch.c',
@@ -57,7 +59,6 @@ lib_wlr_types = static_library(
 		'wlr_xcursor_manager.c',
 		'wlr_xdg_decoration_v1.c',
 		'wlr_xdg_output_v1.c',
-		'wlr_screencopy_v1.c',
 	),
 	include_directories: wlr_inc,
 	dependencies: [pixman, xkbcommon, wayland_server, wlr_protos, libinput],
diff --git a/types/wlr_presentation_time.c b/types/wlr_presentation_time.c
new file mode 100644
index 00000000..710aa4b9
--- /dev/null
+++ b/types/wlr_presentation_time.c
@@ -0,0 +1,222 @@
+#define _POSIX_C_SOURCE 199309L
+#include <assert.h>
+#include <stdlib.h>
+#include <wlr/types/wlr_presentation_time.h>
+#include <wlr/types/wlr_surface.h>
+#include "presentation-time-protocol.h"
+#include "util/signal.h"
+
+#define PRESENTATION_VERSION 1
+
+static struct wlr_presentation_feedback *presentation_feedback_from_resource(
+		struct wl_resource *resource) {
+	assert(wl_resource_instance_of(resource,
+		&wp_presentation_feedback_interface, NULL));
+	return wl_resource_get_user_data(resource);
+}
+
+static void feedback_handle_resource_destroy(struct wl_resource *resource) {
+	struct wlr_presentation_feedback *feedback =
+		presentation_feedback_from_resource(resource);
+	wl_list_remove(&feedback->surface_commit.link);
+	wl_list_remove(&feedback->surface_destroy.link);
+	wl_list_remove(&feedback->link);
+	free(feedback);
+}
+
+// Destroys the feedback
+static void feedback_send_presented(struct wlr_presentation_feedback *feedback,
+		struct wlr_presentation_event *event) {
+	struct wl_client *client = wl_resource_get_client(feedback->resource);
+	struct wl_resource *resource;
+	wl_resource_for_each(resource, &event->output->resources) {
+		if (wl_resource_get_client(resource) == client) {
+			wp_presentation_feedback_send_sync_output(feedback->resource,
+				resource);
+		}
+	}
+
+	uint32_t tv_sec_hi = event->tv_sec >> 32;
+	uint32_t tv_sec_lo = event->tv_sec & 0xFFFFFFFF;
+	uint32_t seq_hi = event->seq >> 32;
+	uint32_t seq_lo = event->seq & 0xFFFFFFFF;
+	wp_presentation_feedback_send_presented(feedback->resource,
+		tv_sec_hi, tv_sec_lo, event->tv_nsec, event->refresh, seq_hi, seq_lo,
+		event->flags);
+
+	wl_resource_destroy(feedback->resource);
+}
+
+// Destroys the feedback
+static void feedback_send_discarded(
+		struct wlr_presentation_feedback *feedback) {
+	wp_presentation_feedback_send_discarded(feedback->resource);
+	wl_resource_destroy(feedback->resource);
+}
+
+static void feedback_handle_surface_commit(struct wl_listener *listener,
+		void *data) {
+	struct wlr_presentation_feedback *feedback =
+		wl_container_of(listener, feedback, surface_commit);
+
+	if (feedback->committed) {
+		// The content update has been superseded
+		feedback_send_discarded(feedback);
+	} else {
+		feedback->committed = true;
+	}
+}
+
+static void feedback_handle_surface_destroy(struct wl_listener *listener,
+		void *data) {
+	struct wlr_presentation_feedback *feedback =
+		wl_container_of(listener, feedback, surface_destroy);
+	feedback_send_discarded(feedback);
+}
+
+static const struct wp_presentation_interface presentation_impl;
+
+static struct wlr_presentation *presentation_from_resource(
+		struct wl_resource *resource) {
+	assert(wl_resource_instance_of(resource, &wp_presentation_interface,
+		&presentation_impl));
+	return wl_resource_get_user_data(resource);
+}
+
+static void presentation_handle_feedback(struct wl_client *client,
+		struct wl_resource *resource, struct wl_resource *surface_resource,
+		uint32_t id) {
+	struct wlr_presentation *presentation =
+		presentation_from_resource(resource);
+	struct wlr_surface *surface = wlr_surface_from_resource(surface_resource);
+
+	struct wlr_presentation_feedback *feedback =
+		calloc(1, sizeof(struct wlr_presentation_feedback));
+	if (feedback == NULL) {
+		wl_client_post_no_memory(client);
+		return;
+	}
+
+	uint32_t version = wl_resource_get_version(resource);
+	feedback->resource = wl_resource_create(client,
+		&wp_presentation_feedback_interface, version, id);
+	if (feedback->resource == NULL) {
+		free(feedback);
+		wl_client_post_no_memory(client);
+		return;
+	}
+	wl_resource_set_implementation(feedback->resource, NULL, feedback,
+		feedback_handle_resource_destroy);
+
+	feedback->surface = surface;
+
+	feedback->surface_commit.notify = feedback_handle_surface_commit;
+	wl_signal_add(&surface->events.commit, &feedback->surface_commit);
+
+	feedback->surface_destroy.notify = feedback_handle_surface_destroy;
+	wl_signal_add(&surface->events.destroy, &feedback->surface_destroy);
+
+	wl_list_insert(&presentation->feedbacks, &feedback->link);
+}
+
+static void presentation_handle_destroy(struct wl_client *client,
+		struct wl_resource *resource) {
+	wl_resource_destroy(resource);
+}
+
+static const struct wp_presentation_interface presentation_impl = {
+	.feedback = presentation_handle_feedback,
+	.destroy = presentation_handle_destroy,
+};
+
+static void presentation_handle_resource_destroy(struct wl_resource *resource) {
+	wl_list_remove(wl_resource_get_link(resource));
+}
+
+static void presentation_bind(struct wl_client *client, void *data,
+		uint32_t version, uint32_t id) {
+	struct wlr_presentation *presentation = data;
+
+	struct wl_resource *resource = wl_resource_create(client,
+		&wp_presentation_interface, version, id);
+	if (resource == NULL) {
+		wl_client_post_no_memory(client);
+		return;
+	}
+	wl_resource_set_implementation(resource, &presentation_impl, presentation,
+		presentation_handle_resource_destroy);
+	wl_list_insert(&presentation->resources, wl_resource_get_link(resource));
+
+	wp_presentation_send_clock_id(resource, presentation->clock);
+}
+
+static void handle_display_destroy(struct wl_listener *listener, void *data) {
+	struct wlr_presentation *presentation =
+		wl_container_of(listener, presentation, display_destroy);
+	wlr_presentation_destroy(presentation);
+}
+
+struct wlr_presentation *wlr_presentation_create(struct wl_display *display) {
+	struct wlr_presentation *presentation =
+		calloc(1, sizeof(struct wlr_presentation));
+	if (presentation == NULL) {
+		return NULL;
+	}
+
+	presentation->global = wl_global_create(display, &wp_presentation_interface,
+		PRESENTATION_VERSION, presentation, presentation_bind);
+	if (presentation->global == NULL) {
+		free(presentation);
+		return NULL;
+	}
+
+	// TODO: get clock from backend
+	presentation->clock = CLOCK_MONOTONIC;
+
+	wl_list_init(&presentation->resources);
+	wl_list_init(&presentation->feedbacks);
+	wl_signal_init(&presentation->events.destroy);
+
+	presentation->display_destroy.notify = handle_display_destroy;
+	wl_display_add_destroy_listener(display, &presentation->display_destroy);
+
+	return presentation;
+}
+
+void wlr_presentation_destroy(struct wlr_presentation *presentation) {
+	if (presentation == NULL) {
+		return;
+	}
+
+	wlr_signal_emit_safe(&presentation->events.destroy, presentation);
+
+	wl_global_destroy(presentation->global);
+
+	struct wlr_presentation_feedback *feedback, *feedback_tmp;
+	wl_list_for_each_safe(feedback, feedback_tmp, &presentation->feedbacks,
+			link) {
+		wl_resource_destroy(feedback->resource);
+	}
+
+	struct wl_resource *resource, *resource_tmp;
+	wl_resource_for_each_safe(resource, resource_tmp,
+			&presentation->resources) {
+		wl_resource_destroy(resource);
+	}
+
+	wl_list_remove(&presentation->display_destroy.link);
+	free(presentation);
+}
+
+void wlr_presentation_send_surface_presented(
+		struct wlr_presentation *presentation, struct wlr_surface *surface,
+		struct wlr_presentation_event *event) {
+	// TODO: maybe use a hashtable to optimize this function
+	struct wlr_presentation_feedback *feedback, *feedback_tmp;
+	wl_list_for_each_safe(feedback, feedback_tmp,
+			&presentation->feedbacks, link) {
+		if (feedback->surface == surface && feedback->committed) {
+			feedback_send_presented(feedback, event);
+		}
+	}
+}