voirs 0.1.0-alpha.2

Advanced voice synthesis and speech processing library for Rust
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
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
# Multi-language Support

VoiRS Recognizer provides comprehensive multi-language support with automatic language detection, language-specific optimizations, and cross-lingual capabilities.

## Supported Languages

VoiRS supports 99+ languages through the Whisper backend. Here are the most commonly used languages:

### Major Languages

| Language | Code | Whisper Support | Notes |
|----------|------|-----------------|-------|
| English (US) | `EnUs` || Best supported |
| English (UK) | `EnGb` || British English |
| Spanish | `EsEs` || Spain Spanish |
| French | `FrFr` || French |
| German | `DeDE` || German |
| Italian | `ItIt` || Italian |
| Portuguese | `PtBr` || Brazilian Portuguese |
| Russian | `RuRu` || Russian |
| Japanese | `JaJp` || Japanese |
| Korean | `KoKr` || Korean |
| Chinese | `ZhCn` || Mandarin Chinese |
| Arabic | `ArAr` || Modern Standard Arabic |
| Hindi | `HiIn` || Hindi |

### Regional Variants

```rust
use voirs_recognizer::prelude::*;

// English variants
let us_english = LanguageCode::EnUs;
let uk_english = LanguageCode::EnGb;
let au_english = LanguageCode::EnAu;

// Spanish variants
let spain_spanish = LanguageCode::EsEs;
let mexico_spanish = LanguageCode::EsMx;
let argentina_spanish = LanguageCode::EsAr;

// Portuguese variants
let brazil_portuguese = LanguageCode::PtBr;
let portugal_portuguese = LanguageCode::PtPt;
```

## Automatic Language Detection

### Basic Language Detection

```rust
use voirs_recognizer::prelude::*;

#[tokio::main]
async fn main() -> Result<(), RecognitionError> {
    let audio = load_audio("multilingual_audio.wav", &AudioLoadConfig::default()).await?;
    
    // Enable automatic language detection
    let config = ASRConfig {
        language: None,  // Auto-detect
        detect_language: true,
        language_detection_threshold: 0.8,
        ..Default::default()
    };
    
    let mut asr = ASRBackend::new_whisper(config).await?;
    let result = asr.recognize(&audio, None).await?;
    
    println!("Detected language: {:?}", result.language);
    println!("Language confidence: {:.2}", result.language_confidence);
    println!("Transcript: {}", result.text);
    
    Ok(())
}
```

### Language Detection with Candidates

```rust
// Limit detection to specific languages
let config = ASRConfig {
    language: None,
    detect_language: true,
    language_candidates: Some(vec![
        LanguageCode::EnUs,
        LanguageCode::EsEs,
        LanguageCode::FrFr,
    ]),
    ..Default::default()
};

let mut asr = ASRBackend::new_whisper(config).await?;
let result = asr.recognize(&audio, None).await?;

// Get language probabilities
if let Some(probs) = result.language_probabilities {
    for (lang, prob) in probs {
        println!("{:?}: {:.3}", lang, prob);
    }
}
```

## Language-Specific Configuration

### Optimized Configurations

```rust
use voirs_recognizer::prelude::*;

// English - optimized for natural speech
let english_config = ASRConfig {
    language: Some(LanguageCode::EnUs),
    punctuation: true,
    sentence_segmentation: true,
    word_timestamps: true,
    ..Default::default()
};

// Japanese - optimized for character-based writing
let japanese_config = ASRConfig {
    language: Some(LanguageCode::JaJp),
    punctuation: false,  // Less punctuation in Japanese
    sentence_segmentation: false,
    character_level: true,
    ..Default::default()
};

// Arabic - optimized for RTL text
let arabic_config = ASRConfig {
    language: Some(LanguageCode::ArAr),
    text_direction: TextDirection::RightToLeft,
    punctuation: true,
    normalize_text: true,
    ..Default::default()
};
```

### Language-Specific Preprocessing

```rust
// Chinese - handle tone and character conversion
let chinese_config = ASRConfig {
    language: Some(LanguageCode::ZhCn),
    text_normalization: TextNormalization::Traditional,
    tone_marks: true,
    character_conversion: CharacterConversion::Simplified,
    ..Default::default()
};

// German - handle compound words
let german_config = ASRConfig {
    language: Some(LanguageCode::DeDE),
    compound_word_splitting: true,
    case_normalization: true,
    ..Default::default()
};
```

## Multi-language Processing

### Sequential Processing

```rust
use voirs_recognizer::prelude::*;

async fn process_multilingual_content(
    audio_files: Vec<&str>,
    languages: Vec<LanguageCode>
) -> Result<Vec<String>, RecognitionError> {
    let mut results = Vec::new();
    
    for (file, lang) in audio_files.iter().zip(languages.iter()) {
        let audio = load_audio(file, &AudioLoadConfig::default()).await?;
        
        let config = ASRConfig {
            language: Some(*lang),
            ..Default::default()
        };
        
        let mut asr = ASRBackend::new_whisper(config).await?;
        let result = asr.recognize(&audio, None).await?;
        
        results.push(result.text);
    }
    
    Ok(results)
}
```

