[mirror_qemu.git] / include / ui / console.h

#ifndef CONSOLE_H
#define CONSOLE_H

#include "ui/qemu-pixman.h"
#include "qom/object.h"
#include "qapi/qmp/qdict.h"
#include "qemu/notify.h"
#include "qapi-types.h"
#include "qemu/error-report.h"
#include "qapi/error.h"

#ifdef CONFIG_OPENGL
# include <epoxy/gl.h>
#endif

/* keyboard/mouse support */

#define MOUSE_EVENT_LBUTTON 0x01
#define MOUSE_EVENT_RBUTTON 0x02
#define MOUSE_EVENT_MBUTTON 0x04
#define MOUSE_EVENT_WHEELUP 0x08
#define MOUSE_EVENT_WHEELDN 0x10

/* identical to the ps/2 keyboard bits */
#define QEMU_SCROLL_LOCK_LED (1 << 0)
#define QEMU_NUM_LOCK_LED    (1 << 1)
#define QEMU_CAPS_LOCK_LED   (1 << 2)

/* in ms */
#define GUI_REFRESH_INTERVAL_DEFAULT    30
#define GUI_REFRESH_INTERVAL_IDLE     3000

/* Color number is match to standard vga palette */
enum qemu_color_names {
    QEMU_COLOR_BLACK   = 0,
    QEMU_COLOR_BLUE    = 1,
    QEMU_COLOR_GREEN   = 2,
    QEMU_COLOR_CYAN    = 3,
    QEMU_COLOR_RED     = 4,
    QEMU_COLOR_MAGENTA = 5,
    QEMU_COLOR_YELLOW  = 6,
    QEMU_COLOR_WHITE   = 7
};
/* Convert to curses char attributes */
#define ATTR2CHTYPE(c, fg, bg, bold) \
    ((bold) << 21 | (bg) << 11 | (fg) << 8 | (c))

typedef void QEMUPutKBDEvent(void *opaque, int keycode);
typedef void QEMUPutLEDEvent(void *opaque, int ledstate);
typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state);

typedef struct QEMUPutMouseEntry QEMUPutMouseEntry;
typedef struct QEMUPutKbdEntry QEMUPutKbdEntry;
typedef struct QEMUPutLEDEntry QEMUPutLEDEntry;

QEMUPutKbdEntry *qemu_add_kbd_event_handler(QEMUPutKBDEvent *func,
                                            void *opaque);
QEMUPutMouseEntry *qemu_add_mouse_event_handler(QEMUPutMouseEvent *func,
                                                void *opaque, int absolute,
                                                const char *name);
void qemu_remove_mouse_event_handler(QEMUPutMouseEntry *entry);
void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry);

QEMUPutLEDEntry *qemu_add_led_event_handler(QEMUPutLEDEvent *func, void *opaque);
void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry);

void kbd_put_ledstate(int ledstate);

struct MouseTransformInfo {
    /* Touchscreen resolution */
    int x;
    int y;
    /* Calibration values as used/generated by tslib */
    int a[7];
};

void hmp_mouse_set(Monitor *mon, const QDict *qdict);

/* keysym is a unicode code except for special keys (see QEMU_KEY_xxx
   constants) */
#define QEMU_KEY_ESC1(c) ((c) | 0xe100)
#define QEMU_KEY_BACKSPACE  0x007f
#define QEMU_KEY_UP         QEMU_KEY_ESC1('A')
#define QEMU_KEY_DOWN       QEMU_KEY_ESC1('B')
#define QEMU_KEY_RIGHT      QEMU_KEY_ESC1('C')
#define QEMU_KEY_LEFT       QEMU_KEY_ESC1('D')
#define QEMU_KEY_HOME       QEMU_KEY_ESC1(1)
#define QEMU_KEY_END        QEMU_KEY_ESC1(4)
#define QEMU_KEY_PAGEUP     QEMU_KEY_ESC1(5)
#define QEMU_KEY_PAGEDOWN   QEMU_KEY_ESC1(6)
#define QEMU_KEY_DELETE     QEMU_KEY_ESC1(3)

#define QEMU_KEY_CTRL_UP         0xe400
#define QEMU_KEY_CTRL_DOWN       0xe401
#define QEMU_KEY_CTRL_LEFT       0xe402
#define QEMU_KEY_CTRL_RIGHT      0xe403
#define QEMU_KEY_CTRL_HOME       0xe404
#define QEMU_KEY_CTRL_END        0xe405
#define QEMU_KEY_CTRL_PAGEUP     0xe406
#define QEMU_KEY_CTRL_PAGEDOWN   0xe407

void kbd_put_keysym_console(QemuConsole *s, int keysym);
bool kbd_put_qcode_console(QemuConsole *s, int qcode);
void kbd_put_string_console(QemuConsole *s, const char *str, int len);
void kbd_put_keysym(int keysym);

/* consoles */

#define TYPE_QEMU_CONSOLE "qemu-console"
#define QEMU_CONSOLE(obj) \
    OBJECT_CHECK(QemuConsole, (obj), TYPE_QEMU_CONSOLE)
#define QEMU_CONSOLE_GET_CLASS(obj) \
    OBJECT_GET_CLASS(QemuConsoleClass, (obj), TYPE_QEMU_CONSOLE)
#define QEMU_CONSOLE_CLASS(klass) \
    OBJECT_CLASS_CHECK(QemuConsoleClass, (klass), TYPE_QEMU_CONSOLE)

typedef struct QemuConsoleClass QemuConsoleClass;

struct QemuConsoleClass {
    ObjectClass parent_class;
};

#define QEMU_ALLOCATED_FLAG     0x01

struct PixelFormat {
    uint8_t bits_per_pixel;
    uint8_t bytes_per_pixel;
    uint8_t depth; /* color depth in bits */
    uint32_t rmask, gmask, bmask, amask;
    uint8_t rshift, gshift, bshift, ashift;
    uint8_t rmax, gmax, bmax, amax;
    uint8_t rbits, gbits, bbits, abits;
};

