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