wlroots/types/wlr_output.c

#define _POSIX_C_SOURCE 200809L
#include <assert.h>
#include <stdlib.h>
#include <string.h>
#include <tgmath.h>
#include <time.h>
#include <wayland-server.h>
#include <wlr/types/wlr_box.h>
#include <wlr/types/wlr_output.h>
#include <wlr/types/wlr_surface.h>
#include <wlr/interfaces/wlr_output.h>
#include <wlr/types/wlr_list.h>
#include <wlr/util/log.h>
#include <GLES2/gl2.h>
#include <wlr/render/matrix.h>
#include <wlr/render/gles2.h>
#include <wlr/render.h>

static void wl_output_send_to_resource(struct wl_resource *resource) {
	assert(resource);
	struct wlr_output *output = wl_resource_get_user_data(resource);
	assert(output);
	const uint32_t version = wl_resource_get_version(resource);
	if (version >= WL_OUTPUT_GEOMETRY_SINCE_VERSION) {
		wl_output_send_geometry(resource, output->lx, output->ly,
			output->phys_width, output->phys_height, output->subpixel,
			output->make, output->model, output->transform);
	}
	if (version >= WL_OUTPUT_MODE_SINCE_VERSION) {
		struct wlr_output_mode *mode;
		wl_list_for_each(mode, &output->modes, link) {
			// TODO: mode->flags should just be preferred
			uint32_t flags = mode->flags;
			if (output->current_mode == mode) {
				flags |= WL_OUTPUT_MODE_CURRENT;
			}
			wl_output_send_mode(resource, flags, mode->width, mode->height,
				mode->refresh);
		}

		if (wl_list_length(&output->modes) == 0) {
			// Output has no mode, send the current width/height
			wl_output_send_mode(resource, WL_OUTPUT_MODE_CURRENT,
				output->width, output->height, 0);
		}
	}
	if (version >= WL_OUTPUT_SCALE_SINCE_VERSION) {
		wl_output_send_scale(resource, output->scale);
	}
	if (version >= WL_OUTPUT_DONE_SINCE_VERSION) {
		wl_output_send_done(resource);
	}
}

static void wlr_output_send_current_mode_to_resource(
		struct wl_resource *resource) {
	struct wlr_output *output = wl_resource_get_user_data(resource);
	assert(output);
	const uint32_t version = wl_resource_get_version(resource);
	if (version < WL_OUTPUT_MODE_SINCE_VERSION) {
		return;
	}
	if (output->current_mode != NULL) {
		struct wlr_output_mode *mode = output->current_mode;
		wl_output_send_mode(resource, mode->flags | WL_OUTPUT_MODE_CURRENT,
			mode->width, mode->height, mode->refresh);
	} else {
		// Output has no mode, send the current width/height
		wl_output_send_mode(resource, WL_OUTPUT_MODE_CURRENT, output->width,
			output->height, 0);
	}
}

static void wl_output_destroy(struct wl_resource *resource) {
	struct wlr_output *output = wl_resource_get_user_data(resource);
	struct wl_resource *_resource = NULL;
	wl_resource_for_each(_resource, &output->wl_resources) {
		if (_resource == resource) {
			struct wl_list *link = wl_resource_get_link(_resource);
			wl_list_remove(link);
			break;
		}
	}
}

static void wl_output_release(struct wl_client *client, struct wl_resource *resource) {
	wl_output_destroy(resource);
}

static struct wl_output_interface wl_output_impl = {
	.release = wl_output_release
};

static void wl_output_bind(struct wl_client *wl_client, void *_wlr_output,
		uint32_t version, uint32_t id) {
	struct wlr_output *wlr_output = _wlr_output;
	assert(wl_client && wlr_output);

	struct wl_resource *wl_resource = wl_resource_create(wl_client,
		&wl_output_interface, version, id);
	wl_resource_set_implementation(wl_resource, &wl_output_impl, wlr_output,
		wl_output_destroy);
	wl_list_insert(&wlr_output->wl_resources,
		wl_resource_get_link(wl_resource));
	wl_output_send_to_resource(wl_resource);
}

