@remotion/renderer 4.0.0-alpha13 → 4.0.0-alpha16

package/dist/render-frames.js

@@ -3,15 +3,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.renderFrames = void 0;
+exports.renderFrames = exports.internalRenderFrames = void 0;
 const node_fs_1 = __importDefault(require("node:fs"));
 const node_path_1 = __importDefault(require("node:path"));
 const perf_hooks_1 = require("perf_hooks");
 const remotion_1 = require("remotion");
 const download_and_map_assets_to_file_1 = require("./assets/download-and-map-assets-to-file");
-const download_map_1 = require("./assets/download-map");
 const browser_1 = require("./browser");
 const is_target_closed_err_1 = require("./browser/is-target-closed-err");
+const TimeoutSettings_1 = require("./browser/TimeoutSettings");
 const compress_assets_1 = require("./compress-assets");
 const cycle_browser_tabs_1 = require("./cycle-browser-tabs");
 const handle_javascript_exception_1 = require("./error-handling/handle-javascript-exception");
@@ -20,7 +20,6 @@ const get_concurrency_1 = require("./get-concurrency");
 const get_duration_from_frame_range_1 = require("./get-duration-from-frame-range");
 const get_frame_padded_index_1 = require("./get-frame-padded-index");
 const get_frame_to_render_1 = require("./get-frame-to-render");
-const image_format_1 = require("./image-format");
 const jpeg_quality_1 = require("./jpeg-quality");
 const make_cancel_signal_1 = require("./make-cancel-signal");
 const open_browser_1 = require("./open-browser");
@@ -35,7 +34,7 @@ const take_frame_and_compose_1 = require("./take-frame-and-compose");
 const truthy_1 = require("./truthy");
 const validate_scale_1 = require("./validate-scale");
 const MAX_RETRIES_PER_FRAME = 1;
