feat: exclude pieces from part keepalive

bbc · Jan 8, 2025 · 74bea6c · 74bea6c
1 parent 997e111
commit 74bea6c
Show file tree

Hide file tree

Showing 10 changed files with 3,322 additions and 22 deletions.
diff --git a/packages/blueprints-integration/src/documents/piece.ts b/packages/blueprints-integration/src/documents/piece.ts
@@ -35,6 +35,11 @@ export interface IBlueprintPiece<TPrivateData = unknown, TPublicData = unknown>
 	 * User editing definitions for this piece
 	 */
 	userEditOperations?: UserEditingDefinition[]
+
+	/**
+	 * Whether to stop this piece before the 'keepalive' period of the part
+	 */
+	excludeDuringPartKeepalive?: boolean
 }
 export interface IBlueprintPieceDB<TPrivateData = unknown, TPublicData = unknown>
 	extends IBlueprintPiece<TPrivateData, TPublicData> {

diff --git a/packages/corelib/src/playout/__tests__/timings.test.ts b/packages/corelib/src/playout/__tests__/timings.test.ts
@@ -80,6 +80,7 @@ describe('Part Playout Timings', () => {
 							fromPartRemaining: 0,
 							fromPartPostroll: 0,
 							toPartPostroll: 0,
+							fromPartKeepalive: 0,
 						})
 					)
 				})
@@ -102,6 +103,7 @@ describe('Part Playout Timings', () => {
 							fromPartRemaining: 0,
 							fromPartPostroll: 0,
 							toPartPostroll: 0,
+							fromPartKeepalive: 0,
 						})
 					)
 				})
@@ -124,6 +126,7 @@ describe('Part Playout Timings', () => {
 							fromPartRemaining: 231,
 							fromPartPostroll: 231,
 							toPartPostroll: 0,
+							fromPartKeepalive: 0,
 						})
 					)
 				})
@@ -146,6 +149,7 @@ describe('Part Playout Timings', () => {
 							fromPartRemaining: 289,
 							fromPartPostroll: 0,
 							toPartPostroll: 0,
+							fromPartKeepalive: 0,
 						})
 					)
 				})
@@ -168,6 +172,7 @@ describe('Part Playout Timings', () => {
 							fromPartRemaining: 231 + 289,
 							fromPartPostroll: 231,
 							toPartPostroll: 0,
+							fromPartKeepalive: 0,
 						})
 					)
 				})
@@ -191,6 +196,7 @@ describe('Part Playout Timings', () => {
 							fromPartRemaining: 452,
 							fromPartPostroll: 0,
 							toPartPostroll: 0,
+							fromPartKeepalive: 452,
 						})
 					)
 				})
@@ -214,6 +220,7 @@ describe('Part Playout Timings', () => {
 							fromPartRemaining: 231 + 452,
 							fromPartPostroll: 231,
 							toPartPostroll: 0,
+							fromPartKeepalive: 452,
 						})
 					)
 				})
@@ -238,6 +245,7 @@ describe('Part Playout Timings', () => {
 							fromPartRemaining: 452,
 							fromPartPostroll: 0,
 							toPartPostroll: 0,
+							fromPartKeepalive: 452,
 						})
 					)
 				})
@@ -262,6 +270,7 @@ describe('Part Playout Timings', () => {
 							fromPartRemaining: 231 + 452,
 							fromPartPostroll: 231,
 							toPartPostroll: 0,
+							fromPartKeepalive: 452,
 						})
 					)
 				})
@@ -286,6 +295,7 @@ describe('Part Playout Timings', () => {
 							fromPartRemaining: 2256,
 							fromPartPostroll: 0,
 							toPartPostroll: 0,
+							fromPartKeepalive: 452,
 						})
 					)
 				})
@@ -310,6 +320,7 @@ describe('Part Playout Timings', () => {
 							fromPartRemaining: 231 + 2256,
 							fromPartPostroll: 231,
 							toPartPostroll: 0,
+							fromPartKeepalive: 452,
 						})
 					)
 				})
@@ -331,6 +342,7 @@ describe('Part Playout Timings', () => {
 							fromPartRemaining: 500,
 							fromPartPostroll: 0,
 							toPartPostroll: 0,
+							fromPartKeepalive: 0,
 						})
 					)
 				})
@@ -345,6 +357,7 @@ describe('Part Playout Timings', () => {
 							fromPartRemaining: 500,
 							fromPartPostroll: 0,
 							toPartPostroll: 0,
+							fromPartKeepalive: 0,
 						})
 					)
 				})
@@ -365,6 +378,7 @@ describe('Part Playout Timings', () => {
 							fromPartRemaining: 231 + 500,
 							fromPartPostroll: 231,
 							toPartPostroll: 0,
+							fromPartKeepalive: 0,
 						})
 					)
 				})
@@ -387,6 +401,7 @@ describe('Part Playout Timings', () => {
 							fromPartRemaining: 500,
 							fromPartPostroll: 0,
 							toPartPostroll: 0,
+							fromPartKeepalive: 0,
 						})
 					)
 				})
