xref: /openbmc/qemu/ui/vnc.h (revision a10b9d93)
1 /*
2  * QEMU VNC display driver
3  *
4  * Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws>
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/queue.h"
31 #include "qemu/thread.h"
32 #include "ui/console.h"
33 #include "audio/audio.h"
34 #include "qemu/bitmap.h"
35 #include "crypto/tlssession.h"
36 #include "qemu/buffer.h"
37 #include "io/channel-socket.h"
38 #include "io/channel-tls.h"
39 #include "io/net-listener.h"
40 #include "authz/base.h"
41 #include <zlib.h>
42 
43 #include "keymaps.h"
44 #include "vnc-palette.h"
45 #include "vnc-enc-zrle.h"
46 #include "ui/kbd-state.h"
47 
48 // #define _VNC_DEBUG 1
49 
50 #ifdef _VNC_DEBUG
51 #define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
52 #else
53 #define VNC_DEBUG(fmt, ...) do { } while (0)
54 #endif
55 
56 /*****************************************************************************
57  *
58  * Core data structures
59  *
60  *****************************************************************************/
61 
62 typedef struct VncState VncState;
63 typedef struct VncJob VncJob;
64 typedef struct VncRect VncRect;
65 typedef struct VncRectEntry VncRectEntry;
66 
67 typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len);
68 
69 typedef void VncWritePixels(VncState *vs, void *data, int size);
70 
71 typedef void VncSendHextileTile(VncState *vs,
72                                 int x, int y, int w, int h,
73                                 void *last_bg,
74                                 void *last_fg,
75                                 int *has_bg, int *has_fg);
76 
77 /* VNC_DIRTY_PIXELS_PER_BIT is the number of dirty pixels represented
78  * by one bit in the dirty bitmap, should be a power of 2 */
79 #define VNC_DIRTY_PIXELS_PER_BIT 16
80 
81 /* VNC_MAX_WIDTH must be a multiple of VNC_DIRTY_PIXELS_PER_BIT. */
82 
83 #define VNC_MAX_WIDTH ROUND_UP(2560, VNC_DIRTY_PIXELS_PER_BIT)
84 #define VNC_MAX_HEIGHT 2048
85 
86 /* VNC_DIRTY_BITS is the number of bits in the dirty bitmap. */
87 #define VNC_DIRTY_BITS (VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT)
88 
89 /* VNC_DIRTY_BPL (BPL = bits per line) might be greater than
90  * VNC_DIRTY_BITS due to alignment */
91 #define VNC_DIRTY_BPL(x) (sizeof((x)->dirty) / VNC_MAX_HEIGHT * BITS_PER_BYTE)
92 
93 #define VNC_STAT_RECT  64
94 #define VNC_STAT_COLS (VNC_MAX_WIDTH / VNC_STAT_RECT)
95 #define VNC_STAT_ROWS (VNC_MAX_HEIGHT / VNC_STAT_RECT)
96 
97 #define VNC_AUTH_CHALLENGE_SIZE 16
98 
99 typedef struct VncDisplay VncDisplay;
100 
101 #include "vnc-auth-vencrypt.h"
102 #ifdef CONFIG_VNC_SASL
103 #include "vnc-auth-sasl.h"
104 #endif
105 #include "vnc-ws.h"
106 
107 struct VncRectStat
108 {
109     /* time of last 10 updates, to find update frequency */
110     struct timeval times[10];
111     int idx;
112 
113     double freq;        /* Update frequency (in Hz) */
114     bool updated;       /* Already updated during this refresh */
115 };
116 
117 typedef struct VncRectStat VncRectStat;
118 
119 struct VncSurface
120 {
121     struct timeval last_freq_check;
122     DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT],
123                    VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT);
124     VncRectStat stats[VNC_STAT_ROWS][VNC_STAT_COLS];
125     pixman_image_t *fb;
126     pixman_format_code_t format;
127 };
128 
129 typedef enum VncShareMode {
130     VNC_SHARE_MODE_CONNECTING = 1,
131     VNC_SHARE_MODE_SHARED,
132     VNC_SHARE_MODE_EXCLUSIVE,
133     VNC_SHARE_MODE_DISCONNECTED,
134 } VncShareMode;
135 
136 typedef enum VncSharePolicy {
137     VNC_SHARE_POLICY_IGNORE = 1,
138     VNC_SHARE_POLICY_ALLOW_EXCLUSIVE,
139     VNC_SHARE_POLICY_FORCE_SHARED,
140 } VncSharePolicy;
141 
142 struct VncDisplay
143 {
144     QTAILQ_HEAD(, VncState) clients;
145     int num_connecting;
146     int num_shared;
147     int num_exclusive;
148     int connections_limit;
149     VncSharePolicy share_policy;
150     QIONetListener *listener;
151     QIONetListener *wslistener;
152     DisplaySurface *ds;
153     DisplayChangeListener dcl;
154     kbd_layout_t *kbd_layout;
155     int lock_key_sync;
156     QEMUPutLEDEntry *led;
157     int ledstate;
158     QKbdState *kbd;
159     QemuMutex mutex;
160 
161     QEMUCursor *cursor;
162     int cursor_msize;
163     uint8_t *cursor_mask;
164 
165     struct VncSurface guest;   /* guest visible surface (aka ds->surface) */
166     pixman_image_t *server;    /* vnc server surface */
167 
168     const char *id;
169     QTAILQ_ENTRY(VncDisplay) next;
170     bool is_unix;
171     char *password;
172     time_t expires;
173     int auth;
174     int subauth; /* Used by VeNCrypt */
175     int ws_auth; /* Used by websockets */
176     int ws_subauth; /* Used by websockets */
177     bool lossy;
178     bool non_adaptive;
179     bool power_control;
180     QCryptoTLSCreds *tlscreds;
181     QAuthZ *tlsauthz;
182     char *tlsauthzid;
183 #ifdef CONFIG_VNC_SASL
184     VncDisplaySASL sasl;
185 #endif
186 
187     AudioState *audio_state;
188 };
189 
190 typedef struct VncTight {
191     int type;
192     uint8_t quality;
193     uint8_t compression;
194     uint8_t pixel24;
195     Buffer tight;
196     Buffer tmp;
197     Buffer zlib;
198     Buffer gradient;
199 #ifdef CONFIG_VNC_JPEG
200     Buffer jpeg;
201 #endif
202 #ifdef CONFIG_VNC_PNG
203     Buffer png;
204 #endif
205     int levels[4];
206     z_stream stream[4];
207 } VncTight;
208 
209 typedef struct VncHextile {
210     VncSendHextileTile *send_tile;
211 } VncHextile;
212 
213 typedef struct VncZlib {
214     Buffer zlib;
215     Buffer tmp;
216     z_stream stream;
217     int level;
218 } VncZlib;
219 
220 typedef struct VncZrle {
221     int type;
222     Buffer fb;
223     Buffer zrle;
224     Buffer tmp;
225     Buffer zlib;
226     z_stream stream;
227     VncPalette palette;
228 } VncZrle;
229 
230 typedef struct VncZywrle {
231     int buf[VNC_ZRLE_TILE_WIDTH * VNC_ZRLE_TILE_HEIGHT];
232 } VncZywrle;
233 
234 struct VncRect
235 {
236     int x;
237     int y;
238     int w;
239     int h;
240 };
241 
242 struct VncRectEntry
243 {
244     struct VncRect rect;
245     QLIST_ENTRY(VncRectEntry) next;
246 };
247 
248 struct VncJob
249 {
250     VncState *vs;
251 
252     QLIST_HEAD(, VncRectEntry) rectangles;
253     QTAILQ_ENTRY(VncJob) next;
254 };
255 
256 typedef enum {
257     VNC_STATE_UPDATE_NONE,
258     VNC_STATE_UPDATE_INCREMENTAL,
259     VNC_STATE_UPDATE_FORCE,
260 } VncStateUpdate;
261 
262 #define VNC_MAGIC ((uint64_t)0x05b3f069b3d204bb)
263 
264 struct VncState
265 {
266     uint64_t magic;
267     QIOChannelSocket *sioc; /* The underlying socket */
268     QIOChannel *ioc; /* The channel currently used for I/O */
269     guint ioc_tag;
270     gboolean disconnecting;
271 
272     DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_DIRTY_BITS);
273     uint8_t **lossy_rect; /* Not an Array to avoid costly memcpy in
274                            * vnc-jobs-async.c */
275 
276     VncDisplay *vd;
277     VncStateUpdate update; /* Most recent pending request from client */
278     VncStateUpdate job_update; /* Currently processed by job thread */
279     int has_dirty;
280     uint32_t features;
281     int absolute;
282     int last_x;
283     int last_y;
284     uint32_t last_bmask;
285     size_t client_width; /* limited to u16 by RFB proto */
286     size_t client_height; /* limited to u16 by RFB proto */
287     VncShareMode share_mode;
288 
289     uint32_t vnc_encoding;
290 
291     int major;
292     int minor;
293 
294     int auth;
295     int subauth; /* Used by VeNCrypt */
296     char challenge[VNC_AUTH_CHALLENGE_SIZE];
297     QCryptoTLSSession *tls; /* Borrowed pointer from channel, don't free */
298 #ifdef CONFIG_VNC_SASL
299     VncStateSASL sasl;
300 #endif
301     bool encode_ws;
302     bool websocket;
303 
304 #ifdef CONFIG_VNC
305     VncClientInfo *info;
306 #endif
307 
308     /* Job thread bottom half has put data for a forced update
309      * into the output buffer. This offset points to the end of
310      * the update data in the output buffer. This lets us determine
311      * when a force update is fully sent to the client, allowing
312      * us to process further forced updates. */
313     size_t force_update_offset;
314     /* We allow multiple incremental updates or audio capture
315      * samples to be queued in output buffer, provided the
316      * buffer size doesn't exceed this threshold. The value
317      * is calculating dynamically based on framebuffer size
318      * and audio sample settings in vnc_update_throttle_offset() */
319     size_t throttle_output_offset;
320     Buffer output;
321     Buffer input;
322     /* current output mode information */
323     VncWritePixels *write_pixels;
324     PixelFormat client_pf;
325     pixman_format_code_t client_format;
326     bool client_be;
327 
328     CaptureVoiceOut *audio_cap;
329     struct audsettings as;
330 
331     VncReadEvent *read_handler;
332     size_t read_handler_expect;
333 
334     bool abort;
335     QemuMutex output_mutex;
336     QEMUBH *bh;
337     Buffer jobs_buffer;
338 
339     /* Encoding specific, if you add something here, don't forget to
340      *  update vnc_async_encoding_start()
341      */
342     VncTight *tight;
343     VncZlib zlib;
344     VncHextile hextile;
345     VncZrle *zrle;
346     VncZywrle zywrle;
347 
348     Notifier mouse_mode_notifier;
349 
350     QTAILQ_ENTRY(VncState) next;
351 };
352 
353 
354 /*****************************************************************************
355  *
356  * Authentication modes
357  *
358  *****************************************************************************/
359 
360 enum {
361     VNC_AUTH_INVALID = 0,
362     VNC_AUTH_NONE = 1,
363     VNC_AUTH_VNC = 2,
364     VNC_AUTH_RA2 = 5,
365     VNC_AUTH_RA2NE = 6,
366     VNC_AUTH_TIGHT = 16,
367     VNC_AUTH_ULTRA = 17,
368     VNC_AUTH_TLS = 18,      /* Supported in GTK-VNC & VINO */
369     VNC_AUTH_VENCRYPT = 19, /* Supported in GTK-VNC & VeNCrypt */
370     VNC_AUTH_SASL = 20,     /* Supported in GTK-VNC & VINO */
371 };
372 
373 enum {
374     VNC_AUTH_VENCRYPT_PLAIN = 256,
375     VNC_AUTH_VENCRYPT_TLSNONE = 257,
376     VNC_AUTH_VENCRYPT_TLSVNC = 258,
377     VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
378     VNC_AUTH_VENCRYPT_X509NONE = 260,
379     VNC_AUTH_VENCRYPT_X509VNC = 261,
380     VNC_AUTH_VENCRYPT_X509PLAIN = 262,
381     VNC_AUTH_VENCRYPT_X509SASL = 263,
382     VNC_AUTH_VENCRYPT_TLSSASL = 264,
383 };
384 
385 
386 /*****************************************************************************
387  *
388  * Encoding types
389  *
390  *****************************************************************************/
391 
392 #define VNC_ENCODING_RAW                  0x00000000
393 #define VNC_ENCODING_COPYRECT             0x00000001
394 #define VNC_ENCODING_RRE                  0x00000002
395 #define VNC_ENCODING_CORRE                0x00000004
396 #define VNC_ENCODING_HEXTILE              0x00000005
397 #define VNC_ENCODING_ZLIB                 0x00000006
398 #define VNC_ENCODING_TIGHT                0x00000007
399 #define VNC_ENCODING_ZLIBHEX              0x00000008
400 #define VNC_ENCODING_TRLE                 0x0000000f
401 #define VNC_ENCODING_ZRLE                 0x00000010
402 #define VNC_ENCODING_ZYWRLE               0x00000011
403 #define VNC_ENCODING_COMPRESSLEVEL0       0xFFFFFF00 /* -256 */
404 #define VNC_ENCODING_QUALITYLEVEL0        0xFFFFFFE0 /* -32  */
405 #define VNC_ENCODING_XCURSOR              0xFFFFFF10 /* -240 */
406 #define VNC_ENCODING_RICH_CURSOR          0xFFFFFF11 /* -239 */
407 #define VNC_ENCODING_POINTER_POS          0xFFFFFF18 /* -232 */
408 #define VNC_ENCODING_LASTRECT             0xFFFFFF20 /* -224 */
409 #define VNC_ENCODING_DESKTOPRESIZE        0xFFFFFF21 /* -223 */
410 #define VNC_ENCODING_POINTER_TYPE_CHANGE  0XFFFFFEFF /* -257 */
411 #define VNC_ENCODING_EXT_KEY_EVENT        0XFFFFFEFE /* -258 */
412 #define VNC_ENCODING_AUDIO                0XFFFFFEFD /* -259 */
413 #define VNC_ENCODING_TIGHT_PNG            0xFFFFFEFC /* -260 */
414 #define VNC_ENCODING_LED_STATE            0XFFFFFEFB /* -261 */
415 #define VNC_ENCODING_DESKTOP_RESIZE_EXT   0XFFFFFECC /* -308 */
416 #define VNC_ENCODING_XVP                  0XFFFFFECB /* -309 */
417 #define VNC_ENCODING_ALPHA_CURSOR         0XFFFFFEC6 /* -314 */
418 #define VNC_ENCODING_WMVi                 0x574D5669
419 
420 /*****************************************************************************
421  *
422  * Other tight constants
423  *
424  *****************************************************************************/
425 
426 /*
427  * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
428  */
429 
430 #define VNC_TIGHT_CCB_RESET_MASK   (0x0f)
431 #define VNC_TIGHT_CCB_TYPE_MASK    (0x0f << 4)
432 #define VNC_TIGHT_CCB_TYPE_FILL    (0x08 << 4)
433 #define VNC_TIGHT_CCB_TYPE_JPEG    (0x09 << 4)
434 #define VNC_TIGHT_CCB_TYPE_PNG     (0x0A << 4)
435 #define VNC_TIGHT_CCB_BASIC_MAX    (0x07 << 4)
436 #define VNC_TIGHT_CCB_BASIC_ZLIB   (0x03 << 4)
437 #define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
438 
439 /*****************************************************************************
440  *
441  * Features
442  *
443  *****************************************************************************/
444 
445 enum VncFeatures {
446     VNC_FEATURE_RESIZE,
447     VNC_FEATURE_RESIZE_EXT,
448     VNC_FEATURE_HEXTILE,
449     VNC_FEATURE_POINTER_TYPE_CHANGE,
450     VNC_FEATURE_WMVI,
451     VNC_FEATURE_TIGHT,
452     VNC_FEATURE_ZLIB,
453     VNC_FEATURE_RICH_CURSOR,
454     VNC_FEATURE_ALPHA_CURSOR,
455     VNC_FEATURE_TIGHT_PNG,
456     VNC_FEATURE_ZRLE,
457     VNC_FEATURE_ZYWRLE,
458     VNC_FEATURE_LED_STATE,
459     VNC_FEATURE_XVP,
460 };
461 
462 #define VNC_FEATURE_RESIZE_MASK              (1 << VNC_FEATURE_RESIZE)
463 #define VNC_FEATURE_RESIZE_EXT_MASK          (1 << VNC_FEATURE_RESIZE_EXT)
464 #define VNC_FEATURE_HEXTILE_MASK             (1 << VNC_FEATURE_HEXTILE)
465 #define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
466 #define VNC_FEATURE_WMVI_MASK                (1 << VNC_FEATURE_WMVI)
467 #define VNC_FEATURE_TIGHT_MASK               (1 << VNC_FEATURE_TIGHT)
468 #define VNC_FEATURE_ZLIB_MASK                (1 << VNC_FEATURE_ZLIB)
469 #define VNC_FEATURE_RICH_CURSOR_MASK         (1 << VNC_FEATURE_RICH_CURSOR)
470 #define VNC_FEATURE_ALPHA_CURSOR_MASK        (1 << VNC_FEATURE_ALPHA_CURSOR)
471 #define VNC_FEATURE_TIGHT_PNG_MASK           (1 << VNC_FEATURE_TIGHT_PNG)
472 #define VNC_FEATURE_ZRLE_MASK                (1 << VNC_FEATURE_ZRLE)
473 #define VNC_FEATURE_ZYWRLE_MASK              (1 << VNC_FEATURE_ZYWRLE)
474 #define VNC_FEATURE_LED_STATE_MASK           (1 << VNC_FEATURE_LED_STATE)
475 #define VNC_FEATURE_XVP_MASK                 (1 << VNC_FEATURE_XVP)
476 
477 
478 /* Client -> Server message IDs */
479 #define VNC_MSG_CLIENT_SET_PIXEL_FORMAT           0
480 #define VNC_MSG_CLIENT_SET_ENCODINGS              2
481 #define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3
482 #define VNC_MSG_CLIENT_KEY_EVENT                  4
483 #define VNC_MSG_CLIENT_POINTER_EVENT              5
484 #define VNC_MSG_CLIENT_CUT_TEXT                   6
485 #define VNC_MSG_CLIENT_VMWARE_0                   127
486 #define VNC_MSG_CLIENT_CALL_CONTROL               249
487 #define VNC_MSG_CLIENT_XVP                        250
488 #define VNC_MSG_CLIENT_SET_DESKTOP_SIZE           251
489 #define VNC_MSG_CLIENT_TIGHT                      252
490 #define VNC_MSG_CLIENT_GII                        253
491 #define VNC_MSG_CLIENT_VMWARE_1                   254
492 #define VNC_MSG_CLIENT_QEMU                       255
493 
494 /* Server -> Client message IDs */
495 #define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE         0
496 #define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES     1
497 #define VNC_MSG_SERVER_BELL                       2
498 #define VNC_MSG_SERVER_CUT_TEXT                   3
499 #define VNC_MSG_SERVER_VMWARE_0                   127
500 #define VNC_MSG_SERVER_CALL_CONTROL               249
501 #define VNC_MSG_SERVER_XVP                        250
502 #define VNC_MSG_SERVER_TIGHT                      252
503 #define VNC_MSG_SERVER_GII                        253
504 #define VNC_MSG_SERVER_VMWARE_1                   254
505 #define VNC_MSG_SERVER_QEMU                       255
506 
507 
508 
509 /* QEMU client -> server message IDs */
510 #define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT         0
511 #define VNC_MSG_CLIENT_QEMU_AUDIO                 1
512 
513 /* QEMU server -> client message IDs */
514 #define VNC_MSG_SERVER_QEMU_AUDIO                 1
515 
516 
517 
518 /* QEMU client -> server audio message IDs */
519 #define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE          0
520 #define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE         1
521 #define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT      2
522 
523 /* QEMU server -> client audio message IDs */
524 #define VNC_MSG_SERVER_QEMU_AUDIO_END             0
525 #define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN           1
526 #define VNC_MSG_SERVER_QEMU_AUDIO_DATA            2
527 
528 /* XVP server -> client status code */
529 #define VNC_XVP_CODE_FAIL 0
530 #define VNC_XVP_CODE_INIT 1
531 
532 /* XVP client -> server action request  */
533 #define VNC_XVP_ACTION_SHUTDOWN 2
534 #define VNC_XVP_ACTION_REBOOT 3
535 #define VNC_XVP_ACTION_RESET 4
536 
537 
538 /*****************************************************************************
539  *
540  * Internal APIs
541  *
542  *****************************************************************************/
543 
544 /* Event loop functions */
545 gboolean vnc_client_io(QIOChannel *ioc,
546                        GIOCondition condition,
547                        void *opaque);
548 
549 size_t vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
550 size_t vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);
551 
552 /* Protocol I/O functions */
553 void vnc_write(VncState *vs, const void *data, size_t len);
554 void vnc_write_u32(VncState *vs, uint32_t value);
555 void vnc_write_s32(VncState *vs, int32_t value);
556 void vnc_write_u16(VncState *vs, uint16_t value);
557 void vnc_write_u8(VncState *vs, uint8_t value);
558 void vnc_flush(VncState *vs);
559 void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting);
560 void vnc_disconnect_finish(VncState *vs);
561 void vnc_start_protocol(VncState *vs);
562 
563 
564 /* Buffer I/O functions */
565 uint32_t read_u32(uint8_t *data, size_t offset);
566 
567 /* Protocol stage functions */
568 void vnc_client_error(VncState *vs);
569 size_t vnc_client_io_error(VncState *vs, ssize_t ret, Error *err);
570 
571 void start_client_init(VncState *vs);
572 void start_auth_vnc(VncState *vs);
573 
574 
575 /* Misc helpers */
576 
577 static inline uint32_t vnc_has_feature(VncState *vs, int feature) {
578     return (vs->features & (1 << feature));
579 }
580 
581 /* Framebuffer */
582 void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h,
583                             int32_t encoding);
584 
585 /* server fb is in PIXMAN_x8r8g8b8 */
586 #define VNC_SERVER_FB_FORMAT PIXMAN_FORMAT(32, PIXMAN_TYPE_ARGB, 0, 8, 8, 8)
587 #define VNC_SERVER_FB_BITS   (PIXMAN_FORMAT_BPP(VNC_SERVER_FB_FORMAT))
588 #define VNC_SERVER_FB_BYTES  ((VNC_SERVER_FB_BITS+7)/8)
589 
590 void *vnc_server_fb_ptr(VncDisplay *vd, int x, int y);
591 int vnc_server_fb_stride(VncDisplay *vd);
592 
593 void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v);
594 double vnc_update_freq(VncState *vs, int x, int y, int w, int h);
595 void vnc_sent_lossy_rect(VncState *vs, int x, int y, int w, int h);
596 
597 /* Encodings */
598 int vnc_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
599 
600 int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
601 
602 int vnc_hextile_send_framebuffer_update(VncState *vs, int x,
603                                          int y, int w, int h);
604 void vnc_hextile_set_pixel_conversion(VncState *vs, int generic);
605 
606 void *vnc_zlib_zalloc(void *x, unsigned items, unsigned size);
607 void vnc_zlib_zfree(void *x, void *addr);
608 int vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
609 void vnc_zlib_clear(VncState *vs);
610 
611 int vnc_tight_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
612 int vnc_tight_png_send_framebuffer_update(VncState *vs, int x, int y,
613                                           int w, int h);
614 void vnc_tight_clear(VncState *vs);
615 
616 int vnc_zrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
617 int vnc_zywrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
618 void vnc_zrle_clear(VncState *vs);
619 
620 #endif /* QEMU_VNC_H */
621