diff --git a/packages/core/src/compositionReadiness.test.ts b/packages/core/src/compositionReadiness.test.ts index 3dc7c4cb13..9b3b5995d6 100644 --- a/packages/core/src/compositionReadiness.test.ts +++ b/packages/core/src/compositionReadiness.test.ts @@ -8,7 +8,7 @@ import { settleFirstFrameCompositionReadiness, } from "./compositionReadiness.js"; import { createRuntimeStartTimeResolver } from "./runtime/startResolver.js"; -import { STUDIO_PREVIEW_MARK_META } from "./studioPreviewMark.js"; +import { DEFER_MEDIA_META, STUDIO_PREVIEW_MARK_META } from "./studioPreviewMark.js"; import { isRuntimeElementVisibleAt } from "./runtime/timeline.js"; function docWith(bodyHtml: string): Document { @@ -180,7 +180,7 @@ describe("mediaReadinessInput", () => { await expect(pending).resolves.toBeUndefined(); }); - it("waits on a later clip in Studio's preview only once the runtime has set it to buffer", () => { + it("waits on a later clip in Studio's preview or a capture only once the runtime has set it to buffer", () => { const html = '' + '' + @@ -189,11 +189,14 @@ describe("mediaReadinessInput", () => { preview.head .appendChild(preview.createElement("meta")) .setAttribute("name", STUDIO_PREVIEW_MARK_META); + const capture = docWith(html); + capture.head.appendChild(capture.createElement("meta")).setAttribute("name", DEFER_MEDIA_META); const plain = docWith(html); const ids = (doc: Document) => scanPendingCompositionAssets(doc, { scope: "all" }).pendingMedia.map((el) => el.id); expect(ids(preview)).toEqual(["due"]); + expect(ids(capture)).toEqual(["due"]); expect(ids(plain)).toEqual(["deferred", "untrimmed", "due"]); }); diff --git a/packages/core/src/compositionReadiness.ts b/packages/core/src/compositionReadiness.ts index 7361ecad92..6a5e0e5960 100644 --- a/packages/core/src/compositionReadiness.ts +++ b/packages/core/src/compositionReadiness.ts @@ -1,7 +1,7 @@ import { createRuntimeStartTimeResolver } from "./runtime/startResolver.js"; import { isRuntimeElementVisibleAt } from "./runtime/timeline.js"; import type { RuntimeTimelineLike } from "./runtime/types.js"; -import { STUDIO_PREVIEW_MARK_META } from "./studioPreviewMark.js"; +import { defersMedia } from "./studioPreviewMark.js"; /** A composition is "ready" once every declared input settles, not just once * its duration is known. Each input returns null (nothing to wait on) or a @@ -105,13 +105,13 @@ export function scanPendingCompositionAssets( includeAuthoredTimingAttrs: true, }); // Studio's preview buffers a clip off the first frame only once it comes due, as with a lazy image. - const defersMedia = doc.querySelector(`meta[name="${STUDIO_PREVIEW_MARK_META}"]`) !== null; + const mediaDeferred = defersMedia(doc); const pendingMedia = Array.from(doc.querySelectorAll("video, audio")) .filter(isRealmHtmlMediaElement) .filter((el) => shouldIncludeAsset( el, - defersMedia && el.preload !== "auto" ? FIRST_FRAME_READINESS_SCOPE : scope, + mediaDeferred && el.preload !== "auto" ? FIRST_FRAME_READINESS_SCOPE : scope, resolver, runtimeWindow?.__timelines ?? {}, ), diff --git a/packages/core/src/runtime/entry.test.ts b/packages/core/src/runtime/entry.test.ts index d54f98505f..b7abef4313 100644 --- a/packages/core/src/runtime/entry.test.ts +++ b/packages/core/src/runtime/entry.test.ts @@ -1,7 +1,7 @@ // fallow-ignore-file code-duplication import { afterEach, describe, expect, it, vi } from "vitest"; import { HF_COLOR_GRADING_ATTR, serializeHfColorGrading } from "../colorGrading"; -import { STUDIO_PREVIEW_LAZY_ATTR, STUDIO_PREVIEW_MARK_META } from "../studioPreviewMark"; +import { DEFER_MEDIA_META, STUDIO_PREVIEW_LAZY_ATTR, STUDIO_PREVIEW_MARK_META } from "../studioPreviewMark"; import type { RuntimeTimelineLike } from "./types"; function pausedTimeline(duration: number): RuntimeTimelineLike { @@ -387,6 +387,22 @@ describe("runtime entry", () => { const armed = (...els: HTMLMediaElement[]) => els.map((el) => el.preload === "auto"); afterEach(() => vi.restoreAllMocks()); + it("loads a capture build's media only near its moment, while every image of a hidden clip stays shown", async () => { + spyLoad(); + // What a capture build carries instead of the preview mark. + document.head.appendChild(Object.assign(document.createElement("meta"), { name: DEFER_MEDIA_META })); + const root = mountRoot(); + const [now, later] = videos(root, "0", "9"); + const hidden = withImage(timed(root, "div", "9")); + + await evaluateRuntime(); + expect(armed(now, later)).toEqual([true, false]); + expect(loadsOf(now, later)).toEqual([1, 0]); + expect(imageSkipped(hidden)).toEqual([false]); + window.__player?.seek(9.5); + expect(armed(later)).toEqual([true]); + }); + it("loads a preview's media only on screen or due within the look-ahead, and frees what the playhead left", async () => { spyLoad(); servePreview(); diff --git a/packages/core/src/runtime/init.ts b/packages/core/src/runtime/init.ts index c6c8d1a839..05c8c1ed24 100644 --- a/packages/core/src/runtime/init.ts +++ b/packages/core/src/runtime/init.ts @@ -18,6 +18,7 @@ import { RUNTIME_STAMPED_ATTR, STUDIO_PREVIEW_LAZY_ATTR, STUDIO_PREVIEW_UPCOMING_ATTR, + defersMedia, } from "../studioPreviewMark"; import { initRuntimeAnalytics, emitAnalyticsEvent } from "./analytics"; import { injectCompositionCssVariables } from "./getVariables"; @@ -2789,6 +2790,7 @@ export function initSandboxRuntimeModular(): void { }; const hiddenImagesSkipped = skipsHiddenImages(); + const mediaDeferred = defersMedia(document); const LOOKAHEAD_SECONDS = 2; const RELEASE_LOOKAHEAD_SECONDS = 4; // Unskipped while within the window on either side of the playhead, so a step or shuttle back @@ -2814,7 +2816,7 @@ export function initSandboxRuntimeModular(): void { // A clip with no authored length loads as in a render: a reload would drop the duration it is // timed by. const inPreloadWindow = (el: HTMLMediaElement) => - hiddenImagesSkipped && el.hasAttribute("data-start") && lengthIsAuthored(el); + mediaDeferred && el.hasAttribute("data-start") && lengthIsAuthored(el); // Media on screen or due within the look-ahead loads; the rest stops holding a connection to // the origin that also serves Studio's thumbnails. @@ -2967,8 +2969,11 @@ export function initSandboxRuntimeModular(): void { const isRuntimeStamped = isDiscoveryStamped(rawNode); if (!isRuntimeStamped) rawNode.style.visibility = isVisibleNow ? "visible" : "hidden"; rawNode.toggleAttribute(CLIP_HIDDEN_ATTR, !isRuntimeStamped && !isVisibleNow); - const upcoming = - hiddenImagesSkipped && !isVisibleNow && dueSoon(rawNode, visibleAt, currentTime); + const due = + (hiddenImagesSkipped || mediaDeferred) && + !isVisibleNow && + dueSoon(rawNode, visibleAt, currentTime); + const upcoming = hiddenImagesSkipped && due; if (upcoming && !rawNode.hasAttribute(STUDIO_PREVIEW_UPCOMING_ATTR)) loadPreviewImagesIn(rawNode); rawNode.toggleAttribute(STUDIO_PREVIEW_UPCOMING_ATTR, upcoming); @@ -2976,7 +2981,7 @@ export function initSandboxRuntimeModular(): void { preloadNearPlayhead( rawNode, isVisibleNow, - upcoming || mediaStaysDue(rawNode, visibleAt, currentTime), + due || mediaStaysDue(rawNode, visibleAt, currentTime), ); if (!isMediaElement(rawNode) && !isImageElement(rawNode)) decidedTimedClip = true; if (isVideoElement(rawNode) || isImageElement(rawNode)) { diff --git a/packages/core/src/runtime/preloadMedia.ts b/packages/core/src/runtime/preloadMedia.ts index 43ac5ccf54..2d5f4c06c5 100644 --- a/packages/core/src/runtime/preloadMedia.ts +++ b/packages/core/src/runtime/preloadMedia.ts @@ -1,6 +1,6 @@ import { parseStrictFiniteTimingNumber } from "./playbackRate"; import { createRuntimeStartTimeResolver } from "./startResolver"; -import { skipsHiddenImages } from "./timedClipHide"; +import { defersMedia } from "../studioPreviewMark"; type PreloadableMedia = Pick< HTMLMediaElement, @@ -34,13 +34,13 @@ export function lengthIsAuthored(media: Element): boolean { type DeferralWindow = Window & { __hfMediaDeferral?: MutationObserver }; -/** Preview only: later clips parse at preload none, as Chromium ignores a none set mid-fetch. +/** Preview and capture builds only: later clips parse at preload none, as Chromium ignores a none set mid-fetch. * One watcher per page: a runtime evaluated again replaces the last one's. */ export function deferMediaUntilDue(): void { const win = window as DeferralWindow; win.__hfMediaDeferral?.disconnect(); win.__hfMediaDeferral = undefined; - if (!skipsHiddenImages()) return; + if (!defersMedia(document)) return; const defer = (el: Element, startInFilm: (el: Element) => number) => { const start = parseStrictFiniteTimingNumber(el.getAttribute("data-start")); if (start != null && lengthIsAuthored(el) && startInFilm(el) > 0) diff --git a/packages/core/src/studioPreviewMark.ts b/packages/core/src/studioPreviewMark.ts index e885cd6aff..deb6af246a 100644 --- a/packages/core/src/studioPreviewMark.ts +++ b/packages/core/src/studioPreviewMark.ts @@ -1,4 +1,6 @@ export const STUDIO_PREVIEW_MARK_META = "hyperframes-studio-preview"; +/** Media deferral without the preview's image skipping: a capture's still loads only the media near its moment. */ +export const DEFER_MEDIA_META = "hyperframes-defer-media"; export const STUDIO_PREVIEW_UPCOMING_ATTR = "data-hf-upcoming"; export const STUDIO_PREVIEW_LAZY_ATTR = "data-hf-preview-lazy"; export const STUDIO_PREVIEW_ERRORS = "__hfPreviewErrors"; @@ -18,3 +20,7 @@ export function applyAuthoredTiming( for (const [name, value] of attrs) el.setAttribute(name, value); el.removeAttribute(RUNTIME_STAMPED_ATTR); } + +/** Whether `doc` loads media only near the playhead: Studio's preview, or a capture build that asks for that alone. */ +export const defersMedia = (doc: Document): boolean => + doc.querySelector(`meta[name="${STUDIO_PREVIEW_MARK_META}"], meta[name="${DEFER_MEDIA_META}"]`) !== null; diff --git a/packages/studio-server/src/routes/preview.test.ts b/packages/studio-server/src/routes/preview.test.ts index cfab3342c6..4c4b11a46f 100644 --- a/packages/studio-server/src/routes/preview.test.ts +++ b/packages/studio-server/src/routes/preview.test.ts @@ -23,6 +23,7 @@ import { join, parse } from "node:path"; import { ensureHfIds } from "@hyperframes/parsers/hf-ids"; import { STUDIO_PREVIEW_ERRORS, + DEFER_MEDIA_META, STUDIO_PREVIEW_MARK_META, } from "@hyperframes/core/studio-preview-mark"; import { AFTER_FONTS_SCRIPT_TYPE } from "@hyperframes/core/compiler"; @@ -281,7 +282,7 @@ describe("registerPreviewRoutes", () => { expect(previewWindow[STUDIO_PREVIEW_ERRORS]).toEqual(["Uncaught Error: GSAP could not load"]); }); - it("serves a later scene's image lazy, and captures every image eager with no mark", async () => { + it("serves a later scene's image lazy, and captures every image eager with only media deferred", async () => { const projectDir = createProjectDir(); const later = '
