weston/tests/output-capture-protocol-test.c

/*
 * Copyright 2022 Collabora, Ltd.
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice (including the
 * next paragraph) shall be included in all copies or substantial
 * portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#include "config.h"

#include "weston-test-client-helper.h"
#include "weston-test-fixture-compositor.h"
#include "shared/xalloc.h"
#include "weston-output-capture-client-protocol.h"
#include "weston-test-assert.h"
#include "shared/client-buffer-util.h"
#include "shared/weston-drm-fourcc.h"

#define SKIP_NO_UDMABUF(buffer_type)						  \
do {										  \
	enum client_buffer_type type = (buffer_type);				  \
										  \
	if (type == CLIENT_BUFFER_TYPE_DMABUF && 				  \
	    !client_buffer_util_is_dmabuf_supported()) { 			  \
		testlog("%s: Skipped: udmabuf not supported\n", get_test_name()); \
		return RESULT_SKIP;						  \
	} 									  \
} while (0)

struct setup_args {
	struct fixture_metadata meta;
	enum weston_renderer_type renderer;
	enum client_buffer_type buffer_type;
	uint32_t expected_drm_format;
};

static const struct setup_args my_setup_args[] = {
	{
		.meta.name = "pixman",
		.renderer = WESTON_RENDERER_PIXMAN,
		.buffer_type = CLIENT_BUFFER_TYPE_SHM,
		.expected_drm_format = DRM_FORMAT_XRGB8888,
	},
	{
		.meta.name = "GL-shm",
		.renderer = WESTON_RENDERER_GL,
		.buffer_type = CLIENT_BUFFER_TYPE_SHM,
		.expected_drm_format = DRM_FORMAT_ARGB8888,
	},
	{
		.meta.name = "GL-dmabuf",
		.renderer = WESTON_RENDERER_GL,
		.buffer_type = CLIENT_BUFFER_TYPE_DMABUF,
		.expected_drm_format = DRM_FORMAT_ARGB8888,
	},
	{
		.meta.name = "Vulkan",
		.renderer = WESTON_RENDERER_VULKAN,
		.buffer_type = CLIENT_BUFFER_TYPE_SHM,
		.expected_drm_format = DRM_FORMAT_ARGB8888,
	},
};

static enum test_result_code
fixture_setup(struct weston_test_harness *harness, const struct setup_args *arg)
{
	struct compositor_setup setup;

	compositor_setup_defaults(&setup);
	setup.renderer = arg->renderer;
	setup.width = 100;
	setup.height = 60;
	setup.shell = SHELL_TEST_DESKTOP;

	return weston_test_harness_execute_as_client(harness, &setup);
}
DECLARE_FIXTURE_SETUP_WITH_ARG(fixture_setup, my_setup_args, meta);

struct capturer {
	int width;
	int height;
	uint32_t drm_format;

	struct weston_capture_v1 *factory;
	struct weston_capture_source_v1 *source;

	enum {
		CAPTURE_TASK_PENDING = 0,
		CAPTURE_TASK_COMPLETE,
		CAPTURE_TASK_RETRY,
		CAPTURE_TASK_FAILED,
	} state;

	struct {
		bool size;
		bool format;
		bool formats_done;
		bool reply;
	} events;

	char *last_failure;
};

static void
capture_source_handle_format(void *data,
			     struct weston_capture_source_v1 *proxy,
			     uint32_t drm_format)
{
	struct capturer *capt = data;

	test_assert_ptr_eq(capt->source, proxy);

	if (capt->events.formats_done) {
		capt->drm_format = DRM_FORMAT_INVALID;
		capt->events.formats_done = false;
	}

	capt->events.format = true;
	if (capt->drm_format == DRM_FORMAT_INVALID)
		capt->drm_format = drm_format;
}

static void
capture_source_handle_formats_done(void *data,
				   struct weston_capture_source_v1 *proxy)
{
	struct capturer *capt = data;

	test_assert_ptr_eq(capt->source, proxy);

	capt->events.formats_done = true;
}

static void
capture_source_handle_size(void *data,
			   struct weston_capture_source_v1 *proxy,
			   int32_t width, int32_t height)
{
	struct capturer *capt = data;

	test_assert_ptr_eq(capt->source, proxy);

	capt->events.size = true;
	capt->width = width;
	capt->height = height;
}

static void
capture_source_handle_complete(void *data,
			       struct weston_capture_source_v1 *proxy)
{
	struct capturer *capt = data;

	test_assert_ptr_eq(capt->source, proxy);
	test_assert_enum(capt->state, CAPTURE_TASK_PENDING);
	capt->state = CAPTURE_TASK_COMPLETE;
	capt->events.reply = true;
}

static void
capture_source_handle_retry(void *data,
			    struct weston_capture_source_v1 *proxy)
{
	struct capturer *capt = data;

	test_assert_ptr_eq(capt->source, proxy);
	test_assert_enum(capt->state, CAPTURE_TASK_PENDING);
	capt->state = CAPTURE_TASK_RETRY;
	capt->events.reply = true;
}

static void
capture_source_handle_failed(void *data,
			     struct weston_capture_source_v1 *proxy,
			     const char *msg)
{
	struct capturer *capt = data;

	test_assert_ptr_eq(capt->source, proxy);
	test_assert_enum(capt->state, CAPTURE_TASK_PENDING);
	capt->state = CAPTURE_TASK_FAILED;
	capt->events.reply = true;

	free(capt->last_failure);
	capt->last_failure = msg ? xstrdup(msg) : NULL;
}

static const struct weston_capture_source_v1_listener capture_source_handlers = {
	.format = capture_source_handle_format,
	.formats_done = capture_source_handle_formats_done,
	.size = capture_source_handle_size,
	.complete = capture_source_handle_complete,
	.retry = capture_source_handle_retry,
	.failed = capture_source_handle_failed,
};

static struct capturer *
capturer_create(struct client *client,
		struct output *output,
		enum weston_capture_v1_source src)
{
	struct capturer *capt;

	capt = xzalloc(sizeof *capt);

	capt->factory = bind_to_singleton_global(client,
						 &weston_capture_v1_interface,
						 2);

	capt->source = weston_capture_v1_create(capt->factory,
						output->wl_output, src);
	weston_capture_source_v1_add_listener(capt->source,
					      &capture_source_handlers, capt);

	return capt;
}

static void
capturer_destroy(struct capturer *capt)
{
	weston_capture_source_v1_destroy(capt->source);
	weston_capture_v1_destroy(capt->factory);
	free(capt->last_failure);
	free(capt);
}

/*
 * Use the guaranteed source and all the right parameters to check that
 * shooting succeeds on the first try.
 */
