wavecraft-bridge 0.12.26

IPC bridge for WebView ↔ Rust communication
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
//! In-memory ParameterHost implementation for dev tools and tests.

use std::collections::HashMap;
use std::sync::{Arc, RwLock};

use crate::{BridgeError, ParameterHost};
use wavecraft_protocol::{AudioRuntimeStatus, MeterFrame, OscilloscopeFrame, ParameterInfo};

/// Provides metering data for an in-memory host.
pub trait MeterProvider: Send + Sync {
    /// Return the latest meter frame, if available.
    fn get_meter_frame(&self) -> Option<MeterFrame>;
}

/// Provides oscilloscope frame data for an in-memory host.
pub trait OscilloscopeProvider: Send + Sync {
    /// Return the latest oscilloscope frame, if available.
    fn get_oscilloscope_frame(&self) -> Option<OscilloscopeFrame>;
}

/// In-memory host for storing parameter values and optional meter data.
///
/// This is intended for development tools (like the CLI dev server) and tests.
pub struct InMemoryParameterHost {
    parameters: RwLock<Vec<ParameterInfo>>,
    values: RwLock<HashMap<String, f32>>,
    meter_provider: Option<Arc<dyn MeterProvider>>,
    oscilloscope_provider: Option<Arc<dyn OscilloscopeProvider>>,
}

impl InMemoryParameterHost {
    /// Create a new in-memory host with the given parameter metadata.
    pub fn new(parameters: Vec<ParameterInfo>) -> Self {
        let values = parameters
            .iter()
            .map(|p| (p.id.clone(), p.default))
            .collect();

        Self {
            parameters: RwLock::new(parameters),
            values: RwLock::new(values),
            meter_provider: None,
            oscilloscope_provider: None,
        }
    }

    /// Create a new in-memory host with a meter provider.
    pub fn with_meter_provider(
        parameters: Vec<ParameterInfo>,
        meter_provider: Arc<dyn MeterProvider>,
    ) -> Self {
        let mut host = Self::new(parameters);
        host.meter_provider = Some(meter_provider);
        host
    }

    /// Create a new in-memory host with an oscilloscope provider.
    pub fn with_oscilloscope_provider(
        parameters: Vec<ParameterInfo>,
        oscilloscope_provider: Arc<dyn OscilloscopeProvider>,
    ) -> Self {
        let mut host = Self::new(parameters);
        host.oscilloscope_provider = Some(oscilloscope_provider);
        host
    }

    /// Create a new in-memory host with both meter and oscilloscope providers.
    pub fn with_providers(
        parameters: Vec<ParameterInfo>,
        meter_provider: Option<Arc<dyn MeterProvider>>,
        oscilloscope_provider: Option<Arc<dyn OscilloscopeProvider>>,
    ) -> Self {
        let mut host = Self::new(parameters);
        host.meter_provider = meter_provider;
        host.oscilloscope_provider = oscilloscope_provider;
        host
    }

    /// Replace all parameters with new metadata from a fresh build.
    ///
    /// This method is used during hot-reload to update parameter definitions
    /// while preserving existing parameter values where possible. Parameters
    /// with matching IDs retain their current values; new parameters get
    /// their default values; removed parameters are dropped.
    ///
    /// # Thread Safety
    ///
    /// This method acquires write locks on both the parameters and values maps.
    /// If a lock is poisoned (from a previous panic), it recovers gracefully
    /// by clearing the poisoned lock and continuing.
    ///
    /// # Errors
    ///
    /// Returns an error if both lock recovery attempts fail.
    pub fn replace_parameters(&self, new_params: Vec<ParameterInfo>) -> Result<(), String> {
        // Acquire values lock with poison recovery
        let mut values = match self.values.write() {
            Ok(guard) => guard,
            Err(poisoned) => {
                eprintln!("⚠ Recovering from poisoned values lock");
                poisoned.into_inner()
            }
        };

        // Build new values map, preserving existing values where IDs match
        let mut new_values = HashMap::new();
        for param in &new_params {
            let value = values.get(&param.id).copied().unwrap_or(param.default);
            new_values.insert(param.id.clone(), value);
        }

        *values = new_values;
        drop(values); // Release values lock before acquiring parameters lock

        // Acquire parameters lock with poison recovery
        let mut params = match self.parameters.write() {
            Ok(guard) => guard,
            Err(poisoned) => {
                eprintln!("⚠ Recovering from poisoned parameters lock");
                poisoned.into_inner()
            }
        };

        *params = new_params;
        Ok(())
    }

    fn current_value(&self, id: &str, default: f32) -> f32 {
        self.values
            .read()
            .ok()
            .and_then(|values| values.get(id).copied())
            .unwrap_or(default)
    }
}

