Skip to content

🎥 Make videos programmatically with React

5.1 KB
Raw Blame
import type {OnLog} from './browser/BrowserPage';
import type {Codec} from './codec';
import type {LogLevel} from './log-level';
import {Log} from './logger';
import type {HardwareAccelerationOption} from './options/hardware-acceleration';

export type CodecSettings = {
	encoderName: string;
	hardwareAccelerated: boolean;
};

export const hasSpecifiedUnsupportedHardwareQualifySettings = ({
	encodingMaxRate,
	encodingBufferSize,
	crf,
}: {
	encodingMaxRate: string | null;
	encodingBufferSize: string | null;
	crf: unknown;
}) => {
	if (encodingBufferSize !== null) {
		return 'encodingBufferSize';
	}

	if (encodingMaxRate !== null) {
		return 'encodingMaxRate';
	}

	if (crf !== null && typeof crf !== 'undefined') {
		return 'crf';
	}

	return null;
};

export const getCodecName = ({
	codec,
	encodingMaxRate,
	encodingBufferSize,
	crf,
	hardwareAcceleration,
	logLevel,
	indent,
	onLog,
}: {
	codec: Codec;
	hardwareAcceleration: HardwareAccelerationOption;
	encodingMaxRate: string | null;
	encodingBufferSize: string | null;
	crf: unknown;
	logLevel: LogLevel;
	indent: boolean;
	onLog: OnLog | null;
}): CodecSettings | null => {
	const preferredHwAcceleration =
		hardwareAcceleration === 'required' ||
		hardwareAcceleration === 'if-possible';

	const unsupportedQualityOption =
		hasSpecifiedUnsupportedHardwareQualifySettings({
			encodingMaxRate,
			encodingBufferSize,
			crf,
		});

	if (hardwareAcceleration === 'required' && unsupportedQualityOption) {
		throw new Error(
			`When using hardware accelerated encoding, the option "${unsupportedQualityOption}" with hardware acceleration is not supported. Disable hardware accelerated encoding or use "if-possible" instead.`,
		);
	}

	const warnAboutDisabledHardwareAcceleration = () => {
		if (hardwareAcceleration === 'if-possible' && unsupportedQualityOption) {
			const message = `Hardware accelerated encoding disabled - "${unsupportedQualityOption}" option is not supported with hardware acceleration`;
			if (onLog !== null) {
				onLog({
					logLevel: 'warn',
					previewString: message,
					tag: '',
				});
				return;
			}

			Log.warn({indent, logLevel}, `${indent ? '' : '\n'}${message}`);
		}
	};

	if (codec === 'prores') {
		if (
			preferredHwAcceleration &&
			process.platform === 'darwin' &&
			!unsupportedQualityOption
		) {
			return {encoderName: 'prores_videotoolbox', hardwareAccelerated: true};
		}

		if (
			preferredHwAcceleration &&
			process.platform !== 'darwin' &&
			!unsupportedQualityOption
		) {
			if (hardwareAcceleration === 'required') {
				throw new Error(
					`Codec "prores" does not support hardware acceleration on ${process.platform}, but "hardwareAcceleration" is set to "required"`,
				);
			}
		}

		warnAboutDisabledHardwareAcceleration();

		return {encoderName: 'prores_ks', hardwareAccelerated: false};
	}

	if (codec === 'h264') {
		if (
			preferredHwAcceleration &&
			process.platform === 'darwin' &&
			!unsupportedQualityOption
		) {
			return {encoderName: 'h264_videotoolbox', hardwareAccelerated: true};
		}

		// NVENC for Linux/Windows
		if (
			preferredHwAcceleration &&
			(process.platform === 'linux' || process.platform === 'win32') &&
			!unsupportedQualityOption
		) {
			return {encoderName: 'h264_nvenc', hardwareAccelerated: true};
		}

		warnAboutDisabledHardwareAcceleration();

		return {encoderName: 'libx264', hardwareAccelerated: false};
	}

	if (codec === 'h265') {
		if (
			preferredHwAcceleration &&
			process.platform === 'darwin' &&
			!unsupportedQualityOption
		) {
			return {encoderName: 'hevc_videotoolbox', hardwareAccelerated: true};
		}

		// NVENC for Linux/Windows
		if (
			preferredHwAcceleration &&
			(process.platform === 'linux' || process.platform === 'win32') &&
			!unsupportedQualityOption
		) {
			return {encoderName: 'hevc_nvenc', hardwareAccelerated: true};
		}

		warnAboutDisabledHardwareAcceleration();

		return {encoderName: 'libx265', hardwareAccelerated: false};
	}

	if (codec === 'vp8') {
		return {encoderName: 'libvpx', hardwareAccelerated: false};
	}

	if (codec === 'vp9') {
		return {encoderName: 'libvpx-vp9', hardwareAccelerated: false};
	}

	if (codec === 'av1') {
		Log.warn(
			{indent, logLevel},
			'AV1 encoding is significantly slower than other codecs.',
		);
		return {encoderName: 'libaom-av1', hardwareAccelerated: false};
	}

	if (codec === 'gif') {
		return {encoderName: 'gif', hardwareAccelerated: false};
	}

	if (codec === 'mp3') {
		return null;
	}

	if (codec === 'aac') {
		return null;
	}

	if (codec === 'wav') {
		return null;
	}

	if (codec === 'h264-mkv') {
		if (hardwareAcceleration === 'required') {
			throw new Error(
				`Codec "h264-mkv" does not support hardware acceleration on ${process.platform}, but "hardwareAcceleration" is set to "required"`,
			);
		}

		return {encoderName: 'libx264', hardwareAccelerated: false};
	}

	if (codec === 'h264-ts') {
		if (hardwareAcceleration === 'required') {
			throw new Error(
				`Codec "h264-ts" does not support hardware acceleration on ${process.platform}, but "hardwareAcceleration" is set to "required"`,
			);
		}

		return {encoderName: 'libx264', hardwareAccelerated: false};
	}

	throw new Error(`Could not get codec for ${codec satisfies never}`);
};