xref: /openbmc/qemu/ui/vnc.h (revision 1c37425423f60c3e0deec6e942cfb17982fd8b6d)
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/clipboard.h"
33 #include "ui/console.h"
34 #include "audio/audio.h"
35 #include "qemu/bitmap.h"
36 #include "crypto/tlssession.h"
37 #include "qemu/buffer.h"
38 #include "io/channel-socket.h"
39 #include "io/channel-tls.h"
40 #include "io/net-listener.h"
41 #include "authz/base.h"
42 #include <zlib.h>
43 
44 #include "keymaps.h"
45 #include "vnc-palette.h"
46 #include "vnc-enc-zrle.h"
47 #include "ui/kbd-state.h"
48 
49 // #define _VNC_DEBUG 1
50 
51 #ifdef _VNC_DEBUG
52 #define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
53 #else
54 #define VNC_DEBUG(fmt, ...) do { } while (0)
55 #endif
56 
57 /*****************************************************************************
58  *
59  * Core data structures
60  *
61  *****************************************************************************/
62 
63 typedef struct VncState VncState;
64 typedef struct VncJob VncJob;
65 typedef struct VncRect VncRect;
66 typedef struct VncRectEntry VncRectEntry;
67 
68 typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len);
69 
70 typedef void VncWritePixels(VncState *vs, void *data, int size);
71 
72 typedef void VncSendHextileTile(VncState *vs,
73                                 int x, int y, int w, int h,
74                                 void *last_bg,
75                                 void *last_fg,
76                                 int *has_bg, int *has_fg);
77 
78 /* VNC_DIRTY_PIXELS_PER_BIT is the number of dirty pixels represented
79  * by one bit in the dirty bitmap, should be a power of 2 */
80 #define VNC_DIRTY_PIXELS_PER_BIT 16
81 
82 /* VNC_MAX_WIDTH must be a multiple of VNC_DIRTY_PIXELS_PER_BIT. */
83 
84 #define VNC_MAX_WIDTH ROUND_UP(5120, VNC_DIRTY_PIXELS_PER_BIT)
85 #define VNC_MAX_HEIGHT 2160
86 
87 /* VNC_DIRTY_BITS is the number of bits in the dirty bitmap. */
88 #define VNC_DIRTY_BITS (VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT)
89 
90 /* VNC_DIRTY_BPL (BPL = bits per line) might be greater than
91  * VNC_DIRTY_BITS due to alignment */
92 #define VNC_DIRTY_BPL(x) (sizeof((x)->dirty) / VNC_MAX_HEIGHT * BITS_PER_BYTE)
93 
94 #define VNC_STAT_RECT  64
95 #define VNC_STAT_COLS (VNC_MAX_WIDTH / VNC_STAT_RECT)
96 #define VNC_STAT_ROWS (VNC_MAX_HEIGHT / VNC_STAT_RECT)
97 
98 #define VNC_AUTH_CHALLENGE_SIZE 16
99 
100 typedef struct VncDisplay VncDisplay;
101 
102 #include "vnc-auth-vencrypt.h"
103 #ifdef CONFIG_VNC_SASL
104 #include "vnc-auth-sasl.h"
105 #endif
106 #include "vnc-ws.h"
107 
108 struct VncRectStat
109 {
110     /* time of last 10 updates, to find update frequency */
111     struct timeval times[10];
112     int idx;
113 
114     double freq;        /* Update frequency (in Hz) */
115     bool updated;       /* Already updated during this refresh */
116 };
117 
118 typedef struct VncRectStat VncRectStat;
119 
120 struct VncSurface
121 {
122     struct timeval last_freq_check;
123     DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT],
124                    VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT);
125     VncRectStat stats[VNC_STAT_ROWS][VNC_STAT_COLS];
126     pixman_image_t *fb;
127     pixman_format_code_t format;
128 };
129 
130 typedef enum VncShareMode {
131     VNC_SHARE_MODE_CONNECTING = 1,
132     VNC_SHARE_MODE_SHARED,
133     VNC_SHARE_MODE_EXCLUSIVE,
134     VNC_SHARE_MODE_DISCONNECTED,
135 } VncShareMode;
136 
137 typedef enum VncSharePolicy {
138     VNC_SHARE_POLICY_IGNORE = 1,
139     VNC_SHARE_POLICY_ALLOW_EXCLUSIVE,
140     VNC_SHARE_POLICY_FORCE_SHARED,
141 } VncSharePolicy;
142 
143 struct VncDisplay
144 {
145     QTAILQ_HEAD(, VncState) clients;
146     int num_connecting;
147     int num_shared;
148     int num_exclusive;
149     int connections_limit;
150     VncSharePolicy share_policy;
151     QIONetListener *listener;
152     QIONetListener *wslistener;
153     DisplaySurface *ds;
154     DisplayChangeListener dcl;
155     kbd_layout_t *kbd_layout;
156     int lock_key_sync;
157     QEMUPutLEDEntry *led;
158     int ledstate;
159     QKbdState *kbd;
160     QemuMutex mutex;
161 
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     int true_width; /* server surface width before rounding up */
168 
169     const char *id;
170     QTAILQ_ENTRY(VncDisplay) next;
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     VMChangeStateEntry *vmstate_handler_entry;
190 };
191 
192 typedef struct VncTight {
193     int type;
194     uint8_t quality;
195     uint8_t compression;
196     uint8_t pixel24;
197     Buffer tight;
198     Buffer tmp;
199     Buffer zlib;
200     Buffer gradient;
201 #ifdef CONFIG_VNC_JPEG
202     Buffer jpeg;
203 #endif
204 #ifdef CONFIG_PNG
205     Buffer png;
206 #endif
207     int levels[4];
208     z_stream stream[4];
209 } VncTight;
210 
211 typedef struct VncHextile {
212     VncSendHextileTile *send_tile;
213 } VncHextile;
214 
215 typedef struct VncZlib {
216     Buffer zlib;
217     Buffer tmp;
218     z_stream stream;
219     int level;
220 } VncZlib;
221 
222 typedef struct VncZrle {
223     int type;
224     Buffer fb;
225     Buffer zrle;
226     Buffer tmp;
227     Buffer zlib;
228     z_stream stream;
229     VncPalette palette;
230 } VncZrle;
231 
232 typedef struct VncZywrle {
233     int buf[VNC_ZRLE_TILE_WIDTH * VNC_ZRLE_TILE_HEIGHT];
234 } VncZywrle;
235 
236 struct VncRect
237 {
238     int x;
239     int y;
240     int w;
241     int h;
242 };
243 
244 struct VncRectEntry
245 {
246     struct VncRect rect;
247     QLIST_ENTRY(VncRectEntry) next;
248 };
249 
250 struct VncJob
251 {
252     VncState *vs;
253 
254     QLIST_HEAD(, VncRectEntry) rectangles;
255     QTAILQ_ENTRY(VncJob) next;
256 };
257 
258 typedef enum {
259     VNC_STATE_UPDATE_NONE,
260     VNC_STATE_UPDATE_INCREMENTAL,
261     VNC_STATE_UPDATE_FORCE,
262 } VncStateUpdate;
263 
264 #define VNC_MAGIC ((uint64_t)0x05b3f069b3d204bb)
265 
266 struct VncState
267 {
268     uint64_t magic;
269     QIOChannelSocket *sioc; /* The underlying socket */
270     QIOChannel *ioc; /* The channel currently used for I/O */
271     guint ioc_tag;
272     gboolean disconnecting;
273 
274     DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_DIRTY_BITS);
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     int client_endian; /* G_LITTLE_ENDIAN or G_BIG_ENDIAN */
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     VncHextile hextile;
343     VncZywrle zywrle;
344 
345     Notifier mouse_mode_notifier;
346 
347     QemuClipboardPeer cbpeer;
348     QemuClipboardInfo *cbinfo;
349     uint32_t cbpending;
350 
351     QTAILQ_ENTRY(VncState) next;
352 };
353 
354 typedef struct VncWorker {
355     uint8_t lossy_rect[VNC_STAT_ROWS][VNC_STAT_COLS];
356 
357     VncTight tight;
358     VncZlib zlib;
359     VncZrle zrle;
360 } VncWorker;
361 
362 typedef struct VncConnection {
363     VncState vs;
364     VncWorker worker;
365 } VncConnection;
366 
367 
368 /*****************************************************************************
369  *
370  * Authentication modes
371  *
372  *****************************************************************************/
373 
374 enum {
375     VNC_AUTH_INVALID = 0,
376     VNC_AUTH_NONE = 1,
377     VNC_AUTH_VNC = 2,
378     VNC_AUTH_RA2 = 5,
379     VNC_AUTH_RA2NE = 6,
380     VNC_AUTH_TIGHT = 16,
381     VNC_AUTH_ULTRA = 17,
382     VNC_AUTH_TLS = 18,      /* Supported in GTK-VNC & VINO */
383     VNC_AUTH_VENCRYPT = 19, /* Supported in GTK-VNC & VeNCrypt */
384     VNC_AUTH_SASL = 20,     /* Supported in GTK-VNC & VINO */
385 };
386 
387 enum {
388     VNC_AUTH_VENCRYPT_PLAIN = 256,
389     VNC_AUTH_VENCRYPT_TLSNONE = 257,
390     VNC_AUTH_VENCRYPT_TLSVNC = 258,
391     VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
392     VNC_AUTH_VENCRYPT_X509NONE = 260,
393     VNC_AUTH_VENCRYPT_X509VNC = 261,
394     VNC_AUTH_VENCRYPT_X509PLAIN = 262,
395     VNC_AUTH_VENCRYPT_X509SASL = 263,
396     VNC_AUTH_VENCRYPT_TLSSASL = 264,
397 };
398 
399 
400 /*****************************************************************************
401  *
402  * Encoding types
403  *
404  *****************************************************************************/
405 
406 #define VNC_ENCODING_RAW                  0x00000000
407 #define VNC_ENCODING_COPYRECT             0x00000001
408 #define VNC_ENCODING_RRE                  0x00000002
409 #define VNC_ENCODING_CORRE                0x00000004
410 #define VNC_ENCODING_HEXTILE              0x00000005
411 #define VNC_ENCODING_ZLIB                 0x00000006
412 #define VNC_ENCODING_TIGHT                0x00000007
413 #define VNC_ENCODING_ZLIBHEX              0x00000008
414 #define VNC_ENCODING_TRLE                 0x0000000f
415 #define VNC_ENCODING_ZRLE                 0x00000010
416 #define VNC_ENCODING_ZYWRLE               0x00000011
417 #define VNC_ENCODING_COMPRESSLEVEL0       0xFFFFFF00 /* -256 */
418 #define VNC_ENCODING_QUALITYLEVEL0        0xFFFFFFE0 /* -32  */
419 #define VNC_ENCODING_XCURSOR              0xFFFFFF10 /* -240 */
420 #define VNC_ENCODING_RICH_CURSOR          0xFFFFFF11 /* -239 */
421 #define VNC_ENCODING_POINTER_POS          0xFFFFFF18 /* -232 */
422 #define VNC_ENCODING_LASTRECT             0xFFFFFF20 /* -224 */
423 #define VNC_ENCODING_DESKTOPRESIZE        0xFFFFFF21 /* -223 */
424 #define VNC_ENCODING_POINTER_TYPE_CHANGE  0XFFFFFEFF /* -257 */
425 #define VNC_ENCODING_EXT_KEY_EVENT        0XFFFFFEFE /* -258 */
426 #define VNC_ENCODING_AUDIO                0XFFFFFEFD /* -259 */
427 #define VNC_ENCODING_TIGHT_PNG            0xFFFFFEFC /* -260 */
428 #define VNC_ENCODING_LED_STATE            0XFFFFFEFB /* -261 */
429 #define VNC_ENCODING_DESKTOP_RESIZE_EXT   0XFFFFFECC /* -308 */
430 #define VNC_ENCODING_XVP                  0XFFFFFECB /* -309 */
431 #define VNC_ENCODING_ALPHA_CURSOR         0XFFFFFEC6 /* -314 */
432 #define VNC_ENCODING_WMVi                 0x574D5669
433 #define VNC_ENCODING_CLIPBOARD_EXT        0xc0a1e5ce
434 
435 /*****************************************************************************
436  *
437  * Other tight constants
438  *
439  *****************************************************************************/
440 
441 /*
442  * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
443  */
444 
445 #define VNC_TIGHT_CCB_RESET_MASK   (0x0f)
446 #define VNC_TIGHT_CCB_TYPE_MASK    (0x0f << 4)
447 #define VNC_TIGHT_CCB_TYPE_FILL    (0x08 << 4)
448 #define VNC_TIGHT_CCB_TYPE_JPEG    (0x09 << 4)
449 #define VNC_TIGHT_CCB_TYPE_PNG     (0x0A << 4)
450 #define VNC_TIGHT_CCB_BASIC_MAX    (0x07 << 4)
451 #define VNC_TIGHT_CCB_BASIC_ZLIB   (0x03 << 4)
452 #define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
453 
454 /*****************************************************************************
455  *
456  * Features
457  *
458  *****************************************************************************/
459 
460 enum VncFeatures {
461     VNC_FEATURE_RESIZE,
462     VNC_FEATURE_RESIZE_EXT,
463     VNC_FEATURE_HEXTILE,
464     VNC_FEATURE_POINTER_TYPE_CHANGE,
465     VNC_FEATURE_WMVI,
466     VNC_FEATURE_TIGHT,
467     VNC_FEATURE_ZLIB,
468     VNC_FEATURE_RICH_CURSOR,
469     VNC_FEATURE_ALPHA_CURSOR,
470     VNC_FEATURE_TIGHT_PNG,
471     VNC_FEATURE_ZRLE,
472     VNC_FEATURE_ZYWRLE,
473     VNC_FEATURE_LED_STATE,
474     VNC_FEATURE_XVP,
475     VNC_FEATURE_CLIPBOARD_EXT,
476     VNC_FEATURE_AUDIO,
477 };
478 
479 
480 /* Client -> Server message IDs */
481 #define VNC_MSG_CLIENT_SET_PIXEL_FORMAT           0
482 #define VNC_MSG_CLIENT_SET_ENCODINGS              2
483 #define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3
484 #define VNC_MSG_CLIENT_KEY_EVENT                  4
485 #define VNC_MSG_CLIENT_POINTER_EVENT              5
486 #define VNC_MSG_CLIENT_CUT_TEXT                   6
487 #define VNC_MSG_CLIENT_VMWARE_0                   127
488 #define VNC_MSG_CLIENT_CALL_CONTROL               249
489 #define VNC_MSG_CLIENT_XVP                        250
490 #define VNC_MSG_CLIENT_SET_DESKTOP_SIZE           251
491 #define VNC_MSG_CLIENT_TIGHT                      252
492 #define VNC_MSG_CLIENT_GII                        253
493 #define VNC_MSG_CLIENT_VMWARE_1                   254
494 #define VNC_MSG_CLIENT_QEMU                       255
495 
496 /* Server -> Client message IDs */
497 #define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE         0
498 #define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES     1
499 #define VNC_MSG_SERVER_BELL                       2
500 #define VNC_MSG_SERVER_CUT_TEXT                   3
501 #define VNC_MSG_SERVER_VMWARE_0                   127
502 #define VNC_MSG_SERVER_CALL_CONTROL               249
503 #define VNC_MSG_SERVER_XVP                        250
504 #define VNC_MSG_SERVER_TIGHT                      252
505 #define VNC_MSG_SERVER_GII                        253
506 #define VNC_MSG_SERVER_VMWARE_1                   254
507 #define VNC_MSG_SERVER_QEMU                       255
508 
509 
510 
511 /* QEMU client -> server message IDs */
512 #define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT         0
513 #define VNC_MSG_CLIENT_QEMU_AUDIO                 1
514 
515 /* QEMU server -> client message IDs */
516 #define VNC_MSG_SERVER_QEMU_AUDIO                 1
517 
518 
519 
520 /* QEMU client -> server audio message IDs */
521 #define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE          0
522 #define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE         1
523 #define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT      2
524 
525 /* QEMU server -> client audio message IDs */
526 #define VNC_MSG_SERVER_QEMU_AUDIO_END             0
527 #define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN           1
528 #define VNC_MSG_SERVER_QEMU_AUDIO_DATA            2
529 
530 /* XVP server -> client status code */
531 #define VNC_XVP_CODE_FAIL 0
532 #define VNC_XVP_CODE_INIT 1
533 
534 /* XVP client -> server action request  */
535 #define VNC_XVP_ACTION_SHUTDOWN 2
536 #define VNC_XVP_ACTION_REBOOT 3
537 #define VNC_XVP_ACTION_RESET 4
538 
539 /* extended clipboard flags  */
540 #define VNC_CLIPBOARD_TEXT     (1 << 0)
541 #define VNC_CLIPBOARD_RTF      (1 << 1)
542 #define VNC_CLIPBOARD_HTML     (1 << 2)
543 #define VNC_CLIPBOARD_DIB      (1 << 3)
544 #define VNC_CLIPBOARD_FILES    (1 << 4)
545 #define VNC_CLIPBOARD_CAPS     (1 << 24)
546 #define VNC_CLIPBOARD_REQUEST  (1 << 25)
547 #define VNC_CLIPBOARD_PEEK     (1 << 26)
548 #define VNC_CLIPBOARD_NOTIFY   (1 << 27)
549 #define VNC_CLIPBOARD_PROVIDE  (1 << 28)
550 
551 /*****************************************************************************
552  *
553  * Internal APIs
554  *
555  *****************************************************************************/
556 
557 /* Event loop functions */
558 gboolean vnc_client_io(QIOChannel *ioc,
559                        GIOCondition condition,
560                        void *opaque);
561 
562 size_t vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
563 size_t vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);
564 
565 /* Protocol I/O functions */
566 void vnc_write(VncState *vs, const void *data, size_t len);
567 void vnc_write_u32(VncState *vs, uint32_t value);
568 void vnc_write_s32(VncState *vs, int32_t value);
569 void vnc_write_u16(VncState *vs, uint16_t value);
570 void vnc_write_u8(VncState *vs, uint8_t value);
571 void vnc_flush(VncState *vs);
572 void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting);
573 void vnc_disconnect_finish(VncState *vs);
574 void vnc_start_protocol(VncState *vs);
575 
576 
577 /* Buffer I/O functions */
578 uint32_t read_u32(uint8_t *data, size_t offset);
579 
580 /* Protocol stage functions */
581 void vnc_client_error(VncState *vs);
582 size_t vnc_client_io_error(VncState *vs, ssize_t ret, Error *err);
583 
584 void start_client_init(VncState *vs);
585 void start_auth_vnc(VncState *vs);
586 
587 
588 /* Misc helpers */
589 
vnc_has_feature(VncState * vs,int feature)590 static inline uint32_t vnc_has_feature(VncState *vs, int feature) {
591     return (vs->features & (1 << feature));
592 }
593 
vnc_set_feature(VncState * vs,enum VncFeatures feature)594 static inline void vnc_set_feature(VncState *vs, enum VncFeatures feature)
595 {
596     vs->features |= (1 << feature);
597 }
598 
599 /* Framebuffer */
600 void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h,
601                             int32_t encoding);
602 
603 /* server fb is in PIXMAN_x8r8g8b8 */
604 #define VNC_SERVER_FB_FORMAT PIXMAN_FORMAT(32, PIXMAN_TYPE_ARGB, 0, 8, 8, 8)
605 #define VNC_SERVER_FB_BITS   (PIXMAN_FORMAT_BPP(VNC_SERVER_FB_FORMAT))
606 #define VNC_SERVER_FB_BYTES  ((VNC_SERVER_FB_BITS+7)/8)
607 
608 void *vnc_server_fb_ptr(VncDisplay *vd, int x, int y);
609 int vnc_server_fb_stride(VncDisplay *vd);
610 
611 void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v);
612 double vnc_update_freq(VncState *vs, int x, int y, int w, int h);
613 void vnc_sent_lossy_rect(VncWorker *worker, int x, int y, int w, int h);
614 
615 /* Encodings */
616 int vnc_send_framebuffer_update(VncState *vs, VncWorker *worker,
617                                 int x, int y, int w, int h);
618 
619 int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
620 
621 int vnc_hextile_send_framebuffer_update(VncState *vs, int x,
622                                          int y, int w, int h);
623 void vnc_hextile_set_pixel_conversion(VncState *vs, int generic);
624 
625 void *vnc_zlib_zalloc(void *x, unsigned items, unsigned size);
626 void vnc_zlib_zfree(void *x, void *addr);
627 int vnc_zlib_send_framebuffer_update(VncState *vs, VncWorker *worker,
628                                      int x, int y, int w, int h);
629 void vnc_zlib_clear(VncWorker *worker);
630 
631 int vnc_tight_send_framebuffer_update(VncState *vs, VncWorker *worker,
632                                       int x, int y, int w, int h);
633 int vnc_tight_png_send_framebuffer_update(VncState *vs, VncWorker *worker,
634                                           int x, int y, int w, int h);
635 void vnc_tight_clear(VncWorker *worker);
636 
637 int vnc_zrle_send_framebuffer_update(VncState *vs, VncWorker *worker,
638                                      int x, int y, int w, int h);
639 int vnc_zywrle_send_framebuffer_update(VncState *vs, VncWorker *worker,
640                                        int x, int y, int w, int h);
641 void vnc_zrle_clear(VncWorker *worker);
642 
643 /* vnc-clipboard.c */
644 void vnc_server_cut_text_caps(VncState *vs);
645 void vnc_client_cut_text(VncState *vs, size_t len, uint8_t *text);
646 void vnc_client_cut_text_ext(VncState *vs, int32_t len, uint32_t flags, uint8_t *data);
647 
648 #endif /* QEMU_VNC_H */
649