@remotion/renderer 4.0.0-alpha13 → 4.0.0-alpha16

package/dist/compositor/compositor.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import type { CompositorCommand } from './payloads';
-export declare type Compositor = {
+export type Compositor = {
     finishCommands: () => void;
     executeCommand: <T extends keyof CompositorCommand>(type: T, payload: CompositorCommand[T]) => Promise<Buffer>;
     waitForDone: () => Promise<void>;

package/dist/compositor/compositor.js

@@ -45,7 +45,7 @@ const startCompositor = (type, payload, indent) => {
     const waiters = new Map();
     const onMessage = (statusType, nonce, data) => {
         if (nonce === '0') {
-            logger_1.Log.verboseAdvanced({ indent, logLevel: (0, logger_1.getLogLevel)(), tag: 'COMPOSITOR' }, data.toString('utf8'));
+            logger_1.Log.verboseAdvanced({ indent, logLevel: (0, logger_1.getLogLevel)(), tag: 'compositor' }, data.toString('utf8'));
         }
         if (waiters.has(nonce)) {
             if (statusType === 'error') {
@@ -63,7 +63,7 @@ const startCompositor = (type, payload, indent) => {
             waiters.delete(nonce);
         }
     };
-    let quit = false;
+    let runningStatus = { type: 'running' };
     let missingData = null;
     const processInput = () => {
         let separatorIndex = outputBuffer.indexOf(separator);
@@ -145,9 +145,9 @@ const startCompositor = (type, payload, indent) => {
     let resolve = null;
     let reject = null;
     child.on('close', (code) => {
-        quit = true;
         const waitersToKill = Array.from(waiters.values());
         if (code === 0) {
+            runningStatus = { type: 'quit-without-error' };
             resolve === null || resolve === void 0 ? void 0 : resolve();
             for (const waiter of waitersToKill) {
                 waiter.reject(new Error(`Compositor already quit`));
@@ -155,7 +155,9 @@ const startCompositor = (type, payload, indent) => {
             waiters.clear();
         }
         else {
-            const error = new Error(`Compositor panicked: ${Buffer.concat(stderrChunks).toString('utf-8')}`);
+            const errorMessage = Buffer.concat(stderrChunks).toString('utf-8');
+            runningStatus = { type: 'quit-with-error', error: errorMessage };
+            const error = new Error(`Compositor panicked: ${errorMessage}`);
             for (const waiter of waitersToKill) {
                 waiter.reject(error);
             }
@@ -166,24 +168,34 @@ const startCompositor = (type, payload, indent) => {
     return {
         waitForDone: () => {
             return new Promise((res, rej) => {
-                if (quit) {
+                if (runningStatus.type === 'quit-without-error') {
                     rej(new Error('Compositor already quit'));
                     return;
                 }
+                if (runningStatus.type === 'quit-with-error') {
+                    rej(new Error(`Compositor already quit: ${runningStatus.error}`));
+                    return;
+                }
                 resolve = res;
                 reject = rej;
             });
         },
         finishCommands: () => {
-            if (quit) {
+            if (runningStatus.type === 'quit-with-error') {
+                throw new Error(`Compositor already quit: ${runningStatus.error}`);
+            }
+            if (runningStatus.type === 'quit-without-error') {
                 throw new Error('Compositor already quit');
             }
             child.stdin.write('EOF\n');
         },
         executeCommand: (command, params) => {
-            if (quit) {
+            if (runningStatus.type === 'quit-without-error') {
                 throw new Error('Compositor already quit');
             }
+            if (runningStatus.type === 'quit-with-error') {
+                throw new Error(`Compositor quit: ${runningStatus.error}`);
+            }
             return new Promise((_resolve, _reject) => {
                 const nonce = (0, make_nonce_1.makeNonce)();
                 const composed = {

package/dist/compositor/payloads.d.ts

@@ -1,4 +1,4 @@
-export declare type Layer = {
+export type Layer = {
     type: 'PngImage';
     params: {
         src: string;
@@ -26,8 +26,8 @@ export declare type Layer = {
         height: number;
     };
 };
-export declare type CompositorImageFormat = 'Png' | 'Jpeg';
-export declare type CompositorCommand = {
+export type CompositorImageFormat = 'Png' | 'Jpeg';
+export type CompositorCommand = {
     Compose: {
         output: string;
         width: number;
@@ -55,14 +55,14 @@ export declare type CompositorCommand = {
         percent_of_memory: number;
     };
 };
-export declare type CompositorCommandSerialized<T extends keyof CompositorCommand> = {
+export type CompositorCommandSerialized<T extends keyof CompositorCommand> = {
     nonce: string;
     payload: {
         type: T;
         params: CompositorCommand[T];
     };
 };
-export declare type ErrorPayload = {
+export type ErrorPayload = {
     error: string;
     backtrace: string;
 };

package/dist/crf.d.ts

@@ -1,5 +1,5 @@
 import type { Codec } from './codec';
-export declare type Crf = number | undefined;
+export type Crf = number | undefined;
 export declare const getDefaultCrfForCodec: (codec: Codec) => number;
 export declare const getValidCrfRanges: (codec: Codec) => [number, number];
 export declare const validateQualitySettings: ({ codec, crf, videoBitrate, }: {

package/dist/error-handling/symbolicate-error.js

@@ -7,8 +7,10 @@ const handle_javascript_exception_1 = require("./handle-javascript-exception");
 const symbolicateError = async (symbolicateableError) => {
     const { delayRenderCall, stackFrame } = symbolicateableError;
     const [mainErrorFrames, delayRenderFrames] = await Promise.all([
-        stackFrame ? (0, symbolicate_stacktrace_1.symbolicateStackTrace)(stackFrame) : null,
-        delayRenderCall ? (0, symbolicate_stacktrace_1.symbolicateStackTrace)(delayRenderCall) : null,
+        stackFrame ? (0, symbolicate_stacktrace_1.symbolicateStackTraceFromRemoteFrames)(stackFrame) : null,
+        delayRenderCall
+            ? (0, symbolicate_stacktrace_1.symbolicateStackTraceFromRemoteFrames)(delayRenderCall)
+            : null,
     ].filter(truthy_1.truthy));
     const symbolicatedErr = new handle_javascript_exception_1.ErrorWithStackFrame({
         message: symbolicateableError.message,

package/dist/ffmpeg-override.d.ts

@@ -1,4 +1,4 @@
-export declare type FfmpegOverrideFn = (info: {
+export type FfmpegOverrideFn = (info: {
     type: 'pre-stitcher' | 'stitcher';
     args: string[];
 }) => string[];

package/dist/file-extensions.d.ts

@@ -1,6 +1,6 @@
 import type { supportedAudioCodecs } from './audio-codec';
 import type { Codec } from './codec';
-export declare type FileExtension = 'aac' | '3gp' | 'm4a' | 'm4b' | 'mpg' | 'mpeg' | 'mkv' | 'mp4' | 'gif' | 'hevc' | 'mp3' | 'mov' | 'mxf' | 'wav' | 'webm';
+export type FileExtension = 'aac' | '3gp' | 'm4a' | 'm4b' | 'mpg' | 'mpeg' | 'mkv' | 'mp4' | 'gif' | 'hevc' | 'mp3' | 'mov' | 'mxf' | 'wav' | 'webm';
 export declare const defaultFileExtensionMap: {
     [key in Codec]: {
         default: FileExtension;

package/dist/frame-range.d.ts

@@ -1,2 +1,2 @@
-export declare type FrameRange = number | [number, number];
+export type FrameRange = number | [number, number];
 export declare const validateFrameRange: (frameRange: FrameRange | null) => void;

package/dist/get-browser-instance.d.ts

@@ -2,10 +2,15 @@ import type { BrowserExecutable } from './browser-executable';
 import type { HeadlessBrowser } from './browser/Browser';
 import type { Page } from './browser/BrowserPage';
 import type { ChromiumOptions } from './open-browser';
-export declare const getPageAndCleanupFn: ({ passedInInstance, browserExecutable, chromiumOptions, }: {
+import type { AnySourceMapConsumer } from './symbolicate-stacktrace';
+export declare const getPageAndCleanupFn: ({ passedInInstance, browserExecutable, chromiumOptions, context, forceDeviceScaleFactor, indent, shouldDumpIo, }: {
     passedInInstance: HeadlessBrowser | undefined;
     browserExecutable: BrowserExecutable | null;
     chromiumOptions: ChromiumOptions;
+    context: AnySourceMapConsumer | null;
+    indent: boolean;
+    forceDeviceScaleFactor: number | undefined;
+    shouldDumpIo: boolean;
 }) => Promise<{
     cleanup: () => void;
     page: Page;

package/dist/get-browser-instance.js

@@ -3,9 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPageAndCleanupFn = void 0;
 const browser_1 = require("./browser");
 const open_browser_1 = require("./open-browser");
-const getPageAndCleanupFn = async ({ passedInInstance, browserExecutable, chromiumOptions, }) => {
+const getPageAndCleanupFn = async ({ passedInInstance, browserExecutable, chromiumOptions, context, forceDeviceScaleFactor, indent, shouldDumpIo, }) => {
     if (passedInInstance) {
-        const page = await passedInInstance.newPage();
+        const page = await passedInInstance.newPage(context);
         return {
             page,
             cleanup: () => {
@@ -17,11 +17,16 @@ const getPageAndCleanupFn = async ({ passedInInstance, browserExecutable, chromi
             },
         };
     }
-    const browserInstance = await (0, open_browser_1.openBrowser)(browser_1.DEFAULT_BROWSER, {
+    const browserInstance = await (0, open_browser_1.internalOpenBrowser)({
+        browser: browser_1.DEFAULT_BROWSER,
         browserExecutable,
         chromiumOptions,
+        forceDeviceScaleFactor,
+        indent,
+        shouldDumpIo,
+        viewport: null,
     });
-    const browserPage = await browserInstance.newPage();
+    const browserPage = await browserInstance.newPage(context);
     return {
         page: browserPage,
         cleanup: () => {

package/dist/get-compositions.d.ts

@@ -1,10 +1,24 @@
 import type { AnyCompMetadata } from 'remotion';
-import type { DownloadMap } from './assets/download-map';
 import type { BrowserExecutable } from './browser-executable';
 import type { BrowserLog } from './browser-log';
 import type { HeadlessBrowser } from './browser/Browser';
 import type { ChromiumOptions } from './open-browser';
-declare type GetCompositionsConfig = {
+import type { RemotionServer } from './prepare-server';
+type InternalGetCompositionsOptions = {
+    inputProps: Record<string, unknown>;
+    envVariables: Record<string, string>;
+    puppeteerInstance: HeadlessBrowser | undefined;
+    onBrowserLog: null | ((log: BrowserLog) => void);
+    browserExecutable: BrowserExecutable | null;
+    timeoutInMilliseconds: number;
+    chromiumOptions: ChromiumOptions;
+    port: number | null;
+    server: RemotionServer | undefined;
+    indent: boolean;
+    verbose: boolean;
+    serveUrlOrWebpackUrl: string;
+};
+export type GetCompositionsOptions = {
     inputProps?: Record<string, unknown> | null;
     envVariables?: Record<string, string>;
     puppeteerInstance?: HeadlessBrowser;
@@ -13,19 +27,12 @@ declare type GetCompositionsConfig = {
     timeoutInMilliseconds?: number;
     chromiumOptions?: ChromiumOptions;
     port?: number | null;
-    /**
-     * @deprecated Only for Remotion internal usage
-     */
-    downloadMap?: DownloadMap;
-    /**
-     * @deprecated Only for Remotion internal usage
-     */
-    indent?: boolean;
     verbose?: boolean;
 };
+export declare const internalGetCompositions: ({ browserExecutable, chromiumOptions, envVariables, indent, inputProps, onBrowserLog, port, puppeteerInstance, serveUrlOrWebpackUrl, server, timeoutInMilliseconds, verbose, }: InternalGetCompositionsOptions) => Promise<AnyCompMetadata[]>;
 /**
  * @description Gets the compositions defined in a Remotion project based on a Webpack bundle.
  * @see [Documentation](https://www.remotion.dev/docs/renderer/get-compositions)
  */
-export declare const getCompositions: (serveUrlOrWebpackUrl: string, config?: GetCompositionsConfig) => Promise<AnyCompMetadata[]>;
+export declare const getCompositions: (serveUrlOrWebpackUrl: string, config?: GetCompositionsOptions) => Promise<AnyCompMetadata[]>;
 export {};

package/dist/get-compositions.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCompositions = void 0;
-const download_map_1 = require("./assets/download-map");
+exports.getCompositions = exports.internalGetCompositions = void 0;
+const TimeoutSettings_1 = require("./browser/TimeoutSettings");
 const handle_javascript_exception_1 = require("./error-handling/handle-javascript-exception");
 const find_closest_package_json_1 = require("./find-closest-package-json");
 const get_browser_instance_1 = require("./get-browser-instance");
@@ -10,26 +10,24 @@ const puppeteer_evaluate_1 = require("./puppeteer-evaluate");
 const seek_to_frame_1 = require("./seek-to-frame");
 const set_props_and_env_1 = require("./set-props-and-env");
 const validate_puppeteer_timeout_1 = require("./validate-puppeteer-timeout");
-const innerGetCompositions = async (serveUrl, page, config, proxyPort) => {
-    var _a;
-    if (config === null || config === void 0 ? void 0 : config.onBrowserLog) {
+const innerGetCompositions = async ({ envVariables, inputProps, onBrowserLog, page, proxyPort, serveUrl, timeoutInMilliseconds, }) => {
+    if (onBrowserLog) {
         page.on('console', (log) => {
-            var _a;
-            (_a = config.onBrowserLog) === null || _a === void 0 ? void 0 : _a.call(config, {
+            onBrowserLog({
                 stackTrace: log.stackTrace(),
                 text: log.text,
                 type: log.type,
             });
         });
     }
-    (0, validate_puppeteer_timeout_1.validatePuppeteerTimeout)(config === null || config === void 0 ? void 0 : config.timeoutInMilliseconds);
+    (0, validate_puppeteer_timeout_1.validatePuppeteerTimeout)(timeoutInMilliseconds);
     await (0, set_props_and_env_1.setPropsAndEnv)({
-        inputProps: (_a = config === null || config === void 0 ? void 0 : config.inputProps) !== null && _a !== void 0 ? _a : {},
-        envVariables: config === null || config === void 0 ? void 0 : config.envVariables,
+        inputProps,
+        envVariables,
         page,
         serveUrl,
         initialFrame: 0,
-        timeoutInMilliseconds: config === null || config === void 0 ? void 0 : config.timeoutInMilliseconds,
+        timeoutInMilliseconds,
         proxyPort,
         retriesRemaining: 2,
         audioEnabled: false,
@@ -38,7 +36,7 @@ const innerGetCompositions = async (serveUrl, page, config, proxyPort) => {
     await (0, puppeteer_evaluate_1.puppeteerEvaluateWithCatch)({
         page,
         pageFunction: () => {
-            window.setBundleMode({
+            window.remotion_setBundleMode({
                 type: 'evaluation',
             });
         },
@@ -56,62 +54,81 @@ const innerGetCompositions = async (serveUrl, page, config, proxyPort) => {
     });
     return result;
 };
-/**
- * @description Gets the compositions defined in a Remotion project based on a Webpack bundle.
- * @see [Documentation](https://www.remotion.dev/docs/renderer/get-compositions)
- */
-const getCompositions = async (serveUrlOrWebpackUrl, config) => {
-    var _a, _b, _c;
-    const downloadMap = (_a = config === null || config === void 0 ? void 0 : config.downloadMap) !== null && _a !== void 0 ? _a : (0, download_map_1.makeDownloadMap)();
-    const { page, cleanup } = await (0, get_browser_instance_1.getPageAndCleanupFn)({
-        passedInInstance: config === null || config === void 0 ? void 0 : config.puppeteerInstance,
-        browserExecutable: (_b = config === null || config === void 0 ? void 0 : config.browserExecutable) !== null && _b !== void 0 ? _b : null,
-        chromiumOptions: (_c = config === null || config === void 0 ? void 0 : config.chromiumOptions) !== null && _c !== void 0 ? _c : {},
+const internalGetCompositions = async ({ browserExecutable, chromiumOptions, envVariables, indent, inputProps, onBrowserLog, port, puppeteerInstance, serveUrlOrWebpackUrl, server, timeoutInMilliseconds, verbose, }) => {
+    const { page, cleanup: cleanupPage } = await (0, get_browser_instance_1.getPageAndCleanupFn)({
+        passedInInstance: puppeteerInstance,
+        browserExecutable,
+        chromiumOptions,
+        context: null,
+        forceDeviceScaleFactor: undefined,
+        indent,
+        shouldDumpIo: verbose,
     });
+    const cleanup = [cleanupPage];
     return new Promise((resolve, reject) => {
-        var _a, _b, _c;
         const onError = (err) => reject(err);
-        const cleanupPageError = (0, handle_javascript_exception_1.handleJavascriptException)({
+        cleanup.push((0, handle_javascript_exception_1.handleJavascriptException)({
             page,
             frame: null,
             onError,
-        });
-        let close = null;
-        (0, prepare_server_1.prepareServer)({
+        }));
+        (0, prepare_server_1.makeOrReuseServer)(server, {
             webpackConfigOrServeUrl: serveUrlOrWebpackUrl,
-            onDownload: () => undefined,
-            onError,
-            port: (_a = config === null || config === void 0 ? void 0 : config.port) !== null && _a !== void 0 ? _a : null,
-            downloadMap,
+            port,
             remotionRoot: (0, find_closest_package_json_1.findRemotionRoot)(),
             concurrency: 1,
-            verbose: (_b = config === null || config === void 0 ? void 0 : config.verbose) !== null && _b !== void 0 ? _b : false,
-            indent: (_c = config === null || config === void 0 ? void 0 : config.indent) !== null && _c !== void 0 ? _c : false,
+            verbose,
+            indent,
+        }, {
+            onDownload: () => undefined,
+            onError,
         })
-            .then(({ serveUrl, closeServer, offthreadPort }) => {
-            close = closeServer;
-            return innerGetCompositions(serveUrl, page, config !== null && config !== void 0 ? config : {}, offthreadPort);
+            .then(({ server: { serveUrl, offthreadPort, sourceMap }, cleanupServer }) => {
+            page.setBrowserSourceMapContext(sourceMap);
+            cleanup.push(() => cleanupServer(true));
+            return innerGetCompositions({
+                envVariables,
+                inputProps,
+                onBrowserLog,
+                page,
+                proxyPort: offthreadPort,
+                serveUrl,
+                timeoutInMilliseconds,
+            });
         })
             .then((comp) => {
-            if (close) {
-                return Promise.all([comp, close(true)]);
-            }
-            return Promise.resolve([comp, null]);
-        })
-            .then(([comp]) => {
             return resolve(comp);
         })
             .catch((err) => {
             reject(err);
         })
             .finally(() => {
-            cleanup();
-            cleanupPageError();
-            // Clean download map if it was not passed in
-            if (!(config === null || config === void 0 ? void 0 : config.downloadMap)) {
-                (0, download_map_1.cleanDownloadMap)(downloadMap);
-            }
+            cleanup.forEach((c) => {
+                c();
+            });
         });
     });
 };
+exports.internalGetCompositions = internalGetCompositions;
+/**
+ * @description Gets the compositions defined in a Remotion project based on a Webpack bundle.
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/get-compositions)
+ */
+const getCompositions = (serveUrlOrWebpackUrl, config) => {
+    const { browserExecutable, chromiumOptions, envVariables, inputProps, onBrowserLog, port, puppeteerInstance, timeoutInMilliseconds, verbose, } = config !== null && config !== void 0 ? config : {};
+    return (0, exports.internalGetCompositions)({
+        browserExecutable: browserExecutable !== null && browserExecutable !== void 0 ? browserExecutable : null,
+        chromiumOptions: chromiumOptions !== null && chromiumOptions !== void 0 ? chromiumOptions : {},
+        envVariables: envVariables !== null && envVariables !== void 0 ? envVariables : {},
+        inputProps: inputProps !== null && inputProps !== void 0 ? inputProps : {},
+        indent: false,
+        onBrowserLog: onBrowserLog !== null && onBrowserLog !== void 0 ? onBrowserLog : null,
+        port: port !== null && port !== void 0 ? port : null,
+        puppeteerInstance: puppeteerInstance !== null && puppeteerInstance !== void 0 ? puppeteerInstance : undefined,
+        serveUrlOrWebpackUrl,
+        server: undefined,
+        timeoutInMilliseconds: timeoutInMilliseconds !== null && timeoutInMilliseconds !== void 0 ? timeoutInMilliseconds : TimeoutSettings_1.DEFAULT_TIMEOUT,
+        verbose: verbose !== null && verbose !== void 0 ? verbose : false,
+    });
+};
 exports.getCompositions = getCompositions;

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

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

package/dist/image-format.d.ts

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