fix: take Part preroll into account when stopping a Piece with another Piece.

Previously Piece control objects end caps caused Pieces to end prematurely.
This changes how start times of adlibbed Pieces gets stored, to keep everything in a pre-preroll-adjusted timespace.

Co authored by Julian Waller <[email protected]>

Author: nytamin

packages/corelib/src/playout/processAndPrune.ts

@@ -15,15 +15,7 @@ function getPieceStartTimeAsReference(newPieceStart: number | 'now'): number | R
 }
 
 function getPieceStartTimeWithinPart(p: ReadonlyDeep<PieceInstance>): 'now' | number {
-	// If the piece is dynamically inserted, then its preroll should be factored into its start time, but not for any infinite continuations
-	const isStartOfAdlib =
-		!!p.dynamicallyInserted && !(p.infinite?.fromPreviousPart || p.infinite?.fromPreviousPlayhead)
-
-	if (isStartOfAdlib && p.piece.enable.start !== 'now') {
-		return p.piece.enable.start + (p.piece.prerollDuration ?? 0)
-	} else {
-		return p.piece.enable.start
-	}
+	return p.piece.enable.start
 }
 
 function isClear(piece?: ReadonlyDeep<PieceInstance>): boolean {

packages/job-worker/src/playout/__tests__/timeline.test.ts

@@ -1285,8 +1285,9 @@ describe('Timeline', () => {
 					})
 
 					const pieceOffset = 12560
+
 					// Simulate the piece timing confirmation from playout-gateway
-					await doSimulatePiecePlaybackTimings(playlistId, pieceOffset, 2)
+					await doSimulatePiecePlaybackTimings(playlistId, pieceOffset, 2) // This pieceOffset includes the partPreroll
 
 					// Now we have a concrete time
 					await checkTimings({
@@ -1456,16 +1457,14 @@ describe('Timeline', () => {
 					// Simulate the piece timing confirmation from playout-gateway
 					await doSimulatePiecePlaybackTimings(playlistId, pieceOffset, 2)
 
-					const pieceOffsetWithPreroll = pieceOffset + 340
-
 					// Now we have a concrete time
 					await checkTimings({
 						previousPart: null,
 						currentPieces: {
 							piece000: {
 								controlObj: {
 									start: 500, // This one gave the preroll
-									end: pieceOffsetWithPreroll,
+									end: pieceOffset,
 								},
 								childGroup: {
 									preroll: 500,
@@ -1484,7 +1483,7 @@ describe('Timeline', () => {
 							[adlibbedPieceId]: {
 								// Our adlibbed piece
 								controlObj: {
-									start: pieceOffsetWithPreroll,
+									start: pieceOffset,
 								},
 								childGroup: {
 									preroll: 340,

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

@@ -539,7 +539,7 @@ describe('Pieces', () => {
 				classes: [],
 				enable: {
 					...enable,
-					end: 400,
+					end: 600,
 				},
 			})
 		})

packages/job-worker/src/playout/timeline/multi-gateway.ts

@@ -225,14 +225,15 @@ function deNowifyCurrentPieces(
 	const objectsNotDeNowified: TimelineObjRundown[] = []
 	// The relative time for 'now' to be resolved to, inside of the part group
 	const nowInPart = targetNowTime - currentPartGroupStartTime
+	const nowInPartWithoutPreroll = nowInPart - (currentPartInstance.partInstance.partPlayoutTimings?.toPartDelay ?? 0)
 
 	// Ensure any pieces in the currentPartInstance have their now replaced
 	for (const pieceInstance of currentPartInstance.pieceInstances) {
 		if (pieceInstance.pieceInstance.piece.enable.start === 'now') {
 			pieceInstance.updatePieceProps({
 				enable: {
 					...pieceInstance.pieceInstance.piece.enable,
-					start: nowInPart,
+					start: nowInPartWithoutPreroll,
 				},
 			})
 		}

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

@@ -66,7 +66,7 @@ export function transformPartIntoTimeline(
 				nowInParentGroup,
 				pieceInstance,
 				pieceEnable,
-				0,
+				pieceInstance.dynamicallyInserted ? 0 : partTimings.toPartDelay,
 				pieceGroupFirstObjClasses,
 				isInHold,
 				false

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

@@ -95,13 +95,8 @@ export function getPieceEnableInsidePart(
 ): TSR.Timeline.TimelineEnable {
 	const pieceEnable: TSR.Timeline.TimelineEnable = { ...pieceInstance.piece.enable }
 	if (typeof pieceEnable.start === 'number') {
-		if (pieceInstance.dynamicallyInserted) {
-			// timed adlibbed pieces needs to factor in their preroll
-			pieceEnable.start += pieceInstance.piece.prerollDuration || 0
-		} else {
-			// timed planned pieces should be offset based on the preroll of the part
-			pieceEnable.start += partTimings.toPartDelay
-		}
+		// pieces should be offset based on the preroll of the part
+		pieceEnable.start += partTimings.toPartDelay
 	}
 
 	// If the part has an end time, we can consider post-roll

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

@@ -136,7 +136,7 @@ export function createPieceGroupAndCap(
 	let resolvedEndCap: number | string | undefined
 	// If the start has been adjusted, the end needs to be updated to compensate
 	if (typeof pieceInstance.resolvedEndCap === 'number') {
-		resolvedEndCap = pieceInstance.resolvedEndCap - (pieceStartOffset ?? 0)
+		resolvedEndCap = pieceInstance.resolvedEndCap + (pieceStartOffset ?? 0)
 	} else if (pieceInstance.resolvedEndCap) {
 		// TODO - there could already be a piece with a cap of 'now' that we could use as our end time
 		// As the cap is for 'now', rather than try to get tsr to understand `end: 'now'`, we can create a 'now' object to tranlate it

packages/job-worker/src/playout/timings/timelineTriggerTime.ts

@@ -13,6 +13,7 @@ import { PieceTimelineMetadata } from '../timeline/pieceGroup'
 import { deserializeTimelineBlob } from '@sofie-automation/corelib/dist/dataModel/Timeline'
 import { ReadonlyDeep } from 'type-fest'
 import { AnyBulkWriteOperation } from 'mongodb'
+import { DBPartInstance } from '@sofie-automation/corelib/dist/dataModel/PartInstance'
 
 /**
  * Called from Playout-gateway when the trigger-time of a timeline object has updated
@@ -40,20 +41,38 @@ export async function handleTimelineTriggerTime(context: JobContext, data: OnTim
 						(id): id is PartInstanceId => id !== null
 					)
 
-					// We only need the PieceInstances, so load just them
-					const pieceInstances = await context.directCollections.PieceInstances.findFetch({
-						rundownId: { $in: rundownIDs },
-						partInstanceId: {
-							$in: partInstanceIDs,
-						},
-					})
+					// We only need the PieceInstances and PartInstances, so load just them
+					const [pieceInstances, partInstances] = await Promise.all([
+						context.directCollections.PieceInstances.findFetch({
+							rundownId: { $in: rundownIDs },
+							partInstanceId: {
+								$in: partInstanceIDs,
+							},
+						}),
+						context.directCollections.PartInstances.findFetch(
+							{
+								rundownId: { $in: rundownIDs },
+								_id: {
+									$in: partInstanceIDs,
+								},
+							},
+							{
+								projection: {
+									_id: 1,
+									partPlayoutTimings: 1,
+								},
+							}
+						) as Promise<Array<Pick<DBPartInstance, '_id' | 'partPlayoutTimings'>>>,
+					])
 					const pieceInstancesMap = normalizeArrayToMap(pieceInstances, '_id')
+					const partInstanceMap = normalizeArrayToMap(partInstances, '_id')
 
 					// Take ownership of the playlist in the db, so that we can mutate the timeline and piece instances
 					const changes = timelineTriggerTimeInner(
 						context,
 						studioCache,
 						data.results,
+						partInstanceMap,
 						pieceInstancesMap,
 						activePlaylist
 					)
@@ -62,7 +81,7 @@ export async function handleTimelineTriggerTime(context: JobContext, data: OnTim
 				})
 			} else {
 				// No playlist is active. no extra lock needed
-				timelineTriggerTimeInner(context, studioCache, data.results, undefined, undefined)
+				timelineTriggerTimeInner(context, studioCache, data.results, undefined, undefined, undefined)
 			}
 		})
 	}
@@ -107,6 +126,7 @@ function timelineTriggerTimeInner(
 	context: JobContext,
 	studioPlayoutModel: StudioPlayoutModel,
 	results: OnTimelineTriggerTimeProps['results'],
+	partInstances: Map<PartInstanceId, Pick<DBPartInstance, '_id' | 'partPlayoutTimings'>> | undefined,
 	pieceInstances: Map<PieceInstanceId, PieceInstance> | undefined,
 	activePlaylist: ReadonlyDeep<DBRundownPlaylist> | undefined
 ) {
@@ -142,7 +162,7 @@ function timelineTriggerTimeInner(
 
 				const objPieceInstanceId = (obj.metaData as Partial<PieceTimelineMetadata> | undefined)
 					?.triggerPieceInstanceId
-				if (objPieceInstanceId && activePlaylist && pieceInstances) {
+				if (objPieceInstanceId && activePlaylist && pieceInstances && partInstances) {
 					logger.debug('Update PieceInstance: ', {
 						pieceId: objPieceInstanceId,
 						time: new Date(o.time).toTimeString(),
@@ -154,8 +174,12 @@ function timelineTriggerTimeInner(
 						pieceInstance.dynamicallyInserted !== undefined &&
 						pieceInstance.piece.enable.start === 'now'
 					) {
-						pieceInstance.piece.enable.start = o.time
-						changes.setStartTime.set(pieceInstance._id, o.time)
+						const partPrerollDuration =
+							partInstances.get(pieceInstance.partInstanceId)?.partPlayoutTimings?.toPartDelay ?? 0
+
+						const adjustedStartTime = o.time - partPrerollDuration
+						pieceInstance.piece.enable.start = adjustedStartTime
+						changes.setStartTime.set(pieceInstance._id, adjustedStartTime)
 
 						const takeTime = pieceInstance.dynamicallyInserted
 						lastTakeTime = lastTakeTime === undefined ? takeTime : Math.max(lastTakeTime, takeTime)