@neurodevs/node-lsl 10.2.2 → 11.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -38
- package/build/__tests__/{AbstractNodeLslTest.d.ts → AbstractLslTest.d.ts} +5 -4
- package/build/__tests__/{AbstractNodeLslTest.js → AbstractLslTest.js} +30 -24
- package/build/__tests__/AbstractLslTest.js.map +1 -0
- package/build/__tests__/EventMarkerOutlet.test.d.ts +18 -0
- package/build/__tests__/EventMarkerOutlet.test.js +144 -0
- package/build/__tests__/EventMarkerOutlet.test.js.map +1 -0
- package/build/__tests__/{Liblsl.test.d.ts → LiblslAdapter.test.d.ts} +2 -2
- package/build/__tests__/{Liblsl.test.js → LiblslAdapter.test.js} +43 -75
- package/build/__tests__/LiblslAdapter.test.js.map +1 -0
- package/build/__tests__/LslStreamInfo.test.d.ts +3 -3
- package/build/__tests__/LslStreamInfo.test.js +3 -3
- package/build/__tests__/LslStreamInfo.test.js.map +1 -1
- package/build/__tests__/{LslInlet.test.d.ts → LslStreamInlet.test.d.ts} +4 -4
- package/build/__tests__/{LslInlet.test.js → LslStreamInlet.test.js} +17 -17
- package/build/__tests__/LslStreamInlet.test.js.map +1 -0
- package/build/__tests__/{LslOutlet.test.d.ts → LslStreamOutlet.test.d.ts} +3 -3
- package/build/__tests__/{LslOutlet.test.js → LslStreamOutlet.test.js} +45 -41
- package/build/__tests__/LslStreamOutlet.test.js.map +1 -0
- package/build/components/EventMarkerOutlet.d.ts +20 -0
- package/build/components/{TimeMarkerOutlet.js → EventMarkerOutlet.js} +19 -25
- package/build/components/EventMarkerOutlet.js.map +1 -0
- package/build/components/{Liblsl.d.ts → LiblslAdapter.d.ts} +1 -1
- package/build/components/{Liblsl.js → LiblslAdapter.js} +7 -7
- package/build/components/LiblslAdapter.js.map +1 -0
- package/build/components/LslStreamInfo.js +2 -2
- package/build/components/LslStreamInfo.js.map +1 -1
- package/build/components/{LslInlet.d.ts → LslStreamInlet.d.ts} +4 -4
- package/build/components/{LslInlet.js → LslStreamInlet.js} +5 -5
- package/build/components/LslStreamInlet.js.map +1 -0
- package/build/components/{LslOutlet.d.ts → LslStreamOutlet.d.ts} +1 -1
- package/build/components/{LslOutlet.js → LslStreamOutlet.js} +5 -5
- package/build/components/LslStreamOutlet.js.map +1 -0
- package/build/index.d.ts +20 -19
- package/build/index.js +33 -28
- package/build/index.js.map +1 -1
- package/build/nodeLsl.types.d.ts +3 -3
- package/build/testDoubles/{FakeLiblsl.d.ts → Liblsl/FakeLiblsl.d.ts} +1 -1
- package/build/testDoubles/Liblsl/FakeLiblsl.js.map +1 -0
- package/build/testDoubles/LslInlet/SpyLslInlet.d.ts +7 -0
- package/build/testDoubles/{SpyLslInlet.js → LslInlet/SpyLslInlet.js} +2 -2
- package/build/testDoubles/LslInlet/SpyLslInlet.js.map +1 -0
- package/build/testDoubles/{FakeLslOutlet.d.ts → LslOutlet/FakeLslOutlet.d.ts} +3 -5
- package/build/testDoubles/{FakeLslOutlet.js → LslOutlet/FakeLslOutlet.js} +0 -4
- package/build/testDoubles/LslOutlet/FakeLslOutlet.js.map +1 -0
- package/build/testDoubles/{FakeTimeMarkerOutlet.d.ts → MarkerOutlet/FakeMarkerOutlet.d.ts} +4 -4
- package/build/testDoubles/{FakeTimeMarkerOutlet.js → MarkerOutlet/FakeMarkerOutlet.js} +4 -4
- package/build/testDoubles/MarkerOutlet/FakeMarkerOutlet.js.map +1 -0
- package/build/testDoubles/{MockTimeMarkerOutlet.d.ts → MarkerOutlet/MockMarkerOutlet.d.ts} +3 -2
- package/build/testDoubles/{MockTimeMarkerOutlet.js → MarkerOutlet/MockMarkerOutlet.js} +3 -3
- package/build/testDoubles/MarkerOutlet/MockMarkerOutlet.js.map +1 -0
- package/build/testDoubles/MarkerOutlet/SpyMarkerOutlet.d.ts +9 -0
- package/build/testDoubles/MarkerOutlet/SpyMarkerOutlet.js +24 -0
- package/build/testDoubles/MarkerOutlet/SpyMarkerOutlet.js.map +1 -0
- package/build/testDoubles/{FakeStreamInfo.d.ts → StreamInfo/FakeStreamInfo.d.ts} +2 -2
- package/build/testDoubles/StreamInfo/FakeStreamInfo.js.map +1 -0
- package/build/testDoubles/StreamInfo/SpyStreamInfo.d.ts +9 -0
- package/build/testDoubles/{SpyLslStreamInfo.js → StreamInfo/SpyStreamInfo.js} +4 -4
- package/build/testDoubles/StreamInfo/SpyStreamInfo.js.map +1 -0
- package/build/testDoubles/generateRandomOutletOptions.d.ts +1 -1
- package/package.json +1 -1
- package/src/__tests__/AbstractLslTest.ts +58 -0
- package/src/__tests__/EventMarkerOutlet.test.ts +165 -0
- package/src/__tests__/{Liblsl.test.ts → LiblslAdapter.test.ts} +18 -22
- package/src/__tests__/LslStreamInfo.test.ts +12 -12
- package/src/__tests__/{LslInlet.test.ts → LslStreamInlet.test.ts} +11 -11
- package/src/__tests__/{LslOutlet.test.ts → LslStreamOutlet.test.ts} +28 -22
- package/src/components/{TimeMarkerOutlet.ts → EventMarkerOutlet.ts} +23 -33
- package/src/components/{Liblsl.ts → LiblslAdapter.ts} +3 -3
- package/src/components/LslStreamInfo.ts +2 -2
- package/src/components/{LslInlet.ts → LslStreamInlet.ts} +5 -5
- package/src/components/{LslOutlet.ts → LslStreamOutlet.ts} +3 -3
- package/src/index.ts +28 -19
- package/src/nodeLsl.types.ts +3 -3
- package/src/testDoubles/{FakeLiblsl.ts → Liblsl/FakeLiblsl.ts} +1 -1
- package/src/testDoubles/{SpyLslInlet.ts → LslInlet/SpyLslInlet.ts} +5 -3
- package/src/testDoubles/{FakeLslOutlet.ts → LslOutlet/FakeLslOutlet.ts} +3 -9
- package/src/testDoubles/{FakeTimeMarkerOutlet.ts → MarkerOutlet/FakeMarkerOutlet.ts} +4 -4
- package/src/testDoubles/{MockTimeMarkerOutlet.ts → MarkerOutlet/MockMarkerOutlet.ts} +3 -2
- package/src/testDoubles/MarkerOutlet/SpyMarkerOutlet.ts +24 -0
- package/src/testDoubles/{FakeStreamInfo.ts → StreamInfo/FakeStreamInfo.ts} +2 -2
- package/src/testDoubles/{SpyLslStreamInfo.ts → StreamInfo/SpyStreamInfo.ts} +4 -2
- package/src/testDoubles/generateRandomOutletOptions.ts +1 -1
- package/build/__tests__/AbstractNodeLslTest.js.map +0 -1
- package/build/__tests__/Liblsl.test.js.map +0 -1
- package/build/__tests__/LslInlet.test.js.map +0 -1
- package/build/__tests__/LslOutlet.test.js.map +0 -1
- package/build/__tests__/SpyLslStreamInfo.d.ts +0 -5
- package/build/__tests__/SpyLslStreamInfo.js +0 -17
- package/build/__tests__/SpyLslStreamInfo.js.map +0 -1
- package/build/__tests__/TimeMarkerOutlet.test.d.ts +0 -28
- package/build/__tests__/TimeMarkerOutlet.test.js +0 -165
- package/build/__tests__/TimeMarkerOutlet.test.js.map +0 -1
- package/build/components/Liblsl.js.map +0 -1
- package/build/components/LslInlet.js.map +0 -1
- package/build/components/LslOutlet.js.map +0 -1
- package/build/components/TimeMarkerOutlet.d.ts +0 -19
- package/build/components/TimeMarkerOutlet.js.map +0 -1
- package/build/demo.d.ts +0 -1
- package/build/demo.js +0 -42
- package/build/demo.js.map +0 -1
- package/build/testDoubles/FakeLiblsl.js.map +0 -1
- package/build/testDoubles/FakeLslOutlet.js.map +0 -1
- package/build/testDoubles/FakeLslStreamInfo.d.ts +0 -5
- package/build/testDoubles/FakeLslStreamInfo.js +0 -10
- package/build/testDoubles/FakeLslStreamInfo.js.map +0 -1
- package/build/testDoubles/FakeStreamInfo.js.map +0 -1
- package/build/testDoubles/FakeTimeMarkerOutlet.js.map +0 -1
- package/build/testDoubles/MockTimeMarkerOutlet.js.map +0 -1
- package/build/testDoubles/SpyLslInlet.d.ts +0 -7
- package/build/testDoubles/SpyLslInlet.js.map +0 -1
- package/build/testDoubles/SpyLslStreamInfo.d.ts +0 -9
- package/build/testDoubles/SpyLslStreamInfo.js.map +0 -1
- package/build/testDoubles/SpyTimeMarkerOutlet.d.ts +0 -9
- package/build/testDoubles/SpyTimeMarkerOutlet.js +0 -19
- package/build/testDoubles/SpyTimeMarkerOutlet.js.map +0 -1
- package/src/__tests__/AbstractNodeLslTest.ts +0 -50
- package/src/__tests__/TimeMarkerOutlet.test.ts +0 -181
- package/src/demo.ts +0 -43
- package/src/testDoubles/SpyTimeMarkerOutlet.ts +0 -19
- /package/build/testDoubles/{FakeLiblsl.js → Liblsl/FakeLiblsl.js} +0 -0
- /package/build/testDoubles/{FakeStreamInfo.js → StreamInfo/FakeStreamInfo.js} +0 -0
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
import { randomInt } from 'crypto'
|
|
2
|
+
import { assert, generateId, test } from '@sprucelabs/test-utils'
|
|
3
|
+
import EventMarkerOutlet from '../components/EventMarkerOutlet'
|
|
4
|
+
import { LslOutletOptions } from '../components/LslStreamOutlet'
|
|
5
|
+
import generateRandomOutletOptions from '../testDoubles/generateRandomOutletOptions'
|
|
6
|
+
import FakeLslOutlet from '../testDoubles/LslOutlet/FakeLslOutlet'
|
|
7
|
+
import SpyMarkerOutlet from '../testDoubles/MarkerOutlet/SpyMarkerOutlet'
|
|
8
|
+
import AbstractLslTest from './AbstractLslTest'
|
|
9
|
+
|
|
10
|
+
export default class EventMarkerOutletTest extends AbstractLslTest {
|
|
11
|
+
private static instance: SpyMarkerOutlet
|
|
12
|
+
|
|
13
|
+
protected static async beforeEach() {
|
|
14
|
+
await super.beforeEach()
|
|
15
|
+
|
|
16
|
+
this.setFakeLiblsl()
|
|
17
|
+
this.setFakeLslOutlet()
|
|
18
|
+
this.setSpyMarkerOutlet()
|
|
19
|
+
|
|
20
|
+
this.instance = await this.EventMarkerOutlet()
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
@test()
|
|
24
|
+
protected static async loadsWithEventMarkerSpecificOptions() {
|
|
25
|
+
assert.isEqualDeep(FakeLslOutlet.callsToConstructor[0].options, {
|
|
26
|
+
name: 'Event markers',
|
|
27
|
+
type: 'Markers',
|
|
28
|
+
channelNames: ['Markers'],
|
|
29
|
+
sampleRate: 0,
|
|
30
|
+
channelFormat: 'string',
|
|
31
|
+
sourceId: 'event-markers',
|
|
32
|
+
manufacturer: 'N/A',
|
|
33
|
+
unit: 'N/A',
|
|
34
|
+
chunkSize: 0,
|
|
35
|
+
maxBuffered: 0,
|
|
36
|
+
})
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
@test()
|
|
40
|
+
protected static async canOverrideDefaultOptions() {
|
|
41
|
+
const options = generateRandomOutletOptions()
|
|
42
|
+
await this.EventMarkerOutlet(options)
|
|
43
|
+
|
|
44
|
+
assert.isEqualDeep(FakeLslOutlet.callsToConstructor[1].options, options)
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
@test()
|
|
48
|
+
protected static async pushingSingleMarkerIncrementsHitCountAndWaitTime() {
|
|
49
|
+
const markers = [this.generateDurationMarker()]
|
|
50
|
+
await this.instance.pushMarkers(markers)
|
|
51
|
+
|
|
52
|
+
const marker = markers[0]
|
|
53
|
+
|
|
54
|
+
assert.isEqual(
|
|
55
|
+
FakeLslOutlet.callsToPushSample[0][0],
|
|
56
|
+
marker.name,
|
|
57
|
+
'Pushed the wrong marker!'
|
|
58
|
+
)
|
|
59
|
+
|
|
60
|
+
assert.isEqual(this.instance.totalWaitTimeMs, marker.durationMs)
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
@test()
|
|
64
|
+
protected static async pushingTwoMarkersIncrementsHitCountAndWaitTimeTwice() {
|
|
65
|
+
const markers = await this.pushTotalMarkers(2)
|
|
66
|
+
|
|
67
|
+
assert.isEqual(FakeLslOutlet.callsToPushSample.length, 2)
|
|
68
|
+
|
|
69
|
+
assert.isEqual(
|
|
70
|
+
this.instance.totalWaitTimeMs,
|
|
71
|
+
markers[0].durationMs + markers[1].durationMs
|
|
72
|
+
)
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
@test('can stop on the first marker', 1)
|
|
76
|
+
@test('can stop on the second marker', 2)
|
|
77
|
+
@test('can stop on the third marker', 3)
|
|
78
|
+
protected static async canStopEventMarkersMidPush(bailIdx: number) {
|
|
79
|
+
let hitCount = 0
|
|
80
|
+
|
|
81
|
+
const outlet = this.instance.getLslOutlet()
|
|
82
|
+
|
|
83
|
+
outlet.pushSample = () => {
|
|
84
|
+
hitCount += 1
|
|
85
|
+
if (hitCount === bailIdx) {
|
|
86
|
+
this.instance.stop()
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
await this.pushTotalMarkers(10)
|
|
91
|
+
|
|
92
|
+
assert.isEqual(hitCount, bailIdx)
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
@test()
|
|
96
|
+
protected static async canStartAgainAfterStopping() {
|
|
97
|
+
this.instance.stop()
|
|
98
|
+
|
|
99
|
+
let hitCount = 0
|
|
100
|
+
|
|
101
|
+
const outlet = this.instance.getLslOutlet()
|
|
102
|
+
|
|
103
|
+
outlet.pushSample = () => {
|
|
104
|
+
hitCount++
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
await this.pushTotalMarkers(10)
|
|
108
|
+
|
|
109
|
+
assert.isEqual(hitCount, 10)
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
@test()
|
|
113
|
+
protected static async doesNotWaitIfStopped() {
|
|
114
|
+
await this.setupOutlet()
|
|
115
|
+
|
|
116
|
+
const startMs = Date.now()
|
|
117
|
+
const promise = this.pushTotalMarkers(2, 1000)
|
|
118
|
+
this.instance.stop()
|
|
119
|
+
await promise
|
|
120
|
+
const endMs = Date.now()
|
|
121
|
+
|
|
122
|
+
assert.isBelow(endMs - startMs, 10)
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
@test()
|
|
126
|
+
protected static async clearsTheTimeoutOnStop() {
|
|
127
|
+
void this.pushTotalMarkers(2, 100)
|
|
128
|
+
this.instance.stop()
|
|
129
|
+
|
|
130
|
+
this.lslOutlet.pushSample = () =>
|
|
131
|
+
assert.fail('Should not have been called')
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
private static get lslOutlet() {
|
|
135
|
+
return this.instance.getLslOutlet()
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
private static async setupOutlet() {
|
|
139
|
+
EventMarkerOutlet.Class = EventMarkerOutlet as any
|
|
140
|
+
this.instance = await this.EventMarkerOutlet()
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
private static async pushTotalMarkers(total: number, durationMs?: number) {
|
|
144
|
+
const markers = new Array(total)
|
|
145
|
+
.fill(null)
|
|
146
|
+
.map(() => this.generateDurationMarker(durationMs))
|
|
147
|
+
|
|
148
|
+
await this.instance.pushMarkers(markers)
|
|
149
|
+
|
|
150
|
+
return markers
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
private static generateDurationMarker(durationMs?: number) {
|
|
154
|
+
return {
|
|
155
|
+
name: generateId(),
|
|
156
|
+
durationMs: durationMs ?? randomInt(100, 1000),
|
|
157
|
+
}
|
|
158
|
+
}
|
|
159
|
+
|
|
160
|
+
private static async EventMarkerOutlet(
|
|
161
|
+
options?: Partial<LslOutletOptions>
|
|
162
|
+
) {
|
|
163
|
+
return (await EventMarkerOutlet.Create(options)) as SpyMarkerOutlet
|
|
164
|
+
}
|
|
165
|
+
}
|
|
@@ -1,12 +1,7 @@
|
|
|
1
1
|
import { randomInt } from 'crypto'
|
|
2
|
-
import
|
|
3
|
-
test,
|
|
4
|
-
assert,
|
|
5
|
-
errorAssert,
|
|
6
|
-
generateId,
|
|
7
|
-
} from '@sprucelabs/test-utils'
|
|
2
|
+
import { test, assert, errorAssert, generateId } from '@sprucelabs/test-utils'
|
|
8
3
|
import { DataType, OpenParams } from 'ffi-rs'
|
|
9
|
-
import
|
|
4
|
+
import LiblslAdapter from '../components/LiblslAdapter'
|
|
10
5
|
import {
|
|
11
6
|
BoundChild,
|
|
12
7
|
BoundDescription,
|
|
@@ -18,9 +13,10 @@ import {
|
|
|
18
13
|
LiblslBindings,
|
|
19
14
|
LslChannel,
|
|
20
15
|
} from '../nodeLsl.types'
|
|
21
|
-
import FakeLiblsl from '../testDoubles/FakeLiblsl'
|
|
16
|
+
import FakeLiblsl from '../testDoubles/Liblsl/FakeLiblsl'
|
|
17
|
+
import AbstractLslTest from './AbstractLslTest'
|
|
22
18
|
|
|
23
|
-
export default class
|
|
19
|
+
export default class LiblslAdapterTest extends AbstractLslTest {
|
|
24
20
|
private static lsl: Liblsl
|
|
25
21
|
private static libraryPath?: string
|
|
26
22
|
private static libraryOptions?: Record<string, any>
|
|
@@ -76,11 +72,11 @@ export default class LiblslTest extends AbstractSpruceTest {
|
|
|
76
72
|
this.appendChildHitCount = 0
|
|
77
73
|
|
|
78
74
|
delete this.ffiRsOpenOptions
|
|
79
|
-
|
|
75
|
+
LiblslAdapter.ffiRsOpen = (options) => {
|
|
80
76
|
this.ffiRsOpenOptions = options
|
|
81
77
|
}
|
|
82
78
|
|
|
83
|
-
|
|
79
|
+
LiblslAdapter.ffiRsDefine = (options) => {
|
|
84
80
|
this.ffiRsDefineOptions = options
|
|
85
81
|
if (this.shouldThrowWhenCreatingBindings) {
|
|
86
82
|
throw new Error('Failed to create bindings!')
|
|
@@ -88,16 +84,16 @@ export default class LiblslTest extends AbstractSpruceTest {
|
|
|
88
84
|
return this.fakeBindings as any
|
|
89
85
|
}
|
|
90
86
|
|
|
91
|
-
|
|
92
|
-
this.lsl =
|
|
87
|
+
LiblslAdapter.resetInstance()
|
|
88
|
+
this.lsl = LiblslAdapter.getInstance()
|
|
93
89
|
}
|
|
94
90
|
|
|
95
91
|
@test()
|
|
96
92
|
protected static async throwsWhenBindingsFailToLoad() {
|
|
97
93
|
this.shouldThrowWhenCreatingBindings = true
|
|
98
|
-
|
|
94
|
+
LiblslAdapter.resetInstance()
|
|
99
95
|
|
|
100
|
-
const err = assert.doesThrow(() =>
|
|
96
|
+
const err = assert.doesThrow(() => LiblslAdapter.getInstance())
|
|
101
97
|
errorAssert.assertError(err, 'FAILED_TO_LOAD_LIBLSL', {
|
|
102
98
|
liblslPath: process.env.LIBLSL_PATH,
|
|
103
99
|
})
|
|
@@ -167,21 +163,21 @@ export default class LiblslTest extends AbstractSpruceTest {
|
|
|
167
163
|
|
|
168
164
|
@test()
|
|
169
165
|
protected static async worksAsASingleton() {
|
|
170
|
-
const liblsl =
|
|
166
|
+
const liblsl = LiblslAdapter.getInstance()
|
|
171
167
|
//@ts-ignore
|
|
172
|
-
assert.isInstanceOf(liblsl,
|
|
168
|
+
assert.isInstanceOf(liblsl, LiblslAdapter)
|
|
173
169
|
}
|
|
174
170
|
|
|
175
171
|
@test()
|
|
176
172
|
protected static async singletonIsTheSame() {
|
|
177
|
-
assert.isEqual(
|
|
173
|
+
assert.isEqual(LiblslAdapter.getInstance(), LiblslAdapter.getInstance())
|
|
178
174
|
}
|
|
179
175
|
|
|
180
176
|
@test()
|
|
181
177
|
protected static canSetInstance() {
|
|
182
178
|
const fake = new FakeLiblsl()
|
|
183
|
-
|
|
184
|
-
assert.isEqual(
|
|
179
|
+
LiblslAdapter.setInstance(fake)
|
|
180
|
+
assert.isEqual(LiblslAdapter.getInstance(), fake)
|
|
185
181
|
}
|
|
186
182
|
|
|
187
183
|
@test()
|
|
@@ -402,8 +398,8 @@ export default class LiblslTest extends AbstractSpruceTest {
|
|
|
402
398
|
protected static async defaultsToMacOsPath() {
|
|
403
399
|
delete process.env.LIBLSL_PATH
|
|
404
400
|
|
|
405
|
-
|
|
406
|
-
this.lsl =
|
|
401
|
+
LiblslAdapter.resetInstance()
|
|
402
|
+
this.lsl = LiblslAdapter.getInstance()
|
|
407
403
|
|
|
408
404
|
assert.isEqual(
|
|
409
405
|
this.ffiRsOpenOptions?.path,
|
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
import { test, assert, generateId, errorAssert } from '@sprucelabs/test-utils'
|
|
2
2
|
import LslStreamInfo, { StreamInfoOptions } from '../components/LslStreamInfo'
|
|
3
3
|
import { CHANNEL_FORMATS } from '../consts'
|
|
4
|
-
import
|
|
5
|
-
import
|
|
4
|
+
import SpyStreamInfo from '../testDoubles/StreamInfo/SpyStreamInfo'
|
|
5
|
+
import AbstractLslTest from './AbstractLslTest'
|
|
6
6
|
|
|
7
|
-
export default class LslStreamInfoTest extends
|
|
8
|
-
private static instance:
|
|
7
|
+
export default class LslStreamInfoTest extends AbstractLslTest {
|
|
8
|
+
private static instance: SpyStreamInfo
|
|
9
9
|
|
|
10
10
|
protected static async beforeEach() {
|
|
11
11
|
await super.beforeEach()
|
|
12
12
|
|
|
13
|
-
this.
|
|
13
|
+
this.setSpyStreamInfo()
|
|
14
14
|
|
|
15
15
|
this.instance = this.LslStreamInfo()
|
|
16
16
|
}
|
|
@@ -191,13 +191,6 @@ export default class LslStreamInfoTest extends AbstractNodeLslTest {
|
|
|
191
191
|
)
|
|
192
192
|
}
|
|
193
193
|
|
|
194
|
-
private static LslStreamInfo(options?: Partial<StreamInfoOptions>) {
|
|
195
|
-
return LslStreamInfo.Create({
|
|
196
|
-
...this.defaultOptions,
|
|
197
|
-
...options,
|
|
198
|
-
}) as SpyLslStreamInfo
|
|
199
|
-
}
|
|
200
|
-
|
|
201
194
|
private static readonly defaultOptions = {
|
|
202
195
|
name: generateId(),
|
|
203
196
|
type: generateId(),
|
|
@@ -206,4 +199,11 @@ export default class LslStreamInfoTest extends AbstractNodeLslTest {
|
|
|
206
199
|
channelFormat: 'float32',
|
|
207
200
|
sampleRate: 100 * Math.random(),
|
|
208
201
|
} as StreamInfoOptions
|
|
202
|
+
|
|
203
|
+
private static LslStreamInfo(options?: Partial<StreamInfoOptions>) {
|
|
204
|
+
return LslStreamInfo.Create({
|
|
205
|
+
...this.defaultOptions,
|
|
206
|
+
...options,
|
|
207
|
+
}) as SpyStreamInfo
|
|
208
|
+
}
|
|
209
209
|
}
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import { test, assert, errorAssert } from '@sprucelabs/test-utils'
|
|
2
|
-
import
|
|
3
|
-
import
|
|
4
|
-
import
|
|
5
|
-
import
|
|
2
|
+
import LslStreamInlet, { LslInletOptions } from '../components/LslStreamInlet'
|
|
3
|
+
import { SpyLslInlet } from '../testDoubles/LslInlet/SpyLslInlet'
|
|
4
|
+
import FakeStreamInfo from '../testDoubles/StreamInfo/FakeStreamInfo'
|
|
5
|
+
import AbstractLslTest from './AbstractLslTest'
|
|
6
6
|
|
|
7
|
-
export default class
|
|
7
|
+
export default class LslStreamInletTest extends AbstractLslTest {
|
|
8
8
|
private static instance: SpyLslInlet
|
|
9
9
|
|
|
10
10
|
protected static async beforeEach() {
|
|
@@ -13,11 +13,11 @@ export default class LslInletTest extends AbstractNodeLslTest {
|
|
|
13
13
|
this.setSpyLslInlet()
|
|
14
14
|
this.setFakeStreamInfo()
|
|
15
15
|
|
|
16
|
-
this.instance = this.
|
|
16
|
+
this.instance = this.LslStreamInlet()
|
|
17
17
|
}
|
|
18
18
|
|
|
19
19
|
@test()
|
|
20
|
-
protected static async
|
|
20
|
+
protected static async canCreateLslStreamInlet() {
|
|
21
21
|
assert.isTruthy(this.instance, 'Instance should be created!')
|
|
22
22
|
}
|
|
23
23
|
|
|
@@ -25,7 +25,7 @@ export default class LslInletTest extends AbstractNodeLslTest {
|
|
|
25
25
|
protected static async throwsWithMissingRequiredOptions() {
|
|
26
26
|
const err = assert.doesThrow(
|
|
27
27
|
// @ts-ignore
|
|
28
|
-
() =>
|
|
28
|
+
() => LslStreamInlet.Create()
|
|
29
29
|
)
|
|
30
30
|
errorAssert.assertError(err, 'MISSING_PARAMETERS', {
|
|
31
31
|
parameters: [
|
|
@@ -56,7 +56,7 @@ export default class LslInletTest extends AbstractNodeLslTest {
|
|
|
56
56
|
|
|
57
57
|
@test()
|
|
58
58
|
protected static async uniqueNameHasSetPrefix() {
|
|
59
|
-
const instance = this.
|
|
59
|
+
const instance = this.LslStreamInlet({ name: undefined })
|
|
60
60
|
|
|
61
61
|
assert.doesInclude(
|
|
62
62
|
instance.getName(),
|
|
@@ -82,7 +82,7 @@ export default class LslInletTest extends AbstractNodeLslTest {
|
|
|
82
82
|
)
|
|
83
83
|
}
|
|
84
84
|
|
|
85
|
-
private static
|
|
85
|
+
private static LslStreamInlet(options?: Partial<LslInletOptions>) {
|
|
86
86
|
const defaultOptions = {
|
|
87
87
|
channelNames: this.channelNames,
|
|
88
88
|
channelFormat: 'float32',
|
|
@@ -94,6 +94,6 @@ export default class LslInletTest extends AbstractNodeLslTest {
|
|
|
94
94
|
maxBuffered: this.maxBuffered,
|
|
95
95
|
...options,
|
|
96
96
|
} as LslInletOptions
|
|
97
|
-
return
|
|
97
|
+
return LslStreamInlet.Create(defaultOptions) as SpyLslInlet
|
|
98
98
|
}
|
|
99
99
|
}
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import { test, assert, errorAssert, generateId } from '@sprucelabs/test-utils'
|
|
2
|
-
import LslOutletImpl, { LslOutletOptions } from '../components/LslOutlet'
|
|
3
2
|
import { StreamInfo } from '../components/LslStreamInfo'
|
|
3
|
+
import LslStreamOutlet, {
|
|
4
|
+
LslOutletOptions,
|
|
5
|
+
} from '../components/LslStreamOutlet'
|
|
4
6
|
import { LslSample } from '../nodeLsl.types'
|
|
5
7
|
import {
|
|
6
8
|
TEST_SUPPORTED_CHANNEL_FORMATS,
|
|
@@ -8,17 +10,17 @@ import {
|
|
|
8
10
|
TestChannelFormat,
|
|
9
11
|
} from '../testDoubles/consts'
|
|
10
12
|
|
|
11
|
-
import FakeStreamInfo from '../testDoubles/FakeStreamInfo'
|
|
12
13
|
import generateRandomOutletOptions from '../testDoubles/generateRandomOutletOptions'
|
|
13
|
-
import
|
|
14
|
+
import FakeStreamInfo from '../testDoubles/StreamInfo/FakeStreamInfo'
|
|
15
|
+
import AbstractLslTest from './AbstractLslTest'
|
|
14
16
|
|
|
15
|
-
export default class
|
|
17
|
+
export default class LslStreamOutletTest extends AbstractLslTest {
|
|
16
18
|
private static randomOutletOptions: LslOutletOptions
|
|
17
19
|
|
|
18
20
|
protected static async beforeEach() {
|
|
19
21
|
await super.beforeEach()
|
|
20
22
|
|
|
21
|
-
delete
|
|
23
|
+
delete LslStreamOutlet.Class
|
|
22
24
|
|
|
23
25
|
this.randomOutletOptions = generateRandomOutletOptions()
|
|
24
26
|
|
|
@@ -30,7 +32,7 @@ export default class LslOutletTest extends AbstractNodeLslTest {
|
|
|
30
32
|
protected static async throwsWithMissingRequiredParams() {
|
|
31
33
|
const err = await assert.doesThrowAsync(
|
|
32
34
|
//@ts-ignore
|
|
33
|
-
async () => await
|
|
35
|
+
async () => await LslStreamOutlet.Create()
|
|
34
36
|
)
|
|
35
37
|
errorAssert.assertError(err, 'MISSING_PARAMETERS', {
|
|
36
38
|
parameters: [
|
|
@@ -55,7 +57,7 @@ export default class LslOutletTest extends AbstractNodeLslTest {
|
|
|
55
57
|
|
|
56
58
|
@test()
|
|
57
59
|
protected static async allowsZeroSampleRate() {
|
|
58
|
-
await this.
|
|
60
|
+
await this.LslStreamOutlet({ sampleRate: 0 })
|
|
59
61
|
}
|
|
60
62
|
|
|
61
63
|
@test()
|
|
@@ -75,7 +77,7 @@ export default class LslOutletTest extends AbstractNodeLslTest {
|
|
|
75
77
|
|
|
76
78
|
@test()
|
|
77
79
|
protected static async throwsWithInvalidChunkSize() {
|
|
78
|
-
await this.
|
|
80
|
+
await this.LslStreamOutlet({ chunkSize: 0 })
|
|
79
81
|
await this.assertThrowsInvalidChunkSize(-1)
|
|
80
82
|
await this.assertThrowsInvalidChunkSize(-1.5)
|
|
81
83
|
await this.assertThrowsInvalidChunkSize(1.5)
|
|
@@ -83,7 +85,7 @@ export default class LslOutletTest extends AbstractNodeLslTest {
|
|
|
83
85
|
|
|
84
86
|
@test()
|
|
85
87
|
protected static async throwsWithInvalidMaxBuffered() {
|
|
86
|
-
await this.
|
|
88
|
+
await this.LslStreamOutlet({ maxBuffered: 0 })
|
|
87
89
|
await this.assertThrowsInvalidMaxBuffered(-1)
|
|
88
90
|
await this.assertThrowsInvalidMaxBuffered(-1.5)
|
|
89
91
|
await this.assertThrowsInvalidMaxBuffered(1.5)
|
|
@@ -94,7 +96,9 @@ export default class LslOutletTest extends AbstractNodeLslTest {
|
|
|
94
96
|
for (let unsupportedType of TEST_UNSUPPORTED_CHANNEL_FORMATS) {
|
|
95
97
|
await assert.doesThrowAsync(
|
|
96
98
|
async () =>
|
|
97
|
-
await this.
|
|
99
|
+
await this.LslStreamOutlet({
|
|
100
|
+
channelFormat: unsupportedType,
|
|
101
|
+
}),
|
|
98
102
|
`This method currently does not support the ${unsupportedType} type! Please implement it.`
|
|
99
103
|
)
|
|
100
104
|
}
|
|
@@ -103,7 +107,9 @@ export default class LslOutletTest extends AbstractNodeLslTest {
|
|
|
103
107
|
@test()
|
|
104
108
|
protected static async supportsAllKnownChannelFormats() {
|
|
105
109
|
for (const format of TEST_SUPPORTED_CHANNEL_FORMATS) {
|
|
106
|
-
await this.
|
|
110
|
+
await this.LslStreamOutlet({
|
|
111
|
+
channelFormat: format as TestChannelFormat,
|
|
112
|
+
})
|
|
107
113
|
}
|
|
108
114
|
}
|
|
109
115
|
|
|
@@ -172,7 +178,7 @@ export default class LslOutletTest extends AbstractNodeLslTest {
|
|
|
172
178
|
|
|
173
179
|
@test()
|
|
174
180
|
protected static async constructionCreatesStreamInfo() {
|
|
175
|
-
await this.
|
|
181
|
+
await this.LslStreamOutlet()
|
|
176
182
|
|
|
177
183
|
assert.isEqualDeep(FakeStreamInfo.callsToConstructor[0], {
|
|
178
184
|
channelNames: this.randomOutletOptions.channelNames,
|
|
@@ -187,15 +193,15 @@ export default class LslOutletTest extends AbstractNodeLslTest {
|
|
|
187
193
|
|
|
188
194
|
@test()
|
|
189
195
|
protected static async canOverrideClassInstantiatedInFactory() {
|
|
190
|
-
|
|
191
|
-
const instance = await this.
|
|
196
|
+
LslStreamOutlet.Class = CheckingOutlet
|
|
197
|
+
const instance = await this.LslStreamOutlet()
|
|
192
198
|
|
|
193
199
|
assert.isInstanceOf(instance, CheckingOutlet)
|
|
194
200
|
}
|
|
195
201
|
|
|
196
202
|
@test()
|
|
197
203
|
protected static async canDestroyOutlet() {
|
|
198
|
-
const outlet = await this.
|
|
204
|
+
const outlet = await this.LslStreamOutlet()
|
|
199
205
|
outlet.destroy()
|
|
200
206
|
|
|
201
207
|
assert.isEqual(this.fakeLiblsl.destroyOutletHitCount, 1)
|
|
@@ -214,7 +220,7 @@ export default class LslOutletTest extends AbstractNodeLslTest {
|
|
|
214
220
|
@test()
|
|
215
221
|
protected static async waitsForTenMsAfterConstructionBeforeReturning() {
|
|
216
222
|
const startMs = Date.now()
|
|
217
|
-
await this.
|
|
223
|
+
await this.LslStreamOutlet({ waitAfterConstructionMs: 10 })
|
|
218
224
|
const endMs = Date.now()
|
|
219
225
|
|
|
220
226
|
assert.isAbove(endMs - startMs, 10)
|
|
@@ -250,7 +256,7 @@ export default class LslOutletTest extends AbstractNodeLslTest {
|
|
|
250
256
|
parameters: string[]
|
|
251
257
|
) {
|
|
252
258
|
const err = await assert.doesThrowAsync(
|
|
253
|
-
async () => await this.
|
|
259
|
+
async () => await this.LslStreamOutlet(options)
|
|
254
260
|
)
|
|
255
261
|
errorAssert.assertError(err, 'INVALID_PARAMETERS', {
|
|
256
262
|
parameters,
|
|
@@ -258,22 +264,22 @@ export default class LslOutletTest extends AbstractNodeLslTest {
|
|
|
258
264
|
}
|
|
259
265
|
|
|
260
266
|
private static async StringOutlet() {
|
|
261
|
-
return await this.
|
|
267
|
+
return await this.LslStreamOutlet({ channelFormat: 'string' })
|
|
262
268
|
}
|
|
263
269
|
|
|
264
270
|
private static async FloatOutlet() {
|
|
265
|
-
return await this.
|
|
271
|
+
return await this.LslStreamOutlet({ channelFormat: 'float32' })
|
|
266
272
|
}
|
|
267
273
|
|
|
268
|
-
private static async
|
|
269
|
-
return await
|
|
274
|
+
private static async LslStreamOutlet(options?: Partial<LslOutletOptions>) {
|
|
275
|
+
return await LslStreamOutlet.Create({
|
|
270
276
|
...this.randomOutletOptions,
|
|
271
277
|
...options,
|
|
272
278
|
})
|
|
273
279
|
}
|
|
274
280
|
}
|
|
275
281
|
|
|
276
|
-
class CheckingOutlet extends
|
|
282
|
+
class CheckingOutlet extends LslStreamOutlet {
|
|
277
283
|
public constructor(info: StreamInfo, options: LslOutletOptions) {
|
|
278
284
|
super(info, options)
|
|
279
285
|
}
|
|
@@ -1,52 +1,45 @@
|
|
|
1
1
|
import { DurationMarker } from '../nodeLsl.types'
|
|
2
|
-
import
|
|
3
|
-
import LslStreamInfo, { StreamInfo } from './LslStreamInfo'
|
|
2
|
+
import LslStreamOutlet, { LslOutletOptions, LslOutlet } from './LslStreamOutlet'
|
|
4
3
|
|
|
5
|
-
export default class
|
|
6
|
-
|
|
7
|
-
implements TimeMarkerOutlet
|
|
8
|
-
{
|
|
9
|
-
public static Class?: TimeMarkerOutletConstructor
|
|
4
|
+
export default class EventMarkerOutlet implements MarkerOutlet {
|
|
5
|
+
public static Class?: MarkerOutletConstructor
|
|
10
6
|
|
|
7
|
+
protected lslOutlet: LslOutlet
|
|
11
8
|
private isPlaying = false
|
|
12
9
|
private waitResolve?: () => void
|
|
13
10
|
private timeout?: any
|
|
14
11
|
|
|
15
|
-
|
|
16
|
-
|
|
12
|
+
protected constructor(lslOutlet: LslOutlet) {
|
|
13
|
+
this.lslOutlet = lslOutlet
|
|
14
|
+
}
|
|
17
15
|
|
|
18
|
-
|
|
19
|
-
|
|
16
|
+
public static async Create(options?: Partial<LslOutletOptions>) {
|
|
17
|
+
const defaultOptions = {
|
|
18
|
+
name: 'Event markers',
|
|
20
19
|
type: 'Markers',
|
|
21
20
|
channelNames: ['Markers'],
|
|
22
21
|
sampleRate: 0,
|
|
23
22
|
channelFormat: 'string',
|
|
24
|
-
sourceId: '
|
|
25
|
-
|
|
26
|
-
|
|
23
|
+
sourceId: 'event-markers',
|
|
24
|
+
manufacturer: 'N/A',
|
|
25
|
+
unit: 'N/A',
|
|
26
|
+
chunkSize: 0,
|
|
27
|
+
maxBuffered: 0,
|
|
27
28
|
} as LslOutletOptions
|
|
28
29
|
|
|
29
|
-
const
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
manufacturer: manufacturer ?? 'N/A',
|
|
34
|
-
chunkSize: chunkSize ?? 0,
|
|
35
|
-
maxBuffered: maxBuffered ?? 0,
|
|
36
|
-
unit: unit ?? 'N/A',
|
|
37
|
-
}
|
|
38
|
-
|
|
39
|
-
// @ts-ignore
|
|
40
|
-
delete outletOptions.units
|
|
30
|
+
const outlet = await LslStreamOutlet.Create({
|
|
31
|
+
...defaultOptions,
|
|
32
|
+
...options,
|
|
33
|
+
})
|
|
41
34
|
|
|
42
|
-
return new (this.Class ?? this)(
|
|
35
|
+
return new (this.Class ?? this)(outlet)
|
|
43
36
|
}
|
|
44
37
|
|
|
45
38
|
public async pushMarkers(markers: DurationMarker[]) {
|
|
46
39
|
this.isPlaying = true
|
|
47
40
|
|
|
48
41
|
for (let marker of markers) {
|
|
49
|
-
this.pushSample([marker.name])
|
|
42
|
+
this.lslOutlet.pushSample([marker.name])
|
|
50
43
|
|
|
51
44
|
await this.wait(marker.durationMs)
|
|
52
45
|
|
|
@@ -72,12 +65,9 @@ export default class TimeMarkerOutletImpl
|
|
|
72
65
|
}
|
|
73
66
|
}
|
|
74
67
|
|
|
75
|
-
export interface
|
|
68
|
+
export interface MarkerOutlet {
|
|
76
69
|
pushMarkers(markers: DurationMarker[]): Promise<void>
|
|
77
70
|
stop(): void
|
|
78
71
|
}
|
|
79
72
|
|
|
80
|
-
export type
|
|
81
|
-
info: StreamInfo,
|
|
82
|
-
options: LslOutletOptions
|
|
83
|
-
) => TimeMarkerOutlet
|
|
73
|
+
export type MarkerOutletConstructor = new (lslOutlet: LslOutlet) => MarkerOutlet
|
|
@@ -14,7 +14,7 @@ import {
|
|
|
14
14
|
DestroyInletOptions,
|
|
15
15
|
} from '../nodeLsl.types'
|
|
16
16
|
|
|
17
|
-
export default class
|
|
17
|
+
export default class LiblslAdapter implements Liblsl {
|
|
18
18
|
private static instance?: Liblsl
|
|
19
19
|
public static ffiRsOpen = open
|
|
20
20
|
public static ffiRsDefine = define
|
|
@@ -54,12 +54,12 @@ export default class LiblslImpl implements Liblsl {
|
|
|
54
54
|
}
|
|
55
55
|
|
|
56
56
|
private loadBindings(liblslPath: string) {
|
|
57
|
-
|
|
57
|
+
LiblslAdapter.ffiRsOpen({
|
|
58
58
|
library: 'lsl',
|
|
59
59
|
path: liblslPath,
|
|
60
60
|
})
|
|
61
61
|
|
|
62
|
-
return
|
|
62
|
+
return LiblslAdapter.ffiRsDefine({
|
|
63
63
|
lsl_create_streaminfo: {
|
|
64
64
|
library: 'lsl',
|
|
65
65
|
retType: DataType.External,
|
|
@@ -2,7 +2,7 @@ import { assertOptions } from '@sprucelabs/schema'
|
|
|
2
2
|
import { generateId } from '@sprucelabs/test-utils'
|
|
3
3
|
import { CHANNEL_FORMATS_MAP } from '../consts'
|
|
4
4
|
import { BoundStreamInfo, ChannelFormat } from '../nodeLsl.types'
|
|
5
|
-
import
|
|
5
|
+
import LiblslAdapter from './LiblslAdapter'
|
|
6
6
|
|
|
7
7
|
export default class LslStreamInfo implements StreamInfo {
|
|
8
8
|
public static Class?: StreamInfoConstructor
|
|
@@ -79,7 +79,7 @@ export default class LslStreamInfo implements StreamInfo {
|
|
|
79
79
|
}
|
|
80
80
|
|
|
81
81
|
private get lsl() {
|
|
82
|
-
return
|
|
82
|
+
return LiblslAdapter.getInstance()
|
|
83
83
|
}
|
|
84
84
|
|
|
85
85
|
private readonly defaultName = `lsl-stream-info-${generateId()}`
|