[MISC] Updated maintainer
[qemu/mini2440/sniper_sniper_test.git] / vnc.h
blob8b6bc5e1289b512c756f7f8aa97ad64f292f991b
1 /*
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
24 * THE SOFTWARE.
27 #ifndef __QEMU_VNC_H
28 #define __QEMU_VNC_H
30 #include "qemu-common.h"
31 #include "console.h"
32 #include "monitor.h"
33 #include "audio/audio.h"
34 #include <zlib.h>
36 #include "keymaps.h"
38 // #define _VNC_DEBUG 1
40 #ifdef _VNC_DEBUG
41 #define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
42 #else
43 #define VNC_DEBUG(fmt, ...) do { } while (0)
44 #endif
46 /*****************************************************************************
48 * Core data structures
50 *****************************************************************************/
52 typedef struct Buffer
54 size_t capacity;
55 size_t offset;
56 uint8_t *buffer;
57 } Buffer;
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,
67 void *last_bg,
68 void *last_fg,
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;
79 #ifdef CONFIG_VNC_TLS
80 #include "vnc-tls.h"
81 #include "vnc-auth-vencrypt.h"
82 #endif
83 #ifdef CONFIG_VNC_SASL
84 #include "vnc-auth-sasl.h"
85 #endif
88 struct VncDisplay
90 int lsock;
91 DisplayState *ds;
92 VncState *clients;
93 kbd_layout_t *kbd_layout;
95 char *display;
96 char *password;
97 int auth;
98 #ifdef CONFIG_VNC_TLS
99 int subauth; /* Used by VeNCrypt */
100 VncDisplayTLS tls;
101 #endif
102 #ifdef CONFIG_VNC_SASL
103 VncDisplaySASL sasl;
104 #endif
107 struct VncState
109 QEMUTimer *timer;
110 int csock;
111 DisplayState *ds;
112 VncDisplay *vd;
113 int need_update;
114 uint32_t dirty_row[VNC_MAX_HEIGHT][VNC_DIRTY_WORDS];
115 char *old_data;
116 uint32_t features;
117 int absolute;
118 int last_x;
119 int last_y;
121 uint32_t vnc_encoding;
122 uint8_t tight_quality;
123 uint8_t tight_compression;
125 int major;
126 int minor;
128 char challenge[VNC_AUTH_CHALLENGE_SIZE];
129 #ifdef CONFIG_VNC_TLS
130 VncStateTLS tls;
131 #endif
132 #ifdef CONFIG_VNC_SASL
133 VncStateSASL sasl;
134 #endif
136 Buffer output;
137 Buffer input;
138 /* current output mode information */
139 VncWritePixels *write_pixels;
140 VncSendHextileTile *send_hextile_tile;
141 DisplaySurface clientds, serverds;
143 CaptureVoiceOut *audio_cap;
144 struct audsettings as;
146 VncReadEvent *read_handler;
147 size_t read_handler_expect;
148 /* input */
149 uint8_t modifiers_state[256];
151 Buffer zlib;
152 Buffer zlib_tmp;
153 z_stream zlib_stream[4];
155 VncState *next;
159 /*****************************************************************************
161 * Authentication modes
163 *****************************************************************************/
165 enum {
166 VNC_AUTH_INVALID = 0,
167 VNC_AUTH_NONE = 1,
168 VNC_AUTH_VNC = 2,
169 VNC_AUTH_RA2 = 5,
170 VNC_AUTH_RA2NE = 6,
171 VNC_AUTH_TIGHT = 16,
172 VNC_AUTH_ULTRA = 17,
173 VNC_AUTH_TLS = 18, /* Supported in GTK-VNC & VINO */
174 VNC_AUTH_VENCRYPT = 19, /* Supported in GTK-VNC & VeNCrypt */
175 VNC_AUTH_SASL = 20, /* Supported in GTK-VNC & VINO */
178 enum {
179 VNC_AUTH_VENCRYPT_PLAIN = 256,
180 VNC_AUTH_VENCRYPT_TLSNONE = 257,
181 VNC_AUTH_VENCRYPT_TLSVNC = 258,
182 VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
183 VNC_AUTH_VENCRYPT_X509NONE = 260,
184 VNC_AUTH_VENCRYPT_X509VNC = 261,
185 VNC_AUTH_VENCRYPT_X509PLAIN = 262,
186 VNC_AUTH_VENCRYPT_X509SASL = 263,
187 VNC_AUTH_VENCRYPT_TLSSASL = 264,
191 /*****************************************************************************
193 * Encoding types
195 *****************************************************************************/
197 #define VNC_ENCODING_RAW 0x00000000
198 #define VNC_ENCODING_COPYRECT 0x00000001
199 #define VNC_ENCODING_RRE 0x00000002
200 #define VNC_ENCODING_CORRE 0x00000004
201 #define VNC_ENCODING_HEXTILE 0x00000005
202 #define VNC_ENCODING_ZLIB 0x00000006
203 #define VNC_ENCODING_TIGHT 0x00000007
204 #define VNC_ENCODING_ZLIBHEX 0x00000008
205 #define VNC_ENCODING_TRLE 0x0000000f
206 #define VNC_ENCODING_ZRLE 0x00000010
207 #define VNC_ENCODING_ZYWRLE 0x00000011
208 #define VNC_ENCODING_COMPRESSLEVEL0 0xFFFFFF00 /* -256 */
209 #define VNC_ENCODING_QUALITYLEVEL0 0xFFFFFFE0 /* -32 */
210 #define VNC_ENCODING_XCURSOR 0xFFFFFF10 /* -240 */
211 #define VNC_ENCODING_RICH_CURSOR 0xFFFFFF11 /* -239 */
212 #define VNC_ENCODING_POINTER_POS 0xFFFFFF18 /* -232 */
213 #define VNC_ENCODING_LASTRECT 0xFFFFFF20 /* -224 */
214 #define VNC_ENCODING_DESKTOPRESIZE 0xFFFFFF21 /* -223 */
215 #define VNC_ENCODING_POINTER_TYPE_CHANGE 0XFFFFFEFF /* -257 */
216 #define VNC_ENCODING_EXT_KEY_EVENT 0XFFFFFEFE /* -258 */
217 #define VNC_ENCODING_AUDIO 0XFFFFFEFD /* -259 */
218 #define VNC_ENCODING_WMVi 0x574D5669
220 /*****************************************************************************
222 * Other tight constants
224 *****************************************************************************/
227 * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
230 #define VNC_TIGHT_CCB_RESET_MASK (0x0f)
231 #define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4)
232 #define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4)
233 #define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4)
234 #define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4)
235 #define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4)
236 #define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
238 /*****************************************************************************
240 * Features
242 *****************************************************************************/
244 #define VNC_FEATURE_RESIZE 0
245 #define VNC_FEATURE_HEXTILE 1
246 #define VNC_FEATURE_POINTER_TYPE_CHANGE 2
247 #define VNC_FEATURE_WMVI 3
248 #define VNC_FEATURE_TIGHT 4
249 #define VNC_FEATURE_ZLIB 5
250 #define VNC_FEATURE_COPYRECT 6
252 #define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE)
253 #define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE)
254 #define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
255 #define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI)
256 #define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT)
257 #define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB)
258 #define VNC_FEATURE_COPYRECT_MASK (1 << VNC_FEATURE_COPYRECT)
261 /*****************************************************************************
263 * Internal APIs
265 *****************************************************************************/
267 /* Event loop functions */
268 void vnc_client_read(void *opaque);
269 void vnc_client_write(void *opaque);
271 long vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
272 long vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);
274 /* Protocol I/O functions */
275 void vnc_write(VncState *vs, const void *data, size_t len);
276 void vnc_write_u32(VncState *vs, uint32_t value);
277 void vnc_write_s32(VncState *vs, int32_t value);
278 void vnc_write_u16(VncState *vs, uint16_t value);
279 void vnc_write_u8(VncState *vs, uint8_t value);
280 void vnc_flush(VncState *vs);
281 void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting);
284 /* Buffer I/O functions */
285 uint8_t read_u8(uint8_t *data, size_t offset);
286 uint16_t read_u16(uint8_t *data, size_t offset);
287 int32_t read_s32(uint8_t *data, size_t offset);
288 uint32_t read_u32(uint8_t *data, size_t offset);
290 /* Protocol stage functions */
291 void vnc_client_error(VncState *vs);
292 int vnc_client_io_error(VncState *vs, int ret, int last_errno);
294 void start_client_init(VncState *vs);
295 void start_auth_vnc(VncState *vs);
297 /* Buffer management */
298 void buffer_reserve(Buffer *buffer, size_t len);
299 int buffer_empty(Buffer *buffer);
300 uint8_t *buffer_end(Buffer *buffer);
301 void buffer_reset(Buffer *buffer);
302 void buffer_append(Buffer *buffer, const void *data, size_t len);
305 /* Misc helpers */
307 char *vnc_socket_local_addr(const char *format, int fd);
308 char *vnc_socket_remote_addr(const char *format, int fd);
310 #endif /* __QEMU_VNC_H */