pixi-effects 0.11.0 → 0.12.0

package/dist/{Movie-nzmWsxWX.d.ts → Movie-CY2QPVVM.d.cts}

@@ -1,6 +1,6 @@
 import { Application } from 'pixi.js';
 import { gsap } from 'gsap';
-import { c as AssetSpec, j as CompositionSpec } from './types-BXu28nJj.js';
+import { z as Stop, e as AssetSpec, c as CompositionSpec } from './types-mpqQO8MJ.cjs';
 
 interface AudioInspectOptions {
     /** Width of each loudness window in seconds. Default 0.1. */
@@ -207,6 +207,30 @@ interface SnapshotOptions {
     /** Return a `data:` URL string instead of a Blob (handy for scripts that can only return text). */
     as?: 'blob' | 'dataURL';
 }
+/** One picture of a stop (see `movie.stopImages()`). */
+interface StopImage {
+    stop: Stop; /** The page it belongs to (0-based). */
+    page: number;
+    image: Blob | string;
+}
+interface StopImagesOptions {
+    /** One picture per page (default) or one per stop. */
+    which?: 'pages' | 'stops';
+    /** With `which: 'pages'`: the page's last stop (default: the page fully built) or its first. */
+    pick?: 'last' | 'first';
+    /** Output size relative to the canvas. Default 1. */
+    scale?: number;
+    /** `'image/png'` (default) or `'image/jpeg'`. */
+    type?: 'image/png' | 'image/jpeg';
+    /** JPEG quality, 0–1. */
+    quality?: number;
+    /** Return `data:` URLs instead of Blobs. */
+    as?: 'blob' | 'dataURL';
+    /** Motion blur for the pictures (off unless you ask: they are usually for looking at). */
+    motionBlur?: MotionBlurSpec;
+    /** Called as each picture is ready, in order. */
+    onImage?: (image: StopImage) => void;
+}
 interface ContactSheetOptions {
     /** Motion blur for these pictures (see `MovieOptions.motionBlur`); overrides the movie's own setting, `false` turns it off. */
     motionBlur?: MotionBlurSpec;
@@ -226,6 +250,12 @@ interface FrameEvent {
     frame: number;
     totalFrames: number;
 }
+/** A presentation reached a stop (`movie.next()` played to it, or `prev()` / `goToStop()` / `goToPage()` jumped to it). */
+interface StopEvent {
+    index: number;
+    stop: Stop;
+    pageIndex: number;
+}
 interface ProgressEvent {
     progress: number;
     frame: number;
@@ -254,6 +284,12 @@ declare class Movie {
     private _cancelAudioStart;
     /** The poster time in seconds (`movie.init({ poster })`), or null. */
     poster: number | null;
+    /** The stops of the composition (`composition.stops`), checked and in order: where `next()` pauses. Empty for an ordinary movie. */
+    stops: Stop[];
+    /** The frame `next()` is playing toward, or null. */
+    private _stopAt;
+    private _stopWaiters;
+    private _arriving;
     /** The motion blur `render()`, `snapshot()` and `contactSheet()` apply unless told otherwise (`movie.init({ motionBlur })`), or null. */
     motionBlur: ResolvedMotionBlur | null;
     private _posterFrame;
@@ -279,6 +315,8 @@ declare class Movie {
     private _audioSources;
     private _mixStats;
     on(event: 'ready', fn: () => void): this;
+    /** A presentation is now on a stop (see `stops` in the composition, `next()`, `prev()`). */
+    on(event: 'stop', fn: (e: StopEvent) => void): this;
     on(event: 'frame', fn: (e: FrameEvent) => void): this;
     /** A jump to another frame (`gotoFrame`, a seek bar) starts / finishes. Not emitted for playback ticks, `render()`, `snapshot()` or `contactSheet()`. */
     on(event: 'seeking' | 'seeked', fn: (e: FrameEvent) => void): this;
@@ -330,6 +368,31 @@ declare class Movie {
     snapshot(frame: number | undefined, opts: SnapshotOptions & {
         as: 'dataURL';
     }): Promise<string>;
+    /** Seek to `frame` (quietly, and stay there) and encode the canvas as a picture. */
+    private _captureFrame;
+    /**
+     * A picture of the settled state of each page (default: the page's last stop, fully built) or of every stop, for a page list, an
+     * overview, an export. Pauses the movie, and leaves the playhead where it was. `onImage` is called as each picture is ready.
+     */
+    stopImages(opts: StopImagesOptions & {
+        as: 'dataURL';
+    }): Promise<Array<StopImage & {
+        image: string;
+    }>>;
+    stopImages(opts?: StopImagesOptions): Promise<StopImage[]>;
+    /**
+     * 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
+     * JPEG at the canvas size. Needs `composition.stops`. A transparent background comes out black: give the movie a `background`.
+     */
+    exportPDF(opts?: {
+        which?: 'pages' | 'stops';
+        pick?: 'last' | 'first';
+        scale?: number;
+        quality?: number;
+        title?: string;
+        motionBlur?: MotionBlurSpec;
+        onImage?: (image: StopImage) => void;
+    }): Promise<Blob>;
     /**
      * 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.
@@ -378,6 +441,31 @@ declare class Movie {
      */
     _exposeFrame(frame: number, mb: ResolvedMotionBlur, target: HTMLCanvasElement, settle: boolean): Promise<void>;
     private _blurCanvas;
+    /** Which stop the playhead is on or has passed (-1 before the first). */
+    get stopIndex(): number;
+    /** The stop the playhead is on or has passed, or null. */
+    get currentStop(): Stop | null;
+    /** Which page the playhead is in (0-based), -1 before the first stop. */
+    get pageIndex(): number;
+    /** How many pages the stops make. */
+    get pageCount(): number;
+    private _cancelStop;
+    private _settleStopWaiters;
+    private _emitStop;
+    /** Land exactly on a stop's frame, pause, and say so. */
+    private _arriveAtStop;
+    /**
+     * Play to the next stop and pause exactly there (a presentation's "next"). Pressed again while it is playing toward a stop, it skips the
+     * rest of the animation and lands on that stop at once. After the last stop it plays to the end. Resolves when it has landed (or
+     * stopped for another reason). An ordinary `play()` ignores the stops.
+     */
+    next(): Promise<void>;
+    /** Jump back to the previous stop at once (no reverse playback); from the first stop, to the start. */
+    prev(): Promise<void>;
+    /** Jump to stop `index` (0-based). */
+    goToStop(index: number): Promise<void>;
+    /** Jump to the first stop of page `page` (0-based). */
+    goToPage(page: number): Promise<void>;
     play(): void;
     pause(): void;
     set volume(v: number);
@@ -389,4 +477,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 TimelineHtmlOptions as j, type TimelineRow as k, type TimelineSvgOptions as l, type TimelineTransition as m, dismissLoader as n, failLoader as o, resolveLoader as r };
+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 };

package/dist/{Movie-DSSNOF3T.d.cts → Movie-EBF6_RfX.d.ts}

@@ -1,6 +1,6 @@
 import { Application } from 'pixi.js';
 import { gsap } from 'gsap';
-import { c as AssetSpec, j as CompositionSpec } from './types-BXu28nJj.cjs';
+import { z as Stop, e as AssetSpec, c as CompositionSpec } from './types-mpqQO8MJ.js';
 
 interface AudioInspectOptions {
     /** Width of each loudness window in seconds. Default 0.1. */
@@ -207,6 +207,30 @@ interface SnapshotOptions {
     /** Return a `data:` URL string instead of a Blob (handy for scripts that can only return text). */
     as?: 'blob' | 'dataURL';
 }
+/** One picture of a stop (see `movie.stopImages()`). */
+interface StopImage {
+    stop: Stop; /** The page it belongs to (0-based). */
+    page: number;
+    image: Blob | string;
+}
+interface StopImagesOptions {
+    /** One picture per page (default) or one per stop. */
+    which?: 'pages' | 'stops';
+    /** With `which: 'pages'`: the page's last stop (default: the page fully built) or its first. */
+    pick?: 'last' | 'first';
+    /** Output size relative to the canvas. Default 1. */
+    scale?: number;
+    /** `'image/png'` (default) or `'image/jpeg'`. */
+    type?: 'image/png' | 'image/jpeg';
+    /** JPEG quality, 0–1. */
+    quality?: number;
+    /** Return `data:` URLs instead of Blobs. */
+    as?: 'blob' | 'dataURL';
+    /** Motion blur for the pictures (off unless you ask: they are usually for looking at). */
+    motionBlur?: MotionBlurSpec;
+    /** Called as each picture is ready, in order. */
+    onImage?: (image: StopImage) => void;
+}
 interface ContactSheetOptions {
     /** Motion blur for these pictures (see `MovieOptions.motionBlur`); overrides the movie's own setting, `false` turns it off. */
     motionBlur?: MotionBlurSpec;
@@ -226,6 +250,12 @@ interface FrameEvent {
     frame: number;
     totalFrames: number;
 }
+/** A presentation reached a stop (`movie.next()` played to it, or `prev()` / `goToStop()` / `goToPage()` jumped to it). */
+interface StopEvent {
+    index: number;
+    stop: Stop;
+    pageIndex: number;
+}
 interface ProgressEvent {
     progress: number;
     frame: number;
@@ -254,6 +284,12 @@ declare class Movie {
     private _cancelAudioStart;
     /** The poster time in seconds (`movie.init({ poster })`), or null. */
     poster: number | null;
+    /** The stops of the composition (`composition.stops`), checked and in order: where `next()` pauses. Empty for an ordinary movie. */
+    stops: Stop[];
+    /** The frame `next()` is playing toward, or null. */
+    private _stopAt;
+    private _stopWaiters;
+    private _arriving;
     /** The motion blur `render()`, `snapshot()` and `contactSheet()` apply unless told otherwise (`movie.init({ motionBlur })`), or null. */
     motionBlur: ResolvedMotionBlur | null;
     private _posterFrame;
@@ -279,6 +315,8 @@ declare class Movie {
     private _audioSources;
     private _mixStats;
     on(event: 'ready', fn: () => void): this;
+    /** A presentation is now on a stop (see `stops` in the composition, `next()`, `prev()`). */
+    on(event: 'stop', fn: (e: StopEvent) => void): this;
     on(event: 'frame', fn: (e: FrameEvent) => void): this;
     /** A jump to another frame (`gotoFrame`, a seek bar) starts / finishes. Not emitted for playback ticks, `render()`, `snapshot()` or `contactSheet()`. */
     on(event: 'seeking' | 'seeked', fn: (e: FrameEvent) => void): this;
@@ -330,6 +368,31 @@ declare class Movie {
     snapshot(frame: number | undefined, opts: SnapshotOptions & {
         as: 'dataURL';
     }): Promise<string>;
+    /** Seek to `frame` (quietly, and stay there) and encode the canvas as a picture. */
+    private _captureFrame;
+    /**
+     * A picture of the settled state of each page (default: the page's last stop, fully built) or of every stop, for a page list, an
+     * overview, an export. Pauses the movie, and leaves the playhead where it was. `onImage` is called as each picture is ready.
+     */
+    stopImages(opts: StopImagesOptions & {
+        as: 'dataURL';
+    }): Promise<Array<StopImage & {
+        image: string;
+    }>>;
+    stopImages(opts?: StopImagesOptions): Promise<StopImage[]>;
+    /**
+     * 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
+     * JPEG at the canvas size. Needs `composition.stops`. A transparent background comes out black: give the movie a `background`.
+     */
+    exportPDF(opts?: {
+        which?: 'pages' | 'stops';
+        pick?: 'last' | 'first';
+        scale?: number;
+        quality?: number;
+        title?: string;
+        motionBlur?: MotionBlurSpec;
+        onImage?: (image: StopImage) => void;
+    }): Promise<Blob>;
     /**
      * 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.
@@ -378,6 +441,31 @@ declare class Movie {
      */
     _exposeFrame(frame: number, mb: ResolvedMotionBlur, target: HTMLCanvasElement, settle: boolean): Promise<void>;
     private _blurCanvas;
+    /** Which stop the playhead is on or has passed (-1 before the first). */
+    get stopIndex(): number;
+    /** The stop the playhead is on or has passed, or null. */
+    get currentStop(): Stop | null;
+    /** Which page the playhead is in (0-based), -1 before the first stop. */
+    get pageIndex(): number;
+    /** How many pages the stops make. */
+    get pageCount(): number;
+    private _cancelStop;
+    private _settleStopWaiters;
+    private _emitStop;
+    /** Land exactly on a stop's frame, pause, and say so. */
+    private _arriveAtStop;
+    /**
+     * Play to the next stop and pause exactly there (a presentation's "next"). Pressed again while it is playing toward a stop, it skips the
+     * rest of the animation and lands on that stop at once. After the last stop it plays to the end. Resolves when it has landed (or
+     * stopped for another reason). An ordinary `play()` ignores the stops.
+     */
+    next(): Promise<void>;
+    /** Jump back to the previous stop at once (no reverse playback); from the first stop, to the start. */
+    prev(): Promise<void>;
+    /** Jump to stop `index` (0-based). */
+    goToStop(index: number): Promise<void>;
+    /** Jump to the first stop of page `page` (0-based). */
+    goToPage(page: number): Promise<void>;
     play(): void;
     pause(): void;
     set volume(v: number);
@@ -389,4 +477,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 TimelineHtmlOptions as j, type TimelineRow as k, type TimelineSvgOptions as l, type TimelineTransition as m, dismissLoader as n, failLoader as o, resolveLoader as r };
+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 };