@snap/camera-kit 0.16.2 → 0.18.0

package/dist/media-sources/CameraKitSource.d.ts

@@ -0,0 +1,130 @@
+import type { LensCore } from "../lens-core-module/lensCore";
+import type { Transform2D } from "../transforms/Transform2D";
+export declare const defaultDeviceInfo: CameraKitDeviceOptions;
+/**
+ * When creating a {@link CameraKitSource}, passing a CameraKitSourceSubscriber allows logic to implemented which will
+ * run whenever that source is attached/detached from a CameraKitSession.
+ *
+ * @category Rendering
+ */
+export interface CameraKitSourceSubscriber {
+    readonly onAttach?: (source: CameraKitSource, lensCore: LensCore, reportError: (error: Error) => void) => void | Promise<void>;
+    readonly onDetach?: (reportError: (error: Error) => void) => void | Promise<void>;
+}
+export declare function isCameraKitSource(value: unknown): value is CameraKitSource;
+export declare function isPartialCameraKitDeviceOptionsOrUndefined(value: unknown): value is Partial<CameraKitDeviceOptions> | undefined;
+/**
+ * Device options.
+ *
+ * @category Rendering
+ */
+export interface CameraKitDeviceOptions {
+    /**
+     * Specifies the camera type for which certain features are enabled or disabled.
+     * For example, surface tracking features are only active when the camera is set to "environment" mode.
+     * The default value is "user", which accommodates the majority of Lenses.
+     * "user" refers to the front-facing camera, while "environment" refers to the rear-facing camera.
+     */
+    cameraType: "user" | "environment";
+    /**
+     * Limits the frames per second (FPS) to optimize performance by reducing compute resources
+     * when high FPS is not critical. By default, no limit is set, allowing usage of the video's native FPS.
+     * Useful for controlling resource usage on varying device capabilities.
+     */
+    fpsLimit: number;
+}
+/** @category Rendering */
+export interface CameraKitSourceInfo {
+    /**
+     * HTML element or MediaStream as an input source.
+     * If useManualFrameProcessing is true, then this parameter is optional.
+     */
+    media?: HTMLCanvasElement | HTMLImageElement | HTMLVideoElement | MediaStream;
+    /**
+     * Whether to provide frames manually.
+     */
+    useManualFrameProcessing?: boolean;
+    /**
+     * If specified, the passed-in tracking data buffer will be used as tracking data for the current
+     * media element instead of live tracking data.
+     */
+    replayTrackingData?: {
+        buffer: Uint8Array | ArrayBuffer;
+    };
+}
+/**
+ * This general-purpose class represents a source of media for a {@link CameraKitSession}.
+ *
+ * When an instance is passed to {@link CameraKitSession.setSource | CameraKitSession.setSource}, it will be "attached"
+ * to the session. Later it may be "detached" from the session.
+ *
+ * Passing a {@link CameraKitSourceSubscriber} to the constructor allows callers to specify behavior
+ * that will occur when the source is attached and detached. This can be used to e.g. update the render size.
+ *
+ * @category Rendering
+ */
+declare class CameraKitSource {
+    private readonly sourceInfo;
+    private readonly subscriber;
+    private lensCore?;
+    private readonly deviceInfo;
+    constructor(sourceInfo: CameraKitSourceInfo, subscriber?: CameraKitSourceSubscriber, deviceInfo?: Partial<CameraKitDeviceOptions>);
+    /**
+     * Called by {@link CameraKitSession} when this source is set as that session's source.
+     *
+     * @param lensCore
+     * @param reportError Calling this function will report an error back to the session.
+     * @returns Rejects if any calls to LensCore or CameraKitSource.subscriber.onAttach fail.
+     * @internal
+     */
+    attach(lensCore: LensCore, reportError: (error: Error) => void): Promise<void>;
+    /**
+     * Make a copy of the source, sharing the same {@link CameraKitSourceSubscriber}.
+     *
+     * @param deviceInfo Optionally provide new device info for the copy (e.g. to change the camera type).
+     * @returns The new {@link CameraKitSource}
+     */
+    copy(deviceInfo?: Partial<CameraKitDeviceOptions>): CameraKitSource;
+    /**
+     * Called by {@link CameraKitSession} when it must remove this source.
+     *
+     * @param reportError Calling this function will report an error back to the session.
+     * @returns
+     * @internal
+     */
+    detach(reportError: (error: Error) => void): void | Promise<void>;
+    /**
+     * Set the resolution used to render this source.
+     *
+     * If greater performance is required, a smaller render size may boost frame-rate. It does come at a cost, including
+     * loss of accuracy in various tracking and computer-vision algorithms (since they'll be operating on fewer pixels).
+     *
+     * By default (i.e. if this method is never called), then the render size will match the size of the input media.
+     * Best performance can be achieved by varying the size of the input media and allowing CameraKit to render at a
+     * resolution that matches the input media -- this method should only be used if the input media resolution cannot
+     * be changed to the desired size.
+     *
+     * It’s important to distinguish render size from display size. The size at which the output canvases are displayed
+     * on a web page is determined by the CSS of the page. It is distinct from the size at which CameraKit renders
+     * Lenses. Performance is dominated by render size, while any display scaling (using CSS) can most often be thought
+     * of as free.
+     *
+     * The size of the Live and Capture {@link RenderTarget} is always the same.
+     *
+     * @todo Currently it's only valid to call `setRenderSize` after `CameraKitSession.play` has been called. This
+     * constraint should be removed, so callers don't have to understand the underlying LensCore state machine.
+     *
+     * @param width pixels
+     * @param height pixels
+     * @returns Promise resolves when the render size has been successfully updated.
+     */
+    setRenderSize(width: number, height: number): Promise<void>;
+    /**
+     * Apply a 2D transformation to the source (e.g. translation, rotation, scale).
+     *
+     * @param transform Specifies the 3x3 matrix describing the transformation.
+     */
+    setTransform(transform: Transform2D): Promise<void>;
+}
+export { CameraKitSource };
+//# sourceMappingURL=CameraKitSource.d.ts.map

