Merge branch 'main' into pr/1800

Author: JonnyBurger

packages/cli/src/config/audio-codec.ts

@@ -0,0 +1,25 @@
+import type {AudioCodec} from '@remotion/renderer';
+import {RenderInternals} from '@remotion/renderer';
+
+let _audioCodec: AudioCodec | null = null;
+
+export const setAudioCodec = (audioCodec: AudioCodec | null) => {
+	if (audioCodec === null) {
+		_audioCodec = null;
+		return;
+	}
+
+	if (!RenderInternals.validAudioCodecs.includes(audioCodec)) {
+		throw new Error(
+			`Audio codec must be one of the following: ${RenderInternals.validAudioCodecs.join(
+				', '
+			)}, but got ${audioCodec}`
+		);
+	}
+
+	_audioCodec = audioCodec;
+};
+
+export const getAudioCodec = () => {
+	return _audioCodec;
+};

packages/cli/src/config/index.ts

@@ -38,6 +38,7 @@ import {getWebpackCaching} from './webpack-caching';
 import type {WebpackConfiguration} from '@remotion/bundler';
 // eslint-disable-next-line no-restricted-imports
 import type {ConfigType} from 'remotion';
+import {getAudioCodec, setAudioCodec} from './audio-codec';
 import {
 	getAudioBitrate,
 	getVideoBitrate,
@@ -175,6 +176,8 @@ export const Config: ConfigType = {
 	Puppeteer,
 	Rendering,
 	Output,
+	// Options added after migration
+	setAudioCodec,
 } as ConfigType;
 
 export type {Concurrency, WebpackConfiguration, WebpackOverrideFn};
@@ -199,6 +202,7 @@ export const ConfigInternals = {
 	getConcurrency,
 	getCurrentPuppeteerTimeout,
 	getQuality,
+	getAudioCodec,
 	getStillFrame,
 	getShouldOutputImageSequence,
 	getDotEnvLocation,

packages/cli/src/get-audio-codec.ts

@@ -0,0 +1,7 @@
+import type {AudioCodec} from '@remotion/renderer';
+import {ConfigInternals} from './config';
+import {parsedCli} from './parse-command-line';
+
+export const getResolvedAudioCodec = (): AudioCodec | null => {
+	return parsedCli['audio-codec'] ?? ConfigInternals.getAudioCodec();
+};

packages/cli/src/get-filename.ts

@@ -1,29 +1,26 @@
-import type {Codec} from '@remotion/renderer';
 import {RenderInternals} from '@remotion/renderer';
 import {Log} from './log';
 import {getOutputLocation} from './user-passed-output-location';
 
 export const getOutputFilename = ({
-	codec,
 	imageSequence,
 	compositionName,
 	defaultExtension,
 	args,
 }: {
-	codec: Codec;
 	imageSequence: boolean;
 	compositionName: string;
 	defaultExtension: string;
 	args: string[];
 }): string => {
-	let filename = getOutputLocation({
+	const filename = getOutputLocation({
 		compositionId: compositionName,
 		defaultExtension,
 		args,
 		type: imageSequence ? 'sequence' : 'asset',
 	});
 
-	let extension = RenderInternals.getExtensionOfFilename(filename);
+	const extension = RenderInternals.getExtensionOfFilename(filename);
 	if (imageSequence) {
 		if (extension !== null) {
 			Log.error(
@@ -37,29 +34,10 @@ export const getOutputFilename = ({
 	}
 
 	if (extension === null && !imageSequence) {
-		if (codec === 'h264' || codec === 'h265') {
-			Log.warn('No file extension specified, adding .mp4 automatically.');
-			filename += '.mp4';
-			extension = 'mp4';
-		}
-
-		if (codec === 'h264-mkv') {
-			Log.warn('No file extension specified, adding .mkv automatically.');
-			filename += '.mkv';
-			extension = 'mkv';
-		}
-
-		if (codec === 'vp8' || codec === 'vp9') {
-			Log.warn('No file extension specified, adding .webm automatically.');
-			filename += '.webm';
-			extension = 'webm';
-		}
-
-		if (codec === 'prores') {
-			Log.warn('No file extension specified, adding .mov automatically.');
-			filename += '.mov';
-			extension = 'mov';
-		}
+		Log.warn(
+			`No file extension specified, adding ${defaultExtension} automatically.`
+		);
+		return `${filename}.${defaultExtension}`;
 	}
 
 	return filename;

packages/cli/src/get-final-output-codec.ts

@@ -1,25 +1,23 @@
-import type {Codec, CodecOrUndefined} from '@remotion/renderer';
+import type {Codec, CodecOrUndefined, FileExtension} from '@remotion/renderer';
 import {RenderInternals} from '@remotion/renderer';
 
-const fileExtensions: Record<string, Codec[]> = {
-	webm: ['vp8', 'vp9'],
-	hevc: ['h265'],
-	mp3: ['mp3'],
-	mov: ['prores'],
-	wav: ['wav'],
-	aac: ['aac'],
-	mkv: ['h264-mkv'],
-	gif: ['gif'],
-	mp4: ['h264'],
-	m4a: ['aac'],
-};
-
-const deriveExtensionFromFilename = (extension: string | null) => {
+const deriveCodecsFromFilename = (
+	extension: string | null
+): {
+	possible: Codec[];
+	default: Codec | null;
+} => {
 	if (extension === null) {
-		return [];
+		return {possible: [], default: null};
 	}
 
-	return fileExtensions[extension] ?? [];
+	return {
+		default:
+			RenderInternals.defaultCodecsForFileExtension[
+				extension as FileExtension
+			] ?? null,
+		possible: RenderInternals.makeFileExtensionMap()[extension] ?? [],
+	};
 };
 
 export const getFinalOutputCodec = ({
@@ -37,15 +35,14 @@ export const getFinalOutputCodec = ({
 		RenderInternals.getExtensionOfFilename(downloadName);
 	const outNameExtension = RenderInternals.getExtensionOfFilename(outName);
 
-	const derivedDownloadCodecs = deriveExtensionFromFilename(
-		downloadNameExtension
-	);
-	const derivedOutNameCodecs = deriveExtensionFromFilename(outNameExtension);
+	const derivedDownloadCodecs = deriveCodecsFromFilename(downloadNameExtension);
+	const derivedOutNameCodecs = deriveCodecsFromFilename(outNameExtension);
 
 	if (
-		derivedDownloadCodecs.length > 0 &&
-		derivedOutNameCodecs.length > 0 &&
-		derivedDownloadCodecs.join('') !== derivedOutNameCodecs.join('')
+		derivedDownloadCodecs.possible.length > 0 &&
+		derivedOutNameCodecs.possible.length > 0 &&
+		derivedDownloadCodecs.possible.join('') !==
+			derivedOutNameCodecs.possible.join('')
 	) {
 		throw new TypeError(
 			`The download name is ${downloadName} but the output name is ${outName}. The file extensions must match`
@@ -54,22 +51,22 @@ export const getFinalOutputCodec = ({
 
 	if (cliFlag) {
 		if (
-			derivedDownloadCodecs.length > 0 &&
-			derivedDownloadCodecs.indexOf(cliFlag) === -1
+			derivedDownloadCodecs.possible.length > 0 &&
+			derivedDownloadCodecs.possible.indexOf(cliFlag) === -1
 		) {
 			throw new TypeError(
-				`The download name is ${downloadName} but --codec=${cliFlag} was passed. The download name implies a codec of ${derivedDownloadCodecs.join(
+				`The download name is ${downloadName} but --codec=${cliFlag} was passed. The download name implies a codec of ${derivedDownloadCodecs.possible.join(
 					' or '
 				)} which does not align with the --codec flag.`
 			);
 		}
 
 		if (
-			derivedOutNameCodecs.length > 0 &&
-			derivedOutNameCodecs.indexOf(cliFlag) === -1
+			derivedOutNameCodecs.possible.length > 0 &&
+			derivedOutNameCodecs.possible.indexOf(cliFlag) === -1
 		) {
 			throw new TypeError(
-				`The out name is ${outName} but --codec=${cliFlag} was passed. The out name implies a codec of ${derivedOutNameCodecs.join(
+				`The out name is ${outName} but --codec=${cliFlag} was passed. The out name implies a codec of ${derivedOutNameCodecs.possible.join(
 					' or '
 				)} which does not align with the --codec flag.`
 			);
@@ -78,16 +75,16 @@ export const getFinalOutputCodec = ({
 		return {codec: cliFlag, reason: 'from --codec flag'};
 	}
 
-	if (derivedDownloadCodecs.length > 0) {
+	if (derivedDownloadCodecs.possible.length > 0) {
 		return {
-			codec: derivedDownloadCodecs[0],
+			codec: derivedDownloadCodecs.default as Codec,
 			reason: 'derived from download name',
 		};
 	}
 
-	if (derivedOutNameCodecs.length > 0) {
+	if (derivedOutNameCodecs.possible.length > 0) {
 		return {
-			codec: derivedOutNameCodecs[0],
+			codec: derivedOutNameCodecs.default as Codec,
 			reason: 'derived from out name',
 		};
 	}

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

@@ -1,6 +1,7 @@
 import type {Codec, RenderMediaOptions} from '@remotion/renderer';
 import {RenderInternals} from '@remotion/renderer';
 import {ConfigInternals} from './config';
+import {getResolvedAudioCodec} from './get-audio-codec';
 import {getCliOptions} from './get-cli-options';
 import {getImageFormat} from './image-formats';
 
@@ -49,6 +50,7 @@ export const getRenderMediaOptions = async ({
 	});
 
 	const imageFormat = getImageFormat(codec);
+	const audioCodec = getResolvedAudioCodec();
 
 	return {
 		outputLocation,
@@ -91,5 +93,6 @@ export const getRenderMediaOptions = async ({
 		codec,
 		audioBitrate,
 		videoBitrate,
+		audioCodec,
 	};
 };

packages/cli/src/parse-command-line.ts

@@ -1,4 +1,5 @@
 import type {
+	AudioCodec,
 	BrowserExecutable,
 	Codec,
 	FfmpegExecutable,
@@ -35,6 +36,7 @@ export type CommandLineOptions = {
 	['public-dir']: string;
 	['audio-bitrate']: string;
 	['video-bitrate']: string;
+	['audio-codec']: AudioCodec;
 	crf: number;
 	force: boolean;
 	overwrite: boolean;

packages/cli/src/render.tsx

@@ -14,6 +14,7 @@ import {Internals} from 'remotion';
 import {chalk} from './chalk';
 import {ConfigInternals} from './config';
 import {findEntryPoint} from './entry-point';
+import {getResolvedAudioCodec} from './get-audio-codec';
 import {
 	getAndValidateAbsoluteOutputFile,
 	getCliOptions,
@@ -177,11 +178,15 @@ export const render = async (remotionRoot: string, args: string[]) => {
 		scale,
 	});
 
+	const audioCodec = getResolvedAudioCodec();
+
 	const relativeOutputLocation = getOutputFilename({
-		codec,
 		imageSequence: shouldOutputImageSequence,
 		compositionName: compositionId,
-		defaultExtension: RenderInternals.getFileExtensionFromCodec(codec),
+		defaultExtension: RenderInternals.getFileExtensionFromCodec(
+			codec,
+			audioCodec
+		),
 		args: argsAfterComposition,
 	});
 

packages/core/src/audio/AudioForRendering.tsx

@@ -51,6 +51,7 @@ const AudioForRenderingRefForwardingFunction: React.ForwardRefRenderFunction<
 		volume: volumeProp,
 		playbackRate,
 		allowAmplificationDuringRender,
+		onDuration,
 		...nativeProps
 	} = props;
 
@@ -112,7 +113,7 @@ const AudioForRenderingRefForwardingFunction: React.ForwardRefRenderFunction<
 		allowAmplificationDuringRender,
 	]);
 
-	const {src, onDuration} = props;
+	const {src} = props;
 
 	// If audio source switches, make new handle
 	if (environment === 'rendering') {

packages/core/src/config.ts

@@ -33,7 +33,14 @@ type FlatConfig = ObjectConfig['Bundling'] &
 	ObjectConfig['Preview'] &
 	ObjectConfig['Puppeteer'] &
 	ObjectConfig['Output'] &
-	ObjectConfig['Rendering'];
+	ObjectConfig['Rendering'] & {
+		/**
+		 * Set the audio codec to use for the output video.
+		 * See the Encoding guide in the docs for defaults and available options.
+		 */
+		setAudioCodec: (codec: 'pcm-16' | 'aac' | 'mp3' | 'opus') => void;
+	};
+
 // Legacy config format: New options to not need to be added here.
 type ObjectConfig = {
 	/**