feat: adds new type and output metadata on pieces

src/tv2-common/actions/CoreActionExecutionContext.ts

@@ -197,10 +197,11 @@ export class CoreActionExecutionContext implements ITV2ActionExecutionContext {
 				this.modifiedParts.add('next')
 			}
 		}
-
-		piece.metaData = {
-			...piece.metaData,
-			modifiedByAction: true
+		if (piece.metaData) {
+			piece.metaData = {
+				...piece.metaData,
+				modifiedByAction: true
+			}
 		}
 
 		// Regardless of above, let core handle errors

src/tv2-common/actions/executeAction.ts

@@ -77,6 +77,8 @@ import {
 	TallyTags
 } from 'tv2-constants'
 import _ = require('underscore')
+import { Tv2OutputLayer } from '../../tv2-constants/tv2-output-layer'
+import { Tv2PieceType } from '../../tv2-constants/tv2-piece-type'
 import { EnableServer } from '../content'
 import { GetJinglePartPropertiesFromTableValue } from '../jinglePartProperties'
 import { CreateEffektForPartBase, CreateEffektForPartInner, CreateMixTransitionBlueprintPieceForPart } from '../parts'
@@ -557,6 +559,7 @@ async function executeActionSelectDVE<
 	const end = parsedCue.end ? calculateTime(parsedCue.end) : undefined
 
 	const metaData: DVEPieceMetaData = {
+		type: Tv2PieceType.SPLIT_SCREEN,
 		mediaPlayerSessions: dveContainsServer(parsedCue.sources) ? [externalId] : [],
 		sources: parsedCue.sources,
 		config: rawTemplate,
@@ -744,6 +747,7 @@ async function executeActionSelectDVELayout<
 		}
 
 		const newMetaData: DVEPieceMetaData = {
+			type: Tv2PieceType.SPLIT_SCREEN,
 			sources,
 			config: userData.config,
 			userData: {
@@ -1018,6 +1022,8 @@ async function executeActionCutToCamera<
 		sourceLayerId: settings.SourceLayers.Cam,
 		lifespan: PieceLifespan.WithinPart,
 		metaData: {
+			type: Tv2PieceType.CAMERA,
+			outputLayer: Tv2OutputLayer.PROGRAM,
 			sisyfosPersistMetaData: {
 				sisyfosLayers: [],
 				acceptsPersistedAudio: sourceInfoCam.acceptPersistAudio,
@@ -1228,6 +1234,8 @@ async function executeActionCutToRemote<
 		lifespan: PieceLifespan.WithinPart,
 		toBeQueued: true,
 		metaData: {
+			type: Tv2PieceType.REMOTE,
+			outputLayer: Tv2OutputLayer.PROGRAM,
 			sisyfosPersistMetaData
 		},
 		tags: [GetTagForLive(userData.sourceDefinition)],

src/tv2-common/cues/ekstern.ts

@@ -16,6 +16,8 @@ import {
 	TV2StudioConfigBase
 } from 'tv2-common'
 import { ControlClasses, SharedOutputLayer, SourceType } from 'tv2-constants'
+import { Tv2OutputLayer } from '../../tv2-constants/tv2-output-layer'
+import { Tv2PieceType } from '../../tv2-constants/tv2-piece-type'
 import { GetSisyfosTimelineObjForRemote } from '../helpers'
 import { GetTagForLive } from '../pieces'
 import { findSourceInfo } from '../sources'
@@ -58,6 +60,8 @@ export function EvaluateEksternBase<
 			toBeQueued: true,
 			lifespan: PieceLifespan.WithinPart,
 			metaData: {
+				type: Tv2PieceType.REMOTE,
+				outputLayer: Tv2OutputLayer.PROGRAM,
 				sisyfosPersistMetaData: {
 					sisyfosLayers: sourceInfoEkstern.sisyfosLayers ?? [],
 					wantsToPersistAudio: sourceInfoEkstern.wantsToPersistAudio,
@@ -95,6 +99,8 @@ export function EvaluateEksternBase<
 		lifespan: PieceLifespan.WithinPart,
 		toBeQueued: true,
 		metaData: {
+			type: Tv2PieceType.REMOTE,
+			outputLayer: Tv2OutputLayer.PROGRAM,
 			sisyfosPersistMetaData: {
 				sisyfosLayers: sourceInfoEkstern.sisyfosLayers ?? [],
 				wantsToPersistAudio: sourceInfoEkstern.wantsToPersistAudio,

src/tv2-common/cues/gfx-schema-generator.ts

@@ -9,6 +9,7 @@ import {
 	TV2ShowStyleConfig
 } from 'tv2-common'
 import { CueType, SharedGraphicLLayer, SharedOutputLayer, SharedSourceLayer } from 'tv2-constants'
+import { Tv2PieceType } from '../../tv2-constants/tv2-piece-type'
 import { DveLoopGenerator } from '../helpers/graphics/caspar/dve-loop-generator'
 
 const NON_BASELINE_SCHEMA = 'NON_BASELINE_SCHEMA'
@@ -64,7 +65,10 @@ export class GfxSchemaGenerator {
 				path: cue.schema,
 				ignoreMediaObjectStatus: true,
 				timelineObjects: this.createTimelineObjects(context, cue)
-			})
+			}),
+			metaData: {
+				type: Tv2PieceType.GRAPHICS
+			}
 		})
 	}
 

src/tv2-common/cues/lyd.ts

@@ -26,6 +26,8 @@ import {
 	SharedSisyfosLLayer,
 	SharedSourceLayer
 } from 'tv2-constants'
+import { Tv2OutputLayer } from '../../tv2-constants/tv2-output-layer'
+import { Tv2PieceType } from '../../tv2-constants/tv2-piece-type'
 import { TV2ShowStyleConfig } from '../blueprintConfig'
 
 export function EvaluateLYD(
@@ -71,6 +73,10 @@ export function EvaluateLYD(
 				? Math.max(1000, fadeIn ? getTimeFromFrames(fadeIn) : 0)
 				: getTimingEnable(parsedCue).enable.duration ?? undefined,
 			content: LydContent(context.config, file, lydType, fadeIn, fadeOut),
+			metaData: {
+				type: Tv2PieceType.AUDIO,
+				outputLayer: Tv2OutputLayer.AUDIO
+			},
 			tags: [AdlibTags.ADLIB_FLOW_PRODUCER]
 		})
 	} else {
@@ -90,7 +96,11 @@ export function EvaluateLYD(
 			outputLayerId: SharedOutputLayer.MUSIK,
 			sourceLayerId: SharedSourceLayer.PgmAudioBed,
 			lifespan,
-			content: LydContent(context.config, file, lydType, fadeIn, fadeOut)
+			content: LydContent(context.config, file, lydType, fadeIn, fadeOut),
+			metaData: {
+				type: Tv2PieceType.AUDIO,
+				outputLayer: Tv2OutputLayer.AUDIO
+			}
 		})
 	}
 }

