chore: skip keyer transitions if ME doesn't diff

Author: mint-dewit

src/resolvers/__tests__/downstreamKeyer.spec.ts

@@ -2,7 +2,7 @@ import { resolveDownstreamKeyerState } from '../downstreamKeyer'
 import { Commands, VideoState } from 'atem-connection'
 import * as Defaults from '../../defaults'
 import { jsonClone } from '../../util'
-import { DiffDownstreamKeyer } from '../../diff'
+import { DiffDownstreamKeyer, SectionsToDiff } from '../../diff'
 
 function setupDSK(props?: Partial<VideoState.DSK.DownstreamKeyer>): Required<VideoState.DSK.DownstreamKeyer> {
 	return jsonClone({
@@ -19,11 +19,13 @@ function setupDSK(props?: Partial<VideoState.DSK.DownstreamKeyer>): Required<Vid
 const DSK1 = [setupDSK(), setupDSK()]
 const DSK2 = [setupDSK(), setupDSK()]
 
-const fullDiff: Required<DiffDownstreamKeyer> = {
-	sources: true,
-	onAir: true,
-	properties: true,
-	mask: true,
+const fullDiff: SectionsToDiff['video'] & { downstreamKeyers: Required<DiffDownstreamKeyer> } = {
+	downstreamKeyers: {
+		sources: true,
+		onAir: true,
+		properties: true,
+		mask: true,
+	},
 }
 
 test('Unit: Downstream keyer: same state gives no commands', function () {
@@ -164,3 +166,14 @@ test('Unit: Downstream keyer: mask', function () {
 		right: 0,
 	}
 })
+
+test('Unit: Downstream keyer: onAir with tie returns doTransition', function () {
+	DSK2[0].properties.tie = true
+	DSK2[0].onAir = true
+	const { commands, doTransition } = resolveDownstreamKeyerState(DSK1, DSK2, {
+		...fullDiff,
+		mixEffects: { programPreview: true },
+	})
+	expect(doTransition).toBe(true)
+	expect(commands.filter((c) => c.constructor.name === 'DownstreamKeyOnAirCommand')).toHaveLength(0)
+})

src/resolvers/__tests__/mixEffect.spec.ts

@@ -89,7 +89,7 @@ test('Unit: mix effect: program + preview', function () {
 	ME2.programInput = 1
 	ME2.transition = Enums.TransitionStyle.CUT
 	const commands = ME.resolveMixEffectsState([ME1], [ME2], fullDiffObject) as Array<
-		Commands.PreviewInputCommand | Commands.PreviewInputCommand
+		Commands.ProgramInputCommand | Commands.PreviewInputCommand
 	>
 	expect(commands).toHaveLength(2)
 

src/resolvers/downstreamKeyer.ts

@@ -2,18 +2,23 @@ import { Commands as AtemCommands, VideoState } from 'atem-connection'
 import { PartialDeep } from 'type-fest'
 import * as Defaults from '../defaults'
 import { getAllKeysNumber, diffObject, fillDefaults } from '../util'
-import { DiffDownstreamKeyer } from '../diff'
+import { SectionsToDiff } from '../diff'
 
 export function resolveDownstreamKeyerState(
 	oldDsks: Array<PartialDeep<VideoState.DSK.DownstreamKeyer> | undefined> | undefined,
 	newDsks: Array<PartialDeep<VideoState.DSK.DownstreamKeyer> | undefined> | undefined,
-	diffOptions: DiffDownstreamKeyer | DiffDownstreamKeyer[]
+	diffOptions: SectionsToDiff['video']
 ): { commands: Array<AtemCommands.ISerializableCommand>; doTransition: boolean } {
+	const canUseMixEffectTransition =
+		(Array.isArray(diffOptions?.mixEffects) ? diffOptions?.mixEffects[0] : diffOptions?.mixEffects)?.programPreview ??
+		false
 	const commands: Array<AtemCommands.ISerializableCommand> = []
 	let doTransition = false
 
 	for (const index of getAllKeysNumber(oldDsks, newDsks)) {
-		const thisDiffOptions = Array.isArray(diffOptions) ? diffOptions[index] : diffOptions
+		const thisDiffOptions = Array.isArray(diffOptions?.downstreamKeyers)
+			? diffOptions?.downstreamKeyers[index]
+			: diffOptions?.downstreamKeyers
 
 		if (thisDiffOptions) {
 			const oldDsk = fillDefaults(Defaults.Video.DownstreamKeyer, oldDsks?.[index])
@@ -42,7 +47,7 @@ export function resolveDownstreamKeyerState(
 				if (!oldDsk.isAuto && newDsk.isAuto) {
 					commands.push(new AtemCommands.DownstreamKeyAutoCommand(index))
 				} else if (oldDsk.onAir !== newDsk.onAir) {
-					if (newDsk.properties?.tie) {
+					if (newDsk.properties?.tie && canUseMixEffectTransition) {
 						doTransition = true
 					} else {
 						const command = new AtemCommands.DownstreamKeyOnAirCommand(index, newDsk.onAir)

src/resolvers/index.ts

@@ -26,7 +26,7 @@ export function diffState(
 		const dskDiff = resolveDownstreamKeyerState(
 			oldState.video?.downstreamKeyers,
 			newState.video?.downstreamKeyers,
-			diffOptions.video.downstreamKeyers
+			diffOptions.video
 		)
 
 		commands.push(...dskDiff.commands)

src/resolvers/mixEffect.ts

@@ -48,11 +48,11 @@ export function resolveMixEffectsState(
 				mixEffectId,
 				oldMixEffect?.upstreamKeyers,
 				newMixEffect?.upstreamKeyers,
-				newMixEffect?.transitionProperties?.nextSelection,
+				thisDiffOptions.programPreview ? newMixEffect?.transitionProperties?.nextSelection : undefined,
 				thisDiffOptions.upstreamKeyers
 			)
 			commands.push(...uskDiff.commands)
-			doTransition = uskDiff.doTransition
+			doTransition = uskDiff.doTransition || dskTransition
 		}
 
 		if (thisDiffOptions.programPreview) {
@@ -63,7 +63,7 @@ export function resolveMixEffectsState(
 			const nextSelection =
 				newMixEffect?.transitionProperties?.nextSelection ?? Defaults.Video.TransitionProperties.nextSelection
 			const transitionIsBg =
-				nextSelection.length === 0 ||
+				nextSelection.length === 0 || // note - can't set empty array in atem so use defaults anyway
 				!!nextSelection?.find((layer) => layer === ConnectionEnums.TransitionSelection.Background)
 			doTransition = doTransition || (programInput !== oldProgramInput && transition !== Enums.TransitionStyle.CUT)