@picovoice/eagle-web 0.2.0 → 2.0.0

package/src/eagle_profiler_worker.ts

@@ -1,5 +1,5 @@
 /*
-  Copyright 2023 Picovoice Inc.
+  Copyright 2023-2025 Picovoice Inc.
 
   You may not use this file except in compliance with the license. A copy of the license is located in the "LICENSE"
   file accompanying this source.
@@ -15,11 +15,13 @@ import {
   EagleModel,
   EagleProfile,
   EagleProfilerEnrollResult,
+  EagleProfilerOptions,
   EagleProfilerWorkerEnrollResponse,
   EagleProfilerWorkerExportResponse,
   EagleProfilerWorkerInitResponse,
   EagleProfilerWorkerReleaseResponse,
   EagleProfilerWorkerResetResponse,
+  PvStatus,
 } from './types';
 import { loadModel } from '@picovoice/web-utils';
 import { pvStatusToException } from "./eagle_errors";
@@ -30,9 +32,12 @@ export class EagleProfilerWorker {
   private readonly _sampleRate: number;
   private readonly _version: string;
 
-  private static _wasm: string;
   private static _wasmSimd: string;
-  private static _sdk: string = "web";
+  private static _wasmSimdLib: string;
+  private static _wasmPThread: string;
+  private static _wasmPThreadLib: string;
+
+  private static _sdk: string = 'web';
 
   private constructor(
     worker: Worker,
@@ -68,22 +73,42 @@ export class EagleProfilerWorker {
   }
 
   /**
-   * Set base64 wasm file.
-   * @param wasm Base64'd wasm file to use to initialize wasm.
+   * Set base64 wasm file with SIMD feature.
+   * @param wasmSimd Base64'd wasm SIMD file to use to initialize wasm.
    */
