@remotion/renderer 4.0.424 → 4.0.426

package/dist/options/port.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.portOption = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const cliFlag = 'port';
+let currentPort = null;
+exports.portOption = {
+    name: 'Port',
+    cliFlag,
+    description: () => (jsx_runtime_1.jsx(jsx_runtime_1.Fragment, { children: "Set a custom HTTP server port for the Studio or the render process. If not defined, Remotion will try to find a free port." })),
+    ssrName: null,
+    docLink: 'https://www.remotion.dev/docs/config#setstudioport',
+    getValue: ({ commandLine }) => {
+        if (commandLine[cliFlag] !== undefined) {
+            return {
+                source: 'cli',
+                value: commandLine[cliFlag],
+            };
+        }
+        if (currentPort !== null) {
+            return {
+                source: 'config',
+                value: currentPort,
+            };
+        }
+        return {
+            source: 'default',
+            value: null,
+        };
+    },
+    setConfig: (value) => {
+        currentPort = value;
+    },
+    type: 0,
+    id: cliFlag,
+};

package/dist/options/private-license-key.d.ts

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

package/dist/options/private-license-key.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.privateLicenseKeyOption = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const cliFlag = 'private-license-key';
+let currentPrivateLicenseKey = null;
+exports.privateLicenseKeyOption = {
+    name: 'Private License Key',
+    cliFlag,
+    description: () => ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: ["The private license key for your company license, obtained from the \"Usage\" tab on ", (0, jsx_runtime_1.jsx)("a", { href: "https://remotion.pro/dashboard", children: "remotion.pro" }), ". If you are eligible for the free license, pass \"free-license\"."] })),
+    ssrName: 'privateLicenseKey',
+    docLink: 'https://www.remotion.dev/docs/licensing',
+    getValue: ({ commandLine }) => {
+        if (commandLine[cliFlag] !== undefined) {
+            return {
+                source: 'cli',
+                value: commandLine[cliFlag],
+            };
+        }
+        if (currentPrivateLicenseKey !== null) {
+            return {
+                source: 'config',
+                value: currentPrivateLicenseKey,
+            };
+        }
+        return {
+            source: 'default',
+            value: null,
+        };
+    },
+    setConfig: (value) => {
+        currentPrivateLicenseKey = value;
+    },
+    type: null,
+};

package/dist/options/props.d.ts

@@ -0,0 +1,19 @@
+export declare const propsOption: {
+    name: string;
+    cliFlag: "props";
+    description: () => import("react/jsx-runtime").JSX.Element;
+    ssrName: null;
+    docLink: string;
+    getValue: ({ commandLine }: {
+        commandLine: Record<string, unknown>;
+    }) => {
+        source: string;
+        value: string;
+    } | {
+        source: string;
+        value: null;
+    };
+    setConfig: () => never;
+    type: string | null;
+    id: "props";
+};

package/dist/options/props.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.propsOption = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const cliFlag = 'props';
+exports.propsOption = {
+    name: 'Input Props',
+    cliFlag,
+    description: () => (jsx_runtime_1.jsxs(jsx_runtime_1.Fragment, { children: ["Input Props to pass to the selected composition of your video. Must be a serialized JSON string (",
+            jsx_runtime_1.jsxs("code", { children: ["--props='", '{', "\"hello\": \"world\"", '}', "'"] }),
+            ") or a path to a JSON file (",
+            jsx_runtime_1.jsx("code", { children: "./path/to/props.json" }),
+            ")."] })),
+    ssrName: null,
+    docLink: 'https://www.remotion.dev/docs/passing-props#passing-input-props-in-the-cli',
+    getValue: ({ commandLine }) => {
+        if (commandLine[cliFlag] !== undefined) {
+            return {
+                source: 'cli',
+                value: commandLine[cliFlag],
+            };
+        }
+        return {
+            source: 'default',
+            value: null,
+        };
+    },
+    setConfig: () => {
+        throw new Error('setProps is not supported. Pass --props via the CLI instead.');
+    },
+    type: '',
+    id: cliFlag,
+};

