pixi-effects 0.1.0 → 0.2.0

package/dist/{Movie-Bp66rkaC.d.cts → types-CNBilhpz.d.cts}

@@ -1,6 +1,3 @@
-import { Application } from 'pixi.js';
-import { gsap } from 'gsap';
-
 /**
  * pixi-effects public DSL types.
  *
@@ -164,6 +161,13 @@ interface SequenceCommon {
      * Routed through PIXI's native `setMask({ inverse: true })`.
      */
     maskInverted?: boolean;
+    /**
+     * Opt this layer into 2.5D: it can then use `z`, `rotationX`, `rotationY`
+     * (in `initial` / keyframes) and is projected through the composition's
+     * `camera` layer. Default false. With z = 0, no 3D rotation and the default
+     * camera, a threeD layer renders exactly like a 2D one.
+     */
+    threeD?: boolean;
 }
 interface VideoSequenceSpec extends SequenceCommon {
     type: 'video';
@@ -212,6 +216,15 @@ interface CompositionSequenceSpec extends SequenceCommon {
     sequences?: SequenceSpec[];
     transitions?: TransitionSpec[];
 }
+/**
+ * A camera layer. Put its props in `initial` / `keyframes`:
+ * `x`, `y`, `z`, `lookAtX`, `lookAtY`, `lookAtZ`, `fov` (vertical degrees, default 40).
+ * Unset `z` follows `fov` so the z = 0 plane stays 1:1. Affects only `threeD`
+ * siblings in the same composition. +z points toward the viewer.
+ */
+interface CameraSequenceSpec extends SequenceCommon {
+    type: 'camera';
+}
 interface ShapeBase extends SequenceCommon {
     type: 'shape';
     /**
@@ -277,7 +290,7 @@ interface PathShapeSpec extends ShapeBase {
     d: string;
 }
 type ShapeSequenceSpec = RectShapeSpec | CircleShapeSpec | EllipseShapeSpec | LineShapeSpec | PolygonShapeSpec | PathShapeSpec;
-type SequenceSpec = VideoSequenceSpec | ImageSequenceSpec | TextSequenceSpec | AudioSequenceSpec | CompositionSequenceSpec | ShapeSequenceSpec;
+type SequenceSpec = VideoSequenceSpec | ImageSequenceSpec | TextSequenceSpec | AudioSequenceSpec | CompositionSequenceSpec | CameraSequenceSpec | ShapeSequenceSpec;
 /** Top-level composition (root node) — same as `CompositionSequenceSpec` minus the discriminant. */
 interface CompositionSpec extends SequenceCommon {
     width?: number;
@@ -285,80 +298,23 @@ interface CompositionSpec extends SequenceCommon {
     sequences?: SequenceSpec[];
     transitions?: TransitionSpec[];
 }
-
-interface MovieOptions {
-    width?: number;
-    height?: number;
-    duration?: number;
-    frameRate?: number;
-    background?: string;
-    canvas?: HTMLCanvasElement;
-    assets?: AssetSpec[];
-    composition?: CompositionSpec;
-}
-interface RenderOptions {
-    format?: 'mp4' | 'mov' | 'webm' | 'mkv';
-    video?: {
-        codec?: string;
-        bitrate?: 'very-low' | 'low' | 'medium' | 'high' | 'very-high';
-    };
-    audio?: {
-        codec?: string;
-        bitrate?: 'very-low' | 'low' | 'medium' | 'high' | 'very-high';
-    };
-}
-interface FrameEvent {
-    frame: number;
-    totalFrames: number;
-}
-interface ProgressEvent {
-    progress: number;
-    frame: number;
-    totalFrames: number;
-}
-type Listener = (...args: any[]) => void;
-declare class Movie {
-    private _events;
-    private _initState;
-    app: Application | null;
-    timeline: ReturnType<typeof gsap.timeline> | null;
-    audioBuffer: AudioBuffer | null;
-    audioSource: AudioBufferSourceNode | null;
-    gainNode: GainNode | null;
-    private _volume;
-    private _muted;
-    isPlaying: boolean;
-    currentFrame: number;
-    totalFrames: number;
+/** Resolved parent / root composition shape used for scope and sizing. */
+interface CompositionShape {
     width: number;
     height: number;
     duration: number;
-    frameRate: number;
-    background: string;
-    private _audioContext;
-    private _rootSequence;
-    private _rootContainer;
-    private _raf;
-    on(event: 'ready', fn: () => void): this;
-    on(event: 'frame', fn: (e: FrameEvent) => void): this;
-    on(event: 'progress', fn: (e: ProgressEvent) => void): this;
-    on(event: 'pause', fn: () => void): this;
-    off(event: string, fn: Listener): this;
-    emit(event: string, ...args: unknown[]): void;
-    get isReady(): boolean;
-    private _ensureAudioContext;
-    init(options?: MovieOptions): Promise<void>;
-    gotoFrame(frame: number, force?: boolean): Promise<void>;
-    private _awaitVideoFrames;
-    play(): void;
-    pause(): void;
-    set volume(v: number);
-    get volume(): number;
-    set muted(v: boolean);
-    get muted(): boolean;
-    toggleMute(): boolean;
-    render(options?: RenderOptions): Promise<Blob>;
-    destroy(): Promise<void>;
+}
+/** Audio descriptor pushed to the mixdown queue by AudioSequence/VideoSequence. */
+interface AudioDescriptor {
+    buffer: AudioBuffer;
+    loop: boolean;
+    start: number;
+    end: number;
+    initialVolume: number;
+    volumeKeyframes: {
+        time: number;
+        value: number;
+    }[];
 }
 
-export { type AssetSpec as A, type ChromaKeyFilterSpec as C, type DipTransition as D, type EllipseShapeSpec as E, type FilterSpec as F, type ImageSequenceSpec as I, type Keyframe as K, type LineShapeSpec as L, Movie as M, type PathShapeSpec as P, type RectShapeSpec as R, type SequenceCommon as S, type TextSequenceSpec as T, type VideoSequenceSpec as V, type WipeTransition as W, type ZoomTransition as Z, type AudioSequenceSpec as a, type CircleShapeSpec as b, type CompositionSequenceSpec as c, type CompositionSpec as d, type CrossfadeTransition as e, type CustomFilterSpec as f, type DissolveTransition as g, type Expr as h, type FrameEvent as i, type IrisTransition as j, type MovieOptions as k, type PolygonShapeSpec as l, type ProgressEvent as m, type PropValue as n, type Props as o, type RenderOptions as p, type SequenceSpec as q, type ShapeSequenceSpec as r, type SlideTransition as s, type TransitionCommon as t, type TransitionSpec as u };
+export type { AssetSpec as A, CompositionShape as C, DipTransition as D, EllipseShapeSpec as E, FilterSpec as F, ImageSequenceSpec as I, Keyframe as K, LineShapeSpec as L, PathShapeSpec as P, RectShapeSpec as R, SequenceSpec as S, TextSequenceSpec as T, VideoSequenceSpec as V, WipeTransition as W, ZoomTransition as Z, SequenceCommon as a, AudioSequenceSpec as b, CameraSequenceSpec as c, ChromaKeyFilterSpec as d, CircleShapeSpec as e, CompositionSequenceSpec as f, CompositionSpec as g, CrossfadeTransition as h, CustomFilterSpec as i, DissolveTransition as j, Expr as k, IrisTransition as l, PolygonShapeSpec as m, PropValue as n, Props as o, ShapeSequenceSpec as p, SlideTransition as q, TransitionCommon as r, TransitionSpec as s, AudioDescriptor as t };

package/dist/{Movie-Bp66rkaC.d.ts → types-CNBilhpz.d.ts}

@@ -1,6 +1,3 @@
-import { Application } from 'pixi.js';
-import { gsap } from 'gsap';
-
 /**
  * pixi-effects public DSL types.
  *
@@ -164,6 +161,13 @@ interface SequenceCommon {
      * Routed through PIXI's native `setMask({ inverse: true })`.
      */
     maskInverted?: boolean;
+    /**
+     * Opt this layer into 2.5D: it can then use `z`, `rotationX`, `rotationY`
+     * (in `initial` / keyframes) and is projected through the composition's
+     * `camera` layer. Default false. With z = 0, no 3D rotation and the default
+     * camera, a threeD layer renders exactly like a 2D one.
+     */
+    threeD?: boolean;
 }
 interface VideoSequenceSpec extends SequenceCommon {
     type: 'video';
@@ -212,6 +216,15 @@ interface CompositionSequenceSpec extends SequenceCommon {
     sequences?: SequenceSpec[];
     transitions?: TransitionSpec[];
 }
+/**
+ * A camera layer. Put its props in `initial` / `keyframes`:
+ * `x`, `y`, `z`, `lookAtX`, `lookAtY`, `lookAtZ`, `fov` (vertical degrees, default 40).
+ * Unset `z` follows `fov` so the z = 0 plane stays 1:1. Affects only `threeD`
+ * siblings in the same composition. +z points toward the viewer.
+ */
+interface CameraSequenceSpec extends SequenceCommon {
+    type: 'camera';
+}
 interface ShapeBase extends SequenceCommon {
     type: 'shape';
     /**
@@ -277,7 +290,7 @@ interface PathShapeSpec extends ShapeBase {
     d: string;
 }
 type ShapeSequenceSpec = RectShapeSpec | CircleShapeSpec | EllipseShapeSpec | LineShapeSpec | PolygonShapeSpec | PathShapeSpec;
-type SequenceSpec = VideoSequenceSpec | ImageSequenceSpec | TextSequenceSpec | AudioSequenceSpec | CompositionSequenceSpec | ShapeSequenceSpec;
+type SequenceSpec = VideoSequenceSpec | ImageSequenceSpec | TextSequenceSpec | AudioSequenceSpec | CompositionSequenceSpec | CameraSequenceSpec | ShapeSequenceSpec;
 /** Top-level composition (root node) — same as `CompositionSequenceSpec` minus the discriminant. */
 interface CompositionSpec extends SequenceCommon {
     width?: number;
@@ -285,80 +298,23 @@ interface CompositionSpec extends SequenceCommon {
     sequences?: SequenceSpec[];
     transitions?: TransitionSpec[];
 }
-
-interface MovieOptions {
-    width?: number;
-    height?: number;
-    duration?: number;
-    frameRate?: number;
-    background?: string;
-    canvas?: HTMLCanvasElement;
-    assets?: AssetSpec[];
-    composition?: CompositionSpec;
-}
-interface RenderOptions {
-    format?: 'mp4' | 'mov' | 'webm' | 'mkv';
-    video?: {
-        codec?: string;
-        bitrate?: 'very-low' | 'low' | 'medium' | 'high' | 'very-high';
-    };
-    audio?: {
-        codec?: string;
-        bitrate?: 'very-low' | 'low' | 'medium' | 'high' | 'very-high';
-    };
-}
-interface FrameEvent {
-    frame: number;
-    totalFrames: number;
-}
-interface ProgressEvent {
-    progress: number;
-    frame: number;
-    totalFrames: number;
-}
-type Listener = (...args: any[]) => void;
-declare class Movie {
-    private _events;
-    private _initState;
-    app: Application | null;
-    timeline: ReturnType<typeof gsap.timeline> | null;
-    audioBuffer: AudioBuffer | null;
-    audioSource: AudioBufferSourceNode | null;
-    gainNode: GainNode | null;
-    private _volume;
-    private _muted;
-    isPlaying: boolean;
-    currentFrame: number;
-    totalFrames: number;
+/** Resolved parent / root composition shape used for scope and sizing. */
+interface CompositionShape {
     width: number;
     height: number;
     duration: number;
-    frameRate: number;
-    background: string;
-    private _audioContext;
-    private _rootSequence;
-    private _rootContainer;
-    private _raf;
-    on(event: 'ready', fn: () => void): this;
-    on(event: 'frame', fn: (e: FrameEvent) => void): this;
-    on(event: 'progress', fn: (e: ProgressEvent) => void): this;
-    on(event: 'pause', fn: () => void): this;
-    off(event: string, fn: Listener): this;
-    emit(event: string, ...args: unknown[]): void;
-    get isReady(): boolean;
-    private _ensureAudioContext;
-    init(options?: MovieOptions): Promise<void>;
-    gotoFrame(frame: number, force?: boolean): Promise<void>;
-    private _awaitVideoFrames;
-    play(): void;
-    pause(): void;
-    set volume(v: number);
-    get volume(): number;
-    set muted(v: boolean);
-    get muted(): boolean;
-    toggleMute(): boolean;
-    render(options?: RenderOptions): Promise<Blob>;
-    destroy(): Promise<void>;
+}
+/** Audio descriptor pushed to the mixdown queue by AudioSequence/VideoSequence. */
+interface AudioDescriptor {
+    buffer: AudioBuffer;
+    loop: boolean;
+    start: number;
+    end: number;
+    initialVolume: number;
+    volumeKeyframes: {
+        time: number;
+        value: number;
+    }[];
 }
 
-export { type AssetSpec as A, type ChromaKeyFilterSpec as C, type DipTransition as D, type EllipseShapeSpec as E, type FilterSpec as F, type ImageSequenceSpec as I, type Keyframe as K, type LineShapeSpec as L, Movie as M, type PathShapeSpec as P, type RectShapeSpec as R, type SequenceCommon as S, type TextSequenceSpec as T, type VideoSequenceSpec as V, type WipeTransition as W, type ZoomTransition as Z, type AudioSequenceSpec as a, type CircleShapeSpec as b, type CompositionSequenceSpec as c, type CompositionSpec as d, type CrossfadeTransition as e, type CustomFilterSpec as f, type DissolveTransition as g, type Expr as h, type FrameEvent as i, type IrisTransition as j, type MovieOptions as k, type PolygonShapeSpec as l, type ProgressEvent as m, type PropValue as n, type Props as o, type RenderOptions as p, type SequenceSpec as q, type ShapeSequenceSpec as r, type SlideTransition as s, type TransitionCommon as t, type TransitionSpec as u };
+export type { AssetSpec as A, CompositionShape as C, DipTransition as D, EllipseShapeSpec as E, FilterSpec as F, ImageSequenceSpec as I, Keyframe as K, LineShapeSpec as L, PathShapeSpec as P, RectShapeSpec as R, SequenceSpec as S, TextSequenceSpec as T, VideoSequenceSpec as V, WipeTransition as W, ZoomTransition as Z, SequenceCommon as a, AudioSequenceSpec as b, CameraSequenceSpec as c, ChromaKeyFilterSpec as d, CircleShapeSpec as e, CompositionSequenceSpec as f, CompositionSpec as g, CrossfadeTransition as h, CustomFilterSpec as i, DissolveTransition as j, Expr as k, IrisTransition as l, PolygonShapeSpec as m, PropValue as n, Props as o, ShapeSequenceSpec as p, SlideTransition as q, TransitionCommon as r, TransitionSpec as s, AudioDescriptor as t };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pixi-effects",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Declarative composition and video rendering for the web. Built on PixiJS v8.",
   "type": "module",
   "exports": {
@@ -11,6 +11,10 @@
     "./controller": {
       "import": { "types": "./dist/Controller.d.ts", "default": "./dist/Controller.js" },
       "require": { "types": "./dist/Controller.d.cts", "default": "./dist/Controller.cjs" }
+    },
+    "./three": {
+      "import": { "types": "./dist/three.d.ts", "default": "./dist/three.js" },
+      "require": { "types": "./dist/three.d.cts", "default": "./dist/three.cjs" }
     }
   },
   "main": "./dist/index.cjs",
@@ -19,7 +23,8 @@
   "files": ["dist", "README.md", "LICENSE"],
   "keywords": [
     "pixi", "pixijs", "video", "composition", "compositing", "rendering",
-    "after-effects", "motion-graphics", "timeline", "webgl", "gsap", "keyframe", "typescript"
+    "after-effects", "motion-graphics", "timeline", "webgl", "gsap", "keyframe", "typescript",
+    "three", "threejs"
   ],
   "license": "MIT",
   "author": "tefista <tefista.dev@gmail.com>",
@@ -36,11 +41,15 @@
     "prepublishOnly": "npm run typecheck && npm test && npm run build"
   },
   "dependencies": {
-    "mediabunny": "^1.43.0"
+    "mediabunny": "^1.61.3"
   },
   "peerDependencies": {
     "gsap": "^3.12.0",
-    "pixi.js": "^8.0.0"
+    "pixi.js": "^8.0.0",
+    "three": ">=0.150.0"
+  },
+  "peerDependenciesMeta": {
+    "three": { "optional": true }
   },
   "devDependencies": {
     "tsup": "^8.0.0",
@@ -48,7 +57,9 @@
     "vitest": "^2.1.0",
     "happy-dom": "^15.0.0",
     "gsap": "^3.12.0",
-    "pixi.js": "^8.16.0"
+    "pixi.js": "^8.22.0",
+    "three": "^0.185.1",
+    "@types/three": "^0.185.0"
   },
   "engines": { "node": ">=18" }
 }