@remotion/cli 3.2.21 → 3.2.23-ensure-ffmpeg.123

package/dist/editor/state/modals.d.ts

@@ -1,4 +1,5 @@
 import type React from 'react';
+import type { QuickSwitcherMode } from '../components/QuickSwitcher/NoResults';
 import type { UpdateInfo } from '../components/UpdateCheck';
 export declare type CompType = 'composition' | 'still';
 export declare type ModalState = {
@@ -8,7 +9,9 @@ export declare type ModalState = {
     type: 'update';
     info: UpdateInfo;
 } | {
-    type: 'shortcuts';
+    type: 'quick-switcher';
+    mode: QuickSwitcherMode;
+    invocationTimestamp: number;
 };
 export declare type ModalContextType = {
     selectedModal: ModalState | null;

package/dist/editor/state/z-index.js

@@ -17,6 +17,7 @@ const EscapeHook = ({ onEscape }) => {
             key: 'Escape',
             callback: onEscape,
             commandCtrlKey: false,
+            preventDefault: true,
         });
         return () => {
             escape.unregister();

package/dist/entry-point.d.ts

@@ -0,0 +1,5 @@
+export declare const findEntryPoint: (args: string[], remotionRoot: string) => {
+    file: string | null;
+    remainingArgs: string[];
+    reason: string;
+};

package/dist/entry-point.js

@@ -0,0 +1,46 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findEntryPoint = void 0;
+const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
+const config_1 = require("./config");
+const log_1 = require("./log");
+const candidates = [
+    path_1.default.join('src', 'index.ts'),
+    path_1.default.join('src', 'index.tsx'),
+    path_1.default.join('src', 'index.js'),
+    path_1.default.join('remotion', 'index.tsx'),
+    path_1.default.join('remotion', 'index.ts'),
+    path_1.default.join('remotion', 'index.js'),
+];
+const findCommonPath = (remotionRoot) => {
+    return candidates.find((candidate) => (0, fs_1.existsSync)(path_1.default.resolve(remotionRoot, candidate)));
+};
+const findEntryPoint = (args, remotionRoot) => {
+    // 1st priority: Explicitly passed entry point
+    let file = args[0];
+    if (file) {
+        log_1.Log.verbose('Checking if', file, 'is the entry file');
+        // Intentionally resolving CLI files to CWD, while resolving config file to remotionRoot
+        if ((0, fs_1.existsSync)(path_1.default.resolve(process.cwd(), file))) {
+            return { file, remainingArgs: args.slice(1), reason: 'argument passed' };
+        }
+    }
+    // 2nd priority: Config file
+    file = config_1.ConfigInternals.getEntryPoint();
+    if (file) {
+        log_1.Log.verbose('Entry point from config file is', file);
+        return { file, remainingArgs: args, reason: 'config file' };
+    }
+    // 3rd priority: Common paths
+    const found = findCommonPath(remotionRoot);
+    if (found) {
+        log_1.Log.verbose('Selected', found, 'as the entry point because file exists and is a common entry point and no entry point was explicitly selected');
+        return { file: found, remainingArgs: args, reason: 'common paths' };
+    }
+    return { file: null, remainingArgs: args, reason: 'none found' };
+};
+exports.findEntryPoint = findEntryPoint;

package/dist/event-source-events.d.ts

@@ -3,4 +3,7 @@ export declare type EventSourceEvent = {
     newProps: object;
 } | {
     type: 'init';
+} | {
+    type: 'new-env-variables';
+    newEnvVariables: Record<string, string>;
 };

package/dist/event-source.js

@@ -7,22 +7,24 @@ const openEventSource = () => {
     source = new EventSource('/events');
     source.addEventListener('message', (event) => {
         const newEvent = JSON.parse(event.data);
-        if (newEvent.type === 'new-input-props') {
+        if (newEvent.type === 'new-input-props' ||
+            newEvent.type === 'new-env-variables') {
             window.location.reload();
         }
     });
     source.addEventListener('open', () => {
         var _a;
         (_a = ServerDisconnected_1.serverDisconnectedRef.current) === null || _a === void 0 ? void 0 : _a.setServerConnected();
-    });
-    source.addEventListener('error', () => {
-        var _a;
-        // Display an error message that the preview server has disconnected.
-        (_a = ServerDisconnected_1.serverDisconnectedRef.current) === null || _a === void 0 ? void 0 : _a.setServerDisconnected();
-        // Retry later
-        setTimeout(() => {
-            (0, exports.openEventSource)();
-        }, 1000);
+        source.addEventListener('error', () => {
+            var _a;
+            // Display an error message that the preview server has disconnected.
+            (_a = ServerDisconnected_1.serverDisconnectedRef.current) === null || _a === void 0 ? void 0 : _a.setServerDisconnected();
+            source === null || source === void 0 ? void 0 : source.close();
+            // Retry later
+            setTimeout(() => {
+                (0, exports.openEventSource)();
+            }, 1000);
+        }, { once: true });
     });
 };
 exports.openEventSource = openEventSource;

package/dist/get-cli-options.d.ts

@@ -1,24 +1,31 @@
-import type { BrowserExecutable, ChromiumOptions, FrameRange } from '@remotion/renderer';
+import type { BrowserExecutable, ChromiumOptions, Codec, FrameRange } from '@remotion/renderer';
+export declare const validateFfmepgCanUseCodec: (codec: Codec, remotionRoot: string) => Promise<void>;
+export declare const getFinalCodec: (options: {
+    downloadName: string | null;
+    outName: string | null;
+}) => {
+    codec: Codec;
+    reason: string;
+};
 export declare const getAndValidateAbsoluteOutputFile: (relativeOutputLocation: string, overwrite: boolean) => string;
 export declare const getCliOptions: (options: {
     isLambda: boolean;
     type: 'still' | 'series' | 'get-compositions';
+    remotionRoot: string;
 }) => Promise<{
     puppeteerTimeout: number;
     concurrency: number | null;
     frameRange: 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;
     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: BrowserExecutable;
     ffmpegExecutable: import("@remotion/renderer").FfmpegExecutable;
@@ -30,6 +37,10 @@ export declare const getCliOptions: (options: {
     port: number | null;
     muted: boolean;
     enforceAudioTrack: boolean;
-    keyboardShortcutsEnables: boolean;
     publicDir: string | null;
+    ffmpegOverride: import("@remotion/renderer").FfmpegOverrideFn;
+    audioBitrate: string | null;
+    videoBitrate: string | null;
+    height: number | null;
+    width: number | null;
 }>;

package/dist/get-cli-options.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCliOptions = exports.getAndValidateAbsoluteOutputFile = void 0;
+exports.getCliOptions = exports.getAndValidateAbsoluteOutputFile = exports.getFinalCodec = exports.validateFfmepgCanUseCodec = void 0;
 const renderer_1 = require("@remotion/renderer");
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
@@ -11,9 +11,8 @@ const config_1 = require("./config");
 const get_env_1 = require("./get-env");
 const get_final_output_codec_1 = require("./get-final-output-codec");
 const get_input_props_1 = require("./get-input-props");
-const image_formats_1 = require("./image-formats");
 const log_1 = require("./log");
-const user_passed_output_location_1 = require("./user-passed-output-location");
+const parse_command_line_1 = require("./parse-command-line");
 const getAndValidateFrameRange = () => {
     const frameRange = config_1.ConfigInternals.getRange();
     if (typeof frameRange === 'number') {
@@ -23,21 +22,13 @@ const getAndValidateFrameRange = () => {
     }
     return frameRange;
 };
-const getFinalCodec = async (options) => {
-    const userCodec = config_1.ConfigInternals.getOutputCodecOrUndefined();
-    const codec = (0, get_final_output_codec_1.getFinalOutputCodec)({
-        codec: userCodec,
-        fileExtension: options.isLambda
-            ? null
-            : renderer_1.RenderInternals.getExtensionOfFilename((0, user_passed_output_location_1.getUserPassedOutputLocation)()),
-        emitWarning: true,
-    });
+const validateFfmepgCanUseCodec = async (codec, remotionRoot) => {
     const ffmpegExecutable = config_1.ConfigInternals.getCustomFfmpegExecutable();
     if (codec === 'vp8' &&
         !(await renderer_1.RenderInternals.ffmpegHasFeature({
             feature: 'enable-libvpx',
-            isLambda: options.isLambda,
             ffmpegExecutable,
+            remotionRoot,
         }))) {
         log_1.Log.error("The Vp8 codec has been selected, but your FFMPEG binary wasn't compiled with the --enable-lipvpx flag.");
         log_1.Log.error('This does not work, please switch out your FFMPEG binary or choose a different codec.');
@@ -45,8 +36,8 @@ const getFinalCodec = async (options) => {
     if (codec === 'h265' &&
         !(await renderer_1.RenderInternals.ffmpegHasFeature({
             feature: 'enable-gpl',
-            isLambda: options.isLambda,
             ffmpegExecutable,
+            remotionRoot,
         }))) {
         log_1.Log.error("The H265 codec has been selected, but your FFMPEG binary wasn't compiled with the --enable-gpl flag.");
         log_1.Log.error('This does not work, please recompile your FFMPEG binary with --enable-gpl --enable-libx265 or choose a different codec.');
@@ -54,14 +45,25 @@ const getFinalCodec = async (options) => {
     if (codec === 'h265' &&
         !(await renderer_1.RenderInternals.ffmpegHasFeature({
             feature: 'enable-libx265',
-            isLambda: options.isLambda,
             ffmpegExecutable,
+            remotionRoot,
         }))) {
         log_1.Log.error("The H265 codec has been selected, but your FFMPEG binary wasn't compiled with the --enable-libx265 flag.");
         log_1.Log.error('This does not work, please recompile your FFMPEG binary with --enable-gpl --enable-libx265 or choose a different codec.');
     }
-    return codec;
 };
+exports.validateFfmepgCanUseCodec = validateFfmepgCanUseCodec;
+const getFinalCodec = (options) => {
+    var _a;
+    const { codec, reason } = (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: options.downloadName,
+        outName: options.outName,
+    });
+    return { codec, reason };
+};
+exports.getFinalCodec = getFinalCodec;
 const getBrowser = () => { var _a; return (_a = config_1.ConfigInternals.getBrowser()) !== null && _a !== void 0 ? _a : renderer_1.RenderInternals.DEFAULT_BROWSER; };
 const getAndValidateAbsoluteOutputFile = (relativeOutputLocation, overwrite) => {
     const absoluteOutputFile = path_1.default.resolve(process.cwd(), relativeOutputLocation);
@@ -72,38 +74,24 @@ const getAndValidateAbsoluteOutputFile = (relativeOutputLocation, overwrite) =>
     return absoluteOutputFile;
 };
 exports.getAndValidateAbsoluteOutputFile = getAndValidateAbsoluteOutputFile;
-const getAndValidateShouldOutputImageSequence = async ({ frameRange, isLambda, }) => {
+const getAndValidateShouldOutputImageSequence = async ({ frameRange, isLambda, remotionRoot, }) => {
     const shouldOutputImageSequence = config_1.ConfigInternals.getShouldOutputImageSequence(frameRange);
     // When parsing options locally, we don't need FFMPEG because the render will happen on Lambda
     if (!shouldOutputImageSequence && !isLambda) {
-        await renderer_1.RenderInternals.validateFfmpeg(config_1.ConfigInternals.getCustomFfmpegExecutable());
+        await renderer_1.RenderInternals.validateFfmpeg(config_1.ConfigInternals.getCustomFfmpegExecutable(), remotionRoot, 'ffmpeg');
     }
     return shouldOutputImageSequence;
 };
-const getAndValidateCrf = (shouldOutputImageSequence, codec) => {
+const getCrf = (shouldOutputImageSequence) => {
     const crf = shouldOutputImageSequence
         ? null
-        : config_1.ConfigInternals.getActualCrf(codec);
-    if (crf !== null) {
-        renderer_1.RenderInternals.validateSelectedCrfAndCodecCombination(crf, codec);
-    }
+        : config_1.ConfigInternals.getCrfOrUndefined();
     return crf;
 };
-const getAndValidatePixelFormat = (codec) => {
-    const pixelFormat = config_1.ConfigInternals.getPixelFormat();
-    renderer_1.RenderInternals.validateSelectedPixelFormatAndCodecCombination(pixelFormat, codec);
-    return pixelFormat;
-};
-const getAndValidateProResProfile = (actualCodec) => {
+const getProResProfile = () => {
     const proResProfile = config_1.ConfigInternals.getProResProfile();
-    renderer_1.RenderInternals.validateSelectedCodecAndProResCombination(actualCodec, proResProfile);
     return proResProfile;
 };
-const getAndValidateImageFormat = ({ shouldOutputImageSequence, codec, pixelFormat, }) => {
-    const imageFormat = (0, image_formats_1.getImageFormat)(shouldOutputImageSequence ? undefined : codec);
-    renderer_1.RenderInternals.validateSelectedPixelFormatAndImageFormatCombination(pixelFormat, imageFormat);
-    return imageFormat;
-};
 const getAndValidateBrowser = async (browserExecutable) => {
     const browser = getBrowser();
     try {
@@ -119,26 +107,20 @@ const getAndValidateBrowser = async (browserExecutable) => {
 const getCliOptions = async (options) => {
     var _a;
     const frameRange = getAndValidateFrameRange();
-    const codec = options.type === 'get-compositions'
-        ? 'h264'
-        : await getFinalCodec({
-            isLambda: options.isLambda,
-        });
     const shouldOutputImageSequence = options.type === 'still'
         ? true
         : await getAndValidateShouldOutputImageSequence({
             frameRange,
             isLambda: options.isLambda,
+            remotionRoot: options.remotionRoot,
         });
-    const overwrite = config_1.ConfigInternals.getShouldOverwrite();
-    const crf = getAndValidateCrf(shouldOutputImageSequence, codec);
-    const pixelFormat = getAndValidatePixelFormat(codec);
-    const imageFormat = getAndValidateImageFormat({
-        shouldOutputImageSequence,
-        codec,
-        pixelFormat,
+    const overwrite = config_1.ConfigInternals.getShouldOverwrite({
+        defaultValue: !options.isLambda,
     });
-    const proResProfile = getAndValidateProResProfile(codec);
+    const crf = getCrf(shouldOutputImageSequence);
+    const videoBitrate = config_1.ConfigInternals.getVideoBitrate();
+    const pixelFormat = config_1.ConfigInternals.getPixelFormat();
+    const proResProfile = getProResProfile();
     const browserExecutable = config_1.ConfigInternals.getBrowserExecutable();
     const ffmpegExecutable = config_1.ConfigInternals.getCustomFfmpegExecutable();
     const ffprobeExecutable = config_1.ConfigInternals.getCustomFfprobeExecutable();
@@ -150,23 +132,23 @@ const getCliOptions = async (options) => {
         headless: config_1.ConfigInternals.getChromiumHeadlessMode(),
         gl: (_a = config_1.ConfigInternals.getChromiumOpenGlRenderer()) !== null && _a !== void 0 ? _a : renderer_1.RenderInternals.DEFAULT_OPENGL_RENDERER,
     };
-    const everyNthFrame = config_1.ConfigInternals.getAndValidateEveryNthFrame(codec);
-    const numberOfGifLoops = config_1.ConfigInternals.getAndValidateNumberOfGifLoops(codec);
+    const everyNthFrame = config_1.ConfigInternals.getEveryNthFrame();
+    const numberOfGifLoops = config_1.ConfigInternals.getNumberOfGifLoops();
     const concurrency = config_1.ConfigInternals.getConcurrency();
+    const height = config_1.ConfigInternals.getHeight();
+    const width = config_1.ConfigInternals.getWidth();
     renderer_1.RenderInternals.validateConcurrency(concurrency, 'concurrency');
     return {
         puppeteerTimeout: config_1.ConfigInternals.getCurrentPuppeteerTimeout(),
         concurrency,
         frameRange,
         shouldOutputImageSequence,
-        codec,
         inputProps: (0, get_input_props_1.getInputProps)(() => undefined),
-        envVariables: await (0, get_env_1.getEnvironmentVariables)(),
+        envVariables: await (0, get_env_1.getEnvironmentVariables)(() => undefined),
         quality: config_1.ConfigInternals.getQuality(),
         browser: await getAndValidateBrowser(browserExecutable),
         crf,
         pixelFormat,
-        imageFormat,
         proResProfile,
         everyNthFrame,
         numberOfGifLoops,
@@ -181,8 +163,12 @@ const getCliOptions = async (options) => {
         port: port !== null && port !== void 0 ? port : null,
         muted: config_1.ConfigInternals.getMuted(),
         enforceAudioTrack: config_1.ConfigInternals.getEnforceAudioTrack(),
-        keyboardShortcutsEnables: config_1.ConfigInternals.getKeyboardShortcutsEnabled(),
         publicDir: config_1.ConfigInternals.getPublicDir(),
+        ffmpegOverride: config_1.ConfigInternals.getFfmpegOverrideFunction(),
+        audioBitrate: config_1.ConfigInternals.getAudioBitrate(),
+        videoBitrate,
+        height,
+        width,
     };
 };
 exports.getCliOptions = getCliOptions;

package/dist/get-composition-id.d.ts

@@ -1 +1,7 @@
-export declare const getCompositionId: () => string;
+import type { TCompMetadata } from 'remotion';
+export declare const getCompositionId: (validCompositions: TCompMetadata[], args: string[]) => Promise<{
+    compositionId: string;
+    reason: string;
+    config: TCompMetadata;
+    argsAfterComposition: string[];
+}>;

package/dist/get-composition-id.js

@@ -2,13 +2,36 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCompositionId = void 0;
 const log_1 = require("./log");
-const parse_command_line_1 = require("./parse-command-line");
-const getCompositionId = () => {
-    if (!parse_command_line_1.parsedCli._[2]) {
-        log_1.Log.error('Composition ID not passed.');
-        log_1.Log.error('Pass an extra argument <composition-id>.');
-        process.exit(1);
+const select_composition_1 = require("./select-composition");
+const getCompositionId = async (validCompositions, args) => {
+    const [compName, ...remainingArgs] = args;
+    if (compName) {
+        const config = validCompositions.find((c) => c.id === compName);
+        if (!config) {
+            throw new Error(`Cannot find composition with ID "${compName}". Available composition: ${validCompositions
+                .map((c) => c.id)
+                .join(', ')}`);
+        }
+        return {
+            compositionId: compName,
+            reason: 'Passed as argument',
+            config,
+            argsAfterComposition: remainingArgs,
+        };
     }
-    return parse_command_line_1.parsedCli._[2];
+    if (!process.env.CI) {
+        const { compositionId, reason } = await (0, select_composition_1.selectComposition)(validCompositions);
+        if (compositionId && typeof compositionId === 'string') {
+            return {
+                compositionId,
+                reason,
+                config: validCompositions.find((c) => c.id === compositionId),
+                argsAfterComposition: args,
+            };
+        }
+    }
+    log_1.Log.error('Composition ID not passed.');
+    log_1.Log.error('Pass an extra argument <composition-id>.');
+    process.exit(1);
 };
 exports.getCompositionId = getCompositionId;

package/dist/get-composition-with-dimension-override.d.ts

@@ -0,0 +1,12 @@
+import type { TCompMetadata } from 'remotion';
+export declare const getCompositionWithDimensionOverride: ({ validCompositions, height, width, args, }: {
+    validCompositions: TCompMetadata[];
+    height: number | null;
+    width: number | null;
+    args: string[];
+}) => Promise<{
+    compositionId: string;
+    reason: string;
+    config: TCompMetadata;
+    argsAfterComposition: string[];
+}>;

package/dist/get-composition-with-dimension-override.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCompositionWithDimensionOverride = void 0;
+const get_composition_id_1 = require("./get-composition-id");
+const getCompositionWithDimensionOverride = async ({ validCompositions, height, width, args, }) => {
+    const returnValue = await (0, get_composition_id_1.getCompositionId)(validCompositions, args);
+    return {
+        ...returnValue,
+        config: {
+            ...returnValue.config,
+            height: height !== null && height !== void 0 ? height : returnValue.config.height,
+            width: width !== null && width !== void 0 ? width : returnValue.config.width,
+        },
+    };
+};
+exports.getCompositionWithDimensionOverride = getCompositionWithDimensionOverride;

package/dist/get-env.d.ts

@@ -1 +1 @@
-export declare const getEnvironmentVariables: () => Promise<Record<string, string>>;
+export declare const getEnvironmentVariables: (onUpdate: (newProps: Record<string, string>) => void) => Promise<Record<string, string>>;