package/dist/options/prores-profile.d.ts

@@ -0,0 +1,20 @@
+export type ProResProfile = '4444-xq' | '4444' | 'hq' | 'standard' | 'light' | 'proxy';
+export declare const proResProfileOption: {
+    name: string;
+    cliFlag: "prores-profile";
+    description: () => import("react/jsx-runtime").JSX.Element;
+    ssrName: "proResProfile";
+    docLink: string;
+    type: ProResProfile | undefined;
+    getValue: ({ commandLine }: {
+        commandLine: Record<string, unknown>;
+    }) => {
+        source: string;
+        value: ProResProfile;
+    } | {
+        source: string;
+        value: undefined;
+    };
+    setConfig: (value: ProResProfile | undefined) => void;
+    id: "prores-profile";
+};

package/dist/options/prores-profile.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.proResProfileOption = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const validProResProfiles = [
+    '4444-xq',
+    '4444',
+    'hq',
+    'standard',
+    'light',
+    'proxy',
+];
+let proResProfile;
+const cliFlag = 'prores-profile';
+exports.proResProfileOption = {
+    name: 'ProRes profile',
+    cliFlag,
+    description: () => (jsx_runtime_1.jsxs(jsx_runtime_1.Fragment, { children: ["Set the ProRes profile. This option is only valid if the codec has been set to ",
+            jsx_runtime_1.jsx("code", { children: "prores" }),
+            ". Possible values:", ' ', validProResProfiles.map((p) => `"${p}"`).join(', '), ". Default:", ' ', jsx_runtime_1.jsx("code", { children: "\"hq\"" }),
+            ". See", ' ', jsx_runtime_1.jsx("a", { href: "https://video.stackexchange.com/a/14715", children: "here" }),
+            " for an explanation of possible values."] })),
+    ssrName: 'proResProfile',
+    docLink: 'https://www.remotion.dev/docs/config#setproresprofile',
+    type: undefined,
+    getValue: ({ commandLine }) => {
+        if (commandLine[cliFlag] !== undefined) {
+            return {
+                source: 'cli',
+                value: String(commandLine[cliFlag]),
+            };
+        }
+        if (proResProfile !== undefined) {
+            return {
+                source: 'config',
+                value: proResProfile,
+            };
+        }
+        return {
+            source: 'default',
+            value: undefined,
+        };
+    },
+    setConfig: (value) => {
+        proResProfile = value;
+    },
+    id: cliFlag,
+};

package/dist/options/rspack.d.ts

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

package/dist/options/rspack.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rspackOption = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+let rspackEnabled = false;
+const cliFlag = 'experimental-rspack';
+exports.rspackOption = {
+    name: 'Experimental Rspack',
+    cliFlag,
+    description: () => (jsx_runtime_1.jsx(jsx_runtime_1.Fragment, { children: "Uses Rspack instead of Webpack as the bundler for the Studio or bundle." })),
+    ssrName: null,
+    docLink: null,
+    type: false,
+    getValue: ({ commandLine }) => {
+        if (commandLine[cliFlag] !== undefined) {
+            rspackEnabled = true;
+            return {
+                value: commandLine[cliFlag],
+                source: 'cli',
+            };
+        }
+        return {
+            value: rspackEnabled,
+            source: 'config',
+        };
+    },
+    setConfig(value) {
+        rspackEnabled = value;
+    },
+    id: cliFlag,
+};

package/dist/options/runs.d.ts

@@ -0,0 +1,16 @@
+export declare const runsOption: {
+    name: string;
+    cliFlag: "runs";
+    description: () => import("react/jsx-runtime").JSX.Element;
+    ssrName: null;
+    docLink: string;
+    type: number;
+    getValue: ({ commandLine }: {
+        commandLine: Record<string, unknown>;
+    }) => {
+        value: number;
+        source: string;
+    };
+    setConfig: (value: number) => void;
+    id: "runs";
+};

