@remotion/cli 3.3.33 → 3.3.35

package/dist/preview-server/render-queue/process-still.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.processStill = void 0;
+const convert_entry_point_to_serve_url_1 = require("../../convert-entry-point-to-serve-url");
+const get_cli_options_1 = require("../../get-cli-options");
+const still_1 = require("../../render-flows/still");
+const processStill = async ({ job, remotionRoot, entryPoint, onProgress, addCleanupCallback, }) => {
+    var _a;
+    if (job.type !== 'still') {
+        throw new Error('Expected still job');
+    }
+    const { publicDir, browserExecutable, ffmpegExecutable, ffprobeExecutable, chromiumOptions, envVariables, inputProps, port, browser, puppeteerTimeout, } = await (0, get_cli_options_1.getCliOptions)({
+        isLambda: false,
+        type: 'still',
+        remotionRoot,
+    });
+    const fullEntryPoint = (0, convert_entry_point_to_serve_url_1.convertEntryPointToServeUrl)(entryPoint);
+    await (0, still_1.renderStillFlow)({
+        remotionRoot,
+        browser,
+        browserExecutable,
+        chromiumOptions,
+        entryPointReason: 'same as preview',
+        envVariables,
+        ffmpegExecutable,
+        ffprobeExecutable,
+        height: null,
+        fullEntryPoint,
+        inputProps,
+        overwrite: true,
+        port,
+        publicDir,
+        puppeteerTimeout,
+        quality: (_a = job.quality) !== null && _a !== void 0 ? _a : undefined,
+        remainingArgs: [],
+        scale: job.scale,
+        stillFrame: job.frame,
+        width: null,
+        compositionIdFromUi: job.compositionId,
+        imageFormatFromUi: job.imageFormat,
+        configFileImageFormat: undefined,
+        logLevel: job.verbose ? 'verbose' : 'info',
+        onProgress,
+        indentOutput: true,
+        addCleanupCallback,
+        cancelSignal: job.cancelToken.cancelSignal,
+    });
+    // TODO: Accept CLI options
+};
+exports.processStill = processStill;

package/dist/preview-server/render-queue/process-video.d.ts

@@ -0,0 +1,8 @@
+import type { JobProgressCallback, RenderJob } from './job';
+export declare const processVideoJob: ({ job, remotionRoot, entryPoint, onProgress, addCleanupCallback, }: {
+    job: RenderJob;
+    remotionRoot: string;
+    entryPoint: string;
+    onProgress: JobProgressCallback;
+    addCleanupCallback: (cb: () => Promise<void>) => void;
+}) => Promise<void>;

package/dist/preview-server/render-queue/process-video.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.processVideoJob = void 0;
+const convert_entry_point_to_serve_url_1 = require("../../convert-entry-point-to-serve-url");
+const get_cli_options_1 = require("../../get-cli-options");
+const render_1 = require("../../render-flows/render");
+const processVideoJob = async ({ job, remotionRoot, entryPoint, onProgress, addCleanupCallback, }) => {
+    var _a;
+    if (job.type !== 'video') {
+        throw new Error('Expected video job');
+    }
+    const { publicDir, browserExecutable, ffmpegExecutable, ffprobeExecutable, chromiumOptions, envVariables, inputProps, port, browser, puppeteerTimeout, } = await (0, get_cli_options_1.getCliOptions)({
+        isLambda: false,
+        type: 'still',
+        remotionRoot,
+    });
+    const fullEntryPoint = (0, convert_entry_point_to_serve_url_1.convertEntryPointToServeUrl)(entryPoint);
+    await (0, render_1.renderCompFlow)({
+        remotionRoot,
+        browser,
+        browserExecutable,
+        chromiumOptions,
+        entryPointReason: 'same as preview',
+        envVariables,
+        ffmpegExecutable,
+        ffprobeExecutable,
+        height: null,
+        fullEntryPoint,
+        inputProps,
+        overwrite: true,
+        port,
+        publicDir,
+        puppeteerTimeout,
+        quality: (_a = job.quality) !== null && _a !== void 0 ? _a : undefined,
+        remainingArgs: [],
+        scale: job.scale,
+        width: null,
+        compositionIdFromUi: job.compositionId,
+        configFileImageFormat: undefined,
+        logLevel: job.verbose ? 'verbose' : 'info',
+        onProgress,
+        indent: true,
+        // TODO: Make configurable
+        concurrency: null,
+        // TODO: Make configurable
+        everyNthFrame: 1,
+        // TODO: Make configurable
+        frameRange: null,
+        quiet: false,
+        shouldOutputImageSequence: false,
+        addCleanupCallback,
+        outputLocationFromUI: job.outName,
+        uiCodec: job.codec,
+        uiImageFormat: job.imageFormat,
+        cancelSignal: job.cancelToken.cancelSignal,
+    });
+    // TODO: Accept CLI options
+};
+exports.processVideoJob = processVideoJob;