src/tv2-common/cues/mixMinus.ts

@@ -1,6 +1,7 @@
 import { IBlueprintPiece, PieceLifespan, TSR } from 'blueprints-integration'
 import { CueDefinitionMixMinus, findSourceInfo, PartDefinition, ShowStyleContext, TemporalPriority } from 'tv2-common'
 import { ControlClasses, SharedOutputLayer, SharedSourceLayer, SwitcherAuxLLayer } from 'tv2-constants'
+import { Tv2PieceType } from '../../tv2-constants/tv2-piece-type'
 
 export function EvaluateCueMixMinus(
 	context: ShowStyleContext,
@@ -33,6 +34,9 @@ export function EvaluateCueMixMinus(
 		outputLayerId: SharedOutputLayer.AUX,
 		content: {
 			timelineObjects: [getMixMinusTimelineObject(context, switcherInput, MixMinusPriority.MINUSKAM_CUE)]
+		},
+		metaData: {
+			type: Tv2PieceType.AUDIO
 		}
 	})
 }

src/tv2-common/helpers/__tests__/serverResume.spec.ts

@@ -8,6 +8,7 @@ import {
 } from 'blueprints-integration'
 import { DVEPieceMetaData, literal, PieceMetaData, RemoteType, SourceDefinitionRemote } from 'tv2-common'
 import { SharedSourceLayer, SourceType } from 'tv2-constants'