struct wl_global *wlr_output_create_global(struct wlr_output *wlr_output,
		struct wl_display *display) {
	if (wlr_output->wl_global != NULL) {
		return wlr_output->wl_global;
	}
	struct wl_global *wl_global = wl_global_create(display,
		&wl_output_interface, 3, wlr_output, wl_output_bind);
	wlr_output->wl_global = wl_global;
	wl_list_init(&wlr_output->wl_resources);
	return wl_global;
}

void wlr_output_destroy_global(struct wlr_output *wlr_output) {
	if (wlr_output->wl_global == NULL) {
		return;
	}
	struct wl_resource *resource, *tmp;
	wl_resource_for_each_safe(resource, tmp, &wlr_output->wl_resources) {
		struct wl_list *link = wl_resource_get_link(resource);
		wl_list_remove(link);
	}
	wl_global_destroy(wlr_output->wl_global);
	wlr_output->wl_global = NULL;
}

static void wlr_output_update_matrix(struct wlr_output *output) {
	wlr_matrix_texture(output->transform_matrix, output->width, output->height,
		output->transform);
}

void wlr_output_enable(struct wlr_output *output, bool enable) {
	if (output->impl->enable) {
		output->impl->enable(output, enable);
	}
}

bool wlr_output_set_mode(struct wlr_output *output,
		struct wlr_output_mode *mode) {
	if (!output->impl || !output->impl->set_mode) {
		return false;
	}
	bool result = output->impl->set_mode(output, mode);
	if (result) {
		wlr_output_update_matrix(output);
		struct wl_resource *resource;
		wl_resource_for_each(resource, &output->wl_resources) {
			wlr_output_send_current_mode_to_resource(resource);
		}
	}
	return result;
}

void wlr_output_update_size(struct wlr_output *output, int32_t width,
		int32_t height) {
	output->width = width;
	output->height = height;
	wlr_output_update_matrix(output);
	if (output->wl_global != NULL) {
		struct wl_resource *resource;
		wl_resource_for_each(resource, &output->wl_resources) {
			wlr_output_send_current_mode_to_resource(resource);
		}
	}
}

void wlr_output_transform(struct wlr_output *output,
		enum wl_output_transform transform) {
	output->impl->transform(output, transform);
	wlr_output_update_matrix(output);
}

void wlr_output_set_position(struct wlr_output *output, int32_t lx,
		int32_t ly) {
	if (lx == output->lx && ly == output->ly) {
		return;
	}

	output->lx = lx;
	output->ly = ly;

	struct wl_resource *resource;
	wl_resource_for_each(resource, &output->wl_resources) {
		wl_output_send_to_resource(resource);
	}
}

void wlr_output_init(struct wlr_output *output, struct wlr_backend *backend,
		const struct wlr_output_impl *impl) {
	assert(impl->make_current && impl->swap_buffers && impl->transform);
	output->backend = backend;
	output->impl = impl;
	wl_list_init(&output->modes);
	output->transform = WL_OUTPUT_TRANSFORM_NORMAL;
	output->scale = 1;
	wl_list_init(&output->cursors);
	wl_signal_init(&output->events.frame);
	wl_signal_init(&output->events.swap_buffers);
	wl_signal_init(&output->events.resolution);
	wl_signal_init(&output->events.destroy);
}

void wlr_output_destroy(struct wlr_output *output) {
	if (!output) {
		return;
	}

	wl_signal_emit(&output->events.destroy, output);

	struct wlr_output_mode *mode, *tmp_mode;
	wl_list_for_each_safe(mode, tmp_mode, &output->modes, link) {
		free(mode);
	}
	wl_list_remove(&output->modes);
	if (output->impl && output->impl->destroy) {
		output->impl->destroy(output);
	} else {
		free(output);
	}
}

void wlr_output_effective_resolution(struct wlr_output *output,
		int *width, int *height) {
	if (output->transform % 2 == 1) {
		*width = output->height;
		*height = output->width;
	} else {
		*width = output->width;
		*height = output->height;
	}
	*width /= output->scale;
	*height /= output->scale;
}

void wlr_output_make_current(struct wlr_output *output) {
	output->impl->make_current(output);
}

static void output_cursor_get_box(struct wlr_output_cursor *cursor,
		struct wlr_box *box) {
	box->x = cursor->x - cursor->hotspot_x;
	box->y = cursor->y - cursor->hotspot_y;
	box->width = cursor->width;
	box->height = cursor->height;
}

