@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.
- package/dist/benchmark.d.ts +1 -0
- package/dist/benchmark.js +180 -0
- package/dist/compositions.js +2 -1
- package/dist/config/image-format.js +8 -1
- package/dist/config/log.d.ts +1 -1
- package/dist/determine-image-format.d.ts +11 -0
- package/dist/determine-image-format.js +48 -0
- package/dist/event-source-events.d.ts +3 -0
- package/dist/event-source.js +1 -1
- package/dist/get-cli-options.d.ts +11 -3
- package/dist/get-cli-options.js +22 -28
- package/dist/get-env.d.ts +1 -1
- package/dist/get-env.js +58 -6
- package/dist/get-final-output-codec.d.ts +9 -5
- package/dist/get-final-output-codec.js +56 -56
- package/dist/get-render-media-options.d.ts +7 -0
- package/dist/get-render-media-options.js +44 -0
- package/dist/index.d.ts +21 -4
- package/dist/index.js +13 -3
- package/dist/initialize-cli.d.ts +1 -0
- package/dist/initialize-cli.js +22 -0
- package/dist/lambda-command.js +0 -2
- package/dist/parse-command-line.d.ts +1 -1
- package/dist/parse-command-line.js +1 -12
- package/dist/preview-server/routes.d.ts +2 -1
- package/dist/preview-server/routes.js +4 -2
- package/dist/preview-server/start-server.d.ts +1 -1
- package/dist/preview-server/start-server.js +2 -1
- package/dist/preview.js +10 -4
- package/dist/print-help.js +6 -3
- package/dist/progress-bar.js +3 -1
- package/dist/render.js +22 -32
- package/dist/still.js +15 -25
- package/dist/validate-image-format.d.ts +2 -0
- package/dist/validate-image-format.js +15 -0
- package/dist/versions.js +1 -1
- package/package.json +7 -7
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const benchmarkCommand: (remotionRoot: string, args: string[]) => Promise<void>;
|
|
@@ -0,0 +1,180 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.benchmarkCommand = void 0;
|
|
7
|
+
const renderer_1 = require("@remotion/renderer");
|
|
8
|
+
const path_1 = __importDefault(require("path"));
|
|
9
|
+
const chalk_1 = require("./chalk");
|
|
10
|
+
const config_1 = require("./config");
|
|
11
|
+
const get_cli_options_1 = require("./get-cli-options");
|
|
12
|
+
const get_render_media_options_1 = require("./get-render-media-options");
|
|
13
|
+
const log_1 = require("./log");
|
|
14
|
+
const make_progress_bar_1 = require("./make-progress-bar");
|
|
15
|
+
const parse_command_line_1 = require("./parse-command-line");
|
|
16
|
+
const progress_bar_1 = require("./progress-bar");
|
|
17
|
+
const setup_cache_1 = require("./setup-cache");
|
|
18
|
+
const truthy_1 = require("./truthy");
|
|
19
|
+
const DEFAULT_RUNS = 3;
|
|
20
|
+
const getValidConcurrency = (renderMediaOptions) => {
|
|
21
|
+
var _a;
|
|
22
|
+
const concurrency = 'concurrency' in renderMediaOptions
|
|
23
|
+
? (_a = renderMediaOptions.concurrency) !== null && _a !== void 0 ? _a : null
|
|
24
|
+
: null;
|
|
25
|
+
const { concurrencies } = parse_command_line_1.parsedCli;
|
|
26
|
+
if (!concurrencies) {
|
|
27
|
+
return [renderer_1.RenderInternals.getActualConcurrency(concurrency)];
|
|
28
|
+
}
|
|
29
|
+
return concurrencies
|
|
30
|
+
.split(',')
|
|
31
|
+
.map((c) => parseInt(c.trim(), 10));
|
|
32
|
+
};
|
|
33
|
+
const runBenchmark = async (runs, options, onProgress) => {
|
|
34
|
+
const timeTaken = [];
|
|
35
|
+
for (let run = 0; run < runs; ++run) {
|
|
36
|
+
const startTime = performance.now();
|
|
37
|
+
await (0, renderer_1.renderMedia)({
|
|
38
|
+
...options,
|
|
39
|
+
onProgress: ({ progress }) => onProgress === null || onProgress === void 0 ? void 0 : onProgress(run, progress),
|
|
40
|
+
});
|
|
41
|
+
const endTime = performance.now();
|
|
42
|
+
timeTaken.push(endTime - startTime);
|
|
43
|
+
}
|
|
44
|
+
return timeTaken;
|
|
45
|
+
};
|
|
46
|
+
const formatTime = (time) => {
|
|
47
|
+
let ret = '';
|
|
48
|
+
const hours = Math.floor(time / (60 * 60 * 1000));
|
|
49
|
+
if (hours) {
|
|
50
|
+
ret = `${hours}h`;
|
|
51
|
+
}
|
|
52
|
+
time %= 60 * 60 * 1000;
|
|
53
|
+
const minutes = Math.floor(time / (60 * 1000));
|
|
54
|
+
if (minutes) {
|
|
55
|
+
ret = `${ret}${minutes}m`;
|
|
56
|
+
}
|
|
57
|
+
time %= 60 * 1000;
|
|
58
|
+
const seconds = (time / 1000).toFixed(5);
|
|
59
|
+
if (seconds) {
|
|
60
|
+
ret = `${ret}${seconds}s`;
|
|
61
|
+
}
|
|
62
|
+
return ret;
|
|
63
|
+
};
|
|
64
|
+
const avg = (time) => time.reduce((prev, curr) => prev + curr) / time.length;
|
|
65
|
+
const stdDev = (time) => {
|
|
66
|
+
const mean = avg(time);
|
|
67
|
+
return Math.sqrt(time.map((x) => (x - mean) ** 2).reduce((a, b) => a + b) / time.length);
|
|
68
|
+
};
|
|
69
|
+
const getResults = (results, runs) => {
|
|
70
|
+
const mean = avg(results);
|
|
71
|
+
const dev = stdDev(results);
|
|
72
|
+
const max = Math.max(...results);
|
|
73
|
+
const min = Math.min(...results);
|
|
74
|
+
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`)}
|
|
75
|
+
`;
|
|
76
|
+
};
|
|
77
|
+
const makeBenchmarkProgressBar = ({ totalRuns, run, progress, doneIn, }) => {
|
|
78
|
+
const totalProgress = (run + progress) / totalRuns;
|
|
79
|
+
return [
|
|
80
|
+
`Rendering (${run + 1} out of ${totalRuns} runs)`,
|
|
81
|
+
(0, make_progress_bar_1.makeProgressBar)(totalProgress),
|
|
82
|
+
doneIn === null
|
|
83
|
+
? `${(totalProgress * 100).toFixed(2)}% `
|
|
84
|
+
: chalk_1.chalk.gray(doneIn),
|
|
85
|
+
].join(' ');
|
|
86
|
+
};
|
|
87
|
+
const benchmarkCommand = async (remotionRoot, args) => {
|
|
88
|
+
var _a, _b;
|
|
89
|
+
const runs = (_a = parse_command_line_1.parsedCli.runs) !== null && _a !== void 0 ? _a : DEFAULT_RUNS;
|
|
90
|
+
const filePath = args[0];
|
|
91
|
+
if (!filePath) {
|
|
92
|
+
log_1.Log.error('No entry file passed.');
|
|
93
|
+
log_1.Log.info('Pass an additional argument specifying the entry file');
|
|
94
|
+
log_1.Log.info();
|
|
95
|
+
log_1.Log.info(`$ remotion benchmark <entry file>`);
|
|
96
|
+
process.exit(1);
|
|
97
|
+
}
|
|
98
|
+
const fullPath = path_1.default.join(process.cwd(), filePath);
|
|
99
|
+
const { inputProps, envVariables, browserExecutable, ffmpegExecutable, ffprobeExecutable, chromiumOptions, port, puppeteerTimeout, browser, scale, publicDir, } = await (0, get_cli_options_1.getCliOptions)({
|
|
100
|
+
isLambda: false,
|
|
101
|
+
type: 'series',
|
|
102
|
+
codec: 'h264',
|
|
103
|
+
});
|
|
104
|
+
const browserInstance = (0, renderer_1.openBrowser)(browser, {
|
|
105
|
+
browserExecutable,
|
|
106
|
+
shouldDumpIo: renderer_1.RenderInternals.isEqualOrBelowLogLevel(config_1.ConfigInternals.Logging.getLogLevel(), 'verbose'),
|
|
107
|
+
chromiumOptions,
|
|
108
|
+
forceDeviceScaleFactor: scale,
|
|
109
|
+
});
|
|
110
|
+
const { urlOrBundle: bundleLocation, cleanup: cleanupBundle } = await (0, setup_cache_1.bundleOnCliOrTakeServeUrl)({
|
|
111
|
+
fullPath,
|
|
112
|
+
publicDir,
|
|
113
|
+
remotionRoot,
|
|
114
|
+
steps: ['bundling'],
|
|
115
|
+
});
|
|
116
|
+
const puppeteerInstance = await browserInstance;
|
|
117
|
+
const comps = await (0, renderer_1.getCompositions)(bundleLocation, {
|
|
118
|
+
inputProps,
|
|
119
|
+
envVariables,
|
|
120
|
+
chromiumOptions,
|
|
121
|
+
timeoutInMilliseconds: puppeteerTimeout,
|
|
122
|
+
ffmpegExecutable,
|
|
123
|
+
ffprobeExecutable,
|
|
124
|
+
port,
|
|
125
|
+
puppeteerInstance,
|
|
126
|
+
});
|
|
127
|
+
const ids = ((_b = args[1]) !== null && _b !== void 0 ? _b : '')
|
|
128
|
+
.split(',')
|
|
129
|
+
.map((c) => c.trim())
|
|
130
|
+
.filter(truthy_1.truthy);
|
|
131
|
+
const compositions = ids.map((compId) => {
|
|
132
|
+
const composition = comps.find((c) => c.id === compId);
|
|
133
|
+
if (!composition) {
|
|
134
|
+
throw new Error(`No composition with the ID "${compId}" found.`);
|
|
135
|
+
}
|
|
136
|
+
return composition;
|
|
137
|
+
});
|
|
138
|
+
if (compositions.length === 0) {
|
|
139
|
+
log_1.Log.error('No composition IDs passed. Add another argument to the command specifying at least 1 composition ID.');
|
|
140
|
+
}
|
|
141
|
+
const benchmark = {};
|
|
142
|
+
let count = 1;
|
|
143
|
+
const { codec, reason: codecReason } = (0, get_cli_options_1.getFinalCodec)({
|
|
144
|
+
downloadName: null,
|
|
145
|
+
outName: null,
|
|
146
|
+
});
|
|
147
|
+
for (const composition of compositions) {
|
|
148
|
+
const renderMediaOptions = await (0, get_render_media_options_1.getRenderMediaOptions)({
|
|
149
|
+
config: composition,
|
|
150
|
+
outputLocation: undefined,
|
|
151
|
+
serveUrl: bundleLocation,
|
|
152
|
+
codec,
|
|
153
|
+
});
|
|
154
|
+
const concurrency = getValidConcurrency(renderMediaOptions);
|
|
155
|
+
benchmark[composition.id] = {};
|
|
156
|
+
for (const con of concurrency) {
|
|
157
|
+
const benchmarkProgress = (0, progress_bar_1.createOverwriteableCliOutput)((0, parse_command_line_1.quietFlagProvided)());
|
|
158
|
+
log_1.Log.info();
|
|
159
|
+
log_1.Log.info(`${chalk_1.chalk.bold(`Benchmark #${count++}:`)} ${chalk_1.chalk.gray(`composition=${composition.id} concurrency=${con} codec=${codec} (${codecReason})`)}`);
|
|
160
|
+
const timeTaken = await runBenchmark(runs, {
|
|
161
|
+
...renderMediaOptions,
|
|
162
|
+
puppeteerInstance,
|
|
163
|
+
concurrency: con,
|
|
164
|
+
}, (run, progress) => {
|
|
165
|
+
benchmarkProgress.update(makeBenchmarkProgressBar({
|
|
166
|
+
totalRuns: runs,
|
|
167
|
+
run,
|
|
168
|
+
doneIn: null,
|
|
169
|
+
progress,
|
|
170
|
+
}));
|
|
171
|
+
});
|
|
172
|
+
benchmarkProgress.update('');
|
|
173
|
+
benchmarkProgress.update(getResults(timeTaken, runs));
|
|
174
|
+
benchmark[composition.id][`${con}`] = timeTaken;
|
|
175
|
+
}
|
|
176
|
+
}
|
|
177
|
+
log_1.Log.info();
|
|
178
|
+
await cleanupBundle();
|
|
179
|
+
};
|
|
180
|
+
exports.benchmarkCommand = benchmarkCommand;
|
package/dist/compositions.js
CHANGED
|
@@ -27,7 +27,7 @@ const max = (arr) => {
|
|
|
27
27
|
const listCompositionsCommand = async (remotionRoot) => {
|
|
28
28
|
const file = parse_command_line_1.parsedCli._[1];
|
|
29
29
|
if (!file) {
|
|
30
|
-
log_1.Log.error('The `compositions` command requires you to specify a
|
|
30
|
+
log_1.Log.error('The `compositions` command requires you to specify a entry point. For example');
|
|
31
31
|
log_1.Log.error(' npx remotion compositions src/index.tsx');
|
|
32
32
|
log_1.Log.error('See https://www.remotion.dev/docs/register-root for more information.');
|
|
33
33
|
process.exit(1);
|
|
@@ -38,6 +38,7 @@ const listCompositionsCommand = async (remotionRoot) => {
|
|
|
38
38
|
const { browserExecutable, ffmpegExecutable, ffprobeExecutable, chromiumOptions, envVariables, inputProps, puppeteerTimeout, port, publicDir, } = await (0, get_cli_options_1.getCliOptions)({
|
|
39
39
|
isLambda: false,
|
|
40
40
|
type: 'get-compositions',
|
|
41
|
+
codec: 'h264',
|
|
41
42
|
});
|
|
42
43
|
const { urlOrBundle: bundled, cleanup: cleanupBundle } = await (0, setup_cache_1.bundleOnCliOrTakeServeUrl)({
|
|
43
44
|
remotionRoot,
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.getUserPreferredImageFormat = exports.setImageFormat = void 0;
|
|
4
4
|
const renderer_1 = require("@remotion/renderer");
|
|
5
|
+
const truthy_1 = require("../truthy");
|
|
5
6
|
let currentImageFormat;
|
|
6
7
|
const setImageFormat = (format) => {
|
|
7
8
|
if (typeof format === 'undefined') {
|
|
@@ -9,7 +10,13 @@ const setImageFormat = (format) => {
|
|
|
9
10
|
return;
|
|
10
11
|
}
|
|
11
12
|
if (!renderer_1.RenderInternals.validImageFormats.includes(format)) {
|
|
12
|
-
throw new TypeError(
|
|
13
|
+
throw new TypeError([
|
|
14
|
+
`Value ${format} is not valid as an image format.`,
|
|
15
|
+
// @ts-expect-error
|
|
16
|
+
format === 'jpg' ? 'Did you mean "jpeg"?' : null,
|
|
17
|
+
]
|
|
18
|
+
.filter(truthy_1.truthy)
|
|
19
|
+
.join(' '));
|
|
13
20
|
}
|
|
14
21
|
currentImageFormat = format;
|
|
15
22
|
};
|
package/dist/config/log.d.ts
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
import type { LogLevel } from '@remotion/renderer';
|
|
2
|
-
export declare const getLogLevel: () => "
|
|
2
|
+
export declare const getLogLevel: () => "error" | "verbose" | "info" | "warn";
|
|
3
3
|
export declare const setLogLevel: (newLogLevel: LogLevel) => void;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { ImageFormat, StillImageFormat } from '@remotion/renderer';
|
|
2
|
+
export declare const determineFinalImageFormat: ({ downloadName, outName, configImageFormat, cliFlag, isLambda, }: {
|
|
3
|
+
downloadName: string | null;
|
|
4
|
+
outName: string | null;
|
|
5
|
+
configImageFormat: ImageFormat | null;
|
|
6
|
+
cliFlag: ImageFormat | null;
|
|
7
|
+
isLambda: boolean;
|
|
8
|
+
}) => {
|
|
9
|
+
format: StillImageFormat;
|
|
10
|
+
source: string;
|
|
11
|
+
};
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.determineFinalImageFormat = void 0;
|
|
4
|
+
const deriveExtensionFromFilename = (filename) => {
|
|
5
|
+
if (filename === null || filename === void 0 ? void 0 : filename.endsWith('.png')) {
|
|
6
|
+
return 'png';
|
|
7
|
+
}
|
|
8
|
+
if (filename === null || filename === void 0 ? void 0 : filename.endsWith('.jpg')) {
|
|
9
|
+
return 'jpeg';
|
|
10
|
+
}
|
|
11
|
+
if (filename === null || filename === void 0 ? void 0 : filename.endsWith('.jpeg')) {
|
|
12
|
+
return 'jpeg';
|
|
13
|
+
}
|
|
14
|
+
return null;
|
|
15
|
+
};
|
|
16
|
+
const determineFinalImageFormat = ({ downloadName, outName, configImageFormat, cliFlag, isLambda, }) => {
|
|
17
|
+
const outNameExtension = deriveExtensionFromFilename(outName);
|
|
18
|
+
const downloadNameExtension = deriveExtensionFromFilename(downloadName);
|
|
19
|
+
const outNameDescription = isLambda ? 'S3 output key' : 'out name';
|
|
20
|
+
if (outNameExtension &&
|
|
21
|
+
downloadNameExtension &&
|
|
22
|
+
outNameExtension !== downloadNameExtension) {
|
|
23
|
+
throw new TypeError(`Image format mismatch: ${outName} was given as the ${outNameDescription} and ${downloadName} was given as the download name, but the extensions don't match.`);
|
|
24
|
+
}
|
|
25
|
+
if (downloadNameExtension) {
|
|
26
|
+
if (cliFlag && downloadNameExtension !== cliFlag) {
|
|
27
|
+
throw new TypeError(`Image format mismatch: ${downloadName} was given as the download name, but --image-format=${cliFlag} was passed. The image formats must match.`);
|
|
28
|
+
}
|
|
29
|
+
return { format: downloadNameExtension, source: 'Download name extension' };
|
|
30
|
+
}
|
|
31
|
+
if (outNameExtension) {
|
|
32
|
+
if (cliFlag && outNameExtension !== cliFlag) {
|
|
33
|
+
throw new TypeError(`Image format mismatch: ${outName} was given as the ${outNameDescription}, but --image-format=${cliFlag} was passed. The image formats must match.`);
|
|
34
|
+
}
|
|
35
|
+
return { format: outNameExtension, source: 'Out name extension' };
|
|
36
|
+
}
|
|
37
|
+
if (cliFlag === 'none') {
|
|
38
|
+
throw new TypeError('The --image-format flag must not be "none" for stills.');
|
|
39
|
+
}
|
|
40
|
+
if (cliFlag !== null) {
|
|
41
|
+
return { format: cliFlag, source: '--image-format flag' };
|
|
42
|
+
}
|
|
43
|
+
if (configImageFormat !== null && configImageFormat !== 'none') {
|
|
44
|
+
return { format: configImageFormat, source: 'Config file' };
|
|
45
|
+
}
|
|
46
|
+
return { format: 'png', source: 'Default' };
|
|
47
|
+
};
|
|
48
|
+
exports.determineFinalImageFormat = determineFinalImageFormat;
|
package/dist/event-source.js
CHANGED
|
@@ -7,7 +7,7 @@ const openEventSource = () => {
|
|
|
7
7
|
source = new EventSource('/events');
|
|
8
8
|
source.addEventListener('message', (event) => {
|
|
9
9
|
const newEvent = JSON.parse(event.data);
|
|
10
|
-
if (newEvent.type === 'new-input-props') {
|
|
10
|
+
if (newEvent.type === 'new-input-props' || newEvent.type === 'new-env-variables') {
|
|
11
11
|
window.location.reload();
|
|
12
12
|
}
|
|
13
13
|
});
|
|
@@ -1,14 +1,22 @@
|
|
|
1
|
-
import type { BrowserExecutable, ChromiumOptions, FrameRange } from '@remotion/renderer';
|
|
1
|
+
import type { BrowserExecutable, ChromiumOptions, Codec, FrameRange } from '@remotion/renderer';
|
|
2
|
+
export declare const validateFfmpegCanUseCodec: (codec: Codec) => Promise<void>;
|
|
3
|
+
export declare const getFinalCodec: (options: {
|
|
4
|
+
downloadName: string | null;
|
|
5
|
+
outName: string | null;
|
|
6
|
+
}) => {
|
|
7
|
+
codec: Codec;
|
|
8
|
+
reason: string;
|
|
9
|
+
};
|
|
2
10
|
export declare const getAndValidateAbsoluteOutputFile: (relativeOutputLocation: string, overwrite: boolean) => string;
|
|
3
11
|
export declare const getCliOptions: (options: {
|
|
4
12
|
isLambda: boolean;
|
|
5
13
|
type: 'still' | 'series' | 'get-compositions';
|
|
14
|
+
codec: Codec;
|
|
6
15
|
}) => Promise<{
|
|
7
16
|
puppeteerTimeout: number;
|
|
8
17
|
concurrency: number | null;
|
|
9
18
|
frameRange: FrameRange | null;
|
|
10
19
|
shouldOutputImageSequence: boolean;
|
|
11
|
-
codec: "h264" | "h265" | "vp8" | "vp9" | "mp3" | "aac" | "wav" | "prores" | "h264-mkv" | "gif";
|
|
12
20
|
inputProps: object;
|
|
13
21
|
envVariables: Record<string, string>;
|
|
14
22
|
quality: number | undefined;
|
|
@@ -23,7 +31,7 @@ export declare const getCliOptions: (options: {
|
|
|
23
31
|
browserExecutable: BrowserExecutable;
|
|
24
32
|
ffmpegExecutable: import("@remotion/renderer").FfmpegExecutable;
|
|
25
33
|
ffprobeExecutable: import("@remotion/renderer").FfmpegExecutable;
|
|
26
|
-
logLevel: "
|
|
34
|
+
logLevel: "error" | "verbose" | "info" | "warn";
|
|
27
35
|
scale: number;
|
|
28
36
|
chromiumOptions: ChromiumOptions;
|
|
29
37
|
overwrite: boolean;
|
package/dist/get-cli-options.js
CHANGED
|
@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
3
3
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
4
|
};
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
-
exports.getCliOptions = exports.getAndValidateAbsoluteOutputFile = void 0;
|
|
6
|
+
exports.getCliOptions = exports.getAndValidateAbsoluteOutputFile = exports.getFinalCodec = exports.validateFfmpegCanUseCodec = void 0;
|
|
7
7
|
const renderer_1 = require("@remotion/renderer");
|
|
8
8
|
const fs_1 = __importDefault(require("fs"));
|
|
9
9
|
const path_1 = __importDefault(require("path"));
|
|
@@ -13,7 +13,7 @@ const get_final_output_codec_1 = require("./get-final-output-codec");
|
|
|
13
13
|
const get_input_props_1 = require("./get-input-props");
|
|
14
14
|
const image_formats_1 = require("./image-formats");
|
|
15
15
|
const log_1 = require("./log");
|
|
16
|
-
const
|
|
16
|
+
const parse_command_line_1 = require("./parse-command-line");
|
|
17
17
|
const getAndValidateFrameRange = () => {
|
|
18
18
|
const frameRange = config_1.ConfigInternals.getRange();
|
|
19
19
|
if (typeof frameRange === 'number') {
|
|
@@ -23,20 +23,11 @@ const getAndValidateFrameRange = () => {
|
|
|
23
23
|
}
|
|
24
24
|
return frameRange;
|
|
25
25
|
};
|
|
26
|
-
const
|
|
27
|
-
const userCodec = config_1.ConfigInternals.getOutputCodecOrUndefined();
|
|
28
|
-
const codec = (0, get_final_output_codec_1.getFinalOutputCodec)({
|
|
29
|
-
codec: userCodec,
|
|
30
|
-
fileExtension: options.isLambda
|
|
31
|
-
? null
|
|
32
|
-
: renderer_1.RenderInternals.getExtensionOfFilename((0, user_passed_output_location_1.getUserPassedOutputLocation)()),
|
|
33
|
-
emitWarning: true,
|
|
34
|
-
});
|
|
26
|
+
const validateFfmpegCanUseCodec = async (codec) => {
|
|
35
27
|
const ffmpegExecutable = config_1.ConfigInternals.getCustomFfmpegExecutable();
|
|
36
28
|
if (codec === 'vp8' &&
|
|
37
29
|
!(await renderer_1.RenderInternals.ffmpegHasFeature({
|
|
38
30
|
feature: 'enable-libvpx',
|
|
39
|
-
isLambda: options.isLambda,
|
|
40
31
|
ffmpegExecutable,
|
|
41
32
|
}))) {
|
|
42
33
|
log_1.Log.error("The Vp8 codec has been selected, but your FFMPEG binary wasn't compiled with the --enable-lipvpx flag.");
|
|
@@ -45,7 +36,6 @@ const getFinalCodec = async (options) => {
|
|
|
45
36
|
if (codec === 'h265' &&
|
|
46
37
|
!(await renderer_1.RenderInternals.ffmpegHasFeature({
|
|
47
38
|
feature: 'enable-gpl',
|
|
48
|
-
isLambda: options.isLambda,
|
|
49
39
|
ffmpegExecutable,
|
|
50
40
|
}))) {
|
|
51
41
|
log_1.Log.error("The H265 codec has been selected, but your FFMPEG binary wasn't compiled with the --enable-gpl flag.");
|
|
@@ -54,14 +44,24 @@ const getFinalCodec = async (options) => {
|
|
|
54
44
|
if (codec === 'h265' &&
|
|
55
45
|
!(await renderer_1.RenderInternals.ffmpegHasFeature({
|
|
56
46
|
feature: 'enable-libx265',
|
|
57
|
-
isLambda: options.isLambda,
|
|
58
47
|
ffmpegExecutable,
|
|
59
48
|
}))) {
|
|
60
49
|
log_1.Log.error("The H265 codec has been selected, but your FFMPEG binary wasn't compiled with the --enable-libx265 flag.");
|
|
61
50
|
log_1.Log.error('This does not work, please recompile your FFMPEG binary with --enable-gpl --enable-libx265 or choose a different codec.');
|
|
62
51
|
}
|
|
63
|
-
return codec;
|
|
64
52
|
};
|
|
53
|
+
exports.validateFfmpegCanUseCodec = validateFfmpegCanUseCodec;
|
|
54
|
+
const getFinalCodec = (options) => {
|
|
55
|
+
var _a;
|
|
56
|
+
const { codec, reason } = (0, get_final_output_codec_1.getFinalOutputCodec)({
|
|
57
|
+
cliFlag: parse_command_line_1.parsedCli.codec,
|
|
58
|
+
configFile: (_a = config_1.ConfigInternals.getOutputCodecOrUndefined()) !== null && _a !== void 0 ? _a : null,
|
|
59
|
+
downloadName: options.downloadName,
|
|
60
|
+
outName: options.outName,
|
|
61
|
+
});
|
|
62
|
+
return { codec, reason };
|
|
63
|
+
};
|
|
64
|
+
exports.getFinalCodec = getFinalCodec;
|
|
65
65
|
const getBrowser = () => { var _a; return (_a = config_1.ConfigInternals.getBrowser()) !== null && _a !== void 0 ? _a : renderer_1.RenderInternals.DEFAULT_BROWSER; };
|
|
66
66
|
const getAndValidateAbsoluteOutputFile = (relativeOutputLocation, overwrite) => {
|
|
67
67
|
const absoluteOutputFile = path_1.default.resolve(process.cwd(), relativeOutputLocation);
|
|
@@ -119,11 +119,6 @@ const getAndValidateBrowser = async (browserExecutable) => {
|
|
|
119
119
|
const getCliOptions = async (options) => {
|
|
120
120
|
var _a;
|
|
121
121
|
const frameRange = getAndValidateFrameRange();
|
|
122
|
-
const codec = options.type === 'get-compositions'
|
|
123
|
-
? 'h264'
|
|
124
|
-
: await getFinalCodec({
|
|
125
|
-
isLambda: options.isLambda,
|
|
126
|
-
});
|
|
127
122
|
const shouldOutputImageSequence = options.type === 'still'
|
|
128
123
|
? true
|
|
129
124
|
: await getAndValidateShouldOutputImageSequence({
|
|
@@ -133,14 +128,14 @@ const getCliOptions = async (options) => {
|
|
|
133
128
|
const overwrite = config_1.ConfigInternals.getShouldOverwrite({
|
|
134
129
|
defaultValue: !options.isLambda,
|
|
135
130
|
});
|
|
136
|
-
const crf = getAndValidateCrf(shouldOutputImageSequence, codec);
|
|
137
|
-
const pixelFormat = getAndValidatePixelFormat(codec);
|
|
131
|
+
const crf = getAndValidateCrf(shouldOutputImageSequence, options.codec);
|
|
132
|
+
const pixelFormat = getAndValidatePixelFormat(options.codec);
|
|
138
133
|
const imageFormat = getAndValidateImageFormat({
|
|
139
134
|
shouldOutputImageSequence,
|
|
140
|
-
codec,
|
|
135
|
+
codec: options.codec,
|
|
141
136
|
pixelFormat,
|
|
142
137
|
});
|
|
143
|
-
const proResProfile = getAndValidateProResProfile(codec);
|
|
138
|
+
const proResProfile = getAndValidateProResProfile(options.codec);
|
|
144
139
|
const browserExecutable = config_1.ConfigInternals.getBrowserExecutable();
|
|
145
140
|
const ffmpegExecutable = config_1.ConfigInternals.getCustomFfmpegExecutable();
|
|
146
141
|
const ffprobeExecutable = config_1.ConfigInternals.getCustomFfprobeExecutable();
|
|
@@ -152,8 +147,8 @@ const getCliOptions = async (options) => {
|
|
|
152
147
|
headless: config_1.ConfigInternals.getChromiumHeadlessMode(),
|
|
153
148
|
gl: (_a = config_1.ConfigInternals.getChromiumOpenGlRenderer()) !== null && _a !== void 0 ? _a : renderer_1.RenderInternals.DEFAULT_OPENGL_RENDERER,
|
|
154
149
|
};
|
|
155
|
-
const everyNthFrame = config_1.ConfigInternals.getAndValidateEveryNthFrame(codec);
|
|
156
|
-
const numberOfGifLoops = config_1.ConfigInternals.getAndValidateNumberOfGifLoops(codec);
|
|
150
|
+
const everyNthFrame = config_1.ConfigInternals.getAndValidateEveryNthFrame(options.codec);
|
|
151
|
+
const numberOfGifLoops = config_1.ConfigInternals.getAndValidateNumberOfGifLoops(options.codec);
|
|
157
152
|
const concurrency = config_1.ConfigInternals.getConcurrency();
|
|
158
153
|
renderer_1.RenderInternals.validateConcurrency(concurrency, 'concurrency');
|
|
159
154
|
return {
|
|
@@ -161,9 +156,8 @@ const getCliOptions = async (options) => {
|
|
|
161
156
|
concurrency,
|
|
162
157
|
frameRange,
|
|
163
158
|
shouldOutputImageSequence,
|
|
164
|
-
codec,
|
|
165
159
|
inputProps: (0, get_input_props_1.getInputProps)(() => undefined),
|
|
166
|
-
envVariables: await (0, get_env_1.getEnvironmentVariables)(),
|
|
160
|
+
envVariables: await (0, get_env_1.getEnvironmentVariables)(() => undefined),
|
|
167
161
|
quality: config_1.ConfigInternals.getQuality(),
|
|
168
162
|
browser: await getAndValidateBrowser(browserExecutable),
|
|
169
163
|
crf,
|
package/dist/get-env.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const getEnvironmentVariables: () => Promise<Record<string, string>>;
|
|
1
|
+
export declare const getEnvironmentVariables: (onUpdate: (newProps: Record<string, string>) => void) => Promise<Record<string, string>>;
|
package/dist/get-env.js
CHANGED
|
@@ -7,6 +7,7 @@ exports.getEnvironmentVariables = void 0;
|
|
|
7
7
|
const dotenv_1 = __importDefault(require("dotenv"));
|
|
8
8
|
const fs_1 = __importDefault(require("fs"));
|
|
9
9
|
const path_1 = __importDefault(require("path"));
|
|
10
|
+
const chalk_1 = require("./chalk");
|
|
10
11
|
const config_1 = require("./config");
|
|
11
12
|
const find_closest_package_json_1 = require("./find-closest-package-json");
|
|
12
13
|
const log_1 = require("./log");
|
|
@@ -19,9 +20,54 @@ function getProcessEnv() {
|
|
|
19
20
|
}
|
|
20
21
|
return env;
|
|
21
22
|
}
|
|
22
|
-
const
|
|
23
|
+
const watchEnvFile = ({ processEnv, envFile, onUpdate, existedBefore, }) => {
|
|
24
|
+
const listener = async () => {
|
|
25
|
+
try {
|
|
26
|
+
const file = await fs_1.default.promises.readFile(envFile, 'utf-8');
|
|
27
|
+
onUpdate({
|
|
28
|
+
...processEnv,
|
|
29
|
+
...dotenv_1.default.parse(file),
|
|
30
|
+
});
|
|
31
|
+
if (existedBefore) {
|
|
32
|
+
log_1.Log.info(chalk_1.chalk.blueBright(`Updated env file ${envFile}`));
|
|
33
|
+
}
|
|
34
|
+
else {
|
|
35
|
+
log_1.Log.info(chalk_1.chalk.blueBright(`Added env file ${envFile}`));
|
|
36
|
+
}
|
|
37
|
+
fs_1.default.unwatchFile(envFile, listener);
|
|
38
|
+
watchEnvFile({
|
|
39
|
+
envFile,
|
|
40
|
+
existedBefore: true,
|
|
41
|
+
onUpdate,
|
|
42
|
+
processEnv,
|
|
43
|
+
});
|
|
44
|
+
}
|
|
45
|
+
catch (err) {
|
|
46
|
+
// No error message if user did not have a .env file from the beginning
|
|
47
|
+
if (!existedBefore && !fs_1.default.existsSync(envFile)) {
|
|
48
|
+
return;
|
|
49
|
+
}
|
|
50
|
+
if (fs_1.default.existsSync(envFile) && existedBefore) {
|
|
51
|
+
log_1.Log.error(`${envFile} update failed with error ${err}`);
|
|
52
|
+
}
|
|
53
|
+
else {
|
|
54
|
+
log_1.Log.warn(`${envFile} was deleted.`);
|
|
55
|
+
fs_1.default.unwatchFile(envFile, listener);
|
|
56
|
+
watchEnvFile({
|
|
57
|
+
envFile,
|
|
58
|
+
existedBefore: false,
|
|
59
|
+
onUpdate,
|
|
60
|
+
processEnv,
|
|
61
|
+
});
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
};
|
|
65
|
+
fs_1.default.watchFile(envFile, { interval: 100 }, listener);
|
|
66
|
+
};
|
|
67
|
+
const getEnvForEnvFile = async (processEnv, envFile, onUpdate) => {
|
|
23
68
|
try {
|
|
24
69
|
const envFileData = await fs_1.default.promises.readFile(envFile);
|
|
70
|
+
watchEnvFile({ processEnv, envFile, onUpdate, existedBefore: true });
|
|
25
71
|
return {
|
|
26
72
|
...processEnv,
|
|
27
73
|
...dotenv_1.default.parse(envFileData),
|
|
@@ -33,7 +79,7 @@ const getEnvForEnvFile = async (processEnv, envFile) => {
|
|
|
33
79
|
process.exit(1);
|
|
34
80
|
}
|
|
35
81
|
};
|
|
36
|
-
const getEnvironmentVariables = () => {
|
|
82
|
+
const getEnvironmentVariables = (onUpdate) => {
|
|
37
83
|
const processEnv = getProcessEnv();
|
|
38
84
|
if (parse_command_line_1.parsedCli['env-file']) {
|
|
39
85
|
const envFile = path_1.default.resolve(process.cwd(), parse_command_line_1.parsedCli['env-file']);
|
|
@@ -43,24 +89,30 @@ const getEnvironmentVariables = () => {
|
|
|
43
89
|
log_1.Log.error('Check that your path is correct and try again.');
|
|
44
90
|
process.exit(1);
|
|
45
91
|
}
|
|
46
|
-
return getEnvForEnvFile(processEnv, envFile);
|
|
92
|
+
return getEnvForEnvFile(processEnv, envFile, onUpdate);
|
|
47
93
|
}
|
|
48
94
|
const remotionRoot = (0, find_closest_package_json_1.findRemotionRoot)();
|
|
49
95
|
const configFileSetting = config_1.ConfigInternals.getDotEnvLocation();
|
|
50
96
|
if (configFileSetting) {
|
|
51
97
|
const envFile = path_1.default.resolve(remotionRoot, configFileSetting);
|
|
52
98
|
if (!fs_1.default.existsSync(envFile)) {
|
|
53
|
-
log_1.Log.error('You
|
|
99
|
+
log_1.Log.error('You specified a custom .env file using `Config.Rendering.setDotEnvLocation()` in the config file but it could not be found');
|
|
54
100
|
log_1.Log.error('We looked for the file at:', envFile);
|
|
55
101
|
log_1.Log.error('Check that your path is correct and try again.');
|
|
56
102
|
process.exit(1);
|
|
57
103
|
}
|
|
58
|
-
return getEnvForEnvFile(processEnv, envFile);
|
|
104
|
+
return getEnvForEnvFile(processEnv, envFile, onUpdate);
|
|
59
105
|
}
|
|
60
106
|
const defaultEnvFile = path_1.default.resolve(remotionRoot, '.env');
|
|
61
107
|
if (!fs_1.default.existsSync(defaultEnvFile)) {
|
|
108
|
+
watchEnvFile({
|
|
109
|
+
processEnv,
|
|
110
|
+
envFile: defaultEnvFile,
|
|
111
|
+
onUpdate,
|
|
112
|
+
existedBefore: false,
|
|
113
|
+
});
|
|
62
114
|
return Promise.resolve(processEnv);
|
|
63
115
|
}
|
|
64
|
-
return getEnvForEnvFile(processEnv, defaultEnvFile);
|
|
116
|
+
return getEnvForEnvFile(processEnv, defaultEnvFile, onUpdate);
|
|
65
117
|
};
|
|
66
118
|
exports.getEnvironmentVariables = getEnvironmentVariables;
|
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
import type { Codec, CodecOrUndefined } from '@remotion/renderer';
|
|
2
|
-
export declare const getFinalOutputCodec: ({
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
2
|
+
export declare const getFinalOutputCodec: ({ cliFlag, configFile, downloadName, outName, }: {
|
|
3
|
+
cliFlag: CodecOrUndefined;
|
|
4
|
+
outName: string | null;
|
|
5
|
+
downloadName: string | null;
|
|
6
|
+
configFile: Codec | null;
|
|
7
|
+
}) => {
|
|
8
|
+
codec: Codec;
|
|
9
|
+
reason: string;
|
|
10
|
+
};
|