Skip to content

🎥 Make videos programmatically with React

`@remotion/web-renderer`: Add Mediabunny `Quality` inputs to `renderMediaOnWeb()`

JonnyBurger12dd72039226
diff --git a/packages/docs/docs/web-renderer/can-render-media-on-web.mdx b/packages/docs/docs/web-renderer/can-render-media-on-web.mdx
index cb56b9d487..84b5f08ca6 100644
--- a/packages/docs/docs/web-renderer/can-render-media-on-web.mdx
+++ b/packages/docs/docs/web-renderer/can-render-media-on-web.mdx
@@ -95,12 +95,15 @@ If `true`, audio codec checks are skipped. Default is `false`.
### `videoBitrate?`
-_number | string_ <TsType type="WebRendererQuality" source="@remotion/web-renderer" />
+_number | string | Quality_ <TsType type="WebRendererQuality" source="@remotion/web-renderer" />
The video bitrate. Can be a number (bits per second) or a quality preset: `"very-low"`, `"low"`, `"medium"`, `"high"`, `"very-high"`.
Default is `"medium"`.
+Since <AvailableFrom v="4.0.535" inline />, you can also pass a [Mediabunny `Quality` instance](/docs/web-renderer/render-media-on-web#mediabunny-quality).
+Pass the same value to [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web) so the support check uses the requested encoding settings.
+
### `audioBitrate?`
_number | string_ <TsType type="WebRendererQuality" source="@remotion/web-renderer" />
diff --git a/packages/docs/docs/web-renderer/get-encodable-video-codecs.mdx b/packages/docs/docs/web-renderer/get-encodable-video-codecs.mdx
index b5415ba3ee..ef6f33adf3 100644
--- a/packages/docs/docs/web-renderer/get-encodable-video-codecs.mdx
+++ b/packages/docs/docs/web-renderer/get-encodable-video-codecs.mdx
@@ -34,10 +34,13 @@ Optional configuration object.
#### `videoBitrate?`
-_number | string_ <TsType type="WebRendererQuality" source="@remotion/web-renderer" />
+_number | string | Quality_ <TsType type="WebRendererQuality" source="@remotion/web-renderer" />
A number (bits per second) or quality preset (`"very-low"`, `"low"`, `"medium"`, `"high"`, `"very-high"`).
+Since <AvailableFrom v="4.0.535" inline />, you can also pass a [Mediabunny `Quality` instance](/docs/web-renderer/render-media-on-web#mediabunny-quality).
+Pass the same value to [`renderMediaOnWeb()`](/docs/web-renderer/render-media-on-web) so the support check uses the requested encoding settings.
+
## Return value
Returns a `Promise<WebRendererVideoCodec[]>` - an array of video codec identifiers that the browser can encode.
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 bf8dfca293..47de27e1f3 100644
--- a/packages/docs/docs/web-renderer/render-media-on-web.mdx
+++ b/packages/docs/docs/web-renderer/render-media-on-web.mdx
@@ -137,7 +137,7 @@ This option is best effort. Long synchronous browser or graphics operations may
### `videoBitrate?`
-_number | string_ <TsType type="WebRendererQuality" source="@remotion/web-renderer" href="/docs/web-renderer/types#webrendererquality" />
+_number | string | Quality_ <TsType type="WebRendererQuality" source="@remotion/web-renderer" href="/docs/web-renderer/types#webrendererquality" />
Controls the quality and file size of the output video. Can be either a number representing the bitrate in bits per second, or one of the preset quality levels:
@@ -147,6 +147,37 @@ Controls the quality and file size of the output video. Can be either a number r
- `"high"`: Larger file size, higher quality
- `"very-high"`: Largest file size, highest quality
+#### Mediabunny `Quality`<AvailableFrom v="4.0.535" />
+
+Pass a [Mediabunny `Quality`](https://mediabunny.dev/guide/media-sources#encoding-quality) instance to control encoding settings directly.
+String presets use bitrate encoding. To prefer quantizer encoding, pass a `Quality` with `preferBitrate: false`:
+
+```tsx twoslash title="Use quantizer encoding"
+const Component: React.FC = () => null;
+
+// ---cut---
+import {renderMediaOnWeb} from '@remotion/web-renderer';
+import {Quality} from 'mediabunny';
+
+await renderMediaOnWeb({
+ composition: {
+ component: Component,
+ durationInFrames: 100,
+ fps: 30,
+ width: 1920,
+ height: 1080,
+ id: 'my-composition',
+ },
+ videoBitrate: new Quality({quality: 'high', preferBitrate: false}),
+});
+```
+
+Quantizer encoding lets the bitrate vary with the content and can produce substantially larger files.
+Mediabunny falls back to bitrate encoding if the browser reports that quantizer encoding is unsupported.
+A browser may accept the configuration but still fail during encoding or introduce a large startup delay. See [known WebCodecs issues](/docs/mediabunny/webcodecs-bugs).
+
+Pass the same `Quality` instance to [`canRenderMediaOnWeb()`](/docs/web-renderer/can-render-media-on-web) or [`getEncodableVideoCodecs()`](/docs/web-renderer/get-encodable-video-codecs) when checking support.
+
### `hardwareAcceleration?`
_"no-preference" | "prefer-hardware" | "prefer-software"_
diff --git a/packages/web-renderer/src/can-render-types.ts b/packages/web-renderer/src/can-render-types.ts
index a604c20ecd..c9da8a3741 100644
--- a/packages/web-renderer/src/can-render-types.ts
+++ b/packages/web-renderer/src/can-render-types.ts
@@ -1,3 +1,4 @@
+import type {Quality} from 'mediabunny';
import type {
WebRendererAudioCodec,
WebRendererContainer,
@@ -39,7 +40,7 @@ export type CanRenderMediaOnWebOptions = {
scale?: number;
transparent?: boolean;
muted?: boolean;
- videoBitrate?: number | WebRendererQuality;
+ videoBitrate?: number | WebRendererQuality | Quality;
audioBitrate?: number | WebRendererQuality;
outputTarget?: WebRendererOutputTarget | null;
};
diff --git a/packages/web-renderer/src/get-encodable-codecs.ts b/packages/web-renderer/src/get-encodable-codecs.ts
index 40db99131f..395fe8268e 100644
--- a/packages/web-renderer/src/get-encodable-codecs.ts
+++ b/packages/web-renderer/src/get-encodable-codecs.ts
@@ -1,6 +1,7 @@
import {
getEncodableAudioCodecs as mediabunnyGetEncodableAudioCodecs,
getEncodableVideoCodecs as mediabunnyGetEncodableVideoCodecs,
+ type Quality,
} from 'mediabunny';
import {
codecToMediabunnyCodec,
@@ -17,7 +18,7 @@ import {ensureFlacEncoderRegistered} from './register-flac-encoder';
import {ensureMp3EncoderRegistered} from './register-mp3-encoder';
export type GetEncodableVideoCodecsOptions = {
- videoBitrate?: number | WebRendererQuality;
+ videoBitrate?: number | WebRendererQuality | Quality;
};
export type GetEncodableAudioCodecsOptions = {
diff --git a/packages/web-renderer/src/mediabunny-mappings.ts b/packages/web-renderer/src/mediabunny-mappings.ts
index a137715d0b..ba866d774b 100644
--- a/packages/web-renderer/src/mediabunny-mappings.ts
+++ b/packages/web-renderer/src/mediabunny-mappings.ts
@@ -136,8 +136,12 @@ export const getDefaultContainerForCodec = (
};
export const getQualityForWebRendererQuality = (
- quality: WebRendererQuality,
+ quality: WebRendererQuality | Quality,
): Quality => {
+ if (quality instanceof Quality) {
+ return quality;
+ }
+
return new Quality({quality, preferBitrate: true});
};
diff --git a/packages/web-renderer/src/render-media-on-web.tsx b/packages/web-renderer/src/render-media-on-web.tsx
index 6bcecf3bfa..b36d7f758a 100644
--- a/packages/web-renderer/src/render-media-on-web.tsx
+++ b/packages/web-renderer/src/render-media-on-web.tsx
@@ -2,6 +2,7 @@ import {
BufferTarget,
StreamTarget,
type MetadataTags,
+ type Quality,
type StreamTargetChunk,
} from 'mediabunny';
import type {CalculateMetadataFunction} from 'remotion';
@@ -132,7 +133,7 @@ type OptionalRenderMediaOnWebOptions<Schema extends $ZodObject> = {
onProgress: RenderMediaOnWebProgressCallback | null;
hardwareAcceleration: WebRendererHardwareAcceleration;
keyframeIntervalInSeconds: number;
- videoBitrate: number | WebRendererQuality;
+ videoBitrate: number | WebRendererQuality | Quality;
frameRange: FrameRange | null;
transparent: boolean;
onArtifact: WebRendererOnArtifact | null;