@remotion/renderer 3.2.16 → 3.2.20

package/dist/ffmpeg-args-hook.d.ts

@@ -0,0 +1 @@
+export declare type FfmpegArgsHook = (args: string[]) => string[];

package/dist/ffmpeg-args-hook.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import execa from 'execa';
 import { SymbolicateableError } from './error-handling/symbolicateable-error';
 import { mimeContentType, mimeLookup } from './mime-types';
@@ -68,7 +67,7 @@ export declare const RenderInternals: {
         task: Promise<Buffer | null>;
         getLogs: () => string;
     }>;
-    getFileExtensionFromCodec: (codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif", type: "chunk" | "final") => "mp3" | "aac" | "wav" | "gif" | "webm" | "mp4" | "mov" | "mkv";
+    getFileExtensionFromCodec: (codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif", type: "chunk" | "final") => "mp3" | "aac" | "wav" | "gif" | "mp4" | "mkv" | "mov" | "webm";
     tmpDir: (str: string) => string;
     deleteDirectory: (directory: string) => Promise<void>;
     isServeUrl: (potentialUrl: string) => boolean;
@@ -123,8 +122,8 @@ export declare const RenderInternals: {
     validPixelFormats: readonly ["yuv420p", "yuva420p", "yuv422p", "yuv444p", "yuv420p10le", "yuv422p10le", "yuv444p10le", "yuva444p10le"];
     DEFAULT_BROWSER: import("./browser").Browser;
     validateFrameRange: (frameRange: import("./frame-range").FrameRange | null) => void;
-    DEFAULT_OPENGL_RENDERER: "angle" | "swangle" | "egl" | "swiftshader" | null;
-    validateOpenGlRenderer: (option: "angle" | "swangle" | "egl" | "swiftshader" | null) => "angle" | "swangle" | "egl" | "swiftshader" | null;
+    DEFAULT_OPENGL_RENDERER: "swangle" | "angle" | "egl" | "swiftshader" | null;
+    validateOpenGlRenderer: (option: "swangle" | "angle" | "egl" | "swiftshader" | null) => "swangle" | "angle" | "egl" | "swiftshader" | null;
     getDefaultCrfForCodec: (codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif") => number;
     validateSelectedCrfAndCodecCombination: (crf: unknown, codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif") => void;
     validImageFormats: readonly ["png", "jpeg", "none"];
@@ -136,12 +135,12 @@ export declare const RenderInternals: {
     DEFAULT_TIMEOUT: number;
     getValidCrfRanges: (codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif") => [number, number];
     validateSelectedPixelFormatAndCodecCombination: (pixelFormat: "yuv420p" | "yuva420p" | "yuv422p" | "yuv444p" | "yuv420p10le" | "yuv422p10le" | "yuv444p10le" | "yuva444p10le", codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif") => void;
-    validateSelectedCodecAndProResCombination: (actualCodec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif", actualProResProfile: "proxy" | "4444-xq" | "4444" | "hq" | "standard" | "light" | undefined) => void;
-    validateSelectedPixelFormatAndImageFormatCombination: (pixelFormat: "yuv420p" | "yuva420p" | "yuv422p" | "yuv444p" | "yuv420p10le" | "yuv422p10le" | "yuv444p10le" | "yuva444p10le", imageFormat: "jpeg" | "png" | "none") => "none" | "valid";
+    validateSelectedCodecAndProResCombination: (actualCodec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif", actualProResProfile: "4444-xq" | "4444" | "hq" | "standard" | "light" | "proxy" | undefined) => void;
+    validateSelectedPixelFormatAndImageFormatCombination: (pixelFormat: "yuv420p" | "yuva420p" | "yuv422p" | "yuv444p" | "yuv420p10le" | "yuv422p10le" | "yuv444p10le" | "yuva444p10le", imageFormat: "png" | "jpeg" | "none") => "none" | "valid";
     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;
     validateEveryNthFrame: (everyNthFrame: unknown) => void;
     perf: typeof perf;

package/dist/make-assets-download-dir.d.ts

@@ -0,0 +1 @@
+export declare const makeAssetsDownloadTmpDir: () => string;

package/dist/make-assets-download-dir.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeAssetsDownloadTmpDir = void 0;
+const tmp_dir_1 = require("./tmp-dir");
+let dir = null;
+const makeAssetsDownloadTmpDir = () => {
+    if (dir) {
+        return dir;
+    }
+    dir = (0, tmp_dir_1.tmpDir)('remotion-assets-dir');
+    return dir;
+};
+exports.makeAssetsDownloadTmpDir = makeAssetsDownloadTmpDir;

package/dist/render-frames.d.ts

@@ -20,6 +20,14 @@ declare type ConfigOrComposition = {
 } | {
     composition: SmallTCompMetadata;
 };
+declare type ConcurrencyOrParallelism = {
+    concurrency: number | null;
+} | {
+    /**
+     * @deprecated This field has been renamed to `concurrency`
+     */
+    parallelism: number | null;
+};
 declare type RenderFramesOptions = {
     onStart: (data: OnStartData) => void;
     onFrameUpdate: (framesRendered: number, frameIndex: number) => void;
@@ -27,7 +35,6 @@ declare type RenderFramesOptions = {
     inputProps: unknown;
     envVariables?: Record<string, string>;
     imageFormat: ImageFormat;
-    parallelism?: number | null;
     quality?: number;
     frameRange?: FrameRange | null;
     everyNthFrame?: number;
@@ -49,6 +56,6 @@ declare type RenderFramesOptions = {
      */
     downloadMap?: DownloadMap;
     muted?: boolean;
-} & ConfigOrComposition & ServeUrlOrWebpackBundle;
+} & ConfigOrComposition & ConcurrencyOrParallelism & ServeUrlOrWebpackBundle;
 export declare const renderFrames: (options: RenderFramesOptions) => Promise<RenderFramesOutput>;
 export {};

package/dist/render-frames.js

@@ -39,12 +39,21 @@ const getComposition = (others) => {
     }
     return undefined;
 };
+const getConcurrency = (others) => {
+    if ('concurrency' in others) {
+        return others.concurrency;
+    }
+    if ('parallelism' in others) {
+        return others.parallelism;
+    }
+    return undefined;
+};
 const getPool = async (pages) => {
     const puppeteerPages = await Promise.all(pages);
     const pool = new pool_1.Pool(puppeteerPages);
     return pool;
 };
-const innerRenderFrames = ({ onFrameUpdate, outputDir, onStart, inputProps, quality, imageFormat = image_format_1.DEFAULT_IMAGE_FORMAT, frameRange, puppeteerInstance, onError, envVariables, onBrowserLog, onFrameBuffer, onDownload, pagesArray, serveUrl, composition, timeoutInMilliseconds, scale, actualParallelism, everyNthFrame = 1, proxyPort, cancelSignal, downloadMap, muted, }) => {
+const innerRenderFrames = ({ onFrameUpdate, outputDir, onStart, inputProps, quality, imageFormat = image_format_1.DEFAULT_IMAGE_FORMAT, frameRange, puppeteerInstance, onError, envVariables, onBrowserLog, onFrameBuffer, onDownload, pagesArray, serveUrl, composition, timeoutInMilliseconds, scale, actualConcurrency, everyNthFrame = 1, proxyPort, cancelSignal, downloadMap, muted, }) => {
     if (!puppeteerInstance) {
         throw new Error('no puppeteer instance passed to innerRenderFrames - internal error');
     }
@@ -59,7 +68,7 @@ const innerRenderFrames = ({ onFrameUpdate, outputDir, onStart, inputProps, qual
     const realFrameRange = (0, get_frame_to_render_1.getRealFrameRange)(composition.durationInFrames, frameRange !== null && frameRange !== void 0 ? frameRange : null);
     const framesToRender = (0, get_duration_from_frame_range_1.getFramesToRender)(realFrameRange, everyNthFrame);
     const lastFrame = framesToRender[framesToRender.length - 1];
-    const pages = new Array(actualParallelism).fill(true).map(async () => {
+    const pages = new Array(actualConcurrency).fill(true).map(async () => {
         const page = await puppeteerInstance.newPage();
         pagesArray.push(page);
         await page.setViewport({
@@ -234,8 +243,9 @@ const innerRenderFrames = ({ onFrameUpdate, outputDir, onStart, inputProps, qual
         .then(() => happyPath);
 };
 const renderFrames = (options) => {
-    var _a, _b, _c, _d, _e;
+    var _a, _b, _c, _d;
     const composition = getComposition(options);
+    const concurrency = getConcurrency(options);
     if (!composition) {
         throw new Error('No `composition` option has been specified for renderFrames()');
     }
@@ -257,7 +267,7 @@ const renderFrames = (options) => {
     });
     const downloadMap = (_c = options.downloadMap) !== null && _c !== void 0 ? _c : (0, download_map_1.makeDownloadMap)();
     const onDownload = (_d = options.onDownload) !== null && _d !== void 0 ? _d : (() => () => undefined);
-    const actualParallelism = (0, get_concurrency_1.getActualConcurrency)((_e = options.parallelism) !== null && _e !== void 0 ? _e : null);
+    const actualConcurrency = (0, get_concurrency_1.getActualConcurrency)(concurrency !== null && concurrency !== void 0 ? concurrency : null);
     const openedPages = [];
     return new Promise((resolve, reject) => {
         var _a, _b, _c;
@@ -284,7 +294,7 @@ const renderFrames = (options) => {
                 }),
                 browserInstance,
             ]).then(([{ serveUrl, closeServer, offthreadPort }, puppeteerInstance]) => {
-                const { stopCycling } = (0, cycle_browser_tabs_1.cycleBrowserTabs)(puppeteerInstance, actualParallelism);
+                const { stopCycling } = (0, cycle_browser_tabs_1.cycleBrowserTabs)(puppeteerInstance, actualConcurrency);
                 cleanup.push(stopCycling);
                 cleanup.push(closeServer);
                 return innerRenderFrames({
@@ -294,7 +304,7 @@ const renderFrames = (options) => {
                     pagesArray: openedPages,
                     serveUrl,
                     composition,
-                    actualParallelism,
+                    actualConcurrency,
                     onDownload,
                     proxyPort: offthreadPort,
                     downloadMap,

package/dist/render-media.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { SmallTCompMetadata } from 'remotion';
 import type { RenderMediaOnDownload } from './assets/download-and-map-assets-to-file';
 import type { DownloadMap } from './assets/download-map';
@@ -20,6 +19,7 @@ export declare type RenderMediaOnProgress = (progress: {
     encodedFrames: number;
     encodedDoneIn: number | null;
     renderedDoneIn: number | null;
+    progress: number;
     stitchStage: StitchingState;
 }) => void;
 export declare type RenderMediaOptions = {
@@ -27,7 +27,6 @@ export declare type RenderMediaOptions = {
     codec: Codec;
     composition: SmallTCompMetadata;
     inputProps?: unknown;
-    parallelism?: number | null;
     crf?: number | null;
     imageFormat?: 'png' | 'jpeg' | 'none';
     ffmpegExecutable?: FfmpegExecutable;
@@ -59,10 +58,19 @@ export declare type RenderMediaOptions = {
     downloadMap?: DownloadMap;
     muted?: boolean;
     enforceAudioTrack?: boolean;
-} & ServeUrlOrWebpackBundle;
+} & ServeUrlOrWebpackBundle & ConcurrencyOrParallelism;
+declare type ConcurrencyOrParallelism = {
+    concurrency: number | null;
+} | {
+    /**
+     * @deprecated This field has been renamed to `concurrency`
+     */
+    parallelism: number | null;
+};
 /**
  *
  * @description Render a video from a composition
  * @link https://www.remotion.dev/docs/renderer/render-media
  */
-export declare const renderMedia: ({ parallelism, proResProfile, crf, composition, ffmpegExecutable, ffprobeExecutable, inputProps, pixelFormat, codec, envVariables, frameRange, puppeteerInstance, outputLocation, onProgress, overwrite, onDownload, dumpBrowserLogs, onBrowserLog, onStart, timeoutInMilliseconds, chromiumOptions, scale, browserExecutable, port, cancelSignal, muted, enforceAudioTrack, ...options }: RenderMediaOptions) => Promise<Buffer | null>;
+export declare const renderMedia: ({ proResProfile, crf, composition, ffmpegExecutable, ffprobeExecutable, inputProps, pixelFormat, codec, envVariables, frameRange, puppeteerInstance, outputLocation, onProgress, overwrite, onDownload, dumpBrowserLogs, onBrowserLog, onStart, timeoutInMilliseconds, chromiumOptions, scale, browserExecutable, port, cancelSignal, muted, enforceAudioTrack, ...options }: RenderMediaOptions) => Promise<Buffer | null>;
+export {};

package/dist/render-media.js

@@ -32,12 +32,21 @@ const stitch_frames_to_video_1 = require("./stitch-frames-to-video");
 const validate_even_dimensions_with_codec_1 = require("./validate-even-dimensions-with-codec");
 const validate_output_filename_1 = require("./validate-output-filename");
 const validate_scale_1 = require("./validate-scale");
+const getConcurrency = (others) => {
+    if ('concurrency' in others) {
+        return others.concurrency;
+    }
+    if ('parallelism' in others) {
+        return others.parallelism;
+    }
+    return null;
+};
 /**
  *
  * @description Render a video from a composition
  * @link https://www.remotion.dev/docs/renderer/render-media
  */
-const renderMedia = ({ parallelism, proResProfile, crf, composition, ffmpegExecutable, ffprobeExecutable, inputProps, pixelFormat, codec, envVariables, frameRange, puppeteerInstance, outputLocation, onProgress, overwrite, onDownload, dumpBrowserLogs, onBrowserLog, onStart, timeoutInMilliseconds, chromiumOptions, scale, browserExecutable, port, cancelSignal, muted, enforceAudioTrack, ...options }) => {
+const renderMedia = ({ proResProfile, crf, composition, ffmpegExecutable, ffprobeExecutable, inputProps, pixelFormat, codec, envVariables, frameRange, puppeteerInstance, outputLocation, onProgress, overwrite, onDownload, dumpBrowserLogs, onBrowserLog, onStart, timeoutInMilliseconds, chromiumOptions, scale, browserExecutable, port, cancelSignal, muted, enforceAudioTrack, ...options }) => {
     var _a, _b, _c, _d;
     (0, quality_1.validateQuality)(options.quality);
     if (typeof crf !== 'undefined' && crf !== null) {
@@ -50,6 +59,7 @@ const renderMedia = ({ parallelism, proResProfile, crf, composition, ffmpegExecu
         ? path_1.default.resolve(process.cwd(), outputLocation)
         : null;
     (0, validate_scale_1.validateScale)(scale);
+    const concurrency = getConcurrency(options);
     const everyNthFrame = (_a = options.everyNthFrame) !== null && _a !== void 0 ? _a : 1;
     const numberOfGifLoops = (_b = options.numberOfGifLoops) !== null && _b !== void 0 ? _b : null;
     const serveUrl = (0, legacy_webpack_config_1.getServeUrlWithFallback)(options);
@@ -101,6 +111,9 @@ const renderMedia = ({ parallelism, proResProfile, crf, composition, ffmpegExecu
             renderedDoneIn,
             renderedFrames,
             stitchStage,
+            progress: Math.round(((0.7 * renderedFrames + 0.3 * encodedFrames) /
+                composition.durationInFrames) *
+                100) / 100,
         });
     };
     const realFrameRange = (0, get_frame_to_render_1.getRealFrameRange)(composition.durationInFrames, frameRange !== null && frameRange !== void 0 ? frameRange : null);
@@ -160,7 +173,7 @@ const renderMedia = ({ parallelism, proResProfile, crf, composition, ffmpegExecu
                 renderedFrames = frame;
                 callUpdate();
             },
-            parallelism,
+            concurrency,
             outputDir,
             onStart: (data) => {
                 renderedFrames = 0;

package/dist/validate-ffmpeg-args-hook.d.ts

@@ -0,0 +1,2 @@
+import type { FfmpegArgsHook } from './ffmpeg-args-hook';
+export declare const validateFfmpegArgsHook: (ffmpegArgsHook?: FfmpegArgsHook) => void;

package/dist/validate-ffmpeg-args-hook.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateFfmpegArgsHook = void 0;
+const validateFfmpegArgsHook = (ffmpegArgsHook) => {
+    if (ffmpegArgsHook && typeof ffmpegArgsHook !== 'function') {
+        throw new TypeError(`Argument passed for "ffmpegArgsHook" is not a function: ${ffmpegArgsHook}`);
+    }
+};
+exports.validateFfmpegArgsHook = validateFfmpegArgsHook;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@remotion/renderer",
-	"version": "3.2.16",
+	"version": "3.2.20",
 	"description": "Renderer for Remotion",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
@@ -22,7 +22,7 @@
 	"dependencies": {
 		"execa": "5.1.1",
 		"extract-zip": "2.0.1",
-		"remotion": "3.2.16",
+		"remotion": "3.2.20",
 		"source-map": "^0.8.0-beta.0",
 		"ws": "8.7.0"
 	},
@@ -57,5 +57,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "3c64e274a2c74e1b791d4a24b3af2ae456c0fd9e"
+	"gitHead": "640f36c0c2d9fb1b7768925bf9d64840cbc31bc6"
 }