@remotion/cli 4.0.0-alpha4 → 4.0.0-alpha5

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

@@ -0,0 +1,138 @@
+import type { AudioCodec, Codec, makeCancelSignal, PixelFormat, ProResProfile, StillImageFormat, VideoImageFormat } from '@remotion/renderer';
+import type { AggregateRenderProgress } from '../../progress-types';
+import type { RequiredChromiumOptions } from '../../required-chromium-options';
+declare type BaseRenderProgress = {
+    message: string;
+    value: number;
+};
+declare type RenderJobDynamicStatus = {
+    status: 'done';
+    progress: BaseRenderProgress & AggregateRenderProgress;
+} | {
+    status: 'running';
+    progress: BaseRenderProgress & AggregateRenderProgress;
+} | {
+    status: 'idle';
+} | {
+    status: 'failed';
+    error: {
+        message: string;
+        stack: string | undefined;
+    };
+};
+export declare type JobProgressCallback = (options: BaseRenderProgress & AggregateRenderProgress) => void;
+declare type RenderJobDynamicFields = ({
+    type: 'still';
+    imageFormat: StillImageFormat;
+    jpegQuality: number | null;
+    frame: number;
+    scale: number;
+} & RenderJobDynamicStatus) | ({
+    type: 'video';
+    imageFormat: VideoImageFormat;
+    jpegQuality: number | null;
+    scale: number;
+    codec: Codec;
+    audioCodec: AudioCodec;
+    concurrency: number;
+    crf: number | null;
+    startFrame: number;
+    endFrame: number;
+    muted: boolean;
+    enforceAudioTrack: boolean;
+    proResProfile: ProResProfile | null;
+    pixelFormat: PixelFormat;
+    audioBitrate: string | null;
+    videoBitrate: string | null;
+    everyNthFrame: number;
+    numberOfGifLoops: number | null;
+    disallowParallelEncoding: boolean;
+} & RenderJobDynamicStatus);
+export declare type RenderJob = {
+    startedAt: number;
+    compositionId: string;
+    id: string;
+    outName: string;
+    deletedOutputLocation: boolean;
+    verbose: boolean;
+    delayRenderTimeout: number;
+    cancelToken: ReturnType<typeof makeCancelSignal>;
+    chromiumOptions: RequiredChromiumOptions;
+    envVariables: Record<string, string>;
+    inputProps: unknown;
+} & RenderJobDynamicFields;
+export declare type RenderJobWithCleanup = RenderJob & {
+    cleanup: (() => void)[];
+};
+declare type AddRenderRequestDynamicFields = {
+    type: 'still';
+    imageFormat: StillImageFormat;
+    jpegQuality: number | null;
+    frame: number;
+    scale: number;
+    verbose: boolean;
+} | {
+    type: 'video';
+    codec: Codec;
+    audioCodec: AudioCodec;
+    imageFormat: VideoImageFormat;
+    jpegQuality: number | null;
+    scale: number;
+    verbose: boolean;
+    concurrency: number;
+    crf: number | null;
+    startFrame: number;
+    endFrame: number;
+    muted: boolean;
+    enforceAudioTrack: boolean;
+    proResProfile: ProResProfile | null;
+    pixelFormat: PixelFormat;
+    audioBitrate: string | null;
+    videoBitrate: string | null;
+    everyNthFrame: number;
+    numberOfGifLoops: number | null;
+    disallowParallelEncoding: boolean;
+};
+export declare type CancelRenderRequest = {
+    jobId: string;
+};
+export declare type CancelRenderResponse = {};
+export declare type AddRenderRequest = {
+    compositionId: string;
+    outName: string;
+    chromiumOptions: RequiredChromiumOptions;
+    delayRenderTimeout: number;
+    envVariables: Record<string, string>;
+    inputProps: unknown;
+} & AddRenderRequestDynamicFields;
+export declare type RemoveRenderRequest = {
+    jobId: string;
+};
+export declare type OpenInFileExplorerRequest = {
+    directory: string;
+};
+export declare type SubscribeToFileExistenceRequest = {
+    file: string;
+    clientId: string;
+};
+export declare type SubscribeToFileExistenceResponse = {
+    exists: boolean;
+};
+export declare type UnsubscribeFromFileExistenceRequest = {
+    file: string;
+    clientId: string;
+};
+export declare type UpdateDefaultPropsRequest = {
+    compositionId: string;
+    defaultProps: string;
+};
+export declare type CanUpdateDefaultPropsRequest = {
+    compositionId: string;
+};
+export declare type CanUpdateDefaultPropsResponse = {
+    canUpdate: true;
+} | {
+    canUpdate: false;
+    reason: string;
+};
+export {};

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/preview-server/render-queue/make-retry-payload.d.ts