package/dist/preview-server/render-queue/queue.d.ts

@@ -0,0 +1,21 @@
+import type { JobProgressCallback, RenderJob, RenderJobWithCleanup } from './job';
+export declare const getRenderQueue: () => RenderJob[];
+export declare const notifyClientsOfJobUpdate: () => void;
+export declare const processJob: ({ job, remotionRoot, entryPoint, onProgress, addCleanupCallback, }: {
+    job: RenderJob;
+    remotionRoot: string;
+    entryPoint: string;
+    onProgress: JobProgressCallback;
+    addCleanupCallback: (cb: () => Promise<void>) => void;
+}) => Promise<void>;
+export declare const addJob: ({ job, entryPoint, remotionRoot, }: {
+    job: RenderJobWithCleanup;
+    entryPoint: string;
+    remotionRoot: string;
+}) => void;
+export declare const removeJob: (jobId: string) => void;
+export declare const cancelJob: (jobId: string) => void;
+export declare const processJobIfPossible: ({ remotionRoot, entryPoint, }: {
+    remotionRoot: string;
+    entryPoint: string;
+}) => Promise<void>;

package/dist/preview-server/render-queue/queue.js

@@ -0,0 +1,185 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.processJobIfPossible = exports.cancelJob = exports.removeJob = exports.addJob = exports.processJob = exports.notifyClientsOfJobUpdate = exports.getRenderQueue = void 0;
+const path_1 = __importDefault(require("path"));
+const chalk_1 = require("../../chalk");
+const file_watcher_1 = require("../../file-watcher");
+const log_1 = require("../../log");
+const live_events_1 = require("../live-events");
+const process_still_1 = require("./process-still");
+const process_video_1 = require("./process-video");
+let jobQueue = [];
+const updateJob = (id, updater) => {
+    jobQueue = jobQueue.map((j) => {
+        if (id === j.id) {
+            return updater(j);
+        }
+        return j;
+    });
+    (0, exports.notifyClientsOfJobUpdate)();
+};
+const getRenderQueue = () => {
+    return jobQueue.map((j) => {
+        const { cleanup, ...rest } = j;
+        return rest;
+    });
+};
+exports.getRenderQueue = getRenderQueue;
+const notifyClientsOfJobUpdate = () => {
+    (0, live_events_1.waitForLiveEventsListener)().then((listener) => {
+        listener.sendEventToClient({
+            type: 'render-queue-updated',
+            queue: (0, exports.getRenderQueue)(),
+        });
+    });
+};
+exports.notifyClientsOfJobUpdate = notifyClientsOfJobUpdate;
+const processJob = async ({ job, remotionRoot, entryPoint, onProgress, addCleanupCallback, }) => {
+    if (job.type === 'still') {
+        await (0, process_still_1.processStill)({
+            job,
+            remotionRoot,
+            entryPoint,
+            onProgress,
+            addCleanupCallback,
+        });
+        return;
+    }
+    if (job.type === 'video') {
+        await (0, process_video_1.processVideoJob)({
+            job,
+            remotionRoot,
+            entryPoint,
+            onProgress,
+            addCleanupCallback,
+        });
+        return;
+    }
+    throw new Error(`Unknown job ${JSON.stringify(job)}`);
+};
+exports.processJob = processJob;
+const addJob = ({ job, entryPoint, remotionRoot, }) => {
+    jobQueue.push(job);
+    (0, exports.processJobIfPossible)({ entryPoint, remotionRoot });
+    (0, exports.notifyClientsOfJobUpdate)();
+};
+exports.addJob = addJob;
+const removeJob = (jobId) => {
+    jobQueue = jobQueue.filter((job) => {
+        if (job.id === jobId) {
+            job.cleanup.forEach((c) => {
+                c();
+            });
+            return false;
+        }
+        return true;
+    });
+    (0, exports.notifyClientsOfJobUpdate)();
+};
+exports.removeJob = removeJob;
+const cancelJob = (jobId) => {
+    for (const job of jobQueue) {
+        if (job.id === jobId) {
+            if (job.status !== 'running') {
+                throw new Error('Job is not running');
+            }
+            job.cancelToken.cancel();
+            break;
+        }
+    }
+};
+exports.cancelJob = cancelJob;
+const processJobIfPossible = async ({ remotionRoot, entryPoint, }) => {
+    const nextJob = jobQueue.find((q) => {
+        return q.status === 'idle';
+    });
+    if (!nextJob) {
+        return;
+    }
+    const jobCleanups = [];
+    try {
+        updateJob(nextJob.id, (job) => {
+            return {
+                ...job,
+                status: 'running',
+                progress: 0,
+                message: 'Starting job...',
+            };
+        });
+        const startTime = Date.now();
+        log_1.Log.info(chalk_1.chalk.gray('╭─ Starting render '));
+        await (0, exports.processJob)({
+            job: nextJob,
+            entryPoint,
+            remotionRoot,
+            onProgress: ({ message, progress }) => {
+                updateJob(nextJob.id, (job) => {
+                    // Ignore late callbacks of progress updates after cancelling
+                    if (job.status === 'failed' || job.status === 'done') {
+                        return job;
+                    }
+                    return {
+                        ...job,
+                        status: 'running',
+                        progress,
+                        message,
+                    };
+                });
+            },
+            addCleanupCallback: (cleanup) => {
+                jobCleanups.push(cleanup);
+            },
+        });
+        log_1.Log.info(chalk_1.chalk.gray('╰─ Done in ' + (Date.now() - startTime) + 'ms.'));
+        const { unwatch } = (0, file_watcher_1.installFileWatcher)({
+            file: path_1.default.resolve(remotionRoot, nextJob.outName),
+            onChange: (type) => {
+                if (type === 'created') {
+                    updateJob(nextJob.id, (job) => ({
+                        ...job,
+                        deletedOutputLocation: false,
+                    }));
+                }
+                if (type === 'deleted') {
+                    updateJob(nextJob.id, (job) => ({
+                        ...job,
+                        deletedOutputLocation: true,
+                    }));
+                }
+            },
+        });
+        updateJob(nextJob.id, (job) => ({
+            ...job,
+            status: 'done',
+            cleanup: [...job.cleanup, unwatch],
+        }));
+    }
+    catch (err) {
+        // TODO: Tell to look in preview to find the error
+        log_1.Log.error(chalk_1.chalk.gray('╰─ Render failed:'), err);
+        updateJob(nextJob.id, (job) => {
+            return {
+                ...job,
+                status: 'failed',
+                error: {
+                    message: err.message,
+                    stack: err.stack,
+                },
+            };
+        });
+        (0, live_events_1.waitForLiveEventsListener)().then((listener) => {
+            listener.sendEventToClient({
+                type: 'render-job-failed',
+                compositionId: nextJob.compositionId,
+                error: err,
+            });
+        });
+    }
+    finally {
+        await Promise.all(jobCleanups.map((c) => c()));
+    }
+};
+exports.processJobIfPossible = processJobIfPossible;

