@remotion/renderer 4.0.357 → 4.0.358

package/package/dist/options/folder-expiry.d.ts

@@ -0,0 +1,15 @@
+export declare const folderExpiryOption: {
+    name: string;
+    cliFlag: "enable-folder-expiry";
+    description: () => import("react/jsx-runtime").JSX.Element;
+    ssrName: "enableFolderExpiry";
+    docLink: string;
+    type: boolean | null;
+    getValue: ({ commandLine }: {
+        commandLine: Record<string, unknown>;
+    }) => {
+        source: string;
+        value: boolean | null;
+    };
+    setConfig: (value: boolean | null) => void;
+};

package/package/dist/options/folder-expiry.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.folderExpiryOption = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+let enableFolderExpiry = null;
+const cliFlag = 'enable-folder-expiry';
+exports.folderExpiryOption = {
+    name: 'Lambda render expiration',
+    cliFlag,
+    description: () => {
+        return ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: ["When deploying sites, enable or disable S3 Lifecycle policies which allow for renders to auto-delete after a certain time. Default is", ' ', (0, jsx_runtime_1.jsx)("code", { children: "null" }), ", which does not change any lifecycle policies of the S3 bucket. See: ", (0, jsx_runtime_1.jsx)("a", { href: "/docs/lambda/autodelete", children: "Lambda autodelete" }), "."] }));
+    },
+    ssrName: 'enableFolderExpiry',
+    docLink: 'https://www.remotion.dev/docs/lambda/autodelete',
+    type: false,
+    getValue: ({ commandLine }) => {
+        if (commandLine[cliFlag] !== undefined) {
+            return {
+                source: 'cli',
+                value: commandLine[cliFlag],
+            };
+        }
+        if (enableFolderExpiry !== null) {
+            return {
+                source: 'config',
+                value: enableFolderExpiry,
+            };
+        }
+        return {
+            source: 'default',
+            value: null,
+        };
+    },
+    setConfig: (value) => {
+        enableFolderExpiry = value;
+    },
+};

package/package/dist/options/for-seamless-aac-concatenation.d.ts

@@ -0,0 +1,19 @@
+export declare const getForSeamlessAacConcatenation: () => boolean;
+export declare const forSeamlessAacConcatenationOption: {
+    name: string;
+    cliFlag: "for-seamless-aac-concatenation";
+    description: () => import("react/jsx-runtime").JSX.Element;
+    docLink: string;
+    getValue: ({ commandLine }: {
+        commandLine: Record<string, unknown>;
+    }) => {
+        source: string;
+        value: true;
+    } | {
+        source: string;
+        value: false;
+    };
+    setConfig: (value: boolean) => void;
+    ssrName: string;
+    type: boolean;
+};

package/package/dist/options/for-seamless-aac-concatenation.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.forSeamlessAacConcatenationOption = exports.getForSeamlessAacConcatenation = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const DEFAULT = false;
+let forSeamlessAacConcatenation = DEFAULT;
+const getForSeamlessAacConcatenation = () => {
+    return forSeamlessAacConcatenation;
+};
+exports.getForSeamlessAacConcatenation = getForSeamlessAacConcatenation;
+const cliFlag = 'for-seamless-aac-concatenation';
+exports.forSeamlessAacConcatenationOption = {
+    name: 'For seamless AAC concatenation',
+    cliFlag,
+    description: () => ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: ["If enabled, the audio is trimmed to the nearest AAC frame, which is required for seamless concatenation of AAC files. This is a requirement if you later want to combine multiple video snippets seamlessly.", (0, jsx_runtime_1.jsx)("br", {}), (0, jsx_runtime_1.jsx)("br", {}), " This option is used internally. There is currently no documentation yet for to concatenate the audio chunks."] })),
+    docLink: 'https://remotion.dev/docs/renderer',
+    getValue: ({ commandLine }) => {
+        if (commandLine[cliFlag]) {
+            return {
+                source: 'cli',
+                value: true,
+            };
+        }
+        if (forSeamlessAacConcatenation !== DEFAULT) {
+            return {
+                source: 'config',
+                value: forSeamlessAacConcatenation,
+            };
+        }
+        return {
+            source: 'default',
+            value: DEFAULT,
+        };
+    },
+    setConfig: (value) => {
+        forSeamlessAacConcatenation = value;
+    },
+    ssrName: 'forSeamlessAacConcatenation',
+    type: false,
+};

