@neurodevs/node-lsl 14.0.1 → 14.1.1

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,18 @@ 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 lsl = LiblslAdapter.getInstance()
+
+    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 +51,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 +61,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 +80,18 @@ 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]
-    }
-
-    private get lsl() {
-        return LiblslAdapter.getInstance()
+    public get boundStreamInfo() {
+        return this.boundInfo
     }
-
-    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

@@ -2,7 +2,7 @@ import generateId from '@neurodevs/generate-id'
 import { createPointer, DataType, JsExternal, unwrapPointer } from 'ffi-rs'
 
 import handleError from '../handleError.js'
-import { BoundInlet, ChannelFormat, Liblsl } from './LiblslAdapter.js'
+import { BoundInlet, ChannelFormat } from './LiblslAdapter.js'
 import LiblslAdapter from './LiblslAdapter.js'
 import LslStreamInfo, {
     StreamInfo,
@@ -29,7 +29,7 @@ export default class LslStreamInlet implements StreamInlet {
         timestamps: Float64Array | undefined
     }
 
-    private lsl: Liblsl
+    private lsl = LiblslAdapter.getInstance()
 
     protected inlet!: BoundInlet
 
@@ -74,8 +74,6 @@ export default class LslStreamInlet implements StreamInlet {
             this.pullDataMethod = this.pullChunk
         }
 
-        this.lsl = this.getLiblslSingleton()
-
         this.createBoundInlet()
     }
 
@@ -88,12 +86,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,11 +252,16 @@ export default class LslStreamInlet implements StreamInlet {
     }
 
     public destroy() {
-        this.lsl.destroyInlet({ inlet: this.inlet })
+        this.destroyBoundStreamInfo()
+        this.destroyBoundInlet()
     }
 
-    private getLiblslSingleton() {
-        return LiblslAdapter.getInstance()
+    private destroyBoundStreamInfo() {
+        this.lsl.destroyStreamInfo({ info: this.boundStreamInfo })
+    }
+
+    private destroyBoundInlet() {
+        this.lsl.destroyInlet({ inlet: this.inlet })
     }
 
     private static LslStreamInfo(options: StreamInfoOptions) {

package/src/impl/LslStreamOutlet.ts

@@ -37,6 +37,8 @@ export default class LslStreamOutlet implements StreamOutlet {
     private outlet!: BoundOutlet
     private pushSampleMethod!: (options: unknown) => LslErrorCode
 
+    private lsl = LiblslAdapter.getInstance()
+
     protected constructor(info: StreamInfo, options: StreamOutletOptions) {
         const {
             name,
@@ -144,11 +146,16 @@ export default class LslStreamOutlet implements StreamOutlet {
     }
 
     public destroy() {
-        this.lsl.destroyOutlet({ outlet: this.outlet })
+        this.destroyBoundStreamInfo()
+        this.destroyBoundOutlet()
     }
 
-    private get lsl() {
-        return LiblslAdapter.getInstance()
+    private destroyBoundStreamInfo() {
+        this.lsl.destroyStreamInfo({ info: this.boundStreamInfo })
+    }
+
+    private destroyBoundOutlet() {
+        this.lsl.destroyOutlet({ outlet: this.outlet })
     }
 
     private static async waitToAllowSetup(waitAfterConstructionMs: number) {

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
     ) {

package/src/testDoubles/StreamInfo/FakeStreamInfo.ts

@@ -3,17 +3,24 @@ import { StreamInfo, StreamInfoOptions } from '../../impl/LslStreamInfo.js'
 
 export default class FakeStreamInfo implements StreamInfo {
     public static callsToConstructor: StreamInfoOptions[] = []
+    public static numCallsToDestroy = 0
+
     public static boundStreamInfo = {} as BoundStreamInfo
 
     public constructor(options: StreamInfoOptions) {
         FakeStreamInfo.callsToConstructor.push(options)
     }
 
+    public destroy() {
+        FakeStreamInfo.numCallsToDestroy++
+    }
+
     public get boundStreamInfo() {
         return FakeStreamInfo.boundStreamInfo
     }
 
     public static resetTestDouble() {
         FakeStreamInfo.callsToConstructor = []
+        FakeStreamInfo.numCallsToDestroy = 0
     }
 }

package/src/testDoubles/StreamInfo/SpyStreamInfo.ts

@@ -5,8 +5,8 @@ export default class SpyStreamInfo extends LslStreamInfo {
         super(options)
     }
 
-    public getStreamInfo() {
-        return this.streamInfo
+    public getBoundInfo() {
+        return this.boundInfo
     }
 
     public getName() {