@remotion/renderer 4.0.0-lambda.1 → 4.0.0-newpathfunctions.13

package/dist/prespawn-ffmpeg.js

@@ -6,26 +6,29 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.prespawnFfmpeg = void 0;
 const execa_1 = __importDefault(require("execa"));
 const remotion_1 = require("remotion");
+const codec_1 = require("./codec");
+const crf_1 = require("./crf");
+const ffmpeg_flags_1 = require("./ffmpeg-flags");
 const get_codec_name_1 = require("./get-codec-name");
 const get_prores_profile_name_1 = require("./get-prores-profile-name");
 const parse_ffmpeg_progress_1 = require("./parse-ffmpeg-progress");
+const pixel_format_1 = require("./pixel-format");
 const validate_even_dimensions_with_codec_1 = require("./validate-even-dimensions-with-codec");
 const validate_ffmpeg_1 = require("./validate-ffmpeg");
-const prespawnFfmpeg = async (options) => {
-    var _a, _b, _c, _d, _e, _f, _g;
+const prespawnFfmpeg = async (options, remotionRoot) => {
+    var _a, _b, _c, _d, _e, _f;
     remotion_1.Internals.validateDimension(options.height, 'height', 'passed to `stitchFramesToVideo()`');
     remotion_1.Internals.validateDimension(options.width, 'width', 'passed to `stitchFramesToVideo()`');
-    remotion_1.Internals.validateFps(options.fps, 'passed to `stitchFramesToVideo()`');
-    const codec = (_a = options.codec) !== null && _a !== void 0 ? _a : remotion_1.Internals.DEFAULT_CODEC;
+    const codec = (_a = options.codec) !== null && _a !== void 0 ? _a : codec_1.DEFAULT_CODEC;
+    remotion_1.Internals.validateFps(options.fps, 'in `stitchFramesToVideo()`', codec === 'gif');
     (0, validate_even_dimensions_with_codec_1.validateEvenDimensionsWithCodec)({
         width: options.width,
         height: options.height,
         codec,
         scale: 1,
     });
-    const crf = (_b = options.crf) !== null && _b !== void 0 ? _b : remotion_1.Internals.getDefaultCrfForCodec(codec);
-    const pixelFormat = (_c = options.pixelFormat) !== null && _c !== void 0 ? _c : remotion_1.Internals.DEFAULT_PIXEL_FORMAT;
-    await (0, validate_ffmpeg_1.validateFfmpeg)((_d = options.ffmpegExecutable) !== null && _d !== void 0 ? _d : null);
+    const pixelFormat = (_b = options.pixelFormat) !== null && _b !== void 0 ? _b : pixel_format_1.DEFAULT_PIXEL_FORMAT;
+    await (0, validate_ffmpeg_1.validateFfmpeg)((_c = options.ffmpegExecutable) !== null && _c !== void 0 ? _c : null, remotionRoot, 'ffmpeg');
     const encoderName = (0, get_codec_name_1.getCodecName)(codec);
     const proResProfileName = (0, get_prores_profile_name_1.getProResProfileName)(codec, options.proResProfile);
     if (encoderName === null) {
@@ -33,19 +36,18 @@ const prespawnFfmpeg = async (options) => {
     }
     const supportsCrf = codec !== 'prores';
     if (options.verbose) {
-        console.log('[verbose] ffmpeg', (_e = options.ffmpegExecutable) !== null && _e !== void 0 ? _e : 'ffmpeg in PATH');
+        console.log('[verbose] ffmpeg', (_d = options.ffmpegExecutable) !== null && _d !== void 0 ? _d : 'ffmpeg in PATH');
         console.log('[verbose] encoder', encoderName);
         console.log('[verbose] pixelFormat', pixelFormat);
         if (supportsCrf) {
-            console.log('[verbose] crf', crf);
+            console.log('[verbose] crf', options.crf);
         }
         console.log('[verbose] codec', codec);
         console.log('[verbose] proResProfileName', proResProfileName);
     }
-    remotion_1.Internals.validateSelectedCrfAndCodecCombination(crf, codec);
-    remotion_1.Internals.validateSelectedPixelFormatAndCodecCombination(pixelFormat, codec);
+    (0, pixel_format_1.validateSelectedPixelFormatAndCodecCombination)(pixelFormat, codec);
     const ffmpegArgs = [
-        ['-r', String(options.fps)],
+        ['-r', options.fps.toFixed(2)],
         ...[
             ['-f', 'image2pipe'],
             ['-s', `${options.width}x${options.height}`],
@@ -58,12 +60,15 @@ const prespawnFfmpeg = async (options) => {
         // and specified the video codec.
         ['-c:v', encoderName],
         proResProfileName ? ['-profile:v', proResProfileName] : null,
-        supportsCrf ? ['-crf', String(crf)] : null,
         ['-pix_fmt', pixelFormat],
         // Without explicitly disabling auto-alt-ref,
         // transparent WebM generation doesn't work
         pixelFormat === 'yuva420p' ? ['-auto-alt-ref', '0'] : null,
-        ['-b:v', '1M'],
+        ...(0, crf_1.validateQualitySettings)({
+            crf: options.crf,
+            videoBitrate: options.videoBitrate,
+            codec,
+        }),
         '-y',
         options.outputLocation,
     ];
@@ -72,12 +77,15 @@ const prespawnFfmpeg = async (options) => {
         console.log(ffmpegArgs);
     }
     const ffmpegString = ffmpegArgs.flat(2).filter(Boolean);
-    const task = (0, execa_1.default)((_f = options.ffmpegExecutable) !== null && _f !== void 0 ? _f : 'ffmpeg', ffmpegString);
+    const finalFfmpegString = options.ffmpegOverride
+        ? options.ffmpegOverride({ type: 'pre-stitcher', args: ffmpegString })
+        : ffmpegString;
+    const task = (0, execa_1.default)(await (0, ffmpeg_flags_1.getExecutableBinary)((_e = options.ffmpegExecutable) !== null && _e !== void 0 ? _e : null, remotionRoot, 'ffmpeg'), finalFfmpegString);
     options.signal(() => {
         task.kill();
     });
     let ffmpegOutput = '';
-    (_g = task.stderr) === null || _g === void 0 ? void 0 : _g.on('data', (data) => {
+    (_f = task.stderr) === null || _f === void 0 ? void 0 : _f.on('data', (data) => {
         const str = data.toString();
         ffmpegOutput += str;
         if (options.onProgress) {

package/dist/prestitcher-memory-usage.d.ts

@@ -0,0 +1,12 @@
+export declare const estimateMemoryUsageForPrestitcher: ({ width, height, }: {
+    width: number;
+    height: number;
+}) => number;
+export declare const shouldUseParallelEncoding: ({ width, height, }: {
+    width: number;
+    height: number;
+}) => {
+    hasEnoughMemory: boolean;
+    freeMemory: number;
+    estimatedUsage: number;
+};

package/dist/prestitcher-memory-usage.js

@@ -0,0 +1,30 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shouldUseParallelEncoding = exports.estimateMemoryUsageForPrestitcher = void 0;
+const os_1 = __importDefault(require("os"));
+const estimateMemoryUsageForPrestitcher = ({ width, height, }) => {
+    // Empirically we detected that per 1 million pixels, FFMPEG uses around 1GB of memory, relatively independent of
+    // the duration of the video.
+    const memoryUsageFor4K = 1000000000;
+    const memoryUsageOfPixel = memoryUsageFor4K / 1000000;
+    return memoryUsageOfPixel * width * height;
+};
+exports.estimateMemoryUsageForPrestitcher = estimateMemoryUsageForPrestitcher;
+const shouldUseParallelEncoding = ({ width, height, }) => {
+    const freeMemory = os_1.default.freemem();
+    const estimatedUsage = (0, exports.estimateMemoryUsageForPrestitcher)({
+        height,
+        width,
+    });
+    const hasEnoughMemory = freeMemory - estimatedUsage > 2000000000 &&
+        estimatedUsage / freeMemory < 0.5;
+    return {
+        hasEnoughMemory,
+        freeMemory,
+        estimatedUsage,
+    };
+};
+exports.shouldUseParallelEncoding = shouldUseParallelEncoding;

package/dist/prores-profile.d.ts

@@ -0,0 +1,8 @@
+import type { Codec } from './codec';
+declare const proResProfileOptions: readonly ["4444-xq", "4444", "hq", "standard", "light", "proxy"];
+export declare type ProResProfile = typeof proResProfileOptions[number];
+export declare const validateSelectedCodecAndProResCombination: ({ codec, proResProfile, }: {
+    codec: Codec;
+    proResProfile: ProResProfile | undefined;
+}) => void;
+export {};

package/dist/prores-profile.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateSelectedCodecAndProResCombination = void 0;
+const proResProfileOptions = [
+    '4444-xq',
+    '4444',
+    'hq',
+    'standard',
+    'light',
+    'proxy',
+];
+const validateSelectedCodecAndProResCombination = ({ codec, proResProfile, }) => {
+    if (typeof proResProfile !== 'undefined' && codec !== 'prores') {
+        throw new TypeError(`You have set a ProRes profile but the codec is "${codec}". Set the codec to "prores" or remove the ProRes profile.`);
+    }
+    if (proResProfile !== undefined &&
+        !proResProfileOptions.includes(proResProfile)) {
+        throw new TypeError(`The ProRes profile "${proResProfile}" is not valid. Valid options are ${proResProfileOptions
+            .map((p) => `"${p}"`)
+            .join(', ')}`);
+    }
+};
+exports.validateSelectedCodecAndProResCombination = validateSelectedCodecAndProResCombination;

package/dist/provide-screenshot.d.ts

@@ -1,11 +1,15 @@
-import puppeteer from 'puppeteer-core';
-import { ImageFormat } from 'remotion';
-export declare const provideScreenshot: ({ page, imageFormat, options, quality, }: {
-    page: puppeteer.Page;
+import type { ClipRegion } from 'remotion';
+import type { Page } from './browser/BrowserPage';
+import type { ImageFormat } from './image-format';
+export declare const provideScreenshot: ({ page, imageFormat, options, quality, height, width, clipRegion, }: {
+    page: Page;
     imageFormat: ImageFormat;
     quality: number | undefined;
     options: {
         frame: number;
-        output?: string;
+        output: string | null;
     };
+    height: number;
+    width: number;
+    clipRegion: ClipRegion | null;
 }) => Promise<Buffer>;

package/dist/provide-screenshot.js

@@ -2,15 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.provideScreenshot = void 0;
 const screenshot_dom_element_1 = require("./screenshot-dom-element");
-const provideScreenshot = ({ page, imageFormat, options, quality, }) => {
+const provideScreenshot = ({ page, imageFormat, options, quality, height, width, clipRegion, }) => {
     return (0, screenshot_dom_element_1.screenshotDOMElement)({
         page,
         opts: {
             path: options.output,
-            selector: '#remotion-canvas',
         },
         imageFormat,
         quality,
+        height,
+        width,
+        clipRegion,
     });
 };
 exports.provideScreenshot = provideScreenshot;

package/dist/puppeteer-evaluate.d.ts

@@ -1,4 +1,4 @@
-import { Page } from 'puppeteer-core';
+import type { Page } from './browser/BrowserPage';
 export declare function puppeteerEvaluateWithCatch<ReturnType>({ page, pageFunction, frame, args, }: {
     page: Page;
     pageFunction: Function | string;

package/dist/puppeteer-evaluate.js

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.puppeteerEvaluateWithCatch = void 0;
-/* eslint-disable no-new */
-const puppeteer_core_1 = require("puppeteer-core");
+const JSHandle_1 = require("./browser/JSHandle");
 const symbolicateable_error_1 = require("./error-handling/symbolicateable-error");
 const parse_browser_error_stack_1 = require("./parse-browser-error-stack");
 const EVALUATION_SCRIPT_URL = '__puppeteer_evaluation_script__';
@@ -33,7 +32,7 @@ function isString(obj) {
 async function puppeteerEvaluateWithCatch({ page, pageFunction, frame, args, }) {
     var _a, _b, _c, _d, _e, _f, _g;
     const contextId = (await page.mainFrame().executionContext())._contextId;
-    const client = page._client;
+    const client = page._client();
     const suffix = `//# sourceURL=${EVALUATION_SCRIPT_URL}`;
     if (isString(pageFunction)) {
         const expression = pageFunction;
@@ -100,18 +99,26 @@ async function puppeteerEvaluateWithCatch({ page, pageFunction, frame, args, })
             error.message += ' Are you passing a nested JSHandle?';
         throw error;
     }
-    const { exceptionDetails, result: remoteObject } = await callFunctionOnPromise;
-    if (exceptionDetails) {
-        const err = new symbolicateable_error_1.SymbolicateableError({
-            stack: (_c = exceptionDetails.exception) === null || _c === void 0 ? void 0 : _c.description,
-            name: (_d = exceptionDetails.exception) === null || _d === void 0 ? void 0 : _d.className,
-            message: (_f = (_e = exceptionDetails.exception) === null || _e === void 0 ? void 0 : _e.description) === null || _f === void 0 ? void 0 : _f.split('\n')[0],
-            frame,
-            stackFrame: (0, parse_browser_error_stack_1.parseStack)(((_g = exceptionDetails.exception) === null || _g === void 0 ? void 0 : _g.description).split('\n')),
-        });
-        throw err;
+    try {
+        const { exceptionDetails, result: remoteObject } = await callFunctionOnPromise;
+        if (exceptionDetails) {
+            const err = new symbolicateable_error_1.SymbolicateableError({
+                stack: (_c = exceptionDetails.exception) === null || _c === void 0 ? void 0 : _c.description,
+                name: (_d = exceptionDetails.exception) === null || _d === void 0 ? void 0 : _d.className,
+                message: (_f = (_e = exceptionDetails.exception) === null || _e === void 0 ? void 0 : _e.description) === null || _f === void 0 ? void 0 : _f.split('\n')[0],
+                frame,
+                stackFrame: (0, parse_browser_error_stack_1.parseStack)(((_g = exceptionDetails.exception) === null || _g === void 0 ? void 0 : _g.description).split('\n')),
+            });
+            throw err;
+        }
+        return valueFromRemoteObject(remoteObject);
+    }
+    catch (error) {
+        if (error === null || error === void 0 ? void 0 : error.originalMessage.startsWith("Object couldn't be returned by value")) {
+            throw new Error('Could not serialize the return value of the function. Did you pass non-serializable values to defaultProps?');
+        }
+        throw error;
     }
-    return valueFromRemoteObject(remoteObject);
 }
 exports.puppeteerEvaluateWithCatch = puppeteerEvaluateWithCatch;
 /**
@@ -140,7 +147,7 @@ function convertArgument(arg) {
         return { unserializableValue: '-Infinity' };
     if (Object.is(arg, NaN))
         return { unserializableValue: 'NaN' };
-    const objectHandle = arg && arg instanceof puppeteer_core_1.JSHandle ? arg : null;
+    const objectHandle = arg && arg instanceof JSHandle_1.JSHandle ? arg : null;
     if (objectHandle) {
         if (objectHandle._disposed)
             throw new Error('JSHandle is disposed!');

package/dist/puppeteer-screenshot.d.ts

@@ -1,2 +1,12 @@
-import { Page, ScreenshotOptions } from 'puppeteer-core';
-export declare const screenshot: (page: Page, options?: ScreenshotOptions) => Promise<Buffer | string | void>;
+import type { ClipRegion } from 'remotion';
+import type { Page } from './browser/BrowserPage';
+export declare const screenshot: (options: {
+    page: Page;
+    type: 'png' | 'jpeg';
+    path?: string;
+    quality?: number;
+    omitBackground: boolean;
+    width: number;
+    height: number;
+    clipRegion: ClipRegion | null;
+}) => Promise<Buffer | string>;

package/dist/puppeteer-screenshot.js

@@ -26,7 +26,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.screenshot = void 0;
 const assert = __importStar(require("assert"));
 const screenshot_task_1 = require("./screenshot-task");
-const screenshot = (page, options = {}) => {
+const screenshot = (options) => {
     let screenshotType = null;
     // options.type takes precedence over inferring the type from options.path
     // because it may be a 0-length file with no extension created beforehand
@@ -58,20 +58,15 @@ const screenshot = (page, options = {}) => {
         assert.ok(options.quality >= 0 && options.quality <= 100, 'Expected options.quality to be between 0 and 100 (inclusive), got ' +
             options.quality);
     }
-    assert.ok(!options.clip || !options.fullPage, 'options.clip and options.fullPage are exclusive');
-    if (options.clip) {
-        assert.ok(typeof options.clip.x === 'number', 'Expected options.clip.x to be a number but found ' +
-            typeof options.clip.x);
-        assert.ok(typeof options.clip.y === 'number', 'Expected options.clip.y to be a number but found ' +
-            typeof options.clip.y);
-        assert.ok(typeof options.clip.width === 'number', 'Expected options.clip.width to be a number but found ' +
-            typeof options.clip.width);
-        assert.ok(typeof options.clip.height === 'number', 'Expected options.clip.height to be a number but found ' +
-            typeof options.clip.height);
-        assert.ok(options.clip.width !== 0, 'Expected options.clip.width not to be 0.');
-        assert.ok(options.clip.height !== 0, 'Expected options.clip.height not to be 0.');
-    }
-    // @ts-expect-error
-    return page._screenshotTaskQueue.postTask(() => (0, screenshot_task_1._screenshotTask)(page, screenshotType, options));
+    return options.page.screenshotTaskQueue.postTask(() => (0, screenshot_task_1.screenshotTask)({
+        page: options.page,
+        format: screenshotType,
+        height: options.height,
+        width: options.width,
+        omitBackground: options.omitBackground,
+        path: options.path,
+        quality: options.quality,
+        clipRegion: options.clipRegion,
+    }));
 };
 exports.screenshot = screenshot;

package/dist/quality.d.ts

@@ -0,0 +1 @@
+export declare const validateQuality: (q: number | undefined) => void;

package/dist/quality.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateQuality = void 0;
+const validateQuality = (q) => {
+    if (typeof q !== 'undefined' && typeof q !== 'number') {
+        throw new Error(`Quality option must be a number or undefined. Got ${typeof q} (${JSON.stringify(q)})`);
+    }
+    if (typeof q === 'undefined') {
+        return;
+    }
+    if (!Number.isFinite(q)) {
+        throw new RangeError(`Quality must be a finite number, but is ${q}`);
+    }
+    if (Number.isNaN(q)) {
+        throw new RangeError(`Quality is NaN, but must be a real number`);
+    }
+    if (q > 100 || q < 0) {
+        throw new RangeError('Quality option must be between 0 and 100.');
+    }
+};
+exports.validateQuality = validateQuality;

package/dist/redirect-status-codes.d.ts

@@ -0,0 +1 @@
+export declare const redirectStatusCodes: number[];

package/dist/redirect-status-codes.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.redirectStatusCodes = void 0;
+// Don't handle 304 status code (Not Modified) as a redirect,
+// since the browser will display the right page.
+exports.redirectStatusCodes = [301, 302, 303, 307, 308];

package/dist/render-frames.d.ts

@@ -1,12 +1,17 @@
 /// <reference types="node" />
-import { Browser as PuppeteerBrowser } from 'puppeteer-core';
-import { BrowserExecutable, FfmpegExecutable, FrameRange, ImageFormat, SmallTCompMetadata } from 'remotion';
-import { RenderMediaOnDownload } from './assets/download-and-map-assets-to-file';
-import { BrowserLog } from './browser-log';
-import { ServeUrlOrWebpackBundle } from './legacy-webpack-config';
-import { CancelSignal } from './make-cancel-signal';
-import { ChromiumOptions } from './open-browser';
-import { OnStartData, RenderFramesOutput } from './types';
+import type { SmallTCompMetadata } from 'remotion';
+import type { RenderMediaOnDownload } from './assets/download-and-map-assets-to-file';
+import type { DownloadMap } from './assets/download-map';
+import type { BrowserExecutable } from './browser-executable';
+import type { BrowserLog } from './browser-log';
+import type { Browser } from './browser/Browser';
+import type { FfmpegExecutable } from './ffmpeg-executable';
+import type { FrameRange } from './frame-range';
+import type { ImageFormat } from './image-format';
+import type { ServeUrlOrWebpackBundle } from './legacy-webpack-config';
+import type { CancelSignal } from './make-cancel-signal';
+import type { ChromiumOptions } from './open-browser';
+import type { OnStartData, RenderFramesOutput } from './types';
 declare type ConfigOrComposition = {
     /**
      * @deprecated This field has been renamed to `composition`
@@ -15,18 +20,26 @@ declare type ConfigOrComposition = {
 } | {
     composition: SmallTCompMetadata;
 };
+declare type ConcurrencyOrParallelism = {
+    concurrency?: number | string | 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;
+    onFrameUpdate: (framesRendered: number, frameIndex: number, timeToRenderInMilliseconds: number) => void;
     outputDir: string | null;
     inputProps: unknown;
     envVariables?: Record<string, string>;
     imageFormat: ImageFormat;
-    parallelism?: number | null;
     quality?: number;
     frameRange?: FrameRange | null;
+    everyNthFrame?: number;
     dumpBrowserLogs?: boolean;
-    puppeteerInstance?: PuppeteerBrowser;
+    puppeteerInstance?: Browser;
     browserExecutable?: BrowserExecutable;
     onBrowserLog?: (log: BrowserLog) => void;
     onFrameBuffer?: (buffer: Buffer, frame: number) => void;
@@ -38,6 +51,11 @@ declare type RenderFramesOptions = {
     ffprobeExecutable?: FfmpegExecutable;
     port?: number | null;
     cancelSignal?: CancelSignal;
-} & ConfigOrComposition & ServeUrlOrWebpackBundle;
+    /**
+     * @deprecated Only for Remotion internal usage
+     */
+    downloadMap?: DownloadMap;
+    muted?: boolean;
+} & ConfigOrComposition & ConcurrencyOrParallelism & ServeUrlOrWebpackBundle;
 export declare const renderFrames: (options: RenderFramesOptions) => Promise<RenderFramesOutput>;
 export {};