@remotion/cli 4.0.0-lambda.3 → 4.0.0-newpaths.13

package/dist/render-flows/render.js

@@ -0,0 +1,256 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderCompFlow = 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 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 get_render_media_options_1 = require("../get-render-media-options");
+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 renderCompFlow = async ({ 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, }) => {
+    var _a;
+    const downloads = [];
+    const downloadMap = renderer_1.RenderInternals.makeDownloadMap();
+    addCleanupCallback(() => renderer_1.RenderInternals.cleanDownloadMap(downloadMap));
+    const ffmpegVersion = await renderer_1.RenderInternals.getFfmpegVersion({
+        ffmpegExecutable,
+        remotionRoot,
+    });
+    log_1.Log.verboseAdvanced({ indent, logLevel }, 'FFMPEG Version:', ffmpegVersion ? ffmpegVersion.join('.') : 'Built from source');
+    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,
+    });
+    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;
+    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,
+    });
+    (0, get_cli_options_1.validateFfmpegCanUseCodec)(codec, remotionRoot);
+    renderer_1.RenderInternals.validateEvenDimensionsWithCodec({
+        width: config.width,
+        height: config.height,
+        codec,
+        scale,
+    });
+    const relativeOutputLocation = (0, get_filename_1.getOutputFilename)({
+        codec,
+        imageSequence: shouldOutputImageSequence,
+        compositionName: compositionId,
+        defaultExtension: renderer_1.RenderInternals.getFileExtensionFromCodec(codec, 'final'),
+        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 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: renderer_1.RenderInternals.getActualConcurrency(concurrency),
+                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.getImageFormat)({
+        codec: shouldOutputImageSequence ? undefined : codec,
+        configFileImageFormat,
+        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)({
+            config,
+            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,
+            puppeteerInstance,
+            quality,
+            timeoutInMilliseconds: puppeteerTimeout,
+            chromiumOptions,
+            scale,
+            ffmpegExecutable,
+            ffprobeExecutable,
+            browserExecutable,
+            port,
+            downloadMap,
+        });
+        updateRenderProgress();
+        log_1.Log.infoAdvanced({ indent, logLevel }, chalk_1.chalk.cyan(`▶ ${absoluteOutputFile}`));
+    }
+    const options = await (0, get_render_media_options_1.getRenderMediaOptions)({
+        config,
+        outputLocation: absoluteOutputFile,
+        serveUrl: urlOrBundle,
+        codec,
+        remotionRoot,
+    });
+    await (0, renderer_1.renderMedia)({
+        ...options,
+        onProgress: (update) => {
+            encodedDoneIn = update.encodedDoneIn;
+            encodedFrames = update.encodedFrames;
+            renderedDoneIn = update.renderedDoneIn;
+            stitchStage = update.stitchStage;
+            renderedFrames = update.renderedFrames;
+            updateRenderProgress();
+        },
+        puppeteerInstance,
+        onDownload,
+        downloadMap,
+        cancelSignal: cancelSignal !== null && cancelSignal !== void 0 ? cancelSignal : undefined,
+        onSlowestFrames: (slowestFrames) => {
+            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)`);
+            });
+        },
+        printLog: (...str) => log_1.Log.verboseAdvanced({ indent, logLevel }, ...str),
+    });
+    log_1.Log.infoAdvanced({ indent, logLevel });
+    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.renderCompFlow = renderCompFlow;

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

@@ -0,0 +1,32 @@
+import type { Browser, BrowserExecutable, CancelSignal, ChromiumOptions, FfmpegExecutable, ImageFormat, 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, ffmpegExecutable, ffprobeExecutable, height, inputProps, overwrite, port, publicDir, puppeteerTimeout, quality, scale, stillFrame, width, compositionIdFromUi, imageFormatFromUi, logLevel, configFileImageFormat, 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;
+    ffmpegExecutable: FfmpegExecutable;
+    ffprobeExecutable: FfmpegExecutable;
+    overwrite: boolean;
+    puppeteerTimeout: number;
+    port: number | null;
+    publicDir: string | null;
+    height: number | null;
+    width: number | null;
+    compositionIdFromUi: string | null;
+    imageFormatFromUi: StillImageFormat | null;
+    logLevel: LogLevel;
+    configFileImageFormat: ImageFormat | undefined;
+    onProgress: JobProgressCallback;
+    indentOutput: boolean;
+    addCleanupCallback: (cb: () => Promise<void>) => void;
+    cancelSignal: CancelSignal | null;
+}) => Promise<void>;

package/dist/render-flows/still.js

@@ -0,0 +1,170 @@
+"use strict";
+// Prints to CLI and also reports back to browser
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderStillFlow = void 0;
+const renderer_1 = require("@remotion/renderer");
+const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
+const chalk_1 = require("../chalk");
+const determine_image_format_1 = require("../determine-image-format");
+const get_cli_options_1 = require("../get-cli-options");
+const get_composition_with_dimension_override_1 = require("../get-composition-with-dimension-override");
+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 renderStillFlow = async ({ remotionRoot, fullEntryPoint, entryPointReason, remainingArgs, browser, browserExecutable, chromiumOptions, envVariables, ffmpegExecutable, ffprobeExecutable, height, inputProps, overwrite, port, publicDir, puppeteerTimeout, quality, scale, stillFrame, width, compositionIdFromUi, imageFormatFromUi, logLevel, configFileImageFormat, onProgress, indentOutput, addCleanupCallback, cancelSignal, }) => {
+    var _a;
+    const downloads = [];
+    const aggregate = {
+        rendering: null,
+        downloads,
+        stitching: null,
+        bundling: {
+            message: null,
+            progress: 0,
+        },
+    };
+    let renderProgress = null;
+    const updateProgress = () => {
+        const { output, progress, message } = (0, progress_bar_1.makeRenderingAndStitchingProgress)(aggregate, indentOutput);
+        if (renderProgress) {
+            renderProgress.update(output);
+        }
+        onProgress({ progress, message });
+    };
+    log_1.Log.verboseAdvanced({ indent: indentOutput, logLevel }, 'Browser executable: ', browserExecutable);
+    const shouldDumpIo = renderer_1.RenderInternals.isEqualOrBelowLogLevel(logLevel, 'verbose');
+    const browserInstance = (0, renderer_1.openBrowser)(browser, {
+        browserExecutable,
+        chromiumOptions,
+        shouldDumpIo,
+        forceDeviceScaleFactor: scale,
+        indentationString: indentOutput ? log_1.INDENT_TOKEN + ' ' : '',
+    });
+    const steps = [
+        renderer_1.RenderInternals.isServeUrl(fullEntryPoint) ? null : 'bundling',
+        'rendering',
+    ].filter(truthy_1.truthy);
+    const { cleanup: cleanupBundle, urlOrBundle } = await (0, setup_cache_1.bundleOnCliOrTakeServeUrl)({
+        fullPath: fullEntryPoint,
+        remotionRoot,
+        steps,
+        publicDir,
+        onProgress: (progress) => {
+            aggregate.bundling = progress;
+            updateProgress();
+        },
+        indentOutput,
+        logLevel,
+    });
+    addCleanupCallback(cleanupBundle);
+    const puppeteerInstance = await browserInstance;
+    addCleanupCallback(() => puppeteerInstance.close(false));
+    const downloadMap = renderer_1.RenderInternals.makeDownloadMap();
+    addCleanupCallback(() => renderer_1.RenderInternals.cleanDownloadMap(downloadMap));
+    const comps = await (0, renderer_1.getCompositions)(urlOrBundle, {
+        inputProps,
+        puppeteerInstance,
+        envVariables,
+        timeoutInMilliseconds: puppeteerTimeout,
+        chromiumOptions,
+        port,
+        browserExecutable,
+        ffmpegExecutable,
+        ffprobeExecutable,
+        downloadMap,
+    });
+    const { compositionId, config, reason, argsAfterComposition } = await (0, get_composition_with_dimension_override_1.getCompositionWithDimensionOverride)({
+        validCompositions: comps,
+        height,
+        width,
+        args: remainingArgs,
+        compositionIdFromUi,
+    });
+    const { format: imageFormat, source } = (0, determine_image_format_1.determineFinalImageFormat)({
+        cliFlag: (_a = parse_command_line_1.parsedCli['image-format']) !== null && _a !== void 0 ? _a : null,
+        configImageFormat: configFileImageFormat !== null && configFileImageFormat !== void 0 ? configFileImageFormat : null,
+        downloadName: null,
+        outName: (0, user_passed_output_location_1.getUserPassedOutputLocation)(argsAfterComposition),
+        isLambda: false,
+        fromUi: imageFormatFromUi,
+    });
+    const relativeOutputLocation = (0, user_passed_output_location_1.getOutputLocation)({
+        compositionId,
+        defaultExtension: imageFormat,
+        args: argsAfterComposition,
+        type: 'asset',
+    });
+    const absoluteOutputLocation = (0, get_cli_options_1.getAndValidateAbsoluteOutputFile)(relativeOutputLocation, overwrite);
+    (0, fs_1.mkdirSync)(path_1.default.join(absoluteOutputLocation, '..'), {
+        recursive: true,
+    });
+    log_1.Log.infoAdvanced({ indent: indentOutput, logLevel }, chalk_1.chalk.gray(`Entry point = ${fullEntryPoint} (${entryPointReason}), Output = ${relativeOutputLocation}, Format = ${imageFormat} (${source}), Composition = ${compositionId} (${reason})`));
+    renderProgress = (0, progress_bar_1.createOverwriteableCliOutput)({
+        quiet: (0, parse_command_line_1.quietFlagProvided)(),
+        cancelSignal,
+    });
+    const renderStart = Date.now();
+    aggregate.rendering = {
+        frames: 0,
+        concurrency: 1,
+        doneIn: null,
+        steps,
+        totalFrames: 1,
+    };
+    updateProgress();
+    const onDownload = (src) => {
+        const id = Math.random();
+        const download = {
+            id,
+            name: src,
+            progress: 0,
+            downloaded: 0,
+            totalBytes: null,
+        };
+        downloads.push(download);
+        updateProgress();
+        return ({ percent }) => {
+            download.progress = percent;
+            updateProgress();
+        };
+    };
+    await (0, renderer_1.renderStill)({
+        composition: config,
+        frame: stillFrame,
+        output: absoluteOutputLocation,
+        serveUrl: urlOrBundle,
+        quality,
+        dumpBrowserLogs: shouldDumpIo,
+        envVariables,
+        imageFormat,
+        inputProps,
+        chromiumOptions,
+        timeoutInMilliseconds: puppeteerTimeout,
+        scale,
+        ffmpegExecutable,
+        browserExecutable,
+        overwrite,
+        onDownload,
+        port,
+        downloadMap,
+        puppeteerInstance,
+    });
+    aggregate.rendering = {
+        frames: 1,
+        concurrency: 1,
+        doneIn: Date.now() - renderStart,
+        steps,
+        totalFrames: 1,
+    };
+    updateProgress();
+    log_1.Log.infoAdvanced({ indent: indentOutput, logLevel });
+    log_1.Log.infoAdvanced({ indent: indentOutput, logLevel }, chalk_1.chalk.cyan(`▶️ ${absoluteOutputLocation}`));
+};
+exports.renderStillFlow = renderStillFlow;

package/dist/render.d.ts

@@ -1 +1 @@
-export declare const render: () => Promise<void>;
+export declare const render: (remotionRoot: string, args: string[]) => Promise<void>;