add seeking and deduplicate

Author: yara-blue

CHANGELOG.md

@@ -11,6 +11,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Added `FixedSource` which mirrors `Source` but does not allow the sample rate or
+  channel count to change.
+- Added `ConstSource` which is like `FixedSource` except the sample rate and
+  channel count are fixed at compile time.
 - Added `Skippable::skipped` function to check if the inner source was skipped.
 - All sources now implement `ExactSizeIterator` when their inner source does.
 - All sources now implement `Iterator::size_hint()`.
@@ -21,6 +25,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- Breaking: `Microphone` now implements `FixedSource`
 - Breaking: `Done` now calls a callback instead of decrementing an `Arc<AtomicUsize>`.
 - Updated `cpal` to v0.18.
 - Clarified `Source::current_span_len()` documentation to specify it returns total span length.

examples/microphone.rs

@@ -1,6 +1,6 @@
 use inquire::Select;
 use rodio::microphone::{self, MicrophoneBuilder};
-use rodio::Source;
+use rodio::FixedSource;
 use std::error::Error;
 use std::thread;
 use std::time::Duration;

src/const_source.rs

@@ -58,33 +58,33 @@ pub trait ConstSource<const SR: u32, const CH: u16>: Iterator<Item = Sample> {
         IntoDynamicSource { inner: self }
     }
 
-     /// Use this const source as if it's a fixed source which is generally
-     /// easier to work with since it drops the generics. The same effects are
-     /// available for both.
-     ///
-     /// # Example
-     ///
-     /// ```rust
-     /// # struct CustomEffect<S: FixedSource>(S);
-     /// # use rodio::{FixedSource, ConstSource};
-     /// # use rodio::generators::const_source;
-     ///
-     /// // Note custom effect can only wrap a FixedSource
-     /// fn apply_custom_effect<S: FixedSource>(source: S) -> CustomEffect<S> {
-     ///     CustomEffect(source)
-     /// }
-     ///
-     /// let source = const_source::Silence::<44100>::new();
-     /// let source = source.into_fixed_source();
-     /// apply_custom_effect(source);
-     /// ```
-     fn into_fixed_source(self) -> IntoFixedSource<SR, CH, Self>
-     where
-         Self: Sized,
-     {
-         IntoFixedSource { inner: self }
-     }
- 
+    /// Use this const source as if it's a fixed source which is generally
+    /// easier to work with since it drops the generics. The same effects are
+    /// available for both.
+    ///
+    /// # Example
+    ///
+    /// ```rust
+    /// # struct CustomEffect<S: FixedSource>(S);
+    /// # use rodio::{FixedSource, ConstSource};
+    /// # use rodio::generators::const_source;
+    ///
+    /// // Note custom effect can only wrap a FixedSource
+    /// fn apply_custom_effect<S: FixedSource>(source: S) -> CustomEffect<S> {
+    ///     CustomEffect(source)
+    /// }
+    ///
+    /// let source = const_source::Silence::<44100>::new();
+    /// let source = source.into_fixed_source();
+    /// apply_custom_effect(source);
+    /// ```
+    fn into_fixed_source(self) -> IntoFixedSource<SR, CH, Self>
+    where
+        Self: Sized,
+    {
+        IntoFixedSource { inner: self }
+    }
+
     #[doc = include_str!("docs/collect_into_buffer.md")]
     fn collect_into_buffer(self) -> SamplesBuffer<SR, CH>
     where

src/fixed_source.rs

@@ -2,6 +2,7 @@
 //! channel count.
 use std::time::Duration;
 
+use crate::source::SeekError;
 use crate::{ChannelCount, ConstSource, Sample, SampleRate};
 
 mod buffer;