impl ParameterHost for InMemoryParameterHost {
    fn get_parameter(&self, id: &str) -> Option<ParameterInfo> {
        let parameters = self.parameters.read().ok()?;
        let param = parameters.iter().find(|p| p.id == id)?;

        Some(ParameterInfo {
            id: param.id.clone(),
            name: param.name.clone(),
            param_type: param.param_type,
            value: self.current_value(&param.id, param.default),
            default: param.default,
            min: param.min,
            max: param.max,
            unit: param.unit.clone(),
            group: param.group.clone(),
        })
    }

    fn set_parameter(&self, id: &str, value: f32) -> Result<(), BridgeError> {
        let parameters = self.parameters.read().ok();
        let param_exists = parameters
            .as_ref()
            .map(|p| p.iter().any(|param| param.id == id))
            .unwrap_or(false);

        if !param_exists {
            return Err(BridgeError::ParameterNotFound(id.to_string()));
        }

        let Some(param) = parameters
            .as_ref()
            .and_then(|p| p.iter().find(|param| param.id == id))
        else {
            return Err(BridgeError::ParameterNotFound(id.to_string()));
        };

        if !(param.min..=param.max).contains(&value) {
            return Err(BridgeError::ParameterOutOfRange {
                id: id.to_string(),
                value,
            });
        }

        if let Ok(mut values) = self.values.write() {
            values.insert(id.to_string(), value);
        }

        Ok(())
    }

    fn get_all_parameters(&self) -> Vec<ParameterInfo> {
        let parameters = match self.parameters.read() {
            Ok(guard) => guard,
            Err(_) => return Vec::new(), // Return empty on poisoned lock
        };

        parameters
            .iter()
            .map(|param| ParameterInfo {
                id: param.id.clone(),
                name: param.name.clone(),
                param_type: param.param_type,
                value: self.current_value(&param.id, param.default),
                default: param.default,
                min: param.min,
                max: param.max,
                unit: param.unit.clone(),
                group: param.group.clone(),
            })
            .collect()
    }

    fn get_meter_frame(&self) -> Option<MeterFrame> {
        self.meter_provider
            .as_ref()
            .and_then(|provider| provider.get_meter_frame())
    }

    fn get_oscilloscope_frame(&self) -> Option<OscilloscopeFrame> {
        self.oscilloscope_provider
            .as_ref()
            .and_then(|provider| provider.get_oscilloscope_frame())
    }

    fn request_resize(&self, _width: u32, _height: u32) -> bool {
        false
    }

