[PATCH] Add a simple client for testing compositor damage handling

Pekka Paalanen ppaalanen at gmail.com
Sat Jun 14 06:47:11 PDT 2014


On Wed, 11 Jun 2014 09:54:17 -0700
Jason Ekstrand <jason at jlekstrand.net> wrote:

> From: Jason Ekstrand <jason at jlekstrand.net>
> 
> This allows for easily testing a compositor's damage tracking in all
> currently available configurations including wl_surface.buffer_transform,
> wl_surface.buffer_scale, and wl_viewport.  It also includes a
> --rotating-damage that flag instructs the client to change the
> wl_surface.buffer_transform on every commit.  This tests the compositor for
> proper handling of texture uploads even when the transform has changed but
> the buffer size hasn't.
> ---
>  .gitignore              |   4 +-
>  Makefile.am             |  12 +
>  clients/simple-damage.c | 882 ++++++++++++++++++++++++++++++++++++++++++++++++
>  3 files changed, 896 insertions(+), 2 deletions(-)
>  create mode 100644 clients/simple-damage.c
> 
> diff --git a/.gitignore b/.gitignore
> index f9a6a7b..2f6edd6 100644
> --- a/.gitignore
> +++ b/.gitignore
> @@ -1,6 +1,5 @@
>  *.deps
> -*.jpg
> -*.la
> +*.jpg *.la

This hunk probably should not be here?