@@ -23,6 +24,14 @@ pub trait FixedSource: Iterator<Item = Sample> {
     /// `None` indicates at the same time "infinite" or "unknown".
     fn total_duration(&self) -> Option<Duration>;
 
+    #[allow(unused_variables)]
+    #[doc = include_str!("docs/try_seek.md")]
+    fn try_seek(&mut self, pos: Duration) -> Result<(), SeekError> {
+        Err(SeekError::NotSupported {
+            underlying_source: std::any::type_name::<Self>(),
+        })
+    }
+
     /// Tries to convert from a fixed source to a const one assuming
     /// the parameters already match. If they do not this returns an error.
     ///
@@ -56,6 +65,18 @@ pub trait FixedSource: Iterator<Item = Sample> {
         IntoDynamicSource(self)
     }
 
+    #[doc = include_str!("docs/collect_into_buffer.md")]
+    fn collect_into_buffer(self) -> SamplesBuffer
+    where
+        Self: Sized,
+    {
+        SamplesBuffer::new(
+            self.channels(),
+            self.sample_rate(),
+            self.collect::<Vec<_>>(),
+        )
+    }
+
     /// Add another source to play directly after this one.
     ///
     /// # Example
@@ -106,6 +127,14 @@ where
     inner: std::marker::PhantomData<S>,
 }
 
+impl<S> Placeholder<S>
+where
+    S: FixedSource,
+{
+    /// placeholder
+    pub fn record(&self) {}
+}
+
 /// A [`ConstSource`] adapted from a [`FixedSource`].
 pub struct IntoConstSource<const SR: u32, const CH: u16, S: FixedSource>(S);
 

src/fixed_source/buffer.rs

@@ -1,6 +1,7 @@
 use std::sync::Arc;
 use std::time::Duration;
 
+use crate::source::SeekError;
 use crate::FixedSource;
 use crate::{ChannelCount, Sample, SampleRate};
 
@@ -19,7 +20,7 @@ impl SamplesBuffer {
     where
         D: Into<Vec<Sample>>,
     {
-        let data: Arc<[f32]> = data.into().into();
+        let data: Arc<[Sample]> = data.into().into();
         SamplesBuffer {
             data,
             pos: 0,
@@ -38,52 +39,9 @@ impl FixedSource for SamplesBuffer {
     fn sample_rate(&self) -> SampleRate {
         self.sample_rate
     }
-    /// # Panics
-    /// If the length of the buffer is larger than approximately 16 billion elements.
-    /// This is because the calculation of the duration would overflow.
-    #[inline]
-    fn total_duration(&self) -> Option<Duration> {
-        let duration_ns = 1_000_000_000u64
-            .checked_mul(self.data.len() as u64)
-            .unwrap()
-            / self.sample_rate.get() as u64
-            / self.channels.get() as u64;
-        let duration = Duration::new(
-            duration_ns / 1_000_000_000,
-            (duration_ns % 1_000_000_000) as u32,
-        );
-
-        Some(duration)
-    }
-    // /// This jumps in memory till the sample for `pos`.
-    // #[inline]
-    // fn try_seek(&mut self, pos: Duration) -> Result<(), SeekError> {
-    //     // This is fast because all the samples are in memory already
-    //     // and due to the constant sample_rate we can jump to the right
-    //     // sample directly.
-    //     let curr_channel = self.pos % self.channels() as usize;
-    //     let new_pos = pos.as_secs_f32() * self.sample_rate() as f32 * self.channels() as f32;
-    //     // saturate pos at the end of the source
-    //     let new_pos = new_pos as usize;
-    //     let new_pos = new_pos.min(self.data.len());
-    //     // make sure the next sample is for the right channel
-    //     let new_pos = new_pos.next_multiple_of(self.channels() as usize);
-    //     let new_pos = new_pos - curr_channel;
-    //     self.pos = new_pos;
-    //     Ok(())
-    // }
+    crate::common::source::buffer::source_impl! {}
 }
 
 impl Iterator for SamplesBuffer {
-    type Item = Sample;
-    #[inline]
-    fn next(&mut self) -> Option<Self::Item> {
-        let sample = self.data.get(self.pos)?;
-        self.pos += 1;
-        Some(*sample)
-    }
-    #[inline]
-    fn size_hint(&self) -> (usize, Option<usize>) {
-        (self.data.len(), Some(self.data.len()))
-    }
+    crate::common::source::buffer::iter_impl! {}
 }

src/fixed_source/chain.rs

@@ -7,8 +7,8 @@ use crate::{ChannelCount, SampleRate};
 /// Two chained sources, the one played after the other.
 #[derive(Clone)]
 pub struct SourceChain<S1, S2> {
-    inner: S1,
-    next: S2,
+    first: S1,
+    second: S2,
     playing_inner: bool,
 }
 
@@ -43,44 +43,19 @@ impl<S1: FixedSource, S2: FixedSource> SourceChain<S1, S2> {
             })
         } else {
             Ok(SourceChain {
-                inner: s1,
-                next: s2,
+                first: s1,
+                second: s2,
                 playing_inner: true,
             })
         }
     }
 }
 
