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