-  public static setWasm(wasm: string): void {
-    if (this._wasm === undefined) {
-      this._wasm = wasm;
+  public static setWasmSimd(wasmSimd: string): void {
+    if (this._wasmSimd === undefined) {
+      this._wasmSimd = wasmSimd;
     }
   }
 
   /**
-   * Set base64 wasm file with SIMD feature.
-   * @param wasmSimd Base64'd wasm file to use to initialize wasm.
+   * Set base64 wasm file with SIMD feature in text format.
+   * @param wasmSimdLib Base64'd wasm SIMD file in text format.
    */
-  public static setWasmSimd(wasmSimd: string): void {
-    if (this._wasmSimd === undefined) {
-      this._wasmSimd = wasmSimd;
+  public static setWasmSimdLib(wasmSimdLib: string): void {
+    if (this._wasmSimdLib === undefined) {
+      this._wasmSimdLib = wasmSimdLib;
+    }
+  }
+
+  /**
+   * Set base64 wasm file with SIMD and pthread feature.
+   * @param wasmPThread Base64'd wasm file to use to initialize wasm.
+   */
+  public static setWasmPThread(wasmPThread: string): void {
+    if (this._wasmPThread === undefined) {
+      this._wasmPThread = wasmPThread;
+    }
+  }
+
+  /**
+   * Set base64 SIMD and thread wasm file in text format.
+   * @param wasmPThreadLib Base64'd wasm file in text format.
+   */
+  public static setWasmPThreadLib(wasmPThreadLib: string): void {
+    if (this._wasmPThreadLib === undefined) {
+      this._wasmPThreadLib = wasmPThreadLib;
     }
   }
 
@@ -102,12 +127,19 @@ export class EagleProfilerWorker {
    * Set to a different name to use multiple models across `eagle` instances.
    * @param model.forceWrite Flag to overwrite the model in storage even if it exists.
    * @param model.version Version of the model file. Increment to update the model file in storage.
+   * @param options Optional configuration arguments.
+   * @param options.device String representation of the device (e.g., CPU or GPU) to use. If set to `best`, the most
+   * suitable device is selected automatically. If set to `gpu`, the engine uses the first available GPU device. To select a specific
+   * GPU device, set this argument to `gpu:${GPU_INDEX}`, where `${GPU_INDEX}` is the index of the target GPU. If set to
+   * `cpu`, the engine will run on the CPU with the default number of threads. To specify the number of threads, set this
+   * argument to `cpu:${NUM_THREADS}`, where `${NUM_THREADS}` is the desired number of threads.
    *
    * @return An instance of the Eagle Profiler.
    */
   public static async create(
     accessKey: string,
-    model: EagleModel
+    model: EagleModel,
+    options: EagleProfilerOptions = {}
   ): Promise<EagleProfilerWorker> {
     const customWritePath = model.customWritePath
       ? model.customWritePath
@@ -135,11 +167,22 @@ export class EagleProfilerWorker {
               break;
             case 'failed':
             case 'error':
-              reject(pvStatusToException(event.data.status, event.data.shortMessage, event.data.messageStack));
+              reject(
+                pvStatusToException(
+                  event.data.status,
+                  event.data.shortMessage,
+                  event.data.messageStack
+                )
+              );
               break;
             default:
-              // @ts-ignore
-              reject(pvStatusToException(PvStatus.RUNTIME_ERROR, `Unrecognized command: ${event.data.command}`));
+              reject(
+                pvStatusToException(
+                  PvStatus.RUNTIME_ERROR,
+                  // @ts-ignore
+                  `Unrecognized command: ${event.data.command}`
+                )
+              );
           }
         };
       }
@@ -149,8 +192,11 @@ export class EagleProfilerWorker {
       command: 'init',
       accessKey: accessKey,
       modelPath: modelPath,
-      wasm: this._wasm,
+      options: options,
       wasmSimd: this._wasmSimd,
+      wasmSimdLib: this._wasmSimdLib,
+      wasmPThread: this._wasmPThread,
+      wasmPThreadLib: this._wasmPThreadLib,
       sdk: this._sdk,
     });
 
@@ -194,11 +240,22 @@ export class EagleProfilerWorker {
               break;
             case 'failed':
             case 'error':
-              reject(pvStatusToException(event.data.status, event.data.shortMessage, event.data.messageStack));
+              reject(
+                pvStatusToException(
+                  event.data.status,
+                  event.data.shortMessage,
+                  event.data.messageStack
+                )
+              );
               break;
             default:
-              // @ts-ignore
-              reject(pvStatusToException(PvStatus.RUNTIME_ERROR, `Unrecognized command: ${event.data.command}`));
+              reject(
+                pvStatusToException(
+                  PvStatus.RUNTIME_ERROR,
+                  // @ts-ignore
+                  `Unrecognized command: ${event.data.command}`
+                )
+              );
           }
         };
       }
@@ -230,11 +287,22 @@ export class EagleProfilerWorker {
               break;
             case 'failed':
             case 'error':
-              reject(pvStatusToException(event.data.status, event.data.shortMessage, event.data.messageStack));
+              reject(
+                pvStatusToException(
+                  event.data.status,
+                  event.data.shortMessage,
+                  event.data.messageStack
+                )
+              );
               break;
             default:
-              // @ts-ignore
-              reject(pvStatusToException(PvStatus.RUNTIME_ERROR, `Unrecognized command: ${event.data.command}`));
+              reject(
+                pvStatusToException(
+                  PvStatus.RUNTIME_ERROR,
+                  // @ts-ignore
+                  `Unrecognized command: ${event.data.command}`
+                )
+              );
           }
         };
       }
@@ -261,11 +329,22 @@ export class EagleProfilerWorker {
             break;
           case 'failed':
           case 'error':
-            reject(pvStatusToException(event.data.status, event.data.shortMessage, event.data.messageStack));
+            reject(
+              pvStatusToException(
+                event.data.status,
+                event.data.shortMessage,
+                event.data.messageStack
+              )
+            );
             break;
           default:
-            // @ts-ignore
-            reject(pvStatusToException(PvStatus.RUNTIME_ERROR, `Unrecognized command: ${event.data.command}`));
+            reject(
+              pvStatusToException(
+                PvStatus.RUNTIME_ERROR,
+                // @ts-ignore
+                `Unrecognized command: ${event.data.command}`
+              )
+            );
         }
       };
     });
