@remotion/cli 4.0.0-prefetch.11 → 4.0.0-prefetch.12

package/LICENSE.md

@@ -1,34 +1,34 @@
 # Remotion License
 
-Depending on the type of your legal entity, you are granted permission to use Remotion for your project. Individuals and small companies are allowed to use Remotion create videos for free (even commercial), while a company license is required for for-profit organisations of a certain size. This two-tier system was designed to ensure funding for this project while still allowing the source code to be available and the program to be free for most. Read below for the exact terms of use.
+Depending on the type of your legal entity, you are granted permission to use Remotion for your project. Individuals and small companies are allowed to use Remotion to create videos for free (even commercial), while a company license is required for for-profit organizations of a certain size. This two-tier system was designed to ensure funding for this project while still allowing the source code to be available and the program to be free for most. Read below for the exact terms of use.
 
 - [Free license](#free-license)
 - [Company license](#company-license)
 
 ## Free license
 
-Copyright © 2022 [Jonny Burger](https://jonny.io)
+Copyright © 2022 [Remotion](https://www.remotion.dev/)
 
 ### Eligibility
 
 You are eligible to use Remotion for free if you are:
 
 - an individual
-- a for-profit organisation with up to 3 employees
-- a non-profit or not-for-profit organisation
+- a for-profit organization with up to 3 employees
+- a non-profit or not-for-profit organization
 - evaluating whether Remotion is a good fit, and are not yet using it in a commercial way
 
 ### Allowed use cases
 
-Permission is hereby granted, free of charge, to any person eligible for the "Free license", to use the software non-commercially or commercially for the purpose of creating videos and images and to modify and the software to their own liking, for the purpose of fulfilling their custom use case or to contribute bug fixes or improvements back to Remotion.
+Permission is hereby granted, free of charge, to any person eligible for the "Free license", to use the software non-commercially or commercially for the purpose of creating videos and images and to modify the software to their own liking, for the purpose of fulfilling their custom use case or to contribute bug fixes or improvements back to Remotion.
 
 ### Disallowed use cases
 
-It is not allowed to copy or modify Remotion code for the purpose of selling, renting, licensing, relicensing, sublicensing your own derivate of Remotion.
+It is not allowed to copy or modify Remotion code for the purpose of selling, renting, licensing, relicensing, or sublicensing your own derivate of Remotion.
 
 ### Warranty notice
 
-The software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the author or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.
+The software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement. In no event shall the author or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.
 
 ### Support
 

package/dist/benchmark.d.ts

@@ -0,0 +1 @@
+export declare const benchmarkCommand: (remotionRoot: string, args: string[]) => Promise<void>;

package/dist/benchmark.js

@@ -0,0 +1,180 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.benchmarkCommand = void 0;
+const renderer_1 = require("@remotion/renderer");
+const path_1 = __importDefault(require("path"));
+const chalk_1 = require("./chalk");
+const config_1 = require("./config");
+const get_cli_options_1 = require("./get-cli-options");
+const get_render_media_options_1 = require("./get-render-media-options");
+const log_1 = require("./log");
+const make_progress_bar_1 = require("./make-progress-bar");
+const parse_command_line_1 = require("./parse-command-line");
+const progress_bar_1 = require("./progress-bar");
+const setup_cache_1 = require("./setup-cache");
+const truthy_1 = require("./truthy");
+const DEFAULT_RUNS = 3;
+const getValidConcurrency = (renderMediaOptions) => {
+    var _a;
+    const concurrency = 'concurrency' in renderMediaOptions
+        ? (_a = renderMediaOptions.concurrency) !== null && _a !== void 0 ? _a : null
+        : null;
+    const { concurrencies } = parse_command_line_1.parsedCli;
+    if (!concurrencies) {
+        return [renderer_1.RenderInternals.getActualConcurrency(concurrency)];
+    }
+    return concurrencies
+        .split(',')
+        .map((c) => parseInt(c.trim(), 10));
+};
+const runBenchmark = async (runs, options, onProgress) => {
+    const timeTaken = [];
+    for (let run = 0; run < runs; ++run) {
+        const startTime = performance.now();
+        await (0, renderer_1.renderMedia)({
+            ...options,
+            onProgress: ({ progress }) => onProgress === null || onProgress === void 0 ? void 0 : onProgress(run, progress),
+        });
+        const endTime = performance.now();
+        timeTaken.push(endTime - startTime);
+    }
+    return timeTaken;
+};
+const formatTime = (time) => {
+    let ret = '';
+    const hours = Math.floor(time / (60 * 60 * 1000));
+    if (hours) {
+        ret = `${hours}h`;
+    }
+    time %= 60 * 60 * 1000;
+    const minutes = Math.floor(time / (60 * 1000));
+    if (minutes) {
+        ret = `${ret}${minutes}m`;
+    }
+    time %= 60 * 1000;
+    const seconds = (time / 1000).toFixed(5);
+    if (seconds) {
+        ret = `${ret}${seconds}s`;
+    }
+    return ret;
+};
+const avg = (time) => time.reduce((prev, curr) => prev + curr) / time.length;
+const stdDev = (time) => {
+    const mean = avg(time);
+    return Math.sqrt(time.map((x) => (x - mean) ** 2).reduce((a, b) => a + b) / time.length);
+};
+const getResults = (results, runs) => {
+    const mean = avg(results);
+    const dev = stdDev(results);
+    const max = Math.max(...results);
+    const min = Math.min(...results);
+    return `    Time (${chalk_1.chalk.green('mean')} ± ${chalk_1.chalk.green('σ')}):         ${chalk_1.chalk.green(formatTime(mean))} ± ${chalk_1.chalk.green(formatTime(dev))}\n    Range (${chalk_1.chalk.blue('min')} ... ${chalk_1.chalk.red('max')}):     ${chalk_1.chalk.blue(formatTime(min))} ... ${chalk_1.chalk.red(formatTime(max))} \t ${chalk_1.chalk.gray(`${runs} runs`)}
+	`;
+};
+const makeBenchmarkProgressBar = ({ totalRuns, run, progress, doneIn, }) => {
+    const totalProgress = (run + progress) / totalRuns;
+    return [
+        `Rendering (${run + 1} out of ${totalRuns} runs)`,
+        (0, make_progress_bar_1.makeProgressBar)(totalProgress),
+        doneIn === null
+            ? `${(totalProgress * 100).toFixed(2)}% `
+            : chalk_1.chalk.gray(doneIn),
+    ].join(' ');
+};
+const benchmarkCommand = async (remotionRoot, args) => {
+    var _a, _b;
+    const runs = (_a = parse_command_line_1.parsedCli.runs) !== null && _a !== void 0 ? _a : DEFAULT_RUNS;
+    const filePath = args[0];
+    if (!filePath) {
+        log_1.Log.error('No entry file passed.');
+        log_1.Log.info('Pass an additional argument specifying the entry file');
+        log_1.Log.info();
+        log_1.Log.info(`$ remotion benchmark <entry file>`);
+        process.exit(1);
+    }
+    const fullPath = path_1.default.join(process.cwd(), filePath);
+    const { inputProps, envVariables, browserExecutable, ffmpegExecutable, ffprobeExecutable, chromiumOptions, port, puppeteerTimeout, browser, scale, publicDir, } = await (0, get_cli_options_1.getCliOptions)({
+        isLambda: false,
+        type: 'series',
+        codec: 'h264',
+    });
+    const browserInstance = (0, renderer_1.openBrowser)(browser, {
+        browserExecutable,
+        shouldDumpIo: renderer_1.RenderInternals.isEqualOrBelowLogLevel(config_1.ConfigInternals.Logging.getLogLevel(), 'verbose'),
+        chromiumOptions,
+        forceDeviceScaleFactor: scale,
+    });
+    const { urlOrBundle: bundleLocation, cleanup: cleanupBundle } = await (0, setup_cache_1.bundleOnCliOrTakeServeUrl)({
+        fullPath,
+        publicDir,
+        remotionRoot,
+        steps: ['bundling'],
+    });
+    const puppeteerInstance = await browserInstance;
+    const comps = await (0, renderer_1.getCompositions)(bundleLocation, {
+        inputProps,
+        envVariables,
+        chromiumOptions,
+        timeoutInMilliseconds: puppeteerTimeout,
+        ffmpegExecutable,
+        ffprobeExecutable,
+        port,
+        puppeteerInstance,
+    });
+    const ids = ((_b = args[1]) !== null && _b !== void 0 ? _b : '')
+        .split(',')
+        .map((c) => c.trim())
+        .filter(truthy_1.truthy);
+    const compositions = ids.map((compId) => {
+        const composition = comps.find((c) => c.id === compId);
+        if (!composition) {
+            throw new Error(`No composition with the ID "${compId}" found.`);
+        }
+        return composition;
+    });
+    if (compositions.length === 0) {
+        log_1.Log.error('No composition IDs passed. Add another argument to the command specifying at least 1 composition ID.');
+    }
+    const benchmark = {};
+    let count = 1;
+    const { codec, reason: codecReason } = (0, get_cli_options_1.getFinalCodec)({
+        downloadName: null,
+        outName: null,
+    });
+    for (const composition of compositions) {
+        const renderMediaOptions = await (0, get_render_media_options_1.getRenderMediaOptions)({
+            config: composition,
+            outputLocation: undefined,
+            serveUrl: bundleLocation,
+            codec,
+        });
+        const concurrency = getValidConcurrency(renderMediaOptions);
+        benchmark[composition.id] = {};
+        for (const con of concurrency) {
+            const benchmarkProgress = (0, progress_bar_1.createOverwriteableCliOutput)((0, parse_command_line_1.quietFlagProvided)());
+            log_1.Log.info();
+            log_1.Log.info(`${chalk_1.chalk.bold(`Benchmark #${count++}:`)} ${chalk_1.chalk.gray(`composition=${composition.id} concurrency=${con} codec=${codec} (${codecReason})`)}`);
+            const timeTaken = await runBenchmark(runs, {
+                ...renderMediaOptions,
+                puppeteerInstance,
+                concurrency: con,
+            }, (run, progress) => {
+                benchmarkProgress.update(makeBenchmarkProgressBar({
+                    totalRuns: runs,
+                    run,
+                    doneIn: null,
+                    progress,
+                }));
+            });
+            benchmarkProgress.update('');
+            benchmarkProgress.update(getResults(timeTaken, runs));
+            benchmark[composition.id][`${con}`] = timeTaken;
+        }
+    }
+    log_1.Log.info();
+    await cleanupBundle();
+};
+exports.benchmarkCommand = benchmarkCommand;

package/dist/compositions.js

@@ -27,7 +27,7 @@ const max = (arr) => {
 const listCompositionsCommand = async (remotionRoot) => {
     const file = parse_command_line_1.parsedCli._[1];
     if (!file) {
-        log_1.Log.error('The `compositions` command requires you to specify a root file. For example');
+        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.tsx');
         log_1.Log.error('See https://www.remotion.dev/docs/register-root for more information.');
         process.exit(1);
@@ -38,6 +38,7 @@ const listCompositionsCommand = async (remotionRoot) => {
     const { browserExecutable, ffmpegExecutable, ffprobeExecutable, chromiumOptions, envVariables, inputProps, puppeteerTimeout, port, publicDir, } = await (0, get_cli_options_1.getCliOptions)({
         isLambda: false,
         type: 'get-compositions',
+        codec: 'h264',
     });
     const { urlOrBundle: bundled, cleanup: cleanupBundle } = await (0, setup_cache_1.bundleOnCliOrTakeServeUrl)({
         remotionRoot,

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/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/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/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;
@@ -45,5 +46,9 @@ export declare const ConfigInternals: {
     setEnforceAudioTrack: (enforceAudioTrack: boolean) => void;
     getKeyboardShortcutsEnabled: () => boolean;
     getPublicDir: () => string | null;
+    getFfmpegOverrideFunction: () => import("@remotion/renderer").FfmpegOverrideFn;
+    getAudioBitrate: () => string | null;
+    getVideoBitrate: () => string | null;
+    getCrfOrUndefined: () => import("@remotion/renderer").Crf;
 };
 export declare const overrideRemotion: () => void;

package/dist/config/index.js

@@ -31,7 +31,6 @@ const browser_executable_1 = require("./browser-executable");
 const chromium_flags_1 = require("./chromium-flags");
 const codec_1 = require("./codec");
 const concurrency_1 = require("./concurrency");
-const crf_1 = require("./crf");
 const env_file_1 = require("./env-file");
 const every_nth_frame_1 = require("./every-nth-frame");
 const ffmpeg_executable_1 = require("./ffmpeg-executable");
@@ -52,15 +51,17 @@ const scale_1 = require("./scale");
 const still_frame_1 = require("./still-frame");
 const timeout_1 = require("./timeout");
 const webpack_caching_1 = require("./webpack-caching");
+const bitrate_1 = require("./bitrate");
 const browser_executable_2 = require("./browser-executable");
 const chromium_flags_2 = require("./chromium-flags");
 const codec_2 = require("./codec");
 const concurrency_2 = require("./concurrency");
-const crf_2 = require("./crf");
+const crf_1 = require("./crf");
 const enforce_audio_track_1 = require("./enforce-audio-track");
 const env_file_2 = require("./env-file");
 const every_nth_frame_2 = require("./every-nth-frame");
 const ffmpeg_executable_2 = require("./ffmpeg-executable");
+const ffmpeg_override_1 = require("./ffmpeg-override");
 const frame_range_2 = require("./frame-range");
 const image_format_2 = require("./image-format");
 const image_sequence_2 = require("./image-sequence");
@@ -122,9 +123,12 @@ exports.Config = {
         setPixelFormat: pixel_format_2.setPixelFormat,
         setOutputFormat: codec_2.setOutputFormat,
         setCodec: codec_2.setCodec,
-        setCrf: crf_2.setCrf,
+        setCrf: crf_1.setCrf,
         setImageSequence: image_sequence_2.setImageSequence,
         setProResProfile: prores_profile_2.setProResProfile,
+        setAudioBitrate: bitrate_1.setAudioBitrate,
+        setVideoBitrate: bitrate_1.setVideoBitrate,
+        overrideFfmpegCommand: ffmpeg_override_1.setFfmpegOverrideFunction,
     },
 };
 // eslint-disable-next-line no-restricted-imports
@@ -133,7 +137,6 @@ exports.ConfigInternals = {
     getOutputCodecOrUndefined: codec_1.getOutputCodecOrUndefined,
     getCustomFfmpegExecutable: ffmpeg_executable_1.getCustomFfmpegExecutable,
     getBrowser: browser_1.getBrowser,
-    getActualCrf: crf_1.getActualCrf,
     getPixelFormat: pixel_format_1.getPixelFormat,
     getProResProfile: prores_profile_1.getProResProfile,
     getShouldOverwrite: overwrite_1.getShouldOverwrite,
@@ -168,6 +171,10 @@ exports.ConfigInternals = {
     setEnforceAudioTrack: enforce_audio_track_1.setEnforceAudioTrack,
     getKeyboardShortcutsEnabled: keyboard_shortcuts_1.getKeyboardShortcutsEnabled,
     getPublicDir: public_dir_1.getPublicDir,
+    getFfmpegOverrideFunction: ffmpeg_override_1.getFfmpegOverrideFunction,
+    getAudioBitrate: bitrate_1.getAudioBitrate,
+    getVideoBitrate: bitrate_1.getVideoBitrate,
+    getCrfOrUndefined: crf_1.getCrfOrUndefined,
 };
 const overrideRemotion = () => {
     Object.assign(remotion_1.Config, exports.Config);

package/dist/config/overwrite.d.ts

@@ -1,2 +1,4 @@
 export declare const setOverwriteOutput: (newOverwrite: boolean) => void;
-export declare const getShouldOverwrite: () => boolean;
+export declare const getShouldOverwrite: ({ defaultValue, }: {
+    defaultValue: boolean;
+}) => boolean;

package/dist/config/overwrite.js

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getShouldOverwrite = exports.setOverwriteOutput = void 0;
-const renderer_1 = require("@remotion/renderer");
-let shouldOverwrite = renderer_1.RenderInternals.DEFAULT_OVERWRITE;
+let shouldOverwrite = null;
 const setOverwriteOutput = (newOverwrite) => {
     if (typeof newOverwrite !== 'boolean') {
         throw new Error(`overwriteExisting must be a boolean but got ${typeof newOverwrite} (${JSON.stringify(newOverwrite)})`);
@@ -10,5 +9,5 @@ const setOverwriteOutput = (newOverwrite) => {
     shouldOverwrite = newOverwrite;
 };
 exports.setOverwriteOutput = setOverwriteOutput;
-const getShouldOverwrite = () => shouldOverwrite;
+const getShouldOverwrite = ({ defaultValue, }) => shouldOverwrite !== null && shouldOverwrite !== void 0 ? shouldOverwrite : defaultValue;
 exports.getShouldOverwrite = getShouldOverwrite;