pixi-effects 0.12.0 → 0.13.1

package/dist/index.d.cts

@@ -1,7 +1,7 @@
-export { A as AudioInspectOptions, a as AudioReport, b as AudioSourceReport, C as ContactSheetOptions, F as FrameEvent, I as InspectOptions, c as InspectReport, L as LayerInfo, d as LoaderOption, M as MotionBlurOptions, e as MotionBlurSpec, f as Movie, g as MovieErrorEvent, h as MovieOptions, P as ProgressEvent, R as RenderOptions, S as SnapshotOptions, i as SoundMeasure, j as StopEvent, k as StopImage, l as StopImagesOptions, T as TimelineData, m as TimelineHtmlOptions, n as TimelineRow, o as TimelineSvgOptions, p as TimelineTransition, V as VolumeEvent, q as dismissLoader, r as failLoader, s as resolveLoader } from './Movie-CY2QPVVM.cjs';
-import { S as SequenceSpec, C as CompositionShape, I as ImageSequenceSpec, a as CameraSequenceSpec, K as Keyframe, T as TextSequenceSpec, P as Props, b as TransitionSpec, c as CompositionSpec, d as SequenceCommon } from './types-mpqQO8MJ.cjs';
-export { A as ArcShapeSpec, e as AssetSpec, f as AudioAssetSpec, g as AudioSequenceSpec, h as AudioSfxSpec, i as ChromaKeyFilterSpec, j as CircleShapeSpec, k as CompositionSequenceSpec, l as CrossfadeTransition, m as CustomFilterSpec, D as DipTransition, n as DissolveTransition, E as EllipseShapeSpec, o as Expr, F as FilterSpec, G as GradientSpec, p as IrisTransition, L as LineShapeSpec, N as NullSequenceSpec, q as PathShapeSpec, r as PolygonShapeSpec, s as PropValue, R as RectShapeSpec, t as SfxKnobs, u as SfxOptions, v as SfxPreset, w as SfxVoice, x as ShapeSequenceSpec, y as SlideTransition, z as Stop, B as StopSpec, H as TransitionCommon, V as VideoSequenceSpec, W as WipeTransition, Z as ZoomTransition, J as normalizeStops } from './types-mpqQO8MJ.cjs';
-import { S as Sequence } from './Base-W3sQzGPO.cjs';
+export { A as AudioInspectOptions, a as AudioReport, b as AudioSourceReport, C as ContactSheetOptions, F as FrameEvent, I as InspectOptions, c as InspectReport, L as LayerInfo, d as LoaderOption, M as MotionBlurOptions, e as MotionBlurSpec, f as Movie, g as MovieErrorEvent, h as MovieOptions, P as ProgressEvent, R as RenderOptions, S as SnapshotOptions, i as SoundMeasure, j as StopEvent, k as StopImage, l as StopImagesOptions, T as TimelineData, m as TimelineHtmlOptions, n as TimelineRow, o as TimelineSvgOptions, p as TimelineTransition, V as VolumeEvent, q as dismissLoader, r as failLoader, s as resolveLoader } from './Movie-Tl5dRLJl.cjs';
+import { S as SequenceSpec, C as CompositionShape, I as ImageSequenceSpec, a as CameraSequenceSpec, K as Keyframe, T as TextSequenceSpec, P as Props, b as TransitionSpec, c as CompositionSpec, d as SequenceCommon } from './types-CBSiUKau.cjs';
+export { A as ArcShapeSpec, e as AssetSpec, f as AudioAssetSpec, g as AudioSequenceSpec, h as AudioSfxSpec, i as ChromaKeyFilterSpec, j as CircleShapeSpec, k as CompositionSequenceSpec, l as CrossfadeTransition, m as CustomFilterSpec, D as DipTransition, n as DissolveTransition, E as EllipseShapeSpec, o as Expr, F as FilterSpec, G as GradientSpec, p as IrisTransition, L as LineShapeSpec, N as NullSequenceSpec, q as PathShapeSpec, r as PolygonShapeSpec, s as PropValue, R as RectShapeSpec, t as SfxKnobs, u as SfxOptions, v as SfxPreset, w as SfxVoice, x as ShapeSequenceSpec, y as SlideTransition, z as Stop, B as StopSpec, H as TransitionCommon, V as VideoSequenceSpec, W as WipeTransition, Z as ZoomTransition, J as normalizeStops, M as pictureStops } from './types-CBSiUKau.cjs';
+import { S as Sequence } from './Base-C6ZnJ9pD.cjs';
 import 'pixi.js';
 import 'gsap';
 
