@remotion/cli 3.2.25 → 3.2.26-crf.18

package/dist/preview.js

@@ -9,7 +9,6 @@ const path_1 = __importDefault(require("path"));
 const config_1 = require("./config");
 const get_env_1 = require("./get-env");
 const get_input_props_1 = require("./get-input-props");
-const initialize_render_cli_1 = require("./initialize-render-cli");
 const log_1 = require("./log");
 const parse_command_line_1 = require("./parse-command-line");
 const start_server_1 = require("./preview-server/start-server");
@@ -40,7 +39,6 @@ const previewCommand = async (remotionRoot) => {
     }
     const { port: desiredPort } = parse_command_line_1.parsedCli;
     const fullPath = path_1.default.join(process.cwd(), file);
-    await (0, initialize_render_cli_1.initializeRenderCli)(remotionRoot, 'preview');
     let inputProps = (0, get_input_props_1.getInputProps)((newProps) => {
         waitForLiveEventsListener().then((listener) => {
             inputProps = newProps;
@@ -50,10 +48,18 @@ const previewCommand = async (remotionRoot) => {
             });
         });
     });
-    const envVariables = await (0, get_env_1.getEnvironmentVariables)();
+    let envVariables = await (0, get_env_1.getEnvironmentVariables)((newEnvVariables) => {
+        waitForLiveEventsListener().then((listener) => {
+            envVariables = newEnvVariables;
+            listener.sendEventToClient({
+                type: 'new-env-variables',
+                newEnvVariables,
+            });
+        });
+    });
     const { port, liveEventsServer } = await (0, start_server_1.startServer)(path_1.default.resolve(__dirname, 'previewEntry.js'), fullPath, {
         getCurrentInputProps: () => inputProps,
-        envVariables,
+        getEnvVariables: () => envVariables,
         port: desiredPort,
         maxTimelineTracks: config_1.ConfigInternals.getMaxTimelineTracks(),
         remotionRoot,

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,7 +19,7 @@ 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'],
@@ -40,7 +40,7 @@ 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)'],
@@ -59,6 +59,9 @@ 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();

package/dist/progress-bar.js

@@ -34,7 +34,9 @@ const makeBundlingProgress = ({ progress, steps, doneIn, }) => [
     doneIn === null
         ? (progress * 100).toFixed(0) + '%'
         : chalk_1.chalk.gray(`${doneIn}ms`),
-].join(' ');
+]
+    .filter(truthy_1.truthy)
+    .join(' ');
 exports.makeBundlingProgress = makeBundlingProgress;
 const makeRenderingProgress = ({ frames, totalFrames, steps, concurrency, doneIn, }) => {
     const progress = frames / totalFrames;

package/dist/render.js

@@ -15,11 +15,12 @@ const config_1 = require("./config");
 const get_cli_options_1 = require("./get-cli-options");
 const get_composition_id_1 = require("./get-composition-id");
 const get_filename_1 = require("./get-filename");
-const initialize_render_cli_1 = require("./initialize-render-cli");
+const get_render_media_options_1 = require("./get-render-media-options");
 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 user_passed_output_location_1 = require("./user-passed-output-location");
 const validate_ffmpeg_version_1 = require("./validate-ffmpeg-version");
 const render = async (remotionRoot) => {
     const startTime = Date.now();
@@ -34,11 +35,20 @@ const render = async (remotionRoot) => {
         ? file
         : path_1.default.join(process.cwd(), file);
     const downloadMap = renderer_1.RenderInternals.makeDownloadMap();
-    await (0, initialize_render_cli_1.initializeRenderCli)(remotionRoot, 'sequence');
+    if (parse_command_line_1.parsedCli.frame) {
+        log_1.Log.error('--frame flag was passed to the `render` command. This flag only works with the `still` command. Did you mean `--frames`? See reference: https://www.remotion.dev/docs/cli/');
+        process.exit(1);
+    }
     log_1.Log.verbose('Asset dirs', downloadMap.assetDir);
-    const { codec, proResProfile, concurrency, frameRange, shouldOutputImageSequence, overwrite, inputProps, envVariables, quality, browser, crf, pixelFormat, imageFormat, browserExecutable, ffmpegExecutable, ffprobeExecutable, scale, chromiumOptions, port, numberOfGifLoops, everyNthFrame, puppeteerTimeout, muted, enforceAudioTrack, publicDir, ffmpegOverride, } = await (0, get_cli_options_1.getCliOptions)({
+    const { codec, reason: codecReason } = (0, get_cli_options_1.getFinalCodec)({
+        downloadName: null,
+        outName: (0, user_passed_output_location_1.getUserPassedOutputLocation)(),
+    });
+    (0, get_cli_options_1.validateFfmpegCanUseCodec)(codec);
+    const { concurrency, frameRange, shouldOutputImageSequence, overwrite, inputProps, envVariables, quality, browser, imageFormat, browserExecutable, ffmpegExecutable, ffprobeExecutable, scale, chromiumOptions, port, everyNthFrame, puppeteerTimeout, publicDir, } = await (0, get_cli_options_1.getCliOptions)({
         isLambda: false,
         type: 'series',
+        codec,
     });
     const relativeOutputLocation = (0, get_filename_1.getOutputFilename)({
         codec,
@@ -48,7 +58,7 @@ const render = async (remotionRoot) => {
     });
     const absoluteOutputFile = (0, get_cli_options_1.getAndValidateAbsoluteOutputFile)(relativeOutputLocation, overwrite);
     const compositionId = (0, get_composition_id_1.getCompositionId)();
-    log_1.Log.info(chalk_1.chalk.gray(`Composition = ${compositionId}, Codec = ${codec}, Output = ${relativeOutputLocation}`));
+    log_1.Log.info(chalk_1.chalk.gray(`Composition = ${compositionId}, Codec = ${codec} (${codecReason}), Output = ${relativeOutputLocation}`));
     log_1.Log.verbose('Browser executable: ', browserExecutable);
     await (0, validate_ffmpeg_version_1.checkAndValidateFfmpegVersion)({
         ffmpegExecutable,
@@ -93,10 +103,11 @@ const render = async (remotionRoot) => {
         inputProps,
         puppeteerInstance,
         envVariables,
-        timeoutInMilliseconds: config_1.ConfigInternals.getCurrentPuppeteerTimeout(),
+        timeoutInMilliseconds: puppeteerTimeout,
         chromiumOptions,
         browserExecutable,
         downloadMap,
+        port,
     });
     const config = comps.find((c) => c.id === compositionId);
     if (!config) {
@@ -197,17 +208,14 @@ const render = async (remotionRoot) => {
         log_1.Log.info(chalk_1.chalk.green('\nYour image sequence is ready!'));
         return;
     }
-    await (0, renderer_1.renderMedia)({
+    const options = await (0, get_render_media_options_1.getRenderMediaOptions)({
+        config,
         outputLocation: absoluteOutputFile,
+        serveUrl: urlOrBundle,
         codec,
-        composition: config,
-        crf,
-        envVariables,
-        ffmpegExecutable,
-        ffprobeExecutable,
-        frameRange,
-        imageFormat,
-        inputProps,
+    });
+    await (0, renderer_1.renderMedia)({
+        ...options,
         onProgress: (update) => {
             encodedDoneIn = update.encodedDoneIn;
             encodedFrames = update.encodedFrames;
@@ -217,26 +225,8 @@ const render = async (remotionRoot) => {
             updateRenderProgress();
         },
         puppeteerInstance,
-        overwrite,
-        concurrency,
-        pixelFormat,
-        proResProfile,
-        quality,
-        serveUrl: urlOrBundle,
         onDownload,
-        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'),
         downloadMap,
-        muted,
-        enforceAudioTrack,
-        browserExecutable,
-        ffmpegOverride,
     });
     log_1.Log.info();
     log_1.Log.info();

package/dist/still.js

@@ -9,9 +9,9 @@ const fs_1 = require("fs");
 const path_1 = __importDefault(require("path"));
 const chalk_1 = require("./chalk");
 const config_1 = require("./config");
+const determine_image_format_1 = require("./determine-image-format");
 const get_cli_options_1 = require("./get-cli-options");
 const get_composition_id_1 = require("./get-composition-id");
-const initialize_render_cli_1 = require("./initialize-render-cli");
 const log_1 = require("./log");
 const parse_command_line_1 = require("./parse-command-line");
 const progress_bar_1 = require("./progress-bar");
@@ -19,46 +19,36 @@ const setup_cache_1 = require("./setup-cache");
 const truthy_1 = require("./truthy");
 const user_passed_output_location_1 = require("./user-passed-output-location");
 const still = async (remotionRoot) => {
+    var _a, _b;
     const startTime = Date.now();
     const file = parse_command_line_1.parsedCli._[1];
     const fullPath = renderer_1.RenderInternals.isServeUrl(file)
         ? file
         : path_1.default.join(process.cwd(), file);
-    await (0, initialize_render_cli_1.initializeRenderCli)(remotionRoot, 'still');
-    const userPassedOutput = (0, user_passed_output_location_1.getUserPassedOutputLocation)();
-    if ((userPassedOutput === null || userPassedOutput === void 0 ? void 0 : userPassedOutput.endsWith('.jpeg')) ||
-        (userPassedOutput === null || userPassedOutput === void 0 ? void 0 : userPassedOutput.endsWith('.jpg'))) {
-        log_1.Log.verbose('Output file has a JPEG extension, setting the image format to JPEG.');
-        config_1.Config.Rendering.setImageFormat('jpeg');
-    }
-    if (userPassedOutput === null || userPassedOutput === void 0 ? void 0 : userPassedOutput.endsWith('.png')) {
-        log_1.Log.verbose('Output file has a PNG extension, setting the image format to PNG.');
-        config_1.Config.Rendering.setImageFormat('png');
+    if (parse_command_line_1.parsedCli.frames) {
+        log_1.Log.error('--frames flag was passed to the `still` command. This flag only works with the `render` command. Did you mean `--frame`? See reference: https://www.remotion.dev/docs/cli/');
+        process.exit(1);
     }
-    const { inputProps, envVariables, quality, browser, imageFormat, stillFrame, browserExecutable, chromiumOptions, scale, ffmpegExecutable, ffprobeExecutable, overwrite, puppeteerTimeout, port, publicDir, } = await (0, get_cli_options_1.getCliOptions)({
+    const { inputProps, envVariables, quality, browser, stillFrame, browserExecutable, chromiumOptions, scale, ffmpegExecutable, ffprobeExecutable, overwrite, puppeteerTimeout, port, publicDir, } = await (0, get_cli_options_1.getCliOptions)({
         isLambda: false,
         type: 'still',
+        codec: 'h264',
     });
     log_1.Log.verbose('Browser executable: ', browserExecutable);
     const compositionId = (0, get_composition_id_1.getCompositionId)();
+    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: (_b = config_1.ConfigInternals.getUserPreferredImageFormat()) !== null && _b !== void 0 ? _b : null,
+        downloadName: null,
+        outName: (0, user_passed_output_location_1.getUserPassedOutputLocation)(),
+        isLambda: false,
+    });
     const relativeOutputLocation = (0, user_passed_output_location_1.getOutputLocation)({
         compositionId,
         defaultExtension: imageFormat,
     });
     const absoluteOutputLocation = (0, get_cli_options_1.getAndValidateAbsoluteOutputFile)(relativeOutputLocation, overwrite);
-    log_1.Log.info(chalk_1.chalk.gray(`Output = ${relativeOutputLocation}, Format = ${imageFormat}, Composition = ${compositionId}`));
-    if (imageFormat === 'none') {
-        log_1.Log.error('No image format was selected - this is probably an error in Remotion - please post your command on Github Issues for help.');
-        process.exit(1);
-    }
-    if (imageFormat === 'png' && !absoluteOutputLocation.endsWith('.png')) {
-        log_1.Log.warn(`Rendering a PNG, expected a .png extension but got ${absoluteOutputLocation}`);
-    }
-    if (imageFormat === 'jpeg' &&
-        !absoluteOutputLocation.endsWith('.jpg') &&
-        !absoluteOutputLocation.endsWith('.jpeg')) {
-        log_1.Log.warn(`Rendering a JPEG, expected a .jpg or .jpeg extension but got ${absoluteOutputLocation}`);
-    }
+    log_1.Log.info(chalk_1.chalk.gray(`Output = ${relativeOutputLocation}, Format = ${imageFormat} (${source}), Composition = ${compositionId}`));
     const browserInstance = (0, renderer_1.openBrowser)(browser, {
         browserExecutable,
         chromiumOptions,

package/dist/validate-image-format.d.ts

@@ -0,0 +1,2 @@
+import type { ImageFormat } from '@remotion/renderer';
+export declare const validateImageFormat: (imageFormat: ImageFormat, outName: string | null) => void;

package/dist/validate-image-format.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateImageFormat = void 0;
+const log_1 = require("./log");
+const validateImageFormat = (imageFormat, outName) => {
+    if (imageFormat === 'png' && (outName === null || outName === void 0 ? void 0 : outName.endsWith('.png'))) {
+        log_1.Log.warn(`Rendering a PNG, expected a .png extension but got ${outName}`);
+    }
+    if (imageFormat === 'jpeg' &&
+        !(outName === null || outName === void 0 ? void 0 : outName.endsWith('.jpg')) &&
+        !(outName === null || outName === void 0 ? void 0 : outName.endsWith('.jpeg'))) {
+        log_1.Log.warn(`Rendering a JPEG, expected a .jpg or .jpeg extension but got ${outName}`);
+    }
+};
+exports.validateImageFormat = validateImageFormat;

package/dist/versions.js

@@ -68,7 +68,7 @@ const validateVersionsBeforeCommand = async (remotionRoot) => {
 };
 exports.validateVersionsBeforeCommand = validateVersionsBeforeCommand;
 const versionsCommand = async (remotionRoot) => {
-    (0, parse_command_line_1.parseCommandLine)('versions');
+    (0, parse_command_line_1.parseCommandLine)();
     const versions = await getAllVersions(remotionRoot);
     const grouped = groupBy(versions);
     const installedVersions = Object.keys(grouped);

package/dist/webpack-cache.d.ts

@@ -0,0 +1,12 @@
+declare type Environment = 'development' | 'production';
+declare global {
+    namespace NodeJS {
+        interface ProcessVersions {
+            pnp?: string;
+        }
+    }
+}
+export declare const clearCache: (environment: Environment, inputProps: object | null) => Promise<void>;
+export declare const getWebpackCacheName: (environment: Environment, inputProps: object | null) => string;
+export declare const cacheExists: (environment: Environment, inputProps: object | null) => boolean;
+export {};

package/dist/webpack-cache.js

@@ -0,0 +1,66 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cacheExists = exports.getWebpackCacheName = exports.clearCache = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const remotion_1 = require("remotion");
+// Inlined from https://github.com/webpack/webpack/blob/4c2ee7a4ddb8db2362ca83b6c4190523387ba7ee/lib/config/defaults.js#L265
+// An algorithm to determine where Webpack will cache the depencies
+const getWebpackCacheDir = () => {
+    const cwd = process.cwd();
+    let dir = cwd;
+    for (;;) {
+        try {
+            if (fs_1.default.statSync(path_1.default.join(dir, 'package.json')).isFile()) {
+                break;
+            }
+            // eslint-disable-next-line no-empty
+        }
+        catch (e) { }
+        const parent = path_1.default.dirname(dir);
+        if (dir === parent) {
+            dir = undefined;
+            break;
+        }
+        dir = parent;
+    }
+    if (!dir) {
+        return path_1.default.resolve(cwd, '.cache/webpack');
+    }
+    if (process.versions.pnp === '1') {
+        return path_1.default.resolve(dir, '.pnp/.cache/webpack');
+    }
+    if (process.versions.pnp === '3') {
+        return path_1.default.resolve(dir, '.yarn/.cache/webpack');
+    }
+    return path_1.default.resolve(dir, 'node_modules/.cache/webpack');
+};
+const remotionCacheLocation = (environment, inputProps) => {
+    return path_1.default.join(getWebpackCacheDir(), (0, exports.getWebpackCacheName)(environment, inputProps));
+};
+const clearCache = (environment, inputProps) => {
+    var _a;
+    return ((_a = fs_1.default.promises.rm) !== null && _a !== void 0 ? _a : fs_1.default.promises.rmdir)(remotionCacheLocation(environment, inputProps), {
+        recursive: true,
+    });
+};
+exports.clearCache = clearCache;
+const getWebpackCacheName = (environment, inputProps) => {
+    // In development, let's reset the cache when input props
+    // are changing, because they are injected using Webpack and if changed,
+    // it will get the cached version
+    if (environment === 'development') {
+        return `remotion-v3-${environment}-${(0, remotion_1.random)(JSON.stringify(inputProps))}`;
+    }
+    // In production, the cache is independent from input props because
+    // they are passed over URL params. Speed is mostly important in production.
+    return `remotion-v3-${environment}`;
+};
+exports.getWebpackCacheName = getWebpackCacheName;
+const cacheExists = (environment, inputProps) => {
+    return fs_1.default.existsSync(remotionCacheLocation(environment, inputProps));
+};
+exports.cacheExists = cacheExists;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@remotion/cli",
-	"version": "3.2.25",
+	"version": "3.2.26-crf.18+b22217116",
 	"description": "CLI for Remotion",
 	"main": "dist/index.js",
 	"sideEffects": false,
@@ -23,15 +23,15 @@
 	"author": "Jonny Burger <jonny@remotion.dev>",
 	"license": "SEE LICENSE IN LICENSE.md",
 	"dependencies": {
-		"@remotion/bundler": "3.2.25",
-		"@remotion/media-utils": "3.2.25",
-		"@remotion/player": "3.2.25",
-		"@remotion/renderer": "3.2.25",
+		"@remotion/bundler": "3.2.26-crf.18+b22217116",
+		"@remotion/media-utils": "3.2.26-crf.18+b22217116",
+		"@remotion/player": "3.2.26-crf.18+b22217116",
+		"@remotion/renderer": "3.2.26-crf.18+b22217116",
 		"better-opn": "2.1.1",
 		"dotenv": "9.0.2",
 		"memfs": "3.4.3",
 		"minimist": "1.2.6",
-		"remotion": "3.2.25",
+		"remotion": "3.2.26-crf.18+b22217116",
 		"semver": "7.3.5",
 		"source-map": "0.6.1"
 	},
@@ -71,5 +71,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "8e51d998e16f062336d65469cbfc9266068b7701"
+	"gitHead": "b222171164aefac1d44e1ad9e08231e9bad9a029"
 }