[qemu.git] / vnc.h

/*
 * QEMU VNC display driver
 *
 * Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws>
 * Copyright (C) 2006 Fabrice Bellard
 * Copyright (C) 2009 Red Hat, Inc
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#ifndef __QEMU_VNC_H
#define __QEMU_VNC_H

#include "qemu-common.h"
#include "qemu-queue.h"
#include "console.h"
#include "monitor.h"
#include "audio/audio.h"
#include <zlib.h>

#include "keymaps.h"

// #define _VNC_DEBUG 1

#ifdef _VNC_DEBUG
#define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
#else
#define VNC_DEBUG(fmt, ...) do { } while (0)
#endif

/*****************************************************************************
 *
 * Core data structures
 *
 *****************************************************************************/

typedef struct Buffer
{
    size_t capacity;
    size_t offset;
    uint8_t *buffer;
} Buffer;

typedef struct VncState VncState;

typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len);

typedef void VncWritePixels(VncState *vs, struct PixelFormat *pf, void *data, int size);

typedef void VncSendHextileTile(VncState *vs,
                                int x, int y, int w, int h,
                                void *last_bg,
                                void *last_fg,
                                int *has_bg, int *has_fg);

#define VNC_MAX_WIDTH 2560
#define VNC_MAX_HEIGHT 2048
#define VNC_DIRTY_WORDS (VNC_MAX_WIDTH / (16 * 32))

#define VNC_AUTH_CHALLENGE_SIZE 16

typedef struct VncDisplay VncDisplay;

#ifdef CONFIG_VNC_TLS
#include "vnc-tls.h"
#include "vnc-auth-vencrypt.h"
#endif
#ifdef CONFIG_VNC_SASL
#include "vnc-auth-sasl.h"
#endif

struct VncSurface
{
    uint32_t dirty[VNC_MAX_HEIGHT][VNC_DIRTY_WORDS];
    DisplaySurface *ds;
};

struct VncDisplay
{
    QTAILQ_HEAD(, VncState) clients;
    QEMUTimer *timer;
    int timer_interval;
    int lsock;
    DisplayState *ds;
    kbd_layout_t *kbd_layout;
    int lock_key_sync;

    QEMUCursor *cursor;
    int cursor_msize;
    uint8_t *cursor_mask;

    struct VncSurface guest;   /* guest visible surface (aka ds->surface) */
    DisplaySurface *server;  /* vnc server surface */

    char *display;
    char *password;
    int auth;
#ifdef CONFIG_VNC_TLS
    int subauth; /* Used by VeNCrypt */
    VncDisplayTLS tls;
#endif
#ifdef CONFIG_VNC_SASL
    VncDisplaySASL sasl;
#endif
};

struct VncState
{
    int csock;

    DisplayState *ds;
    uint32_t dirty[VNC_MAX_HEIGHT][VNC_DIRTY_WORDS];

    VncDisplay *vd;
    int need_update;
    int force_update;
    uint32_t features;
    int absolute;
    int last_x;
    int last_y;

    uint32_t vnc_encoding;

    int major;
    int minor;

    char challenge[VNC_AUTH_CHALLENGE_SIZE];
#ifdef CONFIG_VNC_TLS
    VncStateTLS tls;
#endif
#ifdef CONFIG_VNC_SASL
    VncStateSASL sasl;
#endif

    QObject *info;

    Buffer output;
    Buffer input;
    /* current output mode information */
    VncWritePixels *write_pixels;
    DisplaySurface clientds;

    CaptureVoiceOut *audio_cap;
    struct audsettings as;

    VncReadEvent *read_handler;
    size_t read_handler_expect;
    /* input */
    uint8_t modifiers_state[256];
    QEMUPutLEDEntry *led;

    /* Encoding specific */

    /* Tight */
    uint8_t tight_quality;
    uint8_t tight_compression;
    uint8_t tight_pixel24;
    Buffer tight;
    Buffer tight_tmp;
    Buffer tight_zlib;
    int tight_levels[4];
    z_stream tight_stream[4];

