@remotion/renderer 4.0.0-alpha13 → 4.0.0-alpha16

package/dist/index.d.ts

@@ -5,7 +5,6 @@ import { SymbolicateableError } from './error-handling/symbolicateable-error';
 import { mimeContentType, mimeLookup } from './mime-types';
 import * as perf from './perf';
 export type { RenderMediaOnDownload } from './assets/download-and-map-assets-to-file';
-export type { DownloadMap } from './assets/download-map';
 export { AudioCodec } from './audio-codec';
 export { Browser } from './browser';
 export { BrowserExecutable } from './browser-executable';
@@ -17,7 +16,7 @@ export { ErrorWithStackFrame } from './error-handling/handle-javascript-exceptio
 export type { FfmpegOverrideFn } from './ffmpeg-override';
 export { FileExtension } from './file-extensions';
 export { FrameRange } from './frame-range';
-export { getCompositions } from './get-compositions';
+export { getCompositions, GetCompositionsOptions } from './get-compositions';
 export { ImageFormat, StillImageFormat, validateSelectedPixelFormatAndImageFormatCombination, VideoImageFormat, } from './image-format';
 export type { LogLevel } from './log-level';
 export { CancelSignal, makeCancelSignal } from './make-cancel-signal';
@@ -25,12 +24,13 @@ export { openBrowser } from './open-browser';
 export type { ChromiumOptions } from './open-browser';
 export { RemotionOption } from './options/option';
 export { PixelFormat } from './pixel-format';
+export { RemotionServer } from './prepare-server';
 export { ProResProfile } from './prores-profile';
-export { renderFrames } from './render-frames';
-export { renderMedia, RenderMediaOnProgress, RenderMediaOptions, SlowFrame, StitchingState, } from './render-media';
+export { renderFrames, RenderFramesOptions } from './render-frames';
+export { InternalRenderMediaOptions, renderMedia, RenderMediaOnProgress, RenderMediaOptions, SlowFrame, StitchingState, } from './render-media';
 export { renderStill, RenderStillOptions } from './render-still';
-export { selectComposition } from './select-composition';
-export { StitcherOptions, stitchFramesToVideo } from './stitch-frames-to-video';
+export { selectComposition, SelectCompositionOptions, } from './select-composition';
+export { stitchFramesToVideo, StitchFramesToVideoOptions, } from './stitch-frames-to-video';
 export { SymbolicatedStackFrame } from './symbolicate-stacktrace';
 export { OnStartData, RenderFramesOutput } from './types';
 export { OpenGlRenderer } from './validate-opengl-renderer';