-const innerRenderFrames = ({ onFrameUpdate, outputDir, onStart, inputProps, jpegQuality, quality, imageFormat = image_format_1.DEFAULT_VIDEO_IMAGE_FORMAT, frameRange, onError, envVariables, onBrowserLog, onFrameBuffer, onDownload, pagesArray, serveUrl, composition, timeoutInMilliseconds, scale = 1, actualConcurrency, everyNthFrame = 1, proxyPort, cancelSignal, downloadMap, muted, makeBrowser, browserReplacer, compositor, }) => {
+const innerRenderFrames = async ({ onFrameUpdate, outputDir, onStart, inputProps, jpegQuality, imageFormat, frameRange, onError, envVariables, onBrowserLog, onFrameBuffer, onDownload, pagesArray, serveUrl, composition, timeoutInMilliseconds, scale, actualConcurrency, everyNthFrame, proxyPort, cancelSignal, downloadMap, muted, makeBrowser, browserReplacer, compositor, sourcemapContext, }) => {
     if (outputDir) {
         if (!node_fs_1.default.existsSync(outputDir)) {
             node_fs_1.default.mkdirSync(outputDir, {
@@ -43,20 +42,17 @@ const innerRenderFrames = ({ onFrameUpdate, outputDir, onStart, inputProps, jpeg
             });
         }
     }
-    if (quality) {
-        throw new Error(`The "quality" option has been renamed. Use "jpegQuality" instead.`);
-    }
     const downloadPromises = [];
-    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 framesToRender = (0, get_duration_from_frame_range_1.getFramesToRender)(realFrameRange, everyNthFrame);
     const lastFrame = framesToRender[framesToRender.length - 1];
-    const makePage = async () => {
-        const page = await browserReplacer.getBrowser().newPage();
+    const makePage = async (context) => {
+        const page = await browserReplacer.getBrowser().newPage(context);
         pagesArray.push(page);
         await page.setViewport({
             width: composition.width,
             height: composition.height,
-            deviceScaleFactor: scale !== null && scale !== void 0 ? scale : 1,
+            deviceScaleFactor: scale,
         });
         const logCallback = (log) => {
             onBrowserLog === null || onBrowserLog === void 0 ? void 0 : onBrowserLog({
@@ -84,7 +80,7 @@ const innerRenderFrames = ({ onFrameUpdate, outputDir, onStart, inputProps, jpeg
         await (0, puppeteer_evaluate_1.puppeteerEvaluateWithCatch)({
             // eslint-disable-next-line max-params
             pageFunction: (id, defaultProps, durationInFrames, fps, height, width) => {
-                window.setBundleMode({
+                window.remotion_setBundleMode({
                     type: 'composition',
                     compositionName: id,
                     compositionDefaultProps: defaultProps,
@@ -108,8 +104,10 @@ const innerRenderFrames = ({ onFrameUpdate, outputDir, onStart, inputProps, jpeg
         page.off('console', logCallback);
         return page;
     };
-    const getPool = async () => {
-        const pages = new Array(actualConcurrency).fill(true).map(() => makePage());
+    const getPool = async (context) => {
+        const pages = new Array(actualConcurrency)
+            .fill(true)
+            .map(() => makePage(context));
         const puppeteerPages = await Promise.all(pages);
         const pool = new pool_1.Pool(puppeteerPages);
         return pool;
@@ -123,8 +121,8 @@ const innerRenderFrames = ({ onFrameUpdate, outputDir, onStart, inputProps, jpeg
         countType,
     });
     let framesRendered = 0;
-    const poolPromise = getPool();
-    onStart({
+    const poolPromise = getPool(sourcemapContext);
+    onStart === null || onStart === void 0 ? void 0 : onStart({
         frameCount: framesToRender.length,
     });
     const assets = new Array(framesToRender.length).fill(undefined);
@@ -196,7 +194,7 @@ const innerRenderFrames = ({ onFrameUpdate, outputDir, onStart, inputProps, jpeg
             });
         });
         framesRendered++;
-        onFrameUpdate(framesRendered, frame, perf_hooks_1.performance.now() - startTime);
+        onFrameUpdate === null || onFrameUpdate === void 0 ? void 0 : onFrameUpdate(framesRendered, frame, perf_hooks_1.performance.now() - startTime);
         cleanupPageError();
         freePage.off('error', errorCallbackOnFrame);
         pool.release(freePage);
@@ -247,7 +245,7 @@ const innerRenderFrames = ({ onFrameUpdate, outputDir, onStart, inputProps, jpeg
             await browserReplacer.replaceBrowser(makeBrowser, async () => {
                 const pages = new Array(actualConcurrency)
                     .fill(true)
-                    .map(() => makePage());
+                    .map(() => makePage(sourcemapContext));
                 const puppeteerPages = await Promise.all(pages);
                 const pool = await poolPromise;
                 for (const newPage of puppeteerPages) {
@@ -281,22 +279,11 @@ const innerRenderFrames = ({ onFrameUpdate, outputDir, onStart, inputProps, jpeg
         };
         return returnValue;
     });
-    return happyPath
-        .then(() => {
-        return Promise.all(downloadPromises);
-    })
-        .then(() => happyPath);
+    const result = await happyPath;
+    await Promise.all(downloadPromises);
+    return result;
 };
-/**
- * @description Renders a series of images using Puppeteer and computes information for mixing audio.
- * @see [Documentation](https://www.remotion.dev/docs/renderer/render-frames)
- */
-const renderFrames = (options) => {
-    var _a, _b, _c;
-    const { composition, concurrency } = options;
-    if (!composition) {
-        throw new Error('No `composition` option has been specified for renderFrames()');
-    }
+const internalRenderFrames = ({ browserExecutable, cancelSignal, chromiumOptions, composition, concurrency, dumpBrowserLogs, envVariables, everyNthFrame, frameRange, imageFormat, indent, inputProps, jpegQuality, muted, onBrowserLog, onDownload, onFrameBuffer, onFrameUpdate, onStart, outputDir, port, puppeteerInstance, scale, server, timeoutInMilliseconds, verbose, webpackBundleOrServeUrl, }) => {
     remotion_1.Internals.validateDimension(composition.height, 'height', 'in the `config` object passed to `renderFrames()`');
     remotion_1.Internals.validateDimension(composition.width, 'width', 'in the `config` object passed to `renderFrames()`');
     remotion_1.Internals.validateFps(composition.fps, 'in the `config` object of `renderFrames()`', false);
@@ -305,63 +292,49 @@ const renderFrames = (options) => {
         component: 'in the `config` object passed to `renderFrames()`',
         allowFloats: false,
     });
-    if (options.jpegQuality !== undefined && options.imageFormat !== 'jpeg') {
-        throw new Error("You can only pass the `jpegQuality` option if `imageFormat` is 'jpeg'.");
-    }
-    (0, jpeg_quality_1.validateJpegQuality)(options.jpegQuality);
-    (0, validate_scale_1.validateScale)(options.scale);
-    const makeBrowser = () => {
-        var _a, _b;
-        return (0, open_browser_1.openBrowser)(browser_1.DEFAULT_BROWSER, {
-            shouldDumpIo: options.dumpBrowserLogs,
-            browserExecutable: options.browserExecutable,
-            chromiumOptions: options.chromiumOptions,
-            forceDeviceScaleFactor: (_a = options.scale) !== null && _a !== void 0 ? _a : 1,
-            indent: (_b = options.indent) !== null && _b !== void 0 ? _b : false,
-        });
-    };
-    const browserInstance = (_a = options.puppeteerInstance) !== null && _a !== void 0 ? _a : makeBrowser();
-    const downloadMap = (_b = options.downloadMap) !== null && _b !== void 0 ? _b : (0, download_map_1.makeDownloadMap)();
-    const onDownload = (_c = options.onDownload) !== null && _c !== void 0 ? _c : (() => () => undefined);
-    const actualConcurrency = (0, get_concurrency_1.getActualConcurrency)(concurrency !== null && concurrency !== void 0 ? concurrency : null);
+    (0, jpeg_quality_1.validateJpegQuality)(jpegQuality);
+    (0, validate_scale_1.validateScale)(scale);
+    const makeBrowser = () => (0, open_browser_1.internalOpenBrowser)({
+        browser: browser_1.DEFAULT_BROWSER,
+        shouldDumpIo: dumpBrowserLogs,
+        browserExecutable,
+        chromiumOptions,
+        forceDeviceScaleFactor: scale,
+        indent,
+        viewport: null,
+    });
+    const browserInstance = puppeteerInstance !== null && puppeteerInstance !== void 0 ? puppeteerInstance : makeBrowser();
+    const actualConcurrency = (0, get_concurrency_1.getActualConcurrency)(concurrency);
     const openedPages = [];
     return new Promise((resolve, reject) => {
-        var _a, _b, _c;
         const cleanup = [];
-        if (!options.downloadMap) {
-            cleanup.push(() => (0, download_map_1.cleanDownloadMap)(downloadMap));
-        }
         const onError = (err) => {
             reject(err);
         };
         Promise.race([
             new Promise((_, rej) => {
-                var _a;
-                (_a = options.cancelSignal) === null || _a === void 0 ? void 0 : _a.call(options, () => {
+                cancelSignal === null || cancelSignal === void 0 ? void 0 : cancelSignal(() => {
                     rej(new Error(make_cancel_signal_1.cancelErrorMessages.renderFrames));
                 });
             }),
             Promise.all([
-                (0, prepare_server_1.prepareServer)({
-                    webpackConfigOrServeUrl: options.serveUrl,
-                    onDownload,
-                    onError,
-                    port: (_a = options.port) !== null && _a !== void 0 ? _a : null,
-                    downloadMap,
+                (0, prepare_server_1.makeOrReuseServer)(server, {
+                    webpackConfigOrServeUrl: webpackBundleOrServeUrl,
+                    port,
                     remotionRoot: (0, find_closest_package_json_1.findRemotionRoot)(),
                     concurrency: actualConcurrency,
-                    verbose: (_b = options.verbose) !== null && _b !== void 0 ? _b : false,
-                    indent: (_c = options.indent) !== null && _c !== void 0 ? _c : false,
+                    verbose,
+                    indent,
+                }, {
+                    onDownload,
+                    onError,
                 }),
                 browserInstance,
-            ]).then(([{ serveUrl, closeServer, offthreadPort, compositor }, puppeteerInstance,]) => {
-                const browserReplacer = (0, replace_browser_1.handleBrowserCrash)(puppeteerInstance);
-                const { stopCycling } = (0, cycle_browser_tabs_1.cycleBrowserTabs)(browserReplacer, actualConcurrency);
-                cleanup.push(stopCycling);
-                cleanup.push(() => closeServer(false));
+            ]).then(([{ server: { serveUrl, offthreadPort, compositor, sourceMap, downloadMap, }, cleanupServer, }, pInstance,]) => {
+                const browserReplacer = (0, replace_browser_1.handleBrowserCrash)(pInstance);
+                cleanup.push((0, cycle_browser_tabs_1.cycleBrowserTabs)(browserReplacer, actualConcurrency).stopCycling);
+                cleanup.push(() => cleanupServer(false));
                 return innerRenderFrames({
-                    ...options,
-                    puppeteerInstance,
                     onError,
                     pagesArray: openedPages,
                     serveUrl,
@@ -369,10 +342,26 @@ const renderFrames = (options) => {
                     actualConcurrency,
                     onDownload,
                     proxyPort: offthreadPort,
-                    downloadMap,
                     makeBrowser,
                     browserReplacer,
                     compositor,
+                    sourcemapContext: sourceMap,
+                    downloadMap,
+                    cancelSignal,
+                    envVariables,
+                    everyNthFrame,
+                    frameRange,
+                    imageFormat,
+                    inputProps,
+                    jpegQuality,
+                    muted,
+                    onBrowserLog,
+                    onFrameBuffer,
+                    onFrameUpdate,
+                    onStart,
+                    outputDir,
+                    scale,
+                    timeoutInMilliseconds,
                 });
             }),
         ])
@@ -384,7 +373,7 @@ const renderFrames = (options) => {
             // If browser instance was passed in, we close all the pages
             // we opened.
             // If new browser was opened, then closing the browser as a cleanup.
-            if (options.puppeteerInstance) {
+            if (puppeteerInstance) {
                 Promise.all(openedPages.map((p) => p.close())).catch((err) => {
                     if ((0, is_target_closed_err_1.isTargetClosedErr)(err)) {
                         return;
@@ -394,8 +383,8 @@ const renderFrames = (options) => {
             }
             else {
                 Promise.resolve(browserInstance)
-                    .then((puppeteerInstance) => {
-                    return puppeteerInstance.close(true);
+                    .then((instance) => {
+                    return instance.close(true);
                 })
                     .catch((err) => {
                     if (!(err === null || err === void 0 ? void 0 : err.message.includes('Target closed'))) {
@@ -410,4 +399,50 @@ const renderFrames = (options) => {
         });
     });
 };
+exports.internalRenderFrames = internalRenderFrames;
+/**
+ * @description Renders a series of images using Puppeteer and computes information for mixing audio.
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/render-frames)
+ */
+const renderFrames = (options) => {
+    const { composition, inputProps, onFrameUpdate, onStart, outputDir, serveUrl, browserExecutable, cancelSignal, chromiumOptions, concurrency, dumpBrowserLogs, envVariables, everyNthFrame, frameRange, imageFormat, jpegQuality, muted, onBrowserLog, onDownload, onFrameBuffer, port, puppeteerInstance, scale, timeoutInMilliseconds, verbose, quality, } = options;
+    if (!composition) {
+        throw new Error('No `composition` option has been specified for renderFrames()');
+    }
+    if (typeof jpegQuality !== 'undefined' && imageFormat !== 'jpeg') {
+        throw new Error("You can only pass the `quality` option if `imageFormat` is 'jpeg'.");
+    }
+    if (quality) {
+        console.warn('Passing `quality()` to `renderStill` is deprecated. Use `jpegQuality` instead.');
+    }
+    return (0, exports.internalRenderFrames)({
+        browserExecutable: browserExecutable !== null && browserExecutable !== void 0 ? browserExecutable : null,
+        cancelSignal,
+        chromiumOptions: chromiumOptions !== null && chromiumOptions !== void 0 ? chromiumOptions : {},
+        composition,
+        concurrency: concurrency !== null && concurrency !== void 0 ? concurrency : null,
+        dumpBrowserLogs: dumpBrowserLogs !== null && dumpBrowserLogs !== void 0 ? dumpBrowserLogs : false,
+        envVariables: envVariables !== null && envVariables !== void 0 ? envVariables : {},
+        everyNthFrame: everyNthFrame !== null && everyNthFrame !== void 0 ? everyNthFrame : 1,
+        frameRange: frameRange !== null && frameRange !== void 0 ? frameRange : null,
+        imageFormat: imageFormat !== null && imageFormat !== void 0 ? imageFormat : 'jpeg',
+        indent: false,
+        jpegQuality: jpegQuality !== null && jpegQuality !== void 0 ? jpegQuality : jpeg_quality_1.DEFAULT_JPEG_QUALITY,
+        onDownload: onDownload !== null && onDownload !== void 0 ? onDownload : null,
+        inputProps,
+        puppeteerInstance,
+        muted: muted !== null && muted !== void 0 ? muted : false,
+        onBrowserLog: onBrowserLog !== null && onBrowserLog !== void 0 ? onBrowserLog : null,
+        onFrameBuffer: onFrameBuffer !== null && onFrameBuffer !== void 0 ? onFrameBuffer : null,
+        onFrameUpdate,
+        onStart,
+        outputDir,
+        port: port !== null && port !== void 0 ? port : null,
+        scale: scale !== null && scale !== void 0 ? scale : 1,
+        verbose: verbose !== null && verbose !== void 0 ? verbose : false,
+        timeoutInMilliseconds: timeoutInMilliseconds !== null && timeoutInMilliseconds !== void 0 ? timeoutInMilliseconds : TimeoutSettings_1.DEFAULT_TIMEOUT,
+        webpackBundleOrServeUrl: serveUrl,
+        server: undefined,
+    });
+};
 exports.renderFrames = renderFrames;

package/dist/render-media.d.ts

@@ -1,7 +1,6 @@
 /// <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 { AudioCodec } from './audio-codec';
 import type { BrowserExecutable } from './browser-executable';
 import type { BrowserLog } from './browser-log';
@@ -13,14 +12,15 @@ import type { VideoImageFormat } from './image-format';
 import type { CancelSignal } from './make-cancel-signal';
 import type { ChromiumOptions } from './open-browser';
 import type { PixelFormat } from './pixel-format';
+import type { RemotionServer } from './prepare-server';
 import type { ProResProfile } from './prores-profile';
 import type { OnStartData } from './types';
-export declare type StitchingState = 'encoding' | 'muxing';
-export declare type SlowFrame = {
+export type StitchingState = 'encoding' | 'muxing';
+export type SlowFrame = {
     frame: number;
     time: number;
 };
-export declare type RenderMediaOnProgress = (progress: {
+export type RenderMediaOnProgress = (progress: {
     renderedFrames: number;
     encodedFrames: number;
     encodedDoneIn: number | null;
@@ -28,7 +28,49 @@ export declare type RenderMediaOnProgress = (progress: {
     progress: number;
     stitchStage: StitchingState;
 }) => void;
-export declare type RenderMediaOptions = {
+export type InternalRenderMediaOptions = {
+    outputLocation: string | null;
+    codec: Codec;
+    composition: AnySmallCompMetadata;
+    inputProps: Record<string, unknown>;
+    crf: number | null;
+    imageFormat: VideoImageFormat;
+    pixelFormat: PixelFormat;
+    envVariables: Record<string, string>;
+    jpegQuality: number;
+    frameRange: FrameRange | null;
+    everyNthFrame: number;
+    numberOfGifLoops: number | null;
+    puppeteerInstance: HeadlessBrowser | undefined;
+    overwrite: boolean;
+    onProgress: RenderMediaOnProgress;
+    onDownload: RenderMediaOnDownload;
+    proResProfile: ProResProfile | undefined;
+    dumpBrowserLogs: boolean;
+    onBrowserLog: ((log: BrowserLog) => void) | null;
+    onStart: (data: OnStartData) => void;
+    timeoutInMilliseconds: number;
+    chromiumOptions: ChromiumOptions;
+    scale: number;
+    port: number | null;
+    cancelSignal: CancelSignal | undefined;
+    browserExecutable: BrowserExecutable | null;
+    verbose: boolean;
+    onCtrlCExit: (fn: () => void) => void;
+    indent: boolean;
+    server: RemotionServer | undefined;
+    preferLossless: boolean;
+    muted: boolean;
+    enforceAudioTrack: boolean;
+    ffmpegOverride: FfmpegOverrideFn | undefined;
+    audioBitrate: string | null;
+    videoBitrate: string | null;
+    disallowParallelEncoding: boolean;
+    audioCodec: AudioCodec | null;
+    serveUrl: string;
+    concurrency: number | string | null;
+};
+export type RenderMediaOptions = {
     outputLocation?: string | null;
     codec: Codec;
     composition: AnySmallCompMetadata;
@@ -60,20 +102,6 @@ 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;
-        /**
-         * @deprecated Only for Remotion internal usage
-         */
-        indent?: boolean;
-    };
     preferLossless?: boolean;
     muted?: boolean;
     enforceAudioTrack?: boolean;
@@ -85,14 +113,15 @@ export declare type RenderMediaOptions = {
     serveUrl: string;
     concurrency?: number | string | null;
 };
-declare type RenderMediaResult = {
+type RenderMediaResult = {
     buffer: Buffer | null;
     slowestFrames: SlowFrame[];
 };
+export declare 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, }: InternalRenderMediaOptions) => Promise<RenderMediaResult>;
 /**
  *
  * @description Render a video from a composition
  * @see [Documentation](https://www.remotion.dev/docs/renderer/render-media)
  */
-export declare 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 }: RenderMediaOptions) => Promise<RenderMediaResult>;
+export declare 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, }: RenderMediaOptions) => Promise<RenderMediaResult>;
 export {};