@neurodevs/node-lsl 12.0.5 → 13.0.0

package/build/__tests__/impl/LslWebSocketBridge.test.js

@@ -4,23 +4,133 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
+import { randomInt } from 'crypto';
 import { test, assert } from '@neurodevs/node-tdd';
 import LslWebSocketBridge from '../../impl/LslWebSocketBridge.js';
+import FakeStreamInlet from '../../testDoubles/StreamInlet/FakeStreamInlet.js';
+import FakeWebSocket from '../../testDoubles/WebSockets/FakeWebSocket.js';
+import FakeWebSocketServer from '../../testDoubles/WebSockets/FakeWebSocketServer.js';
 import AbstractPackageTest from '../AbstractPackageTest.js';
 export default class LslWebSocketBridgeTest extends AbstractPackageTest {
     static instance;
     static async beforeEach() {
         await super.beforeEach();
+        this.setFakeStreamInlet();
+        this.setFakeWebSocketServer();
+        this.setSpyLslWebSocketBridge();
         this.instance = this.LslWebSocketBridge();
     }
     static async createsInstance() {
         assert.isTruthy(this.instance, 'Failed to create instance!');
     }
-    static LslWebSocketBridge() {
-        return LslWebSocketBridge.Create();
+    static async createsLslStreamInlet() {
+        const { channelNames, channelFormat, sampleRateHz, chunkSize } = FakeStreamInlet.callsToConstructor[0]?.options ?? {};
+        assert.isEqualDeep({
+            channelNames,
+            channelFormat,
+            sampleRateHz,
+            chunkSize,
+        }, this.baseOptions);
+    }
+    static async activateCallsStartPullingOnInlet() {
+        this.activate();
+        assert.isEqual(FakeStreamInlet.numCallsToStartPulling, 1, 'Did not call startPulling on inlet!');
+    }
+    static async deactivateCallsStopPullingOnInlet() {
+        this.activate();
+        this.deactivate();
+        assert.isEqual(FakeStreamInlet.numCallsToStopPulling, 1, 'Did not call stopPulling on inlet!');
+    }
+    static async destroyCallsDestroyOnInlet() {
+        this.destroy();
+        assert.isEqual(FakeStreamInlet.numCallsToDestroy, 1, 'Did not call destroy on inlet!');
+    }
+    static async createsWebSocketServer() {
+        assert.isEqualDeep(FakeWebSocketServer.callsToConstructor[0], { port: this.wssPort }, 'Did not create WebSocketServer!');
+    }
+    static async activateSendsDataToWebSocketClients() {
+        this.activate();
+        const { samples, timestamps } = this.simulateOnDataCallback();
+        for (const client of FakeWebSocketServer.clients) {
+            const callToClient = FakeWebSocket.callsToSend.filter((c) => c.id === client.id)[0];
+            assert.isEqualDeep(callToClient?.data, JSON.stringify({
+                samples,
+                timestamps,
+            }), 'Did not send data to client!');
+        }
+    }
+    static async doesNotSendToClientsThatAreNotReady() {
+        for (const client of FakeWebSocketServer.clients) {
+            client.readyState = WebSocket.CONNECTING;
+        }
+        this.activate();
+        this.simulateOnDataCallback();
+        assert.isEqual(FakeWebSocket.callsToSend.length, 0, 'Sent data to clients that are not ready!');
+    }
+    static async destroyClosesWebSocketServer() {
+        this.destroy();
+        assert.isEqual(FakeWebSocketServer.numCallsToClose, 1, 'Did not call close on WebSocketServer!');
+    }
+    static async throwsIfActivateIsCalledAfterDestroy() {
+        this.destroy();
+        assert.doesThrow(() => {
+            this.activate();
+        }, `\n\n Cannot re-activate bridge after destroying it! \n\n Please create and activate a new instance. \n`);
+    }
+    static activate() {
+        this.instance.activate();
+    }
+    static deactivate() {
+        this.instance.deactivate();
+    }
+    static destroy() {
+        this.instance.destroy();
+    }
+    static simulateOnDataCallback() {
+        const samples = new Float32Array([1, 2, 3, 4, 5, 6]);
+        const timestamps = new Float64Array([7, 8]);
+        FakeStreamInlet.callsToConstructor[0]?.onData(samples, timestamps);
+        return { samples, timestamps };
+    }
+    static wssPort = 8080;
+    static baseOptions = {
+        channelNames: this.channelNames,
+        channelFormat: 'float32',
+        sampleRateHz: 100 * Math.random(),
+        chunkSize: randomInt(1, 100),
+    };
+    static LslWebSocketBridge(options) {
+        return LslWebSocketBridge.Create({ ...this.baseOptions, ...options });
     }
 }
 __decorate([
     test()
 ], LslWebSocketBridgeTest, "createsInstance", null);
+__decorate([
+    test()
+], LslWebSocketBridgeTest, "createsLslStreamInlet", null);
+__decorate([
+    test()
+], LslWebSocketBridgeTest, "activateCallsStartPullingOnInlet", null);
+__decorate([
+    test()
+], LslWebSocketBridgeTest, "deactivateCallsStopPullingOnInlet", null);
+__decorate([
+    test()
+], LslWebSocketBridgeTest, "destroyCallsDestroyOnInlet", null);
+__decorate([
+    test()
+], LslWebSocketBridgeTest, "createsWebSocketServer", null);
+__decorate([
+    test()
+], LslWebSocketBridgeTest, "activateSendsDataToWebSocketClients", null);
+__decorate([
+    test()
+], LslWebSocketBridgeTest, "doesNotSendToClientsThatAreNotReady", null);
+__decorate([
+    test()
+], LslWebSocketBridgeTest, "destroyClosesWebSocketServer", null);
+__decorate([
+    test()
+], LslWebSocketBridgeTest, "throwsIfActivateIsCalledAfterDestroy", null);
 //# sourceMappingURL=LslWebSocketBridge.test.js.map

package/build/__tests__/impl/LslWebSocketBridge.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"LslWebSocketBridge.test.js","sourceRoot":"","sources":["../../../src/__tests__/impl/LslWebSocketBridge.test.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAElD,OAAO,kBAEN,MAAM,kCAAkC,CAAA;AACzC,OAAO,mBAAmB,MAAM,2BAA2B,CAAA;AAE3D,MAAM,CAAC,OAAO,OAAO,sBAAuB,SAAQ,mBAAmB;IAC3D,MAAM,CAAC,QAAQ,CAAuB;IAEpC,MAAM,CAAC,KAAK,CAAC,UAAU;QAC7B,MAAM,KAAK,CAAC,UAAU,EAAE,CAAA;QAExB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAA;IAC7C,CAAC;IAGsB,AAAb,MAAM,CAAC,KAAK,CAAC,eAAe;QAClC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,4BAA4B,CAAC,CAAA;IAChE,CAAC;IAEO,MAAM,CAAC,kBAAkB;QAC7B,OAAO,kBAAkB,CAAC,MAAM,EAAE,CAAA;IACtC,CAAC;CACJ;AAP0B;IADtB,IAAI,EAAE;mDAGN"}
+{"version":3,"file":"LslWebSocketBridge.test.js","sourceRoot":"","sources":["../../../src/__tests__/impl/LslWebSocketBridge.test.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAA;AAElC,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAElD,OAAO,kBAEN,MAAM,kCAAkC,CAAA;AACzC,OAAO,eAAe,MAAM,kDAAkD,CAAA;AAE9E,OAAO,aAAa,MAAM,+CAA+C,CAAA;AACzE,OAAO,mBAAmB,MAAM,qDAAqD,CAAA;AACrF,OAAO,mBAAmB,MAAM,2BAA2B,CAAA;AAE3D,MAAM,CAAC,OAAO,OAAO,sBAAuB,SAAQ,mBAAmB;IAC3D,MAAM,CAAC,QAAQ,CAAuB;IAEpC,MAAM,CAAC,KAAK,CAAC,UAAU;QAC7B,MAAM,KAAK,CAAC,UAAU,EAAE,CAAA;QAExB,IAAI,CAAC,kBAAkB,EAAE,CAAA;QACzB,IAAI,CAAC,sBAAsB,EAAE,CAAA;QAC7B,IAAI,CAAC,wBAAwB,EAAE,CAAA;QAE/B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,kBAAkB,EAA2B,CAAA;IACtE,CAAC;IAGsB,AAAb,MAAM,CAAC,KAAK,CAAC,eAAe;QAClC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,4BAA4B,CAAC,CAAA;IAChE,CAAC;IAGsB,AAAb,MAAM,CAAC,KAAK,CAAC,qBAAqB;QACxC,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,YAAY,EAAE,SAAS,EAAE,GAC1D,eAAe,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,OAAO,IAAI,EAAE,CAAA;QAExD,MAAM,CAAC,WAAW,CACd;YACI,YAAY;YACZ,aAAa;YACb,YAAY;YACZ,SAAS;SACZ,EACD,IAAI,CAAC,WAAW,CACnB,CAAA;IACL,CAAC;IAGsB,AAAb,MAAM,CAAC,KAAK,CAAC,gCAAgC;QACnD,IAAI,CAAC,QAAQ,EAAE,CAAA;QAEf,MAAM,CAAC,OAAO,CACV,eAAe,CAAC,sBAAsB,EACtC,CAAC,EACD,qCAAqC,CACxC,CAAA;IACL,CAAC;IAGsB,AAAb,MAAM,CAAC,KAAK,CAAC,iCAAiC;QACpD,IAAI,CAAC,QAAQ,EAAE,CAAA;QACf,IAAI,CAAC,UAAU,EAAE,CAAA;QAEjB,MAAM,CAAC,OAAO,CACV,eAAe,CAAC,qBAAqB,EACrC,CAAC,EACD,oCAAoC,CACvC,CAAA;IACL,CAAC;IAGsB,AAAb,MAAM,CAAC,KAAK,CAAC,0BAA0B;QAC7C,IAAI,CAAC,OAAO,EAAE,CAAA;QAEd,MAAM,CAAC,OAAO,CACV,eAAe,CAAC,iBAAiB,EACjC,CAAC,EACD,gCAAgC,CACnC,CAAA;IACL,CAAC;IAGsB,AAAb,MAAM,CAAC,KAAK,CAAC,sBAAsB;QACzC,MAAM,CAAC,WAAW,CACd,mBAAmB,CAAC,kBAAkB,CAAC,CAAC,CAAC,EACzC,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,EACtB,iCAAiC,CACpC,CAAA;IACL,CAAC;IAGsB,AAAb,MAAM,CAAC,KAAK,CAAC,mCAAmC;QACtD,IAAI,CAAC,QAAQ,EAAE,CAAA;QAEf,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,sBAAsB,EAAE,CAAA;QAE7D,KAAK,MAAM,MAAM,IAAI,mBAAmB,CAAC,OAAO,EAAE,CAAC;YAC/C,MAAM,YAAY,GAAG,aAAa,CAAC,WAAW,CAAC,MAAM,CACjD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,MAAM,CAAC,EAAE,CAC5B,CAAC,CAAC,CAAC,CAAA;YAEJ,MAAM,CAAC,WAAW,CACd,YAAY,EAAE,IAAI,EAClB,IAAI,CAAC,SAAS,CAAC;gBACX,OAAO;gBACP,UAAU;aACb,CAAC,EACF,8BAA8B,CACjC,CAAA;QACL,CAAC;IACL,CAAC;IAGsB,AAAb,MAAM,CAAC,KAAK,CAAC,mCAAmC;QACtD,KAAK,MAAM,MAAM,IAAI,mBAAmB,CAAC,OAAO,EAAE,CAAC;YAC/C,MAAM,CAAC,UAAU,GAAG,SAAS,CAAC,UAAU,CAAA;QAC5C,CAAC;QAED,IAAI,CAAC,QAAQ,EAAE,CAAA;QACf,IAAI,CAAC,sBAAsB,EAAE,CAAA;QAE7B,MAAM,CAAC,OAAO,CACV,aAAa,CAAC,WAAW,CAAC,MAAM,EAChC,CAAC,EACD,0CAA0C,CAC7C,CAAA;IACL,CAAC;IAGsB,AAAb,MAAM,CAAC,KAAK,CAAC,4BAA4B;QAC/C,IAAI,CAAC,OAAO,EAAE,CAAA;QAEd,MAAM,CAAC,OAAO,CACV,mBAAmB,CAAC,eAAe,EACnC,CAAC,EACD,wCAAwC,CAC3C,CAAA;IACL,CAAC;IAGsB,AAAb,MAAM,CAAC,KAAK,CAAC,oCAAoC;QACvD,IAAI,CAAC,OAAO,EAAE,CAAA;QAEd,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE;YAClB,IAAI,CAAC,QAAQ,EAAE,CAAA;QACnB,CAAC,EAAE,wGAAwG,CAAC,CAAA;IAChH,CAAC;IAEO,MAAM,CAAC,QAAQ;QACnB,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAA;IAC5B,CAAC;IAEO,MAAM,CAAC,UAAU;QACrB,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAA;IAC9B,CAAC;IAEO,MAAM,CAAC,OAAO;QAClB,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAA;IAC3B,CAAC;IAEO,MAAM,CAAC,sBAAsB;QACjC,MAAM,OAAO,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;QACpD,MAAM,UAAU,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;QAE3C,eAAe,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,MAAO,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;QACnE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,CAAA;IAClC,CAAC;IAEO,MAAM,CAAU,OAAO,GAAG,IAAI,CAAA;IAE9B,MAAM,CAAU,WAAW,GAAG;QAClC,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,aAAa,EAAE,SAAkB;QACjC,YAAY,EAAE,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE;QACjC,SAAS,EAAE,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC;KAC/B,CAAA;IAEO,MAAM,CAAC,kBAAkB,CAC7B,OAA+C;QAE/C,OAAO,kBAAkB,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,CAAC,WAAW,EAAE,GAAG,OAAO,EAAE,CAAC,CAAA;IACzE,CAAC;;AA1JsB;IADtB,IAAI,EAAE;mDAGN;AAGsB;IADtB,IAAI,EAAE;yDAcN;AAGsB;IADtB,IAAI,EAAE;oEASN;AAGsB;IADtB,IAAI,EAAE;qEAUN;AAGsB;IADtB,IAAI,EAAE;8DASN;AAGsB;IADtB,IAAI,EAAE;0DAON;AAGsB;IADtB,IAAI,EAAE;uEAoBN;AAGsB;IADtB,IAAI,EAAE;uEAcN;AAGsB;IADtB,IAAI,EAAE;gEASN;AAGsB;IADtB,IAAI,EAAE;wEAON"}

package/build/assertions.d.ts

@@ -1,6 +1,6 @@
-import { ChannelFormat } from './types.js';
+import { ChannelFormat } from 'impl/LiblslAdapter.js';
 export declare function assertValidChunkSize(chunkSize: number): void;
-export declare function assertValidMaxBuffered(maxBuffered: number): void;
+export declare function assertValidMaxBufferedMs(maxBufferedMs: number): void;
 export declare function assertValidChannelFormat(channelFormat: ChannelFormat): void;
-export declare function assertValidSampleRate(sampleRate: number): void;
+export declare function assertValidSampleRateHz(sampleRateHz: number): void;
 export declare function assertValidChannelCount(channelCount: number): void;

package/build/assertions.js

@@ -5,9 +5,9 @@ export function assertValidChunkSize(chunkSize) {
         throw new Error(`Invalid chunk size! Must be a positive integer or zero, not: ${chunkSize}.`);
     }
 }
-export function assertValidMaxBuffered(maxBuffered) {
-    if (!isPositiveIntegerOrZero(maxBuffered)) {
-        throw new Error(`Invalid max buffered! Must be a positive integer or zero, not: ${maxBuffered}.`);
+export function assertValidMaxBufferedMs(maxBufferedMs) {
+    if (!isPositiveIntegerOrZero(maxBufferedMs)) {
+        throw new Error(`Invalid max buffered! Must be a positive integer or zero, not: ${maxBufferedMs}.`);
     }
 }
 export function assertValidChannelFormat(channelFormat) {
@@ -15,9 +15,9 @@ export function assertValidChannelFormat(channelFormat) {
         throw new Error(`Invalid channel format! Must be one of: ${CHANNEL_FORMATS.join(', ')}, not ${channelFormat}.`);
     }
 }
-export function assertValidSampleRate(sampleRate) {
-    if (!isGreaterThanOrEqualToZero(sampleRate)) {
-        throw new Error(`Invalid sample rate! Must be a positive number or zero, not: ${sampleRate}.`);
+export function assertValidSampleRateHz(sampleRateHz) {
+    if (!isGreaterThanOrEqualToZero(sampleRateHz)) {
+        throw new Error(`Invalid sample rate! Must be a positive number or zero, not: ${sampleRateHz}.`);
     }
 }
 export function assertValidChannelCount(channelCount) {

package/build/assertions.js.map

@@ -1 +1 @@
-{"version":3,"file":"assertions.js","sourceRoot":"","sources":["../src/assertions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C,OAAO,EACH,0BAA0B,EAC1B,iBAAiB,EACjB,uBAAuB,EACvB,eAAe,GAClB,MAAM,kBAAkB,CAAA;AAEzB,MAAM,UAAU,oBAAoB,CAAC,SAAiB;IAClD,IAAI,CAAC,uBAAuB,CAAC,SAAS,CAAC,EAAE,CAAC;QACtC,MAAM,IAAI,KAAK,CACX,gEAAgE,SAAS,GAAG,CAC/E,CAAA;IACL,CAAC;AACL,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,WAAmB;IACtD,IAAI,CAAC,uBAAuB,CAAC,WAAW,CAAC,EAAE,CAAC;QACxC,MAAM,IAAI,KAAK,CACX,kEAAkE,WAAW,GAAG,CACnF,CAAA;IACL,CAAC;AACL,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,aAA4B;IACjE,IAAI,CAAC,eAAe,CAAC,aAAa,EAAE,eAAe,CAAC,EAAE,CAAC;QACnD,MAAM,IAAI,KAAK,CACX,2CAA2C,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,aAAa,GAAG,CACjG,CAAA;IACL,CAAC;AACL,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,UAAkB;IACpD,IAAI,CAAC,0BAA0B,CAAC,UAAU,CAAC,EAAE,CAAC;QAC1C,MAAM,IAAI,KAAK,CACX,gEAAgE,UAAU,GAAG,CAChF,CAAA;IACL,CAAC;AACL,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,YAAoB;IACxD,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CACX,2DAA2D,YAAY,GAAG,CAC7E,CAAA;IACL,CAAC;AACL,CAAC"}
+{"version":3,"file":"assertions.js","sourceRoot":"","sources":["../src/assertions.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EACH,0BAA0B,EAC1B,iBAAiB,EACjB,uBAAuB,EACvB,eAAe,GAClB,MAAM,kBAAkB,CAAA;AAEzB,MAAM,UAAU,oBAAoB,CAAC,SAAiB;IAClD,IAAI,CAAC,uBAAuB,CAAC,SAAS,CAAC,EAAE,CAAC;QACtC,MAAM,IAAI,KAAK,CACX,gEAAgE,SAAS,GAAG,CAC/E,CAAA;IACL,CAAC;AACL,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,aAAqB;IAC1D,IAAI,CAAC,uBAAuB,CAAC,aAAa,CAAC,EAAE,CAAC;QAC1C,MAAM,IAAI,KAAK,CACX,kEAAkE,aAAa,GAAG,CACrF,CAAA;IACL,CAAC;AACL,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,aAA4B;IACjE,IAAI,CAAC,eAAe,CAAC,aAAa,EAAE,eAAe,CAAC,EAAE,CAAC;QACnD,MAAM,IAAI,KAAK,CACX,2CAA2C,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,aAAa,GAAG,CACjG,CAAA;IACL,CAAC;AACL,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,YAAoB;IACxD,IAAI,CAAC,0BAA0B,CAAC,YAAY,CAAC,EAAE,CAAC;QAC5C,MAAM,IAAI,KAAK,CACX,gEAAgE,YAAY,GAAG,CAClF,CAAA;IACL,CAAC;AACL,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,YAAoB;IACxD,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CACX,2DAA2D,YAAY,GAAG,CAC7E,CAAA;IACL,CAAC;AACL,CAAC"}

package/build/handleError.d.ts

@@ -0,0 +1,8 @@
+export default function handleError(errorCode: number): void;
+export declare enum LslErrorCode {
+    Ok = 0,
+    Timeout = -1,
+    Lost = -2,
+    BadArgument = -3,
+    InternalError = -4
+}

package/build/handleError.js

@@ -0,0 +1,25 @@
+export default function handleError(errorCode) {
+    switch (errorCode) {
+        case 0:
+            return;
+        case -1:
+            throw new Error(`The liblsl operation failed due to a timeout!`);
+        case -2:
+            throw new Error(`The liblsl stream has been lost!`);
+        case -3:
+            throw new Error(`A liblsl argument was incorrectly specified!`);
+        case -4:
+            throw new Error(`An internal liblsl error has occurred!`);
+        default:
+            throw new Error(`An unknown liblsl error has occurred!`);
+    }
+}
+export var LslErrorCode;
+(function (LslErrorCode) {
+    LslErrorCode[LslErrorCode["Ok"] = 0] = "Ok";
+    LslErrorCode[LslErrorCode["Timeout"] = -1] = "Timeout";
+    LslErrorCode[LslErrorCode["Lost"] = -2] = "Lost";
+    LslErrorCode[LslErrorCode["BadArgument"] = -3] = "BadArgument";
+    LslErrorCode[LslErrorCode["InternalError"] = -4] = "InternalError";
+})(LslErrorCode || (LslErrorCode = {}));
+//# sourceMappingURL=handleError.js.map

package/build/handleError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"handleError.js","sourceRoot":"","sources":["../src/handleError.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,UAAU,WAAW,CAAC,SAAiB;IACjD,QAAQ,SAAS,EAAE,CAAC;QAChB,KAAK,CAAC;YACF,OAAM;QACV,KAAK,CAAC,CAAC;YACH,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;QACpE,KAAK,CAAC,CAAC;YACH,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAA;QACvD,KAAK,CAAC,CAAC;YACH,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;QACnE,KAAK,CAAC,CAAC;YACH,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAA;QAC7D;YACI,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;IAChE,CAAC;AACL,CAAC;AAED,MAAM,CAAN,IAAY,YAMX;AAND,WAAY,YAAY;IACpB,2CAAM,CAAA;IACN,sDAAY,CAAA;IACZ,gDAAS,CAAA;IACT,8DAAgB,CAAA;IAChB,kEAAkB,CAAA;AACtB,CAAC,EANW,YAAY,KAAZ,YAAY,QAMvB"}

package/build/impl/LiblslAdapter.d.ts

@@ -1,27 +1,142 @@
-import { define, open } from 'ffi-rs';
-import { Liblsl, CreateStreamInfoOptions, AppendChannelsToStreamInfoOptions, CreateOutletOptions, DestroyOutletOptions, PushSampleFloatTimestampOptions, PushSampleStringTimestampOptions, CreateInletOptions, DestroyInletOptions, FlushInletOptions } from '../types.js';
+import { define, JsExternal, load, open } from 'ffi-rs';
+import { CHANNEL_FORMATS } from '../consts.js';
+import { LslErrorCode } from '../handleError.js';
 export default class LiblslAdapter implements Liblsl {
-    static ffiRsOpen: typeof open;
-    static ffiRsDefine: typeof define;
+    static open: typeof open;
+    static define: typeof define;
+    static load: typeof load;
     private static instance?;
-    private path;
+    liblslPath: string;
     private bindings;
+    private readonly defaultMacOsPath;
     protected constructor();
     private tryToLoadBindings;
-    private generateFailedMessage;
+    private throwFailedToLoadLiblsl;
     static getInstance(): Liblsl;
     static setInstance(instance: Liblsl): void;
     static resetInstance(): void;
     private loadBindings;
-    createStreamInfo(options: CreateStreamInfoOptions): import("../types.js").BoundStreamInfo;
+    private openLiblsl;
+    private defineLiblslBindings;
+    createStreamInfo(options: CreateStreamInfoOptions): BoundStreamInfo;
     appendChannelsToStreamInfo(options: AppendChannelsToStreamInfoOptions): void;
-    createOutlet(options: CreateOutletOptions): import("../types.js").BoundOutlet;
-    pushSampleFloatTimestamp(options: PushSampleFloatTimestampOptions): void;
-    pushSampleStringTimestamp(options: PushSampleStringTimestampOptions): void;
+    createOutlet(options: CreateOutletOptions): BoundOutlet;
+    pushSampleFloatTimestamp(options: PushSampleFloatTimestampOptions): LslErrorCode;
+    pushSampleStringTimestamp(options: PushSampleStringTimestampOptions): LslErrorCode;
     destroyOutlet(options: DestroyOutletOptions): void;
-    createInlet(options: CreateInletOptions): import("../types.js").BoundInlet;
+    createInlet(options: CreateInletOptions): BoundInlet;
+    pullSample(options: PullSampleOptions): number;
+    pullChunk(options: PullChunkOptions): number;
     flushInlet(options: FlushInletOptions): void;
-    destroyInlet(_options: DestroyInletOptions): void;
+    destroyInlet(options: DestroyInletOptions): void;
     localClock(): number;
-    private readonly defaultMacOsPath;
+    private get open();
+    private get define();
+    private get load();
+    private get liblslFuncs();
+}
+export interface Liblsl {
+    liblslPath: string;
+    createStreamInfo(options: CreateStreamInfoOptions): BoundStreamInfo;
+    appendChannelsToStreamInfo(options: AppendChannelsToStreamInfoOptions): void;
+    createOutlet(options: CreateOutletOptions): BoundOutlet;
+    pushSampleFloatTimestamp(options: PushSampleFloatTimestampOptions): LslErrorCode;
+    pushSampleStringTimestamp(options: PushSampleStringTimestampOptions): LslErrorCode;
+    destroyOutlet(options: DestroyOutletOptions): void;
+    createInlet(options: CreateInletOptions): BoundInlet;
+    pullSample(options: PullSampleOptions): number;
+    pullChunk(options: PullChunkOptions): number;
+    flushInlet(options: FlushInletOptions): void;
+    destroyInlet(options: DestroyInletOptions): void;
+    localClock(): number;
+}
+export interface CreateStreamInfoOptions {
+    name: string;
+    type: string;
+    channelCount: number;
+    sampleRateHz: number;
+    channelFormat: number;
+    sourceId: string;
+    manufacturer?: string;
+    units?: string;
+}
+export interface AppendChannelsToStreamInfoOptions {
+    info: BoundStreamInfo;
+    channels: LslChannel[];
+}
+export interface CreateOutletOptions {
+    info: BoundStreamInfo;
+    chunkSize: number;
+    maxBufferedMs: number;
+}
+export interface PushSampleFloatTimestampOptions {
+    outlet: BoundOutlet;
+    sample: number[];
+    timestamp: number;
+}
+export interface PushSampleStringTimestampOptions {
+    outlet: BoundOutlet;
+    sample: string[];
+    timestamp: number;
+}
+export interface DestroyOutletOptions {
+    outlet: BoundOutlet;
+}
+export interface CreateInletOptions {
+    info: BoundStreamInfo;
+    chunkSize: number;
+    maxBufferedMs: number;
+}
+export interface PullSampleOptions {
+    inlet: BoundInlet;
+    dataBufferPtr: JsExternal;
+    dataBufferElements: number;
+    timeout: number;
+    errcodePtr: JsExternal;
+}
+export interface PullChunkOptions {
+    inlet: BoundInlet;
+    dataBufferPtr: JsExternal;
+    timestampBufferPtr: JsExternal;
+    dataBufferElements: number;
+    timestampBufferElements: number;
+    timeout: number;
+    errcodePtr: JsExternal;
+}
+export interface FlushInletOptions {
+    inlet: BoundInlet;
+}
+export interface DestroyInletOptions {
+    inlet: BoundInlet;
+}
+export interface LiblslBindings {
+    lsl_create_streaminfo(args: [string, string, number, number, number, string]): BoundStreamInfo;
+    lsl_create_outlet(args: [BoundStreamInfo, number, number]): BoundOutlet;
+    lsl_push_sample_ft(args: [BoundOutlet, LslSample, number]): LslErrorCode;
+    lsl_push_sample_strt(args: [BoundOutlet, LslSample, number]): LslErrorCode;
+    lsl_destroy_outlet(args: [BoundOutlet]): void;
+    lsl_create_inlet(args: any): BoundInlet;
+    lsl_flush_inlet(args: [BoundInlet]): void;
+    lsl_destroy_inlet(args: any): void;
+    lsl_local_clock(args: []): number;
+    lsl_get_desc(args: [BoundStreamInfo]): BoundDescription;
+    lsl_append_child(args: [BoundDescription, string]): BoundChild;
+    lsl_append_child_value(args: [BoundChild, string, string]): void;
+}
+export type ChannelFormat = (typeof CHANNEL_FORMATS)[number];
+export interface LslChannel {
+    label: string;
+    units: string;
+    type: string;
+}
+export type LslSample = (number | string | undefined)[];
+export interface BoundStreamInfo {
+}
+export interface BoundOutlet {
+}
+export interface BoundInlet {
+}
+export interface BoundDescription {
+}
+export interface BoundChild {
 }

package/build/impl/LiblslAdapter.js

@@ -1,24 +1,26 @@
-import { DataType, define, open } from 'ffi-rs';
+import { DataType, define, load, open, unwrapPointer } from 'ffi-rs';
 export default class LiblslAdapter {
-    static ffiRsOpen = open;
-    static ffiRsDefine = define;
+    static open = open;
+    static define = define;
+    static load = load;
     static instance;
-    path;
+    liblslPath;
     bindings;
+    defaultMacOsPath = `/opt/homebrew/Cellar/lsl/1.16.2/lib/liblsl.1.16.2.dylib`;
     constructor() {
-        this.path = process.env.LIBLSL_PATH ?? this.defaultMacOsPath;
+        this.liblslPath = process.env.LIBLSL_PATH ?? this.defaultMacOsPath;
         this.tryToLoadBindings();
     }
     tryToLoadBindings() {
         try {
-            this.bindings = this.loadBindings(this.path);
+            this.loadBindings();
         }
         catch (error) {
-            throw new Error(this.generateFailedMessage(error));
+            this.throwFailedToLoadLiblsl(error);
         }
     }
-    generateFailedMessage(error) {
-        return `Loading the liblsl dylib failed! I tried to load it from ${this.path}.\n\n${error.message}\n\n`;
+    throwFailedToLoadLiblsl(error) {
+        throw new Error(`Loading the liblsl dylib failed! I tried to load it from ${this.liblslPath}.\n\n${error.message}\n\n`);
     }
     static getInstance() {
         if (!this.instance) {
@@ -32,12 +34,143 @@ export default class LiblslAdapter {
     static resetInstance() {
         delete this.instance;
     }
-    loadBindings(liblslPath) {
-        LiblslAdapter.ffiRsOpen({
+    loadBindings() {
+        this.openLiblsl();
+        this.bindings = this.defineLiblslBindings();
+    }
+    openLiblsl() {
+        this.open({
             library: 'lsl',
-            path: liblslPath,
+            path: this.liblslPath,
         });
-        return LiblslAdapter.ffiRsDefine({
+    }
+    defineLiblslBindings() {
+        return this.define(this.liblslFuncs);
+    }
+    createStreamInfo(options) {
+        const { name, type, channelCount, sampleRateHz, channelFormat, sourceId, } = options;
+        return this.bindings.lsl_create_streaminfo([
+            name,
+            type,
+            channelCount,
+            sampleRateHz,
+            channelFormat,
+            sourceId,
+        ]);
+    }
+    appendChannelsToStreamInfo(options) {
+        const { info, channels } = options;
+        const description = this.bindings.lsl_get_desc([info]);
+        const parent = this.bindings.lsl_append_child([description, 'channels']);
+        for (const channel of channels) {
+            const child = this.bindings.lsl_append_child([parent, 'channel']);
+            this.bindings.lsl_append_child_value([
+                child,
+                'label',
+                channel.label,
+            ]);
+            this.bindings.lsl_append_child_value([child, 'unit', channel.units]);
+            this.bindings.lsl_append_child_value([child, 'type', channel.type]);
+        }
+    }
+    createOutlet(options) {
+        const { info, chunkSize, maxBufferedMs } = options;
+        return this.bindings.lsl_create_outlet([
+            info,
+            chunkSize,
+            maxBufferedMs / 1000,
+        ]);
+    }
+    pushSampleFloatTimestamp(options) {
+        const { outlet, sample, timestamp } = options;
+        return this.bindings.lsl_push_sample_ft([outlet, sample, timestamp]);
+    }
+    pushSampleStringTimestamp(options) {
+        const { outlet, sample, timestamp } = options;
+        return this.bindings.lsl_push_sample_strt([outlet, sample, timestamp]);
+    }
+    destroyOutlet(options) {
+        const { outlet } = options;
+        this.bindings.lsl_destroy_outlet([outlet]);
+    }
+    createInlet(options) {
+        const { info, chunkSize, maxBufferedMs } = options;
+        return this.bindings.lsl_create_inlet([
+            info,
+            chunkSize,
+            maxBufferedMs / 1000,
+        ]);
+    }
+    pullSample(options) {
+        const { inlet, dataBufferPtr, dataBufferElements, timeout, errcodePtr, } = options;
+        return this.load({
+            library: 'lsl',
+            funcName: 'lsl_pull_sample_f',
+            retType: DataType.Double,
+            paramsType: [
+                DataType.External,
+                DataType.External,
+                DataType.I32,
+                DataType.Double,
+                DataType.External,
+            ],
+            paramsValue: [
+                inlet,
+                dataBufferPtr,
+                dataBufferElements,
+                timeout,
+                errcodePtr,
+            ],
+        });
+    }
+    pullChunk(options) {
+        const { inlet, dataBufferPtr, timestampBufferPtr, dataBufferElements, timestampBufferElements, timeout, errcodePtr, } = options;
+        return this.load({
+            library: 'lsl',
+            funcName: 'lsl_pull_chunk_f',
+            retType: DataType.Double,
+            paramsType: [
+                DataType.External,
+                DataType.External,
+                DataType.External,
+                DataType.I32,
+                DataType.I32,
+                DataType.Double,
+                DataType.External,
+            ],
+            paramsValue: [
+                inlet,
+                unwrapPointer([dataBufferPtr])[0],
+                unwrapPointer([timestampBufferPtr])[0],
+                dataBufferElements,
+                timestampBufferElements,
+                timeout,
+                unwrapPointer([errcodePtr])[0],
+            ],
+        });
+    }
+    flushInlet(options) {
+        const { inlet } = options;
+        this.bindings.lsl_flush_inlet([inlet]);
+    }
+    destroyInlet(options) {
+        const { inlet } = options;
+        this.bindings.lsl_destroy_inlet([inlet]);
+    }
+    localClock() {
+        return this.bindings.lsl_local_clock([]);
+    }
+    get open() {
+        return LiblslAdapter.open;
+    }
+    get define() {
+        return LiblslAdapter.define;
+    }
+    get load() {
+        return LiblslAdapter.load;
+    }
+    get liblslFuncs() {
+        return {
             lsl_create_streaminfo: {
                 library: 'lsl',
                 retType: DataType.External,
@@ -57,7 +190,7 @@ export default class LiblslAdapter {
             },
             lsl_push_sample_ft: {
                 library: 'lsl',
-                retType: DataType.Void,
+                retType: DataType.I32,
                 paramsType: [
                     DataType.External,
                     DataType.FloatArray,
@@ -66,7 +199,7 @@ export default class LiblslAdapter {
             },
             lsl_push_sample_strt: {
                 library: 'lsl',
-                retType: DataType.Void,
+                retType: DataType.I32,
                 paramsType: [
                     DataType.External,
                     DataType.StringArray,
@@ -117,62 +250,7 @@ export default class LiblslAdapter {
                 retType: DataType.Double,
                 paramsType: [],
             },
-        });
-    }
-    createStreamInfo(options) {
-        const { name, type, channelCount, sampleRate, channelFormat, sourceId, } = options;
-        return this.bindings.lsl_create_streaminfo([
-            name,
-            type,
-            channelCount,
-            sampleRate,
-            channelFormat,
-            sourceId,
-        ]);
-    }
-    appendChannelsToStreamInfo(options) {
-        const { info, channels } = options;
-        const description = this.bindings.lsl_get_desc([info]);
-        const parent = this.bindings.lsl_append_child([description, 'channels']);
-        for (const channel of channels) {
-            const child = this.bindings.lsl_append_child([parent, 'channel']);
-            this.bindings.lsl_append_child_value([
-                child,
-                'label',
-                channel.label,
-            ]);
-            this.bindings.lsl_append_child_value([child, 'unit', channel.unit]);
-            this.bindings.lsl_append_child_value([child, 'type', channel.type]);
-        }
-    }
-    createOutlet(options) {
-        const { info, chunkSize, maxBuffered } = options;
-        return this.bindings.lsl_create_outlet([info, chunkSize, maxBuffered]);
-    }
-    pushSampleFloatTimestamp(options) {
-        const { outlet, sample, timestamp } = options;
-        this.bindings.lsl_push_sample_ft([outlet, sample, timestamp]);
-    }
-    pushSampleStringTimestamp(options) {
-        const { outlet, sample, timestamp } = options;
-        this.bindings.lsl_push_sample_strt([outlet, sample, timestamp]);
-    }
-    destroyOutlet(options) {
-        const { outlet } = options;
-        this.bindings.lsl_destroy_outlet([outlet]);
-    }
-    createInlet(options) {
-        const { info, chunkSize, maxBuffered } = options;
-        return this.bindings.lsl_create_inlet([info, chunkSize, maxBuffered]);
-    }
-    flushInlet(options) {
-        const { inlet } = options;
-        this.bindings.lsl_flush_inlet([inlet]);
-    }
-    destroyInlet(_options) { }
-    localClock() {
-        return this.bindings.lsl_local_clock([]);
+        };
     }
-    defaultMacOsPath = '/opt/homebrew/Cellar/lsl/1.16.2/lib/liblsl.1.16.2.dylib';
 }
 //# sourceMappingURL=LiblslAdapter.js.map