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
/// Trait used to govern sequential reading of an audio buffer. /// /// This is the "in" part of "buffered I/O". It allows for buffers to govern /// which slice of frames in them has been read so that operations can be /// performed in multiple stages. /// /// This can be accomplished manually using available buffer combinators such as /// [Buf::tail][crate::Buf::tail]. But buffered I/O allows us to do this in a /// much more structured fashion. /// /// # Examples /// /// ```rust /// use audio::ReadBuf as _; /// use audio::{io, wrap}; /// # fn send_data(buf: &mut [i16]) {} /// /// // A simple mutable buffer we want to write to. Fits 2 channels with 64 /// // frames each. /// let mut to = [0i16; 128]; /// /// // A buffer we want to read from. 2 channels with 512 frames each. /// let from = audio::interleaved![[0i16; 512]; 2]; /// let mut from = io::Read::new(from); /// /// let mut steps = 0; /// /// while from.has_remaining() { /// // Wrap the output buffer according to format so it can be written to /// // correctly. /// io::copy_remaining(&mut from, wrap::interleaved(&mut to[..], 2)); /// /// send_data(&mut to[..]); /// /// steps += 1; /// } /// /// // We needed to write 8 times to copy our entire buffer. /// assert_eq!(steps, 8); /// ``` pub trait ReadBuf { /// Test if there are any remaining frames to read. /// /// # Examples /// /// ```rust /// use audio::ReadBuf as _; /// /// let mut buffer = audio::wrap::interleaved(&[0, 1, 2, 3, 4, 5, 6, 7][..], 2); /// /// assert!(buffer.has_remaining()); /// assert_eq!(buffer.remaining(), 4); /// buffer.advance(4); /// assert_eq!(buffer.remaining(), 0); /// ``` fn has_remaining(&self) -> bool { self.remaining() > 0 } /// Get the number of frames remaining that can be read from the buffer. /// /// # Examples /// /// ```rust /// use audio::ReadBuf as _; /// /// let buffer = audio::wrap::interleaved(&[0, 1, 2, 3, 4, 5, 6, 7][..], 2); /// /// assert_eq!(buffer.remaining(), 4); /// ``` fn remaining(&self) -> usize; /// Advance the read number of frames by `n`. /// /// # Examples /// /// ```rust /// use audio::ReadBuf as _; /// /// let mut buffer = audio::wrap::interleaved(&[0, 1, 2, 3, 4, 5, 6, 7][..], 2); /// /// assert_eq!(buffer.remaining(), 4); /// buffer.advance(2); /// assert_eq!(buffer.remaining(), 2); /// ``` fn advance(&mut self, n: usize); } impl<B> ReadBuf for &'_ mut B where B: ReadBuf, { fn has_remaining(&self) -> bool { (**self).has_remaining() } fn remaining(&self) -> usize { (**self).remaining() } fn advance(&mut self, n: usize) { (**self).advance(n); } } /// Trait used to govern sequential writing to an audio buffer. /// /// This is the "out" part of "buffered I/O". It allows for buffers to govern /// which slice of frames in them has been read so that operations can be /// performed in multiple stages. /// /// This can be accomplished manually using available buffer combinators such as /// [Buf::tail][crate::Buf::tail]. But buffered I/O allows us to do this in a /// much more structured fashion. /// /// # Examples /// /// ```rust /// use audio::WriteBuf as _; /// use audio::{io, wrap}; /// # fn recv_data(buf: &mut [i16]) {} /// /// // A simple buffer we want to read from to. Fits 2 channels with 64 /// // frames each. /// let mut from = [0i16; 128]; /// /// // A buffer we want to write to. 2 channels with 512 frames each. /// let to = audio::interleaved![[0i16; 512]; 2]; /// let mut to = io::Write::new(to); /// /// let mut steps = 0; /// /// while to.has_remaining_mut() { /// // Fill the buffer with something interesting. /// recv_data(&mut from[..]); /// /// // Wrap the filled buffer according to format so it can be written to /// // correctly. /// io::copy_remaining(wrap::interleaved(&mut from[..], 2), &mut to); /// /// steps += 1; /// } /// /// // We needed to write 8 times to fill our entire buffer. /// assert_eq!(steps, 8); /// ``` pub trait WriteBuf { /// Test if this buffer has remaining mutable frames that can be written. /// /// # Examples /// /// ```rust /// use audio::WriteBuf as _; /// /// let mut buffer = [0, 1, 2, 3, 4, 5, 6, 7]; /// let mut buffer = audio::wrap::interleaved(&mut buffer[..], 2); /// /// assert!(buffer.has_remaining_mut()); /// assert_eq!(buffer.remaining_mut(), 4); /// buffer.advance_mut(4); /// assert_eq!(buffer.remaining_mut(), 0); /// ``` fn has_remaining_mut(&self) -> bool { self.remaining_mut() > 0 } /// Remaining number of frames that can be written. /// /// # Examples /// /// ```rust /// use audio::WriteBuf as _; /// /// let mut buffer = [0, 1, 2, 3, 4, 5, 6, 7]; /// let buffer = audio::wrap::interleaved(&mut buffer[..], 2); /// /// assert_eq!(buffer.remaining_mut(), 4); /// ``` fn remaining_mut(&self) -> usize; /// Advance the number of frames that have been written. /// /// # Examples /// /// ```rust /// use audio::WriteBuf as _; /// /// let mut buffer = [0, 1, 2, 3, 4, 5, 6, 7]; /// let mut buffer = audio::wrap::interleaved(&mut buffer[..], 2); /// /// assert_eq!(buffer.remaining_mut(), 4); /// buffer.advance_mut(2); /// assert_eq!(buffer.remaining_mut(), 2); /// ``` fn advance_mut(&mut self, n: usize); } impl<B> WriteBuf for &'_ mut B where B: WriteBuf, { fn has_remaining_mut(&self) -> bool { (**self).has_remaining_mut() } fn remaining_mut(&self) -> usize { (**self).remaining_mut() } fn advance_mut(&mut self, n: usize) { (**self).advance_mut(n); } }