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