spectrograms 1.1.0

High-performance FFT-based computations for audio and image processing
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

/// Error types for the spectrogram library.
use thiserror::Error;

pub type SpectrogramResult<T> = Result<T, SpectrogramError>;

/// Represents errors that can occur in the spectrogram library.
///
/// Variants:
/// - `InvalidInput`: Indicates that the provided input is invalid.
/// - `DimensionMismatch`: Indicates a mismatch in expected and actual dimensions.
/// - `FftBackendError`: Represents errors originating from the FFT backend.
///
#[derive(Debug, Error, Clone)]
#[non_exhaustive]
pub enum SpectrogramError {
    /// The input provided to the spectrogram function is invalid.
    #[error("Invalid input: {0}")]
    InvalidInput(String),
    /// The dimensions provided do not match the expected dimensions.
    #[error("Dimension mismatch: expected {expected}, got {got}")]
    DimensionMismatch { expected: usize, got: usize },
    /// An error originating from the FFT backend.
    #[error("{backend} -- FFT backend error: {msg}")]
    FftBackendError { backend: &'static str, msg: String },
    /// An internal error occurred within the spectrogram library.
    #[error("Internal error: {0}")]
    InternalError(String),
}

impl SpectrogramError {
    /// Create an FFT backend error based on the given backend and message.
    ///
    /// # Arguments
    /// * `backend` - The name of the FFT backend (e.g., "fftw", "realfft").
    /// * `msg` - The error message from the backend.
    ///
    /// # Returns
    /// A `SpectrogramError::FftBackendError` variant containing the backend name and message.
    #[inline]
    pub fn fft_backend<S: Into<String>>(backend: &'static str, msg: S) -> Self {
        Self::FftBackendError {
            backend,
            msg: msg.into(),
        }
    }

    /// Create an invalid input error.
    ///
    /// # Arguments
    /// * `msg` - The error message describing the invalid input.
    ///
    /// # Type Parameters
    /// * `S` - A type that can be converted into a `String`.
    ///
    /// # Returns
    /// A `SpectrogramError::InvalidInput` variant containing the message.
    #[inline]
    pub fn invalid_input<S: Into<String>>(msg: S) -> Self {
        Self::InvalidInput(msg.into())
    }

    /// Create a dimension mismatch error.
    ///
    /// # Arguments
    /// * `expected` - The expected dimension size.
    /// * `got` - The actual dimension size received.
    ///
    /// # Returns
    /// A `SpectrogramError::DimensionMismatch` variant containing the expected and actual sizes.
    #[inline]
    #[must_use]
    pub const fn dimension_mismatch(expected: usize, got: usize) -> Self {
        Self::DimensionMismatch { expected, got }
    }

    /// Create an internal error.
    ///
    /// # Arguments
    /// * `msg` - The error message describing the internal error.
    ///
    /// # Type Parameters
    /// * `S` - A type that can be converted into a `String`.
    ///
    /// # Returns
    /// A `SpectrogramError::InternalError` variant containing the message.
    #[inline]
    pub fn internal_error<S: Into<String>>(msg: S) -> Self {
        Self::InternalError(msg.into())
    }
}