@remotion/cli 3.2.25 → 3.2.28

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2,62 +2,62 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.getFinalOutputCodec = void 0;
4
4
  const renderer_1 = require("@remotion/renderer");
5
- const log_1 = require("./log");
6
- const getFinalOutputCodec = ({ codec: inputCodec, fileExtension, emitWarning, }) => {
7
- if (inputCodec === undefined && fileExtension === 'webm') {
8
- if (emitWarning) {
9
- log_1.Log.info('You have specified a .webm extension, using the VP8 encoder. Use --codec=vp9 to use the Vp9 encoder.');
10
- }
11
- return 'vp8';
12
- }
13
- if (inputCodec === undefined && fileExtension === 'hevc') {
14
- if (emitWarning) {
15
- log_1.Log.info('You have specified a .hevc extension, using the H265 encoder.');
16
- }
17
- return 'h265';
18
- }
19
- if (inputCodec === undefined && fileExtension === 'mp3') {
20
- if (emitWarning) {
21
- log_1.Log.info('You have specified a .mp3 extension, using the MP3 encoder.');
22
- }
23
- return 'mp3';
24
- }
25
- if (inputCodec === undefined && fileExtension === 'mov') {
26
- if (emitWarning) {
27
- log_1.Log.info('You have specified a .mov extension, using the Apple ProRes encoder.');
28
- }
29
- return 'prores';
30
- }
31
- if (inputCodec === undefined && fileExtension === 'wav') {
32
- if (emitWarning) {
33
- log_1.Log.info('You have specified a .wav extension, using the WAV encoder.');
34
- }
35
- return 'wav';
36
- }
37
- if (inputCodec === undefined && fileExtension === 'aac') {
38
- if (emitWarning) {
39
- log_1.Log.info('You have specified a .aac extension, using the AAC encoder.');
40
- }
41
- return 'aac';
42
- }
43
- if (inputCodec === undefined && fileExtension === 'm4a') {
44
- if (emitWarning) {
45
- log_1.Log.info('You have specified a .m4a extension, using the AAC encoder.');
46
- }
47
- return 'aac';
48
- }
49
- if (inputCodec === undefined && fileExtension === 'mkv') {
50
- if (emitWarning) {
51
- log_1.Log.info('You have specified a .mkv extension, using the H264 encoder and WAV audio format.');
52
- }
53
- return 'h264-mkv';
54
- }
55
- if (inputCodec === undefined && fileExtension === 'gif') {
56
- if (emitWarning) {
57
- log_1.Log.info('You have specified a .gif extension, rendering a GIF');
58
- }
59
- return 'gif';
5
+ const fileExtensions = {
6
+ webm: 'vp8',
7
+ hevc: 'h265',
8
+ mp3: 'mp3',
9
+ mov: 'prores',
10
+ wav: 'wav',
11
+ aac: 'aac',
12
+ mkv: 'h264-mkv',
13
+ gif: 'gif',
14
+ mp4: 'h264',
15
+ m4a: 'aac',
16
+ };
17
+ const deriveExtensionFromFilename = (extension) => {
18
+ var _a;
19
+ if (extension === null) {
20
+ return null;
60
21
  }
61
- return inputCodec !== null && inputCodec !== void 0 ? inputCodec : renderer_1.RenderInternals.DEFAULT_CODEC;
22
+ return (_a = fileExtensions[extension]) !== null && _a !== void 0 ? _a : null;
23
+ };
24
+ const getFinalOutputCodec = ({ cliFlag, configFile, downloadName, outName, }) => {
25
+ const downloadNameExtension = renderer_1.RenderInternals.getExtensionOfFilename(downloadName);
26
+ const outNameExtension = renderer_1.RenderInternals.getExtensionOfFilename(outName);
27
+ const derivedDownloadCodec = deriveExtensionFromFilename(downloadNameExtension);
28
+ const derivedOutNameCodec = deriveExtensionFromFilename(outNameExtension);
29
+ if (derivedDownloadCodec &&
30
+ derivedOutNameCodec &&
31
+ derivedDownloadCodec !== derivedOutNameCodec) {
32
+ throw new TypeError(`The download name is ${downloadName} but the output name is ${outName}. The file extensions must match`);
33
+ }
34
+ if (derivedDownloadCodec) {
35
+ if (cliFlag && derivedDownloadCodec !== cliFlag) {
36
+ throw new TypeError(`The download name is ${downloadName} but --codec=${cliFlag} was passed. The download name implies a codec of ${derivedDownloadCodec} which does not align with the --codec flag.`);
37
+ }
38
+ return {
39
+ codec: derivedDownloadCodec,
40
+ reason: 'derived from download name',
41
+ };
42
+ }
43
+ if (derivedOutNameCodec) {
44
+ if (cliFlag && derivedOutNameCodec !== cliFlag) {
45
+ throw new TypeError(`The out name is ${outName} but --codec=${cliFlag} was passed. The out name implies a codec of ${derivedOutNameCodec} which does not align with the --codec flag.`);
46
+ }
47
+ return {
48
+ codec: derivedOutNameCodec,
49
+ reason: 'derived from out name',
50
+ };
51
+ }
52
+ if (cliFlag) {
53
+ return { codec: cliFlag, reason: 'from --codec flag' };
54
+ }
55
+ if (configFile) {
56
+ return {
57
+ codec: configFile,
58
+ reason: 'Config file',
59
+ };
60
+ }
61
+ return { codec: renderer_1.RenderInternals.DEFAULT_CODEC, reason: 'default' };
62
62
  };
63
63
  exports.getFinalOutputCodec = getFinalOutputCodec;
@@ -0,0 +1,7 @@
1
+ import type { Codec, RenderMediaOptions } from '@remotion/renderer';
2
+ export declare const getRenderMediaOptions: ({ outputLocation, config, serveUrl, codec, }: {
3
+ outputLocation: RenderMediaOptions['outputLocation'];
4
+ config: RenderMediaOptions['composition'];
5
+ serveUrl: string;
6
+ codec: Codec;
7
+ }) => Promise<RenderMediaOptions>;
@@ -0,0 +1,44 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.getRenderMediaOptions = void 0;
4
+ const renderer_1 = require("@remotion/renderer");
5
+ const config_1 = require("./config");
6
+ const get_cli_options_1 = require("./get-cli-options");
7
+ const getRenderMediaOptions = async ({ outputLocation, config, serveUrl, codec, }) => {
8
+ const { proResProfile, concurrency, frameRange, overwrite, inputProps, envVariables, quality, crf, pixelFormat, imageFormat, browserExecutable, ffmpegExecutable, ffprobeExecutable, scale, chromiumOptions, port, numberOfGifLoops, everyNthFrame, muted, enforceAudioTrack, ffmpegOverride, } = await (0, get_cli_options_1.getCliOptions)({
9
+ isLambda: false,
10
+ type: 'series',
11
+ codec,
12
+ });
13
+ return {
14
+ outputLocation,
15
+ composition: config,
16
+ crf,
17
+ envVariables,
18
+ ffmpegExecutable,
19
+ ffprobeExecutable,
20
+ frameRange,
21
+ imageFormat,
22
+ inputProps,
23
+ overwrite,
24
+ pixelFormat,
25
+ proResProfile,
26
+ quality,
27
+ dumpBrowserLogs: renderer_1.RenderInternals.isEqualOrBelowLogLevel(config_1.ConfigInternals.Logging.getLogLevel(), 'verbose'),
28
+ chromiumOptions,
29
+ timeoutInMilliseconds: config_1.ConfigInternals.getCurrentPuppeteerTimeout(),
30
+ scale,
31
+ port,
32
+ numberOfGifLoops,
33
+ everyNthFrame,
34
+ verbose: renderer_1.RenderInternals.isEqualOrBelowLogLevel(config_1.ConfigInternals.Logging.getLogLevel(), 'verbose'),
35
+ muted,
36
+ enforceAudioTrack,
37
+ browserExecutable,
38
+ ffmpegOverride,
39
+ concurrency,
40
+ serveUrl,
41
+ codec,
42
+ };
43
+ };
44
+ exports.getRenderMediaOptions = getRenderMediaOptions;
package/dist/index.d.ts CHANGED
@@ -70,12 +70,12 @@ export declare const CliInternals: {
70
70
  getCliOptions: (options: {
71
71
  isLambda: boolean;
72
72
  type: "still" | "series" | "get-compositions";
73
+ codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif";
73
74
  }) => Promise<{
74
75
  puppeteerTimeout: number;
75
76
  concurrency: number | null;
76
77
  frameRange: import("@remotion/renderer").FrameRange | null;
77
78
  shouldOutputImageSequence: boolean;
78
- codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif";
79
79
  inputProps: object;
80
80
  envVariables: Record<string, string>;
81
81
  quality: number | undefined;
@@ -90,7 +90,7 @@ export declare const CliInternals: {
90
90
  browserExecutable: import("@remotion/renderer").BrowserExecutable;
91
91
  ffmpegExecutable: import("@remotion/renderer").FfmpegExecutable;
92
92
  ffprobeExecutable: import("@remotion/renderer").FfmpegExecutable;
93
- logLevel: "verbose" | "info" | "warn" | "error";
93
+ logLevel: "error" | "verbose" | "info" | "warn";
94
94
  scale: number;
95
95
  chromiumOptions: import("@remotion/renderer").ChromiumOptions;
96
96
  overwrite: boolean;
@@ -100,9 +100,9 @@ export declare const CliInternals: {
100
100
  publicDir: string | null;
101
101
  ffmpegOverride: import("@remotion/renderer").FfmpegOverrideFn;
102
102
  }>;
103
- parseCommandLine: (type: "sequence" | "still" | "lambda" | "preview" | "versions") => void;
103
+ parseCommandLine: () => void;
104
104
  loadConfig: (remotionRoot: string) => Promise<string | null>;
105
- initializeRenderCli: (remotionRoot: string, type: "sequence" | "still" | "lambda" | "preview") => Promise<void>;
105
+ initializeCli: (remotionRoot: string) => Promise<void>;
106
106
  BooleanFlags: string[];
107
107
  quietFlagProvided: () => boolean;
108
108
  parsedCli: import("./parse-command-line").CommandLineOptions & import("minimist").ParsedArgs;
@@ -115,4 +115,21 @@ export declare const CliInternals: {
115
115
  }) => string;
116
116
  getFileSizeDownloadBar: (downloaded: number) => string;
117
117
  findRemotionRoot: () => string;
118
+ getFinalCodec: (options: {
119
+ downloadName: string | null;
120
+ outName: string | null;
121
+ }) => {
122
+ codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif";
123
+ reason: string;
124
+ };
125
+ determineFinalImageFormat: ({ downloadName, outName, configImageFormat, cliFlag, isLambda, }: {
126
+ downloadName: string | null;
127
+ outName: string | null;
128
+ configImageFormat: "png" | "jpeg" | "none" | null;
129
+ cliFlag: "png" | "jpeg" | "none" | null;
130
+ isLambda: boolean;
131
+ }) => {
132
+ format: import("@remotion/renderer").StillImageFormat;
133
+ source: string;
134
+ };
118
135
  };
package/dist/index.js CHANGED
@@ -16,17 +16,19 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  exports.CliInternals = exports.overrideRemotion = exports.ConfigInternals = exports.cli = void 0;
18
18
  const renderer_1 = require("@remotion/renderer");
19
+ const benchmark_1 = require("./benchmark");
19
20
  const chalk_1 = require("./chalk");
20
21
  const check_version_1 = require("./check-version");
21
22
  const compositions_1 = require("./compositions");
22
23
  const index_1 = require("./config/index");
24
+ const determine_image_format_1 = require("./determine-image-format");
23
25
  const download_progress_1 = require("./download-progress");
24
26
  const find_closest_package_json_1 = require("./find-closest-package-json");
25
27
  const format_bytes_1 = require("./format-bytes");
26
28
  const get_cli_options_1 = require("./get-cli-options");
27
29
  const get_config_file_name_1 = require("./get-config-file-name");
28
30
  const handle_common_errors_1 = require("./handle-common-errors");
29
- const initialize_render_cli_1 = require("./initialize-render-cli");
31
+ const initialize_cli_1 = require("./initialize-cli");
30
32
  const lambda_command_1 = require("./lambda-command");
31
33
  const load_config_1 = require("./load-config");
32
34
  const log_1 = require("./log");
@@ -54,6 +56,7 @@ const cli = async () => {
54
56
  await (0, versions_1.validateVersionsBeforeCommand)(remotionRoot);
55
57
  }
56
58
  const errorSymbolicationLock = renderer_1.RenderInternals.registerErrorSymbolicationLock();
59
+ await (0, initialize_cli_1.initializeCli)(remotionRoot);
57
60
  try {
58
61
  if (command === 'compositions') {
59
62
  await (0, compositions_1.listCompositionsCommand)(remotionRoot);
@@ -76,12 +79,17 @@ const cli = async () => {
76
79
  else if (command === versions_1.VERSIONS_COMMAND) {
77
80
  await (0, versions_1.versionsCommand)(remotionRoot);
78
81
  }
82
+ else if (command === 'benchmark') {
83
+ await (0, benchmark_1.benchmarkCommand)(remotionRoot, parse_command_line_1.parsedCli._.slice(1));
84
+ }
79
85
  else if (command === 'help') {
80
86
  (0, print_help_1.printHelp)();
81
87
  process.exit(0);
82
88
  }
83
89
  else {
84
- log_1.Log.error(`Command ${command} not found.`);
90
+ if (command) {
91
+ log_1.Log.error(`Command ${command} not found.`);
92
+ }
85
93
  (0, print_help_1.printHelp)();
86
94
  process.exit(1);
87
95
  }
@@ -109,7 +117,7 @@ exports.CliInternals = {
109
117
  getCliOptions: get_cli_options_1.getCliOptions,
110
118
  parseCommandLine: parse_command_line_1.parseCommandLine,
111
119
  loadConfig: get_config_file_name_1.loadConfig,
112
- initializeRenderCli: initialize_render_cli_1.initializeRenderCli,
120
+ initializeCli: initialize_cli_1.initializeCli,
113
121
  BooleanFlags: parse_command_line_1.BooleanFlags,
114
122
  quietFlagProvided: parse_command_line_1.quietFlagProvided,
115
123
  parsedCli: parse_command_line_1.parsedCli,
@@ -117,4 +125,6 @@ exports.CliInternals = {
117
125
  formatBytes: format_bytes_1.formatBytes,
118
126
  getFileSizeDownloadBar: download_progress_1.getFileSizeDownloadBar,
119
127
  findRemotionRoot: find_closest_package_json_1.findRemotionRoot,
128
+ getFinalCodec: get_cli_options_1.getFinalCodec,
129
+ determineFinalImageFormat: determine_image_format_1.determineFinalImageFormat,
120
130
  };
@@ -0,0 +1 @@
1
+ export declare const initializeCli: (remotionRoot: string) => Promise<void>;
@@ -0,0 +1,22 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.initializeCli = void 0;
4
+ const get_config_file_name_1 = require("./get-config-file-name");
5
+ const log_1 = require("./log");
6
+ const parse_command_line_1 = require("./parse-command-line");
7
+ const initializeCli = async (remotionRoot) => {
8
+ const appliedName = await (0, get_config_file_name_1.loadConfig)(remotionRoot);
9
+ (0, parse_command_line_1.parseCommandLine)();
10
+ // Only now Log.verbose is available
11
+ log_1.Log.verbose('Remotion root directory:', remotionRoot);
12
+ if (remotionRoot !== process.cwd()) {
13
+ log_1.Log.warn(`Warning: The root directory of your project is ${remotionRoot}, but you are executing this command from ${process.cwd()}. The recommendation is to execute commands from the root directory.`);
14
+ }
15
+ if (appliedName) {
16
+ log_1.Log.verbose(`Applied configuration from ${appliedName}.`);
17
+ }
18
+ else {
19
+ log_1.Log.verbose('No config file loaded.');
20
+ }
21
+ };
22
+ exports.initializeCli = initializeCli;
@@ -1,7 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.lambdaCommand = void 0;
4
- const initialize_render_cli_1 = require("./initialize-render-cli");
5
4
  const log_1 = require("./log");
6
5
  const parse_command_line_1 = require("./parse-command-line");
7
6
  const get_package_manager_1 = require("./preview-server/get-package-manager");
@@ -12,7 +11,6 @@ const lambdaCommand = async (remotionRoot) => {
12
11
  paths: [remotionRoot],
13
12
  });
14
13
  const { LambdaInternals } = require(path);
15
- await (0, initialize_render_cli_1.initializeRenderCli)(remotionRoot, 'lambda');
16
14
  await LambdaInternals.executeCommand(parse_command_line_1.parsedCli._.slice(1));
17
15
  process.exit(0);
18
16
  }
@@ -41,5 +41,5 @@ export declare type CommandLineOptions = {
41
41
  };
42
42
  export declare const BooleanFlags: string[];
43
43
  export declare const parsedCli: CommandLineOptions & minimist.ParsedArgs;
44
- export declare const parseCommandLine: (type: 'still' | 'sequence' | 'lambda' | 'preview' | 'versions') => void;
44
+ export declare const parseCommandLine: () => void;
45
45
  export declare const quietFlagProvided: () => boolean;
@@ -33,7 +33,7 @@ exports.BooleanFlags = [
33
33
  exports.parsedCli = (0, minimist_1.default)(process.argv.slice(2), {
34
34
  boolean: exports.BooleanFlags,
35
35
  });
36
- const parseCommandLine = (type) => {
36
+ const parseCommandLine = () => {
37
37
  if (exports.parsedCli['pixel-format']) {
38
38
  config_1.Config.Output.setPixelFormat(exports.parsedCli['pixel-format']);
39
39
  }
@@ -81,17 +81,9 @@ const parseCommandLine = (type) => {
81
81
  config_1.Config.Puppeteer.setTimeoutInMilliseconds(exports.parsedCli.timeout);
82
82
  }
83
83
  if (exports.parsedCli.frames) {
84
- if (type === 'still') {
85
- 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/');
86
- process.exit(1);
87
- }
88
84
  config_1.ConfigInternals.setFrameRangeFromCli(exports.parsedCli.frames);
89
85
  }
90
86
  if (exports.parsedCli.frame) {
91
- if (type === 'sequence') {
92
- 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/');
93
- process.exit(1);
94
- }
95
87
  config_1.ConfigInternals.setStillFrame(Number(exports.parsedCli.frame));
96
88
  }
97
89
  if (exports.parsedCli.png) {
@@ -105,9 +97,6 @@ const parseCommandLine = (type) => {
105
97
  if (typeof exports.parsedCli.crf !== 'undefined') {
106
98
  config_1.Config.Output.setCrf(exports.parsedCli.crf);
107
99
  }
108
- if (exports.parsedCli.codec) {
109
- config_1.Config.Output.setCodec(exports.parsedCli.codec);
110
- }
111
100
  if (exports.parsedCli['every-nth-frame']) {
112
101
  config_1.Config.Rendering.setEveryNthFrame(exports.parsedCli['every-nth-frame']);
113
102
  }
@@ -1,12 +1,13 @@
1
1
  import type { IncomingMessage, ServerResponse } from 'http';
2
2
  import type { LiveEventsServer } from './live-events';
3
- export declare const handleRoutes: ({ hash, hashPrefix, request, response, liveEventsServer, getCurrentInputProps, remotionRoot, userPassedPublicDir, }: {
3
+ export declare const handleRoutes: ({ hash, hashPrefix, request, response, liveEventsServer, getCurrentInputProps, getEnvVariables, remotionRoot, userPassedPublicDir, }: {
4
4
  hash: string;
5
5
  hashPrefix: string;
6
6
  request: IncomingMessage;
7
7
  response: ServerResponse;
8
8
  liveEventsServer: LiveEventsServer;
9
9
  getCurrentInputProps: () => object;
10
+ getEnvVariables: () => Record<string, string>;
10
11
  remotionRoot: string;
11
12
  userPassedPublicDir: string | null;
12
13
  }) => void | Promise<void>;
@@ -25,7 +25,7 @@ const static404 = (response) => {
25
25
  response.writeHead(404);
26
26
  response.end('The static/ prefix has been changed, this URL is no longer valid.');
27
27
  };
28
- const handleFallback = async ({ remotionRoot, hash, response, getCurrentInputProps, }) => {
28
+ const handleFallback = async ({ remotionRoot, hash, response, getCurrentInputProps, getEnvVariables, }) => {
29
29
  const [edit] = await editorGuess;
30
30
  const displayName = (0, open_in_editor_1.getDisplayNameForEditor)(edit ? edit.command : null);
31
31
  response.setHeader('content-type', 'text/html');
@@ -35,6 +35,7 @@ const handleFallback = async ({ remotionRoot, hash, response, getCurrentInputPro
35
35
  staticHash: hash,
36
36
  baseDir: '/',
37
37
  editorName: displayName,
38
+ envVariables: getEnvVariables(),
38
39
  inputProps: getCurrentInputProps(),
39
40
  remotionRoot,
40
41
  previewServerCommand: packageManager === 'unknown' ? null : packageManager.startCommand,
@@ -117,7 +118,7 @@ const handleFavicon = (_, response) => {
117
118
  const readStream = (0, fs_1.createReadStream)(filePath);
118
119
  readStream.pipe(response);
119
120
  };
120
- const handleRoutes = ({ hash, hashPrefix, request, response, liveEventsServer, getCurrentInputProps, remotionRoot, userPassedPublicDir, }) => {
121
+ const handleRoutes = ({ hash, hashPrefix, request, response, liveEventsServer, getCurrentInputProps, getEnvVariables, remotionRoot, userPassedPublicDir, }) => {
121
122
  const url = new URL(request.url, 'http://localhost');
122
123
  if (url.pathname === '/api/update') {
123
124
  return handleUpdate(remotionRoot, request, response);
@@ -156,6 +157,7 @@ const handleRoutes = ({ hash, hashPrefix, request, response, liveEventsServer, g
156
157
  hash,
157
158
  response,
158
159
  getCurrentInputProps,
160
+ getEnvVariables,
159
161
  });
160
162
  };
161
163
  exports.handleRoutes = handleRoutes;
@@ -3,7 +3,7 @@ import type { LiveEventsServer } from './live-events';
3
3
  export declare const startServer: (entry: string, userDefinedComponent: string, options: {
4
4
  webpackOverride: WebpackOverrideFn;
5
5
  getCurrentInputProps: () => object;
6
- envVariables?: Record<string, string>;
6
+ getEnvVariables: () => Record<string, string>;
7
7
  port: number | null;
8
8
  maxTimelineTracks?: number;
9
9
  remotionRoot: string;
@@ -26,7 +26,7 @@ const startServer = async (entry, userDefinedComponent, options) => {
26
26
  outDir: tmpDir,
27
27
  environment: 'development',
28
28
  webpackOverride: (_a = options === null || options === void 0 ? void 0 : options.webpackOverride) !== null && _a !== void 0 ? _a : config_1.ConfigInternals.getWebpackOverrideFn(),
29
- envVariables: (_b = options === null || options === void 0 ? void 0 : options.envVariables) !== null && _b !== void 0 ? _b : {},
29
+ envVariables: (_b = options === null || options === void 0 ? void 0 : options.getEnvVariables()) !== null && _b !== void 0 ? _b : {},
30
30
  maxTimelineTracks: (_c = options === null || options === void 0 ? void 0 : options.maxTimelineTracks) !== null && _c !== void 0 ? _c : 15,
31
31
  entryPoints: [
32
32
  require.resolve('./hot-middleware/client'),
@@ -62,6 +62,7 @@ const startServer = async (entry, userDefinedComponent, options) => {
62
62
  response,
63
63
  liveEventsServer,
64
64
  getCurrentInputProps: options.getCurrentInputProps,
65
+ getEnvVariables: options.getEnvVariables,
65
66
  remotionRoot: options.remotionRoot,
66
67
  userPassedPublicDir: options.userPassedPublicDir,
67
68
  });
package/dist/preview.js CHANGED
@@ -9,7 +9,6 @@ const path_1 = __importDefault(require("path"));
9
9
  const config_1 = require("./config");
10
10
  const get_env_1 = require("./get-env");
11
11
  const get_input_props_1 = require("./get-input-props");
12
- const initialize_render_cli_1 = require("./initialize-render-cli");
13
12
  const log_1 = require("./log");
14
13
  const parse_command_line_1 = require("./parse-command-line");
15
14
  const start_server_1 = require("./preview-server/start-server");
@@ -40,7 +39,6 @@ const previewCommand = async (remotionRoot) => {
40
39
  }
41
40
  const { port: desiredPort } = parse_command_line_1.parsedCli;
42
41
  const fullPath = path_1.default.join(process.cwd(), file);
43
- await (0, initialize_render_cli_1.initializeRenderCli)(remotionRoot, 'preview');
44
42
  let inputProps = (0, get_input_props_1.getInputProps)((newProps) => {
45
43
  waitForLiveEventsListener().then((listener) => {
46
44
  inputProps = newProps;
@@ -50,10 +48,18 @@ const previewCommand = async (remotionRoot) => {
50
48
  });
51
49
  });
52
50
  });
53
- const envVariables = await (0, get_env_1.getEnvironmentVariables)();
51
+ let envVariables = await (0, get_env_1.getEnvironmentVariables)((newEnvVariables) => {
52
+ waitForLiveEventsListener().then((listener) => {
53
+ envVariables = newEnvVariables;
54
+ listener.sendEventToClient({
55
+ type: 'new-env-variables',
56
+ newEnvVariables,
57
+ });
58
+ });
59
+ });
54
60
  const { port, liveEventsServer } = await (0, start_server_1.startServer)(path_1.default.resolve(__dirname, 'previewEntry.js'), fullPath, {
55
61
  getCurrentInputProps: () => inputProps,
56
- envVariables,
62
+ getEnvVariables: () => envVariables,
57
63
  port: desiredPort,
58
64
  maxTimelineTracks: config_1.ConfigInternals.getMaxTimelineTracks(),
59
65
  remotionRoot,
@@ -11,7 +11,7 @@ const printFlags = (flags) => {
11
11
  });
12
12
  };
13
13
  const printHelp = () => {
14
- log_1.Log.info(`@remotion/cli ${packagejson.version} © ${new Date().getFullYear()} Jonny Burger`);
14
+ log_1.Log.info(`@remotion/cli ${packagejson.version} © ${new Date().getFullYear()} The Remotion developers`);
15
15
  log_1.Log.info();
16
16
  log_1.Log.info('Available commands:');
17
17
  log_1.Log.info('');
@@ -19,7 +19,7 @@ const printHelp = () => {
19
19
  log_1.Log.info(chalk_1.chalk.gray('Start the preview server.'));
20
20
  printFlags([['--props', 'Pass input props as filename or as JSON']]);
21
21
  log_1.Log.info();
22
- log_1.Log.info('remotion render <entry-point.ts> <comp-name> <output-file.mp4>');
22
+ log_1.Log.info('remotion render <entry-point.ts> <comp-id> <output-file.mp4>');
23
23
  log_1.Log.info(chalk_1.chalk.gray('Render video, audio or an image sequence.'));
24
24
  printFlags([
25
25
  ['--props', 'Pass input props as filename or as JSON'],
@@ -40,7 +40,7 @@ const printHelp = () => {
40
40
  ['--env-file', 'Specify a location for a dotenv file'],
41
41
  ]);
42
42
  log_1.Log.info();
43
- log_1.Log.info('remotion still <entry-point.ts> <comp-name> <still.png>');
43
+ log_1.Log.info('remotion still <entry-point.ts> <comp-id> <still.png>');
44
44
  log_1.Log.info(chalk_1.chalk.gray('Render a still frame and save it as an image.'));
45
45
  printFlags([
46
46
  ['--frame', 'Which frame to render (default 0)'],
@@ -59,6 +59,9 @@ const printHelp = () => {
59
59
  log_1.Log.info('remotion compositions <index-file.ts>');
60
60
  log_1.Log.info(chalk_1.chalk.gray('Prints the available compositions.'));
61
61
  log_1.Log.info();
62
+ log_1.Log.info('remotion benchmark <index-file.ts> <list-of-compositions>');
63
+ log_1.Log.info(chalk_1.chalk.gray('Benchmarks rendering a composition. Same options as for render.'));
64
+ log_1.Log.info();
62
65
  log_1.Log.info('remotion ' + versions_1.VERSIONS_COMMAND);
63
66
  log_1.Log.info(chalk_1.chalk.gray('Prints and validates versions of all Remotion packages.'));
64
67
  log_1.Log.info();
@@ -34,7 +34,9 @@ const makeBundlingProgress = ({ progress, steps, doneIn, }) => [
34
34
  doneIn === null
35
35
  ? (progress * 100).toFixed(0) + '%'
36
36
  : chalk_1.chalk.gray(`${doneIn}ms`),
37
- ].join(' ');
37
+ ]
38
+ .filter(truthy_1.truthy)
39
+ .join(' ');
38
40
  exports.makeBundlingProgress = makeBundlingProgress;
39
41
  const makeRenderingProgress = ({ frames, totalFrames, steps, concurrency, doneIn, }) => {
40
42
  const progress = frames / totalFrames;
package/dist/render.js CHANGED
@@ -15,11 +15,12 @@ const config_1 = require("./config");
15
15
  const get_cli_options_1 = require("./get-cli-options");
16
16
  const get_composition_id_1 = require("./get-composition-id");
17
17
  const get_filename_1 = require("./get-filename");
18
- const initialize_render_cli_1 = require("./initialize-render-cli");
18
+ const get_render_media_options_1 = require("./get-render-media-options");
19
19
  const log_1 = require("./log");
20
20
  const parse_command_line_1 = require("./parse-command-line");
21
21
  const progress_bar_1 = require("./progress-bar");
22
22
  const setup_cache_1 = require("./setup-cache");
23
+ const user_passed_output_location_1 = require("./user-passed-output-location");
23
24
  const validate_ffmpeg_version_1 = require("./validate-ffmpeg-version");
24
25
  const render = async (remotionRoot) => {
25
26
  const startTime = Date.now();
@@ -34,11 +35,20 @@ const render = async (remotionRoot) => {
34
35
  ? file
35
36
  : path_1.default.join(process.cwd(), file);
36
37
  const downloadMap = renderer_1.RenderInternals.makeDownloadMap();
37
- await (0, initialize_render_cli_1.initializeRenderCli)(remotionRoot, 'sequence');
38
+ if (parse_command_line_1.parsedCli.frame) {
39
+ 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/');
40
+ process.exit(1);
41
+ }
38
42
  log_1.Log.verbose('Asset dirs', downloadMap.assetDir);
39
- 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)({
43
+ const { codec, reason: codecReason } = (0, get_cli_options_1.getFinalCodec)({
44
+ downloadName: null,
45
+ outName: (0, user_passed_output_location_1.getUserPassedOutputLocation)(),
46
+ });
47
+ (0, get_cli_options_1.validateFfmpegCanUseCodec)(codec);
48
+ 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)({
40
49
  isLambda: false,
41
50
  type: 'series',
51
+ codec,
42
52
  });
43
53
  const relativeOutputLocation = (0, get_filename_1.getOutputFilename)({
44
54
  codec,
@@ -48,7 +58,7 @@ const render = async (remotionRoot) => {
48
58
  });
49
59
  const absoluteOutputFile = (0, get_cli_options_1.getAndValidateAbsoluteOutputFile)(relativeOutputLocation, overwrite);
50
60
  const compositionId = (0, get_composition_id_1.getCompositionId)();
51
- log_1.Log.info(chalk_1.chalk.gray(`Composition = ${compositionId}, Codec = ${codec}, Output = ${relativeOutputLocation}`));
61
+ log_1.Log.info(chalk_1.chalk.gray(`Composition = ${compositionId}, Codec = ${codec} (${codecReason}), Output = ${relativeOutputLocation}`));
52
62
  log_1.Log.verbose('Browser executable: ', browserExecutable);
53
63
  await (0, validate_ffmpeg_version_1.checkAndValidateFfmpegVersion)({
54
64
  ffmpegExecutable,
@@ -93,10 +103,11 @@ const render = async (remotionRoot) => {
93
103
  inputProps,
94
104
  puppeteerInstance,
95
105
  envVariables,
96
- timeoutInMilliseconds: config_1.ConfigInternals.getCurrentPuppeteerTimeout(),
106
+ timeoutInMilliseconds: puppeteerTimeout,
97
107
  chromiumOptions,
98
108
  browserExecutable,
99
109
  downloadMap,
110
+ port,
100
111
  });
101
112
  const config = comps.find((c) => c.id === compositionId);
102
113
  if (!config) {
@@ -197,17 +208,14 @@ const render = async (remotionRoot) => {
197
208
  log_1.Log.info(chalk_1.chalk.green('\nYour image sequence is ready!'));
198
209
  return;
199
210
  }
200
- await (0, renderer_1.renderMedia)({
211
+ const options = await (0, get_render_media_options_1.getRenderMediaOptions)({
212
+ config,
201
213
  outputLocation: absoluteOutputFile,
214
+ serveUrl: urlOrBundle,
202
215
  codec,
203
- composition: config,
204
- crf,
205
- envVariables,
206
- ffmpegExecutable,
207
- ffprobeExecutable,
208
- frameRange,
209
- imageFormat,
210
- inputProps,
216
+ });
217
+ await (0, renderer_1.renderMedia)({
218
+ ...options,
211
219
  onProgress: (update) => {
212
220
  encodedDoneIn = update.encodedDoneIn;
213
221
  encodedFrames = update.encodedFrames;
@@ -217,26 +225,8 @@ const render = async (remotionRoot) => {
217
225
  updateRenderProgress();
218
226
  },
219
227
  puppeteerInstance,
220
- overwrite,
221
- concurrency,
222
- pixelFormat,
223
- proResProfile,
224
- quality,
225
- serveUrl: urlOrBundle,
226
228
  onDownload,
227
- dumpBrowserLogs: renderer_1.RenderInternals.isEqualOrBelowLogLevel(config_1.ConfigInternals.Logging.getLogLevel(), 'verbose'),
228
- chromiumOptions,
229
- timeoutInMilliseconds: config_1.ConfigInternals.getCurrentPuppeteerTimeout(),
230
- scale,
231
- port,
232
- numberOfGifLoops,
233
- everyNthFrame,
234
- verbose: renderer_1.RenderInternals.isEqualOrBelowLogLevel(config_1.ConfigInternals.Logging.getLogLevel(), 'verbose'),
235
229
  downloadMap,
236
- muted,
237
- enforceAudioTrack,
238
- browserExecutable,
239
- ffmpegOverride,
240
230
  });
241
231
  log_1.Log.info();
242
232
  log_1.Log.info();