@neurodevs/node-lsl 12.0.6 → 13.0.1

package/src/scripts/runOutletToInlet.ts

@@ -0,0 +1,53 @@
+import LslStreamInlet from '../impl/LslStreamInlet.js'
+import LslStreamOutlet from '../impl/LslStreamOutlet.js'
+
+console.log('Creating outlet...')
+const outlet = await LslStreamOutlet.Create({
+    name: 'TestOutlet',
+    type: 'TEST',
+    sourceId: 'TestOutletID',
+    sampleRateHz: 100,
+    channelNames: ['Ch1', 'Ch2', 'Ch3'],
+    channelFormat: 'float32',
+    chunkSize: 1,
+    units: 'test',
+    manufacturer: 'test',
+})
+
+console.log('Creating inlet...')
+
+const inletOptions = {
+    name: 'TestOutlet',
+    type: 'TEST',
+    sourceId: 'TestOutletID',
+    sampleRateHz: 100,
+    channelNames: ['Ch1', 'Ch2', 'Ch3'],
+    channelFormat: 'float32' as const,
+    chunkSize: 1,
+}
+
+const inlet = LslStreamInlet.Create(inletOptions, (samples, timestamps) => {
+    console.log('Received samples:', samples, 'at timestamps:', timestamps)
+})
+
+console.log('Start pulling...')
+inlet.startPulling()
+
+console.log('Waiting for 100 ms...')
+await new Promise((resolve) => setTimeout(resolve, 100))
+
+console.log('Pushing samples...')
+for (let i = 0; i < 300; i++) {
+    const sample = [i, i, i]
+    outlet.pushSample(sample)
+    await new Promise((resolve) => setTimeout(resolve, 10))
+}
+
+await new Promise((resolve) => setTimeout(resolve, 1000))
+
+console.log('Pushing more samples...')
+for (let i = 0; i < 30; i++) {
+    const sample = [i, i, i]
+    outlet.pushSample(sample)
+    await new Promise((resolve) => setTimeout(resolve, 100))
+}

package/src/testDoubles/EventMarkerOutlet/FakeEventMarkerOutlet.ts

