🎥 Make videos programmatically with React
`@remotion/studio`: Make audio waveforms react to muted changes (#10617)
Jonny Burgere7caa0782712
diff --git a/packages/core/src/CompositionManager.tsx b/packages/core/src/CompositionManager.tsxindex 4223d607a0..44e6289fe8 100644--- a/packages/core/src/CompositionManager.tsx+++ b/packages/core/src/CompositionManager.tsx@@ -78,6 +78,7 @@ type EnhancedTSequenceData =// If not a function was passed, a number is being usedvolume: string | number;doesVolumeChange: boolean;+ muted: boolean;startMediaFrom: number;mediaFrameAtSequenceZero: number | null;playbackRate: number;@@ -88,6 +89,7 @@ type EnhancedTSequenceData =src: string;volume: string | number;doesVolumeChange: boolean;+ muted: boolean;startMediaFrom: number;mediaFrameAtSequenceZero: number | null;playbackRate: number;diff --git a/packages/core/src/Sequence.tsx b/packages/core/src/Sequence.tsxindex cd0391e1cf..07da4163e1 100644--- a/packages/core/src/Sequence.tsx+++ b/packages/core/src/Sequence.tsx@@ -512,6 +512,7 @@ const RegularSequenceRefForwardingFunction: React.ForwardRefRenderFunction<startMediaFrom: startMediaFrom ?? isMedia.data.startMediaFrom,mediaFrameAtSequenceZero,volume: isMedia.data.volumes,+ muted: isMedia.data.muted,refForOutline: refForOutline ?? null,isInsideSeries,frozenFrame: registeredFrozenFrame,diff --git a/packages/core/src/audio/AudioForPreview.tsx b/packages/core/src/audio/AudioForPreview.tsxindex b5a523a2e6..0fe15b55a8 100644--- a/packages/core/src/audio/AudioForPreview.tsx+++ b/packages/core/src/audio/AudioForPreview.tsx@@ -188,6 +188,7 @@ const AudioForDevelopmentForwardRefFunction: React.ForwardRefRenderFunction<loopDisplay: undefined,documentationLink: 'https://www.remotion.dev/docs/html5-audio',refForOutline: null,+ muted: muted ?? false,});// putting playback before useVolumediff --git a/packages/core/src/test/sequence-register-once.test.tsx b/packages/core/src/test/sequence-register-once.test.tsxindex 5b0499c90a..bc6fb38040 100644--- a/packages/core/src/test/sequence-register-once.test.tsx+++ b/packages/core/src/test/sequence-register-once.test.tsx@@ -217,6 +217,7 @@ const makeMediaInTimelineData = ({volumes: 1,duration: 100,doesVolumeChange: false,+ muted: false,nonce: {get: () => [[0, 0]]},finalDisplayName: 'video.mp4',startMediaFrom,diff --git a/packages/core/src/test/use-media-in-timeline.test.tsx b/packages/core/src/test/use-media-in-timeline.test.tsxindex e60c1ba2fa..55328fac54 100644--- a/packages/core/src/test/use-media-in-timeline.test.tsx+++ b/packages/core/src/test/use-media-in-timeline.test.tsx@@ -42,7 +42,7 @@ afterAll(() => {mock.restore();});-test('useMediaInTimeline registers and unregisters new sequence', () => {+test('useMediaInTimeline registers muted changes and unregisters the sequence', () => {const registerSequence = mock();const unregisterSequence = mock();const wrapper: React.FC<{@@ -66,8 +66,8 @@ test('useMediaInTimeline registers and unregisters new sequence', () => {);};- const {unmount} = renderHook(- () =>+ const {rerender, unmount} = renderHook(+ ({muted}: {readonly muted: boolean}) =>useMediaInTimeline({volume: 1,src: 'test',@@ -83,15 +83,22 @@ test('useMediaInTimeline registers and unregisters new sequence', () => {loopDisplay: undefined,documentationLink: null,refForOutline: null,+ muted,}),{wrapper,+ initialProps: {muted: false},},);expect(registerSequence).toHaveBeenCalled();expect(registerSequence.mock.calls[0]?.[0]).toMatchObject({mediaFrameAtSequenceZero: null,+ muted: false,});++ rerender({muted: true});+ expect(registerSequence.mock.calls.at(-1)?.[0]).toMatchObject({muted: true});+unmount();expect(unregisterSequence).toHaveBeenCalled();});@@ -137,6 +144,7 @@ test('useMediaInTimeline keeps documentation links for custom display names', ()loopDisplay: undefined,documentationLink: 'https://www.remotion.dev/docs/html5-video',refForOutline: null,+ muted: false,}),{wrapper,diff --git a/packages/core/src/use-media-in-timeline.ts b/packages/core/src/use-media-in-timeline.tsindex 985fa4d342..3976e1d13d 100644--- a/packages/core/src/use-media-in-timeline.ts+++ b/packages/core/src/use-media-in-timeline.ts@@ -34,6 +34,7 @@ export const useBasicMediaInTimeline = ({sequenceDurationInFrames,mediaStartsAt,loop,+ muted,}: {volume: VolumeProp | undefined;mediaVolume: number;@@ -46,6 +47,7 @@ export const useBasicMediaInTimeline = ({sequenceDurationInFrames: number;mediaStartsAt: number;loop: boolean;+ muted: boolean;}) => {if (!src) {throw new Error('No src passed');@@ -112,6 +114,7 @@ export const useBasicMediaInTimeline = ({startMediaFrom,src,playbackRate,+ muted,};}, [volumes,@@ -122,6 +125,7 @@ export const useBasicMediaInTimeline = ({src,startMediaFrom,playbackRate,+ muted,]);return memoizedResult;@@ -146,6 +150,7 @@ export const useMediaInTimeline = ({loopDisplay,documentationLink,refForOutline,+ muted,}: {volume: VolumeProp | undefined;mediaVolume: number;@@ -161,6 +166,7 @@ export const useMediaInTimeline = ({loopDisplay: LoopDisplay | undefined;documentationLink: string | null;refForOutline: React.RefObject<Element | null> | null;+ muted: boolean;}) => {const parentSequence = useContext(SequenceContext);const startsAt = useMediaStartsAt();@@ -181,6 +187,7 @@ export const useMediaInTimeline = ({sequenceDurationInFrames: durationInFrames,mediaStartsAt,loop: false,+ muted,});const {isStudio} = useRemotionEnvironment();@@ -210,6 +217,7 @@ export const useMediaInTimeline = ({displayName: finalDisplayName,documentationLink,volume: volumes,+ muted,showInTimeline: true,nonce: nonce.get(),startMediaFrom: 0 - startsAt,@@ -253,5 +261,6 @@ export const useMediaInTimeline = ({finalDisplayName,isStudio,refForOutline,+ muted,]);};diff --git a/packages/core/src/video/VideoForPreview.tsx b/packages/core/src/video/VideoForPreview.tsxindex 6e3c61622f..cb53d9f9b7 100644--- a/packages/core/src/video/VideoForPreview.tsx+++ b/packages/core/src/video/VideoForPreview.tsx@@ -177,6 +177,7 @@ const VideoForDevelopmentRefForwardingFunction: React.ForwardRefRenderFunction<? 'https://www.remotion.dev/docs/offthreadvideo': 'https://www.remotion.dev/docs/html5-video',refForOutline: videoRef,+ muted: muted ?? false,});// putting playback before useVolumediff --git a/packages/media/src/audio/audio.tsx b/packages/media/src/audio/audio.tsxindex cce79d504d..f319fc1bfe 100644--- a/packages/media/src/audio/audio.tsx+++ b/packages/media/src/audio/audio.tsx@@ -43,6 +43,7 @@ export const audioSchema: InteractivitySchema = {hiddenFromList: false,keyframable: false,},+ muted: {type: 'boolean', default: false, description: 'Muted'},loop: {type: 'boolean', default: false, description: 'Loop'},} as const satisfies InteractivitySchema;@@ -89,6 +90,7 @@ const AudioInner: React.FC<mediaVolume,mediaStartsAt,loop: props.loop ?? false,+ muted: props.muted ?? false,});// TODO: Redundant with what we do in the Studiodiff --git a/packages/media/src/test/border-schema.test.ts b/packages/media/src/test/border-schema.test.tsindex 1492ef6ff3..72bbe0ed95 100644--- a/packages/media/src/test/border-schema.test.ts+++ b/packages/media/src/test/border-schema.test.ts@@ -40,3 +40,11 @@ test('Audio does not expose visual background or border controls', () => {expect('style.borderBottomRightRadius' in audioSchema).toBe(false);expect('style.borderBottomLeftRadius' in audioSchema).toBe(false);});++test('Audio exposes a muted control', () => {+ expect(audioSchema.muted).toEqual({+ type: 'boolean',+ default: false,+ description: 'Muted',+ });+});diff --git a/packages/media/src/video/video.tsx b/packages/media/src/video/video.tsxindex 07b52ef945..73ffad7ca5 100644--- a/packages/media/src/video/video.tsx+++ b/packages/media/src/video/video.tsx@@ -277,6 +277,7 @@ const VideoInner: React.FC<mediaVolume,mediaStartsAt,loop: loop ?? false,+ muted: muted ?? false,});// TODO: Redundant with what we do in the Studiodiff --git a/packages/studio/src/components/AudioWaveform.tsx b/packages/studio/src/components/AudioWaveform.tsxindex e8da0eb371..5ef6d2ccb1 100644--- a/packages/studio/src/components/AudioWaveform.tsx+++ b/packages/studio/src/components/AudioWaveform.tsx@@ -81,6 +81,7 @@ const AudioWaveformInner: React.FC<{readonly displayDurationInFrames: number;readonly volume: string | number;readonly doesVolumeChange: boolean;+ readonly muted: boolean;readonly playbackRate: number;readonly loopDisplay: LoopDisplay | undefined;}> = ({@@ -93,6 +94,7 @@ const AudioWaveformInner: React.FC<{visualizationWidth,volume,doesVolumeChange,+ muted,playbackRate,loopDisplay,}) => {@@ -114,6 +116,10 @@ const AudioWaveformInner: React.FC<{doesVolumeChange && typeof volume === 'string';const parsedVolume = useMemo(() => parseVolume(volume), [volume]);const visibleVolume = useMemo((): WaveformVolume => {+ if (muted) {+ return 0;+ }+return getVisibleWaveformVolume({displayDurationInFrames,displayOffsetInFrames,@@ -124,6 +130,7 @@ const AudioWaveformInner: React.FC<{displayDurationInFrames,displayOffsetInFrames,loopDisplay,+ muted,parsedVolume,]);diff --git a/packages/studio/src/components/Timeline/TimelineSequence.tsx b/packages/studio/src/components/Timeline/TimelineSequence.tsxindex c9a4849eca..e84edf63c6 100644--- a/packages/studio/src/components/Timeline/TimelineSequence.tsx+++ b/packages/studio/src/components/Timeline/TimelineSequence.tsx@@ -680,6 +680,7 @@ const TimelineSequenceInner: React.FC<{src={s.src}height={TIMELINE_LAYER_HEIGHT_AUDIO}doesVolumeChange={s.doesVolumeChange}+ muted={s.muted}visualizationWidth={visibleLayout.media.width}startFrom={s.startMediaFrom}durationInFrames={s.duration}@@ -702,6 +703,7 @@ const TimelineSequenceInner: React.FC<{sequenceFrameOffset={sequenceFrameOffset}playbackRate={s.playbackRate}volume={s.volume}+ muted={s.muted}doesVolumeChange={s.doesVolumeChange}marginLeft={visibleLayout.media.left}loopDisplay={s.loopDisplay}diff --git a/packages/studio/src/components/Timeline/TimelineVideoInfo.tsx b/packages/studio/src/components/Timeline/TimelineVideoInfo.tsxindex 3a09a909e8..cf94f92de2 100644--- a/packages/studio/src/components/Timeline/TimelineVideoInfo.tsx+++ b/packages/studio/src/components/Timeline/TimelineVideoInfo.tsx@@ -61,6 +61,7 @@ const TimelineVideoInfoSegment: React.FC<{readonly playbackRate: number;readonly volume: string | number;readonly doesVolumeChange: boolean;+ readonly muted: boolean;readonly frozenMediaFrame: number | null;readonly extendLastFrame: boolean;}> = ({@@ -75,6 +76,7 @@ const TimelineVideoInfoSegment: React.FC<{playbackRate,volume,doesVolumeChange,+ muted,frozenMediaFrame,extendLastFrame,}) => {@@ -479,6 +481,7 @@ const TimelineVideoInfoSegment: React.FC<{}volume={volume}doesVolumeChange={doesVolumeChange}+ muted={muted}playbackRate={playbackRate}loopDisplay={tiledLoop?.loopDisplay}/>@@ -536,6 +539,7 @@ const TimelineVideoInfoInner: React.FC<{readonly playbackRate: number;readonly volume: string | number;readonly doesVolumeChange: boolean;+ readonly muted: boolean;readonly marginLeft: number;readonly loopDisplay: LoopDisplay | undefined;readonly frozenMediaFrame: number | null;@@ -551,6 +555,7 @@ const TimelineVideoInfoInner: React.FC<{playbackRate,volume,doesVolumeChange,+ muted,marginLeft,loopDisplay,frozenMediaFrame,@@ -633,6 +638,7 @@ const TimelineVideoInfoInner: React.FC<{playbackRate={playbackRate}volume={volume}doesVolumeChange={doesVolumeChange}+ muted={muted}frozenMediaFrame={frozenMediaFrame}extendLastFrame={extendLastFrame}/>@@ -654,6 +660,7 @@ const TimelineVideoInfoInner: React.FC<{segment.durationInFrames,)}doesVolumeChange={doesVolumeChange}+ muted={muted}frozenMediaFrame={frozenMediaFrame}extendLastFrame={extendLastFrame}/>diff --git a/packages/studio/src/test/sequenced-timeline.test.ts b/packages/studio/src/test/sequenced-timeline.test.tsindex 5b00c15d05..ee34274081 100644--- a/packages/studio/src/test/sequenced-timeline.test.ts+++ b/packages/studio/src/test/sequenced-timeline.test.ts@@ -154,6 +154,7 @@ test('Should calculate sequences correctly', () => {nonce: [[0, 212]],startMediaFrom: 0,doesVolumeChange: false,+ muted: false,getStack,refForOutline: null,isInsideSeries: false,@@ -214,6 +215,7 @@ test('Should calculate sequences correctly', () => {nonce: [[0, 214]],startMediaFrom: 330,doesVolumeChange: false,+ muted: false,getStack,refForOutline: null,isInsideSeries: false,@@ -293,6 +295,7 @@ const sequences: TSequence[] = [nonce: [[0, 212]],startMediaFrom: 0,doesVolumeChange: false,+ muted: false,getStack,refForOutline: null,isInsideSeries: false,@@ -345,6 +348,7 @@ const sequences: TSequence[] = [nonce: [[0, 214]],startMediaFrom: 330,doesVolumeChange: false,+ muted: false,getStack,refForOutline: null,isInsideSeries: false,diff --git a/packages/studio/src/test/timeline.test.ts b/packages/studio/src/test/timeline.test.tsindex 41c54d9ec7..5735550d8f 100644--- a/packages/studio/src/test/timeline.test.ts+++ b/packages/studio/src/test/timeline.test.ts@@ -239,6 +239,7 @@ test('Should inherit loop display from parent for media tracks', () => {src: 'video.mp4',volume: 1,doesVolumeChange: false,+ muted: false,startMediaFrom: 0,playbackRate: 1,frozenMediaFrame: null,@@ -375,6 +376,7 @@ test('Should account for a parent Sequence trimBefore in video thumbnails', () =src: 'https://remotion.media/video.mp4',volume: 1,doesVolumeChange: false,+ muted: false,startMediaFrom: 0,playbackRate: 1,},