static void output_cursor_render(struct wlr_output_cursor *cursor) {
	struct wlr_texture *texture = cursor->texture;
	struct wlr_renderer *renderer = cursor->renderer;
	if (cursor->surface != NULL) {
		// Some clients commit a cursor surface with a NULL buffer to hide it.
		if (!wlr_surface_has_buffer(cursor->surface)) {
			return;
		}
		texture = cursor->surface->texture;
		renderer = cursor->surface->renderer;
	}

	if (texture == NULL || renderer == NULL) {
		return;
	}

	struct wlr_box output_box;
	output_box.x = output_box.y = 0;
	output_box.width = cursor->output->width;
	output_box.height = cursor->output->height;

	struct wlr_box cursor_box;
	output_cursor_get_box(cursor, &cursor_box);

	struct wlr_box intersection;
	struct wlr_box *intersection_ptr = &intersection;
	if (!wlr_box_intersection(&output_box, &cursor_box, &intersection_ptr)) {
		return;
	}

	glViewport(0, 0, cursor->output->width, cursor->output->height);
	glEnable(GL_BLEND);
	glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);

	float matrix[16];
	wlr_texture_get_matrix(texture, &matrix,
		&cursor->output->transform_matrix, cursor->x - cursor->hotspot_x,
		cursor->y - cursor->hotspot_y);
	wlr_render_with_matrix(renderer, texture, &matrix);
}

void wlr_output_swap_buffers(struct wlr_output *output) {
	struct wlr_output_cursor *cursor;
	wl_list_for_each(cursor, &output->cursors, link) {
		if (output->hardware_cursor == cursor) {
			continue;
		}
		output_cursor_render(cursor);
	}

	wl_signal_emit(&output->events.swap_buffers, &output);

	output->impl->swap_buffers(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);
	}
}

uint32_t wlr_output_get_gamma_size(struct wlr_output *output) {
	if (!output->impl->get_gamma_size) {
		return 0;
	}
	return output->impl->get_gamma_size(output);
}

static void output_cursor_reset(struct wlr_output_cursor *cursor) {
	if (cursor->surface != NULL) {
		wl_list_remove(&cursor->surface_commit.link);
		wl_list_remove(&cursor->surface_destroy.link);
		cursor->surface = NULL;
	}
}

bool wlr_output_cursor_set_image(struct wlr_output_cursor *cursor,
		const uint8_t *pixels, int32_t stride, uint32_t width, uint32_t height,
		int32_t hotspot_x, int32_t hotspot_y) {
	output_cursor_reset(cursor);

	cursor->width = width;
	cursor->height = height;
	cursor->hotspot_x = hotspot_x;
	cursor->hotspot_y = hotspot_y;

	if (cursor->output->hardware_cursor == NULL &&
			cursor->output->impl->set_cursor) {
		int ok = cursor->output->impl->set_cursor(cursor->output, pixels,
			stride, width, height, hotspot_x, hotspot_y, true);
		if (ok) {
			cursor->output->hardware_cursor = cursor;
			return true;
		}
	}

	wlr_log(L_INFO, "Falling back to software cursor");

	if (cursor->renderer == NULL) {
		cursor->renderer = wlr_gles2_renderer_create(cursor->output->backend);
		if (cursor->renderer == NULL) {
			return false;
		}
	}

	if (cursor->texture == NULL) {
		cursor->texture = wlr_render_texture_create(cursor->renderer);
		if (cursor->texture == NULL) {
			return false;
		}
	}

	return wlr_texture_upload_pixels(cursor->texture, WL_SHM_FORMAT_ARGB8888,
		stride, width, height, pixels);
}

static void output_cursor_commit(struct wlr_output_cursor *cursor) {
	cursor->width = cursor->surface->current->width;
	cursor->height = cursor->surface->current->height;

	// TODO: if hardware cursor, upload pixels
}

static inline int64_t timespec_to_msec(const struct timespec *a) {
	return (int64_t)a->tv_sec * 1000 + a->tv_nsec / 1000000;
}

