feat: quickloop improvements

Author: Julusian

meteor/server/api/userActions.ts

@@ -1269,6 +1269,26 @@ class ServerUserActionAPI
 		)
 	}
 
+	async clearQuickLoop(
+		userEvent: string,
+		eventTime: number,
+		playlistId: RundownPlaylistId
+	): Promise<ClientAPI.ClientResponse<void>> {
+		return ServerClientAPI.runUserActionInLogForPlaylistOnWorker(
+			this,
+			userEvent,
+			eventTime,
+			playlistId,
+			() => {
+				check(playlistId, String)
+			},
+			StudioJobs.ClearQuickLoopMarkers,
+			{
+				playlistId,
+			}
+		)
+	}
+
 	async createAdlibTestingRundownForShowStyleVariant(
 		userEvent: string,
 		eventTime: number,

packages/blueprints-integration/src/context/eventContext.ts

@@ -2,6 +2,7 @@ import type { OnGenerateTimelineObj, TSR } from '../timeline'
 import type { IBlueprintPartInstance, IBlueprintPieceInstance, IBlueprintSegmentDB } from '../documents'
 import type { IRundownContext } from './rundownContext'
 import type { IBlueprintExternalMessageQueueObj } from '../message'
+import { BlueprintQuickLookInfo } from './quickLoopInfo'
 
 export interface IEventContext {
 	getCurrentTime(): number
@@ -12,6 +13,9 @@ export interface ITimelineEventContext extends IEventContext, IRundownContext {
 	readonly nextPartInstance: Readonly<IBlueprintPartInstance> | undefined
 	readonly previousPartInstance: Readonly<IBlueprintPartInstance> | undefined
 
+	/** Information about the current loop, if there is one */
+	readonly quickLoopInfo: BlueprintQuickLookInfo | null
+
 	/**
 	 * Get the full session id for an ab playback session.
 	 * Note: sessionName should be unique within the segment unless pieces want to share a session

packages/blueprints-integration/src/context/onSetAsNextContext.ts

@@ -9,12 +9,16 @@ import {
 	IEventContext,
 	IShowStyleUserContext,
 } from '..'
+import { BlueprintQuickLookInfo } from './quickLoopInfo'
 
 /**
  * Context in which 'current' is the part currently on air, and 'next' is the partInstance being set as Next
  * This is similar to `IPartAndPieceActionContext`, but has more limits on what is allowed to be changed.
  */
 export interface IOnSetAsNextContext extends IShowStyleUserContext, IEventContext {
+	/** Information about the current loop, if there is one */
+	readonly quickLoopInfo: BlueprintQuickLookInfo | null
+
 	/**
 	 * Data fetching
 	 */
@@ -65,4 +69,12 @@ export interface IOnSetAsNextContext extends IShowStyleUserContext, IEventContex
 	 */
 	/** Remove piecesInstances by id. Returns ids of piecesInstances that were removed. Note: For now we only allow removing from the next, but this might change to include current if there is justification */
 	removePieceInstances(part: 'next', pieceInstanceIds: string[]): Promise<string[]>
+
+	/**
+	 * Move the next part through the rundown. Can move by either a number of parts, or segments in either direction.
+	 * This will result in the `onSetAsNext` callback being called again following the current call, with the new PartInstance.
+	 * Multiple calls of this inside one call to `onSetAsNext` will replace earlier calls.
+	 * @returns Whether a new Part was found using the provided offset
+	 */
+	moveNextPart(partDelta: number, segmentDelta: number): Promise<boolean>
 }

packages/blueprints-integration/src/context/partsAndPieceActionContext.ts

@@ -8,8 +8,12 @@ import {
 	IBlueprintResolvedPieceInstance,
 	Time,
 } from '..'
+import { BlueprintQuickLookInfo } from './quickLoopInfo'
 
 export interface IPartAndPieceActionContext {
+	/** Information about the current loop, if there is one */
+	readonly quickLoopInfo: BlueprintQuickLookInfo | null
+
 	/**
 	 * Data fetching
 	 */

packages/blueprints-integration/src/context/quickLoopInfo.ts

@@ -0,0 +1,6 @@
+export type BlueprintQuickLookInfo = Readonly<{
+	/** Whether there is a loop running */
+	running: boolean
+	/** Whether the loop is locked from user editing */
+	locked: boolean
+}>

packages/corelib/src/worker/studio.ts

@@ -194,6 +194,11 @@ export enum StudioJobs {
 	 */
 	SetQuickLoopMarker = 'setQuickLoopMarker',
 
+	/**
+	 * Clear all QuickLoop markers
+	 */
+	ClearQuickLoopMarkers = 'clearQuickLoopMarkers',
+
 	/**
 	 * Switch the route of the studio
 	 * for use in ad.lib actions and other triggers
@@ -350,6 +355,7 @@ export interface SetQuickLoopMarkerProps extends RundownPlayoutPropsBase {
 	type: 'start' | 'end'
 	marker: QuickLoopMarker | null
 }
+export type ClearQuickLoopMarkersProps = RundownPlayoutPropsBase
 
 export interface SwitchRouteSetProps {
 	routeSetId: string
@@ -409,6 +415,7 @@ export type StudioJobFunc = {
 	[StudioJobs.ActivateAdlibTesting]: (data: ActivateAdlibTestingProps) => void
 
 	[StudioJobs.SetQuickLoopMarker]: (data: SetQuickLoopMarkerProps) => void
+	[StudioJobs.ClearQuickLoopMarkers]: (data: ClearQuickLoopMarkersProps) => void
 
 	[StudioJobs.SwitchRouteSet]: (data: SwitchRouteSetProps) => void
 }

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

@@ -22,11 +22,16 @@ import { PlayoutModel } from '../../playout/model/PlayoutModel'
 import { ReadonlyDeep } from 'type-fest'
 import { getCurrentTime } from '../../lib'
 import { protectString } from '@sofie-automation/corelib/dist/protectedString'
+import { BlueprintQuickLookInfo } from '@sofie-automation/blueprints-integration/dist/context/quickLoopInfo'
+import { DBPart } from '@sofie-automation/corelib/dist/dataModel/Part'
+import { selectNewPartWithOffsets } from '../../playout/moveNextPart'
 
 export class OnSetAsNextContext
 	extends ShowStyleUserContext
 	implements IOnSetAsNextContext, IEventContext, IPartAndPieceInstanceActionContext
 {
+	public pendingMoveNextPart: { selectedPart: ReadonlyDeep<DBPart> | null } | undefined = undefined
+
 	constructor(
 		contextInfo: UserContextInfo,
 		context: JobContext,
@@ -38,6 +43,10 @@ export class OnSetAsNextContext
 		super(contextInfo, context, showStyle, watchedPackages)
 	}
 
+	public get quickLoopInfo(): BlueprintQuickLookInfo | null {
+		return this.partAndPieceInstanceService.quickLoopInfo
+	}
+
 	public get nextPartState(): ActionPartChange {
 		return this.partAndPieceInstanceService.nextPartState
 	}
@@ -112,6 +121,23 @@ export class OnSetAsNextContext
 		return this.partAndPieceInstanceService.removePieceInstances('next', pieceInstanceIds)
 	}
 
+	async moveNextPart(partDelta: number, segmentDelta: number): Promise<boolean> {
+		if (typeof partDelta !== 'number') throw new Error('partDelta must be a number')
+		if (typeof segmentDelta !== 'number') throw new Error('segmentDelta must be a number')
+
+		// Values of 0 mean discard the pending change
+		if (partDelta === 0 && segmentDelta === 0) {
+			this.pendingMoveNextPart = undefined
+			return true
+		}
+
+		this.pendingMoveNextPart = {
+			selectedPart: selectNewPartWithOffsets(this.jobContext, this.playoutModel, partDelta, segmentDelta),
+		}
+
+		return !!this.pendingMoveNextPart.selectedPart
+	}
+
 	getCurrentTime(): number {
 		return getCurrentTime()
 	}

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

@@ -23,10 +23,15 @@ import { getCurrentTime } from '../../lib'
 import { JobContext, ProcessedShowStyleCompound } from '../../jobs'
 import { executePeripheralDeviceAction, listPlayoutDevices } from '../../peripheralDevice'
 import { ActionPartChange, PartAndPieceInstanceActionService } from './services/PartAndPieceInstanceActionService'
+import { BlueprintQuickLookInfo } from '@sofie-automation/blueprints-integration/dist/context/quickLoopInfo'
 
 export class OnTakeContext extends ShowStyleUserContext implements IOnTakeContext, IEventContext {
 	public isTakeAborted: boolean
 
+	public get quickLoopInfo(): BlueprintQuickLookInfo | null {
+		return this.partAndPieceInstanceService.quickLoopInfo
+	}
+
 	public get currentPartState(): ActionPartChange {
 		return this.partAndPieceInstanceService.currentPartState
 	}

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

@@ -15,17 +15,20 @@ import { PieceInstance, ResolvedPieceInstance } from '@sofie-automation/corelib/
 import { ProcessedStudioConfig, ProcessedShowStyleConfig } from '../config'
 import _ = require('underscore')
 import { ProcessedShowStyleCompound } from '../../jobs'
-import { convertPartInstanceToBlueprints } from './lib'
+import { convertPartInstanceToBlueprints, createBlueprintQuickLoopInfo } from './lib'
 import { RundownContext } from './RundownContext'
 import { AbSessionHelper } from '../../playout/abPlayback/abSessionHelper'
 import { protectString } from '@sofie-automation/corelib/dist/protectedString'
 import { PieceInstanceId } from '@sofie-automation/corelib/dist/dataModel/Ids'
+import { BlueprintQuickLookInfo } from '@sofie-automation/blueprints-integration/dist/context/quickLoopInfo'
 
 export class OnTimelineGenerateContext extends RundownContext implements ITimelineEventContext {
 	readonly currentPartInstance: Readonly<IBlueprintPartInstance> | undefined
 	readonly nextPartInstance: Readonly<IBlueprintPartInstance> | undefined
 	readonly previousPartInstance: Readonly<IBlueprintPartInstance> | undefined
 
+	readonly quickLoopInfo: BlueprintQuickLookInfo | null
+
 	readonly abSessionsHelper: AbSessionHelper
 	readonly #pieceInstanceCache = new Map<PieceInstanceId, ReadonlyDeep<PieceInstance>>()
 
@@ -57,6 +60,8 @@ export class OnTimelineGenerateContext extends RundownContext implements ITimeli
 		this.nextPartInstance = nextPartInstance && convertPartInstanceToBlueprints(nextPartInstance)
 		this.previousPartInstance = previousPartInstance && convertPartInstanceToBlueprints(previousPartInstance)
 
+		this.quickLoopInfo = createBlueprintQuickLoopInfo(playlist)
+
 		const partInstances = _.compact([previousPartInstance, currentPartInstance, nextPartInstance])
 
 		for (const pieceInstance of pieceInstances) {

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

@@ -23,13 +23,15 @@ import { ShowStyleUserContext } from './ShowStyleUserContext'
 import { WatchedPackagesHelper } from './watchedPackages'
 import { getCurrentTime } from '../../lib'
 import { JobContext, ProcessedShowStyleCompound } from '../../jobs'
-import { moveNextPart } from '../../playout/moveNextPart'
+import { selectNewPartWithOffsets } from '../../playout/moveNextPart'
 import { ProcessedShowStyleConfig } from '../config'
 import { DatastorePersistenceMode } from '@sofie-automation/shared-lib/dist/core/model/TimelineDatastore'
 import { removeTimelineDatastoreValue, setTimelineDatastoreValue } from '../../playout/datastore'
 import { executePeripheralDeviceAction, listPlayoutDevices } from '../../peripheralDevice'
 import { ActionPartChange, PartAndPieceInstanceActionService } from './services/PartAndPieceInstanceActionService'
 import { applyAndValidateOverrides } from '@sofie-automation/corelib/dist/settings/objectWithOverrides'
+import { BlueprintQuickLookInfo } from '@sofie-automation/blueprints-integration/dist/context/quickLoopInfo'
+import { setNextPartFromPart } from '../../playout/setNext'
 
 export class DatastoreActionExecutionContext
 	extends ShowStyleUserContext
@@ -72,6 +74,10 @@ export class ActionExecutionContext extends ShowStyleUserContext implements IAct
 	 */
 	public forceRegenerateTimeline = false
 
+	public get quickLoopInfo(): BlueprintQuickLookInfo | null {
+		return this.partAndPieceInstanceService.quickLoopInfo
+	}
+
 	public get currentPartState(): ActionPartChange {
 		return this.partAndPieceInstanceService.currentPartState
 	}
@@ -153,7 +159,8 @@ export class ActionExecutionContext extends ShowStyleUserContext implements IAct
 	}
 
 	async moveNextPart(partDelta: number, segmentDelta: number): Promise<void> {
-		await moveNextPart(this._context, this._playoutModel, partDelta, segmentDelta)
+		const selectedPart = selectNewPartWithOffsets(this._context, this._playoutModel, partDelta, segmentDelta)
+		if (selectedPart) await setNextPartFromPart(this._context, this._playoutModel, selectedPart, true)
 	}
 
 	async updatePartInstance(