]> git.proxmox.com Git - mirror_qemu.git/blame - include/ui/console.h
include: add missing config-host.h include
[mirror_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"
95be0669 5#include "qom/object.h"
7b1b5d19 6#include "qapi/qmp/qdict.h"
1de7afc9 7#include "qemu/notify.h"
83c9089e 8#include "monitor/monitor.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 23/* in ms */
0f7b2864
GH
24#define GUI_REFRESH_INTERVAL_DEFAULT 30
25#define GUI_REFRESH_INTERVAL_IDLE 3000
7ed9eba3 26
87ecb68b 27typedef void QEMUPutKBDEvent(void *opaque, int keycode);
03a23a85 28typedef void QEMUPutLEDEvent(void *opaque, int ledstate);
87ecb68b
PB
29typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state);
30
72711efb 31typedef struct QEMUPutMouseEntry QEMUPutMouseEntry;
5a37532d 32typedef struct QEMUPutKbdEntry QEMUPutKbdEntry;
72711efb 33typedef struct QEMUPutLEDEntry QEMUPutLEDEntry;
03a23a85 34
5a37532d
GH
35QEMUPutKbdEntry *qemu_add_kbd_event_handler(QEMUPutKBDEvent *func,
36 void *opaque);
37void qemu_remove_kbd_event_handler(QEMUPutKbdEntry *entry);
87ecb68b
PB
38QEMUPutMouseEntry *qemu_add_mouse_event_handler(QEMUPutMouseEvent *func,
39 void *opaque, int absolute,
40 const char *name);
41void qemu_remove_mouse_event_handler(QEMUPutMouseEntry *entry);
6fef28ee
AL
42void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry);
43
03a23a85
GH
44QEMUPutLEDEntry *qemu_add_led_event_handler(QEMUPutLEDEvent *func, void *opaque);
45void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry);
87ecb68b
PB
46
47void kbd_put_keycode(int keycode);
03a23a85 48void kbd_put_ledstate(int ledstate);
87ecb68b 49void kbd_mouse_event(int dx, int dy, int dz, int buttons_state);
eb2e259d
AL
50
51/* Does the current mouse generate absolute events */
87ecb68b 52int kbd_mouse_is_absolute(void);
7e581fb3
AL
53void qemu_add_mouse_mode_change_notifier(Notifier *notify);
54void qemu_remove_mouse_mode_change_notifier(Notifier *notify);
87ecb68b 55
eb2e259d
AL
56/* Of all the mice, is there one that generates absolute events */
57int kbd_mouse_has_absolute(void);
58
bc24a225 59struct MouseTransformInfo {
a5d7eb65
AZ
60 /* Touchscreen resolution */
61 int x;
62 int y;
63 /* Calibration values as used/generated by tslib */
64 int a[7];
65};
66
d54908a5 67void do_mouse_set(Monitor *mon, const QDict *qdict);
87ecb68b
PB
68
69/* keysym is a unicode code except for special keys (see QEMU_KEY_xxx
70 constants) */
71#define QEMU_KEY_ESC1(c) ((c) | 0xe100)
72#define QEMU_KEY_BACKSPACE 0x007f
73#define QEMU_KEY_UP QEMU_KEY_ESC1('A')
74#define QEMU_KEY_DOWN QEMU_KEY_ESC1('B')
75#define QEMU_KEY_RIGHT QEMU_KEY_ESC1('C')
76#define QEMU_KEY_LEFT QEMU_KEY_ESC1('D')
77#define QEMU_KEY_HOME QEMU_KEY_ESC1(1)
78#define QEMU_KEY_END QEMU_KEY_ESC1(4)
79#define QEMU_KEY_PAGEUP QEMU_KEY_ESC1(5)
80#define QEMU_KEY_PAGEDOWN QEMU_KEY_ESC1(6)
81#define QEMU_KEY_DELETE QEMU_KEY_ESC1(3)
82
83#define QEMU_KEY_CTRL_UP 0xe400
84#define QEMU_KEY_CTRL_DOWN 0xe401
85#define QEMU_KEY_CTRL_LEFT 0xe402
86#define QEMU_KEY_CTRL_RIGHT 0xe403
87#define QEMU_KEY_CTRL_HOME 0xe404
88#define QEMU_KEY_CTRL_END 0xe405
89#define QEMU_KEY_CTRL_PAGEUP 0xe406
90#define QEMU_KEY_CTRL_PAGEDOWN 0xe407
91
92void kbd_put_keysym(int keysym);
93
94/* consoles */
95
95be0669
GH
96#define TYPE_QEMU_CONSOLE "qemu-console"
97#define QEMU_CONSOLE(obj) \
98 OBJECT_CHECK(QemuConsole, (obj), TYPE_QEMU_CONSOLE)
99#define QEMU_CONSOLE_GET_CLASS(obj) \
100 OBJECT_GET_CLASS(QemuConsoleClass, (obj), TYPE_QEMU_CONSOLE)
101#define QEMU_CONSOLE_CLASS(klass) \
102 OBJECT_CLASS_CHECK(QemuConsoleClass, (klass), TYPE_QEMU_CONSOLE)
103
104typedef struct QemuConsoleClass QemuConsoleClass;
105
106struct QemuConsoleClass {
107 ObjectClass parent_class;
108};
109
7d957bd8
AL
110#define QEMU_BIG_ENDIAN_FLAG 0x01
111#define QEMU_ALLOCATED_FLAG 0x02
112
113struct PixelFormat {
114 uint8_t bits_per_pixel;
115 uint8_t bytes_per_pixel;
116 uint8_t depth; /* color depth in bits */
117 uint32_t rmask, gmask, bmask, amask;
118 uint8_t rshift, gshift, bshift, ashift;
119 uint8_t rmax, gmax, bmax, amax;
90a1e3c0 120 uint8_t rbits, gbits, bbits, abits;
7d957bd8
AL
121};
122
123struct DisplaySurface {
69c77777
GH
124 pixman_format_code_t format;
125 pixman_image_t *image;
7d957bd8 126 uint8_t flags;
7d957bd8
AL
127
128 struct PixelFormat pf;
129};
130
254e5950
GH
131/* cursor data format is 32bit RGBA */
132typedef struct QEMUCursor {
133 int width, height;
134 int hot_x, hot_y;
135 int refcount;
136 uint32_t data[];
137} QEMUCursor;
138
139QEMUCursor *cursor_alloc(int width, int height);
140void cursor_get(QEMUCursor *c);
141void cursor_put(QEMUCursor *c);
142QEMUCursor *cursor_builtin_hidden(void);
143QEMUCursor *cursor_builtin_left_ptr(void);
144void cursor_print_ascii_art(QEMUCursor *c, const char *prefix);
145int cursor_get_mono_bpl(QEMUCursor *c);
146void cursor_set_mono(QEMUCursor *c,
147 uint32_t foreground, uint32_t background, uint8_t *image,
148 int transparent, uint8_t *mask);
149void cursor_get_mono_image(QEMUCursor *c, int foreground, uint8_t *mask);
150void cursor_get_mono_mask(QEMUCursor *c, int transparent, uint8_t *mask);
151
7c20b4a3
GH
152typedef struct DisplayChangeListenerOps {
153 const char *dpy_name;
154
bc2ed970 155 void (*dpy_refresh)(DisplayChangeListener *dcl);
7c20b4a3
GH
156
157 void (*dpy_gfx_update)(DisplayChangeListener *dcl,
7c20b4a3 158 int x, int y, int w, int h);
c12aeb86 159 void (*dpy_gfx_switch)(DisplayChangeListener *dcl,
c12aeb86 160 struct DisplaySurface *new_surface);
7c20b4a3 161 void (*dpy_gfx_copy)(DisplayChangeListener *dcl,
bc2ed970 162 int src_x, int src_y,
a93a4a22 163 int dst_x, int dst_y, int w, int h);
a93a4a22 164
7c20b4a3 165 void (*dpy_text_cursor)(DisplayChangeListener *dcl,
7c20b4a3
GH
166 int x, int y);
167 void (*dpy_text_resize)(DisplayChangeListener *dcl,
7c20b4a3
GH
168 int w, int h);
169 void (*dpy_text_update)(DisplayChangeListener *dcl,
7c20b4a3
GH
170 int x, int y, int w, int h);
171
172 void (*dpy_mouse_set)(DisplayChangeListener *dcl,
7c20b4a3
GH
173 int x, int y, int on);
174 void (*dpy_cursor_define)(DisplayChangeListener *dcl,
7c20b4a3
GH
175 QEMUCursor *cursor);
176} DisplayChangeListenerOps;
7d957bd8 177
7c20b4a3 178struct DisplayChangeListener {
0f7b2864 179 uint64_t update_interval;
7c20b4a3
GH
180 const DisplayChangeListenerOps *ops;
181 DisplayState *ds;
284d1c6b 182 QemuConsole *con;
bf2fde70 183
87e487a1 184 QLIST_ENTRY(DisplayChangeListener) next;
7d957bd8
AL
185};
186
64840c66 187DisplayState *init_displaystate(void);
7d957bd8 188DisplaySurface* qemu_create_displaysurface_from(int width, int height, int bpp,
b1424e03
GH
189 int linesize, uint8_t *data,
190 bool byteswap);
0da2ea1b 191PixelFormat qemu_different_endianness_pixelformat(int bpp);
192PixelFormat qemu_default_pixelformat(int bpp);
7d957bd8 193
da229ef3
GH
194DisplaySurface *qemu_create_displaysurface(int width, int height);
195void qemu_free_displaysurface(DisplaySurface *surface);
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
5209089f 210void register_displaychangelistener(DisplayChangeListener *dcl);
0f7b2864
GH
211void update_displaychangelistener(DisplayChangeListener *dcl,
212 uint64_t interval);
7c20b4a3
GH
213void unregister_displaychangelistener(DisplayChangeListener *dcl);
214
c78f7137
GH
215void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h);
216void dpy_gfx_replace_surface(QemuConsole *con,
da229ef3 217 DisplaySurface *surface);
c78f7137 218void dpy_gfx_copy(QemuConsole *con, int src_x, int src_y,
7c20b4a3 219 int dst_x, int dst_y, int w, int h);
c78f7137
GH
220void dpy_text_cursor(QemuConsole *con, int x, int y);
221void dpy_text_update(QemuConsole *con, int x, int y, int w, int h);
222void dpy_text_resize(QemuConsole *con, int w, int h);
223void dpy_mouse_set(QemuConsole *con, int x, int y, int on);
224void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor);
225bool dpy_cursor_define_supported(QemuConsole *con);
bf2fde70 226
626e3b34
GH
227static inline int surface_stride(DisplaySurface *s)
228{
229 return pixman_image_get_stride(s->image);
230}
231
232static inline void *surface_data(DisplaySurface *s)
233{
234 return pixman_image_get_data(s->image);
235}
236
237static inline int surface_width(DisplaySurface *s)
238{
239 return pixman_image_get_width(s->image);
240}
241
242static inline int surface_height(DisplaySurface *s)
243{
244 return pixman_image_get_height(s->image);
245}
246
247static inline int surface_bits_per_pixel(DisplaySurface *s)
248{
249 int bits = PIXMAN_FORMAT_BPP(s->format);
250 return bits;
251}
252
253static inline int surface_bytes_per_pixel(DisplaySurface *s)
254{
255 int bits = PIXMAN_FORMAT_BPP(s->format);
256 return (bits + 7) / 8;
257}
258
df00bed0
DP
259#ifdef CONFIG_CURSES
260#include <curses.h>
261typedef chtype console_ch_t;
262#else
c227f099 263typedef unsigned long console_ch_t;
df00bed0 264#endif
c227f099 265static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
4d3b6f6e 266{
f6d20d0f
BK
267 if (!(ch & 0xff))
268 ch |= ' ';
9ae19b65 269 *dest = ch;
4d3b6f6e
AZ
270}
271
380cd056
GH
272typedef struct GraphicHwOps {
273 void (*invalidate)(void *opaque);
274 void (*gfx_update)(void *opaque);
275 void (*text_update)(void *opaque, console_ch_t *text);
dea1b0bd 276 void (*update_interval)(void *opaque, uint64_t interval);
380cd056 277} GraphicHwOps;
87ecb68b 278
aa2beaa1
GH
279QemuConsole *graphic_console_init(DeviceState *dev,
280 const GraphicHwOps *ops,
c78f7137 281 void *opaque);
3023f332 282
1dbfa005
GH
283void graphic_hw_update(QemuConsole *con);
284void graphic_hw_invalidate(QemuConsole *con);
285void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata);
87ecb68b 286
284d1c6b 287QemuConsole *qemu_console_lookup_by_index(unsigned int index);
14a93649 288QemuConsole *qemu_console_lookup_by_device(DeviceState *dev);
81c0d5a6
GH
289bool qemu_console_is_visible(QemuConsole *con);
290bool qemu_console_is_graphic(QemuConsole *con);
291bool qemu_console_is_fixedsize(QemuConsole *con);
292
2796dae0 293void text_consoles_set_display(DisplayState *ds);
87ecb68b
PB
294void console_select(unsigned int index);
295void console_color_init(DisplayState *ds);
c78f7137
GH
296void qemu_console_resize(QemuConsole *con, int width, int height);
297void qemu_console_copy(QemuConsole *con, int src_x, int src_y,
3023f332 298 int dst_x, int dst_y, int w, int h);
c78f7137
GH
299DisplaySurface *qemu_console_surface(QemuConsole *con);
300DisplayState *qemu_console_displaystate(QemuConsole *console);
87ecb68b 301
702ec69c 302typedef CharDriverState *(VcHandler)(ChardevVC *vc);
d82831db 303
702ec69c 304CharDriverState *vc_init(ChardevVC *vc);
d82831db
AL
305void register_vc_handler(VcHandler *handler);
306
87ecb68b
PB
307/* sdl.c */
308void sdl_display_init(DisplayState *ds, int full_screen, int no_frame);
309
310/* cocoa.m */
311void cocoa_display_init(DisplayState *ds, int full_screen);
312
313/* vnc.c */
314void vnc_display_init(DisplayState *ds);
007fcd3e 315void vnc_display_open(DisplayState *ds, const char *display, Error **errp);
2c8cf549 316void vnc_display_add_client(DisplayState *ds, int csock, bool skipauth);
821601ea
JS
317char *vnc_display_local_addr(DisplayState *ds);
318#ifdef CONFIG_VNC
319int vnc_display_password(DisplayState *ds, const char *password);
3c9405a0 320int vnc_display_pw_expire(DisplayState *ds, time_t expires);
821601ea
JS
321#else
322static inline int vnc_display_password(DisplayState *ds, const char *password)
323{
821601ea
JS
324 return -ENODEV;
325}
326static inline int vnc_display_pw_expire(DisplayState *ds, time_t expires)
327{
821601ea
JS
328 return -ENODEV;
329};
821601ea 330#endif
87ecb68b 331
4d3b6f6e
AZ
332/* curses.c */
333void curses_display_init(DisplayState *ds, int full_screen);
334
1048c88f 335/* input.c */
1048c88f
AK
336int index_from_key(const char *key);
337int index_from_keycode(int code);
338
a4ccabcf
AL
339/* gtk.c */
340void early_gtk_display_init(void);
787ba4f0 341void gtk_display_init(DisplayState *ds, bool full_screen);
a4ccabcf 342
87ecb68b 343#endif