pixi-effects 0.17.0 → 0.18.0

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, L as LayerInfo, e as LoaderOption, M as MotionBlurOptions, f as MotionBlurSpec, g as Movie, h as MovieErrorEvent, i as MovieOptions, O as OnionSkinOptions, P as ProgressEvent, R as RenderOptions, S as SnapshotOptions, j as SoundMeasure, k as StopEvent, l as StopImage, m as StopImagesOptions, T as TimelineData, n as TimelineHtmlOptions, o as TimelineRow, p as TimelineSvgOptions, q as TimelineTransition, V as VolumeEvent, r as dismissLoader, s as failLoader, t as resolveLoader } from './Movie-CoxF2Z7t.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 LoaderOption, M as MotionBlurOptions, g as MotionBlurSpec, h as Movie, i as MovieErrorEvent, j as MovieOptions, O as OnionSkinOptions, P as ProgressEvent, R as RenderOptions, k as ReviewOptions, l as ReviewReport, S as SnapshotOptions, m as SoundMeasure, n as StopEvent, o as StopImage, p as StopImagesOptions, T as TimelineData, q as TimelineHtmlOptions, r as TimelineRow, s as TimelineSvgOptions, t as TimelineTransition, V as VolumeEvent, u as dismissLoader, v as failLoader, w as resolveLoader } from './Movie-K2YuVAdg.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-SS51lP6O.cjs';
 export { A as ArcShapeSpec, e as AssetSpec, f as AudioAssetSpec, g as AudioMusicSpec, h as AudioSequenceSpec, i as AudioSfxSpec, 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 LineShapeSpec, r as MusicDrum, s as MusicDrums, t as MusicInstrument, u as MusicLevel, v as MusicTrack, N as NullSequenceSpec, w as PathShapeSpec, x as PolygonShapeSpec, y as PropValue, R as RectShapeSpec, z as SfxKnobs, B as SfxOptions, H as SfxPreset, J as SfxVoice, O as ShapeSequenceSpec, Q as SlideTransition, U as Stop, V as StopSpec, W as TransitionCommon, X as VideoSequenceSpec, Y as WipeTransition, Z as ZoomTransition, _ as normalizeStops, $ as pictureStops } from './types-SS51lP6O.cjs';
 import { S as Sequence } from './Base-OHqp8qvX.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, L as LayerInfo, e as LoaderOption, M as MotionBlurOptions, f as MotionBlurSpec, g as Movie, h as MovieErrorEvent, i as MovieOptions, O as OnionSkinOptions, P as ProgressEvent, R as RenderOptions, S as SnapshotOptions, j as SoundMeasure, k as StopEvent, l as StopImage, m as StopImagesOptions, T as TimelineData, n as TimelineHtmlOptions, o as TimelineRow, p as TimelineSvgOptions, q as TimelineTransition, V as VolumeEvent, r as dismissLoader, s as failLoader, t as resolveLoader } from './Movie-DHJRrUfI.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 LoaderOption, M as MotionBlurOptions, g as MotionBlurSpec, h as Movie, i as MovieErrorEvent, j as MovieOptions, O as OnionSkinOptions, P as ProgressEvent, R as RenderOptions, k as ReviewOptions, l as ReviewReport, S as SnapshotOptions, m as SoundMeasure, n as StopEvent, o as StopImage, p as StopImagesOptions, T as TimelineData, q as TimelineHtmlOptions, r as TimelineRow, s as TimelineSvgOptions, t as TimelineTransition, V as VolumeEvent, u as dismissLoader, v as failLoader, w as resolveLoader } from './Movie-DlHQ9C02.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-SS51lP6O.js';
 export { A as ArcShapeSpec, e as AssetSpec, f as AudioAssetSpec, g as AudioMusicSpec, h as AudioSequenceSpec, i as AudioSfxSpec, 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 LineShapeSpec, r as MusicDrum, s as MusicDrums, t as MusicInstrument, u as MusicLevel, v as MusicTrack, N as NullSequenceSpec, w as PathShapeSpec, x as PolygonShapeSpec, y as PropValue, R as RectShapeSpec, z as SfxKnobs, B as SfxOptions, H as SfxPreset, J as SfxVoice, O as ShapeSequenceSpec, Q as SlideTransition, U as Stop, V as StopSpec, W as TransitionCommon, X as VideoSequenceSpec, Y as WipeTransition, Z as ZoomTransition, _ as normalizeStops, $ as pictureStops } from './types-SS51lP6O.js';
 import { S as Sequence } from './Base-BQUodYZK.js';

