@remotion/renderer 4.0.0-alpha13 → 4.0.0-alpha16

package/dist/render-media.js

@@ -3,18 +3,20 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.renderMedia = void 0;
+exports.renderMedia = exports.internalRenderMedia = void 0;
 const node_fs_1 = __importDefault(require("node:fs"));
 const node_os_1 = __importDefault(require("node:os"));
 const node_path_1 = __importDefault(require("node:path"));
 const remotion_1 = require("remotion");
-const download_map_1 = require("./assets/download-map");
+const TimeoutSettings_1 = require("./browser/TimeoutSettings");
 const can_use_parallel_encoding_1 = require("./can-use-parallel-encoding");
 const codec_supports_media_1 = require("./codec-supports-media");
 const crf_1 = require("./crf");
 const delete_directory_1 = require("./delete-directory");
 const ensure_frames_in_order_1 = require("./ensure-frames-in-order");
 const ensure_output_directory_1 = require("./ensure-output-directory");
+const find_closest_package_json_1 = require("./find-closest-package-json");
+const get_concurrency_1 = require("./get-concurrency");
 const get_duration_from_frame_range_1 = require("./get-duration-from-frame-range");
 const get_extension_from_codec_1 = require("./get-extension-from-codec");
 const get_extension_of_filename_1 = require("./get-extension-of-filename");
@@ -27,6 +29,7 @@ const make_cancel_signal_1 = require("./make-cancel-signal");
 const overwrite_1 = require("./overwrite");
 const perf_1 = require("./perf");
 const pixel_format_1 = require("./pixel-format");
+const prepare_server_1 = require("./prepare-server");
 const prespawn_ffmpeg_1 = require("./prespawn-ffmpeg");
 const prestitcher_memory_usage_1 = require("./prestitcher-memory-usage");
 const prores_profile_1 = require("./prores-profile");
@@ -40,17 +43,8 @@ const validate_output_filename_1 = require("./validate-output-filename");
 const validate_scale_1 = require("./validate-scale");
 const validate_videobitrate_1 = require("./validate-videobitrate");
 const SLOWEST_FRAME_COUNT = 10;
