[Spice-devel] [RFC PATH 1/3] Add protocol to send streams to server

[Frediano Ziglio]

This protocol allows a guest to send a video stream to the server.

Signed-off-by: Frediano Ziglio <fziglio at redhat.com>
---
 spice/Makefile.am     |  1 +
 spice/stream-device.h | 83 +++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 84 insertions(+)
 create mode 100644 spice/stream-device.h

diff --git a/spice/Makefile.am b/spice/Makefile.am
index a54ae89..4f9a607 100644
--- a/spice/Makefile.am
+++ b/spice/Makefile.am
@@ -19,6 +19,7 @@ spice_protocol_include_HEADERS =		\
 	types.h					\
 	vd_agent.h				\
 	vdi_dev.h				\
+	stream-device.h				\
 	$(NULL)
 
 -include $(top_srcdir)/git.mk
diff --git a/spice/stream-device.h b/spice/stream-device.h
new file mode 100644
index 0000000..4d1e3a2
--- /dev/null
+++ b/spice/stream-device.h
@@ -0,0 +1,83 @@
+/*
+   Copyright (C) 2017 Red Hat, Inc.
+
+   This library is free software; you can redistribute it and/or
+   modify it under the terms of the GNU Lesser General Public
+   License as published by the Free Software Foundation; either
+   version 2.1 of the License, or (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU Lesser General Public
+   License along with this library; if not, see <http://www.gnu.org/licenses/>.
+*/
+
+/*
+ * This header contains definition for the device that
+ * allows to send streamed data to the server.
+ */
+
+#ifndef SPICE_STREAM_DEVICE_H_
+#define SPICE_STREAM_DEVICE_H_
+
+#include <spice/types.h>
+
+/*
+ * The structure are all "naturally aligned"
+ * containing integers up to 64 bit.
+ * All numbers are in little endian format.
+ */
+
+#define STREAM_DEVICE_PROTOCOL 1
+
+typedef struct StreamDevHeader {
+    /* should be STREAM_DEVICE_PROTOCOL */
+    uint8_t protocol_version;
+    uint8_t padding;
+    /* as defined in StreamDevType enumeration */
+    uint16_t type;
+    /* size of the following message */
+    uint32_t size;
+} StreamDevHeader;
+
+typedef enum StreamDevType {
+    /* invalid, do not use */
+    STREAM_TYPE_INVALID = 0,
+    /* allows to send version information */
+    STREAM_TYPE_CAPABILITIES,
+    /* send screen resolution */
+    STREAM_TYPE_FORMAT,
+    /* stream data */
+    STREAM_TYPE_DATA,
+} StreamDevType;
+
+/* generic extension capabilities */
+typedef struct StreamMsgCapabilities {
+    uint32_t num_capabilities;
+    uint32_t capabilities[0];
+} StreamMsgCapabilities;
+
+/* Define the format of the stream, start a new stream.
+ * This message is sent by the guest to the host to
+ * tell the host the new stream format.
+ */
+typedef struct StreamMsgFormat {
+    /* screen resolution/stream size */
+    uint32_t width;
+    uint32_t height;
+    /* as defined in SpiceVideoCodecType enumeration */
+    uint8_t codec;
+    uint8_t padding1[3];
+} StreamMsgFormat;
+
+/* This message contains just raw data stream.
+ * This message is sent by the guest to the host.
+ */
+typedef struct StreamMsgData {
+    uint8_t data[0];
+} StreamMsgData;
+
+#endif /* SPICE_STREAM_DEVICE_H_ */
-- 
2.9.3