@remotion/renderer 4.0.0-alpha4 → 4.0.0-alpha6

package/dist/delete-directory.js

@@ -22,37 +22,37 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.deleteDirectory = void 0;
-const execa_1 = __importDefault(require("execa"));
-const fs_1 = __importStar(require("fs"));
+const node_fs_1 = __importStar(require("node:fs"));
 const is_serve_url_1 = require("./is-serve-url");
 const deleteDirectory = (directory) => {
-    var _a;
     if ((0, is_serve_url_1.isServeUrl)(directory)) {
         return;
     }
-    if (!(0, fs_1.existsSync)(directory)) {
+    if (!(0, node_fs_1.existsSync)(directory)) {
         return;
     }
-    if (process.platform === 'win32') {
-        // We use del before to remove all files inside the directories otherwise
-        // rmdir will throw an error.
-        execa_1.default.sync('cmd', ['/c', 'del', '/f', '/s', '/q', directory]);
+    // Working around a bug with NodeJS 16 on Windows:
+    // If a subdirectory is already deleted, it will fail with EPERM
+    // even with force: true and recursive and maxRetries set higher.
+    // This is even with the fixWinEPERMSync function being called by Node.JS.
+    // This is a workaround for this issue.
+    let retries = 2;
+    while (retries >= 0) {
         try {
-            execa_1.default.sync('cmd', ['/c', 'rmdir', '/s', '/q', directory]);
+            node_fs_1.default.rmSync(directory, {
+                maxRetries: 2,
+                recursive: true,
+                force: true,
+                retryDelay: 100,
+            });
         }
         catch (err) {
-            // Is not a directory
+            retries--;
+            continue;
         }
-    }
-    else {
-        ((_a = fs_1.default.rmSync) !== null && _a !== void 0 ? _a : fs_1.default.rmdirSync)(directory, {
-            recursive: true,
-        });
+        break;
     }
 };
 exports.deleteDirectory = deleteDirectory;

package/dist/does-have-m2-bug.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.warnAboutM2Bug = void 0;
-const os_1 = require("os");
+const node_os_1 = require("node:os");
 const warnAboutM2Bug = (codec, pixelFormat) => {
-    const isM2 = (0, os_1.cpus)().find((c) => c.model.includes('Apple M2'));
+    const isM2 = (0, node_os_1.cpus)().find((c) => c.model.includes('Apple M2'));
     if (codec === 'prores' && pixelFormat === 'yuv422p10le' && isM2) {
         console.warn();
         console.warn('⚠️ Known issue: Apple M2 CPUs currently suffer from a bug where transparent ProRes videos have flickering. https://github.com/remotion-dev/remotion/issues/1929');

package/dist/ensure-output-directory.js

@@ -4,12 +4,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ensureOutputDirectory = void 0;
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
 const ensureOutputDirectory = (outputLocation) => {
-    const dirName = path_1.default.dirname(outputLocation);
-    if (!fs_1.default.existsSync(dirName)) {
-        fs_1.default.mkdirSync(dirName, {
+    const dirName = node_path_1.default.dirname(outputLocation);
+    if (!node_fs_1.default.existsSync(dirName)) {
+        node_fs_1.default.mkdirSync(dirName, {
             recursive: true,
         });
     }

package/dist/ffmpeg-filter-file.js

@@ -29,25 +29,25 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeFfmpegFilterFileStr = exports.makeFfmpegFilterFile = void 0;
-const fs_1 = __importStar(require("fs"));
-const path_1 = __importDefault(require("path"));
+const node_fs_1 = __importStar(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
 const makeFfmpegFilterFile = (complexFilter, downloadMap) => {
     return (0, exports.makeFfmpegFilterFileStr)(complexFilter.filter, downloadMap);
 };
 exports.makeFfmpegFilterFile = makeFfmpegFilterFile;
 const makeFfmpegFilterFileStr = async (complexFilter, downloadMap) => {
     const random = Math.random().toString().replace('.', '');
-    const filterFile = path_1.default.join(downloadMap.complexFilter, 'complex-filter-' + random + '.txt');
+    const filterFile = node_path_1.default.join(downloadMap.complexFilter, 'complex-filter-' + random + '.txt');
     // Race condition: Sometimes the download map is deleted before the file is written.
     // Can remove this once the original bug has been fixed
-    if (!(0, fs_1.existsSync)(downloadMap.complexFilter)) {
-        fs_1.default.mkdirSync(downloadMap.complexFilter, { recursive: true });
+    if (!(0, node_fs_1.existsSync)(downloadMap.complexFilter)) {
+        node_fs_1.default.mkdirSync(downloadMap.complexFilter, { recursive: true });
     }
-    await fs_1.default.promises.writeFile(filterFile, complexFilter);
+    await node_fs_1.default.promises.writeFile(filterFile, complexFilter);
     return {
         file: filterFile,
         cleanup: () => {
-            fs_1.default.unlinkSync(filterFile);
+            node_fs_1.default.unlinkSync(filterFile);
         },
     };
 };

package/dist/file-extensions.d.ts

@@ -1,16 +1,5 @@
+import type { supportedAudioCodecs } from './audio-codec';
 import type { Codec } from './codec';
-export declare const supportedAudioCodecs: {
-    readonly h264: readonly ["aac", "pcm-16"];
-    readonly 'h264-mkv': readonly ["pcm-16"];
-    readonly aac: readonly ["aac", "pcm-16"];
-    readonly gif: readonly [];
-    readonly h265: readonly ["aac", "pcm-16"];
-    readonly mp3: readonly ["mp3", "pcm-16"];
-    readonly prores: readonly ["pcm-16", "aac"];
-    readonly vp8: readonly ["opus", "pcm-16"];
-    readonly vp9: readonly ["opus", "pcm-16"];
-    readonly wav: readonly ["pcm-16"];
-};
 export declare type FileExtension = 'aac' | '3gp' | 'm4a' | 'm4b' | 'mpg' | 'mpeg' | 'mkv' | 'mp4' | 'gif' | 'hevc' | 'mp3' | 'mov' | 'mxf' | 'wav' | 'webm';
 export declare const defaultFileExtensionMap: {
     [key in Codec]: {

package/dist/file-extensions.js

@@ -1,18 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultFileExtensionMap = exports.supportedAudioCodecs = void 0;
-exports.supportedAudioCodecs = {
-    h264: ['aac', 'pcm-16'],
-    'h264-mkv': ['pcm-16'],
-    aac: ['aac', 'pcm-16'],
-    gif: [],
-    h265: ['aac', 'pcm-16'],
-    mp3: ['mp3', 'pcm-16'],
-    prores: ['pcm-16', 'aac'],
-    vp8: ['opus', 'pcm-16'],
-    vp9: ['opus', 'pcm-16'],
-    wav: ['pcm-16'],
-};
+exports.defaultFileExtensionMap = void 0;
 exports.defaultFileExtensionMap = {
     'h264-mkv': {
         default: 'mkv',
@@ -35,7 +23,13 @@ exports.defaultFileExtensionMap = {
     },
     gif: {
         default: 'gif',
-        forAudioCodec: {},
+        forAudioCodec: {
+            // This is just to make the types happy, GIF does not support any audio
+            'pcm-16': { possible: [], default: 'wav' },
+            aac: { possible: [], default: 'wav' },
+            mp3: { possible: [], default: 'wav' },
+            opus: { possible: [], default: 'wav' },
+        },
     },
     h264: {
         default: 'mp4',

package/dist/find-closest-package-json.js

@@ -4,19 +4,19 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.findRemotionRoot = exports.findClosestPackageJson = void 0;
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
 const recursionLimit = 5;
 const findClosestPackageJson = () => {
     let currentDir = process.cwd();
     let possiblePackageJson = '';
     for (let i = 0; i < recursionLimit; i++) {
-        possiblePackageJson = path_1.default.join(currentDir, 'package.json');
-        const exists = fs_1.default.existsSync(possiblePackageJson);
+        possiblePackageJson = node_path_1.default.join(currentDir, 'package.json');
+        const exists = node_fs_1.default.existsSync(possiblePackageJson);
         if (exists) {
             return possiblePackageJson;
         }
-        currentDir = path_1.default.dirname(currentDir);
+        currentDir = node_path_1.default.dirname(currentDir);
     }
     return null;
 };
@@ -26,6 +26,6 @@ const findRemotionRoot = () => {
     if (closestPackageJson === null) {
         return process.cwd();
     }
-    return path_1.default.dirname(closestPackageJson);
+    return node_path_1.default.dirname(closestPackageJson);
 };
 exports.findRemotionRoot = findRemotionRoot;

package/dist/get-compositions.d.ts

@@ -1,9 +1,8 @@
-import type { TCompMetadata } from 'remotion';
+import type { AnyCompMetadata } from 'remotion';
 import type { DownloadMap } from './assets/download-map';
 import type { BrowserExecutable } from './browser-executable';
 import type { BrowserLog } from './browser-log';
 import type { Browser } from './browser/Browser';
-import type { FfmpegExecutable } from './ffmpeg-executable';
 import type { ChromiumOptions } from './open-browser';
 declare type GetCompositionsConfig = {
     inputProps?: object | null;
@@ -13,17 +12,16 @@ declare type GetCompositionsConfig = {
     browserExecutable?: BrowserExecutable;
     timeoutInMilliseconds?: number;
     chromiumOptions?: ChromiumOptions;
-    ffmpegExecutable?: FfmpegExecutable;
-    ffprobeExecutable?: FfmpegExecutable;
     port?: number | null;
     /**
      * @deprecated Only for Remotion internal usage
      */
     downloadMap?: DownloadMap;
+    verbose?: boolean;
 };
 /**
  * @description Gets the compositions defined in a Remotion project based on a Webpack bundle.
  * @see [Documentation](https://www.remotion.dev/docs/renderer/get-compositions)
  */
-export declare const getCompositions: (serveUrlOrWebpackUrl: string, config?: GetCompositionsConfig) => Promise<TCompMetadata[]>;
+export declare const getCompositions: (serveUrlOrWebpackUrl: string, config?: GetCompositionsConfig) => Promise<AnyCompMetadata[]>;
 export {};

package/dist/get-compositions.js

@@ -9,7 +9,6 @@ const prepare_server_1 = require("./prepare-server");
 const puppeteer_evaluate_1 = require("./puppeteer-evaluate");
 const seek_to_frame_1 = require("./seek-to-frame");
 const set_props_and_env_1 = require("./set-props-and-env");
-const validate_ffmpeg_1 = require("./validate-ffmpeg");
 const validate_puppeteer_timeout_1 = require("./validate-puppeteer-timeout");
 const innerGetCompositions = async (serveUrl, page, config, proxyPort) => {
     if (config === null || config === void 0 ? void 0 : config.onBrowserLog) {
@@ -61,17 +60,15 @@ const innerGetCompositions = async (serveUrl, page, config, proxyPort) => {
  * @see [Documentation](https://www.remotion.dev/docs/renderer/get-compositions)
  */
 const getCompositions = async (serveUrlOrWebpackUrl, config) => {
-    var _a, _b, _c, _d, _e;
-    await (0, validate_ffmpeg_1.validateFfmpeg)((_a = config === null || config === void 0 ? void 0 : config.ffmpegExecutable) !== null && _a !== void 0 ? _a : null, (0, find_closest_package_json_1.findRemotionRoot)(), 'ffmpeg');
-    await (0, validate_ffmpeg_1.validateFfmpeg)((_b = config === null || config === void 0 ? void 0 : config.ffprobeExecutable) !== null && _b !== void 0 ? _b : null, (0, find_closest_package_json_1.findRemotionRoot)(), 'ffprobe');
-    const downloadMap = (_c = config === null || config === void 0 ? void 0 : config.downloadMap) !== null && _c !== void 0 ? _c : (0, download_map_1.makeDownloadMap)();
+    var _a, _b, _c;
+    const downloadMap = (_a = config === null || config === void 0 ? void 0 : config.downloadMap) !== null && _a !== void 0 ? _a : (0, download_map_1.makeDownloadMap)();
     const { page, cleanup } = await (0, get_browser_instance_1.getPageAndCleanupFn)({
         passedInInstance: config === null || config === void 0 ? void 0 : config.puppeteerInstance,
-        browserExecutable: (_d = config === null || config === void 0 ? void 0 : config.browserExecutable) !== null && _d !== void 0 ? _d : null,
-        chromiumOptions: (_e = config === null || config === void 0 ? void 0 : config.chromiumOptions) !== null && _e !== void 0 ? _e : {},
+        browserExecutable: (_b = config === null || config === void 0 ? void 0 : config.browserExecutable) !== null && _b !== void 0 ? _b : null,
+        chromiumOptions: (_c = config === null || config === void 0 ? void 0 : config.chromiumOptions) !== null && _c !== void 0 ? _c : {},
     });
     return new Promise((resolve, reject) => {
-        var _a, _b, _c;
+        var _a, _b;
         const onError = (err) => reject(err);
         const cleanupPageError = (0, handle_javascript_exception_1.handleJavascriptException)({
             page,
@@ -83,11 +80,11 @@ const getCompositions = async (serveUrlOrWebpackUrl, config) => {
             webpackConfigOrServeUrl: serveUrlOrWebpackUrl,
             onDownload: () => undefined,
             onError,
-            ffmpegExecutable: (_a = config === null || config === void 0 ? void 0 : config.ffmpegExecutable) !== null && _a !== void 0 ? _a : null,
-            ffprobeExecutable: (_b = config === null || config === void 0 ? void 0 : config.ffprobeExecutable) !== null && _b !== void 0 ? _b : null,
-            port: (_c = config === null || config === void 0 ? void 0 : config.port) !== null && _c !== void 0 ? _c : null,
+            port: (_a = config === null || config === void 0 ? void 0 : config.port) !== null && _a !== void 0 ? _a : null,
             downloadMap,
             remotionRoot: (0, find_closest_package_json_1.findRemotionRoot)(),
+            concurrency: 1,
+            verbose: (_b = config === null || config === void 0 ? void 0 : config.verbose) !== null && _b !== void 0 ? _b : false,
         })
             .then(({ serveUrl, closeServer, offthreadPort }) => {
             close = closeServer;

package/dist/get-concurrency.js

@@ -4,12 +4,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getActualConcurrency = void 0;
-const os_1 = __importDefault(require("os"));
+const node_os_1 = __importDefault(require("node:os"));
 const getActualConcurrency = (userPreference) => {
     if (userPreference === null) {
-        return Math.round(Math.min(8, Math.max(1, os_1.default.cpus().length / 2)));
+        return Math.round(Math.min(8, Math.max(1, node_os_1.default.cpus().length / 2)));
     }
-    const max = os_1.default.cpus().length;
+    const max = node_os_1.default.cpus().length;
     const min = 1;
     let rounded;
     if (typeof userPreference === 'string') {

package/dist/get-extension-from-codec.d.ts

@@ -1,6 +1,6 @@
 import type { AudioCodec } from './audio-codec';
 import type { Codec } from './codec';
 import type { FileExtension } from './file-extensions';
-export declare const getFileExtensionFromCodec: <T extends "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif">(codec: T, audioCodec: AudioCodec | null) => FileExtension;
-export declare const makeFileExtensionMap: () => Record<string, ("h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif")[]>;
+export declare const getFileExtensionFromCodec: <T extends "aac" | "mp3" | "h264" | "h265" | "vp8" | "vp9" | "wav" | "prores" | "h264-mkv" | "gif">(codec: T, audioCodec: AudioCodec | null) => FileExtension;
+export declare const makeFileExtensionMap: () => Record<string, ("aac" | "mp3" | "h264" | "h265" | "vp8" | "vp9" | "wav" | "prores" | "h264-mkv" | "gif")[]>;
 export declare const defaultCodecsForFileExtension: Record<FileExtension, Codec>;

package/dist/get-extension-of-filename.js

@@ -4,12 +4,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getExtensionOfFilename = void 0;
-const path_1 = __importDefault(require("path"));
+const node_path_1 = __importDefault(require("node:path"));
 const getExtensionOfFilename = (filename) => {
     if (filename === null) {
         return null;
     }
-    const filenameArr = path_1.default.normalize(filename).split('.');
+    const filenameArr = node_path_1.default.normalize(filename).split('.');
     const hasExtension = filenameArr.length >= 2;
     const filenameArrLength = filenameArr.length;
     const extension = hasExtension ? filenameArr[filenameArrLength - 1] : null;

package/dist/get-frame-padded-index.d.ts

@@ -1,8 +1,9 @@
+import type { VideoImageFormat } from './image-format';
 export declare type CountType = 'from-zero' | 'actual-frames';
 export declare const getFrameOutputFileName: ({ index, frame, imageFormat, countType, lastFrame, totalFrames, }: {
     index: number;
     frame: number;
-    imageFormat: 'png' | 'jpeg' | 'none';
+    imageFormat: VideoImageFormat;
     countType: CountType;
     lastFrame: number;
     totalFrames: number;

package/dist/get-local-browser-executable.js

@@ -4,7 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getLocalBrowserExecutable = exports.ensureLocalBrowser = void 0;
-const fs_1 = __importDefault(require("fs"));
+const node_fs_1 = __importDefault(require("node:fs"));
 const BrowserFetcher_1 = require("./browser/BrowserFetcher");
 const create_browser_fetcher_1 = require("./browser/create-browser-fetcher");
 const revisions_1 = require("./browser/revisions");
@@ -38,7 +38,7 @@ const getSearchPathsForProduct = (product) => {
 const mapBrowserToProduct = (browser) => browser;
 const getLocalBrowser = (product) => {
     for (const p of getSearchPathsForProduct(product)) {
-        if (fs_1.default.existsSync(p)) {
+        if (node_fs_1.default.existsSync(p)) {
             return p;
         }
     }
@@ -46,7 +46,7 @@ const getLocalBrowser = (product) => {
 };
 const getBrowserStatus = (product, browserExecutablePath) => {
     if (browserExecutablePath) {
-        if (!fs_1.default.existsSync(browserExecutablePath)) {
+        if (!node_fs_1.default.existsSync(browserExecutablePath)) {
             console.warn(`Browser executable was specified as '${browserExecutablePath}' but the path doesn't exist.`);
         }
         return { path: browserExecutablePath, type: 'user-defined-path' };
@@ -56,7 +56,7 @@ const getBrowserStatus = (product, browserExecutablePath) => {
         return { path: localBrowser, type: 'local-browser' };
     }
     const revision = (0, BrowserFetcher_1.getRevisionInfo)(revisions_1.PUPPETEER_REVISIONS.chromium, product);
-    if (revision.local && fs_1.default.existsSync(revision.executablePath)) {
+    if (revision.local && node_fs_1.default.existsSync(revision.executablePath)) {
         return { path: revision.executablePath, type: 'local-puppeteer-browser' };
     }
     return { type: 'no-browser' };

package/dist/get-video-threads-flag.js

@@ -4,12 +4,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getIdealVideoThreadsFlag = void 0;
-const os_1 = __importDefault(require("os"));
+const node_os_1 = __importDefault(require("node:os"));
 const MEMORY_USAGE_PER_THREAD = 400000000; // 400MB
 const RESERVED_MEMORY = 2000000000;
 const getIdealVideoThreadsFlag = () => {
-    const freeMemory = os_1.default.freemem();
-    const cpus = os_1.default.cpus().length;
+    const freeMemory = node_os_1.default.freemem();
+    const cpus = node_os_1.default.cpus().length;
     const maxRecommendedBasedOnCpus = (cpus * 2) / 3;
     const maxRecommendedBasedOnMemory = (freeMemory - RESERVED_MEMORY) / MEMORY_USAGE_PER_THREAD;
     const maxRecommended = Math.min(maxRecommendedBasedOnCpus, maxRecommendedBasedOnMemory);

package/dist/guess-extension-for-media.d.ts

@@ -1,5 +1,3 @@
-export declare const guessExtensionForVideo: ({ src, remotionRoot, ffprobeBinary, }: {
+export declare const guessExtensionForVideo: ({ src }: {
     src: string;
-    remotionRoot: string;
-    ffprobeBinary: string | null;
 }) => Promise<"mp3" | "wav" | "mp4" | "webm">;

package/dist/guess-extension-for-media.js

@@ -1,14 +1,10 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.guessExtensionForVideo = void 0;
-const execa_1 = __importDefault(require("execa"));
-const ffmpeg_flags_1 = require("./ffmpeg-flags");
-const guessExtensionForVideo = async ({ src, remotionRoot, ffprobeBinary, }) => {
-    const { stderr } = await (0, execa_1.default)(await (0, ffmpeg_flags_1.getExecutableBinary)(ffprobeBinary, remotionRoot, 'ffprobe'), [src]);
-    if (stderr.includes('mp3,')) {
+const call_ffmpeg_1 = require("./call-ffmpeg");
+const guessExtensionForVideo = async ({ src }) => {
+    const { stderr } = await (0, call_ffmpeg_1.callFf)('ffprobe', [src]);
+    if (stderr.includes('Audio: mp3,')) {
         return 'mp3';
     }
     if (stderr.includes('Video: vp9')) {

package/dist/image-format.d.ts

@@ -1,7 +1,13 @@
 import type { PixelFormat } from './pixel-format';
-export declare const validImageFormats: readonly ["png", "jpeg", "none"];
-export declare type ImageFormat = typeof validImageFormats[number];
-export declare type StillImageFormat = 'png' | 'jpeg';
-export declare const DEFAULT_IMAGE_FORMAT: ImageFormat;
-export declare const validateSelectedPixelFormatAndImageFormatCombination: (pixelFormat: PixelFormat | undefined, imageFormat: ImageFormat) => 'none' | 'valid';
-export declare const validateNonNullImageFormat: (imageFormat: ImageFormat) => void;
+export declare const validVideoImageFormats: readonly ["png", "jpeg", "none"];
+export declare const validStillImageFormats: readonly ["png", "jpeg", "pdf", "webp"];
+export declare type VideoImageFormat = typeof validVideoImageFormats[number];
+export declare type StillImageFormat = typeof validStillImageFormats[number];
+/**
+ * @deprecated Use VideoImageFormat or StillImageFormat instead
+ */
+export declare type ImageFormat = 'This type is deprecated, use VideoImageFormat or StillImageFormat instead';
+export declare const DEFAULT_VIDEO_IMAGE_FORMAT: VideoImageFormat;
+export declare const DEFAULT_STILL_IMAGE_FORMAT: StillImageFormat;
+export declare const validateSelectedPixelFormatAndImageFormatCombination: (pixelFormat: PixelFormat | undefined, videoImageFormat: VideoImageFormat) => 'none' | 'valid';
+export declare const validateStillImageFormat: (imageFormat: StillImageFormat) => void;

package/dist/image-format.js

@@ -2,33 +2,36 @@
 // Keeping the default image format PNG if you don't pass a
 // value to the renderer for backwards compatibility.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateNonNullImageFormat = exports.validateSelectedPixelFormatAndImageFormatCombination = exports.DEFAULT_IMAGE_FORMAT = exports.validImageFormats = void 0;
-exports.validImageFormats = ['png', 'jpeg', 'none'];
-// However, the CLI will override it and use JPEG if suitable.
-exports.DEFAULT_IMAGE_FORMAT = 'png';
+exports.validateStillImageFormat = exports.validateSelectedPixelFormatAndImageFormatCombination = exports.DEFAULT_STILL_IMAGE_FORMAT = exports.DEFAULT_VIDEO_IMAGE_FORMAT = exports.validStillImageFormats = exports.validVideoImageFormats = void 0;
+exports.validVideoImageFormats = ['png', 'jpeg', 'none'];
+exports.validStillImageFormats = ['png', 'jpeg', 'pdf', 'webp'];
+exports.DEFAULT_VIDEO_IMAGE_FORMAT = 'jpeg';
+exports.DEFAULT_STILL_IMAGE_FORMAT = 'png';
 // By returning a value, we improve testability as we can specifically test certain branches
-const validateSelectedPixelFormatAndImageFormatCombination = (pixelFormat, imageFormat) => {
-    if (imageFormat === 'none') {
+const validateSelectedPixelFormatAndImageFormatCombination = (pixelFormat, videoImageFormat) => {
+    if (videoImageFormat === 'none') {
         return 'none';
     }
     if (typeof pixelFormat === 'undefined') {
         return 'valid';
     }
-    if (!exports.validImageFormats.includes(imageFormat)) {
-        throw new TypeError(`Value ${imageFormat} is not valid as an image format.`);
+    if (!exports.validVideoImageFormats.includes(videoImageFormat)) {
+        throw new TypeError(`Value ${videoImageFormat} is not valid as an image format.`);
     }
     if (pixelFormat !== 'yuva420p' && pixelFormat !== 'yuva444p10le') {
         return 'valid';
     }
-    if (imageFormat !== 'png') {
+    if (videoImageFormat !== 'png') {
         throw new TypeError(`Pixel format was set to '${pixelFormat}' but the image format is not PNG. To render transparent videos, you need to set PNG as the image format.`);
     }
     return 'valid';
 };
 exports.validateSelectedPixelFormatAndImageFormatCombination = validateSelectedPixelFormatAndImageFormatCombination;
-const validateNonNullImageFormat = (imageFormat) => {
-    if (imageFormat !== 'jpeg' && imageFormat !== 'png') {
-        throw new TypeError('Image format should be either "png" or "jpeg"');
+const validateStillImageFormat = (imageFormat) => {
+    if (!exports.validStillImageFormats.includes(imageFormat)) {
+        throw new TypeError(String(`Image format should be one of: ${exports.validStillImageFormats
+            .map((v) => `"${v}"`)
+            .join(', ')}`));
     }
 };
-exports.validateNonNullImageFormat = validateNonNullImageFormat;
+exports.validateStillImageFormat = validateStillImageFormat;