aumate 0.2.8

Cross-platform desktop automation library with GUI support
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
//! Whisper transcription engine (Candle-based)
//!
//! Provides speech-to-text transcription using Whisper via Candle ML framework.

use super::audio::AudioData;
use crate::error::{AumateError, Result};
use crate::ml::{Device, DeviceConfig, get_device};
use byteorder::{ByteOrder, LittleEndian};
use candle_core::{DType, Tensor};
use candle_nn::VarBuilder;
use candle_transformers::models::whisper::{self as m, Config};
use std::path::{Path, PathBuf};
use std::time::Instant;
use tokenizers::Tokenizer;

/// Pre-computed mel filter coefficients for 80 mel bins
const MEL_FILTERS_80: &[u8] = include_bytes!("melfilters.bytes");
/// Pre-computed mel filter coefficients for 128 mel bins
const MEL_FILTERS_128: &[u8] = include_bytes!("melfilters128.bytes");

/// Whisper model variant
pub enum WhisperModel {
    Normal(m::model::Whisper),
    // Quantized variant could be added later
}

impl WhisperModel {
    /// Run encoder forward pass
    pub fn encoder_forward(&mut self, mel: &Tensor, flush: bool) -> Result<Tensor> {
        match self {
            Self::Normal(model) => model
                .encoder
                .forward(mel, flush)
                .map_err(|e| AumateError::Other(format!("Encoder forward failed: {}", e))),
        }
    }

    /// Run decoder forward pass
    pub fn decoder_forward(
        &mut self,
        tokens: &Tensor,
        audio_features: &Tensor,
        flush: bool,
    ) -> Result<Tensor> {
        match self {
            Self::Normal(model) => {
                let decoder_output = model
                    .decoder
                    .forward(tokens, audio_features, flush)
                    .map_err(|e| AumateError::Other(format!("Decoder forward failed: {}", e)))?;
                // Project to vocabulary logits
                model
                    .decoder
                    .final_linear(&decoder_output)
                    .map_err(|e| AumateError::Other(format!("Final linear failed: {}", e)))
            }
        }
    }

    /// Reset KV cache
    #[allow(dead_code)]
    pub fn reset_kv_cache(&mut self) {
        match self {
            Self::Normal(model) => model.reset_kv_cache(),
        }
    }
}

/// Result of a transcription
#[derive(Debug, Clone)]
pub struct TranscriptionResult {
    /// Transcribed text
    pub text: String,
    /// Detected or specified language
    pub language: Option<String>,
    /// Transcription duration in milliseconds
    pub duration_ms: u64,
}

/// Whisper transcription engine using Candle
pub struct WhisperEngine {
    /// The loaded model
    model: Option<WhisperModel>,
    /// Model configuration
    config: Option<Config>,
    /// Tokenizer
    tokenizer: Option<Tokenizer>,
    /// Mel filters for audio processing
    mel_filters: Vec<f32>,
    /// Device to run inference on
    device: Device,
    /// Path to the loaded model
    model_path: Option<PathBuf>,
    /// Language to use for transcription (None = auto-detect)
    language: Option<String>,
}

impl WhisperEngine {
    /// Create a new Whisper engine (no model loaded)
    pub fn new() -> Self {
        let device = get_device(&DeviceConfig::with_gpu()).unwrap_or(Device::Cpu);
        Self {
            model: None,
            config: None,
            tokenizer: None,
            mel_filters: Vec::new(),
            device,
            model_path: None,
            language: None,
        }
    }

    /// Create a new Whisper engine with specific device config
    pub fn with_device(config: DeviceConfig) -> Result<Self> {
        let device = get_device(&config)?;
        Ok(Self {
            model: None,
            config: None,
            tokenizer: None,
            mel_filters: Vec::new(),
            device,
            model_path: None,
            language: None,
        })
    }

