20 releases (12 breaking)

new 0.13.2 Nov 22, 2024
0.12.0 Nov 6, 2024
0.11.1 Apr 6, 2024
0.10.0 Nov 27, 2023
0.2.0 Oct 29, 2022

#33 in Machine learning

Download history 337/week @ 2024-08-02 325/week @ 2024-08-09 321/week @ 2024-08-16 369/week @ 2024-08-23 505/week @ 2024-08-30 389/week @ 2024-09-06 575/week @ 2024-09-13 403/week @ 2024-09-20 398/week @ 2024-09-27 217/week @ 2024-10-04 179/week @ 2024-10-11 304/week @ 2024-10-18 173/week @ 2024-10-25 568/week @ 2024-11-01 246/week @ 2024-11-08 163/week @ 2024-11-15

1,212 downloads per month
Used in 8 crates (6 directly)

Unlicense

5MB
97K SLoC

C++ 35K SLoC // 0.1% comments C 34K SLoC // 0.1% comments CUDA 8K SLoC // 0.0% comments Rust 7K SLoC // 0.0% comments Metal Shading Language 5.5K SLoC // 0.0% comments GLSL 3.5K SLoC // 0.0% comments Objective-C 3.5K SLoC // 0.1% comments Objective-C++ 51 SLoC // 0.0% comments Python 40 SLoC // 0.3% 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.3MB
~46K SLoC