    /* Hextile */
    VncSendHextileTile *send_hextile_tile;

    /* Zlib */
    Buffer zlib;
    Buffer zlib_tmp;
    z_stream zlib_stream;
    int zlib_level;

    Notifier mouse_mode_notifier;

    QTAILQ_ENTRY(VncState) next;
};


/*****************************************************************************
 *
 * Authentication modes
 *
 *****************************************************************************/

enum {
    VNC_AUTH_INVALID = 0,
    VNC_AUTH_NONE = 1,
    VNC_AUTH_VNC = 2,
    VNC_AUTH_RA2 = 5,
    VNC_AUTH_RA2NE = 6,
    VNC_AUTH_TIGHT = 16,
    VNC_AUTH_ULTRA = 17,
    VNC_AUTH_TLS = 18,      /* Supported in GTK-VNC & VINO */
    VNC_AUTH_VENCRYPT = 19, /* Supported in GTK-VNC & VeNCrypt */
    VNC_AUTH_SASL = 20,     /* Supported in GTK-VNC & VINO */
};

enum {
    VNC_AUTH_VENCRYPT_PLAIN = 256,
    VNC_AUTH_VENCRYPT_TLSNONE = 257,
    VNC_AUTH_VENCRYPT_TLSVNC = 258,
    VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
    VNC_AUTH_VENCRYPT_X509NONE = 260,
    VNC_AUTH_VENCRYPT_X509VNC = 261,
    VNC_AUTH_VENCRYPT_X509PLAIN = 262,
    VNC_AUTH_VENCRYPT_X509SASL = 263,
    VNC_AUTH_VENCRYPT_TLSSASL = 264,
};


/*****************************************************************************
 *
 * Encoding types
 *
 *****************************************************************************/

#define VNC_ENCODING_RAW                  0x00000000
#define VNC_ENCODING_COPYRECT             0x00000001
#define VNC_ENCODING_RRE                  0x00000002
#define VNC_ENCODING_CORRE                0x00000004
#define VNC_ENCODING_HEXTILE              0x00000005
#define VNC_ENCODING_ZLIB                 0x00000006
#define VNC_ENCODING_TIGHT                0x00000007
#define VNC_ENCODING_ZLIBHEX              0x00000008
#define VNC_ENCODING_TRLE                 0x0000000f
#define VNC_ENCODING_ZRLE                 0x00000010
#define VNC_ENCODING_ZYWRLE               0x00000011
#define VNC_ENCODING_COMPRESSLEVEL0       0xFFFFFF00 /* -256 */
#define VNC_ENCODING_QUALITYLEVEL0        0xFFFFFFE0 /* -32  */
#define VNC_ENCODING_XCURSOR              0xFFFFFF10 /* -240 */
#define VNC_ENCODING_RICH_CURSOR          0xFFFFFF11 /* -239 */
#define VNC_ENCODING_POINTER_POS          0xFFFFFF18 /* -232 */
#define VNC_ENCODING_LASTRECT             0xFFFFFF20 /* -224 */
#define VNC_ENCODING_DESKTOPRESIZE        0xFFFFFF21 /* -223 */
#define VNC_ENCODING_POINTER_TYPE_CHANGE  0XFFFFFEFF /* -257 */
#define VNC_ENCODING_EXT_KEY_EVENT        0XFFFFFEFE /* -258 */
#define VNC_ENCODING_AUDIO                0XFFFFFEFD /* -259 */
#define VNC_ENCODING_WMVi                 0x574D5669

/*****************************************************************************
 *
 * Other tight constants
 *
 *****************************************************************************/

/*
 * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
 */

#define VNC_TIGHT_CCB_RESET_MASK   (0x0f)
#define VNC_TIGHT_CCB_TYPE_MASK    (0x0f << 4)
#define VNC_TIGHT_CCB_TYPE_FILL    (0x08 << 4)
#define VNC_TIGHT_CCB_TYPE_JPEG    (0x09 << 4)
#define VNC_TIGHT_CCB_BASIC_MAX    (0x07 << 4)
#define VNC_TIGHT_CCB_BASIC_ZLIB   (0x03 << 4)
#define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)

