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