package/dist/preview-server/routes/add-render.d.ts

@@ -0,0 +1,3 @@
+import type { ApiHandler } from '../api-types';
+import type { AddRenderRequest } from '../render-queue/job';
+export declare const handleAddRender: ApiHandler<AddRenderRequest, undefined>;

package/dist/preview-server/routes/add-render.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleAddRender = void 0;
+const renderer_1 = require("@remotion/renderer");
+const queue_1 = require("../render-queue/queue");
+const handleAddRender = ({ input, entryPoint, remotionRoot, }) => {
+    const id = String(Math.random()).replace('0.', '');
+    if (input.type === 'video') {
+        (0, queue_1.addJob)({
+            entryPoint,
+            remotionRoot,
+            job: {
+                cleanup: [],
+                codec: input.codec,
+                compositionId: input.compositionId,
+                deletedOutputLocation: false,
+                type: 'video',
+                status: 'idle',
+                id,
+                imageFormat: input.imageFormat,
+                outName: input.outName,
+                quality: input.quality,
+                scale: input.scale,
+                startedAt: Date.now(),
+                verbose: input.verbose,
+                cancelToken: (0, renderer_1.makeCancelSignal)(),
+            },
+        });
+    }
+    if (input.type === 'still') {
+        (0, queue_1.addJob)({
+            job: {
+                compositionId: input.compositionId,
+                id: String(Math.random()).replace('0.', ''),
+                startedAt: Date.now(),
+                type: 'still',
+                outName: input.outName,
+                status: 'idle',
+                imageFormat: input.imageFormat,
+                quality: input.quality,
+                frame: input.frame,
+                scale: input.scale,
+                cleanup: [],
+                deletedOutputLocation: false,
+                verbose: input.verbose,
+                cancelToken: (0, renderer_1.makeCancelSignal)(),
+            },
+            entryPoint,
+            remotionRoot,
+        });
+    }
+    return Promise.resolve(undefined);
+};
+exports.handleAddRender = handleAddRender;