>  *.lo
>  *.log
>  *.o
> @@ -50,6 +49,7 @@ weston-scaler
>  weston-simple-egl
>  weston-simple-shm
>  weston-simple-touch
> +weston-simple-damage
>  weston-smoke
>  weston-stacking
>  weston-subsurfaces
> diff --git a/Makefile.am b/Makefile.am
> index 343adc6..9fc04ee 100644
> --- a/Makefile.am
> +++ b/Makefile.am
> @@ -386,6 +386,7 @@ endif
>  if BUILD_SIMPLE_CLIENTS
>  demo_clients +=					\
>  	weston-simple-shm			\
> +	weston-simple-damage			\
>  	weston-simple-touch			\
>  	weston-multi-resource
>  
> @@ -398,6 +399,17 @@ nodist_weston_simple_shm_SOURCES =		\
>  weston_simple_shm_CFLAGS = $(AM_CFLAGS) $(SIMPLE_CLIENT_CFLAGS)
>  weston_simple_shm_LDADD = $(SIMPLE_CLIENT_LIBS) libshared.la
>  
> +weston_simple_damage_SOURCES = clients/simple-damage.c
> +nodist_weston_simple_damage_SOURCES =		\
> +	protocol/scaler-protocol.c		\
> +	protocol/scaler-client-protocol.h	\
> +	protocol/xdg-shell-protocol.c		\
> +	protocol/xdg-shell-client-protocol.h	\
> +	protocol/fullscreen-shell-protocol.c	\
> +	protocol/fullscreen-shell-client-protocol.h
> +weston_simple_damage_CFLAGS = $(AM_CFLAGS) $(SIMPLE_CLIENT_CFLAGS)
> +weston_simple_damage_LDADD = $(SIMPLE_CLIENT_LIBS) libshared.la
> +
>  weston_simple_touch_SOURCES = clients/simple-touch.c
>  weston_simple_touch_CFLAGS = $(AM_CFLAGS) $(SIMPLE_CLIENT_CFLAGS)
>  weston_simple_touch_LDADD = $(SIMPLE_CLIENT_LIBS) libshared.la
> diff --git a/clients/simple-damage.c b/clients/simple-damage.c
> new file mode 100644
> index 0000000..24595a1
> --- /dev/null
> +++ b/clients/simple-damage.c
> @@ -0,0 +1,882 @@
> +/*
> + * Copyright © 2014 Jason Ekstrand
> + * Copyright © 2011 Benjamin Franzke
> + * Copyright © 2010 Intel Corporation
> + *
> + * 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.
> + */
> +
> +#include <config.h>
> +
> +#include <stdio.h>
> +#include <stdlib.h>
> +#include <string.h>
> +#include <stdbool.h>
> +#include <assert.h>
> +#include <unistd.h>
> +#include <sys/mman.h>
> +#include <sys/time.h>
> +#include <signal.h>
> +
> +#include <wayland-client.h>
> +#include "../shared/os-compatibility.h"
> +#include "xdg-shell-client-protocol.h"
> +#include "fullscreen-shell-client-protocol.h"
> +#include "scaler-client-protocol.h"
> +
> +int print_debug = 0;
> +
> +struct display {
> +	struct wl_display *display;
> +	struct wl_registry *registry;
> +	int compositor_version;
> +	struct wl_compositor *compositor;
> +	struct wl_scaler *scaler;
> +	struct xdg_shell *shell;
> +	struct _wl_fullscreen_shell *fshell;
> +	struct wl_shm *shm;
> +	uint32_t formats;
> +};
> +
> +struct buffer {
> +	struct wl_buffer *buffer;
> +	uint32_t *shm_data;
> +	int busy;
> +};
> +
> +enum window_flags {
> +	WINDOW_FLAG_USE_VIEWPORT = 0x1,
> +	WINDOW_FLAG_ROTATING_TRANSFORM = 0x2,
> +};
> +
> +struct window {
> +	struct display *display;
> +	int width, height, border;
> +	struct wl_surface *surface;
> +	struct wl_viewport *viewport;
> +	struct xdg_surface *xdg_surface;
> +	struct wl_callback *callback;
> +	struct buffer buffers[2];
> +	struct buffer *prev_buffer;
> +
> +	enum window_flags flags;
> +	int scale;
> +	enum wl_output_transform transform;
> +
> +	struct {
> +		float x, y; /* position in pixels */
> +		float dx, dy; /* velocity in pixels/second */
> +		int radius; /* radius in pixels */
> +		uint32_t prev_time;
> +	} ball;
> +};
> +
> +static int running = 1;
> +
> +static void
> +buffer_release(void *data, struct wl_buffer *buffer)
> +{
> +	struct buffer *mybuf = data;
> +
> +	mybuf->busy = 0;
> +}
> +
> +static const struct wl_buffer_listener buffer_listener = {
> +	buffer_release
> +};
> +
> +static int
> +create_shm_buffer(struct display *display, struct buffer *buffer,
> +		  int width, int height, uint32_t format)
> +{
> +	struct wl_shm_pool *pool;
> +	int fd, size, stride;
> +	void *data;
> +
> +	stride = width * 4;
> +	size = stride * height;
> +
> +	fd = os_create_anonymous_file(size);
> +	if (fd < 0) {
> +		fprintf(stderr, "creating a buffer file for %d B failed: %m\n",
> +			size);
> +		return -1;
> +	}
> +
> +	data = mmap(NULL, size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
> +	if (data == MAP_FAILED) {
> +		fprintf(stderr, "mmap failed: %m\n");
> +		close(fd);
> +		return -1;
> +	}
> +
> +	pool = wl_shm_create_pool(display->shm, fd, size);
> +	buffer->buffer = wl_shm_pool_create_buffer(pool, 0,
> +						   width, height,
> +						   stride, format);
> +	wl_buffer_add_listener(buffer->buffer, &buffer_listener, buffer);
> +	wl_shm_pool_destroy(pool);
> +	close(fd);
> +
> +	buffer->shm_data = data;
> +
> +	return 0;
> +}
> +
> +static void
> +handle_configure(void *data, struct xdg_surface *surface,
> +		 int32_t width, int32_t height, struct wl_array *states,
> +		 uint32_t serial)
> +{
> +}
> +
> +static void
> +handle_close(void *data, struct xdg_surface *xdg_surface)
> +{
> +	running = 0;
> +}
> +
> +static const struct xdg_surface_listener xdg_surface_listener = {
> +	handle_configure,
> +	handle_close,
> +};
> +
> +static float
> +bounded_randf(float a, float b)
> +{
> +	return a + ((float)rand() / (float)RAND_MAX) * (b - a);
> +}
> +
> +static void
> +window_init_game(struct window *window)
> +{
> +	int ax1, ay1, ax2, ay2; /* playable arena size */
> +	struct timeval tv;
> +
> +	gettimeofday(&tv, NULL);
> +	srand(tv.tv_usec);
> +
> +	ax1 = window->border + window->ball.radius;
> +	ay1 = window->border + window->ball.radius;
> +	ax2 = window->width - window->border - window->ball.radius;
> +	ay2 = window->height - window->border - window->ball.radius;
> +
> +	window->ball.radius = 10;

A little strange to use ball.radius first, and then set it here.

> +	window->ball.x = bounded_randf(ax1, ax2);
> +	window->ball.y = bounded_randf(ay1, ay2);
> +
> +	window->ball.dx = bounded_randf(0, window->width);
> +	window->ball.dy = bounded_randf(0, window->height);
> +
> +	window->ball.prev_time = 0;
> +}
> +
> +static void
> +window_advance_game(struct window *window, uint32_t timestamp)
> +{
> +	int ax1, ay1, ax2, ay2; /* Arena size */
> +	float dt;
> +
> +	if (window->ball.prev_time == 0) {
> +		/* first pass, don't do anything */
> +		window->ball.prev_time = timestamp;
> +		return;
> +	}
> +
> +	/* dt in seconds */
> +	dt = (float)(timestamp - window->ball.prev_time) / 1000.0f;
> +
> +	ax1 = window->border + window->ball.radius;
> +	ay1 = window->border + window->ball.radius;
> +	ax2 = window->width - window->border - window->ball.radius;
> +	ay2 = window->height - window->border - window->ball.radius;
> +
> +	window->ball.x += window->ball.dx * dt;
> +	while (window->ball.x < ax1 || ax2 < window->ball.x) {
> +		if (window->ball.x < ax1)
> +			window->ball.x = 2 * ax1 - window->ball.x;
> +		if (ax2 <= window->ball.x)
> +			window->ball.x = 2 * ax2 - window->ball.x;
> +
> +		window->ball.dx *= -1.0f;
> +	}
> +
> +	window->ball.y += window->ball.dy * dt;
> +	while (window->ball.y < ay1 || ay2 < window->ball.y) {
> +		if (window->ball.y < ay1)
> +			window->ball.y = 2 * ay1 - window->ball.y;
> +		if (ay2 <= window->ball.y)
> +			window->ball.y = 2 * ay2 - window->ball.y;
> +
> +		window->ball.dy *= -1.0f;
> +	}
> +
> +	window->ball.prev_time = timestamp;
> +}
> +
> +static struct window *
> +create_window(struct display *display, int width, int height,
> +	      enum wl_output_transform transform, int scale,
> +	      enum window_flags flags)
> +{
> +	struct window *window;
> +
> +	if (display->compositor_version < 2 &&
> +	    (transform != WL_OUTPUT_TRANSFORM_NORMAL ||
> +	     flags & WINDOW_FLAG_ROTATING_TRANSFORM)) {
> +		fprintf(stderr, "wl_surface.buffer_transform unsupported in "
> +				"wl_surface version %d\n",
> +			display->compositor_version);
> +		exit(1);
> +	}
> +
> +	if (display->compositor_version < 3 &&
> +	    (! (flags & WINDOW_FLAG_USE_VIEWPORT)) && scale != 1) {
> +		fprintf(stderr, "wl_surface.buffer_scale unsupported in "
> +				"wl_surface version %d\n",
> +			display->compositor_version);
> +		exit(1);
> +	}
> +
> +	if (display->scaler == NULL && (flags & WINDOW_FLAG_USE_VIEWPORT)) {
> +		fprintf(stderr, "Compositor does not support wl_viewport");
> +		exit(1);
> +	}
> +
> +	window = calloc(1, sizeof *window);
> +	if (!window)
> +		return NULL;
> +
> +	window->callback = NULL;
> +	window->display = display;
> +	window->width = width;
> +	window->height = height;
> +	window->border = 10;
> +	window->flags = flags;
> +	window->transform = transform;
> +	window->scale = scale;
> +
> +	window_init_game(window);
> +
> +	window->surface = wl_compositor_create_surface(display->compositor);
> +
> +	if (window->flags & WINDOW_FLAG_USE_VIEWPORT)
> +		window->viewport = wl_scaler_get_viewport(display->scaler,
> +							  window->surface);
> +
> +	if (display->shell) {
> +		window->xdg_surface =
> +			xdg_shell_get_xdg_surface(display->shell,
> +						  window->surface);
> +
> +		assert(window->xdg_surface);
> +
> +		xdg_surface_add_listener(window->xdg_surface,
> +					 &xdg_surface_listener, window);
> +
> +		xdg_surface_set_title(window->xdg_surface, "simple-damage");
> +	} else if (display->fshell) {
> +		_wl_fullscreen_shell_present_surface(display->fshell,
> +						     window->surface,
> +						     _WL_FULLSCREEN_SHELL_PRESENT_METHOD_DEFAULT,
> +						     NULL);
> +	} else {
> +		assert(0);
> +	}
> +
> +	/* Initialise damage to full surface, so the padding gets painted */
> +	wl_surface_damage(window->surface, 0, 0, INT32_MAX, INT32_MAX);
> +
> +	return window;
> +}
> +
> +static void
> +destroy_window(struct window *window)
> +{
> +	if (window->callback)
> +		wl_callback_destroy(window->callback);
> +
> +	if (window->buffers[0].buffer)
> +		wl_buffer_destroy(window->buffers[0].buffer);
> +	if (window->buffers[1].buffer)
> +		wl_buffer_destroy(window->buffers[1].buffer);
> +
> +	if (window->xdg_surface)
> +		xdg_surface_destroy(window->xdg_surface);
> +	if (window->viewport)
> +		wl_viewport_destroy(window->viewport);
> +	wl_surface_destroy(window->surface);
> +	free(window);
> +}
> +
> +static struct buffer *
> +window_next_buffer(struct window *window)
> +{
> +	struct buffer *buffer;
> +	int ret = 0, bwidth, bheight;
> +
> +	if (!window->buffers[0].busy)
> +		buffer = &window->buffers[0];
> +	else if (!window->buffers[1].busy)
> +		buffer = &window->buffers[1];
> +	else
> +		return NULL;
> +
> +	switch (window->transform) {
> +	default:
> +	case WL_OUTPUT_TRANSFORM_NORMAL:
> +	case WL_OUTPUT_TRANSFORM_180:
> +	case WL_OUTPUT_TRANSFORM_FLIPPED:
> +	case WL_OUTPUT_TRANSFORM_FLIPPED_180:
> +		bwidth = window->width * window->scale;
> +		bheight = window->height * window->scale;
> +		break;
> +	case WL_OUTPUT_TRANSFORM_90:
> +	case WL_OUTPUT_TRANSFORM_270:
> +	case WL_OUTPUT_TRANSFORM_FLIPPED_90:
> +	case WL_OUTPUT_TRANSFORM_FLIPPED_270:
> +		bwidth = window->height * window->scale;
> +		bheight = window->width * window->scale;
> +		break;
> +	}
> +
> +	/* If we're using a viewport, we make it double-size and crop */
> +	if (window->viewport) {
> +		bwidth *= 2;
> +		bheight *= 2;
> +	}
> +
> +	if (!buffer->buffer) {
> +		ret = create_shm_buffer(window->display, buffer,
> +					bwidth, bheight,
> +					WL_SHM_FORMAT_ARGB8888);
> +
> +		if (ret < 0)
> +			return NULL;
> +	}
> +
> +	return buffer;
> +}
> +
> +static void
> +paint_box(uint32_t *pixels, int stride, int x, int y, int width, int height,
> +	  uint32_t color)
> +{
> +	int i, j;
> +
> +	for (j = y; j < y + height; ++j)
> +		for (i = x; i < x + width; ++i)
> +			pixels[i + j * stride] = color;
> +}
> +
> +static void
> +paint_circle(uint32_t *pixels, int stride, float x, float y, int radius,
> +	     uint32_t color)
> +{
> +	int i, j;
> +
> +	for (j = y - radius; j <= (int)(y + radius); ++j)
> +		for (i = x - radius; i <= (int)(x + radius); ++i)
> +			if ((j+0.5f-y)*(j+0.5f-y) + (i+0.5f-x)*(i+0.5f-x) <= radius * radius)
> +				pixels[i + j * stride] = color;
> +}
> +
> +static void
> +window_get_transformed_ball(struct window *window, float *bx, float *by)
> +{
> +	float wx, wy;
> +
> +	wx = window->ball.x;
> +	wy = window->ball.y;
> +
> +	switch (window->transform) {
> +	default:
> +	case WL_OUTPUT_TRANSFORM_NORMAL:
> +		*bx = wx;
> +		*by = wy;
> +		break;
> +	case WL_OUTPUT_TRANSFORM_90:
> +		*bx = window->height - wy;
> +		*by = wx;
> +		break;
> +	case WL_OUTPUT_TRANSFORM_180:
> +		*bx = window->width - wx;
> +		*by = window->height - wy;
> +		break;
> +	case WL_OUTPUT_TRANSFORM_270:
> +		*bx = wy;
> +		*by = window->width - wx;
> +		break;
> +	case WL_OUTPUT_TRANSFORM_FLIPPED:
> +		*bx = window->width - wx;
> +		*by = wy;
> +		break;
> +	case WL_OUTPUT_TRANSFORM_FLIPPED_90:
> +		*bx = window->height - wy;
> +		*by = window->width - wx;
> +		break;
> +	case WL_OUTPUT_TRANSFORM_FLIPPED_180:
> +		*bx = wx;
> +		*by = window->height - wy;
> +		break;
> +	case WL_OUTPUT_TRANSFORM_FLIPPED_270:
> +		*bx = wy;
> +		*by = wx;
> +		break;
> +	}

This looks ok, though I didn't really check that this definition
corresponds to the protocol.

> +
> +	*bx *= window->scale;
> +	*by *= window->scale;
> +}
> +
> +static const struct wl_callback_listener frame_listener;
> +
> +static void
> +redraw(void *data, struct wl_callback *callback, uint32_t time)
> +{
> +	struct window *window = data;
> +	struct buffer *buffer;
> +	int bwidth, bheight, bborder, bstride;
> +	uint32_t *buffer_data;
> +	float bx, by;
> +
> +	buffer = window_next_buffer(window);
> +	if (!buffer) {
> +		fprintf(stderr,
> +			!callback ? "Failed to create the first buffer.\n" :
> +			"Both buffers busy at redraw(). Server bug?\n");
> +		abort();
> +	}
> +
> +	/* Rotate the damage, but keep the even/odd parity so the
> +	 * dimensions of the buffers don't change */
> +	if (window->flags & WINDOW_FLAG_ROTATING_TRANSFORM)
> +		window->transform = (window->transform + 2) % 8;
> +
> +	switch (window->transform) {
> +	default:
> +	case WL_OUTPUT_TRANSFORM_NORMAL:
> +	case WL_OUTPUT_TRANSFORM_180:
> +	case WL_OUTPUT_TRANSFORM_FLIPPED:
> +	case WL_OUTPUT_TRANSFORM_FLIPPED_180:
> +		bwidth = window->width * window->scale;
> +		bheight = window->height * window->scale;
> +		break;
> +	case WL_OUTPUT_TRANSFORM_90:
> +	case WL_OUTPUT_TRANSFORM_270:
> +	case WL_OUTPUT_TRANSFORM_FLIPPED_90:
> +	case WL_OUTPUT_TRANSFORM_FLIPPED_270:
> +		bwidth = window->height * window->scale;
> +		bheight = window->width * window->scale;
> +		break;
> +	}
> +
> +	if (window->viewport) {
> +		/* The buffer is actually twice as big.  We'll crop it down
> +		 * to size */
> +		bstride = bwidth * 2;

You seem to always use stride in units of pixels. I'm used to
seeing it in bytes. Maybe use pitch instead or just add a comment?

> +		buffer_data = buffer->shm_data;
> +
> +		switch (window->transform) {
> +		case WL_OUTPUT_TRANSFORM_NORMAL:
> +			buffer_data += (bheight / 4) * bstride +
> +				       (bwidth / 3);
> +			break;
> +		case WL_OUTPUT_TRANSFORM_90:
> +			buffer_data += (bheight / 3) * bstride +
> +				       (bwidth - bwidth / 4);
> +			break;
> +		case WL_OUTPUT_TRANSFORM_180:
> +			buffer_data += (bheight - bheight / 4) * bstride +
> +				       (bwidth - bwidth / 3);
> +			break;
> +		case WL_OUTPUT_TRANSFORM_270:
> +			buffer_data += (bheight - bheight / 3) * bstride +
> +				       (bwidth / 4);
> +			break;
> +		case WL_OUTPUT_TRANSFORM_FLIPPED:
> +			buffer_data += (bheight / 4) * bstride +
> +				       (bwidth - bwidth / 3);
> +			break;
> +		case WL_OUTPUT_TRANSFORM_FLIPPED_90:
> +			buffer_data += (bheight - bheight / 3) * bstride +
> +				       (bwidth - bwidth / 4);
> +			break;
> +		case WL_OUTPUT_TRANSFORM_FLIPPED_180:
> +			buffer_data += (bheight - bheight / 4) * bstride +
> +				       (bwidth / 3);
> +			break;
> +		case WL_OUTPUT_TRANSFORM_FLIPPED_270:
> +			buffer_data += (bheight / 3) * bstride +
> +				       (bwidth / 4);
> +			break;
> +		}
> +
> +		wl_viewport_set_source(window->viewport,
> +				       wl_fixed_from_int(window->width * window->scale / 3),
> +				       wl_fixed_from_int(window->height * window->scale / 4),
> +				       wl_fixed_from_int(window->width * window->scale),
> +				       wl_fixed_from_int(window->height * window->scale));

This is not right... is it?

Viewport's source is defined in "old" surface coordinates, and the
destination is defined in "new" surface coordinates. Therefore I
think the multiplication by window->scale is wrong, window->width
is the intended surface width in surface coordinates.

Hrm, see the comment about setting buffer_scale below.

> +
> +		/* Fill the whole thing with red to detect viewport errors */
> +		paint_box(buffer->shm_data, bstride,
> +			  0, 0, bwidth * 2, bheight * 2, 0xffff0000);
> +	} else {
> +		bstride = bwidth;
> +		buffer_data = buffer->shm_data;
> +	}
> +
> +	bborder = window->border * window->scale;
> +
> +	/* Paint the border */
> +	paint_box(buffer_data, bstride, 0, 0, bwidth, bborder, 0xffffffff);
> +	paint_box(buffer_data, bstride, 0, 0, bborder, bheight, 0xffffffff);
> +	paint_box(buffer_data, bstride,
> +		  bwidth - bborder, 0, bborder, bheight, 0xffffffff);
> +	paint_box(buffer_data, bstride,
> +		  0, bheight - bborder, bwidth, bborder, 0xffffffff);
> +
> +	/* fill with translucent */
> +	paint_box(buffer_data, bstride, bborder, bborder,
> +		  bwidth - 2 * bborder, bheight - 2 * bborder, 0x80000000);
> +
> +	/* Damage where the ball was */
> +	wl_surface_damage(window->surface,
> +			  window->ball.x - window->ball.radius,
> +			  window->ball.y - window->ball.radius,
> +			  window->ball.radius * 2 + 1,
> +			  window->ball.radius * 2 + 1);
> +
> +	window_advance_game(window, time);
> +
> +	window_get_transformed_ball(window, &bx, &by);
> +
> +	/* Paint the ball */
> +	paint_circle(buffer_data, bstride, bx, by,
> +		     window->ball.radius * window->scale, 0xff00ff00);
> +
> +	if (print_debug) {
> +		printf("Ball now located at (%f, %f)\n",
> +		       window->ball.x, window->ball.y);
> +
> +		printf("Circle painted at (%f, %f), radius %d\n", bx, by,
> +		       window->ball.radius * window->scale);
> +
> +		printf("Buffer damage rectangle: (%d, %d) @ %dx%d\n",
> +		       (int)(bx - window->ball.radius * window->scale),
> +		       (int)(by - window->ball.radius * window->scale),
> +		       window->ball.radius * window->scale * 2 + 1,
> +		       window->ball.radius * window->scale * 2 + 1);
> +	}
> +
> +	/* Damage where the ball is now */
> +	wl_surface_damage(window->surface,
> +			  window->ball.x - window->ball.radius,
> +			  window->ball.y - window->ball.radius,
> +			  window->ball.radius * 2 + 1,
> +			  window->ball.radius * 2 + 1);
> +
> +	wl_surface_attach(window->surface, buffer->buffer, 0, 0);
> +
> +	if (window->display->compositor_version >= 2 &&
> +	    window->transform != WL_OUTPUT_TRANSFORM_NORMAL)
> +		wl_surface_set_buffer_transform(window->surface,
> +						window->transform);

If you rotate transforms, does this not skip setting back to NORMAL?

> +
> +	if (window->scale != 1) {
> +		if (window->viewport) {
> +			wl_viewport_set_destination(window->viewport,
> +						    window->width,
> +						    window->height);
> +		} else {
> +			wl_surface_set_buffer_scale(window->surface,
> +						    window->scale);

Wait, why are you not setting buffer_scale if you use also viewport?

You can get the same end effect, yes, but we skip testing
buffer_scale+viewport. And the math earlier seems confusing as I
commented.

> +		}
> +	}
> +
> +	if (callback)
> +		wl_callback_destroy(callback);
> +
> +	window->callback = wl_surface_frame(window->surface);
> +	wl_callback_add_listener(window->callback, &frame_listener, window);
> +	wl_surface_commit(window->surface);
> +	buffer->busy = 1;
> +}
> +
> +static const struct wl_callback_listener frame_listener = {
> +	redraw
> +};
> +
> +static void
> +shm_format(void *data, struct wl_shm *wl_shm, uint32_t format)
> +{
> +	struct display *d = data;
> +
> +	d->formats |= (1 << format);
> +}
> +
> +struct wl_shm_listener shm_listener = {
> +	shm_format
> +};
> +
> +static void
> +xdg_shell_ping(void *data, struct xdg_shell *shell, uint32_t serial)
> +{
> +	xdg_shell_pong(shell, serial);
> +}
> +
> +static const struct xdg_shell_listener xdg_shell_listener = {
> +	xdg_shell_ping,
> +};
> +
> +#define XDG_VERSION 3 /* The version of xdg-shell that we implement */
> +#ifdef static_assert
> +static_assert(XDG_VERSION == XDG_SHELL_VERSION_CURRENT,
> +	      "Interface version doesn't match implementation version");
> +#endif
> +
> +static void
> +registry_handle_global(void *data, struct wl_registry *registry,
> +		       uint32_t id, const char *interface, uint32_t version)
> +{
> +	struct display *d = data;
> +
> +	if (strcmp(interface, "wl_compositor") == 0) {
> +		if (d->compositor_version > (int)version) {
> +			fprintf(stderr, "Compositor does not support "
> +				"wl_surface version %d\n", d->compositor_version);
> +			exit(1);
> +		}
> +
> +		if (d->compositor_version > 0)
> +			version = d->compositor_version;
> +
> +		d->compositor =
> +			wl_registry_bind(registry,
> +					 id, &wl_compositor_interface, version);
> +	} else if (strcmp(interface, "wl_scaler") == 0 && version >= 2) {
> +		d->scaler = wl_registry_bind(registry,
> +					     id, &wl_scaler_interface, 2);
> +	} else if (strcmp(interface, "xdg_shell") == 0) {
> +		d->shell = wl_registry_bind(registry,
> +					    id, &xdg_shell_interface, 1);
> +		xdg_shell_use_unstable_version(d->shell, XDG_VERSION);
> +		xdg_shell_add_listener(d->shell, &xdg_shell_listener, d);
> +	} else if (strcmp(interface, "_wl_fullscreen_shell") == 0) {
> +		d->fshell = wl_registry_bind(registry,
> +					     id, &_wl_fullscreen_shell_interface, 1);
> +	} else if (strcmp(interface, "wl_shm") == 0) {
> +		d->shm = wl_registry_bind(registry,
> +					  id, &wl_shm_interface, 1);
> +		wl_shm_add_listener(d->shm, &shm_listener, d);
> +	}
> +}
> +
> +static void
> +registry_handle_global_remove(void *data, struct wl_registry *registry,
> +			      uint32_t name)
> +{
> +}
> +
> +static const struct wl_registry_listener registry_listener = {
> +	registry_handle_global,
> +	registry_handle_global_remove
> +};
> +
> +static struct display *
> +create_display(int version)
> +{
> +	struct display *display;
> +
> +	display = malloc(sizeof *display);
> +	if (display == NULL) {
> +		fprintf(stderr, "out of memory\n");
> +		exit(1);
> +	}
> +	display->display = wl_display_connect(NULL);
> +	assert(display->display);
> +
> +	display->compositor_version = version;
> +	display->formats = 0;
> +	display->registry = wl_display_get_registry(display->display);
> +	wl_registry_add_listener(display->registry,
> +				 &registry_listener, display);
> +	wl_display_roundtrip(display->display);
> +	if (display->shm == NULL) {
> +		fprintf(stderr, "No wl_shm global\n");
> +		exit(1);
> +	}
> +
> +	wl_display_roundtrip(display->display);
> +
> +	if (!(display->formats & (1 << WL_SHM_FORMAT_XRGB8888))) {
> +		fprintf(stderr, "WL_SHM_FORMAT_XRGB32 not available\n");
> +		exit(1);
> +	}
> +
> +	return display;
> +}
> +
> +static void
> +destroy_display(struct display *display)
> +{
> +	if (display->shm)
> +		wl_shm_destroy(display->shm);
> +
> +	if (display->shell)
> +		xdg_shell_destroy(display->shell);
> +
> +	if (display->fshell)
> +		_wl_fullscreen_shell_release(display->fshell);
> +
> +	if (display->scaler)
> +		wl_scaler_destroy(display->scaler);
> +
> +	if (display->compositor)
> +		wl_compositor_destroy(display->compositor);
> +
> +	wl_registry_destroy(display->registry);
> +	wl_display_flush(display->display);
> +	wl_display_disconnect(display->display);
> +	free(display);
> +}
> +
> +static void
> +signal_int(int signum)
> +{
> +	running = 0;
> +}
> +
> +static void
> +print_usage(int retval)
> +{
> +	printf(
> +		"usage: weston-simple-damage [options]\n\n"
> +		"options:\n"
> +		"  -h, --help\t\tPring this help\n"
> +		"  --verbose\t\tPrint verbose log information\n"
> +		"  --version=VERSION\tVersion of wl_surface to use\n"
> +		"  --width=WIDTH\t\tWidth of the window\n"
> +		"  --height=HEIGHT\tHeight of the window\n"
> +		"  --scale=SCALE\t\tScale factor for the surface\n"
> +		"  --transform=TRANSFORM\tTransform for the surface\n"
> +		"  --rotating-transform\tUse a different buffer_transform for each frame\n"
> +		"  --use-viewport\tUse wl_viewport\n"
> +	);
> +
> +	exit(retval);
> +}
> +
> +static int
> +parse_transform(const char *str, enum wl_output_transform *transform)
> +{
> +	int i;
> +	static const struct {
> +		const char *name;
> +		enum wl_output_transform transform;
> +	} names[] = {
> +		{ "normal",	WL_OUTPUT_TRANSFORM_NORMAL },
> +		{ "90",		WL_OUTPUT_TRANSFORM_90 },
> +		{ "180",	WL_OUTPUT_TRANSFORM_180 },
> +		{ "270",	WL_OUTPUT_TRANSFORM_270 },
> +		{ "flipped",	WL_OUTPUT_TRANSFORM_FLIPPED },
> +		{ "flipped-90",	WL_OUTPUT_TRANSFORM_FLIPPED_90 },
> +		{ "flipped-180", WL_OUTPUT_TRANSFORM_FLIPPED_180 },
> +		{ "flipped-270", WL_OUTPUT_TRANSFORM_FLIPPED_270 },
> +	};
> +
> +	for (i = 0; i < 8; i++) {
> +		if (strcmp(names[i].name, str) == 0) {
> +			*transform = names[i].transform;
> +			return 1;
> +		}
> +	}
> +
> +	return 0;
> +}
> +
> +int
> +main(int argc, char **argv)
> +{
> +	struct sigaction sigint;
> +	struct display *display;
> +	struct window *window;
> +	int i, ret = 0;
> +	int version = 0;
> +	int width = 300, height = 200, scale = 1;
> +	enum wl_output_transform transform = WL_OUTPUT_TRANSFORM_NORMAL;
> +	enum window_flags flags = 0;
> +
> +	for (i = 1; i < argc; ++i) {
> +		if (strcmp(argv[i], "--help") == 0 ||
> +		    strcmp(argv[i], "-h") == 0) {
> +			print_usage(0);
> +		} else if (sscanf(argv[i], "--version=%d", &version) > 0) {
> +			if (version < 1 || version > 3) {
> +				fprintf(stderr, "Unsupported wl_surface version: %d\n",
> +					version);
> +				return 1;
> +			}
> +			continue;
> +		} else if (strcmp(argv[i], "--verbose") == 0) {
> +			print_debug = 1;
> +			continue;
> +		} else if (sscanf(argv[i], "--width=%d", &width) > 0) {
> +			continue;
> +		} else if (sscanf(argv[i], "--height=%d", &height) > 0) {
> +			continue;
> +		} else if (strncmp(argv[i], "--transform=", 12) == 0 &&
> +			   parse_transform(argv[i] + 12, &transform) > 0) {
> +			continue;
> +		} else if (strcmp(argv[i], "--rotating-transform") == 0) {
> +			flags |= WINDOW_FLAG_ROTATING_TRANSFORM;
> +			continue;
> +		} else if (sscanf(argv[i], "--scale=%d", &scale) > 0) {
> +			continue;
> +		} else if (strcmp(argv[i], "--use-viewport") == 0) {
> +			flags |= WINDOW_FLAG_USE_VIEWPORT;
> +			continue;
> +		} else {
> +			printf("Invalid option: %s\n", argv[i]);
> +			print_usage(255);
> +		}
> +	}
> +
> +	display = create_display(version);
> +
> +	window = create_window(display, width, height, transform, scale, flags);
> +	if (!window)
> +		return 1;
> +
> +	sigint.sa_handler = signal_int;
> +	sigemptyset(&sigint.sa_mask);
> +	sigint.sa_flags = SA_RESETHAND;
> +	sigaction(SIGINT, &sigint, NULL);
> +
> +	redraw(window, NULL, 0);
> +
> +	while (running && ret != -1)
> +		ret = wl_display_dispatch(display->display);
> +
> +	fprintf(stderr, "simple-shm exiting\n");
> +	destroy_window(window);
> +	destroy_display(display);
> +
> +	return 0;
> +}
> -- 

This test program is an excellent idea. If you don't want another
review after you have addressed the issues I raised above, feel
free to push this.


Thanks,
pq


More information about the wayland-devel mailing list