    fn get_audio_status(&self) -> Option<AudioRuntimeStatus> {
        None
    }
}

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

    struct StaticMeterProvider {
        frame: MeterFrame,
    }

    struct StaticOscilloscopeProvider {
        frame: OscilloscopeFrame,
    }

    impl MeterProvider for StaticMeterProvider {
        fn get_meter_frame(&self) -> Option<MeterFrame> {
            Some(self.frame)
        }
    }

    impl OscilloscopeProvider for StaticOscilloscopeProvider {
        fn get_oscilloscope_frame(&self) -> Option<OscilloscopeFrame> {
            Some(self.frame.clone())
        }
    }

    fn test_params() -> Vec<ParameterInfo> {
        vec![
            ParameterInfo {
                id: "gain".to_string(),
                name: "Gain".to_string(),
                param_type: ParameterType::Float,
                value: 0.5,
                default: 0.5,
                min: 0.0,
                max: 1.0,
                unit: Some("dB".to_string()),
                group: Some("Input".to_string()),
            },
            ParameterInfo {
                id: "mix".to_string(),
                name: "Mix".to_string(),
                param_type: ParameterType::Float,
                value: 1.0,
                default: 1.0,
                min: 0.0,
                max: 1.0,
                unit: Some("%".to_string()),
                group: None,
            },
        ]
    }

    #[test]
    fn test_get_parameter() {
        let host = InMemoryParameterHost::new(test_params());

        let param = host.get_parameter("gain").expect("should find gain");
        assert_eq!(param.id, "gain");
        assert_eq!(param.name, "Gain");
        assert!((param.value - 0.5).abs() < f32::EPSILON);
    }

    #[test]
    fn test_set_parameter() {
        let host = InMemoryParameterHost::new(test_params());

        host.set_parameter("gain", 0.75).expect("should set gain");

        let param = host.get_parameter("gain").expect("should find gain");
        assert!((param.value - 0.75).abs() < f32::EPSILON);
    }

    #[test]
    fn test_set_parameter_out_of_range() {
        let host = InMemoryParameterHost::new(test_params());

        let result = host.set_parameter("gain", 1.5);
        assert!(result.is_err());

        let result = host.set_parameter("gain", -0.1);
        assert!(result.is_err());
    }

    #[test]
    fn test_get_all_parameters() {
        let host = InMemoryParameterHost::new(test_params());

        let params = host.get_all_parameters();
        assert_eq!(params.len(), 2);
        assert!(params.iter().any(|p| p.id == "gain"));
        assert!(params.iter().any(|p| p.id == "mix"));
    }

    #[test]
    fn test_get_meter_frame() {
        let frame = MeterFrame {
            peak_l: 0.7,
            rms_l: 0.5,
            peak_r: 0.6,
            rms_r: 0.4,
            timestamp: 0,
        };
        let provider = Arc::new(StaticMeterProvider { frame });
        let host = InMemoryParameterHost::with_meter_provider(test_params(), provider);

        let read = host.get_meter_frame().expect("should have meter frame");
        assert!((read.peak_l - 0.7).abs() < f32::EPSILON);
        assert!((read.rms_r - 0.4).abs() < f32::EPSILON);
    }

    #[test]
    fn test_get_oscilloscope_frame() {
        let frame = OscilloscopeFrame {
            points_l: vec![0.1; 1024],
            points_r: vec![0.2; 1024],
            sample_rate: 48_000.0,
            timestamp: 99,
            no_signal: false,
            trigger_mode: wavecraft_protocol::OscilloscopeTriggerMode::RisingZeroCrossing,
        };
        let provider = Arc::new(StaticOscilloscopeProvider { frame });
        let host = InMemoryParameterHost::with_oscilloscope_provider(test_params(), provider);

        let read = host
            .get_oscilloscope_frame()
            .expect("should have oscilloscope frame");
        assert_eq!(read.points_l.len(), 1024);
        assert_eq!(read.points_r.len(), 1024);
        assert_eq!(read.timestamp, 99);
    }

    #[test]
    fn test_replace_parameters_preserves_values() {
        let host = InMemoryParameterHost::new(test_params());

        // Set custom values
        host.set_parameter("gain", 0.75).expect("should set gain");
        host.set_parameter("mix", 0.5).expect("should set mix");

        // Add a new parameter
        let new_params = vec![
            ParameterInfo {
                id: "gain".to_string(),
                name: "Gain".to_string(),
                param_type: ParameterType::Float,
                value: 0.5,
                default: 0.5,
                min: 0.0,
                max: 1.0,
                unit: Some("dB".to_string()),
                group: Some("Input".to_string()),
            },
            ParameterInfo {
                id: "mix".to_string(),
                name: "Mix".to_string(),
                param_type: ParameterType::Float,
                value: 1.0,
                default: 1.0,
                min: 0.0,
                max: 1.0,
                unit: Some("%".to_string()),
                group: None,
            },
            ParameterInfo {
                id: "freq".to_string(),
                name: "Frequency".to_string(),
                param_type: ParameterType::Float,
                value: 440.0,
                default: 440.0,
                min: 20.0,
                max: 5_000.0,
                unit: Some("Hz".to_string()),
                group: None,
            },
        ];

        host.replace_parameters(new_params)
            .expect("should replace parameters");

        // Existing parameters should preserve their values
        let gain = host.get_parameter("gain").expect("should find gain");
        assert!((gain.value - 0.75).abs() < f32::EPSILON);

        let mix = host.get_parameter("mix").expect("should find mix");
        assert!((mix.value - 0.5).abs() < f32::EPSILON);

        // New parameter should have default value
        let freq = host.get_parameter("freq").expect("should find freq");
        assert!((freq.value - 440.0).abs() < f32::EPSILON);
    }

    #[test]
    fn test_replace_parameters_removes_old() {
        let host = InMemoryParameterHost::new(test_params());

        // Replace with fewer parameters
        let new_params = vec![ParameterInfo {
            id: "gain".to_string(),
            name: "Gain".to_string(),
            param_type: ParameterType::Float,
            value: 0.5,
            default: 0.5,
            min: 0.0,
            max: 1.0,
            unit: Some("dB".to_string()),
            group: Some("Input".to_string()),
        }];

        host.replace_parameters(new_params)
            .expect("should replace parameters");

        // Old parameter should be gone
        assert!(host.get_parameter("mix").is_none());

        // Kept parameter should still be accessible
        assert!(host.get_parameter("gain").is_some());
    }

    #[test]
    fn test_set_parameter_uses_declared_range_not_normalized_range() {
        let host = InMemoryParameterHost::new(vec![ParameterInfo {
            id: "oscillator_frequency".to_string(),
            name: "Frequency".to_string(),
            param_type: ParameterType::Float,
            value: 440.0,
            default: 440.0,
            min: 20.0,
            max: 5_000.0,
            unit: Some("Hz".to_string()),
            group: Some("Oscillator".to_string()),
        }]);

        host.set_parameter("oscillator_frequency", 2_000.0)
            .expect("frequency in declared range should be accepted");

        let freq = host
            .get_parameter("oscillator_frequency")
            .expect("frequency should exist");
        assert!((freq.value - 2_000.0).abs() < f32::EPSILON);

        let too_low = host.set_parameter("oscillator_frequency", 10.0);
        assert!(too_low.is_err(), "value below min should be rejected");

        let too_high = host.set_parameter("oscillator_frequency", 10_000.0);
        assert!(too_high.is_err(), "value above max should be rejected");
    }
}