[Spice-devel] [PATCH] Basic SPICE port implementation

Oliver Gutierrez ogutierrez at redhat.com
Mon Oct 3 12:09:58 UTC 2016


---
 enums.js        |  9 ++++++
 main.js         |  3 ++
 port.js         | 85 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 spice.html      | 13 +++++++++
 spice_auto.html | 13 +++++++++
 spicemsg.js     | 18 ++++++++++++
 utils.js        |  7 +++++
 7 files changed, 148 insertions(+)
 create mode 100644 port.js

diff --git a/enums.js b/enums.js
index 301fea0..b6e013c 100644
--- a/enums.js
+++ b/enums.js
@@ -166,6 +166,15 @@ var SPICE_MSG_PLAYBACK_VOLUME           = 105;
 var SPICE_MSG_PLAYBACK_MUTE             = 106;
 var SPICE_MSG_PLAYBACK_LATENCY          = 107;
 
+var SPICE_MSG_SPICEVMC_DATA             = 101;
+var SPICE_MSG_PORT_INIT                 = 201;
+var SPICE_MSG_PORT_EVENT                = 202;
+var SPICE_MSG_END_PORT                  = 203;
+
+var SPICE_MSGC_SPICEVMC_DATA            = 101;
+var SPICE_MSGC_PORT_EVENT               = 201;
+var SPICE_MSGC_END_PORT                 = 202;
+
 var SPICE_PLAYBACK_CAP_CELT_0_5_1       = 0;
 var SPICE_PLAYBACK_CAP_VOLUME           = 1;
 var SPICE_PLAYBACK_CAP_LATENCY          = 2;
diff --git a/main.js b/main.js
index 874a038..2d8a1ff 100644
--- a/main.js
+++ b/main.js
@@ -59,6 +59,7 @@ function SpiceMainConn()
     this.file_xfer_tasks = {};
     this.file_xfer_task_id = 0;
     this.file_xfer_read_queue = [];
+    this.ports = [];
 }
 
 SpiceMainConn.prototype = Object.create(SpiceConn.prototype);
@@ -154,6 +155,8 @@ SpiceMainConn.prototype.process_channel_message = function(msg)
                 this.cursor = new SpiceCursorConn(conn);
             else if (chans.channels[i].type == SPICE_CHANNEL_PLAYBACK)
                 this.cursor = new SpicePlaybackConn(conn);
+            else if (chans.channels[i].type == SPICE_CHANNEL_PORT)
+                this.ports.push(new SpicePortConn(conn));
             else
             {
                 if (! ("extra_channels" in this))
diff --git a/port.js b/port.js
new file mode 100644
index 0000000..ee22073
--- /dev/null
+++ b/port.js
@@ -0,0 +1,85 @@
+"use strict";
+/*
+   Copyright (C) 2016 by Oliver Gutierrez <ogutsua at gmail.com>
+                         Miroslav Chodil <mchodil at redhat.com>
+
+   This file is part of spice-html5.
+
+   spice-html5 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 3 of the License, or
+   (at your option) any later version.
+
+   spice-html5 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 Lesser General Public License for more details.
+
+   You should have received a copy of the GNU Lesser General Public License
+   along with spice-html5.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/*----------------------------------------------------------------------------
+**  SpicePortConn
+**      Drive the Spice Port Channel
+**--------------------------------------------------------------------------*/
+function SpicePortConn()
+{
+    DEBUG > 0 && console.log('SPICE port: created SPICE port channel. Args:', arguments);
+    SpiceConn.apply(this, arguments);
+    this.port_name = null;
+}
+
+SpicePortConn.prototype = Object.create(SpiceConn.prototype);
+
+SpicePortConn.prototype.process_channel_message = function(msg)
+{
+    if (msg.type == SPICE_MSG_PORT_INIT)
+    {
+        if (this.port_name === null)
+        {
+            var m = new SpiceMsgPortInit(msg.data);
+            this.portName = arraybuffer_to_str(new Uint8Array(m.name));
+            this.portOpened = m.opened
+            DEBUG > 0 && console.log('SPICE port: Port', this.portName, 'initialized');
+            return true;
+        }
+
+        DEBUG > 0 && console.log('SPICE port: Port', this.port_name, 'is already initialized.');
+    }
+    else if (msg.type == SPICE_MSG_PORT_EVENT)
+    {
+        DEBUG > 0 && console.log('SPICE port: Port event received for', this.portName, msg);
+        var event = new CustomEvent('spice-port-event', {
+            detail: {
+                channel: this,
+                spiceEvent: new Uint8Array(msg.data)
+            },
+            bubbles: true,
+            cancelable: true
+        });
+
+        window.dispatchEvent(event);
+        return true;
+    }
+    else if (msg.type == SPICE_MSG_SPICEVMC_DATA)
+    {
+        DEBUG > 0 && console.log('SPICE port: Data received in port', this.portName, msg);
+        var event = new CustomEvent('spice-port-data', {
+            detail: {
+                channel: this,
+                data: msg.data
+            },
+            bubbles: true,
+            cancelable: true
+        });
+        window.dispatchEvent(event);
+        return true;
+    }
+    else
+    {
+        DEBUG > 0 && console.log('SPICE port: SPICE message type not recognized:', msg)
+    }
+
+    return false;
+};
diff --git a/spice.html b/spice.html
index c473678..d4c9962 100644
--- a/spice.html
+++ b/spice.html
@@ -42,6 +42,7 @@
         <script src="wire.js"></script>
         <script src="spiceconn.js"></script>
         <script src="display.js"></script>
+        <script src="port.js"></script>
         <script src="main.js"></script>
         <script src="inputs.js"></script>
         <script src="webm.js"></script>
@@ -142,6 +143,18 @@
                 }
             }
 