/*****************************************************************************
 *
 * Features
 *
 *****************************************************************************/

#define VNC_FEATURE_RESIZE                   0
#define VNC_FEATURE_HEXTILE                  1
#define VNC_FEATURE_POINTER_TYPE_CHANGE      2
#define VNC_FEATURE_WMVI                     3
#define VNC_FEATURE_TIGHT                    4
#define VNC_FEATURE_ZLIB                     5
#define VNC_FEATURE_COPYRECT                 6
#define VNC_FEATURE_RICH_CURSOR              7

#define VNC_FEATURE_RESIZE_MASK              (1 << VNC_FEATURE_RESIZE)
#define VNC_FEATURE_HEXTILE_MASK             (1 << VNC_FEATURE_HEXTILE)
#define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
#define VNC_FEATURE_WMVI_MASK                (1 << VNC_FEATURE_WMVI)
#define VNC_FEATURE_TIGHT_MASK               (1 << VNC_FEATURE_TIGHT)
#define VNC_FEATURE_ZLIB_MASK                (1 << VNC_FEATURE_ZLIB)
#define VNC_FEATURE_COPYRECT_MASK            (1 << VNC_FEATURE_COPYRECT)
#define VNC_FEATURE_RICH_CURSOR_MASK         (1 << VNC_FEATURE_RICH_CURSOR)


/* Client -> Server message IDs */
#define VNC_MSG_CLIENT_SET_PIXEL_FORMAT           0
#define VNC_MSG_CLIENT_SET_ENCODINGS              2
#define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3
#define VNC_MSG_CLIENT_KEY_EVENT                  4
#define VNC_MSG_CLIENT_POINTER_EVENT              5
#define VNC_MSG_CLIENT_CUT_TEXT                   6
#define VNC_MSG_CLIENT_VMWARE_0                   127
#define VNC_MSG_CLIENT_CALL_CONTROL               249
#define VNC_MSG_CLIENT_XVP                        250
#define VNC_MSG_CLIENT_SET_DESKTOP_SIZE           251
#define VNC_MSG_CLIENT_TIGHT                      252
#define VNC_MSG_CLIENT_GII                        253
#define VNC_MSG_CLIENT_VMWARE_1                   254
#define VNC_MSG_CLIENT_QEMU                       255

/* Server -> Client message IDs */
#define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE         0
#define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES     1
#define VNC_MSG_SERVER_BELL                       2
#define VNC_MSG_SERVER_CUT_TEXT                   3
#define VNC_MSG_SERVER_VMWARE_0                   127
#define VNC_MSG_SERVER_CALL_CONTROL               249
#define VNC_MSG_SERVER_XVP                        250
#define VNC_MSG_SERVER_TIGHT                      252
#define VNC_MSG_SERVER_GII                        253
#define VNC_MSG_SERVER_VMWARE_1                   254
#define VNC_MSG_SERVER_QEMU                       255


/* QEMU client -> server message IDs */
#define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT         0
#define VNC_MSG_CLIENT_QEMU_AUDIO                 1

/* QEMU server -> client message IDs */
#define VNC_MSG_SERVER_QEMU_AUDIO                 1


/* QEMU client -> server audio message IDs */
#define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE          0
#define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE         1
#define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT      2

/* QEMU server -> client audio message IDs */
#define VNC_MSG_SERVER_QEMU_AUDIO_END             0
#define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN           1
#define VNC_MSG_SERVER_QEMU_AUDIO_DATA            2


/*****************************************************************************
 *
 * Internal APIs
 *
 *****************************************************************************/

/* Event loop functions */
void vnc_client_read(void *opaque);
void vnc_client_write(void *opaque);

long vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
long vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);

/* Protocol I/O functions */
void vnc_write(VncState *vs, const void *data, size_t len);
void vnc_write_u32(VncState *vs, uint32_t value);
void vnc_write_s32(VncState *vs, int32_t value);
void vnc_write_u16(VncState *vs, uint16_t value);
void vnc_write_u8(VncState *vs, uint8_t value);
void vnc_flush(VncState *vs);
void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting);