@@ -409,6 +424,7 @@ describe('Part Playout Timings', () => {
 							fromPartRemaining: 231 + 500,
 							fromPartPostroll: 231,
 							toPartPostroll: 0,
+							fromPartKeepalive: 0,
 						})
 					)
 				})
@@ -431,6 +447,7 @@ describe('Part Playout Timings', () => {
 							fromPartRemaining: 823,
 							fromPartPostroll: 0,
 							toPartPostroll: 0,
+							fromPartKeepalive: 0,
 						})
 					)
 				})
@@ -453,6 +470,7 @@ describe('Part Playout Timings', () => {
 							fromPartRemaining: 231 + 823,
 							fromPartPostroll: 231,
 							toPartPostroll: 0,
+							fromPartKeepalive: 0,
 						})
 					)
 				})
@@ -476,6 +494,7 @@ describe('Part Playout Timings', () => {
 							fromPartRemaining: 500 + 452,
 							fromPartPostroll: 0,
 							toPartPostroll: 0,
+							fromPartKeepalive: 452,
 						})
 					)
 				})
@@ -499,6 +518,7 @@ describe('Part Playout Timings', () => {
 							fromPartRemaining: 231 + 500 + 452,
 							fromPartPostroll: 231,
 							toPartPostroll: 0,
+							fromPartKeepalive: 452,
 						})
 					)
 				})
@@ -523,6 +543,7 @@ describe('Part Playout Timings', () => {
 							fromPartRemaining: 500 + 452,
 							fromPartPostroll: 0,
 							toPartPostroll: 0,
+							fromPartKeepalive: 452,
 						})
 					)
 				})
@@ -547,6 +568,7 @@ describe('Part Playout Timings', () => {
 							fromPartRemaining: 231 + 500 + 452,
 							fromPartPostroll: 231,
 							toPartPostroll: 0,
+							fromPartKeepalive: 452,
 						})
 					)
 				})
@@ -571,6 +593,7 @@ describe('Part Playout Timings', () => {
 							fromPartRemaining: 2256,
 							fromPartPostroll: 0,
 							toPartPostroll: 0,
+							fromPartKeepalive: 452,
 						})
 					)
 				})
@@ -595,6 +618,7 @@ describe('Part Playout Timings', () => {
 							fromPartRemaining: 231 + 2256,
 							fromPartPostroll: 231,
 							toPartPostroll: 0,
+							fromPartKeepalive: 452,
 						})
 					)
 				})
@@ -624,6 +648,7 @@ describe('Part Playout Timings', () => {
 						fromPartRemaining: 500,
 						fromPartPostroll: 0,
 						toPartPostroll: 0,
+						fromPartKeepalive: 0,
 					})
 				)
 			})
@@ -653,6 +678,7 @@ describe('Part Playout Timings', () => {
 						fromPartRemaining: 500 + 452,
 						fromPartPostroll: 0,
 						toPartPostroll: 0,
+						fromPartKeepalive: 452,
 					})
 				)
 			})
@@ -682,6 +708,7 @@ describe('Part Playout Timings', () => {
 						fromPartRemaining: 231 + 500 + 452,
 						fromPartPostroll: 231,
 						toPartPostroll: 0,
+						fromPartKeepalive: 452,
 					})
 				)
 			})
@@ -710,6 +737,7 @@ describe('Part Playout Timings', () => {
 						fromPartRemaining: 500,
 						fromPartPostroll: 0,
 						toPartPostroll: 0,
+						fromPartKeepalive: 0,
 					})
 				)
 			})
@@ -738,6 +766,7 @@ describe('Part Playout Timings', () => {
 						fromPartRemaining: 231 + 500,
 						fromPartPostroll: 231,
 						toPartPostroll: 0,
+						fromPartKeepalive: 0,
 					})
 				)
 			})
@@ -764,6 +793,7 @@ describe('Part Playout Timings', () => {
 						fromPartRemaining: 5000,
 						fromPartPostroll: 0,
 						toPartPostroll: 0,
+						fromPartKeepalive: 5000,
 					})
 				)
 			})
@@ -790,6 +820,7 @@ describe('Part Playout Timings', () => {
 						fromPartRemaining: 500,
 						fromPartPostroll: 0,
 						toPartPostroll: 0,
+						fromPartKeepalive: 0,
 					})
 				)
 			})
@@ -816,6 +847,7 @@ describe('Part Playout Timings', () => {
 						fromPartRemaining: 500,
 						fromPartPostroll: 0,
 						toPartPostroll: 0,
+						fromPartKeepalive: 0,
 					})
 				)
 			})
@@ -843,6 +875,7 @@ describe('Part Playout Timings', () => {
 							fromPartRemaining: 231 + 5000,
 							fromPartPostroll: 231,
 							toPartPostroll: 0,
+							fromPartKeepalive: 5000,
 						})
 					)
 				})
