Implement wlr-gamma-control-unstable-v1

backend/drm/atomic.c

@@ -199,14 +199,18 @@ static bool atomic_crtc_move_cursor(struct wlr_drm_backend *drm,
 static bool atomic_crtc_set_gamma(struct wlr_drm_backend *drm,
 		struct wlr_drm_crtc *crtc, uint16_t *r, uint16_t *g, uint16_t *b,
 		uint32_t size) {
-	struct drm_color_lut gamma[size];
-
 	// Fallback to legacy gamma interface when gamma properties are not available
 	// (can happen on older intel gpu's that support gamma but not degamma)
 	if (crtc->props.gamma_lut == 0) {
 		return legacy_iface.crtc_set_gamma(drm, crtc, r, g, b, size);
 	}
 
+	struct drm_color_lut *gamma = malloc(size * sizeof(struct drm_color_lut));
+	if (gamma == NULL) {
+		wlr_log(WLR_ERROR, "Failed to allocate gamma table");
+		return false;
+	}
+
 	for (uint32_t i = 0; i < size; i++) {
 		gamma[i].red = r[i];
 		gamma[i].green = g[i];
@@ -218,10 +222,12 @@ static bool atomic_crtc_set_gamma(struct wlr_drm_backend *drm,
 	}
 
 	if (drmModeCreatePropertyBlob(drm->fd, gamma,
-				sizeof(struct drm_color_lut) * size, &crtc->gamma_lut)) {
+			size * sizeof(struct drm_color_lut), &crtc->gamma_lut)) {
+		free(gamma);
 		wlr_log_errno(WLR_ERROR, "Unable to create property blob");
 		return false;
 	}
+	free(gamma);
 
 	struct atomic atom;
 	atomic_begin(crtc, &atom);

backend/drm/drm.c

@@ -228,19 +228,19 @@ static bool drm_connector_swap_buffers(struct wlr_output *output,
 	return true;
 }
 
-static void drm_connector_set_gamma(struct wlr_output *output,
+static bool drm_connector_set_gamma(struct wlr_output *output,
 		uint32_t size, uint16_t *r, uint16_t *g, uint16_t *b) {
 	struct wlr_drm_connector *conn = (struct wlr_drm_connector *)output;
 	struct wlr_drm_backend *drm = (struct wlr_drm_backend *)output->backend;
-	bool ok;
 
+	bool ok = false;
 	if (conn->crtc) {
 		ok = drm->iface->crtc_set_gamma(drm, conn->crtc, r, g, b, size);
 		if (ok) {
 			wlr_output_update_needs_swap(output);
 		}
 	}
-
+	return ok;
 }
 
 static uint32_t drm_connector_get_gamma_size(struct wlr_output *output) {

include/wlr/interfaces/wlr_output.h

@@ -28,7 +28,7 @@ struct wlr_output_impl {
 	void (*destroy)(struct wlr_output *output);
 	bool (*make_current)(struct wlr_output *output, int *buffer_age);
 	bool (*swap_buffers)(struct wlr_output *output, pixman_region32_t *damage);
-	void (*set_gamma)(struct wlr_output *output,
+	bool (*set_gamma)(struct wlr_output *output,
 		uint32_t size, uint16_t *r, uint16_t *g, uint16_t *b);
 	uint32_t (*get_gamma_size)(struct wlr_output *output);
 	bool (*export_dmabuf)(struct wlr_output *output,

include/wlr/types/wlr_gamma_control_v1.h

@@ -0,0 +1,31 @@
+#ifndef WLR_TYPES_WLR_GAMMA_CONTROL_V1_H
+#define WLR_TYPES_WLR_GAMMA_CONTROL_V1_H
+
+#include <wayland-server.h>
+
+struct wlr_gamma_control_manager_v1 {
+	struct wl_global *global;
+	struct wl_list resources;
+	struct wl_list controls; // wlr_gamma_control_v1::link
+
+	struct wl_listener display_destroy;
+
+	void *data;
+};
+
+struct wlr_gamma_control_v1 {
+	struct wl_resource *resource;
+	struct wlr_output *output;
+	struct wl_list link;
+
+	struct wl_listener output_destroy_listener;
+
+	void *data;
+};
+
+struct wlr_gamma_control_manager_v1 *wlr_gamma_control_manager_v1_create(
+	struct wl_display *display);
+void wlr_gamma_control_manager_v1_destroy(
+	struct wlr_gamma_control_manager_v1 *manager);
+
+#endif

include/wlr/types/wlr_output.h

@@ -174,7 +174,7 @@ bool wlr_output_swap_buffers(struct wlr_output *output, struct timespec *when,
  * it is a no-op.
  */
 void wlr_output_schedule_frame(struct wlr_output *output);
-void wlr_output_set_gamma(struct wlr_output *output,
+bool wlr_output_set_gamma(struct wlr_output *output,
 	uint32_t size, uint16_t *r, uint16_t *g, uint16_t *b);
 uint32_t wlr_output_get_gamma_size(struct wlr_output *output);
 bool wlr_output_export_dmabuf(struct wlr_output *output,

protocol/meson.build

@@ -42,6 +42,7 @@ protocols = [
 	'server-decoration.xml',
 	'virtual-keyboard-unstable-v1.xml',
 	'wlr-export-dmabuf-unstable-v1.xml',
+	'wlr-gamma-control-unstable-v1.xml',
 	'wlr-input-inhibitor-unstable-v1.xml',
 	'wlr-layer-shell-unstable-v1.xml',
 	'wlr-screencopy-unstable-v1.xml',

protocol/wlr-gamma-control-unstable-v1.xml

@@ -0,0 +1,126 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<protocol name="wlr_gamma_control_unstable_v1">
+  <copyright>
+    Copyright © 2015 Giulio camuffo
+    Copyright © 2018 Simon Ser
+
+    Permission to use, copy, modify, distribute, and sell this
+    software and its documentation for any purpose is hereby granted
+    without fee, provided that the above copyright notice appear in
+    all copies and that both that copyright notice and this permission
+    notice appear in supporting documentation, and that the name of
+    the copyright holders not be used in advertising or publicity
+    pertaining to distribution of the software without specific,
+    written prior permission.  The copyright holders make no
+    representations about the suitability of this software for any
+    purpose.  It is provided "as is" without express or implied
+    warranty.
+
+    THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
+    SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+    FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
+    SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+    WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
+    AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
+    ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+    THIS SOFTWARE.
+  </copyright>
+
+  <description summary="manage gamma tables of outputs">
+    This protocol allows a privileged client to set the gamma tables for
+    outputs.
+
+    Warning! The protocol described in this file is experimental and
+    backward incompatible changes may be made. Backward compatible changes
+    may be added together with the corresponding interface version bump.
+    Backward incompatible changes are done by bumping the version number in
+    the protocol and interface names and resetting the interface version.
+    Once the protocol is to be declared stable, the 'z' prefix and the
+    version number in the protocol and interface names are removed and the
+    interface version number is reset.
+  </description>
+
+  <interface name="zwlr_gamma_control_manager_v1" version="1">
+    <description summary="manager to create per-output gamma controls">
+      This interface is a manager that allows creating per-output gamma
+      controls.
+    </description>
+
+    <request name="get_gamma_control">
+      <description summary="get a gamma control for an output">
+        Create a gamma control that can be used to adjust gamma tables for the
+        provided output.
+      </description>
+      <arg name="id" type="new_id" interface="zwlr_gamma_control_v1"/>
+      <arg name="output" type="object" interface="wl_output"/>
+    </request>
+
+    <request name="destroy" type="destructor">
+      <description summary="destroy the manager">
+        All objects created by the manager will still remain valid, until their
+        appropriate destroy request has been called.
+      </description>
+    </request>
+  </interface>
+
+  <interface name="zwlr_gamma_control_v1" version="1">
+    <description summary="adjust gamma tables for an output">
+      This interface allows a client to adjust gamma tables for a particular
+      output.
+
+      The client will receive the gamma size, and will then be able to set gamma
+      tables. At any time the compositor can send a failed event indicating that
+      this object is no longer valid.
+
+      There must always be at most one gamma control object per output, which
+      has exclusive access to this particular output. When the gamma control
+      object is destroyed, the gamma table is restored to its original value.
+    </description>
+
+    <event name="gamma_size">
+      <description summary="size of gamma ramps">
+        Advertise the size of each gamma ramp.
+
+        This event is sent immediately when the gamma control object is created.
+      </description>
+      <arg name="size" type="uint" summary="number of elements in a ramp"/>
+    </event>
+
+    <enum name="error">
+      <entry name="invalid_gamma" value="1" summary="invalid gamma tables"/>
+    </enum>
+
+    <request name="set_gamma">
+      <description summary="set the gamma table">
+        Set the gamma table. The file descriptor can be memory-mapped to provide
+        the raw gamma table, which contains successive gamma ramps for the red,
+        green and blue channels. Each gamma ramp is an array of 16-byte unsigned
+        integers which has the same length as the gamma size.
+
+        The file descriptor data must have the same length as three times the
+        gamma size.
+      </description>
+      <arg name="fd" type="fd" summary="gamma table file descriptor"/>
+    </request>
+
+    <event name="failed">
+      <description summary="object no longer valid">
+        This event indicates that the gamma control is no longer valid. This
+        can happen for a number of reasons, including:
+        - The output doesn't support gamma tables
+        - Setting the gamma tables failed
+        - Another client already has exclusive gamma control for this output
+        - The compositor has transfered gamma control to another client
+
+        Upon receiving this event, the client should destroy this object.
+      </description>
+    </event>
+
+    <request name="destroy" type="destructor">
+      <description summary="destroy this control">
+        Destroys the gamma control object. If the object is still valid, this
+        restores the original gamma tables.
+      </description>
+    </request>
+  </interface>
+</protocol>

types/meson.build

@@ -25,6 +25,7 @@ lib_wlr_types = static_library(
 		'wlr_cursor.c',
 		'wlr_export_dmabuf_v1.c',
 		'wlr_gamma_control.c',
+		'wlr_gamma_control_v1.c',
 		'wlr_idle_inhibit_v1.c',
 		'wlr_idle.c',
 		'wlr_input_device.c',

types/wlr_gamma_control.c

@@ -25,7 +25,7 @@ static void gamma_control_destroy(struct wlr_gamma_control *gamma_control) {
 
 static const struct gamma_control_interface gamma_control_impl;
 
-struct wlr_gamma_control *gamma_control_from_resource(
+static struct wlr_gamma_control *gamma_control_from_resource(
 		struct wl_resource *resource) {
 	assert(wl_resource_instance_of(resource, &gamma_control_interface,
 		&gamma_control_impl));
@@ -83,7 +83,7 @@ static const struct gamma_control_interface gamma_control_impl = {
 
 static const struct gamma_control_manager_interface gamma_control_manager_impl;
 
-struct wlr_gamma_control_manager *gamma_control_manager_from_resource(
+static struct wlr_gamma_control_manager *gamma_control_manager_from_resource(
 		struct wl_resource *resource) {
 	assert(wl_resource_instance_of(resource, &gamma_control_manager_interface,
 		&gamma_control_manager_impl));

types/wlr_gamma_control_v1.c

@@ -0,0 +1,244 @@
+#include <assert.h>
+#include <stdlib.h>
+#include <unistd.h>
+#include <wayland-server.h>
+#include <wlr/types/wlr_gamma_control_v1.h>
+#include <wlr/types/wlr_output.h>
+#include <wlr/interfaces/wlr_output.h>
+#include <wlr/util/log.h>
+#include "wlr-gamma-control-unstable-v1-protocol.h"
+#include "util/signal.h"
+
+#define GAMMA_CONTROL_MANAGER_V1_VERSION 1
+
+static void gamma_control_handle_destroy(struct wl_client *client,
+		struct wl_resource *resource) {
+	wl_resource_destroy(resource);
+}
+
+static void gamma_control_destroy(struct wlr_gamma_control_v1 *gamma_control) {
+	if (gamma_control == NULL) {
+		return;
+	}
+	// TODO: reset gamma table
+	wl_resource_set_user_data(gamma_control->resource, NULL);
+	wl_list_remove(&gamma_control->output_destroy_listener.link);
+	wl_list_remove(&gamma_control->link);
+	free(gamma_control);
+}
+
+static const struct zwlr_gamma_control_v1_interface gamma_control_impl;
+
+static struct wlr_gamma_control_v1 *gamma_control_from_resource(
+		struct wl_resource *resource) {
+	assert(wl_resource_instance_of(resource, &zwlr_gamma_control_v1_interface,
+		&gamma_control_impl));
+	return wl_resource_get_user_data(resource);
+}
+
+static void gamma_control_handle_resource_destroy(struct wl_resource *resource) {
+	struct wlr_gamma_control_v1 *gamma_control =
+		gamma_control_from_resource(resource);
+	gamma_control_destroy(gamma_control);
+}
+
+static void gamma_control_handle_output_destroy(struct wl_listener *listener,
+		void *data) {
+	struct wlr_gamma_control_v1 *gamma_control =
+		wl_container_of(listener, gamma_control, output_destroy_listener);
+	gamma_control_destroy(gamma_control);
+}
+
+static void gamma_control_handle_set_gamma(struct wl_client *client,
+		struct wl_resource *gamma_control_resource, int fd) {
+	struct wlr_gamma_control_v1 *gamma_control =
+		gamma_control_from_resource(gamma_control_resource);
+	if (gamma_control == NULL) {
+		close(fd);
+		return;
+	}
+
+	uint32_t ramp_size = wlr_output_get_gamma_size(gamma_control->output);
+	size_t table_size = ramp_size * 3 * sizeof(uint16_t);
+
+	off_t fd_size = lseek(fd, 0, SEEK_END);
+	// Skip checks if kernel does no support seek on buffer
+	if (fd_size != -1 && (size_t)fd_size != table_size) {
+		close(fd);
+		wl_resource_post_error(gamma_control_resource,
+			ZWLR_GAMMA_CONTROL_V1_ERROR_INVALID_GAMMA,
+			"The gamma ramps don't have the correct size");
+		return;
+	}
+	lseek(fd, 0, SEEK_SET);
+
+	// Use the heap since gamma tables can be large
+	uint16_t *table = malloc(table_size);
+	if (table == NULL) {
+		close(fd);
+		wl_resource_post_no_memory(gamma_control_resource);
+		return;
+	}
+
+	ssize_t n_read = read(fd, table, table_size);
+	close(fd);
+	if (n_read == -1 || (size_t)n_read != table_size) {
+		free(table);
+		zwlr_gamma_control_v1_send_failed(gamma_control->resource);
+		gamma_control_destroy(gamma_control);
+		return;
+	}
+
+	uint16_t *r = table;
+	uint16_t *g = table + ramp_size;
+	uint16_t *b = table + 2 * ramp_size;
+
+	bool ok = wlr_output_set_gamma(gamma_control->output, ramp_size, r, g, b);
+	free(table);
+	if (!ok) {
+		zwlr_gamma_control_v1_send_failed(gamma_control->resource);
+		gamma_control_destroy(gamma_control);
+		return;
+	}
+}
+
+static const struct zwlr_gamma_control_v1_interface gamma_control_impl = {
+	.destroy = gamma_control_handle_destroy,
+	.set_gamma = gamma_control_handle_set_gamma,
+};
+
+static const struct zwlr_gamma_control_manager_v1_interface
+	gamma_control_manager_impl;
+
+static struct wlr_gamma_control_manager_v1 *gamma_control_manager_from_resource(
+		struct wl_resource *resource) {
+	assert(wl_resource_instance_of(resource,
+		&zwlr_gamma_control_manager_v1_interface, &gamma_control_manager_impl));
+	return wl_resource_get_user_data(resource);
+}
+
+static void gamma_control_manager_get_gamma_control(struct wl_client *client,
+		struct wl_resource *manager_resource, uint32_t id,
+		struct wl_resource *output_resource) {
+	struct wlr_gamma_control_manager_v1 *manager =
+		gamma_control_manager_from_resource(manager_resource);
+	struct wlr_output *output = wlr_output_from_resource(output_resource);
+
+	struct wlr_gamma_control_v1 *gamma_control =
+		calloc(1, sizeof(struct wlr_gamma_control_v1));
+	if (gamma_control == NULL) {
+		wl_client_post_no_memory(client);
+		return;
+	}
+	gamma_control->output = output;
+
+	uint32_t version = wl_resource_get_version(manager_resource);
+	gamma_control->resource = wl_resource_create(client,
+		&zwlr_gamma_control_v1_interface, version, id);
+	if (gamma_control->resource == NULL) {
+		free(gamma_control);
+		wl_client_post_no_memory(client);
+		return;
+	}
+	wl_resource_set_implementation(gamma_control->resource, &gamma_control_impl,
+		gamma_control, gamma_control_handle_resource_destroy);
+
+	wl_signal_add(&output->events.destroy,
+		&gamma_control->output_destroy_listener);
+	gamma_control->output_destroy_listener.notify =
+		gamma_control_handle_output_destroy;
+
+	wl_list_insert(&manager->controls, &gamma_control->link);
+
+	if (!output->impl->set_gamma) {
+		zwlr_gamma_control_v1_send_failed(gamma_control->resource);
+		gamma_control_destroy(gamma_control);
+		return;
+	}
+
+	struct wlr_gamma_control_v1 *gc;
+	wl_list_for_each(gc, &manager->controls, link) {
+		if (gc->output == output) {
+			zwlr_gamma_control_v1_send_failed(gc->resource);
+			gamma_control_destroy(gc);
+			return;
+		}
+	}
+
+	zwlr_gamma_control_v1_send_gamma_size(gamma_control->resource,
+		wlr_output_get_gamma_size(output));
+}
+
+static const struct zwlr_gamma_control_manager_v1_interface
+		gamma_control_manager_impl = {
+	.get_gamma_control = gamma_control_manager_get_gamma_control,
+};
+
+static void gamma_control_manager_handle_resource_destroy(
+		struct wl_resource *resource) {
+	wl_list_remove(wl_resource_get_link(resource));
+}
+
+static void gamma_control_manager_bind(struct wl_client *client, void *data,
+		uint32_t version, uint32_t id) {
+	struct wlr_gamma_control_manager_v1 *manager = data;
+
+	struct wl_resource *resource = wl_resource_create(client,
+		&zwlr_gamma_control_manager_v1_interface, version, id);
+	if (resource == NULL) {
+		wl_client_post_no_memory(client);
+		return;
+	}
+	wl_resource_set_implementation(resource, &gamma_control_manager_impl,
+		manager, gamma_control_manager_handle_resource_destroy);
+	wl_list_insert(&manager->resources, wl_resource_get_link(resource));
+}
+
+void wlr_gamma_control_manager_v1_destroy(
+		struct wlr_gamma_control_manager_v1 *manager) {
+	if (!manager) {
+		return;
+	}
+	wl_list_remove(&manager->display_destroy.link);
+	struct wlr_gamma_control_v1 *gamma_control, *tmp;
+	wl_list_for_each_safe(gamma_control, tmp, &manager->controls, link) {
+		wl_resource_destroy(gamma_control->resource);
+	}
+	struct wl_resource *resource, *resource_tmp;
+	wl_resource_for_each_safe(resource, resource_tmp, &manager->resources) {
+		wl_resource_destroy(resource);
+	}
+	wl_global_destroy(manager->global);
+	free(manager);
+}
+
+static void handle_display_destroy(struct wl_listener *listener, void *data) {
+	struct wlr_gamma_control_manager_v1 *manager =
+		wl_container_of(listener, manager, display_destroy);
+	wlr_gamma_control_manager_v1_destroy(manager);
+}
+
+struct wlr_gamma_control_manager_v1 *wlr_gamma_control_manager_v1_create(
+		struct wl_display *display) {
+	struct wlr_gamma_control_manager_v1 *manager =
+		calloc(1, sizeof(struct wlr_gamma_control_manager_v1));
+	if (!manager) {
+		return NULL;
+	}
+
+	manager->global = wl_global_create(display,
+		&zwlr_gamma_control_manager_v1_interface,
+		GAMMA_CONTROL_MANAGER_V1_VERSION, manager, gamma_control_manager_bind);
+	if (manager->global == NULL) {
+		free(manager);
+		return NULL;
+	}
+
+	wl_list_init(&manager->resources);
+	wl_list_init(&manager->controls);
+
+	manager->display_destroy.notify = handle_display_destroy;
+	wl_display_add_destroy_listener(display, &manager->display_destroy);
+
+	return manager;
+}

types/wlr_output.c

@@ -552,11 +552,12 @@ void wlr_output_schedule_frame(struct wlr_output *output) {
 		wl_event_loop_add_idle(ev, schedule_frame_handle_idle_timer, output);
 }
 
-void wlr_output_set_gamma(struct wlr_output *output,
-	uint32_t size, uint16_t *r, uint16_t *g, uint16_t *b) {
-	if (output->impl->set_gamma) {
-		output->impl->set_gamma(output, size, r, g, b);
+bool wlr_output_set_gamma(struct wlr_output *output, uint32_t size,
+		uint16_t *r, uint16_t *g, uint16_t *b) {
+	if (!output->impl->set_gamma) {
+		return false;
 	}
+	return output->impl->set_gamma(output, size, r, g, b);
 }
 
 uint32_t wlr_output_get_gamma_size(struct wlr_output *output) {