pixi-effects 0.16.3 → 0.18.0

package/dist/{Movie-oA0SUAyb.d.cts → Movie-K2YuVAdg.d.cts}

@@ -5,6 +5,12 @@ import { U as Stop, e as AssetSpec, c as CompositionSpec } from './types-SS51lP6
 interface AudioInspectOptions {
     /** Width of each loudness window in seconds. Default 0.1. */
     window?: number;
+    /** The scenes to measure one by one (`movie.inspectAudio()` fills this from the movie's named top-level compositions). Default: the whole movie as one. */
+    scenes?: Array<{
+        name: string;
+        start: number;
+        end: number;
+    }>;
 }
 /** One sound measured ON ITS OWN (not mixed), so overlapping layers do not blur it. */
 interface SoundMeasure {
@@ -44,8 +50,76 @@ interface AudioReport {
         peakDb: number;
         brightnessHz: number;
     }>;
-    /** Problems worth fixing: limiting, inaudible layers, sounds cut off by the end of the movie. Read this first. */
+    /** Problems worth fixing: limiting, clipping, a true peak above 0 dBTP, inaudible layers, sounds cut off by the end of the movie. Read this first. */
     issues: string[];
+    /** The mix as a whole (ITU-R BS.1770 loudness; `integratedLufs` is null for a mix shorter than 0.4 s or with nothing above −70 LUFS). */
+    loudness: {
+        integratedLufs: number | null;
+        truePeakDb: number;
+        clippedSamples: number;
+        silences: Array<{
+            from: number;
+            to: number;
+        }>;
+    };
+    /** The same measure for each scene (`silent`: nothing above −60 dBFS). */
+    scenes: Array<{
+        name: string;
+        from: number;
+        to: number;
+        lufs: number | null;
+        peakDb: number;
+        silent: boolean;
+    }>;
+    /** When each sound starts: what a waveform marks. */
+    cues: Array<{
+        t: number;
+        name: string;
+    }>;
+    /** Advice, not faults: a mix that is quiet or loud for web video, little headroom, silent stretches. */
+    notes: string[];
+}
+
+interface FontReport {
+    /** Text layers none of whose fonts is available here: they are drawn in a fallback. */
+    missing: Array<{
+        layer: string;
+        family: string;
+    }>;
+    /** Web fonts (`@font-face`) whose file could not be loaded and that a text layer uses. */
+    failed: string[];
+    /** Web fonts whose file could not be loaded but no text layer uses (an unused face: worth a look, not a fault). */
+    failedUnused: string[];
+}
+
+/** One kind of issue, with how many frames it was seen in. Issues that differ only by numbers are one kind. */
+interface IssueGroup {
+    message: string;
+    count: number;
+    firstFrame: number;
+    lastFrame: number;
+}
+interface ReviewOptions {
+    /** Moments to resolve and report: `3.5`, `50%`, `f120`, `title@end` (comma-separated). */
+    at?: string;
+    /** Every layout issue is a problem (by default text overlaps are only listed for review). */
+    strict?: boolean;
+}
+interface ReviewReport {
+    /** How many frames were inspected. */
+    frames: number;
+    /** Text cut off by an edge, outside the canvas, or with no size (with `strict`: every issue). */
+    problems: IssueGroup[];
+    /** Text overlaps and fonts that are not available: often intentional, look at them on the contact sheet. */
+    review: IssueGroup[];
+    fonts: FontReport;
+    /** The sound as numbers (`movie.inspectAudio()`), or null for a movie with no audio. */
+    audio: AudioReport | null;
+    /** The moments of `at`, as frames with a label that is safe as a file name. */
+    at: Array<{
+        label: string;
+        frame: number;
+    }>;
 }
 
 interface Rect {
@@ -107,6 +181,8 @@ interface TimelineRow {
         start: number;
         end: number;
     }>;
+    /** With `parts`: the name of each layer the row stands for, in the same order (so `render({ range: 'pop-3' })` can find it). */
+    partNames?: string[];
     /** A short text for the tooltip (a text layer's words, an asset name). */
     detail?: string;
 }
@@ -196,6 +272,15 @@ interface RenderOptions {
         codec?: string;
         bitrate?: 'very-low' | 'low' | 'medium' | 'high' | 'very-high';
     };