package/dist/index.js

@@ -1,6 +1,6 @@
-import { CompositionSequence } from './chunk-Q3IVBYT7.js';
-import { ensureFilterLibrary, homeDistance, DEFAULT_FOV, random, noise, flattenSvgPath, rand, DEG, resolveAt, checkEase, collectPropKeys } from './chunk-ORTYBA42.js';
-export { noise, rand, random, registerSequenceType } from './chunk-ORTYBA42.js';
+import { CompositionSequence } from './chunk-UXDR3ZDU.js';
+import { ensureFilterLibrary, homeDistance, DEFAULT_FOV, random, noise, flattenSvgPath, rand, DEG, resolveAt, checkEase, collectPropKeys } from './chunk-SG3Y66FN.js';
+export { noise, rand, random, registerSequenceType } from './chunk-SG3Y66FN.js';
 import { warnUnknownOptions, suggestName } from './chunk-DKGG7WD4.js';
 import * as PIXI from 'pixi.js';
 import { extensions, CullerPlugin, Application, Container, Rectangle, Culler, CanvasTextMetrics, TextStyle, Assets, ExtensionType, Filter, UniformGroup, GpuProgram, GlProgram, defaultFilterVert } from 'pixi.js';
@@ -446,19 +446,22 @@ function inspectFonts(root) {
     if (face.status === "error") failed.add(face.family.replace(/^["']|["']$/g, ""));
   });
   const missing = [];
+  const used = /* @__PURE__ */ new Set();
   const walk2 = (seq, index) => {
     const spec = seq.spec;
     if (spec.type === "text") {
       const raw = spec.style?.fontFamily;
       const family2 = Array.isArray(raw) ? raw.join(", ") : typeof raw === "string" ? raw : "";
       const list = family2.split(",").map((f) => f.trim()).filter(Boolean);
+      for (const f of list) used.add(f.replace(/^["']|["']$/g, "").toLowerCase());
       if (list.length && !list.some(fontAvailable) && !list.some((f) => failed.has(f.replace(/^["']|["']$/g, "")))) missing.push({ layer: spec.name ?? `text#${index}`, family: family2 });
     }
     if (seq.maskSequence) walk2(seq.maskSequence, index);
     (seq._children ?? []).forEach((child, i) => walk2(child, i));
   };
   walk2(root, 0);
-  return { missing, failed: [...failed] };
+  const all = [...failed];
+  return { missing, failed: all.filter((f) => used.has(f.toLowerCase())), failedUnused: all.filter((f) => !used.has(f.toLowerCase())) };
 }
 
 // src/core/scenes.ts
@@ -466,6 +469,92 @@ function namedScenes(rows) {
   return rows.filter((r) => r.depth === 0 && r.type === "composition" && !/[#×]/.test(r.name) && r.end - r.start >= 1).map((r) => ({ name: r.name, start: r.start, end: r.end }));
 }
 
+// src/core/review.ts
+function sampleFrames({ totalFrames, frameRate, scenes = [], step = 0.25, cap = 240 }) {
+  const last = totalFrames;
+  const clamp2 = (f) => Math.max(0, Math.min(last, Math.round(f)));
+  const edges = /* @__PURE__ */ new Set([0, last]);
+  for (const s of scenes) {
+    edges.add(clamp2(s.start * frameRate));
+    edges.add(clamp2(s.end * frameRate - 1));
+  }
+  const room = Math.max(0, cap - edges.size);
+  const seconds = totalFrames / frameRate;
+  const wanted = Math.floor(seconds / step) + 1;
+  const stride = wanted <= room ? step : seconds / Math.max(1, room);
+  const frames = new Set(edges);
+  for (let t = stride; frames.size < cap && t < seconds; t += stride) frames.add(clamp2(t * frameRate));
+  return [...frames].sort((a, b) => a - b);
+}
+var AT_HELP = "use seconds (3.5), a percentage (50%), a frame (f120) or a layer's start / mid / end (name@end)";
+function resolveAtList(list, ctx) {
+  const { frameRate: fps, totalFrames, duration, rows } = ctx;
+  const out = [], used = /* @__PURE__ */ new Set();
+  const named = rows.flatMap((r) => r.parts && r.partNames ? r.partNames.map((name, i) => ({ name, start: r.parts[i].start, end: r.parts[i].end })) : [r]);
+  for (const raw of String(list).split(",").map((s) => s.trim()).filter(Boolean)) {
+    let frame, label, m;
+    if (m = raw.match(/^(.+)@(start|mid|end)$/)) {
+      const row = named.find((r) => r.name === m[1]);
+      if (!row) throw new Error(`--at "${raw}": no layer named "${m[1]}" (names: ${named.slice(0, 40).map((r) => r.name).join(", ")}${named.length > 40 ? ", \u2026" : ""})`);
+      const t = m[2] === "start" ? row.start : m[2] === "mid" ? (row.start + row.end) / 2 : row.end - 1 / fps;
+      frame = Math.round(t * fps);
+      label = `${m[1]}-${m[2]}`;
+    } else if (m = raw.match(/^(\d+(?:\.\d+)?)%$/)) {
+      frame = Math.round(Number(m[1]) / 100 * totalFrames);
+      label = `${m[1]}pct`;
+    } else if (m = raw.match(/^f(\d+)$/i)) {
+      frame = Number(m[1]);
+      label = `f${m[1]}`;
+    } else if (/^\d+(\.\d+)?$/.test(raw)) {
+      frame = Math.round(Number(raw) * fps);
+      label = `${Number(raw).toFixed(2)}s`;
+    } else throw new Error(`--at: cannot read "${raw}": ${AT_HELP}`);
+    if (frame > totalFrames || frame < 0) throw new Error(`--at "${raw}" is past the end: the movie is ${duration} s (${totalFrames} frames)`);
+    label = label.replace(/[\\/:*?"<>|]+/g, "-");
+    let unique = label, n = 2;
+    while (used.has(unique)) unique = `${label}-${n++}`;
+    used.add(unique);
+    out.push({ label: unique, frame });
+  }
+  return out;
+}
+function groupIssues(perFrame) {
+  const groups = /* @__PURE__ */ new Map();
+  for (const { frame, issues } of perFrame) {
+    for (const message of issues) {
+      const key = message.replace(/-?\d+(\.\d+)?/g, "#");
+      const g = groups.get(key);
+      if (g) {
+        g.count++;
+        g.lastFrame = frame;
+      } else groups.set(key, { message, count: 1, firstFrame: frame, lastFrame: frame });
+    }
+  }
+  return [...groups.values()];
+}
+function splitIssues(groups, strict = false) {
+  if (strict) return { problems: groups, review: [] };
+  const overlap = (g) => /\boverlap\b/.test(g.message);
+  return { problems: groups.filter((g) => !overlap(g)), review: groups.filter(overlap) };
+}
+async function reviewMovie(movie, opts = {}) {
+  const rows = movie.timelineData().rows;
+  const at = opts.at ? resolveAtList(opts.at, { frameRate: movie.frameRate, totalFrames: movie.totalFrames, duration: movie.duration, rows }) : [];
+  const frames = sampleFrames({ totalFrames: movie.totalFrames, frameRate: movie.frameRate, scenes: namedScenes(rows) });
+  const perFrame = [];
+  for (const frame of frames) {
+    const r = await movie.inspect(frame, { layers: "none" });
+    if (r.issues.length) perFrame.push({ frame, issues: r.issues });
+  }
+  const grouped = splitIssues(groupIssues(perFrame), !!opts.strict);
+  const fonts = movie.inspectFonts();
+  for (const f of fonts.failedUnused) grouped.review.push({ message: `web font "${f}" failed to load, but no text layer uses it (a broken or unused @font-face)`, count: 1, firstFrame: 0, lastFrame: 0 });
+  for (const m of fonts.missing) {
+    (opts.strict ? grouped.problems : grouped.review).push({ message: `layer "${m.layer}": none of the fonts "${m.family}" is available here (it is drawn in a fallback font)`, count: 1, firstFrame: 0, lastFrame: 0 });
+  }
+  return { frames: frames.length, problems: grouped.problems, review: grouped.review, fonts, audio: movie.audioBuffer ? movie.inspectAudio() : null, at };
+}
+
 // src/core/onion.ts
 function onionTimes(from, to, count) {
   if (count <= 1) return [from];
@@ -502,9 +591,9 @@ function resolveRange(range2, ctx) {
   if (range2 === void 0) return { fromFrame: 0, toFrame: totalFrames, fromSec: 0, toSec: duration, partial: false };
   let from, to;
   if (typeof range2 === "string") {
-    const rows = (ctx.rows ?? []).filter((r) => r.depth === 0);
+    const rows = (ctx.rows ?? []).filter((r) => r.depth === 0).flatMap((r) => r.parts && r.partNames ? r.partNames.map((name, i) => ({ name, start: r.parts[i].start, end: r.parts[i].end })) : [r]);
     const row = rows.find((r) => r.name === range2);
-    if (!row) throw new Error(`pixi-effects: render({ range: "${range2}" }): no layer named "${range2}" at the top level (names: ${rows.map((r) => r.name).join(", ") || "none"})`);
+    if (!row) throw new Error(`pixi-effects: render({ range: "${range2}" }): no layer named "${range2}" at the top level (names: ${rows.slice(0, 40).map((r) => r.name).join(", ") || "none"}${rows.length > 40 ? ", \u2026" : ""})`);
     from = row.start;
     to = row.end;
   } else {
@@ -669,7 +758,7 @@ async function exportFrames(movie, options = {}) {
     }
     await canvasSource.close();
     await output.finalize();
-    if (mb) await movie.gotoFrame(movie.totalFrames, true);
+    if (mb) await movie.gotoFrame(range2.toFrame, true);
     return new Blob([output.target.buffer], { type: output.format.mimeType });
   } finally {
     movie.app.ticker.start();
@@ -1585,7 +1674,8 @@ function groupFamilies(entries) {
         start: Math.min(...members.map((x) => x.start)),
         end: Math.max(...members.map((x) => x.end)),
         keys: members.flatMap((x) => x.keys).sort((a, b) => a - b).slice(0, MAX_KEYS),
-        parts: members.map((x) => ({ start: x.start, end: x.end }))
+        parts: members.map((x) => ({ start: x.start, end: x.end })),
+        partNames: members.map((x) => x.name)
       });
     } else {
       out.push(e.row, ...e.inner);
@@ -2405,6 +2495,27 @@ var Movie = class {
    * The soundtrack, measured: when every audio layer plays, how loud the mix is over time, and `issues`
    * (limiting, inaudible layers, sounds cut off by the end). Use it to CHECK sound you cannot hear.
    */
+  /** The pictures to look at for moments such as `3.5`, `50%`, `f120`, `title@end` (comma-separated). A mistake says what could not be read. */
+  resolveAt(list) {
+    this._requireReady("resolveAt");
+    return resolveAtList(list, { frameRate: this.frameRate, totalFrames: this.totalFrames, duration: this.duration, rows: this.timelineData().rows });
+  }
+  /**
+   * One call that looks at everything `pixi-effects-check` looks at inside the page: layout issues over the whole timeline (every
+   * scene's first and last frame and a frame every 0.25 s), fonts and the sound. See `ReviewReport`. Page warnings are in `window.__logs`. The movie is left as it was.
+   */
+  async review(opts = {}) {
+    warnUnknownOptions("movie.review()", opts, ["at", "strict"]);
+    this._requireReady("review");
+    const back = this.currentFrame, wasAtPoster = this._atPoster;
+    try {
+      return await reviewMovie(this, opts);
+    } finally {
+      this.currentFrame = back;
+      if (wasAtPoster) await this._showPoster();
+      else await this._quietly(() => this.gotoFrame(back, true));
+    }
+  }
   /**
    * The fonts of the text layers: `missing` lists layers none of whose `fontFamily` entries is available in this browser (they are
    * drawn in a fallback font), `failed` lists web fonts (`@font-face`) whose file could not be loaded.