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