+    /**
+     * Only part of the movie: `[from, to]` in seconds, or the name of a top-level layer (its start to its end). The file starts at 0
+     * and its sound is cut the same way (with a 10 ms fade on a cut edge). Past the end, backwards or an unknown name is an error.
+     */
+    range?: [number, number] | string;
+    /** Output size relative to the canvas, above 0 and at most 1. Each frame is drawn at full size and copied smaller before it is encoded: the file and the encoding get smaller, the drawing is not faster. */
+    scale?: number;
+    /** For looking, not for delivering: `scale: 0.5`, `video.bitrate: 'low'` and no motion blur. Anything you set yourself wins. */
+    draft?: boolean;
 }
 interface SnapshotOptions {
     /** Motion blur for this picture (see `MovieOptions.motionBlur`); overrides the movie's own setting, `false` turns it off. */
@@ -248,6 +333,19 @@ interface ContactSheetOptions {
     cellWidth?: number;
     as?: 'blob' | 'dataURL';
 }
+interface OnionSkinOptions {
+    /** Where the movement starts, in seconds. Default 0. */
+    from?: number;
+    /** Where it ends, in seconds. Default: the end of the movie. */
+    to?: number;
+    /** How many frames are overlaid, 1–64, spread evenly from `from` to `to`. Default 8. */
+    count?: number;
+    /** Output size relative to the canvas, above 0 and at most 4. Default 1. */
+    scale?: number;
+    /** Motion blur for these pictures (see `MovieOptions.motionBlur`); overrides the movie's own setting, `false` turns it off. */
+    motionBlur?: MotionBlurSpec;
+    as?: 'blob' | 'dataURL';
+}
 interface FrameEvent {
     frame: number;
     totalFrames: number;
@@ -419,6 +517,17 @@ declare class Movie {
         motionBlur?: MotionBlurSpec;
         onImage?: (image: StopImage) => void;
     }): Promise<Blob>;
+    /**
+     * One picture of a movement: `count` frames from `from` to `to` drawn one over the other, each later one stronger, so a thing that
+     * moves leaves a trail (its path and its easing: even steps = constant speed, bunched = slow) and what stays still stays itself.
+     * The movie is left where it was.
+     */
+    onionSkin(opts?: OnionSkinOptions & {
+        as?: 'blob';
+    }): Promise<Blob>;
+    onionSkin(opts: OnionSkinOptions & {
+        as: 'dataURL';
+    }): Promise<string>;
     /**
      * Several frames on ONE image, each labelled with its frame number and time — the cheapest way to
      * check a whole animation by eye. Restores the current frame afterwards.
@@ -447,6 +556,21 @@ declare class Movie {
      * 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: string): Array<{
+        label: string;
+        frame: number;
+    }>;
+    /**
+     * 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.
+     */
+    review(opts?: ReviewOptions): Promise<ReviewReport>;
+    /**
+     * 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.
+     */
+    inspectFonts(): FontReport;
     inspectAudio(opts?: AudioInspectOptions): AudioReport;
     /**
      * Draw the stage now. PixiJS's CullerPlugin only culls inside `app.render()` (the ticker), and we render
@@ -509,4 +633,4 @@ declare class Movie {
     destroy(): Promise<void>;
 }
 
-export { type AudioInspectOptions as A, type ContactSheetOptions as C, type FrameEvent as F, type InspectOptions as I, type LayerInfo as L, type MotionBlurOptions as M, type ProgressEvent as P, type RenderOptions as R, type SnapshotOptions as S, type TimelineData as T, type VolumeEvent as V, type AudioReport as a, type AudioSourceReport as b, type InspectReport as c, type LoaderOption as d, type MotionBlurSpec as e, Movie as f, type MovieErrorEvent as g, type MovieOptions as h, type SoundMeasure as i, type StopEvent as j, type StopImage as k, type StopImagesOptions as l, type TimelineHtmlOptions as m, type TimelineRow as n, type TimelineSvgOptions as o, type TimelineTransition as p, dismissLoader as q, failLoader as r, resolveLoader as s };
+export { type AudioInspectOptions as A, type ContactSheetOptions as C, type FontReport as F, type InspectOptions as I, type LayerInfo as L, type MotionBlurOptions as M, type OnionSkinOptions as O, type ProgressEvent as P, type RenderOptions as R, type SnapshotOptions as S, type TimelineData as T, type VolumeEvent as V, type AudioReport as a, type AudioSourceReport as b, type FrameEvent as c, type InspectReport as d, type IssueGroup as e, type LoaderOption as f, type MotionBlurSpec as g, Movie as h, type MovieErrorEvent as i, type MovieOptions as j, type ReviewOptions as k, type ReviewReport as l, type SoundMeasure as m, type StopEvent as n, type StopImage as o, type StopImagesOptions as p, type TimelineHtmlOptions as q, type TimelineRow as r, type TimelineSvgOptions as s, type TimelineTransition as t, dismissLoader as u, failLoader as v, resolveLoader as w };

package/dist/Presenter.d.cts

@@ -1,4 +1,4 @@
-import { f as Movie } from './Movie-oA0SUAyb.cjs';
+import { h as Movie } from './Movie-K2YuVAdg.cjs';
 import 'pixi.js';
 import 'gsap';
 import './types-SS51lP6O.cjs';

package/dist/Presenter.d.ts

@@ -1,4 +1,4 @@
-import { f as Movie } from './Movie-DilBC348.js';
+import { h as Movie } from './Movie-DlHQ9C02.js';
 import 'pixi.js';
 import 'gsap';
 import './types-SS51lP6O.js';

package/dist/{chunk-FJA5VUOF.cjs → chunk-ANO5R2E6.cjs}

@@ -310,6 +310,26 @@ function looksLikeColorString(s) {
   if (s.charCodeAt(0) === 35) return true;
   return /^(rgb|hsl|oklab|oklch|lab|lch)\b/i.test(s);
 }
+var FAMILIES = ["power1", "power2", "power3", "power4", "back", "elastic", "bounce", "circ", "expo", "sine"];
+var EASE_NAMES = ["none", ...FAMILIES.flatMap((f) => [`${f}.in`, `${f}.out`, `${f}.inOut`])];
+var warned = /* @__PURE__ */ new Set();
+function checkEase(ease, where) {
+  if (typeof ease !== "string") return;
+  const found = gsap.gsap.parseEase(ease);
+  if (typeof found === "function") return;
+  if (warned.has(ease)) return;
+  warned.add(ease);
+  if (ease === "") {
+    console.warn(`pixi-effects: ${where}: an empty ease (GSAP would run its default, power1.out): write 'none' for no easing, or a name such as 'power2.out'`);
+    return;
+  }
+  if (found && /^power[1-4]$/i.test(ease)) {
+    console.warn(`pixi-effects: ${where}: "${ease}" is a family, not an ease \u2014 write ${ease.toLowerCase()}.out, ${ease.toLowerCase()}.in or ${ease.toLowerCase()}.inOut`);
+    return;
+  }
+  const guess = chunkUQBGW5DO_cjs.suggestName(ease, EASE_NAMES);
+  console.warn(`pixi-effects: ${where}: unknown ease "${ease}"${guess ? ` \u2014 did you mean "${guess}"?` : ""} (GSAP would run it as its default ease, power1.out). Examples: ${EASE_NAMES.slice(0, 7).join(", ")}, back.out(1.7), elastic.out(1, 0.3), steps(8)`);
+}
 
 // src/core/Timeline.ts
 function loopVars(kf) {
@@ -337,6 +357,7 @@ function normalizeKeyframe(kf, parentDuration) {
   const at = resolveAt(kf.at, parentDuration);
   const duration = kf.duration ?? 0;
   const ease = kf.ease ?? "none";
+  checkEase(ease, "a keyframe");
   const hasSet = !!kf.set;
   const hasFrom = !!kf.from;
   const hasTo = !!kf.to;
@@ -2754,7 +2775,7 @@ function numOrZero(v, scope) {
 var _CompositionSequence = null;
 async function getCompositionSequence() {
   if (!_CompositionSequence) {
-    _CompositionSequence = (await import('./Composition-3WWNVRR5.cjs')).CompositionSequence;
+    _CompositionSequence = (await import('./Composition-6JMXWNVV.cjs')).CompositionSequence;
   }
   return _CompositionSequence;
 }
@@ -2801,6 +2822,7 @@ exports.Sequence = Sequence;
 exports.buildScope = buildScope;
 exports.buildSequenceTree = buildSequenceTree;
 exports.cameraBasis = cameraBasis;
+exports.checkEase = checkEase;
 exports.collectPropKeys = collectPropKeys;
 exports.describeLayer = describeLayer;
 exports.ensureFilterLibrary = ensureFilterLibrary;
@@ -2817,5 +2839,5 @@ exports.random = random;
 exports.registerSequenceType = registerSequenceType;
 exports.resolveAt = resolveAt;
 exports.summarizeWarnings = summarizeWarnings;
-//# sourceMappingURL=chunk-FJA5VUOF.cjs.map
-//# sourceMappingURL=chunk-FJA5VUOF.cjs.map
+//# sourceMappingURL=chunk-ANO5R2E6.cjs.map
+//# sourceMappingURL=chunk-ANO5R2E6.cjs.map