@neurodevs/node-lsl 17.0.0 → 17.1.0

package/src/impl/LslStreamInfo.ts

@@ -17,26 +17,20 @@ export default class LslStreamInfo implements StreamInfo {
     public readonly channelFormat: ChannelFormat
     public readonly sampleRateHz: number
     public readonly units: string
-
-    protected boundInfo!: BoundStreamInfo
-
-    private readonly defaultName = `lsl-stream-info-${generateId()}`
-    private readonly defaultType = generateId()
-    private readonly defaultSourceId = generateId()
-    private readonly defaultUnits = 'N/A'
+    public readonly boundInfo: BoundStreamInfo
 
     private lsl = LiblslAdapter.getInstance()
 
     protected constructor(options: StreamInfoOptions) {
         const {
-            name = this.defaultName,
-            type = this.defaultType,
-            sourceId = this.defaultSourceId,
+            name = `lsl-stream-info-${generateId()}`,
+            type = generateId(),
+            sourceId = generateId(),
             channelNames,
             channelFormat,
             sampleRateHz,
-            units = this.defaultUnits,
-            boundStreamInfo,
+            units = 'N/A',
+            boundInfo,
         } = options
 
         this.name = name
@@ -48,18 +42,18 @@ export default class LslStreamInfo implements StreamInfo {
         this.sampleRateHz = sampleRateHz
         this.units = units
 
-        if (!boundStreamInfo) {
-            this.createStreamInfo()
+        if (!boundInfo) {
+            this.boundInfo = this.createStreamInfo()
             this.appendChannelsToStreamInfo()
         } else {
-            this.boundInfo = boundStreamInfo
+            this.boundInfo = boundInfo
         }
     }
 
     public static Create(options: StreamInfoOptions) {
         const instance = new (this.Class ?? this)(options)
 
-        const { boundStreamInfo: handle } = instance
+        const { boundInfo: handle } = instance
         this.instanceCache.set(handle, instance)
 
         return instance
@@ -70,7 +64,7 @@ export default class LslStreamInfo implements StreamInfo {
     }
 
     private createStreamInfo() {
-        this.boundInfo = this.lsl.createStreamInfo({
+        return this.lsl.createStreamInfo({
             name: this.name,
             type: this.type,
             sourceId: this.sourceId,
@@ -98,14 +92,6 @@ export default class LslStreamInfo implements StreamInfo {
     public destroy() {
         this.lsl.destroyStreamInfo({ info: this.boundInfo })
     }
-
-    public get boundStreamInfo() {
-        return this.boundInfo
-    }
-
-    public set boundStreamInfo(boundInfo: BoundStreamInfo) {
-        this.boundInfo = boundInfo
-    }
 }
 
 export interface StreamInfo {
@@ -118,7 +104,7 @@ export interface StreamInfo {
     readonly channelCount: number
     readonly channelFormat: ChannelFormat
     readonly sampleRateHz: number
-    boundStreamInfo: BoundStreamInfo
+    readonly boundInfo: BoundStreamInfo
 }
 
 type StreamInfoConstructor = new (options: StreamInfoOptions) => StreamInfo
@@ -131,5 +117,5 @@ export interface StreamInfoOptions {
     type?: string
     sourceId?: string
     units?: string
-    boundStreamInfo?: BoundStreamInfo
+    boundInfo?: BoundStreamInfo
 }

package/src/impl/LslStreamInlet.ts

@@ -3,7 +3,7 @@ import { createPointer, DataType, JsExternal, unwrapPointer } from 'ffi-rs'
 import handleError from '../handleError.js'
 import { BoundInlet } from './LiblslAdapter.js'
 import LiblslAdapter from './LiblslAdapter.js'
-import LslStreamInfo, { StreamInfo } from './LslStreamInfo.js'
+import { StreamInfo } from './LslStreamInfo.js'
 
 export default class LslStreamInlet implements StreamInlet {
     public static Class?: StreamInletConstructor
@@ -39,7 +39,7 @@ export default class LslStreamInlet implements StreamInlet {
 
     protected constructor(
         info: StreamInfo,
-        options: StreamInletOptions,
+        options: StreamInletConstructorOptions,
         onData: OnDataCallback
     ) {
         const { chunkSize, maxBufferedMs, timeoutMs } = options ?? {}
@@ -59,8 +59,7 @@ export default class LslStreamInlet implements StreamInlet {
         options: StreamInletOptions,
         onData: OnDataCallback
     ) {
-        const { sourceId } = options
-        const info = await this.LslStreamInfo(sourceId)
+        const { info } = options
         return new (this.Class ?? this)(info, options, onData)
     }
 
@@ -74,15 +73,11 @@ export default class LslStreamInlet implements StreamInlet {
 
     private createBoundInlet() {
         this.inlet = this.lsl.createInlet({
-            info: this.boundStreamInfo,
+            info: this.info.boundInfo,
             maxBufferedMs: this.maxBufferedMs,
         })
     }
 
-    private get boundStreamInfo() {
-        return this.info.boundStreamInfo
-    }
-
     public startPulling() {
         this.isRunning = true
 
@@ -249,17 +244,6 @@ export default class LslStreamInlet implements StreamInlet {
     private destroyBoundInlet() {
         this.lsl.destroyInlet({ inlet: this.inlet })
     }
-
-    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])
-    }
 }
 
 export interface StreamInlet {
@@ -272,17 +256,19 @@ export interface StreamInlet {
 
 export type StreamInletConstructor = new (
     info: StreamInfo,
-    options: StreamInletOptions,
+    options: StreamInletConstructorOptions,
     onData: OnDataCallback
 ) => StreamInlet
 
 export interface StreamInletOptions {
-    sourceId: string
+    info: StreamInfo
     chunkSize: number
     maxBufferedMs?: number
     timeoutMs?: number
 }
 
+export type StreamInletConstructorOptions = Omit<StreamInletOptions, 'info'>
+
 export type OnDataCallback = (
     samples: Float32Array,
     timestamps: Float64Array

package/src/impl/LslStreamOutlet.ts

@@ -21,6 +21,7 @@ import LslStreamInfo, {
 export default class LslStreamOutlet implements StreamOutlet {
     public static Class?: StreamOutletConstructor
 
+    public readonly info: StreamInfo
     public readonly name: string
     public readonly type: string
     public readonly sourceId: string
@@ -33,7 +34,6 @@ export default class LslStreamOutlet implements StreamOutlet {
     public readonly manufacturer: string = 'N/A'
     public readonly units: string = 'N/A'
 
-    private info: StreamInfo
     private boundOutlet!: BoundOutlet
     private pushSampleMethod!: (options: unknown) => LslErrorCode
 
@@ -109,16 +109,12 @@ export default class LslStreamOutlet implements StreamOutlet {
 
     private createStreamOutlet() {
         this.boundOutlet = this.lsl.createOutlet({
-            info: this.boundStreamInfo,
+            info: this.info.boundInfo,
             chunkSize: this.chunkSize,
             maxBufferedMs: this.maxBufferedMs,
         })
     }
 
-    private get boundStreamInfo() {
-        return this.info.boundStreamInfo
-    }
-
     private setPushSampleMethod() {
         this.pushSampleMethod = (
             this.lsl[this.pushMethod] as (options: unknown) => LslErrorCode
@@ -146,12 +142,12 @@ export default class LslStreamOutlet implements StreamOutlet {
     }
 
     public destroy() {
-        this.destroyBoundStreamInfo()
+        this.destroyBoundInfo()
         this.destroyBoundOutlet()
     }
 
-    private destroyBoundStreamInfo() {
-        this.lsl.destroyStreamInfo({ info: this.boundStreamInfo })
+    private destroyBoundInfo() {
+        this.lsl.destroyStreamInfo({ info: this.info.boundInfo })
     }
 
     private destroyBoundOutlet() {
@@ -190,6 +186,7 @@ export default class LslStreamOutlet implements StreamOutlet {
 export interface StreamOutlet {
     pushSample(sample: LslSample): void
     destroy(): void
+    readonly info: StreamInfo
     readonly name: string
     readonly type: string
     readonly sourceId: string

package/src/impl/LslWebSocketBridge.ts

@@ -1,4 +1,5 @@
 import WebSocket, { WebSocketServer } from 'ws'
+import { StreamInfo } from './LslStreamInfo.js'
 import LslStreamInlet, {
     StreamInlet,
     StreamInletOptions,
@@ -153,7 +154,7 @@ export default class LslWebSocketBridge implements WebSocketBridge {
         return listenPort ? new this.WSS({ port: listenPort }) : undefined
     }
 
-    private static LslStreamInlet(
+    private static async LslStreamInlet(
         options: StreamInletOptions,
         localServer?: WebSocketServer,
         remoteSockets?: WebSocket[]
@@ -174,14 +175,13 @@ export type WebSocketBridgeConstructor = new (
 ) => WebSocketBridge
 
 export interface WebSocketBridgeOptions {
-    sourceId: string
+    info: StreamInfo
     chunkSize: number
     listenPort?: number
     connectUrls?: string | string[]
 }
 
-export interface WebSocketBridgeConstructorOptions
-    extends WebSocketBridgeOptions {
+export interface WebSocketBridgeConstructorOptions extends WebSocketBridgeOptions {
     inlet: StreamInlet
     localServer?: WebSocketServer
     remoteSockets?: WebSocket[]

package/src/scripts/runLslStreamOutlet.ts

@@ -1,19 +1,25 @@
 import LslStreamOutlet from '../impl/LslStreamOutlet.js'
 
 async function main() {
-    const instance = await LslStreamOutlet.Create({
-        name: 'Muse S (2nd gen)',
-        type: 'EEG',
-        channelNames: ['TP9', 'AF7', 'AF8', 'TP10', 'AUX'],
-        sampleRateHz: 256,
+    const outlet = await LslStreamOutlet.Create({
+        name: '10 Hz Pulse',
+        type: 'HZ',
+        sourceId: '10-hz-pulse',
+        channelNames: ['Ch1', 'Ch2', 'Ch3'],
         channelFormat: 'float32',
-        sourceId: 'muse-s-eeg',
-        manufacturer: 'Interaxon Inc.',
-        units: 'microvolt',
-        chunkSize: 12,
+        sampleRateHz: 10,
+        chunkSize: 1,
     })
 
-    instance.pushSample([1, 2, 3, 4, 5])
+    for (let i = 0; i < 100; i++) {
+        await new Promise((resolve) => setTimeout(resolve, 100))
+
+        outlet.pushSample([
+            Math.random() * 100,
+            Math.random() * 100,
+            Math.random() * 100,
+        ])
+    }
 }
 
 main().catch((error) => {

package/src/scripts/runOutletToInlet.ts

@@ -17,12 +17,7 @@ const outlet = await LslStreamOutlet.Create({
 console.log('Creating inlet...')
 
 const inletOptions = {
-    name: 'TestOutlet',
-    type: 'TEST',
-    sourceId: 'TestOutletID',
-    sampleRateHz: 100,
-    channelNames: ['Ch1', 'Ch2', 'Ch3'],
-    channelFormat: 'float32' as const,
+    info: outlet.info,
     chunkSize: 1,
 }
 

package/src/testDoubles/StreamInfo/FakeStreamInfo.ts

@@ -4,10 +4,10 @@ import { BoundStreamInfo } from 'impl/LiblslAdapter.js'
 import { StreamInfo, StreamInfoOptions } from '../../impl/LslStreamInfo.js'
 
 export default class FakeStreamInfo implements StreamInfo {
-    public static callsToConstructor: StreamInfoOptions[] = []
+    public static callsToConstructor: (StreamInfoOptions | undefined)[] = []
     public static numCallsToDestroy = 0
 
-    public static boundStreamInfo = {} as BoundStreamInfo
+    public static boundInfo = {} as BoundStreamInfo
 
     public name = generateId()
     public type = generateId()
@@ -17,7 +17,7 @@ export default class FakeStreamInfo implements StreamInfo {
     public sampleRateHz = 0
     public units = 'N/A'
 
-    public constructor(options: StreamInfoOptions) {
+    public constructor(options?: StreamInfoOptions) {
         FakeStreamInfo.callsToConstructor.push(options)
     }
 
@@ -29,8 +29,8 @@ export default class FakeStreamInfo implements StreamInfo {
         return this.channelNames.length
     }
 
-    public get boundStreamInfo() {
-        return FakeStreamInfo.boundStreamInfo
+    public get boundInfo() {
+        return FakeStreamInfo.boundInfo
     }
 
     public static resetTestDouble() {

package/src/testDoubles/StreamInfo/SpyStreamInfo.ts

@@ -8,10 +8,6 @@ export default class SpyStreamInfo extends LslStreamInfo {
         SpyStreamInfo.numCallsToConstructor++
     }
 
-    public getBoundInfo() {
-        return this.boundInfo
-    }
-
     public getName() {
         return this.name
     }

package/src/testDoubles/StreamInlet/FakeStreamInlet.ts

@@ -1,10 +1,13 @@
 import { StreamInfo } from '../../impl/LslStreamInfo.js'
-import { StreamInlet, StreamInletOptions } from '../../impl/LslStreamInlet.js'
+import {
+    StreamInlet,
+    StreamInletConstructorOptions,
+} from '../../impl/LslStreamInlet.js'
 
 export default class FakeStreamInlet implements StreamInlet {
     public static callsToConstructor: {
         info?: StreamInfo
-        options?: StreamInletOptions
+        options?: StreamInletConstructorOptions
         onData?: (samples: Float32Array, timestamps: Float64Array) => void
     }[] = []
 
@@ -19,7 +22,7 @@ export default class FakeStreamInlet implements StreamInlet {
 
     public constructor(
         info?: StreamInfo,
-        options?: StreamInletOptions,
+        options?: StreamInletConstructorOptions,
         onData?: (samples: Float32Array, timestamps: Float64Array) => void
     ) {
         this.onData = onData ?? (() => {})

package/src/testDoubles/StreamInlet/SpyStreamInlet.ts

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

package/src/testDoubles/StreamOutlet/FakeStreamOutlet.ts

@@ -7,6 +7,7 @@ import {
     StreamOutlet,
     StreamOutletOptions,
 } from '../../impl/LslStreamOutlet.js'
+import FakeStreamInfo from '../StreamInfo/FakeStreamInfo.js'
 
 export default class FakeStreamOutlet implements StreamOutlet {
     public static callsToConstructor: {
@@ -17,10 +18,13 @@ export default class FakeStreamOutlet implements StreamOutlet {
     public static callsToPushSample: LslSample[] = []
     public static numCallsToDestroy = 0
 
+    public info: StreamInfo
     public options?: StreamOutletOptions
 
     public constructor(info?: StreamInfo, options?: StreamOutletOptions) {
         FakeStreamOutlet.callsToConstructor.push({ info, options })
+
+        this.info = info ?? new FakeStreamInfo()
         this.options = options
     }