chore: refactoring

Author: Julusian

packages/job-worker/src/playout/timeline/part.ts

@@ -13,65 +13,34 @@ import { assertNever, literal } from '@sofie-automation/corelib/dist/lib'
 import { getPartGroupId, getPartFirstObjectId } from '@sofie-automation/corelib/dist/playout/ids'
 import { PieceInstanceWithTimings } from '@sofie-automation/corelib/dist/playout/processAndPrune'
 import { PieceTimelineMetadata } from './pieceGroup'
-import { PartCalculatedTimings } from '@sofie-automation/corelib/dist/playout/timings'
 import { JobContext } from '../../jobs'
 import { ReadonlyDeep } from 'type-fest'
 import { getPieceEnableInsidePart, transformPieceGroupAndObjects } from './piece'
 import { PlayoutChangedType } from '@sofie-automation/shared-lib/dist/peripheralDevice/peripheralDeviceAPI'
+import { SelectedPartInstanceTimelineInfo } from './generate'
+import { PartCalculatedTimings } from '@sofie-automation/corelib/dist/playout/timings'
 
 export function transformPartIntoTimeline(
 	context: JobContext,
 	playlistId: RundownPlaylistId,
 	pieceInstances: ReadonlyDeep<Array<PieceInstanceWithTimings>>,
 	pieceGroupFirstObjClasses: string[],
 	parentGroup: TimelineObjGroupPart & OnGenerateTimelineObjExt,
-	nowInParentGroup: number,
-	partTimings: PartCalculatedTimings,
-	isInHold: boolean,
-	outTransition: IBlueprintPartOutTransition | null
+	partInfo: SelectedPartInstanceTimelineInfo,
+	isInHold: boolean
 ): Array<TimelineObjRundown & OnGenerateTimelineObjExt> {
 	const span = context.startSpan('transformPartIntoTimeline')
+
+	const nowInParentGroup = partInfo.nowInPart
+	const partTimings = partInfo.calculatedTimings
+	const outTransition = partInfo.partInstance.part.outTransition ?? null
+
 	const timelineObjs: Array<TimelineObjRundown & OnGenerateTimelineObjExt> = []
 
 	for (const pieceInstance of pieceInstances) {
 		if (pieceInstance.disabled) continue
 
-		let pieceEnable: TSR.Timeline.TimelineEnable | undefined
-		switch (pieceInstance.piece.pieceType) {
-			case IBlueprintPieceType.InTransition:
-				if (typeof partTimings.inTransitionStart === 'number') {
-					// Respect the start time of the piece, in case there is a reason for it being non-zero
-					const startOffset =
-						typeof pieceInstance.piece.enable.start === 'number' ? pieceInstance.piece.enable.start : 0
-
-					pieceEnable = {
-						start: partTimings.inTransitionStart + startOffset,
-						duration: pieceInstance.piece.enable.duration,
-					}
-				}
-				break
-			case IBlueprintPieceType.OutTransition:
-				if (outTransition) {
-					pieceEnable = {
-						start: `#${parentGroup.id}.end - ${outTransition.duration}`,
-					}
-					if (partTimings.toPartPostroll) {
-						pieceEnable.start += ' - ' + partTimings.toPartPostroll
-					}
-				}
-				break
-			case IBlueprintPieceType.Normal:
-				pieceEnable = getPieceEnableInsidePart(
-					pieceInstance,
-					partTimings,
-					parentGroup.id,
-					parentGroup.enable.duration !== undefined || parentGroup.enable.end !== undefined
-				)
-				break
-			default:
-				assertNever(pieceInstance.piece.pieceType)
-				break
-		}
+		const pieceEnable = getPieceEnableForPieceInstance(partTimings, outTransition, parentGroup, pieceInstance)
 
 		// Not able to enable this piece
 		if (!pieceEnable) continue
@@ -94,6 +63,49 @@ export function transformPartIntoTimeline(
 	return timelineObjs
 }
 
+function getPieceEnableForPieceInstance(
+	partTimings: PartCalculatedTimings,
+	outTransition: IBlueprintPartOutTransition | null,
+	parentGroup: TimelineObjGroupPart & OnGenerateTimelineObjExt,
+	pieceInstance: ReadonlyDeep<PieceInstanceWithTimings>
+): TSR.Timeline.TimelineEnable | undefined {
+	switch (pieceInstance.piece.pieceType) {
+		case IBlueprintPieceType.InTransition: {
+			if (typeof partTimings.inTransitionStart !== 'number') return undefined
+			// Respect the start time of the piece, in case there is a reason for it being non-zero
+			const startOffset =
+				typeof pieceInstance.piece.enable.start === 'number' ? pieceInstance.piece.enable.start : 0
+
+			return {
+				start: partTimings.inTransitionStart + startOffset,
+				duration: pieceInstance.piece.enable.duration,
+			}
+		}
+		case IBlueprintPieceType.OutTransition: {
+			if (!outTransition) return undefined
+
+			const pieceEnable: TSR.Timeline.TimelineEnable = {
+				start: `#${parentGroup.id}.end - ${outTransition.duration}`,
+			}
+			if (partTimings.toPartPostroll) {
+				pieceEnable.start += ' - ' + partTimings.toPartPostroll
+			}
+
+			return pieceEnable
+		}
+		case IBlueprintPieceType.Normal:
+			return getPieceEnableInsidePart(
+				pieceInstance,
+				partTimings,
+				parentGroup.id,
+				parentGroup.enable.duration !== undefined || parentGroup.enable.end !== undefined
+			)
+		default:
+			assertNever(pieceInstance.piece.pieceType)
+			return undefined
+	}
+}
+
 export interface PartEnable {
 	start: number | 'now' | string
 	duration?: number

packages/job-worker/src/playout/timeline/pieceGroup.ts

@@ -42,8 +42,11 @@ export function createPieceGroupAndCap(
 	partGroup?: TimelineObjRundown,
 	pieceStartOffset?: number
 ): {
+	/** The 'control' object which defines the bounds of the group. This triggers the timing, and does not include and pre/postroll */
 	controlObj: TimelineObjPieceAbstract & OnGenerateTimelineObjExt<PieceTimelineMetadata>
+	/** The 'group' object that should contain all the content. This uses the control object for its timing, and adds the pre/postroll. */
 	childGroup: TimelineObjGroupRundown & OnGenerateTimelineObjExt<PieceTimelineMetadata>
+	/** Any additional objects which are used to determine points in time that the piece should start/end relative to. */
 	capObjs: Array<TimelineObjRundown & OnGenerateTimelineObjExt<PieceTimelineMetadata>>
 } {
 	const controlObj = literal<TimelineObjPieceAbstract & OnGenerateTimelineObjExt<PieceTimelineMetadata>>({