@twick/core 0.14.19 → 0.14.21

package/lib/app/Player.js

@@ -0,0 +1,375 @@
+import { AsyncEventDispatcher, EventDispatcher, ValueDispatcher, } from '../events';
+import { clamp } from '../tweening';
+import { Vector2 } from '../types';
+import { Semaphore } from '../utils';
+import { PlaybackManager, PlaybackState } from './PlaybackManager';
+import { PlaybackStatus } from './PlaybackStatus';
+import { SharedWebGLContext } from './SharedWebGLContext';
+/**
+ * The player logic used by the editor and embeddable player.
+ *
+ * @remarks
+ * This class builds on top of the `PlaybackManager` to provide a simple
+ * interface similar to other media players. It plays through the animation
+ * using a real-time update loop.
+ */
+export class Player {
+    /**
+     * Triggered during each iteration of the update loop when the frame is ready
+     * to be rendered.
+     *
+     * @remarks
+     * Player does not perform any rendering on its own. For the animation to be
+     * visible, another class must subscribe to this event and perform the
+     * rendering itself. {@link Stage} can be used to display the animation.
+     *
+     * @eventProperty
+     */
+    get onRender() {
+        return this.render.subscribable;
+    }
+    get onStateChanged() {
+        return this.playerState.subscribable;
+    }
+    get onFrameChanged() {
+        return this.frame.subscribable;
+    }
+    get onDurationChanged() {
+        return this.duration.subscribable;
+    }
+    /**
+     * Triggered right after recalculation finishes.
+     *
+     * @remarks
+     * Can be used to provide visual feedback.
+     *
+     * @eventProperty
+     */
+    get onRecalculated() {
+        return this.recalculated.subscribable;
+    }
+    get startFrame() {
+        return Math.min(this.playback.duration, this.status.secondsToFrames(this.startTime));
+    }
+    get endFrame() {
+        return Math.min(this.playback.duration, this.status.secondsToFrames(this.endTime));
+    }
+    get finished() {
+        return this.playback.finished || this.playback.frame >= this.endFrame;
+    }
+    constructor(project, settings = {}, initialState = {}, initialFrame = -1) {
+        this.project = project;
+        this.settings = settings;
+        this.initialState = initialState;
+        this.initialFrame = initialFrame;
+        this.render = new AsyncEventDispatcher();
+        this.frame = new ValueDispatcher(0);
+        this.duration = new ValueDispatcher(0);
+        this.recalculated = new EventDispatcher();
+        this.lock = new Semaphore();
+        this.startTime = 0;
+        this.endTime = Infinity;
+        this.requestId = null;
+        this.renderTime = 0;
+        this.requestedSeek = -1;
+        this.requestedRender = false;
+        this.requestedRecalculation = true;
+        this.active = false;
+        this.playerState = new ValueDispatcher({
+            loop: true,
+            muted: true,
+            volume: 1,
+            speed: 1,
+            ...initialState,
+            paused: true,
+        });
+        this.sharedWebGLContext = new SharedWebGLContext(this.project.logger);
+        this.requestedSeek = initialFrame;
+        this.logger = this.project.logger;
+        this.playback = new PlaybackManager();
+        this.status = new PlaybackStatus(this.playback);
+        this.size = settings.size ?? new Vector2(1920, 1080);
+        this.resolutionScale = settings.resolutionScale ?? 1;
+        this.startTime = settings.range?.[0] ?? 0;
+        this.endTime = settings.range?.[1] ?? Infinity;
+        this.playback.fps = settings.fps ?? 60;
+        const scenes = [];
+        for (const description of project.scenes) {
+            const scene = new description.klass({
+                ...description,
+                playback: this.status,
+                logger: this.project.logger,
+                size: this.size,
+                resolutionScale: this.resolutionScale,
+                sharedWebGLContext: this.sharedWebGLContext,
+                experimentalFeatures: project.experimentalFeatures,
+            });
+            scene.onReloaded.subscribe(() => this.requestRecalculation());
+            scene.variables.updateSignals(project.variables ?? {});
+            scenes.push(scene);
+        }
+        this.playback.setup(scenes);
+        this.activate();
+    }
+    async configure(settings) {
+        await this.lock.acquire();
+        let frame = this.playback.frame;
+        let recalculate = false;
+        this.startTime = settings.range[0];
+        this.endTime = settings.range[1];
+        const newFps = Math.max(1, settings.fps);
+        if (this.playback.fps !== newFps) {
+            const ratio = newFps / this.playback.fps;
+            this.playback.fps = newFps;
+            frame = Math.floor(frame * ratio);
+            recalculate = true;
+        }
+        if (!settings.size.exactlyEquals(this.size) ||
+            settings.resolutionScale !== this.resolutionScale) {
+            this.size = settings.size;
+            this.resolutionScale = settings.resolutionScale;
+            this.playback.reload({
+                size: this.size,
+                resolutionScale: this.resolutionScale,
+            });
+        }
+        this.lock.release();
+        if (recalculate) {
+            this.playback.reload();
+            this.frame.current = frame;
+            this.requestRecalculation();
+            this.requestedSeek = frame;
+        }
+    }
+    /**
+     * Whether the given frame is inside the animation range.
+     *
+     * @param frame - The frame to check.
+     */
+    isInRange(frame) {
+        return frame >= 0 && frame <= this.playback.duration;
+    }
+    /**
+     * Whether the given frame is inside the user-defined range.
+     *
+     * @param frame - The frame to check.
+     */
+    isInUserRange(frame) {
+        return frame >= this.startFrame && frame <= this.endFrame;
+    }
+    requestSeek(value) {
+        this.requestedSeek = this.clampRange(value);
+    }
+    requestPreviousFrame() {
+        this.requestedSeek = this.frame.current - this.playback.speed;
+    }
+    requestNextFrame() {
+        this.requestedSeek = this.frame.current + this.playback.speed;
+    }
+    requestReset() {
+        this.requestedSeek = 0;
+    }
+    requestRender() {
+        this.requestedRender = true;
+    }
+    toggleLoop(value = !this.playerState.current.loop) {
+        if (value !== this.playerState.current.loop) {
+            this.playerState.current = {
+                ...this.playerState.current,
+                loop: value,
+            };
+        }
+    }
+    togglePlayback(value = this.playerState.current.paused) {
+        if (value === this.playerState.current.paused) {
+            this.playerState.current = {
+                ...this.playerState.current,
+                paused: !value,
+            };
+            // hitting play after the animation has finished should reset the
+            // playback, even if looping is disabled.
+            if (value &&
+                !this.playerState.current.loop &&
+                this.playback.frame === this.playback.duration) {
+                this.requestReset();
+            }
+        }
+    }
+    toggleAudio(value = this.playerState.current.muted) {
+        if (value === this.playerState.current.muted) {
+            this.playerState.current = {
+                ...this.playerState.current,
+                muted: !value,
+            };
+        }
+    }
+    setAudioVolume(value) {
+        const clampedValue = clamp(0, 1, value);
+        if (clampedValue !== this.playerState.current.volume) {
+            this.playerState.current = {
+                ...this.playerState.current,
+                volume: clampedValue,
+            };
+        }
+    }
+    addAudioVolume(value) {
+        this.setAudioVolume(this.playerState.current.volume + value);
+    }
+    setSpeed(value) {
+        if (value !== this.playerState.current.speed) {
+            this.playback.speed = value;
+            this.playback.reload();
+            this.playerState.current = {
+                ...this.playerState.current,
+                speed: value,
+            };
+            this.requestRecalculation();
+        }
+    }
+    setVariables(variables) {
+        for (const scene of this.playback.onScenesRecalculated.current) {
+            scene.variables.updateSignals(variables);
+        }
+    }
+    /**
+     * Activate the player.
+     *
+     * @remarks
+     * A player needs to be active in order for the update loop to run. Each
+     * player is active by default.
+     */
+    activate() {
+        this.active = true;
+        this.request();
+    }
+    /**
+     * Deactivate the player.
+     *
+     * @remarks
+     * Deactivating the player prevents its update loop from running. This should
+     * be done before disposing the player, to prevent it from running in the
+     * background.
+     *
+     * Just pausing the player does not stop the loop.
+     */
+    deactivate() {
+        this.active = false;
+        this.sharedWebGLContext.dispose();
+        this.playback.currentScene.stopAllMedia();
+        if (this.requestId !== null) {
+            cancelAnimationFrame(this.requestId);
+            this.requestId = null;
+        }
+    }
+    requestRecalculation() {
+        this.requestedRecalculation = true;
+        this.request();
+    }
+    async prepare() {
+        const state = {
+            ...this.playerState.current,
+            seek: this.requestedSeek,
+            render: this.requestedRender,
+        };
+        this.requestedSeek = -1;
+        this.requestedRender = false;
+        // Recalculate the project if necessary
+        if (this.requestedRecalculation) {
+            if (state.seek < 0) {
+                state.seek = this.playback.frame;
+            }
+            try {
+                await this.playback.recalculate();
+                this.duration.current = this.playback.frame;
+                this.recalculated.dispatch();
+            }
+            catch (e) {
+                this.requestSeek(state.seek);
+                throw e;
+            }
+            finally {
+                this.requestedRecalculation = false;
+            }
+        }
+        // Pause if reached the end or the range is 0
+        // Seek to the beginning for non-empty scenes
+        if ((!state.loop && this.finished && !state.paused && state.seek < 0) ||
+            this.endFrame === this.startFrame) {
+            this.togglePlayback(false);
+            state.paused = true;
+            state.seek =
+                this.endFrame === this.startFrame ? state.seek : this.startFrame;
+        }
+        // Seek to the beginning if looping is enabled
+        if (state.loop &&
+            (state.seek > this.endFrame || (this.finished && !state.paused)) &&
+            this.startFrame !== this.endTime) {
+            state.seek = this.startFrame;
+        }
+        return state;
+    }
+    async run() {
+        const state = await this.prepare();
+        const previousState = this.playback.state;
+        this.playback.state = state.paused
+            ? PlaybackState.Paused
+            : PlaybackState.Playing;
+        // Seek to the given frame
+        if (state.seek >= 0 || !this.isInUserRange(this.status.frame)) {
+            const seekFrame = state.seek < 0 ? this.status.frame : state.seek;
+            const clampedFrame = this.clampRange(seekFrame);
+            this.logger.profile('seek time');
+            await this.playback.seek(clampedFrame);
+            this.logger.profile('seek time');
+        }
+        // Do nothing if paused
+        else if (state.paused) {
+            if (state.render ||
+                (state.paused && previousState !== PlaybackState.Paused)) {
+                // Tells the stage to render the current frame
+                await this.render.dispatch();
+            }
+            this.request();
+            return;
+        }
+        // Simply move forward one frame
+        else if (this.status.frame < this.endFrame) {
+            await this.playback.progress();
+        }
+        // Pause if a new slide has just started.
+        if (!state.paused && this.playback.currentScene.slides.isWaiting()) {
+            this.togglePlayback(false);
+            state.paused = true;
+        }
+        // Draw the project
+        await this.render.dispatch();
+        this.frame.current = this.playback.frame;
+        this.request();
+    }
+    request() {
+        if (!this.active)
+            return;
+        // TODO(konsti): make this loop not run when player is paused
+        this.requestId ?? (this.requestId = requestAnimationFrame(async (time) => {
+            this.requestId = null;
+            if (time - this.renderTime >= 1000 / (this.status.fps + 5)) {
+                this.renderTime = time;
+                await this.lock.acquire();
+                try {
+                    await this.run();
+                }
+                catch (e) {
+                    this.logger.error(e);
+                }
+                this.lock.release();
+            }
+            else {
+                this.request();
+            }
+        }));
+    }
+    clampRange(frame) {
+        return clamp(this.startFrame, this.endFrame, frame);
+    }
+}
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"Player.js","sourceRoot":"","sources":["../../src/app/Player.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,eAAe,EACf,eAAe,GAChB,MAAM,WAAW,CAAC;AAEnB,OAAO,EAAC,KAAK,EAAC,MAAM,aAAa,CAAC;AAClC,OAAO,EAAC,OAAO,EAAC,MAAM,UAAU,CAAC;AACjC,OAAO,EAAC,SAAS,EAAC,MAAM,UAAU,CAAC;AAEnC,OAAO,EAAC,eAAe,EAAE,aAAa,EAAC,MAAM,mBAAmB,CAAC;AACjE,OAAO,EAAC,cAAc,EAAC,MAAM,kBAAkB,CAAC;AAEhD,OAAO,EAAC,kBAAkB,EAAC,MAAM,sBAAsB,CAAC;AAiBxD;;;;;;;GAOG;AACH,MAAM,OAAO,MAAM;IACjB;;;;;;;;;;OAUG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;IAClC,CAAC;IAGD,IAAW,cAAc;QACvB,OAAO,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC;IACvC,CAAC;IAGD,IAAW,cAAc;QACvB,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;IACjC,CAAC;IAGD,IAAW,iBAAiB;QAC1B,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;IACpC,CAAC;IAGD;;;;;;;OAOG;IACH,IAAW,cAAc;QACvB,OAAO,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC;IACxC,CAAC;IAoBD,IAAY,UAAU;QACpB,OAAO,IAAI,CAAC,GAAG,CACb,IAAI,CAAC,QAAQ,CAAC,QAAQ,EACtB,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAC5C,CAAC;IACJ,CAAC;IAED,IAAY,QAAQ;QAClB,OAAO,IAAI,CAAC,GAAG,CACb,IAAI,CAAC,QAAQ,CAAC,QAAQ,EACtB,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAC1C,CAAC;IACJ,CAAC;IAED,IAAY,QAAQ;QAClB,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC;IACxE,CAAC;IAED,YACU,OAAgB,EAChB,WAAoC,EAAE,EACtC,eAAqC,EAAE,EACvC,eAAe,CAAC,CAAC;QAHjB,YAAO,GAAP,OAAO,CAAS;QAChB,aAAQ,GAAR,QAAQ,CAA8B;QACtC,iBAAY,GAAZ,YAAY,CAA2B;QACvC,iBAAY,GAAZ,YAAY,CAAK;QArEV,WAAM,GAAG,IAAI,oBAAoB,EAAQ,CAAC;QAU1C,UAAK,GAAG,IAAI,eAAe,CAAC,CAAC,CAAC,CAAC;QAK/B,aAAQ,GAAG,IAAI,eAAe,CAAC,CAAC,CAAC,CAAC;QAalC,iBAAY,GAAG,IAAI,eAAe,EAAQ,CAAC;QAO3C,SAAI,GAAG,IAAI,SAAS,EAAE,CAAC;QAChC,cAAS,GAAG,CAAC,CAAC;QACd,YAAO,GAAG,QAAQ,CAAC;QACnB,cAAS,GAAkB,IAAI,CAAC;QAChC,eAAU,GAAG,CAAC,CAAC;QACf,kBAAa,GAAG,CAAC,CAAC,CAAC;QACnB,oBAAe,GAAG,KAAK,CAAC;QACxB,2BAAsB,GAAG,IAAI,CAAC;QAG9B,WAAM,GAAG,KAAK,CAAC;QA0BrB,IAAI,CAAC,WAAW,GAAG,IAAI,eAAe,CAAc;YAClD,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,IAAI;YACX,MAAM,EAAE,CAAC;YACT,KAAK,EAAE,CAAC;YACR,GAAG,YAAY;YACf,MAAM,EAAE,IAAI;SACb,CAAC,CAAC;QAEH,IAAI,CAAC,kBAAkB,GAAG,IAAI,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACtE,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAClC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;QAClC,IAAI,CAAC,QAAQ,GAAG,IAAI,eAAe,EAAE,CAAC;QACtC,IAAI,CAAC,MAAM,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,IAAI,IAAI,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACrD,IAAI,CAAC,eAAe,GAAG,QAAQ,CAAC,eAAe,IAAI,CAAC,CAAC;QACrD,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC;QAC/C,IAAI,CAAC,QAAQ,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,IAAI,EAAE,CAAC;QAEvC,MAAM,MAAM,GAAY,EAAE,CAAC;QAC3B,KAAK,MAAM,WAAW,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;YACzC,MAAM,KAAK,GAAG,IAAI,WAAW,CAAC,KAAK,CAAC;gBAClC,GAAG,WAAW;gBACd,QAAQ,EAAE,IAAI,CAAC,MAAM;gBACrB,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;gBAC3B,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,eAAe,EAAE,IAAI,CAAC,eAAe;gBACrC,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;gBAC3C,oBAAoB,EAAE,OAAO,CAAC,oBAAoB;aACnD,CAAC,CAAC;YACH,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,oBAAoB,EAAE,CAAC,CAAC;YAC9D,KAAK,CAAC,SAAS,CAAC,aAAa,CAAC,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC;YACvD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACrB,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC5B,IAAI,CAAC,QAAQ,EAAE,CAAC;IAClB,CAAC;IAEM,KAAK,CAAC,SAAS,CAAC,QAAwB;QAC7C,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;QAC1B,IAAI,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAChC,IAAI,WAAW,GAAG,KAAK,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;QACzC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,KAAK,MAAM,EAAE,CAAC;YACjC,MAAM,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;YACzC,IAAI,CAAC,QAAQ,CAAC,GAAG,GAAG,MAAM,CAAC;YAC3B,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC;YAClC,WAAW,GAAG,IAAI,CAAC;QACrB,CAAC;QACD,IACE,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC;YACvC,QAAQ,CAAC,eAAe,KAAK,IAAI,CAAC,eAAe,EACjD,CAAC;YACD,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;YAC1B,IAAI,CAAC,eAAe,GAAG,QAAQ,CAAC,eAAe,CAAC;YAChD,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;gBACnB,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,eAAe,EAAE,IAAI,CAAC,eAAe;aACtC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;QACpB,IAAI,WAAW,EAAE,CAAC;YAChB,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YACvB,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC;YAC3B,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC5B,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;QAC7B,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,SAAS,CAAC,KAAa;QAC5B,OAAO,KAAK,IAAI,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,KAAa;QAChC,OAAO,KAAK,IAAI,IAAI,CAAC,UAAU,IAAI,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC;IAC5D,CAAC;IAEM,WAAW,CAAC,KAAa;QAC9B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IAC9C,CAAC;IAEM,oBAAoB;QACzB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;IAChE,CAAC;IAEM,gBAAgB;QACrB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;IAChE,CAAC;IAEM,YAAY;QACjB,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC;IACzB,CAAC;IAEM,aAAa;QAClB,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;IAC9B,CAAC;IAEM,UAAU,CAAC,KAAK,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI;QACtD,IAAI,KAAK,KAAK,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YAC5C,IAAI,CAAC,WAAW,CAAC,OAAO,GAAG;gBACzB,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO;gBAC3B,IAAI,EAAE,KAAK;aACZ,CAAC;QACJ,CAAC;IACH,CAAC;IAEM,cAAc,CACnB,QAAiB,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM;QAEhD,IAAI,KAAK,KAAK,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YAC9C,IAAI,CAAC,WAAW,CAAC,OAAO,GAAG;gBACzB,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO;gBAC3B,MAAM,EAAE,CAAC,KAAK;aACf,CAAC;YAEF,iEAAiE;YACjE,yCAAyC;YACzC,IACE,KAAK;gBACL,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI;gBAC9B,IAAI,CAAC,QAAQ,CAAC,KAAK,KAAK,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAC9C,CAAC;gBACD,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,CAAC;QACH,CAAC;IACH,CAAC;IAEM,WAAW,CAAC,QAAiB,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK;QAChE,IAAI,KAAK,KAAK,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YAC7C,IAAI,CAAC,WAAW,CAAC,OAAO,GAAG;gBACzB,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO;gBAC3B,KAAK,EAAE,CAAC,KAAK;aACd,CAAC;QACJ,CAAC;IACH,CAAC;IAEM,cAAc,CAAC,KAAa;QACjC,MAAM,YAAY,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;QACxC,IAAI,YAAY,KAAK,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YACrD,IAAI,CAAC,WAAW,CAAC,OAAO,GAAG;gBACzB,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO;gBAC3B,MAAM,EAAE,YAAY;aACrB,CAAC;QACJ,CAAC;IACH,CAAC;IAEM,cAAc,CAAC,KAAa;QACjC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,GAAG,KAAK,CAAC,CAAC;IAC/D,CAAC;IAEM,QAAQ,CAAC,KAAa;QAC3B,IAAI,KAAK,KAAK,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YAC7C,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC;YAC5B,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YACvB,IAAI,CAAC,WAAW,CAAC,OAAO,GAAG;gBACzB,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO;gBAC3B,KAAK,EAAE,KAAK;aACb,CAAC;YACF,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC9B,CAAC;IACH,CAAC;IAEM,YAAY,CAAC,SAAkC;QACpD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,oBAAoB,CAAC,OAAO,EAAE,CAAC;YAC/D,KAAK,CAAC,SAAS,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;QAC3C,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACI,QAAQ;QACb,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACnB,IAAI,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC;IAED;;;;;;;;;OASG;IACI,UAAU;QACf,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,CAAC;QAClC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,YAAY,EAAE,CAAC;QAC1C,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,EAAE,CAAC;YAC5B,oBAAoB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACrC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACxB,CAAC;IACH,CAAC;IAEO,oBAAoB;QAC1B,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC;QACnC,IAAI,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC;IAEO,KAAK,CAAC,OAAO;QAGnB,MAAM,KAAK,GAAG;YACZ,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO;YAC3B,IAAI,EAAE,IAAI,CAAC,aAAa;YACxB,MAAM,EAAE,IAAI,CAAC,eAAe;SAC7B,CAAC;QACF,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC,CAAC;QACxB,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;QAE7B,uCAAuC;QACvC,IAAI,IAAI,CAAC,sBAAsB,EAAE,CAAC;YAChC,IAAI,KAAK,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;gBACnB,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;YACnC,CAAC;YACD,IAAI,CAAC;gBACH,MAAM,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;gBAClC,IAAI,CAAC,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;gBAC5C,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;YAC/B,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAC7B,MAAM,CAAC,CAAC;YACV,CAAC;oBAAS,CAAC;gBACT,IAAI,CAAC,sBAAsB,GAAG,KAAK,CAAC;YACtC,CAAC;QACH,CAAC;QAED,6CAA6C;QAC7C,6CAA6C;QAC7C,IACE,CAAC,CAAC,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC;YACjE,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,UAAU,EACjC,CAAC;YACD,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YAC3B,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC;YACpB,KAAK,CAAC,IAAI;gBACR,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC;QACrE,CAAC;QAED,8CAA8C;QAC9C,IACE,KAAK,CAAC,IAAI;YACV,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAChE,IAAI,CAAC,UAAU,KAAK,IAAI,CAAC,OAAO,EAChC,CAAC;YACD,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC;QAC/B,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,KAAK,CAAC,GAAG;QACf,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QACnC,MAAM,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAC1C,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC,MAAM;YAChC,CAAC,CAAC,aAAa,CAAC,MAAM;YACtB,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC;QAE1B,0BAA0B;QAC1B,IAAI,KAAK,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9D,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC;YAClE,MAAM,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;YAChD,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YACjC,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACvC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACnC,CAAC;QACD,uBAAuB;aAClB,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YACtB,IACE,KAAK,CAAC,MAAM;gBACZ,CAAC,KAAK,CAAC,MAAM,IAAI,aAAa,KAAK,aAAa,CAAC,MAAM,CAAC,EACxD,CAAC;gBACD,8CAA8C;gBAC9C,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC/B,CAAC;YAED,IAAI,CAAC,OAAO,EAAE,CAAC;YACf,OAAO;QACT,CAAC;QAED,gCAAgC;aAC3B,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC3C,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;QACjC,CAAC;QAED,yCAAyC;QACzC,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;YACnE,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YAC3B,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC;QACtB,CAAC;QAED,mBAAmB;QACnB,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QAC7B,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAEzC,IAAI,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC;IAEO,OAAO;QACb,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,OAAO;QAEzB,6DAA6D;QAE7D,IAAI,CAAC,SAAS,KAAd,IAAI,CAAC,SAAS,GAAK,qBAAqB,CAAC,KAAK,EAAC,IAAI,EAAC,EAAE;YACpD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;YACtB,IAAI,IAAI,GAAG,IAAI,CAAC,UAAU,IAAI,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC;gBAC3D,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;gBACvB,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;gBAC1B,IAAI,CAAC;oBACH,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;gBACnB,CAAC;gBAAC,OAAO,CAAM,EAAE,CAAC;oBAChB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACvB,CAAC;gBACD,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YACtB,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,CAAC;QACH,CAAC,CAAC,EAAC;IACL,CAAC;IAEM,UAAU,CAAC,KAAa;QAC7B,OAAO,KAAK,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACtD,CAAC;CACF"}