TEST(simple_shot)
{
	const struct setup_args *fix = &my_setup_args[get_test_fixture_index()];
	struct client *client;
	struct capturer *capt;
	struct buffer *buf;

	client = create_client();
	capt = capturer_create(client, client->output,
			       WESTON_CAPTURE_V1_SOURCE_FRAMEBUFFER);
	client_roundtrip(client);

	test_assert_true(capt->events.format);
	test_assert_true(capt->events.formats_done);
	test_assert_true(capt->events.size);
	test_assert_enum(capt->state, CAPTURE_TASK_PENDING);
	test_assert_u32_eq(capt->drm_format, fix->expected_drm_format);
	test_assert_int_gt(capt->width, 0);
	test_assert_int_gt(capt->height, 0);
	test_assert_false(capt->events.reply);

	SKIP_NO_UDMABUF(fix->buffer_type);
	buf = create_buffer(client, capt->width, capt->height,
			    fix->expected_drm_format, fix->buffer_type);

	weston_capture_source_v1_capture(capt->source, buf->proxy);
	while (!capt->events.reply)
		if (!test_assert_int_ge(wl_display_dispatch(client->wl_display), 0))
			return RESULT_FAIL;

	test_assert_enum(capt->state, CAPTURE_TASK_COMPLETE);

	capturer_destroy(capt);
	buffer_destroy(buf);
	client_destroy(client);

	return RESULT_OK;
}

/*
 * Use a guaranteed source, but use an unsupported pixel format.
 * This should always cause a retry.
 */
