ContextQMD
Back to Eliza

silero-vad-cpp

packages/native/plugins/silero-vad-cpp/README.md

2.0.13.1 KB
Original Source

silero-vad-cpp

Standalone C library + GGUF conversion script that ports snakers4/silero-vad's small LSTM-based voice-activity classifier (~1.7M parameters, ~2 MB) to the elizaOS/llama.cpp fork's ggml dispatcher. The output replaces plugins/plugin-local-inference/src/services/voice/vad.ts's ONNX path and lets the runtime drop the onnxruntime-node dependency from the voice front-end.

Today the model entry points are a stub: silero_vad_open, silero_vad_reset_state, silero_vad_process, and silero_vad_close in src/silero_vad_stub.c all return -ENOSYS. Two companion TUs are real and exercised by ctest already:

  • src/silero_vad_state.c — LSTM hidden / cell state container with reset + promote helpers.
  • src/silero_vad_resample.c — linear PCM resampler so callers at 8 / 22.05 / 44.1 kHz can normalize to the model's 16 kHz input.

The full port plan — upstream pin, GGUF conversion approach, fork integration steps, replacement path for the TS adapter — lives in AGENTS.md. Read that before changing anything in this directory.

Build

cmake -B build -S packages/native/plugins/silero-vad-cpp
cmake --build build -j
ctest --test-dir build --output-on-failure

Output: libsilero_vad.a plus silero_vad_stub_smoke (build-only ABI smoke), silero_vad_state_test (LSTM state helpers — real behaviour), and silero_vad_resample_test (linear PCM resampler — real behaviour). All three pass on the dev host.

GGUF conversion

The conversion script is a documented skeleton; the TODO blocks in scripts/silero_vad_to_gguf.py call out the exact work the real conversion has to do. To run the skeleton (it raises NotImplementedError until the TODO blocks are filled in):

python scripts/silero_vad_to_gguf.py \
    --weights /path/to/silero_vad.jit-or-onnx \
    --output  /path/to/silero_vad.gguf

Canonical upstream model location:

https://github.com/snakers4/silero-vad/blob/master/src/silero_vad/data/silero_vad.onnx

The conversion script records the pinned upstream commit in the GGUF metadata key silero_vad.upstream_commit; the runtime refuses to load any GGUF whose pin doesn't match the header's expected commit.

Layout

include/silero_vad/silero_vad.h   Public C ABI (frozen — see AGENTS.md).
src/silero_vad_stub.c             ENOSYS stub for the model entry points.
src/silero_vad_state.[ch]         LSTM hidden/cell state helpers (real).
src/silero_vad_resample.c         Linear PCM resampler (real).
scripts/silero_vad_to_gguf.py     Skeleton converter; TODO blocks documented.
test/silero_vad_stub_smoke.c      Build-only ABI smoke for the stub.
test/silero_vad_state_test.c      Real test for the state helpers.
test/silero_vad_resample_test.c   Real test for the linear resampler.
CMakeLists.txt                    Builds libsilero_vad + the three tests.

License

MIT — matches snakers4/silero-vad's license. The pinned upstream commit recorded in scripts/silero_vad_to_gguf.py is the source of the weights this library ships against.