@remotion/renderer 4.0.0-reorg.8 → 4.0.0-retry.8

package/dist/render-still.js

@@ -30,12 +30,13 @@ exports.renderStill = void 0;
 const fs_1 = __importStar(require("fs"));
 const path_1 = __importDefault(require("path"));
 const remotion_1 = require("remotion");
+const download_map_1 = require("./assets/download-map");
 const browser_1 = require("./browser");
+const convert_to_positive_frame_index_1 = require("./convert-to-positive-frame-index");
 const ensure_output_directory_1 = require("./ensure-output-directory");
 const handle_javascript_exception_1 = require("./error-handling/handle-javascript-exception");
 const image_format_1 = require("./image-format");
 const legacy_webpack_config_1 = require("./legacy-webpack-config");
-const make_assets_download_dir_1 = require("./make-assets-download-dir");
 const open_browser_1 = require("./open-browser");
 const prepare_server_1 = require("./prepare-server");
 const provide_screenshot_1 = require("./provide-screenshot");
@@ -53,6 +54,10 @@ const innerRenderStill = async ({ composition, quality, imageFormat = 'png', ser
     remotion_1.Internals.validateDurationInFrames(composition.durationInFrames, 'in the `config` object passed to `renderStill()`');
     (0, image_format_1.validateNonNullImageFormat)(imageFormat);
     (0, validate_frame_1.validateFrame)(frame, composition.durationInFrames);
+    const stillFrame = (0, convert_to_positive_frame_index_1.convertToPositiveFrameIndex)({
+        durationInFrames: composition.durationInFrames,
+        frame,
+    });
     (0, validate_puppeteer_timeout_1.validatePuppeteerTimeout)(timeoutInMilliseconds);
     (0, validate_scale_1.validateScale)(scale);
     if (typeof output !== 'string') {
@@ -113,29 +118,44 @@ const innerRenderStill = async ({ composition, quality, imageFormat = 'png', ser
         envVariables,
         page,
         serveUrl,
-        initialFrame: frame,
+        initialFrame: stillFrame,
         timeoutInMilliseconds,
         proxyPort,
         retriesRemaining: 2,
+        audioEnabled: false,
+        videoEnabled: true,
     });
     await (0, puppeteer_evaluate_1.puppeteerEvaluateWithCatch)({
-        pageFunction: (id) => {
+        // eslint-disable-next-line max-params
+        pageFunction: (id, defaultProps, durationInFrames, fps, height, width) => {
             window.setBundleMode({
                 type: 'composition',
                 compositionName: id,
+                compositionDefaultProps: defaultProps,
+                compositionDurationInFrames: durationInFrames,
+                compositionFps: fps,
+                compositionHeight: height,
+                compositionWidth: width,
             });
         },
-        args: [composition.id],
+        args: [
+            composition.id,
+            composition.defaultProps,
+            composition.durationInFrames,
+            composition.fps,
+            composition.height,
+            composition.width,
+        ],
         frame: null,
         page,
     });
-    await (0, seek_to_frame_1.seekToFrame)({ frame, page });
+    await (0, seek_to_frame_1.seekToFrame)({ frame: stillFrame, page });
     await (0, provide_screenshot_1.provideScreenshot)({
         page,
         imageFormat,
         quality,
         options: {
-            frame,
+            frame: stillFrame,
             output,
         },
     });
@@ -147,22 +167,22 @@ const innerRenderStill = async ({ composition, quality, imageFormat = 'png', ser
  * @link https://www.remotion.dev/docs/renderer/render-still
  */
 const renderStill = (options) => {
-    var _a;
+    var _a, _b;
     const selectedServeUrl = (0, legacy_webpack_config_1.getServeUrlWithFallback)(options);
-    const downloadDir = (0, make_assets_download_dir_1.makeAssetsDownloadTmpDir)();
-    const onDownload = (_a = options.onDownload) !== null && _a !== void 0 ? _a : (() => () => undefined);
+    const downloadMap = (_a = options.downloadMap) !== null && _a !== void 0 ? _a : (0, download_map_1.makeDownloadMap)();
+    const onDownload = (_b = options.onDownload) !== null && _b !== void 0 ? _b : (() => () => undefined);
     const happyPath = new Promise((resolve, reject) => {
         var _a, _b, _c;
         const onError = (err) => reject(err);
         let close = null;
         (0, prepare_server_1.prepareServer)({
             webpackConfigOrServeUrl: selectedServeUrl,
-            downloadDir,
             onDownload,
             onError,
             ffmpegExecutable: (_a = options.ffmpegExecutable) !== null && _a !== void 0 ? _a : null,
             ffprobeExecutable: (_b = options.ffprobeExecutable) !== null && _b !== void 0 ? _b : null,
             port: (_c = options.port) !== null && _c !== void 0 ? _c : null,
+            downloadMap,
         })
             .then(({ serveUrl, closeServer, offthreadPort }) => {
             close = closeServer;
@@ -175,7 +195,13 @@ const renderStill = (options) => {
         })
             .then((res) => resolve(res))
             .catch((err) => reject(err))
-            .finally(() => close === null || close === void 0 ? void 0 : close());
+            .finally(() => {
+            // Clean download map if it was not passed in
+            if (!(options === null || options === void 0 ? void 0 : options.downloadMap)) {
+                (0, download_map_1.cleanDownloadMap)(downloadMap);
+            }
+            return close === null || close === void 0 ? void 0 : close();
+        });
     });
     return Promise.race([
         happyPath,

package/dist/screenshot-task.js

@@ -7,6 +7,7 @@ exports._screenshotTask = void 0;
 const fs_1 = __importDefault(require("fs"));
 const perf_1 = require("./perf");
 const _screenshotTask = async (page, format, options) => {
+    var _a;
     const client = page._client();
     const target = page.target();
     const perfTarget = (0, perf_1.startPerfMeasure)('activate-target');
@@ -20,20 +21,34 @@ const _screenshotTask = async (page, format, options) => {
             color: { r: 0, g: 0, b: 0, a: 0 },
         });
     const cap = (0, perf_1.startPerfMeasure)('capture');
-    const result = await client.send('Page.captureScreenshot', {
-        format,
-        quality: options.quality,
-        clip: undefined,
-        captureBeyondViewport: 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 (options.path)
-        await fs_1.default.promises.writeFile(options.path, buffer);
-    (0, perf_1.stopPerfMeasure)(saveMarker);
-    return buffer;
+    try {
+        const result = await client.send('Page.captureScreenshot', {
+            format,
+            quality: options.quality,
+            clip: undefined,
+            captureBeyondViewport: 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 (options.path)
+            await fs_1.default.promises.writeFile(options.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;

package/dist/serve-static.d.ts

@@ -1,12 +1,13 @@
 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;
 }) => Promise<{
     port: number;
     close: () => Promise<void>;

package/dist/serve-static.js

@@ -14,11 +14,12 @@ const serveStatic = async (path, options) => {
     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,
     });
     try {
+        const connections = {};
         const server = http_1.default
             .createServer((request, response) => {
             var _a;
@@ -38,8 +39,20 @@ 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];
+            });
+        });
+        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 type { Page } from './browser/BrowserPage';
-export declare const setPropsAndEnv: ({ inputProps, envVariables, page, serveUrl, initialFrame, timeoutInMilliseconds, proxyPort, retriesRemaining, }: {
+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,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.setPropsAndEnv = void 0;
+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 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 : TimeoutSettings_1.DEFAULT_TIMEOUT;
     page.setDefaultTimeout(actualTimeout);
@@ -13,23 +14,29 @@ const setPropsAndEnv = async ({ inputProps, envVariables, page, serveUrl, initia
     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.`);
@@ -52,6 +59,8 @@ const setPropsAndEnv = async ({ inputProps, envVariables, page, serveUrl, initia
             retriesRemaining: retriesRemaining - 1,
             serveUrl,
             timeoutInMilliseconds,
+            audioEnabled,
+            videoEnabled,
         });
     }
     if (status !== 200 &&
@@ -82,8 +91,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,13 +1,16 @@
 /// <reference types="node" />
-import type { RenderAssetInfo } from 'remotion';
 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;
@@ -30,11 +33,8 @@ export declare type StitcherOptions = {
         preEncodedFileLocation: string | null;
         imageFormat: ImageFormat;
     };
+    muted?: boolean;
+    enforceAudioTrack?: boolean;
+    ffmpegOverride?: FfmpegOverrideFn;
 };
-declare type ReturnType = {
-    task: Promise<Buffer | null>;
-    getLogs: () => string;
-};
-export declare const spawnFfmpeg: (options: StitcherOptions) => Promise<ReturnType>;
 export declare const stitchFramesToVideo: (options: StitcherOptions) => Promise<Buffer | null>;
-export {};