    /// Load a Whisper model from directory containing model files
    ///
    /// The directory should contain:
    /// - model.safetensors (or model.gguf for quantized)
    /// - config.json
    /// - tokenizer.json
    /// - mel_filters.safetensors (optional, will use built-in if missing)
    pub fn load_model(&mut self, model_dir: &Path) -> Result<()> {
        log::info!("Loading Whisper model from: {:?}", model_dir);

        if !model_dir.exists() {
            return Err(AumateError::Other(format!("Model directory not found: {:?}", model_dir)));
        }

        // Load config
        let config_path = model_dir.join("config.json");
        let config: Config = if config_path.exists() {
            let config_str = std::fs::read_to_string(&config_path)?;
            serde_json::from_str(&config_str)
                .map_err(|e| AumateError::Other(format!("Failed to parse config: {}", e)))?
        } else {
            return Err(AumateError::Other("config.json not found".to_string()));
        };

        // Load tokenizer
        let tokenizer_path = model_dir.join("tokenizer.json");
        let tokenizer = if tokenizer_path.exists() {
            Tokenizer::from_file(&tokenizer_path)
                .map_err(|e| AumateError::Other(format!("Failed to load tokenizer: {}", e)))?
        } else {
            return Err(AumateError::Other("tokenizer.json not found".to_string()));
        };

        // Load mel filters (use built-in based on num_mel_bins)
        self.mel_filters = Self::get_mel_filters(config.num_mel_bins)?;

        // Load model weights
        let weights_path = model_dir.join("model.safetensors");
        if !weights_path.exists() {
            return Err(AumateError::Other("model.safetensors not found".to_string()));
        }

        let vb = unsafe {
            VarBuilder::from_mmaped_safetensors(&[&weights_path], DType::F32, &self.device)
                .map_err(|e| AumateError::Other(format!("Failed to load weights: {}", e)))?
        };

        let model = m::model::Whisper::load(&vb, config.clone())
            .map_err(|e| AumateError::Other(format!("Failed to create model: {}", e)))?;

        self.model = Some(WhisperModel::Normal(model));
        self.config = Some(config);
        self.tokenizer = Some(tokenizer);
        self.model_path = Some(model_dir.to_path_buf());

        log::info!("Whisper model loaded successfully on {:?}", self.device);
        Ok(())
    }

    /// Get mel filters for the specified number of mel bins
    fn get_mel_filters(num_mel_bins: usize) -> Result<Vec<f32>> {
        // Load pre-computed mel filter coefficients from embedded binary data
        let mel_bytes = match num_mel_bins {
            80 => MEL_FILTERS_80,
            128 => MEL_FILTERS_128,
            _ => {
                return Err(AumateError::Other(format!(
                    "Unsupported num_mel_bins: {}. Expected 80 or 128.",
                    num_mel_bins
                )));
            }
        };

        // Convert bytes to f32 array (little-endian)
        let mut mel_filters = vec![0f32; mel_bytes.len() / 4];
        LittleEndian::read_f32_into(mel_bytes, &mut mel_filters);

        log::debug!("Loaded {} mel filters ({} floats)", num_mel_bins, mel_filters.len());

        Ok(mel_filters)
    }

    /// Unload the current model
    pub fn unload_model(&mut self) {
        self.model = None;
        self.config = None;
        self.tokenizer = None;
        self.mel_filters.clear();
        self.model_path = None;
        log::info!("Whisper model unloaded");
    }

    /// Check if a model is loaded
    pub fn is_loaded(&self) -> bool {
        self.model.is_some()
    }

    /// Get the path to the loaded model
    pub fn model_path(&self) -> Option<&Path> {
        self.model_path.as_deref()
    }

    /// Set the language for transcription
    pub fn set_language(&mut self, language: Option<String>) {
        self.language = language;
    }

    /// Get the current language setting
    pub fn language(&self) -> Option<&str> {
        self.language.as_deref()
    }

    /// Get device being used
    pub fn device(&self) -> &Device {
        &self.device
    }

    /// Transcribe audio data
    pub fn transcribe(&mut self, audio: &AudioData) -> Result<TranscriptionResult> {
        // Clone what we need before mutable borrow
        let config = self
            .config
            .clone()
            .ok_or_else(|| AumateError::Other("No config loaded".to_string()))?;
        let tokenizer = self
            .tokenizer
            .clone()
            .ok_or_else(|| AumateError::Other("No tokenizer loaded".to_string()))?;

        // Prepare audio for Whisper (mono, 16kHz)
        let prepared = audio.prepare_for_whisper();

        let start_time = Instant::now();

        // Convert PCM to mel spectrogram
        let mel = self.pcm_to_mel(&prepared.samples, &config)?;

        // Run transcription directly (we have mutable access to model)
        let text = self.decode_audio(&mel, &tokenizer)?;

        let duration_ms = start_time.elapsed().as_millis() as u64;

        log::info!(
            "Transcription completed in {}ms: \"{}\"",
            duration_ms,
            if text.len() > 50 { format!("{}...", &text[..50]) } else { text.clone() }
        );

        Ok(TranscriptionResult { text, language: self.language.clone(), duration_ms })
    }