package/lib/app/Project.d.ts

@@ -0,0 +1,145 @@
+import type { FfmpegExporterOptions, ImageExporterOptions } from '../exporter';
+import type { Plugin } from '../plugin';
+import type { SceneDescription } from '../scenes';
+import type { CanvasColorSpace, Color, Vector2 } from '../types';
+import type { Logger } from './Logger';
+export interface Versions {
+    core: string;
+    two: string | null;
+    ui: string | null;
+    vitePlugin: string | null;
+}
+export declare function createVersionObject(version: string): {
+    core: string;
+    two: string;
+    ui: string;
+    vitePlugin: string;
+};
+export type ExporterSettings = {
+    name: '@twick/core/image-sequence';
+    options: ImageExporterOptions;
+} | {
+    name: '@twick/core/ffmpeg';
+    options: FfmpegExporterOptions;
+} | {
+    name: '@twick/core/wasm';
+};
+export interface ProjectSettings {
+    shared: {
+        background: Color;
+        range: [number, number];
+        size: Vector2;
+    };
+    rendering: {
+        exporter: ExporterSettings;
+        fps: number;
+        resolutionScale: number;
+        colorSpace: CanvasColorSpace;
+    };
+    preview: {
+        fps: number;
+        resolutionScale: number;
+    };
+}
+export interface UserProjectSettings {
+    shared: {
+        range: [number, number];
+        background: string | null;
+        size: {
+            x: number;
+            y: number;
+        };
+    };
+    rendering: {
+        exporter: ExporterSettings;
+        fps: number;
+        resolutionScale: number;
+        colorSpace: CanvasColorSpace;
+    };
+    preview: {
+        fps: number;
+        resolutionScale: number;
+    };
+}
+/**
+ * Settings that can be passed to the renderVideo / renderPartialVideo functions
+ */
+export type RenderVideoUserProjectSettings = {
+    range?: UserProjectSettings['shared']['range'];
+    background?: UserProjectSettings['shared']['background'];
+    size?: UserProjectSettings['shared']['size'];
+    exporter?: UserProjectSettings['rendering']['exporter'];
+};
+/**
+ * Settings that can be passed to the createProject function
+ */
+export type PartialUserProjectSettings = {
+    shared?: Partial<UserProjectSettings['shared']>;
+    rendering?: Partial<UserProjectSettings['rendering']>;
+    preview?: Partial<UserProjectSettings['preview']>;
+};
+export interface UserProject {
+    /**
+     * The name of the project.
+     */
+    name?: string;
+    /**
+     * A list of scene descriptions that make up the project.
+     */
+    scenes: SceneDescription<any>[];
+    /**
+     * Default values for project variables.
+     *
+     * @see https://motioncanvas.io/docs/project-variables
+     */
+    variables?: Record<string, unknown>;
+    /**
+     * Enable experimental features.
+     *
+     * @see https://motioncanvas.io/docs/experimental
+     *
+     * @experimental
+     */
+    experimentalFeatures?: boolean;
+    /**
+     * Settings for the project. This includes shared settings, rendering settings
+     * and preview settings.
+     *
+     * Includes things like the background color, the resolution, the frame rate,
+     * and the exporter to use.
+     */
+    settings?: PartialUserProjectSettings;
+}
+/**
+ * Internal project that includes legacy properties that can't be changed by the user
+ * as well as defaulted properties in case the user didn't provide them.
+ */
+export interface Project extends Omit<UserProject, 'settings'> {
+    name: string;
+    settings: ProjectSettings;
+    /**
+     * @deprecated Not exposed in the public API. We set the exporters as plugins
+     * which is why we can't delete this yet.
+     *
+     * // TODO(konsti): get rid of plugins
+     *
+     * A list of plugins to include in the project.
+     *
+     * @remarks
+     * When a string is provided, the plugin will be imported dynamically using
+     * the string as the module specifier. This is the preferred way to include
+     * editor plugins because it makes sure that the plugin's source code gets
+     * excluded from the production build.
+     */
+    plugins: Plugin[];
+    /**
+     * Not exposed in the public API.
+     */
+    logger: Logger;
+    /**
+     * Manually set via a constant. This should be automated by reading the
+     * package.json files of the packages.
+     */
+    versions: Versions;
+}
+//# sourceMappingURL=Project.d.ts.map

