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