dhvani 1.0.0

Core audio engine — buffers, DSP, resampling, mixing, analysis, and capture for Rust
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

//! Error types for dhvani.

use thiserror::Error;

/// Errors that can occur during dhvani audio operations.
#[must_use]
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum NadaError {
    /// Buffer format (sample rate, channels) doesn't match expected.
    #[error("buffer format mismatch: expected {expected}, got {actual}")]
    FormatMismatch {
        /// Expected format description.
        expected: String,
        /// Actual format description.
        actual: String,
    },

    /// Buffer sample count doesn't match expected.
    #[error("buffer length mismatch: expected {expected} samples, got {actual}")]
    LengthMismatch {
        /// Expected sample count.
        expected: usize,
        /// Actual sample count.
        actual: usize,
    },

    /// Sample rate is zero or out of supported range.
    #[error("invalid sample rate: {0} Hz")]
    InvalidSampleRate(u32),

    /// Channel count is zero or exceeds maximum.
    #[error("invalid channel count: {0}")]
    InvalidChannels(u32),

    /// DSP processing error.
    #[error("DSP error: {0}")]
    Dsp(String),

    /// Audio capture/output error.
    #[error("capture error: {0}")]
    Capture(String),

    /// A parameter value is out of valid range.
    #[error("invalid parameter: {name} = {value} ({reason})")]
    InvalidParameter {
        /// Parameter name.
        name: String,
        /// Invalid value (as string).
        value: String,
        /// Why the value is invalid.
        reason: String,
    },

    /// Format conversion error.
    #[error("conversion error: {0}")]
    Conversion(String),

    /// Wrapped external error.
    #[error("{0}")]
    Other(Box<dyn std::error::Error + Send + Sync>),
}

impl From<Box<dyn std::error::Error + Send + Sync>> for NadaError {
    fn from(err: Box<dyn std::error::Error + Send + Sync>) -> Self {
        Self::Other(err)
    }
}

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

    #[test]
    fn error_display() {
        let errors = [
            NadaError::FormatMismatch {
                expected: "44100Hz".into(),
                actual: "48000Hz".into(),
            },
            NadaError::LengthMismatch {
                expected: 1024,
                actual: 512,
            },
            NadaError::InvalidSampleRate(0),
            NadaError::InvalidChannels(0),
            NadaError::Dsp("test".into()),
            NadaError::Capture("test".into()),
            NadaError::InvalidParameter {
                name: "ratio".into(),
                value: "-1".into(),
                reason: "must be positive".into(),
            },
            NadaError::Conversion("test".into()),
        ];
        for e in &errors {
            let msg = e.to_string();
            assert!(!msg.is_empty());
        }
    }

    #[test]
    fn error_from_boxed() {
        let err: Box<dyn std::error::Error + Send + Sync> = "test error".into();
        let nada: NadaError = err.into();
        assert!(nada.to_string().contains("test error"));
    }
}