struct DisplaySurface {
    pixman_format_code_t format;
    pixman_image_t *image;
    uint8_t flags;
#ifdef CONFIG_OPENGL
    GLenum glformat;
    GLenum gltype;
    GLuint texture;
#endif
};

typedef struct QemuUIInfo {
    /* geometry */
    int       xoff;
    int       yoff;
    uint32_t  width;
    uint32_t  height;
} QemuUIInfo;

/* cursor data format is 32bit RGBA */
typedef struct QEMUCursor {
    int                 width, height;
    int                 hot_x, hot_y;
    int                 refcount;
    uint32_t            data[];
} QEMUCursor;

QEMUCursor *cursor_alloc(int width, int height);
void cursor_get(QEMUCursor *c);
void cursor_put(QEMUCursor *c);
QEMUCursor *cursor_builtin_hidden(void);
QEMUCursor *cursor_builtin_left_ptr(void);
void cursor_print_ascii_art(QEMUCursor *c, const char *prefix);
int cursor_get_mono_bpl(QEMUCursor *c);
void cursor_set_mono(QEMUCursor *c,
                     uint32_t foreground, uint32_t background, uint8_t *image,
                     int transparent, uint8_t *mask);
void cursor_get_mono_image(QEMUCursor *c, int foreground, uint8_t *mask);
void cursor_get_mono_mask(QEMUCursor *c, int transparent, uint8_t *mask);

typedef void *QEMUGLContext;
typedef struct QEMUGLParams QEMUGLParams;

struct QEMUGLParams {
    int major_ver;
    int minor_ver;
};

typedef struct DisplayChangeListenerOps {
    const char *dpy_name;

    void (*dpy_refresh)(DisplayChangeListener *dcl);

    void (*dpy_gfx_update)(DisplayChangeListener *dcl,
                           int x, int y, int w, int h);
    void (*dpy_gfx_switch)(DisplayChangeListener *dcl,
                           struct DisplaySurface *new_surface);
    void (*dpy_gfx_copy)(DisplayChangeListener *dcl,
                         int src_x, int src_y,
                         int dst_x, int dst_y, int w, int h);
    bool (*dpy_gfx_check_format)(DisplayChangeListener *dcl,
                                 pixman_format_code_t format);

    void (*dpy_text_cursor)(DisplayChangeListener *dcl,
                            int x, int y);
    void (*dpy_text_resize)(DisplayChangeListener *dcl,
                            int w, int h);
    void (*dpy_text_update)(DisplayChangeListener *dcl,
                            int x, int y, int w, int h);

    void (*dpy_mouse_set)(DisplayChangeListener *dcl,
                          int x, int y, int on);
    void (*dpy_cursor_define)(DisplayChangeListener *dcl,
                              QEMUCursor *cursor);

    QEMUGLContext (*dpy_gl_ctx_create)(DisplayChangeListener *dcl,
                                       QEMUGLParams *params);
    void (*dpy_gl_ctx_destroy)(DisplayChangeListener *dcl,
                               QEMUGLContext ctx);
    int (*dpy_gl_ctx_make_current)(DisplayChangeListener *dcl,
                                   QEMUGLContext ctx);
    QEMUGLContext (*dpy_gl_ctx_get_current)(DisplayChangeListener *dcl);

    void (*dpy_gl_scanout)(DisplayChangeListener *dcl,
                           uint32_t backing_id, bool backing_y_0_top,
                           uint32_t backing_width, uint32_t backing_height,
                           uint32_t x, uint32_t y, uint32_t w, uint32_t h);
    void (*dpy_gl_update)(DisplayChangeListener *dcl,
                          uint32_t x, uint32_t y, uint32_t w, uint32_t h);

} DisplayChangeListenerOps;

struct DisplayChangeListener {
    uint64_t update_interval;
    const DisplayChangeListenerOps *ops;
    DisplayState *ds;
    QemuConsole *con;

    QLIST_ENTRY(DisplayChangeListener) next;
};

DisplayState *init_displaystate(void);
DisplaySurface *qemu_create_displaysurface_from(int width, int height,
                                                pixman_format_code_t format,
                                                int linesize, uint8_t *data);
DisplaySurface *qemu_create_displaysurface_pixman(pixman_image_t *image);
DisplaySurface *qemu_create_displaysurface_guestmem(int width, int height,
                                                    pixman_format_code_t format,
                                                    int linesize,
                                                    uint64_t addr);
PixelFormat qemu_default_pixelformat(int bpp);

DisplaySurface *qemu_create_displaysurface(int width, int height);
void qemu_free_displaysurface(DisplaySurface *surface);

static inline int is_surface_bgr(DisplaySurface *surface)
{
    if (PIXMAN_FORMAT_BPP(surface->format) == 32 &&
        PIXMAN_FORMAT_TYPE(surface->format) == PIXMAN_TYPE_ABGR) {
        return 1;
    } else {
        return 0;
    }
}

static inline int is_buffer_shared(DisplaySurface *surface)
{
    return !(surface->flags & QEMU_ALLOCATED_FLAG);
}

void register_displaychangelistener(DisplayChangeListener *dcl);
void update_displaychangelistener(DisplayChangeListener *dcl,
                                  uint64_t interval);
void unregister_displaychangelistener(DisplayChangeListener *dcl);

bool dpy_ui_info_supported(QemuConsole *con);
int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info);

void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h);
void dpy_gfx_replace_surface(QemuConsole *con,
                             DisplaySurface *surface);
void dpy_gfx_copy(QemuConsole *con, int src_x, int src_y,
                  int dst_x, int dst_y, int w, int h);
