Skip to content

🎥 Make videos programmatically with React

@remotion/web-renderer: Crop uneven output dimensions

JonnyBurgerf20521d9741e
diff --git a/packages/docs/docs/web-renderer/render-media-on-web.mdx b/packages/docs/docs/web-renderer/render-media-on-web.mdx
index b884e8dff7..3f2b7eef77 100644
--- a/packages/docs/docs/web-renderer/render-media-on-web.mdx
+++ b/packages/docs/docs/web-renderer/render-media-on-web.mdx
@@ -94,7 +94,7 @@ For H.264, H.265, and AV1, the scaled output dimensions are automatically adjust
This uses the same scale-aware calculation as server-side rendering.
For example, a `1200 × 675` composition at `scale: 1` produces a `1200 × 674` video.
-The composition is rendered at the adjusted dimensions. In the example above, [`useVideoConfig()`](/docs/use-video-config) returns a height of `674`, and `onFrame` receives a `1200 × 674` frame.
+The composition dimensions and [`useVideoConfig()`](/docs/use-video-config) values remain unchanged. After `onFrame`, excess pixels on the right and bottom edges are cropped without stretching the frame.
Pass the same `scale` to [`canRenderMediaOnWeb()`](/docs/web-renderer/can-render-media-on-web) when checking support.
### `onProgress?`
diff --git a/packages/web-renderer/src/drawing/draw-background.ts b/packages/web-renderer/src/drawing/draw-background.ts
index f288f48df9..c66aef6e86 100644
--- a/packages/web-renderer/src/drawing/draw-background.ts
+++ b/packages/web-renderer/src/drawing/draw-background.ts
@@ -81,7 +81,6 @@ export const drawBackground = async ({
scale,
onlyBackgroundClipText: true,
waitForPageResponsiveness: null,
- outputSize: null,
});
onlyBackgroundClipText.setTransform(new DOMMatrix().scale(scale, scale));
element.style.backgroundClip = originalBackgroundClip;
diff --git a/packages/web-renderer/src/drawing/process-node.ts b/packages/web-renderer/src/drawing/process-node.ts
index 654da65a92..a06fc37a74 100644
--- a/packages/web-renderer/src/drawing/process-node.ts
+++ b/packages/web-renderer/src/drawing/process-node.ts
@@ -140,7 +140,6 @@ export const processNode = async ({
scale,
onlyBackgroundClipText: false,
waitForPageResponsiveness,
- outputSize: null,
});
if (waitForPageResponsiveness !== null) {
await waitForPageResponsiveness();
diff --git a/packages/web-renderer/src/render-media-on-web.tsx b/packages/web-renderer/src/render-media-on-web.tsx
index d286bf36b7..66aab56b6d 100644
--- a/packages/web-renderer/src/render-media-on-web.tsx
+++ b/packages/web-renderer/src/render-media-on-web.tsx
@@ -316,12 +316,19 @@ const internalRenderMediaOnWeb = async <
compositionWidth: composition.width ?? null,
});
- const dimensions = getEncodedDimensions({
+ const encodedDimensions = getEncodedDimensions({
width: resolved.width,
height: resolved.height,
scale,
codec: videoEnabled ? codec : null,
});
+ const sourceDimensions = {
+ width: Math.ceil(resolved.width * scale),
+ height: Math.ceil(resolved.height * scale),
+ };
+ const needsCrop =
+ encodedDimensions.width !== sourceDimensions.width ||
+ encodedDimensions.height !== sourceDimensions.height;
const realFrameRange = getRealFrameRange(
resolved.durationInFrames,
frameRange,
@@ -332,8 +339,8 @@ const internalRenderMediaOnWeb = async <
}
using scaffold = createScaffold({
- width: dimensions.compositionWidth,
- height: dimensions.compositionHeight,
+ width: resolved.width,
+ height: resolved.height,
fps: resolved.fps,
durationInFrames: resolved.durationInFrames,
Component: composition.component,
@@ -470,6 +477,17 @@ const internalRenderMediaOnWeb = async <
? videoBitrate
: getQualityForWebRendererQuality(videoBitrate),
sizeChangeBehavior: 'deny',
+ ...(needsCrop
+ ? {
+ transform: {
+ crop: {
+ left: 0,
+ top: 0,
+ ...encodedDimensions,
+ },
+ },
+ }
+ : {}),
hardwareAcceleration,
latencyMode: 'quality',
keyFrameInterval: keyframeIntervalInSeconds,
@@ -591,13 +609,7 @@ const internalRenderMediaOnWeb = async <
logLevel,
internalState,
onlyBackgroundClipText: false,
- cutout: new DOMRect(
- 0,
- 0,
- dimensions.compositionWidth,
- dimensions.compositionHeight,
- ),
- outputSize: dimensions,
+ cutout: new DOMRect(0, 0, resolved.width, resolved.height),
htmlInCanvasContext,
onHtmlInCanvasLayerOutcome: htmlInCanvasContext
? onHtmlInCanvasLayerOutcome
@@ -627,8 +639,8 @@ const internalRenderMediaOnWeb = async <
frameToEncode = validateVideoFrame({
originalFrame: videoFrame,
returnedFrame,
- expectedWidth: dimensions.width,
- expectedHeight: dimensions.height,
+ expectedWidth: sourceDimensions.width,
+ expectedHeight: sourceDimensions.height,
expectedTimestamp: timestamp,
});
await waitForPageResponsiveness();
diff --git a/packages/web-renderer/src/render-still-on-web.tsx b/packages/web-renderer/src/render-still-on-web.tsx
index 854de2058b..6e346ef3e3 100644
--- a/packages/web-renderer/src/render-still-on-web.tsx
+++ b/packages/web-renderer/src/render-still-on-web.tsx
@@ -211,7 +211,6 @@ async function internalRenderStillOnWeb<
? onHtmlInCanvasLayerOutcome
: undefined,
waitForPageResponsiveness: null,
- outputSize: null,
});
const {canvas} = capturedFrame;
diff --git a/packages/web-renderer/src/take-screenshot.ts b/packages/web-renderer/src/take-screenshot.ts
index ba5d312705..0fd9389921 100644
--- a/packages/web-renderer/src/take-screenshot.ts
+++ b/packages/web-renderer/src/take-screenshot.ts
@@ -23,7 +23,6 @@ export const createLayer = async ({
htmlInCanvasContext,
onHtmlInCanvasLayerOutcome,
waitForPageResponsiveness,
- outputSize,
}: {
element: HTMLElement | SVGElement;
scale: number;
@@ -34,10 +33,9 @@ export const createLayer = async ({
htmlInCanvasContext?: HtmlInCanvasContext | null;
onHtmlInCanvasLayerOutcome?: (outcome: HtmlInCanvasLayerOutcome) => void;
waitForPageResponsiveness: (() => Promise<void>) | null;
- outputSize: {width: number; height: number} | null;
}) => {
- const scaledWidth = outputSize?.width ?? Math.ceil(cutout.width * scale);
- const scaledHeight = outputSize?.height ?? Math.ceil(cutout.height * scale);
+ const scaledWidth = Math.ceil(cutout.width * scale);
+ const scaledHeight = Math.ceil(cutout.height * scale);
if (
!onlyBackgroundClipText &&
diff --git a/packages/web-renderer/src/test/html-in-canvas.test.tsx b/packages/web-renderer/src/test/html-in-canvas.test.tsx
index 176774e5ea..942f90e9ad 100644
--- a/packages/web-renderer/src/test/html-in-canvas.test.tsx
+++ b/packages/web-renderer/src/test/html-in-canvas.test.tsx
@@ -160,7 +160,6 @@ test('does not create a nested HTML-in-canvas capture', async () => {
onlyBackgroundClipText: false,
scale: 1,
waitForPageResponsiveness: null,
- outputSize: null,
});
expect(drawElementImage).not.toHaveBeenCalled();
diff --git a/packages/web-renderer/src/validate-dimensions.ts b/packages/web-renderer/src/validate-dimensions.ts
index c688827666..4959075afb 100644
--- a/packages/web-renderer/src/validate-dimensions.ts
+++ b/packages/web-renderer/src/validate-dimensions.ts
@@ -16,8 +16,6 @@ export const getEncodedDimensions = ({
codec === 'h264' || codec === 'h265' || codec === 'av1';
if (!shouldHaveEvenDimensions) {
return {
- compositionWidth: width,
- compositionHeight: height,
width: Math.ceil(width * scale),
height: Math.ceil(height * scale),
};
@@ -36,8 +34,6 @@ export const getEncodedDimensions = ({
}
return {
- compositionWidth: widthWithEvenDimensions,
- compositionHeight: heightWithEvenDimensions,
width: Math.round(widthWithEvenDimensions * scale),
height: Math.round(heightWithEvenDimensions * scale),
};