@remotion/cli 3.3.76 → 3.3.78

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

@@ -0,0 +1,69 @@
+"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,
+                audioCodec: input.audioCodec,
+                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)(),
+                concurrency: input.concurrency,
+                crf: input.crf,
+                endFrame: input.endFrame,
+                startFrame: input.startFrame,
+                muted: input.muted,
+                enforceAudioTrack: input.enforceAudioTrack,
+                proResProfile: input.proResProfile,
+                pixelFormat: input.pixelFormat,
+                audioBitrate: input.audioBitrate,
+                videoBitrate: input.videoBitrate,
+                everyNthFrame: input.everyNthFrame,
+                numberOfGifLoops: input.numberOfGifLoops,
+                delayRenderTimeout: input.delayRenderTimeout,
+                disallowParallelEncoding: input.disallowParallelEncoding,
+            },
+        });
+    }
+    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,47 @@
+import type { AudioCodec, Browser, BrowserExecutable, CancelSignal, ChromiumOptions, Codec, Crf, FfmpegOverrideFn, FrameRange, LogLevel, PixelFormat, ProResProfile, VideoImageFormat } from '@remotion/renderer';
+import type { Loop } from '../config/number-of-gif-loops';
+import type { JobProgressCallback } from '../preview-server/render-queue/job';
+export declare const renderVideoFlow: ({ remotionRoot, fullEntryPoint, indent, logLevel, browserExecutable, browser, chromiumOptions, scale, shouldOutputImageSequence, publicDir, inputProps, envVariables, puppeteerTimeout, port, height, width, remainingArgs, compositionIdFromUi, entryPointReason, overwrite, quiet, concurrency, frameRange, everyNthFrame, outputLocationFromUI, quality, onProgress, addCleanupCallback, cancelSignal, crf, uiCodec, uiImageFormat, ffmpegOverride, audioBitrate, muted, enforceAudioTrack, proResProfile, pixelFormat, videoBitrate, numberOfGifLoops, audioCodec, disallowParallelEncoding, }: {
+    remotionRoot: string;
+    fullEntryPoint: string;
+    entryPointReason: string;
+    browserExecutable: BrowserExecutable;
+    chromiumOptions: ChromiumOptions;
+    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;
+    quality: number | undefined;
+    onProgress: JobProgressCallback;
+    addCleanupCallback: (cb: () => void) => void;
+    crf: Crf | null;
+    cancelSignal: CancelSignal | null;
+    uiCodec: Codec | null;
+    uiImageFormat: VideoImageFormat | null;
+    ffmpegOverride: FfmpegOverrideFn;
+    audioBitrate: string | null;
+    videoBitrate: string | null;
+    muted: boolean;
+    enforceAudioTrack: boolean;
+    proResProfile: ProResProfile | undefined;
+    pixelFormat: PixelFormat;
+    numberOfGifLoops: Loop;
+    audioCodec: AudioCodec | null;
+    disallowParallelEncoding: boolean;
+}) => Promise<void>;

package/dist/render-flows/render.js

