#whisper #bindings #cpp-bindings #flags #model #gpu #open-blas

sys whisper-rs-sys

Rust bindings for whisper.cpp (FFI bindings)

18 releases (10 breaking)

0.11.0 Nov 6, 2024
0.9.0 Apr 6, 2024
0.8.0 Nov 27, 2023
0.6.1 Jun 18, 2023
0.2.0 Oct 29, 2022

#352 in Audio

Download history 321/week @ 2024-07-27 320/week @ 2024-08-03 337/week @ 2024-08-10 303/week @ 2024-08-17 421/week @ 2024-08-24 445/week @ 2024-08-31 407/week @ 2024-09-07 596/week @ 2024-09-14 396/week @ 2024-09-21 401/week @ 2024-09-28 210/week @ 2024-10-05 169/week @ 2024-10-12 301/week @ 2024-10-19 186/week @ 2024-10-26 583/week @ 2024-11-02 215/week @ 2024-11-09

1,307 downloads per month
Used in 8 crates (via whisper-rs)

Unlicense

3MB
60K SLoC

C 34K SLoC // 0.1% comments Rust 7.5K SLoC // 0.0% comments C++ 7K SLoC // 0.1% comments Metal Shading Language 5K SLoC // 0.0% comments Objective-C 3K SLoC // 0.1% comments CUDA 2.5K SLoC // 0.1% comments Objective-C++ 52 SLoC // 0.1% comments

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
use whisper_rs::{WhisperContext, WhisperContextParameters, FullParams, SamplingStrategy};

fn main() {
	let path_to_model = std::env::args().nth(1).unwrap();

	// load a context and model
	let ctx = WhisperContext::new_with_params(
		path_to_model,
		WhisperContextParameters::default()
	).expect("failed to load model");

	// create a params object
	let 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 mut state = ctx.create_state().expect("failed to create state");
	state
		.full(params, &audio_data[..])
		.expect("failed to run model");

	// fetch the results
	let num_segments = state
		.full_n_segments()
		.expect("failed to get number of segments");
	for i in 0..num_segments {
		let segment = state
			.full_get_segment_text(i)
			.expect("failed to get segment");
		let start_timestamp = state
			.full_get_segment_t0(i)
			.expect("failed to get segment start timestamp");
		let end_timestamp = state
			.full_get_segment_t1(i)
			.expect("failed to get segment end timestamp");
		println!("[{} - {}]: {}", start_timestamp, end_timestamp, segment);
	}
}

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.
  • whisper-cpp-log: allows hooking into whisper.cpp's log output and sending it to the log backend. Requires calling
  • whisper-cpp-tracing: 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

Dependencies

~0–2.2MB
~44K SLoC