package/dist/media-sources/CameraKitSource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CameraKitSource.d.ts","sourceRoot":"","sources":["../../src/media-sources/CameraKitSource.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAG7D,eAAO,MAAM,iBAAiB,EAAE,sBAG/B,CAAC;AAKF;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACtC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAChB,MAAM,EAAE,eAAe,EACvB,QAAQ,EAAE,QAAQ,EAClB,WAAW,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,KAClC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1B,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACrF;AAWD,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,eAAe,CAE1E;AAED,wBAAgB,0CAA0C,CACtD,KAAK,EAAE,OAAO,GACf,KAAK,IAAI,OAAO,CAAC,sBAAsB,CAAC,GAAG,SAAS,CAEtD;AAcD;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC;;;;;OAKG;IACH,UAAU,EAAE,MAAM,GAAG,aAAa,CAAC;IAEnC;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED,0BAA0B;AAC1B,MAAM,WAAW,mBAAmB;IAChC;;;OAGG;IACH,KAAK,CAAC,EAAE,iBAAiB,GAAG,gBAAgB,GAAG,gBAAgB,GAAG,WAAW,CAAC;IAE9E;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;OAGG;IACH,kBAAkB,CAAC,EAAE;QACjB,MAAM,EAAE,UAAU,GAAG,WAAW,CAAC;KACpC,CAAC;CACL;AAED;;;;;;;;;;GAUG;AACH,cAAM,eAAe;IAKb,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,UAAU;IAL/B,OAAO,CAAC,QAAQ,CAAC,CAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAyB;gBAG/B,UAAU,EAAE,mBAAmB,EAC/B,UAAU,GAAE,yBAA8B,EAC3D,UAAU,GAAE,OAAO,CAAC,sBAAsB,CAAM;IAKpD;;;;;;;OAOG;IACG,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IA6BpF;;;;;OAKG;IACH,IAAI,CAAC,UAAU,GAAE,OAAO,CAAC,sBAAsB,CAAM,GAAG,eAAe;IAIvE;;;;;;OAMG;IACH,MAAM,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAKjE;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IAEH,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAM3D;;;;OAIG;IAEH,YAAY,CAAC,SAAS,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;CAKtD;AAGD,OAAO,EAAE,eAAe,EAAE,CAAC"}

package/dist/media-sources/CameraKitSource.js

@@ -0,0 +1,96 @@
+import { __awaiter, __esDecorate, __runInitializers } from "tslib";
+import { copyDefinedProperties } from "../common/copyDefinedProperties";
+import { isRecord, isUndefined, isValidNumber, isValidNumberOrUndefined } from "../common/typeguards";
+import { validate } from "../common/validate";
+import { isTransform2D } from "../transforms/Transform2D";
+export const defaultDeviceInfo = {
+    cameraType: "user",
+    fpsLimit: Number.POSITIVE_INFINITY,
+};
+const createNotAttachedError = (message) => new Error(`${message}. This CameraKitSource is not attached to a CameraKitSession.`);
+const cameraTypeValueSet = new Set(Object.keys({
+    user: 0,
+    environment: 0,
+}));
+export function isCameraKitSource(value) {
+    return value instanceof CameraKitSource;
+}
+export function isPartialCameraKitDeviceOptionsOrUndefined(value) {
+    return isUndefined(value) || isPartialCameraKitDeviceOptions(value);
+}
+function isPartialCameraKitDeviceOptions(value) {
+    return isRecord(value) && isCameraTypeOrUndefined(value.cameraType) && isValidNumberOrUndefined(value.fpsLimit);
+}
+function isCameraType(value) {
+    return cameraTypeValueSet.has(value);
+}
+function isCameraTypeOrUndefined(value) {
+    return isUndefined(value) || isCameraType(value);
+}
+let CameraKitSource = (() => {
+    var _a;
+    let _instanceExtraInitializers = [];
+    let _setRenderSize_decorators;
+    let _setTransform_decorators;
+    return _a = class CameraKitSource {
+            constructor(sourceInfo, subscriber = {}, deviceInfo = {}) {
+                this.sourceInfo = (__runInitializers(this, _instanceExtraInitializers), sourceInfo);
+                this.subscriber = subscriber;
+                this.deviceInfo = Object.assign(Object.assign({}, defaultDeviceInfo), copyDefinedProperties(deviceInfo));
+            }
+            attach(lensCore, reportError) {
+                return __awaiter(this, void 0, void 0, function* () {
+                    if (this.lensCore) {
+                        throw new Error("Cannot attach. This CameraKitCustomSource has already been attached to " +
+                            "a CameraKitSession. To re-attach, create a copy of this CameraKitCustomSource.");
+                    }
+                    this.lensCore = lensCore;
+                    yield lensCore.useMediaElement({
+                        autoplayNewMedia: false,
+                        autoplayPreviewCanvas: false,
+                        media: this.sourceInfo.media,
+                        pauseExistingMedia: false,
+                        replayTrackingData: this.sourceInfo.replayTrackingData,
+                        requestWebcam: false,
+                        startOnFrontCamera: ["user", "front"].includes(this.deviceInfo.cameraType),
+                        useManualFrameProcessing: this.sourceInfo.useManualFrameProcessing,
+                    });
+                    const fps = this.deviceInfo.fpsLimit < Number.POSITIVE_INFINITY ? this.deviceInfo.fpsLimit : 0;
+                    yield lensCore.setFPSLimit({ fps });
+                    yield lensCore.setRenderSize({ mode: "matchInputResolution" });
+                    if (this.subscriber.onAttach)
+                        yield this.subscriber.onAttach(this, lensCore, reportError);
+                });
+            }
+            copy(deviceInfo = {}) {
+                return new CameraKitSource(this.sourceInfo, this.subscriber, Object.assign(Object.assign({}, this.deviceInfo), deviceInfo));
+            }
+            detach(reportError) {
+                if (!this.lensCore)
+                    return Promise.reject(createNotAttachedError("Cannot detach"));
+                if (this.subscriber.onDetach)
+                    return this.subscriber.onDetach(reportError);
+            }
+            setRenderSize(width, height) {
+                if (!this.lensCore)
+                    return Promise.reject(createNotAttachedError("Cannot setRenderSize"));
+                const target = { width, height };
+                return this.lensCore.setRenderSize({ mode: "explicit", target });
+            }
+            setTransform(transform) {
+                if (!this.lensCore)
+                    return Promise.reject(createNotAttachedError("Cannot setTransform"));
+                const matrix = new Float32Array(transform.matrix);
+                return this.lensCore.setInputTransform({ matrix });
+            }
+        },
+        (() => {
+            _setRenderSize_decorators = [validate(isValidNumber, isValidNumber)];
+            _setTransform_decorators = [validate(isTransform2D)];
+            __esDecorate(_a, null, _setRenderSize_decorators, { kind: "method", name: "setRenderSize", static: false, private: false, access: { has: obj => "setRenderSize" in obj, get: obj => obj.setRenderSize } }, null, _instanceExtraInitializers);
+            __esDecorate(_a, null, _setTransform_decorators, { kind: "method", name: "setTransform", static: false, private: false, access: { has: obj => "setTransform" in obj, get: obj => obj.setTransform } }, null, _instanceExtraInitializers);
+        })(),
+        _a;
+})();
+export { CameraKitSource };
+//# sourceMappingURL=CameraKitSource.js.map

