@remotion/lambda 4.0.47 → 4.0.49

package/LICENSE.md

@@ -7,7 +7,7 @@ Depending on the type of your legal entity, you are granted permission to use Re
 
 ## Free license
 
-Copyright © 2023 [Remotion](https://www.remotion.dev/)
+Copyright © 2023 [Remotion](https://www.remotion.dev)
 
 ### Eligibility
 
@@ -36,6 +36,10 @@ Support is provided on a best-we-can-do basis via GitHub Issues and Discord.
 
 ## Company license
 
-You are required to obtain a company license to use Remotion if you are not within the group of entities eligible for a free license. This license will enable you to use Remotion for the allowed use cases specified in the free license, and give you access to prioritized support (read the [Support Policy](/docs/support)).
+You are required to obtain a company license to use Remotion if you are not within the group of entities eligible for a free license. This license will enable you to use Remotion for the allowed use cases specified in the free license, and give you access to prioritized support (read the [Support Policy](https://www.remotion.dev/docs/support)).
 
-Visit [remotion.pro](https://www.remotion.pro) for pricing and to buy a license.
+Visit [remotion.pro](https://www.remotion.pro/license) for pricing and to buy a license.
+
+### FAQs
+
+Are you not sure whether you need a company license because of an edge case? Here are some [frequently asked questions](https://www.remotion.pro/faq).

package/dist/functions/streaming/streaming.d.ts

@@ -1,12 +1,60 @@
 /// <reference types="node" />
-type OnMessage = (type: 'error' | 'success', nonce: string, data: Buffer) => void;
-export declare const makeStreaming: (onMessage: OnMessage) => {
-    addData: (data: Buffer) => void;
+declare const framesRendered: "frames-rendered";
+declare const errorOccurred: "error-occurred";
+declare const renderIdDetermined: "render-id-determined";
+declare const chunkRendered: "chunk-rendered";
+declare const messageTypes: {
+    readonly '1': {
+        readonly type: "frames-rendered";
+    };
+    readonly '2': {
+        readonly type: "error-occurred";
+    };
+    readonly '3': {
+        readonly type: "render-id-determined";
+    };
+    readonly '4': {
+        readonly type: "chunk-rendered";
+    };
+};
+type MessageTypeId = keyof typeof messageTypes;
+type MessageType = (typeof messageTypes)[MessageTypeId]['type'];
+export declare const formatMap: {
+    [key in MessageType]: 'json' | 'binary';
 };
-export declare const makePayloadMessage: (nonce: number, data: Buffer, status: 0 | 1) => Buffer;
 export type StreamingPayload = {
-    type: 'frames-rendered';
-    frames: number;
+    type: typeof framesRendered;
+    payload: {
+        frames: number;
+    };
+} | {
+    type: typeof chunkRendered;
+    payload: Buffer;
+} | {
+    type: typeof errorOccurred;
+    payload: {
+        error: string;
+    };
+} | {
+    type: typeof renderIdDetermined;
+    payload: {
+        renderId: string;
+    };
+};
+export declare const messageTypeIdToMessage: (messageTypeId: MessageTypeId) => MessageType;
+export declare const messageTypeToMessageId: (messageType: MessageType) => MessageTypeId;
+export type OnMessage = (options: {
+    successType: 'error' | 'success';
+    message: StreamingPayload;
+}) => void;
+export declare const makeStreaming: (options: {
+    onMessage: OnMessage;
+}) => {
+    addData: (data: Buffer) => void;
 };
+export declare const makePayloadMessage: ({ message, status, }: {
+    message: StreamingPayload;
+    status: 0 | 1;
+}) => Buffer;
 export type OnStream = (payload: StreamingPayload) => void;
 export {};

package/dist/functions/streaming/streaming.js

@@ -1,21 +1,53 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makePayloadMessage = exports.makeStreaming = void 0;
-const makeStreaming = (onMessage) => {
+exports.makePayloadMessage = exports.makeStreaming = exports.messageTypeToMessageId = exports.messageTypeIdToMessage = exports.formatMap = void 0;
+const framesRendered = 'frames-rendered';
+const errorOccurred = 'error-occurred';
+const renderIdDetermined = 'render-id-determined';
+const chunkRendered = 'chunk-rendered';
+const messageTypes = {
+    '1': { type: framesRendered },
+    '2': { type: errorOccurred },
+    '3': { type: renderIdDetermined },
+    '4': { type: chunkRendered },
+};
+exports.formatMap = {
+    [framesRendered]: 'json',
+    [errorOccurred]: 'json',
+    [renderIdDetermined]: 'json',
+    [chunkRendered]: 'binary',
+};
+const messageTypeIdToMessage = (messageTypeId) => {
+    const types = messageTypes[messageTypeId];
+    if (!types) {
+        throw new Error(`Unknown message type id ${messageTypeId}`);
+    }
+    return types.type;
+};
+exports.messageTypeIdToMessage = messageTypeIdToMessage;
+const messageTypeToMessageId = (messageType) => {
+    const id = Object.keys(messageTypes).find((key) => messageTypes[key].type === messageType);
+    if (!id) {
+        throw new Error(`Unknown message type ${messageType}`);
+    }
+    return id;
+};
+exports.messageTypeToMessageId = messageTypeToMessageId;
+const magicSeparator = Buffer.from('remotion_buffer:');
+const makeStreaming = (options) => {
     let outputBuffer = Buffer.from('');
-    const separator = Buffer.from('remotion_buffer:');
     let unprocessedBuffers = [];
     let missingData = null;
     const processInput = () => {
-        let separatorIndex = outputBuffer.indexOf(separator);
+        let separatorIndex = outputBuffer.indexOf(magicSeparator);
         if (separatorIndex === -1) {
             return;
         }
-        separatorIndex += separator.length;
-        let nonceString = '';
+        separatorIndex += magicSeparator.length;
+        let messageTypeString = '';
         let lengthString = '';
         let statusString = '';
-        // Each message from Rust is prefixed with `remotion_buffer;{[nonce]}:{[length]}`
+        // Each message has the structure with `remotion_buffer:{[message_type_id]}:{[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
@@ -27,7 +59,7 @@ const makeStreaming = (onMessage) => {
                 break;
             }
             separatorIndex++;
-            nonceString += String.fromCharCode(nextDigit);
+            messageTypeString += String.fromCharCode(nextDigit);
         }
         // eslint-disable-next-line no-constant-condition
         while (true) {
@@ -58,7 +90,17 @@ const makeStreaming = (onMessage) => {
             return;
         }
         const data = outputBuffer.subarray(separatorIndex + 1, separatorIndex + 1 + Number(lengthString));
-        onMessage(status === 1 ? 'error' : 'success', nonceString, data);
+        const messageType = (0, exports.messageTypeIdToMessage)(messageTypeString);
+        const payload = {
+            type: messageType,
+            payload: exports.formatMap[messageType] === 'json'
+                ? JSON.parse(data.toString('utf-8'))
+                : data,
+        };
+        options.onMessage({
+            successType: status === 1 ? 'error' : 'success',
+            message: payload,
+        });
         missingData = null;
         outputBuffer = outputBuffer.subarray(separatorIndex + Number(lengthString) + 1);
         processInput();
@@ -66,7 +108,7 @@ const makeStreaming = (onMessage) => {
     return {
         addData: (data) => {
             unprocessedBuffers.push(data);
-            const separatorIndex = data.indexOf(separator);
+            const separatorIndex = data.indexOf(magicSeparator);
             if (separatorIndex === -1) {
                 if (missingData) {
                     missingData.dataMissing -= data.length;
@@ -78,22 +120,24 @@ const makeStreaming = (onMessage) => {
             unprocessedBuffers.unshift(outputBuffer);
             outputBuffer = Buffer.concat(unprocessedBuffers);
             unprocessedBuffers = [];
-            console.log('the unprocessed input is now', new TextDecoder('utf-8').decode(outputBuffer));
             processInput();
         },
     };
 };
 exports.makeStreaming = makeStreaming;
-const makePayloadMessage = (nonce, data, status) => {
+const makePayloadMessage = ({ message, status, }) => {
+    const body = exports.formatMap[message.type] === 'json'
+        ? Buffer.from(JSON.stringify(message.payload))
+        : message.payload;
     const concat = Buffer.concat([
-        Buffer.from('remotion_buffer:'),
-        Buffer.from(nonce.toString()),
+        magicSeparator,
+        Buffer.from((0, exports.messageTypeToMessageId)(message.type).toString()),
         Buffer.from(':'),
-        Buffer.from(data.length.toString()),
+        Buffer.from(body.length.toString()),
         Buffer.from(':'),
         Buffer.from(String(status)),
         Buffer.from(':'),
-        data,
+        body,
     ]);
     return concat;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remotion/lambda",
-  "version": "4.0.47",
+  "version": "4.0.49",
   "description": "Distributed renderer for Remotion based on AWS Lambda",
   "main": "dist/index.js",
   "sideEffects": false,
@@ -26,10 +26,10 @@
     "aws-policies": "^1.0.1",
     "mime-types": "2.1.34",
     "zod": "3.22.3",
-    "@remotion/bundler": "4.0.47",
-    "@remotion/renderer": "4.0.47",
-    "@remotion/cli": "4.0.47",
-    "remotion": "4.0.47"
+    "@remotion/renderer": "4.0.49",
+    "@remotion/cli": "4.0.49",
+    "@remotion/bundler": "4.0.49",
+    "remotion": "4.0.49"
   },
   "devDependencies": {
     "@jonny/eslint-config": "3.0.276",
@@ -43,11 +43,11 @@
     "ts-node": "^10.8.0",
     "vitest": "0.31.1",
     "zip-lib": "^0.7.2",
-    "@remotion/bundler": "4.0.47",
-    "@remotion/compositor-linux-arm64-gnu": "4.0.47"
+    "@remotion/bundler": "4.0.49",
+    "@remotion/compositor-linux-arm64-gnu": "4.0.49"
   },
   "peerDependencies": {
-    "@remotion/bundler": "4.0.47"
+    "@remotion/bundler": "4.0.49"
   },
   "publishConfig": {
     "access": "public"

package/dist/cli/helpers/validate.d.ts

@@ -1,4 +0,0 @@
-import { Internals } from 'remotion';
-export declare const validateFps: typeof Internals.validateFps;
-export declare const validateDimension: typeof Internals.validateDimension;
-export declare const validateDurationInFrames: typeof Internals.validateDurationInFrames;

package/dist/cli/helpers/validate.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateDurationInFrames = exports.validateDimension = exports.validateFps = void 0;
-/* eslint-disable prefer-destructuring */
-const remotion_1 = require("remotion");
-exports.validateFps = remotion_1.Internals.validateFps;
-exports.validateDimension = remotion_1.Internals.validateDimension;
-exports.validateDurationInFrames = remotion_1.Internals.validateDurationInFrames;