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
// Copyright © 2020-2022 The Fon Contributors.
//
// Licensed under any of:
// - Apache License, Version 2.0 (https://www.apache.org/licenses/LICENSE-2.0)
// - MIT License (https://mit-license.org/)
// - Boost Software License, Version 1.0 (https://www.boost.org/LICENSE_1_0.txt)
// At your choosing (See accompanying files LICENSE_APACHE_2_0.txt,
// LICENSE_MIT.txt and LICENSE_BOOST_1_0.txt).
use core::fmt::Debug;
use core::num::NonZeroU32;
use crate::chan::Channel;
use crate::Frame;
/// Audio sink - a type that consumes audio samples.
pub trait Sink<Chan: Channel, const CH: usize>: Debug {
/// Get the sample rate of the sink in hertz.
fn sample_rate(&self) -> NonZeroU32;
/// Get the length of the sink in frames.
///
/// Sinks must always have finite length.
fn len(&self) -> usize;
/// Sink audio samples from a frame iterator.
///
/// **Warning**: if used incorrectly, this method may introduce audio
/// aliasing. To avoid that, make sure the sample rate of the frames from
/// the iterator matches exactly the sample rate of the sink.
fn sink_with(&mut self, iter: &mut dyn Iterator<Item = Frame<Chan, CH>>);
/// Check if the sink is empty (length of zero).
fn is_empty(&self) -> bool {
self.len() == 0
}
}
/// Sink that converts to a different audio format before passing to another
/// [`Sink`](crate::Sink).
#[derive(Debug)]
pub struct SinkTo<Chan, C, S, const CH: usize, const N: usize>
where
Chan: Channel + From<C>,
C: Channel,
S: Sink<Chan, CH>,
{
sink: S,
_phantom: core::marker::PhantomData<(Chan, C)>,
}
impl<Chan, C, S, const CH: usize, const N: usize> SinkTo<Chan, C, S, CH, N>
where
Chan: Channel + From<C>,
C: Channel,
S: Sink<Chan, CH>,
{
/// Convert an arbitrary `Sink` type to a different format.
pub fn new(sink: S) -> Self {
Self {
sink,
_phantom: core::marker::PhantomData,
}
}
}
#[allow(single_use_lifetimes)]
impl<Chan, C, S, const CH: usize, const N: usize> Sink<C, N>
for &mut SinkTo<Chan, C, S, CH, N>
where
Chan: Channel + From<C>,
C: Channel,
S: Sink<Chan, CH>,
{
/// Get the sample rate of the sink in hertz.
fn sample_rate(&self) -> NonZeroU32 {
self.sink.sample_rate()
}
/// Get the length of the sink in frames.
///
/// Sinks must always have finite length.
fn len(&self) -> usize {
self.sink.len()
}
/// Sink audio samples from a frame iterator.
///
/// **Warning**: if used incorrectly, this method may introduce audio
/// aliasing. To avoid that, make sure the sample rate of the frames from
/// the iterator matches exactly the sample rate of the sink.
fn sink_with(&mut self, iter: &mut dyn Iterator<Item = Frame<C, N>>) {
self.sink.sink_with(&mut iter.map(Frame::to))
}
}
#[allow(single_use_lifetimes)]
impl<Chan, C, S, const CH: usize, const N: usize> Sink<C, N>
for SinkTo<Chan, C, S, CH, N>
where
Chan: Channel + From<C>,
C: Channel,
S: Sink<Chan, CH>,
{
/// Get the sample rate of the sink in hertz.
fn sample_rate(&self) -> NonZeroU32 {
self.sink.sample_rate()
}
/// Get the length of the sink in frames.
///
/// Sinks must always have finite length.
fn len(&self) -> usize {
self.sink.len()
}
/// Sink audio samples from a frame iterator.
///
/// **Warning**: if used incorrectly, this method may introduce audio
/// aliasing. To avoid that, make sure the sample rate of the frames from
/// the iterator matches exactly the sample rate of the sink.
fn sink_with(&mut self, iter: &mut dyn Iterator<Item = Frame<C, N>>) {
self.sink.sink_with(&mut iter.map(Frame::to))
}
}