@remotion/renderer 4.0.0-alpha.4 → 4.0.0-alpha10

package/dist/locks.d.ts

@@ -0,0 +1,7 @@
+export declare const createLock: ({ timeout }: {
+    timeout: number | null;
+}) => {
+    lock: () => number;
+    unlock: (id: number) => void;
+    waitForAllToBeDone: () => Promise<unknown>;
+};

package/dist/locks.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createLock = void 0;
+const createLock = ({ timeout }) => {
+    let locks = [];
+    const waiters = [];
+    const lock = () => {
+        const id = Math.random();
+        locks.push(id);
+        return id;
+    };
+    const unlock = (id) => {
+        locks = locks.filter((l) => l !== id);
+        resolveWaiters();
+    };
+    const resolveWaiters = () => {
+        if (locks.length === 0) {
+            waiters.forEach((w) => w());
+        }
+    };
+    const waitForAllToBeDone = () => {
+        const success = new Promise((resolve) => {
+            waiters.push(() => {
+                resolve();
+            });
+        });
+        resolveWaiters();
+        if (timeout === null) {
+            return success;
+        }
+        const timeoutFn = new Promise((resolve) => {
+            setTimeout(() => {
+                return resolve();
+            }, timeout);
+        });
+        return Promise.race([success, timeoutFn]);
+    };
+    return {
+        lock,
+        unlock,
+        waitForAllToBeDone,
+    };
+};
+exports.createLock = createLock;

package/dist/logger.d.ts

@@ -0,0 +1,22 @@
+import type { LogLevel } from './log-level';
+export declare const INDENT_TOKEN: string;
+declare type LogOptions = {
+    indent: boolean;
+    logLevel: LogLevel;
+};
+declare type VerboseLogOptions = LogOptions & {
+    tag?: string;
+};
+export declare const verboseTag: (str: string) => string;
+export declare const Log: {
+    verbose: (message?: any, ...optionalParams: any[]) => void;
+    verboseAdvanced: (options: VerboseLogOptions, message?: any, ...optionalParams: any[]) => void;
+    info: (message?: any, ...optionalParams: any[]) => void;
+    infoAdvanced: (options: LogOptions, message?: any, ...optionalParams: any[]) => void;
+    warn: (message?: any, ...optionalParams: any[]) => void;
+    warnAdvanced: (options: LogOptions, message?: any, ...optionalParams: any[]) => void;
+    error: (message?: any, ...optionalParams: any[]) => void;
+};
+export declare const getLogLevel: () => "verbose" | "error" | "info" | "warn";
+export declare const setLogLevel: (newLogLevel: LogLevel) => void;
+export {};

package/dist/logger.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setLogLevel = exports.getLogLevel = exports.Log = exports.verboseTag = exports.INDENT_TOKEN = void 0;
+const chalk_1 = require("./chalk");
+const is_color_supported_1 = require("./chalk/is-color-supported");
+const log_level_1 = require("./log-level");
+const truthy_1 = require("./truthy");
+exports.INDENT_TOKEN = chalk_1.chalk.gray('│');
+const verboseTag = (str) => {
+    return is_color_supported_1.isColorSupported
+        ? chalk_1.chalk.bgBlack(` ${str.toUpperCase()} `)
+        : `[${str.toUpperCase()}]`;
+};
+exports.verboseTag = verboseTag;
+exports.Log = {
+    verbose: (...args) => {
+        exports.Log.verboseAdvanced({ indent: false, logLevel: (0, exports.getLogLevel)() }, ...args);
+    },
+    verboseAdvanced: (options, ...args) => {
+        if ((0, log_level_1.isEqualOrBelowLogLevel)(options.logLevel, 'verbose')) {
+            return console.log(...[
+                options.indent ? exports.INDENT_TOKEN : null,
+                options.tag ? (0, exports.verboseTag)(options.tag) : null,
+                ...args.map((a) => chalk_1.chalk.gray(a)),
+            ].filter(truthy_1.truthy));
+        }
+    },
+    info: (...args) => {
+        exports.Log.infoAdvanced({ indent: false, logLevel: (0, exports.getLogLevel)() }, ...args);
+    },
+    infoAdvanced: (options, ...args) => {
+        if ((0, log_level_1.isEqualOrBelowLogLevel)(options.logLevel, 'info')) {
+            return console.log(...[options.indent ? exports.INDENT_TOKEN : null, ...args].filter(truthy_1.truthy));
+        }
+    },
+    warn: (...args) => {
+        exports.Log.warnAdvanced({ indent: false, logLevel: (0, exports.getLogLevel)() }, ...args);
+    },
+    warnAdvanced: (options, ...args) => {
+        if ((0, log_level_1.isEqualOrBelowLogLevel)(options.logLevel, 'warn')) {
+            return console.warn(...[
+                options.indent ? chalk_1.chalk.yellow(exports.INDENT_TOKEN) : null,
+                ...args.map((a) => chalk_1.chalk.yellow(a)),
+            ].filter(truthy_1.truthy));
+        }
+    },
+    error: (...args) => {
+        if ((0, log_level_1.isEqualOrBelowLogLevel)((0, exports.getLogLevel)(), 'error')) {
+            return console.error(...args.map((a) => chalk_1.chalk.red(a)));
+        }
+    },
+};
+let logLevel = 'info';
+const getLogLevel = () => {
+    return logLevel;
+};
+exports.getLogLevel = getLogLevel;
+const setLogLevel = (newLogLevel) => {
+    logLevel = newLogLevel;
+};
+exports.setLogLevel = setLogLevel;

