2 * Copyright © 2012 Intel Corporation
4 * Permission is hereby granted, free of charge, to any person obtaining
5 * a copy of this software and associated documentation files (the
6 * "Software"), to deal in the Software without restriction, including
7 * without limitation the rights to use, copy, modify, merge, publish,
8 * distribute, sublicense, and/or sell copies of the Software, and to
9 * permit persons to whom the Software is furnished to do so, subject to
10 * the following conditions:
12 * The above copyright notice and this permission notice (including the
13 * next paragraph) shall be included in all copies or substantial
14 * portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
20 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
21 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
36 #include "shared/os-compatibility.h"
37 #include "shared/xalloc.h"
38 #include "shared/zalloc.h"
39 #include "weston-test-client-helper.h"
41 #define max(a, b) (((a) > (b)) ? (a) : (b))
42 #define min(a, b) (((a) > (b)) ? (b) : (a))
43 #define clip(x, a, b) min(max(x, a), b)
46 surface_contains(struct surface *surface, int x, int y)
48 /* test whether a global x,y point is contained in the surface */
51 int sw = surface->width;
52 int sh = surface->height;
53 return x >= sx && y >= sy && x < sx + sw && y < sy + sh;
57 frame_callback_handler(void *data, struct wl_callback *callback, uint32_t time)
63 wl_callback_destroy(callback);
66 static const struct wl_callback_listener frame_listener = {
67 frame_callback_handler
71 frame_callback_set(struct wl_surface *surface, int *done)
73 struct wl_callback *callback;
76 callback = wl_surface_frame(surface);
77 wl_callback_add_listener(callback, &frame_listener, done);
83 frame_callback_wait_nofail(struct client *client, int *done)
86 if (wl_display_dispatch(client->wl_display) < 0)
94 move_client(struct client *client, int x, int y)
96 struct surface *surface = client->surface;
99 client->surface->x = x;
100 client->surface->y = y;
101 weston_test_move_surface(client->test->weston_test, surface->wl_surface,
102 surface->x, surface->y);
103 /* The attach here is necessary because commit() will call configure
104 * only on surfaces newly attached, and the one that sets the surface
105 * position is the configure. */
106 wl_surface_attach(surface->wl_surface, surface->buffer->proxy, 0, 0);
107 wl_surface_damage(surface->wl_surface, 0, 0, surface->width,
110 frame_callback_set(surface->wl_surface, &done);
112 wl_surface_commit(surface->wl_surface);
114 frame_callback_wait(client, &done);
118 get_n_egl_buffers(struct client *client)
120 client->test->n_egl_buffers = -1;
122 weston_test_get_n_egl_buffers(client->test->weston_test);
123 wl_display_roundtrip(client->wl_display);
125 return client->test->n_egl_buffers;
129 pointer_handle_enter(void *data, struct wl_pointer *wl_pointer,
130 uint32_t serial, struct wl_surface *wl_surface,
131 wl_fixed_t x, wl_fixed_t y)
133 struct pointer *pointer = data;
136 pointer->focus = wl_surface_get_user_data(wl_surface);
138 pointer->focus = NULL;
140 pointer->x = wl_fixed_to_int(x);
141 pointer->y = wl_fixed_to_int(y);
143 fprintf(stderr, "test-client: got pointer enter %d %d, surface %p\n",
144 pointer->x, pointer->y, pointer->focus);
148 pointer_handle_leave(void *data, struct wl_pointer *wl_pointer,
149 uint32_t serial, struct wl_surface *wl_surface)
151 struct pointer *pointer = data;
153 pointer->focus = NULL;
155 fprintf(stderr, "test-client: got pointer leave, surface %p\n",
156 wl_surface ? wl_surface_get_user_data(wl_surface) : NULL);
160 pointer_handle_motion(void *data, struct wl_pointer *wl_pointer,
161 uint32_t time, wl_fixed_t x, wl_fixed_t y)
163 struct pointer *pointer = data;
165 pointer->x = wl_fixed_to_int(x);
166 pointer->y = wl_fixed_to_int(y);
168 fprintf(stderr, "test-client: got pointer motion %d %d\n",
169 pointer->x, pointer->y);
173 pointer_handle_button(void *data, struct wl_pointer *wl_pointer,
174 uint32_t serial, uint32_t time, uint32_t button,
177 struct pointer *pointer = data;
179 pointer->button = button;
180 pointer->state = state;
182 fprintf(stderr, "test-client: got pointer button %u %u\n",
187 pointer_handle_axis(void *data, struct wl_pointer *wl_pointer,
188 uint32_t time, uint32_t axis, wl_fixed_t value)
190 fprintf(stderr, "test-client: got pointer axis %u %f\n",
191 axis, wl_fixed_to_double(value));
195 pointer_handle_frame(void *data, struct wl_pointer *wl_pointer)
197 fprintf(stderr, "test-client: got pointer frame\n");
201 pointer_handle_axis_source(void *data, struct wl_pointer *wl_pointer,
204 fprintf(stderr, "test-client: got pointer axis source %u\n", source);
208 pointer_handle_axis_stop(void *data, struct wl_pointer *wl_pointer,
209 uint32_t time, uint32_t axis)
211 fprintf(stderr, "test-client: got pointer axis stop\n");
215 pointer_handle_axis_discrete(void *data, struct wl_pointer *wl_pointer,
216 uint32_t axis, int32_t value)
218 fprintf(stderr, "test-client: got pointer axis discrete %u %d\n",
222 static const struct wl_pointer_listener pointer_listener = {
223 pointer_handle_enter,
224 pointer_handle_leave,
225 pointer_handle_motion,
226 pointer_handle_button,
228 pointer_handle_frame,
229 pointer_handle_axis_source,
230 pointer_handle_axis_stop,
231 pointer_handle_axis_discrete,
235 keyboard_handle_keymap(void *data, struct wl_keyboard *wl_keyboard,
236 uint32_t format, int fd, uint32_t size)
240 fprintf(stderr, "test-client: got keyboard keymap\n");
244 keyboard_handle_enter(void *data, struct wl_keyboard *wl_keyboard,
245 uint32_t serial, struct wl_surface *wl_surface,
246 struct wl_array *keys)
248 struct keyboard *keyboard = data;
251 keyboard->focus = wl_surface_get_user_data(wl_surface);
253 keyboard->focus = NULL;
255 fprintf(stderr, "test-client: got keyboard enter, surface %p\n",
260 keyboard_handle_leave(void *data, struct wl_keyboard *wl_keyboard,
261 uint32_t serial, struct wl_surface *wl_surface)
263 struct keyboard *keyboard = data;
265 keyboard->focus = NULL;
267 fprintf(stderr, "test-client: got keyboard leave, surface %p\n",
268 wl_surface ? wl_surface_get_user_data(wl_surface) : NULL);
272 keyboard_handle_key(void *data, struct wl_keyboard *wl_keyboard,
273 uint32_t serial, uint32_t time, uint32_t key,
276 struct keyboard *keyboard = data;
279 keyboard->state = state;
281 fprintf(stderr, "test-client: got keyboard key %u %u\n", key, state);
285 keyboard_handle_modifiers(void *data, struct wl_keyboard *wl_keyboard,
286 uint32_t serial, uint32_t mods_depressed,
287 uint32_t mods_latched, uint32_t mods_locked,
290 struct keyboard *keyboard = data;
292 keyboard->mods_depressed = mods_depressed;
293 keyboard->mods_latched = mods_latched;
294 keyboard->mods_locked = mods_locked;
295 keyboard->group = group;
297 fprintf(stderr, "test-client: got keyboard modifiers %u %u %u %u\n",
298 mods_depressed, mods_latched, mods_locked, group);
302 keyboard_handle_repeat_info(void *data, struct wl_keyboard *wl_keyboard,
303 int32_t rate, int32_t delay)
305 struct keyboard *keyboard = data;
307 keyboard->repeat_info.rate = rate;
308 keyboard->repeat_info.delay = delay;
310 fprintf(stderr, "test-client: got keyboard repeat_info %d %d\n",
314 static const struct wl_keyboard_listener keyboard_listener = {
315 keyboard_handle_keymap,
316 keyboard_handle_enter,
317 keyboard_handle_leave,
319 keyboard_handle_modifiers,
320 keyboard_handle_repeat_info,
324 touch_handle_down(void *data, struct wl_touch *wl_touch,
325 uint32_t serial, uint32_t time, struct wl_surface *surface,
326 int32_t id, wl_fixed_t x_w, wl_fixed_t y_w)
328 struct touch *touch = data;
330 touch->down_x = wl_fixed_to_int(x_w);
331 touch->down_y = wl_fixed_to_int(y_w);
334 fprintf(stderr, "test-client: got touch down %d %d, surf: %p, id: %d\n",
335 touch->down_x, touch->down_y, surface, id);
339 touch_handle_up(void *data, struct wl_touch *wl_touch,
340 uint32_t serial, uint32_t time, int32_t id)
342 struct touch *touch = data;
345 fprintf(stderr, "test-client: got touch up, id: %d\n", id);
349 touch_handle_motion(void *data, struct wl_touch *wl_touch,
350 uint32_t time, int32_t id, wl_fixed_t x_w, wl_fixed_t y_w)
352 struct touch *touch = data;
353 touch->x = wl_fixed_to_int(x_w);
354 touch->y = wl_fixed_to_int(y_w);
356 fprintf(stderr, "test-client: got touch motion, %d %d, id: %d\n",
357 touch->x, touch->y, id);
361 touch_handle_frame(void *data, struct wl_touch *wl_touch)
363 struct touch *touch = data;
367 fprintf(stderr, "test-client: got touch frame (%d)\n", touch->frame_no);
371 touch_handle_cancel(void *data, struct wl_touch *wl_touch)
373 struct touch *touch = data;
377 fprintf(stderr, "test-client: got touch cancel (%d)\n", touch->cancel_no);
380 static const struct wl_touch_listener touch_listener = {
389 surface_enter(void *data,
390 struct wl_surface *wl_surface, struct wl_output *output)
392 struct surface *surface = data;
394 surface->output = wl_output_get_user_data(output);
396 fprintf(stderr, "test-client: got surface enter output %p\n",
401 surface_leave(void *data,
402 struct wl_surface *wl_surface, struct wl_output *output)
404 struct surface *surface = data;
406 surface->output = NULL;
408 fprintf(stderr, "test-client: got surface leave output %p\n",
409 wl_output_get_user_data(output));
412 static const struct wl_surface_listener surface_listener = {
417 static struct wl_buffer *
418 create_shm_buffer(struct client *client, int width, int height, void **pixels)
420 struct wl_shm *shm = client->wl_shm;
421 int stride = width * 4;
422 int size = stride * height;
423 struct wl_shm_pool *pool;
424 struct wl_buffer *buffer;
428 fd = os_create_anonymous_file(size);
431 data = mmap(NULL, size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
432 if (data == MAP_FAILED) {
434 assert(data != MAP_FAILED);
437 pool = wl_shm_create_pool(shm, fd, size);
438 buffer = wl_shm_pool_create_buffer(pool, 0, width, height, stride,
439 WL_SHM_FORMAT_ARGB8888);
440 wl_shm_pool_destroy(pool);
451 create_shm_buffer_a8r8g8b8(struct client *client, int width, int height)
456 buf = xzalloc(sizeof *buf);
457 buf->proxy = create_shm_buffer(client, width, height, &pixels);
458 buf->image = pixman_image_create_bits(PIXMAN_a8r8g8b8, width, height,
460 buf->len = width * height * 4;
469 buffer_destroy(struct buffer *buf)
473 pixels = pixman_image_get_data(buf->image);
476 wl_buffer_destroy(buf->proxy);
477 assert(munmap(pixels, buf->len) == 0);
480 assert(pixman_image_unref(buf->image));
486 shm_format(void *data, struct wl_shm *wl_shm, uint32_t format)
488 struct client *client = data;
490 if (format == WL_SHM_FORMAT_ARGB8888)
491 client->has_argb = 1;
494 struct wl_shm_listener shm_listener = {
499 test_handle_pointer_position(void *data, struct weston_test *weston_test,
500 wl_fixed_t x, wl_fixed_t y)
502 struct test *test = data;
503 test->pointer_x = wl_fixed_to_int(x);
504 test->pointer_y = wl_fixed_to_int(y);
506 fprintf(stderr, "test-client: got global pointer %d %d\n",
507 test->pointer_x, test->pointer_y);
511 test_handle_n_egl_buffers(void *data, struct weston_test *weston_test, uint32_t n)
513 struct test *test = data;
515 test->n_egl_buffers = n;
519 test_handle_capture_screenshot_done(void *data, struct weston_test *weston_test)
521 struct test *test = data;
523 printf("Screenshot has been captured\n");
524 test->buffer_copy_done = 1;
527 static const struct weston_test_listener test_listener = {
528 test_handle_pointer_position,
529 test_handle_n_egl_buffers,
530 test_handle_capture_screenshot_done,
534 input_update_devices(struct input *input)
536 struct pointer *pointer;
537 struct keyboard *keyboard;
540 struct wl_seat *seat = input->wl_seat;
541 enum wl_seat_capability caps = input->caps;
543 if ((caps & WL_SEAT_CAPABILITY_POINTER) && !input->pointer) {
544 pointer = xzalloc(sizeof *pointer);
545 pointer->wl_pointer = wl_seat_get_pointer(seat);
546 wl_pointer_set_user_data(pointer->wl_pointer, pointer);
547 wl_pointer_add_listener(pointer->wl_pointer, &pointer_listener,
549 input->pointer = pointer;
550 } else if (!(caps & WL_SEAT_CAPABILITY_POINTER) && input->pointer) {
551 wl_pointer_destroy(input->pointer->wl_pointer);
552 free(input->pointer);
553 input->pointer = NULL;
556 if ((caps & WL_SEAT_CAPABILITY_KEYBOARD) && !input->keyboard) {
557 keyboard = xzalloc(sizeof *keyboard);
558 keyboard->wl_keyboard = wl_seat_get_keyboard(seat);
559 wl_keyboard_set_user_data(keyboard->wl_keyboard, keyboard);
560 wl_keyboard_add_listener(keyboard->wl_keyboard, &keyboard_listener,
562 input->keyboard = keyboard;
563 } else if (!(caps & WL_SEAT_CAPABILITY_KEYBOARD) && input->keyboard) {
564 wl_keyboard_destroy(input->keyboard->wl_keyboard);
565 free(input->keyboard);
566 input->keyboard = NULL;
569 if ((caps & WL_SEAT_CAPABILITY_TOUCH) && !input->touch) {
570 touch = xzalloc(sizeof *touch);
571 touch->wl_touch = wl_seat_get_touch(seat);
572 wl_touch_set_user_data(touch->wl_touch, touch);
573 wl_touch_add_listener(touch->wl_touch, &touch_listener,
575 input->touch = touch;
576 } else if (!(caps & WL_SEAT_CAPABILITY_TOUCH) && input->touch) {
577 wl_touch_destroy(input->touch->wl_touch);
584 seat_handle_capabilities(void *data, struct wl_seat *seat,
585 enum wl_seat_capability caps)
587 struct input *input = data;
591 /* we will create/update the devices only with the right (test) seat.
592 * If we haven't discovered which seat is the test seat, just
593 * store capabilities and bail out */
594 if (input->seat_name && strcmp(input->seat_name, "test-seat") == 0)
595 input_update_devices(input);
597 fprintf(stderr, "test-client: got seat %p capabilities: %x\n",
602 seat_handle_name(void *data, struct wl_seat *seat, const char *name)
604 struct input *input = data;
606 input->seat_name = strdup(name);
607 assert(input->seat_name && "No memory");
609 fprintf(stderr, "test-client: got seat %p name: \'%s\'\n",
613 static const struct wl_seat_listener seat_listener = {
614 seat_handle_capabilities,
619 output_handle_geometry(void *data,
620 struct wl_output *wl_output,
629 struct output *output = data;
636 output_handle_mode(void *data,
637 struct wl_output *wl_output,
643 struct output *output = data;
645 if (flags & WL_OUTPUT_MODE_CURRENT) {
646 output->width = width;
647 output->height = height;
652 output_handle_scale(void *data,
653 struct wl_output *wl_output,
656 struct output *output = data;
658 output->scale = scale;
662 output_handle_done(void *data,
663 struct wl_output *wl_output)
665 struct output *output = data;
667 output->initialized = 1;
670 static const struct wl_output_listener output_listener = {
671 output_handle_geometry,
678 handle_global(void *data, struct wl_registry *registry,
679 uint32_t id, const char *interface, uint32_t version)
681 struct client *client = data;
682 struct output *output;
684 struct global *global;
687 global = xzalloc(sizeof *global);
689 global->interface = strdup(interface);
691 global->version = version;
692 wl_list_insert(client->global_list.prev, &global->link);
694 if (strcmp(interface, "wl_compositor") == 0) {
695 client->wl_compositor =
696 wl_registry_bind(registry, id,
697 &wl_compositor_interface, version);
698 } else if (strcmp(interface, "wl_seat") == 0) {
699 input = xzalloc(sizeof *input);
701 wl_registry_bind(registry, id,
702 &wl_seat_interface, version);
703 wl_seat_add_listener(input->wl_seat, &seat_listener, input);
704 wl_list_insert(&client->inputs, &input->link);
705 } else if (strcmp(interface, "wl_shm") == 0) {
707 wl_registry_bind(registry, id,
708 &wl_shm_interface, version);
709 wl_shm_add_listener(client->wl_shm, &shm_listener, client);
710 } else if (strcmp(interface, "wl_output") == 0) {
711 output = xzalloc(sizeof *output);
713 wl_registry_bind(registry, id,
714 &wl_output_interface, version);
715 wl_output_add_listener(output->wl_output,
716 &output_listener, output);
717 client->output = output;
718 } else if (strcmp(interface, "weston_test") == 0) {
719 test = xzalloc(sizeof *test);
721 wl_registry_bind(registry, id,
722 &weston_test_interface, version);
723 weston_test_add_listener(test->weston_test, &test_listener, test);
725 } else if (strcmp(interface, "wl_drm") == 0) {
726 client->has_wl_drm = true;
730 static const struct wl_registry_listener registry_listener = {
735 skip(const char *fmt, ...)
740 vfprintf(stderr, fmt, argp);
743 /* automake tests uses exit code 77. weston-test-runner will see
744 * this and use it, and then weston-test's sigchld handler (in the
745 * weston process) will use that as an exit status, which is what
746 * automake will see in the end. */
751 expect_protocol_error(struct client *client,
752 const struct wl_interface *intf,
756 uint32_t errcode, failed = 0;
757 const struct wl_interface *interface;
760 /* if the error has not come yet, make it happen */
761 wl_display_roundtrip(client->wl_display);
763 err = wl_display_get_error(client->wl_display);
765 assert(err && "Expected protocol error but nothing came");
766 assert(err == EPROTO && "Expected protocol error but got local error");
768 errcode = wl_display_get_protocol_error(client->wl_display,
772 if (errcode != code) {
773 fprintf(stderr, "Should get error code %d but got %d\n",
778 /* this should be definitely set */
781 if (strcmp(intf->name, interface->name) != 0) {
782 fprintf(stderr, "Should get interface '%s' but got '%s'\n",
783 intf->name, interface->name);
788 fprintf(stderr, "Expected other protocol error\n");
793 fprintf(stderr, "Got expected protocol error on '%s' (object id: %d) "
794 "with code %d\n", interface->name, id, errcode);
798 log_handler(const char *fmt, va_list args)
800 fprintf(stderr, "libwayland: ");
801 vfprintf(stderr, fmt, args);
805 input_destroy(struct input *inp)
807 wl_list_remove(&inp->link);
808 wl_seat_destroy(inp->wl_seat);
812 /* find the test-seat and set it in client.
813 * Destroy other inputs */
815 client_set_input(struct client *cl)
817 struct input *inp, *inptmp;
818 wl_list_for_each_safe(inp, inptmp, &cl->inputs, link) {
819 assert(inp->seat_name && "BUG: input with no name");
820 if (strcmp(inp->seat_name, "test-seat") == 0) {
822 input_update_devices(inp);
828 /* we keep only one input */
829 assert(wl_list_length(&cl->inputs) == 1);
835 struct client *client;
837 wl_log_set_handler_client(log_handler);
839 /* connect to display */
840 client = xzalloc(sizeof *client);
841 client->wl_display = wl_display_connect(NULL);
842 assert(client->wl_display);
843 wl_list_init(&client->global_list);
844 wl_list_init(&client->inputs);
846 /* setup registry so we can bind to interfaces */
847 client->wl_registry = wl_display_get_registry(client->wl_display);
848 wl_registry_add_listener(client->wl_registry, ®istry_listener,
851 /* this roundtrip makes sure we have all globals and we bound to them */
852 client_roundtrip(client);
853 /* this roundtrip makes sure we got all wl_shm.format and wl_seat.*
855 client_roundtrip(client);
857 /* find the right input for us */
858 client_set_input(client);
860 /* must have WL_SHM_FORMAT_ARGB32 */
861 assert(client->has_argb);
863 /* must have weston_test interface */
864 assert(client->test);
866 /* must have an output */
867 assert(client->output);
869 /* the output must be initialized */
870 assert(client->output->initialized == 1);
872 /* must have seat set */
873 assert(client->input);
879 create_client_and_test_surface(int x, int y, int width, int height)
881 struct client *client;
882 struct surface *surface;
883 pixman_color_t color = { 16384, 16384, 16384, 16384 }; /* uint16_t */
884 pixman_image_t *solid;
886 client = create_client();
888 /* initialize the client surface */
889 surface = xzalloc(sizeof *surface);
890 surface->wl_surface =
891 wl_compositor_create_surface(client->wl_compositor);
892 assert(surface->wl_surface);
894 wl_surface_add_listener(surface->wl_surface, &surface_listener,
897 client->surface = surface;
898 wl_surface_set_user_data(surface->wl_surface, surface);
900 surface->width = width;
901 surface->height = height;
902 surface->buffer = create_shm_buffer_a8r8g8b8(client, width, height);
904 solid = pixman_image_create_solid_fill(&color);
905 pixman_image_composite32(PIXMAN_OP_SRC,
908 surface->buffer->image, /* dst */
913 pixman_image_unref(solid);
915 move_client(client, x, y);
923 char *path = getenv("WESTON_TEST_OUTPUT_PATH");
931 screenshot_output_filename(const char *basename, uint32_t seq)
935 if (asprintf(&filename, "%s/%s-%02d.png",
936 output_path(), basename, seq) < 0)
944 char *path = getenv("WESTON_TEST_REFERENCE_PATH");
947 return "./tests/reference";
952 screenshot_reference_filename(const char *basename, uint32_t seq)
956 if (asprintf(&filename, "%s/%s-%02d.png",
957 reference_path(), basename, seq) < 0)
963 * check_surfaces_geometry() - verifies two surfaces are same size
965 * @returns true if surfaces have the same width and height, or false
966 * if not, or if there is no actual data.
969 check_surfaces_geometry(const struct surface *a, const struct surface *b)
971 if (a == NULL || b == NULL) {
972 printf("Undefined surfaces\n");
975 else if (a->buffer == NULL || b->buffer == NULL) {
976 printf("Undefined data\n");
979 else if (a->width != b->width || a->height != b->height) {
980 printf("Mismatched dimensions: %d,%d != %d,%d\n",
981 a->width, a->height, b->width, b->height);
988 * check_surfaces_equal() - tests if two surfaces are pixel-identical
990 * Returns true if surface buffers have all the same byte values,
991 * false if the surfaces don't match or can't be compared due to
992 * different dimensions.
995 check_surfaces_equal(const struct surface *a, const struct surface *b)
997 int bpp = 4; /* Assumes ARGB */
1001 if (!check_surfaces_geometry(a, b))
1004 data_a = pixman_image_get_data(a->buffer->image);
1005 data_b = pixman_image_get_data(b->buffer->image);
1007 return (memcmp(data_a, data_b, bpp * a->width * a->height) == 0);
1011 * check_surfaces_match_in_clip() - tests if a given region within two
1012 * surfaces are pixel-identical.
1014 * Returns true if the two surfaces have the same byte values within the
1015 * given clipping region, or false if they don't match or the surfaces
1016 * can't be compared.
1019 check_surfaces_match_in_clip(const struct surface *a, const struct surface *b, const struct rectangle *clip_rect)
1024 int bpp = 4; /* Assumes ARGB */
1028 if (!check_surfaces_geometry(a, b) || clip_rect == NULL)
1031 if (clip_rect->x > a->width || clip_rect->y > a->height) {
1032 printf("Clip outside image boundaries\n");
1036 x0 = max(0, clip_rect->x);
1037 y0 = max(0, clip_rect->y);
1038 x1 = min(a->width, clip_rect->x + clip_rect->width);
1039 y1 = min(a->height, clip_rect->y + clip_rect->height);
1041 if (x0 == x1 || y0 == y1) {
1042 printf("Degenerate comparison\n");
1046 data_a = pixman_image_get_data(a->buffer->image);
1047 data_b = pixman_image_get_data(b->buffer->image);
1049 printf("Bytewise comparison inside clip\n");
1050 for (i=y0; i<y1; i++) {
1051 p = data_a + i * a->width * bpp + x0 * bpp;
1052 q = data_b + i * b->width * bpp + x0 * bpp;
1053 if (memcmp(p, q, (x1-x0)*bpp) != 0) {
1054 /* Dump the bad row */
1055 printf("Mismatched image on row %d\n", i);
1056 for (j=0; j<(x1-x0)*bpp; j++) {
1057 char a_char = *((char*)(p+j*bpp));
1058 char b_char = *((char*)(q+j*bpp));
1059 printf("%d,%d: %8x %8x %s\n", i, j, a_char, b_char,
1060 (a_char != b_char)? " <---": "");
1069 /** write_surface_as_png()
1071 * Writes out a given weston test surface to disk as a PNG image
1072 * using the provided filename (with path).
1074 * @returns true if successfully saved file; false otherwise.
1077 write_surface_as_png(const struct surface *weston_surface, const char *fname)
1079 cairo_surface_t *cairo_surface;
1080 cairo_status_t status;
1081 int bpp = 4; /* Assume ARGB */
1082 int stride = bpp * weston_surface->width;
1085 pixels = pixman_image_get_data(weston_surface->buffer->image);
1086 cairo_surface = cairo_image_surface_create_for_data(pixels,
1087 CAIRO_FORMAT_ARGB32,
1088 weston_surface->width,
1089 weston_surface->height,
1091 printf("Writing PNG to disk\n");
1092 status = cairo_surface_write_to_png(cairo_surface, fname);
1093 if (status != CAIRO_STATUS_SUCCESS) {
1094 printf("Failed to save screenshot: %s\n",
1095 cairo_status_to_string(status));
1098 cairo_surface_destroy(cairo_surface);
1102 /** load_surface_from_png()
1104 * Reads a PNG image from disk using the given filename (and path)
1105 * and returns as a freshly allocated weston test surface.
1107 * @returns weston test surface with image, which should be free'd
1108 * when no longer used; or, NULL in case of error.
1111 load_surface_from_png(const char *fname)
1113 struct surface *reference;
1114 cairo_surface_t *reference_cairo_surface;
1115 cairo_status_t status;
1116 size_t source_data_size;
1120 reference_cairo_surface = cairo_image_surface_create_from_png(fname);
1121 status = cairo_surface_status(reference_cairo_surface);
1122 if (status != CAIRO_STATUS_SUCCESS) {
1123 printf("Could not open %s: %s\n", fname, cairo_status_to_string(status));
1124 cairo_surface_destroy(reference_cairo_surface);
1128 /* Disguise the cairo surface in a weston test surface */
1129 reference = zalloc(sizeof *reference);
1130 if (reference == NULL) {
1131 perror("zalloc reference");
1132 cairo_surface_destroy(reference_cairo_surface);
1135 reference->width = cairo_image_surface_get_width(reference_cairo_surface);
1136 reference->height = cairo_image_surface_get_height(reference_cairo_surface);
1137 stride = cairo_image_surface_get_stride(reference_cairo_surface);
1138 source_data_size = stride * reference->height;
1140 /* Check that the file's stride matches our assumption */
1142 if (stride != bpp * reference->width) {
1143 printf("Mismatched stride for screenshot reference image %s\n", fname);
1144 cairo_surface_destroy(reference_cairo_surface);
1149 /* Allocate new buffer for our weston reference, and copy the data from
1150 the cairo surface so we can destroy it */
1152 reference->buffer = xzalloc(sizeof *reference->buffer);
1153 reference->buffer->image = pixman_image_create_bits(PIXMAN_a8r8g8b8,
1157 assert(reference->buffer->image);
1159 memcpy(pixman_image_get_data(reference->buffer->image),
1160 cairo_image_surface_get_data(reference_cairo_surface),
1163 cairo_surface_destroy(reference_cairo_surface);
1167 /** create_screenshot_surface()
1169 * Allocates and initializes a weston test surface for use in
1170 * storing a screenshot of the client's output. Establishes a
1171 * shm backed wl_buffer for retrieving screenshot image data
1172 * from the server, sized to match the client's output display.
1174 * @returns stack allocated surface image, which should be
1175 * free'd when done using it.
1178 create_screenshot_surface(struct client *client)
1180 struct surface *screenshot;
1181 screenshot = zalloc(sizeof *screenshot);
1182 if (screenshot == NULL)
1185 screenshot->buffer = create_shm_buffer_a8r8g8b8(client,
1186 client->output->width,
1187 client->output->height);
1188 screenshot->height = client->output->height;
1189 screenshot->width = client->output->width;
1194 /** capture_screenshot_of_output()
1196 * Requests a screenshot from the server of the output that the
1197 * client appears on. The image data returned from the server
1198 * can be accessed from the screenshot surface's data member.
1200 * @returns a new surface object, which should be free'd when no
1204 capture_screenshot_of_output(struct client *client)
1206 struct surface *screenshot;
1208 /* Create a surface to hold the screenshot */
1209 screenshot = create_screenshot_surface(client);
1211 client->test->buffer_copy_done = 0;
1212 weston_test_capture_screenshot(client->test->weston_test,
1213 client->output->wl_output,
1214 screenshot->buffer->proxy);
1215 while (client->test->buffer_copy_done == 0)
1216 if (wl_display_dispatch(client->wl_display) < 0)
1219 /* FIXME: Document somewhere the orientation the screenshot is taken
1220 * and how the clip coords are interpreted, in case of scaling/transform.
1221 * If we're using read_pixels() just make sure it is documented somewhere.
1222 * Protocol docs in the XML, comparison function docs in Doxygen style.