@@ -40,8 +40,6 @@ export declare const RenderInternals: {
     getActualConcurrency: (userPreference: string | number | null) => number;
     serveStatic: (path: string | null, options: {
         port: number | null;
-        onDownload: import("./assets/download-and-map-assets-to-file").RenderMediaOnDownload;
-        onError: (err: Error) => void;
         downloadMap: import("./assets/download-map").DownloadMap;
         remotionRoot: string;
         concurrency: number;
@@ -51,6 +49,7 @@ export declare const RenderInternals: {
         port: number;
         close: () => Promise<void>;
         compositor: import("./compositor/compositor").Compositor;
+        events: import("./offthread-video-server").OffthreadVideoServerEmitter;
     }>;
     validateEvenDimensionsWithCodec: ({ width, height, codec, scale, }: {
         width: number;
@@ -124,11 +123,9 @@ export declare const RenderInternals: {
     DEFAULT_CODEC: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif";
     isAudioCodec: (codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif" | undefined) => boolean;
     logLevels: readonly ["verbose", "info", "warn", "error"];
-    isEqualOrBelowLogLevel: (currentLevel: "error" | "verbose" | "info" | "warn", level: "error" | "verbose" | "info" | "warn") => boolean;
+    isEqualOrBelowLogLevel: (currentLevel: "verbose" | "error" | "info" | "warn", level: "verbose" | "error" | "info" | "warn") => boolean;
     isValidLogLevel: (level: string) => boolean;
     perf: typeof perf;
-    makeDownloadMap: () => import("./assets/download-map").DownloadMap;
-    cleanDownloadMap: (downloadMap: import("./assets/download-map").DownloadMap) => void;
     convertToPositiveFrameIndex: ({ frame, durationInFrames, }: {
         frame: number;
         durationInFrames: number;
@@ -305,6 +302,7 @@ export declare const RenderInternals: {
     validVideoImageFormats: readonly ["png", "jpeg", "none"];
     DEFAULT_STILL_IMAGE_FORMAT: "jpeg" | "png" | "webp" | "pdf";
     DEFAULT_VIDEO_IMAGE_FORMAT: "jpeg" | "png" | "none";
+    DEFAULT_JPEG_QUALITY: number;
     chalk: {
         enabled: boolean;
         visible: boolean;
@@ -358,25 +356,117 @@ export declare const RenderInternals: {
         verbose: (message?: any, ...optionalParams: any[]) => void;
         verboseAdvanced: (options: {
             indent: boolean;
-            logLevel: "error" | "verbose" | "info" | "warn";
+            logLevel: "verbose" | "error" | "info" | "warn";
         } & {
             tag?: string | undefined;
+            secondTag?: string | undefined;
         }, message?: any, ...optionalParams: any[]) => void;
         info: (message?: any, ...optionalParams: any[]) => void;
         infoAdvanced: (options: {
             indent: boolean;
-            logLevel: "error" | "verbose" | "info" | "warn";
+            logLevel: "verbose" | "error" | "info" | "warn";
         }, message?: any, ...optionalParams: any[]) => void;
         warn: (message?: any, ...optionalParams: any[]) => void;
         warnAdvanced: (options: {
             indent: boolean;
-            logLevel: "error" | "verbose" | "info" | "warn";
+            logLevel: "verbose" | "error" | "info" | "warn";
         }, message?: any, ...optionalParams: any[]) => void;
         error: (message?: any, ...optionalParams: any[]) => void;
     };
-    getLogLevel: () => "error" | "verbose" | "info" | "warn";
-    setLogLevel: (newLogLevel: "error" | "verbose" | "info" | "warn") => void;
+    getLogLevel: () => "verbose" | "error" | "info" | "warn";
+    setLogLevel: (newLogLevel: "verbose" | "error" | "info" | "warn") => void;
     INDENT_TOKEN: string;
     isColorSupported: boolean;
     HeadlessBrowser: typeof HeadlessBrowser;
+    prepareServer: ({ webpackConfigOrServeUrl, port, remotionRoot, concurrency, verbose, indent, }: {
+        webpackConfigOrServeUrl: string;
+        port: number | null;
+        remotionRoot: string;
+        concurrency: number;
+        verbose: boolean;
+        indent: boolean;
+    }) => Promise<import("./prepare-server").RemotionServer>;
+    makeOrReuseServer: (server: import("./prepare-server").RemotionServer | undefined, config: {
+        webpackConfigOrServeUrl: string;
+        port: number | null;
+        remotionRoot: string;
+        concurrency: number;
+        verbose: boolean;
+        indent: boolean;
+    }, { onDownload, onError, }: {
+        onError: (err: Error) => void;
+        onDownload: import("./assets/download-and-map-assets-to-file").RenderMediaOnDownload | null;
+    }) => Promise<{
+        server: import("./prepare-server").RemotionServer;
+        cleanupServer: (force: boolean) => Promise<unknown>;
+    }>;
+    internalRenderStill: (options: {
+        composition: import("remotion").AnySmallCompMetadata;
+        output: string | null;
+        frame: number;
+        inputProps: Record<string, unknown>;
+        imageFormat: "jpeg" | "png" | "webp" | "pdf";
+        jpegQuality: number;
+        puppeteerInstance: HeadlessBrowser | null;
+        dumpBrowserLogs: boolean;
+        envVariables: Record<string, string>;
+        overwrite: boolean;
+        browserExecutable: import("./browser-executable").BrowserExecutable;
+        onBrowserLog: ((log: import("./browser-log").BrowserLog) => void) | null;
+        timeoutInMilliseconds: number;
+        chromiumOptions: import("./open-browser").ChromiumOptions;
+        scale: number;
+        onDownload: import("./assets/download-and-map-assets-to-file").RenderMediaOnDownload | null;
+        cancelSignal: import("./make-cancel-signal").CancelSignal | null;
+        indent: boolean;
+        server: import("./prepare-server").RemotionServer | undefined;
+        verbose: boolean;
+        serveUrl: string;
+        port: number | null;
+    }) => Promise<{
+        buffer: Buffer | null;
+    }>;
+    internalOpenBrowser: ({ browser, browserExecutable, chromiumOptions, forceDeviceScaleFactor, indent, shouldDumpIo, viewport, }: {
+        shouldDumpIo: boolean;
+        browserExecutable: string | null;
+        chromiumOptions: import("./open-browser").ChromiumOptions;
+        forceDeviceScaleFactor: number | undefined;
+        viewport: import("./browser/PuppeteerViewport").Viewport | null;
+        indent: boolean;
+        browser: import("./browser").Browser;
+    }) => Promise<HeadlessBrowser>;
+    internalSelectComposition: (options: {
+        inputProps: Record<string, unknown>;
+        envVariables: Record<string, string>;
+        puppeteerInstance: HeadlessBrowser | undefined;
+        onBrowserLog: ((log: import("./browser-log").BrowserLog) => void) | null;
+        browserExecutable: import("./browser-executable").BrowserExecutable;
+        timeoutInMilliseconds: number;
+        chromiumOptions: import("./open-browser").ChromiumOptions;
+        port: number | null;
+        indent: boolean;
+        server: import("./prepare-server").RemotionServer | undefined;
+        verbose: boolean;
+        serveUrl: string;
+        id: string;
+    }) => Promise<import("remotion").AnyCompMetadata>;
+    internalGetCompositions: ({ browserExecutable, chromiumOptions, envVariables, indent, inputProps, onBrowserLog, port, puppeteerInstance, serveUrlOrWebpackUrl, server, timeoutInMilliseconds, verbose, }: {
+        inputProps: Record<string, unknown>;
+        envVariables: Record<string, string>;
+        puppeteerInstance: HeadlessBrowser | undefined;
+        onBrowserLog: ((log: import("./browser-log").BrowserLog) => void) | null;
+        browserExecutable: import("./browser-executable").BrowserExecutable;
+        timeoutInMilliseconds: number;
+        chromiumOptions: import("./open-browser").ChromiumOptions;
+        port: number | null;
+        server: import("./prepare-server").RemotionServer | undefined;
+        indent: boolean;
+        verbose: boolean;
+        serveUrlOrWebpackUrl: string;
+    }) => Promise<import("remotion").AnyCompMetadata[]>;
+    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, }: import("./render-frames").InternalRenderFramesOptions) => Promise<import("./types").RenderFramesOutput>;
+    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, }: import("./render-media").InternalRenderMediaOptions) => Promise<{
+        buffer: Buffer | null;
+        slowestFrames: import("./render-media").SlowFrame[];
+    }>;
 };

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/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/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;
@@ -17,6 +19,6 @@ export declare const Log: {
     warnAdvanced: (options: LogOptions, message?: any, ...optionalParams: any[]) => void;
     error: (message?: any, ...optionalParams: any[]) => void;
 };
-export declare const getLogLevel: () => "error" | "verbose" | "info" | "warn";
+export declare const getLogLevel: () => "verbose" | "error" | "info" | "warn";
 export declare const setLogLevel: (newLogLevel: LogLevel) => void;
 export {};

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 {};