@ai-coustics/aic-sdk 0.6.3 → 0.10.0

package/{LICENSE.AIC-SDK → LICENSE.AIC_SDK}

@@ -3,8 +3,8 @@ Version 1.0 — 30 September 2025
 Copyright © 2025 ai-coustics GmbH. All rights reserved.
 
 0.  Definitions
-    “SDK”       means the files distributed inside the `sdk` folder
-                sdk/lib/* (e.g. libaic.a, libaic.so, libaic.dylib, aic.dll)
+    “SDK”       means the binaries downloaded during the build process
+	            (e.g. libaic.a, libaic.so, libaic.dylib, aic.dll)
                 together with the public C header aic.h.
     “Wrapper”   means the source code in this repository that links to
                 the SDK. The Wrapper is licensed separately under the

package/README.md

@@ -1,107 +1,74 @@
 # ai-coustics Speech Enhancement SDK for Node.js
 
-Welcome to the ai-coustics SDK! This repository provides the native JavaScript/TypeScript bindings to run our powerful real-time speech enhancement in your Node.js applications.
+Node.js bindings for the ai-coustics Speech Enhancement SDK.
 
-## What is this SDK?
+## Prerequisites
 
-Our Speech Enhancement SDK delivers state-of-the-art speech-enhancement in real-time, enabling you to build applications that remove noise and reverb from speech signals.
+- SDK license key from [ai-coustics Developer Portal](https://developers.ai-coustics.io)
 
-## Quick Start
-
-### Acquire an SDK License Key
-
-You need an **SDK license key**. This is distinct from the API license key used for our cloud API services. To obtain an SDK license key, please contact us at [info@ai-coustics.com](mailto:info@ai-coustics.com)
-
-### Installation
+## Installation
 
 ```bash
 npm install @ai-coustics/aic-sdk
 ```
 
-The SDK binaries will be automatically downloaded during installation for your platform.
-
 ### Supported Platforms
 
-- macOS (x64, ARM64)
-- Linux (x64, ARM64)
-- Windows (x64)
+- Linux: x64, ARM64 (GNU libc)
+- macOS: x64, ARM64
+- Windows: x64, ARM64 (MSVC)
 
-### Example Code
+## Example
 
 ```javascript
-import { Model, ModelType, Parameter, AudioConfig } from '@ai-coustics/aic-sdk';
-
-const model = new Model(ModelType.QUAIL_L48, "YOUR_LICENSE_KEY");
+const { Model, ModelType, EnhancementParameter } = require('@ai-coustics/aic-sdk');
 
-const config: AudioConfig = {
-  sampleRate: model.getOptimalSampleRate(),
-  numChannels: 2,
-  numFrames: model.getOptimalNumFrames()
-};
+const model = new Model(ModelType.QuailS48, process.env.AIC_SDK_LICENSE);
 
-model.initialize(config);
+// Get optimal settings
+const sampleRate = model.optimalSampleRate();
+const numFrames = model.optimalNumFrames(sampleRate);
 
-// Adjust parameters
-model.setParameter(Parameter.ENHANCEMENT_LEVEL, 0.9);
-model.setParameter(Parameter.VOICE_GAIN, 1.2);
+// Initialize for stereo audio
+model.initialize(sampleRate, 2, numFrames, false);
 
-// Planar layout (separate buffers)
-const leftChannel = new Float32Array(480);
-const rightChannel = new Float32Array(480);
-model.processPlanar([leftChannel, rightChannel], 2, 480);
+// Set enhancement parameters
+model.setParameter(EnhancementParameter.EnhancementLevel, 0.7);
+model.setParameter(EnhancementParameter.VoiceGain, 1.5);
 
-// Or interleaved layout
-const interleavedBuffer = new Float32Array(2 * 480);
-model.processInterleaved(interleavedBuffer, 2, 480);
+// Process interleaved audio
+const interleavedBuffer = new Float32Array(2 * numFrames);
+model.processInterleaved(interleavedBuffer, 2, numFrames);
 
-model.destroy();
+// Or process planar audio
+const planarBuffers = [
+  new Float32Array(numFrames), // Left channel
+  new Float32Array(numFrames), // Right channel
+];
+model.processPlanar(planarBuffers);
 ```
 
-## Support & Resources
-
-## Documentation
-
-- [JavaScript Example](examples/example.js)
-- [TypeScript Example](examples/example.ts)
-- [Function Reference](src/index.ts)
-- [C-SDK-Reference](https://github.com/ai-coustics/aic-sdk-c/blob/HEAD/sdk-reference.md)
-
-### Looking for Other Languages?
-
-The ai-coustics Speech Enhancement SDK is available in multiple programming languages to fit your development needs:
+## Links
 
-| Platform | Repository | Description |
-|----------|------------|-------------|
-| **C** | [aic-sdk-c](https://github.com/ai-coustics/aic-sdk-c) | Core C interface and foundation library |
-| **C++** | [`aic-sdk-cpp`](https://github.com/ai-coustics/aic-sdk-cpp) | Modern C++ interface with RAII and type safety |
-| **Python** | [`aic-sdk-py`](https://github.com/ai-coustics/aic-sdk-py) | Idiomatic Python interface |
-| **Rust** | [`aic-sdk-rs`](https://github.com/ai-coustics/aic-sdk-rs) | Safe Rust bindings with zero-cost abstractions |
-| **Web (WASM)** | [`aic-sdk-wasm`](https://github.com/ai-coustics/aic-sdk-wasm) | WebAssembly build for browser applications |
+- [Example Usage](examples/basic.js)
+- [API Reference](index.js)
+- [C SDK Reference](https://github.com/ai-coustics/aic-sdk-c/blob/HEAD/sdk-reference.md)
+- [Documentation](https://docs.ai-coustics.com/)
+- [Issues](https://github.com/ai-coustics/aic-sdk-node/issues)
 
+### Other SDKs
 
-## Demo Plugin
-
-Experience our speech enhancement models firsthand with our Demo Plugin - a complete audio plugin that showcases all available models while serving as a comprehensive C++ integration example.
-
-| Platform | Repository | Description |
-|----------|------------|-------------|
-| **Demo Plugin** | [`aic-sdk-plugin`](https://github.com/ai-coustics/aic-sdk-plugin) | Audio plugin with real-time model comparison and C++ integration reference |
-
-### Get Help
-
-- Documentation: [docs.ai-coustics.com](https://docs.ai-coustics.com/)
-- Issues: [GitHub Issues](https://github.com/ai-coustics/aic-sdk-node/issues)
-- Email: [info@ai-coustics.com](mailto:info@ai-coustics.com)
+| Platform | Repository |
+|----------|------------|
+| **C** | [aic-sdk-c](https://github.com/ai-coustics/aic-sdk-c) |
+| **C++** | [aic-sdk-cpp](https://github.com/ai-coustics/aic-sdk-cpp) |
+| **Python** | [aic-sdk-py](https://github.com/ai-coustics/aic-sdk-py) |
+| **Rust** | [aic-sdk-rs](https://github.com/ai-coustics/aic-sdk-rs) |
+| **Web (WASM)** | [aic-sdk-wasm](https://github.com/ai-coustics/aic-sdk-wasm) |
+| **Demo Plugin** | [aic-sdk-plugin](https://github.com/ai-coustics/aic-sdk-plugin) |
 
 ## License
 
-This project uses a dual-license structure:
-
-- **Node.js Wrapper Code** (source files in this repository): Licensed under the Apache License 2.0. See [LICENSE](LICENSE) for details.
-- **AIC SDK Binaries** (files in `sdk/lib/*` and `aic.h`): Licensed under the proprietary AIC-SDK Binary License Agreement. See [LICENSE.AIC-SDK](LICENSE.AIC-SDK) for details.
-
-When you use this package, both licenses apply to their respective components.
-
----
-
-Made with ❤️ by the ai-coustics team
+Dual-licensed:
+- Node.js wrapper code: Apache License 2.0
+- AIC SDK binaries: Proprietary AIC-SDK Binary License Agreement

package/index.js

@@ -0,0 +1,235 @@
+// Platform-specific binary loader
+let native;
+try {
+  // Try to load platform-specific binary from optional dependencies
+  const platform = process.platform;
+  const arch = process.arch;
+
+  const platformPackages = {
+    "linux-x64": "@ai-coustics/aic-sdk-linux-x64-gnu",
+    "linux-arm64": "@ai-coustics/aic-sdk-linux-arm64-gnu",
+    "darwin-x64": "@ai-coustics/aic-sdk-darwin-x64",
+    "darwin-arm64": "@ai-coustics/aic-sdk-darwin-arm64",
+    "win32-x64": "@ai-coustics/aic-sdk-win32-x64-msvc",
+    "win32-arm64": "@ai-coustics/aic-sdk-win32-arm64-msvc",
+  };
+
+  const platformKey = `${platform}-${arch}`;
+  const platformPackage = platformPackages[platformKey];
+
+  if (platformPackage) {
+    try {
+      native = require(platformPackage);
+    } catch (e) {
+      // Fall back to local binary
+      native = require("./index.node");
+    }
+  } else {
+    // Fall back to local binary
+    native = require("./index.node");
+  }
+} catch (e) {
+  throw new Error(
+    `Failed to load native binary for platform ${process.platform}-${process.arch}. ` +
+      `Supported platforms: Linux (x64/ARM64, GNU libc), macOS (x64/ARM64), Windows (x64/ARM64, MSVC). ` +
+      `Error: ${e.message}`,
+  );
+}
+
+/**
+ * Model types available in the SDK
+ */
+const ModelType = {
+  QuailL48: "QuailL48",
+  QuailL16: "QuailL16",
+  QuailL8: "QuailL8",
+  QuailS48: "QuailS48",
+  QuailS16: "QuailS16",
+  QuailS8: "QuailS8",
+  QuailXS: "QuailXS",
+  QuailXXS: "QuailXXS",
+  QuailSTT: "QuailSTT",
+};
+
+/**
+ * Enhancement parameters
+ */
+const EnhancementParameter = {
+  Bypass: native.ENHANCEMENT_PARAM_BYPASS,
+  EnhancementLevel: native.ENHANCEMENT_PARAM_ENHANCEMENT_LEVEL,
+  VoiceGain: native.ENHANCEMENT_PARAM_VOICE_GAIN,
+};
+
+/**
+ * VAD (Voice Activity Detection) parameters
+ */
+const VadParameter = {
+  LookbackBufferSize: native.VAD_PARAM_LOOKBACK_BUFFER_SIZE,
+  Sensitivity: native.VAD_PARAM_SENSITIVITY,
+};
+
+/**
+ * Voice Activity Detector
+ */
+class Vad {
+  constructor(nativeVad) {
+    this._vad = nativeVad;
+  }
+
+  /**
+   * Check if speech is detected
+   * @returns {boolean}
+   */
+  isSpeechDetected() {
+    return native.vadIsSpeechDetected(this._vad);
+  }
+
+  /**
+   * Set a VAD parameter
+   * @param {number} parameter - Parameter constant from VadParameter
+   * @param {number} value - Parameter value
+   * @throws {Error} If parameter setting fails (invalid parameter, out of range, etc.)
+   */
+  setParameter(parameter, value) {
+    native.vadSetParameter(this._vad, parameter, value);
+  }
+
+  /**
+   * Get a VAD parameter value
+   * @param {number} parameter - Parameter constant from VadParameter
+   * @returns {number}
+   */
+  getParameter(parameter) {
+    return native.vadGetParameter(this._vad, parameter);
+  }
+}
+
+/**
+ * AI-Coustics audio enhancement model
+ */
+class Model {
+  /**
+   * Create a new model instance
+   * @param {string} modelType - Model type from ModelType enum
+   * @param {string} licenseKey - SDK license key
+   * @throws {Error} If model creation fails (invalid license, unsupported model type, etc.)
+   */
+  constructor(modelType, licenseKey) {
+    this._model = native.modelNew(modelType, licenseKey);
+  }
+
+  /**
+   * Get the optimal sample rate for this model
+   * @returns {number} Sample rate in Hz
+   */
+  optimalSampleRate() {
+    return native.modelOptimalSampleRate(this._model);
+  }
+
+  /**
+   * Get the optimal number of frames for a given sample rate
+   * @param {number} sampleRate - Sample rate in Hz
+   * @returns {number} Number of frames
+   */
+  optimalNumFrames(sampleRate) {
+    return native.modelOptimalNumFrames(this._model, sampleRate);
+  }
+
+  /**
+   * Initialize the model with audio configuration
+   * @param {number} sampleRate - Sample rate in Hz
+   * @param {number} numChannels - Number of audio channels
+   * @param {number} numFrames - Number of frames per process call
+   * @param {boolean} allowVariableFrames - Allow variable frame counts
+   * @throws {Error} If initialization fails (invalid parameters)
+   */
+  initialize(sampleRate, numChannels, numFrames, allowVariableFrames = false) {
+    native.modelInitialize(
+      this._model,
+      sampleRate,
+      numChannels,
+      numFrames,
+      allowVariableFrames,
+    );
+  }
+
+  /**
+   * Get the output delay in samples
+   * @returns {number} Delay in samples
+   */
+  outputDelay() {
+    return native.modelOutputDelay(this._model);
+  }
+
+  /**
+   * Reset the model's internal state
+   */
+  reset() {
+    native.modelReset(this._model);
+  }
+
+  /**
+   * Set an enhancement parameter
+   * @param {number} parameter - Parameter constant from EnhancementParameter
+   * @param {number} value - Parameter value
+   * @throws {Error} If parameter setting fails (invalid parameter, out of range, etc)
+   */
+  setParameter(parameter, value) {
+    native.modelSetParameter(this._model, parameter, value);
+  }
+
+  /**
+   * Get an enhancement parameter value
+   * @param {number} parameter - Parameter constant from EnhancementParameter
+   * @returns {number}
+   */
+  getParameter(parameter) {
+    return native.modelGetParameter(this._model, parameter);
+  }
+
+  /**
+   * Process interleaved audio (all channels mixed in one buffer)
+   * @param {Float32Array} buffer - Interleaved audio buffer
+   * @param {number} numChannels - Number of channels
+   * @param {number} numFrames - Number of frames
+   * @throws {Error} If processing fails (model not initialized, invalid buffer size, etc.)
+   */
+  processInterleaved(buffer, numChannels, numFrames) {
+    native.modelProcessInterleaved(this._model, buffer, numChannels, numFrames);
+  }
+
+  /**
+   * Process planar audio (separate buffer for each channel)
+   * @param {Float32Array[]} buffers - Array of audio buffers, one per channel (max 16 channels)
+   * @throws {Error} If processing fails (model not initialized, too many channels, invalid buffer size, etc.)
+   */
+  processPlanar(buffers) {
+    native.modelProcessPlanar(this._model, buffers);
+  }
+
+  /**
+   * Create a Voice Activity Detector for this model
+   * @returns {Vad}
+   */
+  createVad() {
+    const nativeVad = native.modelCreateVad(this._model);
+    return new Vad(nativeVad);
+  }
+}
+
+/**
+ * Get the SDK version
+ * @returns {string}
+ */
+function getVersion() {
+  return native.getVersion();
+}
+
+module.exports = {
+  Model,
+  Vad,
+  ModelType,
+  EnhancementParameter,
+  VadParameter,
+  getVersion,
+};

