@remotion/renderer 4.0.0-alpha.4 → 4.0.0-alpha11

package/dist/compositor/compose.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.callCompositor = exports.compose = exports.serializeCommand = void 0;
+const node_child_process_1 = require("node:child_process");
+const node_crypto_1 = require("node:crypto");
+const node_fs_1 = require("node:fs");
+const promises_1 = require("node:fs/promises");
+const call_ffmpeg_1 = require("../call-ffmpeg");
+const get_executable_path_1 = require("./get-executable-path");
+const make_nonce_1 = require("./make-nonce");
+const getCompositorHash = ({ ...input }) => {
+    return (0, node_crypto_1.createHash)('sha256').update(JSON.stringify(input)).digest('base64');
+};
+const serializeCommand = (command, params) => {
+    return {
+        nonce: (0, make_nonce_1.makeNonce)(),
+        payload: {
+            type: command,
+            params,
+        },
+    };
+};
+exports.serializeCommand = serializeCommand;
+const compose = async ({ height, width, layers, output, downloadMap, imageFormat, compositor, }) => {
+    const hash = getCompositorHash({ height, width, layers, imageFormat });
+    if (downloadMap.compositorCache[hash]) {
+        await (0, promises_1.copyFile)(downloadMap.compositorCache[hash], output);
+        return;
+    }
+    await compositor.executeCommand('Compose', {
+        height,
+        width,
+        layers,
+        output,
+        output_format: imageFormat,
+    });
+    downloadMap.compositorCache[hash] = output;
+};
+exports.compose = compose;
+const callCompositor = (payload) => {
+    return new Promise((resolve, reject) => {
+        const execPath = (0, get_executable_path_1.getExecutablePath)('compositor');
+        if (!process.env.READ_ONLY_FS) {
+            (0, node_fs_1.chmodSync)(execPath, 0o755);
+        }
+        const child = (0, node_child_process_1.spawn)(execPath, [payload], (0, call_ffmpeg_1.dynamicLibraryPathOptions)());
+        const stderrChunks = [];
+        child.stderr.on('data', (d) => stderrChunks.push(d));
+        child.on('close', (code) => {
+            if (code === 0) {
+                resolve();
+            }
+            else {
+                const message = Buffer.concat(stderrChunks).toString('utf-8');
+                try {
+                    // Try to see if the error is a JSON
+                    const parsed = JSON.parse(message);
+                    const msg = `Compositor error: ${parsed.error}`;
+                    const err = new Error(`${msg}\n${parsed.backtrace}`);
+                    reject(err);
+                }
+                catch (err) {
+                    reject(new Error(`Compositor panicked: ${message}`));
+                }
+            }
+        });
+        child.stdin.write(payload);
+        child.stdin.end();
+    });
+};
+exports.callCompositor = callCompositor;

package/dist/compositor/compositor.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="node" />
+import type { CompositorCommand } from './payloads';
+export declare type Compositor = {
+    finishCommands: () => void;
+    executeCommand: <T extends keyof CompositorCommand>(type: T, payload: CompositorCommand[T]) => Promise<Buffer>;
+    waitForDone: () => Promise<void>;
+    pid: number | null;
+};
+export declare const getIdealMaximumFrameCacheItems: () => number;
+export declare const startLongRunningCompositor: (maximumFrameCacheItems: number, verbose: boolean, indent: boolean) => Compositor;
+export declare const startCompositor: <T extends keyof CompositorCommand>(type: T, payload: CompositorCommand[T], indent: boolean) => Compositor;

package/dist/compositor/compositor.js

