voirs-cli 0.1.0-rc.1

Command-line interface 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
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
use super::{Plugin, PluginError, PluginResult, PluginType};
use crate::audio::effects::{AudioEffect, EffectConfig};
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use std::sync::{Arc, Mutex};

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct EffectPluginConfig {
    pub parameters: HashMap<String, f32>,
    pub enabled: bool,
    pub bypass: bool,
    pub wet_mix: f32,
    pub dry_mix: f32,
}

impl Default for EffectPluginConfig {
    fn default() -> Self {
        Self {
            parameters: HashMap::new(),
            enabled: true,
            bypass: false,
            wet_mix: 1.0,
            dry_mix: 0.0,
        }
    }
}

pub trait EffectPlugin: Plugin {
    fn process_audio(
        &self,
        input: &[f32],
        output: &mut [f32],
        config: &EffectPluginConfig,
    ) -> PluginResult<()>;
    fn get_parameter_info(&self) -> Vec<ParameterInfo>;
    fn set_parameter(&mut self, name: &str, value: f32) -> PluginResult<()>;
    fn get_parameter(&self, name: &str) -> PluginResult<f32>;
    fn reset(&mut self) -> PluginResult<()>;
    fn get_latency(&self) -> u32;
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ParameterInfo {
    pub name: String,
    pub display_name: String,
    pub min_value: f32,
    pub max_value: f32,
    pub default_value: f32,
    pub step_size: f32,
    pub unit: String,
    pub description: String,
    pub parameter_type: ParameterType,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum ParameterType {
    Float,
    Integer,
    Boolean,
    Choice(Vec<String>),
}

pub struct EffectPluginManager {
    effects: HashMap<String, Arc<dyn EffectPlugin>>,
    presets: HashMap<String, EffectPluginConfig>,
}

impl EffectPluginManager {
    pub fn new() -> Self {
        Self {
            effects: HashMap::new(),
            presets: HashMap::new(),
        }
    }

    pub fn register_effect(&mut self, name: String, effect: Arc<dyn EffectPlugin>) {
        self.effects.insert(name, effect);
    }

    pub fn unregister_effect(&mut self, name: &str) -> bool {
        self.effects.remove(name).is_some()
    }

    pub fn list_effects(&self) -> Vec<String> {
        self.effects.keys().cloned().collect()
    }

    pub fn get_effect(&self, name: &str) -> Option<Arc<dyn EffectPlugin>> {
        self.effects.get(name).cloned()
    }

    pub fn process_with_effect(
        &self,
        effect_name: &str,
        input: &[f32],
        output: &mut [f32],
        config: &EffectPluginConfig,
    ) -> PluginResult<()> {
        let effect = self
            .effects
            .get(effect_name)
            .ok_or_else(|| PluginError::NotFound(effect_name.to_string()))?;

        if !config.enabled || config.bypass {
            output.copy_from_slice(input);
            return Ok(());
        }

        effect.process_audio(input, output, config)
    }

    pub fn create_effect_chain(&self, effect_names: &[String]) -> EffectChain {
        let mut effects = Vec::new();
        for name in effect_names {
            if let Some(effect) = self.effects.get(name) {
                effects.push((name.clone(), effect.clone()));
            }
        }
        EffectChain::new(effects)
    }

    pub fn save_preset(&mut self, name: String, config: EffectPluginConfig) {
        self.presets.insert(name, config);
    }

    pub fn load_preset(&self, name: &str) -> Option<&EffectPluginConfig> {
        self.presets.get(name)
    }

    pub fn delete_preset(&mut self, name: &str) -> bool {
        self.presets.remove(name).is_some()
    }

    pub fn list_presets(&self) -> Vec<String> {
        self.presets.keys().cloned().collect()
    }
}

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

pub struct EffectChain {
    effects: Vec<(String, Arc<dyn EffectPlugin>)>,
    buffer: Vec<f32>,
}

impl EffectChain {
    pub fn new(effects: Vec<(String, Arc<dyn EffectPlugin>)>) -> Self {
        Self {
            effects,
            buffer: Vec::new(),
        }
    }

    pub fn process(
        &mut self,
        input: &[f32],
        output: &mut [f32],
        configs: &HashMap<String, EffectPluginConfig>,
    ) -> PluginResult<()> {
        if self.effects.is_empty() {
            output.copy_from_slice(input);
            return Ok(());
        }

        // Ensure buffer is large enough
        if self.buffer.len() < input.len() {
            self.buffer.resize(input.len(), 0.0);
        }

        let default_config = EffectPluginConfig::default();

        // First effect processes input to buffer
        if let Some((name, effect)) = self.effects.first() {
            let config = configs.get(name).unwrap_or(&default_config);
            effect.process_audio(input, &mut self.buffer[..input.len()], config)?;
        }

        // Subsequent effects process buffer to buffer (ping-pong if needed)
        for i in 1..self.effects.len() {
            let (name, effect) = &self.effects[i];
            let config = configs.get(name).unwrap_or(&default_config);

            if i == self.effects.len() - 1 {
                // Last effect writes to output
                effect.process_audio(&self.buffer[..input.len()], output, config)?;
            } else {
                // Intermediate effects process in-place
                let mut temp_buffer = vec![0.0; input.len()];
                effect.process_audio(&self.buffer[..input.len()], &mut temp_buffer, config)?;
                self.buffer[..input.len()].copy_from_slice(&temp_buffer);
            }
        }

        Ok(())
    }

    pub fn get_total_latency(&self) -> u32 {
        self.effects
            .iter()
            .map(|(_, effect)| effect.get_latency())
            .sum()
    }

    pub fn reset_all(&mut self) -> PluginResult<()> {
        for (_, effect) in &self.effects {
            // Note: reset requires mutable reference, but we only have immutable
            // In a real implementation, effects would need interior mutability
        }
        Ok(())
    }
}

// Example builtin effect plugin implementations
// Comb filter for reverb
struct CombFilter {
    buffer: Vec<f32>,
    buffer_index: usize,
    feedback: f32,
    filter_state: f32,
    damping: f32,
}

impl CombFilter {
    fn new(size: usize) -> Self {
        Self {
            buffer: vec![0.0; size],
            buffer_index: 0,
            feedback: 0.0,
            filter_state: 0.0,
            damping: 0.0,
        }
    }

    fn process(&mut self, input: f32) -> f32 {
        let output = self.buffer[self.buffer_index];

        // One-pole lowpass filter for damping
        self.filter_state = output * (1.0 - self.damping) + self.filter_state * self.damping;

        self.buffer[self.buffer_index] = input + self.filter_state * self.feedback;
        self.buffer_index = (self.buffer_index + 1) % self.buffer.len();

        output
    }

    fn set_damping(&mut self, damping: f32) {
        self.damping = damping;
    }

    fn set_feedback(&mut self, feedback: f32) {
        self.feedback = feedback;
    }

    fn clear(&mut self) {
        self.buffer.fill(0.0);
        self.filter_state = 0.0;
        self.buffer_index = 0;
    }
}

// Allpass filter for reverb
struct AllpassFilter {
    buffer: Vec<f32>,
    buffer_index: usize,
}

impl AllpassFilter {
    fn new(size: usize) -> Self {
        Self {
            buffer: vec![0.0; size],
            buffer_index: 0,
        }
    }

    fn process(&mut self, input: f32) -> f32 {
        let buffered = self.buffer[self.buffer_index];
        let output = -input + buffered;

        self.buffer[self.buffer_index] = input + buffered * 0.5;
        self.buffer_index = (self.buffer_index + 1) % self.buffer.len();

        output
    }

    fn clear(&mut self) {
        self.buffer.fill(0.0);
        self.buffer_index = 0;
    }
}

pub struct ReverbEffectPlugin {
    name: String,
    version: String,
    room_size: f32,
    damping: f32,
    wet_level: f32,
    dry_level: f32,
    // Freeverb-style filter banks (using Mutex for thread-safe processing state)
    comb_filters: Mutex<Vec<CombFilter>>,
    allpass_filters: Mutex<Vec<AllpassFilter>>,
}

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

impl ReverbEffectPlugin {
    pub fn new() -> Self {
        // Freeverb comb filter delay lengths (at 44.1kHz sample rate)
        const COMB_DELAYS: [usize; 8] = [1116, 1188, 1277, 1356, 1422, 1491, 1557, 1617];
        // Freeverb allpass filter delay lengths
        const ALLPASS_DELAYS: [usize; 4] = [556, 441, 341, 225];

        let comb_filters: Vec<CombFilter> = COMB_DELAYS
            .iter()
            .map(|&size| CombFilter::new(size))
            .collect();

        let allpass_filters: Vec<AllpassFilter> = ALLPASS_DELAYS
            .iter()
            .map(|&size| AllpassFilter::new(size))
            .collect();

        Self {
            name: "builtin-reverb".to_string(),
            version: "1.0.0".to_string(),
            room_size: 0.5,
            damping: 0.5,
            wet_level: 0.3,
            dry_level: 0.7,
            comb_filters: Mutex::new(comb_filters),
            allpass_filters: Mutex::new(allpass_filters),
        }
    }

    fn update_filters(&self) {
        // Update comb filter parameters based on room_size and damping
        let feedback = 0.28 + self.room_size * 0.7;

        let mut comb_filters = self
            .comb_filters
            .lock()
            .expect("Reverb comb_filters mutex poisoned - unrecoverable error");
        for comb in comb_filters.iter_mut() {
            comb.set_feedback(feedback);
            comb.set_damping(self.damping);
        }
    }
}

impl Plugin for ReverbEffectPlugin {
    fn name(&self) -> &str {
        &self.name
    }

    fn version(&self) -> &str {
        &self.version
    }

    fn description(&self) -> &str {
        "Built-in reverb effect plugin"
    }

    fn plugin_type(&self) -> PluginType {
        PluginType::Effect
    }

    fn initialize(&mut self, config: &serde_json::Value) -> PluginResult<()> {
        if let Some(room_size) = config.get("room_size").and_then(|v| v.as_f64()) {
            self.room_size = room_size as f32;
        }
        if let Some(damping) = config.get("damping").and_then(|v| v.as_f64()) {
            self.damping = damping as f32;
        }
        if let Some(wet_level) = config.get("wet_level").and_then(|v| v.as_f64()) {
            self.wet_level = wet_level as f32;
        }
        if let Some(dry_level) = config.get("dry_level").and_then(|v| v.as_f64()) {
            self.dry_level = dry_level as f32;
        }
        Ok(())
    }

    fn cleanup(&mut self) -> PluginResult<()> {
        Ok(())
    }

    fn get_capabilities(&self) -> Vec<String> {
        vec![
            "process_audio".to_string(),
            "set_parameter".to_string(),
            "get_parameter".to_string(),
            "reset".to_string(),
        ]
    }

    fn execute(&self, command: &str, args: &serde_json::Value) -> PluginResult<serde_json::Value> {
        match command {
            "get_parameters" => Ok(serde_json::json!({
                "room_size": self.room_size,
                "damping": self.damping,
                "wet_level": self.wet_level,
                "dry_level": self.dry_level
            })),
            "set_parameter" => {
                let param_name = args.get("name").and_then(|v| v.as_str()).ok_or_else(|| {
                    PluginError::ExecutionFailed("Missing parameter name".to_string())
                })?;
                let value = args.get("value").and_then(|v| v.as_f64()).ok_or_else(|| {
                    PluginError::ExecutionFailed("Missing parameter value".to_string())
                })? as f32;

                match param_name {
                    "room_size" => Ok(serde_json::json!({"old_value": self.room_size})),
                    "damping" => Ok(serde_json::json!({"old_value": self.damping})),
                    "wet_level" => Ok(serde_json::json!({"old_value": self.wet_level})),
                    "dry_level" => Ok(serde_json::json!({"old_value": self.dry_level})),
                    _ => Err(PluginError::ExecutionFailed(format!(
                        "Unknown parameter: {}",
                        param_name
                    ))),
                }
            }
            _ => Err(PluginError::ExecutionFailed(format!(
                "Unknown command: {}",
                command
            ))),
        }
    }
}

impl EffectPlugin for ReverbEffectPlugin {
    fn process_audio(
        &self,
        input: &[f32],
        output: &mut [f32],
        config: &EffectPluginConfig,
    ) -> PluginResult<()> {
        // Real Freeverb implementation with comb and allpass filters
        self.update_filters();

        let mut comb_filters = self
            .comb_filters
            .lock()
            .expect("Reverb comb_filters mutex poisoned - unrecoverable error");
        let mut allpass_filters = self
            .allpass_filters
            .lock()
            .expect("Reverb allpass_filters mutex poisoned - unrecoverable error");

        for (i, &input_sample) in input.iter().enumerate() {
            // Process through parallel comb filters
            let mut comb_out = 0.0;
            for comb in comb_filters.iter_mut() {
                comb_out += comb.process(input_sample);
            }

            // Process through series allpass filters
            let mut allpass_out = comb_out;
            for allpass in allpass_filters.iter_mut() {
                allpass_out = allpass.process(allpass_out);
            }

            // Mix wet and dry signals
            let wet = allpass_out * self.wet_level * config.wet_mix;
            let dry = input_sample * self.dry_level * config.dry_mix;
            output[i] = wet + dry;
        }

        Ok(())
    }

    fn get_parameter_info(&self) -> Vec<ParameterInfo> {
        vec![
            ParameterInfo {
                name: "room_size".to_string(),
                display_name: "Room Size".to_string(),
                min_value: 0.0,
                max_value: 1.0,
                default_value: 0.5,
                step_size: 0.01,
                unit: "".to_string(),
                description: "Size of the reverb room".to_string(),
                parameter_type: ParameterType::Float,
            },
            ParameterInfo {
                name: "damping".to_string(),
                display_name: "Damping".to_string(),
                min_value: 0.0,
                max_value: 1.0,
                default_value: 0.5,
                step_size: 0.01,
                unit: "".to_string(),
                description: "Damping factor for high frequencies".to_string(),
                parameter_type: ParameterType::Float,
            },
            ParameterInfo {
                name: "wet_level".to_string(),
                display_name: "Wet Level".to_string(),
                min_value: 0.0,
                max_value: 1.0,
                default_value: 0.3,
                step_size: 0.01,
                unit: "".to_string(),
                description: "Level of processed signal".to_string(),
                parameter_type: ParameterType::Float,
            },
            ParameterInfo {
                name: "dry_level".to_string(),
                display_name: "Dry Level".to_string(),
                min_value: 0.0,
                max_value: 1.0,
                default_value: 0.7,
                step_size: 0.01,
                unit: "".to_string(),
                description: "Level of original signal".to_string(),
                parameter_type: ParameterType::Float,
            },
        ]
    }

    fn set_parameter(&mut self, name: &str, value: f32) -> PluginResult<()> {
        match name {
            "room_size" => self.room_size = value.clamp(0.0, 1.0),
            "damping" => self.damping = value.clamp(0.0, 1.0),
            "wet_level" => self.wet_level = value.clamp(0.0, 1.0),
            "dry_level" => self.dry_level = value.clamp(0.0, 1.0),
            _ => {
                return Err(PluginError::ExecutionFailed(format!(
                    "Unknown parameter: {}",
                    name
                )))
            }
        }
        Ok(())
    }

    fn get_parameter(&self, name: &str) -> PluginResult<f32> {
        match name {
            "room_size" => Ok(self.room_size),
            "damping" => Ok(self.damping),
            "wet_level" => Ok(self.wet_level),
            "dry_level" => Ok(self.dry_level),
            _ => Err(PluginError::ExecutionFailed(format!(
                "Unknown parameter: {}",
                name
            ))),
        }
    }

    fn reset(&mut self) -> PluginResult<()> {
        // Reset parameters to defaults
        self.room_size = 0.5;
        self.damping = 0.5;
        self.wet_level = 0.3;
        self.dry_level = 0.7;

        // Clear all filter buffers
        let mut comb_filters = self
            .comb_filters
            .lock()
            .expect("Reverb comb_filters mutex poisoned - unrecoverable error");
        for comb in comb_filters.iter_mut() {
            comb.clear();
        }

        let mut allpass_filters = self
            .allpass_filters
            .lock()
            .expect("Reverb allpass_filters mutex poisoned - unrecoverable error");
        for allpass in allpass_filters.iter_mut() {
            allpass.clear();
        }

        Ok(())
    }

    fn get_latency(&self) -> u32 {
        // Reverb has latency from the longest comb filter delay
        1617 // Longest comb filter delay in samples (at 44.1kHz)
    }
}

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

    #[test]
    fn test_effect_plugin_manager() {
        let mut manager = EffectPluginManager::new();
        let reverb = Arc::new(ReverbEffectPlugin::new());

        manager.register_effect("reverb".to_string(), reverb);

        let effects = manager.list_effects();
        assert!(effects.contains(&"reverb".to_string()));

        let effect = manager.get_effect("reverb");
        assert!(effect.is_some());
    }

    #[test]
    fn test_reverb_plugin() {
        let mut reverb = ReverbEffectPlugin::new();
        assert_eq!(reverb.name(), "builtin-reverb");
        assert_eq!(reverb.version(), "1.0.0");

        let config = EffectPluginConfig::default();
        let input = vec![1.0, 0.5, -0.5, -1.0];
        let mut output = vec![0.0; 4];

        reverb
            .process_audio(&input, &mut output, &config)
            .expect("Failed to process audio with reverb");

        // Output should be processed (not just copied)
        assert_ne!(input, output);
    }

    #[test]
    fn test_parameter_setting() {
        let mut reverb = ReverbEffectPlugin::new();

        reverb
            .set_parameter("room_size", 0.8)
            .expect("Failed to set room_size parameter");
        assert_eq!(
            reverb
                .get_parameter("room_size")
                .expect("Failed to get room_size parameter"),
            0.8
        );

        // Test parameter clamping
        reverb
            .set_parameter("room_size", 1.5)
            .expect("Failed to set room_size parameter");
        assert_eq!(
            reverb
                .get_parameter("room_size")
                .expect("Failed to get room_size parameter"),
            1.0
        );

        // Test invalid parameter
        assert!(reverb.set_parameter("invalid", 0.5).is_err());
    }

    #[test]
    fn test_effect_chain() {
        let reverb = Arc::new(ReverbEffectPlugin::new());
        let effects = vec![("reverb".to_string(), reverb as Arc<dyn EffectPlugin>)];
        let mut chain = EffectChain::new(effects);

        let input = vec![1.0, 0.5, -0.5, -1.0];
        let mut output = vec![0.0; 4];
        let configs = HashMap::new();

        chain
            .process(&input, &mut output, &configs)
            .expect("Failed to process audio with effect chain");

        // Should process without error
        assert_eq!(output.len(), input.len());
    }
}