Merge pull request Sofie-Automation#1277 from bbc/upstream/segment-timing

Author: jstarpl

packages/blueprints-integration/src/documents/part.ts

@@ -54,9 +54,6 @@ export interface IBlueprintMutatablePart<TPrivateData = unknown, TPublicData = u
 	/** Expected duration of the line, in milliseconds */
 	expectedDuration?: number
 
-	/** Budget duration of this part, in milliseconds */
-	budgetDuration?: number
-
 	/** Whether this segment line supports being used in HOLD */
 	holdMode?: PartHoldMode
 

packages/blueprints-integration/src/documents/segment.ts

@@ -4,12 +4,25 @@ export enum SegmentDisplayMode {
 	List = 'list',
 }
 
+export enum CountdownType {
+	/** Should count down till the end of the current part */
+	PART_EXPECTED_DURATION = 'part_expected_duration',
+	/** Should count down till the end of the segment's budget */
+	SEGMENT_BUDGET_DURATION = 'segment_budget_duration',
+}
+
 export interface SegmentTimingInfo {
 	/** A unix timestamp of when the segment is expected to begin. Affects rundown timing. */
 	expectedStart?: number
 
 	/** A unix timestamp of when the segment is expected to end. Affects rundown timing. */
 	expectedEnd?: number
+
+	/** Budget duration of this segment, in milliseconds */
+	budgetDuration?: number
+
+	/** Defines the behavior of countdowns during this segment. Default: `CountdownType.PART_EXPECTED_DURATION` */
+	countdownType?: CountdownType
 }
 
 /** The Segment generated from Blueprint */

packages/corelib/src/dataModel/RundownPlaylist.ts

