@remotion/web-renderer 4.0.391 → 4.0.393

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.
Files changed (38) hide show
  1. package/dist/can-use-webfs-target.d.ts +1 -0
  2. package/dist/can-use-webfs-target.js +19 -0
  3. package/dist/compose.d.ts +6 -1
  4. package/dist/compose.js +31 -23
  5. package/dist/drawing/calculate-transforms.js +27 -8
  6. package/dist/drawing/draw-dom-element.d.ts +2 -0
  7. package/dist/drawing/draw-dom-element.js +17 -0
  8. package/dist/drawing/draw-element-to-canvas.d.ts +7 -3
  9. package/dist/drawing/draw-element-to-canvas.js +40 -48
  10. package/dist/drawing/draw-element.d.ts +9 -0
  11. package/dist/drawing/draw-element.js +50 -0
  12. package/dist/drawing/drawn-fn.d.ts +5 -0
  13. package/dist/drawing/drawn-fn.js +1 -0
  14. package/dist/drawing/text/apply-text-transform.d.ts +1 -0
  15. package/dist/drawing/text/apply-text-transform.js +12 -0
  16. package/dist/drawing/text/draw-text.d.ts +2 -0
  17. package/dist/drawing/text/draw-text.js +44 -0
  18. package/dist/drawing/text/handle-text-node.d.ts +7 -1
  19. package/dist/drawing/text/handle-text-node.js +7 -66
  20. package/dist/drawing/transform-in-3d.d.ts +8 -0
  21. package/dist/drawing/transform-in-3d.js +142 -0
  22. package/dist/esm/index.mjs +677 -8534
  23. package/dist/index.d.ts +2 -1
  24. package/dist/mediabunny-mappings.d.ts +1 -0
  25. package/dist/mediabunny-mappings.js +10 -0
  26. package/dist/output-target.d.ts +1 -0
  27. package/dist/output-target.js +1 -0
  28. package/dist/render-media-on-web.d.ts +6 -1
  29. package/dist/render-media-on-web.js +64 -24
  30. package/dist/render-operations-queue.d.ts +3 -0
  31. package/dist/render-operations-queue.js +3 -0
  32. package/dist/render-still-on-web.js +15 -9
  33. package/dist/take-screenshot.js +1 -1
  34. package/dist/walk-tree.d.ts +1 -0
  35. package/dist/walk-tree.js +14 -0
  36. package/dist/web-fs-target.d.ts +7 -0
  37. package/dist/web-fs-target.js +41 -0
  38. package/package.json +6 -6
package/dist/index.d.ts CHANGED
@@ -1,6 +1,7 @@
1
1
  export type { WebRendererCodec, WebRendererContainer, WebRendererQuality, } from './mediabunny-mappings';
2
+ export type { WebRendererOutputTarget } from './output-target';
2
3
  export { renderMediaOnWeb } from './render-media-on-web';
3
- export type { RenderMediaOnWebOptions, RenderMediaOnWebProgress, RenderMediaOnWebProgressCallback, } from './render-media-on-web';
4
+ export type { RenderMediaOnWebOptions, RenderMediaOnWebProgress, RenderMediaOnWebProgressCallback, RenderMediaOnWebResult, } from './render-media-on-web';
4
5
  export { renderStillOnWeb } from './render-still-on-web';
5
6
  export type { RenderStillOnWebImageFormat as RenderStillImageFormat, RenderStillOnWebOptions, } from './render-still-on-web';
6
7
  export type { OnFrameCallback } from './validate-video-frame';
@@ -7,3 +7,4 @@ export declare const codecToMediabunnyCodec: (codec: WebRendererCodec) => VideoC
7
7
  export declare const containerToMediabunnyContainer: (container: WebRendererContainer) => OutputFormat;
8
8
  export declare const getDefaultVideoCodecForContainer: (container: WebRendererContainer) => WebRendererCodec;
9
9
  export declare const getQualityForWebRendererQuality: (quality: WebRendererQuality) => Quality;