+import { Tv2PieceType } from '../../../tv2-constants/tv2-piece-type'
 import { getServerPositionForPartInstance } from '../serverResume'
 
 const EKSTERN_SOURCE: SourceDefinitionRemote = {
@@ -122,7 +123,8 @@ describe('Server Resume', () => {
 							boxSourceConfiguration: [],
 							timelineObjects: []
 						}),
-						metaData: literal<Partial<DVEPieceMetaData>>({
+						metaData: literal<Partial<DVEPieceMetaData> & PieceMetaData>({
+							type: Tv2PieceType.SPLIT_SCREEN,
 							sources: {
 								INP1: { sourceType: SourceType.SERVER },
 								INP2: EKSTERN_SOURCE
@@ -168,7 +170,8 @@ describe('Server Resume', () => {
 							boxSourceConfiguration: [],
 							timelineObjects: []
 						}),
-						metaData: literal<Partial<DVEPieceMetaData>>({
+						metaData: literal<Partial<DVEPieceMetaData> & PieceMetaData>({
+							type: Tv2PieceType.SPLIT_SCREEN,
 							sources: {
 								INP1: { sourceType: SourceType.SERVER },
 								INP2: EKSTERN_SOURCE

src/tv2-common/helpers/dsk.ts

@@ -8,6 +8,7 @@ import {
 } from 'blueprints-integration'
 import { getDskLLayerName, literal, ShowStyleContext, SourceLayerAtemDSK, VideoSwitcher } from 'tv2-common'
 import { AdlibTags, DskRole, SharedOutputLayer } from 'tv2-constants'
+import { Tv2PieceType } from '../../tv2-constants/tv2-piece-type'
 import { ATEMModel } from '../../types/atem'
 import { TV2BlueprintConfigBase, TV2ShowStyleConfig, TV2StudioConfigBase } from '../blueprintConfig'
 import { TableConfigItemDSK } from '../types'
@@ -125,6 +126,9 @@ export function CreateDSKBaselineAdlibs(
 								}
 							})
 						]
+					},
+					metaData: {
+						type: Tv2PieceType.COMMAND
 					}
 				})
 			} else {
@@ -149,6 +153,9 @@ export function CreateDSKBaselineAdlibs(
 								}
 							})
 						]
+					},
+					metaData: {
+						type: Tv2PieceType.COMMAND
 					}
 				})
 			}

src/tv2-common/helpers/graphics/design/index.ts

@@ -16,6 +16,7 @@ import {
 	TV2ShowStyleConfig
 } from 'tv2-common'
 import { SharedGraphicLLayer, SharedOutputLayer, SharedSourceLayer } from 'tv2-constants'
+import { Tv2PieceType } from '../../../../tv2-constants/tv2-piece-type'
 
 const NON_BASELINE_DESIGN = 'NON_BASELINE_DESIGN'
 
@@ -53,7 +54,10 @@ function createDesignAdlibPiece(
 		sourceLayerId: SharedSourceLayer.PgmDesign,
 		// @ts-ignore
 		lifespan: cue.isFromField ? 'rundown-change-segment-lookback' : PieceLifespan.OutOnRundownChange,
-		content: createDesignPieceContent(context, cue)
+		content: createDesignPieceContent(context, cue),
+		metaData: {
+			type: Tv2PieceType.GRAPHICS
+		}
 	}
 }
 
@@ -73,7 +77,10 @@ function createDesignPiece(
 		sourceLayerId: SharedSourceLayer.PgmDesign,
 		// @ts-ignore
 		lifespan: cue.isFromField ? 'rundown-change-segment-lookback' : PieceLifespan.OutOnRundownChange,
-		content: createDesignPieceContent(context, cue)
+		content: createDesignPieceContent(context, cue),
+		metaData: {
+			type: Tv2PieceType.GRAPHICS
+		}
 	}
 }
 

src/tv2-common/helpers/graphics/internal/InternalGraphic.ts

@@ -13,7 +13,8 @@ import {
 } from 'tv2-common'
 import { AdlibTags, SharedOutputLayer, SharedSourceLayer } from 'tv2-constants'
 import * as _ from 'underscore'
-
+import { Tv2OutputLayer } from '../../../../tv2-constants/tv2-output-layer'
+import { Tv2PieceType } from '../../../../tv2-constants/tv2-piece-type'
 import { Graphic } from '../Graphic'
 
 export abstract class InternalGraphic extends Graphic {
@@ -59,7 +60,11 @@ export abstract class InternalGraphic extends Graphic {
 			lifespan: PieceLifespan.WithinPart,
 			expectedDuration: 5000,
 			tags: [AdlibTags.ADLIB_KOMMENTATOR],
-			content: _.clone(this.content)
+			content: _.clone(this.content),
+			metaData: {
+				type: Tv2PieceType.OVERLAY_GRAPHICS,
+				outputLayer: Tv2OutputLayer.OVERLAY
+			}
 		}
 	}
 
@@ -78,7 +83,11 @@ export abstract class InternalGraphic extends Graphic {
 						expectedDuration: this.getPieceEnable().duration
 				  }),
 			lifespan: this.getPieceLifespan(),
