Skip to content

🎥 Make videos programmatically with React

`@remotion/media`: Address effect output size review

Alec Wattsfc8bb8960eff
diff --git a/packages/example/src/EffectsTestbed/VideoEffectsOutputSize.tsx b/packages/example/src/EffectsTestbed/VideoEffectsOutputSize.tsx
index dea324bdc9..18d85a7b82 100644
--- a/packages/example/src/EffectsTestbed/VideoEffectsOutputSize.tsx
+++ b/packages/example/src/EffectsTestbed/VideoEffectsOutputSize.tsx
@@ -22,7 +22,7 @@ const labelStyle: React.CSSProperties = {
};
export const VideoEffectsOutputSize: React.FC<{
- readonly effectsOutputSize?: {width: number; height: number};
+ readonly effectsOutputSize: {width: number; height: number} | null;
}> = ({effectsOutputSize}) => {
const videos = [
{label: '512 x 512 source', src: staticFile('blush-0.5x.webm')},
@@ -42,7 +42,7 @@ export const VideoEffectsOutputSize: React.FC<{
Same video, same display size, pixelate({`{blockSize: 128}`})
</div>
<div style={{color: '#a1a1aa', fontSize: 26, marginTop: 12}}>
- {effectsOutputSize
+ {effectsOutputSize !== null
? 'effectsOutputSize: 1024 x 1024'
: 'Default: effect size follows the encoded source'}
</div>
@@ -52,7 +52,7 @@ export const VideoEffectsOutputSize: React.FC<{
<div style={labelStyle}>{video.label}</div>
<Video
effects={[pixelate({blockSize: 128})]}
- effectsOutputSize={effectsOutputSize}
+ effectsOutputSize={effectsOutputSize ?? undefined}
muted
src={video.src}
style={{height: 650, width: '100%'}}
diff --git a/packages/example/src/Root.tsx b/packages/example/src/Root.tsx
index 1d13912185..fb56db483a 100644
--- a/packages/example/src/Root.tsx
+++ b/packages/example/src/Root.tsx
@@ -2164,6 +2164,7 @@ export const Index: React.FC = () => {
height={1080}
fps={30}
durationInFrames={150}
+ defaultProps={{effectsOutputSize: null}}
/>
<Composition
id="gif-fill-modes"
diff --git a/packages/media/src/audio/audio-for-preview.tsx b/packages/media/src/audio/audio-for-preview.tsx
index 35dd62bb27..3511bfff59 100644
--- a/packages/media/src/audio/audio-for-preview.tsx
+++ b/packages/media/src/audio/audio-for-preview.tsx
@@ -217,6 +217,7 @@ const AudioForPreviewAssertedShowing: React.FC<NewAudioForPreviewProps> = ({
tagType: 'audio',
getEffects: () => [],
getEffectChainState: () => null,
+ getEffectsOutputSize: () => null,
});
mediaPlayerRef.current = player;
diff --git a/packages/media/src/media-player.ts b/packages/media/src/media-player.ts
index b17ff6a5a7..670d3dab52 100644
--- a/packages/media/src/media-player.ts
+++ b/packages/media/src/media-player.ts
@@ -85,7 +85,7 @@ export class MediaPlayer {
height: number,
) => EffectChainState | null;
- private getEffectsOutputSize: () => EffectsOutputSize | undefined;
+ private getEffectsOutputSize: () => EffectsOutputSize | null;
private initializationPromise: Promise<MediaPlayerInitResult> | null = null;
@@ -118,7 +118,7 @@ export class MediaPlayer {
tagType,
getEffects,
getEffectChainState,
- getEffectsOutputSize = () => undefined,
+ getEffectsOutputSize,
}: {
canvas: HTMLCanvasElement | OffscreenCanvas | null;
src: string;
@@ -148,7 +148,7 @@ export class MediaPlayer {
width: number,
height: number,
) => EffectChainState | null;
- getEffectsOutputSize?: () => EffectsOutputSize | undefined;
+ getEffectsOutputSize: () => EffectsOutputSize | null;
}) {
this.canvas = canvas ?? null;
this.src = src;
diff --git a/packages/media/src/test/media-player.test.ts b/packages/media/src/test/media-player.test.ts
index ff494bf1c8..400ad80135 100644
--- a/packages/media/src/test/media-player.test.ts
+++ b/packages/media/src/test/media-player.test.ts
@@ -62,6 +62,7 @@ const makeAudioPlayer = (
tagType: 'audio',
getEffects: () => [],
getEffectChainState: () => null,
+ getEffectsOutputSize: () => null,
});
};
@@ -165,6 +166,7 @@ test('dispose should immediately unblock playback delays', async () => {
tagType: 'video',
getEffects: () => [],
getEffectChainState: () => null,
+ getEffectsOutputSize: () => null,
});
await player.initialize(0, false, 1);
diff --git a/packages/media/src/test/resolve-effects-output-size.test.ts b/packages/media/src/test/resolve-effects-output-size.test.ts
index 461a03948f..d7aa94cc54 100644
--- a/packages/media/src/test/resolve-effects-output-size.test.ts
+++ b/packages/media/src/test/resolve-effects-output-size.test.ts
@@ -6,7 +6,7 @@ test('uses source dimensions by default', () => {
resolveEffectsOutputSize({
sourceWidth: 1920,
sourceHeight: 1080,
- effectsOutputSize: undefined,
+ effectsOutputSize: null,
}),
).toEqual({width: 1920, height: 1080});
});
diff --git a/packages/media/src/test/trim-change-seek.test.ts b/packages/media/src/test/trim-change-seek.test.ts
index 011848ecda..daaa60ca16 100644
--- a/packages/media/src/test/trim-change-seek.test.ts
+++ b/packages/media/src/test/trim-change-seek.test.ts
@@ -28,6 +28,7 @@ test('setTrimBefore and setTrimAfter should update frame when paused', async ()
tagType: 'video',
getEffects: () => [],
getEffectChainState: () => null,
+ getEffectsOutputSize: () => null,
});
await player.initialize(0, false, 1);
diff --git a/packages/media/src/test/video-iterator-manager.test.ts b/packages/media/src/test/video-iterator-manager.test.ts
index b1ba294da6..b7817bea1e 100644
--- a/packages/media/src/test/video-iterator-manager.test.ts
+++ b/packages/media/src/test/video-iterator-manager.test.ts
@@ -98,6 +98,7 @@ const makeManager = (
getIsLooping: () => false,
getEffects: () => [],
getEffectChainState: () => null,
+ getEffectsOutputSize: () => null,
});
test('plays at a high playback rate without restarting the iterator', async () => {
@@ -194,6 +195,7 @@ test('seek should not cause overlapping block/unblock cycles', async () => {
getIsLooping: () => false,
getEffects: () => [],
getEffectChainState: () => null,
+ getEffectsOutputSize: () => null,
});
const nonceManager = makeNonceManager();
@@ -265,6 +267,7 @@ test('rapid sequential seeks should not cause overlapping blocks', async () => {
getIsLooping: () => false,
getEffects: () => [],
getEffectChainState: () => null,
+ getEffectsOutputSize: () => null,
});
const nonceManager = makeNonceManager();
@@ -313,6 +316,7 @@ test('redrawCurrentFrame should not create a new video iterator', async () => {
getIsLooping: () => false,
getEffects: () => [],
getEffectChainState: () => null,
+ getEffectsOutputSize: () => null,
});
const nonceManager = makeNonceManager();
diff --git a/packages/media/src/test/video-with-no-frames-in-beginning.test.ts b/packages/media/src/test/video-with-no-frames-in-beginning.test.ts
index 9c9aa03219..674a3acd86 100644
--- a/packages/media/src/test/video-with-no-frames-in-beginning.test.ts
+++ b/packages/media/src/test/video-with-no-frames-in-beginning.test.ts
@@ -46,6 +46,7 @@ test('in preview, should properly buffer and draw frames', async (t) => {
getOnVideoFrameCallback: () => null,
getEffects: () => [],
getEffectChainState: () => null,
+ getEffectsOutputSize: () => null,
});
const nonceManager = makeNonceManager();
diff --git a/packages/media/src/video-iterator-manager.ts b/packages/media/src/video-iterator-manager.ts
index fd175b1634..0f3dfe5646 100644
--- a/packages/media/src/video-iterator-manager.ts
+++ b/packages/media/src/video-iterator-manager.ts
@@ -56,7 +56,7 @@ export const videoIteratorManager = async ({
getIsLooping,
getEffects,
getEffectChainState,
- getEffectsOutputSize = () => undefined,
+ getEffectsOutputSize,
}: {
videoTrack: InputVideoTrack;
delayPlaybackHandleIfNotPremounting: () => DelayPlaybackIfNotPremounting;
@@ -73,7 +73,7 @@ export const videoIteratorManager = async ({
width: number,
height: number,
) => EffectChainState | null;
- getEffectsOutputSize?: () => EffectsOutputSize | undefined;
+ getEffectsOutputSize: () => EffectsOutputSize | null;
}) => {
let videoIteratorsCreated = 0;
let videoFrameIterator: VideoIterator | null = null;
diff --git a/packages/media/src/video/resolve-effects-output-size.ts b/packages/media/src/video/resolve-effects-output-size.ts
index a650552df0..3b63b843dd 100644
--- a/packages/media/src/video/resolve-effects-output-size.ts
+++ b/packages/media/src/video/resolve-effects-output-size.ts
@@ -7,9 +7,9 @@ export const resolveEffectsOutputSize = ({
}: {
readonly sourceWidth: number;
readonly sourceHeight: number;
- readonly effectsOutputSize: EffectsOutputSize | undefined;
+ readonly effectsOutputSize: EffectsOutputSize | null;
}): EffectsOutputSize => {
- if (effectsOutputSize === undefined) {
+ if (effectsOutputSize === null) {
return {width: sourceWidth, height: sourceHeight};
}
diff --git a/packages/media/src/video/video-for-preview.tsx b/packages/media/src/video/video-for-preview.tsx
index a5f75ad8b9..2f649bad0d 100644
--- a/packages/media/src/video/video-for-preview.tsx
+++ b/packages/media/src/video/video-for-preview.tsx
@@ -303,7 +303,7 @@ const VideoForPreviewAssertedShowing: React.FC<
getEffects: () => effectsRef.current,
getEffectChainState: (width, height) =>
effectChainStateRef.current?.get(width, height)!,
- getEffectsOutputSize: () => effectsOutputSizeRef.current,
+ getEffectsOutputSize: () => effectsOutputSizeRef.current ?? null,
});
mediaPlayerRef.current = player;
@@ -520,7 +520,13 @@ const VideoForPreviewAssertedShowing: React.FC<
mediaPlayer.redrawVideoEffects().catch(() => {
// Player may have been disposed between layout and the async redraw.
});
- }, [effects, effectsOutputSize, mediaPlayerReady, mediaPlayerRef]);
+ }, [
+ effects,
+ effectsOutputSize?.height,
+ effectsOutputSize?.width,
+ mediaPlayerReady,
+ mediaPlayerRef,
+ ]);
const actualStyle: React.CSSProperties = useMemo(() => {
return {
diff --git a/packages/media/src/video/video-for-rendering.tsx b/packages/media/src/video/video-for-rendering.tsx
index 55a480acc1..94589a212d 100644
--- a/packages/media/src/video/video-for-rendering.tsx
+++ b/packages/media/src/video/video-for-rendering.tsx
@@ -330,7 +330,7 @@ export const VideoForRendering: React.FC<InnerVideoProps> = ({
? resolveEffectsOutputSize({
sourceWidth: imageBitmap.width,
sourceHeight: imageBitmap.height,
- effectsOutputSize,
+ effectsOutputSize: effectsOutputSize ?? null,
})
: {width: imageBitmap.width, height: imageBitmap.height};
@@ -468,7 +468,8 @@ export const VideoForRendering: React.FC<InnerVideoProps> = ({
credentials,
effectChainState,
effects,
- effectsOutputSize,
+ effectsOutputSize?.height,
+ effectsOutputSize?.width,
initialRequestInit,
mediaCache,
]);