@neurodevs/node-lsl 14.0.0 → 14.1.0

package/build/testDoubles/StreamInfo/SpyStreamInfo.js.map

@@ -1 +1 @@
-{"version":3,"file":"SpyStreamInfo.js","sourceRoot":"","sources":["../../../src/testDoubles/StreamInfo/SpyStreamInfo.ts"],"names":[],"mappings":"AAAA,OAAO,aAAoC,MAAM,6BAA6B,CAAA;AAE9E,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,aAAa;IACpD,YAAmB,OAA0B;QACzC,KAAK,CAAC,OAAO,CAAC,CAAA;IAClB,CAAC;IAEM,aAAa;QAChB,OAAO,IAAI,CAAC,UAAU,CAAA;IAC1B,CAAC;IAEM,OAAO;QACV,OAAO,IAAI,CAAC,IAAI,CAAA;IACpB,CAAC;IAEM,OAAO;QACV,OAAO,IAAI,CAAC,IAAI,CAAA;IACpB,CAAC;IAEM,WAAW;QACd,OAAO,IAAI,CAAC,QAAQ,CAAA;IACxB,CAAC;IAEM,QAAQ;QACX,OAAO,IAAI,CAAC,KAAK,CAAA;IACrB,CAAC;CACJ"}
+{"version":3,"file":"SpyStreamInfo.js","sourceRoot":"","sources":["../../../src/testDoubles/StreamInfo/SpyStreamInfo.ts"],"names":[],"mappings":"AAAA,OAAO,aAAoC,MAAM,6BAA6B,CAAA;AAE9E,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,aAAa;IACpD,YAAmB,OAA0B;QACzC,KAAK,CAAC,OAAO,CAAC,CAAA;IAClB,CAAC;IAEM,YAAY;QACf,OAAO,IAAI,CAAC,SAAS,CAAA;IACzB,CAAC;IAEM,OAAO;QACV,OAAO,IAAI,CAAC,IAAI,CAAA;IACpB,CAAC;IAEM,OAAO;QACV,OAAO,IAAI,CAAC,IAAI,CAAA;IACpB,CAAC;IAEM,WAAW;QACd,OAAO,IAAI,CAAC,QAAQ,CAAA;IACxB,CAAC;IAEM,QAAQ;QACX,OAAO,IAAI,CAAC,KAAK,CAAA;IACrB,CAAC;CACJ"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neurodevs/node-lsl",
-  "version": "14.0.0",
+  "version": "14.1.0",
   "description": "Lab Streaming Layer (LSL) bindings for Node",
   "type": "module",
   "keywords": [

package/src/__tests__/impl/LiblslAdapter.test.ts

@@ -33,7 +33,9 @@ export default class LiblslAdapterTest extends AbstractPackageTest {
     private static fakeInlet: BoundInlet = {}
     private static fakeDesc: BoundDescription
     private static fakeChildNamedChannels: BoundChild
+
     private static createStreamInfoParams?: any[]
+    private static destroyStreamInfoParams?: any[]
     private static appendChildParams: any[] = []
     private static createOutletParams?: any[]
     private static destroyOutletParams?: any[]
@@ -162,6 +164,11 @@ export default class LiblslAdapterTest extends AbstractPackageTest {
                     DataType.String,
                 ],
             },
+            lsl_destroy_streaminfo: {
+                library: 'lsl',
+                retType: DataType.Void,
+                paramsType: [DataType.External],
+            },
             lsl_create_outlet: {
                 library: 'lsl',
                 retType: DataType.External,
@@ -233,7 +240,7 @@ export default class LiblslAdapterTest extends AbstractPackageTest {
     }
 
     @test()
-    protected static async canCreateStreamInfoWithRequiredParams() {
+    protected static async createsStreamInfoWithRequiredParams() {
         const options = this.generateRandomCreateStreamInfoOptions()
         const actual = this.instance.createStreamInfo(options)
 
@@ -242,7 +249,19 @@ export default class LiblslAdapterTest extends AbstractPackageTest {
     }
 
     @test()
-    protected static async canCreateOutletWithRequiredParams() {
+    protected static async destroysStreamInfoWithBoundInfo() {
+        const info = this.createRandomStreamInfo()
+        this.instance.destroyStreamInfo({ info })
+
+        assert.isEqualDeep(
+            this.destroyStreamInfoParams,
+            [info],
+            'Did not call destroyStreamInfo with expected params!'
+        )
+    }
+
+    @test()
+    protected static async createsOutletWithRequiredParams() {
         const { options, outlet } = this.createRandomOutlet()
 
         const expected = {
@@ -255,7 +274,7 @@ export default class LiblslAdapterTest extends AbstractPackageTest {
     }
 
     @test()
-    protected static async canPushFloatSample() {
+    protected static async pushesFloatSample() {
         const expected = [1.0, 2.0, 3.0]
         const timestamp = randomInt(100)
         const options = {
@@ -273,7 +292,7 @@ export default class LiblslAdapterTest extends AbstractPackageTest {
     }
 
     @test()
-    protected static async canPushStringSample() {
+    protected static async pushesStringSample() {
         const expected = [this.generateId()]
         const timestamp = randomInt(100)
         const options = {
@@ -386,7 +405,7 @@ export default class LiblslAdapterTest extends AbstractPackageTest {
     }
 
     @test()
-    protected static async canCreateInletWithRequiredParams() {
+    protected static async createInletWithRequiredParams() {
         const { options, inlet } = this.createRandomInlet()
 
         const expected = {
@@ -604,6 +623,9 @@ export default class LiblslAdapterTest extends AbstractPackageTest {
                 this.createStreamInfoParams = params
                 return this.fakeStreamInfo
             },
+            lsl_destroy_streaminfo: (params: any[]) => {
+                this.destroyStreamInfoParams = params
+            },
             lsl_create_outlet: (params: any[]) => {
                 this.createOutletParams = params
                 return this.fakeOutlet

package/src/__tests__/impl/LslEventMarkerOutlet.test.ts

@@ -148,6 +148,17 @@ export default class EventMarkerOutletTest extends AbstractPackageTest {
         assert.isEqual(FakeStreamOutlet.callsToPushSample[0][0], markerName)
     }
 
+    @test()
+    protected static async destroyCallsDestroyOnInternalStreamOutlet() {
+        this.instance.destroy()
+
+        assert.isEqual(
+            FakeStreamOutlet.numCallsToDestroy,
+            1,
+            'Did not call destroy on outlet!'
+        )
+    }
+
     private static get streamOutlet() {
         return this.instance.getStreamOutlet()
     }

package/src/__tests__/impl/LslStreamInfo.test.ts

@@ -170,7 +170,7 @@ export default class LslStreamInfoTest extends AbstractPackageTest {
         assert.isEqualDeep(
             this.fakeLiblsl.lastAppendChannelsToStreamInfoOptions,
             {
-                info: this.instance.getStreamInfo(),
+                info: this.instance.getBoundInfo(),
                 channels: this.channelNames.map((label: string) => ({
                     label,
                     units: this.units,
@@ -181,6 +181,17 @@ export default class LslStreamInfoTest extends AbstractPackageTest {
         )
     }
 
+    @test()
+    protected static async callsBindingsToDestroyStreamInfo() {
+        this.instance.destroy()
+
+        assert.isEqualDeep(
+            this.fakeLiblsl.lastDestroyStreamInfoOptions?.info,
+            this.instance.getBoundInfo(),
+            'Should have called destroyStreamInfo!'
+        )
+    }
+
     private static readonly defaultOptions = {
         name: this.generateId(),
         type: this.generateId(),

package/src/__tests__/impl/LslStreamInlet.test.ts

@@ -90,7 +90,18 @@ export default class LslStreamInletTest extends AbstractPackageTest {
         assert.isEqualDeep(
             this.fakeLiblsl.lastDestroyInletOptions,
             { inlet: this.boundInlet },
-            'Should have called destroyInlet!'
+            'Did not destroy inlet!'
+        )
+    }
+
+    @test()
+    protected static async destroyAlsoCallsDestroyStreamInfo() {
+        this.instance.destroy()
+
+        assert.isEqualDeep(
+            this.fakeLiblsl.lastDestroyStreamInfoOptions,
+            { info: this.instance.getStreamInfo().boundStreamInfo },
+            'Did not destroy stream info!'
         )
     }
 

package/src/__tests__/impl/LslStreamOutlet.test.ts

@@ -193,6 +193,18 @@ export default class LslStreamOutletTest extends AbstractPackageTest {
         assert.isEqual(this.fakeLiblsl.destroyOutletHitCount, 1)
     }
 
+    @test()
+    protected static async destroyAlsoCallsDestroyStreamInfo() {
+        const outlet = await this.LslStreamOutlet()
+        outlet.destroy()
+
+        assert.isEqualDeep(
+            this.fakeLiblsl.lastDestroyStreamInfoOptions,
+            { info: this.fakeLiblsl.streamInfo },
+            'Did not call destroyStreamInfo on destroy!'
+        )
+    }
+
     @test()
     protected static async pushSampleShouldNotCreateMultipleOutlets() {
         const outlet = await this.FloatOutlet()

package/src/impl/LiblslAdapter.ts

@@ -69,10 +69,10 @@ export default class LiblslAdapter implements Liblsl {
         const {
             name,
             type,
+            sourceId,
             channelCount,
-            sampleRateHz,
             channelFormat,
-            sourceId,
+            sampleRateHz,
         } = options
 
         return this.bindings.lsl_create_streaminfo([
@@ -85,6 +85,11 @@ export default class LiblslAdapter implements Liblsl {
         ])
     }
 
+    public destroyStreamInfo(options: DestroyStreamInfoOptions) {
+        const { info } = options
+        this.bindings.lsl_destroy_streaminfo([info])
+    }
+
     public appendChannelsToStreamInfo(
         options: AppendChannelsToStreamInfoOptions
     ) {
@@ -248,6 +253,11 @@ export default class LiblslAdapter implements Liblsl {
                     DataType.String,
                 ],
             },
+            lsl_destroy_streaminfo: {
+                library: 'lsl',
+                retType: DataType.Void,
+                paramsType: [DataType.External],
+            },
             lsl_create_outlet: {
                 library: 'lsl',
                 retType: DataType.External,
@@ -323,6 +333,7 @@ export interface Liblsl {
     liblslPath: string
 
     createStreamInfo(options: CreateStreamInfoOptions): BoundStreamInfo
+    destroyStreamInfo(options: DestroyStreamInfoOptions): void
     appendChannelsToStreamInfo(options: AppendChannelsToStreamInfoOptions): void
 
     createOutlet(options: CreateOutletOptions): BoundOutlet
@@ -349,10 +360,10 @@ export interface Liblsl {
 export interface CreateStreamInfoOptions {
     name: string
     type: string
+    sourceId: string
     channelCount: number
-    sampleRateHz: number
     channelFormat: number
-    sourceId: string
+    sampleRateHz: number
     manufacturer?: string
     units?: string
 }
@@ -368,6 +379,10 @@ export interface CreateOutletOptions {
     maxBufferedMs: number
 }
 
+export interface DestroyStreamInfoOptions {
+    info: BoundStreamInfo
+}
+
 export interface PushSampleFloatTimestampOptions {
     outlet: BoundOutlet
     sample: number[]
@@ -421,6 +436,7 @@ export interface LiblslBindings {
         args: [string, string, number, number, number, string]
     ): BoundStreamInfo
 
+    lsl_destroy_streaminfo(args: [BoundStreamInfo]): void
     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

package/src/impl/LslEventMarkerOutlet.ts

@@ -74,12 +74,17 @@ export default class LslEventMarkerOutlet implements EventMarkerOutlet {
         clearTimeout(this.timeout)
         this.isPlaying = false
     }
+
+    public destroy() {
+        this.outlet.destroy()
+    }
 }
 
 export interface EventMarkerOutlet {
     pushMarker(markerName: string): void
     pushMarkers(markers: DurationMarker[]): Promise<void>
     stop(): void
+    destroy(): void
 }
 
 export type EventMarkerOutletConstructor = new (

package/src/impl/LslStreamInfo.ts

@@ -11,11 +11,16 @@ export default class LslStreamInfo implements StreamInfo {
     protected type: string
     protected sourceId: string
     protected units: string
-    protected streamInfo!: BoundStreamInfo
+    protected boundInfo!: BoundStreamInfo
     private channelNames: string[]
     private channelFormat: ChannelFormat
     private sampleRateHz: number
 
+    private readonly defaultName = `lsl-stream-info-${generateId()}`
+    private readonly defaultType = generateId()
+    private readonly defaultSourceId = generateId()
+    private readonly defaultUnits = 'N/A'
+
     protected constructor(options: StreamInfoOptions) {
         const {
             name = this.defaultName,
@@ -44,7 +49,7 @@ export default class LslStreamInfo implements StreamInfo {
     }
 
     private createStreamInfo() {
-        this.streamInfo = this.lsl.createStreamInfo({
+        this.boundInfo = this.lsl.createStreamInfo({
             name: this.name,
             type: this.type,
             sourceId: this.sourceId,
@@ -54,9 +59,17 @@ export default class LslStreamInfo implements StreamInfo {
         })
     }
 
+    private get channelCount() {
+        return this.channelNames.length
+    }
+
+    private get lslChannelFormat() {
+        return CHANNEL_FORMATS_MAP[this.channelFormat]
+    }
+
     private appendChannelsToStreamInfo() {
         this.lsl.appendChannelsToStreamInfo({
-            info: this.streamInfo,
+            info: this.boundInfo,
             channels: this.channelNames.map((label: string) => ({
                 label,
                 units: this.units,
@@ -65,30 +78,22 @@ export default class LslStreamInfo implements StreamInfo {
         })
     }
 
-    public get boundStreamInfo() {
-        return this.streamInfo
+    public destroy() {
+        this.lsl.destroyStreamInfo({ info: this.boundInfo })
     }
 
-    private get channelCount() {
-        return this.channelNames.length
-    }
-
-    private get lslChannelFormat() {
-        return CHANNEL_FORMATS_MAP[this.channelFormat]
+    public get boundStreamInfo() {
+        return this.boundInfo
     }
 
     private get lsl() {
         return LiblslAdapter.getInstance()
     }
-
-    private readonly defaultName = `lsl-stream-info-${generateId()}`
-    private readonly defaultType = generateId()
-    private readonly defaultSourceId = generateId()
-    private readonly defaultUnits = 'N/A'
 }
 
 export interface StreamInfo {
-    boundStreamInfo: BoundStreamInfo
+    destroy(): void
+    readonly boundStreamInfo: BoundStreamInfo
 }
 
 type StreamInfoConstructor = new (options: StreamInfoOptions) => StreamInfo

package/src/impl/LslStreamInlet.ts

@@ -88,12 +88,16 @@ export default class LslStreamInlet implements StreamInlet {
 
     private createBoundInlet() {
         this.inlet = this.lsl.createInlet({
-            info: this.info.boundStreamInfo,
+            info: this.boundStreamInfo,
             chunkSize: this.chunkSize,
             maxBufferedMs: this.maxBufferedMs / 1000,
         })
     }
 
+    private get boundStreamInfo() {
+        return this.info.boundStreamInfo
+    }
+
     public startPulling() {
         this.isRunning = true
 
@@ -250,6 +254,15 @@ export default class LslStreamInlet implements StreamInlet {
     }
 
     public destroy() {
+        this.destroyBoundStreamInfo()
+        this.destroyBoundInlet()
+    }
+
+    private destroyBoundStreamInfo() {
+        this.lsl.destroyStreamInfo({ info: this.boundStreamInfo })
+    }
+
+    private destroyBoundInlet() {
         this.lsl.destroyInlet({ inlet: this.inlet })
     }
 

package/src/impl/LslStreamOutlet.ts

@@ -21,14 +21,48 @@ import LslStreamInfo, {
 export default class LslStreamOutlet implements StreamOutlet {
     public static Class?: StreamOutletConstructor
 
+    public readonly name: string
+    public readonly type: string
+    public readonly sourceId: string
+    public readonly channelNames: string[]
+    public readonly channelFormat: ChannelFormat
+    public readonly channelCount: number
+    public readonly sampleRateHz: number
+    public readonly chunkSize: number
+    public readonly maxBufferedMs = 360 * 1000
+    public readonly manufacturer: string = 'N/A'
+    public readonly units: string = 'N/A'
+
     private info: StreamInfo
-    private options: StreamOutletOptions
     private outlet!: BoundOutlet
     private pushSampleMethod!: (options: unknown) => LslErrorCode
 
     protected constructor(info: StreamInfo, options: StreamOutletOptions) {
+        const {
+            name,
+            type,
+            sourceId,
+            channelNames,
+            channelFormat,
+            sampleRateHz,
+            chunkSize,
+            maxBufferedMs,
+            manufacturer,
+            units,
+        } = options
+
         this.info = info
-        this.options = options
+        this.name = name
+        this.type = type
+        this.sourceId = sourceId
+        this.channelNames = channelNames
+        this.channelFormat = channelFormat
+        this.channelCount = channelNames.length
+        this.sampleRateHz = sampleRateHz
+        this.chunkSize = chunkSize
+        this.maxBufferedMs = maxBufferedMs ?? this.maxBufferedMs
+        this.manufacturer = manufacturer ?? this.manufacturer
+        this.units = units ?? this.units
 
         this.validateOptions()
         this.createStreamOutlet()
@@ -38,20 +72,10 @@ export default class LslStreamOutlet implements StreamOutlet {
     public static async Create(options: StreamOutletOptions) {
         const { waitAfterConstructionMs = 10 } = options ?? {}
 
-        const infoOptions = {
-            channelNames: options.channelNames,
-            channelFormat: options.channelFormat,
-            sampleRateHz: options.sampleRateHz,
-            name: options.name,
-            type: options.type,
-            sourceId: options.sourceId,
-            units: options.units,
-        }
-
-        const info = this.LslStreamInfo(infoOptions)
+        const info = this.LslStreamInfo(options)
         const instance = new (this.Class ?? this)(info, options)
 
-        await this.wait(waitAfterConstructionMs)
+        await this.waitToAllowSetup(waitAfterConstructionMs)
 
         return instance
     }
@@ -62,6 +86,23 @@ export default class LslStreamOutlet implements StreamOutlet {
         assertValidChannelFormat(this.channelFormat)
         assertValidChunkSize(this.chunkSize)
         assertValidMaxBufferedMs(this.maxBufferedMs)
+        this.validateChannelFormat()
+    }
+
+    private validateChannelFormat() {
+        if (!this.isChannelFormatSupported) {
+            this.throwUnsupportedChannelFormat()
+        }
+    }
+
+    private get isChannelFormatSupported() {
+        return this.channelFormat in this.methodMap
+    }
+
+    private throwUnsupportedChannelFormat() {
+        throw new Error(
+            `This method currently does not support the ${this.channelFormat} type! Please implement it.`
+        )
     }
 
     private createStreamOutlet() {
@@ -72,28 +113,16 @@ export default class LslStreamOutlet implements StreamOutlet {
         })
     }
 
-    private setPushSampleMethod() {
-        this.validateChannelFormat()
+    private get boundStreamInfo() {
+        return this.info.boundStreamInfo
+    }
 
+    private setPushSampleMethod() {
         this.pushSampleMethod = (
             this.lsl[this.pushMethod] as (options: unknown) => LslErrorCode
         ).bind(this.lsl)
     }
 
-    private validateChannelFormat() {
-        if (!(this.channelFormat in this.methodMap)) {
-            this.throwUnsupportedChannelFormat()
-        }
-    }
-
-    private throwUnsupportedChannelFormat() {
-        throw new Error(this.unsupportedChannelMessage)
-    }
-
-    private get unsupportedChannelMessage() {
-        return `This method currently does not support the ${this.channelFormat} type! Please implement it.`
-    }
-
     private get pushMethod() {
         return this.methodMap[this.channelFormat]
     }
@@ -106,77 +135,57 @@ export default class LslStreamOutlet implements StreamOutlet {
     public pushSample(sample: LslSample) {
         const timestamp = this.lsl.localClock()
 
-        handleError(
-            this.pushSampleMethod({
-                outlet: this.outlet,
-                sample,
-                timestamp,
-            })
-        )
+        const err = this.pushSampleMethod({
+            outlet: this.outlet,
+            sample,
+            timestamp,
+        })
+        handleError(err)
     }
 
     public destroy() {
-        this.lsl.destroyOutlet({ outlet: this.outlet })
-    }
-
-    public get name() {
-        return this.options.name
-    }
-
-    public get type() {
-        return this.options.type
-    }
-
-    public get sourceId() {
-        return this.options.sourceId
-    }
-
-    public get channelNames() {
-        return this.options.channelNames
-    }
-
-    public get channelCount() {
-        return this.channelNames.length
+        this.destroyBoundStreamInfo()
+        this.destroyBoundOutlet()
     }
 
-    public get channelFormat() {
-        return this.options.channelFormat
+    private destroyBoundStreamInfo() {
+        this.lsl.destroyStreamInfo({ info: this.boundStreamInfo })
     }
 
-    public get sampleRateHz() {
-        return this.options.sampleRateHz
-    }
-
-    public get chunkSize() {
-        return this.options.chunkSize
-    }
-
-    public get maxBufferedMs() {
-        return this.options.maxBufferedMs ?? 360 * 1000
-    }
-
-    public get manufacturer() {
-        return this.options.manufacturer ?? 'N/A'
-    }
-
-    public get units() {
-        return this.options.units ?? 'N/A'
-    }
-
-    private get boundStreamInfo() {
-        return this.info.boundStreamInfo
+    private destroyBoundOutlet() {
+        this.lsl.destroyOutlet({ outlet: this.outlet })
     }
 
     private get lsl() {
         return LiblslAdapter.getInstance()
     }
 
-    private static async wait(waitMs: number) {
-        return new Promise((resolve) => setTimeout(resolve, waitMs))
+    private static async waitToAllowSetup(waitAfterConstructionMs: number) {
+        await new Promise((resolve) =>
+            setTimeout(resolve, waitAfterConstructionMs)
+        )
     }
 
     private static LslStreamInfo(options: StreamInfoOptions) {
-        return LslStreamInfo.Create(options)
+        const {
+            channelNames,
+            channelFormat,
+            sampleRateHz,
+            name,
+            type,
+            sourceId,
+            units,
+        } = options
+
+        return LslStreamInfo.Create({
+            name,
+            type,
+            sourceId,
+            channelNames,
+            channelFormat,
+            sampleRateHz,
+            units,
+        })
     }
 }
 

package/src/impl/LslWebSocketBridge.ts

@@ -51,12 +51,12 @@ export default class LslWebSocketBridge implements WebSocketBridge {
     }
 
     public destroy() {
-        this.destroyCppBoundInlet()
+        this.destroyBoundInlet()
         this.closeWebSocketServer()
         this.isDestroyed = true
     }
 
-    private destroyCppBoundInlet() {
+    private destroyBoundInlet() {
         this.inlet.destroy()
     }
 

package/src/testDoubles/Liblsl/FakeLiblsl.ts

@@ -15,6 +15,7 @@ import {
     FlushInletOptions,
     PullChunkOptions,
     PullSampleOptions,
+    DestroyStreamInfoOptions,
 } from 'impl/LiblslAdapter.js'
 
 export default class FakeLiblsl implements Liblsl {
@@ -45,6 +46,7 @@ export default class FakeLiblsl implements Liblsl {
     public streamInfo: BoundStreamInfo = {} as BoundStreamInfo
 
     public lastCreateStreamInfoOptions?: CreateStreamInfoOptions
+    public lastDestroyStreamInfoOptions?: DestroyStreamInfoOptions
     public lastAppendChannelsToStreamInfoOptions?: AppendChannelsToStreamInfoOptions
     public lastCreateOutletOptions?: CreateOutletOptions
     public lastPushSampleFloatTimestampOptions?: PushSampleFloatTimestampOptions
@@ -70,6 +72,10 @@ export default class FakeLiblsl implements Liblsl {
         return this.streamInfo
     }
 
+    public destroyStreamInfo(options: DestroyStreamInfoOptions) {
+        this.lastDestroyStreamInfoOptions = options
+    }
+
     public appendChannelsToStreamInfo(
         options: AppendChannelsToStreamInfoOptions
     ) {