@@ -0,0 +1,207 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.startCompositor = exports.startLongRunningCompositor = exports.getIdealMaximumFrameCacheItems = void 0;
+const node_child_process_1 = require("node:child_process");
+const node_fs_1 = require("node:fs");
+const node_os_1 = __importDefault(require("node:os"));
+const call_ffmpeg_1 = require("../call-ffmpeg");
+const get_concurrency_1 = require("../get-concurrency");
+const logger_1 = require("../logger");
+const compose_1 = require("./compose");
+const get_executable_path_1 = require("./get-executable-path");
+const make_nonce_1 = require("./make-nonce");
+const getIdealMaximumFrameCacheItems = () => {
+    const freeMemory = node_os_1.default.freemem();
+    // Assuming 1 frame is approximately 6MB
+    // Assuming only half the available memory should be used
+    const max = Math.floor(freeMemory / (1024 * 1024 * 6));
+    // Never store more than 1000 frames
+    // But 100 is needed even if it's going to swap
+    return Math.max(100, Math.min(max, 1000));
+};
+exports.getIdealMaximumFrameCacheItems = getIdealMaximumFrameCacheItems;
+const startLongRunningCompositor = (maximumFrameCacheItems, verbose, indent) => {
+    return (0, exports.startCompositor)('StartLongRunningProcess', {
+        concurrency: (0, get_concurrency_1.getActualConcurrency)(null),
+        maximum_frame_cache_items: maximumFrameCacheItems,
+        verbose,
+    }, indent);
+};
+exports.startLongRunningCompositor = startLongRunningCompositor;
+const startCompositor = (type, payload, indent) => {
+    var _a;
+    const bin = (0, get_executable_path_1.getExecutablePath)('compositor');
+    if (!process.env.READ_ONLY_FS) {
+        (0, node_fs_1.chmodSync)(bin, 0o755);
+    }
+    const fullCommand = (0, compose_1.serializeCommand)(type, payload);
+    const child = (0, node_child_process_1.spawn)(bin, [JSON.stringify(fullCommand)], (0, call_ffmpeg_1.dynamicLibraryPathOptions)());
+    const stderrChunks = [];
+    let outputBuffer = Buffer.from('');
+    const separator = Buffer.from('remotion_buffer:');
+    const waiters = new Map();
+    const onMessage = (statusType, nonce, data) => {
+        if (nonce === '0') {
+            logger_1.Log.verboseAdvanced({ indent, logLevel: (0, logger_1.getLogLevel)(), tag: 'COMPOSITOR' }, data.toString('utf8'));
+        }
+        if (waiters.has(nonce)) {
+            if (statusType === 'error') {
+                try {
+                    const parsed = JSON.parse(data.toString('utf8'));
+                    waiters.get(nonce).reject(new Error(`Compositor error: ${parsed.error}\n${parsed.backtrace}`));
+                }
+                catch (err) {
+                    waiters.get(nonce).reject(new Error(data.toString('utf8')));
+                }
+            }
+            else {
+                waiters.get(nonce).resolve(data);
+            }
+            waiters.delete(nonce);
+        }
+    };
+    let quit = false;
+    let missingData = null;
+    const processInput = () => {
+        let separatorIndex = outputBuffer.indexOf(separator);
+        if (separatorIndex === -1) {
+            return;
+        }
+        separatorIndex += separator.length;
+        let nonceString = '';
+        let lengthString = '';
+        let statusString = '';
+        // Each message from Rust is prefixed with `remotion_buffer;{[nonce]}:{[length]}`
+        // Let's read the buffer to extract the nonce, and if the full length is available,
+        // we'll extract the data and pass it to the callback.
+        // eslint-disable-next-line no-constant-condition
+        while (true) {
+            const nextDigit = outputBuffer[separatorIndex];
+            // 0x3a is the character ":"
+            if (nextDigit === 0x3a) {
+                separatorIndex++;
+                break;
+            }
+            separatorIndex++;
+            nonceString += String.fromCharCode(nextDigit);
+        }
+        // eslint-disable-next-line no-constant-condition
+        while (true) {
+            const nextDigit = outputBuffer[separatorIndex];
+            if (nextDigit === 0x3a) {
+                separatorIndex++;
+                break;
+            }
+            separatorIndex++;
+            lengthString += String.fromCharCode(nextDigit);
+        }
+        // eslint-disable-next-line no-constant-condition
+        while (true) {
+            const nextDigit = outputBuffer[separatorIndex];
+            if (nextDigit === 0x3a) {
+                break;
+            }
+            separatorIndex++;
+            statusString += String.fromCharCode(nextDigit);
+        }
+        const length = Number(lengthString);
+        const status = Number(statusString);
+        const dataLength = outputBuffer.length - separatorIndex - 1;
+        if (dataLength < length) {
+            missingData = {
+                dataMissing: length - dataLength,
+            };
+            return;
+        }
+        const data = outputBuffer.subarray(separatorIndex + 1, separatorIndex + 1 + Number(lengthString));
+        onMessage(status === 1 ? 'error' : 'success', nonceString, data);
+        missingData = null;
+        outputBuffer = outputBuffer.subarray(separatorIndex + Number(lengthString) + 1);
+        processInput();
+    };
+    let unprocessedBuffers = [];
+    child.stdout.on('data', (data) => {
+        unprocessedBuffers.push(data);
+        const separatorIndex = data.indexOf(separator);
+        if (separatorIndex === -1) {
+            if (missingData) {
+                missingData.dataMissing -= data.length;
+            }
+            if (!missingData || missingData.dataMissing > 0) {
+                return;
+            }
+        }
+        unprocessedBuffers.unshift(outputBuffer);
+        outputBuffer = Buffer.concat(unprocessedBuffers);
+        unprocessedBuffers = [];
+        processInput();
+    });
+    child.stderr.on('data', (data) => {
+        stderrChunks.push(data);
+    });
+    let resolve = null;
+    let reject = null;
+    child.on('close', (code) => {
+        quit = true;
+        const waitersToKill = Array.from(waiters.values());
+        if (code === 0) {
+            resolve === null || resolve === void 0 ? void 0 : resolve();
+            for (const waiter of waitersToKill) {
+                waiter.reject(new Error(`Compositor already quit`));
+            }
+            waiters.clear();
+        }
+        else {
+            const error = new Error(`Compositor panicked: ${Buffer.concat(stderrChunks).toString('utf-8')}`);
+            for (const waiter of waitersToKill) {
+                waiter.reject(error);
+            }
+            waiters.clear();
+            reject === null || reject === void 0 ? void 0 : reject(error);
+        }
+    });
+    return {
+        waitForDone: () => {
+            return new Promise((res, rej) => {
+                if (quit) {
+                    rej(new Error('Compositor already quit'));
+                    return;
+                }
+                resolve = res;
+                reject = rej;
+            });
+        },
+        finishCommands: () => {
+            if (quit) {
+                throw new Error('Compositor already quit');
+            }
+            child.stdin.write('EOF\n');
+        },
+        executeCommand: (command, params) => {
+            if (quit) {
+                throw new Error('Compositor already quit');
+            }
+            return new Promise((_resolve, _reject) => {
+                const nonce = (0, make_nonce_1.makeNonce)();
+                const composed = {
+                    nonce,
+                    payload: {
+                        type: command,
+                        params,
+                    },
+                };
+                // TODO: Should have a way to error out a single task
+                child.stdin.write(JSON.stringify(composed) + '\n');
+                waiters.set(nonce, {
+                    resolve: _resolve,
+                    reject: _reject,
+                });
+            });
+        },
+        pid: (_a = child.pid) !== null && _a !== void 0 ? _a : null,
+    };
+};
+exports.startCompositor = startCompositor;