@@ -869,6 +902,7 @@ describe('Part Playout Timings', () => {
 							fromPartRemaining: 231 + 500,
 							fromPartPostroll: 231,
 							toPartPostroll: 0,
+							fromPartKeepalive: 0,
 						})
 					)
 				})
@@ -895,6 +929,7 @@ describe('Part Playout Timings', () => {
 							fromPartRemaining: 231 + 500,
 							fromPartPostroll: 231 + 0,
 							toPartPostroll: 0 + 0,
+							fromPartKeepalive: 0,
 						})
 					)
 				})
@@ -924,6 +959,7 @@ describe('Part Playout Timings', () => {
 						fromPartRemaining: 500 - 345 + 628,
 						fromPartPostroll: 0,
 						toPartPostroll: 0,
+						fromPartKeepalive: 628,
 					})
 				)
 			})
@@ -950,6 +986,7 @@ describe('Part Playout Timings', () => {
 						fromPartRemaining: 231 + 500 - 345 + 628,
 						fromPartPostroll: 231,
 						toPartPostroll: 0,
+						fromPartKeepalive: 628,
 					})
 				)
 			})
@@ -976,6 +1013,7 @@ describe('Part Playout Timings', () => {
 						fromPartRemaining: 628,
 						fromPartPostroll: 0,
 						toPartPostroll: 0,
+						fromPartKeepalive: 628,
 					})
 				)
 			})
@@ -1002,6 +1040,7 @@ describe('Part Playout Timings', () => {
 						fromPartRemaining: 231 + 628,
 						fromPartPostroll: 231,
 						toPartPostroll: 0,
+						fromPartKeepalive: 628,
 					})
 				)
 			})
@@ -1030,6 +1069,7 @@ describe('Part Playout Timings', () => {
 						fromPartRemaining: 500 - 345 + 628,
 						fromPartPostroll: 0,
 						toPartPostroll: 0,
+						fromPartKeepalive: 628,
 					})
 				)
 			})
@@ -1058,6 +1098,7 @@ describe('Part Playout Timings', () => {
 						fromPartRemaining: 231 + 500 - 345 + 628,
 						fromPartPostroll: 231,
 						toPartPostroll: 0,
+						fromPartKeepalive: 628,
 					})
 				)
 			})
@@ -1086,6 +1127,7 @@ describe('Part Playout Timings', () => {
 						fromPartRemaining: 987,
 						fromPartPostroll: 0,
 						toPartPostroll: 0,
+						fromPartKeepalive: 628,
 					})
 				)
 			})
@@ -1114,6 +1156,7 @@ describe('Part Playout Timings', () => {
 						fromPartRemaining: 231 + 987,
 						fromPartPostroll: 231,
 						toPartPostroll: 0,
+						fromPartKeepalive: 628,
 					})
 				)
 			})

diff --git a/packages/corelib/src/playout/timings.ts b/packages/corelib/src/playout/timings.ts
@@ -58,6 +58,7 @@ export interface PartCalculatedTimings {
 	toPartPostroll: number
 	fromPartRemaining: number // How long after the start of toPartGroup should fromPartGroup continue?
 	fromPartPostroll: number
+	fromPartKeepalive: number
 }
 
 export type CalculateTimingsPiece = Pick<Piece, 'enable' | 'prerollDuration' | 'postrollDuration' | 'pieceType'>
@@ -117,6 +118,7 @@ export function calculatePartTimings(
 			// The old part needs to continue for a while
 			fromPartRemaining: takeOffset + fromPartPostroll,
 			fromPartPostroll: fromPartPostroll,
+			fromPartKeepalive: 0,
 		}
 	} else {
 		// The amount of time needed to complete the outTransition before the 'take' point
@@ -136,6 +138,7 @@ export function calculatePartTimings(
 			toPartPostroll: toPartPostroll,
 			fromPartRemaining: takeOffset + inTransition.previousPartKeepaliveDuration + fromPartPostroll,
 			fromPartPostroll: fromPartPostroll,
+			fromPartKeepalive: inTransition.previousPartKeepaliveDuration,
 		}
 	}
 }

diff --git a/packages/job-worker/src/blueprints/context/lib.ts b/packages/job-worker/src/blueprints/context/lib.ts
@@ -97,6 +97,7 @@ export const IBlueprintPieceObjectsSampleKeys = allKeysOfObject<IBlueprintPiece>
 	notInVision: true,
 	abSessions: true,
 	userEditOperations: true,
+	excludeDuringPartKeepalive: true,
 })
 
 // Compile a list of the keys which are allowed to be set
@@ -239,6 +240,7 @@ export function convertPieceToBlueprints(piece: ReadonlyDeep<PieceInstancePiece>
 		extendOnHold: piece.extendOnHold,
 		notInVision: piece.notInVision,
 		userEditOperations: translateUserEditsToBlueprint(piece.userEditOperations),
+		excludeDuringPartKeepalive: piece.excludeDuringPartKeepalive,
 	}
 
 	return obj