gtk: Allow to activate grab-on-hover from the command line
[qemu/ar7.git] / ui / vnc.h
blob8da81b8d6eba60088f3bd065b3be0d95d640aa76
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 "qemu/queue.h"
32 #include "qemu/thread.h"
33 #include "ui/console.h"
34 #include "monitor/monitor.h"
35 #include "audio/audio.h"
36 #include "qemu/bitmap.h"
37 #include <zlib.h>
38 #include <stdbool.h>
40 #include "keymaps.h"
41 #include "vnc-palette.h"
42 #include "vnc-enc-zrle.h"
44 // #define _VNC_DEBUG 1
46 #ifdef _VNC_DEBUG
47 #define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
48 #else
49 #define VNC_DEBUG(fmt, ...) do { } while (0)
50 #endif
52 /*****************************************************************************
54 * Core data structures
56 *****************************************************************************/
58 typedef struct Buffer
60 size_t capacity;
61 size_t offset;
62 uint8_t *buffer;
63 } Buffer;
65 typedef struct VncState VncState;
66 typedef struct VncJob VncJob;
67 typedef struct VncRect VncRect;
68 typedef struct VncRectEntry VncRectEntry;
70 typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len);
72 typedef void VncWritePixels(VncState *vs, void *data, int size);
74 typedef void VncSendHextileTile(VncState *vs,
75 int x, int y, int w, int h,
76 void *last_bg,
77 void *last_fg,
78 int *has_bg, int *has_fg);
80 /* VNC_MAX_WIDTH must be a multiple of 16. */
81 #define VNC_MAX_WIDTH 2560
82 #define VNC_MAX_HEIGHT 2048
84 /* VNC_DIRTY_PIXELS_PER_BIT is the number of dirty pixels represented
85 * by one bit in the dirty bitmap */
86 #define VNC_DIRTY_PIXELS_PER_BIT 16
88 /* VNC_DIRTY_BITS is the number of bits in the dirty bitmap. */
89 #define VNC_DIRTY_BITS (VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT)
91 /* VNC_DIRTY_BPL (BPL = bits per line) might be greater than
92 * VNC_DIRTY_BITS due to alignment */
93 #define VNC_DIRTY_BPL(x) (sizeof((x)->dirty) / VNC_MAX_HEIGHT * BITS_PER_BYTE)
95 #define VNC_STAT_RECT 64
96 #define VNC_STAT_COLS (VNC_MAX_WIDTH / VNC_STAT_RECT)
97 #define VNC_STAT_ROWS (VNC_MAX_HEIGHT / VNC_STAT_RECT)
99 #define VNC_AUTH_CHALLENGE_SIZE 16
101 typedef struct VncDisplay VncDisplay;
103 #ifdef CONFIG_VNC_TLS
104 #include "vnc-tls.h"
105 #include "vnc-auth-vencrypt.h"
106 #endif
107 #ifdef CONFIG_VNC_SASL
108 #include "vnc-auth-sasl.h"
109 #endif
110 #ifdef CONFIG_VNC_WS
111 #include "vnc-ws.h"
112 #endif
114 struct VncRectStat
116 /* time of last 10 updates, to find update frequency */
117 struct timeval times[10];
118 int idx;
120 double freq; /* Update frequency (in Hz) */
121 bool updated; /* Already updated during this refresh */
124 typedef struct VncRectStat VncRectStat;
126 struct VncSurface
128 struct timeval last_freq_check;
129 DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_MAX_WIDTH / 16);
130 VncRectStat stats[VNC_STAT_ROWS][VNC_STAT_COLS];
131 pixman_image_t *fb;
132 pixman_format_code_t format;
135 typedef enum VncShareMode {
136 VNC_SHARE_MODE_CONNECTING = 1,
137 VNC_SHARE_MODE_SHARED,
138 VNC_SHARE_MODE_EXCLUSIVE,
139 VNC_SHARE_MODE_DISCONNECTED,
140 } VncShareMode;
142 typedef enum VncSharePolicy {
143 VNC_SHARE_POLICY_IGNORE = 1,
144 VNC_SHARE_POLICY_ALLOW_EXCLUSIVE,
145 VNC_SHARE_POLICY_FORCE_SHARED,
146 } VncSharePolicy;
148 struct VncDisplay
150 QTAILQ_HEAD(, VncState) clients;
151 int num_exclusive;
152 VncSharePolicy share_policy;
153 int lsock;
154 #ifdef CONFIG_VNC_WS
155 int lwebsock;
156 bool websocket;
157 char *ws_display;
158 #endif
159 DisplaySurface *ds;
160 DisplayChangeListener dcl;
161 kbd_layout_t *kbd_layout;
162 int lock_key_sync;
163 QemuMutex mutex;
165 QEMUCursor *cursor;
166 int cursor_msize;
167 uint8_t *cursor_mask;
169 struct VncSurface guest; /* guest visible surface (aka ds->surface) */
170 pixman_image_t *server; /* vnc server surface */
172 char *display;
173 char *password;
174 time_t expires;
175 int auth;
176 bool lossy;
177 bool non_adaptive;
178 #ifdef CONFIG_VNC_TLS
179 int subauth; /* Used by VeNCrypt */
180 VncDisplayTLS tls;
181 #endif
182 #ifdef CONFIG_VNC_SASL
183 VncDisplaySASL sasl;
184 #endif
187 typedef struct VncTight {
188 int type;
189 uint8_t quality;
190 uint8_t compression;
191 uint8_t pixel24;
192 Buffer tight;
193 Buffer tmp;
194 Buffer zlib;
195 Buffer gradient;
196 #ifdef CONFIG_VNC_JPEG
197 Buffer jpeg;
198 #endif
199 #ifdef CONFIG_VNC_PNG
200 Buffer png;
201 #endif
202 int levels[4];
203 z_stream stream[4];
204 } VncTight;
206 typedef struct VncHextile {
207 VncSendHextileTile *send_tile;
208 } VncHextile;
210 typedef struct VncZlib {
211 Buffer zlib;
212 Buffer tmp;
213 z_stream stream;
214 int level;
215 } VncZlib;
217 typedef struct VncZrle {
218 int type;
219 Buffer fb;
220 Buffer zrle;
221 Buffer tmp;
222 Buffer zlib;
223 z_stream stream;
224 VncPalette palette;
225 } VncZrle;
227 typedef struct VncZywrle {
228 int buf[VNC_ZRLE_TILE_WIDTH * VNC_ZRLE_TILE_HEIGHT];
229 } VncZywrle;
231 struct VncRect
233 int x;
234 int y;
235 int w;
236 int h;
239 struct VncRectEntry
241 struct VncRect rect;
242 QLIST_ENTRY(VncRectEntry) next;
245 struct VncJob
247 VncState *vs;
249 QLIST_HEAD(, VncRectEntry) rectangles;
250 QTAILQ_ENTRY(VncJob) next;
253 struct VncState
255 int csock;
257 DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_DIRTY_BITS);
258 uint8_t **lossy_rect; /* Not an Array to avoid costly memcpy in
259 * vnc-jobs-async.c */
261 VncDisplay *vd;
262 int need_update;
263 int force_update;
264 uint32_t features;
265 int absolute;
266 int last_x;
267 int last_y;
268 uint32_t last_bmask;
269 int client_width;
270 int client_height;
271 VncShareMode share_mode;
273 uint32_t vnc_encoding;
275 int major;
276 int minor;
278 int auth;
279 char challenge[VNC_AUTH_CHALLENGE_SIZE];
280 #ifdef CONFIG_VNC_TLS
281 int subauth; /* Used by VeNCrypt */
282 VncStateTLS tls;
283 #endif
284 #ifdef CONFIG_VNC_SASL
285 VncStateSASL sasl;
286 #endif
287 #ifdef CONFIG_VNC_WS
288 #ifdef CONFIG_VNC_TLS
289 VncStateTLS ws_tls;
290 #endif /* CONFIG_VNC_TLS */
291 bool encode_ws;
292 bool websocket;
293 #endif /* CONFIG_VNC_WS */
295 QObject *info;
297 Buffer output;
298 Buffer input;
299 #ifdef CONFIG_VNC_WS
300 Buffer ws_input;
301 Buffer ws_output;
302 #endif
303 /* current output mode information */
304 VncWritePixels *write_pixels;
305 PixelFormat client_pf;
306 pixman_format_code_t client_format;
307 bool client_be;
309 CaptureVoiceOut *audio_cap;
310 struct audsettings as;
312 VncReadEvent *read_handler;
313 size_t read_handler_expect;
314 /* input */
315 uint8_t modifiers_state[256];
316 QEMUPutLEDEntry *led;
318 bool abort;
319 bool initialized;
320 QemuMutex output_mutex;
321 QEMUBH *bh;
322 Buffer jobs_buffer;
324 /* Encoding specific, if you add something here, don't forget to
325 * update vnc_async_encoding_start()
327 VncTight tight;
328 VncZlib zlib;
329 VncHextile hextile;
330 VncZrle zrle;
331 VncZywrle zywrle;
333 Notifier mouse_mode_notifier;
335 QTAILQ_ENTRY(VncState) next;
339 /*****************************************************************************
341 * Authentication modes
343 *****************************************************************************/
345 enum {
346 VNC_AUTH_INVALID = 0,
347 VNC_AUTH_NONE = 1,
348 VNC_AUTH_VNC = 2,
349 VNC_AUTH_RA2 = 5,
350 VNC_AUTH_RA2NE = 6,
351 VNC_AUTH_TIGHT = 16,
352 VNC_AUTH_ULTRA = 17,
353 VNC_AUTH_TLS = 18, /* Supported in GTK-VNC & VINO */
354 VNC_AUTH_VENCRYPT = 19, /* Supported in GTK-VNC & VeNCrypt */
355 VNC_AUTH_SASL = 20, /* Supported in GTK-VNC & VINO */
358 enum {
359 VNC_AUTH_VENCRYPT_PLAIN = 256,
360 VNC_AUTH_VENCRYPT_TLSNONE = 257,
361 VNC_AUTH_VENCRYPT_TLSVNC = 258,
362 VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
363 VNC_AUTH_VENCRYPT_X509NONE = 260,
364 VNC_AUTH_VENCRYPT_X509VNC = 261,
365 VNC_AUTH_VENCRYPT_X509PLAIN = 262,
366 VNC_AUTH_VENCRYPT_X509SASL = 263,
367 VNC_AUTH_VENCRYPT_TLSSASL = 264,
371 /*****************************************************************************
373 * Encoding types
375 *****************************************************************************/
377 #define VNC_ENCODING_RAW 0x00000000
378 #define VNC_ENCODING_COPYRECT 0x00000001
379 #define VNC_ENCODING_RRE 0x00000002
380 #define VNC_ENCODING_CORRE 0x00000004
381 #define VNC_ENCODING_HEXTILE 0x00000005
382 #define VNC_ENCODING_ZLIB 0x00000006
383 #define VNC_ENCODING_TIGHT 0x00000007
384 #define VNC_ENCODING_ZLIBHEX 0x00000008
385 #define VNC_ENCODING_TRLE 0x0000000f
386 #define VNC_ENCODING_ZRLE 0x00000010
387 #define VNC_ENCODING_ZYWRLE 0x00000011
388 #define VNC_ENCODING_COMPRESSLEVEL0 0xFFFFFF00 /* -256 */
389 #define VNC_ENCODING_QUALITYLEVEL0 0xFFFFFFE0 /* -32 */
390 #define VNC_ENCODING_XCURSOR 0xFFFFFF10 /* -240 */
391 #define VNC_ENCODING_RICH_CURSOR 0xFFFFFF11 /* -239 */
392 #define VNC_ENCODING_POINTER_POS 0xFFFFFF18 /* -232 */
393 #define VNC_ENCODING_LASTRECT 0xFFFFFF20 /* -224 */
394 #define VNC_ENCODING_DESKTOPRESIZE 0xFFFFFF21 /* -223 */
395 #define VNC_ENCODING_POINTER_TYPE_CHANGE 0XFFFFFEFF /* -257 */
396 #define VNC_ENCODING_EXT_KEY_EVENT 0XFFFFFEFE /* -258 */
397 #define VNC_ENCODING_AUDIO 0XFFFFFEFD /* -259 */
398 #define VNC_ENCODING_TIGHT_PNG 0xFFFFFEFC /* -260 */
399 #define VNC_ENCODING_LED_STATE 0XFFFFFEFB /* -261 */
400 #define VNC_ENCODING_WMVi 0x574D5669
402 /*****************************************************************************
404 * Other tight constants
406 *****************************************************************************/
409 * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
412 #define VNC_TIGHT_CCB_RESET_MASK (0x0f)
413 #define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4)
414 #define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4)
415 #define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4)
416 #define VNC_TIGHT_CCB_TYPE_PNG (0x0A << 4)
417 #define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4)
418 #define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4)
419 #define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
421 /*****************************************************************************
423 * Features
425 *****************************************************************************/
427 #define VNC_FEATURE_RESIZE 0
428 #define VNC_FEATURE_HEXTILE 1
429 #define VNC_FEATURE_POINTER_TYPE_CHANGE 2
430 #define VNC_FEATURE_WMVI 3
431 #define VNC_FEATURE_TIGHT 4
432 #define VNC_FEATURE_ZLIB 5
433 #define VNC_FEATURE_COPYRECT 6
434 #define VNC_FEATURE_RICH_CURSOR 7
435 #define VNC_FEATURE_TIGHT_PNG 8
436 #define VNC_FEATURE_ZRLE 9
437 #define VNC_FEATURE_ZYWRLE 10
438 #define VNC_FEATURE_LED_STATE 11
440 #define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE)
441 #define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE)
442 #define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
443 #define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI)
444 #define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT)
445 #define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB)
446 #define VNC_FEATURE_COPYRECT_MASK (1 << VNC_FEATURE_COPYRECT)
447 #define VNC_FEATURE_RICH_CURSOR_MASK (1 << VNC_FEATURE_RICH_CURSOR)
448 #define VNC_FEATURE_TIGHT_PNG_MASK (1 << VNC_FEATURE_TIGHT_PNG)
449 #define VNC_FEATURE_ZRLE_MASK (1 << VNC_FEATURE_ZRLE)
450 #define VNC_FEATURE_ZYWRLE_MASK (1 << VNC_FEATURE_ZYWRLE)
451 #define VNC_FEATURE_LED_STATE_MASK (1 << VNC_FEATURE_LED_STATE)
454 /* Client -> Server message IDs */
455 #define VNC_MSG_CLIENT_SET_PIXEL_FORMAT 0
456 #define VNC_MSG_CLIENT_SET_ENCODINGS 2
457 #define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3
458 #define VNC_MSG_CLIENT_KEY_EVENT 4
459 #define VNC_MSG_CLIENT_POINTER_EVENT 5
460 #define VNC_MSG_CLIENT_CUT_TEXT 6
461 #define VNC_MSG_CLIENT_VMWARE_0 127
462 #define VNC_MSG_CLIENT_CALL_CONTROL 249
463 #define VNC_MSG_CLIENT_XVP 250
464 #define VNC_MSG_CLIENT_SET_DESKTOP_SIZE 251
465 #define VNC_MSG_CLIENT_TIGHT 252
466 #define VNC_MSG_CLIENT_GII 253
467 #define VNC_MSG_CLIENT_VMWARE_1 254
468 #define VNC_MSG_CLIENT_QEMU 255
470 /* Server -> Client message IDs */
471 #define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE 0
472 #define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES 1
473 #define VNC_MSG_SERVER_BELL 2
474 #define VNC_MSG_SERVER_CUT_TEXT 3
475 #define VNC_MSG_SERVER_VMWARE_0 127
476 #define VNC_MSG_SERVER_CALL_CONTROL 249
477 #define VNC_MSG_SERVER_XVP 250
478 #define VNC_MSG_SERVER_TIGHT 252
479 #define VNC_MSG_SERVER_GII 253
480 #define VNC_MSG_SERVER_VMWARE_1 254
481 #define VNC_MSG_SERVER_QEMU 255
485 /* QEMU client -> server message IDs */
486 #define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT 0
487 #define VNC_MSG_CLIENT_QEMU_AUDIO 1
489 /* QEMU server -> client message IDs */
490 #define VNC_MSG_SERVER_QEMU_AUDIO 1
494 /* QEMU client -> server audio message IDs */
495 #define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE 0
496 #define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE 1
497 #define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT 2
499 /* QEMU server -> client audio message IDs */
500 #define VNC_MSG_SERVER_QEMU_AUDIO_END 0
501 #define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN 1
502 #define VNC_MSG_SERVER_QEMU_AUDIO_DATA 2
505 /*****************************************************************************
507 * Internal APIs
509 *****************************************************************************/
511 /* Event loop functions */
512 void vnc_client_read(void *opaque);
513 void vnc_client_write(void *opaque);
515 long vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
516 long vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);
518 /* Protocol I/O functions */
519 void vnc_write(VncState *vs, const void *data, size_t len);
520 void vnc_write_u32(VncState *vs, uint32_t value);
521 void vnc_write_s32(VncState *vs, int32_t value);
522 void vnc_write_u16(VncState *vs, uint16_t value);
523 void vnc_write_u8(VncState *vs, uint8_t value);
524 void vnc_flush(VncState *vs);
525 void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting);
526 void vnc_disconnect_finish(VncState *vs);
527 void vnc_init_state(VncState *vs);
530 /* Buffer I/O functions */
531 uint32_t read_u32(uint8_t *data, size_t offset);
533 /* Protocol stage functions */
534 void vnc_client_error(VncState *vs);
535 int vnc_client_io_error(VncState *vs, int ret, int last_errno);
537 void start_client_init(VncState *vs);
538 void start_auth_vnc(VncState *vs);
540 /* Buffer management */
541 void buffer_reserve(Buffer *buffer, size_t len);
542 void buffer_reset(Buffer *buffer);
543 void buffer_free(Buffer *buffer);
544 void buffer_append(Buffer *buffer, const void *data, size_t len);
545 void buffer_advance(Buffer *buf, size_t len);
546 uint8_t *buffer_end(Buffer *buffer);
549 /* Misc helpers */
551 char *vnc_socket_local_addr(const char *format, int fd);
552 char *vnc_socket_remote_addr(const char *format, int fd);
554 static inline uint32_t vnc_has_feature(VncState *vs, int feature) {
555 return (vs->features & (1 << feature));
558 /* Framebuffer */
559 void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h,
560 int32_t encoding);
562 /* server fb is in PIXMAN_x8r8g8b8 */
563 #define VNC_SERVER_FB_FORMAT PIXMAN_FORMAT(32, PIXMAN_TYPE_ARGB, 0, 8, 8, 8)
564 #define VNC_SERVER_FB_BITS (PIXMAN_FORMAT_BPP(VNC_SERVER_FB_FORMAT))
565 #define VNC_SERVER_FB_BYTES ((VNC_SERVER_FB_BITS+7)/8)
567 void *vnc_server_fb_ptr(VncDisplay *vd, int x, int y);
568 int vnc_server_fb_stride(VncDisplay *vd);
570 void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v);
571 double vnc_update_freq(VncState *vs, int x, int y, int w, int h);
572 void vnc_sent_lossy_rect(VncState *vs, int x, int y, int w, int h);
574 /* Encodings */
575 int vnc_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
577 int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
579 int vnc_hextile_send_framebuffer_update(VncState *vs, int x,
580 int y, int w, int h);
581 void vnc_hextile_set_pixel_conversion(VncState *vs, int generic);
583 void *vnc_zlib_zalloc(void *x, unsigned items, unsigned size);
584 void vnc_zlib_zfree(void *x, void *addr);
585 int vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
586 void vnc_zlib_clear(VncState *vs);
588 int vnc_tight_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
589 int vnc_tight_png_send_framebuffer_update(VncState *vs, int x, int y,
590 int w, int h);
591 void vnc_tight_clear(VncState *vs);
593 int vnc_zrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
594 int vnc_zywrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
595 void vnc_zrle_clear(VncState *vs);
597 #endif /* __QEMU_VNC_H */