Skip to content

Commit 28ac4d7

Browse files
fix(studio): the thumbnail capture page loads media near the playhead like the preview (#6146)
1 parent 2512642 commit 28ac4d7

7 files changed

Lines changed: 62 additions & 10 deletions

File tree

‎packages/core/src/runtime/init.test.ts‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -494,6 +494,37 @@ describe("initSandboxRuntimeModular", () => {
494494
expect([at(1), at(6), at(9)]).toEqual(["hidden", "visible", "hidden"]);
495495
});
496496

497+
it.each([
498+
["no mark", undefined, ["auto", "auto", "auto"]],
499+
["a preview mark", "", ["auto", "none", "none"]],
500+
["a capture-mode mark", "capture", ["auto", "none", "none"]],
501+
])("loads media near the playhead under %s", (_label, mode, expected) => {
502+
if (mode !== undefined) {
503+
const mark = document.createElement("meta");
504+
mark.name = STUDIO_PREVIEW_MARK_META;
505+
if (mode) mark.content = mode;
506+
document.head.append(mark);
507+
}
508+
try {
509+
document.body.innerHTML =
510+
`<div data-composition-id="main" data-root="true" data-start="0" data-duration="60" data-width="1920" data-height="1080">` +
511+
[0, 20, 40]
512+
.map(
513+
(start, i) =>
514+
`<video id="v${i}" src="a.mp4" data-start="${start}" data-duration="2" data-track-index="0"></video>`,
515+
)
516+
.join("") +
517+
`</div>`;
518+
window.__timelines = { main: createMockTimeline(60) };
519+
for (const video of document.querySelectorAll("video")) video.load = vi.fn();
520+
initSandboxRuntimeModular();
521+
window.__player?.seek(0.5);
522+
expect([...document.querySelectorAll("video")].map((v) => v.preload)).toEqual(expected);
523+
} finally {
524+
document.head.querySelector(`meta[name="${STUDIO_PREVIEW_MARK_META}"]`)?.remove();
525+
}
526+
});
527+
497528
it("does not hold a paused seek on images in a stamped container its script hides", () => {
498529
const mark = Object.assign(document.createElement("meta"), {
499530
name: STUDIO_PREVIEW_MARK_META,

‎packages/core/src/runtime/init.ts‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import {
1111
revealTimedClipsAfterFirstPass,
1212
SKIPPED_CLIP,
1313
showHiddenClips,
14+
defersMedia,
1415
skipsHiddenImages,
1516
} from "./timedClipHide";
1617
import {
@@ -2822,6 +2823,7 @@ export function initSandboxRuntimeModular(): void {
28222823
};
28232824

28242825
const hiddenImagesSkipped = skipsHiddenImages();
2826+
const mediaDeferred = defersMedia();
28252827
const LOOKAHEAD_SECONDS = 2;
28262828
const RELEASE_LOOKAHEAD_SECONDS = 4;
28272829
// Unskipped while within the window on either side of the playhead, so a step or shuttle back
@@ -2847,7 +2849,7 @@ export function initSandboxRuntimeModular(): void {
28472849
// A clip with no authored length loads as in a render: a reload would drop the duration it is
28482850
// timed by.
28492851
const inPreloadWindow = (el: HTMLMediaElement) =>
2850-
hiddenImagesSkipped && el.hasAttribute("data-start") && lengthIsAuthored(el);
2852+
mediaDeferred && el.hasAttribute("data-start") && lengthIsAuthored(el);
28512853

28522854
// Media on screen or due within the look-ahead loads; the rest stops holding a connection to
28532855
// the origin that also serves Studio's thumbnails.
@@ -3041,7 +3043,9 @@ export function initSandboxRuntimeModular(): void {
30413043
if (!isRuntimeStamped) rawNode.style.visibility = isVisibleNow ? "visible" : "hidden";
30423044
rawNode.toggleAttribute(CLIP_HIDDEN_ATTR, !isRuntimeStamped && !isVisibleNow);
30433045
const upcoming =
3044-
hiddenImagesSkipped && !isVisibleNow && dueSoon(rawNode, visibleAt, currentTime);
3046+
(hiddenImagesSkipped || mediaDeferred) &&
3047+
!isVisibleNow &&
3048+
dueSoon(rawNode, visibleAt, currentTime);
30453049
if (upcoming && !rawNode.hasAttribute(STUDIO_PREVIEW_UPCOMING_ATTR))
30463050
loadPreviewImagesIn(rawNode);
30473051
rawNode.toggleAttribute(STUDIO_PREVIEW_UPCOMING_ATTR, upcoming);

‎packages/core/src/runtime/preloadMedia.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { parseStrictFiniteTimingNumber } from "./playbackRate";
22
import { createRuntimeStartTimeResolver } from "./startResolver";
3-
import { skipsHiddenImages } from "./timedClipHide";
3+
import { defersMedia } from "./timedClipHide";
44

55
type PreloadableMedia = Pick<
66
HTMLMediaElement,
@@ -40,7 +40,7 @@ export function deferMediaUntilDue(): void {
4040
const win = window as DeferralWindow;
4141
win.__hfMediaDeferral?.disconnect();
4242
win.__hfMediaDeferral = undefined;
43-
if (!skipsHiddenImages()) return;
43+
if (!defersMedia()) return;
4444
const defer = (el: Element, startInFilm: (el: Element) => number) => {
4545
const start = parseStrictFiniteTimingNumber(el.getAttribute("data-start"));
4646
if (start != null && lengthIsAuthored(el) && startInFilm(el) > 0)

‎packages/core/src/runtime/timedClipHide.ts‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import {
22
RUNTIME_STAMPED_ATTR,
3+
STUDIO_PREVIEW_CAPTURE_MODE,
34
STUDIO_PREVIEW_MARK_META,
45
STUDIO_PREVIEW_UPCOMING_ATTR,
56
} from "../studioPreviewMark";
@@ -44,6 +45,10 @@ function appendStyle(parent: Element, attr: string, css: string): void {
4445
parent.appendChild(style);
4546
}
4647

48+
export function defersMedia(): boolean {
49+
return document.querySelector(STUDIO_PREVIEW_MARK) !== null;
50+
}
51+
4752
/** True in Studio's preview, where hidden clips' images are neither fetched nor decoded until due. */
4853
export function skipsHiddenImages(): boolean {
4954
return document.querySelector(`style[${SKIP_ATTR}]`) !== null;
@@ -53,8 +58,11 @@ export function hideTimedClipsUntilFirstPass(): void {
5358
if (typeof document === "undefined") return;
5459
const parent = document.head ?? document.documentElement;
5560
if (!parent) return;
56-
const preview = document.querySelector(STUDIO_PREVIEW_MARK) !== null;
57-
if (preview && !skipsHiddenImages()) appendStyle(parent, SKIP_ATTR, SKIP_HIDDEN_IMAGES);
61+
const mark = document.querySelector(STUDIO_PREVIEW_MARK);
62+
const preview = mark !== null;
63+
const capture = mark?.getAttribute("content") === STUDIO_PREVIEW_CAPTURE_MODE;
64+
if (preview && !capture && !skipsHiddenImages())
65+
appendStyle(parent, SKIP_ATTR, SKIP_HIDDEN_IMAGES);
5866
if (!document.querySelector(`style[${CONTENTS_ATTR}]`))
5967
appendStyle(parent, CONTENTS_ATTR, `${HIDE_HIDDEN_CLIP_CONTENTS} ${HIDE_FILTER_OUTPUT}`);
6068
const win = window as FirstPassWindow;

‎packages/core/src/studioPreviewMark.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
export const STUDIO_PREVIEW_MARK_META = "hyperframes-studio-preview";
2+
export const STUDIO_PREVIEW_CAPTURE_MODE = "capture";
23
export const STUDIO_PREVIEW_UPCOMING_ATTR = "data-hf-upcoming";
34
export const STUDIO_PREVIEW_LAZY_ATTR = "data-hf-preview-lazy";
45
export const STUDIO_PREVIEW_ERRORS = "__hfPreviewErrors";

‎packages/studio-server/src/routes/preview.test.ts‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ import { join, parse } from "node:path";
2323
import { ensureHfIds } from "@hyperframes/parsers/hf-ids";
2424
import {
2525
STUDIO_PREVIEW_ERRORS,
26+
STUDIO_PREVIEW_CAPTURE_MODE,
2627
STUDIO_PREVIEW_MARK_META,
2728
} from "@hyperframes/core/studio-preview-mark";
2829
import { AFTER_FONTS_SCRIPT_TYPE } from "@hyperframes/core/compiler";
@@ -281,7 +282,7 @@ describe("registerPreviewRoutes", () => {
281282
expect(previewWindow[STUDIO_PREVIEW_ERRORS]).toEqual(["Uncaught Error: GSAP could not load"]);
282283
});
283284

284-
it("serves a later scene's image lazy, and captures every image eager with no mark", async () => {
285+
it("serves a later scene's image lazy, and captures every image eager under a capture-mode mark", async () => {
285286
const projectDir = createProjectDir();
286287
const later =
287288
'<!DOCTYPE html><html><head></head><body><div data-start="5"><img src="b.png"></div></body></html>';
@@ -296,7 +297,10 @@ describe("registerPreviewRoutes", () => {
296297
expect(preview, path).toMatch(/<img loading="lazy" [^>]*src="b.png">/);
297298
expect(preview, path).toContain(STUDIO_PREVIEW_MARK_META);
298299
expect(capture, path).not.toContain("loading=");
299-
expect(capture, path).not.toContain(STUDIO_PREVIEW_MARK_META);
300+
expect(capture, path).toContain(
301+
`<meta name="${STUDIO_PREVIEW_MARK_META}" content="${STUDIO_PREVIEW_CAPTURE_MODE}">`,
302+
);
303+
expect(preview, path).not.toContain(STUDIO_PREVIEW_CAPTURE_MODE);
300304
expect(capture, path).toContain("<script data-hf-gsap-fallback>");
301305
}
302306
});

‎packages/studio-server/src/routes/preview.ts‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ import {
1414
type BundleOptions,
1515
} from "@hyperframes/core/compiler";
1616
import {
17+
STUDIO_PREVIEW_CAPTURE_MODE,
1718
STUDIO_PREVIEW_MARK_META,
1819
STUDIO_PREVIEW_ERRORS,
1920
} from "@hyperframes/core/studio-preview-mark";
@@ -320,7 +321,7 @@ function previewVariablesFromRequest(rawVariables: string | undefined):
320321
return { raw: rawVariables, values: parse.values };
321322
}
322323

323-
/** Captures screenshot right after a seek, so they get every image eager and no preview mark. */
324+
/** Captures screenshot right after a seek, so they get every image eager; media loads near the playhead. */
324325
export const PREVIEW_CAPTURE_PARAM = "hf-capture";
325326

326327
// Studio's console capture attaches at the iframe's load; this keeps what was raised before it.
@@ -335,7 +336,10 @@ function injectStudioPreviewAugmentations(
335336
capture: boolean,
336337
): string {
337338
const marked = capture
338-
? html
339+
? injectTagsAtHeadStart(
340+
html,
341+
`<meta name="${STUDIO_PREVIEW_MARK_META}" content="${STUDIO_PREVIEW_CAPTURE_MODE}">`,
342+
)
339343
: injectTagsAtHeadStart(
340344
lazyPreviewImages(html),
341345
`<meta name="${STUDIO_PREVIEW_MARK_META}">${EARLY_ERRORS_SCRIPT}`,

0 commit comments

Comments
 (0)