diff --git a/apps/client/src/AppRouter.tsx b/apps/client/src/AppRouter.tsx index 34d21b950..f9e1e4b0d 100644 --- a/apps/client/src/AppRouter.tsx +++ b/apps/client/src/AppRouter.tsx @@ -20,6 +20,7 @@ const Backstage = lazy(() => import('./views/backstage/Backstage')); const StudioClock = lazy(() => import('./views/studio/Studio')); const Timeline = lazy(() => import('./views/timeline/TimelinePage')); const ProjectInfo = lazy(() => import('./views/project-info/ProjectInfo')); +const Teleprompter = lazy(() => import('./views/teleprompter/Teleprompter')); const Editor = lazy(() => import('./views/editor/ProtectedEditor')); const Cuesheet = lazy(() => import('./views/cuesheet/ProtectedCuesheet')); @@ -95,6 +96,15 @@ export default function AppRouter() { } /> + + + + + } + /> {/*/!* Protected Routes *!/*/} } /> } /> @@ -165,6 +175,7 @@ const PresetViewMap: Record = { [OntimeView.StudioClock]: StudioClock, [OntimeView.Countdown]: Countdown, [OntimeView.ProjectInfo]: ProjectInfo, + [OntimeView.Teleprompter]: Teleprompter, }; /** @@ -214,8 +225,14 @@ function PresetView() { const Component = PresetViewMap[preset.target as OntimeViewPresettable]; return ( - - {Component ? : } + + + {Component ? : } + ); } diff --git a/apps/client/src/common/components/keyboard-shortcuts/KeyboardShortcuts.module.scss b/apps/client/src/common/components/keyboard-shortcuts/KeyboardShortcuts.module.scss new file mode 100644 index 000000000..3e25046e9 --- /dev/null +++ b/apps/client/src/common/components/keyboard-shortcuts/KeyboardShortcuts.module.scss @@ -0,0 +1,66 @@ +.groups { + display: grid; + gap: 0.875rem; +} + +.group { + h3 { + margin: 0 0 0.375rem; + color: var(--shortcut-title-color, currentColor); + font-size: calc(1rem - 3px); + font-weight: 600; + text-transform: uppercase; + } +} + +.list { + display: grid; + gap: 0.25rem; +} + +.row { + min-height: 1.625rem; + display: grid; + grid-template-columns: minmax(10rem, 1fr) minmax(0, auto); + align-items: center; + gap: 0.75rem; + font-size: calc(1rem - 3px); +} + +.label { + min-width: 0; + line-height: 1.2; + color: var(--shortcut-label-color, currentColor); +} + +.keys { + display: inline-flex; + align-items: center; + flex-wrap: wrap; + justify-content: flex-end; + gap: 0.25rem 0.5rem; + min-width: 0; +} + +.combo { + display: inline-flex; + align-items: center; + flex-wrap: nowrap; + gap: 0.25rem 0; +} + +.separator { + color: var(--shortcut-separator-color, currentColor); + font-size: calc(1rem - 5px); +} + +@media (max-width: 680px) { + .row { + grid-template-columns: 1fr; + gap: 0.25rem; + } + + .keys { + justify-content: flex-start; + } +} diff --git a/apps/client/src/common/components/keyboard-shortcuts/KeyboardShortcuts.tsx b/apps/client/src/common/components/keyboard-shortcuts/KeyboardShortcuts.tsx new file mode 100644 index 000000000..503702d35 --- /dev/null +++ b/apps/client/src/common/components/keyboard-shortcuts/KeyboardShortcuts.tsx @@ -0,0 +1,42 @@ +import type { PropsWithChildren } from 'react'; + +import { cx } from '../../utils/styleUtils'; +import Kbd from '../kbd/Kbd'; + +import style from './KeyboardShortcuts.module.scss'; + +export function ShortcutGroups({ className, children }: PropsWithChildren<{ className?: string }>) { + return
{children}
; +} + +export function ShortcutGroup({ title, children }: PropsWithChildren<{ title: string }>) { + return ( +
+

{title}

+
{children}
+
+ ); +} + +export function Shortcut({ label, children }: PropsWithChildren<{ label: string }>) { + return ( +
+ {label} + {children} +
+ ); +} + +export function Combo({ keys }: { keys: string[] }) { + return ( + + {keys.map((key) => ( + {key} + ))} + + ); +} + +export function Separator() { + return /; +} diff --git a/apps/client/src/common/components/navigation-menu/ViewNavigationMenu.tsx b/apps/client/src/common/components/navigation-menu/ViewNavigationMenu.tsx index 09fbfcc56..10128ee4a 100644 --- a/apps/client/src/common/components/navigation-menu/ViewNavigationMenu.tsx +++ b/apps/client/src/common/components/navigation-menu/ViewNavigationMenu.tsx @@ -13,6 +13,8 @@ interface ViewNavigationMenuProps { isNavigationLocked?: boolean; /** prevent showing settings */ suppressSettings?: boolean; + /** leave Space to the view, which needs it for its own transport */ + suppressSpaceHotkey?: boolean; } function isInteractiveKeyboardAction(target: EventTarget | null): boolean { @@ -28,7 +30,7 @@ function isInteractiveKeyboardAction(target: EventTarget | null): boolean { } export default memo(ViewNavigationMenu); -function ViewNavigationMenu({ isNavigationLocked, suppressSettings }: ViewNavigationMenuProps) { +function ViewNavigationMenu({ isNavigationLocked, suppressSettings, suppressSpaceHotkey }: ViewNavigationMenuProps) { const [isMenuOpen, setIsMenuOpen] = useState(false); const { open: showEditFormDrawer } = useViewParamsEditorStore(); const [searchParams] = useSearchParams(); @@ -41,7 +43,7 @@ function ViewNavigationMenu({ isNavigationLocked, suppressSettings }: ViewNaviga [ 'Space', (event) => { - if (isNavigationLocked || isInteractiveKeyboardAction(event.target)) return; + if (suppressSpaceHotkey || isNavigationLocked || isInteractiveKeyboardAction(event.target)) return; event.preventDefault(); toggleMenu(); }, diff --git a/apps/client/src/common/components/view-params-editor/ParamInput.tsx b/apps/client/src/common/components/view-params-editor/ParamInput.tsx index 764a38bb8..2a51cfa7a 100644 --- a/apps/client/src/common/components/view-params-editor/ParamInput.tsx +++ b/apps/client/src/common/components/view-params-editor/ParamInput.tsx @@ -50,7 +50,13 @@ export default function ParamInput({ paramField }: ParamInputProps) { } if (type === 'boolean') { - return ; + const paramValue = searchParams.get(id); + return ( + + ); } if (type === 'number') { diff --git a/apps/client/src/common/components/view-params-editor/__tests__/viewParams.utils.test.ts b/apps/client/src/common/components/view-params-editor/__tests__/viewParams.utils.test.ts index 2a0134fde..79e29b8a6 100644 --- a/apps/client/src/common/components/view-params-editor/__tests__/viewParams.utils.test.ts +++ b/apps/client/src/common/components/view-params-editor/__tests__/viewParams.utils.test.ts @@ -228,11 +228,41 @@ describe('getURLSearchParamsFromObj()', () => { }, ]; const params = { - bool1: 'off', bool2: 'on', }; const result = getURLSearchParamsFromObj(params, mockOptionsWithBooleans); expect(result.get('bool1')).toBe('false'); expect(result.get('bool2')).toBe('true'); }); + + it('omits booleans which match their default', () => { + const mockOptionsWithBooleans: ViewOption[] = [ + { + title: OptionTitle.StyleOverride, + options: [ + { + id: 'onByDefault', + title: 'onByDefault', + description: 'On by default', + type: 'boolean', + defaultValue: true, + }, + { + id: 'offByDefault', + title: 'offByDefault', + description: 'Off by default', + type: 'boolean', + defaultValue: false, + }, + ], + }, + ]; + + const untouched = getURLSearchParamsFromObj({ onByDefault: 'on' }, mockOptionsWithBooleans); + expect(untouched.toString()).toBe(''); + + const flipped = getURLSearchParamsFromObj({ offByDefault: 'on' }, mockOptionsWithBooleans); + expect(flipped.get('onByDefault')).toBe('false'); + expect(flipped.get('offByDefault')).toBe('true'); + }); }); diff --git a/apps/client/src/common/components/view-params-editor/viewParams.utils.ts b/apps/client/src/common/components/view-params-editor/viewParams.utils.ts index 5f7d4d8f9..97ddd6ef8 100644 --- a/apps/client/src/common/components/view-params-editor/viewParams.utils.ts +++ b/apps/client/src/common/components/view-params-editor/viewParams.utils.ts @@ -155,6 +155,14 @@ export function getURLSearchParamsFromObj(paramsObj: ViewParamsObj, paramFields: }); }); + // Unchecked checkboxes are absent from FormData. Persist false when true is the default. + metadata.booleanFields.forEach((id) => { + if (id in paramsObj) return; + if (metadata.defaultValues[id] !== 'false') { + addUniqueParam(id, 'false'); + } + }); + // Then process user-provided values Object.entries(paramsObj).forEach(([id, value]) => { if (typeof value === 'string' && value.length) { diff --git a/apps/client/src/features/app-settings/panel/feature-panel/composite/URLPresetForm.tsx b/apps/client/src/features/app-settings/panel/feature-panel/composite/URLPresetForm.tsx index 5bec107d6..ba234edc6 100644 --- a/apps/client/src/features/app-settings/panel/feature-panel/composite/URLPresetForm.tsx +++ b/apps/client/src/features/app-settings/panel/feature-panel/composite/URLPresetForm.tsx @@ -26,6 +26,7 @@ const targetOptions: SelectOption[] = [ { value: OntimeView.Timeline, label: viewLabels[OntimeView.Timeline] }, { value: OntimeView.StudioClock, label: viewLabels[OntimeView.StudioClock] }, { value: OntimeView.Countdown, label: viewLabels[OntimeView.Countdown] }, + { value: OntimeView.Teleprompter, label: viewLabels[OntimeView.Teleprompter] }, { value: OntimeView.ProjectInfo, label: viewLabels[OntimeView.ProjectInfo] }, ]; diff --git a/apps/client/src/features/rundown/entry-editor/EventEditorEmpty.module.scss b/apps/client/src/features/rundown/entry-editor/EventEditorEmpty.module.scss index 47ef5fb36..74c5a8f5a 100644 --- a/apps/client/src/features/rundown/entry-editor/EventEditorEmpty.module.scss +++ b/apps/client/src/features/rundown/entry-editor/EventEditorEmpty.module.scss @@ -17,59 +17,10 @@ } .shortcuts { - display: grid; - gap: 0.875rem; margin-top: 0.875rem; -} -.shortcutGroup { - h3 { - margin: 0 0 0.375rem; - color: $ui-white; - font-size: calc(1rem - 3px); - font-weight: 600; - text-transform: uppercase; - } -} - -.shortcutList { - display: grid; - gap: 0.25rem; -} - -.shortcutRow { - min-height: 1.625rem; - display: grid; - grid-template-columns: minmax(10rem, 1fr) minmax(0, auto); - align-items: center; - gap: 0.75rem; - font-size: calc(1rem - 3px); -} - -.shortcutLabel { - min-width: 0; - line-height: 1.2; -} - -.shortcutKeys { - display: inline-flex; - align-items: center; - flex-wrap: wrap; - justify-content: flex-end; - gap: 0.25rem 0.5rem; - min-width: 0; -} - -.keyCombo { - display: inline-flex; - align-items: center; - flex-wrap: nowrap; - gap: 0.25rem 0; -} - -.separator { - color: $gray-500; - font-size: calc(1rem - 5px); + --shortcut-title-color: #{$ui-white}; + --shortcut-separator-color: #{$gray-500}; } .prompt { @@ -84,13 +35,4 @@ .shortcutSection { margin-top: 1rem; } - - .shortcutRow { - grid-template-columns: 1fr; - gap: 0.25rem; - } - - .shortcutKeys { - justify-content: flex-start; - } } diff --git a/apps/client/src/features/rundown/entry-editor/EventEditorEmpty.tsx b/apps/client/src/features/rundown/entry-editor/EventEditorEmpty.tsx index 09d69fb13..610c334ec 100644 --- a/apps/client/src/features/rundown/entry-editor/EventEditorEmpty.tsx +++ b/apps/client/src/features/rundown/entry-editor/EventEditorEmpty.tsx @@ -1,7 +1,13 @@ -import { PropsWithChildren, memo } from 'react'; +import { memo } from 'react'; import * as Editor from '../../../common/components/editor-utils/EditorUtils'; -import Kbd from '../../../common/components/kbd/Kbd'; +import { + Combo, + Separator, + Shortcut, + ShortcutGroup, + ShortcutGroups, +} from '../../../common/components/keyboard-shortcuts/KeyboardShortcuts'; import { deviceAlt, deviceMod } from '../../../common/utils/deviceUtils'; import style from './EventEditorEmpty.module.scss'; @@ -13,7 +19,7 @@ function EventEditorEmpty() {
Rundown shortcuts -
+ @@ -100,40 +106,8 @@ function EventEditorEmpty() { -
+
); } - -function ShortcutGroup({ title, children }: PropsWithChildren<{ title: string }>) { - return ( -
-

{title}

-
{children}
-
- ); -} - -function Shortcut({ label, children }: PropsWithChildren<{ label: string }>) { - return ( -
- {label} - {children} -
- ); -} - -function Combo({ keys }: { keys: string[] }) { - return ( - - {keys.map((key) => ( - {key} - ))} - - ); -} - -function Separator() { - return /; -} diff --git a/apps/client/src/features/sharing/GenerateLinkFormExport.tsx b/apps/client/src/features/sharing/GenerateLinkFormExport.tsx index 5b5564c4d..21337ff6f 100644 --- a/apps/client/src/features/sharing/GenerateLinkFormExport.tsx +++ b/apps/client/src/features/sharing/GenerateLinkFormExport.tsx @@ -35,6 +35,7 @@ export default function GenerateLinkFormExport({ lockedPath }: GenerateLinkFormE { value: OntimeView.Timer, label: 'Timer' }, { value: OntimeView.Cuesheet, label: 'Cuesheet' }, { value: OntimeView.Operator, label: 'Operator' }, + { value: OntimeView.Teleprompter, label: 'Teleprompter' }, { value: '<>', label: 'Companion' }, ...urlPresetData.map((preset) => ({ value: `preset-${preset.alias}`, diff --git a/apps/client/src/viewerConfig.ts b/apps/client/src/viewerConfig.ts index 2b9799df4..fa23cbac2 100644 --- a/apps/client/src/viewerConfig.ts +++ b/apps/client/src/viewerConfig.ts @@ -10,6 +10,7 @@ export const viewLabels: Record = { [OntimeView.Timeline]: 'Timeline', [OntimeView.StudioClock]: 'Studio Clock', [OntimeView.Countdown]: 'Countdown', + [OntimeView.Teleprompter]: 'Teleprompter', [OntimeView.ProjectInfo]: 'Project Info', }; @@ -20,6 +21,7 @@ const navigatorViews = [ OntimeView.Timeline, OntimeView.StudioClock, OntimeView.Countdown, + OntimeView.Teleprompter, OntimeView.ProjectInfo, ]; diff --git a/apps/client/src/views/teleprompter/Teleprompter.scss b/apps/client/src/views/teleprompter/Teleprompter.scss new file mode 100644 index 000000000..3db72a64b --- /dev/null +++ b/apps/client/src/views/teleprompter/Teleprompter.scss @@ -0,0 +1,215 @@ +@use '@/theme/viewerDefs' as *; + +.teleprompter { + --tp-flip-x: 1; + --tp-flip-y: 1; + + /* Keep shared stage-screen settings usable on smaller clients. */ + --tp-font-size: min(var(--tp-configured-font-size), 8vw); + + position: relative; + height: 100dvh; + width: 100%; + overflow: hidden; + + font-family: var(--font-family-override, $viewer-font-family); + background: var(--background-color-override, #000000); + color: var(--color-override, #ffffff); + + transform: scale(var(--tp-flip-x), var(--tp-flip-y)); + transform-origin: center center; + + &--flip-h { + --tp-flip-x: -1; + } + + &--flip-v { + --tp-flip-y: -1; + } +} + +.teleprompter__scroller { + height: 100%; + overflow-y: auto; + overscroll-behavior: contain; + + /* The animation loop is the only writer of scrollTop. */ + overflow-anchor: none; + scroll-behavior: auto; + + scrollbar-width: none; + &::-webkit-scrollbar { + display: none; + } +} + +.teleprompter__content { + width: var(--tp-text-width); + margin-inline: auto; + + font-size: var(--tp-font-size); + line-height: var(--tp-line-height); + + /* Percent padding resolves against width, so use viewport-height units. */ + padding-top: calc(var(--tp-reading-line) * 1dvh); + padding-bottom: calc(100dvh - var(--tp-reading-line) * 1dvh); +} + +.teleprompter__block { + margin-bottom: 1em; + + &[data-loaded] .teleprompter__heading { + color: $accent-color; + } + + /* Holds the eye on the cued event without hiding what is around it, which is + what the reader needs when they are recovering from being ahead or behind. */ + .teleprompter--has-playing &:not([data-loaded]) { + opacity: 0.45; + } +} + +.teleprompter__group { + font-size: 0.34em; + text-transform: uppercase; + letter-spacing: 0.1em; + color: $viewer-label-color; + margin-bottom: 0.35em; +} + +.teleprompter__heading { + font-size: 0.38em; + font-weight: 600; + text-transform: uppercase; + letter-spacing: 0.05em; + color: $viewer-secondary-color; + margin-bottom: 0.3em; +} + +.teleprompter__body { + white-space: pre-wrap; + overflow-wrap: break-word; +} + +.teleprompter__dim { + position: absolute; + inset: 0 0 auto 0; + height: calc(var(--tp-reading-line) * 1%); + pointer-events: none; + background: linear-gradient(to bottom, rgba(0, 0, 0, 0.8), rgba(0, 0, 0, 0)); +} + +.teleprompter__reading-line { + position: absolute; + top: calc(var(--tp-reading-line) * 1%); + left: 0; + right: 0; + width: var(--tp-text-width); + margin-inline: auto; + height: calc(var(--tp-font-size) * var(--tp-line-height)); + pointer-events: none; +} + +.teleprompter__reading-marker { + position: absolute; + top: 0; + bottom: 0; + background: $accent-color; + clip-path: polygon(0 0, 100% 50%, 0 100%); + font-size: var(--tp-font-size); + + --tp-gutter: max(0px, calc((100vw - 100%) / 2)); + width: min(1.2em, calc(var(--tp-gutter) * 0.6)); + right: calc(100% + var(--tp-gutter) * 0.2); +} + +.teleprompter__controls { + position: absolute; + bottom: min(2vh, 16px); + left: 50%; + + /* Cancel the view flip so controls remain readable to the operator. */ + transform: translateX(-50%) scale(var(--tp-flip-x), var(--tp-flip-y)); + + display: flex; + align-items: center; + gap: min(1vh, 8px); + padding: min(1vh, 8px) clamp(8px, 1vw, 16px); + + background: rgba(white, 8%); + border-radius: $element-border-radius; + backdrop-filter: blur(6px); + + opacity: 1; + transition: opacity $viewer-transition-time; + + &--idle { + opacity: 0; + pointer-events: none; + } +} + +.teleprompter__speed { + display: flex; + align-items: baseline; + gap: 0.2em; + min-width: 4em; + justify-content: center; + font-size: clamp(14px, 1.4vw, 22px); + font-variant-numeric: tabular-nums; +} + +.teleprompter__speed-unit { + font-size: 0.6em; + color: $viewer-label-color; +} + +.teleprompter__parked { + font-size: clamp(11px, 1vw, 15px); + text-transform: uppercase; + letter-spacing: 0.06em; + white-space: nowrap; + color: $viewer-label-color; +} + +.teleprompter__help { + position: fixed; + inset: 0; + background: rgba(0, 0, 0, 0.75); +} + +.teleprompter__help-card { + position: fixed; + top: 50%; + left: 50%; + transform: translate(-50%, -50%); + + width: min(92vw, 32rem); + max-height: 85dvh; + overflow-y: auto; + padding: 1.5rem; + + background: $viewer-background-color; + color: $viewer-color; + border-radius: $element-border-radius; + font-size: 1rem; +} + +.teleprompter__help-header { + display: flex; + align-items: center; + justify-content: space-between; + gap: 1rem; + margin-bottom: 1.25rem; +} + +.teleprompter__help-title { + font-size: 1.25rem; + font-weight: 600; +} + +.teleprompter__help-groups { + --shortcut-title-color: #{$viewer-label-color}; + --shortcut-label-color: #{$viewer-secondary-color}; + --shortcut-separator-color: #{$viewer-label-color}; +} diff --git a/apps/client/src/views/teleprompter/Teleprompter.tsx b/apps/client/src/views/teleprompter/Teleprompter.tsx new file mode 100644 index 000000000..990c0bf22 --- /dev/null +++ b/apps/client/src/views/teleprompter/Teleprompter.tsx @@ -0,0 +1,162 @@ +import { OntimeView } from 'ontime-types'; +import { type CSSProperties, useState } from 'react'; + +import EmptyPage from '../../common/components/state/EmptyPage'; +import ViewParamsEditor from '../../common/components/view-params-editor/ViewParamsEditor'; +import { useSelectedEventId } from '../../common/hooks/useSocket'; +import { useWindowTitle } from '../../common/hooks/useWindowTitle'; +import { useViewOptionsStore } from '../../common/stores/viewOptions'; +import { cx } from '../../common/utils/styleUtils'; +import Loader from '../common/loader/Loader'; +import ControlOverlay from './control-overlay/ControlOverlay'; +import HelpOverlay from './help-overlay/HelpOverlay'; +import ScriptBlockView from './script-block/ScriptBlock'; +import { defaults, getTeleprompterOptions, useTeleprompterOptions } from './teleprompter.options'; +import { stepFontSize } from './teleprompter.scroll'; +import { buildScript, composeFlip } from './teleprompter.utils'; +import { useSyncTeleprompterParams } from './useSyncTeleprompterParams'; +import { useTeleprompterControls } from './useTeleprompterControls'; +import { type TeleprompterData, useTeleprompterData } from './useTeleprompterData'; +import { useTeleprompterScroll } from './useTeleprompterScroll'; + +import './Teleprompter.scss'; + +export default function TeleprompterLoader() { + const { data, status } = useTeleprompterData(); + + useWindowTitle('Teleprompter'); + + if (status === 'pending') { + return ; + } + + if (status === 'error') { + return ; + } + + return ; +} + +function Teleprompter({ rundown, rundownMetadata, customFields }: TeleprompterData) { + 'use memo'; + + const options = useTeleprompterOptions(); + const selectedEventId = useSelectedEventId(); + const isMirrored = useViewOptionsStore((state) => state.mirror); + + const [showHelp, setShowHelp] = useState(false); + + const fromParams = { flipH: options.flipH, flipV: options.flipV, fontSize: options.fontSize }; + const paramsKey = `${fromParams.flipH}|${fromParams.flipV}|${fromParams.fontSize}`; + + const [live, setLive] = useState(fromParams); + const [seededFrom, setSeededFrom] = useState(paramsKey); + // Reset live controls before commit when the URL configuration changes. + if (seededFrom !== paramsKey) { + setSeededFrom(paramsKey); + setLive(fromParams); + } + + const viewOptions = getTeleprompterOptions(customFields); + + const blocks = buildScript(rundown, rundownMetadata, customFields, { + scriptSource: options.scriptSource, + heading: options.heading, + onlyPlaying: options.onlyPlaying, + hideEmpty: options.hideEmpty, + showGroups: options.showGroups, + }); + + const { scrollerRef, contentRef, registerBlock, controller, isRunning, speed, canReengageFollow, parkedAt } = + useTeleprompterScroll({ + initialSpeed: options.speed, + followLoaded: options.followLoaded, + selectedEventId, + readingLinePos: options.readingLinePos, + blocks, + }); + + const handleFlip = (axis: 'h' | 'v') => + setLive((current) => { + const key = axis === 'h' ? 'flipH' : 'flipV'; + return { ...current, [key]: !current[key] }; + }); + + const handleFontSize = (steps: number) => + setLive((current) => ({ ...current, fontSize: stepFontSize(current.fontSize, steps) })); + + const handleResetFontSize = () => setLive((current) => ({ ...current, fontSize: defaults.fontSize })); + const handleToggleHelp = () => setShowHelp((current) => !current); + + useSyncTeleprompterParams({ speed, fontSize: live.fontSize, flipH: live.flipH, flipV: live.flipV }); + + useTeleprompterControls({ + controller, + isHelpOpen: showHelp, + onFlip: handleFlip, + onFontSize: handleFontSize, + onResetFontSize: handleResetFontSize, + onToggleHelp: handleToggleHelp, + }); + + const hasScriptSource = options.scriptSource !== 'none'; + + const effectiveFlip = composeFlip(live.flipH, live.flipV, isMirrored); + + const viewStyles = { + '--tp-configured-font-size': `${live.fontSize}px`, + '--tp-line-height': options.lineHeight, + '--tp-text-width': `${options.textWidth}%`, + '--tp-reading-line': options.readingLinePos, + } as CSSProperties; + + return ( +
block.isLoaded) && 'teleprompter--has-playing', + ])} + style={viewStyles} + data-testid='teleprompter-view' + > + + + {!hasScriptSource ? ( + + ) : blocks.length === 0 ? ( + + ) : ( + <> +
+
+ {blocks.map((block) => ( + + ))} +
+
+ +
+ {options.readingLine && ( +
+ +
+ )} + + + + )} + + +
+ ); +} diff --git a/apps/client/src/views/teleprompter/__tests__/teleprompter.controls.test.ts b/apps/client/src/views/teleprompter/__tests__/teleprompter.controls.test.ts new file mode 100644 index 000000000..a65e9f2b7 --- /dev/null +++ b/apps/client/src/views/teleprompter/__tests__/teleprompter.controls.test.ts @@ -0,0 +1,78 @@ +import type { TeleprompterController } from '../teleprompter.types'; +import { applyTeleprompterAction } from '../useTeleprompterControls'; + +function makeController() { + const state = { + isRunning: false, + position: 10, + speed: 14, + }; + + const controller: TeleprompterController = { + play: () => { + state.isRunning = true; + }, + pause: () => { + state.isRunning = false; + }, + togglePlay: () => { + state.isRunning = !state.isRunning; + }, + nudge: (lines) => { + state.position += lines; + }, + page: () => undefined, + jumpEvent: () => undefined, + setSpeed: (speed) => { + state.speed = speed; + }, + changeSpeed: (delta) => { + state.speed += delta; + }, + rewind: () => { + state.position = 0; + }, + jumpToEnd: () => undefined, + reengageFollow: () => undefined, + }; + + return { controller, state }; +} + +const callbacks = { + onFlip: () => undefined, + onFontSize: () => undefined, + onResetFontSize: () => undefined, + onToggleHelp: () => undefined, +}; + +describe('applyTeleprompterAction()', () => { + test('preserves consecutive local playback toggles', () => { + const { controller, state } = makeController(); + + applyTeleprompterAction({ type: 'togglePlay' }, { controller, ...callbacks }); + expect(state.isRunning).toBe(true); + + applyTeleprompterAction({ type: 'togglePlay' }, { controller, ...callbacks }); + expect(state.isRunning).toBe(false); + }); + + test('preserves consecutive local speed changes', () => { + const { controller, state } = makeController(); + + applyTeleprompterAction({ type: 'speed', delta: 5 }, { controller, ...callbacks }); + applyTeleprompterAction({ type: 'speed', delta: 5 }, { controller, ...callbacks }); + + expect(state.speed).toBe(24); + }); + + test('rewinds and pauses as two base operations', () => { + const { controller, state } = makeController(); + state.isRunning = true; + + applyTeleprompterAction({ type: 'rewindAndPause' }, { controller, ...callbacks }); + + expect(state.position).toBe(0); + expect(state.isRunning).toBe(false); + }); +}); diff --git a/apps/client/src/views/teleprompter/__tests__/teleprompter.keymap.test.ts b/apps/client/src/views/teleprompter/__tests__/teleprompter.keymap.test.ts new file mode 100644 index 000000000..ca575a03c --- /dev/null +++ b/apps/client/src/views/teleprompter/__tests__/teleprompter.keymap.test.ts @@ -0,0 +1,107 @@ +import { resolveTeleprompterAction, type TeleprompterKeyEvent } from '../teleprompter.keymap'; +import { SPEED_STEP, SPEED_STEP_COARSE } from '../teleprompter.scroll'; + +function makeEvent(overrides: Partial): TeleprompterKeyEvent { + return { + code: '', + key: '', + shiftKey: false, + ctrlKey: false, + metaKey: false, + altKey: false, + repeat: false, + ...overrides, + }; +} + +describe('resolveTeleprompterAction()', () => { + test('space toggles playback', () => { + expect(resolveTeleprompterAction(makeEvent({ code: 'Space' }))).toEqual({ type: 'togglePlay' }); + }); + + test('ignores a repeating space', () => { + expect(resolveTeleprompterAction(makeEvent({ code: 'Space', repeat: true }))).toBeNull(); + }); + + test('vertical arrows nudge by a line', () => { + expect(resolveTeleprompterAction(makeEvent({ code: 'ArrowDown' }))).toEqual({ type: 'nudge', lines: 1 }); + expect(resolveTeleprompterAction(makeEvent({ code: 'ArrowUp' }))).toEqual({ type: 'nudge', lines: -1 }); + }); + + test('a repeating arrow still nudges, so the key can be held', () => { + expect(resolveTeleprompterAction(makeEvent({ code: 'ArrowDown', repeat: true }))).toEqual({ + type: 'nudge', + lines: 1, + }); + }); + + test('shift makes the vertical arrows jump a whole event', () => { + expect(resolveTeleprompterAction(makeEvent({ code: 'ArrowDown', shiftKey: true }))).toEqual({ + type: 'jumpEvent', + direction: 1, + }); + expect(resolveTeleprompterAction(makeEvent({ code: 'ArrowUp', shiftKey: true }))).toEqual({ + type: 'jumpEvent', + direction: -1, + }); + }); + + test('page keys jump a screen', () => { + expect(resolveTeleprompterAction(makeEvent({ code: 'PageDown' }))).toEqual({ type: 'page', direction: 1 }); + expect(resolveTeleprompterAction(makeEvent({ code: 'PageUp' }))).toEqual({ type: 'page', direction: -1 }); + }); + + test('horizontal arrows change speed', () => { + expect(resolveTeleprompterAction(makeEvent({ code: 'ArrowRight' }))).toEqual({ type: 'speed', delta: SPEED_STEP }); + expect(resolveTeleprompterAction(makeEvent({ code: 'ArrowLeft' }))).toEqual({ type: 'speed', delta: -SPEED_STEP }); + }); + + test('shift makes the speed step coarse', () => { + expect(resolveTeleprompterAction(makeEvent({ code: 'ArrowRight', shiftKey: true }))).toEqual({ + type: 'speed', + delta: SPEED_STEP_COARSE, + }); + expect(resolveTeleprompterAction(makeEvent({ code: 'ArrowLeft', shiftKey: true }))).toEqual({ + type: 'speed', + delta: -SPEED_STEP_COARSE, + }); + }); + + test('home rewinds and escape rewinds and stops', () => { + expect(resolveTeleprompterAction(makeEvent({ code: 'Home' }))).toEqual({ type: 'rewind' }); + expect(resolveTeleprompterAction(makeEvent({ code: 'Escape' }))).toEqual({ type: 'rewindAndPause' }); + expect(resolveTeleprompterAction(makeEvent({ code: 'End' }))).toEqual({ type: 'jumpToEnd' }); + }); + + test('f flips, shift+f flips the other axis', () => { + expect(resolveTeleprompterAction(makeEvent({ key: 'f' }))).toEqual({ type: 'flip', axis: 'h' }); + expect(resolveTeleprompterAction(makeEvent({ key: 'F', shiftKey: true }))).toEqual({ type: 'flip', axis: 'v' }); + }); + + test('changes and resets the font size', () => { + expect(resolveTeleprompterAction(makeEvent({ key: '+' }))).toEqual({ type: 'fontSize', steps: 1 }); + expect(resolveTeleprompterAction(makeEvent({ key: '=' }))).toEqual({ type: 'fontSize', steps: 1 }); + expect(resolveTeleprompterAction(makeEvent({ key: '-' }))).toEqual({ type: 'fontSize', steps: -1 }); + expect(resolveTeleprompterAction(makeEvent({ key: '_' }))).toEqual({ type: 'fontSize', steps: -1 }); + expect(resolveTeleprompterAction(makeEvent({ key: '0' }))).toEqual({ type: 'resetFontSize' }); + }); + + test('l re-engages the follow and ? shows the help', () => { + expect(resolveTeleprompterAction(makeEvent({ key: 'l' }))).toEqual({ type: 'reengageFollow' }); + expect(resolveTeleprompterAction(makeEvent({ key: '?', shiftKey: true }))).toEqual({ type: 'toggleHelp' }); + }); + + test('never shadows a shortcut which carries a modifier', () => { + expect(resolveTeleprompterAction(makeEvent({ key: ',', metaKey: true }))).toBeNull(); + expect(resolveTeleprompterAction(makeEvent({ code: 'Space', ctrlKey: true }))).toBeNull(); + expect(resolveTeleprompterAction(makeEvent({ code: 'ArrowRight', altKey: true }))).toBeNull(); + }); + + test('ignores keys it does not bind', () => { + expect(resolveTeleprompterAction(makeEvent({ code: 'KeyQ', key: 'q' }))).toBeNull(); + }); + + test('leaves Enter alone, so a focused transport button can still be pressed', () => { + expect(resolveTeleprompterAction(makeEvent({ code: 'Enter', key: 'Enter' }))).toBeNull(); + }); +}); diff --git a/apps/client/src/views/teleprompter/__tests__/teleprompter.options.test.ts b/apps/client/src/views/teleprompter/__tests__/teleprompter.options.test.ts new file mode 100644 index 000000000..b61794510 --- /dev/null +++ b/apps/client/src/views/teleprompter/__tests__/teleprompter.options.test.ts @@ -0,0 +1,109 @@ +import { getOptionsFromParams, getTeleprompterOptions } from '../teleprompter.options'; +import { DEFAULT_SPEED, MAX_SPEED, MIN_SPEED } from '../teleprompter.scroll'; + +describe('getOptionsFromParams()', () => { + test('provides sensible defaults with no params', () => { + const options = getOptionsFromParams(new URLSearchParams()); + + expect(options).toMatchObject({ + scriptSource: 'none', + heading: 'title', + hideEmpty: true, + showGroups: true, + speed: DEFAULT_SPEED, + followLoaded: true, + fontSize: 52, + lineHeight: 1.3, + textWidth: 80, + readingLine: true, + readingLinePos: 25, + flipH: false, + flipV: false, + }); + }); + + test('reads the script source verbatim so it can be handed to getPropertyValue', () => { + const options = getOptionsFromParams(new URLSearchParams('script=custom-prompter')); + expect(options.scriptSource).toBe('custom-prompter'); + }); + + test('booleans which default to true can be turned off', () => { + const options = getOptionsFromParams( + new URLSearchParams('hideEmpty=false&showGroups=false&followLoaded=false&readingLine=false'), + ); + + expect(options).toMatchObject({ + hideEmpty: false, + showGroups: false, + followLoaded: false, + readingLine: false, + }); + }); + + test('booleans which default to false can be turned on', () => { + const options = getOptionsFromParams(new URLSearchParams('flipH=true&flipV=true')); + + expect(options).toMatchObject({ + flipH: true, + flipV: true, + }); + }); + + test('clamps the speed to the usable range', () => { + expect(getOptionsFromParams(new URLSearchParams('speed=1000')).speed).toBe(MAX_SPEED); + expect(getOptionsFromParams(new URLSearchParams('speed=0')).speed).toBe(MIN_SPEED); + }); + + test('falls back to the default for a non numeric value', () => { + expect(getOptionsFromParams(new URLSearchParams('speed=fast')).speed).toBe(DEFAULT_SPEED); + expect(getOptionsFromParams(new URLSearchParams('speed=')).speed).toBe(DEFAULT_SPEED); + expect(getOptionsFromParams(new URLSearchParams('fontSize=huge')).fontSize).toBe(52); + }); + + test('rejects an unknown value for an enumerated option', () => { + expect(getOptionsFromParams(new URLSearchParams('heading=banana')).heading).toBe('title'); + }); + + test('preset values take precedence over the search params', () => { + const options = getOptionsFromParams( + new URLSearchParams('speed=10&script=custom-a'), + new URLSearchParams('speed=20&script=custom-b'), + ); + + expect(options.speed).toBe(20); + expect(options.scriptSource).toBe('custom-b'); + }); +}); + +describe('getTeleprompterOptions()', () => { + test('every declared default is what parsing an empty query produces', () => { + const parsed = getOptionsFromParams(new URLSearchParams()) as Record; + const parsedByParamId: Record = { ...parsed, script: parsed.scriptSource }; + + const declared = getTeleprompterOptions({}).flatMap((section) => section.options); + expect(declared.length).toBeGreaterThan(0); + + for (const field of declared) { + if (!('defaultValue' in field) || field.defaultValue === undefined) continue; + const expected = field.defaultValue; + expect({ id: field.id, value: parsedByParamId[field.id] }).toEqual({ id: field.id, value: expected }); + } + }); +}); + +describe('option value round trip', () => { + test('every value the editor offers survives parsing', () => { + const selects = getTeleprompterOptions({}) + .flatMap((section) => section.options) + .filter((field) => field.type === 'option' && field.id !== 'script'); + + expect(selects.length).toBeGreaterThan(0); + + for (const field of selects) { + for (const { value } of field.values) { + const parsed = getOptionsFromParams(new URLSearchParams(`${field.id}=${value}`)) as Record; + expect({ id: field.id, value, parsed: parsed[field.id] }).toEqual({ id: field.id, value, parsed: value }); + } + } + }); +}); diff --git a/apps/client/src/views/teleprompter/__tests__/teleprompter.scroll.test.ts b/apps/client/src/views/teleprompter/__tests__/teleprompter.scroll.test.ts new file mode 100644 index 000000000..33b53136e --- /dev/null +++ b/apps/client/src/views/teleprompter/__tests__/teleprompter.scroll.test.ts @@ -0,0 +1,293 @@ +import { + advance, + anchorAtReadPoint, + type BlockGeometry, + clampSpeed, + easeCatchUp, + FOLLOW_BREAK_LINES, + frameDeltaSeconds, + hasBrokenFollow, + indexAtReadPoint, + linesPerMinuteToPxPerSecond, + MAX_FONT_SIZE, + MAX_FRAME_DELTA_MS, + MAX_SPEED, + MIN_FONT_SIZE, + MIN_SPEED, + readPointForAnchor, + segmentAfter, + segmentEndFor, + stepFontSize, +} from '../teleprompter.scroll'; + +describe('linesPerMinuteToPxPerSecond()', () => { + test('converts a read rate into a pixel rate', () => { + // 30 lines a minute over a 64px line is half a line a second + expect(linesPerMinuteToPxPerSecond(30, 64)).toBe(32); + }); +}); + +describe('stepFontSize()', () => { + test('steps by a ratio, so a press is the same visual change at any size', () => { + // a fixed pixel step would be a big jump at 20px and imperceptible at 200px + expect(stepFontSize(100, 1)).toBe(110); + expect(stepFontSize(20, 1)).toBe(22); + }); + + test('shrinking undoes growing', () => { + expect(stepFontSize(stepFontSize(50, 1), -1)).toBe(50); + }); + + test('stays inside the range the option accepts', () => { + expect(stepFontSize(MAX_FONT_SIZE, 5)).toBe(MAX_FONT_SIZE); + expect(stepFontSize(MIN_FONT_SIZE, -5)).toBe(MIN_FONT_SIZE); + }); +}); + +describe('clampSpeed()', () => { + test('bounds the speed to the usable range', () => { + expect(clampSpeed(MIN_SPEED - 10)).toBe(MIN_SPEED); + expect(clampSpeed(MAX_SPEED + 10)).toBe(MAX_SPEED); + expect(clampSpeed(30)).toBe(30); + }); + + test('falls back to the minimum for a non number, rather than stalling at zero', () => { + expect(clampSpeed(Number.NaN)).toBe(MIN_SPEED); + }); +}); + +describe('frameDeltaSeconds()', () => { + test('clamps a long gap so returning to a background tab cannot teleport the script', () => { + // requestAnimationFrame is suspended while hidden, so the first timestamp + // back can be minutes stale + expect(frameDeltaSeconds(1000 / 60)).toBeCloseTo(1 / 60, 6); + expect(frameDeltaSeconds(60_000)).toBe(MAX_FRAME_DELTA_MS / 1000); + }); + + test('ignores nonsense deltas', () => { + expect(frameDeltaSeconds(-5)).toBe(0); + expect(frameDeltaSeconds(Number.NaN)).toBe(0); + }); +}); + +describe('advance()', () => { + test('accumulates sub-pixel movement without losing any to rounding', () => { + // 32px/s sampled at 60fps is 0.53px a frame: rounding each frame would stall + const pxPerSecond = 32; + const frame = 1 / 60; + let position = 0; + + for (let i = 0; i < 100; i += 1) { + position = advance(position, pxPerSecond, frame, 10_000).position; + } + + expect(position).toBeCloseTo((pxPerSecond * 100) / 60, 5); + }); + + test('reports the end of the script once the bottom is reached', () => { + expect(advance(499, 100, 1, 500).atEnd).toBe(true); + expect(advance(100, 100, 1, 500).atEnd).toBe(false); + }); + + test('reports the end without bounding the position, which the caller owns', () => { + // the loop has to bound the position anyway, for nudges and for a document + // which shrank, so this does not do it a second time + expect(advance(490, 100, 1, 500)).toEqual({ position: 590, atEnd: true }); + }); + + test('never reports the end for a document which does not overflow', () => { + // it may simply not have been measured yet, and stopping playback on an + // unmeasured document would look like the prompter refusing to run + expect(advance(0, 100, 1, 0).atEnd).toBe(false); + }); +}); + +describe('hasBrokenFollow()', () => { + const lineHeight = 40; + + test('tolerates drift under the threshold, so momentum or a stray touch does not break it', () => { + const underThreshold = lineHeight * FOLLOW_BREAK_LINES - 1; + expect(hasBrokenFollow(underThreshold, lineHeight)).toBe(false); + expect(hasBrokenFollow(-underThreshold, lineHeight)).toBe(false); + }); + + test('counts a deliberate scroll past the threshold, in either direction', () => { + const overThreshold = lineHeight * FOLLOW_BREAK_LINES + 1; + expect(hasBrokenFollow(overThreshold, lineHeight)).toBe(true); + expect(hasBrokenFollow(-overThreshold, lineHeight)).toBe(true); + }); + + test('never breaks follow before the document has been measured', () => { + // an unmeasured line height would make any distance look like a break + expect(hasBrokenFollow(10_000, 0)).toBe(false); + }); +}); + +describe('the read anchor', () => { + const script: BlockGeometry[] = [ + { id: 'welcome', top: 0, height: 100 }, + { id: 'keynote', top: 100, height: 300 }, + { id: 'lunch', top: 400, height: 100 }, + ]; + const ids = script.map((block) => block.id); + + describe('indexAtReadPoint()', () => { + test('finds the block the reading line is over', () => { + expect(indexAtReadPoint(150, script)).toBe(1); + expect(indexAtReadPoint(400, script)).toBe(2); + }); + + test('clamps past either end, so a jump from there still lands on a block', () => { + expect(indexAtReadPoint(-50, script)).toBe(0); + expect(indexAtReadPoint(10_000, script)).toBe(2); + }); + + test('reports no block for an empty script', () => { + expect(indexAtReadPoint(0, [])).toBe(-1); + }); + }); + + describe('readPointForAnchor()', () => { + test('round trips an unchanged document', () => { + const anchor = anchorAtReadPoint(250, script); + expect(anchor).toEqual({ blockId: 'keynote', offset: 150 }); + expect(readPointForAnchor(anchor!, script, ids)).toBe(250); + }); + + test('holds the same words under the reading line when an event above grows', () => { + // the whole point: the rundown is edited while it is being read, and an + // edit above the reader moves every pixel below it + const anchor = anchorAtReadPoint(250, script); + const grown: BlockGeometry[] = [ + { id: 'welcome', top: 0, height: 180 }, + { id: 'keynote', top: 180, height: 300 }, + { id: 'lunch', top: 480, height: 100 }, + ]; + expect(readPointForAnchor(anchor!, grown, ids)).toBe(330); + }); + + test('follows the anchored event when the rundown is reordered', () => { + const anchor = anchorAtReadPoint(250, script); + const reordered: BlockGeometry[] = [ + { id: 'lunch', top: 0, height: 100 }, + { id: 'welcome', top: 100, height: 100 }, + { id: 'keynote', top: 200, height: 300 }, + ]; + expect(readPointForAnchor(anchor!, reordered, ids)).toBe(350); + }); + + test('stays inside an event which was edited shorter than the read offset', () => { + const anchor = anchorAtReadPoint(250, script); + const trimmed: BlockGeometry[] = [ + { id: 'welcome', top: 0, height: 100 }, + { id: 'keynote', top: 100, height: 40 }, + { id: 'lunch', top: 140, height: 100 }, + ]; + expect(readPointForAnchor(anchor!, trimmed, ids)).toBe(140); + }); + + test('falls back to the end of the nearest surviving event when the anchored one is deleted', () => { + // where the deleted text used to begin, rather than wherever its pixels + // now happen to point + const anchor = anchorAtReadPoint(250, script); + const deleted: BlockGeometry[] = [ + { id: 'welcome', top: 0, height: 100 }, + { id: 'lunch', top: 100, height: 100 }, + ]; + expect(readPointForAnchor(anchor!, deleted, ids)).toBe(100); + }); + + test('gives up rather than guessing when nothing before the anchor survives', () => { + const anchor = anchorAtReadPoint(250, script); + expect(readPointForAnchor(anchor!, [{ id: 'lunch', top: 0, height: 100 }], ids)).toBeNull(); + }); + }); +}); + +describe('segmentAfter()', () => { + const readingOffset = 100; + const script: BlockGeometry[] = [ + { id: 'welcome', top: 0, height: 300 }, + { id: 'keynote', top: 300, height: 500 }, + ]; + + const endAfter = (position: number) => { + const block = segmentAfter(position, readingOffset, script); + return block === null ? null : segmentEndFor(block, readingOffset); + }; + + test('stops playback at the end of the segment being read', () => { + // an event has a stop of its own, and running on would read a segment + // nobody cued: at a conference, the next speaker's script + expect(endAfter(0)).toBe(200); + expect(endAfter(150)).toBe(200); + }); + + test('moves on to the next segment from a position already parked on a boundary', () => { + // otherwise playback would stop again where it already is, and the reader + // could never start the next event by pressing play + expect(endAfter(200)).toBe(700); + }); + + test('treats a position within measurement noise of a boundary as parked on it', () => { + // re-measuring can leave the parked position a fraction off the boundary, + // and a sub-pixel run to it would look like play doing nothing at all + expect(endAfter(199.5)).toBe(700); + expect(endAfter(190)).toBe(200); + }); + + test('gives up the bound past the last segment, leaving the end of the script', () => { + expect(endAfter(700)).toBeNull(); + }); + + test('has no boundary to stop at in a single segment script', () => { + // the plain use of pointing at some text and scrolling through it + const single: BlockGeometry[] = [{ id: 'only', top: 0, height: 5000 }]; + expect(segmentAfter(0, readingOffset, single)?.id).toBe('only'); + expect(segmentAfter(4900, readingOffset, single)).toBeNull(); + }); +}); + +describe('easeCatchUp()', () => { + test('approaches the target monotonically from either side', () => { + let fromAbove = 500; + let fromBelow = 0; + let previousAbove = 501; + let previousBelow = -1; + + for (let i = 0; i < 20; i += 1) { + fromBelow = easeCatchUp(fromBelow, 500, 1 / 60); + fromAbove = easeCatchUp(fromAbove, 0, 1 / 60); + + expect(fromBelow).toBeGreaterThan(previousBelow); + expect(fromBelow).toBeLessThanOrEqual(500); + expect(fromAbove).toBeLessThan(previousAbove); + expect(fromAbove).toBeGreaterThanOrEqual(0); + + previousBelow = fromBelow; + previousAbove = fromAbove; + } + }); + + test('settles exactly on the target instead of creeping forever', () => { + let position = 0; + for (let i = 0; i < 300; i += 1) { + position = easeCatchUp(position, 500, 1 / 60); + } + expect(position).toBe(500); + }); + + test('is framerate independent, so a jump takes the same time on any display', () => { + let atSixty = 0; + for (let i = 0; i < 60; i += 1) { + atSixty = easeCatchUp(atSixty, 1000, 1 / 60); + } + + let atThirty = 0; + for (let i = 0; i < 30; i += 1) { + atThirty = easeCatchUp(atThirty, 1000, 1 / 30); + } + + expect(atSixty).toBeCloseTo(atThirty, 3); + }); +}); diff --git a/apps/client/src/views/teleprompter/__tests__/teleprompter.utils.test.ts b/apps/client/src/views/teleprompter/__tests__/teleprompter.utils.test.ts new file mode 100644 index 000000000..ba6b7d5ac --- /dev/null +++ b/apps/client/src/views/teleprompter/__tests__/teleprompter.utils.test.ts @@ -0,0 +1,239 @@ +import { type CustomFields, type OntimeEntry, type Rundown, SupportedEntry } from 'ontime-types'; + +import type { RundownMetadata, RundownMetadataObject } from '../../../common/utils/rundownMetadata'; +import { buildScript, composeFlip } from '../teleprompter.utils'; + +function makeEvent(id: string, overrides: Partial = {}): OntimeEntry { + return { + type: SupportedEntry.Event, + id, + cue: id.toUpperCase(), + title: `Title ${id}`, + note: `Note ${id}`, + skip: false, + custom: { script: `Script ${id}` }, + parent: null, + ...overrides, + } as OntimeEntry; +} + +function makeGroup(id: string, title: string, entries: string[]): OntimeEntry { + return { type: SupportedEntry.Group, id, title, entries } as OntimeEntry; +} + +function makeMetadata(overrides: Partial = {}): RundownMetadata { + return { isPast: false, isLoaded: false, groupId: null, ...overrides } as RundownMetadata; +} + +function makeRundown(entries: OntimeEntry[], flatOrder?: string[]): Rundown { + return { + id: 'default', + title: 'test', + order: flatOrder ?? entries.map((entry) => entry.id), + flatOrder: flatOrder ?? entries.map((entry) => entry.id), + entries: Object.fromEntries(entries.map((entry) => [entry.id, entry])), + revision: 1, + }; +} + +const customFields: CustomFields = { + script: { type: 'text', colour: '', label: 'Script' }, + poster: { type: 'image', colour: '', label: 'Poster' }, +}; + +const defaultOptions = { + scriptSource: 'custom-script', + heading: 'title' as const, + onlyPlaying: false, + hideEmpty: true, + showGroups: true, +}; + +function metadataFor(ids: string[], overrides: Record> = {}): RundownMetadataObject { + return Object.fromEntries(ids.map((id) => [id, makeMetadata(overrides[id])])); +} + +describe('buildScript()', () => { + test('resolves the script from the selected custom field, in rundown order', () => { + const rundown = makeRundown([makeEvent('a'), makeEvent('b')]); + const blocks = buildScript(rundown, metadataFor(['a', 'b']), customFields, defaultOptions); + + expect(blocks).toHaveLength(2); + expect(blocks.map((block) => block.id)).toEqual(['a', 'b']); + expect(blocks[0].text).toBe('Script a'); + }); + + test('returns nothing when no script source is selected', () => { + const rundown = makeRundown([makeEvent('a')]); + expect(buildScript(rundown, metadataFor(['a']), customFields, { ...defaultOptions, scriptSource: 'none' })).toEqual( + [], + ); + }); + + test('refuses an image custom field, which the select filters but the URL does not', () => { + const rundown = makeRundown([makeEvent('a', { custom: { poster: 'https://example.com/a.png' } })]); + const blocks = buildScript(rundown, metadataFor(['a']), customFields, { + ...defaultOptions, + scriptSource: 'custom-poster', + }); + + expect(blocks).toEqual([]); + }); + + test('reads the note and the title as script sources', () => { + const rundown = makeRundown([makeEvent('a')]); + expect( + buildScript(rundown, metadataFor(['a']), customFields, { ...defaultOptions, scriptSource: 'note' })[0].text, + ).toBe('Note a'); + expect( + buildScript(rundown, metadataFor(['a']), customFields, { ...defaultOptions, scriptSource: 'title' })[0].text, + ).toBe('Title a'); + }); + + test('skips entries which are not events', () => { + const rundown = makeRundown([ + makeEvent('a'), + { type: SupportedEntry.Delay, id: 'd', duration: 10 } as OntimeEntry, + { type: SupportedEntry.Milestone, id: 'm', title: 'milestone' } as OntimeEntry, + ]); + + const blocks = buildScript(rundown, metadataFor(['a', 'd', 'm']), customFields, defaultOptions); + expect(blocks.map((block) => block.id)).toEqual(['a']); + }); + + test('skips events flagged as skipped', () => { + const rundown = makeRundown([makeEvent('a', { skip: true }), makeEvent('b')]); + const blocks = buildScript(rundown, metadataFor(['a', 'b']), customFields, defaultOptions); + expect(blocks.map((block) => block.id)).toEqual(['b']); + }); + + test('onlyPlaying narrows the script to the event being played', () => { + const rundown = makeRundown([makeEvent('a'), makeEvent('b')]); + const metadata = metadataFor(['a', 'b'], { b: { isLoaded: true } }); + + expect(buildScript(rundown, metadata, customFields, { ...defaultOptions, onlyPlaying: true }).map((b) => b.id)) // + .toEqual(['b']); + }); + + test('onlyPlaying shows the whole script while nothing is playing', () => { + // narrowing to nothing would leave a blank screen, which is a worse answer + // than the script the reader asked to see + const rundown = makeRundown([makeEvent('a'), makeEvent('b')]); + + expect( + buildScript(rundown, metadataFor(['a', 'b']), customFields, { ...defaultOptions, onlyPlaying: true }).map( + (b) => b.id, + ), + ).toEqual(['a', 'b']); + }); + + test('hideEmpty drops events with no script text', () => { + const rundown = makeRundown([makeEvent('a', { custom: { script: ' ' } }), makeEvent('b')]); + + expect(buildScript(rundown, metadataFor(['a', 'b']), customFields, defaultOptions).map((b) => b.id)).toEqual(['b']); + expect( + buildScript(rundown, metadataFor(['a', 'b']), customFields, { ...defaultOptions, hideEmpty: false }).map( + (b) => b.id, + ), + ).toEqual(['a', 'b']); + }); + + test('marks the block belonging to the loaded event', () => { + const rundown = makeRundown([makeEvent('a'), makeEvent('b')]); + const metadata = metadataFor(['a', 'b'], { b: { isLoaded: true } }); + + const blocks = buildScript(rundown, metadata, customFields, defaultOptions); + expect(blocks.map((block) => block.isLoaded)).toEqual([false, true]); + }); + + test('emits a group title once, on the first block of the group', () => { + const rundown = makeRundown( + [makeGroup('g', 'Morning session', ['a', 'b']), makeEvent('a'), makeEvent('b')], + ['g', 'a', 'b'], + ); + const metadata = metadataFor(['g', 'a', 'b'], { a: { groupId: 'g' }, b: { groupId: 'g' } }); + + const blocks = buildScript(rundown, metadata, customFields, defaultOptions); + expect(blocks.map((block) => block.groupTitle)).toEqual(['Morning session', null]); + }); + + test('emits each group title as the script moves between groups', () => { + const rundown = makeRundown( + [ + makeGroup('g1', 'Morning session', ['a']), + makeEvent('a'), + makeGroup('g2', 'Afternoon session', ['b']), + makeEvent('b'), + ], + ['g1', 'a', 'g2', 'b'], + ); + const metadata = metadataFor(['g1', 'a', 'g2', 'b'], { a: { groupId: 'g1' }, b: { groupId: 'g2' } }); + + const blocks = buildScript(rundown, metadata, customFields, defaultOptions); + expect(blocks.map((block) => block.groupTitle)).toEqual(['Morning session', 'Afternoon session']); + }); + + test('repeats a group title when the script returns to it after an ungrouped event', () => { + // the reader has lost the context by then, so naming the group again is right + const rundown = makeRundown( + [makeGroup('g', 'Morning session', ['a', 'c']), makeEvent('a'), makeEvent('b'), makeEvent('c')], + ['g', 'a', 'b', 'c'], + ); + const metadata = metadataFor(['g', 'a', 'b', 'c'], { a: { groupId: 'g' }, c: { groupId: 'g' } }); + + const blocks = buildScript(rundown, metadata, customFields, defaultOptions); + expect(blocks.map((block) => block.groupTitle)).toEqual(['Morning session', null, 'Morning session']); + }); + + test('does not emit group titles when they are turned off', () => { + const rundown = makeRundown([makeGroup('g', 'Morning session', ['a']), makeEvent('a')], ['g', 'a']); + const metadata = metadataFor(['g', 'a'], { a: { groupId: 'g' } }); + + const blocks = buildScript(rundown, metadata, customFields, { ...defaultOptions, showGroups: false }); + expect(blocks[0].groupTitle).toBeNull(); + }); + + describe('headings', () => { + const rundown = makeRundown([makeEvent('a')]); + const metadata = metadataFor(['a']); + + test('shows the title, the cue, both, or nothing', () => { + expect(buildScript(rundown, metadata, customFields, { ...defaultOptions, heading: 'title' })[0].heading).toBe( + 'Title a', + ); + expect(buildScript(rundown, metadata, customFields, { ...defaultOptions, heading: 'cue' })[0].heading).toBe('A'); + expect(buildScript(rundown, metadata, customFields, { ...defaultOptions, heading: 'both' })[0].heading).toBe( + 'A · Title a', + ); + expect(buildScript(rundown, metadata, customFields, { ...defaultOptions, heading: 'none' })[0].heading).toBe(''); + }); + + test('leaves no dangling separator when an event has no cue', () => { + const noCue = makeRundown([makeEvent('a', { cue: '' })]); + expect(buildScript(noCue, metadata, customFields, { ...defaultOptions, heading: 'both' })[0].heading).toBe( + 'Title a', + ); + }); + }); +}); + +describe('composeFlip()', () => { + test('passes the per view flips through when Flip Screen is off', () => { + expect(composeFlip(false, false, false)).toEqual({ flipH: false, flipV: false }); + expect(composeFlip(true, false, false)).toEqual({ flipH: true, flipV: false }); + expect(composeFlip(false, true, false)).toEqual({ flipH: false, flipV: true }); + }); + + test('Flip Screen alone flips both axes, matching rotate(180deg) in every other view', () => { + expect(composeFlip(false, false, true)).toEqual({ flipH: true, flipV: true }); + }); + + test('a horizontal flip and Flip Screen leave only the vertical axis flipped', () => { + // scale(-1, 1) composed with scale(-1, -1) is scale(1, -1) + expect(composeFlip(true, false, true)).toEqual({ flipH: false, flipV: true }); + }); + + test('both flips cancel Flip Screen out', () => { + expect(composeFlip(true, true, true)).toEqual({ flipH: false, flipV: false }); + }); +}); diff --git a/apps/client/src/views/teleprompter/control-overlay/ControlOverlay.tsx b/apps/client/src/views/teleprompter/control-overlay/ControlOverlay.tsx new file mode 100644 index 000000000..7637fceb2 --- /dev/null +++ b/apps/client/src/views/teleprompter/control-overlay/ControlOverlay.tsx @@ -0,0 +1,139 @@ +import type { MouseEvent } from 'react'; +import { IoAdd, IoArrowUp, IoHelpCircleOutline, IoLocate, IoPause, IoPlay, IoRemove } from 'react-icons/io5'; + +import IconButton from '../../../common/components/buttons/IconButton'; +import Tooltip from '../../../common/components/tooltip/Tooltip'; +import { useFadeOutOnInactivity } from '../../../common/hooks/useFadeOutOnInactivity'; +import { cx } from '../../../common/utils/styleUtils'; +import { SPEED_STEP } from '../teleprompter.scroll'; +import type { ParkedAt, TeleprompterController } from '../teleprompter.types'; + +interface ControlOverlayProps { + isRunning: boolean; + speed: number; + canReengageFollow: boolean; + parkedAt: ParkedAt; + controller: TeleprompterController; + onToggleHelp: () => void; +} + +export default function ControlOverlay({ + isRunning, + speed, + canReengageFollow, + parkedAt, + controller, + onToggleHelp, +}: ControlOverlayProps) { + const isActive = useFadeOutOnInactivity(true); + + // Pointer activation yields focus so the next Space reaches the transport. + const press = (action: () => void) => (event: MouseEvent) => { + if (event.detail > 0) { + event.currentTarget.blur(); + } + action(); + }; + + return ( +
+ + } + > + {isRunning ? : } + + + controller.changeSpeed(-SPEED_STEP))} + aria-label='Slow down' + /> + } + > + + + +
+ {speed} + lpm +
+ + {parkedAt === 'segment' && ( + + End of event + + )} + + controller.changeSpeed(SPEED_STEP))} + aria-label='Speed up' + /> + } + > + + + + + } + > + + + + + } + > + + + + + } + > + + +
+ ); +} diff --git a/apps/client/src/views/teleprompter/help-overlay/HelpOverlay.tsx b/apps/client/src/views/teleprompter/help-overlay/HelpOverlay.tsx new file mode 100644 index 000000000..af0dcfd58 --- /dev/null +++ b/apps/client/src/views/teleprompter/help-overlay/HelpOverlay.tsx @@ -0,0 +1,107 @@ +import { Dialog } from '@base-ui/react/dialog'; +import { IoClose } from 'react-icons/io5'; + +import IconButton from '../../../common/components/buttons/IconButton'; +import { + Combo, + Separator, + Shortcut, + ShortcutGroup, + ShortcutGroups, +} from '../../../common/components/keyboard-shortcuts/KeyboardShortcuts'; + +interface HelpOverlayProps { + isOpen: boolean; + onClose: () => void; +} + +export default function HelpOverlay({ isOpen, onClose }: HelpOverlayProps) { + return ( + { + if (!open) { + onClose(); + } + }} + > + + + +
+ Prompter shortcuts + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ ); +} diff --git a/apps/client/src/views/teleprompter/script-block/ScriptBlock.tsx b/apps/client/src/views/teleprompter/script-block/ScriptBlock.tsx new file mode 100644 index 000000000..d7b3bfd3b --- /dev/null +++ b/apps/client/src/views/teleprompter/script-block/ScriptBlock.tsx @@ -0,0 +1,22 @@ +import type { ScriptBlock } from '../teleprompter.types'; + +interface ScriptBlockProps { + block: ScriptBlock; + registerRef: (id: string, element: HTMLElement | null) => void; +} + +export default function ScriptBlockView({ block, registerRef }: ScriptBlockProps) { + 'use memo'; + + return ( +
registerRef(block.id, element)} + data-loaded={block.isLoaded || undefined} + > + {block.groupTitle &&
{block.groupTitle}
} + {block.heading &&

{block.heading}

} +

{block.text}

+
+ ); +} diff --git a/apps/client/src/views/teleprompter/teleprompter.keymap.ts b/apps/client/src/views/teleprompter/teleprompter.keymap.ts new file mode 100644 index 000000000..1936150c5 --- /dev/null +++ b/apps/client/src/views/teleprompter/teleprompter.keymap.ts @@ -0,0 +1,67 @@ +import { SPEED_STEP, SPEED_STEP_COARSE } from './teleprompter.scroll'; +import type { TeleprompterAction } from './teleprompter.types'; + +export type TeleprompterKeyEvent = { + code: string; + key: string; + shiftKey: boolean; + ctrlKey: boolean; + metaKey: boolean; + altKey: boolean; + repeat: boolean; +}; + +export function resolveTeleprompterAction(event: TeleprompterKeyEvent): TeleprompterAction | null { + if (event.ctrlKey || event.metaKey || event.altKey) { + return null; + } + + switch (event.code) { + case 'Space': + return event.repeat ? null : { type: 'togglePlay' }; + // Shift is the coarser step on both axes: a bigger speed change sideways, + // a whole event rather than a line vertically. + case 'ArrowDown': + return event.shiftKey ? { type: 'jumpEvent', direction: 1 } : { type: 'nudge', lines: 1 }; + case 'ArrowUp': + return event.shiftKey ? { type: 'jumpEvent', direction: -1 } : { type: 'nudge', lines: -1 }; + case 'PageDown': + return { type: 'page', direction: 1 }; + case 'PageUp': + return { type: 'page', direction: -1 }; + case 'ArrowRight': + return { type: 'speed', delta: event.shiftKey ? SPEED_STEP_COARSE : SPEED_STEP }; + case 'ArrowLeft': + return { type: 'speed', delta: event.shiftKey ? -SPEED_STEP_COARSE : -SPEED_STEP }; + case 'Home': + return { type: 'rewind' }; + case 'End': + return { type: 'jumpToEnd' }; + case 'Escape': + return { type: 'rewindAndPause' }; + } + + // Character bindings use key so they work across keyboard layouts. + switch (event.key) { + case '?': + return { type: 'toggleHelp' }; + case '+': + case '=': + return { type: 'fontSize', steps: 1 }; + case '-': + case '_': + return { type: 'fontSize', steps: -1 }; + case '0': + return { type: 'resetFontSize' }; + } + + const lowerKey = event.key.toLowerCase(); + if (lowerKey === 'f') { + return { type: 'flip', axis: event.shiftKey ? 'v' : 'h' }; + } + if (lowerKey === 'l') { + return { type: 'reengageFollow' }; + } + + return null; +} diff --git a/apps/client/src/views/teleprompter/teleprompter.options.ts b/apps/client/src/views/teleprompter/teleprompter.options.ts new file mode 100644 index 000000000..c4ae01cd4 --- /dev/null +++ b/apps/client/src/views/teleprompter/teleprompter.options.ts @@ -0,0 +1,233 @@ +import type { CustomFields } from 'ontime-types'; +import { use, useMemo } from 'react'; +import { useSearchParams } from 'react-router'; + +import { OptionTitle } from '../../common/components/view-params-editor/constants'; +import type { ViewOption } from '../../common/components/view-params-editor/viewParams.types'; +import { makeOptionsFromCustomFields } from '../../common/components/view-params-editor/viewParams.utils'; +import { PresetContext } from '../../common/context/PresetContext'; +import { isStringBoolean } from '../common/viewUtils'; +import { clamp, DEFAULT_SPEED, MAX_FONT_SIZE, MAX_SPEED, MIN_FONT_SIZE, MIN_SPEED } from './teleprompter.scroll'; +import type { HeadingSource, TeleprompterOptions } from './teleprompter.types'; + +const headingOptions: { value: HeadingSource; label: string }[] = [ + { value: 'title', label: 'Title' }, + { value: 'cue', label: 'Cue' }, + { value: 'both', label: 'Cue and title' }, + { value: 'none', label: 'None' }, +]; +const headingSources = headingOptions.map((option) => option.value); + +export const defaults = { + script: 'none', + heading: 'title' as HeadingSource, + onlyPlaying: false, + hideEmpty: true, + showGroups: true, + speed: DEFAULT_SPEED, + followLoaded: true, + fontSize: 52, + lineHeight: 1.3, + textWidth: 80, + readingLine: true, + readingLinePos: 25, + flipH: false, + flipV: false, +}; + +const bounds = { + speed: [MIN_SPEED, MAX_SPEED], + fontSize: [MIN_FONT_SIZE, MAX_FONT_SIZE], + lineHeight: [1, 4], + textWidth: [20, 100], + readingLinePos: [0, 100], +} as const; + +export const getTeleprompterOptions = (customFields: CustomFields): ViewOption[] => { + const scriptOptions = makeOptionsFromCustomFields(customFields, [ + { value: 'none', label: 'None' }, + { value: 'note', label: 'Note' }, + { value: 'title', label: 'Title' }, + ]); + + return [ + { + title: OptionTitle.DataSources, + collapsible: true, + options: [ + { + id: 'script', + title: 'Script', + description: 'Select the data source which holds the script to read', + type: 'option', + values: scriptOptions, + defaultValue: defaults.script, + }, + { + id: 'heading', + title: 'Segment heading', + description: 'What to show above each segment of the script', + type: 'option', + values: headingOptions, + defaultValue: defaults.heading, + }, + ], + }, + { + title: OptionTitle.BehaviourOptions, + collapsible: true, + options: [ + { + id: 'speed', + title: 'Speed', + description: `Scroll speed in lines per minute (${MIN_SPEED}-${MAX_SPEED}). Adjustable live with the arrow keys`, + type: 'number', + defaultValue: defaults.speed, + }, + { + id: 'followLoaded', + title: 'Follow loaded event', + description: 'Scroll to the segment of the loaded event. Scrolling by hand releases the follow', + type: 'boolean', + defaultValue: defaults.followLoaded, + }, + ], + }, + { + title: OptionTitle.ElementVisibility, + collapsible: true, + options: [ + { + id: 'onlyPlaying', + title: 'Show only the playing event', + description: + 'Hides the rest of the script, leaving only the event being played. Shows the whole script while nothing is playing', + type: 'boolean', + defaultValue: defaults.onlyPlaying, + }, + { + id: 'hideEmpty', + title: 'Hide events without a script', + description: 'Prevents showing headings for events which have no script text', + type: 'boolean', + defaultValue: defaults.hideEmpty, + }, + { + id: 'showGroups', + title: 'Show group names', + description: 'Shows the group name when the script moves into a new group', + type: 'boolean', + defaultValue: defaults.showGroups, + }, + ], + }, + { + title: OptionTitle.StyleOverride, + collapsible: true, + options: [ + { + id: 'fontSize', + title: 'Font size', + description: 'Base font size in pixels. Adjustable live with the + and - keys', + type: 'number', + defaultValue: defaults.fontSize, + }, + { + id: 'lineHeight', + title: 'Line height', + description: 'Spacing between lines, as a multiple of the font size', + type: 'number', + defaultValue: defaults.lineHeight, + }, + { + id: 'textWidth', + title: 'Text width', + description: 'Width of the text column as a percentage of the screen. Narrower means less eye movement', + type: 'number', + defaultValue: defaults.textWidth, + }, + { + id: 'readingLine', + title: 'Reading line', + description: 'Shows a marker beside the line which should be read', + type: 'boolean', + defaultValue: defaults.readingLine, + }, + { + id: 'readingLinePos', + title: 'Reading line position', + description: 'Position of the reading line as a percentage from the top of the screen', + type: 'number', + defaultValue: defaults.readingLinePos, + }, + { + id: 'flipH', + title: 'Flip horizontally', + description: + 'Mirrors the view horizontally, which is what a beam splitter rig needs. Toggled live with F. Flip Screen in the navigation menu flips both axes at once, which is a rotation rather than a mirror', + type: 'boolean', + defaultValue: defaults.flipH, + }, + { + id: 'flipV', + title: 'Flip vertically', + description: 'Mirrors the view vertically. Note this also moves the reading line. Toggled live with Shift+F', + type: 'boolean', + defaultValue: defaults.flipV, + }, + ], + }, + ]; +}; + +function toNumber(value: string | null, [min, max]: readonly [number, number], fallback: number): number { + if (value === null || value === '') return fallback; + const parsed = Number(value); + if (!Number.isFinite(parsed)) return fallback; + return clamp(parsed, min, max); +} + +function toBoolean(value: string | null, fallback: boolean): boolean { + return value === null ? fallback : isStringBoolean(value); +} + +function toEnum(value: string | null, allowed: readonly T[], fallback: T): T { + return allowed.find((candidate) => candidate === value) ?? fallback; +} + +export function getOptionsFromParams( + searchParams: URLSearchParams, + defaultValues?: URLSearchParams, +): TeleprompterOptions { + const getParam = (key: string) => defaultValues?.get(key) ?? searchParams.get(key); + + return { + scriptSource: getParam('script') ?? defaults.script, + heading: toEnum(getParam('heading'), headingSources, defaults.heading), + + onlyPlaying: toBoolean(getParam('onlyPlaying'), defaults.onlyPlaying), + hideEmpty: toBoolean(getParam('hideEmpty'), defaults.hideEmpty), + showGroups: toBoolean(getParam('showGroups'), defaults.showGroups), + + speed: toNumber(getParam('speed'), bounds.speed, defaults.speed), + followLoaded: toBoolean(getParam('followLoaded'), defaults.followLoaded), + + fontSize: toNumber(getParam('fontSize'), bounds.fontSize, defaults.fontSize), + lineHeight: toNumber(getParam('lineHeight'), bounds.lineHeight, defaults.lineHeight), + textWidth: toNumber(getParam('textWidth'), bounds.textWidth, defaults.textWidth), + readingLine: toBoolean(getParam('readingLine'), defaults.readingLine), + readingLinePos: toNumber(getParam('readingLinePos'), bounds.readingLinePos, defaults.readingLinePos), + flipH: toBoolean(getParam('flipH'), defaults.flipH), + flipV: toBoolean(getParam('flipV'), defaults.flipV), + }; +} + +export function useTeleprompterOptions(): TeleprompterOptions { + const [searchParams] = useSearchParams(); + const maybePreset = use(PresetContext); + + return useMemo(() => { + const defaultValues = maybePreset ? new URLSearchParams(maybePreset.search) : undefined; + return getOptionsFromParams(searchParams, defaultValues); + }, [maybePreset, searchParams]); +} diff --git a/apps/client/src/views/teleprompter/teleprompter.scroll.ts b/apps/client/src/views/teleprompter/teleprompter.scroll.ts new file mode 100644 index 000000000..541330c47 --- /dev/null +++ b/apps/client/src/views/teleprompter/teleprompter.scroll.ts @@ -0,0 +1,165 @@ +export const MIN_SPEED = 1; +export const MAX_SPEED = 40; +export const DEFAULT_SPEED = 14; + +export const SPEED_STEP = 1; +export const SPEED_STEP_COARSE = 5; + +export const MIN_FONT_SIZE = 12; +export const MAX_FONT_SIZE = 400; +const FONT_SIZE_STEP_RATIO = 1.1; + +export function stepFontSize(current: number, steps: number): number { + return clamp(Math.round(current * FONT_SIZE_STEP_RATIO ** steps), MIN_FONT_SIZE, MAX_FONT_SIZE); +} + +export const MAX_FRAME_DELTA_MS = 100; + +const CATCH_UP_RATE = 8; +const CATCH_UP_EPSILON = 0.5; + +export function clamp(value: number, min: number, max: number): number { + if (Number.isNaN(value)) return min; + return Math.min(Math.max(value, min), max); +} + +export function clampSpeed(value: number): number { + return clamp(value, MIN_SPEED, MAX_SPEED); +} + +export function linesPerMinuteToPxPerSecond(linesPerMinute: number, lineHeightPx: number): number { + return (linesPerMinute / 60) * lineHeightPx; +} + +export function frameDeltaSeconds(deltaMs: number): number { + if (!Number.isFinite(deltaMs) || deltaMs < 0) return 0; + return Math.min(deltaMs, MAX_FRAME_DELTA_MS) / 1000; +} + +export function advance( + position: number, + pxPerSecond: number, + deltaSeconds: number, + maxScroll: number, +): { position: number; atEnd: boolean } { + const next = position + pxPerSecond * deltaSeconds; + return { position: next, atEnd: maxScroll > 0 && next >= maxScroll }; +} + +export function easeCatchUp(current: number, target: number, deltaSeconds: number): number { + if (deltaSeconds <= 0) return current; + const next = target + (current - target) * Math.exp(-CATCH_UP_RATE * deltaSeconds); + return Math.abs(next - target) < CATCH_UP_EPSILON ? target : next; +} + +/** Where a block sits inside the scrolled content, in layout pixels, ordered top to bottom. */ +export type BlockGeometry = { id: string; top: number; height: number }; + +/** + * The read position expressed as a place in the script rather than an offset + * into the document. + * + * A rundown is edited while it is being read, and an edit above the reader + * moves every pixel below it. Professional prompters cue a story plus an + * offset into it for exactly this reason: the text under the reading line is + * the position, the scroll offset is only how it is currently drawn. + */ +export type ScrollAnchor = { blockId: string; offset: number }; + +/** + * Index of the block the read point falls in, clamped to the ends of the script. + * + * Scans rather than bisects: this runs once a frame over a show's worth of + * events, and a scan makes no assumption the caller has to keep true. + */ +export function indexAtReadPoint(readPoint: number, blocks: BlockGeometry[]): number { + if (blocks.length === 0) return -1; + + // starts on the first block, which is where a read point above the script lands + let index = 0; + for (let i = 1; i < blocks.length; i += 1) { + if (blocks[i].top > readPoint) break; + index = i; + } + + return index; +} + +export function anchorAtReadPoint(readPoint: number, blocks: BlockGeometry[]): ScrollAnchor | null { + const index = indexAtReadPoint(readPoint, blocks); + if (index === -1) return null; + return { blockId: blocks[index].id, offset: readPoint - blocks[index].top }; +} + +/** + * The read point which puts an anchored place in the script back under the + * reading line, or null when it cannot be found at all. + */ +export function readPointForAnchor( + anchor: ScrollAnchor, + blocks: BlockGeometry[], + previousOrder: string[], +): number | null { + const match = blocks.find((block) => block.id === anchor.blockId); + if (match) { + // The block may have been edited shorter than the offset into it. + return match.top + Math.min(anchor.offset, match.height); + } + + // The anchored event was deleted mid-read. Land on the end of the nearest + // event which preceded it and survives, which is where the deleted text + // used to begin, rather than wherever its pixels now happen to point. + const previousIndex = previousOrder.indexOf(anchor.blockId); + for (let i = previousIndex - 1; i >= 0; i -= 1) { + const survivor = blocks.find((block) => block.id === previousOrder[i]); + if (survivor) return survivor.top + survivor.height; + } + + return null; +} + +/** Keeps a position resting on a boundary from counting as still being before it. */ +const SEGMENT_BOUNDARY_EPSILON = 1; + +/** The position at which the reading line reaches the end of a segment. */ +export function segmentEndFor(block: BlockGeometry, readingOffset: number): number { + return block.top + block.height - readingOffset; +} + +/** + * The segment playback should run to, or null past the last one, where the end + * of the script is the bound. + * + * An event is a unit of time with a stop of its own, so running the script on + * into the next one reads a segment nobody has cued: at a conference that is + * the next speaker's script, while they are still walking on. + * + * Takes the first segment ending ahead rather than the one the position sits + * in, so that starting again from a position already parked on a boundary + * carries on into the next segment instead of stopping where it already is. + * Decide this once when playback starts: re-deciding it against a position + * which is moving lets the bound outrun the reader and never arrive. + */ +export function segmentAfter(position: number, readingOffset: number, blocks: BlockGeometry[]): BlockGeometry | null { + for (const block of blocks) { + if (segmentEndFor(block, readingOffset) > position + SEGMENT_BOUNDARY_EPSILON) return block; + } + + return null; +} + +/** How far, in lines, the reader may move the script themselves before it counts as taking over. */ +export const FOLLOW_BREAK_LINES = 1.5; + +/** + * Distinguishes a deliberate scroll away from the read position from momentum + * or a stray touch. + * + * Takes what the reader moved rather than where the script ended up: while + * following eases towards a newly loaded event, and while playback carries the + * script along, the distance to the target is the prompter's own doing. + */ +export function hasBrokenFollow(readerDriftPx: number, lineHeightPx: number): boolean { + if (lineHeightPx <= 0) return false; + return Math.abs(readerDriftPx) > lineHeightPx * FOLLOW_BREAK_LINES; +} diff --git a/apps/client/src/views/teleprompter/teleprompter.types.ts b/apps/client/src/views/teleprompter/teleprompter.types.ts new file mode 100644 index 000000000..23ec509b8 --- /dev/null +++ b/apps/client/src/views/teleprompter/teleprompter.types.ts @@ -0,0 +1,66 @@ +import type { MaybeString } from 'ontime-types'; + +export type HeadingSource = 'none' | 'title' | 'cue' | 'both'; + +export type ScriptBlock = { + id: string; + heading: string; + text: string; + groupTitle: MaybeString; + isLoaded: boolean; +}; + +/** + * Where playback stopped of its own accord: at the end of the segment being + * read, or at the end of the whole script. Null while it has somewhere to go. + */ +export type ParkedAt = 'segment' | 'script' | null; + +export type TeleprompterOptions = { + scriptSource: string; + heading: HeadingSource; + onlyPlaying: boolean; + hideEmpty: boolean; + showGroups: boolean; + /** lines per minute */ + speed: number; + followLoaded: boolean; + fontSize: number; + lineHeight: number; + textWidth: number; + readingLine: boolean; + readingLinePos: number; + flipH: boolean; + flipV: boolean; +}; + +export type TeleprompterAction = + | { type: 'togglePlay' } + | { type: 'nudge'; lines: number } + | { type: 'page'; direction: 1 | -1 } + | { type: 'jumpEvent'; direction: 1 | -1 } + | { type: 'speed'; delta: number } + | { type: 'rewind' } + | { type: 'rewindAndPause' } + | { type: 'jumpToEnd' } + | { type: 'flip'; axis: 'h' | 'v' } + | { type: 'fontSize'; steps: number } + | { type: 'resetFontSize' } + | { type: 'reengageFollow' } + | { type: 'toggleHelp' }; + +export type TeleprompterController = { + play: () => void; + pause: () => void; + /** Local input convenience; remote control should use play or pause. */ + togglePlay: () => void; + nudge: (lines: number) => void; + page: (direction: 1 | -1) => void; + jumpEvent: (direction: 1 | -1) => void; + setSpeed: (speed: number) => void; + /** Local input convenience; remote control should set an absolute speed. */ + changeSpeed: (delta: number) => void; + rewind: () => void; + jumpToEnd: () => void; + reengageFollow: () => void; +}; diff --git a/apps/client/src/views/teleprompter/teleprompter.utils.ts b/apps/client/src/views/teleprompter/teleprompter.utils.ts new file mode 100644 index 000000000..e4183a2da --- /dev/null +++ b/apps/client/src/views/teleprompter/teleprompter.utils.ts @@ -0,0 +1,92 @@ +import { type CustomFields, isOntimeEvent, isOntimeGroup, type MaybeString, type Rundown } from 'ontime-types'; + +import type { RundownMetadataObject } from '../../common/utils/rundownMetadata'; +import { getPropertyValue } from '../common/viewUtils'; +import type { HeadingSource, ScriptBlock, TeleprompterOptions } from './teleprompter.types'; + +type BuildScriptOptions = Pick< + TeleprompterOptions, + 'scriptSource' | 'heading' | 'onlyPlaying' | 'hideEmpty' | 'showGroups' +>; + +function makeHeading(source: HeadingSource, cue: string, title: string): string { + switch (source) { + case 'cue': + return cue; + case 'title': + return title; + case 'both': + return [cue, title].filter(Boolean).join(' · '); + case 'none': + return ''; + } +} + +function isReadableSource(scriptSource: string, customFields: CustomFields): boolean { + if (!scriptSource.startsWith('custom-')) { + return true; + } + const key = scriptSource.slice('custom-'.length); + return customFields[key]?.type === 'text'; +} + +/** Builds the continuous script in rundown order. */ +export function buildScript( + rundown: Rundown, + rundownMetadata: RundownMetadataObject, + customFields: CustomFields, + options: BuildScriptOptions, +): ScriptBlock[] { + const { scriptSource, heading, onlyPlaying, hideEmpty, showGroups } = options; + + if (scriptSource === 'none' || !isReadableSource(scriptSource, customFields)) { + return []; + } + + const blocks: ScriptBlock[] = []; + let lastGroupId: MaybeString = null; + + for (const id of rundown.flatOrder) { + const entry = rundown.entries[id]; + if (!isOntimeEvent(entry) || entry.skip) { + continue; + } + + const metadata = rundownMetadata[id]; + const text = getPropertyValue(entry, scriptSource, rundown.entries)?.trim() ?? ''; + if (hideEmpty && !text) { + continue; + } + + const groupId = metadata?.groupId ?? null; + let groupTitle: MaybeString = null; + if (showGroups && groupId && groupId !== lastGroupId) { + const group = rundown.entries[groupId]; + groupTitle = isOntimeGroup(group) ? group.title : null; + } + lastGroupId = groupId; + + blocks.push({ + id, + heading: makeHeading(heading, entry.cue, entry.title), + text, + groupTitle, + isLoaded: Boolean(metadata?.isLoaded), + }); + } + + if (onlyPlaying) { + const playing = blocks.filter((block) => block.isLoaded); + // With nothing loaded there is no event to narrow to, and a blank screen + // would be a worse answer than the script the reader asked to see. + if (playing.length > 0) { + return playing; + } + } + + return blocks; +} + +export function composeFlip(flipH: boolean, flipV: boolean, isMirrored: boolean): { flipH: boolean; flipV: boolean } { + return { flipH: flipH !== isMirrored, flipV: flipV !== isMirrored }; +} diff --git a/apps/client/src/views/teleprompter/useSyncTeleprompterParams.ts b/apps/client/src/views/teleprompter/useSyncTeleprompterParams.ts new file mode 100644 index 000000000..ef34749d7 --- /dev/null +++ b/apps/client/src/views/teleprompter/useSyncTeleprompterParams.ts @@ -0,0 +1,50 @@ +import { use, useEffect } from 'react'; +import { useSearchParams } from 'react-router'; + +import { PresetContext } from '../../common/context/PresetContext'; +import { defaults } from './teleprompter.options'; + +const SETTLE_MS = 400; + +interface LiveParams { + speed: number; + fontSize: number; + flipH: boolean; + flipV: boolean; +} + +/** Keeps keyboard and overlay changes shareable through the URL. */ +export function useSyncTeleprompterParams({ speed, fontSize, flipH, flipV }: LiveParams) { + const [, setSearchParams] = useSearchParams(); + const isPreset = Boolean(use(PresetContext)); + + useEffect(() => { + if (isPreset) return; + + const timeout = setTimeout(() => { + const values = { + speed: speed === defaults.speed ? null : String(speed), + fontSize: fontSize === defaults.fontSize ? null : String(fontSize), + flipH: flipH === defaults.flipH ? null : String(flipH), + flipV: flipV === defaults.flipV ? null : String(flipV), + }; + + setSearchParams( + (current) => { + const next = new URLSearchParams(current); + for (const [key, value] of Object.entries(values)) { + if (value === null) { + next.delete(key); + } else { + next.set(key, value); + } + } + return next; + }, + { replace: true }, + ); + }, SETTLE_MS); + + return () => clearTimeout(timeout); + }, [flipH, flipV, fontSize, isPreset, setSearchParams, speed]); +} diff --git a/apps/client/src/views/teleprompter/useTeleprompterControls.ts b/apps/client/src/views/teleprompter/useTeleprompterControls.ts new file mode 100644 index 000000000..21f4f0c84 --- /dev/null +++ b/apps/client/src/views/teleprompter/useTeleprompterControls.ts @@ -0,0 +1,80 @@ +import { useEffect, useRef } from 'react'; + +import { useViewParamsEditorStore } from '../../common/components/view-params-editor/viewParamsEditor.store'; +import { resolveTeleprompterAction } from './teleprompter.keymap'; +import type { TeleprompterAction, TeleprompterController } from './teleprompter.types'; + +interface TeleprompterActionContext { + controller: TeleprompterController; + onFlip: (axis: 'h' | 'v') => void; + onFontSize: (steps: number) => void; + onResetFontSize: () => void; + onToggleHelp: () => void; +} + +interface UseTeleprompterControlsArgs extends TeleprompterActionContext { + isHelpOpen: boolean; +} + +const ignoredTags = new Set(['INPUT', 'TEXTAREA', 'SELECT']); + +export function applyTeleprompterAction(action: TeleprompterAction, context: TeleprompterActionContext) { + const { controller, onFlip, onFontSize, onResetFontSize, onToggleHelp } = context; + switch (action.type) { + case 'togglePlay': + return controller.togglePlay(); + case 'nudge': + return controller.nudge(action.lines); + case 'page': + return controller.page(action.direction); + case 'jumpEvent': + return controller.jumpEvent(action.direction); + case 'speed': + return controller.changeSpeed(action.delta); + case 'rewind': + return controller.rewind(); + case 'rewindAndPause': + controller.rewind(); + return controller.pause(); + case 'jumpToEnd': + return controller.jumpToEnd(); + case 'reengageFollow': + return controller.reengageFollow(); + case 'flip': + return onFlip(action.axis); + case 'fontSize': + return onFontSize(action.steps); + case 'resetFontSize': + return onResetFontSize(); + case 'toggleHelp': + return onToggleHelp(); + } +} + +export function useTeleprompterControls(args: UseTeleprompterControlsArgs) { + const argsRef = useRef(args); + useEffect(() => { + argsRef.current = args; + }); + + useEffect(() => { + function handleKeyDown(event: KeyboardEvent) { + const target = event.target as HTMLElement | null; + if (target && (ignoredTags.has(target.tagName) || target.isContentEditable)) { + return; + } + if (useViewParamsEditorStore.getState().isOpen || argsRef.current.isHelpOpen) { + return; + } + + const action = resolveTeleprompterAction(event); + if (!action) return; + + event.preventDefault(); + applyTeleprompterAction(action, argsRef.current); + } + + window.addEventListener('keydown', handleKeyDown); + return () => window.removeEventListener('keydown', handleKeyDown); + }, []); +} diff --git a/apps/client/src/views/teleprompter/useTeleprompterData.ts b/apps/client/src/views/teleprompter/useTeleprompterData.ts new file mode 100644 index 000000000..ed9f3be96 --- /dev/null +++ b/apps/client/src/views/teleprompter/useTeleprompterData.ts @@ -0,0 +1,26 @@ +import type { CustomFields, Rundown } from 'ontime-types'; + +import useCustomFields from '../../common/hooks-query/useCustomFields'; +import { useRundownWithMetadata } from '../../common/hooks-query/useRundown'; +import type { RundownMetadataObject } from '../../common/utils/rundownMetadata'; +import { type ViewData, aggregateQueryStatus } from '../utils/viewLoader.utils'; + +export interface TeleprompterData { + rundown: Rundown; + rundownMetadata: RundownMetadataObject; + customFields: CustomFields; +} + +export function useTeleprompterData(): ViewData { + const { data: rundown, rundownMetadata, status: rundownStatus } = useRundownWithMetadata(); + const { data: customFields, status: customFieldStatus } = useCustomFields(); + + return { + data: { + rundown, + rundownMetadata, + customFields, + }, + status: aggregateQueryStatus([rundownStatus, customFieldStatus]), + }; +} diff --git a/apps/client/src/views/teleprompter/useTeleprompterScroll.ts b/apps/client/src/views/teleprompter/useTeleprompterScroll.ts new file mode 100644 index 000000000..a17e6f3e0 --- /dev/null +++ b/apps/client/src/views/teleprompter/useTeleprompterScroll.ts @@ -0,0 +1,466 @@ +import { useCallback, useEffect, useMemo, useRef, useState } from 'react'; + +import { + advance, + anchorAtReadPoint, + type BlockGeometry, + clamp, + clampSpeed, + easeCatchUp, + frameDeltaSeconds, + hasBrokenFollow, + indexAtReadPoint, + linesPerMinuteToPxPerSecond, + readPointForAnchor, + type ScrollAnchor, + segmentAfter, + segmentEndFor, +} from './teleprompter.scroll'; +import type { ParkedAt, ScriptBlock, TeleprompterController } from './teleprompter.types'; + +const PAGE_FRACTION = 0.85; +const EXTERNAL_SCROLL_EPSILON = 2; +/** Below this the correction would be invisible and only add jitter. */ +const ANCHOR_CORRECTION_EPSILON = 1; + +/** + * Uses layout coordinates because client rects include the teleprompter's CSS + * transform while scrollTop does not. + */ +function getLayoutTop(element: HTMLElement): number { + let top = 0; + let current: HTMLElement | null = element; + + while (current) { + top += current.offsetTop; + current = current.offsetParent instanceof HTMLElement ? current.offsetParent : null; + } + + return top; +} + +function getLineHeight(element: HTMLElement): number { + const styles = getComputedStyle(element); + const lineHeight = Number.parseFloat(styles.lineHeight); + if (Number.isFinite(lineHeight) && lineHeight > 0) { + return lineHeight; + } + + const fontSize = Number.parseFloat(styles.fontSize); + return Number.isFinite(fontSize) ? fontSize * 1.2 : 0; +} + +function measureBlockGeometry(scroller: HTMLElement, blocks: Map): BlockGeometry[] { + const scrollerTop = getLayoutTop(scroller); + return Array.from(blocks, ([id, element]) => ({ + id, + top: getLayoutTop(element) - scrollerTop, + height: element.offsetHeight, + })).sort((a, b) => a.top - b.top); +} + +interface UseTeleprompterScrollArgs { + initialSpeed: number; + followLoaded: boolean; + selectedEventId: string | null; + readingLinePos: number; + blocks: ScriptBlock[]; +} + +/** + * Owns the scroll position of the teleprompter. + * + * The animation frame is the only writer of scrollTop. Controls update refs so + * smooth scrolling and playback cannot compete for the DOM position. + */ +export function useTeleprompterScroll({ + initialSpeed, + followLoaded, + selectedEventId, + readingLinePos, + blocks, +}: UseTeleprompterScrollArgs) { + const scrollerRef = useRef(null); + const contentRef = useRef(null); + const blockRefs = useRef(new Map()); + + const [isScrollerMounted, setIsScrollerMounted] = useState(false); + const attachScroller = useCallback((element: HTMLDivElement | null) => { + scrollerRef.current = element; + setIsScrollerMounted(Boolean(element && contentRef.current)); + }, []); + const attachContent = useCallback((element: HTMLDivElement | null) => { + contentRef.current = element; + setIsScrollerMounted(Boolean(element && scrollerRef.current)); + }, []); + + // authoritative, sub-pixel scroll position + const posRef = useRef(0); + const lastTsRef = useRef(0); + const runningRef = useRef(false); + const speedRef = useRef(initialSpeed); + const lineHeightRef = useRef(0); + const maxScrollRef = useRef(0); + const catchUpTargetRef = useRef(null); + const pendingDeltaRef = useRef(0); + // where following last put (or is easing towards putting) the reader + const followTargetRef = useRef(0); + // how far the reader has moved the script themselves since following last placed it + const readerDriftRef = useRef(0); + // distance from the top of the viewport to the reading line + const readingOffsetRef = useRef(0); + const readingLinePosRef = useRef(readingLinePos); + const selectedEventIdRef = useRef(selectedEventId); + // the script's layout as of the last measure, and the reader's place in it + const geometryRef = useRef([]); + const anchorRef = useRef(null); + // the segment this run of playback stops at, chosen when it started + const playbackSegmentRef = useRef(null); + + const [isRunning, setIsRunning] = useState(false); + const [speed, setSpeed] = useState(initialSpeed); + // mirrors the operator view's lockAutoScroll: true once the reader has taken + // the scroll over by hand, false while following is doing the driving + const [autoScrollLocked, setAutoScrollLocked] = useState(false); + const [parkedAt, setParkedAt] = useState(null); + + const setPlaybackRunning = useCallback((nextIsRunning: boolean) => { + runningRef.current = nextIsRunning; + setIsRunning(nextIsRunning); + }, []); + + const isFollowingRef = useRef(false); + useEffect(() => { + isFollowingRef.current = followLoaded && !autoScrollLocked; + }, [followLoaded, autoScrollLocked]); + + /** + * One rule for every input, wheel and keyboard alike: once the reader has + * moved the script far enough themselves, they are driving. + * + * Accumulates, so a gesture the browser spreads over many frames adds up to + * the move it was, and so does a slow drag. Scrolling back where you came + * from cancels out, which is what keeps momentum and a stray touch from + * taking the scroll over. + */ + const addReaderDrift = useCallback((delta: number) => { + if (!isFollowingRef.current) return; + readerDriftRef.current += delta; + if (hasBrokenFollow(readerDriftRef.current, lineHeightRef.current)) { + setAutoScrollLocked(true); + } + }, []); + + const tick = useCallback( + (timestamp: number) => { + const scroller = scrollerRef.current; + if (!scroller) return; + + // Adopt wheel, touch, scrollbar, browser-clamp and find-in-page changes. + // Whatever the position is that the frame loop did not put there is the + // reader's own doing, which makes this the one place a scroll by hand can + // be measured, however the browser chose to deliver it. + const external = scroller.scrollTop - posRef.current; + if (Math.abs(external) > EXTERNAL_SCROLL_EPSILON) { + addReaderDrift(external); + posRef.current = scroller.scrollTop; + catchUpTargetRef.current = null; + } + + const deltaSeconds = frameDeltaSeconds(timestamp - lastTsRef.current); + lastTsRef.current = timestamp; + + let next = posRef.current; + + if (pendingDeltaRef.current !== 0) { + next += pendingDeltaRef.current; + pendingDeltaRef.current = 0; + catchUpTargetRef.current = null; + } + + if (catchUpTargetRef.current !== null) { + next = easeCatchUp(next, catchUpTargetRef.current, deltaSeconds); + if (next === catchUpTargetRef.current) { + catchUpTargetRef.current = null; + } + } else if (runningRef.current) { + // Only playback is held to the segment. A jump, a page or a nudge is + // the reader asking to leave it, and stays free to cross. + // + // Resolved from the segment's identity rather than the pixel bound + // taken when playback started, so an edit which moves the script keeps + // playback stopping on the same words. + const stopBlock = geometryRef.current.find((block) => block.id === playbackSegmentRef.current); + const stop = stopBlock + ? clamp(segmentEndFor(stopBlock, readingOffsetRef.current), 0, maxScrollRef.current) + : maxScrollRef.current; + + const pxPerSecond = linesPerMinuteToPxPerSecond(speedRef.current, lineHeightRef.current); + const result = advance(next, pxPerSecond, deltaSeconds, stop); + next = Math.min(result.position, stop); + if (result.atEnd) { + setPlaybackRunning(false); + // Past the last segment there is only the trailing padding, so + // stopping there is the end of the read rather than a wait for a cue. + const isLastSegment = stopBlock !== undefined && stopBlock.id === geometryRef.current.at(-1)?.id; + setParkedAt(isLastSegment || stop >= maxScrollRef.current ? 'script' : 'segment'); + } + } + + const clamped = clamp(next, 0, maxScrollRef.current); + if (clamped !== posRef.current) { + posRef.current = clamped; + scroller.scrollTop = clamped; + } + + // Remember the reader's place in the script, not just in the document, so + // the next measure can put them back if the rundown changed underneath + // them. Reads no layout: the geometry is the one taken at that measure. + anchorRef.current = anchorAtReadPoint(clamped + readingOffsetRef.current, geometryRef.current); + }, + [addReaderDrift, setPlaybackRunning], + ); + + useEffect(() => { + lastTsRef.current = performance.now(); + let frame = requestAnimationFrame(function loop(timestamp) { + tick(timestamp); + frame = requestAnimationFrame(loop); + }); + return () => cancelAnimationFrame(frame); + }, [tick]); + + /** Where following would put the reader for a block, against the last measure. */ + const scrollTargetFor = useCallback((blockId: string): number | null => { + const block = geometryRef.current.find((entry) => entry.id === blockId); + if (!block) return null; + return clamp(block.top - readingOffsetRef.current, 0, maxScrollRef.current); + }, []); + + const measure = useCallback(() => { + const scroller = scrollerRef.current; + const content = contentRef.current; + if (!scroller || !content) return; + + maxScrollRef.current = Math.max(0, scroller.scrollHeight - scroller.clientHeight); + readingOffsetRef.current = (scroller.clientHeight * readingLinePosRef.current) / 100; + + lineHeightRef.current = getLineHeight(content); + + const wasEasingToLoadedEvent = catchUpTargetRef.current === followTargetRef.current; + + const previousGeometry = geometryRef.current; + // Registration follows mounting rather than rundown order, so trust layout. + const geometry = measureBlockGeometry(scroller, blockRefs.current); + geometryRef.current = geometry; + + // Put the reader back on the words they were on. Nothing to restore on the + // first measure, when there is no earlier document to have moved. + const anchor = anchorRef.current; + if (anchor && previousGeometry.length > 0) { + const readPoint = readPointForAnchor( + anchor, + geometry, + previousGeometry.map((block) => block.id), + ); + if (readPoint !== null) { + const target = clamp(readPoint - readingOffsetRef.current, 0, maxScrollRef.current); + const delta = target - posRef.current; + if (Math.abs(delta) > ANCHOR_CORRECTION_EPSILON) { + posRef.current = target; + scroller.scrollTop = target; + if (catchUpTargetRef.current !== null) { + catchUpTargetRef.current = clamp(catchUpTargetRef.current + delta, 0, maxScrollRef.current); + } + } + } + } + + // The follow target is a position in a document which may have just moved, + // so take it from the new geometry rather than ageing the old value. + const selectedId = selectedEventIdRef.current; + if (selectedId !== null) { + const followTarget = scrollTargetFor(selectedId); + if (followTarget !== null) { + followTargetRef.current = followTarget; + } + } + + // Shifting an in-flight ease by the correction is only an estimate. When it + // was heading for the loaded event we know better: send it to where that + // event is now, so following still lands exactly on the reading line. + if (wasEasingToLoadedEvent) { + catchUpTargetRef.current = followTargetRef.current; + } + }, [scrollTargetFor]); + + useEffect(() => { + speedRef.current = speed; + }, [speed]); + + const [speedFromOption, setSpeedFromOption] = useState(initialSpeed); + // Keep the live speed in sync with view-param and remote redirect changes. + if (speedFromOption !== initialSpeed) { + setSpeedFromOption(initialSpeed); + setSpeed(initialSpeed); + } + + useEffect(() => { + measure(); + + const scroller = scrollerRef.current; + const content = contentRef.current; + if (!scroller || !content) return; + + const observer = new ResizeObserver(() => measure()); + observer.observe(scroller); + observer.observe(content); + return () => observer.disconnect(); + }, [measure, isScrollerMounted]); + + useEffect(() => { + let cancelled = false; + void document.fonts?.ready.then(() => { + if (!cancelled) measure(); + }); + return () => { + cancelled = true; + }; + }, [measure]); + + useEffect(() => { + readingLinePosRef.current = readingLinePos; + measure(); + }, [readingLinePos, measure]); + + /** + * A resize observer sees the document get taller or shorter, but not a + * reorder or a rewrite which happens to leave the height alone, and both + * move the reader's place in the script. + */ + const contentSignature = blocks.map((block) => `${block.id}:${block.text.length}`).join(); + useEffect(() => { + measure(); + }, [contentSignature, measure]); + + useEffect(() => { + const onVisibilityChange = () => { + lastTsRef.current = performance.now(); + }; + document.addEventListener('visibilitychange', onVisibilityChange); + return () => document.removeEventListener('visibilitychange', onVisibilityChange); + }, []); + + useEffect(() => { + selectedEventIdRef.current = selectedEventId; + }, [selectedEventId]); + + // Avoid re-following when a new blocks array contains the same selected event. + const hasSelectedBlock = selectedEventId !== null && blocks.some((block) => block.id === selectedEventId); + + useEffect(() => { + if (!followLoaded || autoScrollLocked || !selectedEventId) return; + + const target = scrollTargetFor(selectedEventId); + if (target === null) return; + + followTargetRef.current = target; + catchUpTargetRef.current = target; + readerDriftRef.current = 0; + setParkedAt(null); + }, [selectedEventId, followLoaded, autoScrollLocked, readingLinePos, hasSelectedBlock, scrollTargetFor]); + + const registerBlock = useCallback((id: string, element: HTMLElement | null) => { + if (element) { + blockRefs.current.set(id, element); + } else { + blockRefs.current.delete(id); + } + }, []); + + const controller: TeleprompterController = useMemo(() => { + const play = () => { + if (runningRef.current) return; + if (maxScrollRef.current > 0 && posRef.current >= maxScrollRef.current) { + return; + } + const stopAt = segmentAfter(posRef.current, readingOffsetRef.current, geometryRef.current); + playbackSegmentRef.current = stopAt?.id ?? null; + setPlaybackRunning(true); + setParkedAt(null); + }; + + const pause = () => { + if (!runningRef.current) return; + setPlaybackRunning(false); + }; + + /** + * Where the scroll is headed rather than where it currently sits, so + * pressing a step key again before the ease settles moves on by another + * step instead of re-aiming at the one already in flight. + */ + const destination = () => catchUpTargetRef.current ?? posRef.current; + + /** Eases to a position the reader asked for, by hand. */ + const goTo = (position: number) => { + const target = clamp(position, 0, maxScrollRef.current); + addReaderDrift(target - destination()); + catchUpTargetRef.current = target; + setParkedAt(null); + }; + + return { + play, + pause, + togglePlay: () => (runningRef.current ? pause() : play()), + nudge: (lines: number) => { + const distance = lines * lineHeightRef.current; + pendingDeltaRef.current += distance; + addReaderDrift(distance); + setParkedAt(null); + }, + page: (direction: 1 | -1) => { + const scroller = scrollerRef.current; + if (!scroller) return; + goTo(destination() + scroller.clientHeight * PAGE_FRACTION * direction); + }, + jumpEvent: (direction: 1 | -1) => { + const geometry = geometryRef.current; + const current = indexAtReadPoint(destination() + readingOffsetRef.current, geometry); + if (current === -1) return; + + const next = clamp(current + direction, 0, geometry.length - 1); + goTo(geometry[next].top - readingOffsetRef.current); + }, + setSpeed: (nextSpeed: number) => setSpeed(clampSpeed(nextSpeed)), + changeSpeed: (delta: number) => setSpeed((current) => clampSpeed(current + delta)), + rewind: () => goTo(0), + jumpToEnd: () => { + addReaderDrift(maxScrollRef.current - destination()); + catchUpTargetRef.current = maxScrollRef.current; + if (maxScrollRef.current > 0) { + setPlaybackRunning(false); + setParkedAt('script'); + } + }, + reengageFollow: () => { + readerDriftRef.current = 0; + setAutoScrollLocked(false); + }, + }; + }, [addReaderDrift, setPlaybackRunning]); + + return { + scrollerRef: attachScroller, + contentRef: attachContent, + registerBlock, + controller, + isRunning, + speed, + // folds followLoaded in, so callers get one ready-to-use signal instead of + // a runtime flag they must remember to AND with the option themselves + canReengageFollow: followLoaded && autoScrollLocked, + parkedAt, + }; +} diff --git a/apps/electron/src/menu/applicationMenu.js b/apps/electron/src/menu/applicationMenu.js index d11a042f2..e7218decb 100644 --- a/apps/electron/src/menu/applicationMenu.js +++ b/apps/electron/src/menu/applicationMenu.js @@ -151,6 +151,7 @@ function makeViewMenu(clientUrl) { makeItemOpenInBrowser('Editor', `${clientUrl}/editor`), makeItemOpenInBrowser('Cuesheet', `${clientUrl}/cuesheet`), makeItemOpenInBrowser('Operator', `${clientUrl}/op`), + makeItemOpenInBrowser('Teleprompter', `${clientUrl}/teleprompter`), { type: 'separator' }, makeItemOpenInBrowser('Timer', `${clientUrl}/timer`), makeItemOpenInBrowser('Backstage', `${clientUrl}/backstage`), diff --git a/e2e/tests/002-view-navigation.spec.ts b/e2e/tests/002-view-navigation.spec.ts index 66e3e1c99..3b7beb3e0 100644 --- a/e2e/tests/002-view-navigation.spec.ts +++ b/e2e/tests/002-view-navigation.spec.ts @@ -9,45 +9,52 @@ test.describe('test view navigation feature', () => { test('Timeline', async ({ page }) => { await openNavigationMenu(page); await page.getByRole('button', { name: 'Timeline' }).click(); - page.locator('data-testid=timeline-view'); + await expect(page.getByTestId('timeline-view')).toBeVisible(); await expect(page).toHaveURL('/timeline'); }); test('Backstage', async ({ page }) => { await openNavigationMenu(page); await page.getByRole('button', { name: 'Backstage' }).click(); - page.locator('data-testid=backstage-view'); + await expect(page.getByTestId('backstage-view')).toBeVisible(); await expect(page).toHaveURL('/backstage'); }); test('Studio Clock', async ({ page }) => { await openNavigationMenu(page); await page.getByRole('button', { name: 'Studio Clock' }).click(); - page.locator('data-testid=studio-view'); + await expect(page.getByTestId('studio-view')).toBeVisible(); await expect(page).toHaveURL('/studio'); }); test('Countdown', async ({ page }) => { await openNavigationMenu(page); await page.getByRole('button', { name: 'Countdown' }).click(); - page.locator('data-testid=countdown-view'); + await expect(page.getByTestId('countdown-view')).toBeVisible(); await expect(page).toHaveURL('/countdown'); }); test('Project Info', async ({ page }) => { await openNavigationMenu(page); await page.getByRole('button', { name: 'Project Info' }).click(); - page.locator('data-testid=project-view'); + await expect(page.getByTestId('project-view')).toBeVisible(); await expect(page).toHaveURL('/info'); }); test('Timer', async ({ page }) => { await openNavigationMenu(page); await page.getByRole('button', { name: 'Timer', exact: true }).click(); - page.locator('data-testid=timer-view'); + await expect(page.getByTestId('timer-view')).toBeVisible(); await expect(page).toHaveURL('/timer'); }); + test('Teleprompter', async ({ page }) => { + await openNavigationMenu(page); + await page.getByRole('button', { name: 'Teleprompter' }).click(); + await expect(page.getByTestId('teleprompter-view')).toBeVisible(); + await expect(page).toHaveURL('/teleprompter'); + }); + /** * The shortcut has to read the current open state, not the one captured when it was * registered, otherwise it only ever opens the menu. diff --git a/e2e/tests/features/207-view-params.spec.ts b/e2e/tests/features/207-view-params.spec.ts index 10581f927..52f8a8ee6 100644 --- a/e2e/tests/features/207-view-params.spec.ts +++ b/e2e/tests/features/207-view-params.spec.ts @@ -38,3 +38,25 @@ test('View params keeps the values of collapsed sections', async ({ page }) => { await expect(page).toHaveURL(/.*hideClock=true/); await expect(page.getByText('TIME NOW', { exact: true })).not.toBeInViewport(); }); + +test('View params configures teleprompter view', async ({ page, request }) => { + const response = await request.post('/data/db/demo'); + expect(response.ok()).toBe(true); + + await page.goto('/teleprompter?script=note'); + + const readingMarker = page.locator('.teleprompter__reading-marker'); + await expect(readingMarker).toBeVisible(); + + await page.mouse.move(Math.random() * 100, Math.random() * 100); + await page.getByTestId('navigation__toggle-settings').click(); + + const readingLineSwitch = page.locator('label:has(input[name="readingLine"]) [role="switch"]'); + await expect(readingLineSwitch).toHaveAttribute('aria-checked', 'true'); + + await readingLineSwitch.click(); + await page.getByTestId('apply-view-params').click(); + + await expect(page).toHaveURL(/.*readingLine=false/); + await expect(readingMarker).toHaveCount(0); +}); diff --git a/e2e/tests/features/215-teleprompter.spec.ts b/e2e/tests/features/215-teleprompter.spec.ts new file mode 100644 index 000000000..689ad76e7 --- /dev/null +++ b/e2e/tests/features/215-teleprompter.spec.ts @@ -0,0 +1,197 @@ +import { expect, type Page, test } from '@playwright/test'; + +/** The heading of the event the reading line is currently over. */ +function eventUnderReadingLine(page: Page) { + return page.evaluate(() => { + const line = document.querySelector('.teleprompter__reading-line')?.getBoundingClientRect(); + if (!line) throw new Error('Reading line not found'); + const element = document.elementFromPoint(window.innerWidth / 2, line.top + line.height / 2); + return element?.closest('.teleprompter__block')?.querySelector('.teleprompter__heading')?.textContent ?? null; + }); +} + +test('teleprompter renders and responds to its primary controls', async ({ page, request }) => { + // Earlier feature specs edit the loaded rundown. Restore the real demo project + // instead of manufacturing test-only events: its notes are the script fixture. + const response = await request.post('/data/db/demo'); + expect(response.ok()).toBe(true); + const loadResponse = await request.get('/api/load/index/5'); + expect(loadResponse.ok()).toBe(true); + + await page.goto('/teleprompter?script=note&flipV=true'); + + const view = page.getByTestId('teleprompter-view'); + const scroller = page.getByTestId('teleprompter-scroller'); + const speed = page.getByTestId('teleprompter-speed'); + + await expect(view).toBeVisible(); + await expect(scroller).toBeVisible(); + await expect(page.getByText('Music plays, holding slide on screens')).toBeVisible(); + await expect(speed).toContainText('14'); + await expect(view).toHaveCSS('transform', /^matrix\(1, 0, 0, -1/); + + // Following uses layout coordinates, which must remain stable when the view's + // visual coordinates are inverted by a vertical transform. + const loadedBlock = page.locator('.teleprompter__block[data-loaded]'); + await expect(loadedBlock).toBeAttached(); + const expectedScrollTop = await loadedBlock.evaluate((element) => { + const scroller = element.closest('.teleprompter')?.querySelector('.teleprompter__scroller'); + if (!scroller) throw new Error('Teleprompter scroller not found'); + return Math.max(0, (element as HTMLElement).offsetTop - scroller.clientHeight * 0.25); + }); + await expect + .poll(async () => Math.abs((await scroller.evaluate((element) => element.scrollTop)) - expectedScrollTop)) + .toBeLessThan(2); + + await page.goto('/teleprompter?script=note'); + + await page.keyboard.press('Space'); + await expect.poll(() => scroller.evaluate((element) => element.scrollTop)).toBeGreaterThan(0); + await page.keyboard.press('Space'); + + await page.keyboard.press('ArrowRight'); + await page.keyboard.press('f'); + await expect(speed).toContainText('15'); + await expect(page).toHaveURL(/speed=15/); + await expect(page).toHaveURL(/flipH=true/); + await expect(view).toHaveCSS('transform', /^matrix\(-1/); +}); + +test('an edit above the reader leaves the same text under the reading line', async ({ page, request }) => { + const response = await request.post('/data/db/demo'); + expect(response.ok()).toBe(true); + const loadResponse = await request.get('/api/load/index/5'); + expect(loadResponse.ok()).toBe(true); + + // following moves the reader for its own reasons; this is about the document + // changing underneath a position the reader chose + await page.goto('/teleprompter?script=note&followLoaded=false'); + + const scroller = page.getByTestId('teleprompter-scroller'); + await expect(scroller).toBeVisible(); + + // park the reading line inside a block rather than at a fraction of the + // document, whose tail is a screen of padding below the last event + await scroller.evaluate((element) => { + const blocks = element.querySelectorAll('.teleprompter__block'); + const target = blocks[Math.floor(blocks.length / 2)]; + element.scrollTop = target.offsetTop + 10 - element.clientHeight * 0.25; + }); + const before = await eventUnderReadingLine(page); + expect(before).not.toBeNull(); + const scrollBefore = await scroller.evaluate((element) => element.scrollTop); + + // grow the first event's script, which sits above wherever we scrolled to + const edit = await request.put('/data/rundowns/default/entry', { + data: { id: '9bf60f', note: `Music plays, holding slide on screens\n${'Another line of script. '.repeat(120)}` }, + }); + expect(edit.ok()).toBe(true); + + // the document grew, so holding position means the offset had to change + await expect.poll(() => scroller.evaluate((element) => element.scrollTop)).toBeGreaterThan(scrollBefore); + expect(await eventUnderReadingLine(page)).toBe(before); +}); + +test('shift and the vertical arrows walk the reader event by event', async ({ page, request }) => { + const response = await request.post('/data/db/demo'); + expect(response.ok()).toBe(true); + const loadResponse = await request.get('/api/load/index/5'); + expect(loadResponse.ok()).toBe(true); + + await page.goto('/teleprompter?script=note&followLoaded=false'); + + const scroller = page.getByTestId('teleprompter-scroller'); + await expect(scroller).toBeVisible(); + + const headings = await page.locator('.teleprompter__heading').allTextContents(); + expect(headings.length).toBeGreaterThan(2); + await expect.poll(() => eventUnderReadingLine(page)).toBe(headings[0]); + + await page.keyboard.press('Shift+ArrowDown'); + await expect.poll(() => eventUnderReadingLine(page)).toBe(headings[1]); + + await page.keyboard.press('Shift+ArrowDown'); + await expect.poll(() => eventUnderReadingLine(page)).toBe(headings[2]); + + await page.keyboard.press('Shift+ArrowUp'); + await expect.poll(() => eventUnderReadingLine(page)).toBe(headings[1]); +}); + +test('playback stops at the end of the event instead of reading on into the next', async ({ page, request }) => { + const response = await request.post('/data/db/demo'); + expect(response.ok()).toBe(true); + const loadResponse = await request.get('/api/load/index/5'); + expect(loadResponse.ok()).toBe(true); + + await page.goto('/teleprompter?script=note&followLoaded=false&speed=40'); + + const scroller = page.getByTestId('teleprompter-scroller'); + await expect(scroller).toBeVisible(); + + // park the reading line just short of the first event's end, so the run to + // the boundary takes a moment rather than the length of the segment + const segmentEnd = await scroller.evaluate((element) => { + const block = element.querySelector('.teleprompter__block'); + if (!block) throw new Error('No script block found'); + const end = block.offsetTop + block.offsetHeight - element.clientHeight * 0.25; + element.scrollTop = end - 30; + return end; + }); + + await page.keyboard.press('Space'); + + await expect(page.getByTestId('teleprompter-parked')).toBeVisible(); + await expect + .poll(async () => Math.abs((await scroller.evaluate((element) => element.scrollTop)) - segmentEnd)) + .toBeLessThan(3); + + // and it stays there, rather than carrying on after a beat + await page.waitForTimeout(500); + expect(Math.abs((await scroller.evaluate((element) => element.scrollTop)) - segmentEnd)).toBeLessThan(3); + + // pressing play again is how the reader moves on to the next event + await page.keyboard.press('Space'); + await expect.poll(() => scroller.evaluate((element) => element.scrollTop)).toBeGreaterThan(segmentEnd + 5); +}); + +test('onlyPlaying narrows the script to the event being played', async ({ page, request }) => { + const response = await request.post('/data/db/demo'); + expect(response.ok()).toBe(true); + const loadResponse = await request.get('/api/load/index/5'); + expect(loadResponse.ok()).toBe(true); + + await page.goto('/teleprompter?script=note'); + await expect(page.locator('.teleprompter__block').first()).toBeVisible(); + const whole = await page.locator('.teleprompter__block').count(); + expect(whole).toBeGreaterThan(1); + + await page.goto('/teleprompter?script=note&onlyPlaying=true'); + + const blocks = page.locator('.teleprompter__block'); + await expect(blocks).toHaveCount(1); + await expect(blocks.first()).toHaveAttribute('data-loaded', 'true'); +}); + +test('follow tolerates a small scroll and breaks on a real one, like the operator view', async ({ page, request }) => { + const response = await request.post('/data/db/demo'); + expect(response.ok()).toBe(true); + const loadResponse = await request.get('/api/load/index/5'); + expect(loadResponse.ok()).toBe(true); + + await page.goto('/teleprompter?script=note'); + + const scroller = page.getByTestId('teleprompter-scroller'); + const follow = page.getByTestId('teleprompter-follow'); + await expect(scroller).toBeVisible(); + await expect(follow).toBeDisabled(); + + await page.mouse.move(960, 500); + await page.mouse.wheel(0, 15); + await expect(follow).toBeDisabled(); + + await page.mouse.wheel(0, 400); + await expect(follow).toBeEnabled(); + + await page.keyboard.press('l'); + await expect(follow).toBeDisabled(); +}); diff --git a/packages/types/src/definitions/core/UrlPreset.type.ts b/packages/types/src/definitions/core/UrlPreset.type.ts index 57f070225..fbbbb38e8 100644 --- a/packages/types/src/definitions/core/UrlPreset.type.ts +++ b/packages/types/src/definitions/core/UrlPreset.type.ts @@ -11,6 +11,7 @@ export enum OntimeView { StudioClock = 'studio', Countdown = 'countdown', ProjectInfo = 'info', + Teleprompter = 'teleprompter', } export type OntimeViewPresettable = Exclude;