Merge pull request #52 from bitfocus/improve-show-control

Improve show control

Author: janikwitzig

src/actions/control.ts

@@ -1,4 +1,4 @@
-import { CompanionActionDefinitions } from '@companion-module/base'
+import { CompanionActionDefinitions, CompanionOptionValues } from '@companion-module/base'
 import { CompanionActionWithCallback } from './common.js'
 import { InstanceBaseExt } from '../types.js'
 import { WingConfig } from '../config.js'
@@ -9,84 +9,72 @@ import { getIdLabelPair } from '../choices/utils.js'
 
 export enum OtherActionId {
 	RecallScene = 'recall-scene',
-	RecallSceneFromList = 'recall-scene-from-list',
 	SendLibraryAction = 'send-library-action',
 }
 
 export function createControlActions(self: InstanceBaseExt<WingConfig>): CompanionActionDefinitions {
 	const send = self.sendCommand
 	const state = self.state
 	const ensureLoaded = self.ensureLoaded
+	const subscriptions = self.subscriptions
 
 	const actions: { [id in OtherActionId]: CompanionActionWithCallback | undefined } = {
 		[OtherActionId.RecallScene]: {
 			name: 'Recall Scene',
-			description: 'Recall a scene and optionally go to it',
+			description:
+				'ATTENTION: if you have the same scene name twice in your show, you will not be able to recall it by name! In this case, use the scene ID instead.',
 			options: [
+				{
+					type: 'checkbox',
+					id: 'useSceneId',
+					label: 'Use Scene Id',
+					default: false,
+				},
 				{
 					type: 'number',
-					id: 'num',
+					id: 'sceneId',
 					label: 'Scene Number',
 					min: 1,
 					max: 16384,
 					default: 1,
+					isVisible: (options: CompanionOptionValues): boolean => {
+						return options.useSceneId != null && options.useSceneId == true
+					},
 				},
 				{
-					type: 'checkbox',
-					id: 'go',
-					label: 'Go to Scene?',
-					default: true,
+					...GetDropdown('Scene Name', 'sceneName', state.namedChoices.scenes),
+					isVisible: (options: CompanionOptionValues): boolean => {
+						return options.useSceneId != null && options.useSceneId == false
+					},
 				},
 			],
 			callback: async (event) => {
-				send(ControlCommands.LibrarySceneSelectionIndex(), event.options.num as number)
-				if (event.options.go) {
-					send(ControlCommands.LibraryAction(), 'GO')
+				const useSceneId = event.options.useSceneId
+				let sceneId = 0
+				if (useSceneId == true) {
+					sceneId = event.options.sceneId as number
+				} else {
+					sceneId = state.sceneNameToIdMap.get(event.options.sceneName as string) ?? 0
 				}
+				send(ControlCommands.LibrarySceneSelectionIndex(), sceneId)
+				send(ControlCommands.LibraryAction(), 'GO')
 			},
-			subscribe: () => {
-				const cmd = ControlCommands.LibraryActiveSceneIndex()
-				ensureLoaded(cmd)
-			},
-			learn: () => {
-				const cmd = ControlCommands.LibraryActiveSceneIndex()
-				return { num: StateUtil.getNumberFromState(cmd, state) }
-			},
-		},
-		[OtherActionId.RecallSceneFromList]: {
-			name: 'Recall Scene from List',
-			description:
-				'Recall a scene from a list and optionally go to it (NOTE: When you add/remove/move scenes in your show, you must update this command.)',
-			options: [
-				GetDropdown(
-					'Scene',
-					'num',
-					state.namedChoices.scenes,
-					undefined,
-					'This uses the index of the scene, and changes when scenes are added or removed.',
-				),
-				{
-					type: 'checkbox',
-					id: 'go',
-					label: 'Go to Scene?',
-					default: true,
-				},
-			],
-			callback: async (event) => {
-				const go = event.options.go as boolean
-				send(ControlCommands.LibrarySceneSelectionIndex(), event.options.num as number)
-				if (go) {
-					send(ControlCommands.LibraryAction(), 'GO')
+			subscribe: (event) => {
+				if (event.options.useSceneId == false) {
+					subscriptions.subscribePoll(ControlCommands.LibraryScenes())
 				}
-			},
-			subscribe: () => {
-				const cmd = ControlCommands.LibraryActiveSceneIndex()
-				ensureLoaded(cmd)
+				ensureLoaded(ControlCommands.LibraryActiveSceneIndex())
 				ensureLoaded(ControlCommands.LibraryNode(), '?')
 			},
-			learn: () => {
+			learn: (event) => {
+				const sceneIdMap = state.sceneNameToIdMap
 				const cmd = ControlCommands.LibraryActiveSceneIndex()
-				return { num: StateUtil.getNumberFromState(cmd, state) }
+				const sceneId = StateUtil.getNumberFromState(cmd, state)
+				let sceneName = ''
+				for (const [key, value] of sceneIdMap.entries()) {
+					if (value === sceneId) sceneName = key
+				}
+				return { sceneName: sceneName, sceneId: sceneId, useSceneId: event.options.useSceneId }
 			},
 		},
 		[OtherActionId.SendLibraryAction]: {

src/config.ts

@@ -3,7 +3,7 @@ import { WingDeviceDetectorInstance } from './device-detector.js'
 // import { ModelChoices, WingModel } from './models/types.js'
 
 export const fadeUpdateRateDefault = 50
-export const pollUpdateRateDefault = 500
+export const pollUpdateRateDefault = 3000
 
 export const DeskTypes = [
 	{ id: 'wing', label: 'Wing' },

src/feedbacks.ts

@@ -11,13 +11,7 @@ import {
 	CompanionFeedbackInfo,
 } from '@companion-module/base'
 // import { compareNumber, GetDropdownFeedback, GetNumberComparator, GetPanoramaSliderFeedback } from './choices/common.js'
-import {
-	GetDropdown,
-	GetMuteDropdown,
-	getTimeFormatChoices,
-	getTriStateColor,
-	getTriStateTextColor,
-} from './choices/common.js'
+import { GetDropdown, GetMuteDropdown, getTriStateColor, getTriStateTextColor } from './choices/common.js'
 import { getNodeNumber } from './actions/utils.js'
 import { StateUtil } from './state/index.js'
 import { UsbPlayerCommands } from './commands/usbplayer.js'
@@ -34,9 +28,7 @@ export enum FeedbackId {
 	Mute = 'mute',
 	SendMute = 'send-mute',
 	AesStatus = 'aes-status',
-	RecorderTime = 'recorder-time',
 	RecorderState = 'recorder-state',
-	PlayerTime = 'player-time',
 }
 
 function subscribeFeedback(
@@ -160,33 +152,6 @@ export function GetFeedbacksList(
 				unsubscribeFeedback(subs, cmd, event)
 			},
 		},
-		[FeedbackId.RecorderTime]: {
-			type: 'advanced',
-			name: 'USB Recorder Time',
-			description: 'Current Time of the Recording',
-			options: [GetDropdown('Format', 'format', getTimeFormatChoices())],
-			callback: (): CompanionAdvancedFeedbackResult => {
-				const cmd = UsbPlayerCommands.RecorderTime()
-				const time = StateUtil.getNumberFromState(cmd, state) ?? 'N/A'
-				if (time) {
-					if (isNaN(Number(time))) {
-						return {
-							text: time as string,
-						}
-					} else return {}
-				} else return {}
-			},
-			subscribe: (event): void => {
-				const cmd = UsbPlayerCommands.RecorderTime()
-				subs.subscribePoll(cmd, event.id, event.feedbackId as FeedbackId)
-				subscribeFeedback(ensureLoaded, subs, cmd, event)
-			},
-			unsubscribe: (event: CompanionFeedbackInfo): void => {
-				const cmd = UsbPlayerCommands.RecorderTime()
-				subs.unsubscribePoll(cmd, event.feedbackId as FeedbackId)
-				unsubscribeFeedback(subs, cmd, event)
-			},
-		},
 		[FeedbackId.RecorderState]: {
 			type: 'advanced',
 			name: 'USB Recorder State',
@@ -236,28 +201,6 @@ export function GetFeedbacksList(
 				unsubscribeFeedback(subs, cmd, event)
 			},
 		},
-		[FeedbackId.PlayerTime]: {
-			type: 'advanced',
-			name: 'USB Player Time',
-			description: 'Current Time of the USB Player',
-			options: [GetDropdown('Format', 'format', getTimeFormatChoices())],
-			callback: (): CompanionAdvancedFeedbackResult => {
-				const cmd = UsbPlayerCommands.PlayerTotalTime()
-				return {
-					text: `${StateUtil.getNumberFromState(cmd, state) ?? 'N/A'}`,
-				}
-			},
-			subscribe: (event): void => {
-				const cmd = UsbPlayerCommands.PlayerTotalTime()
-				subs.subscribePoll(cmd, event.id, event.feedbackId as FeedbackId)
-				subscribeFeedback(ensureLoaded, subs, cmd, event)
-			},
-			unsubscribe: (event: CompanionFeedbackInfo): void => {
-				const cmd = UsbPlayerCommands.PlayerTotalTime()
-				subs.unsubscribePoll(cmd, event.feedbackId as FeedbackId)
-				unsubscribeFeedback(subs, cmd, event)
-			},
-		},
 	}
 
 	return feedbacks

src/index.ts

@@ -26,8 +26,7 @@ export class WingInstance extends InstanceBase<WingConfig> implements InstanceBa
 	state: WingState
 	model: ModelSpec
 	osc: osc.UDPPort
-
-	private WingSubscriptions: WingSubscriptions
+	subscriptions: WingSubscriptions
 
 	private heartbeatTimer: NodeJS.Timeout | undefined
 	private reconnectTimer: NodeJS.Timeout | undefined
@@ -58,7 +57,7 @@ export class WingInstance extends InstanceBase<WingConfig> implements InstanceBa
 		super(internal)
 
 		this.osc = new osc.UDPPort({})
-		this.WingSubscriptions = new WingSubscriptions()
+		this.subscriptions = new WingSubscriptions()
 		this.model = getDeskModel(WingModel.Full)
 		this.state = new WingState(this.model)
 
@@ -145,7 +144,7 @@ export class WingInstance extends InstanceBase<WingConfig> implements InstanceBa
 	async configUpdated(config: WingConfig): Promise<void> {
 		this.config = config
 
-		this.WingSubscriptions = new WingSubscriptions()
+		this.subscriptions = new WingSubscriptions()
 		this.state = new WingState(this.model)
 
 		this.transitions.stopAll()
@@ -171,7 +170,7 @@ export class WingInstance extends InstanceBase<WingConfig> implements InstanceBa
 	}
 
 	updateFeedbacks(): void {
-		this.setFeedbackDefinitions(GetFeedbacksList(this, this.state, this.WingSubscriptions, this.ensureLoaded))
+		this.setFeedbackDefinitions(GetFeedbacksList(this, this.state, this.subscriptions, this.ensureLoaded))
 	}
 
 	updateVariableDefinitions(): void {
@@ -243,7 +242,7 @@ export class WingInstance extends InstanceBase<WingConfig> implements InstanceBa
 			}, 9000)
 			this.statusUpdateInterval = setInterval(() => {
 				this.requestStatusUpdates()
-			}, this.config.statusPollUpdateRate ?? 250)
+			}, this.config.statusPollUpdateRate ?? 3000)
 
 			this.state.requestNames(this.model, this.ensureLoaded)
 			this.requestQueue.clear()
@@ -312,7 +311,7 @@ export class WingInstance extends InstanceBase<WingConfig> implements InstanceBa
 	}
 
 	private requestStatusUpdates(): void {
-		this.WingSubscriptions.getPollPaths().forEach((c) => {
+		this.subscriptions.getPollPaths().forEach((c) => {
 			this.sendCommand(c)
 		})
 	}
@@ -327,19 +326,19 @@ export class WingInstance extends InstanceBase<WingConfig> implements InstanceBa
 
 		// scene list
 		if (libRe.test(msg.address)) {
-			console.log('Got library')
-			const content = (args[0].value as string) ?? ''
+			const content = String(args[0]?.value ?? '')
 			const scenes = content.match(/\$scenes\s+list\s+\[([^\]]+)\]/)
 			console.log(scenes)
 			if (scenes) {
 				const sceneList = scenes[1].split(',').map((s) => s.trim())
-				this.state.namedChoices.scenes = sceneList.map((s, i) => ({ id: i + 1, label: s }))
+				this.state.namedChoices.scenes = sceneList.map((s) => ({ id: s, label: s }))
+				this.state.sceneNameToIdMap = new Map(sceneList.map((s, i) => [s, i + 1]))
 			}
 		}
 	}
 
 	private checkFeedbackChanges(msg: osc.OscMessage): void {
-		const toUpdate = this.WingSubscriptions.getFeedbacks(msg.address)
+		const toUpdate = this.subscriptions.getFeedbacks(msg.address)
 		if (toUpdate.length > 0) {
 			toUpdate.forEach((f) => this.messageFeedbacks.add(f))
 			this.debounceMessageFeedbacks()
@@ -370,7 +369,7 @@ export class WingInstance extends InstanceBase<WingConfig> implements InstanceBa
 
 		this.setPresetDefinitions(GetPresets(this))
 		this.setActionDefinitions(createActions(this))
-		this.setFeedbackDefinitions(GetFeedbacksList(this, this.state, this.WingSubscriptions, this.ensureLoaded))
+		this.setFeedbackDefinitions(GetFeedbacksList(this, this.state, this.subscriptions, this.ensureLoaded))
 		this.checkFeedbacks()
 	}
 

src/state/state.ts

@@ -53,11 +53,14 @@ export class WingState implements IStoredChannelSubject {
 		scenes: [],
 	}
 
+	sceneNameToIdMap: Map<string, number>
+
 	constructor(model: ModelSpec) {
 		this.data = new Map()
 		this.pressStorage = new Map()
 		this.deltaStorage = new Map()
 		this.storedChannel = 1
+		this.sceneNameToIdMap = new Map()
 		this.updateNames(model)
 	}
 
@@ -264,12 +267,10 @@ export class WingSubscriptions {
 	public getPollPaths(): string[] {
 		return Array.from(this.pollData)
 	}
-	public subscribePoll(path: string, feedbackId: string, type: FeedbackId): void {
-		this.subscribe(path, feedbackId, type)
+	public subscribePoll(path: string): void {
 		this.pollData.add(path)
 	}
-	public unsubscribePoll(path: string, feedbackId: string): void {
-		this.unsubscribe(path, feedbackId)
+	public unsubscribePoll(path: string): void {
 		this.pollData.delete(path)
 	}
 }

src/types.ts

@@ -1,13 +1,14 @@
 import { InstanceBase } from '@companion-module/base'
 import osc from 'osc'
 import { WingTransitions } from './transitions.js'
-import { WingState } from './state/state.js'
+import { WingState, WingSubscriptions } from './state/state.js'
 
 export interface InstanceBaseExt<TConfig> extends InstanceBase<TConfig> {
 	config: TConfig
 	osc: osc.UDPPort
 	transitions: WingTransitions
 	state: WingState
+	subscriptions: WingSubscriptions
 	sendCommand: (cmd: string, argument?: number | string, preferFloat?: boolean) => void
 	ensureLoaded: (path: string, arg?: string | number) => void
 }