void dpy_text_cursor(QemuConsole *con, int x, int y);
void dpy_text_update(QemuConsole *con, int x, int y, int w, int h);
void dpy_text_resize(QemuConsole *con, int w, int h);
void dpy_mouse_set(QemuConsole *con, int x, int y, int on);
void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor);
bool dpy_cursor_define_supported(QemuConsole *con);
bool dpy_gfx_check_format(QemuConsole *con,
                          pixman_format_code_t format);

void dpy_gl_scanout(QemuConsole *con,
                    uint32_t backing_id, bool backing_y_0_top,
                    uint32_t backing_width, uint32_t backing_height,
                    uint32_t x, uint32_t y, uint32_t w, uint32_t h);
void dpy_gl_update(QemuConsole *con,
                   uint32_t x, uint32_t y, uint32_t w, uint32_t h);

QEMUGLContext dpy_gl_ctx_create(QemuConsole *con,
                                QEMUGLParams *params);
void dpy_gl_ctx_destroy(QemuConsole *con, QEMUGLContext ctx);
int dpy_gl_ctx_make_current(QemuConsole *con, QEMUGLContext ctx);
QEMUGLContext dpy_gl_ctx_get_current(QemuConsole *con);

bool console_has_gl(QemuConsole *con);

static inline int surface_stride(DisplaySurface *s)
{
    return pixman_image_get_stride(s->image);
}

static inline void *surface_data(DisplaySurface *s)
{
    return pixman_image_get_data(s->image);
}

static inline int surface_width(DisplaySurface *s)
{
    return pixman_image_get_width(s->image);
}

static inline int surface_height(DisplaySurface *s)
{
    return pixman_image_get_height(s->image);
}

static inline int surface_bits_per_pixel(DisplaySurface *s)
{
    int bits = PIXMAN_FORMAT_BPP(s->format);
    return bits;
}

static inline int surface_bytes_per_pixel(DisplaySurface *s)
{
    int bits = PIXMAN_FORMAT_BPP(s->format);
    return (bits + 7) / 8;
}

static inline pixman_format_code_t surface_format(DisplaySurface *s)
{
    return s->format;
}

#ifdef CONFIG_CURSES
#include <curses.h>
typedef chtype console_ch_t;
extern chtype vga_to_curses[];
#else
typedef unsigned long console_ch_t;
#endif
static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
{
    uint8_t c = ch;
#ifdef CONFIG_CURSES
    if (vga_to_curses[c]) {
        ch &= ~(console_ch_t)0xff;
        ch |= vga_to_curses[c];
    }
#else
    if (c == '\0') {
        ch |= ' ';
    }
#endif
    *dest = ch;
}

typedef struct GraphicHwOps {
    void (*invalidate)(void *opaque);
    void (*gfx_update)(void *opaque);
    void (*text_update)(void *opaque, console_ch_t *text);
    void (*update_interval)(void *opaque, uint64_t interval);
    int (*ui_info)(void *opaque, uint32_t head, QemuUIInfo *info);
    void (*gl_block)(void *opaque, bool block);
} GraphicHwOps;

QemuConsole *graphic_console_init(DeviceState *dev, uint32_t head,
                                  const GraphicHwOps *ops,
                                  void *opaque);
void graphic_console_set_hwops(QemuConsole *con,
                               const GraphicHwOps *hw_ops,
                               void *opaque);

void graphic_hw_update(QemuConsole *con);
void graphic_hw_invalidate(QemuConsole *con);
void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata);
void graphic_hw_gl_block(QemuConsole *con, bool block);

QemuConsole *qemu_console_lookup_by_index(unsigned int index);
QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head);
QemuConsole *qemu_console_lookup_by_device_name(const char *device_id,
                                                uint32_t head, Error **errp);
bool qemu_console_is_visible(QemuConsole *con);
bool qemu_console_is_graphic(QemuConsole *con);
bool qemu_console_is_fixedsize(QemuConsole *con);
char *qemu_console_get_label(QemuConsole *con);
int qemu_console_get_index(QemuConsole *con);
uint32_t qemu_console_get_head(QemuConsole *con);
QemuUIInfo *qemu_console_get_ui_info(QemuConsole *con);
int qemu_console_get_width(QemuConsole *con, int fallback);
int qemu_console_get_height(QemuConsole *con, int fallback);

void console_select(unsigned int index);
void qemu_console_resize(QemuConsole *con, int width, int height);
void qemu_console_copy(QemuConsole *con, int src_x, int src_y,
                       int dst_x, int dst_y, int w, int h);
DisplaySurface *qemu_console_surface(QemuConsole *con);

/* console-gl.c */
typedef struct ConsoleGLState ConsoleGLState;
#ifdef CONFIG_OPENGL
ConsoleGLState *console_gl_init_context(void);
void console_gl_fini_context(ConsoleGLState *gls);
bool console_gl_check_format(DisplayChangeListener *dcl,
                             pixman_format_code_t format);
void surface_gl_create_texture(ConsoleGLState *gls,
                               DisplaySurface *surface);
void surface_gl_update_texture(ConsoleGLState *gls,
                               DisplaySurface *surface,
                               int x, int y, int w, int h);
void surface_gl_render_texture(ConsoleGLState *gls,
                               DisplaySurface *surface);
void surface_gl_destroy_texture(ConsoleGLState *gls,
                               DisplaySurface *surface);
void surface_gl_setup_viewport(ConsoleGLState *gls,
                               DisplaySurface *surface,
                               int ww, int wh);
#endif

/* sdl.c */
#ifdef CONFIG_SDL
void sdl_display_early_init(int opengl);
void sdl_display_init(DisplayState *ds, int full_screen, int no_frame);
#else
static inline void sdl_display_early_init(int opengl)
{
    /* This must never be called if CONFIG_SDL is disabled */
    error_report("SDL support is disabled");
    abort();
}
static inline void sdl_display_init(DisplayState *ds, int full_screen,
                                    int no_frame)
{
    /* This must never be called if CONFIG_SDL is disabled */
    error_report("SDL support is disabled");
    abort();
}
#endif

