samplerate 0.2.4

A library based on libsamplerate for converting samplerates
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

use libsamplerate_sys::*;
use std::ffi::CStr;

#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
pub enum ErrorCode {
    Unknown = -1,
    NoError = 0,
    MallocFailed = 1,
    BadState = 2,
    BadData = 3,
    BadDataPtr = 4,
    NoPrivate = 5,
    BadSrcRatio = 6,
    BadProcPtr = 7,
    ShiftBits = 8,
    FilterLen = 9,
    BadConverter = 10,
    BadChannelCount = 11,
    SincBadBufferLen = 12,
    SizeIncompatibility = 13,
    BadPrivPtr = 14,
    BadSincState = 15,
    DataOverlap = 16,
    BadCallback = 17,
    BadMode = 18,
    NullCallback = 19,
    NoVariableRatio = 20,
    SincPrepareDataBadLen = 21,
    BadInternalState = 22,
    MaxError = 23,
}

impl ErrorCode {
    /// Create a new `ConverterType` enum from the corresponding integer.
    pub fn from_int(value: i32) -> ErrorCode {
        match value {
            0 => ErrorCode::NoError,
            1 => ErrorCode::MallocFailed,
            2 => ErrorCode::BadState,
            3 => ErrorCode::BadData,
            4 => ErrorCode::BadDataPtr,
            5 => ErrorCode::NoPrivate,
            6 => ErrorCode::BadSrcRatio,
            7 => ErrorCode::BadProcPtr,
            8 => ErrorCode::ShiftBits,
            9 => ErrorCode::FilterLen,
            10 => ErrorCode::BadConverter,
            11 => ErrorCode::BadChannelCount,
            12 => ErrorCode::SincBadBufferLen,
            13 => ErrorCode::SizeIncompatibility,
            14 => ErrorCode::BadPrivPtr,
            15 => ErrorCode::BadSincState,
            16 => ErrorCode::DataOverlap,
            17 => ErrorCode::BadCallback,
            18 => ErrorCode::BadMode,
            19 => ErrorCode::NullCallback,
            20 => ErrorCode::NoVariableRatio,
            21 => ErrorCode::SincPrepareDataBadLen,
            22 => ErrorCode::BadInternalState,
            23 => ErrorCode::MaxError,
            _ => ErrorCode::Unknown,
        }
    }

    /// Return the human-readable description for this error.
    pub fn description(&self) -> &'static str {
        match self {
            ErrorCode::Unknown => "Unkown error.",
            _ => unsafe {
                CStr::from_ptr(src_strerror(*self as i32))
            }.to_str().unwrap()
        }
    }
}

#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
pub struct Error {
    code: ErrorCode,
}

impl Error {
    pub fn from_int(code: i32) -> Error {
        Error {
            code: ErrorCode::from_int(code),
        }
    }

    pub fn from_code(code: ErrorCode) -> Error {
        Error { code }
    }

    pub fn code(&self) -> ErrorCode {
        self.code
    }

    pub fn description(&self) -> &'static str {
        self.code.description()
    }
}

impl std::fmt::Display for Error {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        write!(f, "{}", self.description())
    }
}

