Merge branch 'master' into nuget-package

Author: myd7349

.github/workflows/dotnet-core.yaml

@@ -0,0 +1,29 @@
+name: .NET Core
+
+on:
+  push:
+    branches: '*'
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Install .NET Core
+      uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: 5.x
+    - name: Build and package liblsl
+      run: dotnet pack -c Release liblsl.csproj -o pkg
+    - name: Build and package examples
+      run: dotnet pack -c Release examples/LSLExamples.csproj -o pkg
+#    - name: Run examples
+#      run: dotnet run -p examples/LSLExamples.csproj
+    - name: Upload build artifacts
+      uses: actions/upload-artifact@v1
+      with:
+        name: nuget pkg
+        path: pkg

LSL.cs

@@ -196,7 +196,7 @@ public static void check_error(int ec)
                     case -1: throw new TimeoutException("The operation failed due to a timeout.");
                     case -2: throw new LostException("The stream has been lost.");
                     case -3: throw new ArgumentException("An argument was incorrectly specified (e.g., wrong format or wrong length).");
-                    case -4: throw new InternalException("An internal internal error has occurred.");
+                    case -4: throw new InternalException("An internal error has occurred.");
                     default: throw new Exception("An unknown error has occurred.");
                 }
         }
@@ -495,7 +495,7 @@ protected override void DestroyLSLObject(IntPtr obj)
         * Wait until some consumer shows up (without wasting resources).
         * @return True if the wait was successful, false if the timeout expired.
         */
-        public bool wait_for_consumers(double timeout = LSL.FOREVER) { return dll.lsl_wait_for_consumers(obj) > 0; }
+        public bool wait_for_consumers(double timeout = LSL.FOREVER) { return dll.lsl_wait_for_consumers(obj, timeout) > 0; }
 
         /**
         * Retrieve the stream info provided by this outlet.
@@ -1023,7 +1023,7 @@ class dll
         public static extern int lsl_have_consumers(IntPtr obj);
 
         [DllImport(libname, CallingConvention = CallingConvention.Cdecl, CharSet = CharSet.Ansi, ExactSpelling = true)]
-        public static extern int lsl_wait_for_consumers(IntPtr obj);
+        public static extern int lsl_wait_for_consumers(IntPtr obj, double timeout);
 
         [DllImport(libname, CallingConvention = CallingConvention.Cdecl, CharSet = CharSet.Ansi, ExactSpelling = true)]
         public static extern IntPtr lsl_get_info(IntPtr obj);

README-Unity.md

@@ -20,7 +20,7 @@ LSL.cs includes a Unity interface to liblsl as a [Unity native plug-in](https://
 1. When the cube is selected, in the Inspector click on "Add Component", and create a new script called LSLInput.
 1. In the Project viewer, double click on LSLInput.cs. This should launch Visual Studio or another IDE.
 1. Fill in the script. Use [LSL4Unity AInlet](https://github.com/labstreaminglayer/LSL4Unity/blob/master/Scripts/AInlet.cs) for inspiration.
-    * There is [currently a bug](https://github.com/sccn/liblsl/issues/29) that prevents liblsl in Unity from resolving streams from _other_ computers while running in editor, and also the built product but only when using `ContinuousResolver`. For this reason we recommend using `liblsl.resolve_stream` instead.
+    * There is [currently a bug](https://github.com/sccn/liblsl/issues/29) that prevents liblsl in Unity from resolving streams from _other_ computers while running in editor, and also the built product but only when using `ContinuousResolver`. For this reason we recommend using `LSL.resolve_stream` instead.
 
 ```cs
 using System.Collections;
@@ -32,19 +32,22 @@ public class LSLInput : MonoBehaviour
 {
     public string StreamType = "EEG";
     public float scaleInput = 0.1f;
-    liblsl.StreamInfo[] streamInfos;
-    liblsl.StreamInlet streamInlet;
+
+    StreamInfo[] streamInfos;
+    StreamInlet streamInlet;
+
     float[] sample;
     private int channelCount = 0;
 
     void Update()
     {
         if (streamInlet == null)
         {
-            streamInfos = liblsl.resolve_stream("type", StreamType, 1, 0.0);
+
+            streamInfos = LSL.resolve_stream("type", StreamType, 1, 0.0);
             if (streamInfos.Length > 0)
             {
-                streamInlet = new liblsl.StreamInlet(streamInfos[0]);
+                streamInlet = new StreamInlet(streamInfos[0]);
                 channelCount = streamInlet.info().channel_count();
                 streamInlet.open_stream();
             }
@@ -79,41 +82,44 @@ public class LSLInput : MonoBehaviour
 
 1. Attach a new component called LSLPosOutput to the cube.
 1. Edit it as follows:
-    ```cs
-    using System.Collections;
-    using System.Collections.Generic;
-    using UnityEngine;
-    using LSL;
+```cs
+using System.Collections;
+using System.Collections.Generic;
+using UnityEngine;
+using LSL;
 
-    public class LSLOutput : MonoBehaviour
-    {
-        private liblsl.StreamOutlet outlet;
-        private float[] currentSample;
+public class LSLOutput : MonoBehaviour
+{
+    private StreamOutlet outlet;
+    private float[] currentSample;
 
-        public string StreamName = "Unity.ExampleStream";
-        public string StreamType = "Unity.StreamType";
-        public string StreamId = "MyStreamID-Unity1234";
 
-        // Start is called before the first frame update
-        void Start()
-        {
-            liblsl.StreamInfo streamInfo = new liblsl.StreamInfo(StreamName, StreamType, 3, Time.fixedDeltaTime * 1000, liblsl.channel_format_t.cf_float32);
-            liblsl.XMLElement chans = streamInfo.desc().append_child("channels");
-            chans.append_child("channel").append_child_value("label", "X");
-            chans.append_child("channel").append_child_value("label", "Y");
-            chans.append_child("channel").append_child_value("label", "Z");
-            outlet = new liblsl.StreamOutlet(streamInfo);
-            currentSample = new float[3];
-        }
+    public string StreamName = "Unity.ExampleStream";
+    public string StreamType = "Unity.StreamType";
+    public string StreamId = "MyStreamID-Unity1234";
 
-        // Update is called once per frame
-        void FixedUpdate()
-        {
-            Vector3 pos = gameObject.transform.position;
-            currentSample[0] = pos.x;
-            currentSample[1] = pos.y;
-            currentSample[2] = pos.z;
-            outlet.push_sample(currentSample);
-        }
+    // Start is called before the first frame update
+    void Start()
+    {
+        StreamInfo streamInfo = new StreamInfo(StreamName, StreamType, 3, Time.fixedDeltaTime * 1000, LSL.channel_format_t.cf_float32);
+        XMLElement chans = streamInfo.desc().append_child("channels");
+        chans.append_child("channel").append_child_value("label", "X");
+        chans.append_child("channel").append_child_value("label", "Y");
+        chans.append_child("channel").append_child_value("label", "Z");
+        outlet = new StreamOutlet(streamInfo);
+        currentSample = new float[3];
     }
-    ```
+
+
+    // FixedUpdate is a good hook for objects that are governed mostly by physics (gravity, momentum).
+    // Update might be better for objects that are governed by code (stimulus, event).
+    void FixedUpdate()
+    {
+        Vector3 pos = gameObject.transform.position;
+        currentSample[0] = pos.x;
+        currentSample[1] = pos.y;
+        currentSample[2] = pos.z;
+        outlet.push_sample(currentSample);
+    }
+}
+```