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