LXR qemu/ui/vnc.h

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