/* Buffer I/O functions */
uint8_t read_u8(uint8_t *data, size_t offset);
uint16_t read_u16(uint8_t *data, size_t offset);
int32_t read_s32(uint8_t *data, size_t offset);
uint32_t read_u32(uint8_t *data, size_t offset);

/* Protocol stage functions */
void vnc_client_error(VncState *vs);
int vnc_client_io_error(VncState *vs, int ret, int last_errno);

void start_client_init(VncState *vs);
void start_auth_vnc(VncState *vs);

/* Buffer management */
void buffer_reserve(Buffer *buffer, size_t len);
int buffer_empty(Buffer *buffer);
uint8_t *buffer_end(Buffer *buffer);
void buffer_reset(Buffer *buffer);
void buffer_free(Buffer *buffer);
void buffer_append(Buffer *buffer, const void *data, size_t len);


/* Misc helpers */

char *vnc_socket_local_addr(const char *format, int fd);
char *vnc_socket_remote_addr(const char *format, int fd);

/* Framebuffer */
void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h,
                            int32_t encoding);

void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v);

/* Encodings */
int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);

int vnc_hextile_send_framebuffer_update(VncState *vs, int x,
                                         int y, int w, int h);
void vnc_hextile_set_pixel_conversion(VncState *vs, int generic);

void *vnc_zlib_zalloc(void *x, unsigned items, unsigned size);
void vnc_zlib_zfree(void *x, void *addr);
int vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
void vnc_zlib_clear(VncState *vs);


int vnc_tight_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
void vnc_tight_clear(VncState *vs);

#endif /* __QEMU_VNC_H */
Commit	Line	Data
19a490bf AL	1	/*
	2	* QEMU VNC display driver
	3	*
	4	* Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws>
	5	* Copyright (C) 2006 Fabrice Bellard
	6	* Copyright (C) 2009 Red Hat, Inc
	7	*
	8	* Permission is hereby granted, free of charge, to any person obtaining a copy
	9	* of this software and associated documentation files (the "Software"), to deal
	10	* in the Software without restriction, including without limitation the rights
	11	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	12	* copies of the Software, and to permit persons to whom the Software is
	13	* furnished to do so, subject to the following conditions:
	14	*
	15	* The above copyright notice and this permission notice shall be included in
	16	* all copies or substantial portions of the Software.
	17	*
	18	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	19	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	20	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
	21	* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	22	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	23	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
	24	* THE SOFTWARE.
	25	*/
	26
	27	#ifndef __QEMU_VNC_H
	28	#define __QEMU_VNC_H
	29
	30	#include "qemu-common.h"
41b4bef6	31	#include "qemu-queue.h"
19a490bf AL	32	#include "console.h"
	33	#include "monitor.h"
	34	#include "audio/audio.h"
	35	#include <zlib.h>
	36
19a490bf AL	37	#include "keymaps.h"
19a490bf AL	38
5fb6c7a8 AL	39	// #define _VNC_DEBUG 1
	40
	41	#ifdef _VNC_DEBUG
	42	#define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
	43	#else
	44	#define VNC_DEBUG(fmt, ...) do { } while (0)
	45	#endif
	46
19a490bf AL	47	/*****************************************************************************
	48	*
	49	* Core data structures
	50	*
	51	*****************************************************************************/
	52
	53	typedef struct Buffer
	54	{
	55	size_t capacity;
	56	size_t offset;
	57	uint8_t *buffer;
	58	} Buffer;
	59
	60	typedef struct VncState VncState;
	61
	62	typedef int VncReadEvent(VncState vs, uint8_t data, size_t len);
	63
d467b679	64	typedef void VncWritePixels(VncState vs, struct PixelFormat pf, void *data, int size);
19a490bf AL	65
	66	typedef void VncSendHextileTile(VncState *vs,
	67	int x, int y, int w, int h,
	68	void *last_bg,
	69	void *last_fg,
	70	int has_bg, int has_fg);
	71