package/dist/compositor/get-executable-path.d.ts

@@ -0,0 +1 @@
+export declare const getExecutablePath: (type: 'compositor' | 'ffmpeg' | 'ffprobe' | 'ffmpeg-cwd') => string;

package/dist/compositor/get-executable-path.js

@@ -0,0 +1,57 @@
+"use strict";
+// Adapted from @swc/core package
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getExecutablePath = void 0;
+function isMusl() {
+    // @ts-expect-error no types
+    const { glibcVersionRuntime } = process.report.getReport().header;
+    return !glibcVersionRuntime;
+}
+const getExecutablePath = (type) => {
+    if (type === 'compositor' && process.env.COMPOSITOR_PATH) {
+        return process.env.COMPOSITOR_PATH;
+    }
+    const key = type === 'compositor'
+        ? 'binaryPath'
+        : type === 'ffmpeg'
+            ? 'ffmpegPath'
+            : type === 'ffprobe'
+                ? 'ffprobePath'
+                : 'ffmpegCwd';
+    switch (process.platform) {
+        case 'win32':
+            switch (process.arch) {
+                case 'x64':
+                    return require('@remotion/compositor-win32-x64-msvc')[key];
+                default:
+                    throw new Error(`Unsupported architecture on Windows: ${process.arch}`);
+            }
+        case 'darwin':
+            switch (process.arch) {
+                case 'x64':
+                    return require('@remotion/compositor-darwin-x64')[key];
+                case 'arm64':
+                    return require('@remotion/compositor-darwin-arm64')[key];
+                default:
+                    throw new Error(`Unsupported architecture on macOS: ${process.arch}`);
+            }
+        case 'linux':
+            switch (process.arch) {
+                case 'x64':
+                    if (isMusl()) {
+                        return require('@remotion/compositor-linux-x64-musl')[key];
+                    }
+                    return require('@remotion/compositor-linux-x64-gnu')[key];
+                case 'arm64':
+                    if (isMusl()) {
+                        return require('@remotion/compositor-linux-arm64-musl')[key];
+                    }
+                    return require('@remotion/compositor-linux-arm64-gnu')[key];
+                default:
+                    throw new Error(`Unsupported architecture on Linux: ${process.arch}`);
+            }
+        default:
+            throw new Error(`Unsupported OS: ${process.platform}, architecture: ${process.arch}`);
+    }
+};
+exports.getExecutablePath = getExecutablePath;

