fix: compensate for piece preroll for adlibbed pieces SOFIE-3369 (#1236)

Author: Julusian

packages/corelib/src/playout/processAndPrune.ts

@@ -10,10 +10,18 @@ import { getPieceControlObjectId } from './ids'
 /**
  * Get the `enable: { start: ?? }` for the new piece in terms that can be used as an `end` for another object
  */
-function getPieceStartTime(newPieceStart: number | 'now', newPiece: PieceInstance): number | string {
+function getPieceStartTimeAsReference(newPieceStart: number | 'now', newPiece: PieceInstance): number | string {
 	return typeof newPieceStart === 'number' ? newPieceStart : `#${getPieceControlObjectId(newPiece)}.start`
 }
 
+function getPieceStartTimeWithinPart(p: PieceInstance): 'now' | number {
+	if (p.piece.enable.start === 'now' || !p.dynamicallyInserted) {
+		return p.piece.enable.start
+	} else {
+		return p.piece.enable.start + (p.piece.prerollDuration ?? 0)
+	}
+}
+
 function isClear(piece?: PieceInstance): boolean {
 	return !!piece?.piece.virtual
 }
@@ -85,7 +93,7 @@ export function processAndPrunePieceInstanceTimings(
 	for (const pieces of groupedPieces.values()) {
 		// Group and sort the pieces so that we can step through each point in time
 		const piecesByStart: Array<[number | 'now', PieceInstance[]]> = _.sortBy(
-			Array.from(groupByToMapFunc(pieces, (p) => p.piece.enable.start).entries()).map(([k, v]) =>
+			Array.from(groupByToMapFunc(pieces, (p) => getPieceStartTimeWithinPart(p)).entries()).map(([k, v]) =>
 				literal<[number | 'now', PieceInstance[]]>([k === 'now' ? 'now' : Number(k), v])
 			),
 			([k]) => (k === 'now' ? nowInPart : k)
@@ -120,7 +128,7 @@ function updateWithNewPieces(
 	if (newPiece) {
 		const activePiece = activePieces[key]
 		if (activePiece) {
-			activePiece.resolvedEndCap = getPieceStartTime(newPiecesStart, newPiece)
+			activePiece.resolvedEndCap = getPieceStartTimeAsReference(newPiecesStart, newPiece)
 		}
 		// track the new piece
 		activePieces[key] = newPiece
@@ -145,7 +153,7 @@ function updateWithNewPieces(
 					(newPiecesStart !== 0 || isCandidateBetterToBeContinued(activePieces.other, newPiece))
 				) {
 					// These modes should stop the 'other' when they start if not hidden behind a higher priority onEnd
-					activePieces.other.resolvedEndCap = getPieceStartTime(newPiecesStart, newPiece)
+					activePieces.other.resolvedEndCap = getPieceStartTimeAsReference(newPiecesStart, newPiece)
 					activePieces.other = undefined
 				}
 			}

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

@@ -1439,14 +1439,16 @@ describe('Timeline', () => {
 					// Simulate the piece timing confirmation from playout-gateway
 					await doSimulatePiecePlaybackTimings(playlistId, pieceOffset, 1)
 
+					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: pieceOffset,
+									end: pieceOffsetWithPreroll,
 								},
 								childGroup: {
 									preroll: 500,
@@ -1465,7 +1467,7 @@ describe('Timeline', () => {
 							[adlibbedPieceId]: {
 								// Our adlibbed piece
 								controlObj: {
-									start: pieceOffset,
+									start: pieceOffsetWithPreroll,
 								},
 								childGroup: {
 									preroll: 340,

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

@@ -93,10 +93,16 @@ export function getPieceEnableInsidePart(
 	partGroupId: string
 ): TSR.Timeline.TimelineEnable {
 	const pieceEnable: TSR.Timeline.TimelineEnable = { ...pieceInstance.piece.enable }
-	if (typeof pieceEnable.start === 'number' && !pieceInstance.dynamicallyInserted) {
-		// timed pieces should be offset based on the preroll of the part
-		pieceEnable.start += partTimings.toPartDelay
+	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
+		}
 	}
+
 	if (partTimings.toPartPostroll) {
 		if (!pieceEnable.duration) {
 			// make sure that the control object is shortened correctly