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