package/dist/make-cancel-signal.d.ts

@@ -1,7 +1,18 @@
 declare type Callback = () => void;
 export declare type CancelSignal = (callback: Callback) => void;
+/**
+ * @description Returns a signal and a cancel function that allows to you cancel a render triggered using renderMedia(), renderStill(), renderFrames() or stitchFramesToVideo().
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/make-cancel-signal)
+ */
 export declare const makeCancelSignal: () => {
     cancelSignal: CancelSignal;
     cancel: () => void;
 };
+export declare const cancelErrorMessages: {
+    renderMedia: string;
+    renderFrames: string;
+    renderStill: string;
+    stitchFramesToVideo: string;
+};
+export declare const isUserCancelledRender: (err: unknown) => boolean;
 export {};

package/dist/make-cancel-signal.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeCancelSignal = void 0;
+exports.isUserCancelledRender = exports.cancelErrorMessages = exports.makeCancelSignal = void 0;
+/**
+ * @description Returns a signal and a cancel function that allows to you cancel a render triggered using renderMedia(), renderStill(), renderFrames() or stitchFramesToVideo().
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/make-cancel-signal)
+ */
 const makeCancelSignal = () => {
     const callbacks = [];
     let cancelled = false;
@@ -23,3 +27,22 @@ const makeCancelSignal = () => {
     };
 };
 exports.makeCancelSignal = makeCancelSignal;
+exports.cancelErrorMessages = {
+    renderMedia: 'renderMedia() got cancelled',
+    renderFrames: 'renderFrames() got cancelled',
+    renderStill: 'renderStill() got cancelled',
+    stitchFramesToVideo: 'stitchFramesToVideo() got cancelled',
+};
+const isUserCancelledRender = (err) => {
+    if (typeof err === 'object' &&
+        err !== null &&
+        'message' in err &&
+        typeof err.message === 'string') {
+        return (err.message.includes(exports.cancelErrorMessages.renderMedia) ||
+            err.message.includes(exports.cancelErrorMessages.renderFrames) ||
+            err.message.includes(exports.cancelErrorMessages.renderStill) ||
+            err.message.includes(exports.cancelErrorMessages.stitchFramesToVideo));
+    }
+    return false;
+};
+exports.isUserCancelledRender = isUserCancelledRender;

package/dist/merge-audio-track.d.ts

@@ -1,11 +1,11 @@
 import type { DownloadMap } from './assets/download-map';
-import type { FfmpegExecutable } from './ffmpeg-executable';
+import type { PreprocessedAudioTrack } from './preprocess-audio-track';
 declare type Options = {
-    ffmpegExecutable: FfmpegExecutable;
-    files: string[];
+    files: PreprocessedAudioTrack[];
     outName: string;
     numberOfSeconds: number;
     downloadMap: DownloadMap;
+    remotionRoot: string;
 };
 export declare const mergeAudioTrack: (options: Options) => Promise<void>;
 export {};

package/dist/merge-audio-track.js

@@ -4,73 +4,79 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.mergeAudioTrack = void 0;
-const execa_1 = __importDefault(require("execa"));
-const path_1 = __importDefault(require("path"));
+const node_path_1 = __importDefault(require("node:path"));
+const call_ffmpeg_1 = require("./call-ffmpeg");
 const chunk_1 = require("./chunk");
-const convert_to_pcm_1 = require("./convert-to-pcm");
 const create_ffmpeg_complex_filter_1 = require("./create-ffmpeg-complex-filter");