package/package.json

@@ -1,60 +1,48 @@
 {
   "name": "@ai-coustics/aic-sdk",
-  "version": "0.6.3",
-  "description": "Node.js bindings for ai-coustics speech enhancement SDK",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "version": "0.10.0",
+  "description": "Node.js package of ai-coustics SDK",
+  "main": "index.js",
   "scripts": {
-    "install": "node scripts/download-sdk.js && node-gyp rebuild",
-    "build": "tsc",
-    "prepare": "npm run build",
-    "test": "node test-basic.js",
-    "test:full": "node test-basic.js && npm run example:js && npm run example:ts",
-    "example:js": "node examples/example.js",
-    "example:ts": "npx ts-node examples/example.ts",
-    "example:ts-compile": "tsc examples/example.ts --outDir examples && node examples/example.js",
-    "clean": "rm -rf build dist sdk"
+    "test": "node examples/basic.js",
+    "build": "cargo build --release && cp target/release/libaic_sdk_node.so index.node 2>/dev/null || cp target/release/libaic_sdk_node.dylib index.node 2>/dev/null || cp target/release/aic_sdk_node.dll index.node 2>/dev/null || true",
+    "debug": "cargo build && cp target/debug/libaic_sdk_node.so index.node 2>/dev/null || cp target/debug/libaic_sdk_node.dylib index.node 2>/dev/null || cp target/debug/aic_sdk_node.dll index.node 2>/dev/null || true",
+    "version:update": "bash scripts/update-version.sh",
+    "prepublishOnly": "echo 'Use GitHub Actions to publish. See PUBLISHING.md for details.' && exit 1"
   },
+  "author": "ai-coustics GmbH",
+  "license": "Apache-2.0",
   "keywords": [
     "audio",
     "speech",
-    "enhancement",
     "voice",
+    "agent",
     "ai-coustics"
   ],
-  "author": "ai-coustics GmbH",
-  "license": "SEE LICENSE IN LICENSE",
+  "homepage": "https://github.com/ai-coustics/aic-sdk-node#readme",
+  "bugs": {
+    "url": "https://github.com/ai-coustics/aic-sdk-node/issues"
+  },
   "repository": {
     "type": "git",
-    "url": "https://github.com/ai-coustics/aic-sdk-node.git"
+    "url": "git+https://github.com/ai-coustics/aic-sdk-node.git"
   },
-  "engines": {
-    "node": ">=14.0.0"
-  },
-  "os": [
-    "darwin",
-    "linux",
-    "win32"
-  ],
-  "cpu": [
-    "x64",
-    "arm64"
+  "type": "commonjs",
+  "files": [
+    "index.js",
+    "index.node",
+    "README.md",
+    "LICENSE"
   ],
-  "dependencies": {
-    "node-addon-api": "^7.0.0",
-    "node-gyp": "^10.0.0",
-    "tar": "^6.2.0"
+  "optionalDependencies": {
+    "@ai-coustics/aic-sdk-linux-x64-gnu": "0.10.0",
+    "@ai-coustics/aic-sdk-linux-arm64-gnu": "0.10.0",
+    "@ai-coustics/aic-sdk-darwin-x64": "0.10.0",
+    "@ai-coustics/aic-sdk-darwin-arm64": "0.10.0",
+    "@ai-coustics/aic-sdk-win32-x64-msvc": "0.10.0",
+    "@ai-coustics/aic-sdk-win32-arm64-msvc": "0.10.0"
   },
   "devDependencies": {
-    "@types/node": "^20.0.0",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.0.0"
-  },
-  "files": [
-    "dist",
-    "binding.gyp",
-    "scripts",
-    "src/binding.cc"
-  ],
-  "gypfile": true
+    "@neon-rs/cli": "0.1.82"
+  }
 }

package/binding.gyp

@@ -1,52 +0,0 @@
-{
-  "targets": [
-    {
-      "target_name": "aic_binding",
-      "sources": ["src/binding.cc"],
-      "include_dirs": [
-        "<!@(node -p \"require('node-addon-api').include\")",
-        "sdk/include"
-      ],
-      "dependencies": [
-        "<!(node -p \"require('node-addon-api').gyp\")"
-      ],
-      "defines": ["NAPI_DISABLE_CPP_EXCEPTIONS"],
-      "conditions": [
-        ["OS=='linux'", {
-          "libraries": [
-            "<(module_root_dir)/sdk/lib/libaic.so"
-          ],
-          "ldflags": [
-            "-Wl,-rpath,<(module_root_dir)/sdk/lib"
-          ]
-        }],
-        ["OS=='mac'", {
-          "libraries": [
-            "../sdk/lib/libaic.dylib"
-          ],
-          "xcode_settings": {
-            "OTHER_LDFLAGS": [
-              "-Wl,-rpath,@loader_path/../../sdk/lib"
-            ]
-          }
-        }],
-        ["OS=='win'", {
-          "libraries": [
-            "../sdk/lib/aic.lib",
-            "ntdll.lib"
-          ],
-          "copies": [
-            {
-              "destination": "<(module_root_dir)/build/Release/",
-              "files": ["<(module_root_dir)/sdk/lib/aic.dll"]
-            }
-          ]
-        }]
-      ],
-      "cflags!": ["-fno-exceptions"],
-      "cflags_cc!": ["-fno-exceptions"],
-      "cflags": ["-fPIC"],
-      "cflags_cc": ["-fPIC"]
-    }
-  ]
-}