/* cocoa.m */
#ifdef CONFIG_COCOA
void cocoa_display_init(DisplayState *ds, int full_screen);
#else
static inline void cocoa_display_init(DisplayState *ds, int full_screen)
{
    /* This must never be called if CONFIG_COCOA is disabled */
    error_report("Cocoa support is disabled");
    abort();
}
#endif

/* vnc.c */
void vnc_display_init(const char *id);
void vnc_display_open(const char *id, Error **errp);
void vnc_display_add_client(const char *id, int csock, bool skipauth);
#ifdef CONFIG_VNC
int vnc_display_password(const char *id, const char *password);
int vnc_display_pw_expire(const char *id, time_t expires);
QemuOpts *vnc_parse(const char *str, Error **errp);
int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp);
#else
static inline int vnc_display_password(const char *id, const char *password)
{
    return -ENODEV;
}
static inline int vnc_display_pw_expire(const char *id, time_t expires)
{
    return -ENODEV;
};
static inline QemuOpts *vnc_parse(const char *str, Error **errp)
{
    error_setg(errp, "VNC support is disabled");
    return NULL;
}
static inline int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp)
{
    error_setg(errp, "VNC support is disabled");
    return -1;
}
#endif

/* curses.c */
#ifdef CONFIG_CURSES
void curses_display_init(DisplayState *ds, int full_screen);
#else
static inline void curses_display_init(DisplayState *ds, int full_screen)
{
    /* This must never be called if CONFIG_CURSES is disabled */
    error_report("curses support is disabled");
    abort();
}
#endif

/* input.c */
int index_from_key(const char *key, size_t key_length);

/* gtk.c */
#ifdef CONFIG_GTK
void early_gtk_display_init(int opengl);
void gtk_display_init(DisplayState *ds, bool full_screen, bool grab_on_hover);
#else
static inline void gtk_display_init(DisplayState *ds, bool full_screen,
                                    bool grab_on_hover)
{
    /* This must never be called if CONFIG_GTK is disabled */
    error_report("GTK support is disabled");
    abort();
}

static inline void early_gtk_display_init(int opengl)
{
    /* This must never be called if CONFIG_GTK is disabled */
    error_report("GTK support is disabled");
    abort();
}
#endif

#endif
Commit	Line	Data
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"
1048c88f	8	#include "qapi-types.h"
f8c75b24 EH	9	#include "qemu/error-report.h"
f8c75b24 EH	10	#include "qapi/error.h"
87ecb68b	11
cd2bc889	12	#ifdef CONFIG_OPENGL
dcf30025	13	# include <epoxy/gl.h>
cd2bc889 GH	14	#endif
cd2bc889 GH	15
87ecb68b PB	16	/* keyboard/mouse support */
	17
	18	#define MOUSE_EVENT_LBUTTON 0x01
	19	#define MOUSE_EVENT_RBUTTON 0x02
	20	#define MOUSE_EVENT_MBUTTON 0x04
21bae11a GH	21	#define MOUSE_EVENT_WHEELUP 0x08
21bae11a GH	22	#define MOUSE_EVENT_WHEELDN 0x10
87ecb68b	23
03a23a85 GH	24	/* identical to the ps/2 keyboard bits */
	25	#define QEMU_SCROLL_LOCK_LED (1 << 0)
	26	#define QEMU_NUM_LOCK_LED (1 << 1)
	27	#define QEMU_CAPS_LOCK_LED (1 << 2)
	28
7ed9eba3	29	/* in ms */
0f7b2864 GH	30	#define GUI_REFRESH_INTERVAL_DEFAULT 30
0f7b2864 GH	31	#define GUI_REFRESH_INTERVAL_IDLE 3000
7ed9eba3	32
4083733d OH	33	/* Color number is match to standard vga palette */
	34	enum qemu_color_names {
	35	QEMU_COLOR_BLACK = 0,
	36	QEMU_COLOR_BLUE = 1,
	37	QEMU_COLOR_GREEN = 2,
	38	QEMU_COLOR_CYAN = 3,
	39	QEMU_COLOR_RED = 4,
	40	QEMU_COLOR_MAGENTA = 5,
	41	QEMU_COLOR_YELLOW = 6,
	42	QEMU_COLOR_WHITE = 7
	43	};
	44	/* Convert to curses char attributes */
	45	#define ATTR2CHTYPE(c, fg, bg, bold) \
	46	((bold) << 21 \| (bg) << 11 \| (fg) << 8 \| (c))
	47
87ecb68b	48	typedef void QEMUPutKBDEvent(void *opaque, int keycode);
03a23a85	49	typedef void QEMUPutLEDEvent(void *opaque, int ledstate);
87ecb68b PB	50	typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state);
87ecb68b PB	51
72711efb	52	typedef struct QEMUPutMouseEntry QEMUPutMouseEntry;
5a37532d	53	typedef struct QEMUPutKbdEntry QEMUPutKbdEntry;
72711efb	54	typedef struct QEMUPutLEDEntry QEMUPutLEDEntry;
03a23a85	55
5a37532d GH	56	QEMUPutKbdEntry qemu_add_kbd_event_handler(QEMUPutKBDEvent func,
5a37532d GH	57	void *opaque);
87ecb68b PB	58	QEMUPutMouseEntry qemu_add_mouse_event_handler(QEMUPutMouseEvent func,
	59	void *opaque, int absolute,
	60	const char *name);
	61	void qemu_remove_mouse_event_handler(QEMUPutMouseEntry *entry);
6fef28ee AL	62	void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry);
6fef28ee AL	63
03a23a85 GH	64	QEMUPutLEDEntry qemu_add_led_event_handler(QEMUPutLEDEvent func, void *opaque);
03a23a85 GH	65	void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry);
87ecb68b	66
03a23a85	67	void kbd_put_ledstate(int ledstate);
eb2e259d	68
bc24a225	69	struct MouseTransformInfo {
a5d7eb65 AZ	70	/* Touchscreen resolution */
	71	int x;
	72	int y;
	73	/* Calibration values as used/generated by tslib */
	74	int a[7];
	75	};
	76