package/package/dist/options/gl.d.ts

@@ -0,0 +1,24 @@
+export declare const validOpenGlRenderers: readonly ["swangle", "angle", "egl", "swiftshader", "vulkan", "angle-egl"];
+export type OpenGlRenderer = (typeof validOpenGlRenderers)[number];
+export declare const DEFAULT_OPENGL_RENDERER: OpenGlRenderer | null;
+export declare const getChromiumOpenGlRenderer: () => "angle" | "swangle" | "egl" | "swiftshader" | "vulkan" | "angle-egl" | null;
+export declare const setChromiumOpenGlRenderer: (renderer: OpenGlRenderer) => void;
+export declare const glOption: {
+    cliFlag: "gl";
+    docLink: string;
+    name: string;
+    type: OpenGlRenderer | null;
+    ssrName: string;
+    description: () => import("react/jsx-runtime").JSX.Element;
+    getValue: ({ commandLine }: {
+        commandLine: Record<string, unknown>;
+    }) => {
+        value: OpenGlRenderer;
+        source: string;
+    } | {
+        value: null;
+        source: string;
+    };
+    setConfig: (value: OpenGlRenderer | null) => void;
+};
+export declare const validateOpenGlRenderer: (option: unknown) => OpenGlRenderer | null;

package/package/dist/options/gl.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateOpenGlRenderer = exports.glOption = exports.setChromiumOpenGlRenderer = exports.getChromiumOpenGlRenderer = exports.DEFAULT_OPENGL_RENDERER = exports.validOpenGlRenderers = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+exports.validOpenGlRenderers = [
+    'swangle',
+    'angle',
+    'egl',
+    'swiftshader',
+    'vulkan',
+    'angle-egl',
+];
+exports.DEFAULT_OPENGL_RENDERER = null;
+let openGlRenderer = exports.DEFAULT_OPENGL_RENDERER;
+const getChromiumOpenGlRenderer = () => openGlRenderer;
+exports.getChromiumOpenGlRenderer = getChromiumOpenGlRenderer;
+const setChromiumOpenGlRenderer = (renderer) => {
+    (0, exports.validateOpenGlRenderer)(renderer);
+    openGlRenderer = renderer;
+};
+exports.setChromiumOpenGlRenderer = setChromiumOpenGlRenderer;
+const AngleChangelog = () => {
+    return ((0, jsx_runtime_1.jsxs)("details", { style: { fontSize: '0.9em', marginBottom: '1em' }, children: [(0, jsx_runtime_1.jsx)("summary", { children: "Changelog" }), (0, jsx_runtime_1.jsxs)("ul", { children: [(0, jsx_runtime_1.jsxs)("li", { children: ["From Remotion v2.6.7 until v3.0.7, the default for Remotion Lambda was", ' ', (0, jsx_runtime_1.jsx)("code", { children: "swiftshader" }), ", but from v3.0.8 the default is", ' ', (0, jsx_runtime_1.jsx)("code", { children: "swangle" }), " (Swiftshader on Angle) since Chrome 101 added support for it."] }), (0, jsx_runtime_1.jsxs)("li", { children: ["From Remotion v2.4.3 until v2.6.6, the default was ", (0, jsx_runtime_1.jsx)("code", { children: "angle" }), ", however it turns out to have a small memory leak that could crash long Remotion renders."] })] })] }));
+};
+const cliFlag = 'gl';
+exports.glOption = {
+    cliFlag,
+    docLink: 'https://www.remotion.dev/docs/chromium-flags#--gl',
+    name: 'OpenGL renderer',
+    type: 'angle',
+    ssrName: 'gl',
+    description: () => {
+        return ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: [(0, jsx_runtime_1.jsx)(AngleChangelog, {}), (0, jsx_runtime_1.jsxs)("p", { children: ["Select the OpenGL renderer backend for Chromium. ", (0, jsx_runtime_1.jsx)("br", {}), "Accepted values:"] }), (0, jsx_runtime_1.jsxs)("ul", { children: [(0, jsx_runtime_1.jsx)("li", { children: (0, jsx_runtime_1.jsx)("code", { children: '"angle"' }) }), (0, jsx_runtime_1.jsx)("li", { children: (0, jsx_runtime_1.jsx)("code", { children: '"egl"' }) }), (0, jsx_runtime_1.jsx)("li", { children: (0, jsx_runtime_1.jsx)("code", { children: '"swiftshader"' }) }), (0, jsx_runtime_1.jsx)("li", { children: (0, jsx_runtime_1.jsx)("code", { children: '"swangle"' }) }), (0, jsx_runtime_1.jsxs)("li", { children: [(0, jsx_runtime_1.jsx)("code", { children: '"vulkan"' }), " (", (0, jsx_runtime_1.jsx)("em", { children: "from Remotion v4.0.41" }), ")"] }), (0, jsx_runtime_1.jsxs)("li", { children: [(0, jsx_runtime_1.jsx)("code", { children: '"angle-egl"' }), " (", (0, jsx_runtime_1.jsx)("em", { children: "from Remotion v4.0.51" }), ")"] })] }), (0, jsx_runtime_1.jsxs)("p", { children: ["The default is ", (0, jsx_runtime_1.jsx)("code", { children: "null" }), ", letting Chrome decide, except on Lambda where the default is ", (0, jsx_runtime_1.jsx)("code", { children: '"swangle"' })] })] }));
+    },
+    getValue: ({ commandLine }) => {
+        if (commandLine[cliFlag]) {
+            (0, exports.validateOpenGlRenderer)(commandLine[cliFlag]);
+            return {
+                value: commandLine[cliFlag],
+                source: 'cli',
+            };
+        }
+        if (openGlRenderer !== exports.DEFAULT_OPENGL_RENDERER) {
+            return {
+                value: openGlRenderer,
+                source: 'config',
+            };
+        }
+        return {
+            value: exports.DEFAULT_OPENGL_RENDERER,
+            source: 'default',
+        };
+    },
+    setConfig: (value) => {
+        (0, exports.validateOpenGlRenderer)(value);
+        openGlRenderer = value;
+    },
+};
+const validateOpenGlRenderer = (option) => {
+    if (option === null) {
+        return null;
+    }
+    if (!exports.validOpenGlRenderers.includes(option)) {
+        throw new TypeError(`${option} is not a valid GL backend. Accepted values: ${exports.validOpenGlRenderers.join(', ')}`);
+    }
+    return option;
+};
+exports.validateOpenGlRenderer = validateOpenGlRenderer;

