voirs-spatial 0.1.0-rc.1

3D spatial audio and HRTF processing for VoiRS
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

//! Audio-visual synchronization types and state management

use serde::{Deserialize, Serialize};
use std::time::{Duration, Instant};

/// Visual synchronization settings
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VisualSyncSettings {
    /// Audio-visual latency compensation (ms)
    pub latency_compensation: f32,

    /// Synchronization tolerance (ms)
    pub sync_tolerance: f32,

    /// Visual prediction lookahead (ms)
    pub prediction_lookahead: f32,

    /// Frame rate synchronization
    pub frame_sync: bool,

    /// V-sync enable
    pub vsync: bool,
}

/// Visual synchronization state
pub(crate) struct VisualSyncState {
    /// Audio timeline reference
    pub(crate) audio_timeline: Instant,

    /// Visual timeline reference
    pub(crate) visual_timeline: Instant,

    /// Measured latency offset
    pub(crate) measured_latency: Duration,

    /// Frame timing buffer
    pub(crate) frame_timing: Vec<FrameTiming>,

    /// Sync quality metrics
    pub(crate) sync_quality: SyncQualityMetrics,
}

/// Frame timing information
#[derive(Debug, Clone)]
pub(crate) struct FrameTiming {
    /// Frame timestamp
    pub(crate) timestamp: Instant,

    /// Frame duration
    pub(crate) duration: Duration,

    /// Audio-visual offset
    pub(crate) av_offset: Duration,

    /// Sync quality score
    pub(crate) quality_score: f32,
}

/// Synchronization quality metrics
#[derive(Debug, Clone)]
pub(crate) struct SyncQualityMetrics {
    /// Average sync error (ms)
    pub(crate) avg_sync_error: f32,

    /// Maximum sync error (ms)
    pub(crate) max_sync_error: f32,

    /// Sync stability (coefficient of variation)
    pub(crate) sync_stability: f32,

    /// Frames in sync (percentage)
    pub(crate) frames_in_sync: f32,
}

// Default implementations

impl Default for VisualSyncSettings {
    fn default() -> Self {
        Self {
            latency_compensation: 10.0, // 10ms default compensation
            sync_tolerance: 5.0,
            prediction_lookahead: 50.0,
            frame_sync: true,
            vsync: true,
        }
    }
}

impl VisualSyncState {
    pub(crate) fn new() -> Self {
        let now = Instant::now();
        Self {
            audio_timeline: now,
            visual_timeline: now,
            measured_latency: Duration::from_millis(10),
            frame_timing: Vec::new(),
            sync_quality: SyncQualityMetrics {
                avg_sync_error: 0.0,
                max_sync_error: 0.0,
                sync_stability: 1.0,
                frames_in_sync: 100.0,
            },
        }
    }
}