10
+ export declare const getMimeType: (container: WebRendererContainer) => string;
@@ -51,3 +51,13 @@ export const getQualityForWebRendererQuality = (quality) => {
51
51
  throw new Error(`Unsupported quality: ${quality}`);
52
52
  }
53
53
  };
54
+ export const getMimeType = (container) => {
55
+ switch (container) {
56
+ case 'mp4':
57
+ return 'video/mp4';
58
+ case 'webm':
59
+ return 'video/webm';
60
+ default:
61
+ throw new Error(`Unsupported container: ${container}`);
62
+ }
63
+ };
@@ -0,0 +1 @@
1
+ export type WebRendererOutputTarget = 'arraybuffer' | 'web-fs';
@@ -0,0 +1 @@
1
+ export {};
@@ -4,6 +4,7 @@ import { type OnArtifact } from './artifact';
4
4
  import { type FrameRange } from './frame-range';
5
5
  import type { WebRendererContainer, WebRendererQuality } from './mediabunny-mappings';
6
6
  import { type WebRendererCodec } from './mediabunny-mappings';
7
+ import type { WebRendererOutputTarget } from './output-target';
7
8
  import type { CompositionCalculateMetadataOrExplicit } from './props-if-has-props';
8
9
  import { type OnFrameCallback } from './validate-video-frame';
