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