-			content: _.clone(this.content)
+			content: _.clone(this.content),
+			metaData: {
+				type: Tv2PieceType.GRAPHICS,
+				outputLayer: Tv2OutputLayer.OVERLAY
+			}
 		}
 	}
 
@@ -94,11 +103,13 @@ export abstract class InternalGraphic extends Graphic {
 			outputLayerId: this.outputLayerId,
 			sourceLayerId: this.sourceLayerId,
 			lifespan: this.getPieceLifespan(),
+			content: _.clone(this.content),
 			metaData: {
+				type: Tv2PieceType.GRAPHICS,
+				outputLayer: Tv2OutputLayer.OVERLAY,
 				partType: this.partDefinition?.type,
 				pieceExternalId: this.partDefinition?.externalId
-			},
-			content: _.clone(this.content)
+			}
 		}
 	}
 

src/tv2-common/helpers/graphics/pilot/PilotGraphicGenerator.ts

@@ -36,6 +36,8 @@ import {
 	SharedSourceLayer,
 	TallyTags
 } from 'tv2-constants'
+import { Tv2OutputLayer } from '../../../../tv2-constants/tv2-output-layer'
+import { Tv2PieceType } from '../../../../tv2-constants/tv2-piece-type'
 import { Graphic } from '../index'
 
 export interface PilotGraphicProps {
@@ -125,7 +127,11 @@ export abstract class PilotGraphicGenerator extends Graphic {
 			content: this.getContent(),
 			tags: IsTargetingFull(this.engine)
 				? [GetTagForFull(this.segmentExternalId, this.cue.graphic.vcpid), TallyTags.FULL_IS_LIVE]
-				: []
+				: [],
+			metaData: {
+				type: this.getTv2PieceType(),
+				outputLayer: this.getTv2OutputLayer()
+			}
 		}
 	}
 
@@ -158,6 +164,7 @@ export abstract class PilotGraphicGenerator extends Graphic {
 			sourceLayerId: SharedSourceLayer.SelectedAdlibGraphicsFull,
 			lifespan: PieceLifespan.OutOnSegmentEnd,
 			metaData: {
+				type: Tv2PieceType.GRAPHICS,
 				userData: {
 					type: AdlibActionType.SELECT_FULL_GRAFIK,
 					name: this.cue.graphic.name,
@@ -184,6 +191,33 @@ export abstract class PilotGraphicGenerator extends Graphic {
 			: this.config.studio.VizPilotGraphics.PrerollDuration
 	}
 
+	protected getTv2PieceType(): Tv2PieceType {
+		switch (this.engine) {
+			case 'OVL':
+				return Tv2PieceType.OVERLAY_GRAPHICS
+			case 'WALL':
+			case 'FULL':
+			case 'TLF':
+				return Tv2PieceType.GRAPHICS
+			default:
+				return Tv2PieceType.GRAPHICS
+		}
+	}
+
+	protected getTv2OutputLayer(): Tv2OutputLayer | undefined {
+		switch (this.engine) {
+			case 'WALL':
+				return undefined
+			case 'OVL':
+				return Tv2OutputLayer.OVERLAY
+			case 'FULL':
+			case 'TLF':
+				return Tv2OutputLayer.PROGRAM
+			default:
+				return undefined
+		}
+	}
+
 	protected getSourceLayer(): SharedSourceLayer {
 		switch (this.engine) {
 			case 'WALL':

src/tv2-common/onTimelineGenerate.ts

@@ -22,6 +22,8 @@ import {
 } from 'tv2-common'
 import { AbstractLLayer, PartType, SharedSisyfosLLayer, TallyTags } from 'tv2-constants'
 import * as _ from 'underscore'
+import { Tv2OutputLayer } from '../tv2-constants/tv2-output-layer'
+import { Tv2PieceType } from '../tv2-constants/tv2-piece-type'
 import { TV2BlueprintConfigBase, TV2StudioConfigBase } from './blueprintConfig'
 
 export interface PartEndStateExt {
@@ -58,6 +60,8 @@ export type TimelineBlueprintExt = TSR.TSRTimelineObjBase & {
 }
 
 export interface PieceMetaData {
+	type: Tv2PieceType
+	outputLayer?: Tv2OutputLayer
 	sisyfosPersistMetaData?: SisyfosPersistenceMetaData
 	mediaPlayerSessions?: string[]
 	modifiedByAction?: boolean