/usr/lib/spice-protocol/spice1.proto is in libspice-protocol-dev 0.12.10-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 | /* built in types:
int8, uint8, 16, 32, 64
*/
typedef fixed28_4 int32 @ctype(SPICE_FIXED28_4);
struct Point {
int32 x;
int32 y;
};
struct Point16 {
int16 x;
int16 y;
};
struct PointFix {
fixed28_4 x;
fixed28_4 y;
};
struct Rect {
int32 top;
int32 left;
int32 bottom;
int32 right;
};
enum32 link_err {
OK,
ERROR,
INVALID_MAGIC,
INVALID_DATA,
VERSION_MISMATCH,
NEED_SECURED,
NEED_UNSECURED,
PERMISSION_DENIED,
BAD_CONNECTION_ID,
CHANNEL_NOT_AVAILABLE
};
enum32 warn_code {
WARN_GENERAL
} @prefix(SPICE_);
enum32 info_code {
INFO_GENERAL
} @prefix(SPICE_);
flags32 migrate_flags {
NEED_FLUSH,
NEED_DATA_TRANSFER
} @prefix(SPICE_MIGRATE_);
enum32 notify_severity {
INFO,
WARN,
ERROR,
};
enum32 notify_visibility {
LOW,
MEDIUM,
HIGH,
};
flags32 mouse_mode {
SERVER,
CLIENT,
};
enum16 pubkey_type {
INVALID,
RSA,
RSA2,
DSA,
DSA1,
DSA2,
DSA3,
DSA4,
DH,
EC,
};
message Empty {
};
message Data {
uint8 data[] @end @ctype(uint8_t);
} @nocopy;
struct ChannelWait {
uint8 channel_type;
uint8 channel_id;
uint64 message_serial;
} @ctype(SpiceWaitForChannel);
channel BaseChannel {
server:
message {
migrate_flags flags;
} migrate;
Data migrate_data;
message {
uint32 generation;
uint32 window;
} set_ack;
message {
uint32 id;
uint64 timestamp;
uint8 data[] @ctype(uint8_t) @as_ptr(data_len);
} ping;
message {
uint8 wait_count;
ChannelWait wait_list[wait_count] @end;
} wait_for_channels;
message {
uint64 time_stamp;
link_err reason;
} @ctype(SpiceMsgDisconnect) disconnecting;
message {
uint64 time_stamp;
notify_severity severity;
notify_visibility visibilty;
uint32 what; /* error_code/warn_code/info_code */
uint32 message_len;
uint8 message[message_len] @end @nomarshal;
uint8 zero @end @ctype(uint8_t) @nomarshal;
} notify;
client:
message {
uint32 generation;
} ack_sync;
Empty ack;
message {
uint32 id;
uint64 timestamp;
} @ctype(SpiceMsgPing) pong;
Empty migrate_flush_mark;
Data migrate_data;
message {
uint64 time_stamp;
link_err reason;
} @ctype(SpiceMsgDisconnect) disconnecting;
};
struct ChannelId {
uint8 type;
uint8 id;
};
struct DstInfo {
uint16 port;
uint16 sport;
uint32 host_offset @zero;
uint32 host_size;
pubkey_type pub_key_type @minor(1);
uint32 pub_key_offset @minor(1) @zero;
uint32 pub_key_size @minor(1);
uint8 host_data[host_size] @as_ptr @zero_terminated;
uint8 pub_key_data[pub_key_size] @minor(1) @as_ptr @zero_terminated;
} @ctype(SpiceMigrationDstInfo);
channel MainChannel : BaseChannel {
server:
message {
DstInfo dst_info;
} @ctype(SpiceMsgMainMigrationBegin) migrate_begin = 101;
Empty migrate_cancel;
message {
uint32 session_id;
uint32 display_channels_hint;
uint32 supported_mouse_modes;
uint32 current_mouse_mode;
uint32 agent_connected;
uint32 agent_tokens;
uint32 multi_media_time;
uint32 ram_hint;
} init;
message {
uint32 num_of_channels;
ChannelId channels[num_of_channels] @end;
} @ctype(SpiceMsgChannels) channels_list;
message {
mouse_mode supported_modes;
mouse_mode current_mode @unique_flag;
} mouse_mode;
message {
uint32 time;
} @ctype(SpiceMsgMainMultiMediaTime) multi_media_time;
Empty agent_connected;
message {
link_err error_code;
} @ctype(SpiceMsgMainAgentDisconnect) agent_disconnected;
Data agent_data;
message {
uint32 num_tokens;
} @ctype(SpiceMsgMainAgentTokens) agent_token;
message {
uint16 port;
uint16 sport;
uint32 host_offset @zero;
uint32 host_size;
uint32 cert_subject_offset @zero;
uint32 cert_subject_size;
uint8 host_data[host_size] @as_ptr @zero_terminated;
uint8 cert_subject_data[cert_subject_size] @as_ptr @zero_terminated;
} @ctype(SpiceMsgMainMigrationSwitchHost) migrate_switch_host;
client:
message {
uint64 cache_size;
} @ctype(SpiceMsgcClientInfo) client_info = 101;
Empty migrate_connected;
Empty migrate_connect_error;
Empty attach_channels;
message {
mouse_mode mode;
} mouse_mode_request;
message {
uint32 num_tokens;
} agent_start;
Data agent_data;
message {
uint32 num_tokens;
} @ctype(SpiceMsgcMainAgentTokens) agent_token;
};
enum32 clip_type {
NONE,
RECTS
};
flags32 path_flags { /* TODO: C enum names changes */
BEGIN = 0,
END = 1,
CLOSE = 3,
BEZIER = 4,
} @prefix(SPICE_PATH_);
enum32 video_codec_type {
MJPEG = 1,
};
flags32 stream_flags {
TOP_DOWN = 0,
};
enum32 brush_type {
NONE,
SOLID,
PATTERN,
};
flags8 mask_flags {
INVERS,
};
enum8 image_type {
BITMAP,
QUIC,
RESERVED,
LZ_PLT = 100,
LZ_RGB,
GLZ_RGB,
FROM_CACHE,
};
flags8 image_flags {
CACHE_ME,
};
enum8 bitmap_fmt {
INVALID,
1BIT_LE,
1BIT_BE,
4BIT_LE,
4BIT_BE,
8BIT /* 8bit indexed mode */,
16BIT, /* 0555 mode */
24BIT /* 3 byte, brg */,
32BIT /* 4 byte, xrgb in little endian format */,
RGBA /* 4 byte, argb in little endian format */
};
flags8 bitmap_flags {
PAL_CACHE_ME,
PAL_FROM_CACHE,
TOP_DOWN,
};
enum8 image_scale_mode {
INTERPOLATE,
NEAREST,
};
flags16 ropd {
INVERS_SRC,
INVERS_BRUSH,
INVERS_DEST,
OP_PUT,
OP_OR,
OP_AND,
OP_XOR,
OP_BLACKNESS,
OP_WHITENESS,
OP_INVERS,
INVERS_RES,
};
flags8 line_flags {
STYLED = 3,
START_WITH_GAP = 2,
};
enum8 line_cap {
ROUND,
SQUARE,
BUTT,
};
enum8 line_join {
ROUND,
BEVEL,
MITER,
};
flags16 string_flags {
RASTER_A1,
RASTER_A4,
RASTER_A8,
RASTER_TOP_DOWN,
};
enum8 resource_type {
INVALID,
PIXMAP
} @prefix(SPICE_RES_TYPE_);
struct ClipRects {
uint32 num_rects;
Rect rects[num_rects] @end;
};
struct PathSegment {
path_flags flags;
uint32 count;
PointFix points[count] @end;
} @ctype(SpicePathSeg);
struct Path {
uint32 segments_size @bytes_count(num_segments);
PathSegment segments[bytes(segments_size, num_segments)] @ptr_array;
};
struct Clip {
clip_type type;
switch (type) {
case RECTS:
ClipRects *rects @outvar(cliprects);
default:
uint64 data @zero;
} u @anon;
};
struct DisplayBase {
uint32 surface_id @virtual(0);
Rect box;
Clip clip;
} @ctype(SpiceMsgDisplayBase);
struct ResourceID {
uint8 type;
uint64 id;
};
struct WaitForChannel {
uint8 channel_type;
uint8 channel_id;
uint64 message_serial;
};
struct Palette {
uint64 unique;
uint16 num_ents;
uint32 ents[num_ents] @end;
};
struct BitmapData {
bitmap_fmt format;
bitmap_flags flags;
uint32 x;
uint32 y;
uint32 stride;
switch (flags) {
case PAL_FROM_CACHE:
uint64 palette_id;
default:
Palette *palette @outvar(bitmap);
} pal @anon;
uint8 *data[image_size(8, stride, y)] @chunk; /* pointer to array, not array of pointers as in C */
} @ctype(SpiceBitmap);
struct BinaryData {
uint32 data_size;
uint8 data[data_size] @nomarshal @chunk;
} @ctype(SpiceQUICData);
struct LZPLTData {
bitmap_flags flags;
uint32 data_size;
switch (flags) {
case PAL_FROM_CACHE:
uint64 palette_id;
default:
Palette *palette @nonnull @outvar(lzplt);
} pal @anon;
uint8 data[data_size] @nomarshal @chunk;
};
struct Image {
struct ImageDescriptor {
uint64 id;
image_type type;
image_flags flags;
uint32 width;
uint32 height;
} descriptor;
switch (descriptor.type) {
case BITMAP:
BitmapData bitmap;
case QUIC:
BinaryData quic;
case LZ_RGB:
case GLZ_RGB:
BinaryData lz_rgb;
case LZ_PLT:
LZPLTData lz_plt;
} u;
};
struct Pattern {
Image *pat @nonnull;
Point pos;
};
struct Brush {
brush_type type;
switch (type) {
case SOLID:
uint32 color;
case PATTERN:
Pattern pattern;
} u @fixedsize;
};
struct QMask {
mask_flags flags;
Point pos;
Image *bitmap;
};
struct LineAttr {
line_flags flags;
line_join join_style @zero;
line_cap end_style @zero;
uint8 style_nseg;
fixed28_4 width @zero;
fixed28_4 miter_limit @zero;
fixed28_4 *style[style_nseg];
};
struct RasterGlyphA1 {
Point render_pos;
Point glyph_origin;
uint16 width;
uint16 height;
uint8 data[image_size(1, width, height)] @end;
} @ctype(SpiceRasterGlyph);
struct RasterGlyphA4 {
Point render_pos;
Point glyph_origin;
uint16 width;
uint16 height;
uint8 data[image_size(4, width, height)] @end;
} @ctype(SpiceRasterGlyph);
struct RasterGlyphA8 {
Point render_pos;
Point glyph_origin;
uint16 width;
uint16 height;
uint8 data[image_size(8, width, height)] @end;
} @ctype(SpiceRasterGlyph);
struct String {
uint16 length;
string_flags flags; /* Special: Only one of a1/a4/a8 set */
switch (flags) {
case RASTER_A1:
RasterGlyphA1 glyphs[length] @ctype(SpiceRasterGlyph) @ptr_array;
case RASTER_A4:
RasterGlyphA4 glyphs[length] @ctype(SpiceRasterGlyph) @ptr_array;
case RASTER_A8:
RasterGlyphA8 glyphs[length] @ctype(SpiceRasterGlyph) @ptr_array;
} u @anon;
};
struct StreamDataHeader {
uint32 id;
uint32 multi_media_time;
};
channel DisplayChannel : BaseChannel {
server:
message {
uint32 x_res;
uint32 y_res;
uint32 bits;
} mode = 101;
Empty mark;
Empty reset;
message {
DisplayBase base;
Point src_pos;
} copy_bits;
message {
uint16 count;
ResourceID resources[count] @end;
} @ctype(SpiceResourceList) inval_list;
message {
uint8 wait_count;
WaitForChannel wait_list[wait_count] @end;
} @ctype(SpiceMsgWaitForChannels) inval_all_pixmaps;
message {
uint64 id;
} @ctype(SpiceMsgDisplayInvalOne) inval_palette;
Empty inval_all_palettes;
message {
uint32 surface_id @virtual(0);
uint32 id;
stream_flags flags;
video_codec_type codec_type;
uint64 stamp;
uint32 stream_width;
uint32 stream_height;
uint32 src_width;
uint32 src_height;
Rect dest;
Clip clip;
} stream_create = 122;
message {
StreamDataHeader base;
uint32 data_size;
uint32 pad_size @zero;
uint8 data[data_size] @end @nomarshal;
/* Ignore: uint8 padding[pad_size] */
} stream_data;
message {
uint32 id;
Clip clip;
} stream_clip;
message {
uint32 id;
} stream_destroy;
Empty stream_destroy_all;
message {
DisplayBase base;
struct Fill {
Brush brush @outvar(brush);
uint16 rop_descriptor;
QMask mask @outvar(mask);
} data;
} draw_fill = 302;
message {
DisplayBase base;
struct Opaque {
Image *src_bitmap;
Rect src_area;
Brush brush;
ropd rop_descriptor;
image_scale_mode scale_mode;
QMask mask @outvar(mask);
} data;
} draw_opaque;
message {
DisplayBase base;
struct Copy {
Image *src_bitmap;
Rect src_area;
ropd rop_descriptor;
image_scale_mode scale_mode;
QMask mask @outvar(mask);
} data;
} draw_copy;
message {
DisplayBase base;
struct Blend {
Image *src_bitmap;
Rect src_area;
ropd rop_descriptor;
image_scale_mode scale_mode;
QMask mask @outvar(mask);
} @ctype(SpiceCopy) data;
} draw_blend;
message {
DisplayBase base;
struct Blackness {
QMask mask @outvar(mask);
} data;
} draw_blackness;
message {
DisplayBase base;
struct Whiteness {
QMask mask @outvar(mask);
} data;
} draw_whiteness;
message {
DisplayBase base;
struct Invers {
QMask mask @outvar(mask);
} data;
} draw_invers;
message {
DisplayBase base;
struct Rop3 {
Image *src_bitmap;
Rect src_area;
Brush brush;
uint8 rop3;
image_scale_mode scale_mode;
QMask mask @outvar(mask);
} data;
} draw_rop3;
message {
DisplayBase base;
struct Stroke {
Path *path;
LineAttr attr;
Brush brush;
uint16 fore_mode;
uint16 back_mode;
} data;
} draw_stroke;
message {
DisplayBase base;
struct Text {
String *str;
Rect back_area;
Brush fore_brush @outvar(fore_brush);
Brush back_brush @outvar(back_brush);
uint16 fore_mode;
uint16 back_mode;
} data;
} draw_text;
message {
DisplayBase base;
struct Transparent {
Image *src_bitmap;
Rect src_area;
uint32 src_color;
uint32 true_color;
} data;
} draw_transparent;
message {
DisplayBase base;
struct AlphaBlend {
int8 alpha_flags @virtual(0);
uint8 alpha;
Image *src_bitmap;
Rect src_area;
} data;
} draw_alpha_blend;
client:
message {
uint8 pixmap_cache_id;
int64 pixmap_cache_size; //in pixels
uint8 glz_dictionary_id;
int32 glz_dictionary_window_size; // in pixels
} init = 101;
};
flags32 keyboard_modifier_flags {
SCROLL_LOCK,
NUM_LOCK,
CAPS_LOCK
};
enum32 mouse_button {
INVALID,
LEFT,
MIDDLE,
RIGHT,
UP,
DOWN,
};
flags32 mouse_button_mask {
LEFT,
MIDDLE,
RIGHT
};
channel InputsChannel : BaseChannel {
client:
message {
uint32 code;
} @ctype(SpiceMsgcKeyDown) key_down = 101;
message {
uint32 code;
} @ctype(SpiceMsgcKeyUp) key_up;
message {
keyboard_modifier_flags modifiers;
} @ctype(SpiceMsgcKeyModifiers) key_modifiers;
message {
int32 dx;
int32 dy;
mouse_button_mask buttons_state;
} @ctype(SpiceMsgcMouseMotion) mouse_motion = 111;
message {
uint32 x;
uint32 y;
mouse_button_mask buttons_state;
uint8 display_id;
} @ctype(SpiceMsgcMousePosition) mouse_position;
message {
mouse_button button;
mouse_button_mask buttons_state;
} @ctype(SpiceMsgcMousePress) mouse_press;
message {
mouse_button button;
mouse_button_mask buttons_state;
} @ctype(SpiceMsgcMouseRelease) mouse_release;
server:
message {
keyboard_modifier_flags keyboard_modifiers;
} init = 101;
message {
keyboard_modifier_flags modifiers;
} key_modifiers;
Empty mouse_motion_ack = 111;
};
enum16 cursor_type {
ALPHA,
MONO,
COLOR4,
COLOR8,
COLOR16,
COLOR24,
COLOR32,
};
flags32 cursor_flags {
NONE, /* Means no cursor */
CACHE_ME,
FROM_CACHE,
};
struct CursorHeader {
uint64 unique;
cursor_type type;
uint16 width;
uint16 height;
uint16 hot_spot_x;
uint16 hot_spot_y;
};
struct Cursor {
cursor_flags flags;
CursorHeader header;
uint8 data[] @as_ptr(data_size);
};
channel CursorChannel : BaseChannel {
server:
message {
Point16 position;
uint16 trail_length;
uint16 trail_frequency;
uint8 visible;
Cursor cursor;
} init = 101;
Empty reset;
message {
Point16 position;
uint8 visible;
Cursor cursor;
} set;
message {
Point16 position;
} move;
Empty hide;
message {
uint16 length;
uint16 frequency;
} trail;
message {
uint64 id;
} @ctype(SpiceMsgDisplayInvalOne) inval_one;
Empty inval_all;
};
enum32 audio_data_mode {
INVALID,
RAW,
CELT_0_5_1,
OPUS,
};
enum32 audio_fmt {
INVALID,
S16,
};
channel PlaybackChannel : BaseChannel {
server:
message {
uint32 time;
uint8 data[] @as_ptr(data_size);
} @ctype(SpiceMsgPlaybackPacket) data = 101;
message {
uint32 time;
audio_data_mode mode;
uint8 data[] @as_ptr(data_size);
} mode;
message {
uint32 channels;
audio_fmt format;
uint32 frequency;
uint32 time;
} start;
Empty stop;
};
channel RecordChannel : BaseChannel {
server:
message {
uint32 channels;
audio_fmt format;
uint32 frequency;
} start = 101;
Empty stop;
client:
message {
uint32 time;
uint8 data[] @nomarshal @as_ptr(data_size);
} @ctype(SpiceMsgcRecordPacket) data = 101;
message {
uint32 time;
audio_data_mode mode;
uint8 data[] @as_ptr(data_size);
} mode;
message {
uint32 time;
} start_mark;
};
protocol Spice {
MainChannel main = 1;
DisplayChannel display;
InputsChannel inputs;
CursorChannel cursor;
PlaybackChannel playback;
RecordChannel record;
};
|