package/dist/preview-server/routes/cancel-render.d.ts

@@ -0,0 +1,3 @@
+import type { ApiHandler } from '../api-types';
+import type { CancelRenderRequest, CancelRenderResponse } from '../render-queue/job';
+export declare const handleCancelRender: ApiHandler<CancelRenderRequest, CancelRenderResponse>;

package/dist/preview-server/routes/cancel-render.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleCancelRender = void 0;
+const queue_1 = require("../render-queue/queue");
+const handleCancelRender = ({ input: { jobId } }) => {
+    (0, queue_1.cancelJob)(jobId);
+    return Promise.resolve({});
+};
+exports.handleCancelRender = handleCancelRender;

package/dist/preview-server/routes/open-in-file-explorer.d.ts

@@ -0,0 +1,3 @@
+import type { ApiHandler } from '../api-types';
+import type { OpenInFileExplorerRequest } from '../render-queue/job';
+export declare const handleOpenInFileExplorer: ApiHandler<OpenInFileExplorerRequest, void>;

package/dist/preview-server/routes/open-in-file-explorer.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleOpenInFileExplorer = void 0;
+const path_1 = __importDefault(require("path"));
+const open_directory_in_finder_1 = require("../render-queue/open-directory-in-finder");
+const handleOpenInFileExplorer = ({ input: { directory }, remotionRoot }) => {
+    const actualDirectory = path_1.default.resolve(remotionRoot, directory);
+    // TODO: Disallow opening file that is not in Remotion CWD
+    return (0, open_directory_in_finder_1.openDirectoryInFinder)(actualDirectory);
+};
+exports.handleOpenInFileExplorer = handleOpenInFileExplorer;

package/dist/preview-server/routes/remove-render.d.ts

@@ -0,0 +1,3 @@
+import type { ApiHandler } from '../api-types';
+import type { RemoveRenderRequest } from '../render-queue/job';
+export declare const handleRemoveRender: ApiHandler<RemoveRenderRequest, undefined>;

package/dist/preview-server/routes/remove-render.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleRemoveRender = void 0;
+const queue_1 = require("../render-queue/queue");
+const handleRemoveRender = ({ input: { jobId }, }) => {
+    (0, queue_1.removeJob)(jobId);
+    return Promise.resolve(undefined);
+};
+exports.handleRemoveRender = handleRemoveRender;

package/dist/preview-server/routes/subscribe-to-file-existence.d.ts