@@ -290,11 +369,22 @@ export class EagleProfilerWorker {
             break;
           case 'failed':
           case 'error':
-            reject(pvStatusToException(event.data.status, event.data.shortMessage, event.data.messageStack));
+            reject(
+              pvStatusToException(
+                event.data.status,
+                event.data.shortMessage,
+                event.data.messageStack
+              )
+            );
             break;
           default:
-            // @ts-ignore
-            reject(pvStatusToException(PvStatus.RUNTIME_ERROR, `Unrecognized command: ${event.data.command}`));
+            reject(
+              pvStatusToException(
+                PvStatus.RUNTIME_ERROR,
+                // @ts-ignore
+                `Unrecognized command: ${event.data.command}`
+              )
+            );
         }
       };
     });

package/src/eagle_profiler_worker_handler.ts

@@ -1,5 +1,5 @@
 /*
-  Copyright 2023 Picovoice Inc.
+  Copyright 2023-2025 Picovoice Inc.
   You may not use this file except in compliance with the license. A copy of the license is located in the "LICENSE"
   file accompanying this source.
   Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
@@ -32,10 +32,16 @@ const initRequest = async (
     };
   }
   try {
-    EagleProfiler.setWasm(request.wasm);
     EagleProfiler.setWasmSimd(request.wasmSimd);
+    EagleProfiler.setWasmSimdLib(request.wasmSimdLib);
+    EagleProfiler.setWasmPThread(request.wasmPThread);
+    EagleProfiler.setWasmPThreadLib(request.wasmPThreadLib);
     EagleProfiler.setSdk(request.sdk);
-    profiler = await EagleProfiler._init(request.accessKey, request.modelPath);
+    profiler = await EagleProfiler._init(
+      request.accessKey,
+      request.modelPath,
+      request.options
+    );
     return {
       command: 'ok',
       minEnrollSamples: profiler.minEnrollSamples,

package/src/eagle_worker.ts

@@ -1,5 +1,5 @@
 /*
-  Copyright 2023 Picovoice Inc.
+  Copyright 2023-2025 Picovoice Inc.
 
   You may not use this file except in compliance with the license. A copy of the license is located in the "LICENSE"
   file accompanying this source.
@@ -13,11 +13,13 @@ import PvWorker from 'web-worker:./eagle_worker_handler.ts';
 
 import {
   EagleModel,
+  EagleOptions,
   EagleWorkerProcessResponse,
   EagleWorkerInitResponse,
   EagleWorkerReleaseResponse,
   EagleWorkerResetResponse,
   EagleProfile,
+  PvStatus,
 } from './types';
 import { loadModel } from '@picovoice/web-utils';
 import { pvStatusToException } from "./eagle_errors";
@@ -28,9 +30,12 @@ export class EagleWorker {
   private readonly _sampleRate: number;
   private readonly _version: string;
 
-  private static _wasm: string;
   private static _wasmSimd: string;
-  private static _sdk: string = "web";
+  private static _wasmSimdLib: string;
+  private static _wasmPThread: string;
+  private static _wasmPThreadLib: string;
+
+  private static _sdk: string = 'web';
 
   private constructor(
     worker: Worker,
@@ -66,22 +71,42 @@ export class EagleWorker {
   }
 
   /**
-   * Set base64 wasm file.
-   * @param wasm Base64'd wasm file to use to initialize wasm.
+   * Set base64 wasm file with SIMD feature.
+   * @param wasmSimd Base64'd wasm SIMD file to use to initialize wasm.
    */
