@glissade/export-web 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/index.d.ts

@@ -0,0 +1,49 @@
+import { AudioCodec, VideoCodec } from "mediabunny";
+import { Timeline } from "@glissade/core";
+import { Scene, VideoFrameSource } from "@glissade/scene";
+
+//#region src/videoSource.d.ts
+
+declare class MediabunnyVideoFrameSource implements VideoFrameSource {
+  readonly fps: number;
+  readonly duration: number;
+  private readonly sink;
+  private readonly cache;
+  private readonly label;
+  private constructor();
+  static open(src: string | Blob, label?: string): Promise<MediabunnyVideoFrameSource>;
+  private frameIndex;
+  warm(fromT: number, toT: number): Promise<void>;
+  getFrameSync(mediaT: number): HTMLCanvasElement | OffscreenCanvas;
+  close(): void;
+}
+//#endregion
+//#region src/index.d.ts
+interface WebExportOptions {
+  fps?: number;
+  /** 'auto' tries mp4 (avc/hevc/av1) then webm (vp9/vp8/av1). */
+  format?: 'mp4' | 'webm' | 'auto';
+  videoBitrate?: number;
+  audioBitrate?: number;
+  onProgress?: (frame: number, total: number) => void;
+}
+interface WebExportResult {
+  blob: Blob;
+  format: 'mp4' | 'webm';
+  videoCodec: VideoCodec;
+  audioCodec: AudioCodec | null;
+  frames: number;
+}
+declare class ExportUnsupportedError extends Error {
+  constructor(detail: string);
+}
+/** Export a scene + timeline to a video Blob, entirely in the browser. */
+declare function exportVideo(scene: Scene, doc: Timeline, opts?: WebExportOptions): Promise<WebExportResult>;
+/** Unconditional fallback (§5.2): per-frame PNG blobs via a callback — works wherever canvas does. */
+declare function exportPngFrames(scene: Scene, doc: Timeline, onFrame: (frame: number, png: Blob) => void | Promise<void>, opts?: {
+  fps?: number;
+}): Promise<{
+  frames: number;
+}>;
+//#endregion
+export { ExportUnsupportedError, MediabunnyVideoFrameSource, WebExportOptions, WebExportResult, exportPngFrames, exportVideo };

package/dist/index.js