3f54bfbf	72	#define VNC_MAX_WIDTH 2560
19a490bf AL	73	#define VNC_MAX_HEIGHT 2048
	74	#define VNC_DIRTY_WORDS (VNC_MAX_WIDTH / (16 * 32))
	75
	76	#define VNC_AUTH_CHALLENGE_SIZE 16
	77
	78	typedef struct VncDisplay VncDisplay;
	79
5fb6c7a8 AL	80	#ifdef CONFIG_VNC_TLS
	81	#include "vnc-tls.h"
	82	#include "vnc-auth-vencrypt.h"
	83	#endif
2f9606b3 AL	84	#ifdef CONFIG_VNC_SASL
	85	#include "vnc-auth-sasl.h"
	86	#endif
	87
1fc62412 SS	88	struct VncSurface
	89	{
	90	uint32_t dirty[VNC_MAX_HEIGHT][VNC_DIRTY_WORDS];
	91	DisplaySurface *ds;
	92	};
5fb6c7a8	93
19a490bf AL	94	struct VncDisplay
19a490bf AL	95	{
41b4bef6	96	QTAILQ_HEAD(, VncState) clients;
703bc68f	97	QEMUTimer *timer;
2430ffe4	98	int timer_interval;
19a490bf AL	99	int lsock;
19a490bf AL	100	DisplayState *ds;
c227f099	101	kbd_layout_t *kbd_layout;
3a0558b5	102	int lock_key_sync;
19a490bf	103
d467b679 GH	104	QEMUCursor *cursor;
	105	int cursor_msize;
	106	uint8_t *cursor_mask;
	107
1fc62412 SS	108	struct VncSurface guest; /* guest visible surface (aka ds->surface) */
	109	DisplaySurface server; / vnc server surface */
	110
19a490bf AL	111	char *display;
	112	char *password;
	113	int auth;
	114	#ifdef CONFIG_VNC_TLS
5fb6c7a8 AL	115	int subauth; /* Used by VeNCrypt */
5fb6c7a8 AL	116	VncDisplayTLS tls;
19a490bf	117	#endif
76655d6d AL	118	#ifdef CONFIG_VNC_SASL
	119	VncDisplaySASL sasl;
	120	#endif
19a490bf AL	121	};
	122
	123	struct VncState
	124	{
19a490bf	125	int csock;
6baebed7	126
19a490bf	127	DisplayState *ds;
1fc62412	128	uint32_t dirty[VNC_MAX_HEIGHT][VNC_DIRTY_WORDS];
6baebed7	129
19a490bf AL	130	VncDisplay *vd;
19a490bf AL	131	int need_update;
c522d0e2	132	int force_update;
19a490bf AL	133	uint32_t features;
	134	int absolute;
	135	int last_x;
	136	int last_y;
	137
	138	uint32_t vnc_encoding;
19a490bf AL	139
	140	int major;
	141	int minor;
	142
	143	char challenge[VNC_AUTH_CHALLENGE_SIZE];
19a490bf	144	#ifdef CONFIG_VNC_TLS
5fb6c7a8	145	VncStateTLS tls;
19a490bf	146	#endif
2f9606b3 AL	147	#ifdef CONFIG_VNC_SASL
	148	VncStateSASL sasl;
	149	#endif
19a490bf	150
4a80dba3 LC	151	QObject *info;
4a80dba3 LC	152
19a490bf AL	153	Buffer output;
	154	Buffer input;
	155	/* current output mode information */
	156	VncWritePixels *write_pixels;
6baebed7	157	DisplaySurface clientds;
19a490bf AL	158
	159	CaptureVoiceOut *audio_cap;
	160	struct audsettings as;
	161
	162	VncReadEvent *read_handler;
	163	size_t read_handler_expect;
	164	/* input */
	165	uint8_t modifiers_state[256];
7ffb82ca	166	QEMUPutLEDEntry *led;
19a490bf	167
70a4568f CC	168	/* Encoding specific */
	169
	170	/* Tight */
	171	uint8_t tight_quality;
	172	uint8_t tight_compression;
380282b0 CC	173	uint8_t tight_pixel24;
	174	Buffer tight;
	175	Buffer tight_tmp;
	176	Buffer tight_zlib;
	177	int tight_levels[4];
	178	z_stream tight_stream[4];
70a4568f CC	179
	180	/* Hextile */
	181	VncSendHextileTile *send_hextile_tile;
	182
	183	/* Zlib */
19a490bf AL	184	Buffer zlib;
19a490bf AL	185	Buffer zlib_tmp;
b05ad290	186	z_stream zlib_stream;
9f643ec0	187	int zlib_level;
19a490bf	188
37c34d9d AL	189	Notifier mouse_mode_notifier;
37c34d9d AL	190
41b4bef6	191	QTAILQ_ENTRY(VncState) next;
19a490bf AL	192	};
19a490bf AL	193
e06679fb AL	194
	195	/*****************************************************************************
	196	*
	197	* Authentication modes
	198	*
	199	*****************************************************************************/
	200
	201	enum {
	202	VNC_AUTH_INVALID = 0,
	203	VNC_AUTH_NONE = 1,
	204	VNC_AUTH_VNC = 2,
	205	VNC_AUTH_RA2 = 5,
	206	VNC_AUTH_RA2NE = 6,
	207	VNC_AUTH_TIGHT = 16,
	208	VNC_AUTH_ULTRA = 17,
2f9606b3 AL	209	VNC_AUTH_TLS = 18, /* Supported in GTK-VNC & VINO */
	210	VNC_AUTH_VENCRYPT = 19, /* Supported in GTK-VNC & VeNCrypt */
	211	VNC_AUTH_SASL = 20, /* Supported in GTK-VNC & VINO */
e06679fb AL	212	};
e06679fb AL	213
e06679fb AL	214	enum {
	215	VNC_AUTH_VENCRYPT_PLAIN = 256,
	216	VNC_AUTH_VENCRYPT_TLSNONE = 257,
	217	VNC_AUTH_VENCRYPT_TLSVNC = 258,
	218	VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
	219	VNC_AUTH_VENCRYPT_X509NONE = 260,
	220	VNC_AUTH_VENCRYPT_X509VNC = 261,
	221	VNC_AUTH_VENCRYPT_X509PLAIN = 262,
2f9606b3 AL	222	VNC_AUTH_VENCRYPT_X509SASL = 263,
2f9606b3 AL	223	VNC_AUTH_VENCRYPT_TLSSASL = 264,
e06679fb AL	224	};
e06679fb AL	225
e06679fb AL	226
	227	/*****************************************************************************
	228	*
	229	* Encoding types
	230	*
	231	*****************************************************************************/
	232
	233	#define VNC_ENCODING_RAW 0x00000000
	234	#define VNC_ENCODING_COPYRECT 0x00000001
	235	#define VNC_ENCODING_RRE 0x00000002
	236	#define VNC_ENCODING_CORRE 0x00000004
	237	#define VNC_ENCODING_HEXTILE 0x00000005
	238	#define VNC_ENCODING_ZLIB 0x00000006
	239	#define VNC_ENCODING_TIGHT 0x00000007
	240	#define VNC_ENCODING_ZLIBHEX 0x00000008
	241	#define VNC_ENCODING_TRLE 0x0000000f
	242	#define VNC_ENCODING_ZRLE 0x00000010
	243	#define VNC_ENCODING_ZYWRLE 0x00000011
	244	#define VNC_ENCODING_COMPRESSLEVEL0 0xFFFFFF00 /* -256 */
	245	#define VNC_ENCODING_QUALITYLEVEL0 0xFFFFFFE0 /* -32 */
	246	#define VNC_ENCODING_XCURSOR 0xFFFFFF10 /* -240 */
	247	#define VNC_ENCODING_RICH_CURSOR 0xFFFFFF11 /* -239 */
	248	#define VNC_ENCODING_POINTER_POS 0xFFFFFF18 /* -232 */
	249	#define VNC_ENCODING_LASTRECT 0xFFFFFF20 /* -224 */
	250	#define VNC_ENCODING_DESKTOPRESIZE 0xFFFFFF21 /* -223 */
	251	#define VNC_ENCODING_POINTER_TYPE_CHANGE 0XFFFFFEFF /* -257 */
	252	#define VNC_ENCODING_EXT_KEY_EVENT 0XFFFFFEFE /* -258 */
	253	#define VNC_ENCODING_AUDIO 0XFFFFFEFD /* -259 */
	254	#define VNC_ENCODING_WMVi 0x574D5669
	255
	256	/*****************************************************************************
	257	*
	258	* Other tight constants
	259	*
	260	*****************************************************************************/
	261
	262	/*
	263	* Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
	264	*/
	265
	266	#define VNC_TIGHT_CCB_RESET_MASK (0x0f)
	267	#define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4)
	268	#define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4)
	269	#define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4)
	270	#define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4)
	271	#define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4)
	272	#define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
	273
	274	/*****************************************************************************
	275	*
	276	* Features
	277	*
	278	*****************************************************************************/
	279
	280	#define VNC_FEATURE_RESIZE 0
	281	#define VNC_FEATURE_HEXTILE 1
	282	#define VNC_FEATURE_POINTER_TYPE_CHANGE 2
	283	#define VNC_FEATURE_WMVI 3
	284	#define VNC_FEATURE_TIGHT 4
	285	#define VNC_FEATURE_ZLIB 5