package/dist/media-sources/CameraKitSource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CameraKitSource.js","sourceRoot":"","sources":["../../src/media-sources/CameraKitSource.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,aAAa,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AACtG,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAG9C,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAE1D,MAAM,CAAC,MAAM,iBAAiB,GAA2B;IACrD,UAAU,EAAE,MAAM;IAClB,QAAQ,EAAE,MAAM,CAAC,iBAAiB;CACrC,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAAC,OAAe,EAAE,EAAE,CAC/C,IAAI,KAAK,CAAC,GAAG,OAAO,+DAA+D,CAAC,CAAC;AAmBzF,MAAM,kBAAkB,GAAG,IAAI,GAAG,CAC9B,MAAM,CAAC,IAAI,CAAC;IACR,IAAI,EAAE,CAAC;IACP,WAAW,EAAE,CAAC;CACe,CAAiB,CACrD,CAAC;AAEF,MAAM,UAAU,iBAAiB,CAAC,KAAc;IAC5C,OAAO,KAAK,YAAY,eAAe,CAAC;AAC5C,CAAC;AAED,MAAM,UAAU,0CAA0C,CACtD,KAAc;IAEd,OAAO,WAAW,CAAC,KAAK,CAAC,IAAI,+BAA+B,CAAC,KAAK,CAAC,CAAC;AACxE,CAAC;AAED,SAAS,+BAA+B,CAAC,KAAc;IACnD,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,uBAAuB,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,wBAAwB,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;AACpH,CAAC;AAED,SAAS,YAAY,CAAC,KAAc;IAChC,OAAO,kBAAkB,CAAC,GAAG,CAAC,KAAmB,CAAC,CAAC;AACvD,CAAC;AAED,SAAS,uBAAuB,CAAC,KAAc;IAC3C,OAAO,WAAW,CAAC,KAAK,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC;AACrD,CAAC;IAyDK,eAAe;;;;;sBAAf,eAAe;YAIjB,YACqB,UAA+B,EAC/B,aAAwC,EAAE,EAC3D,aAA8C,EAAE;gBAF/B,eAAU,yDAAV,UAAU,EAAqB;gBAC/B,eAAU,GAAV,UAAU,CAAgC;gBAG3D,IAAI,CAAC,UAAU,mCAAQ,iBAAiB,GAAK,qBAAqB,CAAC,UAAU,CAAC,CAAE,CAAC;YACrF,CAAC;YAUK,MAAM,CAAC,QAAkB,EAAE,WAAmC;;oBAChE,IAAI,IAAI,CAAC,QAAQ,EAAE;wBACf,MAAM,IAAI,KAAK,CACX,yEAAyE;4BACrE,gFAAgF,CACvF,CAAC;qBACL;oBAED,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;oBAEzB,MAAM,QAAQ,CAAC,eAAe,CAAC;wBAC3B,gBAAgB,EAAE,KAAK;wBACvB,qBAAqB,EAAE,KAAK;wBAC5B,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK;wBAC5B,kBAAkB,EAAE,KAAK;wBACzB,kBAAkB,EAAE,IAAI,CAAC,UAAU,CAAC,kBAAkB;wBACtD,aAAa,EAAE,KAAK;wBACpB,kBAAkB,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;wBAC1E,wBAAwB,EAAE,IAAI,CAAC,UAAU,CAAC,wBAAwB;qBACrE,CAAC,CAAC;oBAGH,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,GAAG,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC/F,MAAM,QAAQ,CAAC,WAAW,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;oBACpC,MAAM,QAAQ,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,sBAAsB,EAAE,CAAC,CAAC;oBAE/D,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ;wBAAE,MAAM,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;gBAC9F,CAAC;aAAA;YAQD,IAAI,CAAC,aAA8C,EAAE;gBACjD,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,kCAAO,IAAI,CAAC,UAAU,GAAK,UAAU,EAAG,CAAC;YACxG,CAAC;YASD,MAAM,CAAC,WAAmC;gBACtC,IAAI,CAAC,IAAI,CAAC,QAAQ;oBAAE,OAAO,OAAO,CAAC,MAAM,CAAC,sBAAsB,CAAC,eAAe,CAAC,CAAC,CAAC;gBACnF,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ;oBAAE,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;YAC/E,CAAC;YA4BD,aAAa,CAAC,KAAa,EAAE,MAAc;gBACvC,IAAI,CAAC,IAAI,CAAC,QAAQ;oBAAE,OAAO,OAAO,CAAC,MAAM,CAAC,sBAAsB,CAAC,sBAAsB,CAAC,CAAC,CAAC;gBAC1F,MAAM,MAAM,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;gBACjC,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,CAAC;YACrE,CAAC;YAQD,YAAY,CAAC,SAAsB;gBAC/B,IAAI,CAAC,IAAI,CAAC,QAAQ;oBAAE,OAAO,OAAO,CAAC,MAAM,CAAC,sBAAsB,CAAC,qBAAqB,CAAC,CAAC,CAAC;gBACzF,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;gBAClD,OAAO,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;YACvD,CAAC;;;yCAjBA,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;wCAYtC,QAAQ,CAAC,aAAa,CAAC;YAXxB,wLAAA,aAAa,wCAIZ;YAQD,qLAAA,YAAY,wCAIX;;;;AAIL,OAAO,EAAE,eAAe,EAAE,CAAC","sourcesContent":["/* eslint-disable @typescript-eslint/member-ordering */\n\nimport { copyDefinedProperties } from \"../common/copyDefinedProperties\";\nimport { isRecord, isUndefined, isValidNumber, isValidNumberOrUndefined } from \"../common/typeguards\";\nimport { validate } from \"../common/validate\";\nimport type { LensCore } from \"../lens-core-module/lensCore\";\nimport type { Transform2D } from \"../transforms/Transform2D\";\nimport { isTransform2D } from \"../transforms/Transform2D\";\n\nexport const defaultDeviceInfo: CameraKitDeviceOptions = {\n    cameraType: \"user\",\n    fpsLimit: Number.POSITIVE_INFINITY,\n};\n\nconst createNotAttachedError = (message: string) =>\n    new Error(`${message}. This CameraKitSource is not attached to a CameraKitSession.`);\n\n/**\n * When creating a {@link CameraKitSource}, passing a CameraKitSourceSubscriber allows logic to implemented which will\n * run whenever that source is attached/detached from a CameraKitSession.\n *\n * @category Rendering\n */\nexport interface CameraKitSourceSubscriber {\n    readonly onAttach?: (\n        source: CameraKitSource,\n        lensCore: LensCore,\n        reportError: (error: Error) => void\n    ) => void | Promise<void>;\n    readonly onDetach?: (reportError: (error: Error) => void) => void | Promise<void>;\n}\n\n// Helper set to ensure that changes to cameraType will ensure changes to the guard.\ntype CameraType = CameraKitDeviceOptions[\"cameraType\"];\nconst cameraTypeValueSet = new Set(\n    Object.keys({\n        user: 0,\n        environment: 0,\n    } satisfies Record<CameraType, 0>) as CameraType[]\n);\n\nexport function isCameraKitSource(value: unknown): value is CameraKitSource {\n    return value instanceof CameraKitSource;\n}\n\nexport function isPartialCameraKitDeviceOptionsOrUndefined(\n    value: unknown\n): value is Partial<CameraKitDeviceOptions> | undefined {\n    return isUndefined(value) || isPartialCameraKitDeviceOptions(value);\n}\n\nfunction isPartialCameraKitDeviceOptions(value: unknown): value is Partial<CameraKitDeviceOptions> {\n    return isRecord(value) && isCameraTypeOrUndefined(value.cameraType) && isValidNumberOrUndefined(value.fpsLimit);\n}\n\nfunction isCameraType(value: unknown): value is CameraType {\n    return cameraTypeValueSet.has(value as CameraType);\n}\n\nfunction isCameraTypeOrUndefined(value: unknown): value is CameraType | undefined {\n    return isUndefined(value) || isCameraType(value);\n}\n\n/**\n * Device options.\n *\n * @category Rendering\n */\nexport interface CameraKitDeviceOptions {\n    /**\n     * Specifies the camera type for which certain features are enabled or disabled.\n     * For example, surface tracking features are only active when the camera is set to \"environment\" mode.\n     * The default value is \"user\", which accommodates the majority of Lenses.\n     * \"user\" refers to the front-facing camera, while \"environment\" refers to the rear-facing camera.\n     */\n    cameraType: \"user\" | \"environment\";\n\n    /**\n     * Limits the frames per second (FPS) to optimize performance by reducing compute resources\n     * when high FPS is not critical. By default, no limit is set, allowing usage of the video's native FPS.\n     * Useful for controlling resource usage on varying device capabilities.\n     */\n    fpsLimit: number;\n}\n\n/** @category Rendering */\nexport interface CameraKitSourceInfo {\n    /**\n     * HTML element or MediaStream as an input source.\n     * If useManualFrameProcessing is true, then this parameter is optional.\n     */\n    media?: HTMLCanvasElement | HTMLImageElement | HTMLVideoElement | MediaStream;\n\n    /**\n     * Whether to provide frames manually.\n     */\n    useManualFrameProcessing?: boolean;\n\n    /**\n     * If specified, the passed-in tracking data buffer will be used as tracking data for the current\n     * media element instead of live tracking data.\n     */\n    replayTrackingData?: {\n        buffer: Uint8Array | ArrayBuffer;\n    };\n}\n\n/**\n * This general-purpose class represents a source of media for a {@link CameraKitSession}.\n *\n * When an instance is passed to {@link CameraKitSession.setSource | CameraKitSession.setSource}, it will be \"attached\"\n * to the session. Later it may be \"detached\" from the session.\n *\n * Passing a {@link CameraKitSourceSubscriber} to the constructor allows callers to specify behavior\n * that will occur when the source is attached and detached. This can be used to e.g. update the render size.\n *\n * @category Rendering\n */\nclass CameraKitSource {\n    private lensCore?: LensCore;\n    private readonly deviceInfo: CameraKitDeviceOptions;\n\n    constructor(\n        private readonly sourceInfo: CameraKitSourceInfo,\n        private readonly subscriber: CameraKitSourceSubscriber = {},\n        deviceInfo: Partial<CameraKitDeviceOptions> = {}\n    ) {\n        this.deviceInfo = { ...defaultDeviceInfo, ...copyDefinedProperties(deviceInfo) };\n    }\n\n    /**\n     * Called by {@link CameraKitSession} when this source is set as that session's source.\n     *\n     * @param lensCore\n     * @param reportError Calling this function will report an error back to the session.\n     * @returns Rejects if any calls to LensCore or CameraKitSource.subscriber.onAttach fail.\n     * @internal\n     */\n    async attach(lensCore: LensCore, reportError: (error: Error) => void): Promise<void> {\n        if (this.lensCore) {\n            throw new Error(\n                \"Cannot attach. This CameraKitCustomSource has already been attached to \" +\n                    \"a CameraKitSession. To re-attach, create a copy of this CameraKitCustomSource.\"\n            );\n        }\n\n        this.lensCore = lensCore;\n\n        await lensCore.useMediaElement({\n            autoplayNewMedia: false,\n            autoplayPreviewCanvas: false,\n            media: this.sourceInfo.media,\n            pauseExistingMedia: false,\n            replayTrackingData: this.sourceInfo.replayTrackingData,\n            requestWebcam: false,\n            startOnFrontCamera: [\"user\", \"front\"].includes(this.deviceInfo.cameraType),\n            useManualFrameProcessing: this.sourceInfo.useManualFrameProcessing,\n        });\n\n        // LensCore uses 0 to remove the limit.\n        const fps = this.deviceInfo.fpsLimit < Number.POSITIVE_INFINITY ? this.deviceInfo.fpsLimit : 0;\n        await lensCore.setFPSLimit({ fps });\n        await lensCore.setRenderSize({ mode: \"matchInputResolution\" });\n\n        if (this.subscriber.onAttach) await this.subscriber.onAttach(this, lensCore, reportError);\n    }\n\n    /**\n     * Make a copy of the source, sharing the same {@link CameraKitSourceSubscriber}.\n     *\n     * @param deviceInfo Optionally provide new device info for the copy (e.g. to change the camera type).\n     * @returns The new {@link CameraKitSource}\n     */\n    copy(deviceInfo: Partial<CameraKitDeviceOptions> = {}): CameraKitSource {\n        return new CameraKitSource(this.sourceInfo, this.subscriber, { ...this.deviceInfo, ...deviceInfo });\n    }\n\n    /**\n     * Called by {@link CameraKitSession} when it must remove this source.\n     *\n     * @param reportError Calling this function will report an error back to the session.\n     * @returns\n     * @internal\n     */\n    detach(reportError: (error: Error) => void): void | Promise<void> {\n        if (!this.lensCore) return Promise.reject(createNotAttachedError(\"Cannot detach\"));\n        if (this.subscriber.onDetach) return this.subscriber.onDetach(reportError);\n    }\n\n    /**\n     * Set the resolution used to render this source.\n     *\n     * If greater performance is required, a smaller render size may boost frame-rate. It does come at a cost, including\n     * loss of accuracy in various tracking and computer-vision algorithms (since they'll be operating on fewer pixels).\n     *\n     * By default (i.e. if this method is never called), then the render size will match the size of the input media.\n     * Best performance can be achieved by varying the size of the input media and allowing CameraKit to render at a\n     * resolution that matches the input media -- this method should only be used if the input media resolution cannot\n     * be changed to the desired size.\n     *\n     * It’s important to distinguish render size from display size. The size at which the output canvases are displayed\n     * on a web page is determined by the CSS of the page. It is distinct from the size at which CameraKit renders\n     * Lenses. Performance is dominated by render size, while any display scaling (using CSS) can most often be thought\n     * of as free.\n     *\n     * The size of the Live and Capture {@link RenderTarget} is always the same.\n     *\n     * @todo Currently it's only valid to call `setRenderSize` after `CameraKitSession.play` has been called. This\n     * constraint should be removed, so callers don't have to understand the underlying LensCore state machine.\n     *\n     * @param width pixels\n     * @param height pixels\n     * @returns Promise resolves when the render size has been successfully updated.\n     */\n    @validate(isValidNumber, isValidNumber)\n    setRenderSize(width: number, height: number): Promise<void> {\n        if (!this.lensCore) return Promise.reject(createNotAttachedError(\"Cannot setRenderSize\"));\n        const target = { width, height };\n        return this.lensCore.setRenderSize({ mode: \"explicit\", target });\n    }\n\n    /**\n     * Apply a 2D transformation to the source (e.g. translation, rotation, scale).\n     *\n     * @param transform Specifies the 3x3 matrix describing the transformation.\n     */\n    @validate(isTransform2D)\n    setTransform(transform: Transform2D): Promise<void> {\n        if (!this.lensCore) return Promise.reject(createNotAttachedError(\"Cannot setTransform\"));\n        const matrix = new Float32Array(transform.matrix);\n        return this.lensCore.setInputTransform({ matrix });\n    }\n}\n\n// NOTE: jest doesn't like default exports of classes with decorated methods.\nexport { CameraKitSource };\n"]}

