@neurodevs/node-lsl 7.1.3 → 7.1.5

package/src/assertions.ts

@@ -8,7 +8,7 @@ import {
 	isStringInArray,
 } from './validations'
 
-export function assertValidMaxBuffered(maxBuffered: number): void {
+export function assertValidMaxBuffered(maxBuffered: number) {
 	if (!isPositiveIntegerOrZero(maxBuffered)) {
 		throw new SchemaError({
 			code: 'INVALID_PARAMETERS',
@@ -18,7 +18,7 @@ export function assertValidMaxBuffered(maxBuffered: number): void {
 	}
 }
 
-export function assertValidChunkSize(chunkSize: number): void {
+export function assertValidChunkSize(chunkSize: number) {
 	if (!isPositiveIntegerOrZero(chunkSize)) {
 		throw new SchemaError({
 			code: 'INVALID_PARAMETERS',
@@ -28,7 +28,7 @@ export function assertValidChunkSize(chunkSize: number): void {
 	}
 }
 
-export function assertValidChannelFormat(channelFormat: ChannelFormat): void {
+export function assertValidChannelFormat(channelFormat: ChannelFormat) {
 	if (!isStringInArray(channelFormat, CHANNEL_FORMATS)) {
 		throw new SchemaError({
 			code: 'INVALID_PARAMETERS',
@@ -38,7 +38,7 @@ export function assertValidChannelFormat(channelFormat: ChannelFormat): void {
 	}
 }
 
-export function assertValidSampleRate(sampleRate: number): void {
+export function assertValidSampleRate(sampleRate: number) {
 	if (!isGreaterThanOrEqualToZero(sampleRate)) {
 		throw new SchemaError({
 			code: 'INVALID_PARAMETERS',
@@ -48,7 +48,7 @@ export function assertValidSampleRate(sampleRate: number): void {
 	}
 }
 
-export function assertValidChannelCount(channelCount: number): void {
+export function assertValidChannelCount(channelCount: number) {
 	if (!isPositiveInteger(channelCount)) {
 		throw new SchemaError({
 			code: 'INVALID_PARAMETERS',

package/src/implementations/Liblsl.ts

@@ -1,41 +1,36 @@
 import { assertOptions } from '@sprucelabs/schema'
-import ffi from 'ffi-napi'
+import { DataType, define, open } from 'ffi-rs'
 import SpruceError from '../errors/SpruceError'
 import {
 	Liblsl,
 	LiblslBindings,
-	streamInfo,
-	outletType,
-	FloatArray,
-	StringArray,
-	xmlPtr,
 	CreateStreamInfoOptions,
-	BoundStreamInfo,
 	AppendChannelsToStreamInfoOptions,
 	CreateOutletOptions,
-	BoundOutlet,
 	DestroyOutletOptions,
-	PushSampleFtOptions,
-	PushSampleStrtOptions,
+	PushSampleFloatTimestampOptions,
+	PushSampleStringTimestampOptions,
 } from '../nodeLsl.types'
 
 export default class LiblslImpl implements Liblsl {
 	private static instance?: Liblsl
-	public static ffi = ffi
+	public static ffiRsOpen = open
+	public static ffiRsDefine = define
+
 	private bindings: LiblslBindings
 
-	public static getInstance(): Liblsl {
+	public static getInstance() {
 		if (!this.instance) {
 			this.setInstance(new this())
 		}
 		return this.instance!
 	}
 
-	public static setInstance(instance: Liblsl): void {
+	public static setInstance(instance: Liblsl) {
 		this.instance = instance
 	}
 
-	public static resetInstance(): void {
+	public static resetInstance() {
 		delete this.instance
 	}
 
@@ -56,25 +51,69 @@ export default class LiblslImpl implements Liblsl {
 		}
 	}
 
-	private loadBindings(path: string) {
-		//@ts-ignore
-		return LiblslImpl.ffi.Library(path!, {
-			lsl_create_streaminfo: [
-				streamInfo,
-				['string', 'string', 'int', 'double', 'int', 'string'],
-			],
-			lsl_create_outlet: [outletType, [streamInfo, 'int', 'int']],
-			lsl_destroy_outlet: ['void', [outletType]],
-			lsl_local_clock: ['double', []],
-			lsl_push_sample_ft: ['void', [outletType, FloatArray, 'double']],
-			lsl_push_sample_strt: ['void', [outletType, StringArray, 'double']],
-			lsl_get_desc: [xmlPtr, [streamInfo]],
-			lsl_append_child: [xmlPtr, [xmlPtr, 'string']],
-			lsl_append_child_value: [xmlPtr, [xmlPtr, 'string', 'string']],
-		}) as LiblslBindings
+	private loadBindings(liblslPath: string) {
+		LiblslImpl.ffiRsOpen({
+			library: 'lsl',
+			path: liblslPath,
+		})
+
+		return LiblslImpl.ffiRsDefine({
+			lsl_create_streaminfo: {
+				library: 'lsl',
+				retType: DataType.External,
+				paramsType: [
+					DataType.String,
+					DataType.String,
+					DataType.I32,
+					DataType.Double,
+					DataType.I32,
+					DataType.String,
+				],
+			},
+			lsl_create_outlet: {
+				library: 'lsl',
+				retType: DataType.External,
+				paramsType: [DataType.External, DataType.I32, DataType.I32],
+			},
+			lsl_destroy_outlet: {
+				library: 'lsl',
+				retType: DataType.Void,
+				paramsType: [DataType.External],
+			},
+			lsl_local_clock: {
+				library: 'lsl',
+				retType: DataType.Double,
+				paramsType: [],
+			},
+			lsl_push_sample_ft: {
+				library: 'lsl',
+				retType: DataType.Void,
+				paramsType: [DataType.External, DataType.DoubleArray, DataType.Double],
+			},
+			lsl_push_sample_strt: {
+				library: 'lsl',
+				retType: DataType.Void,
+				paramsType: [DataType.External, DataType.StringArray, DataType.Double],
+			},
+			lsl_get_desc: {
+				library: 'lsl',
+				retType: DataType.External,
+				paramsType: [DataType.External],
+			},
+			lsl_append_child: {
+				library: 'lsl',
+				retType: DataType.External,
+				paramsType: [DataType.External, DataType.String],
+			},
+			lsl_append_child_value: {
+				library: 'lsl',
+				retType: DataType.External,
+				paramsType: [DataType.External, DataType.String, DataType.String],
+			},
+		}) as unknown as LiblslBindings
 	}
 
-	public createStreamInfo(options: CreateStreamInfoOptions): BoundStreamInfo {
+	public createStreamInfo(options: CreateStreamInfoOptions) {
 		const { name, type, channelCount, sampleRate, channelFormat, sourceId } =
 			assertOptions(options, [
 				'name',
@@ -97,11 +136,11 @@ export default class LiblslImpl implements Liblsl {
 
 	public appendChannelsToStreamInfo(
 		options: AppendChannelsToStreamInfoOptions
-	): void {
+	) {
 		const { info, channels } = assertOptions(options, ['info', 'channels'])
 
-		const desc = this.bindings.lsl_get_desc(info)
-		const parent = this.bindings.lsl_append_child(desc, 'channels')
+		const description = this.bindings.lsl_get_desc(info)
+		const parent = this.bindings.lsl_append_child(description, 'channels')
 
 		for (const channel of channels) {
 			const child = this.bindings.lsl_append_child(parent, 'channel')
@@ -111,7 +150,7 @@ export default class LiblslImpl implements Liblsl {
 		}
 	}
 
-	public createOutlet(options: CreateOutletOptions): BoundOutlet {
+	public createOutlet(options: CreateOutletOptions) {
 		const { info, chunkSize, maxBuffered } = assertOptions(options, [
 			'info',
 			'chunkSize',
@@ -121,12 +160,12 @@ export default class LiblslImpl implements Liblsl {
 		return this.bindings.lsl_create_outlet(info, chunkSize, maxBuffered)
 	}
 
-	public destroyOutlet(options: DestroyOutletOptions): void {
+	public destroyOutlet(options: DestroyOutletOptions) {
 		const { outlet } = assertOptions(options, ['outlet'])
 		this.bindings.lsl_destroy_outlet(outlet)
 	}
 
-	public pushSampleFt(options: PushSampleFtOptions): void {
+	public pushSampleFloatTimestamp(options: PushSampleFloatTimestampOptions) {
 		const { outlet, sample, timestamp } = assertOptions(options, [
 			'outlet',
 			'sample',
@@ -135,7 +174,7 @@ export default class LiblslImpl implements Liblsl {
 		this.bindings.lsl_push_sample_ft(outlet, sample, timestamp)
 	}
 
-	public pushSampleStrt(options: PushSampleStrtOptions): void {
+	public pushSampleStringTimestamp(options: PushSampleStringTimestampOptions) {
 		const { outlet, sample, timestamp } = assertOptions(options, [
 			'outlet',
 			'sample',
@@ -144,7 +183,7 @@ export default class LiblslImpl implements Liblsl {
 		this.bindings.lsl_push_sample_strt(outlet, sample, timestamp)
 	}
 
-	public localClock(): number {
+	public localClock() {
 		return this.bindings.lsl_local_clock()
 	}
 }

package/src/implementations/LslOutlet.ts

@@ -25,7 +25,7 @@ export default class LslOutletImpl implements LslOutlet {
 	private outlet: BoundOutlet
 	private pushSampleByType: (options: any) => void
 
-	public static Outlet(options: LslOutletOptions): LslOutlet {
+	public static Outlet(options: LslOutletOptions) {
 		return new (this.Class ?? this)(options)
 	}
 
@@ -84,11 +84,11 @@ export default class LslOutletImpl implements LslOutlet {
 		this.pushSampleByType = this.lsl[pushMethod].bind(this.lsl)
 	}
 
-	public destroy(): void {
+	public destroy() {
 		this.lsl.destroyOutlet({ outlet: this.outlet })
 	}
 
-	public pushSample(sample: LslSample): void {
+	public pushSample(sample: LslSample) {
 		const timestamp = this.lsl.localClock()
 
 		this.pushSampleByType({
@@ -98,12 +98,12 @@ export default class LslOutletImpl implements LslOutlet {
 		})
 	}
 
-	private getPushMethod(): keyof Liblsl {
+	private getPushMethod() {
 		const channelFormat = this.options.channelFormat
 
 		const methodMap: Record<string, keyof Liblsl> = {
-			float32: 'pushSampleFt',
-			string: 'pushSampleStrt',
+			float32: 'pushSampleFloatTimestamp',
+			string: 'pushSampleStringTimestamp',
 		}
 
 		if (!(channelFormat in methodMap)) {
@@ -114,11 +114,11 @@ export default class LslOutletImpl implements LslOutlet {
 		return methodMap[channelFormat]
 	}
 
-	private lookupChannelFormat(channelFormat: ChannelFormat): number {
+	private lookupChannelFormat(channelFormat: ChannelFormat) {
 		return CHANNEL_FORMATS_MAP[channelFormat]
 	}
 
-	private get lsl(): Liblsl {
+	private get lsl() {
 		return LiblslImpl.getInstance()
 	}
 }

package/src/nodeLsl.types.ts

@@ -1,5 +1,4 @@
-import ArrayType from 'ref-array-napi'
-import ref from 'ref-napi'
+import { FFIParams } from 'ffi-rs'
 import { CHANNEL_FORMATS } from './consts'
 
 export interface LslOutlet {
@@ -41,8 +40,8 @@ export interface Liblsl {
 	appendChannelsToStreamInfo(options: AppendChannelsToStreamInfoOptions): void
 	createOutlet(options: CreateOutletOptions): BoundOutlet
 	destroyOutlet(options: DestroyOutletOptions): void
-	pushSampleFt(options: PushSampleFtOptions): void
-	pushSampleStrt(options: PushSampleStrtOptions): void
+	pushSampleFloatTimestamp(options: PushSampleFloatTimestampOptions): void
+	pushSampleStringTimestamp(options: PushSampleStringTimestampOptions): void
 	localClock(): number
 }
 
@@ -72,13 +71,13 @@ export interface DestroyOutletOptions {
 	outlet: BoundOutlet
 }
 
-export interface PushSampleFtOptions {
+export interface PushSampleFloatTimestampOptions {
 	outlet: BoundOutlet
 	sample: number[]
 	timestamp: number
 }
 
-export interface PushSampleStrtOptions {
+export interface PushSampleStringTimestampOptions {
 	outlet: BoundOutlet
 	sample: string[]
 	timestamp: number
@@ -89,6 +88,7 @@ export interface LslChannel {
 	unit: string
 	type: string
 }
+
 export type LslSample = (number | string | undefined)[]
 
 export interface LiblslBindings {
@@ -122,18 +122,17 @@ export interface LiblslBindings {
 	): void
 
 	lsl_local_clock(): number
-	lsl_get_desc(info: BoundStreamInfo): BoundDesc
-	lsl_append_child(desc: BoundDesc, name: string): BoundChild
+	lsl_get_desc(info: BoundStreamInfo): BoundDescription
+	lsl_append_child(desc: BoundDescription, name: string): BoundChild
 	lsl_append_child_value(child: BoundChild, name: string, value: string): void
 }
 
 export interface BoundStreamInfo {}
 export interface BoundOutlet {}
-export interface BoundDesc {}
+export interface BoundDescription {}
 export interface BoundChild {}
 
-export const streamInfo = ref.refType(ref.types.void)
-export const outletType = ref.refType(ref.types.void)
-export const FloatArray = ArrayType(ref.types.float)
-export const StringArray = ArrayType(ref.types.CString)
-export const xmlPtr = ref.refType(ref.types.void)
+export type FfiRsDefineOptions = Record<
+	string,
+	Omit<FFIParams<any>, 'funcName' | 'paramsValue'>
+>

package/src/testDoubles/FakeLiblsl.ts

@@ -4,8 +4,8 @@ import {
 	CreateStreamInfoOptions,
 	AppendChannelsToStreamInfoOptions,
 	CreateOutletOptions,
-	PushSampleFtOptions,
-	PushSampleStrtOptions,
+	PushSampleFloatTimestampOptions,
+	PushSampleStringTimestampOptions,
 	Liblsl,
 } from '../nodeLsl.types'
 
@@ -16,15 +16,15 @@ export default class FakeLiblsl implements Liblsl {
 	public lastCreateStreamInfoOptions?: CreateStreamInfoOptions
 	public lastAppendChannelsToStreamInfoOptions?: AppendChannelsToStreamInfoOptions
 	public lastCreateOutletOptions?: CreateOutletOptions
-	public lastPushSampleFtOptions?: PushSampleFtOptions
-	public lastPushSampleStrtOptions?: PushSampleStrtOptions
+	public lastPushSampleFloatTimestampOptions?: PushSampleFloatTimestampOptions
+	public lastPushSampleStringTimestampOptions?: PushSampleStringTimestampOptions
 
 	public createStreamInfoHitCount = 0
 	public destroyOutletHitCount = 0
 	public localClockHitCount = 0
-	public pushSampleStrtHitCount = 0
+	public pushSampleStringTimestampHitCount = 0
 
-	public createStreamInfo(options: CreateStreamInfoOptions): BoundStreamInfo {
+	public createStreamInfo(options: CreateStreamInfoOptions) {
 		this.createStreamInfoHitCount++
 		this.lastCreateStreamInfoOptions = options
 		return this.streamInfo
@@ -36,7 +36,7 @@ export default class FakeLiblsl implements Liblsl {
 		this.lastAppendChannelsToStreamInfoOptions = options
 	}
 
-	public createOutlet(options: CreateOutletOptions): BoundOutlet {
+	public createOutlet(options: CreateOutletOptions) {
 		this.lastCreateOutletOptions = options
 		return this.outlet
 	}
@@ -45,13 +45,13 @@ export default class FakeLiblsl implements Liblsl {
 		this.destroyOutletHitCount++
 	}
 
-	public pushSampleFt(options: PushSampleFtOptions) {
-		this.lastPushSampleFtOptions = options
+	public pushSampleFloatTimestamp(options: PushSampleFloatTimestampOptions) {
+		this.lastPushSampleFloatTimestampOptions = options
 	}
 
-	public pushSampleStrt(options: PushSampleStrtOptions) {
-		this.lastPushSampleStrtOptions = options
-		this.pushSampleStrtHitCount++
+	public pushSampleStringTimestamp(options: PushSampleStringTimestampOptions) {
+		this.lastPushSampleStringTimestampOptions = options
+		this.pushSampleStringTimestampHitCount++
 	}
 
 	public localClock() {

package/src/testDoubles/MockTimeMarkerOutlet.ts

@@ -7,10 +7,10 @@ export default class MockTimeMarkerOutlet implements TimeMarkerOutlet {
 	private didPushSamples = false
 	private pushedSamples?: LslSample[]
 
-	public stop(): void {}
-	public destroy(): void {}
+	public stop() {}
+	public destroy() {}
 
-	public pushSample(sample: LslSample): void {
+	public pushSample(sample: LslSample) {
 		if (!this.didPushSamples) {
 			this.didPushSamples = true
 			this.pushedSamples = []
@@ -18,7 +18,7 @@ export default class MockTimeMarkerOutlet implements TimeMarkerOutlet {
 		this.pushedSamples?.push(sample)
 	}
 
-	public async pushMarkers(markers: DurationMarker[]): Promise<void> {
+	public async pushMarkers(markers: DurationMarker[]) {
 		this.didPushMarkers = true
 		this.pushedMarkers = markers
 	}

package/src/validations.ts

@@ -2,14 +2,16 @@ export function isStringInArray(value: string, array: readonly string[]) {
 	return array.indexOf(value) !== -1
 }
 
-export function isGreaterThanOrEqualToZero(value: number): boolean {
+export function isGreaterThanOrEqualToZero(value: number) {
 	return value >= 0
 }
 
-export function isPositiveInteger(value: number): boolean {
+export function isPositiveInteger(value: number) {
+	//@ts-ignore
 	return Number.isInteger(value) && value > 0
 }
 
-export function isPositiveIntegerOrZero(value: number): boolean {
+export function isPositiveIntegerOrZero(value: number) {
+	//@ts-ignore
 	return Number.isInteger(value) && value >= 0
 }