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
//! Use the [**Frame**](./trait.Frame.html) trait to remain generic over the number of channels at //! a single discrete moment in time. //! //! Implementations are provided for all fixed-size arrays up to 32 elements in length. #![cfg_attr(not(feature = "std"), no_std)] use dasp_sample::Sample; /// Represents one sample from each channel at a single discrete instance in time within a /// PCM signal. /// /// Implementations are provided for: /// /// - All fixed-size arrays up to a length of 32 elements. /// - All primitive types that implement `Sample`. These implementations assume `CHANNELS = 1`. pub trait Frame: Copy + Clone + PartialEq { /// The type of PCM sample stored at each channel within the frame. type Sample: Sample; /// A typified version of a number of channels in the `Frame`, used for safely mapping frames /// of the same length to other `Frame`s, perhaps with a different `Sample` associated type. type NumChannels: NumChannels; /// An iterator yielding the sample in each channel, starting from left (channel 0) and ending /// at the right (channel NumChannels-1). type Channels: Iterator<Item = Self::Sample>; /// A frame type with equilavent number of channels using the associated `Sample::Signed` format. type Signed: Frame<Sample = <Self::Sample as Sample>::Signed, NumChannels = Self::NumChannels>; /// A frame type with equilavent number of channels using the associated `Sample::Float` format. type Float: Frame<Sample = <Self::Sample as Sample>::Float, NumChannels = Self::NumChannels>; /// The equilibrium value for the wave that this `Sample` type represents. This is normally the /// value that is equal distance from both the min and max ranges of the sample. /// /// # Examples /// /// ```rust /// use dasp_frame::{Frame, Mono, Stereo}; /// /// fn main() { /// assert_eq!(Mono::<f32>::EQUILIBRIUM, [0.0]); /// assert_eq!(Stereo::<f32>::EQUILIBRIUM, [0.0, 0.0]); /// assert_eq!(<[f32; 3]>::EQUILIBRIUM, [0.0, 0.0, 0.0]); /// assert_eq!(<[u8; 2]>::EQUILIBRIUM, [128u8, 128]); /// } /// ``` const EQUILIBRIUM: Self; /// The total number of channels within the frame. /// /// # Examples /// /// ```rust /// use dasp_frame::{Frame, Mono, Stereo}; /// /// fn main() { /// assert_eq!(Mono::<f32>::CHANNELS, 1); /// assert_eq!(Stereo::<f32>::CHANNELS, 2); /// assert_eq!(<[f32; 3]>::CHANNELS, 3); /// assert_eq!(<[u8; 2]>::CHANNELS, 2); /// } /// ``` const CHANNELS: usize; /// Create a new `Frame` where the `Sample` for each channel is produced by the given function. /// /// The given function should map each channel index to its respective sample. fn from_fn<F>(from: F) -> Self where F: FnMut(usize) -> Self::Sample; /// Create a new `Frame` from a borrowed `Iterator` yielding samples for each channel. /// /// Returns `None` if the given `Iterator` does not yield enough `Sample`s. /// /// This is necessary for the `signal::FromSamples` `Iterator`, that converts some `Iterator` /// yielding `Sample`s to an `Iterator` yielding `Frame`s. fn from_samples<I>(samples: &mut I) -> Option<Self> where I: Iterator<Item = Self::Sample>; /// Converts the frame into an iterator yielding the sample for each channel in the frame. fn channels(self) -> Self::Channels; /// Yields a reference to the `Sample` of the channel at the given index if there is one. fn channel(&self, idx: usize) -> Option<&Self::Sample>; /// Returns a pointer to the sample of the channel at the given index, without doing bounds /// checking. /// /// Note: This is primarily a necessity for efficient `Frame::map` and `Frame::zip_map` /// methods, as for those methods we can guarantee lengths of different `Frame`s to be the same /// at *compile-time*. unsafe fn channel_unchecked(&self, idx: usize) -> &Self::Sample; /// Applies the given function to each sample in the `Frame` in channel order and returns the /// result as a new `Frame`. /// /// # Example /// /// ```rust /// use dasp_frame::Frame; /// use dasp_sample::Sample; /// /// fn main() { /// let foo = [0i16, 0]; /// let bar: [u8; 2] = foo.map(Sample::to_sample); /// assert_eq!(bar, [128u8, 128]); /// } /// ``` fn map<F, M>(self, map: M) -> F where F: Frame<NumChannels = Self::NumChannels>, M: FnMut(Self::Sample) -> F::Sample; /// Calls the given function with the pair of elements at every index and returns the /// resulting Frame. /// /// On a `Vec` this would be akin to `.into_iter().zip(other).map(|(a, b)| ...).collect()`, though /// much quicker and tailored to fixed-size arrays of samples. fn zip_map<O, F, M>(self, other: O, zip_map: M) -> F where O: Frame<NumChannels = Self::NumChannels>, F: Frame<NumChannels = Self::NumChannels>, M: FnMut(Self::Sample, O::Sample) -> F::Sample; /// Converts the frame type to the equivalent signal in its associated `Float`ing point format. /// /// # Example /// /// ```rust /// use dasp_frame::Frame; /// /// fn main() { /// let foo = [128u8; 2]; /// let signed = foo.to_signed_frame(); /// assert_eq!(signed, [0i8; 2]); /// } /// ``` fn to_signed_frame(self) -> Self::Signed; /// Converts the frame type to the equivalent signal in its associated `Signed` format. /// /// # Example /// /// ```rust /// use dasp_frame::Frame; /// /// fn main() { /// let foo = [128u8; 2]; /// let float = foo.to_float_frame(); /// assert_eq!(float, [0.0; 2]); /// } /// ``` fn to_float_frame(self) -> Self::Float; /// Offsets the amplitude of every channel in the frame by the given `offset` and yields the /// resulting frame. /// /// # Example /// /// ```rust /// use dasp_frame::Frame; /// /// fn main() { /// assert_eq!([0.25, -0.5].offset_amp(0.5), [0.75, 0.0]); /// assert_eq!([0.5, -0.25].offset_amp(-0.25), [0.25, -0.5]); /// assert_eq!([128u8, 192].offset_amp(-64), [64, 128]); /// } /// ``` #[inline] fn offset_amp(self, offset: <Self::Sample as Sample>::Signed) -> Self { self.map(|s| s.add_amp(offset)) } /// Multiplies each `Sample` in the `Frame` by the given amplitude and returns the resulting /// `Frame`. /// /// - A > 1.0 amplifies the sample. /// - A < 1.0 attenuates the sample. /// - A == 1.0 yields the same sample. /// - A == 0.0 yields the `Sample::equilibrium`. /// /// # Example /// /// ```rust /// use dasp_frame::Frame; /// /// fn main() { /// assert_eq!([0.1, 0.2, -0.1, -0.2].scale_amp(2.0), [0.2, 0.4, -0.2, -0.4]); /// } /// ``` #[inline] fn scale_amp(self, amp: <Self::Sample as Sample>::Float) -> Self { self.map(|s| s.mul_amp(amp)) } /// Sums each channel in `other` with each channel in `self` and returns the resulting `Frame`. /// /// # Example /// /// ```rust /// use dasp_frame::Frame; /// /// fn main() { /// let foo = [0.25, 0.5].add_amp([-0.75, 0.25]); /// assert_eq!(foo, [-0.5, 0.75]); /// } /// ``` #[inline] fn add_amp<F>(self, other: F) -> Self where F: Frame<Sample = <Self::Sample as Sample>::Signed, NumChannels = Self::NumChannels>, { self.zip_map(other, Sample::add_amp) } /// Multiplies `other` with `self` and returns the resulting `Frame`. /// /// # Example /// /// ```rust /// use dasp_frame::Frame; /// /// fn main() { /// let foo = [0.25, 0.4].mul_amp([0.2, 0.5]); /// assert_eq!(foo, [0.05, 0.2]); /// /// let bar = [192u8, 64].mul_amp([0.0, -1.0]); /// assert_eq!(bar, [128, 192]); /// } /// ``` #[inline] fn mul_amp<F>(self, other: F) -> Self where F: Frame<Sample = <Self::Sample as Sample>::Float, NumChannels = Self::NumChannels>, { self.zip_map(other, Sample::mul_amp) } } /// Restricts the types that may be used as the `Frame::NumChannels` associated type. /// /// `NumChannels` allows us to enforce the number of channels that a `Frame` must have in certain /// operations. This is particularly useful for `Frame::map` and `Frame::zip_map`, as it allows us /// to guarantee that the input and output frame types will retain the same number of channels at /// compile-time, and in turn removes the need for bounds checking. /// /// This trait is implemented for types `N1`...`N32`. pub trait NumChannels {} pub type Mono<S> = [S; 1]; pub type Stereo<S> = [S; 2]; /// An iterator that yields the sample for each channel in the frame by value. #[derive(Clone)] pub struct Channels<F> { next_idx: usize, frame: F, } macro_rules! impl_frame_for_fixed_size_array { ($($NChan:ident $N:expr, [$($idx:expr)*],)*) => { $( /// A typified version of a number of channels. pub struct $NChan; impl NumChannels for $NChan {} impl<S> Frame for [S; $N] where S: Sample, { type Sample = S; type NumChannels = $NChan; type Channels = Channels<Self>; type Float = [S::Float; $N]; type Signed = [S::Signed; $N]; const EQUILIBRIUM: Self = [S::EQUILIBRIUM; $N]; const CHANNELS: usize = $N; #[inline] fn channels(self) -> Self::Channels { Channels { next_idx: 0, frame: self, } } #[inline] fn channel(&self, idx: usize) -> Option<&Self::Sample> { self.get(idx) } #[inline] fn from_fn<F>(mut from: F) -> Self where F: FnMut(usize) -> S, { [$(from($idx), )*] } #[inline] fn from_samples<I>(samples: &mut I) -> Option<Self> where I: Iterator<Item=Self::Sample> { Some([$( { $idx; match samples.next() { Some(sample) => sample, None => return None, } }, )*]) } #[inline(always)] unsafe fn channel_unchecked(&self, idx: usize) -> &Self::Sample { self.get_unchecked(idx) } #[inline] fn to_signed_frame(self) -> Self::Signed { self.map(|s| s.to_sample()) } #[inline] fn to_float_frame(self) -> Self::Float { self.map(|s| s.to_sample()) } #[inline] fn map<F, M>(self, mut map: M) -> F where F: Frame<NumChannels=Self::NumChannels>, M: FnMut(Self::Sample) -> F::Sample, { F::from_fn(|channel_idx| { // Here we do not require run-time bounds checking as we have asserted that // the two arrays have the same number of channels at compile time with our // where clause, i.e. // // `F: Frame<NumChannels=Self::NumChannels>` unsafe { map(*self.channel_unchecked(channel_idx)) } }) } #[inline] fn zip_map<O, F, M>(self, other: O, mut zip_map: M) -> F where O: Frame<NumChannels=Self::NumChannels>, F: Frame<NumChannels=Self::NumChannels>, M: FnMut(Self::Sample, O::Sample) -> F::Sample { F::from_fn(|channel_idx| { // Here we do not require run-time bounds checking as we have asserted that the two // arrays have the same number of channels at compile time with our where clause, i.e. // // ``` // O: Frame<NumChannels=Self::NumChannels> // F: Frame<NumChannels=Self::NumChannels> // ``` unsafe { zip_map(*self.channel_unchecked(channel_idx), *other.channel_unchecked(channel_idx)) } }) } #[inline] fn scale_amp(self, amp: S::Float) -> Self { [$(self[$idx].mul_amp(amp), )*] } #[inline] fn add_amp<F>(self, other: F) -> Self where F: Frame<Sample=S::Signed, NumChannels=$NChan>, { // Here we do not require run-time bounds checking as we have asserted that the two // arrays have the same number of channels at compile time with our where clause, i.e. unsafe { [$(self[$idx].add_amp(*other.channel_unchecked($idx)), )*] } } } )* }; } impl_frame_for_fixed_size_array! { N1 1, [0], N2 2, [0 1], N3 3, [0 1 2], N4 4, [0 1 2 3], N5 5, [0 1 2 3 4], N6 6, [0 1 2 3 4 5], N7 7, [0 1 2 3 4 5 6], N8 8, [0 1 2 3 4 5 6 7], N9 9, [0 1 2 3 4 5 6 7 8], N10 10, [0 1 2 3 4 5 6 7 8 9], N11 11, [0 1 2 3 4 5 6 7 8 9 10], N12 12, [0 1 2 3 4 5 6 7 8 9 10 11], N13 13, [0 1 2 3 4 5 6 7 8 9 10 11 12], N14 14, [0 1 2 3 4 5 6 7 8 9 10 11 12 13], N15 15, [0 1 2 3 4 5 6 7 8 9 10 11 12 13 14], N16 16, [0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15], N17 17, [0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16], N18 18, [0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17], N19 19, [0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18], N20 20, [0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19], N21 21, [0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20], N22 22, [0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21], N23 23, [0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22], N24 24, [0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23], N25 25, [0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24], N26 26, [0 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], N27 27, [0 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], N28 28, [0 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], N29 29, [0 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], N30 30, [0 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], N31 31, [0 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], N32 32, [0 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], } macro_rules! impl_frame_for_sample { ($($T:ty)*) => { $( impl Frame for $T { type Sample = $T; type NumChannels = N1; type Channels = Channels<Self>; type Float = <$T as Sample>::Float; type Signed = <$T as Sample>::Signed; const EQUILIBRIUM: Self = <$T as Sample>::EQUILIBRIUM; const CHANNELS: usize = 1; #[inline] fn channels(self) -> Self::Channels { Channels { next_idx: 0, frame: self, } } #[inline] fn channel(&self, idx: usize) -> Option<&Self::Sample> { if idx == 0 { Some(self) } else { None } } #[inline] fn from_fn<F>(mut from: F) -> Self where F: FnMut(usize) -> Self::Sample, { from(0) } #[inline] fn from_samples<I>(samples: &mut I) -> Option<Self> where I: Iterator<Item=Self::Sample> { samples.next() } #[inline(always)] unsafe fn channel_unchecked(&self, _idx: usize) -> &Self::Sample { self } #[inline] fn to_signed_frame(self) -> Self::Signed { self.to_signed_sample() } #[inline] fn to_float_frame(self) -> Self::Float { self.to_float_sample() } #[inline] fn map<F, M>(self, mut map: M) -> F where F: Frame<NumChannels=Self::NumChannels>, M: FnMut(Self::Sample) -> F::Sample, { F::from_fn(|channel_idx| { // Here we do not require run-time bounds checking as we have asserted that // the two arrays have the same number of channels at compile time with our // where clause, i.e. // // `F: Frame<NumChannels=Self::NumChannels>` unsafe { map(*self.channel_unchecked(channel_idx)) } }) } #[inline] fn zip_map<O, F, M>(self, other: O, mut zip_map: M) -> F where O: Frame<NumChannels=Self::NumChannels>, F: Frame<NumChannels=Self::NumChannels>, M: FnMut(Self::Sample, O::Sample) -> F::Sample { F::from_fn(|channel_idx| { // Here we do not require run-time bounds checking as we have asserted that the two // arrays have the same number of channels at compile time with our where clause, i.e. // // ``` // O: Frame<NumChannels=Self::NumChannels> // F: Frame<NumChannels=Self::NumChannels> // ``` unsafe { zip_map(*self.channel_unchecked(channel_idx), *other.channel_unchecked(channel_idx)) } }) } #[inline] fn scale_amp(self, amp: <$T as Sample>::Float) -> Self { Sample::mul_amp(self, amp) } #[inline] fn add_amp<F>(self, other: F) -> Self where F: Frame<Sample=<$T as Sample>::Signed, NumChannels=N1>, { // Here we do not require run-time bounds checking as we have asserted that the two // arrays have the same number of channels at compile time with our where clause, i.e. unsafe { Sample::add_amp(self, *other.channel_unchecked(0)) } } } )* }; } impl_frame_for_sample! { i8 i16 i32 i64 u8 u16 u32 u64 f32 f64 } impl_frame_for_sample! { dasp_sample::types::I24 dasp_sample::types::I48 dasp_sample::types::U24 dasp_sample::types::U48 } impl<F> Iterator for Channels<F> where F: Frame, { type Item = F::Sample; #[inline] fn next(&mut self) -> Option<Self::Item> { self.frame.channel(self.next_idx).map(|&s| s).map(|s| { self.next_idx += 1; s }) } } impl<F> ExactSizeIterator for Channels<F> where F: Frame, { #[inline] fn len(&self) -> usize { F::CHANNELS - self.next_idx } }