### Parallel Processing

```rust
use tokio::task;
use futures::future::join_all;

async fn parallel_multilingual_processing(
    audio_files: Vec<&str>,
    languages: Vec<LanguageCode>
) -> Result<Vec<String>, RecognitionError> {
    let tasks = audio_files.into_iter()
        .zip(languages.into_iter())
        .map(|(file, lang)| {
            task::spawn(async move {
                let audio = load_audio(file, &AudioLoadConfig::default()).await?;
                
                let config = ASRConfig {
                    language: Some(lang),
                    ..Default::default()
                };
                
                let mut asr = ASRBackend::new_whisper(config).await?;
                asr.recognize(&audio, None).await.map(|r| r.text)
            })
        })
        .collect::<Vec<_>>();
    
    let results = join_all(tasks).await;
    
    results.into_iter()
        .map(|r| r.unwrap())
        .collect::<Result<Vec<_>, _>>()
}
```

## Code-switching Support

### Mixed Language Audio

```rust
// Handle audio with multiple languages
let mixed_config = ASRConfig {
    language: None,  // Auto-detect
    detect_language: true,
    code_switching: true,
    segment_languages: true,
    ..Default::default()
};

let mut asr = ASRBackend::new_whisper(mixed_config).await?;
let result = asr.recognize(&audio, None).await?;

// Get language segments
if let Some(segments) = result.language_segments {
    for segment in segments {
        println!("{}s-{}s: {:?} - \"{}\"", 
                 segment.start_time, 
                 segment.end_time, 
                 segment.language, 
                 segment.text);
    }
}
```

## Language-Specific Features

### Phoneme Systems

```rust
use voirs_recognizer::phoneme::*;

// English phonemes (ARPABET)
let english_phonemes = PhonemeRecognitionConfig {
    language: LanguageCode::EnUs,
    phoneme_set: PhonemeSet::ARPABET,
    ..Default::default()
};

// Japanese phonemes (Hiragana-based)
let japanese_phonemes = PhonemeRecognitionConfig {
    language: LanguageCode::JaJp,
    phoneme_set: PhonemeSet::Japanese,
    ..Default::default()
};

// International phonemes (IPA)
let ipa_phonemes = PhonemeRecognitionConfig {
    language: LanguageCode::EnUs,
    phoneme_set: PhonemeSet::IPA,
    ..Default::default()
};
```

### Cross-lingual Phoneme Mapping

```rust
// Map phonemes between languages
let cross_lingual_config = PhonemeRecognitionConfig {
    language: LanguageCode::EnUs,
    target_language: Some(LanguageCode::EsEs),
    cross_lingual_mapping: true,
    ..Default::default()
};
```

## Regional Accent Support

### Accent Detection

```rust
let config = ASRConfig {
    language: Some(LanguageCode::EnUs),
    accent_detection: true,
    accent_adaptation: true,
    ..Default::default()
};

let mut asr = ASRBackend::new_whisper(config).await?;
let result = asr.recognize(&audio, None).await?;

if let Some(accent) = result.detected_accent {
    println!("Detected accent: {:?}", accent);
}
```

### Accent-Specific Models

```rust
// Use accent-specific models
let southern_us_config = ASRConfig {
    language: Some(LanguageCode::EnUs),
    accent: Some(AccentCode::EnUsSouthern),
    ..Default::default()
};

let british_config = ASRConfig {
    language: Some(LanguageCode::EnGb),
    accent: Some(AccentCode::EnGbRP),  // Received Pronunciation
    ..Default::default()
};
```

## Text Normalization

### Language-Specific Normalization

```rust
// English text normalization
let english_norm = TextNormalization {
    language: LanguageCode::EnUs,
    expand_contractions: true,
    normalize_numbers: true,
    normalize_dates: true,
    normalize_times: true,
    ..Default::default()
};

// Japanese text normalization
let japanese_norm = TextNormalization {
    language: LanguageCode::JaJp,
    hiragana_katakana_conversion: true,
    kanji_conversion: false,
    normalize_punctuation: true,
    ..Default::default()
};

// Arabic text normalization
let arabic_norm = TextNormalization {
    language: LanguageCode::ArAr,
    normalize_diacritics: true,
    normalize_alef: true,
    normalize_teh: true,
    ..Default::default()
};
```

## Performance Optimization by Language

### Language-Specific Model Selection

```rust
// Optimize model size based on language complexity
fn get_optimal_model_size(language: LanguageCode) -> WhisperModelSize {
    match language {
        LanguageCode::EnUs | LanguageCode::EnGb => WhisperModelSize::Base,
        LanguageCode::ZhCn | LanguageCode::JaJp | LanguageCode::ArAr => WhisperModelSize::Large,
        _ => WhisperModelSize::Small,
    }
}

let config = ASRConfig {
    language: Some(LanguageCode::ZhCn),
    model_size: Some(get_optimal_model_size(LanguageCode::ZhCn)),
    ..Default::default()
};
```

