[pull] main from remotion-dev:main

packages/cli/src/benchmark.ts

@@ -24,8 +24,6 @@ import {shouldUseNonOverlayingLogger} from './should-use-non-overlaying-logger';
 import {showMultiCompositionsPicker} from './show-compositions-picker';
 import {truthy} from './truthy';
 
-const DEFAULT_RUNS = 3;
-
 const {
 	audioBitrateOption,
 	x264Option,
@@ -67,6 +65,13 @@ const {
 	userAgentOption,
 	disableWebSecurityOption,
 	ignoreCertificateErrorsOption,
+	concurrencyOption,
+	overrideHeightOption,
+	overrideWidthOption,
+	overrideFpsOption,
+	overrideDurationOption,
+	bundleCacheOption,
+	runsOption,
 } = BrowserSafeApis.options;
 
 const getValidConcurrency = (cliConcurrency: number | string | null) => {
@@ -182,7 +187,7 @@ export const benchmarkCommand = async (
 	args: string[],
 	logLevel: LogLevel,
 ) => {
-	const runs: number = parsedCli.runs ?? DEFAULT_RUNS;
+	const runs = runsOption.getValue({commandLine: parsedCli}).value;
 
 	const {file, reason, remainingArgs} = findEntryPoint({
 		args,
@@ -209,17 +214,26 @@ export const benchmarkCommand = async (
 		envVariables,
 		frameRange: defaultFrameRange,
 		ffmpegOverride,
-		height,
-		width,
-		fps,
-		durationInFrames,
-		concurrency: unparsedConcurrency,
 	} = getCliOptions({
 		isStill: false,
 		logLevel,
 		indent: false,
 	});
 
+	const unparsedConcurrency = concurrencyOption.getValue({
+		commandLine: parsedCli,
+	}).value;
+	const height = overrideHeightOption.getValue({
+		commandLine: parsedCli,
+	}).value;
+	const width = overrideWidthOption.getValue({
+		commandLine: parsedCli,
+	}).value;
+	const fps = overrideFpsOption.getValue({commandLine: parsedCli}).value;
+	const durationInFrames = overrideDurationOption.getValue({
+		commandLine: parsedCli,
+	}).value;
+
 	const pixelFormat = pixelFormatOption.getValue({
 		commandLine: parsedCli,
 	}).value;
@@ -266,6 +280,9 @@ export const benchmarkCommand = async (
 	const keyboardShortcutsEnabled = keyboardShortcutsOption.getValue({
 		commandLine: parsedCli,
 	}).value;
+	const shouldCache = bundleCacheOption.getValue({
+		commandLine: parsedCli,
+	}).value;
 
 	if (experimentalClientSideRenderingEnabled) {
 		Log.warn(
@@ -338,6 +355,7 @@ export const benchmarkCommand = async (
 			experimentalClientSideRenderingEnabled,
 			askAIEnabled,
 			keyboardShortcutsEnabled,
+			shouldCache,
 		});
 
 	registerCleanupJob(`Deleting bundle`, () => cleanupBundle());

packages/cli/src/bundle.ts

@@ -21,6 +21,8 @@ const {
 	askAIOption,
 	experimentalClientSideRenderingOption,
 	keyboardShortcutsOption,
+	outDirOption,
+	bundleCacheOption,
 } = BrowserSafeApis.options;
 
 export const bundleCommand = async (
@@ -73,6 +75,9 @@ export const bundleCommand = async (
 	const keyboardShortcutsEnabled = keyboardShortcutsOption.getValue({
 		commandLine: parsedCli,
 	}).value;
+	const shouldCache = bundleCacheOption.getValue({
+		commandLine: parsedCli,
+	}).value;
 
 	if (experimentalClientSideRenderingEnabled) {
 		Log.warn(
@@ -90,8 +95,9 @@ export const bundleCommand = async (
 		commandLine: parsedCli,
 	}).value;
 
-	const outputPath = parsedCli['out-dir']
-		? path.resolve(process.cwd(), parsedCli['out-dir'])
+	const outDir = outDirOption.getValue({commandLine: parsedCli}).value;
+	const outputPath = outDir
+		? path.resolve(process.cwd(), outDir)
 		: path.join(remotionRoot, 'build');
 
 	const gitignoreFolder = BundlerInternals.findClosestFolderWithItem(
@@ -160,6 +166,7 @@ export const bundleCommand = async (
 		experimentalClientSideRenderingEnabled,
 		askAIEnabled,
 		keyboardShortcutsEnabled,
+		shouldCache,
 	});
 
 	Log.info(

packages/cli/src/compositions.ts

@@ -33,6 +33,7 @@ const {
 	userAgentOption,
 	disableWebSecurityOption,
 	ignoreCertificateErrorsOption,
+	bundleCacheOption,
 } = BrowserSafeApis.options;
 
 export const listCompositionsCommand = async (
@@ -135,6 +136,9 @@ export const listCompositionsCommand = async (
 	const keyboardShortcutsEnabled = keyboardShortcutsOption.getValue({
 		commandLine: parsedCli,
 	}).value;
+	const shouldCache = bundleCacheOption.getValue({
+		commandLine: parsedCli,
+	}).value;
 
 	if (experimentalClientSideRenderingEnabled) {
 		Log.warn(
@@ -168,6 +172,7 @@ export const listCompositionsCommand = async (
 			experimentalClientSideRenderingEnabled,
 			askAIEnabled,
 			keyboardShortcutsEnabled,
+			shouldCache,
 		});
 
 	registerCleanupJob(`Cleanup bundle`, () => cleanupBundle());

packages/cli/src/config/index.ts

@@ -38,24 +38,17 @@ import {
 } from './buffer-state-delay-in-milliseconds';
 import type {Concurrency} from './concurrency';
 import {getEntryPoint, setEntryPoint} from './entry-point';
-import {setDotEnvLocation} from './env-file';
 import {
 	getFfmpegOverrideFunction,
 	setFfmpegOverrideFunction,
 } from './ffmpeg-override';
 import {setFrameRange} from './frame-range';
-import {setImageSequence} from './image-sequence';
 import {getMetadata, setMetadata} from './metadata';
-import {getShouldOpenBrowser, setShouldOpenBrowser} from './open-browser';
 import {setOutputLocation} from './output-location';
 import type {WebpackOverrideFn} from './override-webpack';
 import {overrideWebpackConfig} from './override-webpack';
 import {setPort, setRendererPort, setStudioPort} from './preview-server';
-import {setWebpackCaching} from './webpack-caching';
-import {
-	getWebpackPolling,
-	setWebpackPollingInMilliseconds,
-} from './webpack-poll';
+import {getWebpackPolling} from './webpack-poll';
 
 export type {Concurrency, WebpackConfiguration, WebpackOverrideFn};
 
@@ -119,6 +112,13 @@ const {
 	overrideWidthOption,
 	overrideFpsOption,
 	overrideDurationOption,
+	outDirOption,
+	webpackPollOption,
+	imageSequenceOption,
+	bundleCacheOption,
+	envFileOption,
+	runsOption,
+	noOpenOption,
 } = BrowserSafeApis.options;
 
 declare global {
@@ -587,10 +587,20 @@ type FlatConfig = RemotionConfigObject &
 		 * Default: false
 		 */
 		setIPv4: (ipv4: boolean) => void;
+		/**
+		 * Define the output directory for `npx remotion bundle`.
+		 * Default: `build` in the Remotion root.
+		 */
+		setBundleOutDir: (outDir: string | null) => void;
 		/**
 		 * Choose between using Chrome Headless Shell or Chrome for Testing
 		 */
 		setChromeMode: (chromeMode: ChromeMode) => void;
+		/**
+		 * Set how many times the video should be rendered during a benchmark.
+		 * Default: 3
+		 */
+		setBenchmarkRuns: (runs: number) => void;
 		/**
 		 * @deprecated 'The config format has changed. Change `Config.Bundling.*()` calls to `Config.*()` in your config file.'
 		 */
@@ -653,11 +663,11 @@ export const Config: FlatConfig = {
 	setExperimentalClientSideRenderingEnabled:
 		experimentalClientSideRenderingOption.setConfig,
 	setNumberOfSharedAudioTags: numberOfSharedAudioTagsOption.setConfig,
-	setWebpackPollingInMilliseconds,
-	setShouldOpenBrowser,
+	setWebpackPollingInMilliseconds: webpackPollOption.setConfig,
+	setShouldOpenBrowser: noOpenOption.setConfig,
 	setBufferStateDelayInMilliseconds,
 	overrideWebpackConfig,
-	setCachingEnabled: setWebpackCaching,
+	setCachingEnabled: bundleCacheOption.setConfig,
 	setPort,
 	setStudioPort,
 	setRendererPort,
@@ -673,7 +683,7 @@ export const Config: FlatConfig = {
 	setChromiumHeadlessMode: headlessOption.setConfig,
 	setChromiumOpenGlRenderer: glOption.setConfig,
 	setChromiumUserAgent: userAgentOption.setConfig,
-	setDotEnvLocation,
+	setDotEnvLocation: envFileOption.setConfig,
 	setConcurrency: concurrencyOption.setConfig,
 	setChromiumMultiProcessOnLinux: enableMultiprocessOnLinuxOption.setConfig,
 	setChromiumDarkMode: darkModeOption.setConfig,
@@ -705,7 +715,7 @@ export const Config: FlatConfig = {
 	setPixelFormat: pixelFormatOption.setConfig,
 	setCodec: videoCodecOption.setConfig,
 	setCrf: crfOption.setConfig,
-	setImageSequence,
+	setImageSequence: imageSequenceOption.setConfig,
 	setProResProfile: proResProfileOption.setConfig,
 	setX264Preset: x264Option.setConfig,
 	setAudioBitrate: audioBitrateOption.setConfig,
@@ -718,9 +728,8 @@ export const Config: FlatConfig = {
 	overrideDuration: overrideDurationOption.setConfig,
 	overrideFfmpegCommand: setFfmpegOverrideFunction,
 	setAudioCodec: audioCodecOption.setConfig,
-	setOffthreadVideoCacheSizeInBytes: (size) => {
-		offthreadVideoCacheSizeInBytesOption.setConfig(size);
-	},
+	setOffthreadVideoCacheSizeInBytes:
+		offthreadVideoCacheSizeInBytesOption.setConfig,
 	setDeleteAfter: deleteAfterOption.setConfig,
 	setColorSpace: colorSpaceOption.setConfig,
 	setDisallowParallelEncoding: disallowParallelEncodingOption.setConfig,
@@ -738,6 +747,8 @@ export const Config: FlatConfig = {
 	setPublicLicenseKey: publicLicenseKeyOption.setConfig,
 	setForceNewStudioEnabled: forceNewStudioOption.setConfig,
 	setIPv4: ipv4Option.setConfig,
+	setBundleOutDir: outDirOption.setConfig,
+	setBenchmarkRuns: runsOption.setConfig,
 };
 
 export const ConfigInternals = {
@@ -761,7 +772,6 @@ export const ConfigInternals = {
 	getMetadata,
 	getEntryPoint,
 	getWebpackPolling,
-	getShouldOpenBrowser,
 	getBufferStateDelayInMilliseconds,
 	getOutputCodecOrUndefined: BrowserSafeApis.getOutputCodecOrUndefined,
 };

packages/cli/src/get-cli-options.ts

@@ -1,5 +1,4 @@
 import type {LogLevel} from '@remotion/renderer';
-import {RenderInternals} from '@remotion/renderer';
 import {BrowserSafeApis} from '@remotion/renderer/client';
 import fs from 'node:fs';
 import path from 'node:path';
@@ -56,36 +55,14 @@ export const getCliOptions = (options: {
 }) => {
 	const frameRange = getAndValidateFrameRange(options.logLevel, false);
 
-	const shouldOutputImageSequence = options.isStill
-		? true
-		: ConfigInternals.getShouldOutputImageSequence(frameRange);
-
-	const concurrency = BrowserSafeApis.options.concurrencyOption.getValue({
+	const imageSequence = BrowserSafeApis.options.imageSequenceOption.getValue({
 		commandLine: parsedCli,
 	}).value;
-
-	const height = BrowserSafeApis.options.overrideHeightOption.getValue({
-		commandLine: parsedCli,
-	}).value;
-	const width = BrowserSafeApis.options.overrideWidthOption.getValue({
-		commandLine: parsedCli,
-	}).value;
-	const fps = BrowserSafeApis.options.overrideFpsOption.getValue({
-		commandLine: parsedCli,
-	}).value;
-	const durationInFrames =
-		BrowserSafeApis.options.overrideDurationOption.getValue({
-			commandLine: parsedCli,
-		}).value;
-
-	RenderInternals.validateConcurrency({
-		value: concurrency,
-		setting: 'concurrency',
-		checkIfValidForCurrentMachine: false,
-	});
+	const shouldOutputImageSequence = options.isStill
+		? true
+		: imageSequence || typeof frameRange === 'number';
 
 	return {
-		concurrency,
 		frameRange,
 		shouldOutputImageSequence,
 		inputProps: getInputProps(null, options.logLevel),
@@ -94,11 +71,10 @@ export const getCliOptions = (options: {
 			options.logLevel,
 			options.indent,
 		),
-		stillFrame: ConfigInternals.getStillFrame(),
+		stillFrame:
+			BrowserSafeApis.options.stillFrameOption.getValue({
+				commandLine: parsedCli,
+			}).value ?? 0,
 		ffmpegOverride: ConfigInternals.getFfmpegOverrideFunction(),
-		height,
-		width,
-		fps,
-		durationInFrames,
 	};
 };