@remotion/renderer 3.3.53 → 3.3.55

package/dist/ensure-ffmpeg.d.ts

@@ -5,6 +5,14 @@ declare type Result = {
     result: 'found-in-path' | 'found-in-node-modules' | 'installed';
     wasAlreadyInstalled: boolean;
 };
+/**
+ * @description Checks if the ffmpeg binary is installed and if it is not, downloads it and puts it into your node_modules folder.
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/ensure-ffmpeg)
+ */
 export declare const ensureFfmpeg: (options?: EnsureFfmpegOptions) => Promise<Result>;
+/**
+ * @description Checks if the ffprobe binary is installed and if it is not, downloads it and puts it into your node_modules folder.
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/ensure-ffprobe)
+ */
 export declare const ensureFfprobe: (options?: EnsureFfmpegOptions) => Promise<Result>;
 export {};

package/dist/ensure-ffmpeg.js

@@ -40,10 +40,18 @@ const ensureFfmpegOrFfprobe = async (binary, options) => {
     }
     throw new Error(`${binary} could not be installed automatically. Your architecture and OS combination (os = ${os_1.default.platform()}, arch = ${process.arch}) is not supported. Please install ${binary} manually and add "${binary}" to your PATH.`);
 };
+/**
+ * @description Checks if the ffmpeg binary is installed and if it is not, downloads it and puts it into your node_modules folder.
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/ensure-ffmpeg)
+ */
 const ensureFfmpeg = (options) => {
     return ensureFfmpegOrFfprobe('ffmpeg', options);
 };
 exports.ensureFfmpeg = ensureFfmpeg;
+/**
+ * @description Checks if the ffprobe binary is installed and if it is not, downloads it and puts it into your node_modules folder.
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/ensure-ffprobe)
+ */
 const ensureFfprobe = (options) => {
     return ensureFfmpegOrFfprobe('ffprobe', options);
 };

package/dist/extract-frame-from-video.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { OffthreadVideoImageFormat } from 'remotion';
 import type { DownloadMap } from './assets/download-map';
 import type { FfmpegExecutable } from './ffmpeg-executable';

package/dist/get-can-extract-frames-fast.d.ts

@@ -1,5 +1,9 @@
 import type { FfmpegExecutable } from './ffmpeg-executable';
 export declare const ACCEPTABLE_OFFSET_THRESHOLD = 50;
