crispasr-sys 0.8.29

Raw FFI bindings to CrispASR — auto-builds libcrispasr from source via cmake, or links a pre-installed copy if CRISPASR_LIB_DIR is set.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

# crispasr-sys

Raw FFI bindings for [CrispASR](https://github.com/CrispStrobe/CrispASR) — lightweight on-device speech recognition via ggml.

This crate is the raw `extern "C"` FFI shim. Its `build.rs` builds `libcrispasr`
from source with cmake by default, or links a pre-built copy when
`CRISPASR_LIB_DIR` is set.

## Install

On [crates.io](https://crates.io/crates/crispasr-sys). `build.rs` needs either
the CrispASR C/C++ sources (to cmake `libcrispasr`) or a pre-built copy. To
build from source, depend via git so the sources are present:

```toml
[dependencies]
crispasr-sys = { git = "https://github.com/CrispStrobe/CrispASR" }
```

To use the crates.io release you must link a **pre-built** library, since the
package does not vendor the sources — build/install it and set the linker path:

```toml
[dependencies]
crispasr-sys = "0.8"
```

```bash
git clone https://github.com/CrispStrobe/CrispASR
cd CrispASR && cmake -B build && cmake --build build -j && sudo cmake --install build
export CRISPASR_LIB_DIR=/path/to/lib   # e.g. /usr/local/lib
```

### Prebuilt release bundle (no build)

The [Releases](https://github.com/CrispStrobe/CrispASR/releases) page ships
relocatable `libcrispasr-<platform>[-cuda|-vulkan].tar.gz` bundles. Extract one
and point **`CRISPASR_SYS_LIB_DIR`** at its root — `build.rs` finds the import
lib and skips cmake. The bundle's tag must match the crate version (ABI); the
`-cuda`/`-vulkan` bundles carry the matching ggml backend libraries.

**Linux / macOS** — libs are flattened into `lib/`:

```bash
export CRISPASR_SYS_LIB_DIR=/path/to/libcrispasr-linux-x86_64
# runtime (if the rpath doesn't resolve after moving the bundle):
export LD_LIBRARY_PATH=$CRISPASR_SYS_LIB_DIR/lib:$LD_LIBRARY_PATH
```

**Windows** — import libs live under `src\Release\` (+ `ggml\src\Release\`) and
the DLLs under `bin\`, so set the linker dir *and* put `bin\` on `PATH` for
runtime:

```powershell
$env:CRISPASR_SYS_LIB_DIR = "C:\path\to\crispasr"    # the folder with include\, src\, bin\
$env:PATH = "C:\path\to\crispasr\bin;$env:PATH"       # crispasr.dll + ggml*.dll + cublas/cudart
cargo build
```

The legacy `libwhisper` alias also works:

```bash
export CRISPASR_LIB_NAME=whisper
```

For the safe high-level wrapper see the [`crispasr`](https://crates.io/crates/crispasr) crate.

## License

MIT — see [LICENSE](LICENSE).