pixi-effects 0.26.2 → 0.26.3

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-export { A as AudioInspectOptions, a as AudioReport, b as AudioSourceReport, C as ContactSheetOptions, F as FontReport, c as FrameEvent, I as InspectOptions, d as InspectReport, e as IssueGroup, L as LayerInfo, f as LoadProgressState, g as LoadStage, h as LoaderOption, M as MotionBlurOptions, i as MotionBlurSpec, j as Movie, k as MovieErrorEvent, l as MovieOptions, O as OnionSkinOptions, P as ProgressEvent, R as RenderOptions, m as ReviewOptions, n as ReviewReport, S as SnapshotOptions, o as SoundMeasure, p as StopEvent, q as StopImage, r as StopImagesOptions, T as TimelineData, s as TimelineHtmlOptions, t as TimelineRow, u as TimelineSvgOptions, v as TimelineTransition, V as VolumeEvent, w as dismissLoader, x as failLoader, y as resolveLoader } from './Movie-i05Oh9mJ.cjs';
+export { A as AudioInspectOptions, a as AudioReport, b as AudioSourceReport, C as ContactSheetOptions, F as FontReport, c as FrameEvent, I as InspectOptions, d as InspectReport, e as IssueGroup, L as LayerInfo, f as LoadProgressState, g as LoadStage, h as LoaderOption, M as MotionBlurOptions, i as MotionBlurSpec, j as Movie, k as MovieErrorEvent, l as MovieOptions, O as OnionSkinOptions, P as ProgressEvent, R as RenderOptions, m as ReviewOptions, n as ReviewReport, S as SnapshotOptions, o as SoundMeasure, p as StopEvent, q as StopImage, r as StopImagesOptions, T as TimelineData, s as TimelineHtmlOptions, t as TimelineRow, u as TimelineSvgOptions, v as TimelineTransition, V as VolumeEvent, w as dismissLoader, x as failLoader, y as resolveLoader } from './Movie-BWLLWRRe.cjs';
 import { S as SequenceSpec, C as CompositionShape, I as ImageSequenceSpec, a as CameraSequenceSpec, K as Keyframe, T as TextSequenceSpec, M as MusicOptions, P as Props, b as TransitionSpec, c as CompositionSpec, d as SequenceCommon } from './types-DSGwN5w1.cjs';
 export { A as ArcShapeSpec, e as AssetSpec, f as AudioAssetSpec, g as AudioMusicSpec, h as AudioSequenceSpec, i as AudioSfxSpec, B as BlendModeName, j as ChromaKeyFilterSpec, k as CircleShapeSpec, l as CompositionSequenceSpec, m as CrossfadeTransition, n as CustomFilterSpec, D as DipTransition, o as DissolveTransition, E as EllipseShapeSpec, p as Expr, F as FilterSpec, G as GradientSpec, q as IrisTransition, L as LightSequenceSpec, r as LineShapeSpec, s as LumaTransition, t as MaskRefSpec, u as MatteRefSpec, v as MusicDrum, w as MusicDrums, x as MusicInstrument, y as MusicLevel, z as MusicTrack, N as NullSequenceSpec, H as PathShapeSpec, J as PolygonShapeSpec, O as PropValue, R as RectShapeSpec, Q as SfxKnobs, U as SfxOptions, V as SfxPreset, W as SfxVoice, X as ShaderSequenceSpec, Y as ShapeSequenceSpec, Z as SlideTransition, _ as Stop, $ as StopSpec, a0 as TransitionCommon, a1 as VideoSequenceSpec, a2 as WipeTransition, a3 as ZoomTransition, a4 as normalizeStops, a5 as pictureStops } from './types-DSGwN5w1.cjs';
 import { S as Sequence } from './Base-TbBhHPrG.cjs';

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { A as AudioInspectOptions, a as AudioReport, b as AudioSourceReport, C as ContactSheetOptions, F as FontReport, c as FrameEvent, I as InspectOptions, d as InspectReport, e as IssueGroup, L as LayerInfo, f as LoadProgressState, g as LoadStage, h as LoaderOption, M as MotionBlurOptions, i as MotionBlurSpec, j as Movie, k as MovieErrorEvent, l as MovieOptions, O as OnionSkinOptions, P as ProgressEvent, R as RenderOptions, m as ReviewOptions, n as ReviewReport, S as SnapshotOptions, o as SoundMeasure, p as StopEvent, q as StopImage, r as StopImagesOptions, T as TimelineData, s as TimelineHtmlOptions, t as TimelineRow, u as TimelineSvgOptions, v as TimelineTransition, V as VolumeEvent, w as dismissLoader, x as failLoader, y as resolveLoader } from './Movie-DVeDTdnc.js';
+export { A as AudioInspectOptions, a as AudioReport, b as AudioSourceReport, C as ContactSheetOptions, F as FontReport, c as FrameEvent, I as InspectOptions, d as InspectReport, e as IssueGroup, L as LayerInfo, f as LoadProgressState, g as LoadStage, h as LoaderOption, M as MotionBlurOptions, i as MotionBlurSpec, j as Movie, k as MovieErrorEvent, l as MovieOptions, O as OnionSkinOptions, P as ProgressEvent, R as RenderOptions, m as ReviewOptions, n as ReviewReport, S as SnapshotOptions, o as SoundMeasure, p as StopEvent, q as StopImage, r as StopImagesOptions, T as TimelineData, s as TimelineHtmlOptions, t as TimelineRow, u as TimelineSvgOptions, v as TimelineTransition, V as VolumeEvent, w as dismissLoader, x as failLoader, y as resolveLoader } from './Movie-BkP82KXS.js';
 import { S as SequenceSpec, C as CompositionShape, I as ImageSequenceSpec, a as CameraSequenceSpec, K as Keyframe, T as TextSequenceSpec, M as MusicOptions, P as Props, b as TransitionSpec, c as CompositionSpec, d as SequenceCommon } from './types-DSGwN5w1.js';
 export { A as ArcShapeSpec, e as AssetSpec, f as AudioAssetSpec, g as AudioMusicSpec, h as AudioSequenceSpec, i as AudioSfxSpec, B as BlendModeName, j as ChromaKeyFilterSpec, k as CircleShapeSpec, l as CompositionSequenceSpec, m as CrossfadeTransition, n as CustomFilterSpec, D as DipTransition, o as DissolveTransition, E as EllipseShapeSpec, p as Expr, F as FilterSpec, G as GradientSpec, q as IrisTransition, L as LightSequenceSpec, r as LineShapeSpec, s as LumaTransition, t as MaskRefSpec, u as MatteRefSpec, v as MusicDrum, w as MusicDrums, x as MusicInstrument, y as MusicLevel, z as MusicTrack, N as NullSequenceSpec, H as PathShapeSpec, J as PolygonShapeSpec, O as PropValue, R as RectShapeSpec, Q as SfxKnobs, U as SfxOptions, V as SfxPreset, W as SfxVoice, X as ShaderSequenceSpec, Y as ShapeSequenceSpec, Z as SlideTransition, _ as Stop, $ as StopSpec, a0 as TransitionCommon, a1 as VideoSequenceSpec, a2 as WipeTransition, a3 as ZoomTransition, a4 as normalizeStops, a5 as pictureStops } from './types-DSGwN5w1.js';
 import { S as Sequence } from './Base-CpdDs4HT.js';