-  public static setWasm(wasm: string): void {
-    if (this._wasm === undefined) {
-      this._wasm = wasm;
+  public static setWasmSimd(wasmSimd: string): void {
+    if (this._wasmSimd === undefined) {
+      this._wasmSimd = wasmSimd;
     }
   }
 
   /**
-   * Set base64 wasm file with SIMD feature.
-   * @param wasmSimd Base64'd wasm file to use to initialize wasm.
+   * Set base64 wasm file with SIMD feature in text format.
+   * @param wasmSimdLib Base64'd wasm SIMD file in text format.
    */
-  public static setWasmSimd(wasmSimd: string): void {
-    if (this._wasmSimd === undefined) {
-      this._wasmSimd = wasmSimd;
+  public static setWasmSimdLib(wasmSimdLib: string): void {
+    if (this._wasmSimdLib === undefined) {
+      this._wasmSimdLib = wasmSimdLib;
+    }
+  }
+
+  /**
+   * Set base64 wasm file with SIMD and pthread feature.
+   * @param wasmPThread Base64'd wasm file to use to initialize wasm.
+   */
+  public static setWasmPThread(wasmPThread: string): void {
+    if (this._wasmPThread === undefined) {
+      this._wasmPThread = wasmPThread;
+    }
+  }
+
+  /**
+   * Set base64 SIMD and thread wasm file in text format.
+   * @param wasmPThreadLib Base64'd wasm file in text format.
+   */
+  public static setWasmPThreadLib(wasmPThreadLib: string): void {
+    if (this._wasmPThreadLib === undefined) {
+      this._wasmPThreadLib = wasmPThreadLib;
     }
   }
 
@@ -101,13 +126,20 @@ export class EagleWorker {
    * @param model.forceWrite Flag to overwrite the model in storage even if it exists.
    * @param model.version Version of the model file. Increment to update the model file in storage.
    * @param speakerProfiles One or more Eagle speaker profiles. These can be constructed using `EagleProfiler`.
+   * @param options Optional configuration arguments.
+   * @param options.device String representation of the device (e.g., CPU or GPU) to use. If set to `best`, the most
+   * suitable device is selected automatically. If set to `gpu`, the engine uses the first available GPU device. To select a specific
+   * GPU device, set this argument to `gpu:${GPU_INDEX}`, where `${GPU_INDEX}` is the index of the target GPU. If set to
+   * `cpu`, the engine will run on the CPU with the default number of threads. To specify the number of threads, set this
+   * argument to `cpu:${NUM_THREADS}`, where `${NUM_THREADS}` is the desired number of threads.
    *
    * @return An instance of the Eagle engine.
    */
   public static async create(
     accessKey: string,
     model: EagleModel,
-    speakerProfiles: EagleProfile[] | EagleProfile
+    speakerProfiles: EagleProfile[] | EagleProfile,
+    options: EagleOptions = {}
   ): Promise<EagleWorker> {
     const customWritePath = model.customWritePath
       ? model.customWritePath
@@ -135,11 +167,22 @@ export class EagleWorker {
               break;
             case 'failed':
             case 'error':
-              reject(pvStatusToException(event.data.status, event.data.shortMessage, event.data.messageStack));
+              reject(
+                pvStatusToException(
+                  event.data.status,
+                  event.data.shortMessage,
+                  event.data.messageStack
+                )
+              );
               break;
             default:
-              // @ts-ignore
-              reject(pvStatusToException(PvStatus.RUNTIME_ERROR, `Unrecognized command: ${event.data.command}`));
+              reject(
+                pvStatusToException(
+                  PvStatus.RUNTIME_ERROR,
+                  // @ts-ignore
+                  `Unrecognized command: ${event.data.command}`
+                )
+              );
           }
         };
       }
@@ -152,8 +195,11 @@ export class EagleWorker {
       speakerProfiles: !Array.isArray(speakerProfiles)
         ? [speakerProfiles]
         : speakerProfiles,
-      wasm: this._wasm,
+      options: options,
       wasmSimd: this._wasmSimd,
+      wasmSimdLib: this._wasmSimdLib,
+      wasmPThread: this._wasmPThread,
+      wasmPThreadLib: this._wasmPThreadLib,
       sdk: this._sdk,
     });
 
@@ -181,11 +227,22 @@ export class EagleWorker {
             break;
           case 'failed':
           case 'error':
-            reject(pvStatusToException(event.data.status, event.data.shortMessage, event.data.messageStack));
+            reject(
+              pvStatusToException(
+                event.data.status,
+                event.data.shortMessage,
+                event.data.messageStack
+              )
+            );
             break;
           default:
-            // @ts-ignore
-            reject(pvStatusToException(PvStatus.RUNTIME_ERROR, `Unrecognized command: ${event.data.command}`));
+            reject(
+              pvStatusToException(
+                PvStatus.RUNTIME_ERROR,
+                // @ts-ignore
+                `Unrecognized command: ${event.data.command}`
+              )
+            );
         }
       };
     });
