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

package/dist/get-final-output-codec.js

@@ -2,62 +2,59 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getFinalOutputCodec = void 0;
 const renderer_1 = require("@remotion/renderer");
-const log_1 = require("./log");
-const getFinalOutputCodec = ({ codec: inputCodec, fileExtension, emitWarning, }) => {
-    if (inputCodec === undefined && fileExtension === 'webm') {
-        if (emitWarning) {
-            log_1.Log.info('You have specified a .webm extension, using the VP8 encoder. Use --codec=vp9 to use the Vp9 encoder.');
-        }
-        return 'vp8';
-    }
-    if (inputCodec === undefined && fileExtension === 'hevc') {
-        if (emitWarning) {
-            log_1.Log.info('You have specified a .hevc extension, using the H265 encoder.');
-        }
-        return 'h265';
-    }
-    if (inputCodec === undefined && fileExtension === 'mp3') {
-        if (emitWarning) {
-            log_1.Log.info('You have specified a .mp3 extension, using the MP3 encoder.');
-        }
-        return 'mp3';
-    }
-    if (inputCodec === undefined && fileExtension === 'mov') {
-        if (emitWarning) {
-            log_1.Log.info('You have specified a .mov extension, using the Apple ProRes encoder.');
-        }
-        return 'prores';
-    }
-    if (inputCodec === undefined && fileExtension === 'wav') {
-        if (emitWarning) {
-            log_1.Log.info('You have specified a .wav extension, using the WAV encoder.');
-        }
-        return 'wav';
-    }
-    if (inputCodec === undefined && fileExtension === 'aac') {
-        if (emitWarning) {
-            log_1.Log.info('You have specified a .aac extension, using the AAC encoder.');
-        }
-        return 'aac';
-    }
-    if (inputCodec === undefined && fileExtension === 'm4a') {
-        if (emitWarning) {
-            log_1.Log.info('You have specified a .m4a extension, using the AAC encoder.');
-        }
-        return 'aac';
-    }
-    if (inputCodec === undefined && fileExtension === 'mkv') {
-        if (emitWarning) {
-            log_1.Log.info('You have specified a .mkv extension, using the H264 encoder and WAV audio format.');
-        }
-        return 'h264-mkv';
-    }
-    if (inputCodec === undefined && fileExtension === 'gif') {
-        if (emitWarning) {
-            log_1.Log.info('You have specified a .gif extension, rendering a GIF');
-        }
-        return 'gif';
-    }
-    return inputCodec !== null && inputCodec !== void 0 ? inputCodec : renderer_1.RenderInternals.DEFAULT_CODEC;
+const deriveCodecsFromFilename = (extension) => {
+    var _a, _b;
+    if (extension === null) {
+        return { possible: [], default: null };
+    }
+    return {
+        default: (_a = renderer_1.RenderInternals.defaultCodecsForFileExtension[extension]) !== null && _a !== void 0 ? _a : null,
+        possible: (_b = renderer_1.RenderInternals.makeFileExtensionMap()[extension]) !== null && _b !== void 0 ? _b : [],
+    };
+};
+const getFinalOutputCodec = ({ cliFlag, configFile, downloadName, outName, uiCodec, }) => {
+    if (uiCodec) {
+        return { codec: uiCodec, reason: 'via UI' };
+    }
+    const downloadNameExtension = renderer_1.RenderInternals.getExtensionOfFilename(downloadName);
+    const outNameExtension = renderer_1.RenderInternals.getExtensionOfFilename(outName);
+    const derivedDownloadCodecs = deriveCodecsFromFilename(downloadNameExtension);
+    const derivedOutNameCodecs = deriveCodecsFromFilename(outNameExtension);
+    if (derivedDownloadCodecs.possible.length > 0 &&
+        derivedOutNameCodecs.possible.length > 0 &&
+        derivedDownloadCodecs.possible.join('') !==
+            derivedOutNameCodecs.possible.join('')) {
+        throw new TypeError(`The download name is ${downloadName} but the output name is ${outName}. The file extensions must match`);
+    }
+    if (cliFlag) {
+        if (derivedDownloadCodecs.possible.length > 0 &&
+            derivedDownloadCodecs.possible.indexOf(cliFlag) === -1) {
+            throw new TypeError(`The download name is ${downloadName} but --codec=${cliFlag} was passed. The download name implies a codec of ${derivedDownloadCodecs.possible.join(' or ')} which does not align with the --codec flag.`);
+        }
+        if (derivedOutNameCodecs.possible.length > 0 &&
+            derivedOutNameCodecs.possible.indexOf(cliFlag) === -1) {
+            throw new TypeError(`The out name is ${outName} but --codec=${cliFlag} was passed. The out name implies a codec of ${derivedOutNameCodecs.possible.join(' or ')} which does not align with the --codec flag.`);
+        }
+        return { codec: cliFlag, reason: 'from --codec flag' };
+    }
+    if (derivedDownloadCodecs.possible.length > 0) {
+        return {
+            codec: derivedDownloadCodecs.default,
+            reason: 'derived from download name',
+        };
+    }
+    if (derivedOutNameCodecs.possible.length > 0) {
+        return {
+            codec: derivedOutNameCodecs.default,
+            reason: 'derived from out name',
+        };
+    }
+    if (configFile) {
+        return {
+            codec: configFile,
+            reason: 'Config file',
+        };
+    }
+    return { codec: renderer_1.RenderInternals.DEFAULT_CODEC, reason: 'default' };
 };
 exports.getFinalOutputCodec = getFinalOutputCodec;

package/dist/get-input-props.d.ts

@@ -1 +1 @@
-export declare const getInputProps: (onUpdate: (newProps: object) => void) => object;
+export declare const getInputProps: (onUpdate: ((newProps: object) => void) | null) => object;

package/dist/get-input-props.js

@@ -17,15 +17,17 @@ const getInputProps = (onUpdate) => {
     try {
         if (fs_1.default.existsSync(jsonFile)) {
             const rawJsonData = fs_1.default.readFileSync(jsonFile, 'utf-8');
-            fs_1.default.watchFile(jsonFile, { interval: 100 }, () => {
-                try {
-                    onUpdate(JSON.parse(fs_1.default.readFileSync(jsonFile, 'utf-8')));
-                    log_1.Log.info(`Updated input props from ${jsonFile}.`);
-                }
-                catch (err) {
-                    log_1.Log.error(`${jsonFile} contains invalid JSON. Did not apply new input props.`);
-                }
-            });
+            if (onUpdate) {
+                fs_1.default.watchFile(jsonFile, { interval: 100 }, () => {
+                    try {
+                        onUpdate(JSON.parse(fs_1.default.readFileSync(jsonFile, 'utf-8')));
+                        log_1.Log.info(`Updated input props from ${jsonFile}.`);
+                    }
+                    catch (err) {
+                        log_1.Log.error(`${jsonFile} contains invalid JSON. Did not apply new input props.`);
+                    }
+                });
+            }
             return JSON.parse(rawJsonData);
         }
         return JSON.parse(parse_command_line_1.parsedCli.props);

package/dist/get-network-address.d.ts

@@ -0,0 +1 @@
+export declare const getNetworkAddress: () => string | undefined;

package/dist/get-network-address.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getNetworkAddress = void 0;
+const os_1 = require("os");
+const getNetworkAddress = () => {
+    for (const interfaceDetails of Object.values((0, os_1.networkInterfaces)())) {
+        if (!interfaceDetails)
+            continue;
+        for (const details of interfaceDetails) {
+            const { address, family, internal } = details;
+            if (family === 'IPv4' && !internal)
+                return address;
+        }
+    }
+};
+exports.getNetworkAddress = getNetworkAddress;

package/dist/get-render-media-options.d.ts

@@ -0,0 +1,8 @@
+import type { Codec, RenderMediaOptions } from '@remotion/renderer';
+export declare const getRenderMediaOptions: ({ outputLocation, config, serveUrl, codec, remotionRoot, }: {
+    outputLocation: RenderMediaOptions['outputLocation'];
+    config: RenderMediaOptions['composition'];
+    serveUrl: string;
+    codec: Codec;
+    remotionRoot: string;
+}) => Promise<RenderMediaOptions>;

package/dist/get-render-media-options.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRenderMediaOptions = void 0;
+const renderer_1 = require("@remotion/renderer");
+const config_1 = require("./config");
+const get_audio_codec_1 = require("./get-audio-codec");
+const get_cli_options_1 = require("./get-cli-options");
+const image_formats_1 = require("./image-formats");
+const getRenderMediaOptions = async ({ outputLocation, config, serveUrl, codec, remotionRoot, }) => {
+    const { proResProfile, concurrency, frameRange, overwrite, inputProps, envVariables, quality, crf, pixelFormat, browserExecutable, ffmpegExecutable, ffprobeExecutable, scale, chromiumOptions, port, numberOfGifLoops, everyNthFrame, muted, enforceAudioTrack, ffmpegOverride, audioBitrate, videoBitrate, height, width, } = await (0, get_cli_options_1.getCliOptions)({
+        isLambda: false,
+        type: 'series',
+        remotionRoot,
+    });
+    const imageFormat = (0, image_formats_1.getImageFormat)(codec);
+    const audioCodec = (0, get_audio_codec_1.getResolvedAudioCodec)();
+    return {
+        outputLocation,
+        composition: {
+            ...config,
+            width: width !== null && width !== void 0 ? width : config.width,
+            height: height !== null && height !== void 0 ? height : config.height,
+        },
+        crf,
+        envVariables,
+        ffmpegExecutable,
+        ffprobeExecutable,
+        frameRange,
+        imageFormat,
+        inputProps,
+        overwrite,
+        pixelFormat,
+        proResProfile,
+        quality,
+        dumpBrowserLogs: renderer_1.RenderInternals.isEqualOrBelowLogLevel(config_1.ConfigInternals.Logging.getLogLevel(), 'verbose'),
+        chromiumOptions,
+        timeoutInMilliseconds: config_1.ConfigInternals.getCurrentPuppeteerTimeout(),
+        scale,
+        port,
+        numberOfGifLoops,
+        everyNthFrame,
+        verbose: renderer_1.RenderInternals.isEqualOrBelowLogLevel(config_1.ConfigInternals.Logging.getLogLevel(), 'verbose'),
+        muted,
+        enforceAudioTrack,
+        browserExecutable,
+        ffmpegOverride,
+        concurrency,
+        serveUrl,
+        codec,
+        audioBitrate,
+        videoBitrate,
+        audioCodec,
+    };
+};
+exports.getRenderMediaOptions = getRenderMediaOptions;

package/dist/handle-common-errors.js

@@ -1,15 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.handleCommonError = void 0;
+const chalk_1 = require("./chalk");
 const log_1 = require("./log");
 const print_error_1 = require("./print-error");
+const truthy_1 = require("./truthy");
 const handleCommonError = async (err) => {
+    var _a;
     await (0, print_error_1.printError)(err);
     if (err.message.includes('Could not play video with')) {
         log_1.Log.info();
         log_1.Log.info('💡 Get help for this issue at https://remotion.dev/docs/media-playback-error');
     }
-    if (err.message.includes('A delayRender was called')) {
+    if (err.message.includes('A delayRender()') &&
+        err.message.includes('was called but not cleared after')) {
         log_1.Log.info();
         log_1.Log.info('💡 Get help for this issue at https://remotion.dev/docs/timeout');
     }
@@ -21,5 +25,28 @@ const handleCommonError = async (err) => {
         log_1.Log.info();
         log_1.Log.info('💡 Get help for this issue at https://remotion.dev/docs/enametoolong');
     }
+    if (err.message.includes('Error creating WebGL context')) {
+        log_1.Log.info();
+        log_1.Log.info('💡 You might need to set the OpenGL renderer to "angle"');
+        log_1.Log.info('💡 Get help for this issue at https://www.remotion.dev/docs/three');
+    }
+    if (err.message.includes('The bucket does not allow ACLs')) {
+        log_1.Log.info();
+        log_1.Log.info(chalk_1.chalk.green('💡 Fix this issue https://remotion.dev/docs/lambda/troubleshooting/bucket-disallows-acl'));
+    }
+    if (err.message.includes('Minified React error #306')) {
+        const componentName = (_a = err.message.match(/<\w+>/)) === null || _a === void 0 ? void 0 : _a[0];
+        log_1.Log.info([
+            '💡 This error indicates that the component',
+            componentName ? `(${componentName})` : null,
+            'you are trying to render is not imported correctly.',
+        ]
+            .filter(truthy_1.truthy)
+            .join(' '));
+        log_1.Log.info();
+        log_1.Log.info('   Check the root file and ensure that the component is not undefined.');
+        log_1.Log.info('   Oftentimes, this happens if the component is missing the `export` keyword');
+        log_1.Log.info('   or if the component was renamed and the import statement not properly adjusted.');
+    }
 };
 exports.handleCommonError = handleCommonError;

package/dist/image-formats.d.ts

@@ -1,3 +1,6 @@
-import type { ImageFormat } from '@remotion/renderer';
+import type { VideoImageFormat } from '@remotion/renderer';
 import { ConfigInternals } from './config';
-export declare const getImageFormat: (codec: ReturnType<typeof ConfigInternals.getOutputCodecOrUndefined>) => ImageFormat;
+export declare const getVideoImageFormat: ({ codec, uiImageFormat, }: {
+    codec: ReturnType<typeof ConfigInternals.getOutputCodecOrUndefined>;
+    uiImageFormat: VideoImageFormat | null;
+}) => VideoImageFormat;

package/dist/image-formats.js

@@ -1,12 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getImageFormat = void 0;
+exports.getVideoImageFormat = void 0;
 const renderer_1 = require("@remotion/renderer");
 const config_1 = require("./config");
-const getImageFormat = (codec) => {
-    const userPreferred = config_1.ConfigInternals.getUserPreferredImageFormat();
-    if (typeof userPreferred !== 'undefined') {
-        return userPreferred;
+const parse_command_line_1 = require("./parse-command-line");
+const getVideoImageFormat = ({ codec, uiImageFormat, }) => {
+    if (uiImageFormat !== null) {
+        return uiImageFormat;
+    }
+    if (typeof parse_command_line_1.parsedCli['image-format'] !== 'undefined') {
+        if (!renderer_1.RenderInternals.validVideoImageFormats.includes(parse_command_line_1.parsedCli['image-format'])) {
+            throw new Error(`Invalid image format: ${parse_command_line_1.parsedCli['image-format']}`);
+        }
+        return parse_command_line_1.parsedCli['image-format'];
+    }
+    const configFileOption = config_1.ConfigInternals.getUserPreferredVideoImageFormat();
+    if (typeof configFileOption !== 'undefined') {
+        return configFileOption;
     }
     if (renderer_1.RenderInternals.isAudioCodec(codec)) {
         return 'none';
@@ -25,4 +35,4 @@ const getImageFormat = (codec) => {
     }
     throw new Error('Unrecognized codec ' + codec);
 };
-exports.getImageFormat = getImageFormat;
+exports.getVideoImageFormat = getVideoImageFormat;

package/dist/index.d.ts

@@ -1,11 +1,11 @@
-/// <reference types="minimist" />
+import minimist from 'minimist';
 export declare const cli: () => Promise<void>;
-export { ConfigInternals, overrideRemotion } from './config/index';
 export * from './render';
 export declare const CliInternals: {
-    createOverwriteableCliOutput: (quiet: boolean) => {
-        update: (up: string) => boolean;
-    };
+    createOverwriteableCliOutput: (options: {
+        quiet: boolean;
+        cancelSignal: import("@remotion/renderer").CancelSignal | null;
+    }) => import("./progress-bar").OverwriteableCliOutput;
     chalk: {
         enabled: boolean;
         visible: boolean;
@@ -62,46 +62,115 @@ export declare const CliInternals: {
     makeProgressBar: (percentage: number) => string;
     Log: {
         verbose: (message?: any, ...optionalParams: any[]) => void;
+        verboseAdvanced: (options: {
+            indent: boolean;
+            logLevel: "verbose" | "info" | "warn" | "error";
+        }, message?: any, ...optionalParams: any[]) => void;
         info: (message?: any, ...optionalParams: any[]) => void;
+        infoAdvanced: (options: {
+            indent: boolean;
+            logLevel: "verbose" | "info" | "warn" | "error";
+        }, message?: any, ...optionalParams: any[]) => void;
         warn: (message?: any, ...optionalParams: any[]) => void;
+        warnAdvanced: (options: {
+            indent: boolean;
+            logLevel: "verbose" | "info" | "warn" | "error";
+        }, message?: any, ...optionalParams: any[]) => void;
         error: (message?: any, ...optionalParams: any[]) => void;
     };
-    loadConfigFile: (remotionRoot: string, configFileName: string, isJavascript: boolean) => Promise<string | null>;
     getCliOptions: (options: {
         isLambda: boolean;
         type: "still" | "series" | "get-compositions";
+        remotionRoot: string;
     }) => Promise<{
         puppeteerTimeout: number;
-        parallelism: number | null;
+        concurrency: string | number | null;
         frameRange: import("@remotion/renderer").FrameRange | null;
         shouldOutputImageSequence: boolean;
-        codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif";
         inputProps: object;
         envVariables: Record<string, string>;
-        quality: number | undefined;
+        jpegQuality: number | undefined;
         browser: import("@remotion/renderer").Browser;
-        crf: number | null;
+        crf: import("@remotion/renderer").Crf | null;
         pixelFormat: "yuv420p" | "yuva420p" | "yuv422p" | "yuv444p" | "yuv420p10le" | "yuv422p10le" | "yuv444p10le" | "yuva444p10le";
-        imageFormat: "png" | "jpeg" | "none";
         proResProfile: "4444-xq" | "4444" | "hq" | "standard" | "light" | "proxy" | undefined;
         everyNthFrame: number;
-        numberOfGifLoops: number | null;
+        numberOfGifLoops: import("./config/number-of-gif-loops").Loop;
         stillFrame: number;
         browserExecutable: import("@remotion/renderer").BrowserExecutable;
-        ffmpegExecutable: import("@remotion/renderer").FfmpegExecutable;
-        ffprobeExecutable: import("@remotion/renderer").FfmpegExecutable;
         logLevel: "verbose" | "info" | "warn" | "error";
         scale: number;
         chromiumOptions: import("@remotion/renderer").ChromiumOptions;
         overwrite: boolean;
         port: number | null;
+        muted: boolean;
+        enforceAudioTrack: boolean;
+        publicDir: string | null;
+        ffmpegOverride: import("@remotion/renderer").FfmpegOverrideFn;
+        audioBitrate: string | null;
+        videoBitrate: string | null;
+        height: number | null;
+        width: number | null;
+        configFileImageFormat: "png" | "jpeg" | "none" | undefined;
     }>;
-    parseCommandLine: (type: "sequence" | "still" | "lambda" | "preview" | "versions") => void;
     loadConfig: (remotionRoot: string) => Promise<string | null>;
-    initializeRenderCli: (remotionRoot: string, type: "sequence" | "still" | "lambda" | "preview") => Promise<void>;
+    initializeCli: (remotionRoot: string) => Promise<void>;
     BooleanFlags: string[];
     quietFlagProvided: () => boolean;
-    parsedCli: import("./parse-command-line").CommandLineOptions & import("minimist").ParsedArgs;
+    parsedCli: {
+        "browser-executable": import("@remotion/renderer").BrowserExecutable;
+        "pixel-format": "yuv420p" | "yuva420p" | "yuv422p" | "yuv444p" | "yuv420p10le" | "yuv422p10le" | "yuv444p10le" | "yuva444p10le";
+        "image-format": "png" | "jpeg" | "pdf" | "webp" | "none";
+        "prores-profile": "4444-xq" | "4444" | "hq" | "standard" | "light" | "proxy";
+        "bundle-cache": string;
+        "env-file": string;
+        "ignore-certificate-errors": string;
+        "disable-web-security": string;
+        "every-nth-frame": number;
+        "number-of-gif-loops": number;
+        "number-of-shared-audio-tags": number;
+        codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif";
+        concurrency: number;
+        timeout: number;
+        config: string;
+        "public-dir": string;
+        "audio-bitrate": string;
+        "video-bitrate": string;
+        "audio-codec": "mp3" | "aac" | "pcm-16" | "opus";
+        crf: number;
+        force: boolean;
+        overwrite: boolean;
+        png: boolean;
+        props: string;
+        quality: number;
+        "jpeg-quality": number;
+        frames: string | number;
+        scale: number;
+        sequence: boolean;
+        quiet: boolean;
+        q: boolean;
+        log: string;
+        help: boolean;
+        port: number;
+        frame: string | number;
+        "disable-headless": boolean;
+        "disable-keyboard-shortcuts": boolean;
+        muted: boolean;
+        height: number;
+        width: number;
+        runs: number;
+        concurrencies: string;
+        "enforce-audio-track": boolean;
+        gl: "swangle" | "angle" | "egl" | "swiftshader";
+        "package-manager": string;
+        "webpack-poll": number;
+        "no-open": boolean;
+        browser: string;
+        "browser-args": string;
+        "user-agent": string;
+    } & {
+        _: string[];
+    };
     handleCommonError: (err: Error) => Promise<void>;
     formatBytes: (number: number, options?: Intl.NumberFormatOptions & {
         locale: string;
@@ -110,5 +179,41 @@ export declare const CliInternals: {
         signed: boolean;
     }) => string;
     getFileSizeDownloadBar: (downloaded: number) => string;
-    findRemotionRoot: () => string;
+    determineFinalStillImageFormat: ({ downloadName, outName, configImageFormat, cliFlag, isLambda, fromUi, }: {
+        downloadName: string | null;
+        outName: string | null;
+        configImageFormat: "png" | "jpeg" | "pdf" | "webp" | null;
+        cliFlag: "png" | "jpeg" | "pdf" | "webp" | "none" | null;
+        isLambda: boolean;
+        fromUi: "png" | "jpeg" | "pdf" | "webp" | null;
+    }) => {
+        format: "png" | "jpeg" | "pdf" | "webp";
+        source: string;
+    };
+    minimist: typeof minimist;
+    selectComposition: (validCompositions: import("remotion").AnyCompMetadata[]) => Promise<{
+        compositionId: string;
+        reason: string;
+    }>;
+    findEntryPoint: (args: string[], remotionRoot: string) => {
+        file: string | null;
+        remainingArgs: string[];
+        reason: string;
+    };
+    getVideoImageFormat: ({ codec, uiImageFormat, }: {
+        codec: import("@remotion/renderer").CodecOrUndefined;
+        uiImageFormat: "png" | "jpeg" | "none" | null;
+    }) => "png" | "jpeg" | "none";
+    printCompositions: (compositions: import("remotion").AnyCompMetadata[]) => void;
+    getFinalOutputCodec: ({ cliFlag, configFile, downloadName, outName, uiCodec, }: {
+        cliFlag: import("@remotion/renderer").CodecOrUndefined;
+        outName: string | null;
+        downloadName: string | null;
+        configFile: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif" | null;
+        uiCodec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif" | null;
+    }) => {
+        codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif";
+        reason: string;
+    };
+    listOfRemotionPackages: string[];
 };