package/dist/index.js

@@ -1,6 +1,6 @@
-import { CompositionSequence, maskSourceOf } from './chunk-GBUM7X2S.js';
-import { ensureFilterLibrary, homeDistance, DEFAULT_FOV, random, noise, flattenSvgPath, rand, DEG, timeRemapOf, contentLength, resolveAt, checkEase } from './chunk-X3HB4DSR.js';
-export { noise, rand, random, registerSequenceType } from './chunk-X3HB4DSR.js';
+import { CompositionSequence, maskSourceOf } from './chunk-WMMZDPWK.js';
+import { ensureFilterLibrary, homeDistance, DEFAULT_FOV, random, noise, flattenSvgPath, rand, DEG, timeRemapOf, contentLength, resolveAt, checkEase } from './chunk-FXAHNPBP.js';
+export { noise, rand, random, registerSequenceType } from './chunk-FXAHNPBP.js';
 import { usesAdvancedBlend, enableAdvancedBlend } from './chunk-AXZUKNXF.js';
 import { collectPropKeys } from './chunk-TLYTYBWX.js';
 import { warnUnknownOptions, suggestName } from './chunk-BXOCEZ4U.js';
@@ -8,7 +8,7 @@ import * as PIXI from 'pixi.js';
 import { extensions, CullerPlugin, Application, Container, Rectangle, Culler, CanvasTextMetrics, TextStyle, Assets, ExtensionType, Filter, Texture, UniformGroup, GpuProgram, GlProgram, defaultFilterVert } from 'pixi.js';
 import { gsap } from 'gsap';
 import { PixiPlugin } from 'gsap/PixiPlugin';
