]> Git Repo - qemu.git/blob - vnc.h
vnc: adjust compression zstream level
[qemu.git] / vnc.h
1 /*
2  * QEMU VNC display driver
3  *
4  * Copyright (C) 2006 Anthony Liguori <[email protected]>
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"
31 #include "qemu-queue.h"
32 #include "console.h"
33 #include "monitor.h"
34 #include "audio/audio.h"
35 #include <zlib.h>
36
37 #include "keymaps.h"
38
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
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
64 typedef void VncWritePixels(VncState *vs, struct PixelFormat *pf, void *data, int size);
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
72 #define VNC_MAX_WIDTH 2560
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
80 #ifdef CONFIG_VNC_TLS
81 #include "vnc-tls.h"
82 #include "vnc-auth-vencrypt.h"
83 #endif
84 #ifdef CONFIG_VNC_SASL
85 #include "vnc-auth-sasl.h"
86 #endif
87
88 struct VncSurface
89 {
90     uint32_t dirty[VNC_MAX_HEIGHT][VNC_DIRTY_WORDS];
91     DisplaySurface *ds;
92 };
93
94 struct VncDisplay
95 {
96     QTAILQ_HEAD(, VncState) clients;
97     QEMUTimer *timer;
98     int timer_interval;
99     int lsock;
100     DisplayState *ds;
101     kbd_layout_t *kbd_layout;
102     int lock_key_sync;
103
104     QEMUCursor *cursor;
105     int cursor_msize;
106     uint8_t *cursor_mask;
107
108     struct VncSurface guest;   /* guest visible surface (aka ds->surface) */
109     DisplaySurface *server;  /* vnc server surface */
110
111     char *display;
112     char *password;
113     int auth;
114 #ifdef CONFIG_VNC_TLS
115     int subauth; /* Used by VeNCrypt */
116     VncDisplayTLS tls;
117 #endif
118 #ifdef CONFIG_VNC_SASL
119     VncDisplaySASL sasl;
120 #endif
121 };
122
123 struct VncState
124 {
125     int csock;
126
127     DisplayState *ds;
128     uint32_t dirty[VNC_MAX_HEIGHT][VNC_DIRTY_WORDS];
129
130     VncDisplay *vd;
131     int need_update;
132     int force_update;
133     uint32_t features;
134     int absolute;
135     int last_x;
136     int last_y;
137
138     uint32_t vnc_encoding;
139
140     int major;
141     int minor;
142
143     char challenge[VNC_AUTH_CHALLENGE_SIZE];
144 #ifdef CONFIG_VNC_TLS
145     VncStateTLS tls;
146 #endif
147 #ifdef CONFIG_VNC_SASL
148     VncStateSASL sasl;
149 #endif
150
151     QObject *info;
152
153     Buffer output;
154     Buffer input;
155     /* current output mode information */
156     VncWritePixels *write_pixels;
157     DisplaySurface clientds;
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];
166     QEMUPutLEDEntry *led;
167
168     /* Encoding specific */
169
170     /* Tight */
171     uint8_t tight_quality;
172     uint8_t tight_compression;
173
174     /* Hextile */
175     VncSendHextileTile *send_hextile_tile;
176
177     /* Zlib */
178     Buffer zlib;
179     Buffer zlib_tmp;
180     z_stream zlib_stream;
181     int zlib_level;
182
183     Notifier mouse_mode_notifier;
184
185     QTAILQ_ENTRY(VncState) next;
186 };
187
188
189 /*****************************************************************************
190  *
191  * Authentication modes
192  *
193  *****************************************************************************/
194
195 enum {
196     VNC_AUTH_INVALID = 0,
197     VNC_AUTH_NONE = 1,
198     VNC_AUTH_VNC = 2,
199     VNC_AUTH_RA2 = 5,
200     VNC_AUTH_RA2NE = 6,
201     VNC_AUTH_TIGHT = 16,
202     VNC_AUTH_ULTRA = 17,
203     VNC_AUTH_TLS = 18,      /* Supported in GTK-VNC & VINO */
204     VNC_AUTH_VENCRYPT = 19, /* Supported in GTK-VNC & VeNCrypt */
205     VNC_AUTH_SASL = 20,     /* Supported in GTK-VNC & VINO */
206 };
207
208 enum {
209     VNC_AUTH_VENCRYPT_PLAIN = 256,
210     VNC_AUTH_VENCRYPT_TLSNONE = 257,
211     VNC_AUTH_VENCRYPT_TLSVNC = 258,
212     VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
213     VNC_AUTH_VENCRYPT_X509NONE = 260,
214     VNC_AUTH_VENCRYPT_X509VNC = 261,
215     VNC_AUTH_VENCRYPT_X509PLAIN = 262,
216     VNC_AUTH_VENCRYPT_X509SASL = 263,
217     VNC_AUTH_VENCRYPT_TLSSASL = 264,
218 };
219
220
221 /*****************************************************************************
222  *
223  * Encoding types
224  *
225  *****************************************************************************/
226
227 #define VNC_ENCODING_RAW                  0x00000000
228 #define VNC_ENCODING_COPYRECT             0x00000001
229 #define VNC_ENCODING_RRE                  0x00000002
230 #define VNC_ENCODING_CORRE                0x00000004
231 #define VNC_ENCODING_HEXTILE              0x00000005
232 #define VNC_ENCODING_ZLIB                 0x00000006
233 #define VNC_ENCODING_TIGHT                0x00000007
234 #define VNC_ENCODING_ZLIBHEX              0x00000008
235 #define VNC_ENCODING_TRLE                 0x0000000f
236 #define VNC_ENCODING_ZRLE                 0x00000010
237 #define VNC_ENCODING_ZYWRLE               0x00000011
238 #define VNC_ENCODING_COMPRESSLEVEL0       0xFFFFFF00 /* -256 */
239 #define VNC_ENCODING_QUALITYLEVEL0        0xFFFFFFE0 /* -32  */
240 #define VNC_ENCODING_XCURSOR              0xFFFFFF10 /* -240 */
241 #define VNC_ENCODING_RICH_CURSOR          0xFFFFFF11 /* -239 */
242 #define VNC_ENCODING_POINTER_POS          0xFFFFFF18 /* -232 */
243 #define VNC_ENCODING_LASTRECT             0xFFFFFF20 /* -224 */
244 #define VNC_ENCODING_DESKTOPRESIZE        0xFFFFFF21 /* -223 */
245 #define VNC_ENCODING_POINTER_TYPE_CHANGE  0XFFFFFEFF /* -257 */
246 #define VNC_ENCODING_EXT_KEY_EVENT        0XFFFFFEFE /* -258 */
247 #define VNC_ENCODING_AUDIO                0XFFFFFEFD /* -259 */
248 #define VNC_ENCODING_WMVi                 0x574D5669
249
250 /*****************************************************************************
251  *
252  * Other tight constants
253  *
254  *****************************************************************************/
255
256 /*
257  * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
258  */
259
260 #define VNC_TIGHT_CCB_RESET_MASK   (0x0f)
261 #define VNC_TIGHT_CCB_TYPE_MASK    (0x0f << 4)
262 #define VNC_TIGHT_CCB_TYPE_FILL    (0x08 << 4)
263 #define VNC_TIGHT_CCB_TYPE_JPEG    (0x09 << 4)
264 #define VNC_TIGHT_CCB_BASIC_MAX    (0x07 << 4)
265 #define VNC_TIGHT_CCB_BASIC_ZLIB   (0x03 << 4)
266 #define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
267
268 /*****************************************************************************
269  *
270  * Features
271  *
272  *****************************************************************************/
273
274 #define VNC_FEATURE_RESIZE                   0
275 #define VNC_FEATURE_HEXTILE                  1
276 #define VNC_FEATURE_POINTER_TYPE_CHANGE      2
277 #define VNC_FEATURE_WMVI                     3
278 #define VNC_FEATURE_TIGHT                    4
279 #define VNC_FEATURE_ZLIB                     5
280 #define VNC_FEATURE_COPYRECT                 6
281 #define VNC_FEATURE_RICH_CURSOR              7
282
283 #define VNC_FEATURE_RESIZE_MASK              (1 << VNC_FEATURE_RESIZE)
284 #define VNC_FEATURE_HEXTILE_MASK             (1 << VNC_FEATURE_HEXTILE)
285 #define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
286 #define VNC_FEATURE_WMVI_MASK                (1 << VNC_FEATURE_WMVI)
287 #define VNC_FEATURE_TIGHT_MASK               (1 << VNC_FEATURE_TIGHT)
288 #define VNC_FEATURE_ZLIB_MASK                (1 << VNC_FEATURE_ZLIB)
289 #define VNC_FEATURE_COPYRECT_MASK            (1 << VNC_FEATURE_COPYRECT)
290 #define VNC_FEATURE_RICH_CURSOR_MASK         (1 << VNC_FEATURE_RICH_CURSOR)
291
292
293 /* Client -> Server message IDs */
294 #define VNC_MSG_CLIENT_SET_PIXEL_FORMAT           0
295 #define VNC_MSG_CLIENT_SET_ENCODINGS              2
296 #define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3
297 #define VNC_MSG_CLIENT_KEY_EVENT                  4
298 #define VNC_MSG_CLIENT_POINTER_EVENT              5
299 #define VNC_MSG_CLIENT_CUT_TEXT                   6
300 #define VNC_MSG_CLIENT_VMWARE_0                   127
301 #define VNC_MSG_CLIENT_CALL_CONTROL               249
302 #define VNC_MSG_CLIENT_XVP                        250
303 #define VNC_MSG_CLIENT_SET_DESKTOP_SIZE           251
304 #define VNC_MSG_CLIENT_TIGHT                      252
305 #define VNC_MSG_CLIENT_GII                        253
306 #define VNC_MSG_CLIENT_VMWARE_1                   254
307 #define VNC_MSG_CLIENT_QEMU                       255
308
309 /* Server -> Client message IDs */
310 #define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE         0
311 #define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES     1
312 #define VNC_MSG_SERVER_BELL                       2
313 #define VNC_MSG_SERVER_CUT_TEXT                   3
314 #define VNC_MSG_SERVER_VMWARE_0                   127
315 #define VNC_MSG_SERVER_CALL_CONTROL               249
316 #define VNC_MSG_SERVER_XVP                        250
317 #define VNC_MSG_SERVER_TIGHT                      252
318 #define VNC_MSG_SERVER_GII                        253
319 #define VNC_MSG_SERVER_VMWARE_1                   254
320 #define VNC_MSG_SERVER_QEMU                       255
321
322
323
324 /* QEMU client -> server message IDs */
325 #define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT         0
326 #define VNC_MSG_CLIENT_QEMU_AUDIO                 1
327
328 /* QEMU server -> client message IDs */
329 #define VNC_MSG_SERVER_QEMU_AUDIO                 1
330
331
332
333 /* QEMU client -> server audio message IDs */
334 #define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE          0
335 #define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE         1
336 #define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT      2
337
338 /* QEMU server -> client audio message IDs */
339 #define VNC_MSG_SERVER_QEMU_AUDIO_END             0
340 #define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN           1
341 #define VNC_MSG_SERVER_QEMU_AUDIO_DATA            2
342
343
344 /*****************************************************************************
345  *
346  * Internal APIs
347  *
348  *****************************************************************************/
349
350 /* Event loop functions */
351 void vnc_client_read(void *opaque);
352 void vnc_client_write(void *opaque);
353
354 long vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
355 long vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);
356
357 /* Protocol I/O functions */
358 void vnc_write(VncState *vs, const void *data, size_t len);
359 void vnc_write_u32(VncState *vs, uint32_t value);
360 void vnc_write_s32(VncState *vs, int32_t value);
361 void vnc_write_u16(VncState *vs, uint16_t value);
362 void vnc_write_u8(VncState *vs, uint8_t value);
363 void vnc_flush(VncState *vs);
364 void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting);
365
366
367 /* Buffer I/O functions */
368 uint8_t read_u8(uint8_t *data, size_t offset);
369 uint16_t read_u16(uint8_t *data, size_t offset);
370 int32_t read_s32(uint8_t *data, size_t offset);
371 uint32_t read_u32(uint8_t *data, size_t offset);
372
373 /* Protocol stage functions */
374 void vnc_client_error(VncState *vs);
375 int vnc_client_io_error(VncState *vs, int ret, int last_errno);
376
377 void start_client_init(VncState *vs);
378 void start_auth_vnc(VncState *vs);
379
380 /* Buffer management */
381 void buffer_reserve(Buffer *buffer, size_t len);
382 int buffer_empty(Buffer *buffer);
383 uint8_t *buffer_end(Buffer *buffer);
384 void buffer_reset(Buffer *buffer);
385 void buffer_append(Buffer *buffer, const void *data, size_t len);
386
387
388 /* Misc helpers */
389
390 char *vnc_socket_local_addr(const char *format, int fd);
391 char *vnc_socket_remote_addr(const char *format, int fd);
392
393 /* Framebuffer */
394 void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h,
395                             int32_t encoding);
396
397 void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v);
398
399 /* Encodings */
400 void vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
401
402 void vnc_hextile_send_framebuffer_update(VncState *vs, int x,
403                                          int y, int w, int h);
404 void vnc_hextile_set_pixel_conversion(VncState *vs, int generic);
405
406 void vnc_zlib_init(VncState *vs);
407 void vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
408
409 #endif /* __QEMU_VNC_H */
This page took 0.043628 seconds and 4 git commands to generate.