@neurodevs/node-lsl 16.0.3 → 17.0.0

package/src/impl/LslStreamInfo.ts

@@ -7,7 +7,7 @@ import LiblslAdapter from './LiblslAdapter.js'
 export default class LslStreamInfo implements StreamInfo {
     public static Class?: StreamInfoConstructor
 
-    private static instanceCache: Record<string, StreamInfo> = {}
+    private static instanceCache = new Map<BoundStreamInfo, StreamInfo>()
 
     public readonly name: string
     public readonly type: string
@@ -36,6 +36,7 @@ export default class LslStreamInfo implements StreamInfo {
             channelFormat,
             sampleRateHz,
             units = this.defaultUnits,
+            boundStreamInfo,
         } = options
 
         this.name = name
@@ -47,40 +48,27 @@ export default class LslStreamInfo implements StreamInfo {
         this.sampleRateHz = sampleRateHz
         this.units = units
 
-        this.createStreamInfo()
-        this.appendChannelsToStreamInfo()
+        if (!boundStreamInfo) {
+            this.createStreamInfo()
+            this.appendChannelsToStreamInfo()
+        } else {
+            this.boundInfo = boundStreamInfo
+        }
     }
 
     public static Create(options: StreamInfoOptions) {
-        const {
-            name,
-            type,
-            sourceId,
-            channelNames,
-            channelFormat,
-            sampleRateHz,
-        } = options
-
-        const channelCount = channelNames.length
-
-        const key = JSON.stringify({
-            name,
-            type,
-            sourceId,
-            channelCount,
-            channelFormat,
-            sampleRateHz,
-        })
+        const instance = new (this.Class ?? this)(options)
 
-        let instance = this.instanceCache[key]
+        const { boundStreamInfo: handle } = instance
+        this.instanceCache.set(handle, instance)
 
-        if (instance === undefined) {
-            instance = new (this.Class ?? this)(options)
-            this.instanceCache[key] = instance
-        }
         return instance
     }
 
+    public static From(handle: BoundStreamInfo) {
+        return this.instanceCache.get(handle)!
+    }
+
     private createStreamInfo() {
         this.boundInfo = this.lsl.createStreamInfo({
             name: this.name,
@@ -114,6 +102,10 @@ export default class LslStreamInfo implements StreamInfo {
     public get boundStreamInfo() {
         return this.boundInfo
     }
+
+    public set boundStreamInfo(boundInfo: BoundStreamInfo) {
+        this.boundInfo = boundInfo
+    }
 }
 
 export interface StreamInfo {
@@ -126,7 +118,7 @@ export interface StreamInfo {
     readonly channelCount: number
     readonly channelFormat: ChannelFormat
     readonly sampleRateHz: number
-    readonly boundStreamInfo: BoundStreamInfo
+    boundStreamInfo: BoundStreamInfo
 }
 
 type StreamInfoConstructor = new (options: StreamInfoOptions) => StreamInfo
@@ -139,4 +131,5 @@ export interface StreamInfoOptions {
     type?: string
     sourceId?: string
     units?: string
+    boundStreamInfo?: BoundStreamInfo
 }

package/src/impl/LslStreamInlet.ts

@@ -1,13 +1,9 @@
-import generateId from '@neurodevs/generate-id'
 import { createPointer, DataType, JsExternal, unwrapPointer } from 'ffi-rs'
 
 import handleError from '../handleError.js'
-import { BoundInlet, ChannelFormat } from './LiblslAdapter.js'
+import { BoundInlet } from './LiblslAdapter.js'
 import LiblslAdapter from './LiblslAdapter.js'
-import LslStreamInfo, {
-    StreamInfo,
-    StreamInfoOptions,
-} from './LslStreamInfo.js'
+import LslStreamInfo, { StreamInfo } from './LslStreamInfo.js'
 
 export default class LslStreamInlet implements StreamInlet {
     public static Class?: StreamInletConstructor
@@ -15,13 +11,10 @@ export default class LslStreamInlet implements StreamInlet {
     public isRunning = false
 
     protected info: StreamInfo
-    protected name: string
-    private channelNames: string[]
     private channelCount: number
     private chunkSize: number
     private maxBufferedMs: number
     private timeoutMs: number
-
     private onData: OnDataCallback
 
     protected inlet!: BoundInlet
@@ -40,7 +33,6 @@ export default class LslStreamInlet implements StreamInlet {
     private errorCodeBuffer!: Buffer<ArrayBuffer>
     private errorCodeBufferPtr!: JsExternal
 
-    private readonly defaultName = `lsl-inlet-${generateId()}`
     private readonly sixMinutesInMs = 360 * 1000
 
     private lsl = LiblslAdapter.getInstance()
@@ -50,18 +42,10 @@ export default class LslStreamInlet implements StreamInlet {
         options: StreamInletOptions,
         onData: OnDataCallback
     ) {
-        const {
-            name = this.defaultName,
-            channelNames,
-            chunkSize,
-            maxBufferedMs,
-            timeoutMs,
-        } = options ?? {}
+        const { chunkSize, maxBufferedMs, timeoutMs } = options ?? {}
 
         this.info = info
-        this.name = name
-        this.channelNames = channelNames
-        this.channelCount = this.channelNames.length
+        this.channelCount = this.info.channelCount
         this.chunkSize = chunkSize
         this.maxBufferedMs = maxBufferedMs ?? this.sixMinutesInMs
         this.timeoutMs = timeoutMs ?? 0
@@ -71,13 +55,12 @@ export default class LslStreamInlet implements StreamInlet {
         this.createBoundInlet()
     }
 
-    public static Create(options: StreamInletOptions, onData: OnDataCallback) {
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        const { maxBufferedMs, chunkSize, ...rest } = options
-        const infoOptions: StreamInfoOptions = rest
-
-        const info = this.LslStreamInfo(infoOptions)
-
+    public static async Create(
+        options: StreamInletOptions,
+        onData: OnDataCallback
+    ) {
+        const { sourceId } = options
+        const info = await this.LslStreamInfo(sourceId)
         return new (this.Class ?? this)(info, options, onData)
     }
 
@@ -267,8 +250,15 @@ export default class LslStreamInlet implements StreamInlet {
         this.lsl.destroyInlet({ inlet: this.inlet })
     }
 
-    private static LslStreamInfo(options: StreamInfoOptions) {
-        return LslStreamInfo.Create(options)
+    private static async LslStreamInfo(sourceId: string) {
+        const lsl = LiblslAdapter.getInstance()
+
+        const handles = await lsl.resolveByProp({
+            prop: 'source_id',
+            value: sourceId,
+        })
+
+        return LslStreamInfo.From(handles[0])
     }
 }
 
@@ -287,17 +277,10 @@ export type StreamInletConstructor = new (
 ) => StreamInlet
 
 export interface StreamInletOptions {
-    channelNames: string[]
-    channelFormat: ChannelFormat
-    sampleRateHz: number
+    sourceId: string
     chunkSize: number
     maxBufferedMs?: number
     timeoutMs?: number
-    name?: string
-    type?: string
-    sourceId?: string
-    manufacturer?: string
-    units?: string
 }
 
 export type OnDataCallback = (

package/src/impl/LslWebSocketBridge.ts

@@ -1,5 +1,4 @@
 import WebSocket, { WebSocketServer } from 'ws'
-import { ChannelFormat } from './LiblslAdapter.js'
 import LslStreamInlet, {
     StreamInlet,
     StreamInletOptions,
@@ -26,14 +25,14 @@ export default class LslWebSocketBridge implements WebSocketBridge {
         this.throwIfNoLocalServerOrRemoteSockets()
     }
 
-    public static Create(options: WebSocketBridgeOptions) {
+    public static async Create(options: WebSocketBridgeOptions) {
         const { listenPort, connectUrls, ...rest } = options
         const inletOptions: StreamInletOptions = rest
 
         const localServer = this.WebSocketServer(listenPort)
         const remoteSockets = this.createSocketsFrom(connectUrls)
 
-        const inlet = this.LslStreamInlet(
+        const inlet = await this.LslStreamInlet(
             inletOptions,
             localServer,
             remoteSockets
@@ -175,13 +174,8 @@ export type WebSocketBridgeConstructor = new (
 ) => WebSocketBridge
 
 export interface WebSocketBridgeOptions {
-    channelNames: string[]
-    channelFormat: ChannelFormat
-    sampleRateHz: number
+    sourceId: string
     chunkSize: number
-    name?: string
-    type?: string
-    sourceId?: string
     listenPort?: number
     connectUrls?: string | string[]
 }

package/src/scripts/runOutletToInlet.ts

@@ -26,9 +26,12 @@ const inletOptions = {
     chunkSize: 1,
 }
 
-const inlet = LslStreamInlet.Create(inletOptions, (samples, timestamps) => {
-    console.log('Received samples:', samples, 'at timestamps:', timestamps)
-})
+const inlet = await LslStreamInlet.Create(
+    inletOptions,
+    (samples, timestamps) => {
+        console.log('Received samples:', samples, 'at timestamps:', timestamps)
+    }
+)
 
 console.log('Start pulling...')
 inlet.startPulling()

package/src/testDoubles/Liblsl/FakeLiblsl.ts

@@ -16,9 +16,13 @@ import {
     PullChunkOptions,
     PullSampleOptions,
     DestroyStreamInfoOptions,
+    ResolveByPropOptions,
+    DestroyOutletOptions,
 } from 'impl/LiblslAdapter.js'
 
 export default class FakeLiblsl implements Liblsl {
+    public static fakeStreamInfoHandles: BoundStreamInfo[] = []
+
     public static fakeSamples: Float32Array[] = [
         new Float32Array([1, 2, 3]),
         new Float32Array([4, 5, 6]),
@@ -46,12 +50,14 @@ export default class FakeLiblsl implements Liblsl {
     public streamInfo: BoundStreamInfo = {} as BoundStreamInfo
 
     public lastCreateStreamInfoOptions?: CreateStreamInfoOptions
-    public lastDestroyStreamInfoOptions?: DestroyStreamInfoOptions
     public lastAppendChannelsToStreamInfoOptions?: AppendChannelsToStreamInfoOptions
+    public lastDestroyStreamInfoOptions?: DestroyStreamInfoOptions
+    public lastResolveByPropOptions?: ResolveByPropOptions
     public lastCreateOutletOptions?: CreateOutletOptions
     public lastPushSampleFloatTimestampOptions?: PushSampleFloatTimestampOptions
     public lastPushSampleStringTimestampOptions?: PushSampleStringTimestampOptions
     public lastCreateInletOptions?: CreateInletOptions
+    public lastDestroyOutletOptions?: DestroyOutletOptions
     public lastPullSampleOptions?: PullSampleOptions
     public lastPullChunkOptions?: PullChunkOptions
     public lastFlushInletOptions?: FlushInletOptions
@@ -72,16 +78,21 @@ export default class FakeLiblsl implements Liblsl {
         return this.streamInfo
     }
 
-    public destroyStreamInfo(options: DestroyStreamInfoOptions) {
-        this.lastDestroyStreamInfoOptions = options
-    }
-
     public appendChannelsToStreamInfo(
         options: AppendChannelsToStreamInfoOptions
     ) {
         this.lastAppendChannelsToStreamInfoOptions = options
     }
 
+    public destroyStreamInfo(options: DestroyStreamInfoOptions) {
+        this.lastDestroyStreamInfoOptions = options
+    }
+
+    public async resolveByProp(options: ResolveByPropOptions) {
+        this.lastResolveByPropOptions = options
+        return FakeLiblsl.fakeStreamInfoHandles as bigint[]
+    }
+
     public pushSampleFloatTimestamp(options: PushSampleFloatTimestampOptions) {
         this.lastPushSampleFloatTimestampOptions = options
         return FakeLiblsl.fakeErrorCode
@@ -101,8 +112,9 @@ export default class FakeLiblsl implements Liblsl {
         return this.outlet
     }
 
-    public destroyOutlet() {
+    public destroyOutlet(options: DestroyOutletOptions) {
         this.destroyOutletHitCount++
+        this.lastDestroyOutletOptions = options
     }
 
     public createInlet(options: CreateInletOptions) {

package/src/testDoubles/StreamInfo/FakeStreamInfo.ts

@@ -12,7 +12,7 @@ export default class FakeStreamInfo implements StreamInfo {
     public name = generateId()
     public type = generateId()
     public sourceId = generateId()
-    public channelNames: string[] = [generateId(), generateId()]
+    public channelNames: string[] = [generateId(), generateId(), generateId()]
     public channelFormat = 'float32' as const
     public sampleRateHz = 0
     public units = 'N/A'

package/src/testDoubles/StreamInlet/SpyStreamInlet.ts

@@ -13,10 +13,6 @@ export class SpyStreamInlet extends LslStreamInlet {
         super(info, options, onData)
     }
 
-    public getName() {
-        return this.name
-    }
-
     public getStreamInfo() {
         return this.info
     }