@@ -0,0 +1,3 @@
+import type { RenderModalState } from '../../editor/state/modals';
+import type { RenderJob } from './job';
+export declare const makeRetryPayload: (job: RenderJob) => RenderModalState;

package/dist/preview-server/render-queue/make-retry-payload.js

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeRetryPayload = void 0;
+const get_default_video_contexts_1 = require("./get-default-video-contexts");
+const makeRetryPayload = (job) => {
+    var _a, _b, _c;
+    const defaults = window.remotion_renderDefaults;
+    if (!defaults) {
+        throw new Error('defaults not set');
+    }
+    if (job.type === 'still') {
+        const { initialAudioCodec, initialRenderType, initialVideoCodec } = (0, get_default_video_contexts_1.getDefaultCodecs)({
+            defaultCodec: defaults.codec,
+            isStill: true,
+        });
+        return {
+            type: 'render',
+            compositionId: job.compositionId,
+            initialFrame: job.frame,
+            initialStillImageFormat: job.imageFormat,
+            initialVideoImageFormat: defaults.videoImageFormat,
+            initialJpegQuality: (_a = job.jpegQuality) !== null && _a !== void 0 ? _a : defaults.jpegQuality,
+            initialOutName: job.outName,
+            initialScale: job.scale,
+            initialVerbose: job.verbose,
+            initialVideoCodecForAudioTab: initialAudioCodec,
+            initialRenderType,
+            initialVideoCodecForVideoTab: initialVideoCodec,
+            initialConcurrency: defaults.concurrency,
+            maxConcurrency: defaults.maxConcurrency,
+            minConcurrency: defaults.minConcurrency,
+            initialMuted: defaults.muted,
+            initialEnforceAudioTrack: defaults.enforceAudioTrack,
+            initialProResProfile: defaults.proResProfile,
+            initialPixelFormat: defaults.pixelFormat,
+            initialAudioBitrate: defaults.audioBitrate,
+            initialVideoBitrate: defaults.videoBitrate,
+            initialEveryNthFrame: defaults.everyNthFrame,
+            initialNumberOfGifLoops: defaults.numberOfGifLoops,
+            initialDelayRenderTimeout: job.delayRenderTimeout,
+            initialAudioCodec: defaults.audioCodec,
+            initialEnvVariables: job.envVariables,
+            initialDisableWebSecurity: job.chromiumOptions.disableWebSecurity,
+            initialOpenGlRenderer: job.chromiumOptions.gl,
+            initialHeadless: job.chromiumOptions.headless,
+            initialIgnoreCertificateErrors: job.chromiumOptions.ignoreCertificateErrors,
+            defaultProps: job.inputProps,
+        };
+    }
+    if (job.type === 'video') {
+        const { initialAudioCodec, initialRenderType, initialVideoCodec } = (0, get_default_video_contexts_1.getDefaultCodecs)({
+            defaultCodec: defaults.codec,
+            isStill: false,
+        });
+        return {
+            type: 'render',
+            compositionId: job.compositionId,
+            initialStillImageFormat: defaults.stillImageFormat,
+            initialVideoImageFormat: job.imageFormat,
+            initialJpegQuality: (_b = job.jpegQuality) !== null && _b !== void 0 ? _b : defaults.jpegQuality,
+            initialOutName: job.outName,
+            initialScale: job.scale,
+            initialVerbose: job.verbose,
+            initialFrame: 0,
+            initialConcurrency: job.concurrency,
+            maxConcurrency: defaults.maxConcurrency,
+            minConcurrency: defaults.minConcurrency,
+            initialMuted: job.muted,
+            initialVideoCodecForAudioTab: initialAudioCodec,
+            initialEnforceAudioTrack: job.enforceAudioTrack,
+            initialRenderType,
+            initialVideoCodecForVideoTab: initialVideoCodec,
+            initialProResProfile: (_c = job.proResProfile) !== null && _c !== void 0 ? _c : defaults.proResProfile,
+            initialPixelFormat: job.pixelFormat,
+            initialAudioBitrate: job.audioBitrate,
+            initialVideoBitrate: job.videoBitrate,
+            initialEveryNthFrame: job.everyNthFrame,
+            initialNumberOfGifLoops: job.numberOfGifLoops,
+            initialDelayRenderTimeout: job.delayRenderTimeout,
+            initialAudioCodec: job.audioCodec,
+            initialEnvVariables: job.envVariables,
+            initialDisableWebSecurity: job.chromiumOptions.disableWebSecurity,
+            initialOpenGlRenderer: job.chromiumOptions.gl,
+            initialHeadless: job.chromiumOptions.headless,
+            initialIgnoreCertificateErrors: job.chromiumOptions.ignoreCertificateErrors,
+            defaultProps: job.inputProps,
+        };
+    }
+    throw new Error(`Job ${JSON.stringify(job)} Not implemented`);
+};
+exports.makeRetryPayload = makeRetryPayload;

