voirs-sdk 0.1.0-rc.1

Unified SDK and public API for VoiRS speech synthesis
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
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
use axum::{
    extract::{Extension, Json},
    http::StatusCode,
    response::{IntoResponse, Response},
};
use serde::{Deserialize, Serialize};
use uuid::Uuid;

use super::{middleware::RequestMetrics, SharedPipeline};
use crate::{
    config::PipelineConfig,
    types::{LanguageCode, QualityLevel},
};

#[derive(Debug, Serialize)]
pub struct ErrorResponse {
    pub error: String,
    pub message: String,
    pub request_id: String,
    pub timestamp: chrono::DateTime<chrono::Utc>,
}

impl ErrorResponse {
    pub fn new(error: String, message: String) -> Self {
        Self {
            error,
            message,
            request_id: Uuid::new_v4().to_string(),
            timestamp: chrono::Utc::now(),
        }
    }
}

impl IntoResponse for ErrorResponse {
    fn into_response(self) -> Response {
        (StatusCode::INTERNAL_SERVER_ERROR, Json(self)).into_response()
    }
}

#[derive(Debug, Deserialize)]
pub struct BatchSynthesisRequest {
    pub texts: Vec<String>,
    pub voice_id: Option<String>,
    pub language: Option<LanguageCode>,
    pub quality: Option<QualityLevel>,
    pub sample_rate: Option<u32>,
    pub output_format: Option<String>,
    pub parallel: Option<bool>,
}

#[derive(Debug, Serialize)]
pub struct BatchSynthesisResponse {
    pub results: Vec<BatchSynthesisResult>,
    pub total_count: usize,
    pub success_count: usize,
    pub error_count: usize,
    pub total_processing_time: f64,
}

#[derive(Debug, Serialize)]
pub struct BatchSynthesisResult {
    pub index: usize,
    pub text: String,
    pub success: bool,
    pub audio_data: Option<Vec<u8>>,
    pub error: Option<String>,
    pub processing_time: f64,
}

#[derive(Debug, Deserialize)]
pub struct VoiceValidationRequest {
    pub voice_id: String,
    pub test_text: Option<String>,
    pub quality_check: Option<bool>,
}

#[derive(Debug, Serialize)]
pub struct VoiceValidationResponse {
    pub voice_id: String,
    pub valid: bool,
    pub issues: Vec<String>,
    pub recommendations: Vec<String>,
    pub quality_score: Option<f32>,
    pub test_audio: Option<Vec<u8>>,
}

#[derive(Debug, Deserialize)]
pub struct ModelManagementRequest {
    pub action: String, // "download", "update", "remove"
    pub model_id: String,
    pub version: Option<String>,
    pub force: Option<bool>,
}

#[derive(Debug, Serialize)]
pub struct ModelManagementResponse {
    pub model_id: String,
    pub action: String,
    pub success: bool,
    pub message: String,
    pub version: Option<String>,
    pub size_mb: Option<f64>,
}

#[derive(Debug, Serialize)]
pub struct SystemInfoResponse {
    pub version: String,
    pub build_info: BuildInfo,
    pub system_specs: SystemSpecs,
    pub supported_features: Vec<String>,
    pub available_languages: Vec<LanguageCode>,
    pub default_voice: Option<String>,
}

#[derive(Debug, Serialize)]
pub struct BuildInfo {
    pub version: String,
    pub commit_hash: String,
    pub build_date: String,
    pub rust_version: String,
    pub target_arch: String,
}

#[derive(Debug, Serialize)]
pub struct SystemSpecs {
    pub cpu_cores: usize,
    pub memory_gb: f64,
    pub disk_space_gb: f64,
    pub gpu_available: bool,
    pub gpu_info: Option<String>,
}