package/dist/media-sources/FunctionSource.d.ts

@@ -0,0 +1,42 @@
+import { CameraKitSource } from "./CameraKitSource";
+/** @internal */
+export type FrameFormat = "rgb" | "yuv" | "nv12";
+/** @internal */
+export interface FrameInput {
+    format?: FrameFormat;
+    imageData: ImageData;
+    timestampMillis: number;
+}
+/** @internal */
+export interface FrameOutput {
+    live: ImageData;
+    capture: ImageData;
+}
+/** @internal */
+export interface MediaSourceFunction {
+    (render: (frame: FrameInput) => Promise<FrameOutput>): Promise<void>;
+}
+/**
+ * Function source options.
+ */
+export interface FunctionSourceOptions {
+    /**
+     * Specifies the camera type for which certain features are enabled or disabled.
+     * For example, surface tracking features are only active when the camera is set to "environment" mode.
+     * The default value is "user", which accommodates the majority of Lenses.
+     * "user" refers to the front-facing camera, while "environment" refers to the rear-facing camera.
+     */
+    cameraType: "user" | "environment";
+}
+/**
+ * Creates a {@link CameraKitSource} from a function which provides per-frame pixel data to CameraKit.
+ *
+ * @param sourceFunction This function will be called in a requestAnimationFrame loop. Each time it is called, it is
+ * passed a `render` function. It may call `render` and CameraKit will process the pixel data passed to `render` and
+ * return a Promise of the processed pixels (along with rendering them to the normal output canvases).
+ * @param options Options.
+ *
+ * @internal
+ */
+export declare const createFunctionSource: (sourceFunction: MediaSourceFunction, options?: Partial<FunctionSourceOptions>) => CameraKitSource;
+//# sourceMappingURL=FunctionSource.d.ts.map

