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