@remotion/cli 4.0.174 → 4.0.176

package/dist/artifact.js

@@ -0,0 +1 @@
+"use strict";

package/dist/benchmark.js

@@ -336,6 +336,7 @@ const benchmarkCommand = async (remotionRoot, args, logLevel) => {
                 }).value,
                 compositionStart: 0,
                 onBrowserDownload,
+                onArtifact: () => undefined,
             }, (run, progress) => {
                 benchmarkProgress.update(makeBenchmarkProgressBar({
                     totalRuns: runs,

package/dist/hyperlinks/hyperlinks.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="node" />
+export declare function supportsHyperlink(stream: NodeJS.WriteStream): boolean;

package/dist/hyperlinks/hyperlinks.js

@@ -0,0 +1,79 @@
+"use strict";
+// From https://github.com/jamestalmage/supports-hyperlinks/blob/master/index.js
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.supportsHyperlink = void 0;
+// MIT License
+// Copyright (c) James Talmage <james@talmage.io> (github.com/jamestalmage)
+// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+// The above copyright notice and this permission notice shall be included in all copies or substantial portions of 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 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS 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.
+const renderer_1 = require("@remotion/renderer");
+function parseVersion(versionString) {
+    if (/^\d{3,4}$/.test(versionString)) {
+        // Env var doesn't always use dots. example: 4601 => 46.1.0
+        const m = /(\d{1,2})(\d{2})/.exec(versionString) || [];
+        return {
+            major: 0,
+            minor: parseInt(m[1], 10),
+            patch: parseInt(m[2], 10),
+        };
+    }
+    const versions = (versionString || '').split('.').map((n) => parseInt(n, 10));
+    return {
+        major: versions[0],
+        minor: versions[1],
+        patch: versions[2],
+    };
+}
+function supportsHyperlink(stream) {
+    const { CI, FORCE_HYPERLINK, NETLIFY, TEAMCITY_VERSION, TERM_PROGRAM, TERM_PROGRAM_VERSION, VTE_VERSION, } = process.env;
+    if (FORCE_HYPERLINK) {
+        return !(FORCE_HYPERLINK.length > 0 && parseInt(FORCE_HYPERLINK, 10) === 0);
+    }
+    // Netlify does not run a TTY, it does not need `supportsColor` check
+    if (NETLIFY) {
+        return true;
+    }
+    // If they specify no colors, they probably don't want hyperlinks.
+    if (!renderer_1.RenderInternals.isColorSupported()) {
+        return false;
+    }
+    if (stream && !stream.isTTY) {
+        return false;
+    }
+    if (process.platform === 'win32') {
+        return false;
+    }
+    if (CI) {
+        return false;
+    }
+    if (TEAMCITY_VERSION) {
+        return false;
+    }
+    if (TERM_PROGRAM) {
+        const version = parseVersion(TERM_PROGRAM_VERSION || '');
+        switch (TERM_PROGRAM) {
+            case 'iTerm.app':
+                if (version.major === 3) {
+                    return version.minor >= 1;
+                }
+                return version.major > 3;
+            case 'WezTerm':
+                return version.major >= 20200620;
+            case 'vscode':
+                // eslint-disable-next-line no-mixed-operators
+                return (version.major > 1 || (version.major === 1 && version.minor >= 72));
+            // No default
+        }
+    }
+    if (VTE_VERSION) {
+        // 0.50.0 was supposed to support hyperlinks, but throws a segfault
+        if (VTE_VERSION === '0.50.0') {
+            return false;
+        }
+        const version = parseVersion(VTE_VERSION);
+        return version.major > 0 || version.minor >= 50;
+    }
+    return false;
+}
+exports.supportsHyperlink = supportsHyperlink;

package/dist/hyperlinks.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="node" />
+export declare function supportsHyperlink(stream: NodeJS.WriteStream): boolean;

package/dist/hyperlinks.js

@@ -0,0 +1,79 @@
+"use strict";
+// From https://github.com/jamestalmage/supports-hyperlinks/blob/master/index.js
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.supportsHyperlink = void 0;
+// MIT License
+// Copyright (c) James Talmage <james@talmage.io> (github.com/jamestalmage)
+// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+// The above copyright notice and this permission notice shall be included in all copies or substantial portions of 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 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS 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.
+const renderer_1 = require("@remotion/renderer");
+function parseVersion(versionString) {
+    if (/^\d{3,4}$/.test(versionString)) {
+        // Env var doesn't always use dots. example: 4601 => 46.1.0
+        const m = /(\d{1,2})(\d{2})/.exec(versionString) || [];
+        return {
+            major: 0,
+            minor: parseInt(m[1], 10),
+            patch: parseInt(m[2], 10),
+        };
+    }
+    const versions = (versionString || '').split('.').map((n) => parseInt(n, 10));
+    return {
+        major: versions[0],
+        minor: versions[1],
+        patch: versions[2],
+    };
+}
+function supportsHyperlink(stream) {
+    const { CI, FORCE_HYPERLINK, NETLIFY, TEAMCITY_VERSION, TERM_PROGRAM, TERM_PROGRAM_VERSION, VTE_VERSION, } = process.env;
+    if (FORCE_HYPERLINK) {
+        return !(FORCE_HYPERLINK.length > 0 && parseInt(FORCE_HYPERLINK, 10) === 0);
+    }
+    // Netlify does not run a TTY, it does not need `supportsColor` check
+    if (NETLIFY) {
+        return true;
+    }
+    // If they specify no colors, they probably don't want hyperlinks.
+    if (!renderer_1.RenderInternals.isColorSupported()) {
+        return false;
+    }
+    if (stream && !stream.isTTY) {
+        return false;
+    }
+    if (process.platform === 'win32') {
+        return false;
+    }
+    if (CI) {
+        return false;
+    }
+    if (TEAMCITY_VERSION) {
+        return false;
+    }
+    if (TERM_PROGRAM) {
+        const version = parseVersion(TERM_PROGRAM_VERSION || '');
+        switch (TERM_PROGRAM) {
+            case 'iTerm.app':
+                if (version.major === 3) {
+                    return version.minor >= 1;
+                }
+                return version.major > 3;
+            case 'WezTerm':
+                return version.major >= 20200620;
+            case 'vscode':
+                // eslint-disable-next-line no-mixed-operators
+                return (version.major > 1 || (version.major === 1 && version.minor >= 72));
+            // No default
+        }
+    }
+    if (VTE_VERSION) {
+        // 0.50.0 was supposed to support hyperlinks, but throws a segfault
+        if (VTE_VERSION === '0.50.0') {
+            return false;
+        }
+        const version = parseVersion(VTE_VERSION);
+        return version.major > 0 || version.minor >= 50;
+    }
+    return false;
+}
+exports.supportsHyperlink = supportsHyperlink;

package/dist/on-artifact.d.ts

@@ -0,0 +1,9 @@
+import type { OnArtifact } from '@remotion/renderer';
+import type { ArtifactProgress } from '@remotion/studio-shared';
+export declare const handleOnArtifact: ({ artifactState, onProgress, compositionId, }: {
+    artifactState: ArtifactProgress;
+    onProgress: (artifact: ArtifactProgress) => void;
+    compositionId: string;
+}) => {
+    onArtifact: OnArtifact;
+};

package/dist/on-artifact.js

@@ -0,0 +1,35 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleOnArtifact = void 0;
+const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
+const handleOnArtifact = ({ artifactState, onProgress, compositionId, }) => {
+    const initialProgress = { ...artifactState };
+    const onArtifact = (artifact) => {
+        // It would be nice in the future to customize the artifact output destination
+        const relativeOutputDestination = path_1.default.join('out', compositionId, artifact.filename.replace('/', path_1.default.sep));
+        const defaultOutName = path_1.default.join(process.cwd(), relativeOutputDestination);
+        if (!(0, fs_1.existsSync)(path_1.default.dirname(defaultOutName))) {
+            (0, fs_1.mkdirSync)(path_1.default.dirname(defaultOutName), {
+                recursive: true,
+            });
+        }
+        const alreadyExisted = (0, fs_1.existsSync)(defaultOutName);
+        (0, fs_1.writeFileSync)(defaultOutName, artifact.content);
+        initialProgress.received.push({
+            absoluteOutputDestination: defaultOutName,
+            filename: artifact.filename,
+            sizeInBytes: artifact.content.length,
+            alreadyExisted,
+            relativeOutputDestination,
+        });
+    };
+    onProgress(initialProgress);
+    return {
+        onArtifact,
+    };
+};
+exports.handleOnArtifact = handleOnArtifact;

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

@@ -147,17 +147,17 @@ declare const beepOnFinishOption: {
     description: () => import("react/jsx-runtime").JSX.Element;
     ssrName: "x264Preset";
     docLink: string;
-    type: "medium" | "ultrafast" | "superfast" | "veryfast" | "faster" | "fast" | "slow" | "slower" | "veryslow" | "placebo" | null;
+    type: "ultrafast" | "superfast" | "veryfast" | "faster" | "fast" | "medium" | "slow" | "slower" | "veryslow" | "placebo" | null;
     getValue: ({ commandLine }: {
         commandLine: Record<string, unknown>;
     }) => {
-        value: "medium" | "ultrafast" | "superfast" | "veryfast" | "faster" | "fast" | "slow" | "slower" | "veryslow" | "placebo";
+        value: "ultrafast" | "superfast" | "veryfast" | "faster" | "fast" | "medium" | "slow" | "slower" | "veryslow" | "placebo";
         source: string;
     } | {
         value: null;
         source: string;
     };
-    setConfig: (profile: "medium" | "ultrafast" | "superfast" | "veryfast" | "faster" | "fast" | "slow" | "slower" | "veryslow" | "placebo" | null) => void;
+    setConfig: (profile: "ultrafast" | "superfast" | "veryfast" | "faster" | "fast" | "medium" | "slow" | "slower" | "veryslow" | "placebo" | null) => void;
 }, enforceAudioOption: {
     name: string;
     cliFlag: "enforce-audio-track";

package/dist/progress-bar.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.printFact = exports.makeRenderingAndStitchingProgress = exports.getRightLabelWidth = exports.makeBundlingAndCopyProgress = exports.createOverwriteableCliOutput = exports.LABEL_WIDTH = void 0;
 const renderer_1 = require("@remotion/renderer");
 const studio_server_1 = require("@remotion/studio-server");
+const studio_shared_1 = require("@remotion/studio-shared");
 const chalk_1 = require("./chalk");
 const download_progress_1 = require("./download-progress");
 const eta_string_1 = require("./eta-string");
@@ -132,6 +133,26 @@ const makeRenderingProgress = ({ frames, totalFrames, doneIn, timeRemainingInMil
         .filter(truthy_1.truthy)
         .join(' ');
 };
+const makeArtifactProgress = (artifactState) => {
+    const { received } = artifactState;
+    if (received.length === 0) {
+        return null;
+    }
+    return received
+        .map((artifact) => {
+        return [
+            chalk_1.chalk.blue((artifact.alreadyExisted ? '○' : '+').padEnd(exports.LABEL_WIDTH)),
+            chalk_1.chalk.blue((0, make_link_1.makeHyperlink)({
+                url: 'file://' + artifact.absoluteOutputDestination,
+                fallback: artifact.absoluteOutputDestination,
+                text: artifact.relativeOutputDestination,
+            })),
+            chalk_1.chalk.gray(`${(0, studio_shared_1.formatBytes)(artifact.sizeInBytes)}`),
+        ].join(' ');
+    })
+        .filter(truthy_1.truthy)
+        .join('\n');
+};
 const getRightLabelWidth = (totalFrames) => {
     return `${totalFrames}/${totalFrames}`.length;
 };
@@ -158,7 +179,7 @@ const makeStitchingProgress = ({ stitchingProgress, isUsingParallelEncoding, })
 };
 const makeRenderingAndStitchingProgress = ({ prog, isUsingParallelEncoding, }) => {
     var _a;
-    const { rendering, stitching, downloads, bundling } = prog;
+    const { rendering, stitching, downloads, bundling, artifactState } = prog;
     const output = [
         rendering ? makeRenderingProgress(rendering) : null,
         (0, download_progress_1.makeMultiDownloadProgress)(downloads, (_a = rendering === null || rendering === void 0 ? void 0 : rendering.totalFrames) !== null && _a !== void 0 ? _a : 0),
@@ -168,6 +189,7 @@ const makeRenderingAndStitchingProgress = ({ prog, isUsingParallelEncoding, }) =
                 stitchingProgress: stitching,
                 isUsingParallelEncoding,
             }),
+        makeArtifactProgress(artifactState),
     ]
         .filter(truthy_1.truthy)
         .join('\n');

package/dist/progress-types.js

@@ -13,5 +13,8 @@ const initialAggregateRenderProgress = () => ({
         bytes: 0,
         doneIn: null,
     },
+    artifactState: {
+        received: [],
+    },
 });
 exports.initialAggregateRenderProgress = initialAggregateRenderProgress;

package/dist/render-flows/render.js

@@ -43,6 +43,7 @@ const make_link_1 = require("../hyperlinks/make-link");
 const image_formats_1 = require("../image-formats");
 const log_1 = require("../log");
 const make_on_download_1 = require("../make-on-download");
+const on_artifact_1 = require("../on-artifact");
 const parsed_cli_1 = require("../parsed-cli");
 const progress_bar_1 = require("../progress-bar");
 const setup_cache_1 = require("../setup-cache");
@@ -101,6 +102,7 @@ const renderVideoFlow = async ({ remotionRoot, fullEntryPoint, indent, logLevel,
         bytes: 0,
         doneIn: null,
     };
+    let artifactState = { received: [] };
     const updateRenderProgress = ({ newline, printToConsole, }) => {
         const aggregateRenderProgress = {
             rendering: renderingProgress,
@@ -108,6 +110,7 @@ const renderVideoFlow = async ({ remotionRoot, fullEntryPoint, indent, logLevel,
             downloads,
             bundling: bundlingProgress,
             copyingState,
+            artifactState,
         };
         const { output, message, progress } = (0, progress_bar_1.makeRenderingAndStitchingProgress)({
             prog: aggregateRenderProgress,
@@ -185,6 +188,14 @@ const renderVideoFlow = async ({ remotionRoot, fullEntryPoint, indent, logLevel,
         binariesDirectory,
         onBrowserDownload,
     });
+    const { onArtifact } = (0, on_artifact_1.handleOnArtifact)({
+        artifactState,
+        onProgress: (progress) => {
+            artifactState = progress;
+            updateRenderProgress({ newline: false, printToConsole: true });
+        },
+        compositionId,
+    });
     const { value: codec, source: codecReason } = client_1.BrowserSafeApis.options.videoCodecOption.getValue({
         commandLine: parsed_cli_1.parsedCli,
     }, {
@@ -317,6 +328,7 @@ const renderVideoFlow = async ({ remotionRoot, fullEntryPoint, indent, logLevel,
             compositionStart: 0,
             forSeamlessAacConcatenation,
             onBrowserDownload,
+            onArtifact,
         });
         log_1.Log.info({ indent, logLevel }, chalk_1.chalk.blue(`▶ ${absoluteOutputFile}`));
         return;
@@ -400,6 +412,7 @@ const renderVideoFlow = async ({ remotionRoot, fullEntryPoint, indent, logLevel,
         forSeamlessAacConcatenation,
         compositionStart: 0,
         onBrowserDownload,
+        onArtifact,
     });
     if (!updatesDontOverwrite) {
         updateRenderProgress({ newline: true, printToConsole: true });

package/dist/render-flows/still.js

@@ -19,6 +19,7 @@ const get_composition_with_dimension_override_1 = require("../get-composition-wi
 const make_link_1 = require("../hyperlinks/make-link");
 const log_1 = require("../log");
 const make_on_download_1 = require("../make-on-download");
+const on_artifact_1 = require("../on-artifact");
 const parsed_cli_1 = require("../parsed-cli");
 const progress_bar_1 = require("../progress-bar");
 const progress_types_1 = require("../progress-types");
@@ -38,10 +39,10 @@ const renderStillFlow = async ({ remotionRoot, fullEntryPoint, entryPointReason,
         updatesDontOverwrite: (0, should_use_non_overlaying_logger_1.shouldUseNonOverlayingLogger)({ logLevel }),
         indent,
     });
-    const updateRenderProgress = ({ newline, printToConsole, isUsingParallelEncoding, }) => {
+    const updateRenderProgress = ({ newline, printToConsole, }) => {
         const { output, progress, message } = (0, progress_bar_1.makeRenderingAndStitchingProgress)({
             prog: aggregate,
-            isUsingParallelEncoding,
+            isUsingParallelEncoding: false,
         });
         if (printToConsole) {
             renderProgress.update(updatesDontOverwrite ? message : output, newline);
@@ -79,7 +80,6 @@ const renderStillFlow = async ({ remotionRoot, fullEntryPoint, entryPointReason,
             updateRenderProgress({
                 newline: false,
                 printToConsole: true,
-                isUsingParallelEncoding: false,
             });
         },
         indentOutput: indent,
@@ -189,7 +189,6 @@ const renderStillFlow = async ({ remotionRoot, fullEntryPoint, entryPointReason,
     updateRenderProgress({
         newline: false,
         printToConsole: true,
-        isUsingParallelEncoding: false,
     });
     const onDownload = (0, make_on_download_1.makeOnDownload)({
         downloads: aggregate.downloads,
@@ -199,6 +198,17 @@ const renderStillFlow = async ({ remotionRoot, fullEntryPoint, entryPointReason,
         updatesDontOverwrite,
         isUsingParallelEncoding: false,
     });
+    const { onArtifact } = (0, on_artifact_1.handleOnArtifact)({
+        artifactState: aggregate.artifactState,
+        compositionId,
+        onProgress: (progress) => {
+            aggregate.artifactState = progress;
+            updateRenderProgress({
+                newline: false,
+                printToConsole: true,
+            });
+        },
+    });
     await renderer_1.RenderInternals.internalRenderStill({
         composition: config,
         frame: stillFrame,
@@ -229,6 +239,7 @@ const renderStillFlow = async ({ remotionRoot, fullEntryPoint, entryPointReason,
         offthreadVideoCacheSizeInBytes,
         binariesDirectory,
         onBrowserDownload,
+        onArtifact,
     });
     aggregate.rendering = {
         frames: 1,
@@ -239,7 +250,6 @@ const renderStillFlow = async ({ remotionRoot, fullEntryPoint, entryPointReason,
     updateRenderProgress({
         newline: true,
         printToConsole: true,
-        isUsingParallelEncoding: false,
     });
     log_1.Log.info({ indent, logLevel }, chalk_1.chalk.blue(`${(exists ? '○' : '+').padEnd(progress_bar_1.LABEL_WIDTH)} ${(0, make_link_1.makeHyperlink)({ url: 'file://' + absoluteOutputLocation, text: relativeOutputLocation, fallback: relativeOutputLocation })}`));
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remotion/cli",
-  "version": "4.0.174",
+  "version": "4.0.176",
   "description": "CLI for Remotion",
   "main": "dist/index.js",
   "sideEffects": false,
@@ -32,14 +32,14 @@
     "dotenv": "9.0.2",
     "minimist": "1.2.6",
     "prompts": "2.4.2",
-    "@remotion/bundler": "4.0.174",
-    "@remotion/renderer": "4.0.174",
-    "@remotion/studio": "4.0.174",
-    "@remotion/media-utils": "4.0.174",
-    "@remotion/player": "4.0.174",
-    "remotion": "4.0.174",
-    "@remotion/studio-shared": "4.0.174",
-    "@remotion/studio-server": "4.0.174"
+    "@remotion/bundler": "4.0.176",
+    "@remotion/media-utils": "4.0.176",
+    "@remotion/player": "4.0.176",
+    "@remotion/studio-server": "4.0.176",
+    "@remotion/studio-shared": "4.0.176",
+    "@remotion/renderer": "4.0.176",
+    "@remotion/studio": "4.0.176",
+    "remotion": "4.0.176"
   },
   "peerDependencies": {
     "react": ">=16.8.0",
@@ -63,10 +63,10 @@
     "react-dom": "18.3.1",
     "vitest": "0.31.1",
     "zod": "3.22.3",
-    "@remotion/zod-types": "4.0.174",
-    "@remotion/tailwind": "4.0.174",
-    "@remotion/enable-scss": "4.0.174",
-    "@remotion/skia": "4.0.174"
+    "@remotion/zod-types": "4.0.176",
+    "@remotion/tailwind": "4.0.176",
+    "@remotion/skia": "4.0.176",
+    "@remotion/enable-scss": "4.0.176"
   },
   "keywords": [
     "remotion",