@@ -1,5 +1,7 @@
-import { EventMarkerOutlet } from '../../impl/LslEventMarkerOutlet.js'
-import { DurationMarker } from '../../types.js'
+import {
+    DurationMarker,
+    EventMarkerOutlet,
+} from '../../impl/LslEventMarkerOutlet.js'
 
 export default class FakeEventMarkerOutlet implements EventMarkerOutlet {
     public static callsToPushMarker: string[] = []

package/src/testDoubles/EventMarkerOutlet/MockEventMarkerOutlet.ts

@@ -1,7 +1,10 @@
 import { assert } from '@neurodevs/node-tdd'
 
-import { EventMarkerOutlet } from '../../impl/LslEventMarkerOutlet.js'
-import { DurationMarker, LslSample } from '../../types.js'
+import { LslSample } from 'impl/LiblslAdapter.js'
+import {
+    DurationMarker,
+    EventMarkerOutlet,
+} from '../../impl/LslEventMarkerOutlet.js'
 
 export default class MockEventMarkerOutlet implements EventMarkerOutlet {
     private didPushMarkers = false

package/src/testDoubles/EventMarkerOutlet/ThrowingEventMarkerOutlet.ts

@@ -1,5 +1,7 @@
-import { EventMarkerOutlet } from '../../impl/LslEventMarkerOutlet.js'
-import { DurationMarker } from '../../types.js'
+import {
+    DurationMarker,
+    EventMarkerOutlet,
+} from '../../impl/LslEventMarkerOutlet.js'
 
 export default class ThrowingEventMarkerOutlet implements EventMarkerOutlet {
     private errorMsg = 'Intentional throwing: '

package/src/testDoubles/Liblsl/FakeLiblsl.ts

@@ -1,3 +1,5 @@
+import generateId from '@neurodevs/generate-id'
+
 import {
     BoundOutlet,
     BoundStreamInfo,
@@ -11,9 +13,34 @@ import {
     DestroyInletOptions,
     BoundInlet,
     FlushInletOptions,
-} from '../../types.js'
+    PullChunkOptions,
+    PullSampleOptions,
+} from 'impl/LiblslAdapter.js'
 
 export default class FakeLiblsl implements Liblsl {
+    public static fakeSamples: Float32Array[] = [
+        new Float32Array([1, 2, 3]),
+        new Float32Array([4, 5, 6]),
+    ]
+
+    public static fakeChunks: Float32Array[] = [
+        new Float32Array([1, 2, 3, 4, 5, 6]),
+        new Float32Array([1, 2, 3, 4, 5, 6]),
+    ]
+
+    public static fakeTimestamps: Float64Array[] = [
+        new Float64Array([7, 8]),
+        new Float64Array([7, 8]),
+    ]
+
+    public static fakeErrorCode = 0
+
+    public liblslPath: string = generateId()
+
+    public fakeSamples = FakeLiblsl.fakeSamples.slice()
+    public fakeChunks = FakeLiblsl.fakeChunks.slice()
+    public fakeTimestamps = FakeLiblsl.fakeTimestamps.slice()
+
     public outlet: BoundOutlet = {} as BoundOutlet
     public streamInfo: BoundStreamInfo = {} as BoundStreamInfo
 
@@ -23,6 +50,8 @@ export default class FakeLiblsl implements Liblsl {
     public lastPushSampleFloatTimestampOptions?: PushSampleFloatTimestampOptions
     public lastPushSampleStringTimestampOptions?: PushSampleStringTimestampOptions
     public lastCreateInletOptions?: CreateInletOptions
+    public lastPullSampleOptions?: PullSampleOptions
+    public lastPullChunkOptions?: PullChunkOptions
     public lastFlushInletOptions?: FlushInletOptions
     public lastDestroyInletOptions?: DestroyInletOptions
 
@@ -49,6 +78,7 @@ export default class FakeLiblsl implements Liblsl {
 
     public pushSampleFloatTimestamp(options: PushSampleFloatTimestampOptions) {
         this.lastPushSampleFloatTimestampOptions = options
+        return FakeLiblsl.fakeErrorCode
     }
 
     public pushSampleStringTimestamp(
@@ -56,6 +86,7 @@ export default class FakeLiblsl implements Liblsl {
     ) {
         this.lastPushSampleStringTimestampOptions = options
         this.pushSampleStringTimestampHitCount++
+        return FakeLiblsl.fakeErrorCode
     }
 
     public createOutlet(options: CreateOutletOptions) {
@@ -74,6 +105,31 @@ export default class FakeLiblsl implements Liblsl {
         return {} as BoundInlet
     }
 
+    public pullSample(options: PullSampleOptions) {
+        this.lastPullSampleOptions = options
+
+        const sample = this.fakeSamples.shift()
+
+        if (sample) {
+            return 1
+        }
+
+        return 0
+    }
+
+    public pullChunk(options: PullChunkOptions) {
+        this.lastPullChunkOptions = options
+
+        const chunk = this.fakeChunks.shift()
+        const timestamps = this.fakeTimestamps.shift()
+
+        if (chunk && timestamps) {
+            return 1
+        }
+
+        return 0
+    }
+
     public flushInlet(options: FlushInletOptions) {
         this.flushInletHitCount++
         this.lastFlushInletOptions = options
@@ -100,5 +156,9 @@ export default class FakeLiblsl implements Liblsl {
         this.destroyOutletHitCount = 0
         this.localClockHitCount = 0
         this.pushSampleStringTimestampHitCount = 0
+
+        this.fakeSamples = FakeLiblsl.fakeSamples.slice()
+        this.fakeChunks = FakeLiblsl.fakeChunks.slice()
+        this.fakeTimestamps = FakeLiblsl.fakeTimestamps.slice()
     }
 }

package/src/testDoubles/StreamInfo/FakeStreamInfo.ts

@@ -1,5 +1,5 @@
+import { BoundStreamInfo } from 'impl/LiblslAdapter.js'
 import { StreamInfo, StreamInfoOptions } from '../../impl/LslStreamInfo.js'
-import { BoundStreamInfo } from '../../types.js'
 
 export default class FakeStreamInfo implements StreamInfo {
     public static callsToConstructor: StreamInfoOptions[] = []

package/src/testDoubles/StreamInlet/FakeStreamInlet.ts

@@ -5,23 +5,54 @@ export default class FakeStreamInlet implements StreamInlet {
     public static callsToConstructor: {
         info?: StreamInfo
         options?: StreamInletOptions
+        onData?: (samples: Float32Array, timestamps: Float64Array) => void
     }[] = []
 
-    public static numCallsToFlushSamples = 0
+    public static numCallsToStartPulling = 0
+    public static numCallsToStopPulling = 0
+    public static numCallsToFlushQueue = 0
+    public static numCallsToDestroy = 0
+
+    public isRunning = false
+
+    protected onData!: (samples: Float32Array, timestamps: Float64Array) => void
+
+    public constructor(
+        info?: StreamInfo,
+        options?: StreamInletOptions,
+        onData?: (samples: Float32Array, timestamps: Float64Array) => void
+    ) {
+        this.onData = onData ?? (() => {})
 
-    public constructor(info?: StreamInfo, options?: StreamInletOptions) {
         FakeStreamInlet.callsToConstructor.push({
             info,
             options,
+            onData: this.onData,
         })
     }
 
-    public flushSamples() {
-        FakeStreamInlet.numCallsToFlushSamples++
+    public startPulling() {
+        FakeStreamInlet.numCallsToStartPulling++
+        this.isRunning = true
+    }
+
+    public stopPulling() {
+        FakeStreamInlet.numCallsToStopPulling++
+        this.isRunning = false
+    }
+
+    public flushQueue() {
+        FakeStreamInlet.numCallsToFlushQueue++
+    }
+
+    public destroy() {
+        FakeStreamInlet.numCallsToDestroy++
     }
 
     public static resetTestDouble() {
         FakeStreamInlet.callsToConstructor = []
-        FakeStreamInlet.numCallsToFlushSamples = 0
+        FakeStreamInlet.numCallsToStartPulling = 0
+        FakeStreamInlet.numCallsToFlushQueue = 0
+        FakeStreamInlet.numCallsToDestroy = 0
     }
 }

package/src/testDoubles/StreamInlet/SpyStreamInlet.ts

@@ -1,11 +1,16 @@
 import { StreamInfo } from '../../impl/LslStreamInfo.js'
 import LslStreamInlet, {
+    OnDataCallback,
     StreamInletOptions,
 } from '../../impl/LslStreamInlet.js'
 
 export class SpyStreamInlet extends LslStreamInlet {
-    public constructor(info: StreamInfo, options: StreamInletOptions) {
-        super(info, options)
+    public constructor(
+        info: StreamInfo,
+        options: StreamInletOptions,
+        onData: OnDataCallback
+    ) {
+        super(info, options, onData)
     }
 
     public getName() {

package/src/testDoubles/StreamOutlet/FakeStreamOutlet.ts

@@ -1,12 +1,12 @@
 import { randomInt } from 'crypto'
 import generateId from '@neurodevs/generate-id'
 
+import { LslSample } from 'impl/LiblslAdapter.js'
 import { StreamInfo } from '../../impl/LslStreamInfo.js'
 import {
     StreamOutlet,
     StreamOutletOptions,
 } from '../../impl/LslStreamOutlet.js'
-import { LslSample } from '../../types.js'
 
 export default class FakeStreamOutlet implements StreamOutlet {
     public static callsToConstructor: {
@@ -56,24 +56,24 @@ export default class FakeStreamOutlet implements StreamOutlet {
         return this.options?.channelFormat ?? 'float32'
     }
 
-    public get sampleRate() {
-        return this.options?.sampleRate ?? randomInt(1, 1000)
+    public get sampleRateHz() {
+        return this.options?.sampleRateHz ?? randomInt(1, 1000)
     }
 
     public get chunkSize() {
         return this.options?.chunkSize ?? randomInt(1, 1000)
     }
 
-    public get maxBuffered() {
-        return this.options?.maxBuffered ?? randomInt(1, 1000)
+    public get maxBufferedMs() {
+        return this.options?.maxBufferedMs ?? randomInt(1, 1000)
     }
 
     public get manufacturer() {
         return this.options?.manufacturer ?? generateId()
     }
 
-    public get unit() {
-        return this.options?.unit ?? generateId()
+    public get units() {
+        return this.options?.units ?? generateId()
     }
 
     public static resetTestDouble() {

package/src/testDoubles/StreamTransportBridge/FakeStreamTransportBridge.ts

@@ -4,12 +4,30 @@ export default class FakeStreamTransportBridge
     implements StreamTransportBridge
 {
     public static numCallsToConstructor = 0
+    public static numCallsToActivate = 0
+    public static numCallsToDeactivate = 0
+    public static numCallsToDestroy = 0
 
     public constructor() {
         FakeStreamTransportBridge.numCallsToConstructor++
     }
 
+    public activate() {
+        FakeStreamTransportBridge.numCallsToActivate++
+    }
+
+    public deactivate() {
+        FakeStreamTransportBridge.numCallsToDeactivate++
+    }
+
+    public destroy() {
+        FakeStreamTransportBridge.numCallsToDestroy++
+    }
+
     public static resetTestDouble() {
         FakeStreamTransportBridge.numCallsToConstructor = 0
+        FakeStreamTransportBridge.numCallsToActivate = 0
+        FakeStreamTransportBridge.numCallsToDeactivate = 0
+        FakeStreamTransportBridge.numCallsToDestroy = 0
     }
 }

package/src/testDoubles/StreamTransportBridge/SpyLslWebSocketBridge.ts

@@ -0,0 +1,9 @@
+import LslWebSocketBridge, {
+    StreamTransportBridgeConstructorOptions,
+} from '../../impl/LslWebSocketBridge.js'
+
+export default class SpyLslWebSocketBridge extends LslWebSocketBridge {
+    public constructor(options: StreamTransportBridgeConstructorOptions) {
+        super(options)
+    }
+}

package/src/testDoubles/WebSockets/FakeWebSocket.ts

@@ -0,0 +1,17 @@
+import generateId from '@neurodevs/generate-id'
+import WebSocket from 'ws'
+
+export default class FakeWebSocket {
+    public static callsToSend: { id: string; data: unknown }[] = []
+
+    public readyState: number = WebSocket.OPEN
+    public id = generateId()
+
+    public send(data: unknown) {
+        FakeWebSocket.callsToSend.push({ id: this.id, data })
+    }
+
+    public static resetTestDouble() {
+        FakeWebSocket.callsToSend = []
+    }
+}

package/src/testDoubles/WebSockets/FakeWebSocketServer.ts

@@ -0,0 +1,32 @@
+import FakeWebSocket from './FakeWebSocket.js'
+
+export default class FakeWebSocketServer {
+    public static callsToConstructor: FakeWSSConstructorOptions[] = []
+    public static numCallsToClose = 0
+
+    public static clients = new Set<FakeWebSocket>([
+        new FakeWebSocket(),
+        new FakeWebSocket(),
+    ])
+
+    public clients = FakeWebSocketServer.clients
+
+    public constructor(options: FakeWSSConstructorOptions) {
+        FakeWebSocketServer.callsToConstructor.push(options)
+    }
+
+    public close() {
+        FakeWebSocketServer.numCallsToClose += 1
+    }
+
+    public static resetTestDouble() {
+        FakeWebSocketServer.callsToConstructor = []
+        FakeWebSocketServer.numCallsToClose = 0
+
+        FakeWebSocket.resetTestDouble()
+    }
+}
+
+export interface FakeWSSConstructorOptions {
+    port: number
+}

package/src/testDoubles/generateRandomOutletOptions.ts

@@ -11,12 +11,12 @@ export default function generateRandomOutletOptions() {
         name: generateId(),
         type: generateId(),
         channelNames: new Array(randomInt(1, 10)).fill(generateId()),
-        sampleRate: Math.random() * 10,
+        sampleRateHz: Math.random() * 10,
         channelFormat: TEST_SUPPORTED_CHANNEL_FORMATS[randomChannelIdx],
         sourceId: generateId(),
         manufacturer: generateId(),
-        unit: generateId(),
+        units: generateId(),
         chunkSize: randomInt(0, 10),
-        maxBuffered: randomInt(0, 10),
+        maxBufferedMs: randomInt(0, 10),
     } as StreamOutletOptions
 }

package/build/types.d.ts

@@ -1,95 +0,0 @@
-import { FuncObj, FieldType } from 'ffi-rs';
-import { CHANNEL_FORMATS } from './consts.js';
-import { StreamInlet } from './impl/LslStreamInlet.js';
-import { StreamOutlet } from './impl/LslStreamOutlet.js';
-export type StreamFixuture = StreamOutlet | StreamInlet;
-export type ChannelFormat = (typeof CHANNEL_FORMATS)[number];
-export interface DurationMarker {
-    name: string;
-    durationMs: number;
-}
-export interface Liblsl {
-    createStreamInfo(options: CreateStreamInfoOptions): BoundStreamInfo;
-    appendChannelsToStreamInfo(options: AppendChannelsToStreamInfoOptions): void;
-    createOutlet(options: CreateOutletOptions): BoundOutlet;
-    pushSampleFloatTimestamp(options: PushSampleFloatTimestampOptions): void;
-    pushSampleStringTimestamp(options: PushSampleStringTimestampOptions): void;
-    destroyOutlet(options: DestroyOutletOptions): void;
-    createInlet(options: CreateInletOptions): BoundInlet;
-    flushInlet(options: FlushInletOptions): void;
-    destroyInlet(options: DestroyInletOptions): void;
-    localClock(): number;
-}
-export interface CreateStreamInfoOptions {
-    name: string;
-    type: string;
-    channelCount: number;
-    sampleRate: number;
-    channelFormat: number;
-    sourceId: string;
-    manufacturer?: string;
-    unit?: string;
-}
-export interface AppendChannelsToStreamInfoOptions {
-    info: BoundStreamInfo;
-    channels: LslChannel[];
-}
-export interface LslChannel {
-    label: string;
-    unit: string;
-    type: string;
-}
-export type LslSample = (number | string | undefined)[];
-export interface CreateOutletOptions {
-    info: BoundStreamInfo;
-    chunkSize: number;
-    maxBuffered: 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;
-    maxBuffered: number;
-}
-export interface FlushInletOptions {
-    inlet: BoundInlet;
-}
-export interface DestroyInletOptions {
-}
-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]): void;
-    lsl_push_sample_strt(args: [BoundOutlet, LslSample, number]): void;
-    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 interface BoundStreamInfo {
-}
-export interface BoundOutlet {
-}
-export interface BoundInlet {
-}
-export interface BoundDescription {
-}
-export interface BoundChild {
-}
-export type FfiRsDefineOptions = FuncObj<FieldType, boolean | undefined>;

package/build/types.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=types.js.map

package/build/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/src/types.ts

@@ -1,111 +0,0 @@
-import { FuncObj, FieldType } from 'ffi-rs'
-
-import { CHANNEL_FORMATS } from './consts.js'
-import { StreamInlet } from './impl/LslStreamInlet.js'
-import { StreamOutlet } from './impl/LslStreamOutlet.js'
-
-export type StreamFixuture = StreamOutlet | StreamInlet
-
-export type ChannelFormat = (typeof CHANNEL_FORMATS)[number]
-
-export interface DurationMarker {
-    name: string
-    durationMs: number
-}
-
-export interface Liblsl {
-    createStreamInfo(options: CreateStreamInfoOptions): BoundStreamInfo
-    appendChannelsToStreamInfo(options: AppendChannelsToStreamInfoOptions): void
-    createOutlet(options: CreateOutletOptions): BoundOutlet
-    pushSampleFloatTimestamp(options: PushSampleFloatTimestampOptions): void
-    pushSampleStringTimestamp(options: PushSampleStringTimestampOptions): void
-    destroyOutlet(options: DestroyOutletOptions): void
-    createInlet(options: CreateInletOptions): BoundInlet
-    flushInlet(options: FlushInletOptions): void
-    destroyInlet(options: DestroyInletOptions): void
-    localClock(): number
-}
-
-export interface CreateStreamInfoOptions {
-    name: string
-    type: string
-    channelCount: number
-    sampleRate: number
-    channelFormat: number
-    sourceId: string
-    manufacturer?: string
-    unit?: string
-}
-
-export interface AppendChannelsToStreamInfoOptions {
-    info: BoundStreamInfo
-    channels: LslChannel[]
-}
-
-export interface LslChannel {
-    label: string
-    unit: string
-    type: string
-}
-
-export type LslSample = (number | string | undefined)[]
-
-export interface CreateOutletOptions {
-    info: BoundStreamInfo
-    chunkSize: number
-    maxBuffered: 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
-    maxBuffered: number
-}
-
-export interface FlushInletOptions {
-    inlet: BoundInlet
-}
-
-export interface DestroyInletOptions {}
-
-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]): void
-    lsl_push_sample_strt(args: [BoundOutlet, LslSample, number]): void
-    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 interface BoundStreamInfo {}
-export interface BoundOutlet {}
-export interface BoundInlet {}
-export interface BoundDescription {}
-export interface BoundChild {}
-
-export type FfiRsDefineOptions = FuncObj<FieldType, boolean | undefined>