TEST(retry_on_wrong_format)
{
	const struct setup_args *fix = &my_setup_args[get_test_fixture_index()];
	const uint32_t drm_format = DRM_FORMAT_ABGR2101010;
	struct client *client;
	struct capturer *capt;
	struct buffer *buf;

	client = create_client();
	capt = capturer_create(client, client->output,
			       WESTON_CAPTURE_V1_SOURCE_FRAMEBUFFER);
	client_roundtrip(client);

	test_assert_true(capt->events.format);
	test_assert_true(capt->events.formats_done);
	test_assert_true(capt->events.size);
	test_assert_enum(capt->state, CAPTURE_TASK_PENDING);

	/* Fix this test if triggered. */
	test_assert_u32_ne(capt->drm_format, drm_format);

	test_assert_int_gt(capt->width, 0);
	test_assert_int_gt(capt->height, 0);
	test_assert_false(capt->events.reply);

	SKIP_NO_UDMABUF(fix->buffer_type);
	buf = create_buffer(client, capt->width, capt->height,
			    drm_format, fix->buffer_type);

	weston_capture_source_v1_capture(capt->source, buf->proxy);
	while (!capt->events.reply)
		if (!test_assert_int_ge(wl_display_dispatch(client->wl_display), 0))
			return RESULT_FAIL;

	test_assert_enum(capt->state, CAPTURE_TASK_RETRY);

	capturer_destroy(capt);
	buffer_destroy(buf);
	client_destroy(client);

	return RESULT_OK;
}

/*
 * Use a guaranteed source, but use a smaller buffer size.
 * This should always cause a retry.
 */
TEST(retry_on_wrong_size)
{
	const struct setup_args *fix = &my_setup_args[get_test_fixture_index()];
	struct client *client;
	struct capturer *capt;
	struct buffer *buf;

	client = create_client();
	capt = capturer_create(client, client->output,
			       WESTON_CAPTURE_V1_SOURCE_FRAMEBUFFER);
	client_roundtrip(client);

	test_assert_true(capt->events.format);
	test_assert_true(capt->events.formats_done);
	test_assert_true(capt->events.size);
	test_assert_enum(capt->state, CAPTURE_TASK_PENDING);
	test_assert_int_gt(capt->width, 5);
	test_assert_int_gt(capt->height, 5);
	test_assert_false(capt->events.reply);

	SKIP_NO_UDMABUF(fix->buffer_type);
	buf = create_buffer(client, capt->width - 3, capt->height - 3,
			    fix->expected_drm_format, fix->buffer_type);

	weston_capture_source_v1_capture(capt->source, buf->proxy);
	while (!capt->events.reply)
		if (!test_assert_int_ge(wl_display_dispatch(client->wl_display), 0))
			return RESULT_FAIL;

	test_assert_enum(capt->state, CAPTURE_TASK_RETRY);

	capturer_destroy(capt);
	buffer_destroy(buf);
	client_destroy(client);

	return RESULT_OK;
}

/*
 * Try a source that is guaranteed to not exist, and check that
 * capturing fails.
 */
TEST(writeback_on_headless_fails)
{
	struct client *client;
	struct capturer *capt;
	struct buffer *buf;

	client = create_client();
	buf = create_shm_buffer_a8r8g8b8(client, 5, 5);
	capt = capturer_create(client, client->output,
			       WESTON_CAPTURE_V1_SOURCE_WRITEBACK);
	client_roundtrip(client);

	test_assert_false(capt->events.format);
	test_assert_false(capt->events.formats_done);
	test_assert_false(capt->events.size);
	test_assert_enum(capt->state, CAPTURE_TASK_PENDING);

	/* Trying pixel source that is not available should fail immediately */
	weston_capture_source_v1_capture(capt->source, buf->proxy);
	client_roundtrip(client);

	test_assert_false(capt->events.format);
	test_assert_false(capt->events.formats_done);
	test_assert_false(capt->events.size);
	test_assert_enum(capt->state, CAPTURE_TASK_FAILED);
	test_assert_str_eq(capt->last_failure, "source unavailable");

	capturer_destroy(capt);
	buffer_destroy(buf);
	client_destroy(client);

	return RESULT_OK;
}