package/dist/options/runs.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runsOption = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const DEFAULT_RUNS = 3;
+let currentRuns = DEFAULT_RUNS;
+const cliFlag = 'runs';
+exports.runsOption = {
+    name: 'Benchmark runs',
+    cliFlag,
+    description: () => (jsx_runtime_1.jsxs(jsx_runtime_1.Fragment, { children: ["Specify how many times the video should be rendered during a benchmark. Default ",
+            jsx_runtime_1.jsx("code", { children: DEFAULT_RUNS }),
+            "."] })),
+    ssrName: null,
+    docLink: 'https://www.remotion.dev/docs/cli/benchmark#--runs',
+    type: DEFAULT_RUNS,
+    getValue: ({ commandLine }) => {
+        if (commandLine[cliFlag] !== undefined) {
+            const value = Number(commandLine[cliFlag]);
+            if (isNaN(value) || value < 1) {
+                throw new Error(`--runs must be a positive number, but got ${commandLine[cliFlag]}`);
+            }
+            return { value, source: 'cli' };
+        }
+        if (currentRuns !== DEFAULT_RUNS) {
+            return { value: currentRuns, source: 'config' };
+        }
+        return { value: DEFAULT_RUNS, source: 'default' };
+    },
+    setConfig: (value) => {
+        if (typeof value !== 'number' || isNaN(value) || value < 1) {
+            throw new Error(`Runs must be a positive number, but got ${value}`);
+        }
+        currentRuns = value;
+    },
+    id: cliFlag,
+};

package/dist/options/still-frame.d.ts

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

package/dist/options/still-frame.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stillFrameOption = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const no_react_1 = require("remotion/no-react");
+const cliFlag = 'frame';
+let currentFrame = null;
+const validate = (frame) => {
+    no_react_1.NoReactInternals.validateFrame({
+        frame,
+        durationInFrames: Infinity,
+        allowFloats: false,
+    });
+};
+exports.stillFrameOption = {
+    name: 'Frame',
+    cliFlag,
+    description: () => (jsx_runtime_1.jsxs(jsx_runtime_1.Fragment, { children: ["Which frame should be rendered when rendering a still. Default", ' ', jsx_runtime_1.jsx("code", { children: "0" }),
+            ". From v3.2.27, negative values are allowed, with", ' ', jsx_runtime_1.jsx("code", { children: "-1" }),
+            " being the last frame."] })),
+    ssrName: 'frame',
+    docLink: 'https://www.remotion.dev/docs/cli/still#--frame',
+    getValue: ({ commandLine }) => {
+        if (commandLine[cliFlag] !== undefined) {
+            const frame = Number(commandLine[cliFlag]);
+            validate(frame);
+            return {
+                source: 'cli',
+                value: frame,
+            };
+        }
+        if (currentFrame !== null) {
+            return {
+                source: 'config',
+                value: currentFrame,
+            };
+        }
+        return {
+            source: 'default',
+            value: null,
+        };
+    },
+    setConfig: (value) => {
+        if (value !== null) {
+            validate(value);
+        }
+        currentFrame = value;
+    },
+    type: 0,
+    id: cliFlag,
+};

package/dist/options/user-agent.d.ts

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

