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 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
//! A dynamically sized, multi-channel interleaved audio buffer. use crate::buf::{Buf, BufMut}; use crate::sample::Sample; use crate::wrap; use std::cmp; use std::fmt; use std::hash; use std::marker; use std::ptr; mod channel; pub use self::channel::{Channel, ChannelMut}; use self::channel::{RawChannelMut, RawChannelRef}; mod iter; pub use self::iter::{Iter, IterMut}; /// A dynamically sized, multi-channel interleaved audio buffer. /// /// An audio buffer is constrained to only support sample-apt types. For more /// information of what this means, see [Sample]. /// /// An *interleaved* audio buffer stores all audio data interleaved in memory, /// one sample from each channel in sequence until we're out of samples. This /// naturally makes the buffer a bit harder to work with, and we have to rely on /// iterators to access logical channels. /// /// Resized regions aren't zeroed, so certain operations might cause stale data /// to be visible after a resize. /// /// ```rust /// let mut buffer = rotary::Interleaved::<f32>::with_topology(2, 4); /// /// for (c, s) in buffer /// .get_mut(0) /// .unwrap() /// .iter_mut() /// .zip(&[1.0, 2.0, 3.0, 4.0]) /// { /// *c = *s; /// } /// /// for (c, s) in buffer /// .get_mut(1) /// .unwrap() /// .iter_mut() /// .zip(&[5.0, 6.0, 7.0, 8.0]) /// { /// *c = *s; /// } /// /// assert_eq!(buffer.as_slice(), &[1.0, 5.0, 2.0, 6.0, 3.0, 7.0, 4.0, 8.0]); /// ``` pub struct Interleaved<T> where T: Sample, { data: Vec<T>, channels: usize, frames: usize, } impl<T> Interleaved<T> where T: Sample, { /// Construct a new empty audio buffer. /// /// # Examples /// /// ```rust /// let mut buffer = rotary::Interleaved::<f32>::new(); /// /// assert_eq!(buffer.frames(), 0); /// ``` pub fn new() -> Self { Self { data: Vec::new(), channels: 0, frames: 0, } } /// Allocate an audio buffer with the given topology. A "topology" is a /// given number of `channels` and the corresponding number of `frames` in /// their buffers. /// /// # Examples /// /// ```rust /// let mut buffer = rotary::Interleaved::<f32>::with_topology(4, 256); /// /// assert_eq!(buffer.frames(), 256); /// assert_eq!(buffer.channels(), 4); /// ``` pub fn with_topology(channels: usize, frames: usize) -> Self { Self { data: vec![T::ZERO; channels * frames], channels, frames, } } /// Allocate an audio buffer from a fixed-size array. /// /// See [dynamic!]. /// /// # Examples /// /// ```rust /// use rotary::BitSet; /// /// let mut buffer = rotary::interleaved![[2.0; 256]; 4]; /// /// assert_eq!(buffer.frames(), 256); /// assert_eq!(buffer.channels(), 4); /// /// for chan in &buffer { /// assert!(chan.iter().eq(&[2.0; 256][..])); /// } /// ``` pub fn from_vec(data: Vec<T>, channels: usize, frames: usize) -> Self { Self { data, channels, frames, } } /// Take ownership of the backing vector. /// /// # Examples /// /// ```rust /// let mut buffer = rotary::Interleaved::<f32>::with_topology(2, 4); /// /// for (c, s) in buffer.get_mut(0).unwrap().iter_mut().zip(&[1.0, 2.0, 3.0, 4.0]) { /// *c = *s; /// } /// /// for (c, s) in buffer.get_mut(1).unwrap().iter_mut().zip(&[1.0, 2.0, 3.0, 4.0]) { /// *c = *s; /// } /// /// buffer.resize(3); /// /// assert_eq!(buffer.into_vec(), vec![1.0, 1.0, 2.0, 2.0, 3.0, 3.0]) /// ``` pub fn into_vec(self) -> Vec<T> { self.data } /// Access the underlying vector as a slice. /// /// # Examples /// /// ```rust /// let mut buffer = rotary::Interleaved::<f32>::with_topology(2, 4); /// /// for (c, s) in buffer.get_mut(0).unwrap().iter_mut().zip(&[1.0, 2.0, 3.0, 4.0]) { /// *c = *s; /// } /// /// for (c, s) in buffer.get_mut(1).unwrap().iter_mut().zip(&[1.0, 2.0, 3.0, 4.0]) { /// *c = *s; /// } /// /// buffer.resize(3); /// /// assert_eq!(buffer.as_slice(), &[1.0, 1.0, 2.0, 2.0, 3.0, 3.0]) /// ``` pub fn as_slice(&self) -> &[T] { &self.data } /// Get the number of frames in the channels of an audio buffer. /// /// # Examples /// /// ```rust /// let mut buffer = rotary::Interleaved::<f32>::new(); /// /// assert_eq!(buffer.frames(), 0); /// buffer.resize(256); /// assert_eq!(buffer.frames(), 256); /// ``` pub fn frames(&self) -> usize { self.frames } /// Check how many channels there are in the buffer. /// /// # Examples /// /// ```rust /// let mut buffer = rotary::Interleaved::<f32>::new(); /// /// assert_eq!(buffer.channels(), 0); /// buffer.resize_channels(2); /// assert_eq!(buffer.channels(), 2); /// ``` pub fn channels(&self) -> usize { self.channels } /// Offset the interleaved buffer and return a wrapped buffer. /// /// This is provided as a special operation for this buffer kind, because it /// can be done more efficiently than what is available through /// [Buf::offset]. pub fn interleaved_offset(&self, offset: usize) -> wrap::Interleaved<&[T]> { wrap::interleaved(&self.data[offset * self.channels..], self.channels) } /// Offset the interleaved buffer and return a mutable wrapped buffer. /// /// This is provided as a special operation for this buffer kind, because it /// can be done more efficiently than what is available through /// [Buf::offset]. /// /// # Examples /// /// ```rust /// use rotary::{Buf as _, BufMut as _}; /// /// let mut buffer = rotary::Interleaved::with_topology(2, 4); /// /// buffer.interleaved_offset_mut(2).channel_mut(0).copy_from_slice(&[1.0, 1.0]); /// /// assert_eq!(buffer.as_slice(), &[0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 1.0, 0.0]) /// ``` pub fn interleaved_offset_mut(&mut self, offset: usize) -> wrap::Interleaved<&mut [T]> { wrap::interleaved(&mut self.data[offset * self.channels..], self.channels) } /// Limit the interleaved buffer and return a wrapped buffer. /// /// This is provided as a special operation for this buffer kind, because it /// can be done more efficiently than what is available through /// [Buf::limit]. /// /// # Examples /// /// ```rust /// use rotary::{Buf as _, BufMut as _}; /// /// let from = rotary::interleaved![[1.0f32; 4]; 2]; /// let mut to = rotary::Interleaved::<f32>::with_topology(2, 4); /// /// to.channel_mut(0).copy_from(from.interleaved_limit(2).channel(0)); /// assert_eq!(to.as_slice(), &[1.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 0.0]); /// ``` pub fn interleaved_limit(&self, limit: usize) -> wrap::Interleaved<&[T]> { wrap::interleaved(&self.data[..limit * self.channels], self.channels) } /// Limit the interleaved buffer and return a mutable wrapped buffer. /// /// This is provided as a special operation for this buffer kind, because it /// can be done more efficiently than what is available through /// [Buf::limit]. pub fn interleaved_limit_mut(&mut self, limit: usize) -> wrap::Interleaved<&mut [T]> { wrap::interleaved(&mut self.data[..limit * self.channels], self.channels) } /// Resize to the given number of channels in use. /// /// If the size of the buffer increases as a result, the new channels will /// be zeroed. If the size decreases, the channels that falls outside of the /// new size will be dropped. /// /// # Examples /// /// ```rust /// let mut buffer = rotary::Interleaved::<f32>::new(); /// /// assert_eq!(buffer.channels(), 0); /// assert_eq!(buffer.frames(), 0); /// /// buffer.resize_channels(4); /// buffer.resize(256); /// /// assert_eq!(buffer.channels(), 4); /// assert_eq!(buffer.frames(), 256); /// ``` pub fn resize_channels(&mut self, channels: usize) { self.inner_resize(channels, self.frames); } /// Set the size of the buffer. The size is the size of each channel's /// buffer. /// /// If the size of the buffer increases as a result, the new regions in the /// frames will be zeroed. If the size decreases, the region will be left /// untouched. So if followed by another increase, the data will be "dirty". /// /// # Examples /// /// ```rust /// let mut buffer = rotary::Interleaved::<f32>::new(); /// /// assert_eq!(buffer.channels(), 0); /// assert_eq!(buffer.frames(), 0); /// /// buffer.resize_channels(4); /// buffer.resize(256); /// /// assert_eq!(buffer.channels(), 4); /// assert_eq!(buffer.frames(), 256); /// /// { /// let mut chan = buffer.get_mut(1).unwrap(); /// /// assert_eq!(chan.get(127), Some(0.0)); /// *chan.get_mut(127).unwrap() = 42.0; /// assert_eq!(chan.get(127), Some(42.0)); /// } /// /// buffer.resize(128); /// assert_eq!(buffer.frame(1, 127), Some(42.0)); /// /// buffer.resize(256); /// assert_eq!(buffer.frame(1, 127), Some(42.0)); /// /// buffer.resize_channels(2); /// assert_eq!(buffer.frame(1, 127), Some(42.0)); /// /// buffer.resize(64); /// assert_eq!(buffer.frame(1, 127), None); /// ``` pub fn resize(&mut self, frames: usize) { self.inner_resize(self.channels, frames); } /// Get a reference to a channel. /// /// # Examples /// /// ```rust /// let mut buffer = rotary::Interleaved::<f32>::with_topology(2, 4); /// /// for (c, s) in buffer.get_mut(0).unwrap().iter_mut().zip(&[1.0, 2.0, 3.0, 4.0]) { /// *c = *s; /// } /// /// for (c, s) in buffer.get_mut(1).unwrap().iter_mut().zip(&[5.0, 6.0, 7.0, 8.0]) { /// *c = *s; /// } /// /// assert_eq!(buffer.get(0).unwrap().iter().nth(2), Some(&3.0)); /// assert_eq!(buffer.get(1).unwrap().iter().nth(2), Some(&7.0)); /// ``` pub fn get(&self, channel: usize) -> Option<Channel<'_, T>> { if channel < self.channels { Some(Channel { inner: RawChannelRef { buffer: self.data.as_ptr(), channel, channels: self.channels, frames: self.frames, }, _marker: marker::PhantomData, }) } else { None } } /// Helper to access a single frame in a single channel. /// /// # Examples /// /// ```rust /// let mut buffer = rotary::Interleaved::<f32>::with_topology(2, 256); /// /// assert_eq!(buffer.frame(1, 128), Some(0.0)); /// *buffer.frame_mut(1, 128).unwrap() = 1.0; /// assert_eq!(buffer.frame(1, 128), Some(1.0)); /// ``` pub fn frame(&self, channel: usize, frame: usize) -> Option<T> { self.get(channel)?.get(frame) } /// Get a mutable reference to a channel. /// /// # Examples /// /// ```rust /// let mut buffer = rotary::Interleaved::<f32>::with_topology(2, 4); /// /// for (c, s) in buffer.get_mut(0).unwrap().iter_mut().zip(&[1.0, 2.0, 3.0, 4.0]) { /// *c = *s; /// } /// /// for (c, s) in buffer.get_mut(1).unwrap().iter_mut().zip(&[5.0, 6.0, 7.0, 8.0]) { /// *c = *s; /// } /// /// assert_eq!(buffer.as_slice(), &[1.0, 5.0, 2.0, 6.0, 3.0, 7.0, 4.0, 8.0]); /// ``` pub fn get_mut(&mut self, channel: usize) -> Option<ChannelMut<'_, T>> { if channel < self.channels { Some(ChannelMut { inner: RawChannelMut { buffer: self.data.as_mut_ptr(), channel, channels: self.channels, frames: self.frames, }, _marker: marker::PhantomData, }) } else { None } } /// Helper to access a single frame in a single channel mutably. /// /// # Examples /// /// ```rust /// let mut buffer = rotary::Interleaved::<f32>::with_topology(2, 256); /// /// assert_eq!(buffer.frame(1, 128), Some(0.0)); /// *buffer.frame_mut(1, 128).unwrap() = 1.0; /// assert_eq!(buffer.frame(1, 128), Some(1.0)); /// ``` pub fn frame_mut(&mut self, channel: usize, frame: usize) -> Option<&mut T> { self.get_mut(channel)?.into_mut(frame) } /// Construct an iterator over all available channels. /// /// # Examples /// /// ```rust /// let mut buffer = rotary::Interleaved::<f32>::with_topology(2, 4); /// /// let mut it = buffer.iter_mut(); /// /// for (c, f) in it.next().unwrap().iter_mut().zip(&[1.0, 2.0, 3.0, 4.0]) { /// *c = *f; /// } /// /// for (c, f) in it.next().unwrap().iter_mut().zip(&[5.0, 6.0, 7.0, 8.0]) { /// *c = *f; /// } /// /// let channels = buffer.iter().collect::<Vec<_>>(); /// let left = channels[0].iter().copied().collect::<Vec<_>>(); /// let right = channels[1].iter().copied().collect::<Vec<_>>(); /// /// assert_eq!(left, &[1.0, 2.0, 3.0, 4.0]); /// assert_eq!(right, &[5.0, 6.0, 7.0, 8.0]); /// ``` pub fn iter(&self) -> Iter<'_, T> { Iter { buffer: self.data.as_ptr(), channel: 0, channels: self.channels, frames: self.frames, _marker: marker::PhantomData, } } /// Construct a mutable iterator over all available channels. /// /// # Examples /// /// ```rust /// let mut buffer = rotary::Interleaved::<f32>::with_topology(2, 4); /// /// let mut it = buffer.iter_mut(); /// /// for (c, f) in it.next().unwrap().iter_mut().zip(&[1.0, 2.0, 3.0, 4.0]) { /// *c = *f; /// } /// /// for (c, f) in it.next().unwrap().iter_mut().zip(&[5.0, 6.0, 7.0, 8.0]) { /// *c = *f; /// } /// /// assert_eq!(buffer.as_slice(), &[1.0, 5.0, 2.0, 6.0, 3.0, 7.0, 4.0, 8.0]); /// ``` pub fn iter_mut(&mut self) -> IterMut<'_, T> { IterMut { buffer: self.data.as_mut_ptr(), channel: 0, channels: self.channels, frames: self.frames, _marker: marker::PhantomData, } } /// The internal resize function for interleaved channel buffers. fn inner_resize(&mut self, channels: usize, frames: usize) { if self.channels == channels && self.frames == frames { return; } let old_cap = self.data.capacity(); let new_cap = frames * channels; if new_cap > old_cap { self.data.reserve(new_cap - old_cap); let new_cap = self.data.capacity(); // Safety: capacity is governed by the underlying vector. unsafe { ptr::write_bytes(self.data.as_mut_ptr().add(old_cap), 0, new_cap - old_cap); } } if self.channels != channels { let len = usize::min(self.channels, channels); // Safety: We trust the known lengths lengths. unsafe { if channels < self.channels { self.inner_shuffle_channels(1..frames, len, channels); } else { self.inner_shuffle_channels((1..frames).rev(), len, channels); } } } // Safety: since we're decreasing the number of frames we're sure // that the data for them is already allocated. unsafe { self.data.set_len(frames * channels); } self.channels = channels; self.frames = frames; } /// Internal function to re-shuffle channels. /// /// # Safety /// /// The caller must ensure that the ranges of frames, the length and that /// the updates `channels` argument is validly within the buffer. #[inline] unsafe fn inner_shuffle_channels<F>(&mut self, frames: F, len: usize, channels: usize) where F: IntoIterator<Item = usize>, { let base = self.data.as_mut_ptr(); for f in frames { let from = f * self.channels; let to = f * channels; ptr::copy(base.add(from), base.add(to), len) } } } impl<T> fmt::Debug for Interleaved<T> where T: Sample + fmt::Debug, { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { f.debug_list().entries(self.iter()).finish() } } impl<T> cmp::PartialEq for Interleaved<T> where T: Sample + cmp::PartialEq, { fn eq(&self, other: &Self) -> bool { self.iter().eq(other.iter()) } } impl<T> cmp::Eq for Interleaved<T> where T: Sample + cmp::Eq {} impl<T> cmp::PartialOrd for Interleaved<T> where T: Sample + cmp::PartialOrd, { fn partial_cmp(&self, other: &Self) -> Option<cmp::Ordering> { self.iter().partial_cmp(other.iter()) } } impl<T> cmp::Ord for Interleaved<T> where T: Sample + cmp::Ord, { fn cmp(&self, other: &Self) -> cmp::Ordering { self.iter().cmp(other.iter()) } } impl<T> hash::Hash for Interleaved<T> where T: Sample + hash::Hash, { fn hash<H: hash::Hasher>(&self, state: &mut H) { for channel in self.iter() { channel.hash(state); } } } impl<T> Buf<T> for Interleaved<T> where T: Sample, { fn frames(&self) -> usize { self.frames } fn channels(&self) -> usize { self.channels } fn channel(&self, channel: usize) -> crate::Channel<'_, T> { crate::Channel::interleaved(&self.data, self.channels, channel) } } impl<T> BufMut<T> for Interleaved<T> where T: Sample, { fn channel_mut(&mut self, channel: usize) -> crate::ChannelMut<'_, T> { crate::ChannelMut::interleaved(&mut self.data, self.channels, channel) } fn resize(&mut self, frames: usize) { Self::resize(self, frames); } fn resize_topology(&mut self, channels: usize, frames: usize) { Self::resize(self, frames); Self::resize_channels(self, channels); } } impl<'a, T> IntoIterator for &'a Interleaved<T> where T: Sample, { type IntoIter = Iter<'a, T>; type Item = <Self::IntoIter as Iterator>::Item; fn into_iter(self) -> Self::IntoIter { self.iter() } } impl<'a, T> IntoIterator for &'a mut Interleaved<T> where T: Sample, { type IntoIter = IterMut<'a, T>; type Item = <Self::IntoIter as Iterator>::Item; fn into_iter(self) -> Self::IntoIter { self.iter_mut() } }