whisper-rs

MIGRATED

This repository has been migrated to Codeberg and this repository will recieve no more updates in the future. Open all future issues and PRs there.

whisper-rs itself remains maintaned at https://codeberg.org/tazz4843/whisper-rs with no plans to discontinue it.

Why'd you do this?

This blogpost is a good summary of my reasons. I recommend reading through it, but a tl;dr: I don't want to deal with GitHub's new GenAI bullshit features that result in more work than they "save", on top of their questionable licensing for a public domain project such as whisper-rs.

Unlike most people who would be maintaining similar libraries, I am opposed to GenAI and similar "tools". They do nothing besides wasting time and scarce natural resources that could be put to much better use otherwise.

whisper-rs

Rust bindings to whisper.cpp

Usage

git clone --recursive https://github.com/tazz4843/whisper-rs.git

cd whisper-rs

cargo run --example basic_use

cargo run --example audio_transcription

…

See examples/basic_use.rs for more details.

Lower level bindings are exposed if needed, but the above should be enough for most use cases. See the docs: https://docs.rs/whisper-rs/ for more details.

Feature flags

All disabled by default unless otherwise specified.

• raw-api: expose whisper-rs-sys without having to pull it in as a dependency. NOTE: enabling this no longer guarantees semver compliance, as whisper-rs-sys may be upgraded to a breaking version in a patch release of whisper-rs.
• cuda: enable CUDA support. Implicitly enables hidden GPU flag at runtime.
• hipblas: enable ROCm/hipBLAS support. Only available on linux. Implicitly enables hidden GPU flag at runtime.
• openblas: enable OpenBLAS support.
• metal: enable Metal support. Implicitly enables hidden GPU flag at runtime.
• vulkan: enable Vulkan support. Implicitly enables hidden GPU flag at runtime.
• log_backend: allows hooking into whisper.cpp's log output and sending it to the log backend. Requires calling
• tracing_backend: allows hooking into whisper.cpp's log output and sending it to the tracing backend.

Building

See BUILDING.md for instructions for building whisper-rs on Windows and OSX M1. Linux builds should just work out of the box.

Troubleshooting

• Something other than Windows/macOS/Linux isn't working!
  • I don't have a way to test these platforms, so I can't really help you.
    • If you can get it working, please open a PR with any changes to make it work and build instructions in BUILDING.md!
• I get a panic during binding generation build!
  • You can attempt to fix it yourself, or you can set the WHISPER_DONT_GENERATE_BINDINGS environment variable. This skips attempting to build the bindings whatsoever and copies the existing ones. They may be out of date, but it's better than nothing.
    • WHISPER_DONT_GENERATE_BINDINGS=1 cargo build
  • If you can fix the issue, please open a PR!

License

Unlicense

tl;dr: public domain