@remotion/renderer 4.0.0-alpha13 → 4.0.0-alpha14

package/dist/index.js

@@ -29,7 +29,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RenderInternals = exports.validateOutputFilename = exports.stitchFramesToVideo = exports.selectComposition = exports.renderStill = exports.renderMedia = exports.renderFrames = exports.openBrowser = exports.makeCancelSignal = exports.validateSelectedPixelFormatAndImageFormatCombination = exports.getCompositions = exports.ErrorWithStackFrame = void 0;
 const execa_1 = __importDefault(require("execa"));
 const download_file_1 = require("./assets/download-file");
-const download_map_1 = require("./assets/download-map");
 const audio_codec_1 = require("./audio-codec");
 const browser_1 = require("./browser");
 const Browser_1 = require("./browser/Browser");
@@ -50,6 +49,7 @@ const symbolicateable_error_1 = require("./error-handling/symbolicateable-error"
 const file_extensions_1 = require("./file-extensions");
 const find_closest_package_json_1 = require("./find-closest-package-json");
 const frame_range_1 = require("./frame-range");
+const get_compositions_1 = require("./get-compositions");
 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");
@@ -68,6 +68,11 @@ const open_browser_1 = require("./open-browser");
 const parse_browser_error_stack_1 = require("./parse-browser-error-stack");
 const perf = __importStar(require("./perf"));
 const pixel_format_1 = require("./pixel-format");
+const prepare_server_1 = require("./prepare-server");
+const render_frames_1 = require("./render-frames");
+const render_media_1 = require("./render-media");
+const render_still_1 = require("./render-still");
+const select_composition_1 = require("./select-composition");
 const is_path_inside_1 = require("./serve-handler/is-path-inside");
 const serve_static_1 = require("./serve-static");
 const tmp_dir_1 = require("./tmp-dir");
@@ -79,22 +84,22 @@ const validate_videobitrate_1 = require("./validate-videobitrate");
 const wait_for_symbolication_error_to_be_done_1 = require("./wait-for-symbolication-error-to-be-done");
 var handle_javascript_exception_1 = require("./error-handling/handle-javascript-exception");
 Object.defineProperty(exports, "ErrorWithStackFrame", { enumerable: true, get: function () { return handle_javascript_exception_1.ErrorWithStackFrame; } });
-var get_compositions_1 = require("./get-compositions");
-Object.defineProperty(exports, "getCompositions", { enumerable: true, get: function () { return get_compositions_1.getCompositions; } });
+var get_compositions_2 = require("./get-compositions");
+Object.defineProperty(exports, "getCompositions", { enumerable: true, get: function () { return get_compositions_2.getCompositions; } });
 var image_format_2 = require("./image-format");
 Object.defineProperty(exports, "validateSelectedPixelFormatAndImageFormatCombination", { enumerable: true, get: function () { return image_format_2.validateSelectedPixelFormatAndImageFormatCombination; } });
 var make_cancel_signal_1 = require("./make-cancel-signal");
 Object.defineProperty(exports, "makeCancelSignal", { enumerable: true, get: function () { return make_cancel_signal_1.makeCancelSignal; } });
 var open_browser_2 = require("./open-browser");
 Object.defineProperty(exports, "openBrowser", { enumerable: true, get: function () { return open_browser_2.openBrowser; } });
-var render_frames_1 = require("./render-frames");
-Object.defineProperty(exports, "renderFrames", { enumerable: true, get: function () { return render_frames_1.renderFrames; } });
-var render_media_1 = require("./render-media");
-Object.defineProperty(exports, "renderMedia", { enumerable: true, get: function () { return render_media_1.renderMedia; } });
-var render_still_1 = require("./render-still");
-Object.defineProperty(exports, "renderStill", { enumerable: true, get: function () { return render_still_1.renderStill; } });
-var select_composition_1 = require("./select-composition");
-Object.defineProperty(exports, "selectComposition", { enumerable: true, get: function () { return select_composition_1.selectComposition; } });
+var render_frames_2 = require("./render-frames");
+Object.defineProperty(exports, "renderFrames", { enumerable: true, get: function () { return render_frames_2.renderFrames; } });
+var render_media_2 = require("./render-media");
+Object.defineProperty(exports, "renderMedia", { enumerable: true, get: function () { return render_media_2.renderMedia; } });
+var render_still_2 = require("./render-still");
+Object.defineProperty(exports, "renderStill", { enumerable: true, get: function () { return render_still_2.renderStill; } });
+var select_composition_2 = require("./select-composition");
+Object.defineProperty(exports, "selectComposition", { enumerable: true, get: function () { return select_composition_2.selectComposition; } });
 var stitch_frames_to_video_1 = require("./stitch-frames-to-video");
 Object.defineProperty(exports, "stitchFramesToVideo", { enumerable: true, get: function () { return stitch_frames_to_video_1.stitchFramesToVideo; } });
 var validate_output_filename_1 = require("./validate-output-filename");
@@ -142,8 +147,6 @@ exports.RenderInternals = {
     isEqualOrBelowLogLevel: log_level_1.isEqualOrBelowLogLevel,
     isValidLogLevel: log_level_1.isValidLogLevel,
     perf,
-    makeDownloadMap: download_map_1.makeDownloadMap,
-    cleanDownloadMap: download_map_1.cleanDownloadMap,
     convertToPositiveFrameIndex: convert_to_positive_frame_index_1.convertToPositiveFrameIndex,
     findRemotionRoot: find_closest_package_json_1.findRemotionRoot,
     validateBitrate: validate_videobitrate_1.validateBitrate,
@@ -163,6 +166,7 @@ exports.RenderInternals = {
     validVideoImageFormats: image_format_1.validVideoImageFormats,
     DEFAULT_STILL_IMAGE_FORMAT: image_format_1.DEFAULT_STILL_IMAGE_FORMAT,
     DEFAULT_VIDEO_IMAGE_FORMAT: image_format_1.DEFAULT_VIDEO_IMAGE_FORMAT,
+    DEFAULT_JPEG_QUALITY: jpeg_quality_1.DEFAULT_JPEG_QUALITY,
     chalk: chalk_1.chalk,
     Log: logger_1.Log,
     getLogLevel: logger_1.getLogLevel,
@@ -170,6 +174,14 @@ exports.RenderInternals = {
     INDENT_TOKEN: logger_1.INDENT_TOKEN,
     isColorSupported: is_color_supported_1.isColorSupported,
     HeadlessBrowser: Browser_1.HeadlessBrowser,
+    prepareServer: prepare_server_1.prepareServer,
+    makeOrReuseServer: prepare_server_1.makeOrReuseServer,
+    internalRenderStill: render_still_1.internalRenderStill,
+    internalOpenBrowser: open_browser_1.internalOpenBrowser,
+    internalSelectComposition: select_composition_1.internalSelectComposition,
+    internalGetCompositions: get_compositions_1.internalGetCompositions,
+    internalRenderFrames: render_frames_1.internalRenderFrames,
+    internalRenderMedia: render_media_1.internalRenderMedia,
 };
 // Warn of potential performance issues with Apple Silicon (M1 chip under Rosetta)
 (0, check_apple_silicon_1.checkNodeVersionAndWarnAboutRosetta)();

package/dist/is-beyond-last-frame.d.ts

@@ -0,0 +1,3 @@
+import type { DownloadMap } from './assets/download-map';
+export declare const isBeyondLastFrame: (downloadMap: DownloadMap, src: string, time: number) => boolean | 0;
+export declare const markAsBeyondLastFrame: (downloadMap: DownloadMap, src: string, time: number) => void;

package/dist/is-beyond-last-frame.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.markAsBeyondLastFrame = exports.isBeyondLastFrame = void 0;
+const isBeyondLastFrame = (downloadMap, src, time) => {
+    return (downloadMap.isBeyondLastFrameMap[src] &&
+        time >= downloadMap.isBeyondLastFrameMap[src]);
+};
+exports.isBeyondLastFrame = isBeyondLastFrame;
+const markAsBeyondLastFrame = (downloadMap, src, time) => {
+    downloadMap.isBeyondLastFrameMap[src] = time;
+};
+exports.markAsBeyondLastFrame = markAsBeyondLastFrame;

package/dist/jpeg-quality.d.ts

@@ -1 +1,2 @@
+export declare const DEFAULT_JPEG_QUALITY = 80;
 export declare const validateJpegQuality: (q: number | undefined) => void;

package/dist/jpeg-quality.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateJpegQuality = void 0;
+exports.validateJpegQuality = exports.DEFAULT_JPEG_QUALITY = void 0;
+exports.DEFAULT_JPEG_QUALITY = 80;
 const validateJpegQuality = (q) => {
     if (typeof q !== 'undefined' && typeof q !== 'number') {
         throw new Error(`JPEG Quality option must be a number or undefined. Got ${typeof q} (${JSON.stringify(q)})`);

package/dist/last-frame-from-video-cache.d.ts

@@ -0,0 +1,17 @@
+import type { OffthreadVideoImageFormat } from 'remotion';
+import type { DownloadMap, SpecialVCodecForTransparency } from './assets/download-map';
+import type { FfmpegExecutable } from './ffmpeg-executable';
+export declare type LastFrameOptions = {
+    ffmpegExecutable: FfmpegExecutable;
+    ffprobeExecutable: FfmpegExecutable;
+    offset: number;
+    src: string;
+    specialVCodecForTransparency: SpecialVCodecForTransparency;
+    imageFormat: OffthreadVideoImageFormat;
+    needsResize: [number, number] | null;
+    downloadMap: DownloadMap;
+    remotionRoot: string;
+};
+export declare const setLastFrameInCache: (options: LastFrameOptions, data: Buffer) => void;
+export declare const getLastFrameFromCache: (options: LastFrameOptions) => Buffer | null;
+export declare const clearLastFileCache: (downloadMap: DownloadMap) => void;

package/dist/last-frame-from-video-cache.js

@@ -0,0 +1,55 @@
+"use strict";
+// OffthreadVideo requires sometimes that the last frame of a video gets extracted, however, this can be slow. We allocate a cache for it but that can be garbage collected
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearLastFileCache = exports.getLastFrameFromCache = exports.setLastFrameInCache = void 0;
+const MAX_CACHE_SIZE = 50 * 1024 * 1024; // 50MB
+let bufferSize = 0;
+const makeLastFrameCacheKey = (options) => {
+    return [
+        options.ffmpegExecutable,
+        options.offset,
+        options.src,
+        options.imageFormat,
+        options.downloadMap.id,
+    ].join('-');
+};
+const setLastFrameInCache = (options, data) => {
+    const key = makeLastFrameCacheKey(options);
+    if (options.downloadMap.lastFrameMap[key]) {
+        bufferSize -= options.downloadMap.lastFrameMap[key].data.byteLength;
+    }
+    options.downloadMap.lastFrameMap[key] = { data, lastAccessed: Date.now() };
+    bufferSize += data.byteLength;
+    ensureMaxSize(options.downloadMap);
+};
+exports.setLastFrameInCache = setLastFrameInCache;
+const getLastFrameFromCache = (options) => {
+    var _a;
+    const key = makeLastFrameCacheKey(options);
+    if (!options.downloadMap.lastFrameMap[key]) {
+        return null;
+    }
+    options.downloadMap.lastFrameMap[key].lastAccessed = Date.now();
+    return (_a = options.downloadMap.lastFrameMap[key].data) !== null && _a !== void 0 ? _a : null;
+};
+exports.getLastFrameFromCache = getLastFrameFromCache;
+const removedLastFrameFromCache = (key, downloadMap) => {
+    if (!downloadMap.lastFrameMap[key]) {
+        return;
+    }
+    bufferSize -= downloadMap.lastFrameMap[key].data.byteLength;
+    delete downloadMap.lastFrameMap[key];
+};
+const ensureMaxSize = (downloadMap) => {
+    // eslint-disable-next-line no-unmodified-loop-condition
+    while (bufferSize > MAX_CACHE_SIZE) {
+        const earliest = Object.entries(downloadMap.lastFrameMap).sort((a, b) => {
+            return a[1].lastAccessed - b[1].lastAccessed;
+        })[0];
+        removedLastFrameFromCache(earliest[0], downloadMap);
+    }
+};
+const clearLastFileCache = (downloadMap) => {
+    downloadMap.lastFrameMap = {};
+};
+exports.clearLastFileCache = clearLastFileCache;

package/dist/legacy-webpack-config.d.ts

@@ -0,0 +1,9 @@
+export declare type ServeUrlOrWebpackBundle = {
+    serveUrl: string;
+} | {
+    /**
+     * @deprecated Renamed to `serveUrl`
+     */
+    webpackBundle: string;
+};
+export declare const getServeUrlWithFallback: (serve: ServeUrlOrWebpackBundle) => string;

package/dist/legacy-webpack-config.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getServeUrlWithFallback = void 0;
+const getServeUrlWithFallback = (serve) => {
+    if ('webpackBundle' in serve) {
+        return serve.webpackBundle;
+    }
+    if ('serveUrl' in serve) {
+        return serve.serveUrl;
+    }
+    throw new Error('You must pass the `serveUrl` parameter');
+};
+exports.getServeUrlWithFallback = getServeUrlWithFallback;

package/dist/log-level.d.ts

@@ -1,4 +1,4 @@
 export declare const logLevels: readonly ["verbose", "info", "warn", "error"];
-export declare type LogLevel = typeof logLevels[number];
+export type LogLevel = typeof logLevels[number];
 export declare const isValidLogLevel: (level: string) => boolean;
 export declare const isEqualOrBelowLogLevel: (currentLevel: LogLevel, level: LogLevel) => boolean;

package/dist/logger.d.ts

@@ -1,13 +1,15 @@
 import type { LogLevel } from './log-level';
 export declare const INDENT_TOKEN: string;
-declare type LogOptions = {
+type LogOptions = {
     indent: boolean;
     logLevel: LogLevel;
 };
-declare type VerboseLogOptions = LogOptions & {
+type VerboseLogOptions = LogOptions & {
     tag?: string;
+    secondTag?: string;
 };
 export declare const verboseTag: (str: string) => string;
+export declare const secondverboseTag: (str: string) => string;
 export declare const Log: {
     verbose: (message?: any, ...optionalParams: any[]) => void;
     verboseAdvanced: (options: VerboseLogOptions, message?: any, ...optionalParams: any[]) => void;

package/dist/logger.js

@@ -1,17 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setLogLevel = exports.getLogLevel = exports.Log = exports.verboseTag = exports.INDENT_TOKEN = void 0;
+exports.setLogLevel = exports.getLogLevel = exports.Log = exports.secondverboseTag = exports.verboseTag = exports.INDENT_TOKEN = void 0;
 const chalk_1 = require("./chalk");
 const is_color_supported_1 = require("./chalk/is-color-supported");
 const log_level_1 = require("./log-level");
 const truthy_1 = require("./truthy");
 exports.INDENT_TOKEN = chalk_1.chalk.gray('│');
 const verboseTag = (str) => {
-    return is_color_supported_1.isColorSupported
-        ? chalk_1.chalk.bgBlack(` ${str.toUpperCase()} `)
-        : `[${str.toUpperCase()}]`;
+    return is_color_supported_1.isColorSupported ? chalk_1.chalk.bgBlack(` ${str} `) : `[${str}]`;
 };
 exports.verboseTag = verboseTag;
+const secondverboseTag = (str) => {
+    return is_color_supported_1.isColorSupported ? chalk_1.chalk.bgWhite(` ${str} `) : `[${str}]`;
+};
+exports.secondverboseTag = secondverboseTag;
 exports.Log = {
     verbose: (...args) => {
         exports.Log.verboseAdvanced({ indent: false, logLevel: (0, exports.getLogLevel)() }, ...args);
@@ -20,7 +22,12 @@ exports.Log = {
         if ((0, log_level_1.isEqualOrBelowLogLevel)(options.logLevel, 'verbose')) {
             return console.log(...[
                 options.indent ? exports.INDENT_TOKEN : null,
-                options.tag ? (0, exports.verboseTag)(options.tag) : null,
+                [
+                    options.tag ? (0, exports.verboseTag)(options.tag) : null,
+                    options.secondTag ? (0, exports.secondverboseTag)(options.secondTag) : null,
+                ]
+                    .filter(truthy_1.truthy)
+                    .join(''),
                 ...args.map((a) => chalk_1.chalk.gray(a)),
             ].filter(truthy_1.truthy));
         }

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

@@ -1,5 +1,5 @@
-declare type Callback = () => void;
-export declare type CancelSignal = (callback: Callback) => void;
+type Callback = () => void;
+export type CancelSignal = (callback: Callback) => void;
 /**
  * @description Returns a signal and a cancel function that allows to you cancel a render triggered using renderMedia(), renderStill(), renderFrames() or stitchFramesToVideo().
  * @see [Documentation](https://www.remotion.dev/docs/renderer/make-cancel-signal)

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

@@ -1,6 +1,6 @@
 import type { DownloadMap } from './assets/download-map';
 import type { PreprocessedAudioTrack } from './preprocess-audio-track';
-declare type Options = {
+type Options = {
     files: PreprocessedAudioTrack[];
     outName: string;
     numberOfSeconds: number;

package/dist/mime-types.js

@@ -36,7 +36,7 @@ function populateMaps(exts, _types) {
     Object.keys(mime_db_1.mimeDb).forEach((type) => {
         const mime = mime_db_1.mimeDb[type];
         const _exts = mime.extensions;
-        if (!_exts || !_exts.length) {
+        if (!(_exts === null || _exts === void 0 ? void 0 : _exts.length)) {
             return;
         }
         // mime -> extensions

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

@@ -1,5 +1,4 @@
 import type { RequestListener } from 'node:http';
-import type { RenderMediaOnDownload } from './assets/download-and-map-assets-to-file';
 import type { DownloadMap } from './assets/download-map';
 import type { Compositor } from './compositor/compositor';
 export declare const extractUrlAndSourceFromUrl: (url: string) => {
@@ -7,9 +6,7 @@ export declare const extractUrlAndSourceFromUrl: (url: string) => {
     time: number;
     transparent: boolean;
 };
-export declare const startOffthreadVideoServer: ({ onDownload, onError, downloadMap, concurrency, verbose, indent, }: {
-    onDownload: RenderMediaOnDownload;
-    onError: (err: Error) => void;
+export declare const startOffthreadVideoServer: ({ downloadMap, concurrency, verbose, indent, }: {
     downloadMap: DownloadMap;
     concurrency: number;
     verbose: boolean;
@@ -18,4 +15,39 @@ export declare const startOffthreadVideoServer: ({ onDownload, onError, download
     listener: RequestListener;
     close: () => Promise<void>;
     compositor: Compositor;
+    events: OffthreadVideoServerEmitter;
 };
+type DownloadEventPayload = {
+    src: string;
+};
+type ProgressEventPayload = {
+    percent: number | null;
+    downloaded: number;
+    totalSize: number | null;
+    src: string;
+};
+type ErrorEventPayload = {
+    error: Error;
+};
+type EventMap = {
+    progress: ProgressEventPayload;
+    error: ErrorEventPayload;
+    download: DownloadEventPayload;
+};
+export type EventTypes = keyof EventMap;
+export type CallbackListener<T extends EventTypes> = (data: {
+    detail: EventMap[T];
+}) => void;
+type Listeners = {
+    [EventType in EventTypes]: CallbackListener<EventType>[];
+};
+export declare class OffthreadVideoServerEmitter {
+    listeners: Listeners;
+    addEventListener<Q extends EventTypes>(name: Q, callback: CallbackListener<Q>): () => void;
+    removeEventListener<Q extends EventTypes>(name: Q, callback: CallbackListener<Q>): void;
+    private dispatchEvent;
+    dispatchError(error: Error): void;
+    dispatchDownloadProgress(src: string, percent: number | null, downloaded: number, totalSize: number | null): void;
+    dispatchDownload(src: string): void;
+}
+export {};

package/dist/offthread-video-server.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.startOffthreadVideoServer = exports.extractUrlAndSourceFromUrl = void 0;
+exports.OffthreadVideoServerEmitter = exports.startOffthreadVideoServer = exports.extractUrlAndSourceFromUrl = void 0;
 const node_url_1 = require("node:url");
 const download_and_map_assets_to_file_1 = require("./assets/download-and-map-assets-to-file");
 const compositor_1 = require("./compositor/compositor");
@@ -27,7 +27,8 @@ const extractUrlAndSourceFromUrl = (url) => {
     };
 };
 exports.extractUrlAndSourceFromUrl = extractUrlAndSourceFromUrl;
-const startOffthreadVideoServer = ({ onDownload, onError, downloadMap, concurrency, verbose, indent, }) => {
+const startOffthreadVideoServer = ({ downloadMap, concurrency, verbose, indent, }) => {
+    const events = new OffthreadVideoServerEmitter();
     const compositor = (0, compositor_1.startCompositor)('StartLongRunningProcess', {
         concurrency,
         maximum_frame_cache_items: (0, compositor_1.getIdealMaximumFrameCacheItems)(),
@@ -66,7 +67,7 @@ const startOffthreadVideoServer = ({ onDownload, onError, downloadMap, concurren
                 res.end();
                 return;
             }
-            (0, download_and_map_assets_to_file_1.downloadAsset)({ src, onDownload, downloadMap })
+            (0, download_and_map_assets_to_file_1.downloadAsset)({ src, emitter: events, downloadMap })
                 .then((to) => {
                 return compositor.executeCommand('ExtractFrame', {
                     input: to,
@@ -85,11 +86,54 @@ const startOffthreadVideoServer = ({ onDownload, onError, downloadMap, concurren
                 .catch((err) => {
                 res.writeHead(500);
                 res.end();
-                onError(err);
+                events.dispatchError(err);
                 console.log('Error occurred', err);
             });
         },
         compositor,
+        events,
     };
 };
 exports.startOffthreadVideoServer = startOffthreadVideoServer;
+class OffthreadVideoServerEmitter {
+    constructor() {
+        this.listeners = {
+            error: [],
+            progress: [],
+            download: [],
+        };
+    }
+    addEventListener(name, callback) {
+        this.listeners[name].push(callback);
+        return () => {
+            this.removeEventListener(name, callback);
+        };
+    }
+    removeEventListener(name, callback) {
+        this.listeners[name] = this.listeners[name].filter((l) => l !== callback);
+    }
+    dispatchEvent(dispatchName, context) {
+        this.listeners[dispatchName].forEach((callback) => {
+            callback({ detail: context });
+        });
+    }
+    dispatchError(error) {
+        this.dispatchEvent('error', {
+            error,
+        });
+    }
+    dispatchDownloadProgress(src, percent, downloaded, totalSize) {
+        this.dispatchEvent('progress', {
+            downloaded,
+            percent,
+            totalSize,
+            src,
+        });
+    }
+    dispatchDownload(src) {
+        this.dispatchEvent('download', {
+            src,
+        });
+    }
+}
+exports.OffthreadVideoServerEmitter = OffthreadVideoServerEmitter;

package/dist/open-browser.d.ts

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

package/dist/open-browser.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.openBrowser = exports.killAllBrowsers = void 0;
+exports.openBrowser = exports.internalOpenBrowser = exports.killAllBrowsers = void 0;
 const node_1 = require("./browser/node");
 const get_local_browser_executable_1 = require("./get-local-browser-executable");
 const get_video_threads_flag_1 = require("./get-video-threads-flag");
@@ -27,23 +27,19 @@ const killAllBrowsers = async () => {
     }
 };
 exports.killAllBrowsers = killAllBrowsers;
-/**
- * @description Opens a Chrome or Chromium browser instance.
- * @see [Documentation](https://www.remotion.dev/docs/renderer/open-browser)
- */
-const openBrowser = async (browser, options) => {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+const internalOpenBrowser = async ({ browser, browserExecutable, chromiumOptions, forceDeviceScaleFactor, indent, shouldDumpIo, viewport, }) => {
+    var _a, _b;
     if (browser === 'firefox') {
         throw new TypeError('Firefox supported is not yet turned on. Stay tuned for the future.');
     }
-    await (0, get_local_browser_executable_1.ensureLocalBrowser)(browser, (_a = options === null || options === void 0 ? void 0 : options.browserExecutable) !== null && _a !== void 0 ? _a : null);
-    const executablePath = (0, get_local_browser_executable_1.getLocalBrowserExecutable)(browser, (_b = options === null || options === void 0 ? void 0 : options.browserExecutable) !== null && _b !== void 0 ? _b : null);
-    const customGlRenderer = getOpenGlRenderer((_d = (_c = options === null || options === void 0 ? void 0 : options.chromiumOptions) === null || _c === void 0 ? void 0 : _c.gl) !== null && _d !== void 0 ? _d : null);
+    await (0, get_local_browser_executable_1.ensureLocalBrowser)(browser, browserExecutable);
+    const executablePath = (0, get_local_browser_executable_1.getLocalBrowserExecutable)(browser, browserExecutable);
+    const customGlRenderer = getOpenGlRenderer((_a = chromiumOptions.gl) !== null && _a !== void 0 ? _a : null);
     const browserInstance = await node_1.puppeteer.launch({
         executablePath,
         product: browser,
-        dumpio: (_e = options === null || options === void 0 ? void 0 : options.shouldDumpIo) !== null && _e !== void 0 ? _e : false,
-        indent: (_f = options === null || options === void 0 ? void 0 : options.indent) !== null && _f !== void 0 ? _f : false,
+        dumpio: shouldDumpIo,
+        indent,
         args: [
             'about:blank',
             '--allow-pre-commit-input',
@@ -76,7 +72,7 @@ const openBrowser = async (browser, options) => {
             '--enable-blink-features=IdleDetection',
             '--export-tagged-pdf',
             '--intensive-wake-up-throttling-policy=0',
-            ((_h = (_g = options === null || options === void 0 ? void 0 : options.chromiumOptions) === null || _g === void 0 ? void 0 : _g.headless) !== null && _h !== void 0 ? _h : true) ? '--headless' : null,
+            ((_b = chromiumOptions.headless) !== null && _b !== void 0 ? _b : true) ? '--headless' : null,
             '--no-sandbox',
             '--disable-setuid-sandbox',
             ...customGlRenderer,
@@ -94,20 +90,20 @@ const openBrowser = async (browser, options) => {
             '--no-pings',
             '--font-render-hinting=none',
             '--no-zygote',
-            (options === null || options === void 0 ? void 0 : options.forceDeviceScaleFactor)
-                ? `--force-device-scale-factor=${options.forceDeviceScaleFactor}`
-                : null,
-            ((_j = options === null || options === void 0 ? void 0 : options.chromiumOptions) === null || _j === void 0 ? void 0 : _j.ignoreCertificateErrors)
+            typeof forceDeviceScaleFactor === 'undefined'
+                ? null
+                : `--force-device-scale-factor=${forceDeviceScaleFactor}`,
+            chromiumOptions.ignoreCertificateErrors
                 ? '--ignore-certificate-errors'
                 : null,
-            ...(((_k = options === null || options === void 0 ? void 0 : options.chromiumOptions) === null || _k === void 0 ? void 0 : _k.disableWebSecurity)
+            ...((chromiumOptions === null || chromiumOptions === void 0 ? void 0 : chromiumOptions.disableWebSecurity)
                 ? ['--disable-web-security']
                 : []),
-            ((_l = options === null || options === void 0 ? void 0 : options.chromiumOptions) === null || _l === void 0 ? void 0 : _l.userAgent)
-                ? `--user-agent="${options.chromiumOptions.userAgent}"`
+            (chromiumOptions === null || chromiumOptions === void 0 ? void 0 : chromiumOptions.userAgent)
+                ? `--user-agent="${chromiumOptions.userAgent}"`
                 : null,
         ].filter(Boolean),
-        defaultViewport: (_m = options === null || options === void 0 ? void 0 : options.viewport) !== null && _m !== void 0 ? _m : {
+        defaultViewport: viewport !== null && viewport !== void 0 ? viewport : {
             height: 720,
             width: 1280,
             deviceScaleFactor: 1,
@@ -118,4 +114,21 @@ const openBrowser = async (browser, options) => {
     browserInstances.push(browserInstance);
     return browserInstance;
 };
+exports.internalOpenBrowser = internalOpenBrowser;
+/**
+ * @description Opens a Chrome or Chromium browser instance.
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/open-browser)
+ */
+const openBrowser = (browser, options) => {
+    const { browserExecutable, chromiumOptions, forceDeviceScaleFactor, shouldDumpIo, } = options !== null && options !== void 0 ? options : {};
+    return (0, exports.internalOpenBrowser)({
+        browser,
+        browserExecutable: browserExecutable !== null && browserExecutable !== void 0 ? browserExecutable : null,
+        chromiumOptions: chromiumOptions !== null && chromiumOptions !== void 0 ? chromiumOptions : {},
+        forceDeviceScaleFactor,
+        indent: false,
+        shouldDumpIo: shouldDumpIo !== null && shouldDumpIo !== void 0 ? shouldDumpIo : false,
+        viewport: null,
+    });
+};
 exports.openBrowser = openBrowser;

package/dist/options/option.d.ts

@@ -1,5 +1,5 @@
 import type React from 'react';
-export declare type RemotionOption = {
+export type RemotionOption = {
     name: string;
     cliFlag: string;
     ssrName: string;

package/dist/parse-browser-error-stack.d.ts

@@ -1,4 +1,4 @@
-export declare type UnsymbolicatedStackFrame = {
+export type UnsymbolicatedStackFrame = {
     functionName: string | null;
     fileName: string;
     lineNumber: number;

package/dist/perf.d.ts

@@ -1,4 +1,4 @@
-declare type PerfId = 'activate-target' | 'capture' | 'save' | 'extract-frame' | 'piping';
+type PerfId = 'activate-target' | 'capture' | 'save' | 'extract-frame' | 'piping';
 export declare const startPerfMeasure: (marker: PerfId) => number;
 export declare const stopPerfMeasure: (id: number) => void;
 export declare const getPerf: () => string[];

package/dist/pixel-format.d.ts

@@ -1,5 +1,5 @@
 import type { Codec } from './codec';
 export declare const validPixelFormats: readonly ["yuv420p", "yuva420p", "yuv422p", "yuv444p", "yuv420p10le", "yuv422p10le", "yuv444p10le", "yuva444p10le"];
-export declare type PixelFormat = typeof validPixelFormats[number];
+export type PixelFormat = typeof validPixelFormats[number];
 export declare const DEFAULT_PIXEL_FORMAT: PixelFormat;
 export declare const validateSelectedPixelFormatAndCodecCombination: (pixelFormat: PixelFormat | undefined, codec: Codec) => undefined;