2 * QEMU VNC display driver
4 * Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws>
5 * Copyright (C) 2006 Fabrice Bellard
6 * Copyright (C) 2009 Red Hat, Inc
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:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
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
30 #include "qemu-common.h"
33 #include "audio/audio.h"
38 // #define _VNC_DEBUG 1
41 #define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
43 #define VNC_DEBUG(fmt, ...) do { } while (0)
46 /*****************************************************************************
48 * Core data structures
50 *****************************************************************************/
59 typedef struct VncState VncState;
61 typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len);
63 typedef void VncWritePixels(VncState *vs, void *data, int size);
65 typedef void VncSendHextileTile(VncState *vs,
66 int x, int y, int w, int h,
69 int *has_bg, int *has_fg);
71 #define VNC_MAX_WIDTH 2048
72 #define VNC_MAX_HEIGHT 2048
73 #define VNC_DIRTY_WORDS (VNC_MAX_WIDTH / (16 * 32))
75 #define VNC_AUTH_CHALLENGE_SIZE 16
77 typedef struct VncDisplay VncDisplay;
81 #include "vnc-auth-vencrypt.h"
83 #ifdef CONFIG_VNC_SASL
84 #include "vnc-auth-sasl.h"
93 kbd_layout_t *kbd_layout;
99 int subauth; /* Used by VeNCrypt */
102 #ifdef CONFIG_VNC_SASL
109 uint32_t dirty[VNC_MAX_HEIGHT][VNC_DIRTY_WORDS];
119 struct VncSurface guest; /* guest visible surface (aka ds->surface) */
120 struct VncSurface server; /* vnc server surface */
129 uint32_t vnc_encoding;
130 uint8_t tight_quality;
131 uint8_t tight_compression;
136 char challenge[VNC_AUTH_CHALLENGE_SIZE];
137 #ifdef CONFIG_VNC_TLS
140 #ifdef CONFIG_VNC_SASL
146 /* current output mode information */
147 VncWritePixels *write_pixels;
148 VncSendHextileTile *send_hextile_tile;
149 DisplaySurface clientds;
151 CaptureVoiceOut *audio_cap;
152 struct audsettings as;
154 VncReadEvent *read_handler;
155 size_t read_handler_expect;
157 uint8_t modifiers_state[256];
161 z_stream zlib_stream[4];
167 /*****************************************************************************
169 * Authentication modes
171 *****************************************************************************/
174 VNC_AUTH_INVALID = 0,
181 VNC_AUTH_TLS = 18, /* Supported in GTK-VNC & VINO */
182 VNC_AUTH_VENCRYPT = 19, /* Supported in GTK-VNC & VeNCrypt */
183 VNC_AUTH_SASL = 20, /* Supported in GTK-VNC & VINO */
187 VNC_AUTH_VENCRYPT_PLAIN = 256,
188 VNC_AUTH_VENCRYPT_TLSNONE = 257,
189 VNC_AUTH_VENCRYPT_TLSVNC = 258,
190 VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
191 VNC_AUTH_VENCRYPT_X509NONE = 260,
192 VNC_AUTH_VENCRYPT_X509VNC = 261,
193 VNC_AUTH_VENCRYPT_X509PLAIN = 262,
194 VNC_AUTH_VENCRYPT_X509SASL = 263,
195 VNC_AUTH_VENCRYPT_TLSSASL = 264,
199 /*****************************************************************************
203 *****************************************************************************/
205 #define VNC_ENCODING_RAW 0x00000000
206 #define VNC_ENCODING_COPYRECT 0x00000001
207 #define VNC_ENCODING_RRE 0x00000002
208 #define VNC_ENCODING_CORRE 0x00000004
209 #define VNC_ENCODING_HEXTILE 0x00000005
210 #define VNC_ENCODING_ZLIB 0x00000006
211 #define VNC_ENCODING_TIGHT 0x00000007
212 #define VNC_ENCODING_ZLIBHEX 0x00000008
213 #define VNC_ENCODING_TRLE 0x0000000f
214 #define VNC_ENCODING_ZRLE 0x00000010
215 #define VNC_ENCODING_ZYWRLE 0x00000011
216 #define VNC_ENCODING_COMPRESSLEVEL0 0xFFFFFF00 /* -256 */
217 #define VNC_ENCODING_QUALITYLEVEL0 0xFFFFFFE0 /* -32 */
218 #define VNC_ENCODING_XCURSOR 0xFFFFFF10 /* -240 */
219 #define VNC_ENCODING_RICH_CURSOR 0xFFFFFF11 /* -239 */
220 #define VNC_ENCODING_POINTER_POS 0xFFFFFF18 /* -232 */
221 #define VNC_ENCODING_LASTRECT 0xFFFFFF20 /* -224 */
222 #define VNC_ENCODING_DESKTOPRESIZE 0xFFFFFF21 /* -223 */
223 #define VNC_ENCODING_POINTER_TYPE_CHANGE 0XFFFFFEFF /* -257 */
224 #define VNC_ENCODING_EXT_KEY_EVENT 0XFFFFFEFE /* -258 */
225 #define VNC_ENCODING_AUDIO 0XFFFFFEFD /* -259 */
226 #define VNC_ENCODING_WMVi 0x574D5669
228 /*****************************************************************************
230 * Other tight constants
232 *****************************************************************************/
235 * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
238 #define VNC_TIGHT_CCB_RESET_MASK (0x0f)
239 #define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4)
240 #define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4)
241 #define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4)
242 #define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4)
243 #define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4)
244 #define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
246 /*****************************************************************************
250 *****************************************************************************/
252 #define VNC_FEATURE_RESIZE 0
253 #define VNC_FEATURE_HEXTILE 1
254 #define VNC_FEATURE_POINTER_TYPE_CHANGE 2
255 #define VNC_FEATURE_WMVI 3
256 #define VNC_FEATURE_TIGHT 4
257 #define VNC_FEATURE_ZLIB 5
258 #define VNC_FEATURE_COPYRECT 6
260 #define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE)
261 #define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE)
262 #define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
263 #define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI)
264 #define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT)
265 #define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB)
266 #define VNC_FEATURE_COPYRECT_MASK (1 << VNC_FEATURE_COPYRECT)
269 /*****************************************************************************
273 *****************************************************************************/
275 /* Event loop functions */
276 void vnc_client_read(void *opaque);
277 void vnc_client_write(void *opaque);
279 long vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
280 long vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);
282 /* Protocol I/O functions */
283 void vnc_write(VncState *vs, const void *data, size_t len);
284 void vnc_write_u32(VncState *vs, uint32_t value);
285 void vnc_write_s32(VncState *vs, int32_t value);
286 void vnc_write_u16(VncState *vs, uint16_t value);
287 void vnc_write_u8(VncState *vs, uint8_t value);
288 void vnc_flush(VncState *vs);
289 void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting);
292 /* Buffer I/O functions */
293 uint8_t read_u8(uint8_t *data, size_t offset);
294 uint16_t read_u16(uint8_t *data, size_t offset);
295 int32_t read_s32(uint8_t *data, size_t offset);
296 uint32_t read_u32(uint8_t *data, size_t offset);
298 /* Protocol stage functions */
299 void vnc_client_error(VncState *vs);
300 int vnc_client_io_error(VncState *vs, int ret, int last_errno);
302 void start_client_init(VncState *vs);
303 void start_auth_vnc(VncState *vs);
305 /* Buffer management */
306 void buffer_reserve(Buffer *buffer, size_t len);
307 int buffer_empty(Buffer *buffer);
308 uint8_t *buffer_end(Buffer *buffer);
309 void buffer_reset(Buffer *buffer);
310 void buffer_append(Buffer *buffer, const void *data, size_t len);
315 char *vnc_socket_local_addr(const char *format, int fd);
316 char *vnc_socket_remote_addr(const char *format, int fd);
318 #endif /* __QEMU_VNC_H */