audio 0.2.1

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

use core::marker;
use core::ptr;

use crate::channel::{InterleavedChannel, InterleavedChannelMut};

/// An immutable iterator over an interleaved buffer.
pub struct IterChannels<'a, T> {
    ptr: ptr::NonNull<T>,
    len: usize,
    channel: usize,
    channels: usize,
    _marker: marker::PhantomData<&'a [T]>,
}

impl<T> IterChannels<'_, T> {
    /// Construct a new unchecked iterator.
    ///
    /// # Safety
    ///
    /// The caller must ensure that the pointed to buffer is a valid immutable
    /// interleaved region of data.
    pub(crate) unsafe fn new_unchecked(ptr: ptr::NonNull<T>, len: usize, channels: usize) -> Self {
        Self {
            ptr,
            len,
            channel: 0,
            channels,
            _marker: marker::PhantomData,
        }
    }
}

impl<'a, T> Iterator for IterChannels<'a, T>
where
    T: Copy,
{
    type Item = InterleavedChannel<'a, T>;

    fn next(&mut self) -> Option<Self::Item> {
        if self.channel == self.channels {
            return None;
        }

        let channel = self.channel;
        self.channel += 1;

        unsafe {
            Some(InterleavedChannel::new_unchecked(
                self.ptr,
                self.len,
                channel,
                self.channels,
            ))
        }
    }
}

/// An mutable iterator over an interleaved buffer.
pub struct IterChannelsMut<'a, T> {
    ptr: ptr::NonNull<T>,
    len: usize,
    channel: usize,
    channels: usize,
    _marker: marker::PhantomData<&'a mut [T]>,
}

impl<T> IterChannelsMut<'_, T> {
    /// Construct a new unchecked iterator.
    ///
    /// # Safety
    ///
    /// The caller must ensure that the pointed to buffer is a valid mutable
    /// interleaved region of data.
    pub(crate) unsafe fn new_unchecked(ptr: ptr::NonNull<T>, len: usize, channels: usize) -> Self {
        Self {
            ptr,
            len,
            channel: 0,
            channels,
            _marker: marker::PhantomData,
        }
    }
}

impl<'a, T> Iterator for IterChannelsMut<'a, T>
where
    T: Copy,
{
    type Item = InterleavedChannelMut<'a, T>;

    fn next(&mut self) -> Option<Self::Item> {
        if self.channel == self.channels {
            return None;
        }

        let channel = self.channel;
        self.channel += 1;

        unsafe {
            Some(InterleavedChannelMut::new_unchecked(
                self.ptr,
                self.len,
                channel,
                self.channels,
            ))
        }
    }
}