aic-sdk 0.6.3

ai-coustics Speech Enhancement SDK
docs.rs failed to build aic-sdk-0.6.3
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.

ai-coustics Speech Enhancement SDK for Rust

What is this SDK?

Our Speech Enhancement SDK delivers state-of-the-art audio processing capabilities, enabling you to enhance speech clarity and intelligibility in real-time.

Quick Start

Acquire an SDK License Key

To use the SDK, you'll need a license key. Contact our team to receive your time-limited demo key:

Once you have your license key, set it as an environment variable or pass it directly to the SDK initialization functions.

Integration

Enable the download-lib feature to automatically download the library when building the crate.

[dependencies]
aic-sdk = { version = "0.6.3", features = ["download-lib"] }

If you want to provide your own library, use the AIC_LIB_PATH environment variable to specify the path to the directory where the library is located.

Example Usage

use aic_sdk::{Model, ModelType, Parameter};

let license_key = std::env::var("AIC_SDK_LICENSE")?;

// Create a speech enhancement model by selecting a model type
// and passing your license key as an &str
let mut model = Model::new(ModelType::QuailS48, &license_key)?;

// Initialize the model with your audio settings
model.initialize(48000, 1, 480)?;

let mut audio_buffer = vec![0.0f32; 480];

// The process function is where the actual enhancement is happening
// This is meant to be called in your real-time audio thread
model.process_interleaved(&mut audio_buffer, 1, 480)?;

// You can also adjust parameters during processing
model.set_parameter(Parameter::EnhancementLevel, 0.8)?;

// For planar audio processing (separate channel buffers)
let mut audio = vec![vec![0.0f32; 480]; 2]; // 2 channels, 480 frames each
let mut audio_refs: Vec<&mut [f32]> = audio.iter_mut().map(|ch| ch.as_mut_slice()).collect();
model.initialize(48000, 2, 480)?;
model.process_planar(&mut audio_refs)?;

Running the Example

To run the example, make sure you have set your license key as an environment variable:

export AIC_SDK_LICENSE="your_license_key_here"

Then use the following commands to configure, build and run the example:

cargo run --example basic_usage --features download-lib

Compatibility

This crate currently builds on Linux and macOS. Windows is not yet supported.

Support & Resources

Documentation

Looking for Other Languages?

The ai-coustics Speech Enhancement SDK is available in multiple programming languages to fit your development needs:

Language Repository Description
C aic-sdk-c Core C interface and foundation library
C++ aic-sdk-cpp C++ interface
Node.js aic-sdk-node JavaScript/TypeScript bindings for Node.js
Python aic-sdk-py Pythonic interface
WebAssembly aic-sdk-wasm Browser-compatible WebAssembly build

All SDKs provide the same core functionality with language-specific optimizations and idioms.

Get Help

Need assistance? We're here to support you:

License

This Rust wrapper is distributed under the Apache 2.0 license, while the core C SDK is distributed under the proprietary AIC-SDK license.

Made with ❤️ by the ai-coustics team