@@ -213,11 +270,22 @@ export class EagleWorker {
             break;
           case 'failed':
           case 'error':
-            reject(pvStatusToException(event.data.status, event.data.shortMessage, event.data.messageStack));
+            reject(
+              pvStatusToException(
+                event.data.status,
+                event.data.shortMessage,
+                event.data.messageStack
+              )
+            );
             break;
           default:
-            // @ts-ignore
-            reject(pvStatusToException(PvStatus.RUNTIME_ERROR, `Unrecognized command: ${event.data.command}`));
+            reject(
+              pvStatusToException(
+                PvStatus.RUNTIME_ERROR,
+                // @ts-ignore
+                `Unrecognized command: ${event.data.command}`
+              )
+            );
         }
       };
     });
@@ -242,11 +310,22 @@ export class EagleWorker {
             break;
           case 'failed':
           case 'error':
-            reject(pvStatusToException(event.data.status, event.data.shortMessage, event.data.messageStack));
+            reject(
+              pvStatusToException(
+                event.data.status,
+                event.data.shortMessage,
+                event.data.messageStack
+              )
+            );
             break;
           default:
-            // @ts-ignore
-            reject(pvStatusToException(PvStatus.RUNTIME_ERROR, `Unrecognized command: ${event.data.command}`));
+            reject(
+              pvStatusToException(
+                PvStatus.RUNTIME_ERROR,
+                // @ts-ignore
+                `Unrecognized command: ${event.data.command}`
+              )
+            );
         }
       };
     });

package/src/eagle_worker_handler.ts