package/dist/media-sources/FunctionSource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FunctionSource.d.ts","sourceRoot":"","sources":["../../src/media-sources/FunctionSource.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAqCpD,gBAAgB;AAChB,MAAM,MAAM,WAAW,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;AAEjD,gBAAgB;AAChB,MAAM,WAAW,UAAU;IACvB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,SAAS,EAAE,SAAS,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;CAC3B;AAED,gBAAgB;AAChB,MAAM,WAAW,WAAW;IACxB,IAAI,EAAE,SAAS,CAAC;IAChB,OAAO,EAAE,SAAS,CAAC;CACtB;AAED,gBAAgB;AAChB,MAAM,WAAW,mBAAmB;IAChC,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,OAAO,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACxE;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC;;;;;OAKG;IACH,UAAU,EAAE,MAAM,GAAG,aAAa,CAAC;CACtC;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,oBAAoB,mBACb,mBAAmB,YAC1B,QAAQ,qBAAqB,CAAC,KACxC,eA0FF,CAAC"}

package/dist/media-sources/FunctionSource.js

@@ -0,0 +1,105 @@
+import { __awaiter } from "tslib";
+import { CameraKitSource } from "./CameraKitSource";
+const getYUVImageData = (canvas, lensCore) => __awaiter(void 0, void 0, void 0, function* () {
+    const { width, height } = canvas;
+    const outputBuffer = new ArrayBuffer((width * height * 3) / 2);
+    yield lensCore.imageToYuvBuffer({ image: canvas, width, height, outputBuffer });
+    const pixels = new Uint8ClampedArray(outputBuffer);
+    return new ImageData(pixels, width, height);
+});
+const getRGBImageData = (output, imageReader2D) => {
+    if (imageReader2D === null)
+        return new ImageData(0, 0);
+    imageReader2D.drawImage(output, 0, 0);
+    return imageReader2D.getImageData(0, 0, output.width, output.height);
+};
+const getImageBitmap = (imageData, format) => __awaiter(void 0, void 0, void 0, function* () {
+    switch (format) {
+        case "nv12":
+        case "yuv":
+            if (!window.VideoFrame)
+                return Promise.reject(new Error(`Cannot process frame. ImageData in ${format} is not supported by this browser.`));
+            const frame = new VideoFrame(imageData.data.buffer, {
+                format: "NV12",
+                codedWidth: imageData.width,
+                codedHeight: imageData.height,
+                timestamp: 0,
+            });
+            return createImageBitmap(frame);
+        case "rgb":
+            return createImageBitmap(imageData);
+    }
+});
+export const createFunctionSource = (sourceFunction, options = {}) => {
+    let width = 0;
+    let height = 0;
+    let shouldProcessFrame = true;
+    const imageReaderCanvas = document.createElement("canvas");
+    const imageReader2D = imageReaderCanvas.getContext("2d");
+    const subscriber = {
+        onAttach: (source, lensCore, reportError) => {
+            const outputs = lensCore.getOutputCanvases();
+            const output = {
+                live: outputs[lensCore.CanvasType.Preview.value],
+                capture: outputs[lensCore.CanvasType.Capture.value],
+            };
+            const processFrame = (source, lensCore, reportError) => requestAnimationFrame(() => __awaiter(void 0, void 0, void 0, function* () {
+                var _a;
+                if (!shouldProcessFrame)
+                    return;
+                try {
+                    yield sourceFunction(({ format, imageData, timestampMillis }) => {
+                        const frameOutput = new Promise((resolve, reject) => __awaiter(void 0, void 0, void 0, function* () {
+                            const inputFrame = yield getImageBitmap(imageData, format !== null && format !== void 0 ? format : "rgb");
+                            if (inputFrame.width !== width || inputFrame.height !== height) {
+                                width = imageReaderCanvas.width = inputFrame.width;
+                                height = imageReaderCanvas.height = inputFrame.height;
+                                source.setRenderSize(width, height);
+                            }
+                            lensCore
+                                .processFrame({ inputFrame, timestampMillis })
+                                .then(() => __awaiter(void 0, void 0, void 0, function* () {
+                                inputFrame.close();
+                                switch (format !== null && format !== void 0 ? format : "rgb") {
+                                    case "nv12":
+                                    case "yuv":
+                                        const [live, capture] = yield Promise.all([
+                                            getYUVImageData(output.live, lensCore),
+                                            getYUVImageData(output.capture, lensCore),
+                                        ]).catch((error) => {
+                                            reject(error);
+                                            return [undefined, undefined];
+                                        });
+                                        if (!live || !capture)
+                                            return;
+                                        return resolve({ live, capture });
+                                    case "rgb":
+                                        return resolve({
+                                            live: getRGBImageData(output.live, imageReader2D),
+                                            capture: getRGBImageData(output.capture, imageReader2D),
+                                        });
+                                }
+                            }))
+                                .catch((error) => {
+                                inputFrame.close();
+                                reject(error);
+                            });
+                        }));
+                        frameOutput.finally(() => processFrame(source, lensCore, reportError));
+                        return frameOutput;
+                    });
+                }
+                catch (error) {
+                    reportError(new Error("Failure to process frame, which was not handled by the provided " +
+                        `MediaSourceFunction ${(_a = sourceFunction.name) !== null && _a !== void 0 ? _a : "anonymous"}.`, { cause: error }));
+                }
+            }));
+            processFrame(source, lensCore, reportError);
+        },
+        onDetach: () => {
+            shouldProcessFrame = false;
+        },
+    };
+    return new CameraKitSource({ useManualFrameProcessing: true }, subscriber, options);
+};
+//# sourceMappingURL=FunctionSource.js.map

