@remotion/cli 3.0.31 → 3.1.0

package/dist/compositions.js

@@ -35,7 +35,7 @@ const listCompositionsCommand = async () => {
     const fullPath = path_1.default.join(process.cwd(), file);
     await (0, get_config_file_name_1.loadConfig)();
     const { browserExecutable, ffmpegExecutable, ffprobeExecutable, chromiumOptions, envVariables, inputProps, puppeteerTimeout, port, } = await (0, get_cli_options_1.getCliOptions)({ isLambda: false, type: 'get-compositions' });
-    const bundled = await (0, setup_cache_1.bundleOnCli)(fullPath, ['bundling']);
+    const bundled = await (0, setup_cache_1.bundleOnCli)({ fullPath, steps: ['bundling'] });
     const compositions = await (0, renderer_1.getCompositions)(bundled, {
         browserExecutable,
         ffmpegExecutable,
@@ -46,12 +46,18 @@ const listCompositionsCommand = async () => {
         timeoutInMilliseconds: puppeteerTimeout,
         port,
     });
-    log_1.Log.info();
-    log_1.Log.info('The following compositions are available:');
-    log_1.Log.info();
+    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) => {

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

@@ -8,7 +8,7 @@ export declare const getCliOptions: (options: {
     parallelism: number | null;
     frameRange: FrameRange | null;
     shouldOutputImageSequence: boolean;
-    codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv";
+    codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif";
     overwrite: boolean;
     inputProps: object;
     envVariables: Record<string, string>;
@@ -19,6 +19,8 @@ export declare const getCliOptions: (options: {
     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;
     stillFrame: number;
     browserExecutable: BrowserExecutable;
     ffmpegExecutable: import("remotion").FfmpegExecutable;

package/dist/get-cli-options.js

@@ -152,6 +152,8 @@ const getCliOptions = async (options) => {
         headless: remotion_1.Internals.getChromiumHeadlessMode(),
         gl: (_a = remotion_1.Internals.getChromiumOpenGlRenderer()) !== null && _a !== void 0 ? _a : remotion_1.Internals.DEFAULT_OPENGL_RENDERER,
     };
+    const everyNthFrame = remotion_1.Internals.getAndValidateEveryNthFrame(codec);
+    const numberOfGifLoops = remotion_1.Internals.getAndValidateNumberOfGifLoops(codec);
     const parallelism = remotion_1.Internals.getConcurrency();
     renderer_1.RenderInternals.validateConcurrency(parallelism, 'concurrency');
     return {
@@ -172,6 +174,8 @@ const getCliOptions = async (options) => {
         pixelFormat,
         imageFormat,
         proResProfile,
+        everyNthFrame,
+        numberOfGifLoops,
         stillFrame: remotion_1.Internals.getStillFrame(),
         browserExecutable,
         ffmpegExecutable,

package/dist/image-formats.js

@@ -15,7 +15,8 @@ const getImageFormat = (codec) => {
         codec === 'h265' ||
         codec === 'vp8' ||
         codec === 'vp9' ||
-        codec === 'prores') {
+        codec === 'prores' ||
+        codec === 'gif') {
         return 'jpeg';
     }
     if (codec === undefined) {

package/dist/index.d.ts

@@ -74,7 +74,7 @@ export declare const CliInternals: {
         parallelism: number | null;
         frameRange: import("remotion").FrameRange | null;
         shouldOutputImageSequence: boolean;
-        codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv";
+        codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif";
         overwrite: boolean;
         inputProps: object;
         envVariables: Record<string, string>;
@@ -85,6 +85,8 @@ export declare const CliInternals: {
         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;
         stillFrame: number;
         browserExecutable: import("remotion").BrowserExecutable;
         ffmpegExecutable: import("remotion").FfmpegExecutable;

package/dist/parse-command-line.d.ts

@@ -11,6 +11,8 @@ export declare type CommandLineOptions = {
     ['env-file']: string;
     ['ignore-certificate-errors']: string;
     ['disable-web-security']: string;
+    ['every-nth-frame']: number;
+    ['number-of-gif-loops']: number;
     codec: Codec;
     concurrency: number;
     timeout: number;

package/dist/parse-command-line.js

@@ -42,6 +42,9 @@ const parseCommandLine = (type) => {
     if (exports.parsedCli['ffmpeg-executable']) {
         remotion_1.Config.Rendering.setFfmpegExecutable((0, path_1.resolve)(exports.parsedCli['ffmpeg-executable']));
     }
+    if (exports.parsedCli['number-of-gif-loops']) {
+        remotion_1.Config.Rendering.setNumberOfGifLoops(exports.parsedCli['number-of-gif-loops']);
+    }
     if (exports.parsedCli['ffprobe-executable']) {
         remotion_1.Config.Rendering.setFfprobeExecutable((0, path_1.resolve)(exports.parsedCli['ffprobe-executable']));
     }
@@ -57,9 +60,6 @@ const parseCommandLine = (type) => {
     if (exports.parsedCli['disable-headless']) {
         remotion_1.Config.Puppeteer.setChromiumHeadlessMode(false);
     }
-    if (exports.parsedCli.gl) {
-        remotion_1.Config.Puppeteer.setChromiumOpenGlRenderer(exports.parsedCli.gl);
-    }
     if (exports.parsedCli.log) {
         if (!remotion_1.Internals.Logging.isValidLogLevel(exports.parsedCli.log)) {
             log_1.Log.error('Invalid `--log` value passed.');
@@ -104,6 +104,12 @@ const parseCommandLine = (type) => {
     if (exports.parsedCli.codec) {
         remotion_1.Config.Output.setCodec(exports.parsedCli.codec);
     }
+    if (exports.parsedCli['every-nth-frame']) {
+        remotion_1.Config.Rendering.setEveryNthFrame(exports.parsedCli['every-nth-frame']);
+    }
+    if (exports.parsedCli.gl) {
+        remotion_1.Config.Puppeteer.setChromiumOpenGlRenderer(exports.parsedCli.gl);
+    }
     if (exports.parsedCli['prores-profile']) {
         remotion_1.Config.Output.setProResProfile(String(exports.parsedCli['prores-profile']));
     }

package/dist/progress-bar.d.ts

@@ -1,4 +1,5 @@
 import type { StitchingState } from '@remotion/renderer';
+import type { Codec } from 'remotion';
 import type { RenderStep } from './step';
 export declare const createProgressBar: (quiet: boolean) => {
     update: (str: string) => boolean;
@@ -25,8 +26,9 @@ declare type StitchingProgressInput = {
     steps: RenderStep[];
     doneIn: number | null;
     stage: StitchingState;
+    codec: Codec;
 };
-export declare const makeStitchingProgress: ({ frames, totalFrames, steps, doneIn, stage, }: StitchingProgressInput) => string;
+export declare const makeStitchingProgress: ({ frames, totalFrames, steps, doneIn, stage, codec, }: StitchingProgressInput) => string;
 export declare type DownloadProgress = {
     name: string;
     id: number;

package/dist/progress-bar.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeRenderingAndStitchingProgress = exports.makeStitchingProgress = exports.makeRenderingProgress = exports.makeBundlingProgress = exports.createOverwriteableCliOutput = exports.createProgressBar = void 0;
+const renderer_1 = require("@remotion/renderer");
 const remotion_1 = require("remotion");
 const ansi_diff_1 = require("./ansi/ansi-diff");
 const chalk_1 = require("./chalk");
@@ -46,14 +47,14 @@ const makeRenderingProgress = ({ frames, totalFrames, steps, concurrency, doneIn
     ].join(' ');
 };
 exports.makeRenderingProgress = makeRenderingProgress;
-const makeStitchingProgress = ({ frames, totalFrames, steps, doneIn, stage, }) => {
+const makeStitchingProgress = ({ frames, totalFrames, steps, doneIn, stage, codec, }) => {
     const progress = frames / totalFrames;
     return [
         `(${steps.indexOf('stitching') + 1}/${steps.length})`,
         (0, make_progress_bar_1.makeProgressBar)(progress),
-        stage === 'muxing'
+        stage === 'muxing' && renderer_1.RenderInternals.canUseParallelEncoding(codec)
             ? `${doneIn ? 'Muxed' : 'Muxing'} audio`
-            : `${doneIn ? 'Encoded' : 'Encoding'} video`,
+            : `${doneIn ? 'Encoded' : 'Encoding'} ${codec === 'gif' ? 'GIF' : 'video'}`,
         doneIn === null ? `${frames}/${totalFrames}` : chalk_1.chalk.gray(`${doneIn}ms`),
     ].join(' ');
 };

package/dist/render.js

@@ -31,7 +31,7 @@ const render = async () => {
         ? file
         : path_1.default.join(process.cwd(), file);
     await (0, initialize_render_cli_1.initializeRenderCli)('sequence');
-    const { codec, proResProfile, parallelism, frameRange, shouldOutputImageSequence, absoluteOutputFile, overwrite, inputProps, envVariables, quality, browser, crf, pixelFormat, imageFormat, browserExecutable, ffmpegExecutable, ffprobeExecutable, scale, chromiumOptions, port, puppeteerTimeout, } = await (0, get_cli_options_1.getCliOptions)({ isLambda: false, type: 'series' });
+    const { codec, proResProfile, parallelism, frameRange, shouldOutputImageSequence, absoluteOutputFile, overwrite, inputProps, envVariables, quality, browser, crf, pixelFormat, imageFormat, browserExecutable, ffmpegExecutable, ffprobeExecutable, scale, chromiumOptions, port, numberOfGifLoops, everyNthFrame, puppeteerTimeout, } = await (0, get_cli_options_1.getCliOptions)({ isLambda: false, type: 'series' });
     if (!absoluteOutputFile) {
         throw new Error('assertion error - expected absoluteOutputFile to not be null');
     }
@@ -52,7 +52,7 @@ const render = async () => {
     ].filter(remotion_1.Internals.truthy);
     const urlOrBundle = renderer_1.RenderInternals.isServeUrl(fullPath)
         ? fullPath
-        : await (0, setup_cache_1.bundleOnCli)(fullPath, steps);
+        : await (0, setup_cache_1.bundleOnCli)({ fullPath, steps });
     const onDownload = (src) => {
         const id = Math.random();
         const download = {
@@ -96,7 +96,8 @@ const render = async () => {
         : await fs_1.default.promises.mkdtemp(path_1.default.join(os_1.default.tmpdir(), 'react-motion-render'));
     log_1.Log.verbose('Output dir', outputDir);
     const renderProgress = (0, progress_bar_1.createOverwriteableCliOutput)((0, parse_command_line_1.quietFlagProvided)());
-    let totalFrames = renderer_1.RenderInternals.getDurationFromFrameRange(frameRange, config.durationInFrames);
+    const realFrameRange = renderer_1.RenderInternals.getRealFrameRange(config.durationInFrames, frameRange);
+    const totalFrames = renderer_1.RenderInternals.getFramesToRender(realFrameRange, everyNthFrame);
     let encodedFrames = 0;
     let renderedFrames = 0;
     let encodedDoneIn = null;
@@ -104,13 +105,13 @@ const render = async () => {
     let stitchStage = 'encoding';
     const downloads = [];
     const updateRenderProgress = () => {
-        if (totalFrames === null) {
+        if (totalFrames.length === 0) {
             throw new Error('totalFrames should not be 0');
         }
         return renderProgress.update((0, progress_bar_1.makeRenderingAndStitchingProgress)({
             rendering: {
                 frames: renderedFrames,
-                totalFrames,
+                totalFrames: totalFrames.length,
                 concurrency: renderer_1.RenderInternals.getActualConcurrency(parallelism),
                 doneIn: renderedDoneIn,
                 steps,
@@ -122,7 +123,8 @@ const render = async () => {
                     frames: encodedFrames,
                     stage: stitchStage,
                     steps,
-                    totalFrames,
+                    totalFrames: totalFrames.length,
+                    codec,
                 },
             downloads,
         }));
@@ -144,10 +146,7 @@ const render = async () => {
                 renderedFrames = rendered;
                 updateRenderProgress();
             },
-            onStart: ({ frameCount }) => {
-                totalFrames = frameCount;
-                return updateRenderProgress();
-            },
+            onStart: () => undefined,
             onDownload: (src) => {
                 if (src.startsWith('data:')) {
                     log_1.Log.info('\nWriting Data URL to file: ', src.substring(0, 30) + '...');
@@ -159,6 +158,7 @@ const render = async () => {
             outputDir,
             serveUrl: urlOrBundle,
             dumpBrowserLogs: remotion_1.Internals.Logging.isEqualOrBelowLogLevel(remotion_1.Internals.Logging.getLogLevel(), 'verbose'),
+            everyNthFrame,
             envVariables,
             frameRange,
             parallelism,
@@ -207,13 +207,12 @@ const render = async () => {
         serveUrl: urlOrBundle,
         onDownload,
         dumpBrowserLogs: remotion_1.Internals.Logging.isEqualOrBelowLogLevel(remotion_1.Internals.Logging.getLogLevel(), 'verbose'),
-        onStart: ({ frameCount }) => {
-            totalFrames = frameCount;
-        },
         chromiumOptions,
         timeoutInMilliseconds: remotion_1.Internals.getCurrentPuppeteerTimeout(),
         scale,
         port,
+        numberOfGifLoops,
+        everyNthFrame,
     });
     log_1.Log.info();
     log_1.Log.info();
@@ -234,7 +233,7 @@ const render = async () => {
         log_1.Log.warn(err);
         log_1.Log.warn('Do you have minimum required Node.js version?');
     }
-    log_1.Log.info(chalk_1.chalk.green('\nYour video is ready!'));
+    log_1.Log.info(chalk_1.chalk.green(`\nYour ${codec === 'gif' ? 'GIF' : 'video'} is ready!`));
     if (remotion_1.Internals.Logging.isEqualOrBelowLogLevel(remotion_1.Internals.Logging.getLogLevel(), 'verbose')) {
         remotion_1.Internals.perf.logPerf();
     }

package/dist/setup-cache.d.ts

@@ -1,2 +1,5 @@
 import type { RenderStep } from './step';
-export declare const bundleOnCli: (fullPath: string, steps: RenderStep[]) => Promise<string>;
+export declare const bundleOnCli: ({ fullPath, steps, }: {
+    fullPath: string;
+    steps: RenderStep[];
+}) => Promise<string>;

package/dist/setup-cache.js

@@ -6,7 +6,7 @@ const remotion_1 = require("remotion");
 const log_1 = require("./log");
 const parse_command_line_1 = require("./parse-command-line");
 const progress_bar_1 = require("./progress-bar");
-const bundleOnCli = async (fullPath, steps) => {
+const bundleOnCli = async ({ fullPath, steps, }) => {
     var _a;
     const shouldCache = remotion_1.Internals.getWebpackCaching();
     const cacheExistedBefore = bundler_1.BundlerInternals.cacheExists('production');

package/dist/still.js

@@ -62,7 +62,7 @@ const still = async () => {
     ].filter(remotion_1.Internals.truthy);
     const urlOrBundle = renderer_1.RenderInternals.isServeUrl(fullPath)
         ? Promise.resolve(fullPath)
-        : await (0, setup_cache_1.bundleOnCli)(fullPath, steps);
+        : await (0, setup_cache_1.bundleOnCli)({ fullPath, steps });
     const puppeteerInstance = await browserInstance;
     const comps = await (0, renderer_1.getCompositions)(await urlOrBundle, {
         inputProps,

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@remotion/cli",
-	"version": "3.0.31",
+	"version": "3.1.0",
 	"description": "CLI for Remotion",
 	"main": "dist/index.js",
 	"sideEffects": false,
@@ -10,7 +10,7 @@
 	"module": "true",
 	"scripts": {
 		"lint": "eslint src --ext ts,tsx",
-		"test": "jest",
+		"test": "vitest --run",
 		"build": "tsc -d",
 		"watch": "tsc -w"
 	},
@@ -23,17 +23,18 @@
 	"author": "Jonny Burger <jonny@remotion.dev>",
 	"license": "SEE LICENSE IN LICENSE.md",
 	"dependencies": {
-		"@remotion/bundler": "3.0.31",
-		"@remotion/media-utils": "3.0.31",
-		"@remotion/player": "3.0.31",
-		"@remotion/renderer": "3.0.31",
+		"@remotion/bundler": "3.1.0",
+		"@remotion/media-utils": "3.1.0",
+		"@remotion/player": "3.1.0",
+		"@remotion/renderer": "3.1.0",
 		"better-opn": "2.1.1",
 		"dotenv": "9.0.2",
 		"memfs": "3.4.3",
 		"minimist": "1.2.6",
-		"remotion": "3.0.31",
+		"remotion": "3.1.0",
 		"semver": "7.3.5",
-		"source-map": "0.6.1"
+		"source-map": "0.6.1",
+		"vitest": "^0.18.0"
 	},
 	"peerDependencies": {
 		"react": ">=16.8.0",
@@ -41,7 +42,6 @@
 	},
 	"devDependencies": {
 		"@jonny/eslint-config": "3.0.266",
-		"@types/jest": "^27.4.0",
 		"@types/minimist": "^1.2.2",
 		"@types/node": "^16.7.5",
 		"@types/react": "18.0.1",
@@ -54,12 +54,10 @@
 		"eslint-plugin-10x": "1.5.2",
 		"eslint-plugin-react": "7.29.4",
 		"eslint-plugin-react-hooks": "4.4.0",
-		"jest": "^27.2.4",
 		"prettier": "^2.0.5",
 		"prettier-plugin-organize-imports": "^2.3.4",
 		"react": "^18.0.0",
 		"react-dom": "^18.0.0",
-		"ts-jest": "^27.0.5",
 		"typescript": "^4.7.0"
 	},
 	"keywords": [
@@ -73,5 +71,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "9342296ce1634b8b7b6dbdaee810a961f6922516"
+	"gitHead": "482c66127662171577aa427f10fe265fa1bc933b"
 }

package/tsconfig.json

@@ -12,5 +12,6 @@
 		{"path": "../renderer"},
 		{"path": "../player"},
 		{"path": "../media-utils"}
-	]
+	],
+	"exclude": ["vitest.config.ts", "dist"]
 }

package/vitest.config.ts

@@ -0,0 +1,9 @@
+import {defineConfig} from 'vitest/config';
+
+export default defineConfig({
+	test: {
+		testTimeout: 90000,
+		maxConcurrency: 1,
+		threads: false,
+	},
+});