timestretch 0.5.0

Pure Rust audio time stretching library optimized for EDM
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

//! Error types for the timestretch crate.

use std::fmt;

/// Errors that can occur during time stretching.
///
/// Implements [`std::error::Error`] and [`Display`](std::fmt::Display) for
/// easy integration with error-handling crates.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum StretchError {
    /// Invalid audio format or parameters.
    InvalidFormat(String),
    /// Invalid stretch ratio.
    InvalidRatio(String),
    /// I/O error.
    IoError(String),
    /// Input too short for the given parameters.
    InputTooShort { provided: usize, minimum: usize },
    /// BPM detection failed.
    BpmDetectionFailed(String),
    /// Input contains non-finite samples (NaN or infinity).
    NonFiniteInput,
    /// Channel index out of range.
    InvalidChannelIndex { requested: usize, available: usize },
    /// Fixed-capacity buffer overflow in real-time path.
    BufferOverflow {
        buffer: &'static str,
        requested: usize,
        available: usize,
    },
    /// Processor entered an invalid state.
    InvalidState(&'static str),
}

impl fmt::Display for StretchError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            StretchError::InvalidFormat(msg) => write!(f, "invalid format: {}", msg),
            StretchError::InvalidRatio(msg) => write!(f, "invalid stretch ratio: {}", msg),
            StretchError::IoError(msg) => write!(f, "I/O error: {}", msg),
            StretchError::InputTooShort { provided, minimum } => {
                write!(
                    f,
                    "input too short: {} samples provided, {} required",
                    provided, minimum
                )
            }
            StretchError::BpmDetectionFailed(msg) => {
                write!(f, "BPM detection failed: {}", msg)
            }
            StretchError::NonFiniteInput => {
                write!(f, "input contains non-finite samples (NaN or infinity)")
            }
            StretchError::InvalidChannelIndex {
                requested,
                available,
            } => write!(
                f,
                "invalid channel index {} (available channels: {})",
                requested, available
            ),
            StretchError::BufferOverflow {
                buffer,
                requested,
                available,
            } => write!(
                f,
                "buffer overflow in {}: requested {}, available {}",
                buffer, requested, available
            ),
            StretchError::InvalidState(msg) => write!(f, "invalid state: {}", msg),
        }
    }
}

impl std::error::Error for StretchError {}

impl From<std::io::Error> for StretchError {
    fn from(err: std::io::Error) -> Self {
        StretchError::IoError(err.to_string())
    }
}