package/dist/media-sources/FunctionSource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FunctionSource.js","sourceRoot":"","sources":["../../src/media-sources/FunctionSource.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,MAAM,eAAe,GAAG,CAAO,MAAyB,EAAE,QAAkB,EAAsB,EAAE;IAChG,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAEjC,MAAM,YAAY,GAAG,IAAI,WAAW,CAAC,CAAC,KAAK,GAAG,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/D,MAAM,QAAQ,CAAC,gBAAgB,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC;IAChF,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC,YAAY,CAAC,CAAC;IACnD,OAAO,IAAI,SAAS,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;AAChD,CAAC,CAAA,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,MAAyB,EAAE,aAA8C,EAAa,EAAE;IAC7G,IAAI,aAAa,KAAK,IAAI;QAAE,OAAO,IAAI,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACvD,aAAa,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACtC,OAAO,aAAa,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;AACzE,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAO,SAAoB,EAAE,MAAmB,EAAwB,EAAE;IAC7F,QAAQ,MAAM,EAAE;QACZ,KAAK,MAAM,CAAC;QACZ,KAAK,KAAK;YACN,IAAI,CAAC,MAAM,CAAC,UAAU;gBAClB,OAAO,OAAO,CAAC,MAAM,CACjB,IAAI,KAAK,CAAC,sCAAsC,MAAM,oCAAoC,CAAC,CAC9F,CAAC;YACN,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE;gBAChD,MAAM,EAAE,MAAM;gBACd,UAAU,EAAE,SAAS,CAAC,KAAK;gBAC3B,WAAW,EAAE,SAAS,CAAC,MAAM;gBAC7B,SAAS,EAAE,CAAC;aACf,CAAC,CAAC;YACH,OAAO,iBAAiB,CAAC,KAAK,CAAC,CAAC;QACpC,KAAK,KAAK;YACN,OAAO,iBAAiB,CAAC,SAAS,CAAC,CAAC;KAC3C;AACL,CAAC,CAAA,CAAC;AA8CF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAChC,cAAmC,EACnC,UAA0C,EAAE,EAC7B,EAAE;IACjB,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,IAAI,kBAAkB,GAAG,IAAI,CAAC;IAI9B,MAAM,iBAAiB,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAC3D,MAAM,aAAa,GAAG,iBAAiB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAEzD,MAAM,UAAU,GAA8B;QAC1C,QAAQ,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,EAAE;YACxC,MAAM,OAAO,GAAG,QAAQ,CAAC,iBAAiB,EAAE,CAAC;YAC7C,MAAM,MAAM,GAAG;gBACX,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC;gBAChD,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC;aACtD,CAAC;YAEF,MAAM,YAAY,GAAG,CAAC,MAAuB,EAAE,QAAkB,EAAE,WAAmC,EAAE,EAAE,CACtG,qBAAqB,CAAC,GAAS,EAAE;;gBAC7B,IAAI,CAAC,kBAAkB;oBAAE,OAAO;gBAChC,IAAI;oBACA,MAAM,cAAc,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,eAAe,EAAE,EAAE,EAAE;wBAE5D,MAAM,WAAW,GAAG,IAAI,OAAO,CAAc,CAAO,OAAO,EAAE,MAAM,EAAE,EAAE;4BACnE,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,SAAS,EAAE,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,KAAK,CAAC,CAAC;4BACpE,IAAI,UAAU,CAAC,KAAK,KAAK,KAAK,IAAI,UAAU,CAAC,MAAM,KAAK,MAAM,EAAE;gCAC5D,KAAK,GAAG,iBAAiB,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;gCACnD,MAAM,GAAG,iBAAiB,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;gCAItD,MAAM,CAAC,aAAa,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;6BACvC;4BACD,QAAQ;iCACH,YAAY,CAAC,EAAE,UAAU,EAAE,eAAe,EAAE,CAAC;iCAC7C,IAAI,CAAC,GAAS,EAAE;gCAGb,UAAU,CAAC,KAAK,EAAE,CAAC;gCAEnB,QAAQ,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,KAAK,EAAE;oCACrB,KAAK,MAAM,CAAC;oCACZ,KAAK,KAAK;wCACN,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;4CACtC,eAAe,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC;4CACtC,eAAe,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC;yCAC5C,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;4CACf,MAAM,CAAC,KAAK,CAAC,CAAC;4CACd,OAAO,CAAC,SAAS,EAAE,SAAS,CAAU,CAAC;wCAC3C,CAAC,CAAC,CAAC;wCAGH,IAAI,CAAC,IAAI,IAAI,CAAC,OAAO;4CAAE,OAAO;wCAC9B,OAAO,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;oCACtC,KAAK,KAAK;wCACN,OAAO,OAAO,CAAC;4CACX,IAAI,EAAE,eAAe,CAAC,MAAM,CAAC,IAAI,EAAE,aAAa,CAAC;4CACjD,OAAO,EAAE,eAAe,CAAC,MAAM,CAAC,OAAO,EAAE,aAAa,CAAC;yCAC1D,CAAC,CAAC;iCACV;4BACL,CAAC,CAAA,CAAC;iCACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gCACb,UAAU,CAAC,KAAK,EAAE,CAAC;gCACnB,MAAM,CAAC,KAAK,CAAC,CAAC;4BAClB,CAAC,CAAC,CAAC;wBACX,CAAC,CAAA,CAAC,CAAC;wBAGH,WAAW,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,MAAM,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC;wBACvE,OAAO,WAAW,CAAC;oBACvB,CAAC,CAAC,CAAC;iBACN;gBAAC,OAAO,KAAK,EAAE;oBACZ,WAAW,CACP,IAAI,KAAK,CACL,kEAAkE;wBAC9D,uBAAuB,MAAA,cAAc,CAAC,IAAI,mCAAI,WAAW,GAAG,EAChE,EAAE,KAAK,EAAE,KAAK,EAAE,CACnB,CACJ,CAAC;iBACL;YACL,CAAC,CAAA,CAAC,CAAC;YACP,YAAY,CAAC,MAAM,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;QAChD,CAAC;QACD,QAAQ,EAAE,GAAG,EAAE;YACX,kBAAkB,GAAG,KAAK,CAAC;QAC/B,CAAC;KACJ,CAAC;IAEF,OAAO,IAAI,eAAe,CAAC,EAAE,wBAAwB,EAAE,IAAI,EAAE,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;AACxF,CAAC,CAAC","sourcesContent":["import type { LensCore } from \"../lens-core-module/lensCore\";\nimport type { CameraKitSourceSubscriber } from \"./CameraKitSource\";\nimport { CameraKitSource } from \"./CameraKitSource\";\n\nconst getYUVImageData = async (canvas: HTMLCanvasElement, lensCore: LensCore): Promise<ImageData> => {\n    const { width, height } = canvas;\n    // A YUV buffer has lower-res UV channels, so the total number of bytes works out like so:\n    const outputBuffer = new ArrayBuffer((width * height * 3) / 2);\n    await lensCore.imageToYuvBuffer({ image: canvas, width, height, outputBuffer });\n    const pixels = new Uint8ClampedArray(outputBuffer);\n    return new ImageData(pixels, width, height);\n};\n\nconst getRGBImageData = (output: HTMLCanvasElement, imageReader2D: CanvasRenderingContext2D | null): ImageData => {\n    if (imageReader2D === null) return new ImageData(0, 0);\n    imageReader2D.drawImage(output, 0, 0);\n    return imageReader2D.getImageData(0, 0, output.width, output.height);\n};\n\nconst getImageBitmap = async (imageData: ImageData, format: FrameFormat): Promise<ImageBitmap> => {\n    switch (format) {\n        case \"nv12\":\n        case \"yuv\":\n            if (!window.VideoFrame)\n                return Promise.reject(\n                    new Error(`Cannot process frame. ImageData in ${format} is not supported by this browser.`)\n                );\n            const frame = new VideoFrame(imageData.data.buffer, {\n                format: \"NV12\",\n                codedWidth: imageData.width,\n                codedHeight: imageData.height,\n                timestamp: 0,\n            });\n            return createImageBitmap(frame);\n        case \"rgb\":\n            return createImageBitmap(imageData);\n    }\n};\n\n/** @internal */\nexport type FrameFormat = \"rgb\" | \"yuv\" | \"nv12\";\n\n/** @internal */\nexport interface FrameInput {\n    format?: FrameFormat;\n    imageData: ImageData;\n    timestampMillis: number;\n}\n\n/** @internal */\nexport interface FrameOutput {\n    live: ImageData;\n    capture: ImageData;\n}\n\n/** @internal */\nexport interface MediaSourceFunction {\n    (render: (frame: FrameInput) => Promise<FrameOutput>): Promise<void>;\n}\n\n/**\n * Function source options.\n */\nexport interface FunctionSourceOptions {\n    /**\n     * Specifies the camera type for which certain features are enabled or disabled.\n     * For example, surface tracking features are only active when the camera is set to \"environment\" mode.\n     * The default value is \"user\", which accommodates the majority of Lenses.\n     * \"user\" refers to the front-facing camera, while \"environment\" refers to the rear-facing camera.\n     */\n    cameraType: \"user\" | \"environment\";\n}\n\n/**\n * Creates a {@link CameraKitSource} from a function which provides per-frame pixel data to CameraKit.\n *\n * @param sourceFunction This function will be called in a requestAnimationFrame loop. Each time it is called, it is\n * passed a `render` function. It may call `render` and CameraKit will process the pixel data passed to `render` and\n * return a Promise of the processed pixels (along with rendering them to the normal output canvases).\n * @param options Options.\n *\n * @internal\n */\nexport const createFunctionSource = (\n    sourceFunction: MediaSourceFunction,\n    options: Partial<FunctionSourceOptions> = {}\n): CameraKitSource => {\n    let width = 0;\n    let height = 0;\n    let shouldProcessFrame = true;\n\n    // We require an auxiliary canvas that we can use to read back pixel data (unless we're in YUV mode, in which case\n    // we use LensCore to convert between formats and we don't need this canvas).\n    const imageReaderCanvas = document.createElement(\"canvas\");\n    const imageReader2D = imageReaderCanvas.getContext(\"2d\");\n\n    const subscriber: CameraKitSourceSubscriber = {\n        onAttach: (source, lensCore, reportError) => {\n            const outputs = lensCore.getOutputCanvases();\n            const output = {\n                live: outputs[lensCore.CanvasType.Preview.value],\n                capture: outputs[lensCore.CanvasType.Capture.value],\n            };\n\n            const processFrame = (source: CameraKitSource, lensCore: LensCore, reportError: (error: Error) => void) =>\n                requestAnimationFrame(async () => {\n                    if (!shouldProcessFrame) return;\n                    try {\n                        await sourceFunction(({ format, imageData, timestampMillis }) => {\n                            // TODO: with processFrame promisified, we don't really need to create a wrapper promise\n                            const frameOutput = new Promise<FrameOutput>(async (resolve, reject) => {\n                                const inputFrame = await getImageBitmap(imageData, format ?? \"rgb\");\n                                if (inputFrame.width !== width || inputFrame.height !== height) {\n                                    width = imageReaderCanvas.width = inputFrame.width;\n                                    height = imageReaderCanvas.height = inputFrame.height;\n                                    // We don't await this promise, because we want to continue to process frames and\n                                    // let LensCore manage the concurrency between setting resolution and processing a\n                                    // frame.\n                                    source.setRenderSize(width, height);\n                                }\n                                lensCore\n                                    .processFrame({ inputFrame, timestampMillis })\n                                    .then(async () => {\n                                        // Closing releases graphics resources associated with the frame, now that is\n                                        // has been processed.\n                                        inputFrame.close();\n\n                                        switch (format ?? \"rgb\") {\n                                            case \"nv12\":\n                                            case \"yuv\":\n                                                const [live, capture] = await Promise.all([\n                                                    getYUVImageData(output.live, lensCore),\n                                                    getYUVImageData(output.capture, lensCore),\n                                                ]).catch((error) => {\n                                                    reject(error);\n                                                    return [undefined, undefined] as const;\n                                                });\n                                                // if either of these is undefined, we'll have already rejected\n                                                // the promise, so we can return.\n                                                if (!live || !capture) return;\n                                                return resolve({ live, capture });\n                                            case \"rgb\":\n                                                return resolve({\n                                                    live: getRGBImageData(output.live, imageReader2D),\n                                                    capture: getRGBImageData(output.capture, imageReader2D),\n                                                });\n                                        }\n                                    })\n                                    .catch((error) => {\n                                        inputFrame.close();\n                                        reject(error);\n                                    });\n                            });\n                            // Even if there's an error processing the frame, we do want to attempt to process the next\n                            // frame. We expect `sourceFunction` to handle a rejected `frameOutput` Promise.\n                            frameOutput.finally(() => processFrame(source, lensCore, reportError));\n                            return frameOutput;\n                        });\n                    } catch (error) {\n                        reportError(\n                            new Error(\n                                \"Failure to process frame, which was not handled by the provided \" +\n                                    `MediaSourceFunction ${sourceFunction.name ?? \"anonymous\"}.`,\n                                { cause: error }\n                            )\n                        );\n                    }\n                });\n            processFrame(source, lensCore, reportError);\n        },\n        onDetach: () => {\n            shouldProcessFrame = false;\n        },\n    };\n\n    return new CameraKitSource({ useManualFrameProcessing: true }, subscriber, options);\n};\n"]}

