wip: global piece prepare time

Author: Julusian

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

@@ -28,11 +28,19 @@ import _ = require('underscore')
 import { getPieceEnableInsidePart, transformPieceGroupAndObjects } from './piece'
 import { logger } from '../../logging'
 
+const DEFAULT_ABSOLUTE_PIECE_PREPARE_TIME = 30000
+
 /**
  * Some additional data used by the timeline generation process
  * Fields are populated as it progresses through generation, and consumed during the finalisation
  */
 export interface RundownTimelineTimingContext {
+	/**
+	 * How long an absolute timed piece should be on the timeline before it is played
+	 * This is a constant derived from the settings
+	 */
+	readonly absolutePiecePrepareTime: number
+
 	currentPartGroup: TimelineObjGroupPart
 	currentPartDuration: number | undefined
 
@@ -140,10 +148,10 @@ export function buildTimelineObjsForRundown(
 	const currentPartGroup = createPartGroup(partInstancesInfo.current.partInstance, currentPartEnable)
 
 	const timingContext: RundownTimelineTimingContext = {
+		absolutePiecePrepareTime:
+			context.studio.settings.rundownGlobalPiecesPrepareTime || DEFAULT_ABSOLUTE_PIECE_PREPARE_TIME,
 		currentPartGroup,
 		currentPartDuration: currentPartEnable.duration,
-
-		// regenerateTimelineAt: For future use
 	}
 
 	// Start generating objects
@@ -280,19 +288,21 @@ function generateCurrentInfinitePieceObjects(
 		return []
 	}
 
-	const { pieceEnable, infiniteGroupEnable, nowInParent } = calculateInfinitePieceEnable(
+	const pieceEnable = calculateInfinitePieceEnable(
 		currentPartInfo,
 		timingContext,
 		pieceInstance,
 		currentTime,
 		currentPartInstanceTimings
 	)
+	// Not allowed to be generated
+	if (!pieceEnable) return []
 
 	const { pieceInstanceWithUpdatedEndCap, cappedInfiniteGroupEnable } = applyInfinitePieceGroupEndCap(
 		currentPartInfo,
 		timingContext,
 		pieceInstance,
-		infiniteGroupEnable,
+		pieceEnable.infiniteGroupEnable,
 		currentPartInstanceTimings,
 		nextPartInstanceTimings,
 		nextPartInfinites.get(pieceInstance.infinite.infiniteInstanceId)
@@ -317,9 +327,9 @@ function generateCurrentInfinitePieceObjects(
 		...transformPieceGroupAndObjects(
 			activePlaylist._id,
 			infiniteGroup,
-			nowInParent,
+			pieceEnable.nowInParent,
 			pieceInstanceWithUpdatedEndCap,
-			pieceEnable,
+			pieceEnable.pieceEnable,
 			0,
 			groupClasses,
 			isInHold,
@@ -355,6 +365,15 @@ function calculateInfinitePieceEnable(
 		const infiniteGroupStart = pieceInstance.plannedStartedPlayback ?? pieceInstance.piece.enable.start
 
 		if (typeof infiniteGroupStart === 'number') {
+			if (infiniteGroupStart > currentTime + timingContext.absolutePiecePrepareTime) {
+				// This piece is starting too far in the future, omit it from the timeline
+				timingContext.regenerateTimelineAt = Math.min(
+					timingContext.regenerateTimelineAt ?? Number.POSITIVE_INFINITY,
+					infiniteGroupStart - timingContext.absolutePiecePrepareTime
+				)
+				return null
+			}
+
 			nowInParent = currentTime - infiniteGroupStart
 		} else {
 			// We should never hit this, but in case start is "now"

packages/shared-lib/src/core/model/StudioSettings.ts

@@ -91,4 +91,9 @@ export interface IStudioSettings {
 	 * Doubleclick changes behaviour as selector for userediting
 	 */
 	enableUserEdits?: boolean
+
+	/**
+	 * How long before their start time a rundown owned piece be added to the timeline
+	 */
+	rundownGlobalPiecesPrepareTime?: number
 }

packages/webui/src/client/ui/Settings/Studio/Generic.tsx

@@ -461,6 +461,23 @@ function StudioSettings({ studio }: { studio: DBStudio }): JSX.Element {
 			>
 				{(value, handleUpdate) => <CheckboxControl value={!!value} handleUpdate={handleUpdate} />}
 			</LabelAndOverridesForCheckbox>
+
+			<LabelAndOverridesForInt
+				label={t('Rundown Global Piece Prepare Time')}
+				item={wrappedItem}
+				itemKey={'rundownGlobalPiecesPrepareTime'}
+				overrideHelper={overrideHelper}
+				hint={t('How much preparation time to add to global pieces on the timeline before they are played')}
+			>
+				{(value, handleUpdate) => (
+					<IntInputControl
+						modifiedClassName="bghl"
+						classNames="input text-input input-l"
+						value={value}
+						handleUpdate={handleUpdate}
+					/>
+				)}
+			</LabelAndOverridesForInt>
 		</>
 	)
 }