Skip to content

🎥 Make videos programmatically with React

`@remotion/lambda`: Default to veryfast in Remotion 5.0 (#10650)

Jonny Burger28df56b39f2f
diff --git a/packages/docs/docs/5-0-migration.mdx b/packages/docs/docs/5-0-migration.mdx
index cbd5081542..2027848add 100644
--- a/packages/docs/docs/5-0-migration.mdx
+++ b/packages/docs/docs/5-0-migration.mdx
@@ -107,6 +107,12 @@ The default value of `overwrite` in [`renderMediaOnLambda()`](/docs/lambda/rende
**Required action**: Set `overwrite: false` if an existing file should still cause an error.
+## `veryfast` is now the default x264 preset on Lambda
+
+The default [`x264Preset`](/docs/lambda/rendermediaonlambda#x264preset) for H.264 Lambda renders has changed from `medium` to `veryfast`. This reduces encoding time and Lambda costs.
+
+**Required action**: Set `x264Preset: "medium"` or pass `--x264-preset=medium` to keep the previous behavior.
+
## `openBrowser()` now takes a `logLevel` instead of `shouldDumpIo`
The `shouldDumpIo` option has been be removed in 5.0.
@@ -205,4 +211,4 @@ There are two effective changes in this license:
- **Contractors now also count towards team size.** Previously, a company could work exclusively with contractors and never have to get a company license.
- **The license is tied to our updated [terms and conditions](/docs/terms)**.
Previously, our terms were generated by a Terms and conditions generator and did not make sense.
- We wrote terms and conditions that reflect our long-standing policies, with the exception of changes mentioned above.
\ No newline at end of file
+ We wrote terms and conditions that reflect our long-standing policies, with the exception of changes mentioned above.
diff --git a/packages/docs/docs/lambda/rendermediaonlambda.mdx b/packages/docs/docs/lambda/rendermediaonlambda.mdx
index e4eeec1cbc..85692610f0 100644
--- a/packages/docs/docs/lambda/rendermediaonlambda.mdx
+++ b/packages/docs/docs/lambda/rendermediaonlambda.mdx
@@ -183,6 +183,8 @@ See [`renderMedia() -> proResProfile`](/docs/renderer/render-media#proresprofile
<Options id="x264-preset" />
+Starting in Remotion 5.0, the default for H.264 Lambda renders is `veryfast`. In Remotion 4.0, the default is `medium`.
+
### `gopSize?`<AvailableFrom v="4.0.466" />
<Options id="gop" />
diff --git a/packages/lambda/src/functions/aws-server-implementation.ts b/packages/lambda/src/functions/aws-server-implementation.ts
index f9905141ec..62b6b5c304 100644
--- a/packages/lambda/src/functions/aws-server-implementation.ts
+++ b/packages/lambda/src/functions/aws-server-implementation.ts
@@ -5,6 +5,7 @@ import {
getBrowserInstanceImplementation,
invokeWebhook,
} from '@remotion/serverless';
+import {NoReactInternals} from 'remotion/no-react';
import {deleteTmpDir} from './helpers/clean-tmpdir';
import {getCurrentRegionInFunctionImplementation} from './helpers/get-current-region';
import {getFolderFiles} from './helpers/get-folder-files';
@@ -12,6 +13,9 @@ import {makeAwsArtifact} from './helpers/make-aws-artifact';
import {timer} from './helpers/timer';
export const serverAwsImplementation: InsideFunctionSpecifics<AwsProvider> = {
+ defaultX264Preset: NoReactInternals.ENABLE_V5_BREAKING_CHANGES
+ ? 'veryfast'
+ : null,
forgetBrowserEventLoop: forgetBrowserEventLoopImplementation,
getBrowserInstance: getBrowserInstanceImplementation,
timer,
diff --git a/packages/lambda/src/test/mock-implementation.ts b/packages/lambda/src/test/mock-implementation.ts
index c5609af821..7a498c5341 100644
--- a/packages/lambda/src/test/mock-implementation.ts
+++ b/packages/lambda/src/test/mock-implementation.ts
@@ -11,6 +11,7 @@ import type {
InvokeWebhookParams,
} from '@remotion/serverless';
import {Log} from '../cli/log';
+import {serverAwsImplementation} from '../functions/aws-server-implementation';
import {mockBundleSite} from './mocks/mock-bundle-site';
import {mockCreateFunction} from './mocks/mock-create-function';
import {mockReadDirectory} from './mocks/mock-read-dir';
@@ -33,6 +34,7 @@ export const getBrowserInstance: GetBrowserInstance = async ({
const paramsArray: InvokeWebhookParams[] = [];
export const mockServerImplementation: InsideFunctionSpecifics<AwsProvider> = {
+ defaultX264Preset: serverAwsImplementation.defaultX264Preset,
forgetBrowserEventLoop: ({launchedBrowser}) => {
browsersOpen.delete(launchedBrowser.instance.id);
diff --git a/packages/lambda/src/test/unit/x264-preset-default.test.ts b/packages/lambda/src/test/unit/x264-preset-default.test.ts
new file mode 100644
index 0000000000..dfeb2251be
--- /dev/null
+++ b/packages/lambda/src/test/unit/x264-preset-default.test.ts
@@ -0,0 +1,119 @@
+import {expect, test} from 'bun:test';
+import type {AwsProvider} from '@remotion/lambda-client';
+import type {
+ ProviderSpecifics,
+ ServerlessPayload,
+ ServerlessStartPayload,
+} from '@remotion/serverless';
+import {ServerlessRoutines, startHandler, VERSION} from '@remotion/serverless';
+import {NoReactInternals} from 'remotion/no-react';
+import {serverAwsImplementation} from '../../functions/aws-server-implementation';
+import {mockServerImplementation} from '../mock-implementation';
+import {mockImplementation} from '../mocks/mock-implementation';
+
+const makeStartPayload = ({
+ codec,
+ x264Preset,
+}: Pick<ServerlessStartPayload<AwsProvider>, 'codec' | 'x264Preset'>) => {
+ return {
+ type: ServerlessRoutines.start,
+ rendererFunctionName: null,
+ serveUrl: 'https://example.com',
+ composition: 'test-composition',
+ framesPerLambda: null,
+ concurrency: null,
+ inputProps: {type: 'payload', payload: '{}'},
+ codec,
+ audioCodec: null,
+ imageFormat: 'jpeg',
+ crf: null,
+ envVariables: {},
+ pixelFormat: null,
+ proResProfile: null,
+ x264Preset,
+ gopSize: null,
+ jpegQuality: 80,
+ maxRetries: 1,
+ privacy: 'public',
+ logLevel: 'error',
+ frameRange: null,
+ outName: null,
+ timeoutInMilliseconds: 30_000,
+ chromiumOptions: {},
+ scale: 1,
+ everyNthFrame: 1,
+ numberOfGifLoops: null,
+ concurrencyPerLambda: 1,
+ downloadBehavior: {type: 'play-in-browser'},
+ muted: false,
+ version: VERSION,
+ overwrite: true,
+ audioBitrate: null,
+ videoBitrate: null,
+ encodingMaxRate: null,
+ encodingBufferSize: null,
+ webhook: null,
+ forceHeight: null,
+ forceWidth: null,
+ forceFps: null,
+ forceDurationInFrames: null,
+ bucketName: 'test-bucket',
+ offthreadVideoCacheSizeInBytes: null,
+ offthreadVideoThreads: null,
+ mediaCacheSizeInBytes: null,
+ deleteAfter: null,
+ colorSpace: null,
+ preferLossless: false,
+ forcePathStyle: false,
+ metadata: null,
+ licenseKey: null,
+ storageClass: null,
+ isProduction: true,
+ sampleRate: 48_000,
+ } satisfies ServerlessStartPayload<AwsProvider>;
+};
+
+test('resolves the Lambda x264 preset at the runtime boundary', async () => {
+ const launchedPayloads: ServerlessPayload<AwsProvider>[] = [];
+ const providerSpecifics = {
+ ...mockImplementation,
+ callFunctionAsync: ({payload}) => {
+ launchedPayloads.push(payload);
+ return Promise.resolve();
+ },
+ } satisfies ProviderSpecifics<AwsProvider>;
+
+ for (const payload of [
+ makeStartPayload({codec: 'h264', x264Preset: null}),
+ makeStartPayload({codec: 'h264', x264Preset: 'medium'}),
+ makeStartPayload({codec: 'vp8', x264Preset: null}),
+ ]) {
+ await startHandler({
+ params: payload,
+ options: {
+ expectedBucketOwner: '123456789012',
+ timeoutInMilliseconds: 120_000,
+ renderId: 'test-render',
+ },
+ providerSpecifics,
+ insideFunctionSpecifics: mockServerImplementation,
+ });
+ }
+
+ const launchPayloads = launchedPayloads.map((payload) => {
+ if (payload.type !== ServerlessRoutines.launch) {
+ throw new Error('Expected a launch payload');
+ }
+
+ return payload;
+ });
+
+ expect(serverAwsImplementation.defaultX264Preset).toBe(
+ NoReactInternals.ENABLE_V5_BREAKING_CHANGES ? 'veryfast' : null,
+ );
+ expect(launchPayloads[0].x264Preset).toBe(
+ NoReactInternals.ENABLE_V5_BREAKING_CHANGES ? 'veryfast' : null,
+ );
+ expect(launchPayloads[1].x264Preset).toBe('medium');
+ expect(launchPayloads[2].x264Preset).toBe(null);
+});
diff --git a/packages/serverless/src/handlers/start.ts b/packages/serverless/src/handlers/start.ts
index ca7fa4bd65..d638d6790c 100644
--- a/packages/serverless/src/handlers/start.ts
+++ b/packages/serverless/src/handlers/start.ts
@@ -95,7 +95,11 @@ export const startHandler = async <Provider extends CloudProvider>({
envVariables: params.envVariables,
pixelFormat: params.pixelFormat ?? null,
proResProfile: params.proResProfile ?? null,
- x264Preset: params.x264Preset,
+ x264Preset:
+ params.x264Preset ??
+ (params.codec === 'h264'
+ ? insideFunctionSpecifics.defaultX264Preset
+ : null),
gopSize: params.gopSize ?? null,
jpegQuality: params.jpegQuality,
maxRetries: params.maxRetries,
diff --git a/packages/serverless/src/provider-implementation.ts b/packages/serverless/src/provider-implementation.ts
index 48c986c4b3..cc4651a451 100644
--- a/packages/serverless/src/provider-implementation.ts
+++ b/packages/serverless/src/provider-implementation.ts
@@ -3,6 +3,7 @@ import type {
ChromiumOptions,
EmittedArtifact,
LogLevel,
+ X264Preset,
} from '@remotion/renderer';
import type {
CloudProvider,
@@ -119,6 +120,7 @@ export type InvokeWebhookParams = {
export type InvokeWebhook = (params: InvokeWebhookParams) => Promise<void>;
export type InsideFunctionSpecifics<Provider extends CloudProvider> = {
+ defaultX264Preset: X264Preset | null;
getBrowserInstance: GetBrowserInstance;
forgetBrowserEventLoop: ForgetBrowserEventLoop;
timer: DebuggingTimer;