package/dist/media-sources/ImageSource.d.ts

@@ -0,0 +1,13 @@
+import type { CameraKitDeviceOptions } from "./CameraKitSource";
+import { CameraKitSource } from "./CameraKitSource";
+/**
+ * Create a {@link CameraKitSource} from an
+ * [HTMLImageElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement).
+ *
+ * @param image Image element.
+ * @param options Options.
+ *
+ * @category Rendering
+ */
+export declare function createImageSource(image: HTMLImageElement, options?: Partial<CameraKitDeviceOptions>): CameraKitSource;
+//# sourceMappingURL=ImageSource.d.ts.map

package/dist/media-sources/ImageSource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ImageSource.d.ts","sourceRoot":"","sources":["../../src/media-sources/ImageSource.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAC7B,KAAK,EAAE,gBAAgB,EACvB,OAAO,GAAE,OAAO,CAAC,sBAAsB,CAAM,GAC9C,eAAe,CAQjB"}

package/dist/media-sources/ImageSource.js

@@ -0,0 +1,7 @@
+import { CameraKitSource } from "./CameraKitSource";
+export function createImageSource(image, options = {}) {
+    return new CameraKitSource({
+        media: image,
+    }, {}, options);
+}
+//# sourceMappingURL=ImageSource.js.map

