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