package/dist/preview-server/render-queue/open-directory-in-finder.d.ts

@@ -0,0 +1 @@
+export declare const openDirectoryInFinder: (dirToOpen: string, allowedDirectory: string) => Promise<void>;

package/dist/preview-server/render-queue/open-directory-in-finder.js

@@ -0,0 +1,43 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.openDirectoryInFinder = void 0;
+const child_process_1 = require("child_process");
+const os_1 = require("os");
+const path_1 = __importDefault(require("path"));
+const truthy_1 = require("../../truthy");
+const openDirectoryInFinder = (dirToOpen, allowedDirectory) => {
+    const resolved = path_1.default.resolve(allowedDirectory, dirToOpen);
+    const relativeToProcessCwd = path_1.default.relative(allowedDirectory, resolved);
+    if (relativeToProcessCwd.startsWith('..')) {
+        throw new Error(`Not allowed to open ${relativeToProcessCwd}`);
+    }
+    const command = (0, os_1.platform)() === 'darwin'
+        ? 'open'
+        : (0, os_1.platform)() === 'linux'
+            ? 'xdg-open'
+            : 'start';
+    const p = (0, child_process_1.spawn)(command, [(0, os_1.platform)() === 'darwin' ? '-R' : null, dirToOpen].filter(truthy_1.truthy));
+    const stderrChunks = [];
+    p.stderr.on('data', (d) => stderrChunks.push(d));
+    return new Promise((resolve, reject) => {
+        p.on('exit', (code) => {
+            if (code === 0) {
+                resolve();
+            }
+            else {
+                const message = Buffer.concat(stderrChunks).toString('utf-8');
+                reject(new Error(message));
+            }
+        });
+        p.on('error', (err) => {
+            p.kill();
+            if (err) {
+                reject(err);
+            }
+        });
+    });
+};
+exports.openDirectoryInFinder = openDirectoryInFinder;

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

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

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

@@ -0,0 +1,46 @@
+"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, 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: job.chromiumOptions,
+        entryPointReason: 'same as preview',
+        envVariables: job.envVariables,
+        height: null,
+        fullEntryPoint,
+        inputProps: job.inputProps,
+        overwrite: true,
+        port,
+        publicDir,
+        puppeteerTimeout,
+        jpegQuality: (_a = job.jpegQuality) !== null && _a !== void 0 ? _a : undefined,
+        remainingArgs: [],
+        scale: job.scale,
+        stillFrame: job.frame,
+        width: null,
+        compositionIdFromUi: job.compositionId,
+        imageFormatFromUi: job.imageFormat,
+        logLevel: job.verbose ? 'verbose' : 'info',
+        onProgress,
+        indentOutput: true,
+        addCleanupCallback,
+        cancelSignal: job.cancelToken.cancelSignal,
+    });
+};
+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: () => void) => void;
+}) => Promise<void>;

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

@@ -0,0 +1,63 @@
+"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, _b;
+    if (job.type !== 'video') {
+        throw new Error('Expected video job');
+    }
+    const { publicDir, browserExecutable, port, browser, ffmpegOverride } = 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.renderVideoFlow)({
+        remotionRoot,
+        browser,
+        browserExecutable,
+        chromiumOptions: job.chromiumOptions,
+        entryPointReason: 'same as preview',
+        envVariables: job.envVariables,
+        height: null,
+        fullEntryPoint,
+        inputProps: job.inputProps,
+        overwrite: true,
+        port,
+        publicDir,
+        puppeteerTimeout: job.delayRenderTimeout,
+        jpegQuality: (_a = job.jpegQuality) !== null && _a !== void 0 ? _a : undefined,
+        remainingArgs: [],
+        scale: job.scale,
+        width: null,
+        compositionIdFromUi: job.compositionId,
+        logLevel: job.verbose ? 'verbose' : 'info',
+        onProgress,
+        indent: true,
+        concurrency: job.concurrency,
+        everyNthFrame: job.everyNthFrame,
+        frameRange: [job.startFrame, job.endFrame],
+        quiet: false,
+        shouldOutputImageSequence: false,
+        addCleanupCallback,
+        outputLocationFromUI: job.outName,
+        uiCodec: job.codec,
+        uiImageFormat: job.imageFormat,
+        cancelSignal: job.cancelToken.cancelSignal,
+        crf: job.crf,
+        ffmpegOverride,
+        audioBitrate: job.audioBitrate,
+        muted: job.muted,
+        enforceAudioTrack: job.enforceAudioTrack,
+        proResProfile: (_b = job.proResProfile) !== null && _b !== void 0 ? _b : undefined,
+        pixelFormat: job.pixelFormat,
+        videoBitrate: job.videoBitrate,
+        numberOfGifLoops: job.numberOfGifLoops,
+        audioCodec: job.audioCodec,
+        disallowParallelEncoding: job.disallowParallelEncoding,
+    });
+};
+exports.processVideoJob = processVideoJob;

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