@@ -0,0 +1,280 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderVideoFlow = void 0;
+const renderer_1 = require("@remotion/renderer");
+const fs_1 = __importDefault(require("fs"));
+const os_1 = __importDefault(require("os"));
+const path_1 = __importDefault(require("path"));
+const chalk_1 = require("../chalk");
+const cleanup_before_quit_1 = require("../cleanup-before-quit");
+const config_1 = require("../config");
+const get_cli_options_1 = require("../get-cli-options");
+const get_composition_with_dimension_override_1 = require("../get-composition-with-dimension-override");
+const get_filename_1 = require("../get-filename");
+const get_final_output_codec_1 = require("../get-final-output-codec");
+const image_formats_1 = require("../image-formats");
+const log_1 = require("../log");
+const parse_command_line_1 = require("../parse-command-line");
+const progress_bar_1 = require("../progress-bar");
+const setup_cache_1 = require("../setup-cache");
+const truthy_1 = require("../truthy");
+const user_passed_output_location_1 = require("../user-passed-output-location");
+const renderVideoFlow = async ({ remotionRoot, fullEntryPoint, indent, logLevel, browserExecutable, browser, chromiumOptions, scale, shouldOutputImageSequence, publicDir, inputProps, envVariables, puppeteerTimeout, port, height, width, remainingArgs, compositionIdFromUi, entryPointReason, overwrite, quiet, concurrency, frameRange, everyNthFrame, outputLocationFromUI, quality, onProgress, addCleanupCallback, cancelSignal, crf, uiCodec, uiImageFormat, ffmpegOverride, audioBitrate, muted, enforceAudioTrack, proResProfile, pixelFormat, videoBitrate, numberOfGifLoops, audioCodec, disallowParallelEncoding, }) => {
+    var _a;
+    const downloads = [];
+    const downloadMap = renderer_1.RenderInternals.makeDownloadMap();
+    addCleanupCallback(() => renderer_1.RenderInternals.cleanDownloadMap(downloadMap));
+    (0, cleanup_before_quit_1.registerCleanupJob)(() => renderer_1.RenderInternals.cleanDownloadMap(downloadMap));
+    log_1.Log.verboseAdvanced({ indent, logLevel }, 'Browser executable: ', browserExecutable);
+    log_1.Log.verboseAdvanced({ indent, logLevel }, 'Asset dirs', downloadMap.assetDir);
+    const browserInstance = (0, renderer_1.openBrowser)(browser, {
+        browserExecutable,
+        shouldDumpIo: renderer_1.RenderInternals.isEqualOrBelowLogLevel(logLevel, 'verbose'),
+        chromiumOptions,
+        forceDeviceScaleFactor: scale,
+        indentationString: indent ? log_1.INDENT_TOKEN + ' ' : '',
+    });
+    const steps = [
+        renderer_1.RenderInternals.isServeUrl(fullEntryPoint) ? null : 'bundling',
+        'rendering',
+        shouldOutputImageSequence ? null : 'stitching',
+    ].filter(truthy_1.truthy);
+    const { urlOrBundle, cleanup: cleanupBundle } = await (0, setup_cache_1.bundleOnCliOrTakeServeUrl)({
+        fullPath: fullEntryPoint,
+        remotionRoot,
+        steps,
+        publicDir,
+        // TODO: Implement onProgress
+        onProgress: () => undefined,
+        indentOutput: indent,
+        logLevel,
+    });
+    (0, cleanup_before_quit_1.registerCleanupJob)(() => cleanupBundle());
+    addCleanupCallback(() => cleanupBundle());
+    const onDownload = (src) => {
+        const id = Math.random();
+        const download = {
+            id,
+            name: src,
+            progress: 0,
+            downloaded: 0,
+            totalBytes: null,
+        };
+        downloads.push(download);
+        updateRenderProgress();
+        return ({ percent, downloaded, totalSize }) => {
+            download.progress = percent;
+            download.totalBytes = totalSize;
+            download.downloaded = downloaded;
+            updateRenderProgress();
+        };
+    };
+    const puppeteerInstance = await browserInstance;
+    (0, cleanup_before_quit_1.registerCleanupJob)(() => puppeteerInstance.close(false));
+    addCleanupCallback(() => puppeteerInstance.close(false));
+    const comps = await (0, renderer_1.getCompositions)(urlOrBundle, {
+        inputProps,
+        puppeteerInstance,
+        envVariables,
+        timeoutInMilliseconds: puppeteerTimeout,
+        chromiumOptions,
+        browserExecutable,
+        downloadMap,
+        port,
+    });
+    const { compositionId, config, reason, argsAfterComposition } = await (0, get_composition_with_dimension_override_1.getCompositionWithDimensionOverride)({
+        validCompositions: comps,
+        height,
+        width,
+        args: remainingArgs,
+        compositionIdFromUi,
+    });
+    const { codec, reason: codecReason } = (0, get_final_output_codec_1.getFinalOutputCodec)({
+        cliFlag: parse_command_line_1.parsedCli.codec,
+        configFile: (_a = config_1.ConfigInternals.getOutputCodecOrUndefined()) !== null && _a !== void 0 ? _a : null,
+        downloadName: null,
+        outName: (0, user_passed_output_location_1.getUserPassedOutputLocation)(argsAfterComposition),
+        uiCodec,
+    });
+    renderer_1.RenderInternals.validateEvenDimensionsWithCodec({
+        width: config.width,
+        height: config.height,
+        codec,
+        scale,
+    });
+    const relativeOutputLocation = (0, get_filename_1.getOutputFilename)({
+        imageSequence: shouldOutputImageSequence,
+        compositionName: compositionId,
+        defaultExtension: renderer_1.RenderInternals.getFileExtensionFromCodec(codec, audioCodec),
+        args: argsAfterComposition,
+        indent,
+        fromUi: outputLocationFromUI,
+        logLevel,
+    });
+    log_1.Log.infoAdvanced({ indent, logLevel }, chalk_1.chalk.gray(`Entry point = ${fullEntryPoint} (${entryPointReason}), Composition = ${compositionId} (${reason}), Codec = ${codec} (${codecReason}), Output = ${relativeOutputLocation}`));
+    const absoluteOutputFile = (0, get_cli_options_1.getAndValidateAbsoluteOutputFile)(relativeOutputLocation, overwrite);
+    const outputDir = shouldOutputImageSequence
+        ? absoluteOutputFile
+        : await fs_1.default.promises.mkdtemp(path_1.default.join(os_1.default.tmpdir(), 'react-motion-render'));
+    log_1.Log.verboseAdvanced({ indent, logLevel }, 'Output dir', outputDir);
+    const renderProgress = (0, progress_bar_1.createOverwriteableCliOutput)({
+        quiet,
+        cancelSignal,
+    });
+    const realFrameRange = renderer_1.RenderInternals.getRealFrameRange(config.durationInFrames, frameRange);
+    const totalFrames = renderer_1.RenderInternals.getFramesToRender(realFrameRange, everyNthFrame);
+    let encodedFrames = 0;
+    let renderedFrames = 0;
+    let encodedDoneIn = null;
+    let renderedDoneIn = null;
+    let stitchStage = 'encoding';
+    const actualConcurrency = renderer_1.RenderInternals.getActualConcurrency(concurrency);
+    const updateRenderProgress = () => {
+        if (totalFrames.length === 0) {
+            throw new Error('totalFrames should not be 0');
+        }
+        const { output, message, progress } = (0, progress_bar_1.makeRenderingAndStitchingProgress)({
+            rendering: {
+                frames: renderedFrames,
+                totalFrames: totalFrames.length,
+                concurrency: actualConcurrency,
+                doneIn: renderedDoneIn,
+                steps,
+            },
+            stitching: shouldOutputImageSequence
+                ? null
+                : {
+                    doneIn: encodedDoneIn,
+                    frames: encodedFrames,
+                    stage: stitchStage,
+                    steps,
+                    totalFrames: totalFrames.length,
+                    codec,
+                },
+            downloads,
+            bundling: {
+                message: 'Bundled',
+                progress: 1,
+            },
+        }, indent);
+        onProgress({ progress, message });
+        return renderProgress.update(output);
+    };
+    const imageFormat = (0, image_formats_1.getVideoImageFormat)({
+        codec: shouldOutputImageSequence ? undefined : codec,
+        uiImageFormat,
+    });
+    if (shouldOutputImageSequence) {
+        fs_1.default.mkdirSync(absoluteOutputFile, {
+            recursive: true,
+        });
+        if (imageFormat === 'none') {
+            throw new Error(`Cannot render an image sequence with a codec that renders no images. codec = ${codec}, imageFormat = ${imageFormat}`);
+        }
+        await (0, renderer_1.renderFrames)({
+            imageFormat,
+            inputProps,
+            onFrameUpdate: (rendered) => {
+                renderedFrames = rendered;
+                updateRenderProgress();
+            },
+            onStart: () => undefined,
+            onDownload: (src) => {
+                if (src.startsWith('data:')) {
+                    log_1.Log.infoAdvanced({ indent, logLevel }, '\nWriting Data URL to file: ', src.substring(0, 30) + '...');
+                }
+                else {
+                    log_1.Log.infoAdvanced({ indent, logLevel }, '\nDownloading asset... ', src);
+                }
+            },
+            cancelSignal: cancelSignal !== null && cancelSignal !== void 0 ? cancelSignal : undefined,
+            outputDir,
+            serveUrl: urlOrBundle,
+            dumpBrowserLogs: renderer_1.RenderInternals.isEqualOrBelowLogLevel(logLevel, 'verbose'),
+            everyNthFrame,
+            envVariables,
+            frameRange,
+            concurrency: actualConcurrency,
+            puppeteerInstance,
+            quality,
+            timeoutInMilliseconds: puppeteerTimeout,
+            chromiumOptions,
+            scale,
+            browserExecutable,
+            port,
+            downloadMap,
+            composition: config,
+        });
+        updateRenderProgress();
+        process.stdout.write('\n');
+        log_1.Log.infoAdvanced({ indent, logLevel }, chalk_1.chalk.cyan(`▶ ${absoluteOutputFile}`));
+    }
+    const { slowestFrames } = await (0, renderer_1.renderMedia)({
+        outputLocation: absoluteOutputFile,
+        composition: {
+            ...config,
+            width: width !== null && width !== void 0 ? width : config.width,
+            height: height !== null && height !== void 0 ? height : config.height,
+        },
+        crf,
+        envVariables,
+        frameRange,
+        inputProps,
+        overwrite,
+        pixelFormat,
+        proResProfile,
+        quality,
+        dumpBrowserLogs: renderer_1.RenderInternals.isEqualOrBelowLogLevel(logLevel, 'verbose'),
+        chromiumOptions,
+        timeoutInMilliseconds: config_1.ConfigInternals.getCurrentPuppeteerTimeout(),
+        scale,
+        port,
+        numberOfGifLoops,
+        everyNthFrame,
+        verbose: renderer_1.RenderInternals.isEqualOrBelowLogLevel(logLevel, 'verbose'),
+        muted,
+        enforceAudioTrack,
+        browserExecutable,
+        ffmpegOverride,
+        concurrency,
+        serveUrl: urlOrBundle,
+        codec,
+        audioBitrate,
+        videoBitrate,
+        onProgress: (update) => {
+            encodedDoneIn = update.encodedDoneIn;
+            encodedFrames = update.encodedFrames;
+            renderedDoneIn = update.renderedDoneIn;
+            stitchStage = update.stitchStage;
+            renderedFrames = update.renderedFrames;
+            updateRenderProgress();
+        },
+        puppeteerInstance,
+        onDownload,
+        internal: {
+            onCtrlCExit: cleanup_before_quit_1.registerCleanupJob,
+            downloadMap,
+        },
+        cancelSignal: cancelSignal !== null && cancelSignal !== void 0 ? cancelSignal : undefined,
+        printLog: (...str) => log_1.Log.verboseAdvanced({ indent, logLevel }, ...str),
+        audioCodec,
+        preferLossless: false,
+        imageFormat,
+        disallowParallelEncoding,
+    });
+    log_1.Log.verboseAdvanced({ indent, logLevel });
+    log_1.Log.verboseAdvanced({ indent, logLevel }, `Slowest frames:`);
+    slowestFrames.forEach(({ frame, time }) => {
+        log_1.Log.verboseAdvanced({ indent, logLevel }, `Frame ${frame} (${time.toFixed(3)}ms)`);
+    });
+    updateRenderProgress();
+    process.stdout.write('\n');
+    log_1.Log.infoAdvanced({ indent, logLevel }, chalk_1.chalk.cyan(`▶ ${absoluteOutputFile}`));
+    for (const line of renderer_1.RenderInternals.perf.getPerf()) {
+        log_1.Log.verboseAdvanced({ indent, logLevel }, line);
+    }
+};
+exports.renderVideoFlow = renderVideoFlow;

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