@@ -1,5 +1,5 @@
 /*
-  Copyright 2023 Picovoice Inc.
+  Copyright 2023-2025 Picovoice Inc.
   You may not use this file except in compliance with the license. A copy of the license is located in the "LICENSE"
   file accompanying this source.
   Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
@@ -30,13 +30,16 @@ const initRequest = async (request: EagleWorkerInitRequest): Promise<any> => {
     };
   }
   try {
-    Eagle.setWasm(request.wasm);
     Eagle.setWasmSimd(request.wasmSimd);
+    Eagle.setWasmSimdLib(request.wasmSimdLib);
+    Eagle.setWasmPThread(request.wasmPThread);
+    Eagle.setWasmPThreadLib(request.wasmPThreadLib);
     Eagle.setSdk(request.sdk);
     eagle = await Eagle._init(
       request.accessKey,
       request.modelPath,
-      request.speakerProfiles
+      request.speakerProfiles,
+      request.options
     );
     return {
       command: 'ok',

package/src/index.ts

@@ -5,9 +5,11 @@ import * as EagleErrors from './eagle_errors';
 
 import {
   EagleModel,
+  EagleOptions,
   EagleProfile,
   EagleProfilerEnrollFeedback,
   EagleProfilerEnrollResult,
+  EagleProfilerOptions,
   EagleProfilerWorkerEnrollRequest,
   EagleProfilerWorkerEnrollResponse,
   EagleProfilerWorkerExportRequest,
@@ -34,26 +36,39 @@ import {
   EagleWorkerResponse,
 } from './types';
 
-import eagleWasm from '../lib/pv_eagle.wasm';
-import eagleWasmSimd from '../lib/pv_eagle_simd.wasm';
+import eagleWasmSimd from './lib/pv_eagle_simd.wasm';
+import eagleWasmSimdLib from './lib/pv_eagle_simd.txt';
+import eagleWasmPThread from './lib/pv_eagle_pthread.wasm';
+import eagleWasmPThreadLib from './lib/pv_eagle_pthread.txt';
 
-Eagle.setWasm(eagleWasm);
 Eagle.setWasmSimd(eagleWasmSimd);
-EagleWorker.setWasm(eagleWasm);
+Eagle.setWasmSimdLib(eagleWasmSimdLib);
+Eagle.setWasmPThread(eagleWasmPThread);
+Eagle.setWasmPThreadLib(eagleWasmPThreadLib);
 EagleWorker.setWasmSimd(eagleWasmSimd);
-EagleProfiler.setWasm(eagleWasm);
+EagleWorker.setWasmSimdLib(eagleWasmSimdLib);
+EagleWorker.setWasmPThread(eagleWasmPThread);
+EagleWorker.setWasmPThreadLib(eagleWasmPThreadLib);
+
 EagleProfiler.setWasmSimd(eagleWasmSimd);
-EagleProfilerWorker.setWasm(eagleWasm);
+EagleProfiler.setWasmSimdLib(eagleWasmSimdLib);
+EagleProfiler.setWasmPThread(eagleWasmPThread);
+EagleProfiler.setWasmPThreadLib(eagleWasmPThreadLib);
 EagleProfilerWorker.setWasmSimd(eagleWasmSimd);
+EagleProfilerWorker.setWasmSimdLib(eagleWasmSimdLib);
+EagleProfilerWorker.setWasmPThread(eagleWasmPThread);
+EagleProfilerWorker.setWasmPThreadLib(eagleWasmPThreadLib);
 
 export {
   Eagle,
   EagleErrors,
   EagleModel,
+  EagleOptions,
   EagleProfile,
   EagleProfiler,
   EagleProfilerEnrollFeedback,
   EagleProfilerEnrollResult,
+  EagleProfilerOptions,
   EagleProfilerWorker,
   EagleProfilerWorkerEnrollRequest,
   EagleProfilerWorkerEnrollResponse,

package/src/types.ts

@@ -1,5 +1,5 @@
 /*
-  Copyright 2023 Picovoice Inc.
+  Copyright 2023-2025 Picovoice Inc.
 
   You may not use this file except in compliance with the license. A copy of the license is located in the "LICENSE"
   file accompanying this source.
@@ -44,6 +44,16 @@ export type EagleProfile = {
   bytes: Uint8Array;
 };
 
+export type EagleOptions = {
+  /** @defaultValue `best` */
+  device?: string;
+};
+
+export type EagleProfilerOptions = {
+  /** @defaultValue `best` */
+  device?: string;
+};
+
 export type EagleProfilerEnrollResult = {
   feedback: EagleProfilerEnrollFeedback;
   percentage: number;
@@ -53,8 +63,11 @@ export type EagleProfilerWorkerInitRequest = {
   command: 'init';
   accessKey: string;
   modelPath: string;
-  wasm: string;
+  options: EagleProfilerOptions;
   wasmSimd: string;
+  wasmSimdLib: string;
+  wasmPThread: string;
+  wasmPThreadLib: string;
   sdk: string;
 };
 
@@ -136,8 +149,11 @@ export type EagleWorkerInitRequest = {
   accessKey: string;
   modelPath: string;
   speakerProfiles: EagleProfile[];
-  wasm: string;
+  options: EagleOptions;
   wasmSimd: string;
+  wasmSimdLib: string;
+  wasmPThread: string;
+  wasmPThreadLib: string;
   sdk: string;
 };
 

package/tsconfig.json

@@ -15,8 +15,8 @@
     "sourceMap": true,
     "strict": true,
     "target": "esnext",
-    "types": ["node"]
+    "types": ["node", "emscripten"]
   },
   "include": ["src", "module.d.ts"],
-  "exclude": ["node_modules"]
+  "exclude": ["node_modules", "src/lib"]
 }