pub async fn batch_synthesis_handler(
    Extension(shared_pipeline): Extension<SharedPipeline>,
    Json(request): Json<BatchSynthesisRequest>,
) -> Result<impl IntoResponse, ErrorResponse> {
    let start_time = std::time::Instant::now();

    let total_count = request.texts.len();
    let mut results = Vec::with_capacity(total_count);
    let mut success_count;
    let mut error_count;

    if request.parallel.unwrap_or(false) {
        // Process texts in parallel
        use futures::future::join_all;

        let output_format = request.output_format.clone();
        let quality = request.quality.unwrap_or(QualityLevel::High);
        let sample_rate = request.sample_rate;

        let futures = request.texts.iter().enumerate().map(|(index, text)| {
            let text = text.clone();
            let output_format = output_format.clone();
            let pipeline_clone = shared_pipeline.clone();
            async move {
                let text_start = std::time::Instant::now();

                let mut config = PipelineConfig::default();
                config.default_synthesis.quality = quality;
                if let Some(sample_rate) = sample_rate {
                    config.default_synthesis.sample_rate = sample_rate;
                }

                let pipeline = pipeline_clone.read().await;
                match pipeline.synthesize(&text).await {
                    Ok(audio_buffer) => {
                        let audio_data = match output_format.as_deref() {
                            Some("wav") | None => audio_buffer.to_wav_bytes(),
                            Some("raw") => Ok(audio_buffer
                                .samples()
                                .iter()
                                .flat_map(|&sample| sample.to_le_bytes())
                                .collect()),
                            _ => audio_buffer.to_wav_bytes(),
                        };

                        BatchSynthesisResult {
                            index,
                            text: text.clone(),
                            success: true,
                            audio_data: Some(audio_data.unwrap_or_default()),
                            error: None,
                            processing_time: text_start.elapsed().as_secs_f64(),
                        }
                    }
                    Err(e) => BatchSynthesisResult {
                        index,
                        text: text.clone(),
                        success: false,
                        audio_data: None,
                        error: Some(e.to_string()),
                        processing_time: text_start.elapsed().as_secs_f64(),
                    },
                }
            }
        });

        results = join_all(futures).await;
    } else {
        // Process texts sequentially
        let pipeline = shared_pipeline.read().await;
        for (index, text) in request.texts.iter().enumerate() {
            let text_start = std::time::Instant::now();

            let mut config = PipelineConfig::default();
            config.default_synthesis.quality = request.quality.unwrap_or(QualityLevel::High);
            if let Some(sample_rate) = request.sample_rate {
                config.default_synthesis.sample_rate = sample_rate;
            }

            let result = match pipeline.synthesize(text).await {
                Ok(audio_buffer) => {
                    let audio_data = match request.output_format.as_deref() {
                        Some("wav") | None => audio_buffer.to_wav_bytes(),
                        Some("raw") => Ok(audio_buffer
                            .samples()
                            .iter()
                            .flat_map(|&sample| sample.to_le_bytes())
                            .collect()),
                        _ => audio_buffer.to_wav_bytes(),
                    };

                    BatchSynthesisResult {
                        index,
                        text: text.clone(),
                        success: true,
                        audio_data: Some(audio_data.unwrap_or_default()),
                        error: None,
                        processing_time: text_start.elapsed().as_secs_f64(),
                    }
                }
                Err(e) => BatchSynthesisResult {
                    index,
                    text: text.clone(),
                    success: false,
                    audio_data: None,
                    error: Some(e.to_string()),
                    processing_time: text_start.elapsed().as_secs_f64(),
                },
            };

            results.push(result);
        }
    }

    success_count = results.iter().filter(|r| r.success).count();
    error_count = results.iter().filter(|r| !r.success).count();

    let response = BatchSynthesisResponse {
        results,
        total_count,
        success_count,
        error_count,
        total_processing_time: start_time.elapsed().as_secs_f64(),
    };

    Ok(Json(response))
}

pub async fn validate_voice_handler(
    Extension(pipeline): Extension<SharedPipeline>,
    Json(request): Json<VoiceValidationRequest>,
) -> Result<impl IntoResponse, ErrorResponse> {
    let pipeline = pipeline.read().await;

    let mut issues = Vec::new();
    let mut recommendations = Vec::new();
    let mut quality_score = None;
    let mut test_audio = None;

    // Check if voice exists by trying to set it
    let voice_info = match pipeline.set_voice(&request.voice_id).await {
        Ok(()) => {
            // Get the current voice to validate it was set successfully
            match pipeline.current_voice().await {
                Some(voice) => voice,
                None => {
                    issues.push(format!("Voice '{}' could not be set", request.voice_id));
                    return Ok(Json(VoiceValidationResponse {
                        voice_id: request.voice_id,
                        valid: false,
                        issues,
                        recommendations,
                        quality_score,
                        test_audio,
                    }));
                }
            }
        }
        Err(e) => {
            issues.push(format!("Error setting voice: {e}"));
            return Ok(Json(VoiceValidationResponse {
                voice_id: request.voice_id,
                valid: false,
                issues,
                recommendations,
                quality_score,
                test_audio,
            }));
        }
    };

    // Validate voice configuration
    if voice_info.language == LanguageCode::EnUs {
        recommendations.push("English US voice selected".to_string());
    }

    // Test synthesis if requested
    if let Some(test_text) = request.test_text {
        match pipeline.synthesize(&test_text).await {
            Ok(audio_buffer) => {
                if let Ok(wav_bytes) = audio_buffer.to_wav_bytes() {
                    test_audio = Some(wav_bytes);
                }
                quality_score = Some(0.85); // Mock quality score
            }
            Err(e) => {
                issues.push(format!("Test synthesis failed: {e}"));
            }
        }
    }

    let response = VoiceValidationResponse {
        voice_id: request.voice_id,
        valid: issues.is_empty(),
        issues,
        recommendations,
        quality_score,
        test_audio,
    };

    Ok(Json(response))
}

