68 lines
2.5 KiB
Markdown
68 lines
2.5 KiB
Markdown
# whisper-rs
|
|
|
|
Rust bindings to [whisper.cpp](https://github.com/ggerganov/whisper.cpp/)
|
|
|
|
## Usage
|
|
```rust
|
|
use whisper_rs::{WhisperContext, FullParams, SamplingStrategy};
|
|
|
|
fn main() {
|
|
// load a context and model
|
|
let mut ctx = WhisperContext::new("path/to/model").expect("failed to load model");
|
|
|
|
// create a params object
|
|
let mut params = FullParams::new(SamplingStrategy::Greedy { best_of: 1 });
|
|
|
|
// assume we have a buffer of audio data
|
|
// here we'll make a fake one, floating point samples, 32 bit, 16KHz, mono
|
|
let audio_data = vec![0_f32; 16000 * 2];
|
|
|
|
// now we can run the model
|
|
let state = ctx.create_state().expect("failed to create state");
|
|
ctx.full(&state, params, &audio_data[..])
|
|
.expect("failed to run model");
|
|
|
|
// fetch the results
|
|
let num_segments = ctx
|
|
.full_n_segments(&state)
|
|
.expect("failed to get number of segments");
|
|
for i in 0..num_segments {
|
|
let segment = ctx
|
|
.full_get_segment_text(&state, i)
|
|
.expect("failed to get segment");
|
|
let start_timestamp = ctx
|
|
.full_get_segment_t0(&state, i)
|
|
.expect("failed to get segment start timestamp");
|
|
let end_timestamp = ctx
|
|
.full_get_segment_t1(&state, i)
|
|
.expect("failed to get segment end timestamp");
|
|
println!("[{} - {}]: {}", start_timestamp, end_timestamp, segment);
|
|
}
|
|
}
|
|
```
|
|
|
|
See [examples/basic_use.rs](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.
|
|
|
|
## Building
|
|
|
|
See [BUILDING.md](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 this 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](LICENSE)
|
|
|
|
tl;dr: public domain
|