+/**
+ * @description Probes whether frames of a video can be efficiently extracted when using <OffthreadVideo>.
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/get-can-extract-frames-fast)
+ */
 export declare const getCanExtractFramesFast: ({ src, ffmpegExecutable, ffprobeExecutable, }: {
     src: string;
     ffmpegExecutable?: FfmpegExecutable | undefined;

package/dist/get-can-extract-frames-fast.js

@@ -11,6 +11,10 @@ const find_closest_package_json_1 = require("./find-closest-package-json");
 const get_video_info_1 = require("./get-video-info");
 const try_to_extract_frame_of_video_fast_1 = require("./try-to-extract-frame-of-video-fast");
 exports.ACCEPTABLE_OFFSET_THRESHOLD = 50;
+/**
+ * @description Probes whether frames of a video can be efficiently extracted when using <OffthreadVideo>.
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/get-can-extract-frames-fast)
+ */
 const getCanExtractFramesFast = async ({ src, ffmpegExecutable, ffprobeExecutable, }) => {
     const remotionRoot = (0, find_closest_package_json_1.findRemotionRoot)();
     const out = await (0, ensure_presentation_timestamp_1.ensurePresentationTimestampWithoutCache)({

package/dist/get-compositions.d.ts

@@ -21,5 +21,9 @@ declare type GetCompositionsConfig = {
      */
     downloadMap?: DownloadMap;
 };
+/**
+ * @description Gets the compositions defined in a Remotion project based on a Webpack bundle.
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/get-compositions)
+ */
 export declare const getCompositions: (serveUrlOrWebpackUrl: string, config?: GetCompositionsConfig) => Promise<TCompMetadata[]>;
 export {};

package/dist/get-compositions.js

@@ -56,6 +56,10 @@ const innerGetCompositions = async (serveUrl, page, config, proxyPort) => {
     });
     return result;
 };
+/**
+ * @description Gets the compositions defined in a Remotion project based on a Webpack bundle.
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/get-compositions)
+ */
 const getCompositions = async (serveUrlOrWebpackUrl, config) => {
     var _a, _b, _c, _d, _e;
     await (0, validate_ffmpeg_1.validateFfmpeg)((_a = config === null || config === void 0 ? void 0 : config.ffmpegExecutable) !== null && _a !== void 0 ? _a : null, (0, find_closest_package_json_1.findRemotionRoot)(), 'ffmpeg');

package/dist/get-frame-of-video-slow.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { OffthreadVideoImageFormat } from 'remotion';
 import type { SpecialVCodecForTransparency } from './assets/download-map';
 import type { FfmpegExecutable } from './ffmpeg-executable';
@@ -8,7 +7,10 @@ export declare const getFrameOfVideoSlow: ({ src, duration, ffmpegExecutable, im
     duration: number;
     imageFormat: OffthreadVideoImageFormat;
     specialVCodecForTransparency: SpecialVCodecForTransparency;
-    needsResize: [number, number] | null;
+    needsResize: [
+        number,
+        number
+    ] | null;
     offset: number;
     fps: number | null;
     remotionRoot: string;

package/dist/index.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import execa from 'execa';
 import { SymbolicateableError } from './error-handling/symbolicateable-error';
 import { mimeContentType, mimeLookup } from './mime-types';

package/dist/last-frame-from-video-cache.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { OffthreadVideoImageFormat } from 'remotion';
 import type { DownloadMap, SpecialVCodecForTransparency } from './assets/download-map';
 import type { FfmpegExecutable } from './ffmpeg-executable';

package/dist/make-cancel-signal.d.ts

@@ -1,5 +1,9 @@
 declare type Callback = () => void;
 export declare type CancelSignal = (callback: Callback) => void;
+/**
+ * @description Returns a signal and a cancel function that allows to you cancel a render triggered using renderMedia(), renderStill(), renderFrames() or stitchFramesToVideo().
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/make-cancel-signal)
+ */
 export declare const makeCancelSignal: () => {
     cancelSignal: CancelSignal;
     cancel: () => void;

package/dist/make-cancel-signal.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isUserCancelledRender = exports.cancelErrorMessages = exports.makeCancelSignal = void 0;
+/**
+ * @description Returns a signal and a cancel function that allows to you cancel a render triggered using renderMedia(), renderStill(), renderFrames() or stitchFramesToVideo().
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/make-cancel-signal)
+ */
 const makeCancelSignal = () => {
     const callbacks = [];
     let cancelled = false;

package/dist/open-browser.d.ts

@@ -10,6 +10,10 @@ export declare type ChromiumOptions = {
     headless?: boolean;
 };
 export declare const killAllBrowsers: () => Promise<void>;
+/**
+ * @description Opens a Chrome or Chromium browser instance.
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/open-browser)
+ */
 export declare const openBrowser: (browser: Browser, options?: {
     shouldDumpIo?: boolean;
     browserExecutable?: string | null;

package/dist/open-browser.js

@@ -27,6 +27,10 @@ const killAllBrowsers = async () => {
     }
 };
 exports.killAllBrowsers = killAllBrowsers;
+/**
+ * @description Opens a Chrome or Chromium browser instance.
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/open-browser)
+ */
 const openBrowser = async (browser, options) => {
     var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
     if (browser === 'firefox') {

package/dist/provide-screenshot.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { ClipRegion } from 'remotion';
 import type { Page } from './browser/BrowserPage';
 import type { ImageFormat } from './image-format';

package/dist/puppeteer-screenshot.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { ClipRegion } from 'remotion';
 import type { Page } from './browser/BrowserPage';
 export declare const screenshot: (options: {

package/dist/render-frames.d.ts

@@ -57,5 +57,9 @@ declare type RenderFramesOptions = {
     downloadMap?: DownloadMap;
     muted?: boolean;
 } & ConfigOrComposition & ConcurrencyOrParallelism & ServeUrlOrWebpackBundle;
+/**
+ * @description Renders a series of images using Puppeteer and computes information for mixing audio.
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/render-frames)
+ */
 export declare const renderFrames: (options: RenderFramesOptions) => Promise<RenderFramesOutput>;
 export {};

package/dist/render-frames.js

@@ -286,6 +286,10 @@ const innerRenderFrames = ({ onFrameUpdate, outputDir, onStart, inputProps, qual
     })
         .then(() => happyPath);
 };
+/**
+ * @description Renders a series of images using Puppeteer and computes information for mixing audio.
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/render-frames)
+ */
 const renderFrames = (options) => {
     var _a, _b, _c;
     const composition = getComposition(options);

package/dist/render-media.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { SmallTCompMetadata } from 'remotion';
 import type { RenderMediaOnDownload } from './assets/download-and-map-assets-to-file';
 import type { DownloadMap } from './assets/download-map';
@@ -88,7 +87,7 @@ declare type ConcurrencyOrParallelism = {
 /**
  *
  * @description Render a video from a composition
- * @link https://www.remotion.dev/docs/renderer/render-media
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/render-media)
  */
 export declare const renderMedia: ({ proResProfile, crf, composition, ffmpegExecutable, ffprobeExecutable, inputProps, pixelFormat, codec, envVariables, frameRange, puppeteerInstance, outputLocation, onProgress, overwrite, onDownload, dumpBrowserLogs, onBrowserLog, onStart, timeoutInMilliseconds, chromiumOptions, scale, browserExecutable, port, cancelSignal, muted, enforceAudioTrack, ffmpegOverride, audioBitrate, videoBitrate, onSlowestFrames, audioCodec, ...options }: RenderMediaOptions) => Promise<Buffer | null>;
 export {};

package/dist/render-media.js

@@ -53,7 +53,7 @@ const getConcurrency = (others) => {
 /**
  *
  * @description Render a video from a composition
- * @link https://www.remotion.dev/docs/renderer/render-media
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/render-media)
  */
 const renderMedia = ({ proResProfile, crf, composition, ffmpegExecutable, ffprobeExecutable, inputProps, pixelFormat, codec, envVariables, frameRange, puppeteerInstance, outputLocation, onProgress, overwrite, onDownload, dumpBrowserLogs, onBrowserLog, onStart, timeoutInMilliseconds, chromiumOptions, scale, browserExecutable, port, cancelSignal, muted, enforceAudioTrack, ffmpegOverride, audioBitrate, videoBitrate, onSlowestFrames, audioCodec, ...options }) => {
     var _a, _b, _c, _d, _e;

package/dist/render-still.d.ts

@@ -42,7 +42,7 @@ export declare type RenderStillOptions = InnerStillOptions & ServeUrlOrWebpackBu
 /**
  *
  * @description Render a still frame from a composition
- * @link https://www.remotion.dev/docs/renderer/render-still
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/render-still)
  */
 export declare const renderStill: (options: RenderStillOptions) => Promise<RenderStillReturnValue>;
 export {};

package/dist/render-still.js

@@ -169,7 +169,7 @@ const innerRenderStill = async ({ composition, quality, imageFormat = 'png', ser
 /**
  *
  * @description Render a still frame from a composition
- * @link https://www.remotion.dev/docs/renderer/render-still
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/render-still)
  */
 const renderStill = (options) => {
     var _a, _b;

package/dist/screenshot-dom-element.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { ClipRegion } from 'remotion';
 import type { Page } from './browser/BrowserPage';
 import type { ImageFormat } from './image-format';

package/dist/screenshot-task.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { ClipRegion } from 'remotion';
 import type { Page } from './browser/BrowserPage';
 import type { StillImageFormat } from './image-format';

package/dist/stitch-frames-to-video.d.ts

@@ -45,5 +45,9 @@ declare type ReturnType = {
     getLogs: () => string;
 };
 export declare const spawnFfmpeg: (options: StitcherOptions, remotionRoot: string) => Promise<ReturnType>;
+/**
+ * @description Takes a series of images and audio information generated by renderFrames() and encodes it to a video.
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/stitch-frames-to-video)
+ */
 export declare const stitchFramesToVideo: (options: StitcherOptions) => Promise<Buffer | null>;
 export {};

package/dist/stitch-frames-to-video.js

@@ -341,6 +341,10 @@ const spawnFfmpeg = async (options, remotionRoot) => {
     };
 };
 exports.spawnFfmpeg = spawnFfmpeg;
+/**
+ * @description Takes a series of images and audio information generated by renderFrames() and encodes it to a video.
+ * @see [Documentation](https://www.remotion.dev/docs/renderer/stitch-frames-to-video)
+ */
 const stitchFramesToVideo = async (options) => {
     const remotionRoot = (0, find_closest_package_json_1.findRemotionRoot)();
     const { task, getLogs } = await (0, exports.spawnFfmpeg)(options, remotionRoot);

package/dist/take-frame-and-compose.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { TAsset } from 'remotion';
 import type { DownloadMap } from './assets/download-map';
 import type { Page } from './browser/BrowserPage';

package/dist/try-to-extract-frame-of-video-fast.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { OffthreadVideoImageFormat } from 'remotion';
 import type { NeedsResize, SpecialVCodecForTransparency } from './assets/download-map';
 import type { FfmpegExecutable } from './ffmpeg-executable';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@remotion/renderer",
-	"version": "3.3.53",
+	"version": "3.3.55",
 	"description": "Renderer for Remotion",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
@@ -24,7 +24,7 @@
 	"dependencies": {
 		"execa": "5.1.1",
 		"extract-zip": "2.0.1",
-		"remotion": "3.3.53",
+		"remotion": "3.3.55",
 		"source-map": "^0.8.0-beta.0",
 		"ws": "8.7.0"
 	},
@@ -49,13 +49,13 @@
 		"vitest": "0.24.3"
 	},
 	"optionalDependencies": {
-		"@remotion/compositor-darwin-arm64": "3.3.53",
-		"@remotion/compositor-darwin-x64": "3.3.53",
-		"@remotion/compositor-linux-arm64-gnu": "3.3.53",
-		"@remotion/compositor-linux-arm64-musl": "3.3.53",
-		"@remotion/compositor-linux-x64-gnu": "3.3.53",
-		"@remotion/compositor-linux-x64-musl": "3.3.53",
-		"@remotion/compositor-win32-x64-msvc": "3.3.53"
+		"@remotion/compositor-darwin-arm64": "3.3.55",
+		"@remotion/compositor-darwin-x64": "3.3.55",
+		"@remotion/compositor-linux-arm64-gnu": "3.3.55",
+		"@remotion/compositor-linux-arm64-musl": "3.3.55",
+		"@remotion/compositor-linux-x64-gnu": "3.3.55",
+		"@remotion/compositor-linux-x64-musl": "3.3.55",
+		"@remotion/compositor-win32-x64-msvc": "3.3.55"
 	},
 	"keywords": [
 		"remotion",
@@ -67,5 +67,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "b6d64c3ec91b55ac537765fda0b927c3a472b529"
+	"gitHead": "4cecccc293e9c906c693f55fac65df8f1cfd2338"
 }

package/dist/get-audio-codec-name.d.ts

@@ -1,2 +0,0 @@
-import type { Codec } from './codec';
-export declare const getAudioCodecName: (codec: Codec) => string | null;

package/dist/get-audio-codec-name.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAudioCodecName = void 0;
-const is_audio_codec_1 = require("./is-audio-codec");
-const getAudioCodecName = (codec) => {
-    if (!(0, is_audio_codec_1.isAudioCodec)(codec)) {
-        // The mkv container supports WAV, but MP4 does only support
-        // AAC. Choose MKV codec for better quality because we can put in lossless audio
-        if (codec === 'h264-mkv') {
-            return 'pcm_s16le';
-        }
-        if (codec === 'vp8' || codec === 'vp9') {
-            return 'libopus';
-        }
-        return 'aac';
-    }
-    if (codec === 'aac') {
-        return 'aac';
-    }
-    if (codec === 'mp3') {
-        return 'libmp3lame';
-    }
-    if (codec === 'wav') {
-        return 'pcm_s16le';
-    }
-    return null;
-};
-exports.getAudioCodecName = getAudioCodecName;

package/dist/validate-frame.d.ts

@@ -1 +0,0 @@
-export declare const validateFrame: (frame: number, durationInFrames: number) => void;

package/dist/validate-frame.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateFrame = void 0;
-const validateFrame = (frame, durationInFrames) => {
-    if (typeof frame === 'undefined') {
-        throw new TypeError(`Argument missing for parameter "frame"`);
-    }
-    if (typeof frame !== 'number') {
-        throw new TypeError(`Argument passed for "frame" is not a number: ${frame}`);
-    }
-    if (!Number.isFinite(frame)) {
-        throw new RangeError(`Frame ${frame} is not finite`);
-    }
-    if (frame % 1 !== 0) {
-        throw new RangeError(`Argument for frame must be an integer, but got ${frame}`);
-    }
-    if (frame < 0 && frame < -durationInFrames) {
-        throw new RangeError(`Cannot use frame ${frame}: Duration of composition is ${durationInFrames}, therefore the lowest frame that can be rendered is ${-durationInFrames}`);
-    }
-    if (frame > durationInFrames - 1) {
-        throw new RangeError(`Cannot use frame ${frame}: Duration of composition is ${durationInFrames}, therefore the highest frame that can be rendered is ${durationInFrames - 1}`);
-    }
-};
-exports.validateFrame = validateFrame;