9
10
  export type InputPropsIfHasProps<Schema extends AnyZodObject, Props> = AnyZodObject extends Schema ? {} extends Props ? {
@@ -22,6 +23,9 @@ export type RenderMediaOnWebProgress = {
22
23
  renderedFrames: number;
23
24
  encodedFrames: number;
24
25
  };
26
+ export type RenderMediaOnWebResult = {
27
+ getBlob: () => Promise<Blob>;
28
+ };
25
29
  export type RenderMediaOnWebProgressCallback = (progress: RenderMediaOnWebProgress) => void;
26
30
  type OptionalRenderMediaOnWebOptions<Schema extends AnyZodObject> = {
27
31
  delayRenderTimeoutInMilliseconds: number;
@@ -39,7 +43,8 @@ type OptionalRenderMediaOnWebOptions<Schema extends AnyZodObject> = {
39
43
  transparent: boolean;
40
44
  onArtifact: OnArtifact | null;
41
45
  onFrame: OnFrameCallback | null;
46
+ outputTarget: WebRendererOutputTarget | null;
42
47
  };
43
48
  export type RenderMediaOnWebOptions<Schema extends AnyZodObject, Props extends Record<string, unknown>> = MandatoryRenderMediaOnWebOptions<Schema, Props> & Partial<OptionalRenderMediaOnWebOptions<Schema>> & InputPropsIfHasProps<Schema, Props>;
44
- export declare const renderMediaOnWeb: <Schema extends AnyZodObject, Props extends Record<string, unknown>>(options: RenderMediaOnWebOptions<Schema, Props>) => Promise<ArrayBuffer>;
49
+ export declare const renderMediaOnWeb: <Schema extends AnyZodObject, Props extends Record<string, unknown>>(options: RenderMediaOnWebOptions<Schema, Props>) => Promise<RenderMediaOnWebResult>;
45
50
  export {};
@@ -1,24 +1,34 @@
1
- import { AudioSampleSource, BufferTarget, Output, VideoSampleSource, } from 'mediabunny';
1
+ import { AudioSampleSource, BufferTarget, Output, StreamTarget, VideoSampleSource, } from 'mediabunny';
2
2
  import { Internals } from 'remotion';
3
3
  import { addAudioSample, addVideoSampleAndCloseFrame } from './add-sample';
4
4
  import { handleArtifacts } from './artifact';
5
5
  import { onlyInlineAudio } from './audio';
6
+ import { canUseWebFsWriter } from './can-use-webfs-target';
6
7
  import { createScaffold } from './create-scaffold';
7
8
  import { getRealFrameRange } from './frame-range';
8
9
  import { getDefaultAudioEncodingConfig } from './get-audio-encoding-config';
9
- import { codecToMediabunnyCodec, containerToMediabunnyContainer, getDefaultVideoCodecForContainer, getQualityForWebRendererQuality, } from './mediabunny-mappings';
10
+ import { codecToMediabunnyCodec, containerToMediabunnyContainer, getDefaultVideoCodecForContainer, getMimeType, getQualityForWebRendererQuality, } from './mediabunny-mappings';
11
+ import { onlyOneRenderAtATimeQueue } from './render-operations-queue';
10
12
  import { createFrame } from './take-screenshot';
11
13
  import { createThrottledProgressCallback } from './throttle-progress';
12
14
  import { validateVideoFrame } from './validate-video-frame';
13
15
  import { waitForReady } from './wait-for-ready';
16
+ import { cleanupStaleOpfsFiles, createWebFsTarget } from './web-fs-target';
14
17
  // TODO: More containers
15
18
  // TODO: Audio
16
19
  // TODO: Metadata
17
20
  // TODO: Validating inputs
18
- // TODO: Web file system API
19
21
  // TODO: Apply defaultCodec
20
- const internalRenderMediaOnWeb = async ({ composition, inputProps, delayRenderTimeoutInMilliseconds, logLevel, mediaCacheSizeInBytes, schema, codec, container, signal, onProgress, hardwareAcceleration, keyframeIntervalInSeconds, videoBitrate, frameRange, transparent, onArtifact, onFrame, }) => {
22
+ const internalRenderMediaOnWeb = async ({ composition, inputProps, delayRenderTimeoutInMilliseconds, logLevel, mediaCacheSizeInBytes, schema, codec, container, signal, onProgress, hardwareAcceleration, keyframeIntervalInSeconds, videoBitrate, frameRange, transparent, onArtifact, onFrame, outputTarget: userDesiredOutputTarget, }) => {
21
23
  var _a, _b, _c, _d, _e, _f, _g;
24
+ const outputTarget = userDesiredOutputTarget === null
25
+ ? (await canUseWebFsWriter())
26
+ ? 'web-fs'
27
+ : 'arraybuffer'
28
+ : userDesiredOutputTarget;
29
+ if (outputTarget === 'web-fs') {
30
+ await cleanupStaleOpfsFiles();
31
+ }
22
32
  const cleanupFns = [];
23
33
  const format = containerToMediabunnyContainer(container);
24
34
  if (codec &&
@@ -62,9 +72,13 @@ const internalRenderMediaOnWeb = async ({ composition, inputProps, delayRenderTi
62
72
  cleanupFns.push(() => {
63
73
  cleanupScaffold();
64
74
  });
75
+ const webFsTarget = outputTarget === 'web-fs' ? await createWebFsTarget() : null;
76
+ const target = webFsTarget
77
+ ? new StreamTarget(webFsTarget.stream)
78
+ : new BufferTarget();
65
79
  const output = new Output({
66
80
  format,
67
- target: new BufferTarget(),
81
+ target,
68
82
  });
69
83
  try {
70
84
  if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
@@ -190,32 +204,58 @@ const internalRenderMediaOnWeb = async ({ composition, inputProps, delayRenderTi
190
204
  videoSampleSource.close();
191
205
  audioSampleSource.close();
192
206
  await output.finalize();
193
- return output.target.buffer;
207
+ const mimeType = getMimeType(container);
208
+ if (webFsTarget) {
209
+ await webFsTarget.close();
210
+ return {
211
+ getBlob: () => {
212
+ return webFsTarget.getBlob();
213
+ },
214
+ };
215
+ }
216
+ if (!(target instanceof BufferTarget)) {
217
+ throw new Error('Expected target to be a BufferTarget');
218
+ }
219
+ return {
220
+ getBlob: () => {
221
+ if (!target.buffer) {
222
+ throw new Error('The resulting buffer is empty');
223
+ }
224
+ return Promise.resolve(new Blob([target.buffer], { type: mimeType }));
225
+ },
226
+ };
194
227
  }
195
228
  finally {
196
229
  cleanupFns.forEach((fn) => fn());
197
230
  }
198
231
  };
199
232
  export const renderMediaOnWeb = (options) => {
200
- var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
233
+ var _a, _b;
201
234
  const container = (_a = options.container) !== null && _a !== void 0 ? _a : 'mp4';
202
235
  const codec = (_b = options.codec) !== null && _b !== void 0 ? _b : getDefaultVideoCodecForContainer(container);
203
- return internalRenderMediaOnWeb({
204
- ...options,
205
- delayRenderTimeoutInMilliseconds: (_c = options.delayRenderTimeoutInMilliseconds) !== null && _c !== void 0 ? _c : 30000,
206
- logLevel: (_d = options.logLevel) !== null && _d !== void 0 ? _d : 'info',
207
- schema: (_e = options.schema) !== null && _e !== void 0 ? _e : undefined,
208
- mediaCacheSizeInBytes: (_f = options.mediaCacheSizeInBytes) !== null && _f !== void 0 ? _f : null,
209
- codec,
210
- container,
211
- signal: (_g = options.signal) !== null && _g !== void 0 ? _g : null,
212
- onProgress: (_h = options.onProgress) !== null && _h !== void 0 ? _h : null,
213
- hardwareAcceleration: (_j = options.hardwareAcceleration) !== null && _j !== void 0 ? _j : 'no-preference',
214
- keyframeIntervalInSeconds: (_k = options.keyframeIntervalInSeconds) !== null && _k !== void 0 ? _k : 5,
215
- videoBitrate: (_l = options.videoBitrate) !== null && _l !== void 0 ? _l : 'medium',
216
- frameRange: (_m = options.frameRange) !== null && _m !== void 0 ? _m : null,
217
- transparent: (_o = options.transparent) !== null && _o !== void 0 ? _o : false,
218
- onArtifact: (_p = options.onArtifact) !== null && _p !== void 0 ? _p : null,
219
- onFrame: (_q = options.onFrame) !== null && _q !== void 0 ? _q : null,
236
+ onlyOneRenderAtATimeQueue.ref = onlyOneRenderAtATimeQueue.ref
237
+ .catch(() => Promise.resolve())
238
+ .then(() => {
239
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
240
+ return internalRenderMediaOnWeb({
241
+ ...options,
242
+ delayRenderTimeoutInMilliseconds: (_a = options.delayRenderTimeoutInMilliseconds) !== null && _a !== void 0 ? _a : 30000,
243
+ logLevel: (_b = options.logLevel) !== null && _b !== void 0 ? _b : 'info',
244
+ schema: (_c = options.schema) !== null && _c !== void 0 ? _c : undefined,
245
+ mediaCacheSizeInBytes: (_d = options.mediaCacheSizeInBytes) !== null && _d !== void 0 ? _d : null,
246
+ codec,
247
+ container,
248
+ signal: (_e = options.signal) !== null && _e !== void 0 ? _e : null,
249
+ onProgress: (_f = options.onProgress) !== null && _f !== void 0 ? _f : null,
250
+ hardwareAcceleration: (_g = options.hardwareAcceleration) !== null && _g !== void 0 ? _g : 'no-preference',
251
+ keyframeIntervalInSeconds: (_h = options.keyframeIntervalInSeconds) !== null && _h !== void 0 ? _h : 5,
252
+ videoBitrate: (_j = options.videoBitrate) !== null && _j !== void 0 ? _j : 'medium',
253
+ frameRange: (_k = options.frameRange) !== null && _k !== void 0 ? _k : null,
254
+ transparent: (_l = options.transparent) !== null && _l !== void 0 ? _l : false,
255
+ onArtifact: (_m = options.onArtifact) !== null && _m !== void 0 ? _m : null,
256
+ onFrame: (_o = options.onFrame) !== null && _o !== void 0 ? _o : null,
257
+ outputTarget: (_p = options.outputTarget) !== null && _p !== void 0 ? _p : null,
258
+ });
220
259
  });
260
+ return onlyOneRenderAtATimeQueue.ref;
221
261
  };
@@ -0,0 +1,3 @@
1
+ export declare const onlyOneRenderAtATimeQueue: {
2
+ ref: Promise<unknown>;
3
+ };
@@ -0,0 +1,3 @@
1
+ export const onlyOneRenderAtATimeQueue = {
2
+ ref: Promise.resolve(),
3
+ };
@@ -1,6 +1,7 @@
1
1
  import { Internals, } from 'remotion';
2
2
  import { handleArtifacts } from './artifact';
3
3
  import { createScaffold } from './create-scaffold';
4
+ import { onlyOneRenderAtATimeQueue } from './render-operations-queue';
4
5
  import { takeScreenshot } from './take-screenshot';
5
6
  import { waitForReady } from './wait-for-ready';
6
7
  async function internalRenderStillOnWeb({ frame, delayRenderTimeoutInMilliseconds, logLevel, inputProps, schema, imageFormat, mediaCacheSizeInBytes, composition, signal, onArtifact, }) {
@@ -68,14 +69,19 @@ async function internalRenderStillOnWeb({ frame, delayRenderTimeoutInMillisecond
68
69
  }
69
70
  }
70
71
  export const renderStillOnWeb = (options) => {
71
- var _a, _b, _c, _d, _e, _f;
72
- return internalRenderStillOnWeb({
73
- ...options,
74
- delayRenderTimeoutInMilliseconds: (_a = options.delayRenderTimeoutInMilliseconds) !== null && _a !== void 0 ? _a : 30000,
75
- logLevel: (_b = options.logLevel) !== null && _b !== void 0 ? _b : 'info',
76
- schema: (_c = options.schema) !== null && _c !== void 0 ? _c : undefined,
77
- mediaCacheSizeInBytes: (_d = options.mediaCacheSizeInBytes) !== null && _d !== void 0 ? _d : null,
78
- signal: (_e = options.signal) !== null && _e !== void 0 ? _e : null,
79
- onArtifact: (_f = options.onArtifact) !== null && _f !== void 0 ? _f : null,
72
+ onlyOneRenderAtATimeQueue.ref = onlyOneRenderAtATimeQueue.ref
73
+ .catch(() => Promise.resolve())
74
+ .then(() => {
75
+ var _a, _b, _c, _d, _e, _f;
76
+ return internalRenderStillOnWeb({
77
+ ...options,
78
+ delayRenderTimeoutInMilliseconds: (_a = options.delayRenderTimeoutInMilliseconds) !== null && _a !== void 0 ? _a : 30000,
79
+ logLevel: (_b = options.logLevel) !== null && _b !== void 0 ? _b : 'info',
80
+ schema: (_c = options.schema) !== null && _c !== void 0 ? _c : undefined,
81
+ mediaCacheSizeInBytes: (_d = options.mediaCacheSizeInBytes) !== null && _d !== void 0 ? _d : null,
82
+ signal: (_e = options.signal) !== null && _e !== void 0 ? _e : null,
83
+ onArtifact: (_f = options.onArtifact) !== null && _f !== void 0 ? _f : null,
84
+ });
80
85
  });
86
+ return onlyOneRenderAtATimeQueue.ref;
81
87
  };
@@ -5,7 +5,7 @@ export const createFrame = async ({ div, width, height, }) => {
5
5
  if (!context) {
6
6
  throw new Error('Could not get context');
7
7
  }
8
- await compose(div, context);
8
+ await compose({ element: div, context, offsetLeft: 0, offsetTop: 0 });
9
9
  return canvas;
10
10
  };
11
11
  export const takeScreenshot = async ({ div, width, height, imageFormat, }) => {
@@ -0,0 +1 @@
1
+ export declare function skipToNextNonDescendant(treeWalker: TreeWalker): boolean;
@@ -0,0 +1,14 @@
1
+ export function skipToNextNonDescendant(treeWalker) {
2
+ // Try to go to next sibling
3
+ if (treeWalker.nextSibling()) {
4
+ return true;
5
+ }
6
+ // No sibling, go up to parent and try to find ancestor's sibling
7
+ while (treeWalker.parentNode()) {
8
+ if (treeWalker.nextSibling()) {
9
+ return true;
10
+ }
11
+ }
12
+ // No more nodes
13
+ return false;
14
+ }
@@ -0,0 +1,7 @@
1
+ import type { StreamTargetChunk } from 'mediabunny';
2
+ export declare const cleanupStaleOpfsFiles: () => Promise<void>;
3
+ export declare const createWebFsTarget: () => Promise<{
4
+ stream: WritableStream<StreamTargetChunk>;
5
+ getBlob: () => Promise<File>;
6
+ close: () => Promise<void>;
7
+ }>;
@@ -0,0 +1,41 @@
1
+ let sessionId = null;
2
+ const getPrefix = () => {
3
+ if (!sessionId) {
4
+ sessionId = crypto.randomUUID();
5
+ }
6
+ return `__remotion_render:${sessionId}:`;
7
+ };
8
+ export const cleanupStaleOpfsFiles = async () => {
9
+ try {
10
+ const root = await navigator.storage.getDirectory();
11
+ for await (const [name] of root.entries()) {
12
+ if (name.startsWith('__remotion_render:') &&
13
+ !name.startsWith(getPrefix())) {
14
+ await root.removeEntry(name);
15
+ }
16
+ }
17
+ }
18
+ catch (_a) {
19
+ // Ignore, could already be closed
20
+ }
21
+ };
22
+ export const createWebFsTarget = async () => {
23
+ const directoryHandle = await navigator.storage.getDirectory();
24
+ const filename = `${getPrefix()}${crypto.randomUUID()}`;
25
+ const fileHandle = await directoryHandle.getFileHandle(filename, {
26
+ create: true,
27
+ });
28
+ const writable = await fileHandle.createWritable();
29
+ const stream = new WritableStream({
30
+ async write(chunk) {
31
+ await writable.seek(chunk.position);
32
+ await writable.write(chunk);
33
+ },
34
+ });
35
+ const getBlob = async () => {
36
+ const handle = await directoryHandle.getFileHandle(filename);
37
+ return handle.getFile();
38
+ };
39
+ const close = () => writable.close();
40
+ return { stream, getBlob, close };
41
+ };
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "url": "https://github.com/remotion-dev/remotion/tree/main/packages/web-renderer"
4
4
  },
5
5
  "name": "@remotion/web-renderer",
6
- "version": "4.0.391",
6
+ "version": "4.0.393",
7
7
  "main": "dist/index.js",
8
8
  "sideEffects": false,
9
9
  "scripts": {
@@ -16,13 +16,13 @@
16
16
  "author": "Remotion <jonny@remotion.dev>",
17
17
  "license": "UNLICENSED",
18
18
  "dependencies": {
19
- "remotion": "4.0.391",
20
- "mediabunny": "1.25.8"
19
+ "remotion": "4.0.393",
20
+ "mediabunny": "1.27.0"
21
21
  },
22
22
  "devDependencies": {
23
- "@remotion/eslint-config-internal": "4.0.391",
24
- "@remotion/player": "4.0.391",
25
- "@remotion/media": "4.0.391",
23
+ "@remotion/eslint-config-internal": "4.0.393",
24
+ "@remotion/player": "4.0.393",
25
+ "@remotion/media": "4.0.393",
26
26
  "@vitejs/plugin-react": "4.1.0",
27
27
  "@vitest/browser-playwright": "4.0.9",
28
28
  "playwright": "1.55.1",