+pub use crate::common::source::chain::ChainSeekError;
 impl<S1: FixedSource, S2: FixedSource> FixedSource for SourceChain<S1, S2> {
-    fn channels(&self) -> ChannelCount {
-        self.inner.channels()
-    }
-
-    fn sample_rate(&self) -> SampleRate {
-        self.inner.sample_rate()
-    }
-
-    fn total_duration(&self) -> Option<std::time::Duration> {
-        self.inner
-            .total_duration()
-            .and_then(|d| self.next.total_duration().map(|d2| d2 + d))
-    }
+    crate::common::source::chain::source_impl! {}
 }
 
 impl<S1: FixedSource, S2: FixedSource> Iterator for SourceChain<S1, S2> {
-    type Item = Sample;
-
-    fn next(&mut self) -> Option<Self::Item> {
-        if self.playing_inner {
-            match self.inner.next() {
-                Some(sample) => Some(sample),
-                None => {
-                    self.playing_inner = false;
-                    self.next.next()
-                }
-            }
-        } else {
-            self.next.next()
-        }
-    }
+    crate::common::source::chain::iter_impl! {}
 }

src/generators/silence.rs

@@ -1,6 +1,9 @@
 pub mod fixed_source {
+    use std::time::Duration;
+
+    use crate::source::SeekError;
+    use crate::{nz, FixedSource};
     use crate::{ChannelCount, SampleRate};
-    use crate::{FixedSource, nz};
 
     /// A source producing an infinite amount of Silence. Like all generators you
     /// probably want to limit the duration of this source.
@@ -46,6 +49,11 @@ pub mod fixed_source {
         fn total_duration(&self) -> Option<std::time::Duration> {
             None
         }
+
+        /// This does nothing since all silence is equal :3
+        fn try_seek(&mut self, _: Duration) -> Result<(), SeekError> {
+            Ok(())
+        }
     }
 
     impl Iterator for Silence {
@@ -102,7 +110,7 @@ pub mod const_source {
     }
 
     impl<const SR: u32> ConstSource<SR, 1> for Silence<SR> {
-        fn total_duration(&self) -> Option<std::time::Duration> {
+        fn total_duration(&self) -> Option<Duration> {
             None
         }
 

src/lib.rs

@@ -224,10 +224,10 @@ pub mod stream;
 mod wav_output;
 
 pub mod buffer;
-pub mod const_source;
 pub mod conversions;
 pub mod decoder;
 
+pub mod const_source;
 pub mod fixed_source;
 
 pub mod generators;

src/microphone.rs

@@ -4,7 +4,7 @@
 //!
 //! ```no_run
 //! use rodio::microphone::MicrophoneBuilder;
-//! use rodio::Source;
+//! use rodio::FixedSource;
 //! use std::time::Duration;
 //!
 //! # fn main() -> Result<(), Box<dyn std::error::Error>> {
@@ -106,7 +106,7 @@ use std::time::Duration;
 
 use crate::common::assert_error_traits;
 use crate::conversions::SampleTypeConverter;
-use crate::{Sample, Source};
+use crate::Sample;
 
 mod builder;
 mod config;
@@ -188,25 +188,6 @@ pub struct Microphone {
     config: InputConfig,
 }
 
-impl Source for Microphone {
-    fn current_span_len(&self) -> Option<usize> {
-        None
-    }
-
-    fn channels(&self) -> crate::ChannelCount {
-        self.config.channel_count
-    }
-
-    fn sample_rate(&self) -> crate::SampleRate {
-        self.config.sample_rate
-    }
-
-    fn total_duration(&self) -> Option<std::time::Duration> {
-        None
-    }
-}
-
-#[cfg(feature = "experimental")]
 impl crate::FixedSource for Microphone {
     fn channels(&self) -> crate::ChannelCount {
         self.config.channel_count

src/microphone/builder.rs

@@ -538,7 +538,7 @@ where
     /// # Example
     /// ```no_run
     /// # use rodio::microphone::MicrophoneBuilder;
-    /// # use rodio::Source;
+    /// # use rodio::FixedSource;
     /// # use std::time::Duration;
     /// let mic = MicrophoneBuilder::new()
     ///     .default_device()?