@remotion/renderer 4.0.0-defer.6 → 4.0.0-esm.17

package/dist/screenshot-dom-element.d.ts

@@ -1,12 +1,15 @@
 /// <reference types="node" />
-import puppeteer from 'puppeteer-core';
-import { ImageFormat } from 'remotion';
-export declare const screenshotDOMElement: ({ page, imageFormat, quality, opts, }: {
-    page: puppeteer.Page;
+import type { ClipRegion } from 'remotion';
+import type { Page } from './browser/BrowserPage';
+import type { ImageFormat } from './image-format';
+export declare const screenshotDOMElement: ({ page, imageFormat, quality, opts, height, width, clipRegion, }: {
+    page: Page;
     imageFormat: ImageFormat;
     quality: number | undefined;
-    opts?: {
-        path?: string | undefined;
-        selector?: string | undefined;
-    } | undefined;
+    opts: {
+        path: string | null;
+    };
+    height: number;
+    width: number;
+    clipRegion: ClipRegion | null;
 }) => Promise<Buffer>;

package/dist/screenshot-dom-element.js

@@ -3,11 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.screenshotDOMElement = void 0;
 const puppeteer_evaluate_1 = require("./puppeteer-evaluate");
 const puppeteer_screenshot_1 = require("./puppeteer-screenshot");
-const screenshotDOMElement = async ({ page, imageFormat, quality, opts = {}, }) => {
-    const path = 'path' in opts ? opts.path : undefined;
-    const { selector } = opts;
-    if (!selector)
-        throw Error('Please provide a selector.');
+const screenshotDOMElement = async ({ page, imageFormat, quality, opts, height, width, clipRegion, }) => {
+    const { path } = opts;
     if (imageFormat === 'png') {
         await (0, puppeteer_evaluate_1.puppeteerEvaluateWithCatch)({
             pageFunction: () => {
@@ -31,11 +28,19 @@ const screenshotDOMElement = async ({ page, imageFormat, quality, opts = {}, })
     if (imageFormat === 'none') {
         throw new TypeError('Tried to make a screenshot with format "none"');
     }
-    return (0, puppeteer_screenshot_1.screenshot)(page, {
+    const buf = await (0, puppeteer_screenshot_1.screenshot)({
+        page,
         omitBackground: imageFormat === 'png',
-        path,
+        path: path !== null && path !== void 0 ? path : undefined,
         type: imageFormat,
         quality,
+        width,
+        height,
+        clipRegion,
     });
+    if (typeof buf === 'string') {
+        throw new TypeError('Expected a buffer');
+    }
+    return buf;
 };
 exports.screenshotDOMElement = screenshotDOMElement;

package/dist/screenshot-task.d.ts

@@ -1,4 +1,14 @@
 /// <reference types="node" />
-import { Page, ScreenshotOptions } from 'puppeteer-core';
-import { StillImageFormat } from 'remotion';
-export declare const _screenshotTask: (page: Page, format: StillImageFormat, options: ScreenshotOptions) => Promise<Buffer | string>;
+import type { ClipRegion } from 'remotion';
+import type { Page } from './browser/BrowserPage';
+import type { StillImageFormat } from './image-format';
+export declare const screenshotTask: ({ format, height, omitBackground, page, width, path, quality, clipRegion, }: {
+    page: Page;
+    format: StillImageFormat;
+    path?: string | undefined;
+    quality?: number | undefined;
+    omitBackground: boolean;
+    width: number;
+    height: number;
+    clipRegion: ClipRegion | null;
+}) => Promise<Buffer | string>;

package/dist/screenshot-task.js

@@ -3,39 +3,67 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._screenshotTask = void 0;
+exports.screenshotTask = void 0;
 const fs_1 = __importDefault(require("fs"));
-const remotion_1 = require("remotion");
-const _screenshotTask = async (page, format, options) => {
-    const client = page._client;
-    const target = page._target;
-    const perfTarget = remotion_1.Internals.perf.startPerfMeasure('activate-target');
+const perf_1 = require("./perf");
+const screenshotTask = async ({ format, height, omitBackground, page, width, path, quality, clipRegion, }) => {
+    var _a;
+    const client = page._client();
+    const target = page.target();
+    const perfTarget = (0, perf_1.startPerfMeasure)('activate-target');
     await client.send('Target.activateTarget', {
         targetId: target._targetId,
     });
-    remotion_1.Internals.perf.stopPerfMeasure(perfTarget);
-    const shouldSetDefaultBackground = options.omitBackground && format === 'png';
+    (0, perf_1.stopPerfMeasure)(perfTarget);
+    const shouldSetDefaultBackground = omitBackground && format === 'png';
     if (shouldSetDefaultBackground)
         await client.send('Emulation.setDefaultBackgroundColorOverride', {
             color: { r: 0, g: 0, b: 0, a: 0 },
         });
-    const cap = remotion_1.Internals.perf.startPerfMeasure('capture');
-    const result = await client.send('Page.captureScreenshot', {
-        format,
-        quality: options.quality,
-        clip: undefined,
-        captureBeyondViewport: true,
-    });
-    remotion_1.Internals.perf.stopPerfMeasure(cap);
-    if (shouldSetDefaultBackground)
-        await client.send('Emulation.setDefaultBackgroundColorOverride');
-    const saveMarker = remotion_1.Internals.perf.startPerfMeasure('save');
-    const buffer = options.encoding === 'base64'
-        ? result.data
-        : Buffer.from(result.data, 'base64');
-    if (options.path)
-        await fs_1.default.promises.writeFile(options.path, buffer);
-    remotion_1.Internals.perf.stopPerfMeasure(saveMarker);
-    return buffer;
+    const cap = (0, perf_1.startPerfMeasure)('capture');
+    try {
+        const result = await client.send('Page.captureScreenshot', {
+            format,
+            quality,
+            clip: clipRegion !== null && clipRegion !== 'hide'
+                ? {
+                    x: clipRegion.x,
+                    y: clipRegion.y,
+                    height: clipRegion.height,
+                    scale: 1,
+                    width: clipRegion.width,
+                }
+                : {
+                    x: 0,
+                    y: 0,
+                    height,
+                    scale: 1,
+                    width,
+                },
+            captureBeyondViewport: true,
+            optimizeForSpeed: true,
+        });
+        (0, perf_1.stopPerfMeasure)(cap);
+        if (shouldSetDefaultBackground)
+            await client.send('Emulation.setDefaultBackgroundColorOverride');
+        const saveMarker = (0, perf_1.startPerfMeasure)('save');
+        const buffer = Buffer.from(result.data, 'base64');
+        if (path)
+            await fs_1.default.promises.writeFile(path, buffer);
+        (0, perf_1.stopPerfMeasure)(saveMarker);
+        return buffer;
+    }
+    catch (err) {
+        if (err.message.includes('Unable to capture screenshot')) {
+            const errMessage = [
+                'Could not take a screenshot because Google Chrome ran out of memory or disk space.',
+                ((_a = process === null || process === void 0 ? void 0 : process.env) === null || _a === void 0 ? void 0 : _a.__RESERVED_IS_INSIDE_REMOTION_LAMBDA)
+                    ? 'Deploy a new Lambda function with more memory or disk space.'
+                    : 'Decrease the concurrency to use less RAM.',
+            ].join(' ');
+            throw new Error(errMessage);
+        }
+        throw err;
+    }
 };
-exports._screenshotTask = _screenshotTask;
+exports.screenshotTask = screenshotTask;

package/dist/seek-to-frame.d.ts

@@ -1,5 +1,6 @@
-import puppeteer from 'puppeteer-core';
+import type { Page } from './browser/BrowserPage';
+export declare const waitForReady: (page: Page) => Promise<unknown>;
 export declare const seekToFrame: ({ frame, page, }: {
     frame: number;
-    page: puppeteer.Page;
+    page: Page;
 }) => Promise<void>;

package/dist/seek-to-frame.js

@@ -1,9 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.seekToFrame = void 0;
+exports.seekToFrame = exports.waitForReady = void 0;
 const puppeteer_evaluate_1 = require("./puppeteer-evaluate");
+const waitForReady = (page) => {
+    return Promise.race([
+        new Promise((_, reject) => {
+            page.on("disposed" /* PageEmittedEvents.Disposed */, () => {
+                reject(new Error('Target closed (page disposed)'));
+            });
+        }),
+        new Promise((_, reject) => {
+            page.browser.on("closed-silent" /* BrowserEmittedEvents.ClosedSilent */, () => {
+                reject(new Error('Target closed'));
+            });
+        }),
+        page
+            .mainFrame()
+            ._mainWorld.waitForFunction(page.browser, 'window.ready === true')
+            .catch((err) => {
+            throw err;
+        }),
+    ]);
+};
+exports.waitForReady = waitForReady;
 const seekToFrame = async ({ frame, page, }) => {
-    await page.waitForFunction('window.ready === true');
+    await (0, exports.waitForReady)(page);
     await (0, puppeteer_evaluate_1.puppeteerEvaluateWithCatch)({
         pageFunction: (f) => {
             window.remotion_setFrame(f);
@@ -12,7 +33,7 @@ const seekToFrame = async ({ frame, page, }) => {
         frame,
         page,
     });
-    await page.waitForFunction('window.ready === true');
+    await (0, exports.waitForReady)(page);
     await page.evaluateHandle('document.fonts.ready');
 };
 exports.seekToFrame = seekToFrame;

package/dist/serve-handler/index.d.ts

@@ -1,4 +1,4 @@
-import { IncomingMessage, ServerResponse } from 'http';
+import type { IncomingMessage, ServerResponse } from 'http';
 export declare const serveHandler: (request: IncomingMessage, response: ServerResponse, config: {
     public: string;
 }) => Promise<void>;

package/dist/serve-handler/index.js

@@ -4,16 +4,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.serveHandler = void 0;
-// Native
 const fs_1 = require("fs");
 const path_1 = __importDefault(require("path"));
 const url_1 = __importDefault(require("url"));
+const mime_types_1 = require("../mime-types");
 // Packages
-const mime_types_1 = __importDefault(require("mime-types"));
 const is_path_inside_1 = require("./is-path-inside");
 const range_parser_1 = require("./range-parser");
 const getHeaders = (absolutePath, stats) => {
-    const related = {};
     const { base } = path_1.default.parse(absolutePath);
     let defaultHeaders = {};
     if (stats) {
@@ -22,18 +20,12 @@ const getHeaders = (absolutePath, stats) => {
             'Accept-Ranges': 'bytes',
         };
         defaultHeaders['Last-Modified'] = stats.mtime.toUTCString();
-        const contentType = mime_types_1.default.contentType(base);
-        if (contentType) {
-            defaultHeaders['Content-Type'] = contentType;
+        const _contentType = (0, mime_types_1.mimeContentType)(base);
+        if (_contentType) {
+            defaultHeaders['Content-Type'] = _contentType;
         }
     }
-    const headers = Object.assign(defaultHeaders, related);
-    for (const key in headers) {
-        if (headers[key] === null) {
-            delete headers[key];
-        }
-    }
-    return headers;
+    return defaultHeaders;
 };
 const getPossiblePaths = (relativePath, extension) => [
     path_1.default.join(relativePath, `index${extension}`),
@@ -154,9 +146,9 @@ const serveHandler = async (request, response, config) => {
         const directory = null;
         const singleFile = null;
         if (directory) {
-            const contentType = 'text/html; charset=utf-8';
+            const _contentType = 'text/html; charset=utf-8';
             response.statusCode = 200;
-            response.setHeader('Content-Type', contentType);
+            response.setHeader('Content-Type', _contentType);
             response.end('Is a directory');
             return;
         }

package/dist/serve-static.d.ts

@@ -1,12 +1,14 @@
-import { FfmpegExecutable } from 'remotion';
-import { RenderMediaOnDownload } from './assets/download-and-map-assets-to-file';
+import type { RenderMediaOnDownload } from './assets/download-and-map-assets-to-file';
+import type { DownloadMap } from './assets/download-map';
+import type { FfmpegExecutable } from './ffmpeg-executable';
 export declare const serveStatic: (path: string | null, options: {
     port: number | null;
     ffmpegExecutable: FfmpegExecutable;
     ffprobeExecutable: FfmpegExecutable;
-    downloadDir: string;
     onDownload: RenderMediaOnDownload;
     onError: (err: Error) => void;
+    downloadMap: DownloadMap;
+    remotionRoot: string;
 }) => Promise<{
     port: number;
     close: () => Promise<void>;

package/dist/serve-static.js

@@ -5,21 +5,22 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.serveStatic = void 0;
 const http_1 = __importDefault(require("http"));
-const remotion_1 = require("remotion");
 const get_port_1 = require("./get-port");
 const offthread_video_server_1 = require("./offthread-video-server");
 const serve_handler_1 = require("./serve-handler");
 const serveStatic = async (path, options) => {
-    var _a, _b;
-    const port = await (0, get_port_1.getDesiredPort)((_b = (_a = options === null || options === void 0 ? void 0 : options.port) !== null && _a !== void 0 ? _a : remotion_1.Internals.getServerPort()) !== null && _b !== void 0 ? _b : undefined, 3000, 3100);
+    var _a;
+    const { port, didUsePort } = await (0, get_port_1.getDesiredPort)((_a = options === null || options === void 0 ? void 0 : options.port) !== null && _a !== void 0 ? _a : undefined, 3000, 3100);
     const offthreadRequest = (0, offthread_video_server_1.startOffthreadVideoServer)({
         ffmpegExecutable: options.ffmpegExecutable,
         ffprobeExecutable: options.ffprobeExecutable,
-        downloadDir: options.downloadDir,
         onDownload: options.onDownload,
         onError: options.onError,
+        downloadMap: options.downloadMap,
+        remotionRoot: options.remotionRoot,
     });
     try {
+        const connections = {};
         const server = http_1.default
             .createServer((request, response) => {
             var _a;
@@ -39,8 +40,23 @@ const serveStatic = async (path, options) => {
             });
         })
             .listen(port);
+        server.on('connection', (conn) => {
+            const key = conn.remoteAddress + ':' + conn.remotePort;
+            connections[key] = conn;
+            conn.on('close', () => {
+                delete connections[key];
+            });
+        });
+        server.on('listening', () => {
+            didUsePort();
+        });
+        const destroyConnections = function () {
+            for (const key in connections)
+                connections[key].destroy();
+        };
         const close = () => {
             return new Promise((resolve, reject) => {
+                destroyConnections();
                 server.close((err) => {
                     if (err) {
                         if (err.code === 'ERR_SERVER_NOT_RUNNING') {

package/dist/set-props-and-env.d.ts

@@ -1,5 +1,5 @@
-import { Page } from 'puppeteer-core';
-export declare const setPropsAndEnv: ({ inputProps, envVariables, page, serveUrl, initialFrame, timeoutInMilliseconds, proxyPort, retriesRemaining, }: {
+import type { Page } from './browser/BrowserPage';
+export declare const setPropsAndEnv: ({ inputProps, envVariables, page, serveUrl, initialFrame, timeoutInMilliseconds, proxyPort, retriesRemaining, audioEnabled, videoEnabled, }: {
     inputProps: unknown;
     envVariables: Record<string, string> | undefined;
     page: Page;
@@ -8,4 +8,6 @@ export declare const setPropsAndEnv: ({ inputProps, envVariables, page, serveUrl
     timeoutInMilliseconds: number | undefined;
     proxyPort: number;
     retriesRemaining: number;
+    audioEnabled: boolean;
+    videoEnabled: boolean;
 }) => Promise<void>;

package/dist/set-props-and-env.js

@@ -1,36 +1,47 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.setPropsAndEnv = void 0;
-const remotion_1 = require("remotion");
+const version_1 = require("remotion/version");
+const TimeoutSettings_1 = require("./browser/TimeoutSettings");
 const normalize_serve_url_1 = require("./normalize-serve-url");
 const puppeteer_evaluate_1 = require("./puppeteer-evaluate");
+const redirect_status_codes_1 = require("./redirect-status-codes");
 const validate_puppeteer_timeout_1 = require("./validate-puppeteer-timeout");
-const setPropsAndEnv = async ({ inputProps, envVariables, page, serveUrl, initialFrame, timeoutInMilliseconds, proxyPort, retriesRemaining, }) => {
+const setPropsAndEnv = async ({ inputProps, envVariables, page, serveUrl, initialFrame, timeoutInMilliseconds, proxyPort, retriesRemaining, audioEnabled, videoEnabled, }) => {
     (0, validate_puppeteer_timeout_1.validatePuppeteerTimeout)(timeoutInMilliseconds);
-    const actualTimeout = timeoutInMilliseconds !== null && timeoutInMilliseconds !== void 0 ? timeoutInMilliseconds : remotion_1.Internals.DEFAULT_PUPPETEER_TIMEOUT;
+    const actualTimeout = timeoutInMilliseconds !== null && timeoutInMilliseconds !== void 0 ? timeoutInMilliseconds : TimeoutSettings_1.DEFAULT_TIMEOUT;
     page.setDefaultTimeout(actualTimeout);
     page.setDefaultNavigationTimeout(actualTimeout);
     const urlToVisit = (0, normalize_serve_url_1.normalizeServeUrl)(serveUrl);
     await page.evaluateOnNewDocument((timeout) => {
         window.remotion_puppeteerTimeout = timeout;
-    }, [actualTimeout]);
+    }, actualTimeout);
     if (inputProps) {
         await page.evaluateOnNewDocument((input) => {
             window.remotion_inputProps = input;
-        }, [JSON.stringify(inputProps)]);
+        }, JSON.stringify(inputProps));
     }
     if (envVariables) {
         await page.evaluateOnNewDocument((input) => {
             window.remotion_envVariables = input;
-        }, [JSON.stringify(envVariables)]);
+        }, JSON.stringify(envVariables));
     }
     await page.evaluateOnNewDocument((key) => {
         window.remotion_initialFrame = key;
-    }, [initialFrame]);
+    }, initialFrame);
     await page.evaluateOnNewDocument((port) => {
         window.remotion_proxyPort = port;
-    }, [proxyPort]);
+    }, proxyPort);
+    await page.evaluateOnNewDocument((enabled) => {
+        window.remotion_audioEnabled = enabled;
+    }, audioEnabled);
+    await page.evaluateOnNewDocument((enabled) => {
+        window.remotion_videoEnabled = enabled;
+    }, videoEnabled);
     const pageRes = await page.goto(urlToVisit);
+    if (pageRes === null) {
+        throw new Error(`Visited "${urlToVisit}" but got no response.`);
+    }
     const status = pageRes.status();
     // S3 in rare occasions returns a 500 or 503 error code for GET operations.
     // Usually it is fixed by retrying.
@@ -49,13 +60,11 @@ const setPropsAndEnv = async ({ inputProps, envVariables, page, serveUrl, initia
             retriesRemaining: retriesRemaining - 1,
             serveUrl,
             timeoutInMilliseconds,
+            audioEnabled,
+            videoEnabled,
         });
     }
-    if (status !== 200 &&
-        status !== 301 &&
-        status !== 302 &&
-        status !== 303 &&
-        status !== 304) {
+    if (!redirect_status_codes_1.redirectStatusCodes.every((code) => code !== status)) {
         throw new Error(`Error while getting compositions: Tried to go to ${urlToVisit} but the status code was ${status} instead of 200. Does the site you specified exist?`);
     }
     const isRemotionFn = await (0, puppeteer_evaluate_1.puppeteerEvaluateWithCatch)({
@@ -77,8 +86,25 @@ const setPropsAndEnv = async ({ inputProps, envVariables, page, serveUrl, initia
         frame: null,
         page,
     });
-    if (siteVersion !== '3') {
-        throw new Error(`Incompatible site: When visiting ${urlToVisit}, a bundle was found, but one that is not compatible with this version of Remotion. The bundle format changed in version 3.0.11. To resolve this error, please bundle and deploy again.`);
+    const remotionVersion = await (0, puppeteer_evaluate_1.puppeteerEvaluateWithCatch)({
+        pageFunction: () => {
+            return window.remotion_version;
+        },
+        args: [],
+        frame: null,
+        page,
+    });
+    const requiredVersion = '4';
+    if (siteVersion !== requiredVersion) {
+        throw new Error(`Incompatible site: When visiting ${urlToVisit}, a bundle was found, but one that is not compatible with this version of Remotion. Found version: ${siteVersion} - Required version: ${requiredVersion}. To resolve this error, please bundle and deploy again.`);
+    }
+    if (remotionVersion !== version_1.VERSION && process.env.NODE_ENV !== 'test') {
+        if (remotionVersion) {
+            console.warn(`The site was bundled with version ${remotionVersion} of @remotion/bundler, while @remotion/renderer is on version ${version_1.VERSION}. You may not have the newest bugfixes and features. Re-bundle the site to fix this issue.`);
+        }
+        else {
+            console.warn(`The site was bundled with an old version of Remotion, while @remotion/renderer is on version ${version_1.VERSION}. You may not have the newest bugfixes and features. Re-bundle the site to fix this issue.`);
+        }
     }
 };
 exports.setPropsAndEnv = setPropsAndEnv;

package/dist/stitch-frames-to-video.d.ts

@@ -1,14 +1,24 @@
-import { Codec, FfmpegExecutable, ImageFormat, PixelFormat, ProResProfile, RenderAssetInfo } from 'remotion';
-import { RenderMediaOnDownload } from './assets/download-and-map-assets-to-file';
-import { CancelSignal } from './make-cancel-signal';
+/// <reference types="node" />
+import type { RenderMediaOnDownload } from './assets/download-and-map-assets-to-file';
+import type { RenderAssetInfo } from './assets/download-map';
+import type { Codec } from './codec';
+import type { FfmpegExecutable } from './ffmpeg-executable';
+import type { FfmpegOverrideFn } from './ffmpeg-override';
+import type { ImageFormat } from './image-format';
+import type { CancelSignal } from './make-cancel-signal';
+import type { PixelFormat } from './pixel-format';
+import type { ProResProfile } from './prores-profile';
 export declare type StitcherOptions = {
+    audioBitrate?: string | null;
+    videoBitrate?: string | null;
     fps: number;
     width: number;
     height: number;
-    outputLocation: string;
+    outputLocation?: string | null;
     force: boolean;
     assetsInfo: RenderAssetInfo;
     pixelFormat?: PixelFormat;
+    numberOfGifLoops?: number | null;
     codec?: Codec;
     crf?: number | null;
     onProgress?: (progress: number) => void;
@@ -23,11 +33,14 @@ export declare type StitcherOptions = {
         preEncodedFileLocation: string | null;
         imageFormat: ImageFormat;
     };
+    muted?: boolean;
+    enforceAudioTrack?: boolean;
+    ffmpegOverride?: FfmpegOverrideFn;
 };
 declare type ReturnType = {
-    task: Promise<void>;
+    task: Promise<Buffer | null>;
     getLogs: () => string;
 };
-export declare const spawnFfmpeg: (options: StitcherOptions) => Promise<ReturnType>;
-export declare const stitchFramesToVideo: (options: StitcherOptions) => Promise<void>;
+export declare const spawnFfmpeg: (options: StitcherOptions, remotionRoot: string) => Promise<ReturnType>;
+export declare const stitchFramesToVideo: (options: StitcherOptions) => Promise<Buffer | null>;
 export {};