Skip to content

πŸŽ₯ Make videos programmatically with React

`remotion`: Disallow nested HTML-in-canvas (#10567)

Jonny Burgercdbf84eec126
diff --git a/bun.lock b/bun.lock
index 3d010b3577..48f6ecefd8 100644
--- a/bun.lock
+++ b/bun.lock
@@ -2686,7 +2686,6 @@
"react-dom": "catalog:",
"three": "catalog:",
"vitest": "catalog:",
- "vitest-browser-react": "2.0.2",
"zod": "catalog:",
},
"peerDependencies": {
diff --git a/packages/browser-studio/src/BrowserStudio.tsx b/packages/browser-studio/src/BrowserStudio.tsx
index ed4f1a5f8e..1df2a02381 100644
--- a/packages/browser-studio/src/BrowserStudio.tsx
+++ b/packages/browser-studio/src/BrowserStudio.tsx
@@ -82,6 +82,7 @@ const getBrowserRenderDefaults = (): RenderDefaults => {
const maxConcurrency = navigator.hardwareConcurrency || 1;
return {
+ allowHtmlInCanvas: false,
audioBitrate: null,
audioCodec: null,
beepOnFinish: false,
diff --git a/packages/cli/src/config/index.ts b/packages/cli/src/config/index.ts
index 03726cec6d..3b081da754 100644
--- a/packages/cli/src/config/index.ts
+++ b/packages/cli/src/config/index.ts
@@ -22,7 +22,6 @@ import type {
import type {HardwareAccelerationOption} from '@remotion/renderer/client';
import {BrowserSafeApis} from '@remotion/renderer/client';
import {StudioServerInternals} from '@remotion/studio-server';
-import {Log} from '../log';
import {getBrowser} from './browser';
import {
getBufferStateDelayInMilliseconds,
@@ -80,6 +79,7 @@ export type {
};
const {
+ allowHtmlInCanvasOption,
benchmarkConcurrenciesOption,
concurrencyOption,
offthreadVideoCacheSizeInBytesOption,
@@ -220,7 +220,8 @@ declare global {
*/
readonly setInteractivityEnabled: (enabled: boolean) => void;
/**
- * @deprecated HTML-in-canvas is now enabled by default when supported. This method is a no-op and can be removed.
+ * Allow the experimental HTML-in-canvas capture path in Studio client-side renders.
+ * @default false
*/
readonly setAllowHtmlInCanvasEnabled: (enabled: boolean) => void;
/**
@@ -718,13 +719,6 @@ type FlatConfig = RemotionConfigObject &
Output: void;
};
-const setAllowHtmlInCanvasEnabled = (_enabled: boolean) => {
- Log.warn(
- {indent: false, logLevel: 'info'},
- 'Config.setAllowHtmlInCanvasEnabled() is now a no-op because HTML-in-canvas is enabled by default when supported. You can remove this option from your config file.',
- );
-};
-
export const Config: FlatConfig = {
get Bundling() {
throw new Error(
@@ -759,7 +753,7 @@ export const Config: FlatConfig = {
setMaxTimelineTracks: StudioServerInternals.setMaxTimelineTracks,
setKeyboardShortcutsEnabled: keyboardShortcutsOption.setConfig,
setInteractivityEnabled: interactivityOption.setConfig,
- setAllowHtmlInCanvasEnabled,
+ setAllowHtmlInCanvasEnabled: allowHtmlInCanvasOption.setConfig,
setRspack: rspackOption.setConfig,
setExperimentalRspackEnabled: rspackOption.setConfig,
setNumberOfSharedAudioTags: numberOfSharedAudioTagsOption.setConfig,
diff --git a/packages/cli/src/get-render-defaults.ts b/packages/cli/src/get-render-defaults.ts
index a832bc912e..8c353a2bc1 100644
--- a/packages/cli/src/get-render-defaults.ts
+++ b/packages/cli/src/get-render-defaults.ts
@@ -6,6 +6,7 @@ import {ConfigInternals} from './config';
import {parsedCli} from './parsed-cli';
const {
+ allowHtmlInCanvasOption,
x264Option,
gopSizeOption,
audioBitrateOption,
@@ -160,6 +161,9 @@ export const getRenderDefaults = (logLevel: LogLevel): RenderDefaults => {
const userAgent = userAgentOption.getValue({commandLine: parsedCli}).value;
const metadata = ConfigInternals.getMetadata();
const outputLocation = ConfigInternals.getOutputLocation();
+ const allowHtmlInCanvas = allowHtmlInCanvasOption.getValue({
+ commandLine: parsedCli,
+ }).value;
const maxConcurrency = RenderInternals.getMaxConcurrency();
const minConcurrency = RenderInternals.getMinConcurrency();
@@ -220,6 +224,7 @@ export const getRenderDefaults = (logLevel: LogLevel): RenderDefaults => {
mediaCacheSizeInBytes,
publicLicenseKey,
outputLocation,
+ allowHtmlInCanvas,
sampleRate: sampleRateOption.getValue({commandLine: parsedCli}).value,
configFileRenderDefaults,
};
diff --git a/packages/cli/src/parsed-cli.ts b/packages/cli/src/parsed-cli.ts
index 11eac44fe7..5dd4bf7553 100644
--- a/packages/cli/src/parsed-cli.ts
+++ b/packages/cli/src/parsed-cli.ts
@@ -8,6 +8,7 @@ import {BrowserSafeApis} from '@remotion/renderer/client';
import minimist from 'minimist';
const {
+ allowHtmlInCanvasOption,
benchmarkConcurrenciesOption,
beepOnFinishOption,
colorSpaceOption,
@@ -86,6 +87,9 @@ const {
} = BrowserSafeApis.options;
export type CommandLineOptions = {
+ [allowHtmlInCanvasOption.cliFlag]: TypeOfOption<
+ typeof allowHtmlInCanvasOption
+ > | null;
[browserExecutableOption.cliFlag]: TypeOfOption<
typeof browserExecutableOption
>;
@@ -209,6 +213,7 @@ export type CommandLineOptions = {
};
export const BooleanFlags = [
+ allowHtmlInCanvasOption.cliFlag,
overwriteOption.cliFlag,
imageSequenceOption.cliFlag,
'help',
@@ -239,6 +244,7 @@ export const BooleanFlags = [
export const parsedCli = minimist<CommandLineOptions>(process.argv.slice(2), {
boolean: BooleanFlags,
default: {
+ [allowHtmlInCanvasOption.cliFlag]: null,
[overwriteOption.cliFlag]: null,
[bundleCacheOption.cliFlag]: null,
[darkModeOption.cliFlag]: null,
diff --git a/packages/core/src/HtmlInCanvas.tsx b/packages/core/src/HtmlInCanvas.tsx
index ad55298d6a..85ac6d06c1 100644
--- a/packages/core/src/HtmlInCanvas.tsx
+++ b/packages/core/src/HtmlInCanvas.tsx
@@ -244,21 +244,6 @@ export const isHtmlInCanvasSupported = (): boolean => {
export const HTML_IN_CANVAS_UNSUPPORTED_MESSAGE =
'HTML in Canvas is not supported. Two common causes: Chrome is older than version 148 (update Chrome), or the HTML-in-Canvas flag is disabled at chrome://flags/#canvas-draw-element (enable it and restart Chrome).';
-const MINIMUM_CHROME_VERSION_FOR_NESTED_HTML_IN_CANVAS = 152;
-
-const getChromeMajorVersion = (): number | null => {
- if (typeof navigator === 'undefined') {
- return null;
- }
-
- const match = navigator.userAgent.match(/\b(?:HeadlessChrome|Chrome)\/(\d+)/);
- if (!match) {
- return null;
- }
-
- return Number(match[1]);
-};
-
export type HtmlInCanvasOnPaint = (
params: HtmlInCanvasOnPaintParams,
) => void | Promise<void>;
@@ -377,13 +362,7 @@ export type HtmlInCanvasProps = Omit<InteractiveBaseProps, 'children'> &
};
/* eslint-enable react/require-default-props */
-type HtmlInCanvasAncestor = {
- readonly requestParentPaint: () => void;
-};
-
-const HtmlInCanvasAncestorContext = createContext<HtmlInCanvasAncestor | null>(
- null,
-);
+const HtmlInCanvasAncestorContext = createContext(false);
type HtmlInCanvasContentProps = {
readonly width: number;
@@ -415,16 +394,13 @@ const HtmlInCanvasContent = forwardRef<
},
ref,
) => {
- const ancestor = useContext(HtmlInCanvasAncestorContext);
+ const isInsideAncestorHtmlInCanvas = useContext(
+ HtmlInCanvasAncestorContext,
+ );
assertHtmlInCanvasDimensions(width, height);
- const chromeMajorVersion = getChromeMajorVersion();
- if (
- ancestor &&
- chromeMajorVersion !== null &&
- chromeMajorVersion < MINIMUM_CHROME_VERSION_FOR_NESTED_HTML_IN_CANVAS
- ) {
+ if (isInsideAncestorHtmlInCanvas) {
throw new Error(
- `Nested <HtmlInCanvas> components require Chrome ${MINIMUM_CHROME_VERSION_FOR_NESTED_HTML_IN_CANVAS} or newer, but the current browser is Chrome ${chromeMajorVersion}. Upgrade Chrome or avoid nesting components that use <HtmlInCanvas>, such as shapes with effects.`,
+ '<HtmlInCanvas> components cannot be nested. Chrome does not reliably render nested HTML-in-canvas subtrees. Consider merging the effects into one <HtmlInCanvas> if you can.',
);
}
@@ -475,8 +451,6 @@ const HtmlInCanvasContent = forwardRef<
const initializedRef = useRef(false);
const onInitCleanupRef = useRef<HtmlInCanvasOnInitCleanup | null>(null);
const unmountedRef = useRef(false);
- const ancestorRef = useRef(ancestor);
- ancestorRef.current = ancestor;
const onPaintCb = useCallback(async () => {
const element = divRef.current;
@@ -623,11 +597,6 @@ const HtmlInCanvasContent = forwardRef<
elImage.close();
}
- // Effects may complete after Chromium has dispatched the parent's
- // paint event. Repaint the direct parent so deeply nested canvases
- // propagate their final pixels through every ancestor.
- ancestorRef.current?.requestParentPaint();
-
continueRender(handle);
} catch (error) {
cancelRender(error);
@@ -643,9 +612,8 @@ const HtmlInCanvasContent = forwardRef<
canRetryMissingPaintRecord,
]);
- // Default paint handlers draw synchronously on the layout canvas itself so
- // Chromium can include their final pixels during its deepest-first nested
- // paint traversal. Custom handlers retain the transferred OffscreenCanvas API.
+ // Default paint handlers draw synchronously on the layout canvas itself.
+ // Custom handlers retain the transferred OffscreenCanvas API.
useLayoutEffect(() => {
const placeholder = canvas2dRef.current;
if (!placeholder) {
@@ -736,16 +704,8 @@ const HtmlInCanvasContent = forwardRef<
};
}, [height, style, width]);
- const ancestorValue = useMemo<HtmlInCanvasAncestor>(() => {
- return {
- requestParentPaint: () => {
- canvas2dRef.current?.requestPaint?.();
- },
- };
- }, []);
-
return (
- <HtmlInCanvasAncestorContext.Provider value={ancestorValue}>
+ <HtmlInCanvasAncestorContext.Provider value>
<canvas
key={canvasSizeKey}
ref={setLayoutCanvasRef}
diff --git a/packages/core/src/test/html-in-canvas.test.tsx b/packages/core/src/test/html-in-canvas.test.tsx
index f2997b0516..9a928c89a3 100644
--- a/packages/core/src/test/html-in-canvas.test.tsx
+++ b/packages/core/src/test/html-in-canvas.test.tsx
@@ -330,51 +330,9 @@ test('<HtmlInCanvas> exposes crop controls', () => {
expect(htmlInCanvasSchema.cropBottom.keyframable).toBe(true);
});
-test('<HtmlInCanvas> throws when nested in Chrome older than 152', () => {
- const originalUserAgent = Object.getOwnPropertyDescriptor(
- window.navigator,
- 'userAgent',
- );
- Object.defineProperty(window.navigator, 'userAgent', {
- configurable: true,
- value: 'Mozilla/5.0 HeadlessChrome/151.0.0.0 Safari/537.36',
- });
-
- try {
- expect(() =>
- render(
- <SequenceTestWrapper onRegisterSequence={() => undefined}>
- <HtmlInCanvas width={120} height={80}>
- <HtmlInCanvas width={60} height={40}>
- <div>Nested</div>
- </HtmlInCanvas>
- </HtmlInCanvas>
- </SequenceTestWrapper>,
- ),
- ).toThrow(
- 'Nested <HtmlInCanvas> components require Chrome 152 or newer, but the current browser is Chrome 151.',
- );
- } finally {
- if (originalUserAgent) {
- Object.defineProperty(window.navigator, 'userAgent', originalUserAgent);
- } else {
- Reflect.deleteProperty(window.navigator, 'userAgent');
- }
- }
-});
-
-test('<HtmlInCanvas> allows nesting in Chrome 152', () => {
- const originalUserAgent = Object.getOwnPropertyDescriptor(
- window.navigator,
- 'userAgent',
- );
- Object.defineProperty(window.navigator, 'userAgent', {
- configurable: true,
- value: 'Mozilla/5.0 Chrome/152.0.0.0 Safari/537.36',
- });
-
- try {
- const {container} = render(
+test('<HtmlInCanvas> throws when nested', () => {
+ expect(() =>
+ render(
<SequenceTestWrapper onRegisterSequence={() => undefined}>
<HtmlInCanvas width={120} height={80}>
<HtmlInCanvas width={60} height={40}>
@@ -382,16 +340,8 @@ test('<HtmlInCanvas> allows nesting in Chrome 152', () => {
</HtmlInCanvas>
</HtmlInCanvas>
</SequenceTestWrapper>,
- );
-
- expect(container.querySelectorAll('canvas')).toHaveLength(2);
- } finally {
- if (originalUserAgent) {
- Object.defineProperty(window.navigator, 'userAgent', originalUserAgent);
- } else {
- Reflect.deleteProperty(window.navigator, 'userAgent');
- }
- }
+ ),
+ ).toThrow('<HtmlInCanvas> components cannot be nested.');
});
test('<HtmlInCanvas> keeps refs current when the canvas remounts', async () => {
@@ -531,118 +481,6 @@ test('<HtmlInCanvas> does not apply pixel density to the live DOM transform', as
});
});
-test('<HtmlInCanvas> propagates paints through nested layers', async () => {
- let deepestPaintCalled = false;
- let innerPaintCalled = false;
- let outerPaintCalled = false;
-
- const {container} = render(
- <SequenceTestWrapper onRegisterSequence={() => undefined}>
- <HtmlInCanvas
- width={100}
- height={100}
- onPaint={() => {
- outerPaintCalled = true;
- }}
- >
- <HtmlInCanvas
- width={50}
- height={50}
- onPaint={() => {
- innerPaintCalled = true;
- }}
- >
- <div>Nested</div>
- <HtmlInCanvas
- width={25}
- height={25}
- onPaint={() => {
- deepestPaintCalled = true;
- }}
- >
- <div>Deepest</div>
- </HtmlInCanvas>
- </HtmlInCanvas>
- </HtmlInCanvas>
- </SequenceTestWrapper>,
- );
-
- await waitFor(() => {
- expect(container.querySelectorAll('canvas')).toHaveLength(3);
- });
-
- const [outerCanvas, innerCanvas, deepestCanvas] =
- container.querySelectorAll('canvas');
- expect(outerCanvas.contains(innerCanvas)).toBe(true);
- expect(innerCanvas.contains(deepestCanvas)).toBe(true);
-
- let innerPaintRequested = false;
- let outerPaintRequested = false;
- Object.defineProperty(innerCanvas, 'requestPaint', {
- configurable: true,
- value: () => {
- innerPaintRequested = true;
- },
- });
- Object.defineProperty(outerCanvas, 'requestPaint', {
- configurable: true,
- value: () => {
- outerPaintRequested = true;
- },
- });
-
- // Chromium 152+ dispatches nested paint events from deepest to shallowest.
- // Remotion requests another parent paint after each async layer completes.
- deepestCanvas.dispatchEvent(new Event('paint'));
- await waitFor(() => {
- expect(deepestPaintCalled).toBe(true);
- expect(innerPaintRequested).toBe(true);
- });
-
- innerCanvas.dispatchEvent(new Event('paint'));
- await waitFor(() => {
- expect(innerPaintCalled).toBe(true);
- expect(outerPaintRequested).toBe(true);
- });
-
- outerCanvas.dispatchEvent(new Event('paint'));
- await waitFor(() => {
- expect(outerPaintCalled).toBe(true);
- });
-});
-
-test('<HtmlInCanvas> paints default nested layers directly on their layout canvases', async () => {
- const {container} = render(
- <SequenceTestWrapper onRegisterSequence={() => undefined}>
- <HtmlInCanvas width={100} height={100}>
- <HtmlInCanvas width={50} height={50}>
- <HtmlInCanvas width={25} height={25}>
- <div>Deepest</div>
- </HtmlInCanvas>
- </HtmlInCanvas>
- </HtmlInCanvas>
- </SequenceTestWrapper>,
- );
-
- await waitFor(() => {
- expect(container.querySelectorAll('canvas')).toHaveLength(3);
- });
-
- expect(transferControlToOffscreenCalls).toBe(0);
-
- const [outerCanvas, innerCanvas, deepestCanvas] =
- container.querySelectorAll('canvas');
- deepestCanvas.dispatchEvent(new Event('paint'));
- innerCanvas.dispatchEvent(new Event('paint'));
- outerCanvas.dispatchEvent(new Event('paint'));
-
- await waitFor(() => {
- expect(deepestCanvas.querySelector('div')?.style.transform).toBe(
- new DOMMatrix().toString(),
- );
- });
-});
-
test('<HtmlInCanvas> lets onInit choose a WebGL2 context', async () => {
let gotWebGl2Context = false;
let paintCalled = false;
diff --git a/packages/docs/docs/cli/studio.mdx b/packages/docs/docs/cli/studio.mdx
index 70bb9825a6..90b9e8e07c 100644
--- a/packages/docs/docs/cli/studio.mdx
+++ b/packages/docs/docs/cli/studio.mdx
@@ -57,6 +57,10 @@ Inline JSON string isn't supported on Windows shells because it removes the `"`
<Options id="disable-interactivity" />
+### `--allow-html-in-canvas`<AvailableFrom v="4.0.447" />
+
+<Options id="allow-html-in-canvas" />
+
### `--editor`<AvailableFrom v="4.0.503" />
<Options id="editor" cli />
diff --git a/packages/docs/docs/client-side-rendering/html-in-canvas.mdx b/packages/docs/docs/client-side-rendering/html-in-canvas.mdx
index 519d88a723..f8ce8e32ab 100644
--- a/packages/docs/docs/client-side-rendering/html-in-canvas.mdx
+++ b/packages/docs/docs/client-side-rendering/html-in-canvas.mdx
@@ -5,25 +5,27 @@ crumb: 'Client-side rendering'
sidebar_label: HTML-in-canvas
---
-# HTML-in-canvas<AvailableFrom v="4.0.491" />
+# HTML-in-canvas<AvailableFrom v="4.0.447" />
:::note
-This is not the same as the [`<HtmlInCanvas>`](/docs/html-in-canvas) component for designing visuals. This page describes how [`@remotion/web-renderer`](/docs/web-renderer) uses HTML-in-canvas to capture full frames during client-side rendering.
+This is not the same as the [`<HtmlInCanvas>`](/docs/html-in-canvas) component for designing visuals. This page describes a [`@remotion/web-renderer`](/docs/web-renderer) option that uses HTML-in-canvas to capture full frames during client-side rendering.
:::
-On supported Chromium-based browsers, [`@remotion/web-renderer`](/docs/web-renderer) automatically captures full frames using the experimental [HTML-in-canvas](/docs/html-in-canvas) APIs.
+On supported Chromium-based browsers, [`@remotion/web-renderer`](/docs/web-renderer) can optionally capture full frames using the experimental [HTML-in-canvas](/docs/html-in-canvas) APIs.
:::info
-Use Chrome or Chromium `152.0.7944.0` or later with `chrome://flags/#canvas-draw-element` enabled. The renderer requires nested HTML-in-canvas support before using the native capture path. See [Compatibility](#compatibility) for details.
+Use a recent version of Google Chrome or another Chromium-based browser with `chrome://flags/#canvas-draw-element` enabled. Current Chrome stable releases ship `canvas.requestPaint()` together with [`drawElementImage`](https://github.com/WICG/html-in-canvas#2-drawelementimage-and-webglwebgpu-equivalents), which is required for correct frame capture. See [Compatibility](#compatibility) for details.
:::
-If the browser does not pass the nesting support check, the renderer uses the [built-in DOM composer](/docs/client-side-rendering/how-it-works).
+Enabling the option does not guarantee that this path runs. If the browser does not have HTML-in-canvas enabled, or if the composition contains an [`<HtmlInCanvas>`](/docs/remotion/html-in-canvas), it falls back to the [default frame capturing mechanism](/docs/client-side-rendering/how-it-works).
-## Automatic selection
+## Enabling
-No option is required. [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web) and [`renderStillOnWeb()`](/docs/web-renderer/render-still-on-web) probe nested HTML-in-canvas support and select the capture backend automatically.
+### In code
-```tsx twoslash title="Render a still"
+Pass `allowHtmlInCanvas: true` to [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web) or [`renderStillOnWeb()`](/docs/web-renderer/render-still-on-web). The default is `false` when you omit the field.
+
+```tsx twoslash title="Example"
import {renderStillOnWeb} from '@remotion/web-renderer';
declare const composition: Parameters<typeof renderStillOnWeb>[0]['composition'];
@@ -33,15 +35,30 @@ await renderStillOnWeb({
composition,
frame: 0,
inputProps: {},
+ allowHtmlInCanvas: true,
});
```
+### In the Studio
+
+Open the render modal, go to the `Advanced` tab, and turn on `Allow HTML-in-canvas`. The initial value comes from your config and CLI defaults.
+
+### As the Studio default
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setAllowHtmlInCanvasEnabled(true);
+```
+
+Or start Studio with `--allow-html-in-canvas`. See [`setAllowHtmlInCanvasEnabled()`](/docs/config#setallowhtmlincanvasenabled) and [`npx remotion studio`](/docs/cli/studio#--allow-html-in-canvas).
+
## Check if HTML-in-canvas was used
If HTML-in-canvas was used, you will see a warning in the browser console:
```
-Using Chromium experimental HTML-in-canvas (drawElementImage) for this frame. See https://remotion.dev/docs/client-side-rendering/html-in-canvas
+Using Chromium experimental HTML-in-canvas (drawElementImage) for this frame. Pixels may differ from the built-in DOM composer. Set allowHtmlInCanvas: false to force software rasterization. See https://remotion.dev/docs/client-side-rendering/html-in-canvas
```
If native capture starts but fails while capturing a frame, a warning is printed and the renderer falls back to the built-in DOM composer:
@@ -50,7 +67,7 @@ If native capture starts but fails while capturing a frame, a warning is printed
Not using HTML-in-canvas: drawElementImage failed (...); falling back to the built-in DOM composer.
```
-If the nesting support probe fails, the built-in DOM composer is selected without a warning.
+If HTML-in-canvas is unavailable, disabled, or would require a nested capture, the built-in DOM composer is selected.
## Compatibility
@@ -70,7 +87,7 @@ If the nesting support probe fails, the built-in DOM composer is selected withou
HTML-in-canvas depends on Chromium flag `chrome://flags/#canvas-draw-element`, which must be enabled explicitly.
-Use Chrome or Chromium `152.0.7944.0` or later with the flag enabled. This version adds the nested capture behavior required by both the renderer capture canvas and compositions containing [`<HtmlInCanvas>`](/docs/remotion/html-in-canvas). Older versions use the built-in DOM composer.
+Use a recent Chrome or Chromium version with the flag enabled for full support. Compositions containing [`<HtmlInCanvas>`](/docs/remotion/html-in-canvas) always use the built-in DOM composer because nested HTML-in-canvas captures are unsupported.
## See also
diff --git a/packages/docs/docs/client-side-rendering/limitations.mdx b/packages/docs/docs/client-side-rendering/limitations.mdx
index c7bdc1ea04..c280e68168 100644
--- a/packages/docs/docs/client-side-rendering/limitations.mdx
+++ b/packages/docs/docs/client-side-rendering/limitations.mdx
@@ -12,7 +12,7 @@ Unlike server-side rendering, where a full screenshot it taken, in client-side r
It is not feasible to support all CSS properties and factors affecting the visual style of a page, so only the most important styling primitives are supported.
:::info
-If automatic [HTML-in-canvas capture](/docs/client-side-rendering/html-in-canvas) is active, these CSS limitations don't apply because a full screenshot is taken instead.
+If the optional [HTML-in-canvas capture](/docs/client-side-rendering/html-in-canvas) mode is active, these CSS limitations don't apply because a full screenshot is taken instead.
:::
## Supported CSS styles
@@ -122,7 +122,7 @@ The [`<Audio>`](/docs/media/audio) from `@remotion/media` is <a style={{color: '
[`<ThreeCanvas>`](/docs/three-canvas) from [`@remotion/three`](/docs/three) is <a style={{color: 'green'}}>supported</a>.
[`<SkiaCanvas>`](/docs/skia/skia-canvas) from [`@remotion/skia`](/docs/skia) is <a style={{color: 'green'}}>supported</a>.
[`<AnimatedImage>`](/docs/animatedimage) is <a style={{color: 'green'}}>supported</a> when rendering in Chrome.
-[`<HtmlInCanvas>`](/docs/remotion/html-in-canvas) is <a style={{color: 'green'}}>supported</a> when the component itself is supported, including its [`onPaint`](/docs/remotion/html-in-canvas#onpaint) and [`onInit`](/docs/remotion/html-in-canvas#oninit) callbacks. Automatic [HTML-in-canvas capture](/docs/client-side-rendering/html-in-canvas) requires Chrome or Chromium `152.0.7944.0` or later; older browsers use the built-in DOM composer.<br />
+[`<HtmlInCanvas>`](/docs/remotion/html-in-canvas) is <a style={{color: 'green'}}>supported</a> when the component itself is supported, including its [`onPaint`](/docs/remotion/html-in-canvas#onpaint) and [`onInit`](/docs/remotion/html-in-canvas#oninit) callbacks. The optional [HTML-in-canvas capture mode](/docs/client-side-rendering/html-in-canvas) falls back to the built-in DOM composer for such compositions to avoid nesting.<br />
[`<OffthreadVideo>`](/docs/offthreadvideo) is <a style={{color: 'red'}}>not supported</a>.
β†’ Use [`<Video>`](/docs/media/video) instead.
[`<Html5Video>`](/docs/html5-video) is <a style={{color: 'red'}}>not supported</a>.
diff --git a/packages/docs/docs/config.mdx b/packages/docs/docs/config.mdx
index bbfe61886d..b9972721aa 100644
--- a/packages/docs/docs/config.mdx
+++ b/packages/docs/docs/config.mdx
@@ -247,11 +247,17 @@ Available coding agents: `codex`, `cursor`, `copilot`, and `claude-code`.
The [`--coding-agent`](/docs/cli/studio#--coding-agent) command line flag takes precedence over this option.
-## ~~`setAllowHtmlInCanvasEnabled()`~~<AvailableFrom v="4.0.447" />
+## `setAllowHtmlInCanvasEnabled()`<AvailableFrom v="4.0.447" />
-:::info Deprecated
-From Remotion v4.0.491, this method is a no-op and can be removed from your config file. [`@remotion/web-renderer`](/docs/web-renderer) automatically uses HTML-in-canvas when the browser supports nested captures.
-:::
+<Options id="allow-html-in-canvas" />
+
+```ts twoslash title="remotion.config.ts"
+import {Config} from '@remotion/cli/config';
+// ---cut---
+Config.setAllowHtmlInCanvasEnabled(true);
+```
+
+The [command line flag](/docs/cli/studio#--allow-html-in-canvas) `--allow-html-in-canvas` will take precedence over this option.
## `setRspack()`<AvailableFrom v="4.0.502" />
diff --git a/packages/docs/docs/html-in-canvas-guide.mdx b/packages/docs/docs/html-in-canvas-guide.mdx
index aa03504176..556678bbeb 100644
--- a/packages/docs/docs/html-in-canvas-guide.mdx
+++ b/packages/docs/docs/html-in-canvas-guide.mdx
@@ -101,7 +101,7 @@ You can also build your own β€” see [Making a custom HTML-in-canvas presentation
HTML-in-canvas is only available in Chrome 149 and later with the `chrome://flags/#canvas-draw-element` flag enabled.
The API is unstable - Chrome may change the API or even remove it in the future.
-Nesting [`<HtmlInCanvas>`](/docs/remotion/html-in-canvas) components requires Chrome or Chromium `152.0.7944.0` or later.
+Nesting [`<HtmlInCanvas>`](/docs/remotion/html-in-canvas) components is not supported and throws an error. If you need to combine multiple effects, merge them into a single `onPaint` callback.
## Rendering
@@ -127,7 +127,7 @@ If your machine has no GPU, we recommend `--gl=swangle` instead (default on Lamb
## AI agents
-Remotion publishes [Agent Skills](/docs/ai/skills) that teach AI agents like Claude Code, Codex and Cursor how to use [`<HtmlInCanvas>`](/docs/remotion/html-in-canvas) correctly β€” including the [`onInit`](/docs/remotion/html-in-canvas#oninit) / [`onPaint`](/docs/remotion/html-in-canvas#onpaint) lifecycle, the [`--gl=angle` flag](#rendering) and [nesting requirements](#limitations).
+Remotion publishes [Agent Skills](/docs/ai/skills) that teach AI agents like Claude Code, Codex and Cursor how to use [`<HtmlInCanvas>`](/docs/remotion/html-in-canvas) correctly β€” including the [`onInit`](/docs/remotion/html-in-canvas#oninit) / [`onPaint`](/docs/remotion/html-in-canvas#onpaint) lifecycle, the [`--gl=angle` flag](#rendering) and the [no-nesting rule](#limitations).
Install them with:
@@ -137,15 +137,13 @@ npx skills add remotion-dev/skills
## Leveraging HTML-in-canvas for client-side rendering
-Not directly related, but [`@remotion/web-renderer`](/docs/client-side-rendering/html-in-canvas) also uses this technology to capture frames.
+Not directly related, but [`@remotion/web-renderer`](/docs/client-side-rendering/html-in-canvas) can also use this technology to capture frames.
-The [client-side renderer](/docs/client-side-rendering) automatically uses HTML-in-canvas when the browser supports nested captures. This can produce more accurate output than the built-in DOM compositor.
+This is opt-in because the mode cannot capture compositions containing [`<HtmlInCanvas>`](/docs/remotion/html-in-canvas): that would create a nested HTML-in-canvas subtree.
## Nested HTML-in-canvas
-Nesting `<HtmlInCanvas>` components is supported from <AvailableFrom v="4.0.491" inline /> for client-side rendering and preview if on Chrome 152.0.7944.0 or later.
-
-On server-side rendering, nested HTML-in-canvas is not yet supported, pending a Chrome upgrade which we are working on.
+Nesting `<HtmlInCanvas>` components is unsupported in preview, client-side rendering, and server-side rendering.
## See also
diff --git a/packages/docs/docs/remotion/html-in-canvas.mdx b/packages/docs/docs/remotion/html-in-canvas.mdx
index 5a290b516e..1facc7757d 100644
--- a/packages/docs/docs/remotion/html-in-canvas.mdx
+++ b/packages/docs/docs/remotion/html-in-canvas.mdx
@@ -796,9 +796,7 @@ const onPaint: HtmlInCanvasOnPaint = async ({canvas, elementImage}) => {
## Nested HTML-in-canvas
-Nesting `<HtmlInCanvas>` components is supported from <AvailableFrom v="4.0.491" inline /> for client-side rendering and preview if on Chrome 152.0.7944.0 or later.
-
-On server-side rendering, nested HTML-in-canvas is not yet supported, pending a Chrome upgrade which we are working on.
+Do not nest `<HtmlInCanvas>` inside another `<HtmlInCanvas>`. Nesting is unsupported and throws an error. If you need to combine multiple effects, merge them into one `<HtmlInCanvas>` if possible.
## Compatibility
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 86d83dca06..1648f59a15 100644
--- a/packages/docs/docs/web-renderer/render-media-on-web.mdx
+++ b/packages/docs/docs/web-renderer/render-media-on-web.mdx
@@ -366,6 +366,12 @@ _default `true`_
<Options id="is-production" />
+### `allowHtmlInCanvas?`<AvailableFrom v="4.0.447" />
+
+_boolean β€” default `false`_
+
+<Options id="allow-html-in-canvas" />
+
## Return value
Returns a promise resolving to an object with the following properties:
diff --git a/packages/docs/docs/web-renderer/render-still-on-web.mdx b/packages/docs/docs/web-renderer/render-still-on-web.mdx
index 104b2f81f2..7f205de8d8 100644
--- a/packages/docs/docs/web-renderer/render-still-on-web.mdx
+++ b/packages/docs/docs/web-renderer/render-still-on-web.mdx
@@ -157,6 +157,12 @@ _default `true`_
<Options id="is-production" />
+### `allowHtmlInCanvas?`<AvailableFrom v="4.0.447" />
+
+_boolean β€” default `false`_
+
+<Options id="allow-html-in-canvas" />
+
## Return value
Returns a promise that resolves to a <TsType type="RenderStillOnWebResult" source="@remotion/web-renderer" href="/docs/web-renderer/types#renderstillonwebresult" /> once the frame has been painted to an internal canvas.
diff --git a/packages/example/src/HtmlInCanvas/index.tsx b/packages/example/src/HtmlInCanvas/index.tsx
index c2ebe30775..6e1c4734a3 100644
--- a/packages/example/src/HtmlInCanvas/index.tsx
+++ b/packages/example/src/HtmlInCanvas/index.tsx
@@ -34,7 +34,6 @@ export {
} from './linear-blur-doc';
export {HtmlInCanvasDocsMinimalWebGL} from './minimal-docs-webgl';
export {HtmlInCanvasDocsMinimalWebGPU} from './minimal-docs-webgpu';
-export {HtmlInCanvasNestedEffects} from './nested-effects';
export {HtmlInCanvasPixelDensity} from './pixel-density';
export {HtmlInCanvasPrivacy} from './privacy';
export {HtmlInCanvasReactSvg} from './react-svg';
diff --git a/packages/example/src/HtmlInCanvas/nested-effects.tsx b/packages/example/src/HtmlInCanvas/nested-effects.tsx
deleted file mode 100644
index ed44fe97dd..0000000000
--- a/packages/example/src/HtmlInCanvas/nested-effects.tsx
+++ /dev/null
@@ -1,118 +0,0 @@
-import {fisheye} from '@remotion/effects/fisheye';
-import {halftone} from '@remotion/effects/halftone';
-import {wave} from '@remotion/effects/wave';
-import React from 'react';
-import {
- AbsoluteFill,
- HtmlInCanvas,
- useCurrentFrame,
- useVideoConfig,
-} from 'remotion';
-
-export const HtmlInCanvasNestedEffects: React.FC = () => {
- const frame = useCurrentFrame();
- const {width, height} = useVideoConfig();
-
- return (
- <HtmlInCanvas
- width={width}
- height={height}
- effects={[
- fisheye({
- fieldOfView: 2.3,
- radius: 0.95,
- zoom: 1,
- }),
- ]}
- >
- <AbsoluteFill
- style={{
- alignItems: 'center',
- backgroundColor: '#071426',
- backgroundImage:
- 'linear-gradient(rgba(90, 185, 255, 0.18) 2px, transparent 2px), linear-gradient(90deg, rgba(90, 185, 255, 0.18) 2px, transparent 2px)',
- backgroundSize: '96px 96px',
- justifyContent: 'center',
- }}
- >
- <div
- style={{
- color: '#9ddcff',
- fontFamily: 'sans-serif',
- fontSize: 34,
- fontWeight: 700,
- left: 80,
- letterSpacing: 8,
- position: 'absolute',
- top: 64,
- }}
- >
- OUTER Β· FISHEYE
- </div>
- <HtmlInCanvas
- width={960}
- height={640}
- effects={[
- wave({
- amplitude: 34,
- phase: frame * 0.08,
- wavelength: 240,
- }),
- ]}
- >
- <AbsoluteFill
- style={{
- alignItems: 'center',
- backgroundColor: '#ffcc00',
- boxShadow: '0 30px 90px rgba(0, 0, 0, 0.35)',
- justifyContent: 'center',
- }}
- >
- <div
- style={{
- color: '#372b00',
- fontFamily: 'sans-serif',
- fontSize: 28,
- fontWeight: 700,
- left: 40,
- letterSpacing: 7,
- position: 'absolute',
- top: 32,
- }}
- >
- LAYER 2 Β· WAVE
- </div>
- <HtmlInCanvas
- width={520}
- height={320}
- effects={[
- halftone({
- colorMode: 'source',
- dotSize: 14,
- dotSpacing: 16,
- rotation: -8,
- }),
- ]}
- >
- <AbsoluteFill
- style={{
- alignItems: 'center',
- backgroundColor: '#ff1744',
- boxShadow: '0 24px 70px rgba(61, 0, 15, 0.4)',
- color: 'white',
- fontFamily: 'sans-serif',
- fontSize: 80,
- fontWeight: 700,
- justifyContent: 'center',
- letterSpacing: -3,
- }}
- >
- Layer 3 Β· Halftone
- </AbsoluteFill>
- </HtmlInCanvas>
- </AbsoluteFill>
- </HtmlInCanvas>
- </AbsoluteFill>
- </HtmlInCanvas>
- );
-};
diff --git a/packages/example/src/Root.tsx b/packages/example/src/Root.tsx
index 9edd153003..ec99465287 100644
--- a/packages/example/src/Root.tsx
+++ b/packages/example/src/Root.tsx
@@ -87,7 +87,6 @@ import {
HtmlInCanvasDocsDemo2DBlur,
HtmlInCanvasDocsMinimalWebGL,
HtmlInCanvasDocsMinimalWebGPU,
- HtmlInCanvasNestedEffects,
HtmlInCanvasPixelDensity,
HtmlInCanvasPrivacy,
HtmlInCanvasReactSvg,
@@ -1272,14 +1271,6 @@ export const Index: React.FC = () => {
width={1920}
durationInFrames={120}
/>
- <Composition
- id="html-in-canvas-nested-effects"
- component={HtmlInCanvasNestedEffects}
- fps={30}
- height={1080}
- width={1920}
- durationInFrames={120}
- />
<Composition
id="book-flip-transition-doc"
component={BookFlipTransitionDoc}
diff --git a/packages/renderer/src/options/allow-html-in-canvas.tsx b/packages/renderer/src/options/allow-html-in-canvas.tsx
new file mode 100644
index 0000000000..3681846e2a
--- /dev/null
+++ b/packages/renderer/src/options/allow-html-in-canvas.tsx
@@ -0,0 +1,41 @@
+import type {AnyRemotionOption} from './option';
+
+let allowHtmlInCanvasEnabled = false;
+
+const cliFlag = 'allow-html-in-canvas' as const;
+
+export const allowHtmlInCanvasOption = {
+ name: 'Allow HTML-in-canvas for client-side rendering',
+ cliFlag,
+ description: () => (
+ <>
+ When client-side rendering is enabled in the Studio, allow the
+ experimental Chromium HTML-in-canvas API to be used for capturing frames.
+ See{' '}
+ <a href="/docs/client-side-rendering/html-in-canvas">
+ HTML-in-canvas docs
+ </a>
+ .
+ </>
+ ),
+ ssrName: null,
+ docLink: 'https://www.remotion.dev/docs/client-side-rendering/html-in-canvas',
+ type: false as boolean,
+ getValue: ({commandLine}) => {
+ if (commandLine[cliFlag] !== null) {
+ return {
+ value: commandLine[cliFlag] as boolean,
+ source: 'cli',
+ };
+ }
+
+ return {
+ value: allowHtmlInCanvasEnabled,
+ source: 'config',
+ };
+ },
+ setConfig(value) {
+ allowHtmlInCanvasEnabled = value;
+ },
+ id: cliFlag,
+} satisfies AnyRemotionOption<boolean>;
diff --git a/packages/renderer/src/options/index.tsx b/packages/renderer/src/options/index.tsx
index ad26feeb60..cff91ca488 100644
--- a/packages/renderer/src/options/index.tsx
+++ b/packages/renderer/src/options/index.tsx
@@ -1,3 +1,4 @@
+import {allowHtmlInCanvasOption} from './allow-html-in-canvas';
import {apiKeyOption} from './api-key';
import {askAIOption} from './ask-ai';
import {audioBitrateOption} from './audio-bitrate';
@@ -95,6 +96,7 @@ import {webpackPollOption} from './webpack-poll';
import {x264Option} from './x264-preset';
export const allOptions = {
+ allowHtmlInCanvasOption,
audioCodecOption,
benchmarkConcurrenciesOption,
browserExecutableOption,
diff --git a/packages/skills/skills/remotion-markup/html-in-canvas.md b/packages/skills/skills/remotion-markup/html-in-canvas.md
index 5c4c759972..d2638015e4 100644
--- a/packages/skills/skills/remotion-markup/html-in-canvas.md
+++ b/packages/skills/skills/remotion-markup/html-in-canvas.md
@@ -7,8 +7,7 @@ Give the user a notice.
## Nesting
-`<HtmlInCanvas>` components may be nested in Chrome 152.0.7944.0 and later.
-Older Chrome versions support a single `<HtmlInCanvas>`, but do not correctly paint nested HTML-in-canvas subtrees.
+Do not nest `<HtmlInCanvas>` components. Remotion rejects nesting because Chrome does not reliably render nested HTML-in-canvas subtrees.
## Enabling WebGL during renders
diff --git a/packages/studio-shared/src/render-defaults.ts b/packages/studio-shared/src/render-defaults.ts
index 1c73e4555a..e758f5de75 100644
--- a/packages/studio-shared/src/render-defaults.ts
+++ b/packages/studio-shared/src/render-defaults.ts
@@ -68,6 +68,7 @@ export type RenderDefaults = {
chromeMode: ChromeMode;
publicLicenseKey: string | null;
outputLocation: string | null;
+ allowHtmlInCanvas: boolean;
sampleRate: number;
configFileRenderDefaults: ConfigFileRenderDefaults | null;
};
diff --git a/packages/studio/src/components/RenderButton.tsx b/packages/studio/src/components/RenderButton.tsx
index 98b0a40f3a..9ebbeb5bb9 100644
--- a/packages/studio/src/components/RenderButton.tsx
+++ b/packages/studio/src/components/RenderButton.tsx
@@ -375,6 +375,7 @@ const RenderButtonInner: React.FC<{
initialTransparent: null,
initialMuted: null,
initialMediaCacheSizeInBytes: defaults.mediaCacheSizeInBytes,
+ initialAllowHtmlInCanvas: defaults.allowHtmlInCanvas,
initialPageResponsiveness: 'medium',
});
}, [video, setSelectedModal, props, inFrame, outFrame, getCurrentFrame]);
diff --git a/packages/studio/src/components/RenderModal/WebRenderModal.tsx b/packages/studio/src/components/RenderModal/WebRenderModal.tsx
index f5cd233b0f..3b938ad0f9 100644
--- a/packages/studio/src/components/RenderModal/WebRenderModal.tsx
+++ b/packages/studio/src/components/RenderModal/WebRenderModal.tsx
@@ -83,6 +83,7 @@ type WebRenderModalProps = {
readonly initialTransparent: boolean | null;
readonly initialMuted: boolean | null;
readonly initialMediaCacheSizeInBytes: number | null;
+ readonly initialAllowHtmlInCanvas: boolean;
readonly initialPageResponsiveness: WebRendererPageResponsiveness;
};
@@ -180,6 +181,7 @@ const WebRenderModal: React.FC<WebRenderModalProps> = ({
initialKeyframeIntervalInSeconds,
initialTransparent,
initialMuted,
+ initialAllowHtmlInCanvas,
initialPageResponsiveness,
}) => {
const context = useContext(ResolvedCompositionContext);
@@ -270,6 +272,9 @@ const WebRenderModal: React.FC<WebRenderModalProps> = ({
const [transparent, setTransparent] = useState(initialTransparent ?? false);
const [muted, setMuted] = useState(initialMuted ?? false);
const [scale, setScale] = useState(initialScale ?? 1);
+ const [allowHtmlInCanvas, setAllowHtmlInCanvas] = useState(
+ initialAllowHtmlInCanvas ?? false,
+ );
const [pageResponsiveness, setPageResponsiveness] =
useState<WebRendererPageResponsiveness>(
@@ -545,6 +550,7 @@ const WebRenderModal: React.FC<WebRenderModalProps> = ({
logLevel,
licenseKey: publicLicenseKey,
scale,
+ allowHtmlInCanvas,
},
compositionRef,
);
@@ -573,6 +579,7 @@ const WebRenderModal: React.FC<WebRenderModalProps> = ({
logLevel,
licenseKey: publicLicenseKey,
scale,
+ allowHtmlInCanvas,
pageResponsiveness,
},
compositionRef,
@@ -617,6 +624,7 @@ const WebRenderModal: React.FC<WebRenderModalProps> = ({
addClientStillJob,
addClientVideoJob,
scale,
+ allowHtmlInCanvas,
pageResponsiveness,
]);
@@ -796,6 +804,8 @@ const WebRenderModal: React.FC<WebRenderModalProps> = ({
setMediaCacheSizeInBytes={setMediaCacheSizeInBytes}
hardwareAcceleration={hardwareAcceleration}
setHardwareAcceleration={setHardwareAcceleration}
+ allowHtmlInCanvas={allowHtmlInCanvas}
+ setAllowHtmlInCanvas={setAllowHtmlInCanvas}
pageResponsiveness={pageResponsiveness}
setPageResponsiveness={setPageResponsiveness}
/>
diff --git a/packages/studio/src/components/RenderModal/WebRenderModalAdvanced.tsx b/packages/studio/src/components/RenderModal/WebRenderModalAdvanced.tsx
index 67828f0622..8150bbb5d3 100644
--- a/packages/studio/src/components/RenderModal/WebRenderModalAdvanced.tsx
+++ b/packages/studio/src/components/RenderModal/WebRenderModalAdvanced.tsx
@@ -29,6 +29,8 @@ type WebRenderModalAdvancedProps = {
readonly setHardwareAcceleration: (
value: 'no-preference' | 'prefer-hardware' | 'prefer-software',
) => void;
+ readonly allowHtmlInCanvas: boolean;
+ readonly setAllowHtmlInCanvas: React.Dispatch<React.SetStateAction<boolean>>;
readonly pageResponsiveness: WebRendererPageResponsiveness;
readonly setPageResponsiveness: React.Dispatch<
React.SetStateAction<WebRendererPageResponsiveness>
@@ -76,6 +78,8 @@ export const WebRenderModalAdvanced: React.FC<WebRenderModalAdvancedProps> = ({
setMediaCacheSizeInBytes,
hardwareAcceleration,
setHardwareAcceleration,
+ allowHtmlInCanvas,
+ setAllowHtmlInCanvas,
pageResponsiveness,
setPageResponsiveness,
}) => {
@@ -88,6 +92,9 @@ export const WebRenderModalAdvanced: React.FC<WebRenderModalAdvancedProps> = ({
return null;
});
}, [setMediaCacheSizeInBytes]);
+ const toggleAllowHtmlInCanvas = useCallback(() => {
+ setAllowHtmlInCanvas((previous) => !previous);
+ }, [setAllowHtmlInCanvas]);
const changeMediaCacheSizeInBytes: React.Dispatch<
React.SetStateAction<number>
@@ -284,6 +291,23 @@ export const WebRenderModalAdvanced: React.FC<WebRenderModalAdvancedProps> = ({
</div>
) : null}
+ <div style={optionRow}>
+ <div style={label}>
+ Allow HTML-in-canvas <Spacing x={0.5} />
+ <WebRendererOptionExplainerBubble
+ apiName="allowHtmlInCanvas"
+ id="allowHtmlInCanvasOption"
+ />
+ </div>
+ <div style={rightRow}>
+ <Checkbox
+ checked={allowHtmlInCanvas}
+ onChange={toggleAllowHtmlInCanvas}
+ name="allow-html-in-canvas"
+ />
+ </div>
+ </div>
+
{renderMode === 'still' ? null : (
<>
<div style={optionRow}>
diff --git a/packages/studio/src/components/RenderQueue/ClientRenderQueueProcessor.tsx b/packages/studio/src/components/RenderQueue/ClientRenderQueueProcessor.tsx
index cd10f5a024..9d8cac7772 100644
--- a/packages/studio/src/components/RenderQueue/ClientRenderQueueProcessor.tsx
+++ b/packages/studio/src/components/RenderQueue/ClientRenderQueueProcessor.tsx
@@ -68,6 +68,7 @@ export const ClientRenderQueueProcessor: React.FC = () => {
licenseKey: job.licenseKey ?? undefined,
scale: job.scale,
signal,
+ allowHtmlInCanvas: job.allowHtmlInCanvas,
})
).blob({format: job.imageFormat});
@@ -135,6 +136,7 @@ export const ClientRenderQueueProcessor: React.FC = () => {
outputTarget: 'web-fs',
licenseKey: job.licenseKey ?? undefined,
pageResponsiveness: job.pageResponsiveness,
+ allowHtmlInCanvas: job.allowHtmlInCanvas,
});
return {
diff --git a/packages/studio/src/components/RenderQueue/client-side-render-types.ts b/packages/studio/src/components/RenderQueue/client-side-render-types.ts
index 9d4da94033..b025ec6329 100644
--- a/packages/studio/src/components/RenderQueue/client-side-render-types.ts
+++ b/packages/studio/src/components/RenderQueue/client-side-render-types.ts
@@ -45,6 +45,7 @@ type ClientRenderJobBase = {
logLevel: LogLevel;
licenseKey: string | null;
scale: number;
+ allowHtmlInCanvas: boolean;
};
export type ClientStillRenderJob = ClientRenderJobBase & {
diff --git a/packages/studio/src/helpers/retry-payload.ts b/packages/studio/src/helpers/retry-payload.ts
index 33e205a06f..9578739d52 100644
--- a/packages/studio/src/helpers/retry-payload.ts
+++ b/packages/studio/src/helpers/retry-payload.ts
@@ -230,6 +230,7 @@ export const makeClientRetryPayload = (
job.type === 'client-video' ? job.keyframeIntervalInSeconds : null,
initialMuted: job.type === 'client-video' ? job.muted : null,
initialTransparent: job.type === 'client-video' ? job.transparent : null,
+ initialAllowHtmlInCanvas: job.allowHtmlInCanvas,
initialPageResponsiveness:
job.type === 'client-video' ? job.pageResponsiveness : 'disabled',
};
diff --git a/packages/studio/src/state/modals.ts b/packages/studio/src/state/modals.ts
index ce83a86951..fffd35f0cc 100644
--- a/packages/studio/src/state/modals.ts
+++ b/packages/studio/src/state/modals.ts
@@ -56,6 +56,7 @@ export type WebRenderModalState = {
initialTransparent: boolean | null;
initialMuted: boolean | null;
initialMediaCacheSizeInBytes: number | null;
+ initialAllowHtmlInCanvas: boolean;
initialPageResponsiveness: WebRendererPageResponsiveness;
};
diff --git a/packages/studio/src/test/make-render-command.test.ts b/packages/studio/src/test/make-render-command.test.ts
index 3ea32bc1d2..f1ab99fdbc 100644
--- a/packages/studio/src/test/make-render-command.test.ts
+++ b/packages/studio/src/test/make-render-command.test.ts
@@ -51,6 +51,7 @@ const getDefaults = (): RenderDefaults => {
chromeMode: 'headless-shell',
publicLicenseKey: null,
outputLocation: null,
+ allowHtmlInCanvas: false,
sampleRate: 48000,
configFileRenderDefaults: null,
};
diff --git a/packages/studio/src/test/retry-payload.test.ts b/packages/studio/src/test/retry-payload.test.ts
index 4befc0e673..9cc82bd3ea 100644
--- a/packages/studio/src/test/retry-payload.test.ts
+++ b/packages/studio/src/test/retry-payload.test.ts
@@ -16,6 +16,7 @@ const getClientVideoJob = (
logLevel: 'info',
licenseKey: null,
scale: 1,
+ allowHtmlInCanvas: false,
container: 'mp4',
videoCodec: 'h264',
audioCodec: 'aac',
diff --git a/packages/web-renderer/package.json b/packages/web-renderer/package.json
index 915bd6e52f..1288bbb5f8 100644
--- a/packages/web-renderer/package.json
+++ b/packages/web-renderer/package.json
@@ -46,7 +46,6 @@
"react-dom": "catalog:",
"three": "catalog:",
"vitest": "catalog:",
- "vitest-browser-react": "2.0.2",
"zod": "catalog:"
},
"peerDependencies": {
diff --git a/packages/web-renderer/src/drawing/draw-background.ts b/packages/web-renderer/src/drawing/draw-background.ts
index 075654bb5c..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,
- waitForRenderReady: () => Promise.resolve(),
});
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 ff8be80c7e..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,
- waitForRenderReady: () => Promise.resolve(),
});
if (waitForPageResponsiveness !== null) {
await waitForPageResponsiveness();
diff --git a/packages/web-renderer/src/html-in-canvas.ts b/packages/web-renderer/src/html-in-canvas.ts
index eb946f66cb..300fda3100 100644
--- a/packages/web-renderer/src/html-in-canvas.ts
+++ b/packages/web-renderer/src/html-in-canvas.ts
@@ -1,6 +1,6 @@
type Canvas2DWithDrawElement = CanvasRenderingContext2D & {
drawElementImage: (
- element: Element | ElementImage,
+ element: Element,
dx: number,
dy: number,
dwidth: number,
@@ -9,20 +9,10 @@ type Canvas2DWithDrawElement = CanvasRenderingContext2D & {
};
type HTMLCanvasWithLayoutSubtree = HTMLCanvasElement & {
- captureElementImage?: (element: Element) => ElementImage;
layoutSubtree?: boolean;
requestPaint?: () => void;
};
-let nestedHtmlInCanvasSupport: Promise<boolean> | null = null;
-let forceDisableHtmlInCanvasForTesting = false;
-
-export const setForceDisableHtmlInCanvasForTesting = (
- forceDisable: boolean,
-) => {
- forceDisableHtmlInCanvasForTesting = forceDisable;
-};
-
export const supportsNativeHtmlInCanvas = (): boolean => {
if (typeof document === 'undefined') {
return false;
@@ -34,162 +24,10 @@ export const supportsNativeHtmlInCanvas = (): boolean => {
return typeof ctx?.drawElementImage === 'function';
};
-const runNestedHtmlInCanvasProbe = (): Promise<boolean> => {
- if (!supportsNativeHtmlInCanvas() || !document.body) {
- return Promise.resolve(false);
- }
-
- const outer = document.createElement('canvas') as HTMLCanvasWithLayoutSubtree;
- const inner = document.createElement('canvas') as HTMLCanvasWithLayoutSubtree;
- const outerTarget = document.createElement('div');
- const innerTarget = document.createElement('div');
- const outerCtx = outer.getContext('2d') as Canvas2DWithDrawElement | null;
- const innerCtx = inner.getContext('2d') as Canvas2DWithDrawElement | null;
- const density = devicePixelRatio;
- const canvasSize = Math.ceil(4 * density);
-
- if (
- !outerCtx ||
- !innerCtx ||
- typeof outer.requestPaint !== 'function' ||
- typeof inner.requestPaint !== 'function'
- ) {
- return Promise.resolve(false);
- }
-
- outer.layoutSubtree = true;
- inner.layoutSubtree = true;
- outer.width = canvasSize;
- outer.height = canvasSize;
- inner.width = canvasSize;
- inner.height = canvasSize;
-
- Object.assign(outer.style, {
- display: 'block',
- height: '4px',
- left: '0',
- pointerEvents: 'none',
- position: 'fixed',
- top: '0',
- visibility: 'visible',
- width: '4px',
- zIndex: '2147483647',
- });
- Object.assign(inner.style, {
- display: 'block',
- height: '4px',
- width: '4px',
- });
- Object.assign(outerTarget.style, {
- display: 'block',
- height: '4px',
- width: '4px',
- });
- Object.assign(innerTarget.style, {
- backgroundColor: 'rgb(255, 0, 0)',
- display: 'block',
- height: '4px',
- width: '4px',
- });
-
- inner.appendChild(innerTarget);
- outerTarget.appendChild(inner);
- outer.appendChild(outerTarget);
- document.body.appendChild(outer);
-
- return new Promise<boolean>((resolve) => {
- let innerPainted = false;
- let settled = false;
- let timeout: number | null = null;
-
- const settle = (supported: boolean) => {
- if (settled) {
- return;
- }
-
- settled = true;
- if (timeout !== null) {
- window.clearTimeout(timeout);
- }
-
- outer.remove();
- resolve(supported);
- };
-
- timeout = window.setTimeout(() => settle(false), 1000);
-
- inner.addEventListener('paint', () => {
- try {
- innerCtx.reset();
- innerCtx.scale(density, density);
- const transform = innerCtx.drawElementImage(innerTarget, 0, 0, 4, 4);
- innerTarget.style.transform = transform.toString();
- innerPainted = true;
- } catch {
- settle(false);
- }
- });
-
- outer.addEventListener('paint', () => {
- if (!innerPainted) {
- return;
- }
-
- try {
- outerCtx.reset();
- outerCtx.scale(density, density);
- if (typeof outer.captureElementImage !== 'function') {
- settle(false);
- return;
- }
-
- const elementImage = outer.captureElementImage(outerTarget);
- const transform = outerCtx.drawElementImage(elementImage, 0, 0, 4, 4);
- elementImage.close();
- outerTarget.style.transform = transform.toString();
- const sampleCoordinate = Math.floor(canvasSize / 2);
- const pixel = outerCtx.getImageData(
- sampleCoordinate,
- sampleCoordinate,
- 1,
- 1,
- ).data;
- settle(
- pixel[0] > 200 && pixel[1] < 20 && pixel[2] < 20 && pixel[3] > 200,
- );
- } catch {
- settle(false);
- }
- });
-
- // Request both paints in the same rendering update. Nested layout canvases
- // dispatch their paint events deepest-first, so the inner bitmap is ready
- // when the outer canvas captures its subtree.
- inner.requestPaint!();
- outer.requestPaint!();
- });
-};
-
-export const supportsNestedHtmlInCanvas = (): Promise<boolean> => {
- if (forceDisableHtmlInCanvasForTesting) {
- return Promise.resolve(false);
- }
-
- if (!nestedHtmlInCanvasSupport) {
- nestedHtmlInCanvasSupport = runNestedHtmlInCanvasProbe();
- }
-
- return nestedHtmlInCanvasSupport;
-};
-
-const countLayoutSubtreeCanvases = (element: HTMLElement): number => {
- return Array.from(element.querySelectorAll('canvas')).filter(
- (canvas) => (canvas as HTMLCanvasWithLayoutSubtree).layoutSubtree === true,
- ).length;
-};
-
export const containsLayoutSubtreeCanvas = (element: HTMLElement): boolean => {
- return countLayoutSubtreeCanvases(element) > 0;
+ return Array.from(element.querySelectorAll('canvas')).some(
+ (canvas) => (canvas as HTMLCanvasWithLayoutSubtree).layoutSubtree === true,
+ );
};
export type HtmlInCanvasContext = {
@@ -275,15 +113,11 @@ export const drawWithHtmlInCanvas = async ({
element,
scaledWidth,
scaledHeight,
- waitForRenderReady,
- useElementImage,
}: {
htmlInCanvasContext: HtmlInCanvasContext;
element: HTMLElement;
scaledWidth: number;
scaledHeight: number;
- waitForRenderReady: () => Promise<void>;
- useElementImage: boolean;
}): Promise<OffscreenCanvasRenderingContext2D> => {
const {ctx, layoutCanvas} = htmlInCanvasContext;
@@ -296,35 +130,9 @@ export const drawWithHtmlInCanvas = async ({
}
await waitForPaint(layoutCanvas);
- // Each nested layout canvas needs one paint to run its async effect and a
- // second paint to propagate the completed bitmap to its parent. One final
- // cycle records the fully composed tree on the web renderer's root canvas.
- const nestedPaintCycles = useElementImage
- ? countLayoutSubtreeCanvases(element) * 2 + 1
- : 0;
- for (let i = 0; i < nestedPaintCycles; i++) {
- await new Promise<void>((resolve) =>
- requestAnimationFrame(() => resolve()),
- );
- await waitForRenderReady();
- await waitForPaint(layoutCanvas);
- }
ctx.reset();
- if (useElementImage) {
- if (typeof layoutCanvas.captureElementImage !== 'function') {
- throw new Error('canvas.captureElementImage() is unavailable');
- }
-
- const elementImage = layoutCanvas.captureElementImage(element);
- try {
- ctx.drawElementImage(elementImage, 0, 0, scaledWidth, scaledHeight);
- } finally {
- elementImage.close();
- }
- } else {
- ctx.drawElementImage(element, 0, 0, scaledWidth, scaledHeight);
- }
+ ctx.drawElementImage(element, 0, 0, scaledWidth, scaledHeight);
const offscreen = new OffscreenCanvas(scaledWidth, scaledHeight);
const offCtx = offscreen.getContext('2d');
diff --git a/packages/web-renderer/src/render-media-on-web.tsx b/packages/web-renderer/src/render-media-on-web.tsx
index fe81d2a454..3b55ded523 100644
--- a/packages/web-renderer/src/render-media-on-web.tsx
+++ b/packages/web-renderer/src/render-media-on-web.tsx
@@ -12,7 +12,7 @@ import {canUseWebFsWriter} from './can-use-webfs-target';
import {createAudioSampleSource} from './create-audio-sample-source';
import {checkForError, createScaffold} from './create-scaffold';
import {getRealFrameRange, type FrameRange} from './frame-range';
-import {supportsNestedHtmlInCanvas} from './html-in-canvas';
+import {supportsNativeHtmlInCanvas} from './html-in-canvas';
import type {InternalState} from './internal-state';
import {makeInternalState} from './internal-state';
import {
@@ -139,6 +139,7 @@ type OptionalRenderMediaOnWebOptions<Schema extends $ZodObject> = {
muted: boolean;
scale: number;
sampleRate: number;
+ allowHtmlInCanvas: boolean;
};
export type RenderMediaOnWebOptions<
@@ -189,6 +190,7 @@ const internalRenderMediaOnWeb = async <
scale,
isProduction,
sampleRate,
+ allowHtmlInCanvas,
}: InternalRenderMediaOnWebOptions<
Schema,
Props
@@ -207,7 +209,7 @@ const internalRenderMediaOnWeb = async <
if (outcome.native) {
Internals.Log.warn(
{logLevel, tag: '@remotion/web-renderer'},
- 'Using Chromium experimental HTML-in-canvas (drawElementImage) for video frames. See https://remotion.dev/docs/client-side-rendering/html-in-canvas',
+ 'Using Chromium experimental HTML-in-canvas (drawElementImage) for video frames. Pixels may differ from the built-in DOM composer. Set allowHtmlInCanvas: false to force software rasterization. See https://remotion.dev/docs/client-side-rendering/html-in-canvas',
);
} else if (outcome.shouldWarn) {
Internals.Log.warn(
@@ -315,8 +317,6 @@ const internalRenderMediaOnWeb = async <
return Promise.reject(new Error('renderMediaOnWeb() was cancelled'));
}
- const useHtmlInCanvas = await supportsNestedHtmlInCanvas();
-
using scaffold = createScaffold({
width: resolved.width,
height: resolved.height,
@@ -334,7 +334,7 @@ const internalRenderMediaOnWeb = async <
initialFrame: 0,
defaultCodec: resolved.defaultCodec,
defaultOutName: resolved.defaultOutName,
- useHtmlInCanvas,
+ useHtmlInCanvas: allowHtmlInCanvas,
pixelDensity: scale,
});
@@ -347,6 +347,30 @@ const internalRenderMediaOnWeb = async <
htmlInCanvasContext,
} = scaffold;
+ if (allowHtmlInCanvas && !htmlInCanvasContext) {
+ if (!supportsNativeHtmlInCanvas()) {
+ onHtmlInCanvasLayerOutcome({
+ native: false,
+ reason:
+ 'This browser does not expose CanvasRenderingContext2D.prototype.drawElementImage. In Chromium, enable chrome://flags/#canvas-draw-element and use a version that ships the API.',
+ shouldWarn: false,
+ });
+ } else {
+ onHtmlInCanvasLayerOutcome({
+ native: false,
+ reason:
+ 'drawElementImage is available but canvas.requestPaint() is missing. Use a Chromium version that ships requestPaint.',
+ shouldWarn: true,
+ });
+ }
+ } else if (!allowHtmlInCanvas) {
+ onHtmlInCanvasLayerOutcome({
+ native: false,
+ reason: 'allowHtmlInCanvas is false; using the built-in DOM composer.',
+ shouldWarn: false,
+ });
+ }
+
using internalState = makeInternalState({
signal,
maskImageTimeoutInMilliseconds: delayRenderTimeoutInMilliseconds,
@@ -531,7 +555,6 @@ const internalRenderMediaOnWeb = async <
? onHtmlInCanvasLayerOutcome
: undefined,
waitForPageResponsiveness,
- waitForRenderReady,
});
internalState.addCreateFrameTime(performance.now() - createFrameStart);
layerCanvas = layer.canvas;
@@ -774,6 +797,7 @@ export const renderMediaOnWeb = <
muted: options.muted ?? false,
scale: options.scale ?? 1,
isProduction: options.isProduction ?? true,
+ allowHtmlInCanvas: options.allowHtmlInCanvas ?? false,
sampleRate: options.sampleRate ?? 48000,
}),
);
diff --git a/packages/web-renderer/src/render-still-on-web.tsx b/packages/web-renderer/src/render-still-on-web.tsx
index 961d6b0b6a..34113e99a6 100644
--- a/packages/web-renderer/src/render-still-on-web.tsx
+++ b/packages/web-renderer/src/render-still-on-web.tsx
@@ -7,7 +7,7 @@ import type {$ZodObject} from 'zod/v4/core';
import type {WebRendererOnArtifact} from './artifact';
import {handleArtifacts} from './artifact';
import {checkForError, createScaffold} from './create-scaffold';
-import {supportsNestedHtmlInCanvas} from './html-in-canvas';
+import {supportsNativeHtmlInCanvas} from './html-in-canvas';
import {makeInternalState} from './internal-state';
import type {CompositionCalculateMetadataOrExplicit} from './props-if-has-props';
import type {InputPropsIfHasProps} from './render-media-on-web';
@@ -46,6 +46,7 @@ type OptionalRenderStillOnWebOptions<Schema extends $ZodObject> = {
licenseKey: string | null;
scale: number;
isProduction: boolean;
+ allowHtmlInCanvas: boolean;
};
type InternalRenderStillOnWebOptions<
@@ -78,6 +79,7 @@ async function internalRenderStillOnWeb<
licenseKey,
scale,
isProduction,
+ allowHtmlInCanvas,
}: InternalRenderStillOnWebOptions<Schema, Props>) {
validateScale(scale);
@@ -85,7 +87,7 @@ async function internalRenderStillOnWeb<
if (outcome.native) {
Internals.Log.warn(
{logLevel, tag: '@remotion/web-renderer'},
- 'Using Chromium experimental HTML-in-canvas (drawElementImage) for this frame. See https://remotion.dev/docs/client-side-rendering/html-in-canvas',
+ 'Using Chromium experimental HTML-in-canvas (drawElementImage) for this frame. Pixels may differ from the built-in DOM composer. Set allowHtmlInCanvas: false to force software rasterization. See https://remotion.dev/docs/client-side-rendering/html-in-canvas',
);
} else if (outcome.shouldWarn) {
Internals.Log.warn(
@@ -114,8 +116,6 @@ async function internalRenderStillOnWeb<
return Promise.reject(new Error('renderStillOnWeb() was cancelled'));
}
- const useHtmlInCanvas = await supportsNestedHtmlInCanvas();
-
using internalState = makeInternalState({
signal,
maskImageTimeoutInMilliseconds: delayRenderTimeoutInMilliseconds,
@@ -138,7 +138,7 @@ async function internalRenderStillOnWeb<
initialFrame: frame,
defaultCodec: resolved.defaultCodec,
defaultOutName: resolved.defaultOutName,
- useHtmlInCanvas,
+ useHtmlInCanvas: allowHtmlInCanvas,
pixelDensity: scale,
});
@@ -150,6 +150,30 @@ async function internalRenderStillOnWeb<
htmlInCanvasContext,
} = scaffold;
+ if (allowHtmlInCanvas && !htmlInCanvasContext) {
+ if (!supportsNativeHtmlInCanvas()) {
+ onHtmlInCanvasLayerOutcome({
+ native: false,
+ reason:
+ 'This browser does not expose CanvasRenderingContext2D.prototype.drawElementImage. In Chromium, enable chrome://flags/#canvas-draw-element and use a version that ships the API.',
+ shouldWarn: false,
+ });
+ } else {
+ onHtmlInCanvasLayerOutcome({
+ native: false,
+ reason:
+ 'drawElementImage is available but canvas.requestPaint() is missing. Use a Chromium version that ships requestPaint.',
+ shouldWarn: true,
+ });
+ }
+ } else if (!allowHtmlInCanvas) {
+ onHtmlInCanvasLayerOutcome({
+ native: false,
+ reason: 'allowHtmlInCanvas is false; using the built-in DOM composer.',
+ shouldWarn: false,
+ });
+ }
+
const artifactsHandler = handleArtifacts();
const waitForRenderReady = async () => {
await waitForReady({
@@ -186,7 +210,6 @@ async function internalRenderStillOnWeb<
? onHtmlInCanvasLayerOutcome
: undefined,
waitForPageResponsiveness: null,
- waitForRenderReady,
});
const {canvas} = capturedFrame;
@@ -253,6 +276,7 @@ export const renderStillOnWeb = <
licenseKey: options.licenseKey ?? null,
scale: options.scale ?? 1,
isProduction: options.isProduction ?? true,
+ allowHtmlInCanvas: options.allowHtmlInCanvas ?? false,
}),
);
diff --git a/packages/web-renderer/src/take-screenshot.ts b/packages/web-renderer/src/take-screenshot.ts
index 91df5bed30..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,
- waitForRenderReady,
}: {
element: HTMLElement | SVGElement;
scale: number;
@@ -34,7 +33,6 @@ export const createLayer = async ({
htmlInCanvasContext?: HtmlInCanvasContext | null;
onHtmlInCanvasLayerOutcome?: (outcome: HtmlInCanvasLayerOutcome) => void;
waitForPageResponsiveness: (() => Promise<void>) | null;
- waitForRenderReady: () => Promise<void>;
}) => {
const scaledWidth = Math.ceil(cutout.width * scale);
const scaledHeight = Math.ceil(cutout.height * scale);
@@ -52,17 +50,20 @@ export const createLayer = async ({
'URL masks are loaded by the built-in DOM composer to guarantee deterministic rendering.',
shouldWarn: false,
});
+ } else if (containsLayoutSubtreeCanvas(element)) {
+ onHtmlInCanvasLayerOutcome({
+ native: false,
+ reason:
+ 'The composition contains an <HtmlInCanvas> element. Nested HTML-in-canvas capture is unsupported, so the built-in DOM composer is used.',
+ shouldWarn: false,
+ });
} else {
- const hasNestedHtmlInCanvas = containsLayoutSubtreeCanvas(element);
-
try {
const offCtx = await drawWithHtmlInCanvas({
htmlInCanvasContext,
element,
scaledWidth,
scaledHeight,
- waitForRenderReady,
- useElementImage: hasNestedHtmlInCanvas,
});
onHtmlInCanvasLayerOutcome({native: true});
return offCtx;
diff --git a/packages/web-renderer/src/test/Root.tsx b/packages/web-renderer/src/test/Root.tsx
index d7c13b594b..1b16e93ba3 100644
--- a/packages/web-renderer/src/test/Root.tsx
+++ b/packages/web-renderer/src/test/Root.tsx
@@ -48,7 +48,6 @@ import {manyLayers} from './fixtures/many-layers';
import {maskImage} from './fixtures/mask-image';
import {maskImageUrl} from './fixtures/mask-image-url';
import {multiLevelTransformOrigins} from './fixtures/multi-level-transform-origins';
-import {nestedHtmlInCanvas} from './fixtures/nested-html-in-canvas';
import {nestedTranslateScale} from './fixtures/nested-translate-scale';
import {objectFit} from './fixtures/object-fit';
import {opacityInherited} from './fixtures/opacity-inherited';
@@ -133,7 +132,6 @@ export const Root: React.FC = () => {
<Composition {...hugeImageTransform} />
<Composition {...objectFit} />
<Composition {...nestedTranslateScale} />
- <Composition {...nestedHtmlInCanvas} />
<Composition {...scaledTranslatedSvg} />
<Composition {...svgExplicitDimensions} />
<Composition {...svgDataUri} />
diff --git a/packages/web-renderer/src/test/fixtures/nested-html-in-canvas.tsx b/packages/web-renderer/src/test/fixtures/nested-html-in-canvas.tsx
deleted file mode 100644
index 3b1da420bc..0000000000
--- a/packages/web-renderer/src/test/fixtures/nested-html-in-canvas.tsx
+++ /dev/null
@@ -1,77 +0,0 @@
-import {fisheye} from '@remotion/effects/fisheye';
-import {halftone} from '@remotion/effects/halftone';
-import {wave} from '@remotion/effects/wave';
-import {AbsoluteFill, HtmlInCanvas, useCurrentFrame} from 'remotion';
-
-const Component: React.FC = () => {
- const frame = useCurrentFrame();
-
- return (
- <HtmlInCanvas
- width={320}
- height={180}
- effects={[
- fisheye({
- fieldOfView: 2.3,
- radius: 0.95,
- zoom: 1,
- }),
- ]}
- >
- <AbsoluteFill
- style={{
- alignItems: 'center',
- backgroundColor: '#071426',
- backgroundImage:
- 'linear-gradient(rgba(90, 185, 255, 0.4) 1px, transparent 1px), linear-gradient(90deg, rgba(90, 185, 255, 0.4) 1px, transparent 1px)',
- backgroundSize: '16px 16px',
- justifyContent: 'center',
- }}
- >
- <HtmlInCanvas
- width={200}
- height={120}
- effects={[
- wave({
- amplitude: 10,
- phase: frame * 0.08,
- wavelength: 60,
- }),
- ]}
- >
- <AbsoluteFill
- style={{
- alignItems: 'center',
- backgroundColor: '#ffcc00',
- justifyContent: 'center',
- }}
- >
- <HtmlInCanvas
- width={100}
- height={60}
- effects={[
- halftone({
- colorMode: 'source',
- dotSize: 5,
- dotSpacing: 6,
- rotation: -8,
- }),
- ]}
- >
- <AbsoluteFill style={{backgroundColor: '#ff1744'}} />
- </HtmlInCanvas>
- </AbsoluteFill>
- </HtmlInCanvas>
- </AbsoluteFill>
- </HtmlInCanvas>
- );
-};
-
-export const nestedHtmlInCanvas = {
- component: Component,
- id: 'nested-html-in-canvas',
- width: 320,
- height: 180,
- fps: 30,
- durationInFrames: 5,
-} as const;
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 293a476d26..0b63736488 100644
--- a/packages/web-renderer/src/test/html-in-canvas.test.tsx
+++ b/packages/web-renderer/src/test/html-in-canvas.test.tsx
@@ -1,38 +1,56 @@
import {Internals} from 'remotion';
import {expect, test, vi} from 'vitest';
import {createScaffold} from '../create-scaffold';
-import {
- setForceDisableHtmlInCanvasForTesting,
- supportsNativeHtmlInCanvas,
- supportsNestedHtmlInCanvas,
-} from '../html-in-canvas';
-import {renderMediaOnWeb} from '../render-media-on-web';
+import {supportsNativeHtmlInCanvas} from '../html-in-canvas';
+import {makeInternalState} from '../internal-state';
import {renderStillOnWeb} from '../render-still-on-web';
import '../symbol-dispose';
-import {nestedHtmlInCanvas} from './fixtures/nested-html-in-canvas';
-import {testImage} from './utils';
-
-setForceDisableHtmlInCanvasForTesting(false);
-
-test('captures three nested HTML-in-canvas effect layers natively', async () => {
- const supportsNesting = await supportsNestedHtmlInCanvas();
- if (!supportsNesting) {
- return;
- }
+import {createLayer, type HtmlInCanvasLayerOutcome} from '../take-screenshot';
+import {backgroundColor} from './fixtures/background-color';
+test('uses the DOM composer by default', async () => {
+ const contextPrototype =
+ CanvasRenderingContext2D.prototype as CanvasRenderingContext2D & {
+ drawElementImage?: () => DOMMatrix;
+ };
+ const originalDrawElementImage = Object.getOwnPropertyDescriptor(
+ contextPrototype,
+ 'drawElementImage',
+ );
+ const originalRequestPaint = Object.getOwnPropertyDescriptor(
+ HTMLCanvasElement.prototype,
+ 'requestPaint',
+ );
+ Object.defineProperty(contextPrototype, 'drawElementImage', {
+ configurable: true,
+ value: () => new DOMMatrix(),
+ });
+ Object.defineProperty(HTMLCanvasElement.prototype, 'requestPaint', {
+ configurable: true,
+ value(this: HTMLCanvasElement) {
+ this.dispatchEvent(new Event('paint'));
+ },
+ });
const warn = vi
.spyOn(Internals.Log, 'warn')
.mockImplementation(() => undefined);
try {
- const nested = await renderStillOnWeb({
- composition: nestedHtmlInCanvas,
+ const result = await renderStillOnWeb({
+ composition: backgroundColor,
frame: 0,
inputProps: {},
licenseKey: 'free-license',
});
- const blob = await nested.blob({format: 'png'});
+ const canvas = await result.canvas();
+ const context = canvas.getContext('2d');
+ if (!context) {
+ throw new Error('Could not get canvas context');
+ }
+ expect(Array.from(context.getImageData(100, 100, 1, 1).data)).toEqual([
+ 255, 0, 0, 255,
+ ]);
expect(
warn.mock.calls.some((call) =>
call.some(
@@ -41,80 +59,120 @@ test('captures three nested HTML-in-canvas effect layers natively', async () =>
value.includes('Using Chromium experimental HTML-in-canvas'),
),
),
- ).toBe(true);
-
- await testImage({blob, testId: 'nested-html-in-canvas'});
+ ).toBe(false);
} finally {
warn.mockRestore();
+ if (originalDrawElementImage) {
+ Object.defineProperty(
+ contextPrototype,
+ 'drawElementImage',
+ originalDrawElementImage,
+ );
+ } else {
+ Reflect.deleteProperty(contextPrototype, 'drawElementImage');
+ }
+
+ if (originalRequestPaint) {
+ Object.defineProperty(
+ HTMLCanvasElement.prototype,
+ 'requestPaint',
+ originalRequestPaint,
+ );
+ } else {
+ Reflect.deleteProperty(HTMLCanvasElement.prototype, 'requestPaint');
+ }
}
});
-test('captures three nested HTML-in-canvas effect layers across video frames', async () => {
- const supportsNesting = await supportsNestedHtmlInCanvas();
- if (!supportsNesting) {
+test('uses native HTML-in-canvas only when explicitly enabled', async () => {
+ if (!supportsNativeHtmlInCanvas()) {
return;
}
- await renderMediaOnWeb({
- composition: nestedHtmlInCanvas,
- inputProps: {},
- licenseKey: 'free-license',
- muted: true,
- });
-});
+ const warn = vi
+ .spyOn(Internals.Log, 'warn')
+ .mockImplementation(() => undefined);
-test('retries a transient missing nested paint record during a client-side render', async () => {
- const supportsNesting = await supportsNestedHtmlInCanvas();
- if (!supportsNesting) {
- return;
+ try {
+ const result = await renderStillOnWeb({
+ allowHtmlInCanvas: true,
+ composition: backgroundColor,
+ frame: 0,
+ inputProps: {},
+ licenseKey: 'free-license',
+ });
+ await result.canvas();
+
+ expect(
+ warn.mock.calls.some((call) =>
+ call.some(
+ (value) =>
+ typeof value === 'string' &&
+ value.includes('Using Chromium experimental HTML-in-canvas'),
+ ),
+ ),
+ ).toBe(true);
+ } finally {
+ warn.mockRestore();
}
+});
- const descriptor = Object.getOwnPropertyDescriptor(
- HTMLCanvasElement.prototype,
- 'captureElementImage',
- );
- if (!descriptor || typeof descriptor.value !== 'function') {
- throw new Error('Expected captureElementImage() to be available');
+test('does not create a nested HTML-in-canvas capture', async () => {
+ const element = document.createElement('div');
+ const nestedLayoutCanvas = document.createElement(
+ 'canvas',
+ ) as HTMLCanvasElement & {
+ layoutSubtree?: boolean;
+ };
+ nestedLayoutCanvas.layoutSubtree = true;
+ element.appendChild(nestedLayoutCanvas);
+ document.body.appendChild(element);
+
+ const outerLayoutCanvas = document.createElement('canvas');
+ const context = outerLayoutCanvas.getContext('2d');
+ if (!context) {
+ throw new Error('Could not get canvas context');
}
- const originalCapture = descriptor.value as (
- this: HTMLCanvasElement,
- element: Element,
- ) => ElementImage;
- let simulatedMissingRecord = false;
-
- Object.defineProperty(HTMLCanvasElement.prototype, 'captureElementImage', {
- ...descriptor,
- value(this: HTMLCanvasElement, element: Element) {
- const ancestorCanvas = this.parentElement?.closest('canvas');
- if (!simulatedMissingRecord && ancestorCanvas) {
- simulatedMissingRecord = true;
- throw new DOMException(
- 'No cached paint record for element',
- 'InvalidStateError',
- );
- }
-
- return originalCapture.call(this, element);
- },
+ const drawElementImage = vi.fn();
+ Object.assign(context, {drawElementImage});
+ let outcome: HtmlInCanvasLayerOutcome | null = null;
+ const internalState = makeInternalState({
+ signal: null,
+ maskImageTimeoutInMilliseconds: 30_000,
});
try {
- await renderMediaOnWeb({
- composition: nestedHtmlInCanvas,
- inputProps: {},
- licenseKey: 'free-license',
- muted: true,
+ await createLayer({
+ cutout: new DOMRect(0, 0, 10, 10),
+ element,
+ htmlInCanvasContext: {
+ ctx: context as CanvasRenderingContext2D & {
+ drawElementImage: typeof drawElementImage;
+ },
+ layoutCanvas: outerLayoutCanvas,
+ },
+ internalState,
+ logLevel: 'error',
+ onHtmlInCanvasLayerOutcome: (newOutcome) => {
+ outcome = newOutcome;
+ },
+ onlyBackgroundClipText: false,
+ scale: 1,
+ waitForPageResponsiveness: null,
+ });
+
+ expect(drawElementImage).not.toHaveBeenCalled();
+ expect(outcome).toEqual({
+ native: false,
+ reason:
+ 'The composition contains an <HtmlInCanvas> element. Nested HTML-in-canvas capture is unsupported, so the built-in DOM composer is used.',
+ shouldWarn: false,
});
} finally {
- Object.defineProperty(
- HTMLCanvasElement.prototype,
- 'captureElementImage',
- descriptor,
- );
+ internalState[Symbol.dispose]();
+ element.remove();
}
-
- expect(simulatedMissingRecord).toBe(true);
});
test('keeps a scaffold without HTML-in-canvas hidden', () => {
@@ -196,39 +254,3 @@ test('keeps the DOM composer scaffold paintable', () => {
scaffold[Symbol.dispose]();
}
});
-
-test('uses the DOM composer when native HTML-in-canvas does not support nesting', async () => {
- if (!supportsNativeHtmlInCanvas()) {
- return;
- }
-
- setForceDisableHtmlInCanvasForTesting(true);
- const warn = vi
- .spyOn(Internals.Log, 'warn')
- .mockImplementation(() => undefined);
-
- try {
- const result = await renderStillOnWeb({
- composition: nestedHtmlInCanvas,
- frame: 0,
- inputProps: {},
- licenseKey: 'free-license',
- });
-
- expect(
- warn.mock.calls.some((call) =>
- call.some(
- (value) =>
- typeof value === 'string' &&
- value.includes('Using Chromium experimental HTML-in-canvas'),
- ),
- ),
- ).toBe(false);
-
- const blob = await result.blob({format: 'png'});
- await testImage({blob, testId: 'nested-html-in-canvas'});
- } finally {
- setForceDisableHtmlInCanvasForTesting(false);
- warn.mockRestore();
- }
-});
diff --git a/packages/web-renderer/src/test/setup.ts b/packages/web-renderer/src/test/setup.ts
deleted file mode 100644
index 91c93906e4..0000000000
--- a/packages/web-renderer/src/test/setup.ts
+++ /dev/null
@@ -1,5 +0,0 @@
-import {setForceDisableHtmlInCanvasForTesting} from '../html-in-canvas';
-
-// Screenshot tests cover Remotion's built-in DOM composer. Chromium's native
-// HTML-in-canvas implementation has separate, explicitly opted-in tests.
-setForceDisableHtmlInCanvasForTesting(true);