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