src/compositor.h

   1 /*
   2  * Copyright © 2008-2011 Kristian Høgsberg
   3  * Copyright © 2012 Collabora, Ltd.
   4  *
   5  * Permission to use, copy, modify, distribute, and sell this software and
   6  * its documentation for any purpose is hereby granted without fee, provided
   7  * that the above copyright notice appear in all copies and that both that
   8  * copyright notice and this permission notice appear in supporting
   9  * documentation, and that the name of the copyright holders not be used in
  10  * advertising or publicity pertaining to distribution of the software
  11  * without specific, written prior permission.  The copyright holders make
  12  * no representations about the suitability of this software for any
  13  * purpose.  It is provided "as is" without express or implied warranty.
  14  *
  15  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
  16  * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
  17  * FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
  18  * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
  19  * RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
  20  * CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  21  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  22  */
  23
  24 #ifndef _WAYLAND_SYSTEM_COMPOSITOR_H_
  25 #define _WAYLAND_SYSTEM_COMPOSITOR_H_
  26
  27 #include <pixman.h>
  28 #include <xkbcommon/xkbcommon.h>
  29 #include <wayland-server.h>
  30
  31 #include <GLES2/gl2.h>
  32 #include <GLES2/gl2ext.h>
  33 #include <EGL/egl.h>
  34 #include <EGL/eglext.h>
  35
  36 #include "matrix.h"
  37 #include "../shared/config-parser.h"
  38 #include "weston-egl-ext.h"
  39
  40
  41 struct weston_transform {
  42         struct weston_matrix matrix;
  43         struct wl_list link;
  44 };
  45
  46 struct weston_surface;
  47 struct shell_surface;
  48 struct weston_seat;
  49 struct weston_output;
  50
  51 struct weston_mode {
  52         uint32_t flags;
  53         int32_t width, height;
  54         uint32_t refresh;
  55         struct wl_list link;
  56 };
  57
  58 struct weston_shell_client {
  59         void (*send_configure)(struct weston_surface *surface,
  60                                uint32_t edges, int32_t width, int32_t height);
  61 };
  62
  63 struct weston_shell_interface {
  64         void *shell;                    /* either desktop or tablet */
  65
  66         struct shell_surface *(*create_shell_surface)(void *shell,
  67                                                       struct weston_surface *surface,
  68                                                       const struct weston_shell_client *client);
  69
  70         void (*set_toplevel)(struct shell_surface *shsurf);
  71
  72         void (*set_transient)(struct shell_surface *shsurf,
  73                               struct shell_surface *pshsurf,
  74                               int x, int y, uint32_t flags);
  75         int (*move)(struct shell_surface *shsurf, struct weston_seat *ws);
  76         int (*resize)(struct shell_surface *shsurf,
  77                       struct weston_seat *ws, uint32_t edges);
  78
  79 };
  80
  81 struct weston_border {
  82         int32_t left, right, top, bottom;
  83 };
  84
  85 struct weston_output_zoom {
  86         int active;
  87         float increment;
  88         float level;
  89         float trans_x, trans_y;
  90 };
  91
  92 /* bit compatible with drm definitions. */
  93 enum dpms_enum {
  94         WESTON_DPMS_ON,
  95         WESTON_DPMS_STANDBY,
  96         WESTON_DPMS_SUSPEND,
  97         WESTON_DPMS_OFF
  98 };
  99
 100 struct weston_read_pixels {
 101         void *data;
 102         int x, y, width, height;
 103         void (*done)(struct weston_read_pixels *read_pixels,
 104                      struct weston_output *output);
 105         struct wl_list link;
 106 };
 107
 108 struct weston_output {
 109         uint32_t id;
 110
 111         struct wl_list link;
 112         struct wl_list resource_list;
 113         struct wl_global *global;
 114         struct weston_compositor *compositor;
 115         struct weston_matrix matrix;
 116         struct wl_list frame_callback_list;
 117         int32_t x, y, mm_width, mm_height;
 118         struct weston_border border;
 119         pixman_region32_t region;
 120         pixman_region32_t previous_damage;
 121         uint32_t flags;
 122         int repaint_needed;
 123         int repaint_scheduled;
 124         struct weston_output_zoom zoom;
 125         int dirty;
 126         struct wl_list read_pixels_list;
 127         struct wl_signal frame_signal;
 128
 129         char *make, *model;
 130         uint32_t subpixel;
 131
 132         struct weston_mode *current;
 133         struct weston_mode *origin;
 134         struct wl_list mode_list;
 135
 136         void (*repaint)(struct weston_output *output,
 137                         pixman_region32_t *damage);
 138         void (*destroy)(struct weston_output *output);
 139         void (*assign_planes)(struct weston_output *output);
 140         int (*switch_mode)(struct weston_output *output, struct weston_mode *mode);
 141
 142         /* backlight values are on 0-255 range, where higher is brighter */
 143         uint32_t backlight_current;
 144         void (*set_backlight)(struct weston_output *output, uint32_t value);
 145         void (*set_dpms)(struct weston_output *output, enum dpms_enum level);
 146 };
 147
 148 struct weston_seat {
 149         struct wl_seat seat;
 150         struct wl_pointer pointer;
 151         struct wl_keyboard keyboard;
 152         struct wl_touch touch;
 153         struct weston_compositor *compositor;
 154         struct weston_surface *sprite;
 155         struct weston_surface *drag_surface;
 156         struct wl_listener drag_surface_destroy_listener;
 157         int32_t hotspot_x, hotspot_y;
 158         struct wl_list link;
 159         uint32_t modifier_state;
 160         int hw_cursor;
 161         struct wl_surface *saved_kbd_focus;
 162         struct wl_listener saved_kbd_focus_listener;
 163
 164         uint32_t num_tp;
 165         struct wl_surface *touch_focus;
 166         struct wl_listener touch_focus_listener;
 167         struct wl_resource *touch_focus_resource;
 168         struct wl_listener touch_focus_resource_listener;
 169
 170         struct wl_listener new_drag_icon_listener;
 171 };
 172
 173 struct weston_shader {
 174         GLuint program;
 175         GLuint vertex_shader, fragment_shader;
 176         GLint proj_uniform;
 177         GLint tex_uniform;
 178         GLint alpha_uniform;
 179         GLint brightness_uniform;
 180         GLint saturation_uniform;
 181         GLint color_uniform;
 182         GLint texwidth_uniform;
 183         GLint opaque_uniform;
 184 };
 185
 186 struct weston_animation {
 187         void (*frame)(struct weston_animation *animation,
 188                       struct weston_output *output, uint32_t msecs);
 189         struct wl_list link;
 190 };
 191
 192 struct weston_spring {
 193         double k;
 194         double friction;
 195         double current;
 196         double target;
 197         double previous;
 198         uint32_t timestamp;
 199 };
 200
 201 enum {
 202         WESTON_COMPOSITOR_ACTIVE,
 203         WESTON_COMPOSITOR_IDLE,         /* shell->unlock called on activity */
 204         WESTON_COMPOSITOR_SLEEPING      /* no rendering, no frame events */
 205 };
 206
 207 struct weston_layer {
 208         struct wl_list surface_list;
 209         struct wl_list link;
 210 };
 211
 212 struct weston_compositor {
 213         struct wl_shm *shm;
 214         struct wl_signal destroy_signal;
 215
 216         EGLDisplay display;
 217         EGLContext context;
 218         EGLConfig config;
 219         GLuint fbo;
 220         struct weston_shader texture_shader;
 221         struct weston_shader solid_shader;
 222         struct weston_shader *current_shader;
 223         struct wl_display *wl_display;
 224         struct weston_shell_interface shell_interface;
 225
 226         struct wl_signal activate_signal;
 227         struct wl_signal lock_signal;
 228         struct wl_signal unlock_signal;
 229
 230         struct wl_event_loop *input_loop;
 231         struct wl_event_source *input_loop_source;
 232
 233         /* There can be more than one, but not right now... */
 234         struct weston_seat *seat;
 235
 236         struct weston_layer fade_layer;
 237         struct weston_layer cursor_layer;
 238
 239         struct wl_list output_list;
 240         struct wl_list seat_list;
 241         struct wl_list layer_list;
 242         struct wl_list surface_list;
 243         struct wl_list binding_list;
 244         struct wl_list animation_list;
 245         struct {
 246                 struct weston_spring spring;
 247                 struct weston_animation animation;
 248                 struct weston_surface *surface;
 249         } fade;
 250
 251         uint32_t state;
 252         struct wl_event_source *idle_source;
 253         uint32_t idle_inhibit;
 254         int option_idle_time;           /* default timeout, s */
 255         int idle_time;                  /* effective timeout, s */
 256
 257         /* Repaint state. */
 258         struct wl_array vertices, indices;
 259         pixman_region32_t damage;
 260
 261         uint32_t focus;
 262
 263         PFNGLEGLIMAGETARGETRENDERBUFFERSTORAGEOESPROC
 264                 image_target_renderbuffer_storage;
 265         PFNGLEGLIMAGETARGETTEXTURE2DOESPROC image_target_texture_2d;
 266         PFNEGLCREATEIMAGEKHRPROC create_image;
 267         PFNEGLDESTROYIMAGEKHRPROC destroy_image;
 268
 269         int has_unpack_subimage;
 270         GLenum read_format;
 271
 272         PFNEGLBINDWAYLANDDISPLAYWL bind_display;
 273         PFNEGLUNBINDWAYLANDDISPLAYWL unbind_display;
 274         int has_bind_display;
 275
 276         void (*destroy)(struct weston_compositor *ec);
 277         int (*authenticate)(struct weston_compositor *c, uint32_t id);
 278
 279         void (*ping_handler)(struct weston_surface *surface, uint32_t serial);
 280
 281         int launcher_sock;
 282
 283         uint32_t output_id_pool;
 284
 285         struct {
 286                 struct xkb_rule_names names;
 287                 struct xkb_context *context;
 288                 struct xkb_keymap *keymap;
 289                 struct xkb_state *state;
 290         } xkb_info;
 291 };
 292
 293 #define MODIFIER_CTRL   (1 << 8)
 294 #define MODIFIER_ALT    (1 << 9)
 295 #define MODIFIER_SUPER  (1 << 10)
 296
 297 enum weston_output_flags {
 298         WL_OUTPUT_FLIPPED = 0x01
 299 };
 300
 301 struct weston_region {
 302         struct wl_resource resource;
 303         pixman_region32_t region;
 304 };
 305
 306 /* Using weston_surface transformations
 307  *
 308  * To add a transformation to a surface, create a struct weston_transform, and
 309  * add it to the list surface->geometry.transformation_list. Whenever you
 310  * change the list, anything under surface->geometry, or anything in the
 311  * weston_transforms linked into the list, you must set
 312  * surface->geometry.dirty = 1.
 313  *
 314  * The order in the list defines the order of transformations. Let the list
 315  * contain the transformation matrices M1, ..., Mn as head to tail. The
 316  * transformation is applied to surface-local coordinate vector p as
 317  *    P = Mn * ... * M2 * M1 * p
 318  * to produce the global coordinate vector P. The total transform
 319  *    Mn * ... * M2 * M1
 320  * is cached in surface->transform.matrix, and the inverse of it in
 321  * surface->transform.inverse.
 322  *
 323  * The list always contains surface->transform.position transformation, which
 324  * is the translation by surface->geometry.x and y.
 325  *
 326  * If you want to apply a transformation in local coordinates, add your
 327  * weston_transform to the head of the list. If you want to apply a
 328  * transformation in global coordinates, add it to the tail of the list.
 329  */
 330
 331 struct weston_surface {
 332         struct wl_surface surface;
 333         struct weston_compositor *compositor;
 334         GLuint texture;
 335         pixman_region32_t clip;
 336         pixman_region32_t damage;
 337         pixman_region32_t opaque;
 338         pixman_region32_t input;
 339         int32_t pitch;
 340         struct wl_list link;
 341         struct wl_list layer_link;
 342         struct weston_shader *shader;
 343         GLfloat color[4];
 344         GLfloat opaque_rect[4];
 345         GLfloat alpha;
 346         GLfloat brightness;
 347         GLfloat saturation;
 348         int blend;
 349
 350         /* Surface geometry state, mutable.
 351          * If you change anything, set dirty = 1.
 352          * That includes the transformations referenced from the list.
 353          */
 354         struct {
 355                 GLfloat x, y; /* surface translation on display */
 356                 int32_t width, height;
 357
 358                 /* struct weston_transform */
 359                 struct wl_list transformation_list;
 360
 361                 int dirty;
 362         } geometry;
 363
 364         /* State derived from geometry state, read-only.
 365          * This is updated by weston_surface_update_transform().
 366          */
 367         struct {
 368                 pixman_region32_t boundingbox;
 369                 pixman_region32_t opaque;
 370
 371                 /* matrix and inverse are used only if enabled = 1.
 372                  * If enabled = 0, use x, y, width, height directly.
 373                  */
 374                 int enabled;
 375                 struct weston_matrix matrix;
 376                 struct weston_matrix inverse;
 377
 378                 struct weston_transform position; /* matrix from x, y */
 379         } transform;
 380
 381         /*
 382          * Which output to vsync this surface to.
 383          * Used to determine, whether to send or queue frame events.
 384          * Must be NULL, if 'link' is not in weston_compositor::surface_list.
 385          */
 386         struct weston_output *output;
 387
 388         /*
 389          * A more complete representation of all outputs this surface is
 390          * displayed on.
 391          */
 392         uint32_t output_mask;
 393
 394         struct wl_list frame_callback_list;
 395
 396         EGLImageKHR image;
 397
 398         struct wl_buffer *buffer;
 399         struct wl_listener buffer_destroy_listener;
 400
 401         /*
 402          * If non-NULL, this function will be called on surface::attach after
 403          * a new buffer has been set up for this surface. The integer params
 404          * are the sx and sy paramerters supplied to surface::attach .
 405          */
 406         void (*configure)(struct weston_surface *es, int32_t sx, int32_t sy);
 407         void *private;
 408 };
 409
 410 void
 411 weston_surface_update_transform(struct weston_surface *surface);
 412
 413 void
 414 weston_surface_to_global(struct weston_surface *surface,
 415                          int32_t sx, int32_t sy, int32_t *x, int32_t *y);
 416 void
 417 weston_surface_to_global_fixed(struct weston_surface *surface,
 418                                wl_fixed_t sx, wl_fixed_t sy,
 419                                wl_fixed_t *x, wl_fixed_t *y);
 420 void
 421 weston_surface_to_global_float(struct weston_surface *surface,
 422                                GLfloat sx, GLfloat sy, GLfloat *x, GLfloat *y);
 423
 424 void
 425 weston_surface_from_global(struct weston_surface *surface,
 426                            int32_t x, int32_t y, int32_t *sx, int32_t *sy);
 427 void
 428 weston_surface_from_global_fixed(struct weston_surface *surface,
 429                                  wl_fixed_t x, wl_fixed_t y,
 430                                  wl_fixed_t *sx, wl_fixed_t *sy);
 431
 432 void
 433 weston_spring_init(struct weston_spring *spring,
 434                    double k, double current, double target);
 435 void
 436 weston_spring_update(struct weston_spring *spring, uint32_t msec);
 437 int
 438 weston_spring_done(struct weston_spring *spring);
 439
 440 void
 441 weston_surface_activate(struct weston_surface *surface,
 442                         struct weston_seat *seat);
 443 void
 444 weston_surface_draw(struct weston_surface *es,
 445                     struct weston_output *output, pixman_region32_t *damage);
 446
 447 void
 448 notify_motion(struct wl_seat *seat, uint32_t time,
 449               wl_fixed_t x, wl_fixed_t y);
 450 void
 451 notify_button(struct wl_seat *seat, uint32_t time, int32_t button,
 452               uint32_t state);
 453 void
 454 notify_axis(struct wl_seat *seat, uint32_t time, uint32_t axis,
 455             int32_t value);
 456 void
 457 notify_key(struct wl_seat *seat, uint32_t time, uint32_t key,
 458            uint32_t state);
 459
 460 void
 461 notify_pointer_focus(struct wl_seat *seat, struct weston_output *output,
 462                      wl_fixed_t x, wl_fixed_t y);
 463
 464 void
 465 notify_keyboard_focus(struct wl_seat *seat, struct wl_array *keys);
 466
 467 void
 468 notify_touch(struct wl_seat *seat, uint32_t time, int touch_id,
 469              wl_fixed_t x, wl_fixed_t y, int touch_type);
 470
 471 void
 472 weston_layer_init(struct weston_layer *layer, struct wl_list *below);
 473
 474 void
 475 weston_output_finish_frame(struct weston_output *output, int msecs);
 476 void
 477 weston_output_damage(struct weston_output *output);
 478 void
 479 weston_output_do_read_pixels(struct weston_output *output);
 480 void
 481 weston_compositor_repick(struct weston_compositor *compositor);
 482 void
 483 weston_compositor_schedule_repaint(struct weston_compositor *compositor);
 484 void
 485 weston_compositor_fade(struct weston_compositor *compositor, float tint);
 486 void
 487 weston_compositor_damage_all(struct weston_compositor *compositor);
 488 void
 489 weston_compositor_unlock(struct weston_compositor *compositor);
 490 void
 491 weston_compositor_wake(struct weston_compositor *compositor);
 492 void
 493 weston_compositor_activity(struct weston_compositor *compositor);
 494 void
 495 weston_compositor_update_drag_surfaces(struct weston_compositor *compositor);
 496
 497
 498 struct weston_binding;
 499 typedef void (*weston_binding_handler_t)(struct wl_seat *seat,
 500                                          uint32_t time, uint32_t key,
 501                                          uint32_t button,
 502                                          uint32_t axis,
 503                                          int32_t value, void *data);
 504 struct weston_binding *
 505 weston_compositor_add_binding(struct weston_compositor *compositor,
 506                               uint32_t key, uint32_t button, uint32_t axis,
 507                               uint32_t modifier,
 508                               weston_binding_handler_t binding, void *data);
 509 void
 510 weston_binding_destroy(struct weston_binding *binding);
 511
 512 void
 513 weston_binding_list_destroy_all(struct wl_list *list);
 514
 515 void
 516 weston_compositor_run_binding(struct weston_compositor *compositor,
 517                               struct weston_seat *seat,
 518                               uint32_t time,
 519                               uint32_t key, uint32_t button, uint32_t axis,
 520                               int32_t value);
 521 int
 522 weston_environment_get_fd(const char *env);
 523
 524 struct wl_list *
 525 weston_compositor_top(struct weston_compositor *compositor);
 526
 527 struct weston_surface *
 528 weston_surface_create(struct weston_compositor *compositor);
 529
 530 void
 531 weston_surface_configure(struct weston_surface *surface,
 532                          GLfloat x, GLfloat y, int width, int height);
 533
 534 void
 535 weston_surface_restack(struct weston_surface *surface, struct wl_list *below);
 536
 537 void
 538 weston_surface_set_position(struct weston_surface *surface,
 539                             GLfloat x, GLfloat y);
 540
 541 int
 542 weston_surface_is_mapped(struct weston_surface *surface);
 543
 544 void
 545 weston_surface_assign_output(struct weston_surface *surface);
 546
 547 void
 548 weston_surface_damage(struct weston_surface *surface);
 549
 550 void
 551 weston_surface_damage_below(struct weston_surface *surface);
 552
 553 void
 554 weston_buffer_post_release(struct wl_buffer *buffer);
 555
 556 uint32_t
 557 weston_compositor_get_time(void);
 558
 559 int
 560 weston_compositor_init(struct weston_compositor *ec, struct wl_display *display);
 561 void
 562 weston_compositor_shutdown(struct weston_compositor *ec);
 563 void
 564 weston_output_update_zoom(struct weston_output *output, int x, int y);
 565 void
 566 weston_output_update_matrix(struct weston_output *output);
 567 void
 568 weston_output_move(struct weston_output *output, int x, int y);
 569 void
 570 weston_output_init(struct weston_output *output, struct weston_compositor *c,
 571                    int x, int y, int width, int height, uint32_t flags);
 572 void
 573 weston_output_destroy(struct weston_output *output);
 574
 575 void
 576 weston_seat_init(struct weston_seat *seat, struct weston_compositor *ec);
 577
 578 void
 579 weston_seat_release(struct weston_seat *seat);
 580
 581 enum {
 582         TTY_ENTER_VT,
 583         TTY_LEAVE_VT
 584 };
 585
 586 typedef void (*tty_vt_func_t)(struct weston_compositor *compositor, int event);
 587
 588 struct tty *
 589 tty_create(struct weston_compositor *compositor,
 590            tty_vt_func_t vt_func, int tty_nr);
 591
 592 void
 593 tty_destroy(struct tty *tty);
 594
 595 int
 596 tty_activate_vt(struct tty *tty, int vt);
 597
 598 void
 599 screenshooter_create(struct weston_compositor *ec);
 600
 601 struct weston_process;
 602 typedef void (*weston_process_cleanup_func_t)(struct weston_process *process,
 603                                             int status);
 604
 605 struct weston_process {
 606         pid_t pid;
 607         weston_process_cleanup_func_t cleanup;
 608         struct wl_list link;
 609 };
 610
 611 struct wl_client *
 612 weston_client_launch(struct weston_compositor *compositor,
 613                      struct weston_process *proc,
 614                      const char *path,
 615                      weston_process_cleanup_func_t cleanup);
 616
 617 void
 618 weston_watch_process(struct weston_process *process);
 619
 620 int
 621 weston_xserver_init(struct weston_compositor *compositor);
 622
 623 struct weston_zoom;
 624 typedef void (*weston_zoom_done_func_t)(struct weston_zoom *zoom, void *data);
 625
 626 struct weston_zoom *
 627 weston_zoom_run(struct weston_surface *surface, GLfloat start, GLfloat stop,
 628                 weston_zoom_done_func_t done, void *data);
 629
 630 struct weston_fade;
 631 typedef void (*weston_fade_done_func_t)(struct weston_fade *fade, void *data);
 632
 633 struct weston_fade *
 634 weston_fade_run(struct weston_surface *surface,
 635                 weston_fade_done_func_t done, void *data);
 636
 637
 638 void
 639 weston_surface_set_color(struct weston_surface *surface,
 640                          GLfloat red, GLfloat green, GLfloat blue, GLfloat alpha);
 641
 642 void
 643 weston_surface_destroy(struct weston_surface *surface);
 644
 645 struct weston_compositor *
 646 backend_init(struct wl_display *display, int argc, char *argv[]);
 647
 648 int
 649 weston_output_switch_mode(struct weston_output *output, struct weston_mode *mode);
 650
 651 #endif