@@ -0,0 +1,9 @@
+import type { RenderJob, RenderJobWithCleanup } from './job';
+export declare const getRenderQueue: () => RenderJob[];
+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;

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

@@ -0,0 +1,212 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cancelJob = exports.removeJob = exports.addJob = exports.getRenderQueue = void 0;
+const path_1 = __importDefault(require("path"));
+const chalk_1 = require("../../chalk");
+const file_watcher_1 = require("../../file-watcher");
+const handle_common_errors_1 = require("../../handle-common-errors");
+const log_1 = require("../../log");
+const progress_types_1 = require("../../progress-types");
+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;
+    });
+    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)(),
+        });
+    });
+};
+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)}`);
+};
+const addJob = ({ job, entryPoint, remotionRoot, }) => {
+    jobQueue.push(job);
+    processJobIfPossible({ entryPoint, remotionRoot });
+    notifyClientsOfJobUpdate();
+};
+exports.addJob = addJob;
+const removeJob = (jobId) => {
+    jobQueue = jobQueue.filter((job) => {
+        if (job.id === jobId) {
+            job.cleanup.forEach((c) => {
+                c();
+            });
+            return false;
+        }
+        return true;
+    });
+    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;
+// TODO: Currently, concurrency = 1 is not enforced
+const processJobIfPossible = async ({ remotionRoot, entryPoint, }) => {
+    const runningJob = jobQueue.find((q) => {
+        return q.status === 'running';
+    });
+    if (runningJob) {
+        return;
+    }
+    const nextJob = jobQueue.find((q) => {
+        return q.status === 'idle';
+    });
+    if (!nextJob) {
+        return;
+    }
+    const jobCleanups = [];
+    try {
+        updateJob(nextJob.id, (job) => {
+            return {
+                ...job,
+                status: 'running',
+                progress: {
+                    value: 0,
+                    message: 'Starting job...',
+                    ...(0, progress_types_1.initialAggregateRenderProgress)(),
+                },
+            };
+        });
+        const startTime = Date.now();
+        log_1.Log.info(chalk_1.chalk.gray('╭─ Starting render '));
+        let lastProgress = null;
+        await processJob({
+            job: nextJob,
+            entryPoint,
+            remotionRoot,
+            onProgress: (progress) => {
+                updateJob(nextJob.id, (job) => {
+                    lastProgress = progress;
+                    // Ignore late callbacks of progress updates after cancelling
+                    if (job.status === 'failed' || job.status === 'done') {
+                        return job;
+                    }
+                    if (job.type === 'still') {
+                        return {
+                            ...job,
+                            status: 'running',
+                            progress,
+                        };
+                    }
+                    if (job.type === 'video') {
+                        return {
+                            ...job,
+                            status: 'running',
+                            progress,
+                        };
+                    }
+                    throw new Error('Unknown job type');
+                });
+            },
+            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) => {
+            if (!lastProgress) {
+                throw new Error('expected progress');
+            }
+            return {
+                ...job,
+                status: 'done',
+                cleanup: [...job.cleanup, unwatch],
+                progress: { message: 'Done', value: 1, ...lastProgress },
+            };
+        });
+    }
+    catch (err) {
+        log_1.Log.error(chalk_1.chalk.gray('╰─ '), chalk_1.chalk.red('Failed to render'));
+        updateJob(nextJob.id, (job) => {
+            return {
+                ...job,
+                status: 'failed',
+                error: {
+                    message: err.message,
+                    stack: err.stack,
+                },
+            };
+        });
+        await (0, handle_common_errors_1.handleCommonError)(err);
+        (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()));
+    }
+    processJobIfPossible({ remotionRoot, entryPoint });
+};

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>;