package/package/dist/options/hardware-acceleration.d.ts

@@ -0,0 +1,18 @@
+export declare const hardwareAccelerationOptions: readonly ["disable", "if-possible", "required"];
+export type HardwareAccelerationOption = (typeof hardwareAccelerationOptions)[number];
+export declare const getHardwareAcceleration: () => "disable" | "if-possible" | "required" | null;
+export declare const hardwareAccelerationOption: {
+    name: string;
+    cliFlag: "hardware-acceleration";
+    description: () => string;
+    ssrName: string;
+    docLink: string;
+    type: HardwareAccelerationOption;
+    getValue: ({ commandLine }: {
+        commandLine: Record<string, unknown>;
+    }) => {
+        source: string;
+        value: "disable" | "if-possible" | "required";
+    };
+    setConfig: (value: HardwareAccelerationOption) => void;
+};

package/package/dist/options/hardware-acceleration.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hardwareAccelerationOption = exports.getHardwareAcceleration = exports.hardwareAccelerationOptions = void 0;
+exports.hardwareAccelerationOptions = [
+    'disable',
+    'if-possible',
+    'required',
+];
+const cliFlag = 'hardware-acceleration';
+let currentValue = null;
+const getHardwareAcceleration = () => {
+    return currentValue;
+};
+exports.getHardwareAcceleration = getHardwareAcceleration;
+exports.hardwareAccelerationOption = {
+    name: 'Hardware Acceleration',
+    cliFlag,
+    description: () => `
+			One of
+			${new Intl.ListFormat('en', { type: 'disjunction' }).format(exports.hardwareAccelerationOptions.map((a) => JSON.stringify(a)))}
+			. Default "disable". Encode using a hardware-accelerated encoder if
+			available. If set to "required" and no hardware-accelerated encoder is
+			available, then the render will fail.
+		`,
+    ssrName: 'hardwareAcceleration',
+    docLink: 'https://www.remotion.dev/docs/encoding',
+    type: 'disable',
+    getValue: ({ commandLine }) => {
+        if (commandLine[cliFlag] !== undefined) {
+            const value = commandLine[cliFlag];
+            if (!exports.hardwareAccelerationOptions.includes(value)) {
+                throw new Error(`Invalid value for --${cliFlag}: ${value}`);
+            }
+            return {
+                source: 'cli',
+                value,
+            };
+        }
+        if (currentValue !== null) {
+            return {
+                source: 'config',
+                value: currentValue,
+            };
+        }
+        return {
+            source: 'default',
+            value: 'disable',
+        };
+    },
+    setConfig: (value) => {
+        if (!exports.hardwareAccelerationOptions.includes(value)) {
+            throw new Error(`Invalid value for --${cliFlag}: ${value}`);
+        }
+        currentValue = value;
+    },
+};