pub async fn model_management_handler(
    Extension(pipeline): Extension<SharedPipeline>,
    Json(request): Json<ModelManagementRequest>,
) -> Result<impl IntoResponse, ErrorResponse> {
    let _pipeline = pipeline.read().await;

    let response = match request.action.as_str() {
        "download" => {
            // Mock model download
            ModelManagementResponse {
                model_id: request.model_id,
                action: "download".to_string(),
                success: true,
                message: "Model downloaded successfully".to_string(),
                version: request.version,
                size_mb: Some(256.0),
            }
        }
        "update" => {
            // Mock model update
            ModelManagementResponse {
                model_id: request.model_id,
                action: "update".to_string(),
                success: true,
                message: "Model updated successfully".to_string(),
                version: request.version,
                size_mb: Some(256.0),
            }
        }
        "remove" => {
            // Mock model removal
            ModelManagementResponse {
                model_id: request.model_id,
                action: "remove".to_string(),
                success: true,
                message: "Model removed successfully".to_string(),
                version: request.version,
                size_mb: None,
            }
        }
        _ => {
            return Err(ErrorResponse::new(
                "Invalid action".to_string(),
                format!("Unknown action: {}", request.action),
            ));
        }
    };

    Ok(Json(response))
}

pub async fn system_info_handler() -> Result<impl IntoResponse, ErrorResponse> {
    let build_info = BuildInfo {
        version: env!("CARGO_PKG_VERSION").to_string(),
        commit_hash: option_env!("VERGEN_GIT_SHA")
            .unwrap_or("unknown")
            .to_string(),
        build_date: option_env!("VERGEN_BUILD_DATE")
            .unwrap_or("unknown")
            .to_string(),
        rust_version: option_env!("VERGEN_RUSTC_SEMVER")
            .unwrap_or("unknown")
            .to_string(),
        target_arch: std::env::consts::ARCH.to_string(),
    };

    let system_specs = SystemSpecs {
        cpu_cores: std::thread::available_parallelism()
            .map(|n| n.get())
            .unwrap_or(4),
        memory_gb: 8.0,       // Mock value
        disk_space_gb: 500.0, // Mock value
        gpu_available: false, // Would need actual GPU detection
        gpu_info: None,
    };

    let supported_features = vec![
        "synthesis".to_string(),
        "streaming".to_string(),
        "voice_switching".to_string(),
        "batch_processing".to_string(),
        "quality_validation".to_string(),
        "model_management".to_string(),
        "caching".to_string(),
        "plugins".to_string(),
    ];

    let available_languages = vec![
        LanguageCode::EnUs,
        LanguageCode::EsEs,
        LanguageCode::FrFr,
        LanguageCode::DeDe,
        LanguageCode::ItIt,
        LanguageCode::PtBr,
        LanguageCode::RuRu,
        LanguageCode::ZhCn,
        LanguageCode::JaJp,
        LanguageCode::KoKr,
    ];

    let response = SystemInfoResponse {
        version: env!("CARGO_PKG_VERSION").to_string(),
        build_info,
        system_specs,
        supported_features,
        available_languages,
        default_voice: Some("default_english_voice".to_string()),
    };

    Ok(Json(response))
}

pub async fn metrics_handler(
    Extension(metrics): Extension<RequestMetrics>,
) -> Result<impl IntoResponse, ErrorResponse> {
    let stats = metrics.get_stats().await;
    Ok(Json(stats))
}

pub async fn debug_handler(
    Extension(pipeline): Extension<SharedPipeline>,
) -> Result<impl IntoResponse, ErrorResponse> {
    let pipeline = pipeline.read().await;

    let debug_info = serde_json::json!({
        "pipeline_initialized": true,
        "current_voice": pipeline.current_voice().await.map(|v| v.id.clone()),
        "cache_stats": {},  // Cache stats not available in current pipeline interface
        "memory_usage": {
            "estimated_mb": 256.0,
            "peak_mb": 512.0
        },
        "component_status": {
            "g2p": "loaded",
            "acoustic": "loaded",
            "vocoder": "loaded"
        }
    });

    Ok(Json(debug_info))
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::VoirsPipelineBuilder;
    use axum::Extension;
    use std::sync::Arc;
    use tokio::sync::RwLock;

    #[tokio::test]
    async fn test_batch_synthesis_handler() {
        let pipeline = VoirsPipelineBuilder::new()
            .build()
            .await
            .expect("Failed to build pipeline");

        let shared_pipeline = Arc::new(RwLock::new(pipeline));

        let request = BatchSynthesisRequest {
            texts: vec!["Hello".to_string(), "World".to_string()],
            voice_id: None,
            language: None,
            quality: None,
            sample_rate: None,
            output_format: None,
            parallel: Some(false),
        };

        let result = batch_synthesis_handler(Extension(shared_pipeline), Json(request)).await;

        assert!(result.is_ok());
    }

    #[tokio::test]
    async fn test_system_info_handler() {
        let result = system_info_handler().await;
        assert!(result.is_ok());
    }

    #[tokio::test]
    async fn test_validate_voice_handler() {
        let pipeline = VoirsPipelineBuilder::new()
            .build()
            .await
            .expect("Failed to build pipeline");

        let shared_pipeline = Arc::new(RwLock::new(pipeline));

        let request = VoiceValidationRequest {
            voice_id: "test_voice".to_string(),
            test_text: Some("Hello world".to_string()),
            quality_check: Some(true),
        };

        let result = validate_voice_handler(Extension(shared_pipeline), Json(request)).await;

        assert!(result.is_ok());
    }
}