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"
89 kbd_layout_t *kbd_layout;
95 int subauth; /* Used by VeNCrypt */
107 uint32_t dirty_row[VNC_MAX_HEIGHT][VNC_DIRTY_WORDS];
114 uint32_t vnc_encoding;
115 uint8_t tight_quality;
116 uint8_t tight_compression;
121 char challenge[VNC_AUTH_CHALLENGE_SIZE];
123 #ifdef CONFIG_VNC_TLS
129 /* current output mode information */
130 VncWritePixels *write_pixels;
131 VncSendHextileTile *send_hextile_tile;
132 DisplaySurface clientds, serverds;
134 CaptureVoiceOut *audio_cap;
135 struct audsettings as;
137 VncReadEvent *read_handler;
138 size_t read_handler_expect;
140 uint8_t modifiers_state[256];
144 z_stream zlib_stream[4];
150 /*****************************************************************************
152 * Authentication modes
154 *****************************************************************************/
157 VNC_AUTH_INVALID = 0,
165 VNC_AUTH_VENCRYPT = 19
169 VNC_AUTH_VENCRYPT_PLAIN = 256,
170 VNC_AUTH_VENCRYPT_TLSNONE = 257,
171 VNC_AUTH_VENCRYPT_TLSVNC = 258,
172 VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
173 VNC_AUTH_VENCRYPT_X509NONE = 260,
174 VNC_AUTH_VENCRYPT_X509VNC = 261,
175 VNC_AUTH_VENCRYPT_X509PLAIN = 262,
179 /*****************************************************************************
183 *****************************************************************************/
185 #define VNC_ENCODING_RAW 0x00000000
186 #define VNC_ENCODING_COPYRECT 0x00000001
187 #define VNC_ENCODING_RRE 0x00000002
188 #define VNC_ENCODING_CORRE 0x00000004
189 #define VNC_ENCODING_HEXTILE 0x00000005
190 #define VNC_ENCODING_ZLIB 0x00000006
191 #define VNC_ENCODING_TIGHT 0x00000007
192 #define VNC_ENCODING_ZLIBHEX 0x00000008
193 #define VNC_ENCODING_TRLE 0x0000000f
194 #define VNC_ENCODING_ZRLE 0x00000010
195 #define VNC_ENCODING_ZYWRLE 0x00000011
196 #define VNC_ENCODING_COMPRESSLEVEL0 0xFFFFFF00 /* -256 */
197 #define VNC_ENCODING_QUALITYLEVEL0 0xFFFFFFE0 /* -32 */
198 #define VNC_ENCODING_XCURSOR 0xFFFFFF10 /* -240 */
199 #define VNC_ENCODING_RICH_CURSOR 0xFFFFFF11 /* -239 */
200 #define VNC_ENCODING_POINTER_POS 0xFFFFFF18 /* -232 */
201 #define VNC_ENCODING_LASTRECT 0xFFFFFF20 /* -224 */
202 #define VNC_ENCODING_DESKTOPRESIZE 0xFFFFFF21 /* -223 */
203 #define VNC_ENCODING_POINTER_TYPE_CHANGE 0XFFFFFEFF /* -257 */
204 #define VNC_ENCODING_EXT_KEY_EVENT 0XFFFFFEFE /* -258 */
205 #define VNC_ENCODING_AUDIO 0XFFFFFEFD /* -259 */
206 #define VNC_ENCODING_WMVi 0x574D5669
208 /*****************************************************************************
210 * Other tight constants
212 *****************************************************************************/
215 * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
218 #define VNC_TIGHT_CCB_RESET_MASK (0x0f)
219 #define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4)
220 #define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4)
221 #define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4)
222 #define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4)
223 #define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4)
224 #define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
226 /*****************************************************************************
230 *****************************************************************************/
232 #define VNC_FEATURE_RESIZE 0
233 #define VNC_FEATURE_HEXTILE 1
234 #define VNC_FEATURE_POINTER_TYPE_CHANGE 2
235 #define VNC_FEATURE_WMVI 3
236 #define VNC_FEATURE_TIGHT 4
237 #define VNC_FEATURE_ZLIB 5
238 #define VNC_FEATURE_COPYRECT 6
240 #define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE)
241 #define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE)
242 #define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
243 #define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI)
244 #define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT)
245 #define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB)
246 #define VNC_FEATURE_COPYRECT_MASK (1 << VNC_FEATURE_COPYRECT)
249 /*****************************************************************************
253 *****************************************************************************/
255 /* Event loop functions */
256 void vnc_client_read(void *opaque);
257 void vnc_client_write(void *opaque);
260 /* Protocol I/O functions */
261 void vnc_write(VncState *vs, const void *data, size_t len);
262 void vnc_write_u32(VncState *vs, uint32_t value);
263 void vnc_write_s32(VncState *vs, int32_t value);
264 void vnc_write_u16(VncState *vs, uint16_t value);
265 void vnc_write_u8(VncState *vs, uint8_t value);
266 void vnc_flush(VncState *vs);
267 void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting);
270 /* Buffer I/O functions */
271 uint8_t read_u8(uint8_t *data, size_t offset);
272 uint16_t read_u16(uint8_t *data, size_t offset);
273 int32_t read_s32(uint8_t *data, size_t offset);
274 uint32_t read_u32(uint8_t *data, size_t offset);
276 /* Protocol stage functions */
277 void vnc_client_error(VncState *vs);
279 void start_client_init(VncState *vs);
280 void start_auth_vnc(VncState *vs);
282 #endif /* __QEMU_VNC_H */