include/ui/console.h

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