-import { QUALITY_VERY_HIGH, QUALITY_HIGH, QUALITY_MEDIUM, QUALITY_LOW, QUALITY_VERY_LOW, Output, BufferTarget, CanvasSource, AudioBufferSource, Input, ALL_FORMATS, BlobSource, WavOutputFormat, Conversion, VideoSampleSink, MkvOutputFormat, WebMOutputFormat, MovOutputFormat, Mp4OutputFormat, getFirstEncodableAudioCodec } from 'mediabunny';
+import { Output, BufferTarget, CanvasSource, AudioBufferSource, Input, ALL_FORMATS, BlobSource, WavOutputFormat, Conversion, VideoSampleSink, OggOutputFormat, QUALITY_VERY_HIGH, QUALITY_HIGH, QUALITY_MEDIUM, QUALITY_LOW, QUALITY_VERY_LOW, MkvOutputFormat, WebMOutputFormat, MovOutputFormat, Mp4OutputFormat, canEncodeVideo, getFirstEncodableAudioCodec } from 'mediabunny';
 
 var registered = false;
 function ensureLoadersRegistered(audioContext) {
@@ -759,24 +759,70 @@ function resolveRenderOptions(o) {
   };
 }
 
-// src/core/Renderer.ts
-var VIDEO_CODEC_BY_FORMAT = {
-  mp4: "avc",
-  mov: "avc",
-  webm: "vp9",
-  mkv: "vp9"
+// src/core/renderOptions.ts
+var QUALITY_NAMES = ["very-low", "low", "medium", "high", "very-high"];
+function parseBitrate(v) {
+  if (v === void 0 || v === null) return {};
+  if (typeof v === "string" && QUALITY_NAMES.includes(v)) return { quality: v };
+  if (typeof v === "number" && Number.isFinite(v) && v > 0) return { bps: Math.round(v) };
+  const m = typeof v === "string" ? /^\s*(\d+(?:\.\d+)?)\s*([kKmM]?)\s*$/.exec(v) : null;
+  if (m) {
+    const n = Number(m[1]) * { "": 1, k: 1e3, m: 1e6 }[m[2].toLowerCase()];
+    if (n > 0) return { bps: Math.round(n) };
+  }
+  throw new Error(`pixi-effects: bitrate ${JSON.stringify(v)}: use a quality (${QUALITY_NAMES.join(", ")}) or bits a second (8000000, '8M', '800k')`);
+}
+var AUDIO_FORMATS = ["wav", "ogg"];
+var isAudioFormat = (f) => AUDIO_FORMATS.includes(f);
+var VIDEO_CODEC_PREFERENCE = {
+  mp4: ["avc", "hevc", "vp9", "av1"],
+  mov: ["avc", "hevc"],
+  webm: ["vp9", "av1", "vp8"],
+  mkv: ["vp9", "avc", "hevc", "av1", "vp8"]
 };
-var AUDIO_CODEC_BY_FORMAT = {
-  mp4: "aac",
-  mov: "aac",
-  webm: "opus",
-  mkv: "opus"
+var CODEC_ALIASES = {
+  h264: "avc",
+  "h.264": "avc",
+  x264: "avc",
+  avc1: "avc",
+  h265: "hevc",
+  "h.265": "hevc",
+  x265: "hevc",
+  hvc1: "hevc",
+  hev1: "hevc",
+  vp09: "vp9",
+  "vp-9": "vp9",
+  av01: "av1",
+  vp80: "vp8",
+  "vp-8": "vp8"
 };
+async function chooseVideoCodec(a) {
+  const held = a.supported ?? VIDEO_CODEC_PREFERENCE[a.fmt];
+  const order = VIDEO_CODEC_PREFERENCE[a.fmt].filter((c) => held.includes(c));
+  const firstThatWorks = async (list) => {
+    for (const c of list) if (await a.canEncode(c)) return c;
+    return null;
+  };
+  if (a.requested) {
+    const alias = CODEC_ALIASES[a.requested.toLowerCase()];
+    if (alias) throw new Error(`pixi-effects: render({ video: { codec: "${a.requested}" } }): "${a.requested}" is not a codec name here; did you mean "${alias}"?`);
+    if (!order.includes(a.requested)) throw new Error(`pixi-effects: render(): "${a.requested}" cannot go in ${a.fmt} (${a.fmt} holds ${order.join(", ")})`);
+    if (await a.canEncode(a.requested)) return { codec: a.requested };
+    const alt = await firstThatWorks(order.filter((c) => c !== a.requested));
+    throw new Error(`pixi-effects: this browser cannot encode "${a.requested}" video for ${a.fmt}` + (alt ? `; "${alt}" would work: render({ format: '${a.fmt}', video: { codec: '${alt}' } }), or leave video.codec out and the best one is chosen.` : "; it can encode none of " + order.join(", ") + "."));
+  }
+  const chosen = await firstThatWorks(order);
+  if (!chosen) throw new Error(`pixi-effects: this browser has no video encoder for ${a.fmt} (it tried ${order.join(", ")}): try another browser, or another format`);
+  return chosen === order[0] ? { codec: chosen } : { codec: chosen, fellBackFrom: order[0] };
+}
+
+// src/core/Renderer.ts
 var AUDIO_PREFERENCE = {
   mp4: ["aac", "opus", "mp3", "flac"],
   mov: ["aac", "mp3"],
   webm: ["opus", "vorbis"],
-  mkv: ["opus", "vorbis", "aac", "flac", "mp3"]
+  mkv: ["opus", "vorbis", "aac", "flac", "mp3"],
+  ogg: ["opus", "vorbis", "flac"]
 };
 async function chooseAudioCodec(fmt, requested, container, audio, bitrate) {
   const supported = container.getSupportedAudioCodecs?.();
@@ -801,6 +847,10 @@ var qualityMap = {
   "high": QUALITY_HIGH,
   "very-high": QUALITY_VERY_HIGH
 };
+function bitrateOf(v, fallback) {
+  const b = parseBitrate(v);
+  return b.bps ?? (b.quality ? qualityMap[b.quality] : fallback);
+}
 function makeOutputFormat(name) {
   switch (name) {
     case "mp4":
@@ -820,19 +870,47 @@ function sliceAudio(buffer, fromSec, toSec, fadeIn, fadeOut) {
   cut.forEach((data, c) => out.copyToChannel(data, c));
   return out;
 }
+async function exportAudioOnly(movie, options, fmt, range2) {
+  if (!movie.audioBuffer) {
+    throw new Error(`pixi-effects: render({ format: '${fmt}' }): this movie has no sound to export (add an audio layer, an sfx or a music score); for the picture use mp4, webm, mov or mkv`);
+  }
+  if (options.video) console.warn(`pixi-effects: render({ format: '${fmt}' }): video options are ignored, only the sound is written`);
+  const audio = range2.partial ? sliceAudio(movie.audioBuffer, range2.fromSec, range2.toSec, range2.fromFrame > 0, range2.toFrame < movie.totalFrames) : movie.audioBuffer;
+  const container = fmt === "wav" ? new WavOutputFormat() : new OggOutputFormat();
+  let codec;
+  if (fmt === "wav") {
+    codec = options.audio?.codec ?? "pcm-s16";
+    const held = container.getSupportedAudioCodecs();
+    if (!held.includes(codec)) throw new Error(`pixi-effects: render({ format: 'wav', audio: { codec: "${codec}" } }): wav holds ${held.join(", ")} (the usual is pcm-s16)`);
+  } else {
+    codec = await chooseAudioCodec("ogg", options.audio?.codec, container, audio, bitrateOf(options.audio?.bitrate, QUALITY_HIGH));
+  }
+  const output = new Output({ format: container, target: new BufferTarget() });
+  const source = new AudioBufferSource({ codec, ...fmt === "wav" ? {} : { bitrate: bitrateOf(options.audio?.bitrate, QUALITY_HIGH) } });
+  output.addAudioTrack(source);
+  movie.emit("progress", { progress: 0, frame: range2.fromFrame, totalFrames: movie.totalFrames });
+  await output.start();
+  await source.add(audio);
+  await source.close();
+  await output.finalize();
+  movie.emit("progress", { progress: 100, frame: range2.toFrame, totalFrames: movie.totalFrames });
+  return new Blob([output.target.buffer], { type: output.format.mimeType });
+}
 async function exportFrames(movie, options = {}) {
   const fmt = options.format ?? "mp4";
   const eff = resolveRenderOptions(options);
   const range2 = resolveRange(options.range, { frameRate: movie.frameRate, totalFrames: movie.totalFrames, duration: movie.duration, rows: typeof options.range === "string" ? movie.timelineData().rows : void 0 });
+  if (isAudioFormat(fmt)) return exportAudioOnly(movie, options, fmt, range2);
+  if (!["mp4", "mov", "webm", "mkv"].includes(fmt)) throw new Error(`pixi-effects: render({ format: "${String(fmt)}" }): use mp4, mov, webm, mkv (a picture) or wav, ogg (only the sound)`);
+  warnUnknownOptions("movie.render({ video })", options.video, ["codec", "bitrate", "hardware", "keyFrameInterval"]);
+  warnUnknownOptions("movie.render({ audio })", options.audio, ["codec", "bitrate"]);
+  const videoBitrate = bitrateOf(eff.bitrate ?? "high", QUALITY_HIGH);
   const opts = {
     format: fmt,
-    video: {
-      codec: options.video?.codec ?? VIDEO_CODEC_BY_FORMAT[fmt],
-      bitrate: qualityMap[eff.bitrate ?? "high"] ?? QUALITY_HIGH
-    },
+    video: { codec: "", bitrate: videoBitrate },
     audio: {
-      codec: options.audio?.codec ?? AUDIO_CODEC_BY_FORMAT[fmt],
-      bitrate: qualityMap[options.audio?.bitrate ?? "high"] ?? QUALITY_HIGH
+      codec: options.audio?.codec ?? (fmt === "mp4" || fmt === "mov" ? "aac" : "opus"),
+      bitrate: bitrateOf(options.audio?.bitrate, QUALITY_HIGH)
     }
   };
   const container = makeOutputFormat(opts.format);
@@ -847,9 +925,23 @@ async function exportFrames(movie, options = {}) {
   const blurCanvas = mb ? Object.assign(document.createElement("canvas"), { width: stage.width, height: stage.height }) : null;
   const small = eff.scale < 1 ? Object.assign(document.createElement("canvas"), { width: Math.max(2, Math.round(stage.width * eff.scale / 2) * 2), height: Math.max(2, Math.round(stage.height * eff.scale / 2) * 2) }) : null;
   const smallCtx = small?.getContext("2d") ?? null;
-  const canvasSource = new CanvasSource(small ?? blurCanvas ?? stage, {
+  const picture = small ?? blurCanvas ?? stage;
+  const chosen = await chooseVideoCodec({
+    fmt,
+    requested: options.video?.codec,
+    supported: container.getSupportedVideoCodecs(),
+    canEncode: (c) => canEncodeVideo(c, { width: picture.width, height: picture.height, bitrate: opts.video.bitrate })
+  });
+  if (chosen.fellBackFrom) console.warn(`pixi-effects: this browser cannot encode ${chosen.fellBackFrom.toUpperCase()} video, so the ${fmt} carries ${chosen.codec.toUpperCase()} instead (name a codec with render({ video: { codec } }) to choose yourself).`);
+  opts.video.codec = chosen.codec;
+  const hardware = options.video?.hardware;
+  if (hardware !== void 0 && !["no-preference", "prefer-hardware", "prefer-software"].includes(hardware)) {
+    throw new Error(`pixi-effects: render({ video: { hardware: "${String(hardware)}" } }): use 'prefer-hardware', 'prefer-software' or 'no-preference'`);
+  }
+  const canvasSource = new CanvasSource(picture, {
     codec: opts.video.codec,
-    bitrate: opts.video.bitrate
+    bitrate: opts.video.bitrate,
+    ...hardware ? { hardwareAcceleration: hardware } : {}
   });
   output.addVideoTrack(canvasSource, { frameRate: movie.frameRate });
   if (audio) {
@@ -865,7 +957,9 @@ async function exportFrames(movie, options = {}) {
     await output.start();
   }
   movie.app.ticker.stop();
-  const keyframeIntervalFrames = Math.max(1, Math.round(2 * movie.frameRate));
+  const interval = options.video?.keyFrameInterval ?? 2;
+  if (!(typeof interval === "number" && Number.isFinite(interval) && interval > 0)) throw new Error(`pixi-effects: render({ video: { keyFrameInterval: ${String(interval)} } }): seconds between keyframes, above 0 (default 2)`);
+  const keyframeIntervalFrames = Math.max(1, Math.round(interval * movie.frameRate));
   try {
     const count = Math.max(1, range2.toFrame - range2.fromFrame);
     for (let frame = range2.fromFrame; frame <= range2.toFrame; frame++) {