-/**
- *
- * @description Render a video from a composition
- * @see [Documentation](https://www.remotion.dev/docs/renderer/render-media)
- */
-const renderMedia = ({ proResProfile, crf, composition, inputProps, pixelFormat, codec, envVariables, frameRange, puppeteerInstance, outputLocation, onProgress, overwrite, onDownload, dumpBrowserLogs, onBrowserLog, onStart, timeoutInMilliseconds, chromiumOptions, scale, browserExecutable, port, cancelSignal, muted, enforceAudioTrack, ffmpegOverride, audioBitrate, videoBitrate, audioCodec, ...options }) => {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s;
-    if (options.quality) {
-        throw new Error(`The "quality" option has been renamed. Please use "jpegQuality" instead.`);
-    }
-    (0, jpeg_quality_1.validateJpegQuality)(options.jpegQuality);
+const internalRenderMedia = ({ proResProfile, crf, composition, inputProps, pixelFormat, codec, envVariables, frameRange, puppeteerInstance, outputLocation, onProgress, overwrite, onDownload, dumpBrowserLogs, onBrowserLog, onStart, timeoutInMilliseconds, chromiumOptions, scale, browserExecutable, port, cancelSignal, muted, enforceAudioTrack, ffmpegOverride, audioBitrate, videoBitrate, audioCodec, concurrency, disallowParallelEncoding, everyNthFrame, imageFormat: provisionalImageFormat, indent, jpegQuality, numberOfGifLoops, onCtrlCExit, preferLossless, serveUrl, server: reusedServer, verbose, }) => {
+    (0, jpeg_quality_1.validateJpegQuality)(jpegQuality);
     (0, crf_1.validateQualitySettings)({ crf, codec, videoBitrate });
     (0, validate_videobitrate_1.validateBitrate)(audioBitrate, 'audioBitrate');
     (0, validate_videobitrate_1.validateBitrate)(videoBitrate, 'videoBitrate');
@@ -62,9 +56,9 @@ const renderMedia = ({ proResProfile, crf, composition, inputProps, pixelFormat,
     if (outputLocation) {
         (0, validate_output_filename_1.validateOutputFilename)({
             codec,
-            audioCodec: audioCodec !== null && audioCodec !== void 0 ? audioCodec : null,
+            audioCodec,
             extension: (0, get_extension_of_filename_1.getExtensionOfFilename)(outputLocation),
-            preferLossless: (_a = options.preferLossless) !== null && _a !== void 0 ? _a : false,
+            preferLossless,
         });
     }
     const absoluteOutputLocation = outputLocation
@@ -72,9 +66,7 @@ const renderMedia = ({ proResProfile, crf, composition, inputProps, pixelFormat,
         : null;
     (0, validate_scale_1.validateScale)(scale);
     (0, validate_ffmpeg_override_1.validateFfmpegOverride)(ffmpegOverride);
-    const everyNthFrame = (_b = options.everyNthFrame) !== null && _b !== void 0 ? _b : 1;
     (0, validate_every_nth_frame_1.validateEveryNthFrame)(everyNthFrame, codec);
-    const numberOfGifLoops = (_c = options.numberOfGifLoops) !== null && _c !== void 0 ? _c : null;
     (0, validate_number_of_gif_loops_1.validateNumberOfGifLoops)(numberOfGifLoops, codec);
     let stitchStage = 'encoding';
     let stitcherFfmpeg;
@@ -85,61 +77,57 @@ const renderMedia = ({ proResProfile, crf, composition, inputProps, pixelFormat,
     let encodedDoneIn = null;
     let cancelled = false;
     const renderStart = Date.now();
-    const downloadMap = (_e = (_d = options.internal) === null || _d === void 0 ? void 0 : _d.downloadMap) !== null && _e !== void 0 ? _e : (0, download_map_1.makeDownloadMap)();
     const { estimatedUsage, freeMemory, hasEnoughMemory } = (0, prestitcher_memory_usage_1.shouldUseParallelEncoding)({
         height: composition.height,
         width: composition.width,
     });
-    const parallelEncoding = !options.disallowParallelEncoding &&
+    const parallelEncoding = !disallowParallelEncoding &&
         hasEnoughMemory &&
         (0, can_use_parallel_encoding_1.canUseParallelEncoding)(codec);
     logger_1.Log.verboseAdvanced({
-        indent: (_g = (_f = options.internal) === null || _f === void 0 ? void 0 : _f.indent) !== null && _g !== void 0 ? _g : false,
-        logLevel: options.verbose ? 'verbose' : 'info',
-        tag: 'PARALLEL ENCODING',
+        indent,
+        logLevel: verbose ? 'verbose' : 'info',
+        tag: 'renderMedia()',
     }, 'Free memory:', freeMemory, 'Estimated usage parallel encoding', estimatedUsage);
     logger_1.Log.verboseAdvanced({
-        indent: (_j = (_h = options.internal) === null || _h === void 0 ? void 0 : _h.indent) !== null && _j !== void 0 ? _j : false,
-        logLevel: options.verbose ? 'verbose' : 'info',
-        tag: 'PARALLEL ENCODING',
+        indent,
+        logLevel: verbose ? 'verbose' : 'info',
+        tag: 'renderMedia()',
     }, 'Codec supports parallel rendering:', (0, can_use_parallel_encoding_1.canUseParallelEncoding)(codec));
     logger_1.Log.verboseAdvanced({
-        indent: (_l = (_k = options.internal) === null || _k === void 0 ? void 0 : _k.indent) !== null && _l !== void 0 ? _l : false,
-        logLevel: options.verbose ? 'verbose' : 'info',
-        tag: 'PARALLEL ENCODING',
-    }, 'User disallowed parallel encoding:', Boolean(options.disallowParallelEncoding));
+        indent,
+        logLevel: verbose ? 'verbose' : 'info',
+        tag: 'renderMedia()',
+    }, 'User disallowed parallel encoding:', Boolean(disallowParallelEncoding));
     if (parallelEncoding) {
         logger_1.Log.verboseAdvanced({
-            indent: (_o = (_m = options.internal) === null || _m === void 0 ? void 0 : _m.indent) !== null && _o !== void 0 ? _o : false,
-            logLevel: options.verbose ? 'verbose' : 'info',
-            tag: 'PARALLEL ENCODING',
+            indent,
+            logLevel: verbose ? 'verbose' : 'info',
+            tag: 'renderMedia()',
         }, 'Parallel encoding is enabled.');
     }
     else {
         logger_1.Log.verboseAdvanced({
-            indent: (_q = (_p = options.internal) === null || _p === void 0 ? void 0 : _p.indent) !== null && _q !== void 0 ? _q : false,
-            logLevel: options.verbose ? 'verbose' : 'info',
-            tag: 'PARALLEL ENCODING',
+            indent,
+            logLevel: verbose ? 'verbose' : 'info',
+            tag: 'renderMedia()',
         }, 'Parallel encoding is disabled.');
     }
     const imageFormat = (0, is_audio_codec_1.isAudioCodec)(codec)
         ? 'none'
-        : (_r = options.imageFormat) !== null && _r !== void 0 ? _r : 'jpeg';
-    const jpegQuality = imageFormat === 'jpeg' ? options.jpegQuality : undefined;
+        : provisionalImageFormat;
     (0, image_format_1.validateSelectedPixelFormatAndImageFormatCombination)(pixelFormat, imageFormat);
+    const workingDir = node_fs_1.default.mkdtempSync(node_path_1.default.join(node_os_1.default.tmpdir(), 'react-motion-render'));
     const preEncodedFileLocation = parallelEncoding
-        ? node_path_1.default.join(downloadMap.preEncode, 'pre-encode.' + (0, get_extension_from_codec_1.getFileExtensionFromCodec)(codec, audioCodec !== null && audioCodec !== void 0 ? audioCodec : null))
+        ? node_path_1.default.join(workingDir, 'pre-encode.' + (0, get_extension_from_codec_1.getFileExtensionFromCodec)(codec, audioCodec))
         : null;
-    const outputDir = parallelEncoding
-        ? null
-        : node_fs_1.default.mkdtempSync(node_path_1.default.join(node_os_1.default.tmpdir(), 'react-motion-render'));
-    if (((_s = options.internal) === null || _s === void 0 ? void 0 : _s.onCtrlCExit) && outputDir) {
-        options.internal.onCtrlCExit(() => (0, delete_directory_1.deleteDirectory)(outputDir));
+    if (onCtrlCExit && workingDir) {
+        onCtrlCExit(() => (0, delete_directory_1.deleteDirectory)(workingDir));
     }
     (0, validate_even_dimensions_with_codec_1.validateEvenDimensionsWithCodec)({
         codec,
         height: composition.height,
-        scale: scale !== null && scale !== void 0 ? scale : 1,
+        scale,
         width: composition.width,
     });
     const callUpdate = () => {
@@ -154,7 +142,7 @@ const renderMedia = ({ proResProfile, crf, composition, inputProps, pixelFormat,
                 100) / 100,
         });
     };
-    const realFrameRange = (0, get_frame_to_render_1.getRealFrameRange)(composition.durationInFrames, frameRange !== null && frameRange !== void 0 ? frameRange : null);
+    const realFrameRange = (0, get_frame_to_render_1.getRealFrameRange)(composition.durationInFrames, frameRange);
     const cancelRenderFrames = (0, make_cancel_signal_1.makeCancelSignal)();
     const cancelPrestitcher = (0, make_cancel_signal_1.makeCancelSignal)();
     const cancelStitcher = (0, make_cancel_signal_1.makeCancelSignal)();
@@ -162,14 +150,13 @@ const renderMedia = ({ proResProfile, crf, composition, inputProps, pixelFormat,
         cancelRenderFrames.cancel();
     });
     const { waitForRightTimeOfFrameToBeInserted, setFrameToStitch, waitForFinish } = (0, ensure_frames_in_order_1.ensureFramesInOrder)(realFrameRange);
-    const fps = composition.fps / (everyNthFrame !== null && everyNthFrame !== void 0 ? everyNthFrame : 1);
+    const fps = composition.fps / everyNthFrame;
     remotion_1.Internals.validateFps(fps, 'in "renderMedia()"', codec === 'gif');
     const createPrestitcherIfNecessary = () => {
-        var _a, _b, _c;
         if (preEncodedFileLocation) {
             preStitcher = (0, prespawn_ffmpeg_1.prespawnFfmpeg)({
-                width: composition.width * (scale !== null && scale !== void 0 ? scale : 1),
-                height: composition.height * (scale !== null && scale !== void 0 ? scale : 1),
+                width: composition.width * scale,
+                height: composition.height * scale,
                 fps,
                 outputLocation: preEncodedFileLocation,
                 pixelFormat,
@@ -180,12 +167,12 @@ const renderMedia = ({ proResProfile, crf, composition, inputProps, pixelFormat,
                     encodedFrames = frame;
                     callUpdate();
                 },
-                verbose: (_a = options.verbose) !== null && _a !== void 0 ? _a : false,
+                verbose,
                 imageFormat,
                 signal: cancelPrestitcher.cancelSignal,
                 ffmpegOverride: ffmpegOverride !== null && ffmpegOverride !== void 0 ? ffmpegOverride : (({ args }) => args),
-                videoBitrate: videoBitrate !== null && videoBitrate !== void 0 ? videoBitrate : null,
-                indent: (_c = (_b = options.internal) === null || _b === void 0 ? void 0 : _b.indent) !== null && _c !== void 0 ? _c : false,
+                videoBitrate,
+                indent,
             });
             stitcherFfmpeg = preStitcher.task;
         }
@@ -229,157 +216,168 @@ const renderMedia = ({ proResProfile, crf, composition, inputProps, pixelFormat,
         }
         minTime = (_b = (_a = slowestFrames[slowestFrames.length - 1]) === null || _a === void 0 ? void 0 : _a.time) !== null && _b !== void 0 ? _b : minTime;
     };
-    const happyPath = Promise.resolve(createPrestitcherIfNecessary())
-        .then(() => {
-        var _a, _b, _c;
-        const renderFramesProc = (0, render_frames_1.renderFrames)({
-            composition,
-            onFrameUpdate: (frame, frameIndex, timeToRenderInMilliseconds) => {
-                renderedFrames = frame;
-                callUpdate();
-                recordFrameTime(frameIndex, timeToRenderInMilliseconds);
-            },
-            concurrency: options.concurrency,
-            outputDir,
-            onStart: (data) => {
-                renderedFrames = 0;
-                callUpdate();
-                onStart === null || onStart === void 0 ? void 0 : onStart(data);
-            },
-            inputProps: inputProps !== null && inputProps !== void 0 ? inputProps : {},
-            envVariables,
-            imageFormat,
-            jpegQuality,
-            frameRange: frameRange !== null && frameRange !== void 0 ? frameRange : null,
-            puppeteerInstance,
-            everyNthFrame,
-            onFrameBuffer: parallelEncoding
-                ? async (buffer, frame) => {
-                    var _a;
-                    await waitForRightTimeOfFrameToBeInserted(frame);
-                    if (cancelled) {
-                        return;
-                    }
-                    const id = (0, perf_1.startPerfMeasure)('piping');
-                    (_a = stitcherFfmpeg === null || stitcherFfmpeg === void 0 ? void 0 : stitcherFfmpeg.stdin) === null || _a === void 0 ? void 0 : _a.write(buffer);
-                    (0, perf_1.stopPerfMeasure)(id);
-                    setFrameToStitch(Math.min(realFrameRange[1] + 1, frame + everyNthFrame));
-                }
-                : undefined,
-            serveUrl: options.serveUrl,
-            dumpBrowserLogs,
-            onBrowserLog,
-            onDownload,
-            timeoutInMilliseconds,
-            chromiumOptions,
-            scale,
-            browserExecutable,
-            port,
-            cancelSignal: cancelRenderFrames.cancelSignal,
-            downloadMap,
-            muted: disableAudio,
-            verbose: (_a = options.verbose) !== null && _a !== void 0 ? _a : false,
-            indent: (_c = (_b = options.internal) === null || _b === void 0 ? void 0 : _b.indent) !== null && _c !== void 0 ? _c : false,
-        });
-        return renderFramesProc;
-    })
-        .then((renderFramesReturn) => {
-        return Promise.all([renderFramesReturn, waitForPrestitcherIfNecessary()]);
-    })
-        .then(([{ assetsInfo }]) => {
-        var _a, _b, _c;
-        renderedDoneIn = Date.now() - renderStart;
-        callUpdate();
-        if (absoluteOutputLocation) {
-            (0, ensure_output_directory_1.ensureOutputDirectory)(absoluteOutputLocation);
-        }
-        const stitchStart = Date.now();
-        return Promise.all([
-            (0, stitch_frames_to_video_1.stitchFramesToVideo)({
-                width: composition.width * (scale !== null && scale !== void 0 ? scale : 1),
-                height: composition.height * (scale !== null && scale !== void 0 ? scale : 1),
-                fps,
-                outputLocation: absoluteOutputLocation,
-                internalOptions: {
-                    preEncodedFileLocation,
-                    imageFormat,
-                    preferLossless: (_a = options.preferLossless) !== null && _a !== void 0 ? _a : false,
-                    indent: (_c = (_b = options.internal) === null || _b === void 0 ? void 0 : _b.indent) !== null && _c !== void 0 ? _c : false,
+    let cleanupServerFn = () => Promise.resolve(undefined);
+    const happyPath = new Promise((resolve, reject) => {
+        Promise.resolve(createPrestitcherIfNecessary())
+            .then(() => {
+            return (0, prepare_server_1.makeOrReuseServer)(reusedServer, {
+                concurrency: (0, get_concurrency_1.getActualConcurrency)(concurrency),
+                indent,
+                port,
+                remotionRoot: (0, find_closest_package_json_1.findRemotionRoot)(),
+                verbose,
+                webpackConfigOrServeUrl: serveUrl,
+            }, {
+                onDownload,
+                onError: (err) => reject(err),
+            });
+        })
+            .then(({ server, cleanupServer }) => {
+            cleanupServerFn = cleanupServer;
+            const renderFramesProc = (0, render_frames_1.internalRenderFrames)({
+                composition,
+                onFrameUpdate: (frame, frameIndex, timeToRenderInMilliseconds) => {
+                    renderedFrames = frame;
+                    callUpdate();
+                    recordFrameTime(frameIndex, timeToRenderInMilliseconds);
                 },
-                force: overwrite !== null && overwrite !== void 0 ? overwrite : overwrite_1.DEFAULT_OVERWRITE,
-                pixelFormat,
-                codec,
-                proResProfile,
-                crf,
-                assetsInfo,
-                onProgress: (frame) => {
-                    stitchStage = 'muxing';
-                    encodedFrames = frame;
+                concurrency,
+                outputDir: parallelEncoding ? null : workingDir,
+                onStart: (data) => {
+                    renderedFrames = 0;
                     callUpdate();
+                    onStart === null || onStart === void 0 ? void 0 : onStart(data);
                 },
+                inputProps,
+                envVariables,
+                imageFormat,
+                jpegQuality,
+                frameRange,
+                puppeteerInstance,
+                everyNthFrame,
+                onFrameBuffer: parallelEncoding
+                    ? async (buffer, frame) => {
+                        var _a;
+                        await waitForRightTimeOfFrameToBeInserted(frame);
+                        if (cancelled) {
+                            return;
+                        }
+                        const id = (0, perf_1.startPerfMeasure)('piping');
+                        (_a = stitcherFfmpeg === null || stitcherFfmpeg === void 0 ? void 0 : stitcherFfmpeg.stdin) === null || _a === void 0 ? void 0 : _a.write(buffer);
+                        (0, perf_1.stopPerfMeasure)(id);
+                        setFrameToStitch(Math.min(realFrameRange[1] + 1, frame + everyNthFrame));
+                    }
+                    : null,
+                webpackBundleOrServeUrl: serveUrl,
+                dumpBrowserLogs,
+                onBrowserLog,
                 onDownload,
-                numberOfGifLoops,
-                verbose: options.verbose,
-                dir: outputDir !== null && outputDir !== void 0 ? outputDir : undefined,
-                cancelSignal: cancelStitcher.cancelSignal,
+                timeoutInMilliseconds,
+                chromiumOptions,
+                scale,
+                browserExecutable,
+                port,
+                cancelSignal: cancelRenderFrames.cancelSignal,
                 muted: disableAudio,
-                enforceAudioTrack,
-                ffmpegOverride,
-                audioBitrate,
-                videoBitrate,
-                audioCodec: audioCodec !== null && audioCodec !== void 0 ? audioCodec : null,
-            }),
-            stitchStart,
-        ]);
-    })
-        .then(([buffer, stitchStart]) => {
-        encodedFrames = (0, get_duration_from_frame_range_1.getFramesToRender)(realFrameRange, everyNthFrame).length;
-        encodedDoneIn = Date.now() - stitchStart;
-        callUpdate();
-        slowestFrames.sort((a, b) => b.time - a.time);
-        const result = {
-            buffer,
-            slowestFrames,
-        };
-        return result;
-    })
-        .catch((err) => {
-        /**
-         * When an error is thrown in renderFrames(...) (e.g., when delayRender() is used incorrectly), fs.unlinkSync(...) throws an error that the file is locked because ffmpeg is still running, and renderMedia returns it.
-         * Therefore we first kill the FFMPEG process before deleting the file
-         */
-        cancelled = true;
-        cancelRenderFrames.cancel();
-        cancelStitcher.cancel();
-        cancelPrestitcher.cancel();
-        if (stitcherFfmpeg !== undefined && stitcherFfmpeg.exitCode === null) {
-            const promise = new Promise((resolve) => {
-                setTimeout(() => {
-                    resolve();
-                }, 2000);
-                stitcherFfmpeg.on('close', resolve);
-            });
-            stitcherFfmpeg.kill();
-            return promise.then(() => {
-                throw err;
+                verbose,
+                indent,
+                server,
             });
-        }
-        throw err;
-    })
-        .finally(() => {
-        var _a;
-        if (preEncodedFileLocation !== null &&
-            node_fs_1.default.existsSync(preEncodedFileLocation)) {
-            (0, delete_directory_1.deleteDirectory)(node_path_1.default.dirname(preEncodedFileLocation));
-        }
-        // Clean download map if it was not passed in
-        if (!((_a = options.internal) === null || _a === void 0 ? void 0 : _a.downloadMap)) {
-            (0, download_map_1.cleanDownloadMap)(downloadMap);
-        }
-        // Clean temporary image frames when rendering ends or fails
-        if (outputDir && node_fs_1.default.existsSync(outputDir)) {
-            (0, delete_directory_1.deleteDirectory)(outputDir);
-        }
+            return renderFramesProc;
+        })
+            .then((renderFramesReturn) => {
+            return Promise.all([
+                renderFramesReturn,
+                waitForPrestitcherIfNecessary(),
+            ]);
+        })
+            .then(([{ assetsInfo }]) => {
+            renderedDoneIn = Date.now() - renderStart;
+            callUpdate();
+            if (absoluteOutputLocation) {
+                (0, ensure_output_directory_1.ensureOutputDirectory)(absoluteOutputLocation);
+            }
+            const stitchStart = Date.now();
+            return Promise.all([
+                (0, stitch_frames_to_video_1.internalStitchFramesToVideo)({
+                    width: composition.width * scale,
+                    height: composition.height * scale,
+                    fps,
+                    outputLocation: absoluteOutputLocation,
+                    preEncodedFileLocation,
+                    preferLossless,
+                    indent,
+                    force: overwrite,
+                    pixelFormat,
+                    codec,
+                    proResProfile,
+                    crf,
+                    assetsInfo,
+                    onProgress: (frame) => {
+                        stitchStage = 'muxing';
+                        encodedFrames = frame;
+                        callUpdate();
+                    },
+                    onDownload,
+                    numberOfGifLoops,
+                    verbose,
+                    dir: workingDir,
+                    cancelSignal: cancelStitcher.cancelSignal,
+                    muted: disableAudio,
+                    enforceAudioTrack,
+                    ffmpegOverride: ffmpegOverride !== null && ffmpegOverride !== void 0 ? ffmpegOverride : null,
+                    audioBitrate,
+                    videoBitrate,
+                    audioCodec,
+                }),
+                stitchStart,
+            ]);
+        })
+            .then(([buffer, stitchStart]) => {
+            encodedFrames = (0, get_duration_from_frame_range_1.getFramesToRender)(realFrameRange, everyNthFrame).length;
+            encodedDoneIn = Date.now() - stitchStart;
+            callUpdate();
+            slowestFrames.sort((a, b) => b.time - a.time);
+            const result = {
+                buffer,
+                slowestFrames,
+            };
+            resolve(result);
+        })
+            .catch((err) => {
+            /**
+             * When an error is thrown in renderFrames(...) (e.g., when delayRender() is used incorrectly), fs.unlinkSync(...) throws an error that the file is locked because ffmpeg is still running, and renderMedia returns it.
+             * Therefore we first kill the FFMPEG process before deleting the file
+             */
+            cancelled = true;
+            cancelRenderFrames.cancel();
+            cancelStitcher.cancel();
+            cancelPrestitcher.cancel();
+            if (stitcherFfmpeg !== undefined && stitcherFfmpeg.exitCode === null) {
+                const promise = new Promise((res) => {
+                    setTimeout(() => {
+                        res();
+                    }, 2000);
+                    stitcherFfmpeg.on('close', res);
+                });
+                stitcherFfmpeg.kill();
+                return promise.then(() => {
+                    reject(err);
+                });
+            }
+            reject(err);
+        })
+            .finally(() => {
+            if (preEncodedFileLocation !== null &&
+                node_fs_1.default.existsSync(preEncodedFileLocation)) {
+                (0, delete_directory_1.deleteDirectory)(node_path_1.default.dirname(preEncodedFileLocation));
+            }
+            // Clean temporary image frames when rendering ends or fails
+            if (workingDir && node_fs_1.default.existsSync(workingDir)) {
+                (0, delete_directory_1.deleteDirectory)(workingDir);
+            }
+            cleanupServerFn === null || cleanupServerFn === void 0 ? void 0 : cleanupServerFn(false);
+        });
     });
     return Promise.race([
         happyPath,
@@ -390,4 +388,58 @@ const renderMedia = ({ proResProfile, crf, composition, inputProps, pixelFormat,
         }),
     ]);
 };
+exports.internalRenderMedia = internalRenderMedia;
+/**
+ *
+ * @description Render a video from a composition
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/render-media)
+ */
+const renderMedia = ({ proResProfile, crf, composition, inputProps, pixelFormat, codec, envVariables, frameRange, puppeteerInstance, outputLocation, onProgress, overwrite, onDownload, dumpBrowserLogs, onBrowserLog, onStart, timeoutInMilliseconds, chromiumOptions, scale, browserExecutable, port, cancelSignal, muted, enforceAudioTrack, ffmpegOverride, audioBitrate, videoBitrate, audioCodec, jpegQuality, concurrency, serveUrl, disallowParallelEncoding, everyNthFrame, imageFormat, numberOfGifLoops, preferLossless, verbose, quality, }) => {
+    var _a;
+    if (quality !== undefined) {
+        console.warn(`The "quality" option has been renamed. Please use "jpegQuality" instead.`);
+    }
+    return (0, exports.internalRenderMedia)({
+        proResProfile: proResProfile !== null && proResProfile !== void 0 ? proResProfile : undefined,
+        codec,
+        composition,
+        serveUrl,
+        audioBitrate: audioBitrate !== null && audioBitrate !== void 0 ? audioBitrate : null,
+        audioCodec: audioCodec !== null && audioCodec !== void 0 ? audioCodec : null,
+        browserExecutable: browserExecutable !== null && browserExecutable !== void 0 ? browserExecutable : null,
+        cancelSignal,
+        chromiumOptions: chromiumOptions !== null && chromiumOptions !== void 0 ? chromiumOptions : {},
+        concurrency: concurrency !== null && concurrency !== void 0 ? concurrency : null,
+        crf: crf !== null && crf !== void 0 ? crf : null,
+        disallowParallelEncoding: disallowParallelEncoding !== null && disallowParallelEncoding !== void 0 ? disallowParallelEncoding : false,
+        dumpBrowserLogs: dumpBrowserLogs !== null && dumpBrowserLogs !== void 0 ? dumpBrowserLogs : false,
+        enforceAudioTrack: enforceAudioTrack !== null && enforceAudioTrack !== void 0 ? enforceAudioTrack : false,
+        envVariables: envVariables !== null && envVariables !== void 0 ? envVariables : {},
+        everyNthFrame: everyNthFrame !== null && everyNthFrame !== void 0 ? everyNthFrame : 1,
+        ffmpegOverride: ffmpegOverride !== null && ffmpegOverride !== void 0 ? ffmpegOverride : undefined,
+        frameRange: frameRange !== null && frameRange !== void 0 ? frameRange : null,
+        imageFormat: imageFormat !== null && imageFormat !== void 0 ? imageFormat : image_format_1.DEFAULT_VIDEO_IMAGE_FORMAT,
+        inputProps: inputProps !== null && inputProps !== void 0 ? inputProps : {},
+        jpegQuality: (_a = jpegQuality !== null && jpegQuality !== void 0 ? jpegQuality : quality) !== null && _a !== void 0 ? _a : jpeg_quality_1.DEFAULT_JPEG_QUALITY,
+        muted: muted !== null && muted !== void 0 ? muted : false,
+        numberOfGifLoops: numberOfGifLoops !== null && numberOfGifLoops !== void 0 ? numberOfGifLoops : null,
+        onBrowserLog: onBrowserLog !== null && onBrowserLog !== void 0 ? onBrowserLog : null,
+        onDownload: onDownload !== null && onDownload !== void 0 ? onDownload : (() => undefined),
+        onProgress: onProgress !== null && onProgress !== void 0 ? onProgress : (() => undefined),
+        onStart: onStart !== null && onStart !== void 0 ? onStart : (() => undefined),
+        outputLocation: outputLocation !== null && outputLocation !== void 0 ? outputLocation : null,
+        overwrite: overwrite !== null && overwrite !== void 0 ? overwrite : overwrite_1.DEFAULT_OVERWRITE,
+        pixelFormat: pixelFormat !== null && pixelFormat !== void 0 ? pixelFormat : pixel_format_1.DEFAULT_PIXEL_FORMAT,
+        port: port !== null && port !== void 0 ? port : null,
+        puppeteerInstance: puppeteerInstance !== null && puppeteerInstance !== void 0 ? puppeteerInstance : undefined,
+        scale: scale !== null && scale !== void 0 ? scale : 1,
+        timeoutInMilliseconds: timeoutInMilliseconds !== null && timeoutInMilliseconds !== void 0 ? timeoutInMilliseconds : TimeoutSettings_1.DEFAULT_TIMEOUT,
+        videoBitrate: videoBitrate !== null && videoBitrate !== void 0 ? videoBitrate : null,
+        verbose: verbose !== null && verbose !== void 0 ? verbose : false,
+        preferLossless: preferLossless !== null && preferLossless !== void 0 ? preferLossless : false,
+        indent: false,
+        onCtrlCExit: () => undefined,
+        server: undefined,
+    });
+};
 exports.renderMedia = renderMedia;

package/dist/render-still.d.ts

@@ -1,23 +1,44 @@
 /// <reference types="node" />
 import type { AnySmallCompMetadata } from 'remotion';
 import type { RenderMediaOnDownload } from './assets/download-and-map-assets-to-file';
-import type { DownloadMap } from './assets/download-map';
 import type { BrowserExecutable } from './browser-executable';
 import type { BrowserLog } from './browser-log';
 import type { HeadlessBrowser } from './browser/Browser';
 import type { StillImageFormat } from './image-format';
 import type { CancelSignal } from './make-cancel-signal';
 import type { ChromiumOptions } from './open-browser';
-declare type InnerStillOptions = {
+import type { RemotionServer } from './prepare-server';
+type InternalRenderStillOptions = {
+    composition: AnySmallCompMetadata;
+    output: string | null;
+    frame: number;
+    inputProps: Record<string, unknown>;
+    imageFormat: StillImageFormat;
+    jpegQuality: number;
+    puppeteerInstance: HeadlessBrowser | null;
+    dumpBrowserLogs: boolean;
+    envVariables: Record<string, string>;
+    overwrite: boolean;
+    browserExecutable: BrowserExecutable;
+    onBrowserLog: null | ((log: BrowserLog) => void);
+    timeoutInMilliseconds: number;
+    chromiumOptions: ChromiumOptions;
+    scale: number;
+    onDownload: RenderMediaOnDownload | null;
+    cancelSignal: CancelSignal | null;
+    indent: boolean;
+    server: RemotionServer | undefined;
+    verbose: boolean;
+    serveUrl: string;
+    port: number | null;
+};
+export type RenderStillOptions = {
+    port?: number | null;
     composition: AnySmallCompMetadata;
     output?: string | null;
     frame?: number;
     inputProps?: Record<string, unknown>;
     imageFormat?: StillImageFormat;
-    /**
-     * @deprecated Renamed to `jpegQuality`
-     */
-    quality?: never;
     jpegQuality?: number;
     puppeteerInstance?: HeadlessBrowser;
     dumpBrowserLogs?: boolean;
@@ -30,23 +51,17 @@ declare type InnerStillOptions = {
     scale?: number;
     onDownload?: RenderMediaOnDownload;
     cancelSignal?: CancelSignal;
+    verbose?: boolean;
+    serveUrl: string;
     /**
-     * @deprecated Only for Remotion internal usage
-     */
-    downloadMap?: DownloadMap;
-    /**
-     * @deprecated Only for Remotion internal usage
+     * @deprecated Renamed to `jpegQuality`
      */
-    indent?: boolean;
-    verbose?: boolean;
+    quality?: never;
 };
-declare type RenderStillReturnValue = {
+type RenderStillReturnValue = {
     buffer: Buffer | null;
 };
-export declare type RenderStillOptions = InnerStillOptions & {
-    serveUrl: string;
-    port?: number | null;
-};
+export declare const internalRenderStill: (options: InternalRenderStillOptions) => Promise<RenderStillReturnValue>;
 /**
  *
  * @description Render a still frame from a composition