3e5a50d6	77	void hmp_mouse_set(Monitor mon, const QDict qdict);
87ecb68b PB	78
	79	/* keysym is a unicode code except for special keys (see QEMU_KEY_xxx
	80	constants) */
	81	#define QEMU_KEY_ESC1(c) ((c) \| 0xe100)
	82	#define QEMU_KEY_BACKSPACE 0x007f
	83	#define QEMU_KEY_UP QEMU_KEY_ESC1('A')
	84	#define QEMU_KEY_DOWN QEMU_KEY_ESC1('B')
	85	#define QEMU_KEY_RIGHT QEMU_KEY_ESC1('C')
	86	#define QEMU_KEY_LEFT QEMU_KEY_ESC1('D')
	87	#define QEMU_KEY_HOME QEMU_KEY_ESC1(1)
	88	#define QEMU_KEY_END QEMU_KEY_ESC1(4)
	89	#define QEMU_KEY_PAGEUP QEMU_KEY_ESC1(5)
	90	#define QEMU_KEY_PAGEDOWN QEMU_KEY_ESC1(6)
	91	#define QEMU_KEY_DELETE QEMU_KEY_ESC1(3)
	92
	93	#define QEMU_KEY_CTRL_UP 0xe400
	94	#define QEMU_KEY_CTRL_DOWN 0xe401
	95	#define QEMU_KEY_CTRL_LEFT 0xe402
	96	#define QEMU_KEY_CTRL_RIGHT 0xe403
	97	#define QEMU_KEY_CTRL_HOME 0xe404
	98	#define QEMU_KEY_CTRL_END 0xe405
	99	#define QEMU_KEY_CTRL_PAGEUP 0xe406
	100	#define QEMU_KEY_CTRL_PAGEDOWN 0xe407
	101
3f9a6e85	102	void kbd_put_keysym_console(QemuConsole *s, int keysym);
50ef4679	103	bool kbd_put_qcode_console(QemuConsole *s, int qcode);
bdef9724	104	void kbd_put_string_console(QemuConsole s, const char str, int len);
87ecb68b PB	105	void kbd_put_keysym(int keysym);
	106
	107	/* consoles */
	108
95be0669 GH	109	#define TYPE_QEMU_CONSOLE "qemu-console"
	110	#define QEMU_CONSOLE(obj) \
	111	OBJECT_CHECK(QemuConsole, (obj), TYPE_QEMU_CONSOLE)
	112	#define QEMU_CONSOLE_GET_CLASS(obj) \
	113	OBJECT_GET_CLASS(QemuConsoleClass, (obj), TYPE_QEMU_CONSOLE)
	114	#define QEMU_CONSOLE_CLASS(klass) \
	115	OBJECT_CLASS_CHECK(QemuConsoleClass, (klass), TYPE_QEMU_CONSOLE)
	116
	117	typedef struct QemuConsoleClass QemuConsoleClass;
	118
	119	struct QemuConsoleClass {
	120	ObjectClass parent_class;
	121	};
	122
77bfcf28	123	#define QEMU_ALLOCATED_FLAG 0x01
7d957bd8 AL	124
	125	struct PixelFormat {
	126	uint8_t bits_per_pixel;
	127	uint8_t bytes_per_pixel;
	128	uint8_t depth; /* color depth in bits */
	129	uint32_t rmask, gmask, bmask, amask;
	130	uint8_t rshift, gshift, bshift, ashift;
	131	uint8_t rmax, gmax, bmax, amax;
90a1e3c0	132	uint8_t rbits, gbits, bbits, abits;
7d957bd8 AL	133	};
	134
	135	struct DisplaySurface {
69c77777 GH	136	pixman_format_code_t format;
69c77777 GH	137	pixman_image_t *image;
7d957bd8	138	uint8_t flags;
cd2bc889 GH	139	#ifdef CONFIG_OPENGL
	140	GLenum glformat;
	141	GLenum gltype;
	142	GLuint texture;
	143	#endif
7d957bd8 AL	144	};
7d957bd8 AL	145
6f90f3d7 GH	146	typedef struct QemuUIInfo {
	147	/* geometry */
	148	int xoff;
	149	int yoff;
	150	uint32_t width;
	151	uint32_t height;
	152	} QemuUIInfo;
	153
254e5950 GH	154	/* cursor data format is 32bit RGBA */
	155	typedef struct QEMUCursor {
	156	int width, height;
	157	int hot_x, hot_y;
	158	int refcount;
	159	uint32_t data[];
	160	} QEMUCursor;
	161
	162	QEMUCursor *cursor_alloc(int width, int height);
	163	void cursor_get(QEMUCursor *c);
	164	void cursor_put(QEMUCursor *c);
	165	QEMUCursor *cursor_builtin_hidden(void);
	166	QEMUCursor *cursor_builtin_left_ptr(void);
	167	void cursor_print_ascii_art(QEMUCursor c, const char prefix);
	168	int cursor_get_mono_bpl(QEMUCursor *c);
	169	void cursor_set_mono(QEMUCursor *c,
	170	uint32_t foreground, uint32_t background, uint8_t *image,
	171	int transparent, uint8_t *mask);
	172	void cursor_get_mono_image(QEMUCursor c, int foreground, uint8_t mask);
	173	void cursor_get_mono_mask(QEMUCursor c, int transparent, uint8_t mask);
	174
06020b95 GH	175	typedef void *QEMUGLContext;
	176	typedef struct QEMUGLParams QEMUGLParams;
	177
	178	struct QEMUGLParams {
	179	int major_ver;
	180	int minor_ver;
	181	};
	182
