Merge pull request Sofie-Automation#1112 from bbc/feat/quickLoop

feat: Implement QuickLoop (SOFIE-2878)

Author: jstarpl

meteor/__mocks__/defaultCollectionObjects.ts

@@ -26,7 +26,10 @@ import {
 	ShowStyleVariantId,
 	StudioId,
 } from '@sofie-automation/corelib/dist/dataModel/Ids'
-import { DEFAULT_MINIMUM_TAKE_SPAN } from '@sofie-automation/shared-lib/dist/core/constants'
+import {
+	DEFAULT_FALLBACK_PART_DURATION,
+	DEFAULT_MINIMUM_TAKE_SPAN,
+} from '@sofie-automation/shared-lib/dist/core/constants'
 
 export function defaultRundownPlaylist(_id: RundownPlaylistId, studioId: StudioId): DBRundownPlaylist {
 	return {
@@ -106,6 +109,7 @@ export function defaultStudio(_id: StudioId): DBStudio {
 			frameRate: 25,
 			mediaPreviewsUrl: '',
 			minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,
+			fallbackPartDuration: DEFAULT_FALLBACK_PART_DURATION,
 		},
 		_rundownVersionHash: '',
 		routeSets: {},

meteor/server/api/rest/v1/typeConversion.ts

@@ -33,8 +33,12 @@ import {
 import { DBShowStyleBase } from '@sofie-automation/corelib/dist/dataModel/ShowStyleBase'
 import { DBShowStyleVariant } from '@sofie-automation/corelib/dist/dataModel/ShowStyleVariant'
 import { Blueprints, ShowStyleBases, Studios } from '../../../collections'
-import { DEFAULT_MINIMUM_TAKE_SPAN } from '@sofie-automation/shared-lib/dist/core/constants'
+import {
+	DEFAULT_MINIMUM_TAKE_SPAN,
+	DEFAULT_FALLBACK_PART_DURATION,
+} from '@sofie-automation/shared-lib/dist/core/constants'
 import { Bucket } from '@sofie-automation/meteor-lib/dist/collections/Buckets'
+import { ForceQuickLoopAutoNext } from '@sofie-automation/corelib/dist/dataModel/RundownPlaylist'
 
 /*
 This file contains functions that convert between the internal Sofie-Core types and types exposed to the external API.
@@ -314,6 +318,9 @@ export function studioSettingsFrom(apiStudioSettings: APIStudioSettings): IStudi
 		allowRundownResetOnAir: apiStudioSettings.allowRundownResetOnAir,
 		preserveOrphanedSegmentPositionInRundown: apiStudioSettings.preserveOrphanedSegmentPositionInRundown,
 		minimumTakeSpan: apiStudioSettings.minimumTakeSpan ?? DEFAULT_MINIMUM_TAKE_SPAN,
+		enableQuickLoop: apiStudioSettings.enableQuickLoop,
+		forceQuickLoopAutoNext: forceQuickLoopAutoNextFrom(apiStudioSettings.forceQuickLoopAutoNext),
+		fallbackPartDuration: apiStudioSettings.fallbackPartDuration ?? DEFAULT_FALLBACK_PART_DURATION,
 	}
 }
 
@@ -330,6 +337,42 @@ export function APIStudioSettingsFrom(settings: IStudioSettings): APIStudioSetti
 		allowRundownResetOnAir: settings.allowRundownResetOnAir,
 		preserveOrphanedSegmentPositionInRundown: settings.preserveOrphanedSegmentPositionInRundown,
 		minimumTakeSpan: settings.minimumTakeSpan,
+		enableQuickLoop: settings.enableQuickLoop,
+		forceQuickLoopAutoNext: APIForceQuickLoopAutoNextFrom(settings.forceQuickLoopAutoNext),
+		fallbackPartDuration: settings.fallbackPartDuration,
+	}
+}
+
+export function forceQuickLoopAutoNextFrom(
+	forceQuickLoopAutoNext: APIStudioSettings['forceQuickLoopAutoNext']
+): ForceQuickLoopAutoNext | undefined {
+	if (!forceQuickLoopAutoNext) return undefined
+	switch (forceQuickLoopAutoNext) {
+		case 'disabled':
+			return ForceQuickLoopAutoNext.DISABLED
+		case 'enabled_forcing_min_duration':
+			return ForceQuickLoopAutoNext.ENABLED_FORCING_MIN_DURATION
+		case 'enabled_when_valid_duration':
+			return ForceQuickLoopAutoNext.ENABLED_WHEN_VALID_DURATION
+		default:
+			assertNever(forceQuickLoopAutoNext)
+			return undefined
+	}
+}
+
+export function APIForceQuickLoopAutoNextFrom(
+	forceQuickLoopAutoNext: ForceQuickLoopAutoNext | undefined
+): APIStudioSettings['forceQuickLoopAutoNext'] {
+	if (!forceQuickLoopAutoNext) return undefined
+	switch (forceQuickLoopAutoNext) {
+		case ForceQuickLoopAutoNext.DISABLED:
+			return 'disabled'
+		case ForceQuickLoopAutoNext.ENABLED_FORCING_MIN_DURATION:
+			return 'enabled_forcing_min_duration'
+		case ForceQuickLoopAutoNext.ENABLED_WHEN_VALID_DURATION:
+			return 'enabled_when_valid_duration'
+		default:
+			assertNever(forceQuickLoopAutoNext)
 	}
 }
 

meteor/server/api/userActions.ts

@@ -49,6 +49,7 @@ import {
 import { IngestDataCache, Parts, Pieces, Rundowns } from '../collections'
 import { IngestCacheType } from '@sofie-automation/corelib/dist/dataModel/IngestDataCache'
 import { verifyHashedToken } from './singleUseTokens'
+import { QuickLoopMarker } from '@sofie-automation/corelib/dist/dataModel/RundownPlaylist'
 import { runIngestOperation } from './ingest/lib'
 import { IngestJobs } from '@sofie-automation/corelib/dist/worker/ingest'
 
@@ -1222,6 +1223,52 @@ class ServerUserActionAPI
 		)
 	}
 
+	async setQuickLoopStart(
+		userEvent: string,
+		eventTime: number,
+		playlistId: RundownPlaylistId,
+		marker: QuickLoopMarker | null
+	): Promise<ClientAPI.ClientResponse<void>> {
+		return ServerClientAPI.runUserActionInLogForPlaylistOnWorker(
+			this,
+			userEvent,
+			eventTime,
+			playlistId,
+			() => {
+				check(playlistId, String)
+			},
+			StudioJobs.SetQuickLoopMarker,
+			{
+				playlistId,
+				marker,
+				type: 'start',
+			}
+		)
+	}
+
+	async setQuickLoopEnd(
+		userEvent: string,
+		eventTime: number,
+		playlistId: RundownPlaylistId,
+		marker: QuickLoopMarker | null
+	): Promise<ClientAPI.ClientResponse<void>> {
+		return ServerClientAPI.runUserActionInLogForPlaylistOnWorker(
+			this,
+			userEvent,
+			eventTime,
+			playlistId,
+			() => {
+				check(playlistId, String)
+			},
+			StudioJobs.SetQuickLoopMarker,
+			{
+				playlistId,
+				marker,
+				type: 'end',
+			}
+		)
+	}
+
 	async createAdlibTestingRundownForShowStyleVariant(
 		userEvent: string,
 		eventTime: number,

meteor/server/lib/rest/v1/studios.ts

@@ -182,5 +182,8 @@ export interface APIStudioSettings {
 	multiGatewayNowSafeLatency?: number
 	allowRundownResetOnAir?: boolean
 	preserveOrphanedSegmentPositionInRundown?: boolean
+	enableQuickLoop?: boolean
+	forceQuickLoopAutoNext?: 'disabled' | 'enabled_when_valid_duration' | 'enabled_forcing_min_duration'
 	minimumTakeSpan?: number
+	fallbackPartDuration?: number
 }

meteor/server/publications/_publications.ts

@@ -9,6 +9,8 @@ import './packageManager/playoutContext'
 import './pieceContentStatusUI/bucket/publication'
 import './pieceContentStatusUI/rundown/publication'
 import './organization'
+import './partsUI/publication'
+import './partInstancesUI/publication'
 import './peripheralDevice'
 import './peripheralDeviceForDevice'
 import './rundown'

meteor/server/publications/lib/quickLoop.ts

@@ -0,0 +1,148 @@
+import { DBPart } from '@sofie-automation/corelib/dist/dataModel/Part'
+import {
+	DBRundownPlaylist,
+	ForceQuickLoopAutoNext,
+	QuickLoopMarker,
+	QuickLoopMarkerType,
+} from '@sofie-automation/corelib/dist/dataModel/RundownPlaylist'
+import { MarkerPosition, compareMarkerPositions } from '@sofie-automation/corelib/dist/playout/playlist'
+import { ProtectedString, unprotectString } from '@sofie-automation/corelib/dist/protectedString'
+import { DEFAULT_FALLBACK_PART_DURATION } from '@sofie-automation/shared-lib/dist/core/constants'
+import { getCurrentTime } from '../../lib/lib'
+import { generateTranslation } from '@sofie-automation/meteor-lib/dist/lib'
+import { DBStudio } from '@sofie-automation/corelib/dist/dataModel/Studio'
+import { DBPartInstance } from '@sofie-automation/corelib/dist/dataModel/PartInstance'
+import { DBSegment } from '@sofie-automation/corelib/dist/dataModel/Segment'
+import { ReadonlyObjectDeep } from 'type-fest/source/readonly-deep'
+import { ReactiveCacheCollection } from './ReactiveCacheCollection'
+
+export function findPartPosition(
+	part: DBPart,
+	segmentRanks: Record<string, number>,
+	rundownRanks: Record<string, number>
+): MarkerPosition {
+	return {
+		rundownRank: rundownRanks[part.rundownId as unknown as string] ?? 0,
+		segmentRank: segmentRanks[part.segmentId as unknown as string] ?? 0,
+		partRank: part._rank,
+	}
+}
+
+export function stringsToIndexLookup(strings: string[]): Record<string, number> {
+	return strings.reduce((result, str, index) => {
+		result[str] = index
+		return result
+	}, {} as Record<string, number>)
+}
+
+export function extractRanks(docs: { _id: ProtectedString<any>; _rank: number }[]): Record<string, number> {
+	return docs.reduce((result, doc) => {
+		result[doc._id as unknown as string] = doc._rank
+		return result
+	}, {} as Record<string, number>)
+}
+
+export function modifyPartForQuickLoop(
+	part: DBPart,
+	segmentRanks: Record<string, number>,
+	rundownRanks: Record<string, number>,
+	playlist: Pick<DBRundownPlaylist, 'quickLoop'>,
+	studio: Pick<DBStudio, 'settings'>,
+	quickLoopStartPosition: MarkerPosition | undefined,
+	quickLoopEndPosition: MarkerPosition | undefined,
+	canSetAutoNext = () => true
+): void {
+	const partPosition = findPartPosition(part, segmentRanks, rundownRanks)
+	const isLoopDefined = quickLoopStartPosition && quickLoopEndPosition
+	const isLoopingOverriden =
+		isLoopDefined &&
+		playlist.quickLoop?.forceAutoNext !== ForceQuickLoopAutoNext.DISABLED &&
+		compareMarkerPositions(quickLoopStartPosition, partPosition) >= 0 &&
+		compareMarkerPositions(partPosition, quickLoopEndPosition) >= 0
+
+	const fallbackPartDuration = studio.settings.fallbackPartDuration ?? DEFAULT_FALLBACK_PART_DURATION
+
+	if (isLoopingOverriden && (part.expectedDuration ?? 0) < fallbackPartDuration) {
+		if (playlist.quickLoop?.forceAutoNext === ForceQuickLoopAutoNext.ENABLED_FORCING_MIN_DURATION) {
+			part.expectedDuration = fallbackPartDuration
+			part.expectedDurationWithTransition = fallbackPartDuration
+		} else if (playlist.quickLoop?.forceAutoNext === ForceQuickLoopAutoNext.ENABLED_WHEN_VALID_DURATION) {
+			part.invalid = true
+			part.invalidReason = {
+				message: generateTranslation('Part duration is 0.'),
+			}
+		}
+	}
+	if (!canSetAutoNext()) return
+	part.autoNext = part.autoNext || (isLoopingOverriden && (part.expectedDuration ?? 0) > 0)
+}
+
+export function modifyPartInstanceForQuickLoop(
+	partInstance: Omit<DBPartInstance, 'part.privateData'>,
+	segmentRanks: Record<string, number>,
+	rundownRanks: Record<string, number>,
+	playlist: Pick<DBRundownPlaylist, 'quickLoop'>,
+	studio: Pick<DBStudio, 'settings'>,
+	quickLoopStartPosition: MarkerPosition | undefined,
+	quickLoopEndPosition: MarkerPosition | undefined
+): void {
+	// note that the logic for when a part does not do autonext in quickloop should reflect the logic in the QuickLoopService in job worker
+	const canAutoNext = () => {
+		const start = partInstance.timings?.plannedStartedPlayback
+		if (start !== undefined && partInstance.part.expectedDuration) {
+			// date.now - start = playback duration, duration + offset gives position in part
+			const playbackDuration = getCurrentTime() - start
+
+			// If there is an auto next planned soon or was in the past
+			if (partInstance.part.expectedDuration - playbackDuration < 0) {
+				return false
+			}
+		}
+
+		return true
+	}
+
+	modifyPartForQuickLoop(
+		partInstance.part,
+		segmentRanks,
+		rundownRanks,
+		playlist,
+		studio,
+		quickLoopStartPosition,
+		quickLoopEndPosition,
+		canAutoNext // do not adjust the part instance if we have passed the time where we can still enable auto next
+	)
+}
+
+export function findMarkerPosition(
+	marker: QuickLoopMarker,
+	fallback: number,
+	segmentCache: ReadonlyObjectDeep<ReactiveCacheCollection<Pick<DBSegment, '_id' | '_rank' | 'rundownId'>>>,
+	partCache:
+		| { parts: ReadonlyObjectDeep<ReactiveCacheCollection<Pick<DBPart, '_id' | '_rank' | 'segmentId'>>> }
+		| { partInstances: ReadonlyObjectDeep<ReactiveCacheCollection<DBPartInstance>> },
+	rundownRanks: Record<string, number>
+): MarkerPosition {
+	const part =
+		marker.type === QuickLoopMarkerType.PART
+			? 'parts' in partCache
+				? partCache.parts.findOne(marker.id)
+				: partCache.partInstances.findOne({ 'part._id': marker.id })?.part
+			: undefined
+	const partRank = part?._rank ?? fallback
+
+	const segmentId = marker.type === QuickLoopMarkerType.SEGMENT ? marker.id : part?.segmentId
+	const segment = segmentId && segmentCache.findOne(segmentId)
+	const segmentRank = segment?._rank ?? fallback
+
+	const rundownId = marker.type === QuickLoopMarkerType.RUNDOWN ? marker.id : segment?.rundownId
+	let rundownRank = rundownId ? rundownRanks[unprotectString(rundownId)] : fallback
+
+	if (marker.type === QuickLoopMarkerType.PLAYLIST) rundownRank = fallback
+
+	return {
+		rundownRank: rundownRank,
+		segmentRank: segmentRank,
+		partRank: partRank,
+	}
+}