@remotion/cli 4.0.0-alpha.4 → 4.0.0-alpha5

package/dist/print-help.js

@@ -11,7 +11,7 @@ const printFlags = (flags) => {
     });
 };
 const printHelp = () => {
-    log_1.Log.info(`@remotion/cli ${packagejson.version} © ${new Date().getFullYear()} Jonny Burger`);
+    log_1.Log.info(`@remotion/cli ${packagejson.version} © ${new Date().getFullYear()} The Remotion developers`);
     log_1.Log.info();
     log_1.Log.info('Available commands:');
     log_1.Log.info('');
@@ -19,18 +19,20 @@ const printHelp = () => {
     log_1.Log.info(chalk_1.chalk.gray('Start the preview server.'));
     printFlags([['--props', 'Pass input props as filename or as JSON']]);
     log_1.Log.info();
-    log_1.Log.info('remotion render <entry-point.ts> <comp-name> <output-file.mp4>');
+    log_1.Log.info('remotion render <entry-point.ts> <comp-id> <output-file.mp4>');
     log_1.Log.info(chalk_1.chalk.gray('Render video, audio or an image sequence.'));
     printFlags([
         ['--props', 'Pass input props as filename or as JSON'],
         ['--concurrency', 'How many frames to render in parallel'],
-        ['--image-format', 'Format to render the frames in, "jpeg" or "png"'],
+        ['--image-format', 'Format to render the video/still in'],
         ['--pixel-format', 'Custom pixel format, see docs for available values'],
         ['--config', 'Custom location for a Remotion config file'],
-        ['--quality', 'Quality for rendered frames, JPEG only, 0-100'],
+        ['--jpeg-quality', 'Quality for rendered frames, JPEG only, 0-100'],
         ['--overwrite', 'Overwrite if file exists, default true'],
         ['--sequence', 'Output as an image sequence'],
         ['--codec', 'Video of audio codec'],
+        ['--audio-bitrate', 'Customize the output audio bitrate'],
+        ['--video-bitrate', 'Customize the output video bitrate'],
         ['--crf', 'FFMPEG CRF value, controls quality, see docs for info'],
         ['--browser-executable', 'Custom path for browser executable'],
         ['--frames', 'Render a portion or a still of a video'],
@@ -40,14 +42,14 @@ const printHelp = () => {
         ['--env-file', 'Specify a location for a dotenv file'],
     ]);
     log_1.Log.info();
-    log_1.Log.info('remotion still <entry-point.ts> <comp-name> <still.png>');
+    log_1.Log.info('remotion still <entry-point.ts> <comp-id> <still.png>');
     log_1.Log.info(chalk_1.chalk.gray('Render a still frame and save it as an image.'));
     printFlags([
         ['--frame', 'Which frame to render (default 0)'],
-        ['--image-format', 'Format to render the frames in, "jpeg" or "png"'],
+        ['--image-format', 'Format to render the video/still in'],
         ['--props', 'Pass input props as filename or as JSON'],
         ['--config', 'Custom location for a Remotion config file'],
-        ['--quality', 'Quality for rendered frames, JPEG only, 0-100'],
+        ['--jpeg-quality', 'Quality for rendered frames, JPEG only, 0-100'],
         ['--overwrite', 'Overwrite if file exists, default true'],
         ['--browser-executable', 'Custom path for browser executable'],
         ['--bundle-cache', 'Cache webpack bundle, boolean, default true'],
@@ -59,11 +61,20 @@ const printHelp = () => {
     log_1.Log.info('remotion compositions <index-file.ts>');
     log_1.Log.info(chalk_1.chalk.gray('Prints the available compositions.'));
     log_1.Log.info();
+    log_1.Log.info('remotion benchmark <index-file.ts> <list-of-compositions>');
+    log_1.Log.info(chalk_1.chalk.gray('Benchmarks rendering a composition. Same options as for render.'));
+    log_1.Log.info();
     log_1.Log.info('remotion ' + versions_1.VERSIONS_COMMAND);
     log_1.Log.info(chalk_1.chalk.gray('Prints and validates versions of all Remotion packages.'));
     log_1.Log.info();
     log_1.Log.info('remotion upgrade');
     log_1.Log.info(chalk_1.chalk.gray('Ensure Remotion is on the newest version.'));
+    printFlags([
+        [
+            '--package-manager',
+            'Force a specific package manager, defaults to use from lockfile',
+        ],
+    ]);
     log_1.Log.info();
     log_1.Log.info('Visit https://www.remotion.dev/docs/cli for browsable CLI documentation.');
 };

package/dist/progress-bar.d.ts

@@ -1,43 +1,35 @@
-import type { Codec, StitchingState } from '@remotion/renderer';
-import type { RenderStep } from './step';
-export declare const createProgressBar: (quiet: boolean) => {
-    update: (str: string) => boolean;
-};
-export declare const createOverwriteableCliOutput: (quiet: boolean) => {
+import type { CancelSignal } from '@remotion/renderer';
+import type { AggregateRenderProgress } from './progress-types';
+export declare type OverwriteableCliOutput = {
     update: (up: string) => boolean;
 };
-export declare const makeBundlingProgress: ({ progress, steps, doneIn, }: {
-    progress: number;
-    steps: RenderStep[];
-    doneIn: number | null;
-}) => string;
-declare type RenderingProgressInput = {
-    frames: number;
-    totalFrames: number;
-    steps: RenderStep[];
-    concurrency: number;
+export declare const createOverwriteableCliOutput: (options: {
+    quiet: boolean;
+    cancelSignal: CancelSignal | null;
+}) => OverwriteableCliOutput;
+export declare type CopyingState = {
+    bytes: number;
     doneIn: number | null;
 };
-export declare const makeRenderingProgress: ({ frames, totalFrames, steps, concurrency, doneIn, }: RenderingProgressInput) => string;
-declare type StitchingProgressInput = {
-    frames: number;
-    totalFrames: number;
-    steps: RenderStep[];
+export declare type BundlingState = {
+    progress: number;
     doneIn: number | null;
-    stage: StitchingState;
-    codec: Codec;
 };
-export declare const makeStitchingProgress: ({ frames, totalFrames, steps, doneIn, stage, codec, }: StitchingProgressInput) => string;
-export declare type DownloadProgress = {
-    name: string;
-    id: number;
-    progress: number | null;
-    totalBytes: number | null;
-    downloaded: number;
+export declare type SymbolicLinksState = {
+    symlinks: string[];
+};
+export declare const makeBundlingAndCopyProgress: ({ bundling, copying, symLinks, }: {
+    bundling: BundlingState;
+    copying: CopyingState;
+    symLinks: SymbolicLinksState;
+}, indent: boolean, bundlingStep: number, steps: number) => string;
+export declare const makeRenderingAndStitchingProgress: ({ prog, indent, steps, stitchingStep, }: {
+    prog: AggregateRenderProgress;
+    indent: boolean;
+    steps: number;
+    stitchingStep: number;
+}) => {
+    output: string;
+    progress: number;
+    message: string;
 };
-export declare const makeRenderingAndStitchingProgress: ({ rendering, stitching, downloads, }: {
-    rendering: RenderingProgressInput;
-    stitching: StitchingProgressInput | null;
-    downloads: DownloadProgress[];
-}) => string;
-export {};

package/dist/progress-bar.js

@@ -1,72 +1,179 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeRenderingAndStitchingProgress = exports.makeStitchingProgress = exports.makeRenderingProgress = exports.makeBundlingProgress = exports.createOverwriteableCliOutput = exports.createProgressBar = void 0;
+exports.makeRenderingAndStitchingProgress = exports.makeBundlingAndCopyProgress = exports.createOverwriteableCliOutput = void 0;
 const renderer_1 = require("@remotion/renderer");
 const ansi_diff_1 = require("./ansi/ansi-diff");
 const chalk_1 = require("./chalk");
-const config_1 = require("./config");
 const download_progress_1 = require("./download-progress");
+const log_1 = require("./log");
 const make_progress_bar_1 = require("./make-progress-bar");
 const truthy_1 = require("./truthy");
-const createProgressBar = (quiet) => {
-    if (!renderer_1.RenderInternals.isEqualOrBelowLogLevel(config_1.ConfigInternals.Logging.getLogLevel(), 'info')) {
-        return { update: () => false };
-    }
-    return (0, exports.createOverwriteableCliOutput)(quiet);
-};
-exports.createProgressBar = createProgressBar;
-const createOverwriteableCliOutput = (quiet) => {
-    if (quiet) {
+const createOverwriteableCliOutput = (options) => {
+    var _a;
+    if (options.quiet) {
         return {
             update: () => false,
         };
     }
     const diff = new ansi_diff_1.AnsiDiff();
+    (_a = options.cancelSignal) === null || _a === void 0 ? void 0 : _a.call(options, () => {
+        process.stdout.write(diff.finish());
+    });
     return {
         update: (up) => process.stdout.write(diff.update(up)),
     };
 };
 exports.createOverwriteableCliOutput = createOverwriteableCliOutput;
-const makeBundlingProgress = ({ progress, steps, doneIn, }) => [
-    `(${steps.indexOf('bundling') + 1}/${steps.length})`,
-    (0, make_progress_bar_1.makeProgressBar)(progress),
-    `${doneIn ? 'Bundled' : 'Bundling'} code`,
-    doneIn === null
-        ? (progress * 100).toFixed(0) + '%'
-        : chalk_1.chalk.gray(`${doneIn}ms`),
-].join(' ');
-exports.makeBundlingProgress = makeBundlingProgress;
-const makeRenderingProgress = ({ frames, totalFrames, steps, concurrency, doneIn, }) => {
+const makeBundlingProgress = ({ bundlingState, indent, bundlingStep, steps, }) => {
+    const { doneIn, progress } = bundlingState;
+    return [
+        indent ? log_1.INDENT_TOKEN : null,
+        `(${bundlingStep + 1}/${steps})`,
+        (0, make_progress_bar_1.makeProgressBar)(progress),
+        `${doneIn ? 'Bundled' : 'Bundling'} code`,
+        doneIn === null
+            ? (progress * 100).toFixed(0) + '%'
+            : chalk_1.chalk.gray(`${doneIn}ms`),
+    ]
+        .filter(truthy_1.truthy)
+        .join(' ');
+};
+const makeCopyingProgress = (options, indent) => {
+    // Don't show copy progress lower than 200MB
+    if (options.bytes < 1000 * 1000 * 200) {
+        return null;
+    }
+    return [
+        indent ? log_1.INDENT_TOKEN : null,
+        '    +',
+        options.doneIn ? (0, make_progress_bar_1.makeProgressBar)(1) : (0, download_progress_1.getFileSizeDownloadBar)(options.bytes),
+        'Copying public dir',
+        options.doneIn === null ? null : chalk_1.chalk.gray(`${options.doneIn}ms`),
+    ]
+        .filter(truthy_1.truthy)
+        .join(' ');
+};
+const makeSymlinkProgress = (options, indent) => {
+    if (options.symlinks.length === 0) {
+        return null;
+    }
+    if (options.symlinks.length === 1) {
+        return [
+            chalk_1.chalk.gray(`      Found a symbolic link in the public folder:`),
+            chalk_1.chalk.gray('      ' + options.symlinks[0]),
+            chalk_1.chalk.gray('      The symlink will be forwarded in to the bundle.'),
+        ]
+            .map((l) => {
+            return indent ? `${log_1.INDENT_TOKEN} ${l}` : null;
+        })
+            .join('\n');
+    }
+    return [
+        chalk_1.chalk.gray(`      Found ${options.symlinks.length} symbolic links in the public folder.`),
+        chalk_1.chalk.gray('      The symlinks will be forwarded in to the bundle.'),
+    ]
+        .map((l) => {
+        return indent ? `${log_1.INDENT_TOKEN} ${l}` : null;
+    })
+        .join('\n');
+};
+const makeBundlingAndCopyProgress = ({ bundling, copying, symLinks, }, indent, bundlingStep, steps) => {
+    return [
+        makeBundlingProgress({
+            bundlingState: bundling,
+            indent,
+            bundlingStep,
+            steps,
+        }),
+        makeCopyingProgress(copying, indent),
+        makeSymlinkProgress(symLinks, indent),
+    ]
+        .filter(truthy_1.truthy)
+        .join('\n');
+};
+exports.makeBundlingAndCopyProgress = makeBundlingAndCopyProgress;
+const makeRenderingProgress = ({ frames, totalFrames, steps, concurrency, doneIn }, indent) => {
     const progress = frames / totalFrames;
     return [
+        indent ? log_1.INDENT_TOKEN : null,
         `(${steps.indexOf('rendering') + 1}/${steps.length})`,
         (0, make_progress_bar_1.makeProgressBar)(progress),
         [doneIn ? 'Rendered' : 'Rendering', `frames (${concurrency}x)`]
             .filter(truthy_1.truthy)
             .join(' '),
         doneIn === null ? `${frames}/${totalFrames}` : chalk_1.chalk.gray(`${doneIn}ms`),
-    ].join(' ');
+    ]
+        .filter(truthy_1.truthy)
+        .join(' ');
 };
-exports.makeRenderingProgress = makeRenderingProgress;
-const makeStitchingProgress = ({ frames, totalFrames, steps, doneIn, stage, codec, }) => {
+const makeStitchingProgress = ({ stitchingProgress, indent, steps, stitchingStep, }) => {
+    const { frames, totalFrames, doneIn, stage, codec } = stitchingProgress;
     const progress = frames / totalFrames;
+    const mediaType = codec === 'gif'
+        ? 'GIF'
+        : renderer_1.RenderInternals.isAudioCodec(codec)
+            ? 'audio'
+            : 'video';
     return [
-        `(${steps.indexOf('stitching') + 1}/${steps.length})`,
+        indent ? log_1.INDENT_TOKEN : null,
+        `(${stitchingStep + 1}/${steps})`,
         (0, make_progress_bar_1.makeProgressBar)(progress),
         stage === 'muxing' && renderer_1.RenderInternals.canUseParallelEncoding(codec)
-            ? `${doneIn ? 'Muxed' : 'Muxing'} audio`
-            : `${doneIn ? 'Encoded' : 'Encoding'} ${codec === 'gif' ? 'GIF' : 'video'}`,
+            ? `${doneIn ? 'Muxed' : 'Muxing'} ${mediaType}`
+            : `${doneIn ? 'Encoded' : 'Encoding'} ${mediaType}`,
         doneIn === null ? `${frames}/${totalFrames}` : chalk_1.chalk.gray(`${doneIn}ms`),
-    ].join(' ');
+    ]
+        .filter(truthy_1.truthy)
+        .join(' ');
 };
-exports.makeStitchingProgress = makeStitchingProgress;
-const makeRenderingAndStitchingProgress = ({ rendering, stitching, downloads, }) => {
-    return [
-        (0, exports.makeRenderingProgress)(rendering),
-        (0, download_progress_1.makeMultiDownloadProgress)(downloads),
-        stitching === null ? null : (0, exports.makeStitchingProgress)(stitching),
+const makeRenderingAndStitchingProgress = ({ prog, indent, steps, stitchingStep, }) => {
+    const { rendering, stitching, downloads, bundling } = prog;
+    const output = [
+        rendering ? makeRenderingProgress(rendering, indent) : null,
+        (0, download_progress_1.makeMultiDownloadProgress)(downloads, indent),
+        stitching === null
+            ? null
+            : makeStitchingProgress({
+                stitchingProgress: stitching,
+                indent,
+                steps,
+                stitchingStep,
+            }),
     ]
         .filter(truthy_1.truthy)
         .join('\n');
+    const renderProgress = rendering
+        ? rendering.frames / rendering.totalFrames
+        : 0;
+    const stitchingProgress = stitching
+        ? stitching.frames / stitching.totalFrames
+        : 0;
+    const progress = bundling.progress * 0.3 + renderProgress * 0.6 + stitchingProgress * 0.1;
+    return { output, progress, message: getGuiProgressSubtitle(prog) };
 };
 exports.makeRenderingAndStitchingProgress = makeRenderingAndStitchingProgress;
+const getGuiProgressSubtitle = (progress) => {
+    if (progress.bundling.progress < 1) {
+        return `Bundling ${Math.round(progress.bundling.progress * 100)}%`;
+    }
+    if (!progress.copyingState.doneIn) {
+        if (progress.copyingState.bytes < 100000000) {
+            return 'Bundling 100%';
+        }
+        const bytes = new Intl.NumberFormat('en', {
+            notation: 'compact',
+            style: 'unit',
+            unit: 'byte',
+            unitDisplay: 'narrow',
+        });
+        return `Copying ${bytes.format(progress.copyingState.bytes)}`;
+    }
+    if (!progress.rendering) {
+        return `Getting compositions`;
+    }
+    const allRendered = progress.rendering.frames === progress.rendering.totalFrames;
+    if (!allRendered || !progress.stitching || progress.stitching.frames === 0) {
+        return `Rendering ${progress.rendering.frames}/${progress.rendering.totalFrames}`;
+    }
+    return `Stitching ${progress.stitching.frames}/${progress.stitching.totalFrames}`;
+};

package/dist/progress-types.d.ts

@@ -0,0 +1,32 @@
+import type { Codec, StitchingState } from '@remotion/renderer';
+import type { BundlingState, CopyingState } from './progress-bar';
+import type { RenderStep } from './step';
+export declare type DownloadProgress = {
+    name: string;
+    id: number;
+    progress: number | null;
+    totalBytes: number | null;
+    downloaded: number;
+};
+export declare type RenderingProgressInput = {
+    frames: number;
+    totalFrames: number;
+    steps: RenderStep[];
+    concurrency: number;
+    doneIn: number | null;
+};
+export declare type StitchingProgressInput = {
+    frames: number;
+    totalFrames: number;
+    doneIn: number | null;
+    stage: StitchingState;
+    codec: Codec;
+};
+export declare type AggregateRenderProgress = {
+    rendering: RenderingProgressInput | null;
+    stitching: StitchingProgressInput | null;
+    downloads: DownloadProgress[];
+    bundling: BundlingState;
+    copyingState: CopyingState;
+};
+export declare const initialAggregateRenderProgress: () => AggregateRenderProgress;

package/dist/progress-types.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initialAggregateRenderProgress = void 0;
+const initialAggregateRenderProgress = () => ({
+    rendering: null,
+    downloads: [],
+    stitching: null,
+    bundling: {
+        progress: 0,
+        doneIn: null,
+    },
+    copyingState: {
+        bytes: 0,
+        doneIn: null,
+    },
+});
+exports.initialAggregateRenderProgress = initialAggregateRenderProgress;

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, jpegQuality, 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;
+    jpegQuality: 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>;