7c20b4a3 GH	183	typedef struct DisplayChangeListenerOps {
	184	const char *dpy_name;
	185
bc2ed970	186	void (dpy_refresh)(DisplayChangeListener dcl);
7c20b4a3 GH	187
7c20b4a3 GH	188	void (dpy_gfx_update)(DisplayChangeListener dcl,
7c20b4a3	189	int x, int y, int w, int h);
c12aeb86	190	void (dpy_gfx_switch)(DisplayChangeListener dcl,
c12aeb86	191	struct DisplaySurface *new_surface);
7c20b4a3	192	void (dpy_gfx_copy)(DisplayChangeListener dcl,
bc2ed970	193	int src_x, int src_y,
a93a4a22	194	int dst_x, int dst_y, int w, int h);
49743df3 BH	195	bool (dpy_gfx_check_format)(DisplayChangeListener dcl,
49743df3 BH	196	pixman_format_code_t format);
a93a4a22	197
7c20b4a3	198	void (dpy_text_cursor)(DisplayChangeListener dcl,
7c20b4a3 GH	199	int x, int y);
7c20b4a3 GH	200	void (dpy_text_resize)(DisplayChangeListener dcl,
7c20b4a3 GH	201	int w, int h);
7c20b4a3 GH	202	void (dpy_text_update)(DisplayChangeListener dcl,
7c20b4a3 GH	203	int x, int y, int w, int h);
	204
	205	void (dpy_mouse_set)(DisplayChangeListener dcl,
7c20b4a3 GH	206	int x, int y, int on);
7c20b4a3 GH	207	void (dpy_cursor_define)(DisplayChangeListener dcl,
7c20b4a3	208	QEMUCursor *cursor);
06020b95 GH	209
	210	QEMUGLContext (dpy_gl_ctx_create)(DisplayChangeListener dcl,
	211	QEMUGLParams *params);
	212	void (dpy_gl_ctx_destroy)(DisplayChangeListener dcl,
	213	QEMUGLContext ctx);
	214	int (dpy_gl_ctx_make_current)(DisplayChangeListener dcl,
	215	QEMUGLContext ctx);
	216	QEMUGLContext (dpy_gl_ctx_get_current)(DisplayChangeListener dcl);
	217
	218	void (dpy_gl_scanout)(DisplayChangeListener dcl,
	219	uint32_t backing_id, bool backing_y_0_top,
9d8256eb	220	uint32_t backing_width, uint32_t backing_height,
06020b95 GH	221	uint32_t x, uint32_t y, uint32_t w, uint32_t h);
	222	void (dpy_gl_update)(DisplayChangeListener dcl,
	223	uint32_t x, uint32_t y, uint32_t w, uint32_t h);
	224
7c20b4a3	225	} DisplayChangeListenerOps;
7d957bd8	226
7c20b4a3	227	struct DisplayChangeListener {
0f7b2864	228	uint64_t update_interval;
7c20b4a3 GH	229	const DisplayChangeListenerOps *ops;
7c20b4a3 GH	230	DisplayState *ds;
284d1c6b	231	QemuConsole *con;
bf2fde70	232
87e487a1	233	QLIST_ENTRY(DisplayChangeListener) next;
7d957bd8 AL	234	};
7d957bd8 AL	235
64840c66	236	DisplayState *init_displaystate(void);
30f1e661 GH	237	DisplaySurface *qemu_create_displaysurface_from(int width, int height,
	238	pixman_format_code_t format,
	239	int linesize, uint8_t *data);
ca58b45f	240	DisplaySurface qemu_create_displaysurface_pixman(pixman_image_t image);
a77549b3 GH	241	DisplaySurface *qemu_create_displaysurface_guestmem(int width, int height,
	242	pixman_format_code_t format,
	243	int linesize,
	244	uint64_t addr);
0da2ea1b	245	PixelFormat qemu_default_pixelformat(int bpp);
7d957bd8	246
da229ef3 GH	247	DisplaySurface *qemu_create_displaysurface(int width, int height);
da229ef3 GH	248	void qemu_free_displaysurface(DisplaySurface *surface);
7b5d76da AL	249
	250	static inline int is_surface_bgr(DisplaySurface *surface)
	251	{
30f1e661 GH	252	if (PIXMAN_FORMAT_BPP(surface->format) == 32 &&
30f1e661 GH	253	PIXMAN_FORMAT_TYPE(surface->format) == PIXMAN_TYPE_ABGR) {
7b5d76da	254	return 1;
30f1e661	255	} else {
7b5d76da	256	return 0;
30f1e661	257	}
7b5d76da AL	258	}
7b5d76da AL	259
7d957bd8 AL	260	static inline int is_buffer_shared(DisplaySurface *surface)
7d957bd8 AL	261	{
187cd1d9	262	return !(surface->flags & QEMU_ALLOCATED_FLAG);
7d957bd8 AL	263	}
7d957bd8 AL	264
5209089f	265	void register_displaychangelistener(DisplayChangeListener *dcl);
0f7b2864 GH	266	void update_displaychangelistener(DisplayChangeListener *dcl,
0f7b2864 GH	267	uint64_t interval);
7c20b4a3 GH	268	void unregister_displaychangelistener(DisplayChangeListener *dcl);
7c20b4a3 GH	269
b7fb49f0	270	bool dpy_ui_info_supported(QemuConsole *con);
6f90f3d7 GH	271	int dpy_set_ui_info(QemuConsole con, QemuUIInfo info);
6f90f3d7 GH	272
c78f7137 GH	273	void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h);
c78f7137 GH	274	void dpy_gfx_replace_surface(QemuConsole *con,
da229ef3	275	DisplaySurface *surface);
c78f7137	276	void dpy_gfx_copy(QemuConsole *con, int src_x, int src_y,
7c20b4a3	277	int dst_x, int dst_y, int w, int h);
c78f7137 GH	278	void dpy_text_cursor(QemuConsole *con, int x, int y);
	279	void dpy_text_update(QemuConsole *con, int x, int y, int w, int h);
	280	void dpy_text_resize(QemuConsole *con, int w, int h);
	281	void dpy_mouse_set(QemuConsole *con, int x, int y, int on);
	282	void dpy_cursor_define(QemuConsole con, QEMUCursor cursor);
	283	bool dpy_cursor_define_supported(QemuConsole *con);
