]> git.proxmox.com Git - qemu.git/blame - include/ui/console.h
console: simplify screendump
[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"
1de7afc9 6#include "qemu/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
7c20b4a3
GH
150typedef struct DisplayChangeListenerOps {
151 const char *dpy_name;
152
bc2ed970 153 void (*dpy_refresh)(DisplayChangeListener *dcl);
7c20b4a3
GH
154
155 void (*dpy_gfx_update)(DisplayChangeListener *dcl,
7c20b4a3 156 int x, int y, int w, int h);
c12aeb86 157 void (*dpy_gfx_switch)(DisplayChangeListener *dcl,
c12aeb86 158 struct DisplaySurface *new_surface);
7c20b4a3 159 void (*dpy_gfx_copy)(DisplayChangeListener *dcl,
bc2ed970 160 int src_x, int src_y,
a93a4a22 161 int dst_x, int dst_y, int w, int h);
a93a4a22 162
7c20b4a3 163 void (*dpy_text_cursor)(DisplayChangeListener *dcl,
7c20b4a3
GH
164 int x, int y);
165 void (*dpy_text_resize)(DisplayChangeListener *dcl,
7c20b4a3
GH
166 int w, int h);
167 void (*dpy_text_update)(DisplayChangeListener *dcl,
7c20b4a3
GH
168 int x, int y, int w, int h);
169
170 void (*dpy_mouse_set)(DisplayChangeListener *dcl,
7c20b4a3
GH
171 int x, int y, int on);
172 void (*dpy_cursor_define)(DisplayChangeListener *dcl,
7c20b4a3
GH
173 QEMUCursor *cursor);
174} DisplayChangeListenerOps;
7d957bd8 175
7c20b4a3
GH
176struct DisplayChangeListener {
177 int idle;
178 uint64_t gui_timer_interval;
179 const DisplayChangeListenerOps *ops;
180 DisplayState *ds;
bf2fde70 181
87e487a1 182 QLIST_ENTRY(DisplayChangeListener) next;
7d957bd8
AL
183};
184
185struct DisplayState {
7d957bd8 186 struct QEMUTimer *gui_timer;
a93a4a22
GH
187 bool have_gfx;
188 bool have_text;
7d957bd8 189
87e487a1 190 QLIST_HEAD(, DisplayChangeListener) listeners;
87ecb68b
PB
191};
192
64840c66 193DisplayState *init_displaystate(void);
7d957bd8 194DisplaySurface* qemu_create_displaysurface_from(int width, int height, int bpp,
b1424e03
GH
195 int linesize, uint8_t *data,
196 bool byteswap);
0da2ea1b 197PixelFormat qemu_different_endianness_pixelformat(int bpp);
198PixelFormat qemu_default_pixelformat(int bpp);
7d957bd8 199
da229ef3
GH
200DisplaySurface *qemu_create_displaysurface(int width, int height);
201void qemu_free_displaysurface(DisplaySurface *surface);
7b5d76da
AL
202
203static inline int is_surface_bgr(DisplaySurface *surface)
204{
205 if (surface->pf.bits_per_pixel == 32 && surface->pf.rshift == 0)
206 return 1;
207 else
208 return 0;
209}
210
7d957bd8
AL
211static inline int is_buffer_shared(DisplaySurface *surface)
212{
187cd1d9 213 return !(surface->flags & QEMU_ALLOCATED_FLAG);
7d957bd8
AL
214}
215
35c9e0a5
GH
216void gui_setup_refresh(DisplayState *ds);
217
7c20b4a3
GH
218void register_displaychangelistener(DisplayState *ds,
219 DisplayChangeListener *dcl);
220void unregister_displaychangelistener(DisplayChangeListener *dcl);
221
c78f7137
GH
222void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h);
223void dpy_gfx_replace_surface(QemuConsole *con,
da229ef3 224 DisplaySurface *surface);
7c20b4a3 225void dpy_refresh(DisplayState *s);
c78f7137 226void dpy_gfx_copy(QemuConsole *con, int src_x, int src_y,
7c20b4a3 227 int dst_x, int dst_y, int w, int h);
c78f7137
GH
228void dpy_text_cursor(QemuConsole *con, int x, int y);
229void dpy_text_update(QemuConsole *con, int x, int y, int w, int h);
230void dpy_text_resize(QemuConsole *con, int w, int h);
231void dpy_mouse_set(QemuConsole *con, int x, int y, int on);
232void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor);
233bool dpy_cursor_define_supported(QemuConsole *con);
bf2fde70 234
626e3b34
GH
235static inline int surface_stride(DisplaySurface *s)
236{
237 return pixman_image_get_stride(s->image);
238}
239
240static inline void *surface_data(DisplaySurface *s)
241{
242 return pixman_image_get_data(s->image);
243}
244
245static inline int surface_width(DisplaySurface *s)
246{
247 return pixman_image_get_width(s->image);
248}
249
250static inline int surface_height(DisplaySurface *s)
251{
252 return pixman_image_get_height(s->image);
253}
254
255static inline int surface_bits_per_pixel(DisplaySurface *s)
256{
257 int bits = PIXMAN_FORMAT_BPP(s->format);
258 return bits;
259}
260
261static inline int surface_bytes_per_pixel(DisplaySurface *s)
262{
263 int bits = PIXMAN_FORMAT_BPP(s->format);
264 return (bits + 7) / 8;
265}
266
df00bed0
DP
267#ifdef CONFIG_CURSES
268#include <curses.h>
269typedef chtype console_ch_t;
270#else
c227f099 271typedef unsigned long console_ch_t;
df00bed0 272#endif
c227f099 273static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
4d3b6f6e 274{
f6d20d0f
BK
275 if (!(ch & 0xff))
276 ch |= ' ';
9ae19b65 277 *dest = ch;
4d3b6f6e
AZ
278}
279
1dbfa005
GH
280typedef void (*graphic_hw_update_ptr)(void *);
281typedef void (*graphic_hw_invalidate_ptr)(void *);
1dbfa005 282typedef void (*graphic_hw_text_update_ptr)(void *, console_ch_t *);
87ecb68b 283
1dbfa005
GH
284QemuConsole *graphic_console_init(graphic_hw_update_ptr update,
285 graphic_hw_invalidate_ptr invalidate,
1dbfa005 286 graphic_hw_text_update_ptr text_update,
c78f7137 287 void *opaque);
3023f332 288
1dbfa005
GH
289void graphic_hw_update(QemuConsole *con);
290void graphic_hw_invalidate(QemuConsole *con);
291void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata);
87ecb68b
PB
292
293int is_graphic_console(void);
c21bbcfa 294int is_fixedsize_console(void);
2796dae0 295void text_consoles_set_display(DisplayState *ds);
87ecb68b
PB
296void console_select(unsigned int index);
297void console_color_init(DisplayState *ds);
c78f7137
GH
298void qemu_console_resize(QemuConsole *con, int width, int height);
299void qemu_console_copy(QemuConsole *con, int src_x, int src_y,
3023f332 300 int dst_x, int dst_y, int w, int h);
c78f7137
GH
301DisplaySurface *qemu_console_surface(QemuConsole *con);
302DisplayState *qemu_console_displaystate(QemuConsole *console);
87ecb68b 303
702ec69c 304typedef CharDriverState *(VcHandler)(ChardevVC *vc);
d82831db 305
702ec69c 306CharDriverState *vc_init(ChardevVC *vc);
d82831db
AL
307void register_vc_handler(VcHandler *handler);
308
87ecb68b
PB
309/* sdl.c */
310void sdl_display_init(DisplayState *ds, int full_screen, int no_frame);
311
312/* cocoa.m */
313void cocoa_display_init(DisplayState *ds, int full_screen);
314
315/* vnc.c */
316void vnc_display_init(DisplayState *ds);
007fcd3e 317void vnc_display_open(DisplayState *ds, const char *display, Error **errp);
13661089 318void vnc_display_add_client(DisplayState *ds, int csock, int skipauth);
821601ea
JS
319char *vnc_display_local_addr(DisplayState *ds);
320#ifdef CONFIG_VNC
321int vnc_display_password(DisplayState *ds, const char *password);
3c9405a0 322int vnc_display_pw_expire(DisplayState *ds, time_t expires);
821601ea
JS
323#else
324static inline int vnc_display_password(DisplayState *ds, const char *password)
325{
821601ea
JS
326 return -ENODEV;
327}
328static inline int vnc_display_pw_expire(DisplayState *ds, time_t expires)
329{
821601ea
JS
330 return -ENODEV;
331};
821601ea 332#endif
87ecb68b 333
4d3b6f6e
AZ
334/* curses.c */
335void curses_display_init(DisplayState *ds, int full_screen);
336
1048c88f 337/* input.c */
1048c88f
AK
338int index_from_key(const char *key);
339int index_from_keycode(int code);
340
a4ccabcf
AL
341/* gtk.c */
342void early_gtk_display_init(void);
343void gtk_display_init(DisplayState *ds);
344
87ecb68b 345#endif