🎥 Make videos programmatically with React
fix(media): unschedule unstarted audio without stopping it
Alec Wattsd263a41a614b
diff --git a/packages/core/src/audio/shared-audio-tags.tsx b/packages/core/src/audio/shared-audio-tags.tsxindex 5a9958b8e4..bb94ef4862 100644--- a/packages/core/src/audio/shared-audio-tags.tsx+++ b/packages/core/src/audio/shared-audio-tags.tsx@@ -92,7 +92,7 @@ type SharedAudioContextValue = {resumeAsAutoPlay: () => Promise<void>;suspend: () => Promise<void>;getIsResumingAudioContext: () => Promise<AudioContextResumeResult> | null;- unscheduleAudioNode: (node: AudioBufferSourceNode) => void;+ unscheduleAudioNode: (node: AudioBufferSourceNode) => boolean;_experimentalKeepAudioContextAlive: boolean;};@@ -273,7 +273,7 @@ export const SharedAudioContextProvider: React.FC<{);const unscheduleAudioNode = useCallback((node: AudioBufferSourceNode) => {- nodesToResume.current.delete(node);+ return nodesToResume.current.delete(node);}, []);const scheduleAudioNode = useMemo(() => {diff --git a/packages/media/src/audio-iterator-manager.ts b/packages/media/src/audio-iterator-manager.tsindex 32bca908c4..78277f0b36 100644--- a/packages/media/src/audio-iterator-manager.ts+++ b/packages/media/src/audio-iterator-manager.ts@@ -423,7 +423,7 @@ export const audioIteratorManager = ({) => number | null;logLevel: LogLevel;loop: boolean;- unscheduleAudioNode: (node: AudioBufferSourceNode) => void;+ unscheduleAudioNode: (node: AudioBufferSourceNode) => boolean | void;getAudioContextCurrentTimeMockedInTest: () => number;}) => {// Audio iterators only schedule forward. Studio's reverse playback mustdiff --git a/packages/media/src/audio/audio-preview-iterator.ts b/packages/media/src/audio/audio-preview-iterator.tsindex 6d05eb1131..1f98b7bacf 100644--- a/packages/media/src/audio/audio-preview-iterator.ts+++ b/packages/media/src/audio/audio-preview-iterator.ts@@ -20,7 +20,7 @@ export type QueuedPeriod = {export type MakeAudioIteratorOptions = {startFromSecond: number;iterator: AsyncGenerator<AudioBufferSlice, void, unknown>;- unscheduleAudioNode: (node: AudioBufferSourceNode) => void;+ unscheduleAudioNode: (node: AudioBufferSourceNode) => boolean | void;};export const makeAudioIterator = ({@@ -34,7 +34,10 @@ export const makeAudioIterator = ({const cleanupAudioQueue = () => {for (const {node} of queuedAudioNodes) {- unscheduleAudioNode(node);+ if (unscheduleAudioNode(node) === true) {+ continue;+ }+try {node.stop();} catch {diff --git a/packages/media/src/shared-audio-context-for-media-player.ts b/packages/media/src/shared-audio-context-for-media-player.tsindex 7b7ad93729..6abe524d4e 100644--- a/packages/media/src/shared-audio-context-for-media-player.ts+++ b/packages/media/src/shared-audio-context-for-media-player.ts@@ -7,5 +7,5 @@ export type SharedAudioContextForMediaPlayer = {scheduleAudioNode: (options: ScheduleAudioNodeOptions,) => ScheduleAudioNodeResult;- unscheduleAudioNode: (node: AudioBufferSourceNode) => void;+ unscheduleAudioNode: (node: AudioBufferSourceNode) => boolean | void;};diff --git a/packages/media/src/test/audio-anchor-reschedule.test.tsx b/packages/media/src/test/audio-anchor-reschedule.test.tsxindex 2d3590ce81..d3b4b630a0 100644--- a/packages/media/src/test/audio-anchor-reschedule.test.tsx+++ b/packages/media/src/test/audio-anchor-reschedule.test.tsx@@ -62,7 +62,11 @@ test('replaces queued audio after a suspension re-anchors a stationary Player',vi.spyOn(context, 'state', 'get').mockReturnValue('suspended');context.dispatchEvent(new Event('statechange'));await vi.waitFor(() => {- expect(oldNodes.every(({stop}) => stop.mock.calls.length > 0)).toBe(true);+ for (const {start, stop} of oldNodes) {+ if (start.mock.calls.length > 0) expect(stop).toHaveBeenCalled();+ else expect(stop).not.toHaveBeenCalled();+ }+const replacements = createdNodes.slice(oldNodeCount).filter(({node}) => node.buffer !== null);@@ -85,3 +89,86 @@ test('replaces queued audio after a suspension re-anchors a stationary Player',vi.restoreAllMocks();}});++test('paused seeks unschedule unstarted nodes while playing cleanup still stops started nodes', async () => {+ const nodes: {+ node: AudioBufferSourceNode;+ start: ReturnType<typeof vi.spyOn>;+ stop: ReturnType<typeof vi.spyOn>;+ }[] = [];+ const {createBufferSource} = AudioContext.prototype;+ const spy = vi+ .spyOn(AudioContext.prototype, 'createBufferSource')+ .mockImplementation(function (this: AudioContext) {+ const node = createBufferSource.call(this);+ nodes.push({+ node,+ start: vi.spyOn(node, 'start'),+ stop: vi.spyOn(node, 'stop'),+ });+ return node;+ });+ const Composition: React.FC = () => (+ <Audio src="/voice-note.m4a" disallowFallbackToHtml5Audio />+ );+ const container = document.createElement('div');+ document.body.appendChild(container);+ const root = createRoot(container);+ const playerRef = React.createRef<PlayerRef>();+ root.render(+ <Player+ ref={playerRef}+ acknowledgeRemotionLicense+ component={Composition}+ compositionWidth={100}+ compositionHeight={100}+ durationInFrames={300}+ fps={30}+ inputProps={{}}+ />,+ );+ try {+ await vi.waitFor(() =>+ expect(+ nodes.filter(({node}) => node.buffer !== null).length,+ ).toBeGreaterThan(5),+ );+ const pending = nodes.filter(({node}) => node.buffer !== null);+ expect(pending.every(({start}) => start.mock.calls.length === 0)).toBe(+ true,+ );+ const beforeSeek = nodes.length;+ playerRef.current!.seekTo(30);+ await vi.waitFor(() =>+ expect(+ nodes.slice(beforeSeek).filter(({node}) => node.buffer !== null).length,+ ).toBeGreaterThan(5),+ );+ for (const {stop} of pending) expect(stop).not.toHaveBeenCalled();+ playerRef.current!.play();+ await vi.waitFor(() =>+ expect(+ nodes.some(+ ({node, start}) =>+ node.buffer !== null && start.mock.calls.length > 0,+ ),+ ).toBe(true),+ );+ const started = nodes.filter(+ ({node, start}) => node.buffer !== null && start.mock.calls.length > 0,+ );+ root.unmount();+ await vi.waitFor(() => {+ for (const {stop} of started) expect(stop).toHaveBeenCalled();+ });+ for (const {node, start, stop} of nodes) {+ if (node.buffer !== null && start.mock.calls.length === 0)+ expect(stop).not.toHaveBeenCalled();+ }+ } finally {+ if (container.hasChildNodes()) root.unmount();+ container.remove();+ spy.mockRestore();+ vi.restoreAllMocks();+ }+});