package/dist/media-sources/ImageSource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ImageSource.js","sourceRoot":"","sources":["../../src/media-sources/ImageSource.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAWpD,MAAM,UAAU,iBAAiB,CAC7B,KAAuB,EACvB,UAA2C,EAAE;IAE7C,OAAO,IAAI,eAAe,CACtB;QACI,KAAK,EAAE,KAAK;KACf,EACD,EAAE,EACF,OAAO,CACV,CAAC;AACN,CAAC","sourcesContent":["import type { CameraKitDeviceOptions } from \"./CameraKitSource\";\nimport { CameraKitSource } from \"./CameraKitSource\";\n\n/**\n * Create a {@link CameraKitSource} from an\n * [HTMLImageElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement).\n *\n * @param image Image element.\n * @param options Options.\n *\n * @category Rendering\n */\nexport function createImageSource(\n    image: HTMLImageElement,\n    options: Partial<CameraKitDeviceOptions> = {}\n): CameraKitSource {\n    return new CameraKitSource(\n        {\n            media: image,\n        },\n        {},\n        options\n    );\n}\n"]}

package/dist/media-sources/MediaStreamSource.d.ts

@@ -0,0 +1,31 @@
+import { Transform2D } from "../transforms/Transform2D";
+import type { CameraKitDeviceOptions } from "./CameraKitSource";
+import { CameraKitSource } from "./CameraKitSource";
+/**
+ * Media stream source options.
+ *
+ * @category Rendering
+ */
+export interface MediaStreamSourceOptions extends CameraKitDeviceOptions {
+    /**
+     * Specifies the 2D transformation to apply to the Lens.
+     * By default, CameraKit applies no transformation.
+     */
+    transform: Transform2D;
+    /**
+     * Indicates whether the audio from the source should be disabled.
+     * By default, CameraKit passes audio to the Lens.
+     */
+    disableSourceAudio: boolean;
+}
+/**
+ * Create a {@link CameraKitSource} from any
+ * [MediaStream](https://developer.mozilla.org/en-US/docs/Web/API/MediaStream).
+ *
+ * @param stream Any MediaStream, such as obtained via `canvas.captureStream()` or `mediaDevices.getUserMedia()`.
+ * @param options Options.
+ *
+ * @category Rendering
+ */
+export declare function createMediaStreamSource(stream: MediaStream, options?: Partial<MediaStreamSourceOptions>): CameraKitSource;
+//# sourceMappingURL=MediaStreamSource.d.ts.map

package/dist/media-sources/MediaStreamSource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MediaStreamSource.d.ts","sourceRoot":"","sources":["../../src/media-sources/MediaStreamSource.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAExD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAChE,OAAO,EAAE,eAAe,EAAqB,MAAM,mBAAmB,CAAC;AA4CvE;;;;GAIG;AACH,MAAM,WAAW,wBAAyB,SAAQ,sBAAsB;IACpE;;;OAGG;IACH,SAAS,EAAE,WAAW,CAAC;IAEvB;;;OAGG;IACH,kBAAkB,EAAE,OAAO,CAAC;CAC/B;AAED;;;;;;;;GAQG;AACH,wBAAgB,uBAAuB,CACnC,MAAM,EAAE,WAAW,EACnB,OAAO,GAAE,OAAO,CAAC,wBAAwB,CAAM,GAChD,eAAe,CAkJjB"}