package/dist/options/user-agent.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.userAgentOption = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+let userAgent = null;
+const cliFlag = 'user-agent';
+exports.userAgentOption = {
+    name: 'User agent',
+    cliFlag,
+    description: () => (jsx_runtime_1.jsx(jsx_runtime_1.Fragment, { children: "Lets you set a custom user agent that the headless Chrome browser assumes." })),
+    ssrName: 'userAgent',
+    docLink: 'https://www.remotion.dev/docs/chromium-flags#--user-agent',
+    type: null,
+    getValue: ({ commandLine }) => {
+        if (commandLine[cliFlag] !== undefined) {
+            return {
+                source: 'cli',
+                value: commandLine[cliFlag],
+            };
+        }
+        if (userAgent !== null) {
+            return {
+                source: 'config',
+                value: userAgent,
+            };
+        }
+        return {
+            source: 'default',
+            value: null,
+        };
+    },
+    setConfig: (value) => {
+        userAgent = value;
+    },
+    id: cliFlag,
+};

package/dist/options/version-flag.d.ts

@@ -0,0 +1,19 @@
+export declare const versionFlagOption: {
+    name: string;
+    cliFlag: "version";
+    description: () => import("react/jsx-runtime").JSX.Element;
+    ssrName: null;
+    docLink: string;
+    getValue: ({ commandLine }: {
+        commandLine: Record<string, unknown>;
+    }) => {
+        source: string;
+        value: string;
+    } | {
+        source: string;
+        value: null;
+    };
+    setConfig: () => never;
+    type: string | null;
+    id: "version";
+};

package/dist/options/version-flag.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.versionFlagOption = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const cliFlag = 'version';
+exports.versionFlagOption = {
+    name: 'Version',
+    cliFlag,
+    description: () => (jsx_runtime_1.jsx(jsx_runtime_1.Fragment, { children: "Install a specific version. Also enables downgrading to an older version." })),
+    ssrName: null,
+    docLink: 'https://www.remotion.dev/docs/cli/upgrade#--version',
+    getValue: ({ commandLine }) => {
+        if (commandLine[cliFlag] !== undefined) {
+            return {
+                source: 'cli',
+                value: String(commandLine[cliFlag]),
+            };
+        }
+        return {
+            source: 'default',
+            value: null,
+        };
+    },
+    setConfig: () => {
+        throw new Error('Cannot set version via config file');
+    },
+    type: '',
+    id: cliFlag,
+};

package/dist/options/webpack-poll.d.ts

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

package/dist/options/webpack-poll.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.webpackPollOption = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const cliFlag = 'webpack-poll';
+let webpackPolling = null;
+exports.webpackPollOption = {
+    name: 'Webpack Polling',
+    cliFlag,
+    description: () => (jsx_runtime_1.jsx(jsx_runtime_1.Fragment, { children: "Enables Webpack polling instead of the file system event listeners for hot reloading. This is useful if you are inside a virtual machine or have a remote file system. Pass a value in milliseconds." })),
+    ssrName: null,
+    docLink: 'https://www.remotion.dev/docs/config#setwebpackpollinginmilliseconds',
+    getValue: ({ commandLine }) => {
+        if (commandLine[cliFlag] !== undefined) {
+            const val = commandLine[cliFlag];
+            if (typeof val !== 'number') {
+                throw new TypeError(`Webpack polling must be a number, got ${JSON.stringify(val)}`);
+            }
+            return {
+                source: 'cli',
+                value: val,
+            };
+        }
+        if (webpackPolling !== null) {
+            return {
+                source: 'config',
+                value: webpackPolling,
+            };
+        }
+        return {
+            source: 'default',
+            value: null,
+        };
+    },
+    setConfig: (value) => {
+        if (typeof value !== 'number' && value !== null) {
+            throw new TypeError(`Polling must be a number or null, got ${JSON.stringify(value)} instead.`);
+        }
+        webpackPolling = value;
+    },
+    type: 0,
+    id: cliFlag,
+};

package/dist/prespawn-ffmpeg.d.ts

