@webex/web-media-effects-types 2.28.2 → 2.30.0

package/index.d.ts

@@ -1,6 +1,6 @@
 import TypedEmitter from 'typed-emitter';
-import { IFrameInferenceResult, Generator, Quality, BlurStrength, Pipeline } from '@webex/ladon-ts';
-export { BlurStrength, Generator, Quality } from '@webex/ladon-ts';
+import { IFrameInferenceResult, Quality, BlurStrength, Pipeline } from '@webex/ladon-ts';
+export { BlurStrength, Quality } from '@webex/ladon-ts';
 import * as js_logger from 'js-logger';
 export { default as Logger } from 'js-logger';
 
@@ -261,10 +261,57 @@ declare class PluginManager {
     dispose(): void;
     getPlugin<T extends PluginType>(name: string): T | undefined;
     getPlugins(): Map<string, Plugin>;
+    getPluginCount(): number;
 }
 
 declare function debounce<F extends (...args: Parameters<F>) => ReturnType<F>>(func: F, delay: number): (...args: Parameters<F>) => void;
 
+interface DebugStats {
+    frameRate: number;
+    modelReady: boolean;
+    effectEnabled: boolean;
+    trackEnabled: boolean;
+    mode: string;
+    quality: string;
+    frameInterval: number;
+    lastFrameTime: number;
+    inputDimensions: {
+        width: number;
+        height: number;
+    };
+    outputDimensions: {
+        width: number;
+        height: number;
+    };
+    videoWidth?: number;
+    videoHeight?: number;
+    videoFrameRate?: number;
+    cpuCores: number;
+    deviceMemory?: number;
+    connectionType?: string;
+    effectiveType?: string;
+    memoryUsage?: number;
+    webglVendor?: string;
+    webglRenderer?: string;
+    maxTextureSize?: number;
+    imageCaptureActive: boolean;
+    trackProcessorActive: boolean;
+    pluginCount: number;
+    totalFrameTime?: number;
+    modelInferenceTime?: number;
+    preprocessingTime?: number;
+    postprocessingTime?: number;
+    inferenceSkipped?: boolean;
+    modelInferenceFPS?: number;
+    averageFrameTime?: number;
+    frameDrops?: number;
+    computePressure?: {
+        state: 'nominal' | 'fair' | 'serious' | 'critical';
+        source: string;
+    };
+    errors: string[];
+}
+
 declare enum VirtualBackgroundMode {
     Blur = "BLUR",
     Image = "IMAGE",
@@ -276,6 +323,7 @@ declare type LadonOverrides = {
     modelRank?: number;
     workerUri?: string;
     executionProviders?: string[];
+    generationIntervalMs?: number;
     inputSize?: {
         width: number;
         height: number;
@@ -291,7 +339,6 @@ declare type LadonOverrides = {
     modelUrlResolver?: (modelPath: string) => Promise<string>;
 };
 interface VirtualBackgroundEffectOptions extends EffectOptions {
-    generator: Generator;
     mode: VirtualBackgroundMode;
     quality: Quality;
     frameRate?: number;
@@ -324,21 +371,23 @@ declare class VirtualBackgroundEffect extends BaseCameraEffect {
     private preloadFuture?;
     private loadFuture?;
     private disposeFuture?;
+    private updateFuture?;
     private lastFrameTime;
-    private frameInterval;
     private restoreEffectOnTrackEnable;
     private setTimeoutId?;
     private rafId?;
-    private lastFrame?;
+    private lastInferenceResult?;
     private pluginManager;
     private beforeInferenceCallbacks;
     private afterInferenceCallbacks;
     private offscreenCanvas?;
     private inputCanvasContext?;
     private configBuilder;
+    private debugStatsGenerator;
     get isReady(): boolean;
     get isLoaded(): boolean;
     get frameRate(): number;
+    get frameInterval(): number;
     constructor(options?: Partial<VirtualBackgroundEffectOptions>);
     preloadAssets(): Promise<void>;
     loadMediaStream(input: MediaStream): Promise<MediaStream>;
@@ -377,6 +426,7 @@ declare class VirtualBackgroundEffect extends BaseCameraEffect {
     initializePlugins: () => void;
     getPlugin: <T extends PluginType>(name: string) => T | undefined;
     getPluginManager: () => PluginManager;
+    getStats(): DebugStats;
 }
 declare const createVirtualBackgroundEffect: (options?: VirtualBackgroundEffectOptions, preloadAssets?: boolean) => Promise<VirtualBackgroundEffect>;
 
@@ -384,6 +434,7 @@ declare abstract class BaseInferencePlugin<T, O> {
     protected core: T;
     protected options: O;
     protected isEffectEnabled: boolean;
+    protected baseInferenceCleanup?: () => void;
     isInitialized: boolean;
     constructor(options?: Partial<O>);
     initialize(effect: VirtualBackgroundEffect): void;
@@ -408,6 +459,7 @@ declare abstract class BaseEventEmitterPlugin<T extends EventEmitter<unknown>, O
 }
 
 declare abstract class BaseAfterInferencePlugin<T extends EventEmitter<unknown> = EventEmitter<unknown>, O extends object = Record<string, never>> extends BaseEventEmitterPlugin<T, O> {
+    private afterInferenceCleanup?;
     constructor(options?: Partial<O>);
     initialize(effect: VirtualBackgroundEffect): void;
     dispose(): void;
@@ -426,6 +478,76 @@ declare class BeRightBackPlugin extends BaseAfterInferencePlugin<BeRightBack, Be
 declare function getOptionsByMode(mode: BeRightBackPluginMode): BeRightBackOptions;
 declare function makeBeRightBackOptions(mode: BeRightBackPluginMode, coreOptions?: Partial<BeRightBackOptions>): BeRightBackOptions;
 
+interface DebugOverlayCoreOptions {
+    showOnInit?: boolean;
+    updateInterval?: number;
+    maxErrors?: number;
+}
+interface DebugOverlayPluginOptions {
+    debug?: boolean;
+    coreOptions?: DebugOverlayCoreOptions;
+}
+declare const DEFAULT_DEBUG_OVERLAY_OPTIONS: DebugOverlayPluginOptions;
+
+declare class DebugOverlay extends EventEmitter<unknown> {
+    private getStats?;
+    private overlay?;
+    private statsContainer?;
+    private header?;
+    private resizeHandle?;
+    private sectionsCreated;
+    private sectionElements;
+    private effect?;
+    private pressureObserver?;
+    private isVisible;
+    private options;
+    private isResizing;
+    private startX;
+    private startY;
+    private startWidth;
+    private startHeight;
+    private updateInterval?;
+    private dom;
+    private styles;
+    private stats;
+    constructor(options?: Partial<DebugOverlayCoreOptions>);
+    show(): void;
+    hide(): void;
+    toggle(): void;
+    get visible(): boolean;
+    setStatsProvider(getStatsCallback: () => DebugStats): void;
+    private updateDisplayStats;
+    private showStatsError;
+    private hideStatsError;
+    private startUpdateInterval;
+    private stopUpdateInterval;
+    static getDefaultStats(): DebugStats;
+    private createOverlay;
+    private createStatsSections;
+    private renderStats;
+    private updateSectionContent;
+    private resetSections;
+    private setupKeyboardListener;
+    private setupPerformanceMonitoring;
+    private setupDragToMove;
+    private setupResizeHandlers;
+    dispose(): void;
+}
+
+declare class DebugOverlayPlugin extends BaseAfterInferencePlugin<DebugOverlay, DebugOverlayPluginOptions> {
+    protected getDefaultOptions(): DebugOverlayPluginOptions;
+    protected createCore(): DebugOverlay;
+    protected onCoreCreated(): void;
+    initialize(effect: VirtualBackgroundEffect): void;
+    getDebugOverlay(): DebugOverlay;
+    show(): void;
+    hide(): void;
+    toggle(): void;
+    get visible(): boolean;
+    onAfterInference(timestamp: number, inferenceResult?: IFrameInferenceResult): Promise<void>;
+    dispose(): void;
+}
+
 interface FrameSkipperOptions {
     baseMinSkipTime: number;
     baseMaxSkipTime: number;
@@ -515,6 +637,7 @@ interface RateEstimatedValues {
     rate?: number;
     status: RateEstimatorStatus;
     threshold: number;
+    targetRate: number;
 }
 interface RateEstimatorOptions {
     hysteresisMargin: number;
@@ -522,6 +645,7 @@ interface RateEstimatorOptions {
     lowThreshold: number;
     minSamples: number;
     maxSamples: number;
+    targetRate: number;
 }
 declare enum RateEstimatorEvent {
     RateOk = "rate-ok",
@@ -567,9 +691,11 @@ declare class RateEstimationPlugin extends BaseAfterInferencePlugin<RateEstimato
     onEffectEnabled(): void;
     destroyCore(): void;
     onAfterInference(timestamp: number): Promise<void>;
+    onOptionsUpdated(): void;
     getRate(): number | undefined;
     getThreshold(): number | undefined;
     getStatus(): RateEstimatorStatus | undefined;
+    getTargetRate(): number | undefined;
 }
 
 declare class SkippedFrameRatePlugin extends BaseAfterInferencePlugin {
@@ -584,4 +710,4 @@ declare class SkippedFrameRatePlugin extends BaseAfterInferencePlugin {
 declare const logger: js_logger.ILogger;
 //# sourceMappingURL=logger.d.ts.map
 
-export { AdaptiveFrameSkipper, BaseCameraEffect, BaseEffect, BaseMicrophoneEffect, BeRightBack, BeRightBackAction, BeRightBackDebugInfo, BeRightBackEvent, BeRightBackEventCallback, BeRightBackOptions, BeRightBackPlugin, BeRightBackPluginMode, BeRightBackPluginOptions, BeRightBackState, DEFAULT_FRAME_RATE, EffectEnv, EffectEvent, EffectEventCallback, EffectOptions, EffectState, FrameSkipperDebugInfo, FrameSkipperInferenceReason, FrameSkipperOptions, FrameSkipperPlugin, FrameSkipperPluginMode, FrameSkipperPluginOptions, GainEffect, LadonOverrides, MediaStreamOrTrack, NoiseReductionEffect, NoiseReductionEffectOptions, NoiseReductionMode, RateEstimatedValues, RateEstimationPlugin, RateEstimationPluginOptions, RateEstimator, RateEstimatorEvent, RateEstimatorEventCallback, RateEstimatorOptions, RateEstimatorStatus, SkippedFrameRatePlugin, TrackEffect, VirtualBackgroundEffect, VirtualBackgroundEffectOptions, VirtualBackgroundMode, createEffect, createNoiseReductionEffect, createVirtualBackgroundEffect, getOptionsByMode, logger, makeBeRightBackOptions, makeFrameSkipperOptions };
+export { AdaptiveFrameSkipper, BaseCameraEffect, BaseEffect, BaseMicrophoneEffect, BeRightBack, BeRightBackAction, BeRightBackDebugInfo, BeRightBackEvent, BeRightBackEventCallback, BeRightBackOptions, BeRightBackPlugin, BeRightBackPluginMode, BeRightBackPluginOptions, BeRightBackState, DEFAULT_DEBUG_OVERLAY_OPTIONS, DEFAULT_FRAME_RATE, DebugOverlay, DebugOverlayCoreOptions, DebugOverlayPlugin, DebugOverlayPluginOptions, EffectEnv, EffectEvent, EffectEventCallback, EffectOptions, EffectState, FrameSkipperDebugInfo, FrameSkipperInferenceReason, FrameSkipperOptions, FrameSkipperPlugin, FrameSkipperPluginMode, FrameSkipperPluginOptions, GainEffect, LadonOverrides, MediaStreamOrTrack, NoiseReductionEffect, NoiseReductionEffectOptions, NoiseReductionMode, RateEstimatedValues, RateEstimationPlugin, RateEstimationPluginOptions, RateEstimator, RateEstimatorEvent, RateEstimatorEventCallback, RateEstimatorOptions, RateEstimatorStatus, SkippedFrameRatePlugin, TrackEffect, VirtualBackgroundEffect, VirtualBackgroundEffectOptions, VirtualBackgroundMode, createEffect, createNoiseReductionEffect, createVirtualBackgroundEffect, getOptionsByMode, logger, makeBeRightBackOptions, makeFrameSkipperOptions };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/web-media-effects-types",
-  "version": "2.28.2",
+  "version": "2.30.0",
   "description": "TypeScript definitions for @webex/web-media-effects",
   "main": "",
   "types": "index.d.ts",