@@ -531,7 +531,10 @@ interface DeckPage {
     /** The page's layers, written in the page's own time (`at: 0` is the start of the page). */
     sequences: SequenceSpec[];
     /** Where the page stops, in the page's own time: the first is the page settled, the rest are steps (a bullet appears, a chart grows). Default: where the transition into the next page begins (the end for the last page). */
-    stops?: number[];
+    stops?: Array<number | {
+        at: number;
+        pdf?: boolean;
+    }>;
     /** Speaker notes (kept on the page's first stop). */
     notes?: string;
     /** Move on by itself this many seconds after the page's last stop (kiosk mode). */

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-export { A as AudioInspectOptions, a as AudioReport, b as AudioSourceReport, C as ContactSheetOptions, F as FrameEvent, I as InspectOptions, c as InspectReport, L as LayerInfo, d as LoaderOption, M as MotionBlurOptions, e as MotionBlurSpec, f as Movie, g as MovieErrorEvent, h as MovieOptions, P as ProgressEvent, R as RenderOptions, S as SnapshotOptions, i as SoundMeasure, j as StopEvent, k as StopImage, l as StopImagesOptions, T as TimelineData, m as TimelineHtmlOptions, n as TimelineRow, o as TimelineSvgOptions, p as TimelineTransition, V as VolumeEvent, q as dismissLoader, r as failLoader, s as resolveLoader } from './Movie-EBF6_RfX.js';
-import { S as SequenceSpec, C as CompositionShape, I as ImageSequenceSpec, a as CameraSequenceSpec, K as Keyframe, T as TextSequenceSpec, P as Props, b as TransitionSpec, c as CompositionSpec, d as SequenceCommon } from './types-mpqQO8MJ.js';
-export { A as ArcShapeSpec, e as AssetSpec, f as AudioAssetSpec, g as AudioSequenceSpec, h as AudioSfxSpec, i as ChromaKeyFilterSpec, j as CircleShapeSpec, k as CompositionSequenceSpec, l as CrossfadeTransition, m as CustomFilterSpec, D as DipTransition, n as DissolveTransition, E as EllipseShapeSpec, o as Expr, F as FilterSpec, G as GradientSpec, p as IrisTransition, L as LineShapeSpec, N as NullSequenceSpec, q as PathShapeSpec, r as PolygonShapeSpec, s as PropValue, R as RectShapeSpec, t as SfxKnobs, u as SfxOptions, v as SfxPreset, w as SfxVoice, x as ShapeSequenceSpec, y as SlideTransition, z as Stop, B as StopSpec, H as TransitionCommon, V as VideoSequenceSpec, W as WipeTransition, Z as ZoomTransition, J as normalizeStops } from './types-mpqQO8MJ.js';
-import { S as Sequence } from './Base-CYH9vPCH.js';
+export { A as AudioInspectOptions, a as AudioReport, b as AudioSourceReport, C as ContactSheetOptions, F as FrameEvent, I as InspectOptions, c as InspectReport, L as LayerInfo, d as LoaderOption, M as MotionBlurOptions, e as MotionBlurSpec, f as Movie, g as MovieErrorEvent, h as MovieOptions, P as ProgressEvent, R as RenderOptions, S as SnapshotOptions, i as SoundMeasure, j as StopEvent, k as StopImage, l as StopImagesOptions, T as TimelineData, m as TimelineHtmlOptions, n as TimelineRow, o as TimelineSvgOptions, p as TimelineTransition, V as VolumeEvent, q as dismissLoader, r as failLoader, s as resolveLoader } from './Movie-DnR4H1OO.js';
+import { S as SequenceSpec, C as CompositionShape, I as ImageSequenceSpec, a as CameraSequenceSpec, K as Keyframe, T as TextSequenceSpec, P as Props, b as TransitionSpec, c as CompositionSpec, d as SequenceCommon } from './types-CBSiUKau.js';
+export { A as ArcShapeSpec, e as AssetSpec, f as AudioAssetSpec, g as AudioSequenceSpec, h as AudioSfxSpec, i as ChromaKeyFilterSpec, j as CircleShapeSpec, k as CompositionSequenceSpec, l as CrossfadeTransition, m as CustomFilterSpec, D as DipTransition, n as DissolveTransition, E as EllipseShapeSpec, o as Expr, F as FilterSpec, G as GradientSpec, p as IrisTransition, L as LineShapeSpec, N as NullSequenceSpec, q as PathShapeSpec, r as PolygonShapeSpec, s as PropValue, R as RectShapeSpec, t as SfxKnobs, u as SfxOptions, v as SfxPreset, w as SfxVoice, x as ShapeSequenceSpec, y as SlideTransition, z as Stop, B as StopSpec, H as TransitionCommon, V as VideoSequenceSpec, W as WipeTransition, Z as ZoomTransition, J as normalizeStops, M as pictureStops } from './types-CBSiUKau.js';
+import { S as Sequence } from './Base-CQOlB2VH.js';
 import 'pixi.js';
 import 'gsap';
 
@@ -531,7 +531,10 @@ interface DeckPage {
     /** The page's layers, written in the page's own time (`at: 0` is the start of the page). */
     sequences: SequenceSpec[];
     /** Where the page stops, in the page's own time: the first is the page settled, the rest are steps (a bullet appears, a chart grows). Default: where the transition into the next page begins (the end for the last page). */
-    stops?: number[];
+    stops?: Array<number | {
+        at: number;
+        pdf?: boolean;
+    }>;
     /** Speaker notes (kept on the page's first stop). */
     notes?: string;
     /** Move on by itself this many seconds after the page's last stop (kiosk mode). */

package/dist/index.js

@@ -1549,7 +1549,7 @@ ${offset}
 }
 
 // src/core/stops.ts
-var KEYS = ["at", "page", "notes", "advance"];
+var KEYS = ["at", "page", "notes", "advance", "pdf"];
 function normalizeStops(raw, duration, frameRate) {
   if (!raw || raw.length === 0) return [];
   const total = Math.round(duration * frameRate);
@@ -1557,7 +1557,7 @@ function normalizeStops(raw, duration, frameRate) {
   raw.forEach((r, i) => {
     const spec = typeof r === "number" ? { at: r } : r && typeof r === "object" ? r : null;
     if (!spec || typeof spec.at !== "number" || !Number.isFinite(spec.at)) {
-      console.warn(`pixi-effects: stops[${i}] ${JSON.stringify(r)} is not a time in seconds (or { at, page?, notes?, advance? }); ignored`);
+      console.warn(`pixi-effects: stops[${i}] ${JSON.stringify(r)} is not a time in seconds (or { at, page?, notes?, advance?, pdf? }); ignored`);
       return;
     }
     if (typeof r === "object") warnUnknownOptions(`stops[${i}]`, r, KEYS);
@@ -1593,6 +1593,10 @@ function normalizeStops(raw, duration, frameRate) {
       if (typeof s.advance === "number" && Number.isFinite(s.advance) && s.advance >= 0) stop.advance = s.advance;
       else console.warn(`pixi-effects: stops[${index}] advance must be a number of seconds >= 0, got ${JSON.stringify(s.advance)}; ignored`);
     }
+    if (s.pdf !== void 0) {
+      if (typeof s.pdf === "boolean") stop.pdf = s.pdf;
+      else console.warn(`pixi-effects: stops[${index}] pdf must be true or false, got ${JSON.stringify(s.pdf)}; ignored`);
+    }
     return stop;
   });
 }
@@ -1610,6 +1614,20 @@ function stopAtOrBefore(stops, frame) {
 function pageStarts(stops) {
   return stops.filter((s) => s.pageStart);
 }
+function pictureStops(stops, opts = {}) {
+  if (opts.which === "stops") return opts.pdf ? stops.filter((s) => s.pdf !== false) : [...stops];
+  const byPage = /* @__PURE__ */ new Map();
+  for (const s of stops) byPage.set(s.pageIndex, [...byPage.get(s.pageIndex) ?? [], s]);
+  const take = (list) => opts.pick === "first" ? list[0] : list[list.length - 1];
+  const picks = [];
+  for (const list of byPage.values()) {
+    const flagged = list.filter((s) => s.pdf === true);
+    const usable = list.filter((s) => s.pdf !== false);
+    const one = take(flagged.length ? flagged : usable.length ? usable : opts.pdf ? [] : list);
+    if (one) picks.push(one);
+  }
+  return picks;
+}
 
 // src/core/loader.ts
 var FADE_FALLBACK_MS = 900;
@@ -1912,16 +1930,10 @@ var Movie = class {
     return encodeCanvas(out, o.type, o.as, o.quality);
   }
   async stopImages(opts = {}) {
-    warnUnknownOptions("movie.stopImages()", opts, ["which", "pick", "scale", "type", "quality", "as", "motionBlur", "onImage"]);
+    warnUnknownOptions("movie.stopImages()", opts, ["which", "pick", "scale", "type", "quality", "as", "motionBlur", "pdf", "onImage"]);
     this._requireReady("stopImages");
     if (this.stops.length === 0) return [];
-    let picks;
-    if (opts.which === "stops") picks = this.stops;
-    else {
-      const byPage = /* @__PURE__ */ new Map();
-      for (const s of this.stops) byPage.set(s.pageIndex, [...byPage.get(s.pageIndex) ?? [], s]);
-      picks = [...byPage.values()].map((list) => opts.pick === "first" ? list[0] : list[list.length - 1]);
-    }
+    const picks = pictureStops(this.stops, { which: opts.which, pick: opts.pick, pdf: opts.pdf });
     this.pause();
     const back = this.currentFrame, wasAtPoster = this._atPoster;
     const out = [];
@@ -1945,7 +1957,8 @@ var Movie = class {
     return out;
   }
   /**
-   * The deck as a PDF: one page per page of the talk (the page's last stop, fully built; `which: 'stops'` makes a page of every stop), each a
+   * The deck as a PDF: one page per page of the talk (the page's last stop, fully built, unless a stop says `pdf: true` or `pdf: false`;
+   * `which: 'stops'` makes a page of every stop that is not `pdf: false`), each a
    * JPEG at the canvas size. Needs `composition.stops`. A transparent background comes out black: give the movie a `background`.
    */
   async exportPDF(opts = {}) {
@@ -1961,6 +1974,7 @@ var Movie = class {
       quality: opts.quality ?? 0.92,
       as: "blob",
       motionBlur: opts.motionBlur,
+      pdf: true,
       onImage: opts.onImage
     });
     const pages = await Promise.all(images.map(async (i) => ({
@@ -3195,7 +3209,11 @@ function deck(options) {
     const id = `page-${i + 1}`;
     const label = page.name ? `"${page.name}"` : `pages[${i}]`;
     const isLast = i === pages.length - 1;
-    const local = page.stops ?? [isLast ? page.duration : page.duration - overlap];
+    const entries = (page.stops ?? [isLast ? page.duration : page.duration - overlap]).map((e, k) => {
+      if (e && typeof e === "object") warnUnknownOptions(`deck() page ${label} stops[${k}]`, e, ["at", "pdf"]);
+      return typeof e === "object" && e !== null ? e : { at: e };
+    });
+    const local = entries.map((e) => e.at);
     local.forEach((s, k) => {
       if (!(typeof s === "number" && Number.isFinite(s) && s > 0 && s <= page.duration + 1e-9)) throw new Error(`deck(): page ${label} has stop ${String(s)}, outside the page (0 to ${page.duration} s)`);
       if (k > 0 && s <= local[k - 1]) throw new Error(`deck(): page ${label} stops must be in order, earliest first (got ${local.join(", ")})`);
@@ -3209,6 +3227,7 @@ function deck(options) {
         if (page.notes !== void 0) stop.notes = page.notes;
       }
       if (k === local.length - 1 && page.advance !== void 0) stop.advance = page.advance;
+      if (entries[k].pdf !== void 0) stop.pdf = entries[k].pdf;
       stops.push(stop);
     });
     if (transition && !isLast) {
@@ -3243,6 +3262,6 @@ function withFade(spec, opts) {
   return spec;
 }
 
-export { Movie, animateText, audioEnvelope, bpmEnvelope, computeEnvelope, deck, dismissLoader, failLoader, followPath, kenBurns, measureText, normalizeStops, orbit, particles, react, resolveLoader, splitText, stagger, wiggle, withFade };
+export { Movie, animateText, audioEnvelope, bpmEnvelope, computeEnvelope, deck, dismissLoader, failLoader, followPath, kenBurns, measureText, normalizeStops, orbit, particles, pictureStops, react, resolveLoader, splitText, stagger, wiggle, withFade };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map