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 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
//! Per-block per-channel per-sample iterators.
use std::marker::PhantomData;
#[cfg(feature = "simd")]
use std::simd::{LaneCount, Simd, SupportedLaneCount};
use super::SamplesIter;
/// An iterator over all samples in the buffer, slicing over the sample-dimension with a maximum
/// size of `max_block_size`. See [`Buffer::iter_blocks()`][super::Buffer::iter_blocks()]. Yields
/// both the block and the offset from the start of the buffer.
pub struct BlocksIter<'slice, 'sample: 'slice> {
/// The raw output buffers.
pub(super) buffers: *mut [&'sample mut [f32]],
pub(super) max_block_size: usize,
pub(super) current_block_start: usize,
pub(super) _marker: PhantomData<&'slice mut [&'sample mut [f32]]>,
}
/// A block yielded by [`BlocksIter`]. Can be iterated over once or multiple times, and also
/// supports direct access to the block's samples if needed.
pub struct Block<'slice, 'sample: 'slice> {
/// The raw output buffers.
pub(self) buffers: *mut [&'sample mut [f32]],
pub(self) current_block_start: usize,
/// The index of the last sample in the block plus one.
pub(self) current_block_end: usize,
pub(self) _marker: PhantomData<&'slice mut [&'sample mut [f32]]>,
}
/// An iterator over all channels in a block yielded by [`Block`], returning an entire channel slice
/// at a time.
pub struct BlockChannelsIter<'slice, 'sample: 'slice> {
/// The raw output buffers.
pub(self) buffers: *mut [&'sample mut [f32]],
pub(self) current_block_start: usize,
pub(self) current_block_end: usize,
pub(self) current_channel: usize,
pub(self) _marker: PhantomData<&'slice mut [&'sample mut [f32]]>,
}
impl<'slice, 'sample> Iterator for BlocksIter<'slice, 'sample> {
type Item = (usize, Block<'slice, 'sample>);
#[inline]
fn next(&mut self) -> Option<Self::Item> {
let buffer_len = unsafe { (*self.buffers).first().map(|b| b.len()).unwrap_or(0) };
if self.current_block_start < buffer_len {
let current_block_start = self.current_block_start;
let current_block_end =
(self.current_block_start + self.max_block_size).min(buffer_len);
let block = Block {
buffers: self.buffers,
current_block_start,
current_block_end,
_marker: self._marker,
};
self.current_block_start += self.max_block_size;
Some((current_block_start, block))
} else {
None
}
}
#[inline]
fn size_hint(&self) -> (usize, Option<usize>) {
let buffer_len = unsafe { (*self.buffers).first().map(|b| b.len()).unwrap_or(0) };
let remaining = (buffer_len as f32 / self.max_block_size as f32).ceil() as usize;
(remaining, Some(remaining))
}
}
impl<'slice, 'sample> IntoIterator for Block<'slice, 'sample> {
type Item = &'sample mut [f32];
type IntoIter = BlockChannelsIter<'slice, 'sample>;
#[inline]
fn into_iter(self) -> Self::IntoIter {
BlockChannelsIter {
buffers: self.buffers,
current_block_start: self.current_block_start,
current_block_end: self.current_block_end,
current_channel: 0,
_marker: self._marker,
}
}
}
impl<'slice, 'sample> Iterator for BlockChannelsIter<'slice, 'sample> {
type Item = &'sample mut [f32];
#[inline]
fn next(&mut self) -> Option<Self::Item> {
if self.current_channel < unsafe { (*self.buffers).len() } {
// SAFETY: These bounds have already been checked
// SAFETY: It is also not possible to have multiple mutable references to the same
// sample at the same time
let slice = unsafe {
(*self.buffers)
.get_unchecked_mut(self.current_channel)
.get_unchecked_mut(self.current_block_start..self.current_block_end)
};
self.current_channel += 1;
Some(slice)
} else {
None
}
}
#[inline]
fn size_hint(&self) -> (usize, Option<usize>) {
let remaining = unsafe { (*self.buffers).len() } - self.current_channel;
(remaining, Some(remaining))
}
}
impl ExactSizeIterator for BlocksIter<'_, '_> {}
impl ExactSizeIterator for BlockChannelsIter<'_, '_> {}
impl<'slice, 'sample> Block<'slice, 'sample> {
/// Get the number of samples per channel in the block.
#[inline]
pub fn samples(&self) -> usize {
self.current_block_end - self.current_block_start
}
/// Returns the number of channels in this buffer.
#[inline]
pub fn channels(&self) -> usize {
unsafe { (*self.buffers).len() }
}
/// A resetting iterator. This lets you iterate over the same block multiple times. Otherwise
/// you don't need to use this function as [`Block`] already implements [`Iterator`]. You can
/// also use the direct accessor functions on this block instead.
#[inline]
pub fn iter_mut(&mut self) -> BlockChannelsIter<'slice, 'sample> {
BlockChannelsIter {
buffers: self.buffers,
current_block_start: self.current_block_start,
current_block_end: self.current_block_end,
current_channel: 0,
_marker: self._marker,
}
}
/// Iterate over this block on a per-sample per-channel basis. This is identical to
/// [`Buffer::iter_samples()`][super::Buffer::iter_samples()] but for a smaller block instead of
/// the entire buffer
#[inline]
pub fn iter_samples(&mut self) -> SamplesIter<'slice, 'sample> {
SamplesIter {
buffers: self.buffers,
current_sample: self.current_block_start,
samples_end: self.current_block_end,
_marker: self._marker,
}
}
/// Access a channel by index. Useful when you would otherwise iterate over this [`Block`]
/// multiple times.
#[inline]
pub fn get(&self, channel_index: usize) -> Option<&[f32]> {
// SAFETY: The block bound has already been checked
unsafe {
Some(
(*self.buffers)
.get(channel_index)?
.get_unchecked(self.current_block_start..self.current_block_end),
)
}
}
/// The same as [`get()`][Self::get], but without any bounds checking.
///
/// # Safety
///
/// `channel_index` must be in the range `0..Self::len()`.
#[inline]
pub unsafe fn get_unchecked(&self, channel_index: usize) -> &[f32] {
(*self.buffers)
.get_unchecked(channel_index)
.get_unchecked(self.current_block_start..self.current_block_end)
}
/// Access a mutable channel by index. Useful when you would otherwise iterate over this
/// [`Block`] multiple times.
#[inline]
pub fn get_mut(&mut self, channel_index: usize) -> Option<&mut [f32]> {
// SAFETY: The block bound has already been checked
unsafe {
Some(
(*self.buffers)
.get_mut(channel_index)?
.get_unchecked_mut(self.current_block_start..self.current_block_end),
)
}
}
/// The same as [`get_mut()`][Self::get_mut], but without any bounds checking.
///
/// # Safety
///
/// `channel_index` must be in the range `0..Self::len()`.
#[inline]
pub unsafe fn get_unchecked_mut(&mut self, channel_index: usize) -> &mut [f32] {
(*self.buffers)
.get_unchecked_mut(channel_index)
.get_unchecked_mut(self.current_block_start..self.current_block_end)
}
/// Get a SIMD vector containing the channel data for a specific sample in this block. If `LANES
/// > channels.len()` then this will be padded with zeroes. If `LANES < channels.len()` then
/// this won't contain all values.
///
/// Returns a `None` value if `sample_index` is out of bounds.
#[cfg(feature = "simd")]
#[inline]
pub fn to_channel_simd<const LANES: usize>(
&self,
sample_index: usize,
) -> Option<Simd<f32, LANES>>
where
LaneCount<LANES>: SupportedLaneCount,
{
if sample_index > self.samples() {
return None;
}
let used_lanes = self.samples().max(LANES);
let mut values = [0.0; LANES];
for (channel_idx, value) in values.iter_mut().enumerate().take(used_lanes) {
*value = unsafe {
*(*self.buffers)
.get_unchecked(channel_idx)
.get_unchecked(self.current_block_start + sample_index)
};
}
Some(Simd::from_array(values))
}
/// Get a SIMD vector containing the channel data for a specific sample in this block. Will
/// always read exactly `LANES` channels, and does not perform bounds checks on `sample_index`.
///
/// # Safety
///
/// Undefined behavior if `LANES > block.len()` or if `sample_index > block.len()`.
#[cfg(feature = "simd")]
#[inline]
pub unsafe fn to_channel_simd_unchecked<const LANES: usize>(
&self,
sample_index: usize,
) -> Simd<f32, LANES>
where
LaneCount<LANES>: SupportedLaneCount,
{
let mut values = [0.0; LANES];
for (channel_idx, value) in values.iter_mut().enumerate() {
*value = *(*self.buffers)
.get_unchecked(channel_idx)
.get_unchecked(self.current_block_start + sample_index);
}
Simd::from_array(values)
}
/// Write data from a SIMD vector to this sample's channel data for a specific sample in this
/// block. This takes the padding added by [`to_channel_simd()`][Self::to_channel_simd()] into
/// account.
///
/// Returns `false` if `sample_index` is out of bounds.
#[cfg(feature = "simd")]
#[allow(clippy::wrong_self_convention)]
#[inline]
pub fn from_channel_simd<const LANES: usize>(
&mut self,
sample_index: usize,
vector: Simd<f32, LANES>,
) -> bool
where
LaneCount<LANES>: SupportedLaneCount,
{
if sample_index > self.samples() {
return false;
}
let used_lanes = self.samples().max(LANES);
let values = vector.to_array();
for (channel_idx, value) in values.into_iter().enumerate().take(used_lanes) {
*unsafe {
(*self.buffers)
.get_unchecked_mut(channel_idx)
.get_unchecked_mut(self.current_block_start + sample_index)
} = value;
}
true
}
/// Write data from a SIMD vector to this sample's channel data for a specific sample in this
/// block.. This assumes `LANES` matches exactly with the number of channels in the buffer, and
/// does not perform bounds checks on `sample_index`.
///
/// # Safety
///
/// Undefined behavior if `LANES > block.len()` or if `sample_index > block.len()`.
#[cfg(feature = "simd")]
#[allow(clippy::wrong_self_convention)]
#[inline]
pub unsafe fn from_channel_simd_unchecked<const LANES: usize>(
&mut self,
sample_index: usize,
vector: Simd<f32, LANES>,
) where
LaneCount<LANES>: SupportedLaneCount,
{
let values = vector.to_array();
for (channel_idx, value) in values.into_iter().enumerate() {
*(*self.buffers)
.get_unchecked_mut(channel_idx)
.get_unchecked_mut(self.current_block_start + sample_index) = value;
}
}
}