package/dist/compositor/make-nonce.d.ts

@@ -0,0 +1 @@
+export declare const makeNonce: () => string;

package/dist/compositor/make-nonce.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeNonce = void 0;
+const makeNonce = () => {
+    return (Math.random().toString(36).substring(2, 15) +
+        Math.random().toString(36).substring(2, 15));
+};
+exports.makeNonce = makeNonce;

package/dist/compositor/payloads.d.ts

@@ -0,0 +1,68 @@
+export declare type Layer = {
+    type: 'PngImage';
+    params: {
+        src: string;
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+} | {
+    type: 'JpgImage';
+    params: {
+        src: string;
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+} | {
+    type: 'Solid';
+    params: {
+        fill: [number, number, number, number];
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+};
+export declare type CompositorImageFormat = 'Png' | 'Jpeg';
+export declare type CompositorCommand = {
+    Compose: {
+        output: string;
+        width: number;
+        height: number;
+        layers: Layer[];
+        output_format: CompositorImageFormat;
+    };
+    ExtractFrame: {
+        input: string;
+        time: number;
+        transparent: boolean;
+    };
+    Echo: {
+        message: string;
+    };
+    StartLongRunningProcess: {
+        concurrency: number;
+        maximum_frame_cache_items: number;
+        verbose: boolean;
+    };
+    GetOpenVideoStats: {};
+    DeliberatePanic: {};
+    CloseAllVideos: {};
+    FreeUpMemory: {
+        percent_of_memory: number;
+    };
+};
+export declare type CompositorCommandSerialized<T extends keyof CompositorCommand> = {
+    nonce: string;
+    payload: {
+        type: T;
+        params: CompositorCommand[T];
+    };
+};
+export declare type ErrorPayload = {
+    error: string;
+    backtrace: string;
+};

package/dist/compositor/payloads.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/convert-to-positive-frame-index.d.ts

@@ -0,0 +1,4 @@
+export declare const convertToPositiveFrameIndex: ({ frame, durationInFrames, }: {
+    frame: number;
+    durationInFrames: number;
+}) => number;

package/dist/convert-to-positive-frame-index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertToPositiveFrameIndex = void 0;
+// Handle negative indices (e.g. -1 being the last frame)
+const convertToPositiveFrameIndex = ({ frame, durationInFrames, }) => {
+    return frame < 0 ? durationInFrames - frame : frame;
+};
+exports.convertToPositiveFrameIndex = convertToPositiveFrameIndex;

package/dist/create-ffmpeg-complex-filter.d.ts

@@ -1,8 +1,9 @@
 import type { DownloadMap } from './assets/download-map';
-export declare const createFfmpegComplexFilter: (filters: number, downloadMap: DownloadMap) => Promise<{
-    complexFilterFlag: [
-        string,
-        string
-    ] | null;
+import type { PreprocessedAudioTrack } from './preprocess-audio-track';
+export declare const createFfmpegComplexFilter: ({ filters, downloadMap, }: {
+    filters: PreprocessedAudioTrack[];
+    downloadMap: DownloadMap;
+}) => Promise<{
+    complexFilterFlag: [string, string] | null;
     cleanup: () => void;
 }>;

package/dist/create-ffmpeg-complex-filter.js

@@ -3,12 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createFfmpegComplexFilter = void 0;
 const create_ffmpeg_merge_filter_1 = require("./create-ffmpeg-merge-filter");
 const ffmpeg_filter_file_1 = require("./ffmpeg-filter-file");
-const createFfmpegComplexFilter = async (filters, downloadMap) => {
-    if (filters === 0) {
+const createFfmpegComplexFilter = async ({ filters, downloadMap, }) => {
+    if (filters.length === 0) {
         return { complexFilterFlag: null, cleanup: () => undefined };
     }
-    const complexFilter = (0, create_ffmpeg_merge_filter_1.createFfmpegMergeFilter)(filters);
-    const { file, cleanup } = await (0, ffmpeg_filter_file_1.makeFfmpegFilterFile)(complexFilter, downloadMap);
+    const complexFilter = (0, create_ffmpeg_merge_filter_1.createFfmpegMergeFilter)({
+        inputs: filters,
+    });
+    const { file, cleanup } = await (0, ffmpeg_filter_file_1.makeFfmpegFilterFileStr)(complexFilter, downloadMap);
     return {
         complexFilterFlag: ['-filter_complex_script', file],
         cleanup,

package/dist/create-ffmpeg-merge-filter.d.ts

@@ -1 +1,5 @@
-export declare const createFfmpegMergeFilter: (inputs: number) => string;
+import type { PreprocessedAudioTrack } from './preprocess-audio-track';
+export declare const OUTPUT_FILTER_NAME = "outputaudio";
+export declare const createFfmpegMergeFilter: ({ inputs, }: {
+    inputs: PreprocessedAudioTrack[];
+}) => string;

package/dist/create-ffmpeg-merge-filter.js

@@ -1,18 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createFfmpegMergeFilter = void 0;
+exports.createFfmpegMergeFilter = exports.OUTPUT_FILTER_NAME = void 0;
 const truthy_1 = require("./truthy");
-const createFfmpegMergeFilter = (inputs) => {
-    const leftChannel = new Array(inputs * 2)
-        .fill(true)
-        .map((_, i) => (i % 2 === 0 ? `c${i}` : null))
-        .filter(truthy_1.truthy)
-        .join('+');
-    const rightChannel = new Array(inputs * 2)
-        .fill(true)
-        .map((_, i) => (i % 2 === 1 ? `c${i}` : null))
-        .filter(truthy_1.truthy)
-        .join('+');
-    return `[0:a][1:a]amerge=inputs=${inputs},pan=stereo|c0=${leftChannel}|c1=${rightChannel}[a]`;
+exports.OUTPUT_FILTER_NAME = 'outputaudio';
+const createFfmpegMergeFilter = ({ inputs, }) => {
+    const pads = inputs.map((input, index) => {
+        const filters = [
+            input.filter.pad_start ? input.filter.pad_start : null,
+            input.filter.pad_end ? input.filter.pad_end : null,
+            'acopy',
+        ];
+        return `[${index}:a]${filters.filter(truthy_1.truthy).join(',')}[padded${index}]`;
+    });
+    const normalize = ':normalize=0';
+    return [
+        ...pads,
+        `${new Array(inputs.length)
+            .fill(true)
+            .map((_, i) => {
+            return `[padded${i}]`;
+        })
+            .join('')}amix=inputs=${inputs.length}:dropout_transition=0${normalize}[${exports.OUTPUT_FILTER_NAME}]`,
+    ].join(';');
 };
 exports.createFfmpegMergeFilter = createFfmpegMergeFilter;

package/dist/create-silent-audio.d.ts

@@ -1,6 +1,4 @@
-import type { FfmpegExecutable } from './ffmpeg-executable';
-export declare const createSilentAudio: ({ ffmpegExecutable, numberOfSeconds, outName, }: {
-    ffmpegExecutable: FfmpegExecutable;
+export declare const createSilentAudio: ({ numberOfSeconds, outName, }: {
     numberOfSeconds: number;
     outName: string;
 }) => Promise<void>;

package/dist/create-silent-audio.js

@@ -1,13 +1,10 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createSilentAudio = void 0;
-const execa_1 = __importDefault(require("execa"));
+const call_ffmpeg_1 = require("./call-ffmpeg");
 const sample_rate_1 = require("./sample-rate");
-const createSilentAudio = async ({ ffmpegExecutable, numberOfSeconds, outName, }) => {
-    await (0, execa_1.default)(ffmpegExecutable !== null && ffmpegExecutable !== void 0 ? ffmpegExecutable : 'ffmpeg', [
+const createSilentAudio = async ({ numberOfSeconds, outName, }) => {
+    await (0, call_ffmpeg_1.callFf)('ffmpeg', [
         '-f',
         'lavfi',
         '-i',

package/dist/crf.d.ts

@@ -2,4 +2,8 @@ import type { Codec } from './codec';
 export declare type Crf = number | undefined;
 export declare const getDefaultCrfForCodec: (codec: Codec) => number;
 export declare const getValidCrfRanges: (codec: Codec) => [number, number];
-export declare const validateSelectedCrfAndCodecCombination: (crf: unknown, codec: Codec) => void;
+export declare const validateQualitySettings: ({ codec, crf, videoBitrate, }: {
+    crf: unknown;
+    codec: Codec;
+    videoBitrate: string | null | undefined;
+}) => string[];