Skip to main content

tauri_plugin_whisper_core/
lib.rs

1//! `tauri-plugin-whisper-core` — Offline, real-time Speech-to-Text for Tauri v2.
2//!
3//! This plugin wraps [whisper.cpp](https://github.com/ggerganov/whisper.cpp)
4//! (via [`whisper-rs`]) to provide streaming transcription with hardware
5//! acceleration (CUDA / Metal / CoreML), Silero VAD, and Pyannote Speaker Diarization.
6//!
7//! # Quick Start
8//!
9//! ```rust,ignore
10//! tauri::Builder::default()
11//!     .plugin(tauri_plugin_whisper_core::init())
12//!     .run(tauri::generate_context!())
13//!     .expect("error while running tauri application");
14//! ```
15
16mod asr_backend;
17mod backends;
18mod commands;
19mod download;
20mod error;
21pub mod state;
22mod mel;
23mod worker;
24mod recording_worker;
25
26#[cfg(feature = "diarization")]
27pub mod diarization;
28
29pub mod sck;
30pub mod vad;
31
32pub use asr_backend::{AsrBackend, TranscriptSegment};
33pub use error::{Result, WhisperError};
34pub use state::{
35    AudioChannel, AudioContext, DiarizedResultPayload, DiarizedSegmentPayload,
36    DownloadProgressPayload, FinalResultPayload, PartialResultPayload,
37    SegmentPayload, WhisperPluginState, RecordingTranscribeProgressPayload,
38};
39pub use recording_worker::{RecordingTranscript, RecordingTranscriptSegment};
40
41use tauri::{
42    plugin::{Builder, TauriPlugin},
43    Manager, Runtime,
44};
45
46/// Initialises the whisper-core plugin.
47///
48/// Call this from your Tauri builder:
49/// ```rust,ignore
50/// tauri::Builder::default()
51///     .plugin(tauri_plugin_whisper_core::init())
52///     // …
53/// ```
54pub fn init<R: Runtime>() -> TauriPlugin<R> {
55    Builder::new("whisper-core")
56        .invoke_handler(tauri::generate_handler![
57            commands::load_model,
58            commands::start_stream,
59            commands::push_audio_chunk,
60            commands::stop_stream,
61            commands::download_model,
62            commands::download_diarization_models,
63            commands::download_silero_vad_model,
64            commands::load_vad_model,
65            commands::get_downloaded_models,
66            commands::list_backends,
67            // Diarization (compiled in when feature is enabled, no-ops otherwise)
68            commands::load_diarization_model,
69            commands::set_diarization_threshold,
70            commands::merge_speakers,
71            commands::get_voice_profiles,
72            commands::delete_voice_profile,
73            commands::clear_voice_profiles,
74            commands::rename_voice_profile,
75            // ScreenCaptureKit
76            commands::check_screen_capture_permission,
77            commands::request_screen_capture_permission,
78            commands::list_capturable_apps,
79            commands::start_sck_capture,
80            commands::stop_sck_capture,
81            // Record-then-transcribe
82            commands::start_recording,
83            commands::push_recording_chunk,
84            commands::stop_recording,
85            commands::transcribe_recording,
86            commands::list_recordings,
87            commands::delete_recording,
88        ])
89        .setup(|app, _api| {
90            app.manage(WhisperPluginState::default());
91            Ok(())
92        })
93        .build()
94}