feat: fly key settings (#28)

Author: mint-dewit

src/defaults/video.ts

@@ -239,6 +239,13 @@ export function flyKeyframe(id: number): VideoState.USK.UpstreamKeyerFlyKeyframe
 	}
 }
 
+export const FlyKeyProperties: VideoState.USK.UpstreamKeyerFlySettings = {
+	isASet: false,
+	isBSet: false,
+	isAtKeyFrame: Enums.IsAtKeyFrame.None,
+	runToInfiniteIndex: Enums.FlyKeyDirection.CentreOfKey,
+}
+
 export const SuperSourceBox: VideoState.SuperSource.SuperSourceBox = {
 	enabled: false,
 	source: defaultInput,

src/diff.ts

@@ -48,6 +48,7 @@ export function DiffAllObject(): DeepComplete<SectionsToDiff> {
 					mask: true,
 
 					flyKeyframes: 'all',
+					flyProperties: true,
 					dveSettings: true,
 					chromaSettings: true,
 					advancedChromaSettings: true,
@@ -162,6 +163,7 @@ export interface DiffUpstreamKeyer {
 	mask?: boolean
 
 	flyKeyframes?: number[] | 'all'
+	flyProperties?: boolean
 	dveSettings?: boolean
 	chromaSettings?: boolean
 	advancedChromaSettings?: boolean

src/resolvers/upstreamKeyers/flyKey.ts

@@ -1,18 +1,18 @@
-import { Commands as AtemCommands, VideoState } from 'atem-connection'
+import { Commands as AtemCommands, Enums, VideoState } from 'atem-connection'
 import { diffObject, fillDefaults, getAllKeysNumber } from '../../util'
 import * as Defaults from '../../defaults'
 import { PartialDeep } from 'type-fest'
 
-type FlyFrmaesState = [
+type FlyFramesState = [
 	VideoState.USK.UpstreamKeyerFlyKeyframe | undefined,
 	VideoState.USK.UpstreamKeyerFlyKeyframe | undefined
 ]
 
 export function resolveFlyKeyerFramesState(
 	mixEffectId: number,
 	upstreamKeyerId: number,
-	oldState: PartialDeep<FlyFrmaesState>,
-	newState: PartialDeep<FlyFrmaesState>,
+	oldState: PartialDeep<FlyFramesState>,
+	newState: PartialDeep<FlyFramesState>,
 	diffOptions: number[] | 'all'
 ): Array<AtemCommands.ISerializableCommand> {
 	const commands: Array<AtemCommands.ISerializableCommand> = []
@@ -32,3 +32,27 @@ export function resolveFlyKeyerFramesState(
 
 	return commands
 }
+
+export function resolveFlyPropertiesState(
+	mixEffectId: number,
+	upstreamKeyerId: number,
+	oldState: Partial<VideoState.USK.UpstreamKeyerFlySettings> | undefined,
+	newState: PartialDeep<VideoState.USK.UpstreamKeyerFlySettings> | undefined
+): Array<AtemCommands.ISerializableCommand> {
+	const commands: Array<AtemCommands.ISerializableCommand> = []
+
+	if (!oldState && !newState) return commands
+
+	const oldKeyProps = fillDefaults(Defaults.Video.FlyKeyProperties, oldState)
+	const newKeyProps = fillDefaults(Defaults.Video.FlyKeyProperties, newState)
+
+	if (oldKeyProps.isAtKeyFrame !== newKeyProps.isAtKeyFrame) {
+		const keyframe: Enums.FlyKeyKeyFrame = newKeyProps.isAtKeyFrame as number
+
+		commands.push(
+			new AtemCommands.MixEffectKeyRunToCommand(mixEffectId, upstreamKeyerId, keyframe, newKeyProps.runToInfiniteIndex)
+		)
+	}
+
+	return commands
+}

src/resolvers/upstreamKeyers/index.ts

@@ -6,7 +6,7 @@ import { resolvePatternKeyerState } from './patternKeyer'
 import { getAllKeysNumber, diffObject, fillDefaults } from '../../util'
 import { PartialDeep } from 'type-fest'
 import * as Defaults from '../../defaults'
-import { resolveFlyKeyerFramesState } from './flyKey'
+import { resolveFlyKeyerFramesState, resolveFlyPropertiesState } from './flyKey'
 import { DiffUpstreamKeyer } from '../../diff'
 
 export function resolveUpstreamKeyerState(
@@ -43,6 +43,11 @@ export function resolveUpstreamKeyerState(
 				)
 			)
 		}
+		if (thisDiffOptions.flyProperties) {
+			commands.push(
+				...resolveFlyPropertiesState(mixEffectId, upstreamKeyerId, oldKeyer.flyProperties, newKeyer.flyProperties)
+			)
+		}
 
 		if (thisDiffOptions.chromaSettings) {
 			commands.push(