[qemu.git] / ui / 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 <stdbool.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;
    bool lossy;
#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;
    int client_width;
    int client_height;

    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 */
    int tight_type;
    uint8_t tight_quality;
    uint8_t tight_compression;
    uint8_t tight_pixel24;
    Buffer tight;
    Buffer tight_tmp;
    Buffer tight_zlib;
    Buffer tight_gradient;
#ifdef CONFIG_VNC_JPEG
    Buffer tight_jpeg;
#endif
#ifdef CONFIG_VNC_PNG
    Buffer tight_png;
#endif
    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_TIGHT_PNG            0xFFFFFEFC /* -260 */
#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_TYPE_PNG     (0x0A << 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_TIGHT_PNG                8

#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)
#define VNC_FEATURE_TIGHT_PNG_MASK           (1 << VNC_FEATURE_TIGHT_PNG)


/* 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);

static inline uint32_t vnc_has_feature(VncState *vs, int feature) {
    return (vs->features & (1 << feature));
}

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