    /// Decode audio mel spectrogram to text
    fn decode_audio(&mut self, mel: &Tensor, tokenizer: &Tokenizer) -> Result<String> {
        let model =
            self.model.as_mut().ok_or_else(|| AumateError::Other("No model loaded".to_string()))?;

        // Get special tokens
        let sot_token = tokenizer.token_to_id("<|startoftranscript|>").unwrap_or(50258);
        let eot_token = tokenizer.token_to_id("<|endoftext|>").unwrap_or(50257);
        let transcribe_token = tokenizer.token_to_id("<|transcribe|>").unwrap_or(50359);
        let no_timestamps_token = tokenizer.token_to_id("<|notimestamps|>").unwrap_or(50363);

        // Get language token if specified
        let language_token =
            self.language.as_ref().and_then(|lang| tokenizer.token_to_id(&format!("<|{}|>", lang)));

        // Encode audio
        let audio_features = model.encoder_forward(mel, true)?;

        // Initial tokens: SOT, language (if specified), transcribe, no_timestamps
        let mut tokens = vec![sot_token];
        if let Some(lang_token) = language_token {
            tokens.push(lang_token);
        }
        tokens.push(transcribe_token);
        tokens.push(no_timestamps_token);

        let initial_len = tokens.len();
        let max_tokens = 224; // Max tokens for a 30-second segment

        // Autoregressive decoding loop
        for _ in 0..max_tokens {
            let tokens_tensor = Tensor::new(tokens.as_slice(), &self.device)
                .map_err(|e| AumateError::Other(format!("Failed to create tokens tensor: {}", e)))?
                .unsqueeze(0)
                .map_err(|e| AumateError::Other(format!("Failed to unsqueeze: {}", e)))?;

            let logits = model.decoder_forward(
                &tokens_tensor,
                &audio_features,
                tokens.len() == initial_len,
            )?;

            // Get logits for last position
            let seq_len = logits
                .dim(1)
                .map_err(|e| AumateError::Other(format!("Failed to get dim: {}", e)))?;
            let last_logits = logits
                .narrow(1, seq_len - 1, 1)
                .map_err(|e| AumateError::Other(format!("Failed to narrow: {}", e)))?
                .squeeze(1)
                .map_err(|e| AumateError::Other(format!("Failed to squeeze: {}", e)))?;

            // Greedy decoding: take argmax
            // After squeeze(1), shape is [1, vocab_size], argmax(1) gives [1]
            // We need to get the single value from [1] tensor
            let next_token_tensor = last_logits
                .argmax(1)
                .map_err(|e| AumateError::Other(format!("Failed to argmax: {}", e)))?;

            let next_token = next_token_tensor
                .squeeze(0)
                .map_err(|e| AumateError::Other(format!("Failed to squeeze argmax: {}", e)))?
                .to_scalar::<u32>()
                .map_err(|e| AumateError::Other(format!("Failed to get scalar: {}", e)))?;

            // Check for end of text
            if next_token == eot_token {
                break;
            }

            tokens.push(next_token);
        }

        // Decode tokens to text (skip special tokens at the beginning)
        let text_tokens: Vec<u32> =
            tokens.into_iter().skip(initial_len).filter(|&t| t != eot_token).collect();

        let text = tokenizer
            .decode(&text_tokens, true)
            .map_err(|e| AumateError::Other(format!("Failed to decode tokens: {}", e)))?;

        Ok(text.trim().to_string())
    }

    /// Convert PCM audio samples to mel spectrogram tensor
    fn pcm_to_mel(&self, samples: &[f32], config: &Config) -> Result<Tensor> {
        let mel = m::audio::pcm_to_mel(config, samples, &self.mel_filters);
        let mel_len = mel.len();

        Tensor::from_vec(mel, (1, config.num_mel_bins, mel_len / config.num_mel_bins), &self.device)
            .map_err(|e| AumateError::Other(format!("Failed to create mel tensor: {}", e)))
    }
}

impl Default for WhisperEngine {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_engine_creation() {
        let engine = WhisperEngine::new();
        assert!(!engine.is_loaded());
        assert!(engine.model_path().is_none());
    }

    #[test]
    fn test_language_setting() {
        let mut engine = WhisperEngine::new();
        assert!(engine.language().is_none());

        engine.set_language(Some("en".to_string()));
        assert_eq!(engine.language(), Some("en"));

        engine.set_language(None);
        assert!(engine.language().is_none());
    }

    #[test]
    fn test_transcribe_without_model() {
        let mut engine = WhisperEngine::new();
        let audio = AudioData { samples: vec![0.0; 16000], sample_rate: 16000, channels: 1 };

        let result = engine.transcribe(&audio);
        assert!(result.is_err());
    }
}