static void output_cursor_handle_commit(struct wl_listener *listener,
		void *data) {
	struct wlr_output_cursor *cursor = wl_container_of(listener, cursor,
		surface_commit);
	struct wlr_surface *surface = data;

	output_cursor_commit(cursor);

	struct timespec now;
	clock_gettime(CLOCK_MONOTONIC, &now);

	struct wlr_frame_callback *cb, *cnext;
	wl_list_for_each_safe(cb, cnext, &surface->current->frame_callback_list,
			link) {
		wl_callback_send_done(cb->resource, timespec_to_msec(&now));
		wl_resource_destroy(cb->resource);
	}
}

static void output_cursor_handle_destroy(struct wl_listener *listener,
		void *data) {
	struct wlr_output_cursor *cursor = wl_container_of(listener, cursor,
		surface_destroy);
	output_cursor_reset(cursor);
}

void wlr_output_cursor_set_surface(struct wlr_output_cursor *cursor,
		struct wlr_surface *surface, int32_t hotspot_x, int32_t hotspot_y) {
	if (surface && strcmp(surface->role, "wl_pointer-cursor") != 0) {
		return;
	}

	if (surface) {
		cursor->width = surface->current->width;
		cursor->height = surface->current->height;
	}
	cursor->hotspot_x = hotspot_x;
	cursor->hotspot_y = hotspot_y;

	if (surface && surface == cursor->surface) {
		if (cursor->output->hardware_cursor == cursor &&
				cursor->output->impl->set_cursor) {
			// If the surface hasn't changed and it's an hardware cursor, only
			// update the hotspot
			cursor->output->impl->set_cursor(cursor->output, NULL, 0, 0, 0,
				hotspot_x, hotspot_y, false);
		}
		return;
	}

	output_cursor_reset(cursor);

	// Disable hardware cursor for surfaces
	// TODO: support hardware cursors
	if (cursor->output->hardware_cursor == cursor &&
			cursor->output->impl->set_cursor) {
		cursor->output->impl->set_cursor(cursor->output, NULL, 0, 0, 0, 0, 0,
			true);
		cursor->output->hardware_cursor = NULL;
	}

	cursor->surface = surface;

	if (surface != NULL) {
		wl_signal_add(&surface->events.commit, &cursor->surface_commit);
		wl_signal_add(&surface->events.destroy, &cursor->surface_destroy);
		output_cursor_commit(cursor);
	} else {
		// TODO: if hardware cursor, disable cursor
	}
}

bool wlr_output_cursor_move(struct wlr_output_cursor *cursor, int x, int y) {
	x *= cursor->output->scale;
	y *= cursor->output->scale;
	cursor->x = x;
	cursor->y = y;

	if (cursor->output->hardware_cursor != cursor) {
		return true;
	}

	if (!cursor->output->impl->move_cursor) {
		return false;
	}
	return cursor->output->impl->move_cursor(cursor->output, x, y);
}

struct wlr_output_cursor *wlr_output_cursor_create(struct wlr_output *output) {
	struct wlr_output_cursor *cursor =
		calloc(1, sizeof(struct wlr_output_cursor));
	if (cursor == NULL) {
		return NULL;
	}
	cursor->output = output;
	wl_list_init(&cursor->surface_commit.link);
	cursor->surface_commit.notify = output_cursor_handle_commit;
	wl_list_init(&cursor->surface_destroy.link);
	cursor->surface_destroy.notify = output_cursor_handle_destroy;
	wl_list_insert(&output->cursors, &cursor->link);
	return cursor;
}

void wlr_output_cursor_destroy(struct wlr_output_cursor *cursor) {
	if (cursor == NULL) {
		return;
	}
	output_cursor_reset(cursor);
	if (cursor->output->hardware_cursor == cursor) {
		// If this cursor was the hardware cursor, disable it
		if (cursor->output->impl->set_cursor) {
			cursor->output->impl->set_cursor(cursor->output, NULL, 0, 0, 0, 0,
				0, true);
		}
		cursor->output->hardware_cursor = NULL;
	}
	if (cursor->texture != NULL) {
		wlr_texture_destroy(cursor->texture);
	}
	if (cursor->renderer != NULL) {
		wlr_renderer_destroy(cursor->renderer);
	}
	wl_list_remove(&cursor->link);
	free(cursor);
}