fix weston launch error
[platform/upstream/weston.git] / tests / internal-screenshot-test.c
1 /*
2  * Copyright © 2015 Samsung Electronics Co., Ltd
3  *
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:
11  *
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.
15  *
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
23  * SOFTWARE.
24  */
25
26 #include "config.h"
27
28 #include <stdint.h>
29 #include <stdio.h>
30
31 #include "weston-test-client-helper.h"
32
33 char *server_parameters="--use-pixman --width=320 --height=240";
34
35 static void
36 draw_stuff(pixman_image_t *image)
37 {
38         int w, h;
39         int stride; /* bytes */
40         int x, y;
41         uint8_t r, g, b;
42         uint32_t *pixels;
43         uint32_t *pixel;
44         pixman_format_code_t fmt;
45
46         fmt = pixman_image_get_format(image);
47         w = pixman_image_get_width(image);
48         h = pixman_image_get_height(image);
49         stride = pixman_image_get_stride(image);
50         pixels = pixman_image_get_data(image);
51
52         assert(PIXMAN_FORMAT_BPP(fmt) == 32);
53
54         for (x = 0; x < w; x++)
55                 for (y = 0; y < h; y++) {
56                         b = x;
57                         g = x + y;
58                         r = y;
59                         pixel = pixels + (y * stride / 4) + x;
60                         *pixel = (255 << 24) | (r << 16) | (g << 8) | b;
61                 }
62 }
63
64 TEST(internal_screenshot)
65 {
66         struct buffer *buf;
67         struct client *client;
68         struct wl_surface *surface;
69         struct buffer *screenshot = NULL;
70         pixman_image_t *reference_good = NULL;
71         pixman_image_t *reference_bad = NULL;
72         pixman_image_t *diffimg;
73         struct rectangle clip;
74         const char *fname;
75         bool match = false;
76         bool dump_all_images = true;
77
78         /* Create the client */
79         printf("Creating client for test\n");
80         client = create_client_and_test_surface(100, 100, 100, 100);
81         assert(client);
82         surface = client->surface->wl_surface;
83
84         /*
85          * We are racing our screenshooting against weston-desktop-shell
86          * setting the cursor. If w-d-s wins, our screenshot will have a cursor
87          * shown, which makes the image comparison fail. Our window and the
88          * default pointer position are accidentally causing an overlap that
89          * intersects our test clip rectangle.
90          *
91          * w-d-s wins very rarely though, so the race is easy to miss. You can
92          * make it happen by putting a delay before the call to
93          * create_client_and_test_surface().
94          *
95          * The weston_test_move_pointer() below makes the race irrelevant, as
96          * the cursor won't overlap with anything we care about.
97          */
98
99         /* Move the pointer away from the screenshot area. */
100         weston_test_move_pointer(client->test->weston_test, 0, 1, 0, 0, 0);
101
102         buf = create_shm_buffer_a8r8g8b8(client, 100, 100);
103         draw_stuff(buf->image);
104         wl_surface_attach(surface, buf->proxy, 0, 0);
105         wl_surface_damage(surface, 0, 0, 100, 100);
106         wl_surface_commit(surface);
107
108         /* Take a snapshot.  Result will be in screenshot->wl_buffer. */
109         printf("Taking a screenshot\n");
110         screenshot = capture_screenshot_of_output(client);
111         assert(screenshot);
112
113         /* Load good reference image */
114         fname = screenshot_reference_filename("internal-screenshot-good", 0);
115         printf("Loading good reference image %s\n", fname);
116         reference_good = load_image_from_png(fname);
117         assert(reference_good);
118
119         /* Load bad reference image */
120         fname = screenshot_reference_filename("internal-screenshot-bad", 0);
121         printf("Loading bad reference image %s\n", fname);
122         reference_bad = load_image_from_png(fname);
123         assert(reference_bad);
124
125         /* Test check_images_match() without a clip.
126          * We expect this to fail since we use a bad reference image
127          */
128         match = check_images_match(screenshot->image, reference_bad, NULL);
129         printf("Screenshot %s reference image\n", match? "equal to" : "different from");
130         assert(!match);
131         pixman_image_unref(reference_bad);
132
133         /* Test check_images_match() with clip.
134          * Alpha-blending and other effects can cause irrelevant discrepancies, so look only
135          * at a small portion of the solid-colored background
136          */
137         clip.x = 100;
138         clip.y = 100;
139         clip.width = 100;
140         clip.height = 100;
141         printf("Clip: %d,%d %d x %d\n", clip.x, clip.y, clip.width, clip.height);
142         match = check_images_match(screenshot->image, reference_good, &clip);
143         printf("Screenshot %s reference image in clipped area\n", match? "matches" : "doesn't match");
144         if (!match) {
145                 diffimg = visualize_image_difference(screenshot->image, reference_good, &clip);
146                 fname = screenshot_output_filename("internal-screenshot-error", 0);
147                 write_image_as_png(diffimg, fname);
148                 pixman_image_unref(diffimg);
149         }
150         pixman_image_unref(reference_good);
151
152         /* Test dumping of non-matching images */
153         if (!match || dump_all_images) {
154                 fname = screenshot_output_filename("internal-screenshot", 0);
155                 write_image_as_png(screenshot->image, fname);
156         }
157
158         buffer_destroy(screenshot);
159
160         printf("Test complete\n");
161         assert(match);
162 }