package/lib/app/Project.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Project.d.ts","sourceRoot":"","sources":["../../src/app/Project.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,qBAAqB,EAAE,oBAAoB,EAAC,MAAM,aAAa,CAAC;AAC7E,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,WAAW,CAAC;AACtC,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,WAAW,CAAC;AAChD,OAAO,KAAK,EAAC,gBAAgB,EAAE,KAAK,EAAE,OAAO,EAAC,MAAM,UAAU,CAAC;AAC/D,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,UAAU,CAAC;AAGrC,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAGD,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM;;;;;EAOlD;AAED,MAAM,MAAM,gBAAgB,GACxB;IACE,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,oBAAoB,CAAC;CAC/B,GACD;IACE,IAAI,EAAE,oBAAoB,CAAC;IAC3B,OAAO,EAAE,qBAAqB,CAAC;CAChC,GACD;IACE,IAAI,EAAE,kBAAkB,CAAC;CAC1B,CAAC;AAGN,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE;QACN,UAAU,EAAE,KAAK,CAAC;QAClB,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACxB,IAAI,EAAE,OAAO,CAAC;KACf,CAAC;IACF,SAAS,EAAE;QACT,QAAQ,EAAE,gBAAgB,CAAC;QAC3B,GAAG,EAAE,MAAM,CAAC;QACZ,eAAe,EAAE,MAAM,CAAC;QACxB,UAAU,EAAE,gBAAgB,CAAC;KAC9B,CAAC;IACF,OAAO,EAAE;QACP,GAAG,EAAE,MAAM,CAAC;QACZ,eAAe,EAAE,MAAM,CAAC;KACzB,CAAC;CACH;AAGD,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE;QACN,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACxB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAC1B,IAAI,EAAE;YAAC,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAA;SAAC,CAAC;KAC9B,CAAC;IACF,SAAS,EAAE;QACT,QAAQ,EAAE,gBAAgB,CAAC;QAC3B,GAAG,EAAE,MAAM,CAAC;QACZ,eAAe,EAAE,MAAM,CAAC;QACxB,UAAU,EAAE,gBAAgB,CAAC;KAC9B,CAAC;IACF,OAAO,EAAE;QACP,GAAG,EAAE,MAAM,CAAC;QACZ,eAAe,EAAE,MAAM,CAAC;KACzB,CAAC;CACH;AAED;;GAEG;AAEH,MAAM,MAAM,8BAA8B,GAAG;IAC3C,KAAK,CAAC,EAAE,mBAAmB,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC;IAC/C,UAAU,CAAC,EAAE,mBAAmB,CAAC,QAAQ,CAAC,CAAC,YAAY,CAAC,CAAC;IACzD,IAAI,CAAC,EAAE,mBAAmB,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC;IAE7C,QAAQ,CAAC,EAAE,mBAAmB,CAAC,WAAW,CAAC,CAAC,UAAU,CAAC,CAAC;CACzD,CAAC;AAEF;;GAEG;AAEH,MAAM,MAAM,0BAA0B,GAAG;IACvC,MAAM,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC,CAAC;IAChD,SAAS,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC,CAAC;IACtD,OAAO,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC,CAAC;CACnD,CAAC;AAEF,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC;IAEhC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEpC;;;;;;OAMG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,0BAA0B,CAAC;CACvC;AAED;;;GAGG;AACH,MAAM,WAAW,OAAQ,SAAQ,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC;IAC5D,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,eAAe,CAAC;IAE1B;;;;;;;;;;;;;OAaG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,QAAQ,EAAE,QAAQ,CAAC;CACpB"}