@@ -0,0 +1,247 @@
+import { ALL_FORMATS, AudioBufferSource, BlobSource, BufferTarget, CanvasSink, CanvasSource, Input, Mp4OutputFormat, Output, UrlSource, WebMOutputFormat, getFirstEncodableAudioCodec, getFirstEncodableVideoCodec } from "mediabunny";
+import { compileTimeline, sampleTrack } from "@glissade/core";
+import { ColdAssetError, evaluate } from "@glissade/scene";
+import { Canvas2DBackend } from "@glissade/backend-canvas2d";
+//#region src/videoSource.ts
+/**
+* Browser video decoding (DESIGN.md §5.4): Mediabunny demux + WebCodecs
+* decode behind the VideoFrameSource seam. warm() decodes a window of frames
+* via CanvasSink (which drives VideoDecoder and handles keyframe seeking —
+* backward/random scrub is O(GOP), a readiness latency, never state).
+*/
+const DEFAULT_LOOKAHEAD_FRAMES = 10;
+const MAX_CACHED_FRAMES = 64;
+var MediabunnyVideoFrameSource = class MediabunnyVideoFrameSource {
+	fps;
+	duration;
+	sink;
+	cache = /* @__PURE__ */ new Map();
+	label;
+	constructor(sink, fps, duration, label) {
+		this.sink = sink;
+		this.fps = fps;
+		this.duration = duration;
+		this.label = label;
+	}
+	static async open(src, label = typeof src === "string" ? src : "blob") {
+		const track = await new Input({
+			formats: ALL_FORMATS,
+			source: typeof src === "string" ? new UrlSource(src) : new BlobSource(src)
+		}).getPrimaryVideoTrack();
+		if (!track) throw new Error(`no video track in ${label}`);
+		if (!await track.canDecode()) throw new Error(`browser cannot decode the video codec of ${label}`);
+		const stats = await track.computePacketStats(120);
+		const duration = await track.computeDuration();
+		return new MediabunnyVideoFrameSource(new CanvasSink(track, { poolSize: 0 }), stats.averagePacketRate, duration, label);
+	}
+	frameIndex(mediaT) {
+		return Math.max(0, Math.floor(mediaT * this.fps + 1e-9));
+	}
+	async warm(fromT, toT) {
+		const from = Math.max(0, fromT);
+		const to = Math.min(toT + DEFAULT_LOOKAHEAD_FRAMES / this.fps, this.duration);
+		const fromIdx = this.frameIndex(from);
+		const toIdx = this.frameIndex(to);
+		let missing = false;
+		for (let i = fromIdx; i <= toIdx; i++) if (!this.cache.has(i)) {
+			missing = true;
+			break;
+		}
+		if (!missing) return;
+		for await (const wrapped of this.sink.canvases(from, to)) {
+			if (!wrapped) continue;
+			this.cache.set(this.frameIndex(wrapped.timestamp), wrapped.canvas);
+		}
+		if (this.cache.size > MAX_CACHED_FRAMES) {
+			const center = (fromIdx + toIdx) / 2;
+			const byDistance = [...this.cache.keys()].sort((a, b) => Math.abs(b - center) - Math.abs(a - center));
+			for (const idx of byDistance.slice(0, this.cache.size - MAX_CACHED_FRAMES)) this.cache.delete(idx);
+		}
+	}
+	getFrameSync(mediaT) {
+		let idx = this.frameIndex(Math.min(mediaT, this.duration));
+		const lastIdx = this.frameIndex(this.duration);
+		while (idx > 0 && !this.cache.has(idx) && idx >= lastIdx - 2) idx--;
+		const hit = this.cache.get(idx);
+		if (!hit) throw new ColdAssetError(this.label, `frame ${idx} not decoded`, mediaT);
+		return hit;
+	}
+	close() {
+		this.cache.clear();
+	}
+};
+//#endregion
+//#region src/index.ts
+/**
+* @glissade/export-web — in-browser export (DESIGN.md §5.1b/§5.2/§5.3):
+* WebCodecs encoding + Mediabunny muxing, frame-accurate and faster than
+* realtime; audio mixed sample-accurately via OfflineAudioContext. Codec
+* support is feature-detected (isConfigSupported under the hood); the PNG
+* frame callback path is the unconditional fallback.
+*/
+var ExportUnsupportedError = class extends Error {
+	constructor(detail) {
+		super(`${detail} — no encodable codec found in this browser. Use the PNG fallback (exportPngFrames) or render via the gs CLI (§5.2).`);
+		this.name = "ExportUnsupportedError";
+	}
+};
+const MP4_VIDEO = [
+	"avc",
+	"hevc",
+	"av1"
+];
+const WEBM_VIDEO = [
+	"vp9",
+	"vp8",
+	"av1"
+];
+const MP4_AUDIO = ["aac", "opus"];
+const WEBM_AUDIO = ["opus"];
+async function pickCodecs(format, width, height, bitrate, needAudio) {
+	const tryFormat = async (f) => {
+		const video = await getFirstEncodableVideoCodec(f === "mp4" ? MP4_VIDEO : WEBM_VIDEO, {
+			width,
+			height,
+			bitrate
+		});
+		if (!video) return null;
+		const audio = needAudio ? await getFirstEncodableAudioCodec(f === "mp4" ? MP4_AUDIO : WEBM_AUDIO) : null;
+		if (needAudio && !audio) return null;
+		return {
+			format: f,
+			video,
+			audio
+		};
+	};
+	for (const f of format === "auto" ? ["mp4", "webm"] : [format]) {
+		const picked = await tryFormat(f);
+		if (picked) return picked;
+	}
+	throw new ExportUnsupportedError(`format '${format}'${needAudio ? " with audio" : ""}`);
+}
+/** Mix timeline audio clips sample-accurately (§5.3 browser path). */
+async function mixAudio(clips, duration, sampleRate = 48e3) {
+	const ctx = new OfflineAudioContext(2, Math.ceil(duration * sampleRate), sampleRate);
+	for (const clip of clips) {
+		if (clip.at >= duration) continue;
+		const resp = await fetch(clip.asset.url);
+		if (!resp.ok) throw new Error(`audio asset fetch failed (${resp.status}): ${clip.asset.url}`);
+		const decoded = await ctx.decodeAudioData(await resp.arrayBuffer());
+		const node = ctx.createBufferSource();
+		node.buffer = decoded;
+		if (clip.playbackRate !== void 0) node.playbackRate.value = clip.playbackRate;
+		let tail = node;
+		if (clip.gain) {
+			const gainNode = ctx.createGain();
+			const keys = clip.gain.keys;
+			gainNode.gain.setValueAtTime(Number(keys[0].value), Math.max(0, clip.at));
+			for (const k of keys) gainNode.gain.linearRampToValueAtTime(Number(sampleTrack(clip.gain, k.t)), clip.at + k.t);
+			tail.connect(gainNode);
+			tail = gainNode;
+		}
+		tail.connect(ctx.destination);
+		const offset = clip.trim?.start ?? 0;
+		const sourceDur = clip.trim ? clip.trim.end - clip.trim.start : void 0;
+		if (sourceDur !== void 0) node.start(Math.max(0, clip.at), offset, sourceDur);
+		else node.start(Math.max(0, clip.at), offset);
+	}
+	return ctx.startRendering();
+}
+/** Export a scene + timeline to a video Blob, entirely in the browser. */
+async function exportVideo(scene, doc, opts = {}) {
+	const compiled = compileTimeline(doc);
+	const fps = opts.fps ?? doc.fps ?? 60;
+	const duration = compiled.duration;
+	const total = Math.max(1, Math.ceil(duration * fps));
+	const { w, h } = scene.size;
+	const videoBitrate = opts.videoBitrate ?? 8e6;
+	const picked = await pickCodecs(opts.format ?? "auto", w, h, videoBitrate, compiled.audio.length > 0);
+	const canvas = new OffscreenCanvas(w, h);
+	const backend = new Canvas2DBackend(canvas);
+	scene.setTextMeasurer(backend);
+	const videoSources = /* @__PURE__ */ new Map();
+	for (const [assetId, ref] of Object.entries(doc.assets ?? {})) if (ref.kind === "font") {
+		const face = new FontFace(assetId, `url(${ref.url})`);
+		const g = globalThis;
+		(g.document?.fonts ?? g.fonts)?.add(face);
+		await face.load();
+	} else if (ref.kind === "image") {
+		const resp = await fetch(ref.url);
+		if (!resp.ok) throw new Error(`image asset fetch failed (${resp.status}): ${ref.url}`);
+		backend.setImageAsset(assetId, await createImageBitmap(await resp.blob()));
+	} else if (ref.kind === "video") {
+		const source = await MediabunnyVideoFrameSource.open(ref.url, assetId);
+		backend.setVideoAsset(assetId, source);
+		videoSources.set(assetId, source);
+	}
+	/** Render one frame, demand-warming any cold video source and retrying (§2.5). */
+	const renderFrame = async (t) => {
+		for (let attempt = 0;; attempt++) try {
+			backend.render(evaluate(scene, doc, t));
+			return;
+		} catch (e) {
+			if (e instanceof ColdAssetError && e.mediaT !== void 0 && attempt < 3) {
+				const source = videoSources.get(e.assetId);
+				if (source) {
+					await source.warm(e.mediaT, e.mediaT);
+					continue;
+				}
+			}
+			throw e;
+		}
+	};
+	const output = new Output({
+		format: picked.format === "mp4" ? new Mp4OutputFormat() : new WebMOutputFormat(),
+		target: new BufferTarget()
+	});
+	const videoSource = new CanvasSource(canvas, {
+		codec: picked.video,
+		bitrate: videoBitrate
+	});
+	output.addVideoTrack(videoSource, { frameRate: fps });
+	let audioSource = null;
+	if (picked.audio) {
+		audioSource = new AudioBufferSource({
+			codec: picked.audio,
+			bitrate: opts.audioBitrate ?? 192e3
+		});
+		output.addAudioTrack(audioSource);
+	}
+	await output.start();
+	if (audioSource) {
+		await audioSource.add(await mixAudio(compiled.audio, duration));
+		audioSource.close();
+	}
+	for (let f = 0; f < total; f++) {
+		await renderFrame(f / fps);
+		await videoSource.add(f / fps, 1 / fps);
+		opts.onProgress?.(f + 1, total);
+	}
+	videoSource.close();
+	await output.finalize();
+	for (const source of videoSources.values()) source.close();
+	const buffer = output.target.buffer;
+	if (!buffer) throw new Error("muxer produced no output");
+	return {
+		blob: new Blob([buffer], { type: picked.format === "mp4" ? "video/mp4" : "video/webm" }),
+		format: picked.format,
+		videoCodec: picked.video,
+		audioCodec: picked.audio,
+		frames: total
+	};
+}
+/** Unconditional fallback (§5.2): per-frame PNG blobs via a callback — works wherever canvas does. */
+async function exportPngFrames(scene, doc, onFrame, opts = {}) {
+	const compiled = compileTimeline(doc);
+	const fps = opts.fps ?? doc.fps ?? 60;
+	const total = Math.max(1, Math.ceil(compiled.duration * fps));
+	const canvas = new OffscreenCanvas(scene.size.w, scene.size.h);
+	const backend = new Canvas2DBackend(canvas);
+	for (let f = 0; f < total; f++) {
+		backend.render(evaluate(scene, doc, f / fps));
+		await onFrame(f, await canvas.convertToBlob({ type: "image/png" }));
+	}
+	return { frames: total };
+}
+//#endregion
+export { ExportUnsupportedError, MediabunnyVideoFrameSource, exportPngFrames, exportVideo };

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@glissade/export-web",
+  "version": "0.1.0",
+  "description": "glissade in-browser export: WebCodecs VideoEncoder + Mediabunny muxing, OfflineAudioContext audio mix. Frame-accurate, faster than realtime, no server.",
+  "license": "Apache-2.0",
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "mediabunny": "^1.0.0",
+    "@glissade/backend-canvas2d": "0.1.0",
+    "@glissade/core": "0.1.0",
+    "@glissade/scene": "0.1.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tyevco/glissade.git",
+    "directory": "packages/export-web"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "typecheck": "tsc --noEmit"
+  }
+}