feat: attempt to handle out of range features safely

src/__tests__/tally.spec.ts

@@ -3,7 +3,7 @@ import { listVisibleInputs } from '../lib/tally'
 
 import { readFileSync } from 'fs'
 import { resolve } from 'path'
-import { parseAtemState } from './util'
+import { parseAtemState, createEmptyState } from './util'
 
 function readJson (fileName: string) {
 	const filePath = resolve(__dirname, fileName)
@@ -12,7 +12,14 @@ function readJson (fileName: string) {
 }
 
 function loadRawState (file: string) {
-	return parseAtemState(readJson(`./tally/${file}-state.json`))
+	const loadedState = parseAtemState(readJson(`./tally/${file}-state.json`))
+
+	if (!loadedState.info.capabilities) {
+		const emptyState = createEmptyState()
+		loadedState.info.capabilities = emptyState.info.capabilities
+	}
+
+	return loadedState
 }
 function loadTally (file: string) {
 	const rawTally = readJson(`./tally/${file}-tally.json`) as Commands.TallyBySourceCommand['properties']

src/__tests__/util.ts

@@ -27,3 +27,28 @@ export function parseAtemState (rawState: any): AtemState {
 
 	return state
 }
+
+export function createEmptyState () {
+	const state = new AtemState()
+
+	// These should be the maximum supported by any device.
+	// But they can also be whatever is needed to allow the tests to run without error
+	state.info.capabilities = {
+		mixEffects: 4,
+		sources: 40,
+		colorGenerators: 2,
+		auxilliaries: 6,
+		talkbackOutputs: 8,
+		mediaPlayers: 4,
+		serialPorts: 1,
+		maxHyperdecks: 4,
+		DVEs: 1,
+		stingers: 1,
+		superSources: 2,
+		talkbackOverSDI: 0,
+		multiViewers: 255,
+		downstreamKeyers: 4
+	}
+
+	return state
+}

src/commands/DeviceProfile/topologyCommand.ts

@@ -7,7 +7,7 @@ export class TopologyCommand extends DeserializedCommand<AtemCapabilites> {
 
 	public static deserialize (rawCommand: Buffer) {
 		const properties = {
-			MEs: rawCommand[0],
+			mixEffects: rawCommand[0],
 			sources: rawCommand[1],
 			colorGenerators: rawCommand[2],
 			auxilliaries: rawCommand[3],
@@ -18,7 +18,12 @@ export class TopologyCommand extends DeserializedCommand<AtemCapabilites> {
 			DVEs: rawCommand[8],
 			stingers: rawCommand[9],
 			superSources: rawCommand[10],
-			talkbackOverSDI: rawCommand[13]
+			talkbackOverSDI: rawCommand[13],
+
+			// TODO - define the below properly
+			multiViewers: 2,
+			downstreamKeyers: 2,
+			upstreamKeyers: 2
 		}
 
 		return new TopologyCommand(properties)

src/commands/DownstreamKey/DownstreamKeyPropertiesCommand.ts

@@ -37,6 +37,10 @@ export class DownstreamKeyPropertiesCommand extends DeserializedCommand<Downstre
 	}
 
 	public applyToState (state: AtemState) {
+		if (!state.info.capabilities || this.downstreamKeyerId >= state.info.capabilities.downstreamKeyers) {
+			throw new Error(`DownstreamKeyer ${this.downstreamKeyerId} is not valid`)
+		}
+
 		state.video.getDownstreamKeyer(this.downstreamKeyerId).properties = this.properties
 		return `video.downstreamKeyers.${this.downstreamKeyerId}`
 	}

src/commands/DownstreamKey/DownstreamKeySourcesCommand.ts

@@ -24,6 +24,10 @@ export class DownstreamKeySourcesCommand extends DeserializedCommand<DownstreamK
 	}
 
 	public applyToState (state: AtemState) {
+		if (!state.info.capabilities || this.downstreamKeyerId >= state.info.capabilities.downstreamKeyers) {
+			throw new Error(`DownstreamKeyer ${this.downstreamKeyerId} is not valid`)
+		}
+
 		state.video.getDownstreamKeyer(this.downstreamKeyerId).sources = this.properties
 		return `video.downstreamKeyers.${this.downstreamKeyerId}`
 	}

src/commands/DownstreamKey/DownstreamKeyStateCommand.ts

@@ -27,6 +27,10 @@ export class DownstreamKeyStateCommand extends DeserializedCommand<DownstreamKey
 	}
 
 	public applyToState (state: AtemState) {
+		if (!state.info.capabilities || this.downstreamKeyerId >= state.info.capabilities.downstreamKeyers) {
+			throw new Error(`DownstreamKeyer ${this.downstreamKeyerId} is not valid`)
+		}
+
 		state.video.downstreamKeyers[this.downstreamKeyerId] = {
 			...state.video.getDownstreamKeyer(this.downstreamKeyerId),
 			...this.properties
@@ -61,6 +65,10 @@ export class DownstreamKeyStateV8Command extends DeserializedCommand<DownstreamK
 	}
 
 	public applyToState (state: AtemState) {
+		if (!state.info.capabilities || this.downstreamKeyerId >= state.info.capabilities.downstreamKeyers) {
+			throw new Error(`DownstreamKeyer ${this.downstreamKeyerId} is not valid`)
+		}
+
 		state.video.downstreamKeyers[this.downstreamKeyerId] = {
 			...state.video.getDownstreamKeyer(this.downstreamKeyerId),
 			...this.properties

src/commands/Media/MediaPlayerSourceCommand.ts

@@ -53,6 +53,10 @@ export class MediaPlayerSourceUpdateCommand extends DeserializedCommand<MediaPla
 	}
 
 	public applyToState (state: AtemState) {
+		if (!state.info.capabilities || this.mediaPlayerId >= state.info.capabilities.mediaPlayers) {
+			throw new Error(`MediaPlayer ${this.mediaPlayerId} is not valid`)
+		}
+
 		state.media.players[this.mediaPlayerId] = {
 			...state.media.getMediaPlayer(this.mediaPlayerId),
 			...this.properties

src/commands/Media/MediaPlayerStatusCommand.ts

@@ -55,6 +55,10 @@ export class MediaPlayerStatusUpdateCommand extends DeserializedCommand<MediaPla
 	}
 
 	public applyToState (state: AtemState) {
+		if (!state.info.capabilities || this.mediaPlayerId >= state.info.capabilities.mediaPlayers) {
+			throw new Error(`MediaPlayer ${this.mediaPlayerId} is not valid`)
+		}
+
 		state.media.players[this.mediaPlayerId] = {
 			...state.media.getMediaPlayer(this.mediaPlayerId),
 			...this.properties

src/commands/Media/MediaPoolClipDescription.ts

@@ -6,12 +6,12 @@ import { Util } from '../../lib/atemUtil'
 export class MediaPoolClipDescriptionCommand extends DeserializedCommand<Omit<ClipBank, 'frames'>> {
 	public static readonly rawName = 'MPCS'
 
-	public readonly mediaPool: number
+	public readonly clipId: number
 
 	constructor (mediaPool: number, properties: Omit<ClipBank, 'frames'>) {
 		super(properties)
 
-		this.mediaPool = mediaPool
+		this.clipId = mediaPool
 	}
 
 	public static deserialize (rawCommand: Buffer) {
@@ -26,10 +26,12 @@ export class MediaPoolClipDescriptionCommand extends DeserializedCommand<Omit<Cl
 	}
 
 	public applyToState (state: AtemState) {
-		state.media.clipPool[this.mediaPool] = {
+		// TODO - validate ids
+
+		state.media.clipPool[this.clipId] = {
 			...this.properties,
-			frames: state.media.getClip(this.mediaPool).frames // TODO - lengthen/shorten array of frames?
+			frames: state.media.getClip(this.clipId).frames // TODO - lengthen/shorten array of frames?
 		}
-		return `media.clipPool.${this.mediaPool}`
+		return `media.clipPool.${this.clipId}`
 	}
 }

src/commands/Media/MediaPoolFrameDescription.ts

@@ -28,16 +28,19 @@ export class MediaPoolFrameDescriptionCommand extends DeserializedCommand<StillF
 		return new MediaPoolFrameDescriptionCommand(mediaPool, frameIndex, properties)
 	}
 
-	public applyToState (state: AtemState) {
+	public applyToState (state: AtemState): string | string[] {
+		// TODO - validate ids
+
 		if (this.mediaPool === 0) {
 			// This is a still
 			state.media.stillPool[this.frameIndex] = this.properties
 			return `media.stillPool.${this.frameIndex}`
 		} else if (this.mediaPool < 3) {
+			const clipId = this.mediaPool - 1
 			// This is a clip
-			state.media.getClip(this.mediaPool - 1).frames[this.frameIndex] = this.properties
-			return `media.clipPool.${this.mediaPool - 1}.${this.frameIndex}`
+			state.media.getClip(clipId).frames[this.frameIndex] = this.properties
+			return `media.clipPool.${clipId}.frames.${this.frameIndex}`
 		}
-		return `media`
+		return []
 	}
 }

src/commands/MixEffects/FadeToBlack/FadeToBlackRateCommand.ts

@@ -40,6 +40,10 @@ export class FadeToBlackRateUpdateCommand extends DeserializedCommand<{ rate: nu
 	}
 
 	public applyToState (state: AtemState) {
+		if (!state.info.capabilities || this.mixEffect >= state.info.capabilities.mixEffects) {
+			throw new Error(`MixEffect ${this.mixEffect} is not valid`)
+		}
+
 		const mixEffect = state.video.getMe(this.mixEffect)
 		mixEffect.fadeToBlack = {
 			isFullyBlack: false,

src/commands/MixEffects/FadeToBlack/FadeToBlackStateCommand.ts

@@ -30,6 +30,10 @@ export class FadeToBlackStateCommand extends DeserializedCommand<FadeToBlackProp
 	}
 
 	public applyToState (state: AtemState) {
+		if (!state.info.capabilities || this.mixEffect >= state.info.capabilities.mixEffects) {
+			throw new Error(`MixEffect ${this.mixEffect} is not valid`)
+		}
+
 		const mixEffect = state.video.getMe(this.mixEffect)
 		mixEffect.fadeToBlack = {
 			rate: 0,

src/commands/MixEffects/Key/MixEffectKeyChromaCommand.ts

@@ -66,6 +66,10 @@ export class MixEffectKeyChromaUpdateCommand extends DeserializedCommand<Upstrea
 	}
 
 	public applyToState (state: AtemState) {
+		if (!state.info.capabilities || this.mixEffect >= state.info.capabilities.mixEffects || this.upstreamKeyerId >= state.info.capabilities.upstreamKeyers) {
+			throw new Error(`UpstreamKeyer ${this.mixEffect}-${this.upstreamKeyerId} is not valid`)
+		}
+
 		const mixEffect = state.video.getMe(this.mixEffect)
 		const upstreamKeyer = mixEffect.getUpstreamKeyer(this.upstreamKeyerId)
 		upstreamKeyer.chromaSettings = {

src/commands/MixEffects/Key/MixEffectKeyDVECommand.ts

@@ -141,6 +141,10 @@ export class MixEffectKeyDVEUpdateCommand extends DeserializedCommand<UpstreamKe
 	}
 
 	public applyToState (state: AtemState) {
+		if (!state.info.capabilities || this.mixEffect >= state.info.capabilities.mixEffects || this.upstreamKeyerId >= state.info.capabilities.upstreamKeyers) {
+			throw new Error(`UpstreamKeyer ${this.mixEffect}-${this.upstreamKeyerId} is not valid`)
+		}
+
 		const mixEffect = state.video.getMe(this.mixEffect)
 		const upstreamKeyer = mixEffect.getUpstreamKeyer(this.upstreamKeyerId)
 		upstreamKeyer.dveSettings = {

src/commands/MixEffects/Key/MixEffectKeyFlyKeyframeGetCommand.ts

@@ -57,6 +57,10 @@ export class MixEffectKeyFlyKeyframeGetCommand extends DeserializedCommand<Upstr
 	}
 
 	public applyToState (state: AtemState) {
+		if (!state.info.capabilities || this.mixEffect >= state.info.capabilities.mixEffects || this.upstreamKeyerId >= state.info.capabilities.upstreamKeyers) {
+			throw new Error(`UpstreamKeyer ${this.mixEffect}-${this.upstreamKeyerId} is not valid`)
+		}
+
 		const mixEffect = state.video.getMe(this.mixEffect)
 		const upstreamKeyer = mixEffect.getUpstreamKeyer(this.upstreamKeyerId)
 		upstreamKeyer.flyKeyframes[this.properties.keyFrameId] = {

src/commands/MixEffects/Key/MixEffectKeyFlyPropertiesGetCommand.ts

@@ -28,6 +28,10 @@ export class MixEffectKeyFlyPropertiesGetCommand extends DeserializedCommand<Ups
 	}
 
 	public applyToState (state: AtemState) {
+		if (!state.info.capabilities || this.mixEffect >= state.info.capabilities.mixEffects || this.upstreamKeyerId >= state.info.capabilities.upstreamKeyers) {
+			throw new Error(`UpstreamKeyer ${this.mixEffect}-${this.upstreamKeyerId} is not valid`)
+		}
+
 		const mixEffect = state.video.getMe(this.mixEffect)
 		const upstreamKeyer = mixEffect.getUpstreamKeyer(this.upstreamKeyerId)
 		upstreamKeyer.flyProperties = {

src/commands/MixEffects/Key/MixEffectKeyLumaCommand.ts

@@ -63,6 +63,10 @@ export class MixEffectKeyLumaUpdateCommand extends DeserializedCommand<UpstreamK
 	}
 
 	public applyToState (state: AtemState) {
+		if (!state.info.capabilities || this.mixEffect >= state.info.capabilities.mixEffects || this.upstreamKeyerId >= state.info.capabilities.upstreamKeyers) {
+			throw new Error(`UpstreamKeyer ${this.mixEffect}-${this.upstreamKeyerId} is not valid`)
+		}
+
 		const mixEffect = state.video.getMe(this.mixEffect)
 		const upstreamKeyer = mixEffect.getUpstreamKeyer(this.upstreamKeyerId)
 		upstreamKeyer.lumaSettings = {

src/commands/MixEffects/Key/MixEffectKeyOnAirCommand.ts

@@ -46,6 +46,10 @@ export class MixEffectKeyOnAirUpdateCommand extends DeserializedCommand<{onAir:
 	}
 
 	public applyToState (state: AtemState) {
+		if (!state.info.capabilities || this.mixEffect >= state.info.capabilities.mixEffects || this.upstreamKeyerId >= state.info.capabilities.upstreamKeyers) {
+			throw new Error(`UpstreamKeyer ${this.mixEffect}-${this.upstreamKeyerId} is not valid`)
+		}
+
 		const mixEffect = state.video.getMe(this.mixEffect)
 		const upstreamKeyer = mixEffect.getUpstreamKeyer(this.upstreamKeyerId)
 		upstreamKeyer.onAir = this.properties.onAir

src/commands/MixEffects/Key/MixEffectKeyPatternCommand.ts

@@ -73,6 +73,10 @@ export class MixEffectKeyUpdateCommand extends DeserializedCommand<UpstreamKeyer
 	}
 
 	public applyToState (state: AtemState) {
+		if (!state.info.capabilities || this.mixEffect >= state.info.capabilities.mixEffects || this.upstreamKeyerId >= state.info.capabilities.upstreamKeyers) {
+			throw new Error(`UpstreamKeyer ${this.mixEffect}-${this.upstreamKeyerId} is not valid`)
+		}
+
 		const mixEffect = state.video.getMe(this.mixEffect)
 		const upstreamKeyer = mixEffect.getUpstreamKeyer(this.upstreamKeyerId)
 		upstreamKeyer.patternSettings = {

src/commands/MixEffects/Key/MixEffectKeyPropertiesGetCommand.ts

@@ -6,17 +6,20 @@ export class MixEffectKeyPropertiesGetCommand extends DeserializedCommand<Upstre
 	public static readonly rawName = 'KeBP'
 
 	public readonly mixEffect: number
+	public readonly upstreamKeyerId: number
 
-	constructor (mixEffect: number, properties: UpstreamKeyerBase) {
+	constructor (mixEffect: number, keyer: number, properties: UpstreamKeyerBase) {
 		super(properties)
 
 		this.mixEffect = mixEffect
+		this.upstreamKeyerId = keyer
 	}
 
 	public static deserialize (rawCommand: Buffer): MixEffectKeyPropertiesGetCommand {
 		const mixEffect = rawCommand[0]
+		const keyer = rawCommand[1]
 		const properties = {
-			upstreamKeyerId: rawCommand[1],
+			upstreamKeyerId: keyer,
 			mixEffectKeyType: rawCommand.readUInt8(2),
 			flyEnabled: rawCommand[5] === 1,
 			fillSource: rawCommand.readUInt16BE(6),
@@ -28,10 +31,14 @@ export class MixEffectKeyPropertiesGetCommand extends DeserializedCommand<Upstre
 			maskRight: rawCommand.readInt16BE(18)
 		}
 
-		return new MixEffectKeyPropertiesGetCommand(mixEffect, properties)
+		return new MixEffectKeyPropertiesGetCommand(mixEffect, keyer, properties)
 	}
 
 	public applyToState (state: AtemState) {
+		if (!state.info.capabilities || this.mixEffect >= state.info.capabilities.mixEffects || this.upstreamKeyerId >= state.info.capabilities.upstreamKeyers) {
+			throw new Error(`UpstreamKeyer ${this.mixEffect}-${this.upstreamKeyerId} is not valid`)
+		}
+
 		const mixEffect = state.video.getMe(this.mixEffect)
 		mixEffect.upstreamKeyers[this.properties.upstreamKeyerId] = {
 			...mixEffect.getUpstreamKeyer(this.properties.upstreamKeyerId),

src/commands/MixEffects/PreviewInputCommand.ts

@@ -45,6 +45,10 @@ export class PreviewInputUpdateCommand extends DeserializedCommand<InputSource>
 	}
 
 	public applyToState (state: AtemState) {
+		if (!state.info.capabilities || this.mixEffect >= state.info.capabilities.mixEffects) {
+			throw new Error(`MixEffect ${this.mixEffect} is not valid`)
+		}
+
 		const mixEffect = state.video.getMe(this.mixEffect)
 		mixEffect.previewInput = this.properties.source
 		return `video.ME.${this.mixEffect}.previewInput`

src/commands/MixEffects/ProgramInputCommand.ts

@@ -42,6 +42,10 @@ export class ProgramInputUpdateCommand extends DeserializedCommand<InputSource>
 	}
 
 	public applyToState (state: AtemState) {
+		if (!state.info.capabilities || this.mixEffect >= state.info.capabilities.mixEffects) {
+			throw new Error(`MixEffect ${this.mixEffect} is not valid`)
+		}
+
 		const mixEffect = state.video.getMe(this.mixEffect)
 		mixEffect.programInput = this.properties.source
 		return `video.ME.${this.mixEffect}.programInput`

src/commands/MixEffects/Transition/TransitionDVECommand.ts

@@ -85,6 +85,10 @@ export class TransitionDVEUpdateCommand extends DeserializedCommand<DVETransitio
 	}
 
 	public applyToState (state: AtemState) {
+		if (!state.info.capabilities || this.mixEffect >= state.info.capabilities.mixEffects) {
+			throw new Error(`MixEffect ${this.mixEffect} is not valid`)
+		}
+
 		const mixEffect = state.video.getMe(this.mixEffect)
 		mixEffect.transitionSettings.DVE = {
 			...this.properties

src/commands/MixEffects/Transition/TransitionDipCommand.ts

@@ -49,6 +49,10 @@ export class TransitionDipUpdateCommand extends DeserializedCommand<DipTransitio
 	}
 
 	public applyToState (state: AtemState) {
+		if (!state.info.capabilities || this.mixEffect >= state.info.capabilities.mixEffects) {
+			throw new Error(`MixEffect ${this.mixEffect} is not valid`)
+		}
+
 		const mixEffect = state.video.getMe(this.mixEffect)
 		mixEffect.transitionSettings.dip = {
 			...this.properties

src/commands/MixEffects/Transition/TransitionMixCommand.ts

@@ -42,6 +42,10 @@ export class TransitionMixUpdateCommand extends DeserializedCommand<MixTransitio
 	}
 
 	public applyToState (state: AtemState) {
+		if (!state.info.capabilities || this.mixEffect >= state.info.capabilities.mixEffects) {
+			throw new Error(`MixEffect ${this.mixEffect} is not valid`)
+		}
+
 		const mixEffect = state.video.getMe(this.mixEffect)
 		mixEffect.transitionSettings.mix = {
 			...this.properties