]> git.proxmox.com Git - qemu.git/blame - include/ui/console.h
monitor: move include files to include/monitor/
[qemu.git] / include / ui / console.h
CommitLineData
87ecb68b
PB
1#ifndef CONSOLE_H
2#define CONSOLE_H
3
28ecbaee 4#include "ui/qemu-pixman.h"
7b1b5d19 5#include "qapi/qmp/qdict.h"
7e581fb3 6#include "notify.h"
83c9089e 7#include "monitor/monitor.h"
cdbc19dd 8#include "trace.h"
1048c88f 9#include "qapi-types.h"
7b1b5d19 10#include "qapi/error.h"
87ecb68b
PB
11
12/* keyboard/mouse support */
13
14#define MOUSE_EVENT_LBUTTON 0x01
15#define MOUSE_EVENT_RBUTTON 0x02
16#define MOUSE_EVENT_MBUTTON 0x04
17
03a23a85
GH
18/* identical to the ps/2 keyboard bits */
19#define QEMU_SCROLL_LOCK_LED (1 << 0)
20#define QEMU_NUM_LOCK_LED (1 << 1)
21#define QEMU_CAPS_LOCK_LED (1 << 2)
22
7ed9eba3
AL
23/* in ms */
24#define GUI_REFRESH_INTERVAL 30
25
87ecb68b 26typedef void QEMUPutKBDEvent(void *opaque, int keycode);
03a23a85 27typedef void QEMUPutLEDEvent(void *opaque, int ledstate);
87ecb68b
PB
28typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state);
29
30typedef struct QEMUPutMouseEntry {
31 QEMUPutMouseEvent *qemu_put_mouse_event;
32 void *qemu_put_mouse_event_opaque;
33 int qemu_put_mouse_event_absolute;
34 char *qemu_put_mouse_event_name;
35
6fef28ee
AL
36 int index;
37
87ecb68b 38 /* used internally by qemu for handling mice */
6fef28ee 39 QTAILQ_ENTRY(QEMUPutMouseEntry) node;
87ecb68b
PB
40} QEMUPutMouseEntry;
41
03a23a85
GH
42typedef struct QEMUPutLEDEntry {
43 QEMUPutLEDEvent *put_led;
44 void *opaque;
45 QTAILQ_ENTRY(QEMUPutLEDEntry) next;
46} QEMUPutLEDEntry;
47
87ecb68b 48void qemu_add_kbd_event_handler(QEMUPutKBDEvent *func, void *opaque);
46aaebff 49void qemu_remove_kbd_event_handler(void);
87ecb68b
PB
50QEMUPutMouseEntry *qemu_add_mouse_event_handler(QEMUPutMouseEvent *func,
51 void *opaque, int absolute,
52 const char *name);
53void qemu_remove_mouse_event_handler(QEMUPutMouseEntry *entry);
6fef28ee
AL
54void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry);
55
03a23a85
GH
56QEMUPutLEDEntry *qemu_add_led_event_handler(QEMUPutLEDEvent *func, void *opaque);
57void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry);
87ecb68b
PB
58
59void kbd_put_keycode(int keycode);
03a23a85 60void kbd_put_ledstate(int ledstate);
87ecb68b 61void kbd_mouse_event(int dx, int dy, int dz, int buttons_state);
eb2e259d
AL
62
63/* Does the current mouse generate absolute events */
87ecb68b 64int kbd_mouse_is_absolute(void);
7e581fb3
AL
65void qemu_add_mouse_mode_change_notifier(Notifier *notify);
66void qemu_remove_mouse_mode_change_notifier(Notifier *notify);
87ecb68b 67
eb2e259d
AL
68/* Of all the mice, is there one that generates absolute events */
69int kbd_mouse_has_absolute(void);
70
bc24a225 71struct MouseTransformInfo {
a5d7eb65
AZ
72 /* Touchscreen resolution */
73 int x;
74 int y;
75 /* Calibration values as used/generated by tslib */
76 int a[7];
77};
78
d54908a5 79void do_mouse_set(Monitor *mon, const QDict *qdict);
87ecb68b
PB
80
81/* keysym is a unicode code except for special keys (see QEMU_KEY_xxx
82 constants) */
83#define QEMU_KEY_ESC1(c) ((c) | 0xe100)
84#define QEMU_KEY_BACKSPACE 0x007f
85#define QEMU_KEY_UP QEMU_KEY_ESC1('A')
86#define QEMU_KEY_DOWN QEMU_KEY_ESC1('B')
87#define QEMU_KEY_RIGHT QEMU_KEY_ESC1('C')
88#define QEMU_KEY_LEFT QEMU_KEY_ESC1('D')
89#define QEMU_KEY_HOME QEMU_KEY_ESC1(1)
90#define QEMU_KEY_END QEMU_KEY_ESC1(4)
91#define QEMU_KEY_PAGEUP QEMU_KEY_ESC1(5)
92#define QEMU_KEY_PAGEDOWN QEMU_KEY_ESC1(6)
93#define QEMU_KEY_DELETE QEMU_KEY_ESC1(3)
94
95#define QEMU_KEY_CTRL_UP 0xe400
96#define QEMU_KEY_CTRL_DOWN 0xe401
97#define QEMU_KEY_CTRL_LEFT 0xe402
98#define QEMU_KEY_CTRL_RIGHT 0xe403
99#define QEMU_KEY_CTRL_HOME 0xe404
100#define QEMU_KEY_CTRL_END 0xe405
101#define QEMU_KEY_CTRL_PAGEUP 0xe406
102#define QEMU_KEY_CTRL_PAGEDOWN 0xe407
103
104void kbd_put_keysym(int keysym);
105
106/* consoles */
107
7d957bd8
AL
108#define QEMU_BIG_ENDIAN_FLAG 0x01
109#define QEMU_ALLOCATED_FLAG 0x02
110
111struct PixelFormat {
112 uint8_t bits_per_pixel;
113 uint8_t bytes_per_pixel;
114 uint8_t depth; /* color depth in bits */
115 uint32_t rmask, gmask, bmask, amask;
116 uint8_t rshift, gshift, bshift, ashift;
117 uint8_t rmax, gmax, bmax, amax;
90a1e3c0 118 uint8_t rbits, gbits, bbits, abits;
7d957bd8
AL
119};
120
121struct DisplaySurface {
69c77777
GH
122 pixman_format_code_t format;
123 pixman_image_t *image;
7d957bd8 124 uint8_t flags;
7d957bd8
AL
125
126 struct PixelFormat pf;
127};
128
254e5950
GH
129/* cursor data format is 32bit RGBA */
130typedef struct QEMUCursor {
131 int width, height;
132 int hot_x, hot_y;
133 int refcount;
134 uint32_t data[];
135} QEMUCursor;
136
137QEMUCursor *cursor_alloc(int width, int height);
138void cursor_get(QEMUCursor *c);
139void cursor_put(QEMUCursor *c);
140QEMUCursor *cursor_builtin_hidden(void);
141QEMUCursor *cursor_builtin_left_ptr(void);
142void cursor_print_ascii_art(QEMUCursor *c, const char *prefix);
143int cursor_get_mono_bpl(QEMUCursor *c);
144void cursor_set_mono(QEMUCursor *c,
145 uint32_t foreground, uint32_t background, uint8_t *image,
146 int transparent, uint8_t *mask);
147void cursor_get_mono_image(QEMUCursor *c, int foreground, uint8_t *mask);
148void cursor_get_mono_mask(QEMUCursor *c, int transparent, uint8_t *mask);
149
7d957bd8
AL
150struct DisplayChangeListener {
151 int idle;
f442e08b 152 uint64_t gui_timer_interval;
87ecb68b 153
87ecb68b 154 void (*dpy_refresh)(struct DisplayState *s);
a93a4a22
GH
155
156 void (*dpy_gfx_update)(struct DisplayState *s, int x, int y, int w, int h);
157 void (*dpy_gfx_resize)(struct DisplayState *s);
158 void (*dpy_gfx_setdata)(struct DisplayState *s);
159 void (*dpy_gfx_copy)(struct DisplayState *s, int src_x, int src_y,
160 int dst_x, int dst_y, int w, int h);
a93a4a22 161
4d3b6f6e 162 void (*dpy_text_cursor)(struct DisplayState *s, int x, int y);
a93a4a22
GH
163 void (*dpy_text_resize)(struct DisplayState *s, int w, int h);
164 void (*dpy_text_update)(struct DisplayState *s, int x, int y, int w, int h);
7d957bd8 165
bf2fde70
GH
166 void (*dpy_mouse_set)(struct DisplayState *s, int x, int y, int on);
167 void (*dpy_cursor_define)(struct DisplayState *s, QEMUCursor *cursor);
168
87e487a1 169 QLIST_ENTRY(DisplayChangeListener) next;
7d957bd8
AL
170};
171
172struct DisplayState {
173 struct DisplaySurface *surface;
174 void *opaque;
175 struct QEMUTimer *gui_timer;
a93a4a22
GH
176 bool have_gfx;
177 bool have_text;
7d957bd8 178
87e487a1 179 QLIST_HEAD(, DisplayChangeListener) listeners;
7d957bd8 180
3023f332 181 struct DisplayState *next;
87ecb68b
PB
182};
183
3023f332
AL
184void register_displaystate(DisplayState *ds);
185DisplayState *get_displaystate(void);
7d957bd8
AL
186DisplaySurface* qemu_create_displaysurface_from(int width, int height, int bpp,
187 int linesize, uint8_t *data);
0da2ea1b 188PixelFormat qemu_different_endianness_pixelformat(int bpp);
189PixelFormat qemu_default_pixelformat(int bpp);
7d957bd8 190
187cd1d9
GH
191DisplaySurface *qemu_create_displaysurface(DisplayState *ds,
192 int width, int height);
193DisplaySurface *qemu_resize_displaysurface(DisplayState *ds,
194 int width, int height);
195void qemu_free_displaysurface(DisplayState *ds);
7b5d76da
AL
196
197static inline int is_surface_bgr(DisplaySurface *surface)
198{
199 if (surface->pf.bits_per_pixel == 32 && surface->pf.rshift == 0)
200 return 1;
201 else
202 return 0;
203}
204
7d957bd8
AL
205static inline int is_buffer_shared(DisplaySurface *surface)
206{
187cd1d9 207 return !(surface->flags & QEMU_ALLOCATED_FLAG);
7d957bd8
AL
208}
209
35c9e0a5
GH
210void gui_setup_refresh(DisplayState *ds);
211
7d957bd8
AL
212static inline void register_displaychangelistener(DisplayState *ds, DisplayChangeListener *dcl)
213{
87e487a1 214 QLIST_INSERT_HEAD(&ds->listeners, dcl, next);
35c9e0a5 215 gui_setup_refresh(ds);
e250d949
GH
216 if (dcl->dpy_gfx_resize) {
217 dcl->dpy_gfx_resize(ds);
218 }
35c9e0a5
GH
219}
220
221static inline void unregister_displaychangelistener(DisplayState *ds,
222 DisplayChangeListener *dcl)
223{
224 QLIST_REMOVE(dcl, next);
225 gui_setup_refresh(ds);
7d957bd8
AL
226}
227
a93a4a22 228static inline void dpy_gfx_update(DisplayState *s, int x, int y, int w, int h)
87ecb68b 229{
87e487a1 230 struct DisplayChangeListener *dcl;
4b4496db
GH
231 int width = pixman_image_get_width(s->surface->image);
232 int height = pixman_image_get_height(s->surface->image);
233
234 x = MAX(x, 0);
235 y = MAX(y, 0);
236 x = MIN(x, width);
237 y = MIN(y, height);
238 w = MIN(w, width - x);
239 h = MIN(h, height - y);
240
87e487a1 241 QLIST_FOREACH(dcl, &s->listeners, next) {
a93a4a22
GH
242 if (dcl->dpy_gfx_update) {
243 dcl->dpy_gfx_update(s, x, y, w, h);
244 }
7d957bd8 245 }
87ecb68b
PB
246}
247
a93a4a22 248static inline void dpy_gfx_resize(DisplayState *s)
87ecb68b 249{
87e487a1
GH
250 struct DisplayChangeListener *dcl;
251 QLIST_FOREACH(dcl, &s->listeners, next) {
a93a4a22
GH
252 if (dcl->dpy_gfx_resize) {
253 dcl->dpy_gfx_resize(s);
254 }
7d957bd8 255 }
87ecb68b
PB
256}
257
a93a4a22 258static inline void dpy_gfx_setdata(DisplayState *s)
4d3b6f6e 259{
87e487a1
GH
260 struct DisplayChangeListener *dcl;
261 QLIST_FOREACH(dcl, &s->listeners, next) {
a93a4a22
GH
262 if (dcl->dpy_gfx_setdata) {
263 dcl->dpy_gfx_setdata(s);
87e487a1 264 }
7d957bd8
AL
265 }
266}
267
268static inline void dpy_refresh(DisplayState *s)
269{
87e487a1
GH
270 struct DisplayChangeListener *dcl;
271 QLIST_FOREACH(dcl, &s->listeners, next) {
272 if (dcl->dpy_refresh) {
273 dcl->dpy_refresh(s);
274 }
7d957bd8
AL
275 }
276}
277
a93a4a22 278static inline void dpy_gfx_copy(struct DisplayState *s, int src_x, int src_y,
87e487a1
GH
279 int dst_x, int dst_y, int w, int h)
280{
281 struct DisplayChangeListener *dcl;
282 QLIST_FOREACH(dcl, &s->listeners, next) {
a93a4a22
GH
283 if (dcl->dpy_gfx_copy) {
284 dcl->dpy_gfx_copy(s, src_x, src_y, dst_x, dst_y, w, h);
87e487a1 285 } else { /* TODO */
a93a4a22 286 dcl->dpy_gfx_update(s, dst_x, dst_y, w, h);
87e487a1 287 }
7d957bd8
AL
288 }
289}
290
bf2fde70 291static inline void dpy_text_cursor(struct DisplayState *s, int x, int y)
87e487a1
GH
292{
293 struct DisplayChangeListener *dcl;
294 QLIST_FOREACH(dcl, &s->listeners, next) {
295 if (dcl->dpy_text_cursor) {
296 dcl->dpy_text_cursor(s, x, y);
297 }
7d957bd8 298 }
4d3b6f6e
AZ
299}
300
a93a4a22
GH
301static inline void dpy_text_update(DisplayState *s, int x, int y, int w, int h)
302{
303 struct DisplayChangeListener *dcl;
304 QLIST_FOREACH(dcl, &s->listeners, next) {
305 if (dcl->dpy_text_update) {
306 dcl->dpy_text_update(s, x, y, w, h);
307 }
308 }
309}
310
311static inline void dpy_text_resize(DisplayState *s, int w, int h)
312{
313 struct DisplayChangeListener *dcl;
314 QLIST_FOREACH(dcl, &s->listeners, next) {
315 if (dcl->dpy_text_resize) {
316 dcl->dpy_text_resize(s, w, h);
317 }
318 }
319}
320
bf2fde70
GH
321static inline void dpy_mouse_set(struct DisplayState *s, int x, int y, int on)
322{
323 struct DisplayChangeListener *dcl;
324 QLIST_FOREACH(dcl, &s->listeners, next) {
325 if (dcl->dpy_mouse_set) {
326 dcl->dpy_mouse_set(s, x, y, on);
327 }
328 }
329}
330
331static inline void dpy_cursor_define(struct DisplayState *s, QEMUCursor *cursor)
332{
333 struct DisplayChangeListener *dcl;
334 QLIST_FOREACH(dcl, &s->listeners, next) {
335 if (dcl->dpy_cursor_define) {
336 dcl->dpy_cursor_define(s, cursor);
337 }
338 }
339}
340
341static inline bool dpy_cursor_define_supported(struct DisplayState *s)
342{
343 struct DisplayChangeListener *dcl;
344 QLIST_FOREACH(dcl, &s->listeners, next) {
345 if (dcl->dpy_cursor_define) {
346 return true;
347 }
348 }
349 return false;
350}
351
0e1f5a0c
AL
352static inline int ds_get_linesize(DisplayState *ds)
353{
64f73592 354 return pixman_image_get_stride(ds->surface->image);
0e1f5a0c
AL
355}
356
357static inline uint8_t* ds_get_data(DisplayState *ds)
358{
64f73592 359 return (void *)pixman_image_get_data(ds->surface->image);
0e1f5a0c
AL
360}
361
362static inline int ds_get_width(DisplayState *ds)
363{
64f73592 364 return pixman_image_get_width(ds->surface->image);
0e1f5a0c
AL
365}
366
367static inline int ds_get_height(DisplayState *ds)
368{
64f73592 369 return pixman_image_get_height(ds->surface->image);
0e1f5a0c
AL
370}
371
372static inline int ds_get_bits_per_pixel(DisplayState *ds)
373{
64f73592
GH
374 int bits = PIXMAN_FORMAT_BPP(ds->surface->format);
375 return bits;
0e1f5a0c
AL
376}
377
8927bcfd
AL
378static inline int ds_get_bytes_per_pixel(DisplayState *ds)
379{
64f73592
GH
380 int bits = PIXMAN_FORMAT_BPP(ds->surface->format);
381 return (bits + 7) / 8;
382}
383
384static inline pixman_format_code_t ds_get_format(DisplayState *ds)
385{
386 return ds->surface->format;
8927bcfd
AL
387}
388
d9a86569
GH
389static inline pixman_image_t *ds_get_image(DisplayState *ds)
390{
391 return ds->surface->image;
392}
393
aa32b38c
BZ
394static inline int ds_get_depth(DisplayState *ds)
395{
396 return ds->surface->pf.depth;
397}
398
399static inline int ds_get_rmask(DisplayState *ds)
400{
401 return ds->surface->pf.rmask;
402}
403
404static inline int ds_get_gmask(DisplayState *ds)
405{
406 return ds->surface->pf.gmask;
407}
408
409static inline int ds_get_bmask(DisplayState *ds)
410{
411 return ds->surface->pf.bmask;
412}
413
df00bed0
DP
414#ifdef CONFIG_CURSES
415#include <curses.h>
416typedef chtype console_ch_t;
417#else
c227f099 418typedef unsigned long console_ch_t;
df00bed0 419#endif
c227f099 420static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
4d3b6f6e 421{
f6d20d0f
BK
422 if (!(ch & 0xff))
423 ch |= ' ';
9ae19b65 424 *dest = ch;
4d3b6f6e
AZ
425}
426
87ecb68b
PB
427typedef void (*vga_hw_update_ptr)(void *);
428typedef void (*vga_hw_invalidate_ptr)(void *);
d7098135
LC
429typedef void (*vga_hw_screen_dump_ptr)(void *, const char *, bool cswitch,
430 Error **errp);
c227f099 431typedef void (*vga_hw_text_update_ptr)(void *, console_ch_t *);
87ecb68b 432
3023f332
AL
433DisplayState *graphic_console_init(vga_hw_update_ptr update,
434 vga_hw_invalidate_ptr invalidate,
435 vga_hw_screen_dump_ptr screen_dump,
436 vga_hw_text_update_ptr text_update,
437 void *opaque);
438
87ecb68b
PB
439void vga_hw_update(void);
440void vga_hw_invalidate(void);
c227f099 441void vga_hw_text_update(console_ch_t *chardata);
87ecb68b
PB
442
443int is_graphic_console(void);
c21bbcfa 444int is_fixedsize_console(void);
1f51470d 445CharDriverState *text_console_init(QemuOpts *opts);
2796dae0 446void text_consoles_set_display(DisplayState *ds);
87ecb68b
PB
447void console_select(unsigned int index);
448void console_color_init(DisplayState *ds);
3023f332
AL
449void qemu_console_resize(DisplayState *ds, int width, int height);
450void qemu_console_copy(DisplayState *ds, int src_x, int src_y,
451 int dst_x, int dst_y, int w, int h);
87ecb68b
PB
452
453/* sdl.c */
454void sdl_display_init(DisplayState *ds, int full_screen, int no_frame);
455
456/* cocoa.m */
457void cocoa_display_init(DisplayState *ds, int full_screen);
458
459/* vnc.c */
460void vnc_display_init(DisplayState *ds);
007fcd3e 461void vnc_display_open(DisplayState *ds, const char *display, Error **errp);
13661089 462void vnc_display_add_client(DisplayState *ds, int csock, int skipauth);
821601ea
JS
463char *vnc_display_local_addr(DisplayState *ds);
464#ifdef CONFIG_VNC
465int vnc_display_password(DisplayState *ds, const char *password);
3c9405a0 466int vnc_display_pw_expire(DisplayState *ds, time_t expires);
821601ea
JS
467#else
468static inline int vnc_display_password(DisplayState *ds, const char *password)
469{
821601ea
JS
470 return -ENODEV;
471}
472static inline int vnc_display_pw_expire(DisplayState *ds, time_t expires)
473{
821601ea
JS
474 return -ENODEV;
475};
821601ea 476#endif
87ecb68b 477
4d3b6f6e
AZ
478/* curses.c */
479void curses_display_init(DisplayState *ds, int full_screen);
480
1048c88f 481/* input.c */
1048c88f
AK
482int index_from_key(const char *key);
483int index_from_keycode(int code);
484
87ecb68b 485#endif