@@ -0,0 +1,29 @@
+import type { Browser, BrowserExecutable, CancelSignal, ChromiumOptions, LogLevel, StillImageFormat } from '@remotion/renderer';
+import type { JobProgressCallback } from '../preview-server/render-queue/job';
+export declare const renderStillFlow: ({ remotionRoot, fullEntryPoint, entryPointReason, remainingArgs, browser, browserExecutable, chromiumOptions, envVariables, height, inputProps, overwrite, port, publicDir, puppeteerTimeout, quality, scale, stillFrame, width, compositionIdFromUi, imageFormatFromUi, logLevel, onProgress, indentOutput, addCleanupCallback, cancelSignal, }: {
+    remotionRoot: string;
+    fullEntryPoint: string;
+    entryPointReason: string;
+    remainingArgs: string[];
+    inputProps: object;
+    envVariables: Record<string, string>;
+    quality: number | undefined;
+    browser: Browser;
+    stillFrame: number;
+    browserExecutable: BrowserExecutable;
+    chromiumOptions: ChromiumOptions;
+    scale: number;
+    overwrite: boolean;
+    puppeteerTimeout: number;
+    port: number | null;
+    publicDir: string | null;
+    height: number | null;
+    width: number | null;
+    compositionIdFromUi: string | null;
+    imageFormatFromUi: StillImageFormat | null;
+    logLevel: LogLevel;
+    onProgress: JobProgressCallback;
+    indentOutput: boolean;
+    addCleanupCallback: (cb: () => void) => void;
+    cancelSignal: CancelSignal | null;
+}) => Promise<void>;