audio 0.2.0

A crate for working with audio in 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
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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254

//! Traits used to generically describe and operate over slice-like types.
//!
//! This is used in for example [LinearChannel][crate::channel::LinearChannel] to allow
//! it to abstract over its content.

#![allow(clippy::len_without_is_empty)]

use core::ptr;

/// Describes how a buffer can be indexed.
pub trait SliceIndex: Slice
where
    Self: Sized,
{
    /// Get a range out of the given slice.
    #[doc(hidden)]
    fn index_from(self, index: usize) -> Self;

    /// Index to the given index.
    #[doc(hidden)]
    fn index_to(self, index: usize) -> Self;

    /// Index to the given index.
    #[doc(hidden)]
    fn index_full(self, from: usize, to: usize) -> Self;
}

/// Trait used to operate over a slice.
pub trait Slice
where
    Self: Sized,
{
    /// A single item in the slice.
    type Item: Copy;

    /// Get the length of the slice.
    #[doc(hidden)]
    fn len(&self) -> usize;

    /// Helper to reborrow the items of self.
    #[doc(hidden)]
    fn as_ref(&self) -> &[Self::Item];

    /// Get the pointer to the first element.
    #[doc(hidden)]
    fn as_ptr(&self) -> ptr::NonNull<Self::Item>;
}

/// Trait used to operate generically over a mutable slice.
pub trait SliceMut: Slice
where
    Self: Sized,
{
    /// Construct a mutable slice.
    fn as_mut(&mut self) -> &mut [Self::Item];

    /// Get the base mutable pointer.
    fn as_mut_ptr(&mut self) -> ptr::NonNull<Self::Item>;
}

impl<T> SliceIndex for &[T]
where
    T: Copy,
{
    #[inline]
    fn index_from(self, index: usize) -> Self {
        self.get(index..).unwrap_or_default()
    }

    #[inline]
    fn index_to(self, index: usize) -> Self {
        self.get(..index).unwrap_or_default()
    }

    #[inline]
    fn index_full(self, from: usize, to: usize) -> Self {
        self.get(from..to).unwrap_or_default()
    }
}

impl<T> Slice for &[T]
where
    T: Copy,
{
    type Item = T;

    #[inline]
    fn len(&self) -> usize {
        <[T]>::len(self)
    }

    #[inline]
    fn as_ref(&self) -> &[Self::Item] {
        self
    }

    #[inline]
    fn as_ptr(&self) -> ptr::NonNull<Self::Item> {
        unsafe { ptr::NonNull::new_unchecked(<[T]>::as_ptr(&self[..]) as *mut _) }
    }
}

impl<T, const N: usize> Slice for [T; N]
where
    T: Copy,
{
    type Item = T;

    #[inline]
    fn len(&self) -> usize {
        N
    }

    #[inline]
    fn as_ref(&self) -> &[Self::Item] {
        &self[..]
    }

    #[inline]
    fn as_ptr(&self) -> ptr::NonNull<Self::Item> {
        unsafe { ptr::NonNull::new_unchecked(<[T]>::as_ptr(self) as *mut _) }
    }
}

impl<T, const N: usize> Slice for &[T; N]
where
    T: Copy,
{
    type Item = T;

    #[inline]
    fn len(&self) -> usize {
        N
    }

    #[inline]
    fn as_ref(&self) -> &[Self::Item] {
        &self[..]
    }

    #[inline]
    fn as_ptr(&self) -> ptr::NonNull<Self::Item> {
        unsafe { ptr::NonNull::new_unchecked(<[T]>::as_ptr(&self[..]) as *mut _) }
    }
}

impl<T> SliceIndex for &mut [T]
where
    T: Copy,
{
    #[inline]
    fn index_from(self, index: usize) -> Self {
        self.get_mut(index..).unwrap_or_default()
    }

    #[inline]
    fn index_to(self, index: usize) -> Self {
        self.get_mut(..index).unwrap_or_default()
    }

    #[inline]
    fn index_full(self, from: usize, to: usize) -> Self {
        self.get_mut(from..to).unwrap_or_default()
    }
}

impl<T> Slice for &mut [T]
where
    T: Copy,
{
    type Item = T;

    #[inline]
    fn len(&self) -> usize {
        <[T]>::len(self)
    }

    #[inline]
    fn as_ref(&self) -> &[Self::Item] {
        &self[..]
    }

    #[inline]
    fn as_ptr(&self) -> ptr::NonNull<Self::Item> {
        unsafe { ptr::NonNull::new_unchecked(<[T]>::as_ptr(&self[..]) as *mut _) }
    }
}

impl<T, const N: usize> Slice for &mut [T; N]
where
    T: Copy,
{
    type Item = T;

    #[inline]
    fn len(&self) -> usize {
        N
    }

    #[inline]
    fn as_ref(&self) -> &[Self::Item] {
        &self[..]
    }

    #[inline]
    fn as_ptr(&self) -> ptr::NonNull<Self::Item> {
        unsafe { ptr::NonNull::new_unchecked(<[T]>::as_ptr(&self[..]) as *mut _) }
    }
}

impl<T> SliceMut for &mut [T]
where
    T: Copy,
{
    #[inline]
    fn as_mut(&mut self) -> &mut [Self::Item] {
        self
    }

    #[inline]
    fn as_mut_ptr(&mut self) -> ptr::NonNull<Self::Item> {
        unsafe { ptr::NonNull::new_unchecked(<[T]>::as_mut_ptr(self)) }
    }
}

impl<T, const N: usize> SliceMut for [T; N]
where
    T: Copy,
{
    #[inline]
    fn as_mut(&mut self) -> &mut [Self::Item] {
        self
    }

    #[inline]
    fn as_mut_ptr(&mut self) -> ptr::NonNull<Self::Item> {
        unsafe { ptr::NonNull::new_unchecked(<[T]>::as_mut_ptr(&mut self[..])) }
    }
}

impl<T, const N: usize> SliceMut for &mut [T; N]
where
    T: Copy,
{
    #[inline]
    fn as_mut(&mut self) -> &mut [Self::Item] {
        &mut self[..]
    }

    #[inline]
    fn as_mut_ptr(&mut self) -> ptr::NonNull<Self::Item> {
        unsafe { ptr::NonNull::new_unchecked(<[T]>::as_mut_ptr(&mut self[..])) }
    }
}