### Language-Specific Preprocessing

```rust
// Different preprocessing for different languages
let preprocessing_config = match language {
    LanguageCode::EnUs => PreprocessingConfig {
        noise_suppression: true,
        auto_gain_control: true,
        echo_cancellation: true,
        ..Default::default()
    },
    LanguageCode::ZhCn => PreprocessingConfig {
        noise_suppression: true,
        auto_gain_control: false,  // Preserve tonal information
        echo_cancellation: true,
        ..Default::default()
    },
    LanguageCode::ArAr => PreprocessingConfig {
        noise_suppression: false,  // Preserve emphatic consonants
        auto_gain_control: true,
        echo_cancellation: true,
        ..Default::default()
    },
    _ => PreprocessingConfig::default(),
};
```

## Translation Integration

### Recognition + Translation

```rust
// Recognize and translate in one pipeline
let config = ASRConfig {
    language: Some(LanguageCode::EsEs),
    translate_to: Some(LanguageCode::EnUs),
    ..Default::default()
};

let mut asr = ASRBackend::new_whisper(config).await?;
let result = asr.recognize(&audio, None).await?;

println!("Original (Spanish): {}", result.text);
if let Some(translation) = result.translation {
    println!("Translation (English): {}", translation);
}
```

## Best Practices

### 1. Language Detection Strategy

```rust
// Use language detection for unknown content
async fn smart_language_detection(audio: &AudioBuffer) -> Result<LanguageCode, RecognitionError> {
    // First, try auto-detection
    let detection_config = ASRConfig {
        language: None,
        detect_language: true,
        language_detection_threshold: 0.8,
        ..Default::default()
    };
    
    let mut detector = ASRBackend::new_whisper(detection_config).await?;
    let result = detector.recognize(audio, None).await?;
    
    if let Some(lang) = result.language {
        if result.language_confidence > 0.8 {
            return Ok(lang);
        }
    }
    
    // Fallback to English if detection fails
    Ok(LanguageCode::EnUs)
}
```

### 2. Language-Specific Quality Checks

```rust
// Validate results based on language characteristics
fn validate_language_result(result: &RecognitionResult, language: LanguageCode) -> bool {
    match language {
        LanguageCode::EnUs => {
            // English should have spaces between words
            result.text.contains(' ') && result.confidence > 0.5
        },
        LanguageCode::ZhCn => {
            // Chinese may not have spaces, check character count
            result.text.chars().count() > 0 && result.confidence > 0.6
        },
        LanguageCode::JaJp => {
            // Japanese mixed scripts validation
            result.text.chars().any(|c| c.is_ascii_alphanumeric() || 
                                   (c >= '\u{3040}' && c <= '\u{309f}') || // Hiragana
                                   (c >= '\u{30a0}' && c <= '\u{30ff}'))   // Katakana
        },
        _ => result.confidence > 0.5,
    }
}
```

### 3. Efficient Multi-language Processing

```rust
// Reuse models when possible
struct MultiLanguageProcessor {
    models: HashMap<LanguageCode, ASRBackend>,
}

impl MultiLanguageProcessor {
    async fn new(languages: Vec<LanguageCode>) -> Result<Self, RecognitionError> {
        let mut models = HashMap::new();
        
        for lang in languages {
            let config = ASRConfig {
                language: Some(lang),
                ..Default::default()
            };
            let asr = ASRBackend::new_whisper(config).await?;
            models.insert(lang, asr);
        }
        
        Ok(Self { models })
    }
    
    async fn recognize(&mut self, audio: &AudioBuffer, language: LanguageCode) -> Result<RecognitionResult, RecognitionError> {
        if let Some(asr) = self.models.get_mut(&language) {
            asr.recognize(audio, None).await
        } else {
            Err(RecognitionError::UnsupportedLanguage(language))
        }
    }
}
```

## Troubleshooting

### Common Issues

1. **Low accuracy for non-English languages**: Use larger models (Small/Large)
2. **Incorrect language detection**: Set language candidates or use manual language selection
3. **Poor accent recognition**: Enable accent adaptation or use accent-specific models
4. **Text normalization issues**: Configure language-specific normalization

### Debug Language Detection

```rust
// Debug language detection
let debug_config = ASRConfig {
    language: None,
    detect_language: true,
    language_detection_debug: true,
    ..Default::default()
};

let mut asr = ASRBackend::new_whisper(debug_config).await?;
let result = asr.recognize(&audio, None).await?;

if let Some(debug_info) = result.language_debug_info {
    println!("Language detection debug:");
    for (lang, score) in debug_info {
        println!("  {:?}: {:.3}", lang, score);
    }
}
```

## Next Steps

- Explore [Phoneme Alignment]./phoneme-alignment.md for detailed linguistic analysis
- Learn about [Audio Analysis]./audio-analysis.md for quality assessment
- Check out [Real-time Streaming]./streaming.md for live multilingual processing
- Review [Performance Optimization]./performance.md for production deployment