Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Set Keyframe actions #317

Merged
merged 4 commits into from
Sep 10, 2024
Merged

feat: Set Keyframe actions #317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
543d4d2
added set keyframe commands
yournamehere Sep 3, 2024
077f605
added learn for set keyframe
yournamehere Sep 4, 2024
46104eb
Merge branch 'bitfocus:main' into main
yournamehere Sep 7, 2024
c9c9056
formatting
yournamehere Sep 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/actions/ActionId.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ export enum ActionId {
USKFly = 'uskFly',
USKMaskLumaChromaPattern = 'uskMaskLumaChromaPattern',
USKDVEProperties = 'uskDveProperties',
USKSetKeyframe = 'uskSetKeyframe',
USKStoreKeyframe = 'uskStoreKeyframe',
USKFlyInfinite = 'uskFlyInfinite',
DSKSource = 'dskSource',
DSKSourceVariables = 'dskSourceVariables',
Expand Down
219 changes: 216 additions & 3 deletions src/actions/mixeffect/upstreamKeyerDVE.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,19 @@
import { Enums, type Atem } from 'atem-connection'
import { AtemMEPicker, AtemUSKDVEPropertiesPickers, AtemUSKPicker } from '../../input.js'
import {
AtemMEPicker,
AtemUSKDVEPropertiesPickers,
AtemUSKPicker,
AtemUSKKeyframePropertiesPickers,
} from '../../input.js'
import type { ModelSpec } from '../../models/index.js'
import { ActionId } from '../ActionId.js'
import type { MyActionDefinitions } from '../types.js'
import { CHOICES_FLYDIRECTIONS, CHOICES_KEYFRAMES } from '../../choices.js'
import { CHOICES_FLYDIRECTIONS, CHOICES_KEYFRAMES, CHOICES_KEYFRAMES_CONFIGURABLE } from '../../choices.js'
import { getUSK, type StateWrapper } from '../../state.js'
import type { UpstreamKeyerDVESettings } from 'atem-connection/dist/state/video/upstreamKeyers.js'
import type {
UpstreamKeyerDVESettings,
UpstreamKeyerFlyKeyframe,
} from 'atem-connection/dist/state/video/upstreamKeyers.js'

export interface AtemUpstreamKeyerDVEActions {
[ActionId.USKDVEProperties]: {
Expand Down Expand Up @@ -68,6 +76,64 @@ export interface AtemUpstreamKeyerDVEActions {
borderBevelSoftness: number
rate: number
}
[ActionId.USKSetKeyframe]: {
mixeffect: number
key: number
keyframe: Enums.FlyKeyKeyFrame.A | Enums.FlyKeyKeyFrame.B

properties: Array<
| 'positionX'
| 'positionY'
| 'sizeX'
| 'sizeY'
| 'rotation'
| 'maskTop'
| 'maskBottom'
| 'maskLeft'
| 'maskRight'
| 'shadowEnabled'
| 'lightSourceDirection'
| 'lightSourceAltitude'
| 'borderEnabled'
| 'borderHue'
| 'borderSaturation'
| 'borderLuma'
| 'borderOuterWidth'
| 'borderInnerWidth'
| 'borderOuterSoftness'
| 'borderInnerSoftness'
| 'borderOpacity'
| 'borderBevelPosition'
| 'borderBevelSoftness'
>

positionX: number
positionY: number
sizeX: number
sizeY: number
rotation: number
maskTop: number
maskBottom: number
maskLeft: number
maskRight: number
lightSourceDirection: number
lightSourceAltitude: number
borderHue: number
borderSaturation: number
borderLuma: number
borderOuterWidth: number
borderInnerWidth: number
borderOuterSoftness: number
borderInnerSoftness: number
borderOpacity: number
borderBevelPosition: number
borderBevelSoftness: number
}
[ActionId.USKStoreKeyframe]: {
mixeffect: number
key: number
keyframe: Enums.FlyKeyKeyFrame.A | Enums.FlyKeyKeyFrame.B
}
[ActionId.USKFly]: {
mixeffect: number
key: number
Expand All @@ -88,6 +154,8 @@ export function createUpstreamKeyerDVEActions(
if (!model.USKs || !model.DVEs) {
return {
[ActionId.USKDVEProperties]: undefined,
[ActionId.USKSetKeyframe]: undefined,
[ActionId.USKStoreKeyframe]: undefined,
[ActionId.USKFly]: undefined,
[ActionId.USKFlyInfinite]: undefined,
}
Expand Down Expand Up @@ -230,6 +298,151 @@ export function createUpstreamKeyerDVEActions(
}
},
},
[ActionId.USKSetKeyframe]: {
name: 'Upstream key: Set Keyframe from values',
options: {
mixeffect: AtemMEPicker(model, 0),
key: AtemUSKPicker(model),
keyframe: {
type: 'dropdown',
id: 'keyframe',
label: 'Key Frame',
choices: CHOICES_KEYFRAMES_CONFIGURABLE,
default: CHOICES_KEYFRAMES_CONFIGURABLE[0].id,
},
...AtemUSKKeyframePropertiesPickers(),
},
callback: async ({ options }) => {
const mixEffectId = options.getPlainNumber('mixeffect')
const keyId = options.getPlainNumber('key')
const keyframeId = options.getPlainNumber('keyframe')
const properties: Partial<UpstreamKeyerFlyKeyframe> = {}

const props = options.getRaw('properties')
if (props && Array.isArray(props)) {
if (props.includes('maskTop')) {
properties.maskTop = options.getPlainNumber('maskTop') * 1000
}
if (props.includes('maskBottom')) {
properties.maskBottom = options.getPlainNumber('maskBottom') * 1000
}
if (props.includes('maskLeft')) {
properties.maskLeft = options.getPlainNumber('maskLeft') * 1000
}
if (props.includes('maskRight')) {
properties.maskRight = options.getPlainNumber('maskRight') * 1000
}
if (props.includes('sizeX')) {
properties.sizeX = options.getPlainNumber('sizeX') * 1000
}
if (props.includes('sizeY')) {
properties.sizeY = options.getPlainNumber('sizeY') * 1000
}
if (props.includes('positionX')) {
properties.positionX = options.getPlainNumber('positionX') * 1000
}
if (props.includes('positionY')) {
properties.positionY = options.getPlainNumber('positionY') * 1000
}
if (props.includes('rotation')) {
properties.rotation = options.getPlainNumber('rotation')
}
if (props.includes('borderOuterWidth')) {
properties.borderOuterWidth = options.getPlainNumber('borderOuterWidth') * 100
}
if (props.includes('borderInnerWidth')) {
properties.borderInnerWidth = options.getPlainNumber('borderInnerWidth') * 100
}
if (props.includes('borderOuterSoftness')) {
properties.borderOuterSoftness = options.getPlainNumber('borderOuterSoftness')
}
if (props.includes('borderInnerSoftness')) {
properties.borderInnerSoftness = options.getPlainNumber('borderInnerSoftness')
}
if (props.includes('borderBevelSoftness')) {
properties.borderBevelSoftness = options.getPlainNumber('borderBevelSoftness')
}
if (props.includes('borderBevelPosition')) {
properties.borderBevelPosition = options.getPlainNumber('borderBevelPosition')
}
if (props.includes('borderOpacity')) {
properties.borderOpacity = options.getPlainNumber('borderOpacity')
}
if (props.includes('borderHue')) {
properties.borderHue = options.getPlainNumber('borderHue') * 10
}
if (props.includes('borderSaturation')) {
properties.borderSaturation = options.getPlainNumber('borderSaturation') * 10
}
if (props.includes('borderLuma')) {
properties.borderLuma = options.getPlainNumber('borderLuma') * 10
}
if (props.includes('lightSourceDirection')) {
properties.lightSourceDirection = options.getPlainNumber('lightSourceDirection') * 10
}
if (props.includes('lightSourceAltitude')) {
properties.lightSourceAltitude = options.getPlainNumber('lightSourceAltitude')
}
}

if (Object.keys(properties).length === 0) return

await atem?.setUpstreamKeyerFlyKeyKeyframe(mixEffectId, keyId, keyframeId, properties)
},
learn: ({ options }) => {
const usk = getUSK(state.state, options.getPlainNumber('mixeffect'), options.getPlainNumber('key'))

if (usk?.dveSettings) {
return {
...options.getJson(),
maskTop: usk.dveSettings.maskTop / 1000,
maskBottom: usk.dveSettings.maskBottom / 1000,
maskLeft: usk.dveSettings.maskLeft / 1000,
maskRight: usk.dveSettings.maskRight / 1000,
sizeX: usk.dveSettings.sizeX / 1000,
sizeY: usk.dveSettings.sizeY / 1000,
positionX: usk.dveSettings.positionX / 1000,
positionY: usk.dveSettings.positionY / 1000,
rotation: usk.dveSettings.rotation,
borderOuterWidth: usk.dveSettings.borderOuterWidth / 100,
borderInnerWidth: usk.dveSettings.borderInnerWidth / 100,
borderOuterSoftness: usk.dveSettings.borderOuterSoftness,
borderInnerSoftness: usk.dveSettings.borderInnerSoftness,
borderBevelSoftness: usk.dveSettings.borderBevelSoftness,
borderBevelPosition: usk.dveSettings.borderBevelPosition,
borderOpacity: usk.dveSettings.borderOpacity,
borderHue: usk.dveSettings.borderHue / 10,
borderSaturation: usk.dveSettings.borderSaturation / 10,
borderLuma: usk.dveSettings.borderLuma / 10,
lightSourceDirection: usk.dveSettings.lightSourceDirection / 10,
lightSourceAltitude: usk.dveSettings.lightSourceAltitude,
}
} else {
return undefined
}
},
},
[ActionId.USKStoreKeyframe]: {
name: 'Upstream key: Set keyframe from current key state',
options: {
mixeffect: AtemMEPicker(model, 0),
key: AtemUSKPicker(model),
keyframe: {
type: 'dropdown',
id: 'keyframe',
label: 'Key Frame',
choices: CHOICES_KEYFRAMES_CONFIGURABLE,
default: CHOICES_KEYFRAMES_CONFIGURABLE[0].id,
},
},
callback: async ({ options }) => {
await atem?.storeUpstreamKeyerFlyKeyKeyframe(
options.getPlainNumber('mixeffect'),
options.getPlainNumber('key'),
options.getPlainNumber('keyframe'),
)
},
},
[ActionId.USKFly]: {
name: 'Upstream key: fly to keyframe',
options: {
Expand Down
5 changes: 5 additions & 0 deletions src/choices.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,11 @@ export const CHOICES_KEYFRAMES: MyDropdownChoice<
{ id: Enums.FlyKeyKeyFrame.Full, label: 'Full' },
]

export const CHOICES_KEYFRAMES_CONFIGURABLE: MyDropdownChoice<Enums.FlyKeyKeyFrame.A | Enums.FlyKeyKeyFrame.B>[] = [
{ id: Enums.FlyKeyKeyFrame.A, label: 'A' },
{ id: Enums.FlyKeyKeyFrame.B, label: 'B' },
]

export const CHOICES_CURRENTKEYFRAMES: MyDropdownChoice<
Enums.IsAtKeyFrame.A | Enums.IsAtKeyFrame.B | Enums.IsAtKeyFrame.RunToInfinite
>[] = [
Expand Down
Loading