package/lib/app/Project.js

@@ -0,0 +1,10 @@
+// TODO(refactor): check if we can get rid of this
+export function createVersionObject(version) {
+    return {
+        core: version,
+        two: version,
+        ui: version,
+        vitePlugin: version,
+    };
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUHJvamVjdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9hcHAvUHJvamVjdC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFjQSxrREFBa0Q7QUFDbEQsTUFBTSxVQUFVLG1CQUFtQixDQUFDLE9BQWU7SUFDakQsT0FBTztRQUNMLElBQUksRUFBRSxPQUFPO1FBQ2IsR0FBRyxFQUFFLE9BQU87UUFDWixFQUFFLEVBQUUsT0FBTztRQUNYLFVBQVUsRUFBRSxPQUFPO0tBQ3BCLENBQUM7QUFDSixDQUFDIn0=

package/lib/app/Renderer.d.ts

@@ -0,0 +1,90 @@
+import type { ExporterSettings, Project } from './Project';
+import type { StageSettings } from './Stage';
+import { Stage } from './Stage';
+import { TimeEstimator } from './TimeEstimator';
+export interface RendererSettings extends StageSettings {
+    name: string;
+    range: [number, number];
+    fps: number;
+    exporter: ExporterSettings;
+    hiddenFolderId?: string;
+}
+export interface AssetInfo {
+    key: string;
+    type: 'video' | 'audio';
+    src: string;
+    playbackRate: number;
+    volume: number;
+    currentTime: number;
+    duration: number;
+    decoder?: string | null;
+}
+export declare enum RendererState {
+    Initial = 0,
+    Working = 1,
+    Aborting = 2
+}
+export declare enum RendererResult {
+    Success = 0,
+    Error = 1,
+    Aborted = 2
+}
+/**
+ * The rendering logic used by the editor to export animations.
+ *
+ * @remarks
+ * This class uses the `PlaybackManager` to render animations. In contrast to a
+ * player, a renderer does not use an update loop. It plays through the
+ * animation as fast as it can, occasionally pausing to keep the UI responsive.
+ *
+ * The actual exporting is outsourced to an Exporter.
+ */
+export declare class Renderer {
+    private project;
+    get onStateChanged(): import("../events").SubscribableValueEvent<RendererState>;
+    private readonly state;
+    get onFinished(): import("../events").Subscribable<RendererResult, import("../events").EventHandler<RendererResult>>;
+    private readonly finished;
+    get onFrameChanged(): import("../events").SubscribableValueEvent<number>;
+    private readonly frame;
+    readonly stage: Stage;
+    readonly estimator: TimeEstimator;
+    private readonly lock;
+    private readonly playback;
+    private readonly status;
+    private readonly sharedWebGLContext;
+    private exporter;
+    private abortController;
+    constructor(project: Project);
+    /**
+     * Returns number of frames that a project will have.
+     */
+    getNumberOfFrames(settings: RendererSettings): Promise<number>;
+    frameToTime(frame: number): number;
+    timeToFrame(second: number): number;
+    /**
+     * Render the animation using the provided settings.
+     *
+     * @param settings - The rendering settings.
+     */
+    render(settings: RendererSettings): Promise<void>;
+    /**
+     * Abort the ongoing render process.
+     */
+    abort(): void;
+    /**
+     * Export an individual frame.
+     *
+     * @remarks
+     * This method always uses the default `ImageExporter`.
+     *
+     * @param settings - The rendering settings.
+     * @param time - The timestamp to export.
+     */
+    renderFrame(settings: RendererSettings, time: number): Promise<void>;
+    private run;
+    private reloadScenes;
+    private exportFrame;
+    private getMediaByFrames;
+}
+//# sourceMappingURL=Renderer.d.ts.map

package/lib/app/Renderer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Renderer.d.ts","sourceRoot":"","sources":["../../src/app/Renderer.ts"],"names":[],"mappings":"AAcA,OAAO,KAAK,EAAC,gBAAgB,EAAE,OAAO,EAAC,MAAM,WAAW,CAAC;AAEzD,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAC,KAAK,EAAC,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAC,aAAa,EAAC,MAAM,iBAAiB,CAAC;AAE9C,MAAM,WAAW,gBAAiB,SAAQ,aAAa;IACrD,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,oBAAY,aAAa;IACvB,OAAO,IAAA;IACP,OAAO,IAAA;IACP,QAAQ,IAAA;CACT;AAED,oBAAY,cAAc;IACxB,OAAO,IAAA;IACP,KAAK,IAAA;IACL,OAAO,IAAA;CACR;AAED;;;;;;;;;GASG;AACH,qBAAa,QAAQ;IA0BA,OAAO,CAAC,OAAO;IAzBlC,IAAW,cAAc,8DAExB;IACD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA8C;IAEpE,IAAW,UAAU,uGAEpB;IACD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAyC;IAElE,IAAW,cAAc,uDAExB;IACD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA0B;IAEhD,SAAgB,KAAK,QAAe;IACpC,SAAgB,SAAS,gBAAuB;IAEhD,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAmB;IACxC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAkB;IAC3C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAiB;IACxC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAqB;IACxD,OAAO,CAAC,QAAQ,CAAyB;IACzC,OAAO,CAAC,eAAe,CAAgC;gBAE5B,OAAO,EAAE,OAAO;IAqB3C;;OAEG;IACU,iBAAiB,CAAC,QAAQ,EAAE,gBAAgB;IAkBlD,WAAW,CAAC,KAAK,EAAE,MAAM;IAIzB,WAAW,CAAC,MAAM,EAAE,MAAM;IAIjC;;;;OAIG;IACU,MAAM,CAAC,QAAQ,EAAE,gBAAgB;IA8B9C;;OAEG;IACI,KAAK;IAMZ;;;;;;;;OAQG;IACU,WAAW,CAAC,QAAQ,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM;YAgCnD,GAAG;YAkIH,YAAY;YAWZ,WAAW;YAmBX,gBAAgB;CAqC/B"}