Skip to content

🎥 Make videos programmatically with React

Visualize volume keyframes in the timeline

JonnyBurger41bcc9c8a918
diff --git a/packages/core/src/use-media-in-timeline.ts b/packages/core/src/use-media-in-timeline.ts
index d2c278f498..744f3e9339 100644
--- a/packages/core/src/use-media-in-timeline.ts
+++ b/packages/core/src/use-media-in-timeline.ts
@@ -1,4 +1,4 @@
-import {useCallback, useContext, useEffect, useMemo, useState} from 'react';
+import {useCallback, useContext, useMemo} from 'react';
import {
Html5MediaTrimContext,
useMediaStartsAt,
@@ -20,21 +20,9 @@ import {useVideoConfig} from './use-video-config.js';
import type {VolumeProp} from './volume-prop.js';
import {evaluateVolume} from './volume-prop.js';
-const didWarn: {[key: string]: boolean} = {};
-const warnOnce = (message: string) => {
- if (didWarn[message]) {
- return;
- }
-
- // eslint-disable-next-line no-console
- console.warn(message);
- didWarn[message] = true;
-};
-
export const useBasicMediaInTimeline = ({
volume,
mediaVolume,
- mediaType,
src,
displayName,
trimBefore,
@@ -48,7 +36,6 @@ export const useBasicMediaInTimeline = ({
}: {
volume: VolumeProp | undefined;
mediaVolume: number;
- mediaType: 'audio' | 'video' | 'image';
src: string | undefined;
displayName: string | null;
trimBefore: number | undefined;
@@ -67,8 +54,6 @@ export const useBasicMediaInTimeline = ({
const parentSequence = useContext(SequenceContext);
const sequencePlaybackRate = parentSequence?.playbackRate ?? 1;
- const [initialVolume] = useState<VolumeProp | undefined>(() => volume);
-
const duration = getTimelineDuration({
compositionDurationInFrames: sequenceDurationInFrames,
playbackRate,
@@ -117,14 +102,6 @@ export const useBasicMediaInTimeline = ({
sequencePlaybackRate,
]);
- useEffect(() => {
- if (typeof volume === 'number' && volume !== initialVolume) {
- warnOnce(
- `Remotion: The ${mediaType} with src ${src} has changed it's volume. Prefer the callback syntax for setting volume to get better timeline display: https://www.remotion.dev/docs/audio/volume`,
- );
- }
- }, [initialVolume, mediaType, src, volume]);
-
const doesVolumeChange = typeof volume === 'function';
const startMediaFrom = 0 - mediaStartsAt + (trimBefore ?? 0);
@@ -215,7 +192,6 @@ export const useMediaInTimeline = ({
} = useBasicMediaInTimeline({
volume: loopContext && typeof volume === 'function' ? undefined : volume,
mediaVolume,
- mediaType,
src,
displayName,
trimAfter: undefined,
diff --git a/packages/docs/docs/audio/volume.mdx b/packages/docs/docs/audio/volume.mdx
index 19ce9e1158..f800feb721 100644
--- a/packages/docs/docs/audio/volume.mdx
+++ b/packages/docs/docs/audio/volume.mdx
@@ -26,28 +26,47 @@ export const MyComposition = () => {
## Changing volume over time
-You can also change volume over time by passing in a function that takes a frame number and returns the volume.
+You can also change volume over time using [`useCurrentFrame()`](/docs/use-current-frame) and [`interpolate()`](/docs/interpolate).
-```tsx twoslash {10} title="MyComp.tsx"
+```tsx twoslash {6,11} title="MyComp.tsx"
import {Audio} from '@remotion/media';
-import {AbsoluteFill, interpolate, staticFile, useVideoConfig} from 'remotion';
+import {AbsoluteFill, interpolate, staticFile, useCurrentFrame, useVideoConfig} from 'remotion';
export const MyComposition = () => {
+ const frame = useCurrentFrame();
const {fps} = useVideoConfig();
return (
<AbsoluteFill>
- <Audio src={staticFile('audio.mp3')} volume={(f) => interpolate(f, [0, 1 * fps], [0, 1], {extrapolateLeft: 'clamp'})} />
+ <Audio src={staticFile('audio.mp3')} volume={interpolate(frame, [0, 1 * fps], [0, 1], {extrapolateLeft: 'clamp', extrapolateRight: 'clamp'})} />
</AbsoluteFill>
);
};
```
In this example we are using the [`interpolate()`](/docs/interpolate) function to fade the audio in over 1 second.
+With [Studio interactivity](/docs/studio/interactivity) enabled, the Studio recognizes these keyframes, lets you edit them, and draws the resulting volume curve in the timeline.
+Select an audio or video timeline row and press <kbd>V</kbd> to select its `volume` property. <AvailableFrom v="4.0.530" inline />
Note that because values below 0 are not allowed, we need to set the [`extrapolateLeft: 'clamp'`](/docs/interpolate#extrapolateleft) option to ensure no negative values.
-Inside the callback function, the value of `f` starts always `0` when the audio begins to play.
-It is not the same as the value of [`useCurrentFrame()`](/docs/use-current-frame).
+## Media-relative and procedural volume
-Prefer using a callback function if the volume is changing. This will enable Remotion to draw a volume curve in the [Studio](/docs/studio) and is more performant.
+The `volume` prop also accepts a callback. Use it when the volume should be relative to the start of the media or when the curve cannot be expressed as editable keyframes:
+
+```tsx twoslash {9} title="MyComp.tsx"
+import {Audio} from '@remotion/media';
+import {interpolate, staticFile, useVideoConfig} from 'remotion';
+
+export const MyComposition = () => {
+ const {fps} = useVideoConfig();
+
+ return (
+ <Audio src={staticFile('audio.mp3')} volume={(mediaFrame) => interpolate(mediaFrame, [0, 1 * fps], [0, 1], {extrapolateRight: 'clamp'})} />
+ );
+};
+```
+
+The callback frame starts at `0` when the media begins to play and is not necessarily the same as [`useCurrentFrame()`](/docs/use-current-frame). For looped media, [`loopVolumeCurveBehavior`](/docs/media/audio#loopvolumecurvebehavior) controls whether it resets on every loop.
+
+Callback volume curves are also drawn in the [Studio](/docs/studio), but they are not editable as keyframes.
diff --git a/packages/docs/docs/config.mdx b/packages/docs/docs/config.mdx
index 30fab5864f..807bd40240 100644
--- a/packages/docs/docs/config.mdx
+++ b/packages/docs/docs/config.mdx
@@ -245,6 +245,7 @@ Config.setKeyboardShortcuts({
playPause: {key: 'q'},
quickSwitcher: {key: 'p', commandOrControl: true},
toggleSnapping: {key: 's', shift: true},
+ selectVolumeProp: {key: 'v', shift: true},
render: null,
});
```
diff --git a/packages/docs/docs/media/audio.mdx b/packages/docs/docs/media/audio.mdx
index d309430f0c..0929bf9a69 100644
--- a/packages/docs/docs/media/audio.mdx
+++ b/packages/docs/docs/media/audio.mdx
@@ -131,13 +131,15 @@ export const MyVideo = () => {
```
```tsx twoslash title="Changing the volume over time"
-import {AbsoluteFill, interpolate, staticFile} from 'remotion';
+import {AbsoluteFill, interpolate, staticFile, useCurrentFrame} from 'remotion';
import {Audio} from '@remotion/media';
export const MyVideo = () => {
+ const frame = useCurrentFrame();
+
return (
<AbsoluteFill>
- <Audio volume={(f) => interpolate(f, [0, 30], [0, 1], {extrapolateLeft: 'clamp'})} src={staticFile('voice.mp3')} />
+ <Audio volume={interpolate(frame, [0, 30], [0, 1], {extrapolateLeft: 'clamp', extrapolateRight: 'clamp'})} src={staticFile('voice.mp3')} />
</AbsoluteFill>
);
};
diff --git a/packages/docs/docs/media/video.mdx b/packages/docs/docs/media/video.mdx
index e23391531c..fd8337dfbd 100644
--- a/packages/docs/docs/media/video.mdx
+++ b/packages/docs/docs/media/video.mdx
@@ -180,13 +180,15 @@ export const MyVideo = () => {
```
```tsx twoslash title="Changing the volume over time"
-import {AbsoluteFill, interpolate, staticFile} from 'remotion';
+import {AbsoluteFill, interpolate, staticFile, useCurrentFrame} from 'remotion';
import {Video} from '@remotion/media';
export const MyVideo = () => {
+ const frame = useCurrentFrame();
+
return (
<AbsoluteFill>
- <Video volume={(f) => interpolate(f, [0, 30], [0, 1], {extrapolateLeft: 'clamp', extrapolateRight: 'clamp'})} src={'https://remotion.media/video.mp4'} />
+ <Video volume={interpolate(frame, [0, 30], [0, 1], {extrapolateLeft: 'clamp', extrapolateRight: 'clamp'})} src={'https://remotion.media/video.mp4'} />
</AbsoluteFill>
);
};
diff --git a/packages/docs/docs/studio/shortcuts.mdx b/packages/docs/docs/studio/shortcuts.mdx
index 16f347b243..1801b79a25 100644
--- a/packages/docs/docs/studio/shortcuts.mdx
+++ b/packages/docs/docs/studio/shortcuts.mdx
@@ -48,6 +48,7 @@ You can also press <kbd>?</kbd> to open this tab.
| `selectOpacityProp` | `T` | Select the `style.opacity` property |
| `selectRotateProp` | `R` | Select the `style.rotate` property |
| `selectScaleProp` | `S` | Select the `style.scale` property |
+| `selectVolumeProp` | `V` | Select the `volume` property <AvailableFrom v="4.0.530" inline /> |
| `duplicateSequences` | `Cmd/Ctrl+D` | Duplicate selected sequences |
| `splitSequences` | `Cmd/Ctrl+Shift+D` | Split eligible selected sequences at the playhead <AvailableFrom v="4.0.527" inline /> |
| `copyEffectsAndValues` | `Cmd/Ctrl+C` | Copy selected effects or property values |
@@ -94,6 +95,7 @@ Config.setKeyboardShortcuts({
toggleLoop: {key: 'y'},
quickSwitcher: {key: 'p', commandOrControl: true},
toggleSnapping: {key: 's', shift: true},
+ selectVolumeProp: {key: 'v', shift: true},
render: null,
});
```
diff --git a/packages/eslint-plugin/src/index.ts b/packages/eslint-plugin/src/index.ts
index 9cc268f3af..b9ec728790 100644
--- a/packages/eslint-plugin/src/index.ts
+++ b/packages/eslint-plugin/src/index.ts
@@ -41,7 +41,6 @@ const recommendedRuleConfig = {
'@remotion/even-dimensions': 'error',
'@remotion/duration-in-frames': 'error',
'@remotion/from-0': 'error',
- '@remotion/volume-callback': 'error',
'@remotion/use-gif-component': 'error',
'@remotion/staticfile-no-relative': 'error',
'@remotion/staticfile-no-remote': 'error',
diff --git a/packages/eslint-plugin/src/rules/volume-callback.ts b/packages/eslint-plugin/src/rules/volume-callback.ts
index 5c1f21cb4b..89561fef80 100644
--- a/packages/eslint-plugin/src/rules/volume-callback.ts
+++ b/packages/eslint-plugin/src/rules/volume-callback.ts
@@ -9,7 +9,7 @@ type Options = [];
type MessageIds = 'VolumeCallback';
const VolumeCallback =
- 'Prefer a callback function for setting the volume: `volume={(f) => interpolate(...)}`. See https://www.remotion.dev/docs/audio/volume';
+ 'Deprecated no-op kept for compatibility. Volume can be animated with regular keyframes.';
export default createRule<Options, MessageIds>({
name: 'volume-callback',
@@ -26,64 +26,5 @@ export default createRule<Options, MessageIds>({
},
},
defaultOptions: [],
- create: (context) => {
- return {
- JSXAttribute: (node) => {
- if (node.type !== 'JSXAttribute') {
- return;
- }
- if (node.name.name !== 'volume') {
- return;
- }
- const value = node.value;
- if (!value || value.type !== 'JSXExpressionContainer') {
- return;
- }
-
- const parent = node.parent;
- if (!parent) {
- return;
- }
-
- if (parent.type !== 'JSXOpeningElement') {
- return;
- }
- const name = parent.name;
- if (name.type !== 'JSXIdentifier') {
- return;
- }
- if (
- name.name !== 'Video' &&
- name.name !== 'Audio' &&
- name.name !== 'Html5Video' &&
- name.name !== 'Html5Audio'
- ) {
- return;
- }
-
- const expression = value.expression;
- if (!expression) {
- return;
- }
-
- if (expression.type === 'Literal') {
- return;
- }
- if (expression.type === 'ArrowFunctionExpression') {
- return;
- }
- if (expression.type === 'FunctionExpression') {
- return;
- }
- if (expression.type === 'Identifier') {
- return;
- }
-
- context.report({
- messageId: 'VolumeCallback',
- node,
- });
- },
- };
- },
+ create: () => ({}),
});
diff --git a/packages/eslint-plugin/src/tests/volume-callback.test.ts b/packages/eslint-plugin/src/tests/volume-callback.test.ts
index 0bda363888..7446a3d414 100644
--- a/packages/eslint-plugin/src/tests/volume-callback.test.ts
+++ b/packages/eslint-plugin/src/tests/volume-callback.test.ts
@@ -77,10 +77,7 @@ export const Re = () => {
);
}
`,
- ],
- invalid: [
- {
- code: `
+ `
import {Video, useCurrentFrame} from 'remotion';
export const Re = () => {
@@ -91,14 +88,7 @@ export const Re = () => {
);
}
`,
- errors: [
- {
- messageId: 'VolumeCallback',
- },
- ],
- },
- {
- code: `
+ `
import {Html5Video, useCurrentFrame} from 'remotion';
export const Re = () => {
@@ -109,14 +99,7 @@ export const Re = () => {
);
}
`,
- errors: [
- {
- messageId: 'VolumeCallback',
- },
- ],
- },
- {
- code: `
+ `
import {Video, useCurrentFrame} from 'remotion';
export const Re = () => {
@@ -127,11 +110,6 @@ export const Re = () => {
);
}
`,
- errors: [
- {
- messageId: 'VolumeCallback',
- },
- ],
- },
],
+ invalid: [],
});
diff --git a/packages/media/src/audio/audio.tsx b/packages/media/src/audio/audio.tsx
index 56a3db0949..0860445ba1 100644
--- a/packages/media/src/audio/audio.tsx
+++ b/packages/media/src/audio/audio.tsx
@@ -129,7 +129,6 @@ const AudioInner: React.FC<
trimBefore: props.trimBefore,
trimAfter: effectiveTrimAfter,
sequenceDurationInFrames,
- mediaType: 'audio',
displayName: name ?? '<Audio>',
mediaVolume,
mediaStartsAt,
diff --git a/packages/media/src/video/video.tsx b/packages/media/src/video/video.tsx
index 55c997141d..bb17a9ed1b 100644
--- a/packages/media/src/video/video.tsx
+++ b/packages/media/src/video/video.tsx
@@ -307,7 +307,6 @@ const VideoInner: React.FC<
trimBefore,
trimAfter: effectiveTrimAfter,
sequenceDurationInFrames,
- mediaType: 'video',
displayName: name ?? '<Video>',
mediaVolume,
mediaStartsAt,
diff --git a/packages/skills/skills/remotion-markup/audio.md b/packages/skills/skills/remotion-markup/audio.md
index 3a31e8ff74..9d514a1989 100644
--- a/packages/skills/skills/remotion-markup/audio.md
+++ b/packages/skills/skills/remotion-markup/audio.md
@@ -81,24 +81,35 @@ Set a static volume (0 to 1):
<Audio src={staticFile("audio.mp3")} volume={0.5} />
```
-Or use a callback for dynamic volume based on the current frame:
+Use `useCurrentFrame()` and `interpolate()` for keyframed volume:
```tsx
-import { interpolate } from "remotion";
+import { interpolate, useCurrentFrame } from "remotion";
+const frame = useCurrentFrame();
const { fps } = useVideoConfig();
return (
<Audio
src={staticFile("audio.mp3")}
- volume={(f) =>
- interpolate(f, [0, 1 * fps], [0, 1], { extrapolateRight: "clamp" })
- }
+ volume={interpolate(frame, [0, 1 * fps], [0, 1], {
+ extrapolateLeft: "clamp",
+ extrapolateRight: "clamp",
+ })}
/>
);
```
-The value of `f` starts at 0 when the audio begins to play, not the composition frame.
+With Studio interactivity enabled, these keyframes can be edited and are shown as a volume curve in the timeline.
+
+The `volume` prop also accepts a callback for procedural or media-relative volume. The callback frame starts at 0 when the audio begins to play, not at the composition frame:
+
+```tsx
+<Audio
+ src={staticFile("audio.mp3")}
+ volume={(mediaFrame) => interpolate(mediaFrame, [0, 30], [0, 1])}
+/>
+```
## Muting
diff --git a/packages/skills/skills/remotion-markup/embedding-videos.md b/packages/skills/skills/remotion-markup/embedding-videos.md
index fd0dd42fce..c7e65dc20c 100644
--- a/packages/skills/skills/remotion-markup/embedding-videos.md
+++ b/packages/skills/skills/remotion-markup/embedding-videos.md
@@ -95,23 +95,27 @@ Set a static volume (0 to 1):
<Video src={staticFile("video.mp4")} volume={0.5} />
```
-Or use a callback for dynamic volume based on the current frame:
+Use `useCurrentFrame()` and `interpolate()` for keyframed volume:
```tsx
-import { interpolate } from "remotion";
+import { interpolate, useCurrentFrame } from "remotion";
+const frame = useCurrentFrame();
const { fps } = useVideoConfig();
return (
<Video
src={staticFile("video.mp4")}
- volume={(f) =>
- interpolate(f, [0, 1 * fps], [0, 1], { extrapolateRight: "clamp" })
- }
+ volume={interpolate(frame, [0, 1 * fps], [0, 1], {
+ extrapolateLeft: "clamp",
+ extrapolateRight: "clamp",
+ })}
/>
);
```
+With Studio interactivity enabled, these keyframes can be edited and are shown as a volume curve in the timeline. A callback is still supported when the curve should be procedural or relative to the start of the media.
+
Use `muted` to silence the video entirely:
```tsx
diff --git a/packages/studio-shared/src/keyboard-shortcuts.ts b/packages/studio-shared/src/keyboard-shortcuts.ts
index 9c66166139..8a5b700d6e 100644
--- a/packages/studio-shared/src/keyboard-shortcuts.ts
+++ b/packages/studio-shared/src/keyboard-shortcuts.ts
@@ -35,6 +35,7 @@ export const studioKeyboardShortcutActions = [
'selectOpacityProp',
'selectRotateProp',
'selectScaleProp',
+ 'selectVolumeProp',
'duplicateSequences',
'splitSequences',
'copyEffectsAndValues',
diff --git a/packages/studio-shared/src/test/keyboard-shortcuts.test.ts b/packages/studio-shared/src/test/keyboard-shortcuts.test.ts
index c365415cce..e6b01bcb6e 100644
--- a/packages/studio-shared/src/test/keyboard-shortcuts.test.ts
+++ b/packages/studio-shared/src/test/keyboard-shortcuts.test.ts
@@ -5,6 +5,7 @@ test('validates Studio keyboard shortcut configuration', () => {
expect(
validateStudioKeyboardShortcuts({
playPause: {key: 'p'},
+ selectVolumeProp: {key: 'v', shift: true},
toggleMute: {key: 'm', shift: false},
toggleLoop: [{key: 'l', shift: true}, {key: 'y'}],
quickSwitcher: {key: 'p', commandOrControl: true},
diff --git a/packages/studio/src/components/AudioWaveform.tsx b/packages/studio/src/components/AudioWaveform.tsx
index a5b73581ef..973e2e04d2 100644
--- a/packages/studio/src/components/AudioWaveform.tsx
+++ b/packages/studio/src/components/AudioWaveform.tsx
@@ -8,11 +8,10 @@ import {
import React, {useLayoutEffect, useMemo, useRef, useState} from 'react';
import type {LoopDisplay} from 'remotion';
import {Internals} from 'remotion';
-import {WHITE_ALPHA_70, WHITE_ALPHA_60} from '../helpers/colors';
+import {BLACK_ALPHA_60, WHITE_ALPHA_60} from '../helpers/colors';
import {TIMELINE_FRAME_WIDTH_AT_MAX_ZOOM} from '../helpers/get-timeline-max-zoom';
import {resolveStudioColor} from '../helpers/resolve-studio-color';
import {getStudioPixelRatio} from '../helpers/studio-pixel-ratio';
-import {TIMELINE_BORDER} from '../helpers/timeline-layout';
const EMPTY_PEAKS = new Float32Array(0);
@@ -31,18 +30,14 @@ const getContainerStyle = (height: number): React.CSSProperties => {
const waveformCanvasStyle: React.CSSProperties = {
pointerEvents: 'none',
flexShrink: 0,
+ position: 'relative',
+ zIndex: 1,
};
const volumeCanvasStyle: React.CSSProperties = {
+ pointerEvents: 'none',
position: 'absolute',
-};
-
-const parseVolume = (volume: string | number): WaveformVolume => {
- if (typeof volume === 'number') {
- return volume;
- }
-
- return volume.split(',').map((v) => Number(v));
+ zIndex: 0,
};
const AudioWaveformInner: React.FC<{
@@ -53,8 +48,7 @@ const AudioWaveformInner: React.FC<{
readonly durationInFrames: number;
readonly displayOffsetInFrames: number;
readonly displayDurationInFrames: number;
- readonly volume: string | number;
- readonly doesVolumeChange: boolean;
+ readonly volume: WaveformVolume;
readonly muted: boolean;
readonly playbackRate: number;
readonly loopDisplay: LoopDisplay | undefined;
@@ -68,7 +62,6 @@ const AudioWaveformInner: React.FC<{
displayDurationInFrames,
visualizationWidth,
volume,
- doesVolumeChange,
muted,
playbackRate,
loopDisplay,
@@ -87,9 +80,16 @@ const AudioWaveformInner: React.FC<{
const waveformCanvas = useRef<HTMLCanvasElement>(null);
const volumeCanvas = useRef<HTMLCanvasElement>(null);
- const shouldRenderVolumeOverlay =
- doesVolumeChange && typeof volume === 'string';
- const parsedVolume = useMemo(() => parseVolume(volume), [volume]);
+ const shouldRenderVolumeOverlay = typeof volume !== 'number';
+ const visualizationMaxVolume = useMemo(() => {
+ if (typeof volume === 'number') {
+ return Math.max(1, volume);
+ }
+
+ return volume.reduce((highest, value) => {
+ return Number.isFinite(value) ? Math.max(highest, value) : highest;
+ }, 1);
+ }, [volume]);
const visibleVolume = useMemo((): WaveformVolume => {
if (muted) {
return 0;
@@ -98,9 +98,9 @@ const AudioWaveformInner: React.FC<{
return getVisibleWaveformVolume({
displayDurationInFrames,
displayOffsetInFrames,
- volume: parsedVolume,
+ volume,
});
- }, [displayDurationInFrames, displayOffsetInFrames, muted, parsedVolume]);
+ }, [displayDurationInFrames, displayOffsetInFrames, muted, volume]);
// Layout effect so that a cache hit sets the peaks synchronously and the
// waveform is painted on the very first frame after mounting.
@@ -177,7 +177,7 @@ const AudioWaveformInner: React.FC<{
}, [height, portionPeaks, visibleVolume, visualizationWidth]);
useLayoutEffect(() => {
- if (!shouldRenderVolumeOverlay) {
+ if (!shouldRenderVolumeOverlay || !peaks) {
return;
}
@@ -201,31 +201,50 @@ const AudioWaveformInner: React.FC<{
volumeCanvasElement.style.height = h / pixelRatio + 'px';
context.clearRect(0, 0, w, h);
- if (!Array.isArray(visibleVolume)) {
+ if (
+ !Array.isArray(visibleVolume) ||
+ visibleVolume.length === 0 ||
+ drawingWidth <= 0 ||
+ h <= 0
+ ) {
return;
}
context.beginPath();
- context.moveTo(0, h);
- visibleVolume.forEach((v, index) => {
- const x =
- visibleVolume.length <= 1
- ? 0
- : (index / (visibleVolume.length - 1)) * drawingWidth;
- const y = (1 - v) * (h - TIMELINE_BORDER * 2 * pixelRatio) + pixelRatio;
- if (index === 0) {
- context.moveTo(x, y);
- } else {
- context.lineTo(x, y);
- }
- });
- context.strokeStyle = resolveStudioColor(
- WHITE_ALPHA_70,
+ context.moveTo(0, 0);
+ // The canvas only spans the virtualized range. Sampling by its physical
+ // width keeps drawing work bounded to the visible part of the timeline.
+ const numberOfPoints = Math.max(2, Math.ceil(drawingWidth));
+ for (let point = 0; point < numberOfPoints; point++) {
+ const progress = point / (numberOfPoints - 1);
+ const volumeIndex = progress * (visibleVolume.length - 1);
+ const leftIndex = Math.floor(volumeIndex);
+ const rightIndex = Math.ceil(volumeIndex);
+ const leftVolume = visibleVolume[leftIndex] ?? 1;
+ const rightVolume = visibleVolume[rightIndex] ?? leftVolume;
+ const interpolatedVolume =
+ leftVolume + (rightVolume - leftVolume) * (volumeIndex - leftIndex);
+ const x = progress * drawingWidth;
+ const unclampedY = (1 - interpolatedVolume / visualizationMaxVolume) * h;
+ const y = Math.max(0, Math.min(h, unclampedY));
+ context.lineTo(x, y);
+ }
+
+ context.lineTo(drawingWidth, 0);
+ context.closePath();
+ context.fillStyle = resolveStudioColor(
+ BLACK_ALPHA_60,
getComputedStyle(volumeCanvasElement),
);
- context.lineWidth = pixelRatio;
- context.stroke();
- }, [height, shouldRenderVolumeOverlay, visibleVolume, visualizationWidth]);
+ context.fill();
+ }, [
+ height,
+ peaks,
+ shouldRenderVolumeOverlay,
+ visualizationMaxVolume,
+ visibleVolume,
+ visualizationWidth,
+ ]);
if (error) {
return null;
@@ -237,10 +256,10 @@ const AudioWaveformInner: React.FC<{
return (
<div style={getContainerStyle(height)}>
- <canvas ref={waveformCanvas} style={waveformCanvasStyle} />
{shouldRenderVolumeOverlay ? (
<canvas ref={volumeCanvas} style={volumeCanvasStyle} />
) : null}
+ <canvas ref={waveformCanvas} style={waveformCanvasStyle} />
</div>
);
};
diff --git a/packages/studio/src/components/GlobalKeybindings.tsx b/packages/studio/src/components/GlobalKeybindings.tsx
index 7ce5d551be..c3c289de0f 100644
--- a/packages/studio/src/components/GlobalKeybindings.tsx
+++ b/packages/studio/src/components/GlobalKeybindings.tsx
@@ -28,6 +28,7 @@ const sequencePropShortcuts = [
{action: 'selectRotateProp', fieldKey: 'style.rotate'},
{action: 'selectScaleProp', fieldKey: 'style.scale'},
{action: 'selectOpacityProp', fieldKey: 'style.opacity'},
+ {action: 'selectVolumeProp', fieldKey: 'volume'},
] as const satisfies readonly {
readonly action: StudioKeyboardShortcutAction;
readonly fieldKey: string;
diff --git a/packages/studio/src/components/Timeline/TimelineKeyframedValue.tsx b/packages/studio/src/components/Timeline/TimelineKeyframedValue.tsx
index 7ae7c33a06..64dc186465 100644
--- a/packages/studio/src/components/Timeline/TimelineKeyframedValue.tsx
+++ b/packages/studio/src/components/Timeline/TimelineKeyframedValue.tsx
@@ -12,6 +12,7 @@ import type {
TimelineFieldOnSave,
} from '../../helpers/timeline-layout';
import {getKeyframeLocalFrame} from './get-timeline-keyframes';
+import {roundToDecimalPlaces} from './timeline-field-utils';
import {TimelineFieldValue} from './TimelineSchemaField';
const valuesEqual = (left: unknown, right: unknown): boolean => {
@@ -44,7 +45,7 @@ export const TimelineKeyframedValue: React.FC<{
status: propStatus,
});
if (typeof raw === 'number') {
- return Math.round(raw * 100) / 100;
+ return roundToDecimalPlaces(raw, 2);
}
return raw;
@@ -60,13 +61,18 @@ export const TimelineKeyframedValue: React.FC<{
);
const effectiveValue = useMemo(() => {
- return Internals.getEffectiveVisualModeValue({
+ const raw = Internals.getEffectiveVisualModeValue({
propStatus: fakeStatus,
dragOverrideValue,
frame: getKeyframeLocalFrame(sourceFrame, propStatus),
defaultValue: field.fieldSchema.default,
shouldResortToDefaultValueIfUndefined: true,
});
+ if (typeof raw === 'number') {
+ return roundToDecimalPlaces(raw, 2);
+ }
+
+ return raw;
}, [
dragOverrideValue,
fakeStatus,
diff --git a/packages/studio/src/components/Timeline/TimelineSequence.tsx b/packages/studio/src/components/Timeline/TimelineSequence.tsx
index 8d94623303..7c1b437c97 100644
--- a/packages/studio/src/components/Timeline/TimelineSequence.tsx
+++ b/packages/studio/src/components/Timeline/TimelineSequence.tsx
@@ -1,5 +1,6 @@
import {CanvasInternals} from '@remotion/canvas';
import type {TimelineTrackData} from '@remotion/canvas';
+import type {WaveformVolume} from '@remotion/timeline-utils';
import React, {
useCallback,
useContext,
@@ -53,12 +54,17 @@ import {
getSequenceContextMenuItems,
} from './get-sequence-context-menu-items';
import {getSequenceSplitMenuItem} from './get-sequence-split-menu-item';
+import {
+ getKeyframeDisplayOffset,
+ getKeyframePlaybackRate,
+} from './get-timeline-keyframes';
import {getTimelineMediaStartFrame} from './get-timeline-media-start-frame';
import {getTimelineSequenceVisibleLayout} from './get-timeline-sequence-visible-layout';
import {getCurrentFrame} from './imperative-state';
import {LoopedTimelineIndicator} from './LoopedTimelineIndicators';
import {splitSelectedTimelineItems} from './split-selected-timeline-item';
import {getTimelineAssetLinkInfo} from './timeline-asset-link';
+import {normalizeTimelineNumber} from './timeline-field-utils';
import {timelineLeftEdgeCursor} from './timeline-left-edge-cursor';
import {timelineRightEdgeCursor} from './timeline-right-edge-cursor';
import {timelineRippleEdgeCursor} from './timeline-ripple-edge-cursor';
@@ -101,6 +107,8 @@ const TimelineSequenceFn: React.FC<{
readonly s: TimelineTrackData['sequence'];
readonly connectedCompositions: readonly _InternalTypes['AnyComposition'][];
readonly nodePathInfo: SequenceNodePathInfo | null;
+ readonly keyframeDisplayOffset: number;
+ readonly keyframePlaybackRate: number;
readonly sequenceFrameOffset: number;
readonly cascadedStart: number;
readonly localStart: number;
@@ -108,6 +116,8 @@ const TimelineSequenceFn: React.FC<{
s,
connectedCompositions,
nodePathInfo,
+ keyframeDisplayOffset,
+ keyframePlaybackRate,
sequenceFrameOffset,
cascadedStart,
localStart,
@@ -124,6 +134,8 @@ const TimelineSequenceFn: React.FC<{
s={s}
connectedCompositions={connectedCompositions}
nodePathInfo={nodePathInfo}
+ keyframeDisplayOffset={keyframeDisplayOffset}
+ keyframePlaybackRate={keyframePlaybackRate}
sequenceFrameOffset={sequenceFrameOffset}
cascadedStart={cascadedStart}
localStart={localStart}
@@ -460,6 +472,8 @@ const TimelineSequenceInner: React.FC<{
readonly connectedCompositions: readonly _InternalTypes['AnyComposition'][];
readonly windowWidth: number;
readonly nodePathInfo: SequenceNodePathInfo | null;
+ readonly keyframeDisplayOffset: number;
+ readonly keyframePlaybackRate: number;
readonly sequenceFrameOffset: number;
readonly cascadedStart: number;
readonly localStart: number;
@@ -468,6 +482,8 @@ const TimelineSequenceInner: React.FC<{
connectedCompositions,
windowWidth,
nodePathInfo,
+ keyframeDisplayOffset,
+ keyframePlaybackRate,
sequenceFrameOffset,
cascadedStart,
localStart,
@@ -571,12 +587,39 @@ const TimelineSequenceInner: React.FC<{
}, [originalLocation]);
const {propStatuses} = useContext(Internals.VisualModePropStatusesContext);
+ const {getDragOverrides} = useContext(
+ Internals.VisualModeDragOverridesContext,
+ );
const nodePath = nodePathInfo?.sequenceSubscriptionKey ?? null;
const propStatusesForOverride = useMemo(() => {
return nodePath
? Internals.getPropStatusesCtx(propStatuses, nodePath)
: undefined;
}, [propStatuses, nodePath]);
+ const volumeDragOverride = useMemo(
+ () => (nodePath ? getDragOverrides(nodePath).volume : undefined),
+ [getDragOverrides, nodePath],
+ );
+ const volumeKeyframeStatus = useMemo(() => {
+ if (volumeDragOverride?.type === 'keyframed') {
+ return {
+ ...volumeDragOverride.status,
+ keyframes: volumeDragOverride.status.keyframes.map((keyframe) => ({
+ ...keyframe,
+ // Fractional frames are valid. Only remove floating-point noise
+ // from the transient values before drawing the curve.
+ value:
+ typeof keyframe.value === 'number'
+ ? normalizeTimelineNumber(keyframe.value)
+ : keyframe.value,
+ })),
+ };
+ }
+
+ return propStatusesForOverride?.volume?.status === 'keyframed'
+ ? propStatusesForOverride.volume
+ : null;
+ }, [propStatusesForOverride?.volume, volumeDragOverride]);
const durationCanUpdate = Boolean(
isStudioInteractivityEnabled() &&
propStatusesForOverride?.durationInFrames?.status === 'static',
@@ -929,6 +972,61 @@ const TimelineSequenceInner: React.FC<{
const displayDurationInFrames = s.loopDisplay
? s.loopDisplay.durationInFrames * s.loopDisplay.numberOfTimes
: s.duration;
+ const registeredVolumeValue =
+ s.type === 'audio' || s.type === 'video' ? s.volume : 1;
+ const registeredVolume = useMemo((): WaveformVolume => {
+ return typeof registeredVolumeValue === 'number'
+ ? registeredVolumeValue
+ : registeredVolumeValue.split(',').map((value) => Number(value));
+ }, [registeredVolumeValue]);
+ const keyframedTimelineVolume = useMemo((): readonly number[] | null => {
+ if (volumeKeyframeStatus === null) {
+ return null;
+ }
+
+ if (
+ !Number.isFinite(displayDurationInFrames) ||
+ displayDurationInFrames <= 0
+ ) {
+ return [];
+ }
+
+ const resolvedDisplayOffset = getKeyframeDisplayOffset({
+ propStatus: volumeKeyframeStatus,
+ keyframeDisplayOffset,
+ keyframePlaybackRate,
+ });
+ const resolvedPlaybackRate = getKeyframePlaybackRate(
+ volumeKeyframeStatus,
+ keyframePlaybackRate,
+ );
+ const firstDisplayFrame = s.from + (s.loopDisplay?.startOffset ?? 0);
+ const curve: number[] = [];
+ for (let index = 0; index < Math.ceil(displayDurationInFrames); index++) {
+ const value = Internals.interpolateKeyframedStatus({
+ forceSpringAllowTail: null,
+ frame:
+ (firstDisplayFrame + index - resolvedDisplayOffset) *
+ resolvedPlaybackRate,
+ status: volumeKeyframeStatus,
+ });
+ if (typeof value !== 'number' || !Number.isFinite(value)) {
+ return null;
+ }
+
+ curve.push(Math.max(0, value));
+ }
+
+ return curve;
+ }, [
+ displayDurationInFrames,
+ keyframeDisplayOffset,
+ keyframePlaybackRate,
+ s.from,
+ s.loopDisplay?.startOffset,
+ volumeKeyframeStatus,
+ ]);
+ const timelineVolume = keyframedTimelineVolume ?? registeredVolume;
const {
marginLeft,
@@ -1211,14 +1309,13 @@ const TimelineSequenceInner: React.FC<{
<AudioWaveform
src={s.src}
height={TIMELINE_LAYER_HEIGHT_AUDIO}
- doesVolumeChange={s.doesVolumeChange}
muted={s.muted}
visualizationWidth={visibleLayout.media.width}
startFrom={mediaLoopStartFrame}
durationInFrames={s.duration}
displayOffsetInFrames={mediaDisplayOffsetInFrames}
displayDurationInFrames={mediaDisplayDurationInFrames}
- volume={s.volume}
+ volume={timelineVolume}
playbackRate={s.playbackRate * s.sequencePlaybackRate}
loopDisplay={s.loopDisplay}
loopDisplayOffsetInFrames={s.loopDisplay?.phaseOffsetInFrames ?? 0}
@@ -1235,9 +1332,8 @@ const TimelineSequenceInner: React.FC<{
mediaFrameAtSequenceZero={mediaLoopStartFrame}
sequenceFrameOffset={0}
playbackRate={s.playbackRate * s.sequencePlaybackRate}
- volume={s.volume}
+ volume={timelineVolume}
muted={s.muted}
- doesVolumeChange={s.doesVolumeChange}
marginLeft={visibleLayout.media.left}
loopDisplay={s.loopDisplay}
loopDisplayOffsetInFrames={s.loopDisplay?.phaseOffsetInFrames ?? 0}
diff --git a/packages/studio/src/components/Timeline/TimelineTrack.tsx b/packages/studio/src/components/Timeline/TimelineTrack.tsx
index 24d8401ccd..997a725fd3 100644
--- a/packages/studio/src/components/Timeline/TimelineTrack.tsx
+++ b/packages/studio/src/components/Timeline/TimelineTrack.tsx
@@ -69,6 +69,8 @@ const TimelineTrackUnmemoized: React.FC<{
track.connectedCompositions ?? emptyConnectedCompositions
}
nodePathInfo={track.nodePathInfo}
+ keyframeDisplayOffset={track.keyframeDisplayOffset}
+ keyframePlaybackRate={track.keyframePlaybackRate}
sequenceFrameOffset={track.sequenceFrameOffset}
/>
</div>
diff --git a/packages/studio/src/components/Timeline/TimelineVideoInfo.tsx b/packages/studio/src/components/Timeline/TimelineVideoInfo.tsx
index 3413b6a4bb..d4850f2f7b 100644
--- a/packages/studio/src/components/Timeline/TimelineVideoInfo.tsx
+++ b/packages/studio/src/components/Timeline/TimelineVideoInfo.tsx
@@ -12,6 +12,7 @@ import {
getTimestampFromFrameDatabaseKey,
makeFrameDatabaseKey,
resizeVideoFrame,
+ type WaveformVolume,
WEBCODECS_TIMESCALE,
} from '@remotion/timeline-utils';
import React, {useEffect, useMemo, useRef, useState} from 'react';
@@ -62,8 +63,7 @@ const TimelineVideoInfoSegment: React.FC<{
readonly loopWidth: number;
} | null;
readonly playbackRate: number;
- readonly volume: string | number;
- readonly doesVolumeChange: boolean;
+ readonly volume: WaveformVolume;
readonly muted: boolean;
readonly frozenMediaFrame: number | null;
readonly extendLastFrame: boolean;
@@ -78,7 +78,6 @@ const TimelineVideoInfoSegment: React.FC<{
tiledLoop,
playbackRate,
volume,
- doesVolumeChange,
muted,
frozenMediaFrame,
extendLastFrame,
@@ -490,7 +489,6 @@ const TimelineVideoInfoSegment: React.FC<{
tiledLoop?.displayDurationInFrames ?? durationInFrames
}
volume={volume}
- doesVolumeChange={doesVolumeChange}
muted={muted}
playbackRate={playbackRate}
loopDisplay={tiledLoop?.loopDisplay}
@@ -543,8 +541,7 @@ const TimelineVideoInfoInner: React.FC<{
readonly mediaFrameAtSequenceZero: number | null;
readonly sequenceFrameOffset: number;
readonly playbackRate: number;
- readonly volume: string | number;
- readonly doesVolumeChange: boolean;
+ readonly volume: WaveformVolume;
readonly muted: boolean;
readonly marginLeft: number;
readonly loopDisplay: LoopDisplay | undefined;
@@ -561,7 +558,6 @@ const TimelineVideoInfoInner: React.FC<{
sequenceFrameOffset,
playbackRate,
volume,
- doesVolumeChange,
muted,
marginLeft,
loopDisplay,
@@ -622,16 +618,13 @@ const TimelineVideoInfoInner: React.FC<{
return volume;
}
- const values = volume.split(',');
- return values
- .slice(
- Math.max(0, Math.floor(segmentDisplayOffsetInFrames)),
- Math.min(
- values.length,
- Math.ceil(segmentDisplayOffsetInFrames + segmentDurationInFrames),
- ),
- )
- .join(',');
+ return volume.slice(
+ Math.max(0, Math.floor(segmentDisplayOffsetInFrames)),
+ Math.min(
+ volume.length,
+ Math.ceil(segmentDisplayOffsetInFrames + segmentDurationInFrames),
+ ),
+ );
};
return (
@@ -648,7 +641,6 @@ const TimelineVideoInfoInner: React.FC<{
tiledLoop={tiledLoop}
playbackRate={playbackRate}
volume={volume}
- doesVolumeChange={doesVolumeChange}
muted={muted}
frozenMediaFrame={frozenMediaFrame}
extendLastFrame={extendLastFrame}
@@ -670,7 +662,6 @@ const TimelineVideoInfoInner: React.FC<{
segment.displayOffsetInFrames - loopDisplayOffsetInFrames,
segment.durationInFrames,
)}
- doesVolumeChange={doesVolumeChange}
muted={muted}
frozenMediaFrame={frozenMediaFrame}
extendLastFrame={extendLastFrame}
diff --git a/packages/studio/src/components/keyboard-shortcuts.ts b/packages/studio/src/components/keyboard-shortcuts.ts
index dc078c76aa..1cff0b1b16 100644
--- a/packages/studio/src/components/keyboard-shortcuts.ts
+++ b/packages/studio/src/components/keyboard-shortcuts.ts
@@ -73,6 +73,7 @@ export const defaultKeyboardShortcuts: Record<
selectOpacityProp: [{key: 't'}],
selectRotateProp: [{key: 'r', shift: false}],
selectScaleProp: [{key: 's'}],
+ selectVolumeProp: [{key: 'v'}],
duplicateSequences: [{key: 'd', commandOrControl: true, shift: false}],
splitSequences: [{key: 'd', commandOrControl: true, shift: true}],
copyEffectsAndValues: [{key: 'c', commandOrControl: true}],
@@ -195,6 +196,7 @@ export const keyboardShortcutGroups: readonly KeyboardShortcutGroup[] = [
shortcut('Select opacity prop', 'selectOpacityProp'),
shortcut('Select rotate prop', 'selectRotateProp'),
shortcut('Select scale prop', 'selectScaleProp'),
+ shortcut('Select volume prop', 'selectVolumeProp'),
shortcut('Duplicate sequences', 'duplicateSequences'),
shortcut('Split sequences at playhead', 'splitSequences'),
shortcut('Copy effects / values', 'copyEffectsAndValues'),
diff --git a/packages/studio/src/test/keyboard-shortcuts.test.ts b/packages/studio/src/test/keyboard-shortcuts.test.ts
index 4acaf5cd3f..a695afb2ad 100644
--- a/packages/studio/src/test/keyboard-shortcuts.test.ts
+++ b/packages/studio/src/test/keyboard-shortcuts.test.ts
@@ -35,6 +35,7 @@ test('includes main-row and numeric-keypad zoom-in shortcuts', () => {
{key: '+', shift: true},
{key: '+'},
]);
+ expect(defaultKeyboardShortcuts.selectVolumeProp).toEqual([{key: 'v'}]);
});
test('matches shortcut modifiers', () => {