impl std::error::Error for Error {
    fn description(&self) -> &str {
        &self.code.description()
    }
}

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

    #[test]
    fn create_converter_type_from_int() {
        assert_eq!(ErrorCode::from_int(0), ErrorCode::NoError);
        assert_eq!(ErrorCode::from_int(1), ErrorCode::MallocFailed);
        assert_eq!(ErrorCode::from_int(2), ErrorCode::BadState);
        assert_eq!(ErrorCode::from_int(3), ErrorCode::BadData);
        assert_eq!(ErrorCode::from_int(4), ErrorCode::BadDataPtr);
        assert_eq!(ErrorCode::from_int(5), ErrorCode::NoPrivate);
        assert_eq!(ErrorCode::from_int(6), ErrorCode::BadSrcRatio);
        assert_eq!(ErrorCode::from_int(7), ErrorCode::BadProcPtr);
        assert_eq!(ErrorCode::from_int(8), ErrorCode::ShiftBits);
        assert_eq!(ErrorCode::from_int(9), ErrorCode::FilterLen);
        assert_eq!(ErrorCode::from_int(10), ErrorCode::BadConverter);
        assert_eq!(ErrorCode::from_int(11), ErrorCode::BadChannelCount);
        assert_eq!(ErrorCode::from_int(12), ErrorCode::SincBadBufferLen);
        assert_eq!(ErrorCode::from_int(13), ErrorCode::SizeIncompatibility);
        assert_eq!(ErrorCode::from_int(14), ErrorCode::BadPrivPtr);
        assert_eq!(ErrorCode::from_int(15), ErrorCode::BadSincState);
        assert_eq!(ErrorCode::from_int(16), ErrorCode::DataOverlap);
        assert_eq!(ErrorCode::from_int(17), ErrorCode::BadCallback);
        assert_eq!(ErrorCode::from_int(18), ErrorCode::BadMode);
        assert_eq!(ErrorCode::from_int(19), ErrorCode::NullCallback);
        assert_eq!(ErrorCode::from_int(20), ErrorCode::NoVariableRatio);
        assert_eq!(ErrorCode::from_int(21), ErrorCode::SincPrepareDataBadLen);
        assert_eq!(ErrorCode::from_int(22), ErrorCode::BadInternalState);
        assert_eq!(ErrorCode::from_int(23), ErrorCode::MaxError);
        assert_eq!(ErrorCode::from_int(24), ErrorCode::Unknown);
    }

    #[test]
    fn description() {
        assert_eq!(ErrorCode::NoError.description(), "No error.");
        assert_eq!(ErrorCode::MallocFailed.description(), "Malloc failed.");
        assert_eq!(ErrorCode::BadState.description(), "SRC_STATE pointer is NULL.");
        assert_eq!(ErrorCode::BadData.description(), "SRC_DATA pointer is NULL.");
        assert_eq!(ErrorCode::BadDataPtr.description(), "SRC_DATA->data_out or SRC_DATA->data_in is NULL.");
        assert_eq!(ErrorCode::NoPrivate.description(), "Internal error. No private data.");
        assert_eq!(ErrorCode::BadSrcRatio.description(), "SRC ratio outside [1/256, 256] range.");
        assert_eq!(ErrorCode::BadSincState.description(), "src_process() called without reset after end_of_input.");
        assert_eq!(ErrorCode::BadProcPtr.description(), "Internal error. No process pointer.");
        assert_eq!(ErrorCode::ShiftBits.description(), "Internal error. SHIFT_BITS too large.");
        assert_eq!(ErrorCode::FilterLen.description(), "Internal error. Filter length too large.");
        assert_eq!(ErrorCode::BadConverter.description(), "Bad converter number.");
        assert_eq!(ErrorCode::BadChannelCount.description(), "Channel count must be >= 1.");
        assert_eq!(ErrorCode::SincBadBufferLen.description(), "Internal error. Bad buffer length. Please report this.");
        assert_eq!(ErrorCode::SizeIncompatibility.description(), "Internal error. Input data / internal buffer size difference. Please report this.");
        assert_eq!(ErrorCode::BadPrivPtr.description(), "Internal error. Private pointer is NULL. Please report this.");
        assert_eq!(ErrorCode::DataOverlap.description(), "Input and output data arrays overlap.");
        assert_eq!(ErrorCode::BadCallback.description(), "Supplied callback function pointer is NULL.");
        assert_eq!(ErrorCode::BadMode.description(), "Calling mode differs from initialisation mode (ie process v callback).");
        assert_eq!(ErrorCode::NullCallback.description(), "Callback function pointer is NULL in src_callback_read ().");
        assert_eq!(ErrorCode::NoVariableRatio.description(), "This converter only allows constant conversion ratios.");
        assert_eq!(ErrorCode::SincPrepareDataBadLen.description(), "Internal error : Bad length in prepare_data ().");
        assert_eq!(ErrorCode::BadInternalState.description(), "Error : Someone is trampling on my internal state.");
        assert_eq!(ErrorCode::MaxError.description(), "Placeholder. No error defined for this error number.");
        assert_eq!(ErrorCode::Unknown.description(), "Unkown error.");
    }

    #[test]
    fn error_from_code_and_int() {
        assert_eq!(Error::from_int(2), Error::from_code(ErrorCode::BadState));
    }

    #[test]
    fn error_description() {
        for i in -1..24 {
            assert_eq!(Error::from_int(i).description(), ErrorCode::from_int(i).description());
        }
    }
}