49743df3 BH	284	bool dpy_gfx_check_format(QemuConsole *con,
49743df3 BH	285	pixman_format_code_t format);
bf2fde70	286
06020b95 GH	287	void dpy_gl_scanout(QemuConsole *con,
06020b95 GH	288	uint32_t backing_id, bool backing_y_0_top,
9d8256eb	289	uint32_t backing_width, uint32_t backing_height,
06020b95 GH	290	uint32_t x, uint32_t y, uint32_t w, uint32_t h);
	291	void dpy_gl_update(QemuConsole *con,
	292	uint32_t x, uint32_t y, uint32_t w, uint32_t h);
	293
	294	QEMUGLContext dpy_gl_ctx_create(QemuConsole *con,
	295	QEMUGLParams *params);
	296	void dpy_gl_ctx_destroy(QemuConsole *con, QEMUGLContext ctx);
	297	int dpy_gl_ctx_make_current(QemuConsole *con, QEMUGLContext ctx);
	298	QEMUGLContext dpy_gl_ctx_get_current(QemuConsole *con);
	299
	300	bool console_has_gl(QemuConsole *con);
	301
626e3b34 GH	302	static inline int surface_stride(DisplaySurface *s)
	303	{
	304	return pixman_image_get_stride(s->image);
	305	}
	306
	307	static inline void surface_data(DisplaySurface s)
	308	{
	309	return pixman_image_get_data(s->image);
	310	}
	311
	312	static inline int surface_width(DisplaySurface *s)
	313	{
	314	return pixman_image_get_width(s->image);
	315	}
	316
	317	static inline int surface_height(DisplaySurface *s)
	318	{
	319	return pixman_image_get_height(s->image);
	320	}
	321
	322	static inline int surface_bits_per_pixel(DisplaySurface *s)
	323	{
	324	int bits = PIXMAN_FORMAT_BPP(s->format);
	325	return bits;
	326	}
	327
	328	static inline int surface_bytes_per_pixel(DisplaySurface *s)
	329	{
	330	int bits = PIXMAN_FORMAT_BPP(s->format);
	331	return (bits + 7) / 8;
	332	}
	333
e444ea34 HR	334	static inline pixman_format_code_t surface_format(DisplaySurface *s)
	335	{
	336	return s->format;
	337	}
	338
df00bed0 DP	339	#ifdef CONFIG_CURSES
	340	#include <curses.h>
	341	typedef chtype console_ch_t;
e2368dc9	342	extern chtype vga_to_curses[];
df00bed0	343	#else
c227f099	344	typedef unsigned long console_ch_t;
df00bed0	345	#endif
c227f099	346	static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
4d3b6f6e	347	{
e2368dc9 OH	348	uint8_t c = ch;
	349	#ifdef CONFIG_CURSES
	350	if (vga_to_curses[c]) {
	351	ch &= ~(console_ch_t)0xff;
	352	ch \|= vga_to_curses[c];
	353	}
	354	#else
	355	if (c == '\0') {
f6d20d0f	356	ch \|= ' ';
e2368dc9 OH	357	}
e2368dc9 OH	358	#endif
9ae19b65	359	*dest = ch;
4d3b6f6e AZ	360	}
4d3b6f6e AZ	361
380cd056 GH	362	typedef struct GraphicHwOps {
	363	void (invalidate)(void opaque);
	364	void (gfx_update)(void opaque);
	365	void (text_update)(void opaque, console_ch_t *text);
dea1b0bd	366	void (update_interval)(void opaque, uint64_t interval);
6f90f3d7	367	int (ui_info)(void opaque, uint32_t head, QemuUIInfo *info);
bba19b88	368	void (gl_block)(void opaque, bool block);
380cd056	369	} GraphicHwOps;
87ecb68b	370
5643706a	371	QemuConsole graphic_console_init(DeviceState dev, uint32_t head,
aa2beaa1	372	const GraphicHwOps *ops,
c78f7137	373	void *opaque);
1c1f9498 GH	374	void graphic_console_set_hwops(QemuConsole *con,
	375	const GraphicHwOps *hw_ops,
	376	void *opaque);
3023f332	377
1dbfa005 GH	378	void graphic_hw_update(QemuConsole *con);
	379	void graphic_hw_invalidate(QemuConsole *con);
	380	void graphic_hw_text_update(QemuConsole con, console_ch_t chardata);
bba19b88	381	void graphic_hw_gl_block(QemuConsole *con, bool block);
87ecb68b	382
284d1c6b	383	QemuConsole *qemu_console_lookup_by_index(unsigned int index);
5643706a	384	QemuConsole qemu_console_lookup_by_device(DeviceState dev, uint32_t head);
f2c1d54c GH	385	QemuConsole qemu_console_lookup_by_device_name(const char device_id,
f2c1d54c GH	386	uint32_t head, Error **errp);
81c0d5a6 GH	387	bool qemu_console_is_visible(QemuConsole *con);
	388	bool qemu_console_is_graphic(QemuConsole *con);
	389	bool qemu_console_is_fixedsize(QemuConsole *con);