@@ -16,6 +16,7 @@ type RunningStatus = {
 } | {
     type: 'quit-with-error';
     exitCode: number;
+    signal: NodeJS.Signals | null;
     stderr: string;
 };
 type PreStitcherOptions = {

package/dist/prespawn-ffmpeg.js

@@ -93,11 +93,12 @@ const prespawnFfmpeg = (options) => {
     let exitCode = {
         type: 'running',
     };
-    task.on('exit', (code) => {
-        if (typeof code === 'number' && code > 0) {
+    task.on('exit', (code, signal) => {
+        if ((typeof code === 'number' && code > 0) || signal) {
             exitCode = {
                 type: 'quit-with-error',
-                exitCode: code,
+                exitCode: code !== null && code !== void 0 ? code : 1,
+                signal: signal !== null && signal !== void 0 ? signal : null,
                 stderr: ffmpegOutput,
             };
         }

package/dist/render-frames.d.ts

@@ -55,7 +55,10 @@ export type FrameAndAssets = {
     artifactAssets: ArtifactWithoutContent[];
     inlineAudioAssets: InlineAudioAsset[];
 };
-export type RenderFramesOptions = {
+type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+export type RenderFramesOptions = Prettify<{
     onStart: (data: OnStartData) => void;
     onFrameUpdate: (framesRendered: number, frameIndex: number, timeToRenderInMilliseconds: number) => void;
     outputDir: string | null;
@@ -91,7 +94,44 @@ export type RenderFramesOptions = {
     concurrency?: number | string | null;
     onArtifact?: OnArtifact | null;
     serveUrl: string;
-} & Partial<ToOptions<typeof optionsMap.renderFrames>>;
+} & Partial<ToOptions<typeof optionsMap.renderFrames>>>;
 export declare const internalRenderFrames: (args_0: InternalRenderFramesOptions) => Promise<RenderFramesOutput>;
-export declare const renderFrames: (options: RenderFramesOptions) => Promise<RenderFramesOutput>;
+export declare const renderFrames: (options: {
+    readonly mediaCacheSizeInBytes?: number | null | undefined;
+    readonly forSeamlessAacConcatenation?: boolean | undefined;
+    readonly offthreadVideoCacheSizeInBytes?: number | null | undefined;
+    readonly offthreadVideoThreads?: number | null | undefined;
+    readonly jpegQuality?: number | undefined;
+    readonly logLevel?: "error" | "info" | "trace" | "verbose" | "warn" | undefined;
+    readonly binariesDirectory?: string | null | undefined;
+    readonly onBrowserDownload?: import(".").OnBrowserDownload | undefined;
+    readonly chromeMode?: "chrome-for-testing" | "headless-shell" | undefined;
+    readonly imageSequencePattern?: string | null | undefined;
+    onStart: (data: OnStartData) => void;
+    onFrameUpdate: (framesRendered: number, frameIndex: number, timeToRenderInMilliseconds: number) => void;
+    outputDir: string | null;
+    inputProps: Record<string, unknown>;
+    envVariables?: Record<string, string> | undefined;
+    imageFormat?: "jpeg" | "none" | "png" | undefined;
+    quality?: undefined;
+    frameRange?: FrameRange | null | undefined;
+    everyNthFrame?: number | undefined;
+    dumpBrowserLogs?: boolean | undefined;
+    verbose?: boolean | undefined;
+    puppeteerInstance?: HeadlessBrowser | undefined;
+    browserExecutable?: BrowserExecutable | undefined;
+    onBrowserLog?: ((log: BrowserLog) => void) | undefined;
+    onFrameBuffer?: ((buffer: Buffer, frame: number) => void) | undefined;
+    onDownload?: RenderMediaOnDownload | undefined;
+    timeoutInMilliseconds?: number | undefined;
+    chromiumOptions?: ChromiumOptions | undefined;
+    scale?: number | undefined;
+    port?: number | null | undefined;
+    cancelSignal?: CancelSignal | undefined;
+    composition: VideoConfig;
+    muted?: boolean | undefined;
+    concurrency?: string | number | null | undefined;
+    onArtifact?: OnArtifact | null | undefined;
+    serveUrl: string;
+}) => Promise<RenderFramesOutput>;
 export {};