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