Implement tablet pads

backend/CMakeLists.txt

@@ -20,6 +20,7 @@ add_library(wlr-backend
     libinput/pointer.c
     libinput/touch.c
     libinput/tablet_tool.c
+    libinput/tablet_pad.c
 
     multi/backend.c
     backend.c

backend/libinput/events.c

@@ -91,7 +91,10 @@ static void handle_device_added(struct wlr_backend_state *state,
 		wl_signal_emit(&state->backend->events.input_add, wlr_device);
 	}
 	if (libinput_device_has_capability(device, LIBINPUT_DEVICE_CAP_TABLET_PAD)) {
-		// TODO
+		struct wlr_input_device *wlr_device = allocate_device(state,
+				device, devices, WLR_INPUT_DEVICE_TABLET_PAD);
+		wlr_device->tablet_pad = wlr_libinput_tablet_pad_create(device);
+		wl_signal_emit(&state->backend->events.input_add, wlr_device);
 	}
 	if (libinput_device_has_capability(device, LIBINPUT_DEVICE_CAP_GESTURE)) {
 		// TODO
@@ -169,6 +172,15 @@ void wlr_libinput_event(struct wlr_backend_state *state,
 	case LIBINPUT_EVENT_TABLET_TOOL_BUTTON:
 		handle_tablet_tool_button(event, device);
 		break;
+	case LIBINPUT_EVENT_TABLET_PAD_BUTTON:
+		handle_tablet_pad_button(event, device);
+		break;
+	case LIBINPUT_EVENT_TABLET_PAD_RING:
+		handle_tablet_pad_ring(event, device);
+		break;
+	case LIBINPUT_EVENT_TABLET_PAD_STRIP:
+		handle_tablet_pad_strip(event, device);
+		break;
 	default:
 		wlr_log(L_DEBUG, "Unknown libinput event %d", event_type);
 		break;

backend/libinput/tablet_pad.c

@@ -0,0 +1,95 @@
+#include <stdlib.h>
+#include <assert.h>
+#include <libinput.h>
+#include <wlr/session.h>
+#include <wlr/types.h>
+#include <wlr/common/list.h>
+#include "backend/libinput.h"
+#include "common/log.h"
+#include "types.h"
+
+struct wlr_tablet_pad *wlr_libinput_tablet_pad_create(
+		struct libinput_device *device) {
+	assert(device);
+	return wlr_tablet_pad_create(NULL, NULL);
+}
+
+void handle_tablet_pad_button(struct libinput_event *event,
+		struct libinput_device *device) {
+	struct wlr_input_device *dev =
+		get_appropriate_device(WLR_INPUT_DEVICE_TABLET_PAD, device);
+	if (!dev) {
+		wlr_log(L_DEBUG, "Got a tablet pad event for a device with no tablet pad?");
+		return;
+	}
+	struct libinput_event_tablet_pad *pevent =
+		libinput_event_get_tablet_pad_event(event);
+	struct wlr_tablet_pad_button *wlr_event =
+		calloc(1, sizeof(struct wlr_tablet_pad_button));
+	wlr_event->time_sec = libinput_event_tablet_pad_get_time(pevent);
+	wlr_event->time_usec = libinput_event_tablet_pad_get_time_usec(pevent);
+	wlr_event->button = libinput_event_tablet_pad_get_button_number(pevent);
+	switch (libinput_event_tablet_pad_get_button_state(pevent)) {
+	case LIBINPUT_BUTTON_STATE_PRESSED:
+		wlr_event->state = WLR_BUTTON_PRESSED;
+		break;
+	case LIBINPUT_BUTTON_STATE_RELEASED:
+		wlr_event->state = WLR_BUTTON_RELEASED;
+		break;
+	}
+	wl_signal_emit(&dev->tablet_pad->events.button, wlr_event);
+}
+
+void handle_tablet_pad_ring(struct libinput_event *event,
+		struct libinput_device *device) {
+	struct wlr_input_device *dev =
+		get_appropriate_device(WLR_INPUT_DEVICE_TABLET_PAD, device);
+	if (!dev) {
+		wlr_log(L_DEBUG, "Got a tablet pad event for a device with no tablet pad?");
+		return;
+	}
+	struct libinput_event_tablet_pad *pevent =
+		libinput_event_get_tablet_pad_event(event);
+	struct wlr_tablet_pad_ring *wlr_event =
+		calloc(1, sizeof(struct wlr_tablet_pad_ring));
+	wlr_event->time_sec = libinput_event_tablet_pad_get_time(pevent);
+	wlr_event->time_usec = libinput_event_tablet_pad_get_time_usec(pevent);
+	wlr_event->ring = libinput_event_tablet_pad_get_ring_number(pevent);
+	wlr_event->position = libinput_event_tablet_pad_get_ring_position(pevent);
+	switch (libinput_event_tablet_pad_get_ring_source(pevent)) {
+	case LIBINPUT_TABLET_PAD_RING_SOURCE_UNKNOWN:
+		wlr_event->source = WLR_TABLET_PAD_RING_SOURCE_UNKNOWN;
+		break;
+	case LIBINPUT_TABLET_PAD_RING_SOURCE_FINGER:
+		wlr_event->source = WLR_TABLET_PAD_RING_SOURCE_FINGER;
+		break;
+	}
+	wl_signal_emit(&dev->tablet_pad->events.ring, wlr_event);
+}
+
+void handle_tablet_pad_strip(struct libinput_event *event,
+		struct libinput_device *device) {
+	struct wlr_input_device *dev =
+		get_appropriate_device(WLR_INPUT_DEVICE_TABLET_PAD, device);
+	if (!dev) {
+		wlr_log(L_DEBUG, "Got a tablet pad event for a device with no tablet pad?");
+		return;
+	}
+	struct libinput_event_tablet_pad *pevent =
+		libinput_event_get_tablet_pad_event(event);
+	struct wlr_tablet_pad_strip *wlr_event =
+		calloc(1, sizeof(struct wlr_tablet_pad_strip));
+	wlr_event->time_sec = libinput_event_tablet_pad_get_time(pevent);
+	wlr_event->time_usec = libinput_event_tablet_pad_get_time_usec(pevent);
+	wlr_event->strip = libinput_event_tablet_pad_get_strip_number(pevent);
+	wlr_event->position = libinput_event_tablet_pad_get_strip_position(pevent);
+	switch (libinput_event_tablet_pad_get_strip_source(pevent)) {
+	case LIBINPUT_TABLET_PAD_STRIP_SOURCE_UNKNOWN:
+		wlr_event->source = WLR_TABLET_PAD_STRIP_SOURCE_UNKNOWN;
+		break;
+	case LIBINPUT_TABLET_PAD_STRIP_SOURCE_FINGER:
+		wlr_event->source = WLR_TABLET_PAD_STRIP_SOURCE_FINGER;
+		break;
+	}
+	wl_signal_emit(&dev->tablet_pad->events.strip, wlr_event);
+}

example/shared.c

@@ -211,6 +211,25 @@ static void tablet_tool_add(struct wlr_input_device *device,
 	wl_list_insert(&state->tablet_tools, &tstate->link);
 }
 
+static void tablet_pad_button_notify(struct wl_listener *listener, void *data) {
+	struct wlr_tablet_pad_button *event = data;
+	struct tablet_pad_state *pstate = wl_container_of(listener, pstate, button);
+	if (pstate->compositor->pad_button_cb) {
+		pstate->compositor->pad_button_cb(pstate, event->button, event->state);
+	}
+}
+
+static void tablet_pad_add(struct wlr_input_device *device,
+		struct compositor_state *state) {
+	struct tablet_pad_state *pstate = calloc(sizeof(struct tablet_pad_state), 1);
+	pstate->device = device;
+	pstate->compositor = state;
+	wl_list_init(&pstate->button.link);
+	pstate->button.notify = tablet_pad_button_notify;
+	wl_signal_add(&device->tablet_pad->events.button, &pstate->button);
+	wl_list_insert(&state->tablet_pads, &pstate->link);
+}
+
 static void input_add_notify(struct wl_listener *listener, void *data) {
 	struct wlr_input_device *device = data;
 	struct compositor_state *state = wl_container_of(listener, state, input_add);
@@ -226,6 +245,10 @@ static void input_add_notify(struct wl_listener *listener, void *data) {
 		break;
 	case WLR_INPUT_DEVICE_TABLET_TOOL:
 		tablet_tool_add(device, state);
+		break;
+	case WLR_INPUT_DEVICE_TABLET_PAD:
+		tablet_pad_add(device, state);
+		break;
 	default:
 		break;
 	}
@@ -391,6 +414,7 @@ void compositor_init(struct compositor_state *state) {
 	wl_list_init(&state->pointers);
 	wl_list_init(&state->touch);
 	wl_list_init(&state->tablet_tools);
+	wl_list_init(&state->tablet_pads);
 	wl_list_init(&state->input_add.link);
 	state->input_add.notify = input_add_notify;
 	wl_list_init(&state->input_remove.link);

example/shared.h

@@ -61,6 +61,14 @@ struct tablet_tool_state {
 	void *data;
 };
 
+struct tablet_pad_state {
+	struct compositor_state *compositor;
+	struct wlr_input_device *device;
+	struct wl_listener button;
+	struct wl_list link;
+	void *data;
+};
+
 struct compositor_state {
 	void (*output_add_cb)(struct output_state *s);
 	void (*keyboard_add_cb)(struct keyboard_state *s);
@@ -91,6 +99,8 @@ struct compositor_state {
 			enum wlr_tablet_tool_tip_state state);
 	void (*tool_button_cb)(struct tablet_tool_state *s,
 			uint32_t button, enum wlr_button_state state);
+	void (*pad_button_cb)(struct tablet_pad_state *s,
+			uint32_t button, enum wlr_button_state state);
 
 	struct wl_display *display;
 	struct wl_event_loop *event_loop;
@@ -101,6 +111,7 @@ struct compositor_state {
 	struct wl_list pointers;
 	struct wl_list touch;
 	struct wl_list tablet_tools;
+	struct wl_list tablet_pads;
 	struct wl_listener input_add;
 	struct wl_listener input_remove;
 

example/tablet.c

@@ -21,13 +21,14 @@
 
 struct sample_state {
 	struct wlr_renderer *renderer;
-	bool proximity, tap;
+	bool proximity, tap, button;
 	double distance;
 	double pressure;
 	double x_mm, y_mm;
 	double width_mm, height_mm;
 	struct wl_list link;
 	float tool_color[4];
+	float pad_color[4];
 };
 
 static void handle_output_frame(struct output_state *output, struct timespec *ts) {
@@ -41,11 +42,10 @@ static void handle_output_frame(struct output_state *output, struct timespec *ts
 	wlr_renderer_begin(sample->renderer, wlr_output);
 
 	float matrix[16], view[16];
-	float pad_color[4] = { 0.75, 0.75, 0.75, 1.0 };
 	float distance = 0.8f * (1 - sample->distance);
 	float tool_color[4] = { distance, distance, distance, 1 };
-	for (size_t i = 0; i < 4; ++i) {
-		tool_color[i] *= sample->tool_color[i];
+	for (size_t i = 0; sample->button && i < 4; ++i) {
+		tool_color[i] = sample->tool_color[i];
 	}
 	float scale = 4;
 
@@ -57,7 +57,7 @@ static void handle_output_frame(struct output_state *output, struct timespec *ts
 	wlr_matrix_scale(&view, pad_width, pad_height, 1);
 	wlr_matrix_mul(&matrix, &view, &view);
 	wlr_matrix_mul(&wlr_output->transform_matrix, &view, &matrix);
-	wlr_render_colored_quad(sample->renderer, &pad_color, &matrix);
+	wlr_render_colored_quad(sample->renderer, &sample->pad_color, &matrix);
 
 	if (sample->proximity) {
 		wlr_matrix_translate(&matrix,
@@ -110,12 +110,31 @@ static void handle_tool_button(struct tablet_tool_state *tstate,
 		uint32_t button, enum wlr_button_state state) {
 	struct sample_state *sample = tstate->compositor->data;
 	if (state == WLR_BUTTON_RELEASED) {
-		float default_color[4] = { 1, 1, 1, 1 };
-		memcpy(sample->tool_color, default_color, 4);
+		sample->button = false;
 	} else {
+		sample->button = true;
 		for (size_t i = 0; i < 3; ++i) {
-			if (button % 3 != i) {
-				sample->tool_color[button % 3] = 0;
+			if (button % 3 == i) {
+				sample->tool_color[i] = 0;
+			} else {
+				sample->tool_color[i] = 1;
+			}
+		}
+	}
+}
+
+static void handle_pad_button(struct tablet_pad_state *pstate,
+		uint32_t button, enum wlr_button_state state) {
+	struct sample_state *sample = pstate->compositor->data;
+	float default_color[4] = { 0.75, 0.75, 0.75, 1.0 };
+	if (state == WLR_BUTTON_RELEASED) {
+		memcpy(sample->pad_color, default_color, sizeof(default_color));
+	} else {
+		for (size_t i = 0; i < 3; ++i) {
+			if (button % 3 == i) {
+				sample->pad_color[i] = 0;
+			} else {
+				sample->pad_color[i] = 1;
 			}
 		}
 	}
@@ -123,7 +142,8 @@ static void handle_tool_button(struct tablet_tool_state *tstate,
 
 int main(int argc, char *argv[]) {
 	struct sample_state state = {
-		.tool_color = { 1, 1, 1, 1 }
+		.tool_color = { 1, 1, 1, 1 },
+		.pad_color = { 0.75, 0.75, 0.75, 1.0 }
 	};
 	struct compositor_state compositor;
 
@@ -133,6 +153,7 @@ int main(int argc, char *argv[]) {
 	compositor.tool_axis_cb = handle_tool_axis;
 	compositor.tool_proximity_cb = handle_tool_proximity;
 	compositor.tool_button_cb = handle_tool_button;
+	compositor.pad_button_cb = handle_pad_button;
 
 	state.renderer = wlr_gles3_renderer_init();
 

include/backend/libinput.h

@@ -68,4 +68,13 @@ void handle_tablet_tool_tip(struct libinput_event *event,
 void handle_tablet_tool_button(struct libinput_event *event,
 		struct libinput_device *device);
 
+struct wlr_tablet_pad *wlr_libinput_tablet_pad_create(
+		struct libinput_device *device);
+void handle_tablet_pad_button(struct libinput_event *event,
+		struct libinput_device *device);
+void handle_tablet_pad_ring(struct libinput_event *event,
+		struct libinput_device *device);
+void handle_tablet_pad_strip(struct libinput_event *event,
+		struct libinput_device *device);
+
 #endif

include/types.h

@@ -53,6 +53,14 @@ struct wlr_tablet_tool *wlr_tablet_tool_create(struct wlr_tablet_tool_impl *impl
 		struct wlr_tablet_tool_state *state);
 void wlr_tablet_tool_destroy(struct wlr_tablet_tool *tool);
 
+struct wlr_tablet_pad_impl {
+	void (*destroy)(struct wlr_tablet_pad_state *pad);
+};
+
+struct wlr_tablet_pad *wlr_tablet_pad_create(struct wlr_tablet_pad_impl *impl,
+		struct wlr_tablet_pad_state *state);
+void wlr_tablet_pad_destroy(struct wlr_tablet_pad *pad);
+
 struct wlr_input_device_impl {
 	void (*destroy)(struct wlr_input_device_state *state);
 };

include/wlr/types.h

@@ -254,8 +254,55 @@ struct wlr_tablet_tool_button {
 	enum wlr_button_state state;
 };
 
-// TODO: tablet pad
-// TODO: switch
+// NOTE: the wlr tablet pad implementation does not currently support tablets
+// with more than one mode. I don't own any such hardware so I cannot test it
+// and it is too complicated to make a meaningful implementation of blindly.
+struct wlr_tablet_pad_impl;
+struct wlr_tablet_pad_state;
+
+struct wlr_tablet_pad {
+	struct wlr_tablet_pad_impl *impl;
+	struct wlr_tablet_pad_state *state;
+
+	struct {
+		struct wl_signal button;
+		struct wl_signal ring;
+		struct wl_signal strip;
+	} events;
+};
+
+struct wlr_tablet_pad_button {
+	uint32_t time_sec;
+	uint64_t time_usec;
+	uint32_t button;
+	enum wlr_button_state state;
+};
+
+enum wlr_tablet_pad_ring_source {
+	WLR_TABLET_PAD_RING_SOURCE_UNKNOWN,
+	WLR_TABLET_PAD_RING_SOURCE_FINGER,
+};
+
+struct wlr_tablet_pad_ring {
+	uint32_t time_sec;
+	uint64_t time_usec;
+	enum wlr_tablet_pad_ring_source source;
+	uint32_t ring;
+	double position;
+};
+
+enum wlr_tablet_pad_strip_source {
+	WLR_TABLET_PAD_STRIP_SOURCE_UNKNOWN,
+	WLR_TABLET_PAD_STRIP_SOURCE_FINGER,
+};
+
+struct wlr_tablet_pad_strip {
+	uint32_t time_sec;
+	uint64_t time_usec;
+	enum wlr_tablet_pad_strip_source source;
+	uint32_t strip;
+	double position;
+};
 
 enum wlr_input_device_type {
 	WLR_INPUT_DEVICE_KEYBOARD,
@@ -284,6 +331,7 @@ struct wlr_input_device {
 		struct wlr_pointer *pointer;
 		struct wlr_touch *touch;
 		struct wlr_tablet_tool *tablet_tool;
+		struct wlr_tablet_pad *tablet_pad;
 	};
 };
 

types/CMakeLists.txt

@@ -10,6 +10,7 @@ add_library(wlr-types
     wlr_pointer.c
     wlr_touch.c
     wlr_tablet_tool.c
+    wlr_tablet_pad.c
 )
 
 target_link_libraries(wlr-types

types/wlr_tablet_pad.c

@@ -0,0 +1,25 @@
+#include <stdlib.h>
+#include <string.h>
+#include <wayland-server.h>
+#include <wlr/types.h>
+#include <wlr/common/list.h>
+#include "types.h"
+
+struct wlr_tablet_pad *wlr_tablet_pad_create(struct wlr_tablet_pad_impl *impl,
+		struct wlr_tablet_pad_state *state) {
+	struct wlr_tablet_pad *pad = calloc(1, sizeof(struct wlr_tablet_pad));
+	pad->impl = impl;
+	pad->state = state;
+	wl_signal_init(&pad->events.button);
+	wl_signal_init(&pad->events.ring);
+	wl_signal_init(&pad->events.strip);
+	return pad;
+}
+
+void wlr_tablet_pad_destroy(struct wlr_tablet_pad *pad) {
+	if (!pad) return;
+	if (pad->impl) {
+		pad->impl->destroy(pad->state);
+	}
+	free(pad);
+}