779ce88f	390	char qemu_console_get_label(QemuConsole con);
d4c85337	391	int qemu_console_get_index(QemuConsole *con);
5643706a	392	uint32_t qemu_console_get_head(QemuConsole *con);
6f90f3d7	393	QemuUIInfo qemu_console_get_ui_info(QemuConsole con);
d4c85337 GH	394	int qemu_console_get_width(QemuConsole *con, int fallback);
d4c85337 GH	395	int qemu_console_get_height(QemuConsole *con, int fallback);
81c0d5a6	396
87ecb68b	397	void console_select(unsigned int index);
c78f7137 GH	398	void qemu_console_resize(QemuConsole *con, int width, int height);
c78f7137 GH	399	void qemu_console_copy(QemuConsole *con, int src_x, int src_y,
3023f332	400	int dst_x, int dst_y, int w, int h);
c78f7137	401	DisplaySurface qemu_console_surface(QemuConsole con);
87ecb68b	402
cd2bc889 GH	403	/* console-gl.c */
	404	typedef struct ConsoleGLState ConsoleGLState;
	405	#ifdef CONFIG_OPENGL
	406	ConsoleGLState *console_gl_init_context(void);
	407	void console_gl_fini_context(ConsoleGLState *gls);
	408	bool console_gl_check_format(DisplayChangeListener *dcl,
	409	pixman_format_code_t format);
	410	void surface_gl_create_texture(ConsoleGLState *gls,
	411	DisplaySurface *surface);
	412	void surface_gl_update_texture(ConsoleGLState *gls,
	413	DisplaySurface *surface,
	414	int x, int y, int w, int h);
	415	void surface_gl_render_texture(ConsoleGLState *gls,
	416	DisplaySurface *surface);
	417	void surface_gl_destroy_texture(ConsoleGLState *gls,
	418	DisplaySurface *surface);
	419	void surface_gl_setup_viewport(ConsoleGLState *gls,
	420	DisplaySurface *surface,
	421	int ww, int wh);
	422	#endif
	423
87ecb68b	424	/* sdl.c */
476db081	425	#ifdef CONFIG_SDL
0b71a5d5	426	void sdl_display_early_init(int opengl);
87ecb68b	427	void sdl_display_init(DisplayState *ds, int full_screen, int no_frame);
476db081 EH	428	#else
	429	static inline void sdl_display_early_init(int opengl)
	430	{
	431	/* This must never be called if CONFIG_SDL is disabled */
	432	error_report("SDL support is disabled");
	433	abort();
	434	}
	435	static inline void sdl_display_init(DisplayState *ds, int full_screen,
	436	int no_frame)
	437	{
	438	/* This must never be called if CONFIG_SDL is disabled */
	439	error_report("SDL support is disabled");
	440	abort();
	441	}
	442	#endif
87ecb68b PB	443
87ecb68b PB	444	/* cocoa.m */
e35ee7c1	445	#ifdef CONFIG_COCOA
87ecb68b	446	void cocoa_display_init(DisplayState *ds, int full_screen);
e35ee7c1 EH	447	#else
	448	static inline void cocoa_display_init(DisplayState *ds, int full_screen)
	449	{
	450	/* This must never be called if CONFIG_COCOA is disabled */
	451	error_report("Cocoa support is disabled");
	452	abort();
	453	}
	454	#endif
87ecb68b PB	455
87ecb68b PB	456	/* vnc.c */
14f7143e	457	void vnc_display_init(const char *id);
4db14629	458	void vnc_display_open(const char id, Error *errp);
14f7143e	459	void vnc_display_add_client(const char *id, int csock, bool skipauth);
821601ea	460	#ifdef CONFIG_VNC
14f7143e GH	461	int vnc_display_password(const char id, const char password);
14f7143e GH	462	int vnc_display_pw_expire(const char *id, time_t expires);
70b94331	463	QemuOpts vnc_parse(const char str, Error **errp);
28d0de7a	464	int vnc_init_func(void opaque, QemuOpts opts, Error **errp);
821601ea	465	#else
14f7143e	466	static inline int vnc_display_password(const char id, const char password)
821601ea	467	{
821601ea JS	468	return -ENODEV;
821601ea JS	469	}
14f7143e	470	static inline int vnc_display_pw_expire(const char *id, time_t expires)
821601ea	471	{
821601ea JS	472	return -ENODEV;
821601ea JS	473	};
f8c75b24 EH	474	static inline QemuOpts vnc_parse(const char str, Error **errp)
	475	{
	476	error_setg(errp, "VNC support is disabled");
	477	return NULL;
	478	}
	479	static inline int vnc_init_func(void opaque, QemuOpts opts, Error **errp)
	480	{
	481	error_setg(errp, "VNC support is disabled");
	482	return -1;
	483	}
821601ea	484	#endif
87ecb68b	485
4d3b6f6e	486	/* curses.c */
674ec686	487	#ifdef CONFIG_CURSES
4d3b6f6e	488	void curses_display_init(DisplayState *ds, int full_screen);
674ec686 EH	489	#else
	490	static inline void curses_display_init(DisplayState *ds, int full_screen)
	491	{
	492	/* This must never be called if CONFIG_CURSES is disabled */
	493	error_report("curses support is disabled");
	494	abort();
	495	}
	496	#endif
4d3b6f6e	497
1048c88f	498	/* input.c */
64ffbe04	499	int index_from_key(const char *key, size_t key_length);
1048c88f	500
a4ccabcf	501	/* gtk.c */
19a2c626	502	#ifdef CONFIG_GTK
97edf3bd	503	void early_gtk_display_init(int opengl);
881249c7	504	void gtk_display_init(DisplayState *ds, bool full_screen, bool grab_on_hover);
19a2c626 EH	505	#else
	506	static inline void gtk_display_init(DisplayState *ds, bool full_screen,
	507	bool grab_on_hover)
	508	{
	509	/* This must never be called if CONFIG_GTK is disabled */
	510	error_report("GTK support is disabled");
	511	abort();
	512	}
	513
	514	static inline void early_gtk_display_init(int opengl)
	515	{
	516	/* This must never be called if CONFIG_GTK is disabled */
	517	error_report("GTK support is disabled");
	518	abort();
	519	}
	520	#endif
a4ccabcf	521
87ecb68b	522	#endif