@@ -0,0 +1,3 @@
+import type { ApiHandler } from '../api-types';
+import type { SubscribeToFileExistenceRequest, SubscribeToFileExistenceResponse } from '../render-queue/job';
+export declare const subscribeToFileExistence: ApiHandler<SubscribeToFileExistenceRequest, SubscribeToFileExistenceResponse>;

package/dist/preview-server/routes/subscribe-to-file-existence.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.subscribeToFileExistence = void 0;
+const file_existence_watchers_1 = require("../file-existence-watchers");
+const subscribeToFileExistence = ({ input: { file, clientId }, remotionRoot }) => {
+    const { exists } = (0, file_existence_watchers_1.subscribeToFileExistenceWatchers)({
+        file,
+        remotionRoot,
+        clientId,
+    });
+    return Promise.resolve({ exists });
+};
+exports.subscribeToFileExistence = subscribeToFileExistence;

package/dist/preview-server/routes/unsubscribe-from-file-existence.d.ts

@@ -0,0 +1,3 @@
+import type { ApiHandler } from '../api-types';
+import type { UnsubscribeFromFileExistenceRequest } from '../render-queue/job';
+export declare const unsubscribeFromFileExistence: ApiHandler<UnsubscribeFromFileExistenceRequest, undefined>;

package/dist/preview-server/routes/unsubscribe-from-file-existence.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.unsubscribeFromFileExistence = void 0;
+const file_existence_watchers_1 = require("../file-existence-watchers");
+const unsubscribeFromFileExistence = ({ input, remotionRoot }) => {
+    (0, file_existence_watchers_1.unsubscribeFromFileExistenceWatchers)({
+        file: input.file,
+        clientId: input.clientId,
+        remotionRoot,
+    });
+    return Promise.resolve(undefined);
+};
+exports.unsubscribeFromFileExistence = unsubscribeFromFileExistence;

package/dist/render-flows/render.d.ts

@@ -0,0 +1,38 @@
+import type { Browser, BrowserExecutable, CancelSignal, ChromiumOptions, Codec, FfmpegExecutable, FrameRange, ImageFormat, LogLevel } from '@remotion/renderer';
+import type { JobProgressCallback } from '../preview-server/render-queue/job';
+export declare const renderCompFlow: ({ remotionRoot, fullEntryPoint, ffmpegExecutable, ffprobeExecutable, indent, logLevel, browserExecutable, browser, chromiumOptions, scale, shouldOutputImageSequence, publicDir, inputProps, envVariables, puppeteerTimeout, port, height, width, remainingArgs, compositionIdFromUi, entryPointReason, overwrite, quiet, concurrency, frameRange, everyNthFrame, configFileImageFormat, outputLocationFromUI, quality, onProgress, addCleanupCallback, uiCodec, uiImageFormat, cancelSignal, }: {
+    remotionRoot: string;
+    fullEntryPoint: string;
+    entryPointReason: string;
+    browserExecutable: BrowserExecutable;
+    chromiumOptions: ChromiumOptions;
+    ffmpegExecutable: FfmpegExecutable;
+    ffprobeExecutable: FfmpegExecutable;
+    logLevel: LogLevel;
+    browser: Browser;
+    scale: number;
+    indent: boolean;
+    shouldOutputImageSequence: boolean;
+    publicDir: string | null;
+    inputProps: object;
+    envVariables: Record<string, string>;
+    puppeteerTimeout: number;
+    port: number | null;
+    height: number | null;
+    width: number | null;
+    remainingArgs: string[];
+    compositionIdFromUi: string | null;
+    outputLocationFromUI: string | null;
+    overwrite: boolean;
+    quiet: boolean;
+    concurrency: number | string | null;
+    frameRange: FrameRange | null;
+    everyNthFrame: number;
+    configFileImageFormat: ImageFormat | undefined;
+    quality: number | undefined;
+    onProgress: JobProgressCallback;
+    addCleanupCallback: (cb: () => Promise<void>) => void;
+    uiCodec: Codec | null;
+    uiImageFormat: ImageFormat | null;
+    cancelSignal: CancelSignal | null;
+}) => Promise<void>;