753b4053	286	#define VNC_FEATURE_COPYRECT 6
d467b679	287	#define VNC_FEATURE_RICH_CURSOR 7
e06679fb AL	288
	289	#define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE)
	290	#define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE)
	291	#define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
	292	#define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI)
	293	#define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT)
	294	#define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB)
753b4053	295	#define VNC_FEATURE_COPYRECT_MASK (1 << VNC_FEATURE_COPYRECT)
d467b679	296	#define VNC_FEATURE_RICH_CURSOR_MASK (1 << VNC_FEATURE_RICH_CURSOR)
e06679fb	297
5fb6c7a8	298
46a183da DB	299	/* Client -> Server message IDs */
	300	#define VNC_MSG_CLIENT_SET_PIXEL_FORMAT 0
	301	#define VNC_MSG_CLIENT_SET_ENCODINGS 2
	302	#define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3
	303	#define VNC_MSG_CLIENT_KEY_EVENT 4
	304	#define VNC_MSG_CLIENT_POINTER_EVENT 5
	305	#define VNC_MSG_CLIENT_CUT_TEXT 6
	306	#define VNC_MSG_CLIENT_VMWARE_0 127
	307	#define VNC_MSG_CLIENT_CALL_CONTROL 249
	308	#define VNC_MSG_CLIENT_XVP 250
	309	#define VNC_MSG_CLIENT_SET_DESKTOP_SIZE 251
	310	#define VNC_MSG_CLIENT_TIGHT 252
	311	#define VNC_MSG_CLIENT_GII 253
	312	#define VNC_MSG_CLIENT_VMWARE_1 254
	313	#define VNC_MSG_CLIENT_QEMU 255
	314
	315	/* Server -> Client message IDs */
	316	#define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE 0
	317	#define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES 1
	318	#define VNC_MSG_SERVER_BELL 2
	319	#define VNC_MSG_SERVER_CUT_TEXT 3
	320	#define VNC_MSG_SERVER_VMWARE_0 127
	321	#define VNC_MSG_SERVER_CALL_CONTROL 249
	322	#define VNC_MSG_SERVER_XVP 250
	323	#define VNC_MSG_SERVER_TIGHT 252
	324	#define VNC_MSG_SERVER_GII 253
	325	#define VNC_MSG_SERVER_VMWARE_1 254
	326	#define VNC_MSG_SERVER_QEMU 255
	327
	328
	329
	330	/* QEMU client -> server message IDs */
	331	#define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT 0
	332	#define VNC_MSG_CLIENT_QEMU_AUDIO 1
	333
	334	/* QEMU server -> client message IDs */
	335	#define VNC_MSG_SERVER_QEMU_AUDIO 1
	336
	337
	338
	339	/* QEMU client -> server audio message IDs */
	340	#define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE 0
	341	#define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE 1
	342	#define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT 2
	343
	344	/* QEMU server -> client audio message IDs */
	345	#define VNC_MSG_SERVER_QEMU_AUDIO_END 0
	346	#define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN 1
	347	#define VNC_MSG_SERVER_QEMU_AUDIO_DATA 2
	348
	349
