fix: refactor input services

Author: Julusian

packages/core/src/__tests__/test.spec.ts

@@ -415,7 +415,7 @@ describe('StreamDeck', () => {
 		})
 	})
 
-	test('down and up events', () => {
+	test.only('down and up events', () => {
 		const downSpy = jest.fn()
 		const upSpy = jest.fn()
 		streamDeck.on('down', downSpy)

packages/core/src/models/base.ts

@@ -12,9 +12,8 @@ import type { ButtonsLcdDisplayService } from '../services/buttonsLcdDisplay/int
 import type { StreamDeckButtonControlDefinition, StreamDeckControlDefinition } from '../controlDefinition.js'
 import type { LcdStripDisplayService } from '../services/lcdStripDisplay/interface.js'
 import type { PropertiesService } from '../services/properties/interface.js'
-import type { EncoderInputService } from '../services/encoderInput.js'
-import type { LcdStripInputService } from '../services/lcdStripInput.js'
 import type { CallbackHook } from '../services/callback-hook.js'
+import type { StreamDeckInputService } from '../services/input/interface.js'
 
 export type EncodeJPEGHelper = (buffer: Uint8Array, width: number, height: number) => Promise<Uint8Array>
 
@@ -46,12 +45,11 @@ export type StreamDeckProperties = Readonly<{
 
 export interface StreamDeckServicesDefinition {
 	deviceProperties: StreamDeckProperties
-	events: CallbackHook<StreamDeckEvents> | null
+	events: CallbackHook<StreamDeckEvents>
 	properties: PropertiesService
 	buttonsLcd: ButtonsLcdDisplayService
+	inputService: StreamDeckInputService
 	lcdStripDisplay: LcdStripDisplayService | null
-	lcdStripInput: LcdStripInputService | null
-	encoderInput: EncoderInputService | null
 }
 
 export class StreamDeckBase extends EventEmitter<StreamDeckEvents> implements StreamDeck {
@@ -88,10 +86,8 @@ export class StreamDeckBase extends EventEmitter<StreamDeckEvents> implements St
 	readonly #propertiesService: PropertiesService
 	readonly #buttonsLcdService: ButtonsLcdDisplayService
 	readonly #lcdStripDisplayService: LcdStripDisplayService | null
-	readonly #lcdStripInputService: LcdStripInputService | null
-	readonly #encoderInputService: EncoderInputService | null
+	readonly #inputService: StreamDeckInputService
 	// private readonly options: Readonly<OpenStreamDeckOptions>
-	readonly #keyState: boolean[]
 
 	constructor(device: HIDDevice, _options: OpenStreamDeckOptions, services: StreamDeckServicesDefinition) {
 		super()
@@ -101,58 +97,18 @@ export class StreamDeckBase extends EventEmitter<StreamDeckEvents> implements St
 		this.#propertiesService = services.properties
 		this.#buttonsLcdService = services.buttonsLcd
 		this.#lcdStripDisplayService = services.lcdStripDisplay
-		this.#lcdStripInputService = services.lcdStripInput
-		this.#encoderInputService = services.encoderInput
+		this.#inputService = services.inputService
 
 		// propogate events
 		services.events?.listen((key, ...args) => this.emit(key, ...args))
 
-		const maxButtonIndex = this.deviceProperties.CONTROLS.filter(
-			(control): control is StreamDeckButtonControlDefinition => control.type === 'button',
-		).map((control) => control.index)
-		this.#keyState = new Array<boolean>(Math.max(-1, ...maxButtonIndex) + 1).fill(false)
-
-		this.device.on('input', (data: Uint8Array) => this.#handleInputBuffer(data))
+		this.device.on('input', (data: Uint8Array) => this.#inputService.handleInput(data))
 
 		this.device.on('error', (err) => {
 			this.emit('error', err)
 		})
 	}
 
-	#handleInputBuffer(data: Uint8Array): void {
-		const inputType = data[0]
-		switch (inputType) {
-			case 0x00: // Button
-				this.#handleButtonInputBuffer(data)
-				break
-			case 0x02: // LCD
-				this.#lcdStripInputService?.handleInput(data)
-				break
-			case 0x03: // Encoder
-				this.#encoderInputService?.handleInput(data)
-				break
-		}
-	}
-
-	#handleButtonInputBuffer(data: Uint8Array): void {
-		const dataOffset = this.deviceProperties.KEY_DATA_OFFSET || 0
-
-		for (const control of this.deviceProperties.CONTROLS) {
-			if (control.type !== 'button') continue
-
-			const keyPressed = Boolean(data[dataOffset + control.hidIndex])
-			const stateChanged = keyPressed !== this.#keyState[control.index]
-			if (stateChanged) {
-				this.#keyState[control.index] = keyPressed
-				if (keyPressed) {
-					this.emit('down', control)
-				} else {
-					this.emit('up', control)
-				}
-			}
-		}
-	}
-
 	protected checkValidKeyIndex(
 		keyIndex: KeyIndex,
 		feedbackType: StreamDeckButtonControlDefinition['feedbackType'] | null,

packages/core/src/models/generic-gen1.ts

@@ -6,6 +6,9 @@ import type { FillImageTargetOptions } from '../util.js'
 import { Gen1PropertiesService } from '../services/properties/gen1.js'
 import { DefaultButtonsLcdService } from '../services/buttonsLcdDisplay/default.js'
 import { BitmapButtonLcdImagePacker } from '../services/imagePacker/bitmap.js'
+import { CallbackHook } from '../services/callback-hook.js'
+import type { StreamDeckEvents } from '../types.js'
+import { ButtonOnlyInputService } from '../services/input/gen1.js'
 
 function extendDevicePropertiesForGen1(rawProps: StreamDeckGen1Properties): StreamDeckProperties {
 	return {
@@ -26,9 +29,11 @@ export function StreamDeckGen1Factory(
 ): StreamDeckBase {
 	const fullProperties = extendDevicePropertiesForGen1(properties)
 
+	const events = new CallbackHook<StreamDeckEvents>()
+
 	return new StreamDeckBase(device, options, {
 		deviceProperties: fullProperties,
-		events: null,
+		events,
 		properties: new Gen1PropertiesService(device),
 		buttonsLcd: new DefaultButtonsLcdService(
 			imageWriter,
@@ -42,7 +47,6 @@ export function StreamDeckGen1Factory(
 			fullProperties,
 		),
 		lcdStripDisplay: null,
-		lcdStripInput: null,
-		encoderInput: null,
+		inputService: new ButtonOnlyInputService(fullProperties, events),
 	})
 }

packages/core/src/models/generic-gen2.ts

@@ -2,12 +2,12 @@ import type { HIDDevice } from '../hid-device.js'
 import type { OpenStreamDeckOptions, StreamDeckProperties, StreamDeckServicesDefinition } from './base.js'
 import { StreamdeckDefaultImageWriter } from '../services/imageWriter/imageWriter.js'
 import { StreamdeckGen2ImageHeaderGenerator } from '../services/imageWriter/headerGenerator.js'
-import { EncoderInputService } from '../services/encoderInput.js'
 import { DefaultButtonsLcdService } from '../services/buttonsLcdDisplay/default.js'
 import { CallbackHook } from '../services/callback-hook.js'
 import type { StreamDeckEvents } from '../types.js'
 import { Gen2PropertiesService } from '../services/properties/gen2.js'
 import { JpegButtonLcdImagePacker } from '../services/imagePacker/jpeg.js'
+import { Gen2InputService } from '../services/input/gen2.js'
 
 function extendDevicePropertiesForGen2(rawProps: StreamDeckGen2Properties): StreamDeckProperties {
 	return {
@@ -24,10 +24,7 @@ export function createBaseGen2Properties(
 	options: Required<OpenStreamDeckOptions>,
 	properties: StreamDeckGen2Properties,
 	disableXYFlip?: boolean,
-): StreamDeckServicesDefinition & {
-	// Always defined for Gen2
-	events: CallbackHook<StreamDeckEvents>
-} {
+): StreamDeckServicesDefinition {
 	const fullProperties = extendDevicePropertiesForGen2(properties)
 
 	const events = new CallbackHook<StreamDeckEvents>()
@@ -48,7 +45,6 @@ export function createBaseGen2Properties(
 			fullProperties,
 		),
 		lcdStripDisplay: null,
-		lcdStripInput: null,
-		encoderInput: new EncoderInputService(events, properties.CONTROLS),
+		inputService: new Gen2InputService(fullProperties, events),
 	}
 }

packages/core/src/models/pedal.ts

@@ -6,6 +6,9 @@ import type { StreamDeckControlDefinition } from '../controlDefinition.js'
 import { freezeDefinitions } from '../controlsGenerator.js'
 import { PedalPropertiesService } from '../services/properties/pedal.js'
 import { PedalLcdService } from '../services/buttonsLcdDisplay/pedal.js'
+import type { StreamDeckEvents } from '../types.js'
+import { CallbackHook } from '../services/callback-hook.js'
+import { ButtonOnlyInputService } from '../services/input/gen1.js'
 
 const pedalControls: StreamDeckControlDefinition[] = [
 	{
@@ -49,13 +52,14 @@ const pedalProperties: StreamDeckProperties = {
 }
 
 export function StreamDeckPedalFactory(device: HIDDevice, options: Required<OpenStreamDeckOptions>): StreamDeckBase {
+	const events = new CallbackHook<StreamDeckEvents>()
+
 	return new StreamDeckBase(device, options, {
 		deviceProperties: pedalProperties,
-		events: null,
+		events,
 		properties: new PedalPropertiesService(device),
 		buttonsLcd: new PedalLcdService(),
 		lcdStripDisplay: null,
-		lcdStripInput: null,
-		encoderInput: null,
+		inputService: new ButtonOnlyInputService(pedalProperties, events),
 	})
 }

packages/core/src/models/plus.ts

@@ -6,7 +6,6 @@ import { createBaseGen2Properties } from './generic-gen2.js'
 import { DeviceModelId } from '../id.js'
 import { freezeDefinitions, generateButtonsGrid } from '../controlsGenerator.js'
 import type { StreamDeckControlDefinition, StreamDeckLcdStripControlDefinition } from '../controlDefinition.js'
-import { LcdStripInputService } from '../services/lcdStripInput.js'
 import { StreamDeckPlusLcdService } from '../services/lcdStripDisplay/plus.js'
 
 const plusControls: StreamDeckControlDefinition[] = generateButtonsGrid(4, 2)
@@ -74,7 +73,6 @@ const lcdStripControls = plusProperties.CONTROLS.filter(
 export function StreamDeckPlusFactory(device: HIDDevice, options: Required<OpenStreamDeckOptions>): StreamDeckBase {
 	const services = createBaseGen2Properties(device, options, plusProperties, true)
 	services.lcdStripDisplay = new StreamDeckPlusLcdService(options.encodeJPEG, device, lcdStripControls)
-	services.lcdStripInput = new LcdStripInputService(lcdStripControls, services.events)
 
 	return new StreamDeckBase(device, options, services)
 }

packages/core/src/services/encoderInput.ts

@@ -0,0 +1,40 @@
+import type { StreamDeckProperties } from '../../models/base.js'
+import type { StreamDeckInputService } from './interface.js'
+import type { StreamDeckEvents } from '../../types.js'
+import type { CallbackHook } from '../callback-hook.js'
+import type { StreamDeckButtonControlDefinition } from '../../controlDefinition.js'
+
+export class ButtonOnlyInputService implements StreamDeckInputService {
+	readonly #deviceProperties: Readonly<StreamDeckProperties>
+	readonly #keyState: boolean[]
+	readonly #eventSource: CallbackHook<StreamDeckEvents>
+
+	constructor(deviceProperties: Readonly<StreamDeckProperties>, eventSource: CallbackHook<StreamDeckEvents>) {
+		this.#deviceProperties = deviceProperties
+		this.#eventSource = eventSource
+
+		const maxButtonIndex = this.#deviceProperties.CONTROLS.filter(
+			(control): control is StreamDeckButtonControlDefinition => control.type === 'button',
+		).map((control) => control.index)
+		this.#keyState = new Array<boolean>(Math.max(-1, ...maxButtonIndex) + 1).fill(false)
+	}
+
+	handleInput(data: Uint8Array): void {
+		const dataOffset = this.#deviceProperties.KEY_DATA_OFFSET || 0
+
+		for (const control of this.#deviceProperties.CONTROLS) {
+			if (control.type !== 'button') continue
+
+			const keyPressed = Boolean(data[dataOffset + control.hidIndex])
+			const stateChanged = keyPressed !== this.#keyState[control.index]
+			if (stateChanged) {
+				this.#keyState[control.index] = keyPressed
+				if (keyPressed) {
+					this.#eventSource.emit('down', control)
+				} else {
+					this.#eventSource.emit('up', control)
+				}
+			}
+		}
+	}
+}