package/package/dist/options/headless.d.ts

@@ -0,0 +1,15 @@
+export declare const headlessOption: {
+    name: string;
+    cliFlag: "disable-headless";
+    description: () => import("react/jsx-runtime").JSX.Element;
+    ssrName: string;
+    docLink: string;
+    type: boolean;
+    getValue: ({ commandLine }: {
+        commandLine: Record<string, unknown>;
+    }) => {
+        source: string;
+        value: boolean;
+    };
+    setConfig: (value: boolean) => void;
+};

package/package/dist/options/headless.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.headlessOption = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const DEFAULT = true;
+let headlessMode = DEFAULT;
+const cliFlag = 'disable-headless';
+exports.headlessOption = {
+    name: 'Disable Headless Mode',
+    cliFlag,
+    description: () => ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: ["Deprecated - will be removed in 5.0.0. With the migration to", ' ', (0, jsx_runtime_1.jsx)("a", { href: "/docs/miscellaneous/chrome-headless-shell", children: "Chrome Headless Shell" }), ", this option is not functional anymore.", (0, jsx_runtime_1.jsx)("br", {}), (0, jsx_runtime_1.jsx)("br", {}), " If disabled, the render will open an actual Chrome window where you can see the render happen. The default is headless mode."] })),
+    ssrName: 'headless',
+    docLink: 'https://www.remotion.dev/docs/chromium-flags#--disable-headless',
+    type: false,
+    getValue: ({ commandLine }) => {
+        if (commandLine[cliFlag] !== undefined) {
+            return {
+                source: 'cli',
+                value: !commandLine[cliFlag],
+            };
+        }
+        if (headlessMode !== DEFAULT) {
+            return {
+                source: 'config',
+                value: headlessMode,
+            };
+        }
+        return {
+            source: 'default',
+            value: headlessMode,
+        };
+    },
+    setConfig: (value) => {
+        headlessMode = value;
+    },
+};

package/package/dist/options/image-sequence-pattern.d.ts

@@ -0,0 +1,15 @@
+export declare const imageSequencePatternOption: {
+    name: string;
+    cliFlag: "image-sequence-pattern";
+    ssrName: string;
+    description: () => import("react/jsx-runtime").JSX.Element;
+    docLink: null;
+    type: string | null;
+    getValue: ({ commandLine }: {
+        commandLine: Record<string, unknown>;
+    }) => {
+        value: string;
+        source: string;
+    };
+    setConfig: (pattern: string | null) => void;
+};

package/package/dist/options/image-sequence-pattern.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.imageSequencePatternOption = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const cliFlag = 'image-sequence-pattern';
+let currentImageSequencePattern = null;
+// Option for --image-sequence-pattern
+exports.imageSequencePatternOption = {
+    name: 'Image Sequence Pattern',
+    cliFlag,
+    ssrName: 'imageSequencePattern',
+    description: () => ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: ["Pattern for naming image sequence files. Supports ", (0, jsx_runtime_1.jsx)("code", { children: "[frame]" }), " for the zero-padded frame number and ", (0, jsx_runtime_1.jsx)("code", { children: "[ext]" }), " for the file extension."] })),
+    docLink: null,
+    type: 'string',
+    getValue: ({ commandLine }) => {
+        if (currentImageSequencePattern !== null) {
+            return {
+                value: currentImageSequencePattern,
+                source: 'config',
+            };
+        }
+        return {
+            value: commandLine[cliFlag],
+            source: 'cli',
+        };
+    },
+    setConfig: (pattern) => {
+        currentImageSequencePattern = pattern;
+    },
+};