src/screenshooter.c

   1 /*
   2  * Copyright © 2008-2011 Kristian Høgsberg
   3  *
   4  * Permission to use, copy, modify, distribute, and sell this software and
   5  * its documentation for any purpose is hereby granted without fee, provided
   6  * that the above copyright notice appear in all copies and that both that
   7  * copyright notice and this permission notice appear in supporting
   8  * documentation, and that the name of the copyright holders not be used in
   9  * advertising or publicity pertaining to distribution of the software
  10  * without specific, written prior permission.  The copyright holders make
  11  * no representations about the suitability of this software for any
  12  * purpose.  It is provided "as is" without express or implied warranty.
  13  *
  14  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
  15  * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
  16  * FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
  17  * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
  18  * RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
  19  * CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  20  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  21  */
  22
  23 #include <stdlib.h>
  24 #include <stdio.h>
  25 #include <string.h>
  26 #include <linux/input.h>
  27 #include <fcntl.h>
  28 #include <unistd.h>
  29 #include <sys/uio.h>
  30
  31 #include "compositor.h"
  32 #include "screenshooter-server-protocol.h"
  33
  34 #include "../wcap/wcap-decode.h"
  35
  36 struct screenshooter {
  37         struct wl_object base;
  38         struct weston_compositor *ec;
  39         struct wl_global *global;
  40         struct wl_client *client;
  41         struct weston_process process;
  42         struct wl_listener destroy_listener;
  43 };
  44
  45 struct screenshooter_read_pixels {
  46         struct weston_read_pixels base;
  47         struct wl_buffer *buffer;
  48         struct wl_resource *resource;
  49 };
  50
  51 static void
  52 copy_bgra_yflip(uint8_t *dst, uint8_t *src, int height, int stride)
  53 {
  54         uint8_t *end;
  55
  56         end = dst + height * stride;
  57         while (dst < end) {
  58                 memcpy(dst, src, stride);
  59                 dst += stride;
  60                 src -= stride;
  61         }
  62 }
  63
  64 static void
  65 copy_row_swap_RB(void *vdst, void *vsrc, int bytes)
  66 {
  67         uint32_t *dst = vdst;
  68         uint32_t *src = vsrc;
  69         uint32_t *end = dst + bytes / 4;
  70
  71         while (dst < end) {
  72                 uint32_t v = *src++;
  73                 /*                    A R G B */
  74                 uint32_t tmp = v & 0xff00ff00;
  75                 tmp |= (v >> 16) & 0x000000ff;
  76                 tmp |= (v << 16) & 0x00ff0000;
  77                 *dst++ = tmp;
  78         }
  79 }
  80
  81 static void
  82 copy_rgba_yflip(uint8_t *dst, uint8_t *src, int height, int stride)
  83 {
  84         uint8_t *end;
  85
  86         end = dst + height * stride;
  87         while (dst < end) {
  88                 copy_row_swap_RB(dst, src, stride);
  89                 dst += stride;
  90                 src -= stride;
  91         }
  92 }
  93
  94 static void
  95 screenshooter_read_pixels_done(struct weston_read_pixels *base,
  96                                struct weston_output *output)
  97 {
  98         struct screenshooter_read_pixels *r =
  99                 (struct screenshooter_read_pixels *) base;
 100         int32_t stride;
 101         uint8_t *d, *s;
 102
 103         stride = wl_shm_buffer_get_stride(r->buffer);
 104
 105         d = wl_shm_buffer_get_data(r->buffer);
 106         s = r->base.data + stride * (r->buffer->height - 1);
 107
 108         switch (output->compositor->read_format) {
 109         case GL_BGRA_EXT:
 110                 copy_bgra_yflip(d, s, output->current->height, stride);
 111                 break;
 112         case GL_RGBA:
 113                 copy_rgba_yflip(d, s, output->current->height, stride);
 114                 break;
 115         default:
 116                 break;
 117         }
 118
 119         wl_list_remove(&r->base.link);
 120
 121         screenshooter_send_done(r->resource);
 122         free(r->base.data);
 123         free(r);
 124
 125 }
 126
 127 static void
 128 screenshooter_shoot(struct wl_client *client,
 129                     struct wl_resource *resource,
 130                     struct wl_resource *output_resource,
 131                     struct wl_resource *buffer_resource)
 132 {
 133         struct weston_output *output = output_resource->data;
 134         struct screenshooter_read_pixels *r;
 135         struct wl_buffer *buffer = buffer_resource->data;
 136         int32_t stride;
 137
 138         if (!wl_buffer_is_shm(buffer))
 139                 return;
 140
 141         if (buffer->width < output->current->width ||
 142             buffer->height < output->current->height)
 143                 return;
 144
 145         r = malloc(sizeof *r);
 146         if (r == NULL) {
 147                 wl_resource_post_no_memory(resource);
 148                 return;
 149         }
 150
 151         r->base.x = 0;
 152         r->base.y = 0;
 153         r->base.width = output->current->width;
 154         r->base.height = output->current->height;
 155         r->base.done = screenshooter_read_pixels_done;
 156         r->buffer = buffer;
 157         r->resource = resource;
 158         stride = buffer->width * 4;
 159         r->base.data = malloc(stride * buffer->height);
 160
 161         if (r->base.data == NULL) {
 162                 free(r);
 163                 wl_resource_post_no_memory(resource);
 164                 return;
 165         }
 166
 167         wl_list_insert(output->read_pixels_list.prev, &r->base.link);
 168         weston_compositor_schedule_repaint(output->compositor);
 169 }
 170
 171 struct screenshooter_interface screenshooter_implementation = {
 172         screenshooter_shoot
 173 };
 174
 175 static void
 176 bind_shooter(struct wl_client *client,
 177              void *data, uint32_t version, uint32_t id)
 178 {
 179         struct screenshooter *shooter = data;
 180         struct wl_resource *resource;
 181
 182         resource = wl_client_add_object(client, &screenshooter_interface,
 183                              &screenshooter_implementation, id, data);
 184
 185         if (client != shooter->client) {
 186                 wl_resource_post_error(resource, WL_DISPLAY_ERROR_INVALID_OBJECT,
 187                                        "screenshooter failed: permission denied");
 188                 wl_resource_destroy(resource);
 189         }
 190 }
 191
 192 static void
 193 screenshooter_sigchld(struct weston_process *process, int status)
 194 {
 195         struct screenshooter *shooter =
 196                 container_of(process, struct screenshooter, process);
 197
 198         shooter->client = NULL;
 199 }
 200
 201 static void
 202 screenshooter_binding(struct wl_seat *seat, uint32_t time, uint32_t key,
 203                       void *data)
 204 {
 205         struct screenshooter *shooter = data;
 206         const char *screenshooter_exe = LIBEXECDIR "/weston-screenshooter";
 207
 208         if (!shooter->client)
 209                 shooter->client = weston_client_launch(shooter->ec,
 210                                         &shooter->process,
 211                                         screenshooter_exe, screenshooter_sigchld);
 212 }
 213
 214 struct weston_recorder {
 215         struct weston_output *output;
 216         uint32_t *frame, *rect;
 217         uint32_t total;
 218         int fd;
 219         struct wl_listener frame_listener;
 220         int count;
 221 };
 222
 223 static uint32_t *
 224 output_run(uint32_t *p, uint32_t delta, int run)
 225 {
 226         int i;
 227
 228         while (run > 0) {
 229                 if (run <= 0xe0) {
 230                         *p++ = delta | ((run - 1) << 24);
 231                         break;
 232                 }
 233
 234                 i = 24 - __builtin_clz(run);
 235                 *p++ = delta | ((i + 0xe0) << 24);
 236                 run -= 1 << (7 + i);
 237         }
 238
 239         return p;
 240 }
 241
 242 static uint32_t
 243 component_delta(uint32_t next, uint32_t prev)
 244 {
 245         unsigned char dr, dg, db;
 246
 247         dr = (next >> 16) - (prev >> 16);
 248         dg = (next >>  8) - (prev >>  8);
 249         db = (next >>  0) - (prev >>  0);
 250
 251         return (dr << 16) | (dg << 8) | (db << 0);
 252 }
 253
 254 static void
 255 weston_recorder_frame_notify(struct wl_listener *listener, void *data)
 256 {
 257         struct weston_recorder *recorder =
 258                 container_of(listener, struct weston_recorder, frame_listener);
 259         struct weston_output *output = recorder->output;
 260         uint32_t msecs = * (uint32_t *) data;
 261         pixman_box32_t *r;
 262         pixman_region32_t damage;
 263         int i, j, k, n, width, height, run, stride;
 264         uint32_t delta, prev, *d, *s, *p, next;
 265         struct {
 266                 uint32_t msecs;
 267                 uint32_t nrects;
 268         } header;
 269         struct iovec v[2];
 270
 271         pixman_region32_init(&damage);
 272         pixman_region32_intersect(&damage, &recorder->output->region,
 273                                   &recorder->output->previous_damage);
 274
 275         r = pixman_region32_rectangles(&damage, &n);
 276         if (n == 0)
 277                 return;
 278         if (recorder->count++ == 0)
 279                 /* The first callback gives us the frame immediately
 280                  * before the weston_output_damage() call, and
 281                  * typically doesn't give us a full frame of damage.*/
 282                 return;
 283
 284         header.msecs = msecs;
 285         header.nrects = n;
 286         v[0].iov_base = &header;
 287         v[0].iov_len = sizeof header;
 288         v[1].iov_base = r;
 289         v[1].iov_len = n * sizeof *r;
 290         recorder->total += writev(recorder->fd, v, 2);
 291         stride = output->current->width;
 292
 293         for (i = 0; i < n; i++) {
 294                 width = r[i].x2 - r[i].x1;
 295                 height = r[i].y2 - r[i].y1;
 296                 glReadPixels(r[i].x1, output->current->height - r[i].y2,
 297                              width, height,
 298                              output->compositor->read_format,
 299                              GL_UNSIGNED_BYTE, recorder->rect);
 300
 301                 s = recorder->rect;
 302                 p = recorder->rect;
 303                 run = prev = 0; /* quiet gcc */
 304                 for (j = 0; j < height; j++) {
 305                         d = recorder->frame +
 306                                 stride * (r[i].y2 - j - 1) + r[i].x1;
 307                         for (k = 0; k < width; k++) {
 308                                 next = *s++;
 309                                 delta = component_delta(next, *d);
 310                                 *d++ = next;
 311                                 if (run == 0 || delta == prev) {
 312                                         run++;
 313                                 } else {
 314                                         p = output_run(p, prev, run);
 315                                         run = 1;
 316                                         prev = delta;
 317                                 }
 318                         }
 319                 }
 320
 321                 p = output_run(p, prev, run);
 322
 323                 recorder->total += write(recorder->fd,
 324                                          recorder->rect,
 325                                          (p - recorder->rect) * 4);
 326
 327 #if 0
 328                 fprintf(stderr,
 329                         "%dx%d at %d,%d rle from %d to %d bytes (%f) total %dM\n",
 330                         width, height, r[i].x1, r[i].y1,
 331                         width * height * 4, (int) (p - recorder->rect) * 4,
 332                         (float) (p - recorder->rect) / (width * height),
 333                         recorder->total / 1024 / 1024);
 334 #endif
 335         }
 336
 337         pixman_region32_fini(&damage);
 338 }
 339
 340 static void
 341 weston_recorder_create(struct weston_output *output, const char *filename)
 342 {
 343         struct weston_recorder *recorder;
 344         int stride, size;
 345         struct { uint32_t magic, format, width, height; } header;
 346
 347         recorder = malloc(sizeof *recorder);
 348         recorder->output = output;
 349
 350         stride = output->current->width;
 351         size = stride * 4 * output->current->height;
 352         recorder->frame = malloc(size);
 353         recorder->rect = malloc(size);
 354         recorder->total = 0;
 355         recorder->count = 0;
 356         memset(recorder->frame, 0, size);
 357
 358         recorder->fd = open(filename,
 359                             O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC, 0644);
 360
 361         header.magic = WCAP_HEADER_MAGIC;
 362
 363         switch (output->compositor->read_format) {
 364         case GL_BGRA_EXT:
 365                 header.format = WCAP_FORMAT_XRGB8888;
 366                 break;
 367         case GL_RGBA:
 368                 header.format = WCAP_FORMAT_XBGR8888;
 369                 break;
 370         }
 371
 372         header.width = output->current->width;
 373         header.height = output->current->height;
 374         recorder->total += write(recorder->fd, &header, sizeof header);
 375
 376         recorder->frame_listener.notify = weston_recorder_frame_notify;
 377         wl_signal_add(&output->frame_signal, &recorder->frame_listener);
 378         weston_output_damage(output);
 379 }
 380
 381 static void
 382 weston_recorder_destroy(struct weston_recorder *recorder)
 383 {
 384         wl_list_remove(&recorder->frame_listener.link);
 385         close(recorder->fd);
 386         free(recorder->frame);
 387         free(recorder->rect);
 388         free(recorder);
 389 }
 390
 391 static void
 392 recorder_binding(struct wl_seat *seat, uint32_t time, uint32_t key, void *data)
 393 {
 394         struct weston_seat *ws = (struct weston_seat *) seat;
 395         struct weston_compositor *ec = ws->compositor;
 396         struct weston_output *output =
 397                 container_of(ec->output_list.next,
 398                              struct weston_output, link);
 399         struct wl_listener *listener;
 400         struct weston_recorder *recorder;
 401         static const char filename[] = "capture.wcap";
 402
 403         listener = wl_signal_get(&output->frame_signal,
 404                                  weston_recorder_frame_notify);
 405         if (listener) {
 406                 recorder = container_of(listener, struct weston_recorder,
 407                                         frame_listener);
 408
 409                 fprintf(stderr,
 410                         "stopping recorder, total file size %dM, %d frames\n",
 411                         recorder->total / (1024 * 1024), recorder->count);
 412
 413                 weston_recorder_destroy(recorder);
 414         } else {
 415                 fprintf(stderr, "starting recorder, file %s\n", filename);
 416                 weston_recorder_create(output, filename);
 417         }
 418 }
 419
 420 static void
 421 screenshooter_destroy(struct wl_listener *listener, void *data)
 422 {
 423         struct screenshooter *shooter =
 424                 container_of(listener, struct screenshooter, destroy_listener);
 425
 426         wl_display_remove_global(shooter->ec->wl_display, shooter->global);
 427         free(shooter);
 428 }
 429
 430 void
 431 screenshooter_create(struct weston_compositor *ec)
 432 {
 433         struct screenshooter *shooter;
 434
 435         shooter = malloc(sizeof *shooter);
 436         if (shooter == NULL)
 437                 return;
 438
 439         shooter->base.interface = &screenshooter_interface;
 440         shooter->base.implementation =
 441                 (void(**)(void)) &screenshooter_implementation;
 442         shooter->ec = ec;
 443         shooter->client = NULL;
 444
 445         shooter->global = wl_display_add_global(ec->wl_display,
 446                                                 &screenshooter_interface,
 447                                                 shooter, bind_shooter);
 448         weston_compositor_add_key_binding(ec, KEY_S, MODIFIER_SUPER,
 449                                           screenshooter_binding, shooter);
 450         weston_compositor_add_key_binding(ec, KEY_R, MODIFIER_SUPER,
 451                                           recorder_binding, shooter);
 452
 453         shooter->destroy_listener.notify = screenshooter_destroy;
 454         wl_signal_add(&ec->destroy_signal, &shooter->destroy_listener);
 455 }