+const create_ffmpeg_merge_filter_1 = require("./create-ffmpeg-merge-filter");
 const create_silent_audio_1 = require("./create-silent-audio");
 const delete_directory_1 = require("./delete-directory");
 const p_limit_1 = require("./p-limit");
 const tmp_dir_1 = require("./tmp-dir");
 const truthy_1 = require("./truthy");
-const mergeAudioTrackUnlimited = async ({ ffmpegExecutable, outName, files, numberOfSeconds, downloadMap, }) => {
+const mergeAudioTrackUnlimited = async ({ outName, files, numberOfSeconds, downloadMap, remotionRoot, }) => {
     if (files.length === 0) {
         await (0, create_silent_audio_1.createSilentAudio)({
             outName,
-            ffmpegExecutable,
             numberOfSeconds,
         });
         return;
     }
-    if (files.length === 1) {
-        await (0, convert_to_pcm_1.convertToPcm)({
-            outName,
-            ffmpegExecutable,
-            input: files[0],
-        });
-        return;
-    }
+    // Previously a bug: We cannot optimize for files.length === 1 because we need to pad the audio
     // In FFMPEG, the total number of left and right tracks that can be merged at one time is limited to 64
     if (files.length >= 32) {
         const chunked = (0, chunk_1.chunk)(files, 10);
         const tempPath = (0, tmp_dir_1.tmpDir)('remotion-large-audio-mixing');
-        const chunkNames = await Promise.all(chunked.map(async (chunkFiles, i) => {
-            const chunkOutname = path_1.default.join(tempPath, `chunk-${i}.wav`);
+        try {
+            const chunkNames = await Promise.all(chunked.map(async (chunkFiles, i) => {
+                const chunkOutname = node_path_1.default.join(tempPath, `chunk-${i}.wav`);
+                await (0, exports.mergeAudioTrack)({
+                    files: chunkFiles,
+                    numberOfSeconds,
+                    outName: chunkOutname,
+                    downloadMap,
+                    remotionRoot,
+                });
+                return chunkOutname;
+            }));
             await (0, exports.mergeAudioTrack)({
-                ffmpegExecutable,
-                files: chunkFiles,
+                files: chunkNames.map((c) => ({
+                    filter: {
+                        pad_end: null,
+                        pad_start: null,
+                    },
+                    outName: c,
+                })),
                 numberOfSeconds,
-                outName: chunkOutname,
+                outName,
                 downloadMap,
+                remotionRoot,
             });
-            return chunkOutname;
-        }));
-        await (0, exports.mergeAudioTrack)({
-            ffmpegExecutable,
-            files: chunkNames,
-            numberOfSeconds,
-            outName,
-            downloadMap,
-        });
-        await (0, delete_directory_1.deleteDirectory)(tempPath);
-        return;
+            return;
+        }
+        finally {
+            (0, delete_directory_1.deleteDirectory)(tempPath);
+        }
     }
-    const { complexFilterFlag: mergeFilter, cleanup } = await (0, create_ffmpeg_complex_filter_1.createFfmpegComplexFilter)(files.length, downloadMap);
+    const { complexFilterFlag: mergeFilter, cleanup } = await (0, create_ffmpeg_complex_filter_1.createFfmpegComplexFilter)({
+        filters: files,
+        downloadMap,
+    });
     const args = [
-        ...files.map((f) => ['-i', f]),
+        ...files.map((f) => ['-i', f.outName]),
         mergeFilter,
         ['-c:a', 'pcm_s16le'],
-        ['-map', '[a]'],
+        ['-map', `[${create_ffmpeg_merge_filter_1.OUTPUT_FILTER_NAME}]`],
         ['-y', outName],
     ]
         .filter(truthy_1.truthy)
         .flat(2);
-    const task = (0, execa_1.default)(ffmpegExecutable !== null && ffmpegExecutable !== void 0 ? ffmpegExecutable : 'ffmpeg', args);
+    const task = (0, call_ffmpeg_1.callFf)('ffmpeg', args);
     await task;
     cleanup();
 };
-const limit = (0, p_limit_1.pLimit)(2);
+// Must be at least 3 because recursively called twice in mergeAudioTrack
+const limit = (0, p_limit_1.pLimit)(3);
 const mergeAudioTrack = (options) => {
     return limit(mergeAudioTrackUnlimited, options);
 };

package/dist/mime-types.d.ts

@@ -1,2 +1,3 @@
+export declare const getExt: (contentType: string) => string | null;
 export declare function mimeLookup(path: string): string | false;
 export declare function mimeContentType(str: string): false | string;

package/dist/mime-types.js

@@ -1,18 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mimeContentType = exports.mimeLookup = void 0;
-const path_1 = require("path");
+exports.mimeContentType = exports.mimeLookup = exports.getExt = void 0;
+const node_path_1 = require("node:path");
 const mime_db_1 = require("./mime-db");
 const extensions = {};
 const types = {};
 // Populate the extensions/types maps
 populateMaps(extensions, {});
+const getExt = (contentType) => {
+    var _a, _b, _c;
+    return (_c = (_b = (_a = mime_db_1.mimeDb[contentType.toLowerCase()]) === null || _a === void 0 ? void 0 : _a.extensions) === null || _b === void 0 ? void 0 : _b[0]) !== null && _c !== void 0 ? _c : null;
+};
+exports.getExt = getExt;
 function mimeLookup(path) {
     if (!path || typeof path !== 'string') {
         return false;
     }
     // get the extension ("ext" or ".ext" or full path)
-    const ext = (0, path_1.extname)('.' + path)
+    const ext = (0, node_path_1.extname)('.' + path)
         .toLowerCase()
         .substr(1);
     if (!ext) {

package/dist/offthread-video-server.d.ts

@@ -1,17 +1,21 @@
-import type { RequestListener } from 'http';
-import type { OffthreadVideoImageFormat } from 'remotion';
+import type { RequestListener } from 'node:http';
 import type { RenderMediaOnDownload } from './assets/download-and-map-assets-to-file';
 import type { DownloadMap } from './assets/download-map';
-import type { FfmpegExecutable } from './ffmpeg-executable';
+import type { Compositor } from './compositor/compositor';
 export declare const extractUrlAndSourceFromUrl: (url: string) => {
     src: string;
     time: number;
-    imageFormat: OffthreadVideoImageFormat;
+    transparent: boolean;
 };
-export declare const startOffthreadVideoServer: ({ ffmpegExecutable, ffprobeExecutable, onDownload, onError, downloadMap, }: {
-    ffmpegExecutable: FfmpegExecutable;
-    ffprobeExecutable: FfmpegExecutable;
+export declare const startOffthreadVideoServer: ({ onDownload, onError, downloadMap, concurrency, verbose, indent, }: {
     onDownload: RenderMediaOnDownload;
     onError: (err: Error) => void;
     downloadMap: DownloadMap;
-}) => RequestListener;
+    concurrency: number;
+    verbose: boolean;
+    indent: boolean;
+}) => {
+    listener: RequestListener;
+    close: () => Promise<void>;
+    compositor: Compositor;
+};

package/dist/offthread-video-server.js

@@ -1,17 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.startOffthreadVideoServer = exports.extractUrlAndSourceFromUrl = void 0;
-const remotion_1 = require("remotion");
-const url_1 = require("url");
+const node_url_1 = require("node:url");
 const download_and_map_assets_to_file_1 = require("./assets/download-and-map-assets-to-file");
-const extract_frame_from_video_1 = require("./extract-frame-from-video");
+const compositor_1 = require("./compositor/compositor");
 const extractUrlAndSourceFromUrl = (url) => {
     const parsed = new URL(url, 'http://localhost');
     const query = parsed.search;
     if (!query.trim()) {
         throw new Error('Expected query from ' + url);
     }
-    const params = new url_1.URLSearchParams(query);
+    const params = new node_url_1.URLSearchParams(query);
     const src = params.get('src');
     if (!src) {
         throw new Error('Did not pass `src` parameter');
@@ -20,56 +19,77 @@ const extractUrlAndSourceFromUrl = (url) => {
     if (!time) {
         throw new Error('Did not get `time` parameter');
     }
-    const imageFormat = params.get('imageFormat');
-    if (!imageFormat) {
-        throw new TypeError('Did not get `imageFormat` parameter');
-    }
-    remotion_1.Internals.validateOffthreadVideoImageFormat(imageFormat);
+    const transparent = params.get('transparent');
     return {
         src,
         time: parseFloat(time),
-        imageFormat: imageFormat,
+        transparent: transparent === 'true',
     };
 };
 exports.extractUrlAndSourceFromUrl = extractUrlAndSourceFromUrl;
-const startOffthreadVideoServer = ({ ffmpegExecutable, ffprobeExecutable, onDownload, onError, downloadMap, }) => {
-    return (req, res) => {
-        if (!req.url) {
-            throw new Error('Request came in without URL');
-        }
-        if (!req.url.startsWith('/proxy')) {
-            res.writeHead(404);
-            res.end();
-            return;
-        }
-        const { src, time, imageFormat } = (0, exports.extractUrlAndSourceFromUrl)(req.url);
-        res.setHeader('access-control-allow-origin', '*');
-        res.setHeader('content-type', `image/${imageFormat === 'jpeg' ? 'jpg' : 'png'}`);
-        (0, download_and_map_assets_to_file_1.downloadAsset)({ src, onDownload, downloadMap })
-            .then((to) => {
-            return (0, extract_frame_from_video_1.extractFrameFromVideo)({
-                time,
-                src: to,
-                ffmpegExecutable,
-                ffprobeExecutable,
-                imageFormat,
-                downloadMap,
-            });
-        })
-            .then((readable) => {
-            if (!readable) {
-                throw new Error('no readable from ffmpeg');
+const startOffthreadVideoServer = ({ onDownload, onError, downloadMap, concurrency, verbose, indent, }) => {
+    const compositor = (0, compositor_1.startCompositor)('StartLongRunningProcess', {
+        concurrency,
+        maximum_frame_cache_items: (0, compositor_1.getIdealMaximumFrameCacheItems)(),
+        verbose,
+    }, indent);
+    return {
+        close: () => {
+            compositor.finishCommands();
+            return compositor.waitForDone();
+        },
+        listener: (req, res) => {
+            if (!req.url) {
+                throw new Error('Request came in without URL');
+            }
+            if (!req.url.startsWith('/proxy')) {
+                res.writeHead(404);
+                res.end();
+                return;
             }
-            res.writeHead(200);
-            res.write(readable);
-            res.end();
-        })
-            .catch((err) => {
-            res.writeHead(500);
-            res.end();
-            onError(err);
-            console.log('Error occurred', err);
-        });
+            const { src, time, transparent } = (0, exports.extractUrlAndSourceFromUrl)(req.url);
+            res.setHeader('access-control-allow-origin', '*');
+            if (transparent) {
+                res.setHeader('content-type', `image/png`);
+            }
+            else {
+                res.setHeader('content-type', `image/bmp`);
+            }
+            // Handling this case on Lambda:
+            // https://support.google.com/chrome/a/answer/7679408?hl=en
+            // Chrome sends Private Network Access preflights for subresources
+            if (req.method === 'OPTIONS') {
+                res.statusCode = 200;
+                if (req.headers['access-control-request-private-network']) {
+                    res.setHeader('Access-Control-Allow-Private-Network', 'true');
+                }
+                res.end();
+                return;
+            }
+            (0, download_and_map_assets_to_file_1.downloadAsset)({ src, onDownload, downloadMap })
+                .then((to) => {
+                return compositor.executeCommand('ExtractFrame', {
+                    input: to,
+                    time,
+                    transparent,
+                });
+            })
+                .then((readable) => {
+                if (!readable) {
+                    throw new Error('no readable from ffmpeg');
+                }
+                res.writeHead(200);
+                res.write(readable);
+                res.end();
+            })
+                .catch((err) => {
+                res.writeHead(500);
+                res.end();
+                onError(err);
+                console.log('Error occurred', err);
+            });
+        },
+        compositor,
     };
 };
 exports.startOffthreadVideoServer = startOffthreadVideoServer;

package/dist/open-browser.d.ts

@@ -1,5 +1,5 @@
 import type { Browser } from './browser';
-import type { Browser as PuppeteerBrowser } from './browser/Browser';
+import type { HeadlessBrowser } from './browser/Browser';
 import type { Viewport } from './browser/PuppeteerViewport';
 declare const validRenderers: readonly ["swangle", "angle", "egl", "swiftshader"];
 declare type OpenGlRenderer = typeof validRenderers[number];
@@ -8,13 +8,19 @@ export declare type ChromiumOptions = {
     disableWebSecurity?: boolean;
     gl?: OpenGlRenderer | null;
     headless?: boolean;
+    userAgent?: string | null;
 };
 export declare const killAllBrowsers: () => Promise<void>;
+/**
+ * @description Opens a Chrome or Chromium browser instance.
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/open-browser)
+ */
 export declare const openBrowser: (browser: Browser, options?: {
     shouldDumpIo?: boolean;
     browserExecutable?: string | null;
     chromiumOptions?: ChromiumOptions;
     forceDeviceScaleFactor?: number;
     viewport?: Viewport;
-}) => Promise<PuppeteerBrowser>;
+    indent?: boolean;
+}) => Promise<HeadlessBrowser>;
 export {};