1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
/*
* Copyright © 2015 Samsung Electronics Co., Ltd
*
* 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 <unistd.h>
#include <stdio.h>
#include <string.h> /* memcpy */
#include <cairo.h>
#include "weston-test-client-helper.h"
char *server_parameters="--use-pixman --width=320 --height=240";
/** write_surface_as_png()
*
* Writes out a given weston test surface to disk as a PNG image
* using the provided filename (with path).
*
* @returns true if successfully saved file; false otherwise.
*/
static bool
write_surface_as_png(const struct surface* weston_surface, const char *fname) {
cairo_surface_t *cairo_surface;
cairo_status_t status;
int bpp = 4; /* Assume ARGB */
int stride = bpp * weston_surface->width;
cairo_surface = cairo_image_surface_create_for_data(weston_surface->data,
CAIRO_FORMAT_ARGB32,
weston_surface->width,
weston_surface->height,
stride);
printf("Writing PNG to disk\n");
status = cairo_surface_write_to_png(cairo_surface, fname);
if (status != CAIRO_STATUS_SUCCESS) {
printf("Failed to save screenshot: %s\n",
cairo_status_to_string(status));
return false;
}
cairo_surface_destroy(cairo_surface);
return true;
}
/** load_surface_from_png()
*
* Reads a PNG image from disk using the given filename (and path)
* and returns as a freshly allocated weston test surface.
*
* @returns weston test surface with image, which should be free'd
* when no longer used; or, NULL in case of error.
*/
static struct surface*
load_surface_from_png(const char *fname) {
struct surface *reference;
cairo_surface_t *reference_cairo_surface;
cairo_status_t status;
size_t source_data_size;
int stride;
printf("Loading reference image %s\n", fname);
reference_cairo_surface = cairo_image_surface_create_from_png(fname);
status = cairo_surface_status(reference_cairo_surface);
if (status != CAIRO_STATUS_SUCCESS) {
printf("Could not open %s: %s\n", fname, cairo_status_to_string(status));
cairo_surface_destroy(reference_cairo_surface);
return NULL;
}
/* Disguise the cairo surface in a weston test surface */
reference = xzalloc(sizeof *reference);
if (reference == NULL) {
perror("xzalloc reference");
cairo_surface_destroy(reference_cairo_surface);
return NULL;
}
reference->width = cairo_image_surface_get_width(reference_cairo_surface);
reference->height = cairo_image_surface_get_height(reference_cairo_surface);
stride = cairo_image_surface_get_stride(reference_cairo_surface);
source_data_size = stride * reference->height;
/* Allocate new buffer for our weston reference, and copy the data from
the cairo surface so we can destroy it */
reference->data = xzalloc(source_data_size);
if (reference->data == NULL) {
perror("xzalloc reference data");
cairo_surface_destroy(reference_cairo_surface);
free(reference);
return NULL;
}
memcpy(reference->data,
cairo_image_surface_get_data(reference_cairo_surface),
source_data_size);
cairo_surface_destroy(reference_cairo_surface);
return reference;
}
/** create_screenshot_surface()
*
* Allocates and initializes a weston test surface for use in
* storing a screenshot of the client's output. Establishes a
* shm backed wl_buffer for retrieving screenshot image data
* from the server, sized to match the client's output display.
*
* @returns stack allocated surface image, which should be
* free'd when done using it.
*/
static struct surface*
create_screenshot_surface(struct client *client) {
struct surface* screenshot;
screenshot = xzalloc(sizeof *screenshot);
if (screenshot == NULL)
return NULL;
screenshot->wl_buffer = create_shm_buffer(client,
client->output->width,
client->output->height,
&screenshot->data);
screenshot->height = client->output->height;
screenshot->width = client->output->width;
return screenshot;
}
/** capture_screenshot_of_output()
*
* Requests a screenshot from the server of the output that the
* client appears on. The image data returned from the server
* can be accessed from the screenshot surface's data member.
*
* @returns a new surface object, which should be free'd when no
* longer needed.
*/
static struct surface *
capture_screenshot_of_output(struct client *client) {
struct surface *screenshot;
/* Create a surface to hold the screenshot */
screenshot = create_screenshot_surface(client);
client->test->buffer_copy_done = 0;
weston_test_capture_screenshot(client->test->weston_test,
client->output->wl_output,
screenshot->wl_buffer);
while (client->test->buffer_copy_done == 0)
if (wl_display_dispatch(client->wl_display) < 0)
break;
/* FIXME: Document somewhere the orientation the screenshot is taken
* and how the clip coords are interpreted, in case of scaling/transform.
* If we're using read_pixels() just make sure it is documented somewhere.
* Protocol docs in the XML, comparison function docs in Doxygen style.
*/
return screenshot;
}
TEST(internal_screenshot)
{
struct client *client;
struct surface *screenshot = NULL;
struct surface *reference = NULL;
struct rectangle clip;
const char *fname;
bool match = false;
bool dump_all_images = true;
/* Create the client */
printf("Creating client for test\n");
client = create_client_and_test_surface(100, 100, 100, 100);
assert(client);
/* Take a snapshot. Result will be in screenshot->wl_buffer. */
printf("Taking a screenshot\n");
screenshot = capture_screenshot_of_output(client);
assert(screenshot);
/* Load reference image */
fname = screenshot_reference_filename("internal-screenshot", 0);
printf("Loading reference image %s\n", fname);
reference = load_surface_from_png(fname);
assert(reference);
/* Test check_surfaces_equal()
* We expect this to fail since the clock will differ from when we made the reference image
*/
match = check_surfaces_equal(screenshot, reference);
printf("Screenshot %s reference image\n", match? "equal to" : "different from");
assert(!match);
/* Test check_surfaces_match_in_clip()
* Alpha-blending and other effects can cause irrelevant discrepancies, so look only
* at a small portion of the solid-colored background
*/
clip.x = 50;
clip.y = 50;
clip.width = 101;
clip.height = 101;
printf("Clip: %d,%d %d x %d\n", clip.x, clip.y, clip.width, clip.height);
match = check_surfaces_match_in_clip(screenshot, reference, &clip);
printf("Screenshot %s reference image in clipped area\n", match? "matches" : "doesn't match");
free(reference);
/* Test dumping of non-matching images */
if (!match || dump_all_images) {
fname = screenshot_output_filename("internal-screenshot", 0);
write_surface_as_png(screenshot, fname);
}
free(screenshot);
printf("Test complete\n");
assert(match);
}
|
