2 * Copyright © 2020 Collabora, Ltd.
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
34 #include <sys/param.h>
39 #include <wayland-client.h>
40 #include "shared/helpers.h"
41 #include "shared/xalloc.h"
42 #include "shared/file-util.h"
43 #include "shared/os-compatibility.h"
44 #include "agl-screenshooter-client-protocol.h"
45 #include "xdg-output-unstable-v1-client-protocol.h"
47 struct screenshooter_data;
49 struct screenshooter_output {
50 struct wl_output *output;
51 struct wl_buffer *buffer;
53 int width, height, offset_x, offset_y, scale;
55 struct screenshooter_data *sh_data;
57 struct wl_list link; /** screenshooter_data::output_list */
60 struct xdg_output_v1_info {
61 struct zxdg_output_v1 *xdg_output;
62 struct screenshooter_output *output;
64 char *name, *description;
65 struct wl_list link; /** screenshooter_data::xdg_output_list */
76 struct screenshooter_data {
77 struct wl_display *display;
79 struct wl_list output_list; /** screenshooter_output::link */
80 struct wl_list xdg_output_list; /** xdg_output_v1_info::link */
82 struct zxdg_output_manager_v1 *xdg_output_manager;
83 struct agl_screenshooter *screenshooter;
87 static int opts = 0x0;
89 #define OPT_SCREENSHOT_OUTPUT 1
90 #define OPT_SHOW_ALL_OUTPUTS 2
91 #define OPT_SCREENSHOT_ALL_OUTPUTS 3
94 display_handle_geometry(void *data,
95 struct wl_output *wl_output,
105 struct screenshooter_output *output;
107 output = wl_output_get_user_data(wl_output);
109 if (wl_output == output->output) {
110 output->offset_x = x;
111 output->offset_y = y;
116 display_handle_mode(void *data,
117 struct wl_output *wl_output,
123 struct screenshooter_output *output;
125 output = wl_output_get_user_data(wl_output);
127 if (wl_output == output->output && (flags & WL_OUTPUT_MODE_CURRENT)) {
128 output->width = width;
129 output->height = height;
134 display_handle_done(void *data, struct wl_output *wl_output)
140 display_handle_scale(void *data, struct wl_output *wl_output,
143 struct screenshooter_output *output = data;
144 output->scale = scale;
148 static const struct wl_output_listener output_listener = {
149 display_handle_geometry,
152 display_handle_scale,
156 handle_xdg_output_v1_logical_position(void *data, struct zxdg_output_v1 *output,
157 int32_t x, int32_t y)
162 handle_xdg_output_v1_logical_size(void *data, struct zxdg_output_v1 *output,
163 int32_t width, int32_t height)
168 handle_xdg_output_v1_done(void *data, struct zxdg_output_v1 *output)
170 /* Don't bother waiting for this; there's no good reason a
171 * compositor will wait more than one roundtrip before sending
172 * these initial events. */
176 handle_xdg_output_v1_name(void *data, struct zxdg_output_v1 *output,
179 struct xdg_output_v1_info *xdg_output = data;
180 xdg_output->name = strdup(name);
184 handle_xdg_output_v1_description(void *data, struct zxdg_output_v1 *output,
185 const char *description)
187 struct xdg_output_v1_info *xdg_output = data;
188 xdg_output->description = strdup(description);
191 static const struct zxdg_output_v1_listener xdg_output_v1_listener = {
192 .logical_position = handle_xdg_output_v1_logical_position,
193 .logical_size = handle_xdg_output_v1_logical_size,
194 .done = handle_xdg_output_v1_done,
195 .name = handle_xdg_output_v1_name,
196 .description = handle_xdg_output_v1_description,
200 add_xdg_output_v1_info(struct screenshooter_data *shooter_data,
201 struct screenshooter_output *output)
203 struct xdg_output_v1_info *xdg_output = zalloc(sizeof(*xdg_output));
207 wl_list_insert(&shooter_data->xdg_output_list, &xdg_output->link);
209 xdg_output->xdg_output =
210 zxdg_output_manager_v1_get_xdg_output(shooter_data->xdg_output_manager,
213 zxdg_output_v1_add_listener(xdg_output->xdg_output,
214 &xdg_output_v1_listener, xdg_output);
215 xdg_output->output = output;
219 screenshot_done(void *data, struct agl_screenshooter *screenshooter, uint32_t status)
221 struct screenshooter_data *sh_data = data;
222 sh_data->buffer_copy_done = 1;
225 static const struct agl_screenshooter_listener screenshooter_listener = {
230 handle_global(void *data, struct wl_registry *registry,
231 uint32_t name, const char *interface, uint32_t version)
233 struct screenshooter_output *output;
234 struct screenshooter_data *sh_data = data;
236 if (strcmp(interface, "wl_output") == 0) {
237 output = zalloc(sizeof(*output));
241 output->output = wl_registry_bind(registry, name,
242 &wl_output_interface, 1);
243 output->sh_data = sh_data;
244 wl_list_insert(&sh_data->output_list, &output->link);
245 wl_output_add_listener(output->output, &output_listener, output);
246 } else if (strcmp(interface, "wl_shm") == 0) {
247 sh_data->shm = wl_registry_bind(registry, name, &wl_shm_interface, 1);
248 } else if (strcmp(interface, "agl_screenshooter") == 0) {
249 sh_data->screenshooter = wl_registry_bind(registry, name,
250 &agl_screenshooter_interface, 1);
252 agl_screenshooter_add_listener(sh_data->screenshooter,
253 &screenshooter_listener, sh_data);
254 } else if (strcmp(interface, "zxdg_output_manager_v1") == 0) {
255 sh_data->xdg_output_manager = wl_registry_bind(registry, name,
256 &zxdg_output_manager_v1_interface, version);
261 handle_global_remove(void *data, struct wl_registry *registry, uint32_t name)
263 /* XXX: unimplemented */
266 static const struct wl_registry_listener registry_listener = {
271 static struct wl_buffer *
272 screenshot_create_shm_buffer(int width, int height, void **data_out,
275 struct wl_shm_pool *pool;
276 struct wl_buffer *buffer;
277 int fd, size, stride;
281 size = stride * height;
283 fd = os_create_anonymous_file(size);
285 fprintf(stderr, "creating a buffer file for %d B failed: %s\n",
286 size, strerror(errno));
290 data = mmap(NULL, size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
291 if (data == MAP_FAILED) {
292 fprintf(stderr, "mmap failed: %s\n", strerror(errno));
297 pool = wl_shm_create_pool(shm, fd, size);
299 buffer = wl_shm_pool_create_buffer(pool, 0, width, height, stride,
300 WL_SHM_FORMAT_XRGB8888);
301 wl_shm_pool_destroy(pool);
309 screenshot_write_png_per_output(const struct buffer_size *buff_size,
310 struct screenshooter_output *sh_output)
312 int output_stride, buffer_stride, i;
313 cairo_surface_t *surface;
316 char filepath[PATH_MAX];
318 buffer_stride = buff_size->width * 4;
319 data = xmalloc(buffer_stride * buff_size->height);
323 output_stride = sh_output->width * 4;
325 d = data + (sh_output->offset_y - buff_size->min_y) * buffer_stride +
326 (sh_output->offset_x - buff_size->min_x) * 4;
328 for (i = 0; i < sh_output->height; i++) {
329 memcpy(d, s, output_stride);
334 surface = cairo_image_surface_create_for_data(data,
340 fp = file_create_dated(getenv("XDG_PICTURES_DIR"), "agl-screenshot-",
341 ".png", filepath, sizeof(filepath));
344 cairo_surface_write_to_png(surface, filepath);
347 cairo_surface_destroy(surface);
352 screenshot_write_png(const struct buffer_size *buff_size,
353 struct wl_list *output_list)
355 int output_stride, buffer_stride, i;
356 cairo_surface_t *surface;
358 struct screenshooter_output *output, *next;
360 char filepath[PATH_MAX];
362 buffer_stride = buff_size->width * 4;
364 data = xmalloc(buffer_stride * buff_size->height);
368 wl_list_for_each_safe(output, next, output_list, link) {
369 output_stride = output->width * 4;
371 d = data + (output->offset_y - buff_size->min_y) * buffer_stride +
372 (output->offset_x - buff_size->min_x) * 4;
374 for (i = 0; i < output->height; i++) {
375 memcpy(d, s, output_stride);
383 surface = cairo_image_surface_create_for_data(data,
389 fp = file_create_dated(getenv("XDG_PICTURES_DIR"), "agl-screenshot-",
390 ".png", filepath, sizeof(filepath));
393 cairo_surface_write_to_png(surface, filepath);
396 cairo_surface_destroy(surface);
401 screenshot_set_buffer_size_per_output(struct buffer_size *buff_size,
402 struct screenshooter_output *output)
404 buff_size->min_x = MIN(buff_size->min_x, output->offset_x);
405 buff_size->min_y = MIN(buff_size->min_y, output->offset_y);
406 buff_size->max_x = MAX(buff_size->max_x, output->offset_x + output->width);
407 buff_size->max_y = MAX(buff_size->max_y, output->offset_y + output->height);
409 buff_size->width = buff_size->max_x - buff_size->min_x;
410 buff_size->height = buff_size->max_y - buff_size->min_y;
414 screenshot_compute_output_offset(int *pos, struct screenshooter_output *sh_output)
416 sh_output->offset_x = *pos;
417 *pos += sh_output->width;
421 screenshot_set_buffer_size(struct buffer_size *buff_size, struct wl_list *output_list)
423 struct screenshooter_output *output;
426 buff_size->min_x = buff_size->min_y = INT_MAX;
427 buff_size->max_x = buff_size->max_y = INT_MIN;
429 wl_list_for_each_reverse(output, output_list, link)
430 screenshot_compute_output_offset(&pos, output);
432 wl_list_for_each(output, output_list, link)
433 screenshot_set_buffer_size_per_output(buff_size, output);
435 if (buff_size->max_x <= buff_size->min_x ||
436 buff_size->max_y <= buff_size->min_y)
439 buff_size->width = buff_size->max_x - buff_size->min_x;
440 buff_size->height = buff_size->max_y - buff_size->min_y;
445 static struct screenshooter_output *
446 agl_shooter_search_for_output(const char *output_name,
447 struct screenshooter_data *sh_data)
449 struct screenshooter_output *found_output = NULL;
450 struct xdg_output_v1_info *output;
455 wl_list_for_each(output, &sh_data->xdg_output_list, link) {
456 if (output->name && strcmp(output->name, output_name) == 0) {
457 found_output = output->output;
466 agl_shooter_display_all_outputs(struct screenshooter_data *sh_data)
468 struct xdg_output_v1_info *xdg_output;
469 wl_list_for_each(xdg_output, &sh_data->xdg_output_list, link) {
470 fprintf(stdout, "Output '%s', desc: '%s'\n", xdg_output->name,
471 xdg_output->description);
477 agl_shooter_screenshot_all_outputs(struct screenshooter_data *sh_data)
479 struct screenshooter_output *output;
480 struct buffer_size buff_size = {};
482 if (screenshot_set_buffer_size(&buff_size, &sh_data->output_list))
485 wl_list_for_each(output, &sh_data->output_list, link) {
487 screenshot_create_shm_buffer(output->width,
492 agl_screenshooter_take_shot(sh_data->screenshooter,
496 sh_data->buffer_copy_done = 0;
497 while (!sh_data->buffer_copy_done)
498 wl_display_roundtrip(sh_data->display);
501 screenshot_write_png(&buff_size, &sh_data->output_list);
505 agl_shooter_screenshot_output(struct screenshooter_output *sh_output)
508 struct buffer_size buff_size = {};
509 struct screenshooter_data *sh_data = sh_output->sh_data;
511 screenshot_compute_output_offset(&pos, sh_output);
512 screenshot_set_buffer_size_per_output(&buff_size, sh_output);
515 screenshot_create_shm_buffer(sh_output->width,
517 &sh_output->data, sh_data->shm);
519 agl_screenshooter_take_shot(sh_data->screenshooter,
523 sh_data->buffer_copy_done = 0;
524 while (!sh_data->buffer_copy_done)
525 wl_display_roundtrip(sh_data->display);
527 screenshot_write_png_per_output(&buff_size, sh_output);
531 agl_shooter_destroy_xdg_output_manager(struct screenshooter_data *sh_data)
533 struct xdg_output_v1_info *xdg_output;
535 wl_list_for_each(xdg_output, &sh_data->xdg_output_list, link) {
536 free(xdg_output->name);
537 free(xdg_output->description);
538 zxdg_output_v1_destroy(xdg_output->xdg_output);
541 zxdg_output_manager_v1_destroy(sh_data->xdg_output_manager);
545 print_usage_and_exit(void)
547 fprintf(stderr, "./agl-screenshooter [-o OUTPUT_NAME] [-l] [-a]\n");
549 fprintf(stderr, "\t-o OUTPUT_NAME -- take a screenshot of the output "
550 "specified by OUTPUT_NAME\n");
551 fprintf(stderr, "\t-a -- take a screenshot of all the outputs found\n");
552 fprintf(stderr, "\t-l -- list all the outputs found\n");
556 int main(int argc, char *argv[])
558 struct wl_display *display;
559 struct wl_registry *registry;
561 struct screenshooter_data sh_data = {};
562 struct screenshooter_output *sh_output = NULL;
565 char *output_name = NULL;
567 static struct option long_options[] = {
568 {"output", required_argument, 0, 'o' },
569 {"list", required_argument, 0, 'l' },
570 {"all", required_argument, 0, 'a' },
571 {"help", no_argument , 0, 'h' },
575 while ((c = getopt_long(argc, argv, "o:lah",
576 long_options, &option_index)) != -1) {
579 output_name = optarg;
580 opts |= (1 << OPT_SCREENSHOT_OUTPUT);
583 opts |= (1 << OPT_SHOW_ALL_OUTPUTS);
586 opts |= (1 << OPT_SCREENSHOT_ALL_OUTPUTS);
589 print_usage_and_exit();
593 display = wl_display_connect(NULL);
594 if (display == NULL) {
595 fprintf(stderr, "failed to create display: %s\n",
600 wl_list_init(&sh_data.output_list);
601 wl_list_init(&sh_data.xdg_output_list);
602 sh_data.display = display;
604 registry = wl_display_get_registry(display);
605 wl_registry_add_listener(registry, ®istry_listener, &sh_data);
607 wl_display_dispatch(display);
608 wl_display_roundtrip(display);
611 if (sh_data.screenshooter == NULL) {
612 fprintf(stderr, "Compositor doesn't support screenshooter\n");
616 wl_list_for_each(sh_output, &sh_data.output_list, link)
617 add_xdg_output_v1_info(&sh_data, sh_output);
619 /* do another round-trip for xdg_output */
620 wl_display_roundtrip(sh_data.display);
622 if (opts & (1 << OPT_SHOW_ALL_OUTPUTS)) {
623 agl_shooter_display_all_outputs(&sh_data);
624 agl_shooter_destroy_xdg_output_manager(&sh_data);
628 if (opts & (1 << OPT_SCREENSHOT_ALL_OUTPUTS)) {
629 agl_shooter_screenshot_all_outputs(&sh_data);
630 agl_shooter_destroy_xdg_output_manager(&sh_data);
636 sh_output = agl_shooter_search_for_output(output_name, &sh_data);
638 if (!sh_output && (opts & (1 << OPT_SCREENSHOT_OUTPUT))) {
639 fprintf(stderr, "Could not find an output matching '%s'\n",
641 agl_shooter_destroy_xdg_output_manager(&sh_data);
645 /* if we're still here just pick the first one available
646 * and use that. Still useful in case we are run without
647 * any args whatsoever */
649 sh_output = container_of(sh_data.output_list.next,
650 struct screenshooter_output, link);
652 /* take a screenshot only of that specific output */
653 agl_shooter_screenshot_output(sh_output);
654 agl_shooter_destroy_xdg_output_manager(&sh_data);