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

package/dist/render-media.d.ts

@@ -1,11 +1,14 @@
+/// <reference types="node" />
 import type { SmallTCompMetadata } from 'remotion';
 import type { RenderMediaOnDownload } from './assets/download-and-map-assets-to-file';
 import type { DownloadMap } from './assets/download-map';
+import type { AudioCodec } from './audio-codec';
 import type { BrowserExecutable } from './browser-executable';
 import type { BrowserLog } from './browser-log';
 import type { Browser as PuppeteerBrowser } from './browser/Browser';
 import type { Codec } from './codec';
 import type { FfmpegExecutable } from './ffmpeg-executable';
+import type { FfmpegOverrideFn } from './ffmpeg-override';
 import type { FrameRange } from './frame-range';
 import type { ServeUrlOrWebpackBundle } from './legacy-webpack-config';
 import type { CancelSignal } from './make-cancel-signal';
@@ -14,11 +17,17 @@ import type { PixelFormat } from './pixel-format';
 import type { ProResProfile } from './prores-profile';
 import type { OnStartData } from './types';
 export declare type StitchingState = 'encoding' | 'muxing';
+export declare type SlowFrame = {
+    frame: number;
+    time: number;
+};
+export declare type OnSlowestFrames = (frames: SlowFrame[]) => void;
 export declare type RenderMediaOnProgress = (progress: {
     renderedFrames: number;
     encodedFrames: number;
     encodedDoneIn: number | null;
     renderedDoneIn: number | null;
+    progress: number;
     stitchStage: StitchingState;
 }) => void;
 export declare type RenderMediaOptions = {
@@ -26,7 +35,6 @@ export declare type RenderMediaOptions = {
     codec: Codec;
     composition: SmallTCompMetadata;
     inputProps?: unknown;
-    parallelism?: number | null;
     crf?: number | null;
     imageFormat?: 'png' | 'jpeg' | 'none';
     ffmpegExecutable?: FfmpegExecutable;
@@ -52,14 +60,38 @@ export declare type RenderMediaOptions = {
     cancelSignal?: CancelSignal;
     browserExecutable?: BrowserExecutable;
     verbose?: boolean;
+    internal?: {
+        /**
+         * @deprecated Only for Remotion internal usage
+         */
+        downloadMap?: DownloadMap;
+        /**
+         * @deprecated Only for Remotion internal usage
+         */
+        onCtrlCExit?: (fn: () => void) => void;
+    };
+    preferLossless?: boolean;
+    muted?: boolean;
+    enforceAudioTrack?: boolean;
+    ffmpegOverride?: FfmpegOverrideFn;
+    audioBitrate?: string | null;
+    videoBitrate?: string | null;
+    onSlowestFrames?: OnSlowestFrames;
+    disallowParallelEncoding?: boolean;
+    audioCodec?: AudioCodec | null;
+} & ServeUrlOrWebpackBundle & ConcurrencyOrParallelism;
+declare type ConcurrencyOrParallelism = {
+    concurrency?: number | string | null;
+} | {
     /**
-     * @deprecated Only for Remotion internal usage
+     * @deprecated This field has been renamed to `concurrency`
      */
-    downloadMap?: DownloadMap;
-} & ServeUrlOrWebpackBundle;
+    parallelism?: number | null;
+};
 /**
  *
  * @description Render a video from a composition
- * @link https://www.remotion.dev/docs/renderer/render-media
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/render-media)
  */
-export declare const renderMedia: ({ parallelism, proResProfile, crf, composition, imageFormat, ffmpegExecutable, ffprobeExecutable, inputProps, pixelFormat, codec, envVariables, quality, frameRange, puppeteerInstance, outputLocation, onProgress, overwrite, onDownload, dumpBrowserLogs, onBrowserLog, onStart, timeoutInMilliseconds, chromiumOptions, scale, browserExecutable, port, cancelSignal, ...options }: RenderMediaOptions) => Promise<Buffer | null>;
+export declare const renderMedia: ({ proResProfile, crf, composition, ffmpegExecutable, ffprobeExecutable, inputProps, pixelFormat, codec, envVariables, frameRange, puppeteerInstance, outputLocation, onProgress, overwrite, onDownload, dumpBrowserLogs, onBrowserLog, onStart, timeoutInMilliseconds, chromiumOptions, scale, browserExecutable, port, cancelSignal, muted, enforceAudioTrack, ffmpegOverride, audioBitrate, videoBitrate, onSlowestFrames, audioCodec, ...options }: RenderMediaOptions) => Promise<Buffer | null>;
+export {};

package/dist/render-media.js

@@ -10,43 +10,81 @@ const path_1 = __importDefault(require("path"));
 const remotion_1 = require("remotion");
 const download_map_1 = require("./assets/download-map");
 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_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");
 const get_frame_to_render_1 = require("./get-frame-to-render");
+const image_format_1 = require("./image-format");
+const is_audio_codec_1 = require("./is-audio-codec");
 const legacy_webpack_config_1 = require("./legacy-webpack-config");
 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 prespawn_ffmpeg_1 = require("./prespawn-ffmpeg");
 const prestitcher_memory_usage_1 = require("./prestitcher-memory-usage");
+const prores_profile_1 = require("./prores-profile");
 const quality_1 = require("./quality");
 const render_frames_1 = require("./render-frames");
 const stitch_frames_to_video_1 = require("./stitch-frames-to-video");
 const validate_even_dimensions_with_codec_1 = require("./validate-even-dimensions-with-codec");
+const validate_every_nth_frame_1 = require("./validate-every-nth-frame");
+const validate_ffmpeg_1 = require("./validate-ffmpeg");
+const validate_ffmpeg_override_1 = require("./validate-ffmpeg-override");
 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;
+const getConcurrency = (others) => {
+    if ('concurrency' in others) {
+        return others.concurrency;
+    }
+    if ('parallelism' in others) {
+        return others.parallelism;
+    }
+    return null;
+};
 /**
  *
  * @description Render a video from a composition
- * @link https://www.remotion.dev/docs/renderer/render-media
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/render-media)
  */
-const renderMedia = ({ parallelism, proResProfile, crf, composition, imageFormat, ffmpegExecutable, ffprobeExecutable, inputProps, pixelFormat, codec, envVariables, quality, frameRange, puppeteerInstance, outputLocation, onProgress, overwrite, onDownload, dumpBrowserLogs, onBrowserLog, onStart, timeoutInMilliseconds, chromiumOptions, scale, browserExecutable, port, cancelSignal, ...options }) => {
-    var _a, _b, _c;
-    (0, quality_1.validateQuality)(quality);
-    if (typeof crf !== 'undefined' && crf !== null) {
-        (0, crf_1.validateSelectedCrfAndCodecCombination)(crf, codec);
-    }
+const renderMedia = ({ proResProfile, crf, composition, ffmpegExecutable, ffprobeExecutable, inputProps, pixelFormat, codec, envVariables, frameRange, puppeteerInstance, outputLocation, onProgress, overwrite, onDownload, dumpBrowserLogs, onBrowserLog, onStart, timeoutInMilliseconds, chromiumOptions, scale, browserExecutable, port, cancelSignal, muted, enforceAudioTrack, ffmpegOverride, audioBitrate, videoBitrate, onSlowestFrames, audioCodec, ...options }) => {
+    var _a, _b, _c, _d, _e, _f, _g;
+    const remotionRoot = (0, find_closest_package_json_1.findRemotionRoot)();
+    (0, validate_ffmpeg_1.validateFfmpeg)(ffmpegExecutable !== null && ffmpegExecutable !== void 0 ? ffmpegExecutable : null, remotionRoot, 'ffmpeg');
+    (0, quality_1.validateQuality)(options.quality);
+    (0, crf_1.validateQualitySettings)({ crf, codec, videoBitrate });
+    (0, validate_videobitrate_1.validateBitrate)(audioBitrate, 'audioBitrate');
+    (0, validate_videobitrate_1.validateBitrate)(videoBitrate, 'videoBitrate');
+    (0, prores_profile_1.validateSelectedCodecAndProResCombination)({
+        codec,
+        proResProfile,
+    });
+    (0, pixel_format_1.validateSelectedPixelFormatAndCodecCombination)(pixelFormat, codec);
     if (outputLocation) {
-        (0, validate_output_filename_1.validateOutputFilename)(codec, (0, get_extension_of_filename_1.getExtensionOfFilename)(outputLocation));
+        (0, validate_output_filename_1.validateOutputFilename)({
+            codec,
+            audioCodec: audioCodec !== null && audioCodec !== void 0 ? audioCodec : null,
+            extension: (0, get_extension_of_filename_1.getExtensionOfFilename)(outputLocation),
+            preferLossless: (_a = options.preferLossless) !== null && _a !== void 0 ? _a : false,
+        });
     }
+    const absoluteOutputLocation = outputLocation
+        ? path_1.default.resolve(process.cwd(), outputLocation)
+        : null;
     (0, validate_scale_1.validateScale)(scale);
-    const everyNthFrame = (_a = options.everyNthFrame) !== null && _a !== void 0 ? _a : 1;
-    const numberOfGifLoops = (_b = options.numberOfGifLoops) !== null && _b !== void 0 ? _b : null;
+    const concurrency = getConcurrency(options);
+    (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;
     const serveUrl = (0, legacy_webpack_config_1.getServeUrlWithFallback)(options);
     let stitchStage = 'encoding';
     let stitcherFfmpeg;
@@ -57,29 +95,39 @@ const renderMedia = ({ parallelism, proResProfile, crf, composition, imageFormat
     let encodedDoneIn = null;
     let cancelled = false;
     const renderStart = Date.now();
-    const downloadMap = (_c = options.downloadMap) !== null && _c !== void 0 ? _c : (0, download_map_1.makeDownloadMap)();
+    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 = hasEnoughMemory && (0, can_use_parallel_encoding_1.canUseParallelEncoding)(codec);
+    const parallelEncoding = !options.disallowParallelEncoding &&
+        hasEnoughMemory &&
+        (0, can_use_parallel_encoding_1.canUseParallelEncoding)(codec);
     if (options.verbose) {
         console.log('[PRESTITCHER] Free memory:', freeMemory, 'Estimated usage parallel encoding', estimatedUsage);
-        console.log('[PRESTICHER]: Codec supports parallel rendering:', (0, can_use_parallel_encoding_1.canUseParallelEncoding)(codec));
+        console.log('[PRESTITCHER]: Codec supports parallel rendering:', (0, can_use_parallel_encoding_1.canUseParallelEncoding)(codec));
+        console.log('[PRESTITCHER]: User disallowed parallel encoding:', Boolean(options.disallowParallelEncoding));
         if (parallelEncoding) {
-            console.log('[PRESTICHER] Parallel encoding is enabled.');
+            console.log('[PRESTITCHER] Parallel encoding is enabled.');
         }
         else {
             console.log('[PRESTITCHER] Parallel encoding is disabled.');
         }
     }
-    const actualImageFormat = imageFormat !== null && imageFormat !== void 0 ? imageFormat : 'jpeg';
+    const imageFormat = (0, is_audio_codec_1.isAudioCodec)(codec)
+        ? 'none'
+        : (_f = options.imageFormat) !== null && _f !== void 0 ? _f : 'jpeg';
+    const quality = imageFormat === 'jpeg' ? options.quality : undefined;
+    (0, image_format_1.validateSelectedPixelFormatAndImageFormatCombination)(pixelFormat, imageFormat);
     const preEncodedFileLocation = parallelEncoding
-        ? path_1.default.join(downloadMap.preEncode, 'pre-encode.' + (0, get_extension_from_codec_1.getFileExtensionFromCodec)(codec, 'chunk'))
+        ? path_1.default.join(downloadMap.preEncode, 'pre-encode.' + (0, get_extension_from_codec_1.getFileExtensionFromCodec)(codec, audioCodec !== null && audioCodec !== void 0 ? audioCodec : null))
         : null;
     const outputDir = parallelEncoding
         ? null
         : fs_1.default.mkdtempSync(path_1.default.join(os_1.default.tmpdir(), 'react-motion-render'));
+    if (((_g = options.internal) === null || _g === void 0 ? void 0 : _g.onCtrlCExit) && outputDir) {
+        options.internal.onCtrlCExit(() => (0, delete_directory_1.deleteDirectory)(outputDir));
+    }
     (0, validate_even_dimensions_with_codec_1.validateEvenDimensionsWithCodec)({
         codec,
         height: composition.height,
@@ -93,6 +141,9 @@ const renderMedia = ({ parallelism, proResProfile, crf, composition, imageFormat
             renderedDoneIn,
             renderedFrames,
             stitchStage,
+            progress: Math.round(((0.7 * renderedFrames + 0.3 * encodedFrames) /
+                composition.durationInFrames) *
+                100) / 100,
         });
     };
     const realFrameRange = (0, get_frame_to_render_1.getRealFrameRange)(composition.durationInFrames, frameRange !== null && frameRange !== void 0 ? frameRange : null);
@@ -123,9 +174,11 @@ const renderMedia = ({ parallelism, proResProfile, crf, composition, imageFormat
                 },
                 verbose: (_a = options.verbose) !== null && _a !== void 0 ? _a : false,
                 ffmpegExecutable,
-                imageFormat: actualImageFormat,
+                imageFormat,
                 signal: cancelPrestitcher.cancelSignal,
-            });
+                ffmpegOverride: ffmpegOverride !== null && ffmpegOverride !== void 0 ? ffmpegOverride : (({ args }) => args),
+                videoBitrate: videoBitrate !== null && videoBitrate !== void 0 ? videoBitrate : null,
+            }, remotionRoot);
             stitcherFfmpeg = preStitcher.task;
         }
     };
@@ -142,15 +195,42 @@ const renderMedia = ({ parallelism, proResProfile, crf, composition, imageFormat
             }
         }
     };
+    const mediaSupport = (0, codec_supports_media_1.codecSupportsMedia)(codec);
+    const disableAudio = !mediaSupport.audio || muted;
+    const slowestFrames = [];
+    let maxTime = 0;
+    let minTime = 0;
+    const recordFrameTime = (frameIndex, time) => {
+        var _a, _b;
+        const frameTime = { frame: frameIndex, time };
+        if (time < minTime && slowestFrames.length === SLOWEST_FRAME_COUNT) {
+            return;
+        }
+        if (time > maxTime) {
+            // add at starting;
+            slowestFrames.unshift(frameTime);
+            maxTime = time;
+        }
+        else {
+            // add frame at appropriate position
+            const index = slowestFrames.findIndex(({ time: indexTime }) => indexTime < time);
+            slowestFrames.splice(index, 0, frameTime);
+        }
+        if (slowestFrames.length > SLOWEST_FRAME_COUNT) {
+            slowestFrames.pop();
+        }
+        minTime = (_b = (_a = slowestFrames[slowestFrames.length - 1]) === null || _a === void 0 ? void 0 : _a.time) !== null && _b !== void 0 ? _b : minTime;
+    };
     const happyPath = createPrestitcherIfNecessary()
         .then(() => {
         const renderFramesProc = (0, render_frames_1.renderFrames)({
             config: composition,
-            onFrameUpdate: (frame) => {
+            onFrameUpdate: (frame, frameIndex, timeToRenderInMilliseconds) => {
                 renderedFrames = frame;
                 callUpdate();
+                recordFrameTime(frameIndex, timeToRenderInMilliseconds);
             },
-            parallelism,
+            concurrency,
             outputDir,
             onStart: (data) => {
                 renderedFrames = 0;
@@ -159,7 +239,7 @@ const renderMedia = ({ parallelism, proResProfile, crf, composition, imageFormat
             },
             inputProps,
             envVariables,
-            imageFormat: actualImageFormat,
+            imageFormat,
             quality,
             frameRange: frameRange !== null && frameRange !== void 0 ? frameRange : null,
             puppeteerInstance,
@@ -190,6 +270,7 @@ const renderMedia = ({ parallelism, proResProfile, crf, composition, imageFormat
             port,
             cancelSignal: cancelRenderFrames.cancelSignal,
             downloadMap,
+            muted: disableAudio,
         });
         return renderFramesProc;
     })
@@ -197,10 +278,11 @@ const renderMedia = ({ parallelism, proResProfile, crf, composition, imageFormat
         return Promise.all([renderFramesReturn, waitForPrestitcherIfNecessary()]);
     })
         .then(([{ assetsInfo }]) => {
+        var _a;
         renderedDoneIn = Date.now() - renderStart;
         callUpdate();
-        if (outputLocation) {
-            (0, ensure_output_directory_1.ensureOutputDirectory)(outputLocation);
+        if (absoluteOutputLocation) {
+            (0, ensure_output_directory_1.ensureOutputDirectory)(absoluteOutputLocation);
         }
         const stitchStart = Date.now();
         return Promise.all([
@@ -208,10 +290,11 @@ const renderMedia = ({ parallelism, proResProfile, crf, composition, imageFormat
                 width: composition.width * (scale !== null && scale !== void 0 ? scale : 1),
                 height: composition.height * (scale !== null && scale !== void 0 ? scale : 1),
                 fps,
-                outputLocation,
+                outputLocation: absoluteOutputLocation,
                 internalOptions: {
                     preEncodedFileLocation,
-                    imageFormat: actualImageFormat,
+                    imageFormat,
+                    preferLossless: (_a = options.preferLossless) !== null && _a !== void 0 ? _a : false,
                 },
                 force: overwrite !== null && overwrite !== void 0 ? overwrite : overwrite_1.DEFAULT_OVERWRITE,
                 pixelFormat,
@@ -231,6 +314,12 @@ const renderMedia = ({ parallelism, proResProfile, crf, composition, imageFormat
                 verbose: options.verbose,
                 dir: outputDir !== null && outputDir !== void 0 ? outputDir : undefined,
                 cancelSignal: cancelStitcher.cancelSignal,
+                muted: disableAudio,
+                enforceAudioTrack,
+                ffmpegOverride,
+                audioBitrate,
+                videoBitrate,
+                audioCodec: audioCodec !== null && audioCodec !== void 0 ? audioCodec : null,
             }),
             stitchStart,
         ]);
@@ -239,6 +328,8 @@ const renderMedia = ({ parallelism, proResProfile, crf, composition, imageFormat
         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);
+        onSlowestFrames === null || onSlowestFrames === void 0 ? void 0 : onSlowestFrames(slowestFrames);
         return buffer;
     })
         .catch((err) => {
@@ -265,20 +356,25 @@ const renderMedia = ({ parallelism, proResProfile, crf, composition, imageFormat
         throw err;
     })
         .finally(() => {
+        var _a;
         if (preEncodedFileLocation !== null &&
             fs_1.default.existsSync(preEncodedFileLocation)) {
             (0, delete_directory_1.deleteDirectory)(path_1.default.dirname(preEncodedFileLocation));
         }
         // Clean download map if it was not passed in
-        if (!(options === null || options === void 0 ? void 0 : options.downloadMap)) {
+        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 && fs_1.default.existsSync(outputDir)) {
+            (0, delete_directory_1.deleteDirectory)(outputDir);
+        }
     });
     return Promise.race([
         happyPath,
         new Promise((_resolve, reject) => {
             cancelSignal === null || cancelSignal === void 0 ? void 0 : cancelSignal(() => {
-                reject(new Error('renderMedia() got cancelled'));
+                reject(new Error(make_cancel_signal_1.cancelErrorMessages.renderMedia));
             });
         }),
     ]);

package/dist/render-still.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import type { SmallTCompMetadata } from 'remotion';
 import type { RenderMediaOnDownload } from './assets/download-and-map-assets-to-file';
 import type { DownloadMap } from './assets/download-map';
@@ -10,7 +11,7 @@ import type { CancelSignal } from './make-cancel-signal';
 import type { ChromiumOptions } from './open-browser';
 declare type InnerStillOptions = {
     composition: SmallTCompMetadata;
-    output: string;
+    output?: string | null;
     frame?: number;
     inputProps?: unknown;
     imageFormat?: StillImageFormat;
@@ -32,13 +33,16 @@ declare type InnerStillOptions = {
      */
     downloadMap?: DownloadMap;
 };
-declare type RenderStillOptions = InnerStillOptions & ServeUrlOrWebpackBundle & {
+declare type RenderStillReturnValue = {
+    buffer: Buffer | null;
+};
+export declare type RenderStillOptions = InnerStillOptions & ServeUrlOrWebpackBundle & {
     port?: number | null;
 };
 /**
  *
  * @description Render a still frame from a composition
- * @link https://www.remotion.dev/docs/renderer/render-still
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/render-still)
  */
-export declare const renderStill: (options: RenderStillOptions) => Promise<void>;
+export declare const renderStill: (options: RenderStillOptions) => Promise<RenderStillReturnValue>;
 export {};

package/dist/render-still.js

@@ -32,47 +32,61 @@ const path_1 = __importDefault(require("path"));
 const remotion_1 = require("remotion");
 const download_map_1 = require("./assets/download-map");
 const browser_1 = require("./browser");
+const convert_to_positive_frame_index_1 = require("./convert-to-positive-frame-index");
 const ensure_output_directory_1 = require("./ensure-output-directory");
 const handle_javascript_exception_1 = require("./error-handling/handle-javascript-exception");
+const find_closest_package_json_1 = require("./find-closest-package-json");
 const image_format_1 = require("./image-format");
 const legacy_webpack_config_1 = require("./legacy-webpack-config");
+const make_cancel_signal_1 = require("./make-cancel-signal");
 const open_browser_1 = require("./open-browser");
 const prepare_server_1 = require("./prepare-server");
-const provide_screenshot_1 = require("./provide-screenshot");
 const puppeteer_evaluate_1 = require("./puppeteer-evaluate");
 const quality_1 = require("./quality");
 const seek_to_frame_1 = require("./seek-to-frame");
 const set_props_and_env_1 = require("./set-props-and-env");
-const validate_frame_1 = require("./validate-frame");
+const take_frame_and_compose_1 = require("./take-frame-and-compose");
 const validate_puppeteer_timeout_1 = require("./validate-puppeteer-timeout");
 const validate_scale_1 = require("./validate-scale");
-const innerRenderStill = async ({ composition, quality, imageFormat = 'png', serveUrl, puppeteerInstance, dumpBrowserLogs = false, onError, inputProps, envVariables, output, frame = 0, overwrite = true, browserExecutable, timeoutInMilliseconds, chromiumOptions, scale, proxyPort, cancelSignal, }) => {
+const innerRenderStill = async ({ composition, quality, imageFormat = 'png', serveUrl, puppeteerInstance, dumpBrowserLogs = false, onError, inputProps, envVariables, output, frame = 0, overwrite = true, browserExecutable, timeoutInMilliseconds, chromiumOptions, scale = 1, proxyPort, cancelSignal, downloadMap, }) => {
     remotion_1.Internals.validateDimension(composition.height, 'height', 'in the `config` object passed to `renderStill()`');
     remotion_1.Internals.validateDimension(composition.width, 'width', 'in the `config` object passed to `renderStill()`');
     remotion_1.Internals.validateFps(composition.fps, 'in the `config` object of `renderStill()`', false);
-    remotion_1.Internals.validateDurationInFrames(composition.durationInFrames, 'in the `config` object passed to `renderStill()`');
+    remotion_1.Internals.validateDurationInFrames({
+        durationInFrames: composition.durationInFrames,
+        component: 'in the `config` object passed to `renderStill()`',
+        allowFloats: false,
+    });
     (0, image_format_1.validateNonNullImageFormat)(imageFormat);
-    (0, validate_frame_1.validateFrame)(frame, composition.durationInFrames);
+    remotion_1.Internals.validateFrame({
+        frame,
+        durationInFrames: composition.durationInFrames,
+        allowFloats: false,
+    });
+    const stillFrame = (0, convert_to_positive_frame_index_1.convertToPositiveFrameIndex)({
+        durationInFrames: composition.durationInFrames,
+        frame,
+    });
     (0, validate_puppeteer_timeout_1.validatePuppeteerTimeout)(timeoutInMilliseconds);
     (0, validate_scale_1.validateScale)(scale);
-    if (typeof output !== 'string') {
-        throw new TypeError('`output` parameter was not passed or is not a string');
-    }
-    output = path_1.default.resolve(process.cwd(), output);
+    output =
+        typeof output === 'string' ? path_1.default.resolve(process.cwd(), output) : null;
     if (quality !== undefined && imageFormat !== 'jpeg') {
         throw new Error("You can only pass the `quality` option if `imageFormat` is 'jpeg'.");
     }
     (0, quality_1.validateQuality)(quality);
-    if (fs_1.default.existsSync(output)) {
-        if (!overwrite) {
-            throw new Error(`Cannot render still - "overwrite" option was set to false, but the output destination ${output} already exists.`);
-        }
-        const stat = (0, fs_1.statSync)(output);
-        if (!stat.isFile()) {
-            throw new Error(`The output location ${output} already exists, but is not a file, but something else (e.g. folder). Cannot save to it.`);
+    if (output) {
+        if (fs_1.default.existsSync(output)) {
+            if (!overwrite) {
+                throw new Error(`Cannot render still - "overwrite" option was set to false, but the output destination ${output} already exists.`);
+            }
+            const stat = (0, fs_1.statSync)(output);
+            if (!stat.isFile()) {
+                throw new Error(`The output location ${output} already exists, but is not a file, but something else (e.g. folder). Cannot save to it.`);
+            }
         }
+        (0, ensure_output_directory_1.ensureOutputDirectory)(output);
     }
-    (0, ensure_output_directory_1.ensureOutputDirectory)(output);
     const browserInstance = puppeteerInstance !== null && puppeteerInstance !== void 0 ? puppeteerInstance : (await (0, open_browser_1.openBrowser)(browser_1.DEFAULT_BROWSER, {
         browserExecutable,
         shouldDumpIo: dumpBrowserLogs,
@@ -100,7 +114,7 @@ const innerRenderStill = async ({ composition, quality, imageFormat = 'png', ser
             await page.close();
         }
         else {
-            browserInstance.close().catch((err) => {
+            browserInstance.close(true).catch((err) => {
                 console.log('Unable to close browser', err);
             });
         }
@@ -113,38 +127,57 @@ const innerRenderStill = async ({ composition, quality, imageFormat = 'png', ser
         envVariables,
         page,
         serveUrl,
-        initialFrame: frame,
+        initialFrame: stillFrame,
         timeoutInMilliseconds,
         proxyPort,
         retriesRemaining: 2,
+        audioEnabled: false,
+        videoEnabled: true,
     });
     await (0, puppeteer_evaluate_1.puppeteerEvaluateWithCatch)({
-        pageFunction: (id) => {
+        // eslint-disable-next-line max-params
+        pageFunction: (id, defaultProps, durationInFrames, fps, height, width) => {
             window.setBundleMode({
                 type: 'composition',
                 compositionName: id,
+                compositionDefaultProps: defaultProps,
+                compositionDurationInFrames: durationInFrames,
+                compositionFps: fps,
+                compositionHeight: height,
+                compositionWidth: width,
             });
         },
-        args: [composition.id],
+        args: [
+            composition.id,
+            composition.defaultProps,
+            composition.durationInFrames,
+            composition.fps,
+            composition.height,
+            composition.width,
+        ],
         frame: null,
         page,
     });
-    await (0, seek_to_frame_1.seekToFrame)({ frame, page });
-    await (0, provide_screenshot_1.provideScreenshot)({
-        page,
+    await (0, seek_to_frame_1.seekToFrame)({ frame: stillFrame, page });
+    const { buffer } = await (0, take_frame_and_compose_1.takeFrameAndCompose)({
+        downloadMap,
+        frame: stillFrame,
+        freePage: page,
+        height: composition.height,
+        width: composition.width,
         imageFormat,
+        scale,
+        output,
         quality,
-        options: {
-            frame,
-            output,
-        },
+        wantsBuffer: !output,
     });
     await cleanup();
+    return { buffer: output ? null : buffer };
 };
 /**
  *
  * @description Render a still frame from a composition
- * @link https://www.remotion.dev/docs/renderer/render-still
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/render-still)
  */
 const renderStill = (options) => {
     var _a, _b;
@@ -163,6 +196,7 @@ const renderStill = (options) => {
             ffprobeExecutable: (_b = options.ffprobeExecutable) !== null && _b !== void 0 ? _b : null,
             port: (_c = options.port) !== null && _c !== void 0 ? _c : null,
             downloadMap,
+            remotionRoot: (0, find_closest_package_json_1.findRemotionRoot)(),
         })
             .then(({ serveUrl, closeServer, offthreadPort }) => {
             close = closeServer;
@@ -171,6 +205,7 @@ const renderStill = (options) => {
                 serveUrl,
                 onError: (err) => reject(err),
                 proxyPort: offthreadPort,
+                downloadMap,
             });
         })
             .then((res) => resolve(res))
@@ -180,7 +215,7 @@ const renderStill = (options) => {
             if (!(options === null || options === void 0 ? void 0 : options.downloadMap)) {
                 (0, download_map_1.cleanDownloadMap)(downloadMap);
             }
-            return close === null || close === void 0 ? void 0 : close();
+            return close === null || close === void 0 ? void 0 : close(false);
         });
     });
     return Promise.race([
@@ -188,7 +223,7 @@ const renderStill = (options) => {
         new Promise((_resolve, reject) => {
             var _a;
             (_a = options.cancelSignal) === null || _a === void 0 ? void 0 : _a.call(options, () => {
-                reject(new Error('renderStill() got cancelled'));
+                reject(new Error(make_cancel_signal_1.cancelErrorMessages.renderStill));
             });
         }),
     ]);

package/dist/replace-browser.d.ts

@@ -0,0 +1,6 @@
+import type { Browser } from './browser/Browser';
+export declare type BrowserReplacer = {
+    getBrowser: () => Browser;
+    replaceBrowser: (make: () => Promise<Browser>, makeNewPages: () => Promise<void>) => Promise<Browser>;
+};
+export declare const handleBrowserCrash: (instance: Browser) => BrowserReplacer;