Skip to content

fix: keep preview effects moving through VFR frame holds #855

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SHN2004 wants to merge 1 commit into
base: main
Choose a base branch
from
+22 −96
Open

fix: keep preview effects moving through VFR frame holds #855

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 19 additions & 56 deletions src/components/video-editor/videoPlayback/videoEventHandlers.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,7 @@ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";

import { createVideoEventHandlers } from "./videoEventHandlers";

type PresentedFrameCallback = (now: DOMHighResTimeStamp, metadata: { mediaTime?: number }) => void;

type MockVideo = HTMLVideoElement & {
requestVideoFrameCallback?: (callback: PresentedFrameCallback) => number;
cancelVideoFrameCallback?: (handle: number) => void;
};
type MockVideo = HTMLVideoElement;

function createMutableRef<T>(value: T) {
return { current: value };
Expand Down Expand Up @@ -41,14 +36,16 @@ describe("createVideoEventHandlers", () => {
vi.unstubAllGlobals();
});

it("prefers requestVideoFrameCallback mediaTime when available", () => {
let presentedFrameCallback: PresentedFrameCallback | null = null;
it("advances from currentTime between presented video frames", () => {
let animationFrameCallback: FrameRequestCallback | null = null;
requestAnimationFrameMock.mockImplementation((callback: FrameRequestCallback) => {
animationFrameCallback = callback;
return 19;
});
const requestVideoFrameCallback = vi.fn(() => 7);
const video = createMockVideo({
requestVideoFrameCallback: vi.fn((callback) => {
presentedFrameCallback = callback;
return 7;
}),
cancelVideoFrameCallback: vi.fn(),
currentTime: 0.5,
requestVideoFrameCallback,
});
const onPlayStateChange = vi.fn();
const onTimeUpdate = vi.fn();
Expand All @@ -70,44 +67,14 @@ describe("createVideoEventHandlers", () => {

handlers.handlePlay();
expect(onPlayStateChange).toHaveBeenCalledWith(true);
expect(video.requestVideoFrameCallback).toHaveBeenCalledTimes(1);
expect(requestAnimationFrameMock).not.toHaveBeenCalled();

presentedFrameCallback?.(0, { mediaTime: 1.25 });

expect(onTimeUpdate).toHaveBeenCalledWith(1.25);
expect(currentTimeRef.current).toBe(1250);
});

it("falls back to requestAnimationFrame when requestVideoFrameCallback is unavailable", () => {
let animationFrameCallback: FrameRequestCallback | null = null;
requestAnimationFrameMock.mockImplementation((callback: FrameRequestCallback) => {
animationFrameCallback = callback;
return 19;
});
const video = createMockVideo({ currentTime: 0.75 });
const onTimeUpdate = vi.fn();

const handlers = createVideoEventHandlers({
video,
isSeekingRef: createMutableRef(false),
isPlayingRef: createMutableRef(false),
allowPlaybackRef: createMutableRef(true),
currentTimeRef: createMutableRef(0),
timeUpdateAnimationRef: createMutableRef<number | null>(null),
onPlayStateChange: vi.fn(),
onTimeUpdate,
trimRegionsRef: createMutableRef([]),
speedRegionsRef: createMutableRef([]),
});

handlers.handlePlay();
expect(requestAnimationFrameMock).toHaveBeenCalledTimes(1);
expect(requestVideoFrameCallback).not.toHaveBeenCalled();

video.paused = true;
video.currentTime = 1.25;
animationFrameCallback?.(0);

expect(onTimeUpdate).toHaveBeenCalledWith(0.75);
expect(onTimeUpdate).toHaveBeenCalledWith(1.25);
expect(currentTimeRef.current).toBe(1250);
});

it("skips removed footage when playback reaches a cut region", () => {
Expand Down Expand Up @@ -139,12 +106,8 @@ describe("createVideoEventHandlers", () => {
expect(onTimeUpdate).toHaveBeenLastCalledWith(2);
});

it("cancels a pending requestVideoFrameCallback on pause and dispose", () => {
const cancelVideoFrameCallback = vi.fn();
const video = createMockVideo({
requestVideoFrameCallback: vi.fn(() => 23),
cancelVideoFrameCallback,
});
it("cancels a pending animation frame on pause and dispose", () => {
const video = createMockVideo();
const handlers = createVideoEventHandlers({
video,
isSeekingRef: createMutableRef(false),
Expand All @@ -160,12 +123,12 @@ describe("createVideoEventHandlers", () => {

handlers.handlePlay();
handlers.handlePause();
expect(cancelVideoFrameCallback).toHaveBeenCalledWith(23);
expect(cancelAnimationFrameMock).toHaveBeenCalledWith(11);

cancelVideoFrameCallback.mockClear();
cancelAnimationFrameMock.mockClear();
handlers.handlePlay();
handlers.dispose();
expect(cancelVideoFrameCallback).toHaveBeenCalledWith(23);
expect(cancelAnimationFrameMock).toHaveBeenCalledWith(11);
});

it("skips removed footage after a paused seek", () => {
Expand Down
43 changes: 3 additions & 40 deletions src/components/video-editor/videoPlayback/videoEventHandlers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,6 @@ import type React from "react";
import { enablePitchPreservingPlayback } from "@/lib/mediaTiming";
import type { SpeedRegion, TrimRegion } from "../types";

interface PresentedFrameMetadata {
mediaTime?: number;
}

type PresentedFrameVideoElement = HTMLVideoElement & {
requestVideoFrameCallback?: (
callback: (now: DOMHighResTimeStamp, metadata: PresentedFrameMetadata) => void,
) => number;
cancelVideoFrameCallback?: (handle: number) => void;
};

interface VideoEventHandlersParams {
video: HTMLVideoElement;
isSeekingRef: React.MutableRefObject<boolean>;
Expand All @@ -39,8 +28,6 @@ export function createVideoEventHandlers(params: VideoEventHandlersParams) {
trimRegionsRef,
speedRegionsRef,
} = params;
const presentedFrameVideo = video as PresentedFrameVideoElement;
let videoFrameRequestId: number | null = null;
enablePitchPreservingPlayback(video);

const emitTime = (timeValue: number) => {
Expand Down Expand Up @@ -84,48 +71,24 @@ export function createVideoEventHandlers(params: VideoEventHandlersParams) {
cancelAnimationFrame(timeUpdateAnimationRef.current);
timeUpdateAnimationRef.current = null;
}

if (
videoFrameRequestId !== null &&
typeof presentedFrameVideo.cancelVideoFrameCallback === "function"
) {
presentedFrameVideo.cancelVideoFrameCallback(videoFrameRequestId);
videoFrameRequestId = null;
}
};

const scheduleNextUpdate = () => {
if (video.paused || video.ended) {
return;
}

// Align editor state with the frame Chromium actually presented instead of
// polling `currentTime` on a generic animation frame.
if (typeof presentedFrameVideo.requestVideoFrameCallback === "function") {
videoFrameRequestId = presentedFrameVideo.requestVideoFrameCallback(
(_now, metadata) => {
videoFrameRequestId = null;
updateTime(metadata);
},
);
return;
}

// Effects follow the continuous media clock even when a VFR source holds a frame.
timeUpdateAnimationRef.current = requestAnimationFrame(() => {
timeUpdateAnimationRef.current = null;
updateTime();
});
};

function getPresentedTime(metadata?: PresentedFrameMetadata): number {
const mediaTime = metadata?.mediaTime;
return Number.isFinite(mediaTime) ? (mediaTime ?? 0) : video.currentTime;
}

function updateTime(metadata?: PresentedFrameMetadata) {
function updateTime() {
if (!video) return;

const presentedTime = getPresentedTime(metadata);
const presentedTime = video.currentTime;
const currentTimeMs = presentedTime * 1000;
const activeTrimRegion = findActiveTrimRegion(currentTimeMs);

Expand Down