+            /* SPICE port event listeners
+            window.addEventListener('spice-port-data', function(event) {
+                // Here we convert data to text, but really we can obtain binary data also
+                var msg_text = arraybuffer_to_str(new Uint8Array(event.detail.data));
+                DEBUG > 0 && console.log('SPICE port', event.detail.channel.portName, 'message text:', msg_text);
+            });
+
+            window.addEventListener('spice-port-event', function(event) {
+                DEBUG > 0 && console.log('SPICE port', event.detail.channel.portName, 'event data:', event.detail.spiceEvent);
+            });
+            */
+
         </script>
 
     </head>
diff --git a/spice_auto.html b/spice_auto.html
index 1179ebe..2f04fc9 100644
--- a/spice_auto.html
+++ b/spice_auto.html
@@ -42,6 +42,7 @@
         <script src="wire.js"></script>
         <script src="spiceconn.js"></script>
         <script src="display.js"></script>
+        <script src="port.js"></script>
         <script src="main.js"></script>
         <script src="inputs.js"></script>
         <script src="webm.js"></script>
@@ -182,6 +183,18 @@
                 }
             }
 
+            /* SPICE port event listeners
+            window.addEventListener('spice-port-data', function(event) {
+                // Here we convert data to text, but really we can obtain binary data also
+                var msg_text = arraybuffer_to_str(new Uint8Array(event.detail.data));
+                DEBUG > 0 && console.log('SPICE port', event.detail.channel.portName, 'message text:', msg_text);
+            });
+
+            window.addEventListener('spice-port-event', function(event) {
+                DEBUG > 0 && console.log('SPICE port', event.detail.channel.portName, 'event data:', event.detail.spiceEvent);
+            });
+            */
+
             connect();
         </script>
 
diff --git a/spicemsg.js b/spicemsg.js
index 0321cc7..3619996 100644
--- a/spicemsg.js
+++ b/spicemsg.js
@@ -1278,3 +1278,21 @@ SpiceMsgDisplayInvalList.prototype =
         }
     },
 }
+
+function SpiceMsgPortInit(a, at)
+{
+    this.from_buffer(a,at);
+};
+
+SpiceMsgPortInit.prototype =
+{
+    from_buffer: function (a, at)
+    {
+        at = at || 0;
+        var dv = new SpiceDataView(a);
+        var namesize = dv.getUint32(at, true); at += 4;
+        var offset = dv.getUint32(at, true); at += 4;
+        this.opened = dv.getUint8(at, true); at += 1;
+        this.name = a.slice(offset, offset + namesize - 1);
+    }
+}
diff --git a/utils.js b/utils.js
index 9093a24..a22d0ae 100644
--- a/utils.js
+++ b/utils.js
@@ -100,6 +100,13 @@ function hexdump_buffer(a)
 }
 
 /*----------------------------------------------------------------------------
+**  Convert arraybuffer to string
+**--------------------------------------------------------------------------*/
+function arraybuffer_to_str(buf) {
+  return String.fromCharCode.apply(null, new Uint16Array(buf));
+}
+
+/*----------------------------------------------------------------------------
 ** Converting keycodes to AT scancodes is very hard.
 ** luckly there are some resources on the web and in the Xorg driver that help
 ** us figure out what browser dependent keycodes match to what scancodes.
-- 
2.9.3



More information about the Spice-devel mailing list