Skip to content

πŸŽ₯ Make videos programmatically with React

Add pitch-preserving speed changes to media Audio and Video

Alec Wattscaaf7ff4cf7f
diff --git a/packages/docs/docs/media/audio.mdx b/packages/docs/docs/media/audio.mdx
index f85a752929..3bb6fef6f6 100644
--- a/packages/docs/docs/media/audio.mdx
+++ b/packages/docs/docs/media/audio.mdx
@@ -202,7 +202,7 @@ export const MyComposition = () => {
:::note
Playing audio in reverse is not supported.
-Changing `playbackRate` also changes the audio pitch. Pitch-preserving speed changes are not supported by the Mediabunny and WebCodecs path. If the audio [falls back to `<Html5Audio>`](/docs/media/fallback) during preview or server-side rendering, audio pitch is preserved by default.
+Audio pitch is preserved by default when changing `playbackRate`. Pass `preservePitch={false}` to let the pitch change with the speed.
:::
### `loop?`<AvailableFrom v="3.2.29" />
@@ -226,6 +226,23 @@ When [`loop`](#loop) is enabled, `"repeat"` (default) resets the callback frame
It has no effect on numeric `volume` values, including `volume={interpolate(frame, ...)}`.
+### `preservePitch?`<AvailableFrom v="4.0.537" />
+
+Controls whether the audio pitch is preserved when changing `playbackRate`. Defaults to `true`.
+Also compensates for playback speed inherited from parent sequences. Applies during preview, server-side rendering, and client-side rendering.
+
+```tsx
+<Audio src={staticFile("audio.wav")} playbackRate={1.4} preservePitch />
+```
+
+Set `preservePitch={false}` to let speed changes raise or lower the pitch.
+`toneFrequency` remains an independent pitch multiplier: for example, `toneFrequency={0.8}` lowers the pitch by 20% even when preserving pitch at a different speed.
+For native fallbacks, `preservePitch` only affects preview; server-side rendering always preserves pitch, matching the fallback component's existing behavior.
+
+The Player's own playback speed is separate and is not compensated by this prop.
+
+When falling back to a native media component, the legacy fallback `preservePitch` setting takes precedence if specified. Native fallbacks do not apply `toneFrequency` during preview.
+
### `muted?`
The `muted` prop will be respected. It will lead to no audio being played while still keeping the audio tag mounted. It's value may change over time, for example to only mute a certain section of the audio.
diff --git a/packages/docs/docs/media/video.mdx b/packages/docs/docs/media/video.mdx
index b225f756fd..f7119190a0 100644
--- a/packages/docs/docs/media/video.mdx
+++ b/packages/docs/docs/media/video.mdx
@@ -251,9 +251,26 @@ export const MyComposition = () => {
:::note
Playing a video in reverse is not supported.
-Changing `playbackRate` also changes the pitch of the video's audio. Pitch-preserving speed changes are not supported by the Mediabunny and WebCodecs path. If the video [falls back to `<OffthreadVideo>`](/docs/media/fallback) during preview or server-side rendering, audio pitch is preserved by default.
+Audio pitch is preserved by default when changing `playbackRate`. Pass `preservePitch={false}` to let the pitch change with the speed.
:::
+### `preservePitch?`<AvailableFrom v="4.0.537" />
+
+Controls whether the audio pitch is preserved when changing `playbackRate`. Defaults to `true`.
+Also compensates for playback speed inherited from parent sequences. Applies during preview, server-side rendering, and client-side rendering.
+
+```tsx
+<Video src={staticFile("clip.mp4")} playbackRate={1.4} preservePitch />
+```
+
+Set `preservePitch={false}` to let speed changes raise or lower the pitch.
+`toneFrequency` remains an independent pitch multiplier: for example, `toneFrequency={0.8}` lowers the pitch by 20% even when preserving pitch at a different speed.
+For native fallbacks, `preservePitch` only affects preview; server-side rendering always preserves pitch, matching the fallback component's existing behavior.
+
+The Player's own playback speed is separate and is not compensated by this prop.
+
+When falling back to a native media component, the legacy fallback `preservePitch` setting takes precedence if specified. Native fallbacks do not apply `toneFrequency` during preview.
+
### `muted?`
You can drop the audio of the video by adding a `muted` prop:
diff --git a/packages/docs/docs/video-tags.mdx b/packages/docs/docs/video-tags.mdx
index ce805f573e..0e17e6d1f3 100644
--- a/packages/docs/docs/video-tags.mdx
+++ b/packages/docs/docs/video-tags.mdx
@@ -29,12 +29,12 @@ The comparison below shows when a fallback or alternative may be relevant.
| **HLS Support** | [βœ… Supported](/docs/hls) | [Chrome v142+, only during preview](/docs/hls) | [Only during preview](/docs/hls) |
| **CORS required** | Yes | No | No |
| **Loopable** | βœ… | ❌ | βœ… |
-| **`playbackRate`** <br/> (Speed Change) | βœ…, but audio pitch changes with the speed | βœ…, audio pitch is preserved by default | βœ…, audio pitch is preserved by default |
+| **`playbackRate`** <br/> (Speed Change) | βœ…, audio pitch is preserved by default | βœ…, audio pitch is preserved by default | βœ…, audio pitch is preserved by default |
| **`toneFrequency`** <br/> (Pitch Change) | βœ… | Only during server-side rendering | Only during server-side rendering |
| **[Three.js texture](/docs/videos/as-threejs-texture)** | [Snippet](/docs/videos/as-threejs-texture) - works best | [`useOffthreadVideoTexture()`](/docs/use-offthread-video-texture) | [ `useVideoTexture()` ](/docs/use-video-texture) |
| **[Client-side rendering](/docs/client-side-rendering)** | βœ… | ❌ | ❌ |
-`playbackRate` changes the media speed with all three components. In the Mediabunny and WebCodecs path used by `<Video>` and `<Audio>` from `@remotion/media`, it also changes the audio pitch. Pitch-preserving speed changes are not currently supported by this path during preview, [server-side rendering](/docs/ssr), or [client-side rendering](/docs/client-side-rendering).
+`playbackRate` changes the media speed with all three components. `<Video>` and `<Audio>` from `@remotion/media` preserve pitch by default in preview and rendering. Set `preservePitch={false}` to let pitch change with the speed.
`<OffthreadVideo>`, `<Html5Video>`, and `<Html5Audio>` preserve audio pitch by default during preview and server-side rendering. If `@remotion/media` falls back to one of these components, the fallback component's behavior applies.
diff --git a/packages/media/src/audio/audio-for-preview.tsx b/packages/media/src/audio/audio-for-preview.tsx
index 5f1922b3d8..aed1c2cb20 100644
--- a/packages/media/src/audio/audio-for-preview.tsx
+++ b/packages/media/src/audio/audio-for-preview.tsx
@@ -45,6 +45,7 @@ type NewAudioForPreviewProps = {
readonly showInTimeline: boolean;
readonly _remotionInternalStack: string | null;
readonly disallowFallbackToHtml5Audio: boolean;
+ readonly preservePitch: boolean;
readonly toneFrequency: number | undefined;
readonly audioStreamIndex: number | undefined;
readonly fallbackHtml5AudioProps: FallbackHtml5AudioProps | undefined;
@@ -69,6 +70,7 @@ const AudioForPreviewAssertedShowing: React.FC<NewAudioForPreviewProps> = ({
_remotionInternalStack,
disallowFallbackToHtml5Audio,
toneFrequency,
+ preservePitch,
audioStreamIndex,
fallbackHtml5AudioProps,
onError,
@@ -82,7 +84,6 @@ const AudioForPreviewAssertedShowing: React.FC<NewAudioForPreviewProps> = ({
const mediaPlayerRef = useRef<MediaPlayer | null>(null);
const initialTrimBeforeRef = useRef(trimBefore);
const initialTrimAfterRef = useRef(trimAfter);
- const initialToneFrequencyRef = useRef(toneFrequency ?? 1);
const [initialRequestInit] = useState(requestInit);
const [mediaPlayerReady, setMediaPlayerReady] = useState(false);
@@ -135,6 +136,9 @@ const AudioForPreviewAssertedShowing: React.FC<NewAudioForPreviewProps> = ({
const parentSequence = useContext(SequenceContext);
const sequencePlaybackRate = parentSequence?.playbackRate ?? 1;
const effectivePlaybackRate = playbackRate * sequencePlaybackRate;
+ const effectiveToneFrequency =
+ (toneFrequency ?? 1) / (preservePitch ? effectivePlaybackRate : 1);
+ const initialToneFrequencyRef = useRef(effectiveToneFrequency);
const sequenceDurationInFrames =
videoConfig.durationInFrames / sequencePlaybackRate;
const currentTime = frame / sequencePlaybackRate / videoConfig.fps;
@@ -185,7 +189,7 @@ const AudioForPreviewAssertedShowing: React.FC<NewAudioForPreviewProps> = ({
effectiveMuted: mediaPlayerMuted,
userPreferredVolume,
playbackRate: effectivePlaybackRate,
- toneFrequency: toneFrequency ?? 1,
+ toneFrequency: effectiveToneFrequency,
globalPlaybackRate,
fps: videoConfig.fps,
sequenceOffset,
@@ -426,6 +430,7 @@ const AudioForPreviewAssertedShowing: React.FC<NewAudioForPreviewProps> = ({
style={style ?? undefined}
_remotionInternalStack={_remotionInternalStack ?? undefined}
toneFrequency={toneFrequency}
+ preservePitch={fallbackHtml5AudioProps?.preservePitch ?? preservePitch}
audioStreamIndex={audioStreamIndex}
pauseWhenBuffering={fallbackHtml5AudioProps?.pauseWhenBuffering}
crossOrigin={fallbackHtml5AudioProps?.crossOrigin}
@@ -459,6 +464,7 @@ type InnerAudioProps = {
readonly trimBefore?: number | undefined;
readonly _remotionInternalStack: string | null;
readonly disallowFallbackToHtml5Audio?: boolean;
+ readonly preservePitch?: boolean;
readonly toneFrequency?: number;
readonly audioStreamIndex?: number;
readonly fallbackHtml5AudioProps?: FallbackHtml5AudioProps;
@@ -483,6 +489,7 @@ export const AudioForPreview: React.FC<InnerAudioProps> = ({
_remotionInternalStack,
disallowFallbackToHtml5Audio,
toneFrequency,
+ preservePitch = true,
audioStreamIndex,
fallbackHtml5AudioProps,
onError,
@@ -547,6 +554,7 @@ export const AudioForPreview: React.FC<InnerAudioProps> = ({
_remotionInternalStack={_remotionInternalStack}
disallowFallbackToHtml5Audio={disallowFallbackToHtml5Audio ?? false}
toneFrequency={toneFrequency}
+ preservePitch={preservePitch}
onError={onError}
credentials={credentials}
requestInit={requestInit}
diff --git a/packages/media/src/audio/audio-for-rendering.tsx b/packages/media/src/audio/audio-for-rendering.tsx
index b6b23b2839..1861e5bb67 100644
--- a/packages/media/src/audio/audio-for-rendering.tsx
+++ b/packages/media/src/audio/audio-for-rendering.tsx
@@ -33,6 +33,7 @@ export const AudioForRendering: React.FC<AudioProps> = ({
name,
disallowFallbackToHtml5Audio,
toneFrequency,
+ preservePitch = true,
trimAfter,
trimBefore,
onError,
@@ -257,7 +258,9 @@ export const AudioForRendering: React.FC<AudioProps> = ({
startInVideo,
timestamp: audio.timestamp,
duration: audio.durationInMicroSeconds,
- toneFrequency: toneFrequency ?? 1,
+ toneFrequency:
+ (toneFrequency ?? 1) /
+ (preservePitch ? (playbackRate ?? 1) * sequencePlaybackRate : 1),
});
}
@@ -302,6 +305,7 @@ export const AudioForRendering: React.FC<AudioProps> = ({
volumeProp,
audioStreamIndex,
toneFrequency,
+ preservePitch,
trimAfter,
trimBefore,
replaceWithHtml5Audio,
@@ -331,7 +335,7 @@ export const AudioForRendering: React.FC<AudioProps> = ({
acceptableTimeShiftInSeconds={
fallbackHtml5AudioProps?.acceptableTimeShiftInSeconds
}
- preservePitch={fallbackHtml5AudioProps?.preservePitch ?? true}
+ preservePitch={fallbackHtml5AudioProps?.preservePitch ?? preservePitch}
name={name}
showInTimeline={showInTimeline}
/>
diff --git a/packages/media/src/audio/audio.tsx b/packages/media/src/audio/audio.tsx
index 527a2b5e38..d38d9562d1 100644
--- a/packages/media/src/audio/audio.tsx
+++ b/packages/media/src/audio/audio.tsx
@@ -50,6 +50,12 @@ export const audioSchema: InteractivitySchema = {
hiddenFromList: false,
keyframable: false,
},
+ preservePitch: {
+ type: 'boolean',
+ default: true,
+ description: 'Preserve pitch',
+ keyframable: false,
+ },
toneFrequency: {
type: 'number',
min: 0.01,
diff --git a/packages/media/src/audio/props.ts b/packages/media/src/audio/props.ts
index a25424aa84..831aa56839 100644
--- a/packages/media/src/audio/props.ts
+++ b/packages/media/src/audio/props.ts
@@ -27,6 +27,8 @@ export type AudioProps = {
volume?: VolumeProp;
loopVolumeCurveBehavior?: LoopVolumeCurveBehavior;
playbackRate?: number;
+ /** Keep the original pitch when changing playback speed. Default: true. */
+ preservePitch?: boolean;
muted?: boolean;
style?: React.CSSProperties;
logLevel?: LogLevel;
diff --git a/packages/media/src/test/pitch-shift-preview.test.tsx b/packages/media/src/test/pitch-shift-preview.test.tsx
index 89fc579702..4ab1f16a5d 100644
--- a/packages/media/src/test/pitch-shift-preview.test.tsx
+++ b/packages/media/src/test/pitch-shift-preview.test.tsx
@@ -2,12 +2,15 @@ import {Player} from '@remotion/player';
import React from 'react';
import {flushSync} from 'react-dom';
import {createRoot} from 'react-dom/client';
+import {Sequence} from 'remotion';
import {expect, test, vi} from 'vitest';
import {Audio} from '../audio/audio';
import {Video} from '../video/video';
type ToneFrequencyProps = {
readonly toneFrequency: number;
+ readonly playbackRate: number;
+ readonly preservePitch: boolean | undefined;
};
const makeSineWaveUrl = ({
@@ -84,7 +87,8 @@ const estimateFrequency = ({
return positiveCrossings / (audio.length / sampleRate);
};
-test('Audio and Video update toneFrequency during preview', async () => {
+// KINO-7177: clip speed and inherited speed must not raise a speaker's pitch.
+test('Audio and Video update pitch while preserving authored speed changes', async () => {
const src = makeSineWaveUrl({
frequency: 440,
sampleRate: 48_000,
@@ -103,6 +107,15 @@ test('Audio and Video update toneFrequency during preview', async () => {
const verify = async (
component: React.ComponentType<ToneFrequencyProps>,
sampleRate: number,
+ {
+ playbackRate,
+ parentRate,
+ preservePitch,
+ }: {
+ playbackRate: number;
+ parentRate: number;
+ preservePitch: boolean | undefined;
+ },
) => {
createdNodes.length = 0;
const container = document.createElement('div');
@@ -113,7 +126,15 @@ test('Audio and Video update toneFrequency during preview', async () => {
const StatefulComposition: React.FC = () => {
const [toneFrequency, setCurrentToneFrequency] = React.useState(1);
setToneFrequency = setCurrentToneFrequency;
- return React.createElement(component, {toneFrequency});
+ return (
+ <Sequence playbackRate={parentRate}>
+ {React.createElement(component, {
+ toneFrequency,
+ playbackRate,
+ preservePitch,
+ })}
+ </Sequence>
+ );
};
root.render(
@@ -131,7 +152,7 @@ test('Audio and Video update toneFrequency during preview', async () => {
try {
await waitFor(
- () => createdNodes.filter((node) => node.buffer !== null).length >= 20,
+ () => createdNodes.filter((node) => node.buffer !== null).length >= 8,
);
const getScheduledFrequency = () => {
for (const node of createdNodes) {
@@ -156,7 +177,10 @@ test('Audio and Video update toneFrequency during preview', async () => {
});
};
- expect(getScheduledFrequency()).toBeCloseTo(440, -1);
+ expect(getScheduledFrequency() * playbackRate * parentRate).toBeCloseTo(
+ 440 * (preservePitch === false ? playbackRate * parentRate : 1),
+ -1,
+ );
createdNodes.length = 0;
if (!setToneFrequency) {
throw new Error('Composition did not mount.');
@@ -164,37 +188,60 @@ test('Audio and Video update toneFrequency during preview', async () => {
flushSync(() => setToneFrequency?.(1.5));
await waitFor(
- () => createdNodes.filter((node) => node.buffer !== null).length >= 20,
+ () => createdNodes.filter((node) => node.buffer !== null).length >= 8,
+ );
+ expect(getScheduledFrequency() * playbackRate * parentRate).toBeCloseTo(
+ 660 * (preservePitch === false ? playbackRate * parentRate : 1),
+ -1,
);
- expect(getScheduledFrequency()).toBeCloseTo(660, -1);
} finally {
root.unmount();
container.remove();
}
};
- const AudioComposition: React.FC<ToneFrequencyProps> = ({toneFrequency}) => (
+ const AudioComposition: React.FC<ToneFrequencyProps> = ({
+ toneFrequency,
+ playbackRate,
+ preservePitch,
+ }) => (
<Audio
disallowFallbackToHtml5Audio
logLevel="error"
src={src}
toneFrequency={toneFrequency}
+ playbackRate={playbackRate}
+ preservePitch={preservePitch}
/>
);
- const VideoComposition: React.FC<ToneFrequencyProps> = ({toneFrequency}) => (
+ const VideoComposition: React.FC<ToneFrequencyProps> = ({
+ toneFrequency,
+ playbackRate,
+ preservePitch,
+ }) => (
<Video
disallowFallbackToOffthreadVideo
headless
logLevel="error"
src={src}
toneFrequency={toneFrequency}
+ playbackRate={playbackRate}
+ preservePitch={preservePitch}
/>
);
try {
for (const sampleRate of [48000, 44100]) {
- await verify(AudioComposition, sampleRate);
- await verify(VideoComposition, sampleRate);
+ for (const options of [
+ {playbackRate: 1, parentRate: 1, preservePitch: undefined},
+ {playbackRate: 1.4, parentRate: 1, preservePitch: undefined},
+ {playbackRate: 1.4, parentRate: 1, preservePitch: false},
+ {playbackRate: 0.5, parentRate: 1, preservePitch: true},
+ {playbackRate: 1.4, parentRate: 1.5, preservePitch: true},
+ ]) {
+ await verify(AudioComposition, sampleRate, options);
+ await verify(VideoComposition, sampleRate, options);
+ }
}
} finally {
createBufferSourceSpy.mockRestore();
diff --git a/packages/media/src/video/props.ts b/packages/media/src/video/props.ts
index c77084e2cd..fab741123e 100644
--- a/packages/media/src/video/props.ts
+++ b/packages/media/src/video/props.ts
@@ -59,6 +59,8 @@ type OptionalVideoProps = {
loopVolumeCurveBehavior: LoopVolumeCurveBehavior;
onVideoFrame: OnVideoFrame | undefined;
playbackRate: number;
+ /** Keep the original pitch when changing playback speed. Default: true. */
+ preservePitch: boolean;
muted: boolean;
delayRenderRetries: number | null;
delayRenderTimeoutInMilliseconds: number | null;
diff --git a/packages/media/src/video/video-for-preview.tsx b/packages/media/src/video/video-for-preview.tsx
index 6d202a3495..68903e9c79 100644
--- a/packages/media/src/video/video-for-preview.tsx
+++ b/packages/media/src/video/video-for-preview.tsx
@@ -57,6 +57,7 @@ type VideoForPreviewProps = NativeVideoProps & {
readonly src: string;
readonly style: React.CSSProperties | undefined;
readonly playbackRate: number;
+ readonly preservePitch: boolean;
readonly toneFrequency: number;
readonly logLevel: LogLevel;
readonly className: string | undefined;
@@ -94,6 +95,7 @@ const VideoForPreviewAssertedShowing: React.FC<
style,
playbackRate,
toneFrequency,
+ preservePitch,
logLevel,
className,
muted,
@@ -198,6 +200,8 @@ const VideoForPreviewAssertedShowing: React.FC<
const sequencePlaybackRate = parentSequence?.playbackRate ?? 1;
const effectivePlaybackRate = playbackRate * sequencePlaybackRate;
+ const effectiveToneFrequency =
+ (toneFrequency ?? 1) / (preservePitch ? effectivePlaybackRate : 1);
const sequenceDurationInFrames =
videoConfig.durationInFrames / sequencePlaybackRate;
const currentTime = frame / sequencePlaybackRate / videoConfig.fps;
@@ -223,7 +227,7 @@ const VideoForPreviewAssertedShowing: React.FC<
const initialIsPostmounting = useRef(isPostmounting);
const initialGlobalPlaybackRate = useRef(globalPlaybackRate);
const initialPlaybackRate = useRef(effectivePlaybackRate);
- const initialToneFrequency = useRef(toneFrequency);
+ const initialToneFrequency = useRef(effectiveToneFrequency);
const initialMuted = useRef(mediaPlayerMuted);
const initialVolume = useRef(userPreferredVolume);
const initialSequenceDuration = useRef(sequenceDurationInFrames);
@@ -508,7 +512,7 @@ const VideoForPreviewAssertedShowing: React.FC<
effectiveMuted: mediaPlayerMuted,
userPreferredVolume,
playbackRate: effectivePlaybackRate,
- toneFrequency,
+ toneFrequency: effectiveToneFrequency,
globalPlaybackRate,
fps: videoConfig.fps,
sequenceOffset,
@@ -588,6 +592,7 @@ const VideoForPreviewAssertedShowing: React.FC<
loop={loop}
showInTimeline={showInTimeline}
_remotionInternalStack={_remotionInternalStack ?? undefined}
+ preservePitch={preservePitch}
{...fallbackOffthreadVideoProps}
/>
);
diff --git a/packages/media/src/video/video-for-rendering.tsx b/packages/media/src/video/video-for-rendering.tsx
index 6815664fd0..5ca1af82a6 100644
--- a/packages/media/src/video/video-for-rendering.tsx
+++ b/packages/media/src/video/video-for-rendering.tsx
@@ -54,6 +54,7 @@ type InnerVideoProps = NativeVideoProps & {
readonly disallowFallbackToOffthreadVideo: boolean;
readonly _remotionInternalStack: string | undefined;
readonly toneFrequency: number;
+ readonly preservePitch: boolean;
readonly trimBeforeValue: number | undefined;
readonly trimAfterValue: number | undefined;
readonly headless: boolean;
@@ -87,6 +88,7 @@ export const VideoForRendering: React.FC<InnerVideoProps> = ({
disallowFallbackToOffthreadVideo,
_remotionInternalStack,
toneFrequency,
+ preservePitch,
trimAfterValue,
trimBeforeValue,
headless,
@@ -416,7 +418,9 @@ export const VideoForRendering: React.FC<InnerVideoProps> = ({
startInVideo,
timestamp: audio.timestamp,
duration: audio.durationInMicroSeconds,
- toneFrequency,
+ toneFrequency:
+ toneFrequency /
+ (preservePitch ? playbackRate * sequencePlaybackRate : 1),
});
}
@@ -463,6 +467,7 @@ export const VideoForRendering: React.FC<InnerVideoProps> = ({
audioStreamIndex,
disallowFallbackToOffthreadVideo,
toneFrequency,
+ preservePitch,
trimAfterValue,
trimBeforeValue,
videoEnabled,
@@ -530,7 +535,9 @@ export const VideoForRendering: React.FC<InnerVideoProps> = ({
durationInFrames={undefined}
trimBefore={trimBeforeValue}
useWebAudioApi={fallbackOffthreadVideoProps?.useWebAudioApi ?? false}
- preservePitch={fallbackOffthreadVideoProps?.preservePitch ?? true}
+ preservePitch={
+ fallbackOffthreadVideoProps?.preservePitch ?? preservePitch
+ }
startFrom={undefined}
endAt={undefined}
_remotionInternalStack={_remotionInternalStack}
diff --git a/packages/media/src/video/video.tsx b/packages/media/src/video/video.tsx
index 52582df109..bea78d3cde 100644
--- a/packages/media/src/video/video.tsx
+++ b/packages/media/src/video/video.tsx
@@ -56,6 +56,12 @@ export const videoSchema: InteractivitySchema = {
hiddenFromList: false,
keyframable: false,
},
+ preservePitch: {
+ type: 'boolean',
+ default: true,
+ description: 'Preserve pitch',
+ keyframable: false,
+ },
toneFrequency: {
type: 'number',
min: 0.01,
@@ -100,6 +106,7 @@ const InnerVideo: React.FC<
volume,
_remotionInternalStack,
toneFrequency,
+ preservePitch,
showInTimeline,
debugOverlay,
headless,
@@ -167,6 +174,7 @@ const InnerVideo: React.FC<
style={style}
volume={volume}
toneFrequency={toneFrequency}
+ preservePitch={preservePitch}
trimAfterValue={trimAfterValue}
trimBeforeValue={trimBeforeValue}
headless={headless}
@@ -209,6 +217,7 @@ const InnerVideo: React.FC<
onVideoFrame={onVideoFrame}
playbackRate={playbackRate}
toneFrequency={toneFrequency ?? 1}
+ preservePitch={preservePitch ?? true}
src={src}
style={style}
volume={volume}
@@ -260,6 +269,7 @@ const VideoInner: React.FC<
trimBefore,
volume,
toneFrequency,
+ preservePitch,
debugOverlay,
headless,
onError,
@@ -443,6 +453,7 @@ const VideoInner: React.FC<
trimBefore={trimBefore}
volume={volume ?? 1}
toneFrequency={toneFrequency ?? 1}
+ preservePitch={preservePitch ?? true}
_remotionInternalStack={sourceStack}
debugOverlay={debugOverlay ?? false}
headless={headless ?? false}
diff --git a/packages/web-renderer/src/test/pitch-shift-audio.test.tsx b/packages/web-renderer/src/test/pitch-shift-audio.test.tsx
index 4062b59e67..471cbeb29e 100644
--- a/packages/web-renderer/src/test/pitch-shift-audio.test.tsx
+++ b/packages/web-renderer/src/test/pitch-shift-audio.test.tsx
@@ -3,7 +3,7 @@ import {Player} from '@remotion/player';
import {ALL_FORMATS, AudioBufferSink, BlobSource, Input} from 'mediabunny';
import {flushSync} from 'react-dom';
import {createRoot} from 'react-dom/client';
-import {useCurrentFrame} from 'remotion';
+import {Sequence, useCurrentFrame} from 'remotion';
import {expect, test} from 'vitest';
import {renderMediaOnWeb} from '../render-media-on-web';
import {makeToneWav, pitchShiftAudio} from './fixtures/pitch-shift-audio';
@@ -98,8 +98,8 @@ test.each([48000, 44100])(
for (let channel = 0; channel < 2; channel++) {
const sourceFrequency = channel === 0 ? 440 : 660;
const lower = sourceFrequency * 0.75;
- // The rendering playbackRate resampler also scales pitch.
- const higher = sourceFrequency * 1.5 * 1.25;
+ // Authored speed is compensated before the deliberate pitch multiplier.
+ const higher = sourceFrequency * 1.5;
const audio = channels[channel];
expect(amplitudeAt(audio, sampleRate, [0.2, 0.4], lower)).toBeGreaterThan(
0.2,
@@ -215,7 +215,7 @@ test('renders a partial frame range with video and pitch shifts Video audio', as
amplitudeAt(audio, 48000, [0.2, 0.4], 440 * 0.75 * 0.8),
).toBeGreaterThan(0.1);
expect(
- amplitudeAt(audio, 48000, [0.65, 0.85], 440 * 1.25 * 1.5 * 0.8),
+ amplitudeAt(audio, 48000, [0.65, 0.85], 440 * 1.5 * 0.8),
).toBeGreaterThan(0.1);
} finally {
URL.revokeObjectURL(src);
@@ -278,3 +278,59 @@ test.each([0.01, 2])(
).toBe(true);
},
);
+
+// KINO-7177: measure the encoded result, including inherited speed and opt-out.
+test.each([true, false])(
+ 'exports clip speed with preservePitch=%s',
+ async (preservePitch) => {
+ const src = makeToneWav();
+ for (const Tag of [Audio, Video]) {
+ const Component: React.FC = () => (
+ <Sequence playbackRate={1.5}>
+ <Tag
+ src={src}
+ playbackRate={1.4}
+ preservePitch={preservePitch}
+ toneFrequency={0.8}
+ />
+ </Sequence>
+ );
+ const result = await renderMediaOnWeb({
+ licenseKey: 'free-license',
+ composition: {
+ ...pitchShiftAudio,
+ component: Component,
+ durationInFrames: 12,
+ calculateMetadata: null,
+ },
+ container: 'wav',
+ outputTarget: 'arraybuffer',
+ });
+ using input = new Input({
+ formats: ALL_FORMATS,
+ source: new BlobSource(await result.getBlob()),
+ });
+ const track = await input.getPrimaryAudioTrack();
+ const samples = new Float32Array(19200);
+ let offset = 0;
+ for await (const {buffer} of new AudioBufferSink(track!).buffers()) {
+ samples.set(buffer.getChannelData(0), offset);
+ offset += buffer.length;
+ }
+
+ expect(offset).toBe(samples.length);
+ const expected = 440 * 0.8 * (preservePitch ? 1 : 1.4 * 1.5);
+ expect(amplitudeAt(samples, 48000, [0.1, 0.3], expected)).toBeGreaterThan(
+ 0.15,
+ );
+ expect(
+ amplitudeAt(
+ samples,
+ 48000,
+ [0.1, 0.3],
+ preservePitch ? expected * 2.1 : expected / 2.1,
+ ),
+ ).toBeLessThan(0.03);
+ }
+ },
+);