5fb6c7a8 AL	350	/*****************************************************************************
	351	*
	352	* Internal APIs
	353	*
	354	*****************************************************************************/
	355
	356	/* Event loop functions */
	357	void vnc_client_read(void *opaque);
	358	void vnc_client_write(void *opaque);
	359
2f9606b3 AL	360	long vnc_client_read_buf(VncState vs, uint8_t data, size_t datalen);
2f9606b3 AL	361	long vnc_client_write_buf(VncState vs, const uint8_t data, size_t datalen);
5fb6c7a8 AL	362
	363	/* Protocol I/O functions */
	364	void vnc_write(VncState vs, const void data, size_t len);
	365	void vnc_write_u32(VncState *vs, uint32_t value);
	366	void vnc_write_s32(VncState *vs, int32_t value);
	367	void vnc_write_u16(VncState *vs, uint16_t value);
	368	void vnc_write_u8(VncState *vs, uint8_t value);
	369	void vnc_flush(VncState *vs);
	370	void vnc_read_when(VncState vs, VncReadEvent func, size_t expecting);
	371
	372
	373	/* Buffer I/O functions */
	374	uint8_t read_u8(uint8_t *data, size_t offset);
	375	uint16_t read_u16(uint8_t *data, size_t offset);
	376	int32_t read_s32(uint8_t *data, size_t offset);
	377	uint32_t read_u32(uint8_t *data, size_t offset);
	378
	379	/* Protocol stage functions */
	380	void vnc_client_error(VncState *vs);