@@ -160,7 +160,10 @@ export interface DBRundownPlaylist {
 	lastIncorrectPartPlaybackReported?: Time
 	/** Actual time of each rundown starting playback */
 	rundownsStartedPlayback?: Record<string, Time>
-	/** Actual time of SOME segments starting playback - usually just the previous and current one */
+	/**
+	 * Actual time of SOME segments starting playback - usually just the previous and current one
+	 * This is not using SegmentId, but SegmentPlayoutId
+	 */
 	segmentsStartedPlayback?: Record<string, Time>
 	/** Time of the last take */
 	lastTakeTime?: Time

packages/job-worker/src/blueprints/context/lib.ts

@@ -94,7 +94,6 @@ export const IBlueprintMutatablePartSampleKeys = allKeysOfObject<IBlueprintMutat
 	disableNextInTransition: true,
 	outTransition: true,
 	expectedDuration: true,
-	budgetDuration: true,
 	holdMode: true,
 	shouldNotifyCurrentPlayingPart: true,
 	classes: true,
@@ -251,7 +250,6 @@ export function convertPartToBlueprints(part: ReadonlyDeep<DBPart>): IBlueprintP
 		disableNextInTransition: part.disableNextInTransition,
 		outTransition: clone(part.outTransition),
 		expectedDuration: part.expectedDuration,
-		budgetDuration: part.budgetDuration,
 		holdMode: part.holdMode,
 		shouldNotifyCurrentPlayingPart: part.shouldNotifyCurrentPlayingPart,
 		classes: clone<string[] | undefined>(part.classes),

packages/job-worker/src/playout/model/PlayoutModel.ts

@@ -7,6 +7,7 @@ import {
 	RundownPlaylistActivationId,
 	RundownPlaylistId,
 	SegmentId,
+	SegmentPlayoutId,
 } from '@sofie-automation/corelib/dist/dataModel/Ids'
 import { BaseModel } from '../../modelBase'
 import {
@@ -331,10 +332,10 @@ export interface PlayoutModel extends PlayoutModelReadonly, StudioPlayoutModelBa
 
 	/**
 	 * Track a Segment as having started playback
-	 * @param segmentId Id of the Segment
+	 * @param segmentPlayoutId Playout id of the Segment
 	 * @param timestamp Timestamp playback started
 	 */
-	setSegmentStartedPlayback(segmentId: SegmentId, timestamp: number): void
+	setSegmentStartedPlayback(segmentPlayoutId: SegmentPlayoutId, timestamp: number): void
 
 	/**
 	 * Set or clear a QuickLoop Marker

packages/job-worker/src/playout/model/implementation/PlayoutModelImpl.ts

@@ -587,6 +587,7 @@ export class PlayoutModelImpl extends PlayoutModelReadonlyImpl implements Playou
 		delete this.playlistImpl.lastTakeTime
 		delete this.playlistImpl.startedPlayback
 		delete this.playlistImpl.rundownsStartedPlayback
+		delete this.playlistImpl.segmentsStartedPlayback
 		delete this.playlistImpl.previousPersistentState
 		delete this.playlistImpl.trackedAbSessions
 		delete this.playlistImpl.queuedSegmentId
@@ -744,21 +745,21 @@ export class PlayoutModelImpl extends PlayoutModelReadonlyImpl implements Playou
 		this.#playlistHasChanged = true
 	}
 
-	setSegmentStartedPlayback(segmentId: SegmentId, timestamp: number): void {
-		const segmentIdsToKeep: string[] = []
+	setSegmentStartedPlayback(segmentPlayoutId: SegmentPlayoutId, timestamp: number): void {
+		const segmentPlayoutIdsToKeep: string[] = []
 		if (this.previousPartInstance) {
-			segmentIdsToKeep.push(unprotectString(this.previousPartInstance.partInstance.segmentId))
+			segmentPlayoutIdsToKeep.push(unprotectString(this.previousPartInstance.partInstance.segmentPlayoutId))
 		}
 		if (this.currentPartInstance) {
-			segmentIdsToKeep.push(unprotectString(this.currentPartInstance.partInstance.segmentId))
+			segmentPlayoutIdsToKeep.push(unprotectString(this.currentPartInstance.partInstance.segmentPlayoutId))
 		}
 
 		this.playlistImpl.segmentsStartedPlayback = this.playlistImpl.segmentsStartedPlayback
-			? _.pick(this.playlistImpl.segmentsStartedPlayback, segmentIdsToKeep)
+			? _.pick(this.playlistImpl.segmentsStartedPlayback, segmentPlayoutIdsToKeep)
 			: {}
 
-		const segmentIdStr = unprotectString(segmentId)
-		this.playlistImpl.segmentsStartedPlayback[segmentIdStr] = timestamp
+		const segmentPlayoutIdStr = unprotectString(segmentPlayoutId)
+		this.playlistImpl.segmentsStartedPlayback[segmentPlayoutIdStr] = timestamp
 		this.#playlistHasChanged = true
 	}
 

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

@@ -195,8 +195,11 @@ export function reportPartInstanceHasStarted(
 			playoutModel.setRundownStartedPlayback(partInstance.partInstance.rundownId, timestamp)
 		}
 
-		if (partInstance.partInstance.segmentId !== playoutModel.previousPartInstance?.partInstance.segmentId) {
-			playoutModel.setSegmentStartedPlayback(partInstance.partInstance.segmentId, timestamp)
+		if (
+			partInstance.partInstance.segmentPlayoutId !==
+			playoutModel.previousPartInstance?.partInstance.segmentPlayoutId
+		) {
+			playoutModel.setSegmentStartedPlayback(partInstance.partInstance.segmentPlayoutId, timestamp)
 		}
 
 		if (timestampUpdated) {

packages/live-status-gateway/api/schemas/activePlaylist.yaml

@@ -172,6 +172,12 @@ $defs:
           projectedEndTime:
             description: Unix timestamp of when the segment is projected to end (milliseconds). The time this segment started, offset by its budget duration, if the segment has a defined budget duration. Otherwise, the time the current part started, offset by the difference between expected durations of all parts in this segment and the as-played durations of the parts that already stopped.
             type: number
+          countdownType:
+            description: 'Countdown type within the segment. Default: `part_expected_duration`'
+            type: string
+            enum:
+              - part_expected_duration
+              - segment_budget_duration
         required: [expectedDurationMs, projectedEndTime]
     required: [id, timing]
     additionalProperties: false
@@ -181,6 +187,7 @@ $defs:
           expectedDurationMs: 15000
           budgetDurationMs: 20000
           projectedEndTime: 1600000075000
+          countdownType: segment_budget_duration
   piece:
     type: object
     properties:

packages/live-status-gateway/api/schemas/segments.yaml

@@ -48,6 +48,12 @@ $defs:
           budgetDurationMs:
             description: Budget duration of the segment (milliseconds)
             type: number
+          countdownType:
+            description: 'Countdown type within the segment. Default: `part_expected_duration`'
+            type: string
+            enum:
+              - part_expected_duration
+              - segment_budget_duration
         required: [expectedDurationMs]
       publicData:
         description: Optional arbitrary data
@@ -60,5 +66,6 @@ $defs:
         timing:
           expectedDurationMs: 15000
           budgetDurationMs: 20000
+          countdownType: segment_budget_duration
         publicData:
           containsLiveSource: true

packages/live-status-gateway/src/collections/segmentHandler.ts

@@ -31,14 +31,19 @@ export class SegmentHandler
 		if (!collection) throw new Error(`collection '${this._collectionName}' not found!`)
 		const allSegments = collection.find(undefined)
 		await this._segmentsHandler.setSegments(allSegments)
-		if (this._currentSegmentId) {
-			this._collectionData = collection.findOne(this._currentSegmentId)
+		await this.updateAndNotify()
+	}
+
+	private async updateAndNotify() {
+		const collection = this._core.getCollection(this._collectionName)
+		const newData = this._currentSegmentId ? collection.findOne(this._currentSegmentId) : undefined
+		if (this._collectionData !== newData) {
+			this._collectionData = newData
 			await this.notify(this._collectionData)
 		}
 	}
 
 	async update(source: string, data: SelectedPartInstances | DBRundownPlaylist | undefined): Promise<void> {
-		const previousSegmentId = this._currentSegmentId
 		const previousRundownIds = this._rundownIds
 
 		switch (source) {
@@ -91,11 +96,6 @@ export class SegmentHandler
 			const allSegments = collection.find(undefined)
 			await this._segmentsHandler.setSegments(allSegments)
 		}
-		if (previousSegmentId !== this._currentSegmentId) {
-			if (this._currentSegmentId) {
-				this._collectionData = collection.findOne(this._currentSegmentId)
-				await this.notify(this._collectionData)
-			}
-		}
+		await this.updateAndNotify()
 	}
 }