Move keymaps to weston_seat
[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         int32_t x, y, mm_width, mm_height;
135         struct weston_border border;
136         pixman_region32_t region;
137         pixman_region32_t previous_damage;
138         uint32_t flags;
139         int repaint_needed;
140         int repaint_scheduled;
141         struct weston_output_zoom zoom;
142         int dirty;
143         struct wl_list read_pixels_list;
144         struct wl_signal frame_signal;
145
146         char *make, *model;
147         uint32_t subpixel;
148         
149         struct weston_mode *current;
150         struct weston_mode *origin;
151         struct wl_list mode_list;
152
153         void (*repaint)(struct weston_output *output,
154                         pixman_region32_t *damage);
155         void (*destroy)(struct weston_output *output);
156         void (*assign_planes)(struct weston_output *output);
157         int (*switch_mode)(struct weston_output *output, struct weston_mode *mode);
158
159         /* backlight values are on 0-255 range, where higher is brighter */
160         uint32_t backlight_current;
161         void (*set_backlight)(struct weston_output *output, uint32_t value);
162         void (*set_dpms)(struct weston_output *output, enum dpms_enum level);
163 };
164
165 struct weston_xkb_info {
166         struct xkb_keymap *keymap;
167         xkb_mod_index_t ctrl_mod;
168         xkb_mod_index_t alt_mod;
169         xkb_mod_index_t super_mod;
170         xkb_led_index_t num_led;
171         xkb_led_index_t caps_led;
172         xkb_led_index_t scroll_led;
173 };
174
175 struct weston_seat {
176         struct wl_seat seat;
177         struct wl_pointer pointer;
178         int has_pointer;
179         struct wl_keyboard keyboard;
180         int has_keyboard;
181         struct wl_touch touch;
182         int has_touch;
183
184         struct weston_compositor *compositor;
185         struct weston_surface *sprite;
186         struct weston_surface *drag_surface;
187         struct wl_listener drag_surface_destroy_listener;
188         int32_t hotspot_x, hotspot_y;
189         struct wl_list link;
190         enum weston_keyboard_modifier modifier_state;
191         int hw_cursor;
192         struct wl_surface *saved_kbd_focus;
193         struct wl_listener saved_kbd_focus_listener;
194
195         uint32_t num_tp;
196         struct wl_surface *touch_focus;
197         struct wl_listener touch_focus_listener;
198         struct wl_resource *touch_focus_resource;
199         struct wl_listener touch_focus_resource_listener;
200
201         struct wl_listener new_drag_icon_listener;
202
203         void (*led_update)(struct weston_seat *ws, enum weston_led leds);
204
205         struct weston_xkb_info xkb_info;
206         struct {
207                 struct xkb_state *state;
208                 uint32_t mods_depressed;
209                 uint32_t mods_latched;
210                 uint32_t mods_locked;
211                 uint32_t group;
212                 enum weston_led leds;
213         } xkb_state;
214 };
215
216 struct weston_shader {
217         GLuint program;
218         GLuint vertex_shader, fragment_shader;
219         GLint proj_uniform;
220         GLint tex_uniform;
221         GLint alpha_uniform;
222         GLint brightness_uniform;
223         GLint saturation_uniform;
224         GLint color_uniform;
225         GLint texwidth_uniform;
226         GLint opaque_uniform;
227 };
228
229 struct weston_animation {
230         void (*frame)(struct weston_animation *animation,
231                       struct weston_output *output, uint32_t msecs);
232         struct wl_list link;
233 };
234
235 struct weston_spring {
236         double k;
237         double friction;
238         double current;
239         double target;
240         double previous;
241         uint32_t timestamp;
242 };
243
244 enum {
245         WESTON_COMPOSITOR_ACTIVE,
246         WESTON_COMPOSITOR_IDLE,         /* shell->unlock called on activity */
247         WESTON_COMPOSITOR_SLEEPING      /* no rendering, no frame events */
248 };
249
250 struct weston_layer {
251         struct wl_list surface_list;
252         struct wl_list link;
253 };
254
255 struct weston_compositor {
256         struct wl_shm *shm;
257         struct wl_signal destroy_signal;
258
259         EGLDisplay display;
260         EGLContext context;
261         EGLConfig config;
262         GLuint fbo;
263         struct weston_shader texture_shader;
264         struct weston_shader solid_shader;
265         struct weston_shader *current_shader;
266         struct wl_display *wl_display;
267         struct weston_shell_interface shell_interface;
268
269         struct wl_signal activate_signal;
270         struct wl_signal lock_signal;
271         struct wl_signal unlock_signal;
272
273         struct wl_event_loop *input_loop;
274         struct wl_event_source *input_loop_source;
275
276         /* There can be more than one, but not right now... */
277         struct weston_seat *seat;
278
279         struct weston_layer fade_layer;
280         struct weston_layer cursor_layer;
281
282         struct wl_list output_list;
283         struct wl_list seat_list;
284         struct wl_list layer_list;
285         struct wl_list surface_list;
286         struct wl_list key_binding_list;
287         struct wl_list button_binding_list;
288         struct wl_list axis_binding_list;
289         struct wl_list animation_list;
290         struct {
291                 struct weston_spring spring;
292                 struct weston_animation animation;
293                 struct weston_surface *surface;
294         } fade;
295
296         uint32_t state;
297         struct wl_event_source *idle_source;
298         uint32_t idle_inhibit;
299         int option_idle_time;           /* default timeout, s */
300         int idle_time;                  /* effective timeout, s */
301
302         /* Repaint state. */
303         struct wl_array vertices, indices;
304         pixman_region32_t damage;
305
306         uint32_t focus;
307
308         PFNGLEGLIMAGETARGETRENDERBUFFERSTORAGEOESPROC
309                 image_target_renderbuffer_storage;
310         PFNGLEGLIMAGETARGETTEXTURE2DOESPROC image_target_texture_2d;
311         PFNEGLCREATEIMAGEKHRPROC create_image;
312         PFNEGLDESTROYIMAGEKHRPROC destroy_image;
313
314         int has_unpack_subimage;
315         GLenum read_format;
316
317         PFNEGLBINDWAYLANDDISPLAYWL bind_display;
318         PFNEGLUNBINDWAYLANDDISPLAYWL unbind_display;
319         int has_bind_display;
320
321         void (*destroy)(struct weston_compositor *ec);
322         int (*authenticate)(struct weston_compositor *c, uint32_t id);
323
324         void (*ping_handler)(struct weston_surface *surface, uint32_t serial);
325
326         int launcher_sock;
327
328         uint32_t output_id_pool;
329
330         struct xkb_rule_names xkb_names;
331         struct xkb_context *xkb_context;
332         struct weston_xkb_info xkb_info;
333 };
334
335 enum weston_output_flags {
336         WL_OUTPUT_FLIPPED = 0x01
337 };
338
339 struct weston_region {
340         struct wl_resource resource;
341         pixman_region32_t region;
342 };
343
344 /* Using weston_surface transformations
345  *
346  * To add a transformation to a surface, create a struct weston_transform, and
347  * add it to the list surface->geometry.transformation_list. Whenever you
348  * change the list, anything under surface->geometry, or anything in the
349  * weston_transforms linked into the list, you must set
350  * surface->geometry.dirty = 1.
351  *
352  * The order in the list defines the order of transformations. Let the list
353  * contain the transformation matrices M1, ..., Mn as head to tail. The
354  * transformation is applied to surface-local coordinate vector p as
355  *    P = Mn * ... * M2 * M1 * p
356  * to produce the global coordinate vector P. The total transform
357  *    Mn * ... * M2 * M1
358  * is cached in surface->transform.matrix, and the inverse of it in
359  * surface->transform.inverse.
360  *
361  * The list always contains surface->transform.position transformation, which
362  * is the translation by surface->geometry.x and y.
363  *
364  * If you want to apply a transformation in local coordinates, add your
365  * weston_transform to the head of the list. If you want to apply a
366  * transformation in global coordinates, add it to the tail of the list.
367  */
368
369 struct weston_surface {
370         struct wl_surface surface;
371         struct weston_compositor *compositor;
372         GLuint texture;
373         pixman_region32_t clip;
374         pixman_region32_t damage;
375         pixman_region32_t opaque;
376         pixman_region32_t input;
377         int32_t pitch;
378         struct wl_list link;
379         struct wl_list layer_link;
380         struct weston_shader *shader;
381         GLfloat color[4];
382         GLfloat opaque_rect[4];
383         GLfloat alpha;
384         GLfloat brightness;
385         GLfloat saturation;
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(struct weston_surface *surface,
453                          int32_t sx, int32_t sy, int32_t *x, int32_t *y);
454 void
455 weston_surface_to_global_fixed(struct weston_surface *surface,
456                                wl_fixed_t sx, wl_fixed_t sy,
457                                wl_fixed_t *x, wl_fixed_t *y);
458 void
459 weston_surface_to_global_float(struct weston_surface *surface,
460                                GLfloat sx, GLfloat sy, GLfloat *x, GLfloat *y);
461
462 void
463 weston_surface_from_global(struct weston_surface *surface,
464                            int32_t x, int32_t y, int32_t *sx, int32_t *sy);
465 void
466 weston_surface_from_global_fixed(struct weston_surface *surface,
467                                  wl_fixed_t x, wl_fixed_t y,
468                                  wl_fixed_t *sx, wl_fixed_t *sy);
469
470 void
471 weston_spring_init(struct weston_spring *spring,
472                    double k, double current, double target);
473 void
474 weston_spring_update(struct weston_spring *spring, uint32_t msec);
475 int
476 weston_spring_done(struct weston_spring *spring);
477
478 void
479 weston_surface_activate(struct weston_surface *surface,
480                         struct weston_seat *seat);
481 void
482 weston_surface_draw(struct weston_surface *es,
483                     struct weston_output *output, pixman_region32_t *damage);
484
485 void
486 notify_motion(struct wl_seat *seat, uint32_t time,
487               wl_fixed_t x, wl_fixed_t y);
488 void
489 notify_button(struct wl_seat *seat, uint32_t time, int32_t button,
490               enum wl_pointer_button_state state);
491 void
492 notify_axis(struct wl_seat *seat, uint32_t time, uint32_t axis,
493             wl_fixed_t value);
494 void
495 notify_key(struct wl_seat *seat, uint32_t time, uint32_t key,
496            enum wl_keyboard_key_state state);
497
498 void
499 notify_pointer_focus(struct wl_seat *seat, struct weston_output *output,
500                      wl_fixed_t x, wl_fixed_t y);
501
502 void
503 notify_keyboard_focus(struct wl_seat *seat, struct wl_array *keys);
504
505 void
506 notify_touch(struct wl_seat *seat, uint32_t time, int touch_id,
507              wl_fixed_t x, wl_fixed_t y, int touch_type);
508
509 void
510 weston_layer_init(struct weston_layer *layer, struct wl_list *below);
511
512 void
513 weston_output_finish_frame(struct weston_output *output, int msecs);
514 void
515 weston_output_damage(struct weston_output *output);
516 void
517 weston_output_do_read_pixels(struct weston_output *output);
518 void
519 weston_compositor_repick(struct weston_compositor *compositor);
520 void
521 weston_compositor_schedule_repaint(struct weston_compositor *compositor);
522 void
523 weston_compositor_fade(struct weston_compositor *compositor, float tint);
524 void
525 weston_compositor_damage_all(struct weston_compositor *compositor);
526 void
527 weston_compositor_unlock(struct weston_compositor *compositor);
528 void
529 weston_compositor_wake(struct weston_compositor *compositor);
530 void
531 weston_compositor_activity(struct weston_compositor *compositor);
532 void
533 weston_compositor_update_drag_surfaces(struct weston_compositor *compositor);
534
535
536 struct weston_binding;
537 typedef void (*weston_key_binding_handler_t)(struct wl_seat *seat,
538                                              uint32_t time, uint32_t key,
539                                              void *data);
540 struct weston_binding *
541 weston_compositor_add_key_binding(struct weston_compositor *compositor,
542                                   uint32_t key,
543                                   enum weston_keyboard_modifier modifier,
544                                   weston_key_binding_handler_t binding,
545                                   void *data);
546
547 typedef void (*weston_button_binding_handler_t)(struct wl_seat *seat,
548                                                 uint32_t time, uint32_t button,
549                                                 void *data);
550 struct weston_binding *
551 weston_compositor_add_button_binding(struct weston_compositor *compositor,
552                                      uint32_t button,
553                                      enum weston_keyboard_modifier modifier,
554                                      weston_button_binding_handler_t binding,
555                                      void *data);
556
557 typedef void (*weston_axis_binding_handler_t)(struct wl_seat *seat,
558                                               uint32_t time, uint32_t axis,
559                                               wl_fixed_t value, void *data);
560 struct weston_binding *
561 weston_compositor_add_axis_binding(struct weston_compositor *compositor,
562                                    uint32_t axis,
563                                    enum weston_keyboard_modifier modifier,
564                                    weston_axis_binding_handler_t binding,
565                                    void *data);
566 void
567 weston_binding_destroy(struct weston_binding *binding);
568
569 void
570 weston_binding_list_destroy_all(struct wl_list *list);
571
572 void
573 weston_compositor_run_key_binding(struct weston_compositor *compositor,
574                                   struct weston_seat *seat, uint32_t time,
575                                   uint32_t key,
576                                   enum wl_keyboard_key_state state);
577 void
578 weston_compositor_run_button_binding(struct weston_compositor *compositor,
579                                      struct weston_seat *seat, uint32_t time,
580                                      uint32_t button,
581                                      enum wl_pointer_button_state value);
582 void
583 weston_compositor_run_axis_binding(struct weston_compositor *compositor,
584                                    struct weston_seat *seat, uint32_t time,
585                                    uint32_t axis, int32_t value);
586
587 int
588 weston_environment_get_fd(const char *env);
589
590 struct wl_list *
591 weston_compositor_top(struct weston_compositor *compositor);
592
593 struct weston_surface *
594 weston_surface_create(struct weston_compositor *compositor);
595
596 void
597 weston_surface_configure(struct weston_surface *surface,
598                          GLfloat x, GLfloat y, int width, int height);
599
600 void
601 weston_surface_restack(struct weston_surface *surface, struct wl_list *below);
602
603 void
604 weston_surface_set_position(struct weston_surface *surface,
605                             GLfloat x, GLfloat y);
606
607 int
608 weston_surface_is_mapped(struct weston_surface *surface);
609
610 void
611 weston_surface_assign_output(struct weston_surface *surface);
612
613 void
614 weston_surface_damage(struct weston_surface *surface);
615
616 void
617 weston_surface_damage_below(struct weston_surface *surface);
618
619 void
620 weston_buffer_post_release(struct wl_buffer *buffer);
621
622 uint32_t
623 weston_compositor_get_time(void);
624
625 int
626 weston_compositor_init(struct weston_compositor *ec, struct wl_display *display);
627 void
628 weston_compositor_shutdown(struct weston_compositor *ec);
629 void
630 weston_output_update_zoom(struct weston_output *output,
631                                                 int x, int y, uint32_t type);
632 void
633 weston_text_cursor_position_notify(struct weston_surface *surface, int x, int y);
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);
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 void
677 text_cursor_position_notifier_create(struct weston_compositor *ec);
678
679 struct weston_process;
680 typedef void (*weston_process_cleanup_func_t)(struct weston_process *process,
681                                             int status);
682
683 struct weston_process {
684         pid_t pid;
685         weston_process_cleanup_func_t cleanup;
686         struct wl_list link;
687 };
688
689 struct wl_client *
690 weston_client_launch(struct weston_compositor *compositor,
691                      struct weston_process *proc,
692                      const char *path,
693                      weston_process_cleanup_func_t cleanup);
694
695 void
696 weston_watch_process(struct weston_process *process);
697
698 int
699 weston_xserver_init(struct weston_compositor *compositor);
700
701 struct weston_zoom;
702 typedef void (*weston_zoom_done_func_t)(struct weston_zoom *zoom, void *data);
703
704 struct weston_zoom *
705 weston_zoom_run(struct weston_surface *surface, GLfloat start, GLfloat stop,
706                 weston_zoom_done_func_t done, void *data);
707
708 struct weston_fade;
709 typedef void (*weston_fade_done_func_t)(struct weston_fade *fade, void *data);
710
711 struct weston_fade *
712 weston_fade_run(struct weston_surface *surface,
713                 weston_fade_done_func_t done, void *data);
714
715
716 void
717 weston_surface_set_color(struct weston_surface *surface,
718                          GLfloat red, GLfloat green, GLfloat blue, GLfloat alpha);
719
720 void
721 weston_surface_destroy(struct weston_surface *surface);
722
723 struct weston_compositor *
724 backend_init(struct wl_display *display, int argc, char *argv[]);
725
726 int
727 weston_output_switch_mode(struct weston_output *output, struct weston_mode *mode);
728
729 #endif