2f9606b3	381	int vnc_client_io_error(VncState *vs, int ret, int last_errno);
5fb6c7a8 AL	382
	383	void start_client_init(VncState *vs);
	384	void start_auth_vnc(VncState *vs);
	385
2f9606b3 AL	386	/* Buffer management */
	387	void buffer_reserve(Buffer *buffer, size_t len);
	388	int buffer_empty(Buffer *buffer);
	389	uint8_t buffer_end(Buffer buffer);
	390	void buffer_reset(Buffer *buffer);
5d418e3b	391	void buffer_free(Buffer *buffer);
2f9606b3 AL	392	void buffer_append(Buffer buffer, const void data, size_t len);
	393
	394
	395	/* Misc helpers */
	396
	397	char vnc_socket_local_addr(const char format, int fd);
	398	char vnc_socket_remote_addr(const char format, int fd);
	399
70a4568f CC	400	/* Framebuffer */
	401	void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h,
	402	int32_t encoding);
	403
	404	void vnc_convert_pixel(VncState vs, uint8_t buf, uint32_t v);
	405
	406	/* Encodings */
a885211e	407	int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
70a4568f	408
a885211e	409	int vnc_hextile_send_framebuffer_update(VncState *vs, int x,
70a4568f CC	410	int y, int w, int h);
	411	void vnc_hextile_set_pixel_conversion(VncState *vs, int generic);
	412
380282b0 CC	413	void vnc_zlib_zalloc(void x, unsigned items, unsigned size);
380282b0 CC	414	void vnc_zlib_zfree(void x, void addr);
a885211e	415	int vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
161c4f20	416	void vnc_zlib_clear(VncState *vs);
70a4568f	417
380282b0 CC	418
	419	int vnc_tight_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
	420	void vnc_tight_clear(VncState *vs);
	421
19a490bf	422	#endif /* __QEMU_VNC_H */