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

package/dist/compositions.js

@@ -1,49 +1,38 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.listCompositionsCommand = void 0;
 const renderer_1 = require("@remotion/renderer");
-const path_1 = __importDefault(require("path"));
+const cleanup_before_quit_1 = require("./cleanup-before-quit");
+const entry_point_1 = require("./entry-point");
 const get_cli_options_1 = require("./get-cli-options");
 const get_config_file_name_1 = require("./get-config-file-name");
 const log_1 = require("./log");
-const parse_command_line_1 = require("./parse-command-line");
+const print_compositions_1 = require("./print-compositions");
 const setup_cache_1 = require("./setup-cache");
-const max = (arr) => {
-    if (arr.length === 0) {
-        throw new Error('Array of 0 length');
-    }
-    let biggest = arr[0];
-    for (let i = 0; i < arr.length; i++) {
-        const elem = arr[i];
-        if (elem > biggest) {
-            biggest = elem;
-        }
-    }
-    return biggest;
-};
-const listCompositionsCommand = async (remotionRoot) => {
-    const file = parse_command_line_1.parsedCli._[1];
+const listCompositionsCommand = async (remotionRoot, args) => {
+    const { file, reason } = (0, entry_point_1.findEntryPoint)(args, remotionRoot);
     if (!file) {
-        log_1.Log.error('The `compositions` command requires you to specify a root file. For example');
-        log_1.Log.error('  npx remotion compositions src/index.tsx');
+        log_1.Log.error('The `compositions` command requires you to specify a entry point. For example');
+        log_1.Log.error('  npx remotion compositions src/index.ts');
         log_1.Log.error('See https://www.remotion.dev/docs/register-root for more information.');
         process.exit(1);
     }
+    log_1.Log.verbose('Entry point:', file, 'reason:', reason);
     const downloadMap = renderer_1.RenderInternals.makeDownloadMap();
-    const fullPath = path_1.default.join(process.cwd(), file);
+    (0, cleanup_before_quit_1.registerCleanupJob)(() => renderer_1.RenderInternals.cleanDownloadMap(downloadMap));
     await (0, get_config_file_name_1.loadConfig)(remotionRoot);
-    const { browserExecutable, ffmpegExecutable, ffprobeExecutable, chromiumOptions, envVariables, inputProps, puppeteerTimeout, port, } = await (0, get_cli_options_1.getCliOptions)({
+    const { browserExecutable, ffmpegExecutable, ffprobeExecutable, chromiumOptions, envVariables, inputProps, puppeteerTimeout, port, publicDir, } = await (0, get_cli_options_1.getCliOptions)({
         isLambda: false,
         type: 'get-compositions',
+        remotionRoot,
     });
     const { urlOrBundle: bundled, cleanup: cleanupBundle } = await (0, setup_cache_1.bundleOnCliOrTakeServeUrl)({
         remotionRoot,
-        fullPath,
+        fullPath: file,
         steps: ['bundling'],
+        publicDir,
     });
+    (0, cleanup_before_quit_1.registerCleanupJob)(() => cleanupBundle());
     const compositions = await (0, renderer_1.getCompositions)(bundled, {
         browserExecutable,
         ffmpegExecutable,
@@ -55,38 +44,7 @@ const listCompositionsCommand = async (remotionRoot) => {
         port,
         downloadMap,
     });
-    if (!(0, parse_command_line_1.quietFlagProvided)()) {
-        log_1.Log.info();
-        log_1.Log.info('The following compositions are available:');
-        log_1.Log.info();
-    }
-    const firstColumnLength = max(compositions.map(({ id }) => id.length)) + 4;
-    const secondColumnLength = 8;
-    const thirdColumnLength = 15;
-    if ((0, parse_command_line_1.quietFlagProvided)()) {
-        log_1.Log.info(compositions.map((c) => c.id).join(' '));
-        return;
-    }
-    log_1.Log.info(`${'Composition'.padEnd(firstColumnLength, ' ')}${'FPS'.padEnd(secondColumnLength)}${'Dimensions'.padEnd(thirdColumnLength, ' ')}Duration`);
-    log_1.Log.info(compositions
-        .map((comp) => {
-        const isStill = comp.durationInFrames === 1;
-        const dimensions = `${comp.width}x${comp.height}`;
-        const fps = isStill ? '' : comp.fps.toString();
-        const durationInSeconds = (comp.durationInFrames / comp.fps).toFixed(2);
-        const formattedDuration = isStill
-            ? 'Still'
-            : `${comp.durationInFrames} (${durationInSeconds} sec)`;
-        return [
-            comp.id.padEnd(firstColumnLength, ' '),
-            fps.padEnd(secondColumnLength, ' '),
-            dimensions.padEnd(thirdColumnLength, ' '),
-            formattedDuration,
-        ].join('');
-    })
-        .join('\n'));
-    await renderer_1.RenderInternals.cleanDownloadMap(downloadMap);
-    await cleanupBundle();
+    (0, print_compositions_1.printCompositions)(compositions);
     log_1.Log.verbose('Cleaned up', downloadMap.assetDir);
 };
 exports.listCompositionsCommand = listCompositionsCommand;

package/dist/config/audio-codec.d.ts

@@ -0,0 +1,3 @@
+import type { AudioCodec } from '@remotion/renderer';
+export declare const setAudioCodec: (audioCodec: AudioCodec | null) => void;
+export declare const getAudioCodec: () => "mp3" | "aac" | "pcm-16" | "opus" | null;

package/dist/config/audio-codec.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAudioCodec = exports.setAudioCodec = void 0;
+const renderer_1 = require("@remotion/renderer");
+let _audioCodec = null;
+const setAudioCodec = (audioCodec) => {
+    if (audioCodec === null) {
+        _audioCodec = null;
+        return;
+    }
+    if (!renderer_1.RenderInternals.validAudioCodecs.includes(audioCodec)) {
+        throw new Error(`Audio codec must be one of the following: ${renderer_1.RenderInternals.validAudioCodecs.join(', ')}, but got ${audioCodec}`);
+    }
+    _audioCodec = audioCodec;
+};
+exports.setAudioCodec = setAudioCodec;
+const getAudioCodec = () => {
+    return _audioCodec;
+};
+exports.getAudioCodec = getAudioCodec;

package/dist/config/bitrate.d.ts

@@ -0,0 +1,4 @@
+export declare const setAudioBitrate: (bitrate: string) => void;
+export declare const getAudioBitrate: () => string | null;
+export declare const setVideoBitrate: (bitrate: string) => void;
+export declare const getVideoBitrate: () => string | null;

package/dist/config/bitrate.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getVideoBitrate = exports.setVideoBitrate = exports.getAudioBitrate = exports.setAudioBitrate = void 0;
+let audioBitrate;
+const setAudioBitrate = (bitrate) => {
+    audioBitrate = bitrate;
+};
+exports.setAudioBitrate = setAudioBitrate;
+const getAudioBitrate = () => {
+    return audioBitrate;
+};
+exports.getAudioBitrate = getAudioBitrate;
+let videoBitrate;
+const setVideoBitrate = (bitrate) => {
+    videoBitrate = bitrate;
+};
+exports.setVideoBitrate = setVideoBitrate;
+const getVideoBitrate = () => {
+    return videoBitrate;
+};
+exports.getVideoBitrate = getVideoBitrate;

package/dist/config/concurrency.d.ts

@@ -1,3 +1,3 @@
-export declare type Concurrency = number | null;
+export declare type Concurrency = number | string | null;
 export declare const setConcurrency: (newConcurrency: Concurrency) => void;
-export declare const getConcurrency: () => number | null;
+export declare const getConcurrency: () => string | number | null;

package/dist/config/crf.d.ts

@@ -1,4 +1,3 @@
-import type { Codec, Crf } from '@remotion/renderer';
+import type { Crf } from '@remotion/renderer';
 export declare const setCrf: (newCrf: Crf) => void;
 export declare const getCrfOrUndefined: () => Crf;
-export declare const getActualCrf: (codec: Codec) => number;

package/dist/config/crf.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getActualCrf = exports.getCrfOrUndefined = exports.setCrf = void 0;
-const renderer_1 = require("@remotion/renderer");
+exports.getCrfOrUndefined = exports.setCrf = void 0;
 let currentCrf;
 const setCrf = (newCrf) => {
     if (typeof newCrf !== 'number' && newCrf !== undefined) {
@@ -14,10 +13,3 @@ const getCrfOrUndefined = () => {
     return currentCrf;
 };
 exports.getCrfOrUndefined = getCrfOrUndefined;
-const getActualCrf = (codec) => {
-    var _a;
-    const crf = (_a = (0, exports.getCrfOrUndefined)()) !== null && _a !== void 0 ? _a : renderer_1.RenderInternals.getDefaultCrfForCodec(codec);
-    renderer_1.RenderInternals.validateSelectedCrfAndCodecCombination(crf, codec);
-    return crf;
-};
-exports.getActualCrf = getActualCrf;

package/dist/config/enforce-audio-track.d.ts

@@ -0,0 +1,2 @@
+export declare const setEnforceAudioTrack: (enforceAudioTrack: boolean) => void;
+export declare const getEnforceAudioTrack: () => boolean;

package/dist/config/enforce-audio-track.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEnforceAudioTrack = exports.setEnforceAudioTrack = void 0;
+const DEFAULT_ENFORCE_AUDIO_TRACK = true;
+let enforceAudioTrackState = DEFAULT_ENFORCE_AUDIO_TRACK;
+const setEnforceAudioTrack = (enforceAudioTrack) => {
+    enforceAudioTrackState = enforceAudioTrack;
+};
+exports.setEnforceAudioTrack = setEnforceAudioTrack;
+const getEnforceAudioTrack = () => {
+    return enforceAudioTrackState;
+};
+exports.getEnforceAudioTrack = getEnforceAudioTrack;

package/dist/config/entry-point.d.ts

@@ -0,0 +1,2 @@
+export declare const setEntryPoint: (ep: string) => void;
+export declare const getEntryPoint: () => string | null;

package/dist/config/entry-point.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEntryPoint = exports.setEntryPoint = void 0;
+let entryPoint = null;
+const setEntryPoint = (ep) => {
+    entryPoint = ep;
+};
+exports.setEntryPoint = setEntryPoint;
+const getEntryPoint = () => {
+    return entryPoint;
+};
+exports.getEntryPoint = getEntryPoint;

package/dist/config/every-nth-frame.d.ts

@@ -1,3 +1,2 @@
-import type { Codec } from '@remotion/renderer';
 export declare const setEveryNthFrame: (frame: number) => void;
-export declare const getAndValidateEveryNthFrame: (codec: Codec) => number;
+export declare const getEveryNthFrame: () => number;

package/dist/config/every-nth-frame.js

@@ -1,20 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAndValidateEveryNthFrame = exports.setEveryNthFrame = void 0;
-const renderer_1 = require("@remotion/renderer");
+exports.getEveryNthFrame = exports.setEveryNthFrame = void 0;
 let everyNthFrame = 1;
 const setEveryNthFrame = (frame) => {
-    renderer_1.RenderInternals.validateEveryNthFrame(frame);
     everyNthFrame = frame;
 };
 exports.setEveryNthFrame = setEveryNthFrame;
-const getAndValidateEveryNthFrame = (codec) => {
-    if (everyNthFrame === 1) {
-        return everyNthFrame;
-    }
-    if (codec !== 'gif') {
-        throw new Error(`"everyNthFrame" can only be set if "codec" is set to "gif". The codec is "${codec}"`);
-    }
+const getEveryNthFrame = () => {
     return everyNthFrame;
 };
-exports.getAndValidateEveryNthFrame = getAndValidateEveryNthFrame;
+exports.getEveryNthFrame = getEveryNthFrame;

package/dist/config/ffmpeg-override.d.ts

@@ -0,0 +1,3 @@
+import type { FfmpegOverrideFn } from '@remotion/renderer';
+export declare const setFfmpegOverrideFunction: (fn: FfmpegOverrideFn) => void;
+export declare const getFfmpegOverrideFunction: () => FfmpegOverrideFn;

package/dist/config/ffmpeg-override.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFfmpegOverrideFunction = exports.setFfmpegOverrideFunction = void 0;
+let ffmpegOverrideFn = ({ args }) => args;
+const setFfmpegOverrideFunction = (fn) => {
+    ffmpegOverrideFn = fn;
+};
+exports.setFfmpegOverrideFunction = setFfmpegOverrideFunction;
+const getFfmpegOverrideFunction = () => {
+    return ffmpegOverrideFn;
+};
+exports.getFfmpegOverrideFunction = getFfmpegOverrideFunction;

package/dist/config/height.d.ts

@@ -0,0 +1,2 @@
+export declare const overrideHeight: (newHeight: number) => void;
+export declare const getHeight: () => number | null;

package/dist/config/height.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getHeight = exports.overrideHeight = void 0;
+const remotion_1 = require("remotion");
+let specifiedHeight;
+const overrideHeight = (newHeight) => {
+    remotion_1.Internals.validateDimension(newHeight, 'height', 'passed to `overrideHeight()`');
+    specifiedHeight = newHeight;
+};
+exports.overrideHeight = overrideHeight;
+const getHeight = () => {
+    return specifiedHeight;
+};
+exports.getHeight = getHeight;

package/dist/config/image-format.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getUserPreferredImageFormat = exports.setImageFormat = void 0;
 const renderer_1 = require("@remotion/renderer");
+const truthy_1 = require("../truthy");
 let currentImageFormat;
 const setImageFormat = (format) => {
     if (typeof format === 'undefined') {
@@ -9,7 +10,13 @@ const setImageFormat = (format) => {
         return;
     }
     if (!renderer_1.RenderInternals.validImageFormats.includes(format)) {
-        throw new TypeError(`Value ${format} is not valid as an image format.`);
+        throw new TypeError([
+            `Value ${format} is not valid as an image format.`,
+            // @ts-expect-error
+            format === 'jpg' ? 'Did you mean "jpeg"?' : null,
+        ]
+            .filter(truthy_1.truthy)
+            .join(' '));
     }
     currentImageFormat = format;
 };

package/dist/config/index.d.ts

@@ -10,10 +10,11 @@ export declare const ConfigInternals: {
     getOutputCodecOrUndefined: () => import("@remotion/renderer").CodecOrUndefined;
     getCustomFfmpegExecutable: () => import("@remotion/renderer").FfmpegExecutable;
     getBrowser: () => import("@remotion/renderer").Browser | null;
-    getActualCrf: (codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif") => number;
     getPixelFormat: () => "yuv420p" | "yuva420p" | "yuv422p" | "yuv444p" | "yuv420p10le" | "yuv422p10le" | "yuv444p10le" | "yuva444p10le";
     getProResProfile: () => "4444-xq" | "4444" | "hq" | "standard" | "light" | "proxy" | undefined;
-    getShouldOverwrite: () => boolean;
+    getShouldOverwrite: ({ defaultValue, }: {
+        defaultValue: boolean;
+    }) => boolean;
     getBrowserExecutable: () => import("@remotion/renderer").BrowserExecutable;
     getCustomFfprobeExecutable: () => import("@remotion/renderer").FfmpegExecutable;
     getScale: () => number;
@@ -22,11 +23,11 @@ export declare const ConfigInternals: {
     getIgnoreCertificateErrors: () => boolean;
     getChromiumHeadlessMode: () => boolean;
     getChromiumOpenGlRenderer: () => "swangle" | "angle" | "egl" | "swiftshader" | null;
-    getAndValidateEveryNthFrame: (codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif") => number;
-    getAndValidateNumberOfGifLoops: (codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif") => number | null;
-    getConcurrency: () => number | null;
+    getEveryNthFrame: () => number;
+    getConcurrency: () => string | number | null;
     getCurrentPuppeteerTimeout: () => number;
     getQuality: () => number | undefined;
+    getAudioCodec: () => "mp3" | "aac" | "pcm-16" | "opus" | null;
     getStillFrame: () => number;
     getShouldOutputImageSequence: (frameRange: import("@remotion/renderer").FrameRange | null) => boolean;
     getDotEnvLocation: () => string | null;
@@ -39,5 +40,22 @@ export declare const ConfigInternals: {
     setStillFrame: (frame: number) => void;
     getMaxTimelineTracks: () => number;
     defaultOverrideFunction: WebpackOverrideFn;
+    setMuted: (muted: boolean) => void;
+    getMuted: () => boolean;
+    getEnforceAudioTrack: () => boolean;
+    setEnforceAudioTrack: (enforceAudioTrack: boolean) => void;
+    getKeyboardShortcutsEnabled: () => boolean;
+    getPublicDir: () => string | null;
+    getFfmpegOverrideFunction: () => import("@remotion/renderer").FfmpegOverrideFn;
+    getAudioBitrate: () => string | null;
+    getVideoBitrate: () => string | null;
+    getHeight: () => number | null;
+    getWidth: () => number | null;
+    getCrfOrUndefined: () => import("@remotion/renderer").Crf;
+    getEntryPoint: () => string | null;
+    getNumberOfGifLoops: () => import("./number-of-gif-loops").Loop;
+    getWebpackPolling: () => number | null;
+    getShouldOpenBrowser: () => boolean;
+    getChromiumUserAgent: () => string | null;
 };
 export declare const overrideRemotion: () => void;