sampled_data_duration 0.3.1

//! Work with durations of time-sampled data, like digital audio.
//!
//! The `sampled_data_duration` crate provides two stucts:
//! `ConstantRateDuration` and `MixedRateDuration`.
//!
//! A `ConstantRateDuraiton` can be used to represents the duration of
//! any data-set which has been sampled at a constant frequency, a
//! prime example might be an audio file sampled at 44.1kHz.
//!
//! A `MixedRateDuration` can be used to represent the duration of a
//! collection of data-sets which have different sampling
//! frequencies. A typical example might be a playlist of audio files
//! where some have been sampled at 44.1kHz, and others at 48kHz or
//! 96kHz, etc.
//!
//! # Example
//!
//! ```
//! use sampled_data_duration::ConstantRateDuration;
//! use sampled_data_duration::MixedRateDuration;
//!
//! // Consider an audio file which consists of `12_345_678` samples per
//! // channel recorded at a sampling rate of 44.1kHz.
//! let crd = ConstantRateDuration::new(12_345_678, 44100);
//!
//! // The default string representation is of the form
//! // `hh:mm:ss;samples`
//! assert_eq!(crd.to_string(), "00:04:39;41778");
//!
//! // Get the duration in various different time-units
//! assert_eq!(crd.as_hours(), 0);
//! assert_eq!(crd.as_mins(), 4);
//! assert_eq!(crd.submin_secs(), 39);
//! assert_eq!(crd.as_secs(), 4 * 60 + 39);
//! assert_eq!(crd.subsec_samples(), 41778);
//! assert_eq!(crd.subsec_secs(), 0.9473469387755102);
//!
//! // Consider and audio playlist which already consists of a file
//! // recorded at 96kHz.
//! let mut mrd = MixedRateDuration::from(ConstantRateDuration::new(87654321, 96000));
//!
//! // The default string representation of the a MixedRateDuration
//! // which consits of only one entry is of the form `hh:mm:ss;samples`
//! assert_eq!(mrd.to_string(), "00:15:13;6321");
//!
//! // However if we add-assign `crd` to `mrd`
//! mrd += crd;
//!
//! // Then we have a duration which is made up of different sampling
//! // rates and the default string representation changes to be of the
//! // form `hh:mm:ss.s`
//! assert_eq!(mrd.to_string(), "00:19:53.013190688");
//!```
//!
//! An attempt has been made to follow the naming conventions defined
//! by [`std::time::Duration`].

// Uncomment to get pedantic warnings when linting with `cargo clippy`.
// #![warn(clippy::pedantic)]

use std::collections::HashMap;
use std::fmt;
use std::ops::Add;
use std::ops::AddAssign;
use std::ops::Div;
use std::ops::DivAssign;
use std::ops::Mul;
use std::ops::MulAssign;
use std::ops::Sub;
use std::ops::SubAssign;
use std::time::Duration;

// Various constants for converting between different units of time
const NANOS_PER_SEC: f64 = 1_000_000_000.0;
const SECS_PER_MIN: u64 = 60;
const SECS_PER_HOUR: u64 = 3600;
const SECS_PER_DAY: u64 = 86400;
const SECS_PER_WEEK: u64 = 604_800;
const DAYS_PER_WEEK: u64 = 7;
const HOURS_PER_DAY: u64 = 24;
const MINS_PER_HOUR: u64 = 60;

/// Represents the duration of a dataset which has been sampled at a
/// constant rate.
///
/// # Examples
///
/// Consider an audio file which consists of `8_394_223` samples per
/// channel recorded with a 48kHz sampling frequency. We can see what
/// the duration of this is by using the default implementation of
/// `std::fmt::Display` for a `ConstantRateDuration` which outputs the
/// duration in the form `hh:mm:ss;samples`.
///
/// ```
/// use sampled_data_duration::ConstantRateDuration;
///
/// let crd = ConstantRateDuration::new(8_394_223, 48000);
/// assert_eq!(crd.to_string(), "00:02:54;42223");
///```
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct ConstantRateDuration {
    count: u64,
    rate: u64,
}
impl ConstantRateDuration {
    /// Construct a new `ConstantRateDuration`, where `count`
    /// corresponds to the number of samples and `rate` is the
    /// sampling rate in Hertz.
    #[must_use]
    pub fn new(count: u64, rate: u64) -> ConstantRateDuration {
        ConstantRateDuration { count, rate }
    }

    /// Returns the number of _whole_ seconds contained by this `ConstantRateDuration`.
    ///
    /// The returned value does not include the fractional part of the
    /// duration which can be obtained with [`subsec_secs`].
    ///
    /// # Example
    ///
    /// ```
    /// use sampled_data_duration::ConstantRateDuration;
    ///
    /// let crd = ConstantRateDuration::new(48000 * 62 + 123, 48000);
    /// assert_eq!(crd.to_string(), "00:01:02;123");
    /// assert_eq!(crd.as_secs(), 62);
    /// ```
    /// [`subsec_secs`]: ConstantRateDuration::subsec_secs
    #[must_use]
    pub fn as_secs(&self) -> u64 {
        self.count / self.rate
    }

    /// Returns the number of _whole_ minutes contained by this `ConstantRateDuration`.
    ///
    /// The returned value does not include the fractional part of the
    /// duration, and can be a value greater than 59.
    ///
    /// # Example
    ///
    /// ```
    /// use sampled_data_duration::ConstantRateDuration;
    ///
    /// let crd = ConstantRateDuration::new(48000 * 60 * 91, 48000);
    /// assert_eq!(crd.to_string(), "01:31:00;0");
    /// assert_eq!(crd.as_mins(), 91);
    /// ```
    #[must_use]
    pub fn as_mins(&self) -> u64 {
        self.as_secs() / SECS_PER_MIN
    }

    /// Returns the number of _whole_ hours contained by this `ConstantRateDuration`.
    ///
    /// The returned value does not include the fractional part of the
    /// duration, and can be a value greater than 23.
    ///
    /// # Example
    ///
    /// ```
    /// use sampled_data_duration::ConstantRateDuration;
    ///
    /// let crd = ConstantRateDuration::new(48000 * 60 * 60 * 48 + 12345, 48000);
    /// assert_eq!(crd.to_string(), "48:00:00;12345");
    /// assert_eq!(crd.as_hours(), 48);
    /// ```
    #[must_use]
    pub fn as_hours(&self) -> u64 {
        self.as_secs() / SECS_PER_HOUR
    }

    /// Returns the number of _whole_ days contained by this `ConstantRateDuration`.
    ///
    /// The returned value does not include the fractional part of the
    /// duration, and can be a value greater than 6.
    ///
    /// # Example
    ///
    /// ```
    /// use sampled_data_duration::ConstantRateDuration;
    ///
    /// let crd = ConstantRateDuration::new(48000 * 60 * 60 * 48 + 12345, 48000);
    /// assert_eq!(crd.to_string(), "48:00:00;12345");
    /// assert_eq!(crd.as_days(), 2);
    /// ```
    #[must_use]
    pub fn as_days(&self) -> u64 {
        self.as_secs() / SECS_PER_DAY
    }

    /// Returns the number of _whole_ weeks contained by this `ConstantRateDuration`.
    ///
    /// The returned value does not include the fractional part of the
    /// duration.
    ///
    /// # Example
    ///
    /// ```
    /// use sampled_data_duration::ConstantRateDuration;
    ///
    /// let crd = ConstantRateDuration::new(48000 * 60 * 60 * 24 * 21 + 12345, 48000);
    /// assert_eq!(crd.to_string(), "504:00:00;12345");
    /// assert_eq!(crd.as_weeks(), 3);
    /// ```
    #[must_use]
    pub fn as_weeks(&self) -> u64 {
        self.as_secs() / SECS_PER_WEEK
    }

    /// Returns the number of samples in the sub-second part of this
    /// `ConstantRateDuration`.
    ///
    /// The returned value will always be less than the sampling rate.
    ///
    /// # Example
    ///
    /// ```
    /// use sampled_data_duration::ConstantRateDuration;
    ///
    /// let crd = ConstantRateDuration::new(48000 + 12345, 48000);
    /// assert_eq!(crd.to_string(), "00:00:01;12345");
    /// assert_eq!(crd.subsec_samples(), 12345);
    /// ```
    #[must_use]
    pub fn subsec_samples(&self) -> u64 {
        self.count % self.rate
    }

    /// Returns the _whole_ number of nanoseconds in the fractional
    /// part of this `ConstantRateDuration`.
    ///
    /// The returned value will always be less than one second i.e. >
    /// `1_000_000_000` nanoseconds.
    ///
    /// # Example
    ///
    /// ```
    /// use sampled_data_duration::ConstantRateDuration;
    ///
    /// let crd = ConstantRateDuration::new(48000 + 24000, 48000);
    /// assert_eq!(crd.to_string(), "00:00:01;24000");
    /// assert_eq!(crd.subsec_nanos(), 500_000_000);
    /// ```
    #[must_use]
    pub fn subsec_nanos(&self) -> u32 {
        let nanos_as_f64 = self.subsec_secs() * NANOS_PER_SEC;

        nanos_as_f64 as u32
    }

    /// Return the sub-second part of this duration in seconds.
    ///
    /// This will return a value in the range `0.0 <= subsec_secs < 1.0`.
    ///
    /// # Example
    ///
    /// ```
    /// use sampled_data_duration::ConstantRateDuration;
    ///
    /// let crd = ConstantRateDuration::new(48000 + 24000, 48000);
    /// assert_eq!(crd.to_string(), "00:00:01;24000");
    /// assert_eq!(crd.subsec_secs(), 0.5);
    /// ```
    #[must_use]
    pub fn subsec_secs(&self) -> f64 {
        self.subsec_samples() as f64 / self.rate as f64
    }

    /// Returns the _whole_ number of seconds left over when this duration is measured in minutes.
    ///
    /// The returned value will always be 0 <= `submin_secs` <= 59.
    ///
    /// # Example
    ///
    /// ```
    /// use sampled_data_duration::ConstantRateDuration;
    ///
    /// let crd = ConstantRateDuration::new(48000 * 65 + 32000, 48000);
    /// assert_eq!(crd.to_string(), "00:01:05;32000");
    /// assert_eq!(crd.submin_secs(), 5);
    /// ```
    #[must_use]
    pub fn submin_secs(&self) -> u64 {
        self.as_secs() % SECS_PER_MIN
    }

    /// Returns the _whole_ number of minutes left over when this duration is measured in hours.
    ///
    /// The returned value will always be 0 <= `subhour_mins` <= 59.
    ///
    /// # Example
    ///
    /// ```
    /// use sampled_data_duration::ConstantRateDuration;
    ///
    /// let crd = ConstantRateDuration::new(48000 * 60 * 68, 48000);
    /// assert_eq!(crd.to_string(), "01:08:00;0");
    /// assert_eq!(crd.subhour_mins(), 8);
    /// ```
    #[must_use]
    pub fn subhour_mins(&self) -> u64 {
        self.as_mins() % MINS_PER_HOUR
    }

    /// Returns the _whole_ number of hours left over when this duration is measured in days.
    ///
    /// The returned value will always be 0 <= `subday_hours` <= 23.
    ///
    /// # Example
    ///
    /// ```
    /// use sampled_data_duration::ConstantRateDuration;
    ///
    /// let crd = ConstantRateDuration::new(48000 * 60 * 60 * 25, 48000);
    /// assert_eq!(crd.to_string(), "25:00:00;0");
    /// assert_eq!(crd.subday_hours(), 1);
    /// ```
    #[must_use]
    pub fn subday_hours(&self) -> u64 {
        self.as_hours() % HOURS_PER_DAY
    }

    /// Returns the _whole_ number of days left over when this duration is measured in weeks.
    ///
    /// The returned value will always be 0 <= `subweek_days` <= 6.
    ///
    /// # Example
    ///
    /// ```
    /// use sampled_data_duration::ConstantRateDuration;
    ///
    /// let crd = ConstantRateDuration::new(48000 * 60 * 60 * 24 * 9, 48000);
    /// assert_eq!(crd.to_string(), "216:00:00;0");
    /// assert_eq!(crd.subweek_days(), 2);
    /// ```
    #[must_use]
    pub fn subweek_days(&self) -> u64 {
        self.as_days() % DAYS_PER_WEEK
    }

    /// Returns this `ConstantRateDuration` as a `std::time::Duration`.
    ///
    /// # Example
    ///
    /// ```
    /// use sampled_data_duration::ConstantRateDuration;
    ///
    /// let crd = ConstantRateDuration::new(48000 * 42, 48000);
    /// assert_eq!(crd.to_string(), "00:00:42;0");
    /// assert_eq!(crd.to_duration().as_secs_f64(), 42.0);
    /// ```
    #[must_use]
    pub fn to_duration(&self) -> Duration {
        Duration::new(self.as_secs(), self.subsec_nanos())
    }

    /// Computes `self + other` returning `Ok(ConstantRateDuration)`
    /// if the sampling rates of `self` and `other` are the same, or
    /// `Err(MixedRateDuration)` if they are not.
    ///
    /// If the sample count of the new duration exceeds the maximum
    /// capacity of a `u64` then this method will panic with the error
    /// message `"overflow when adding ConstantRateDurations"`.
    ///
    /// # Examples
    ///
    /// ```
    /// use sampled_data_duration::*;
    ///
    /// let a = ConstantRateDuration::new(48000, 48000);
    /// let b = ConstantRateDuration::new(48000 * 2, 48000);
    ///
    /// if let Ok(c) = a.try_add(b) {
    ///   assert_eq!(c.as_secs(), 3);
    /// } else {
    ///   assert!(false);
    /// }
    ///```
    ///
    /// # Errors
    ///
    /// Will return a `Err(MixedRateDuration)` if the provided
    /// `ConstantRateDurations` have incommensurate sampling rates.
    pub fn try_add(
        self,
        other: ConstantRateDuration,
    ) -> Result<ConstantRateDuration, MixedRateDuration> {
        if self.rate == other.rate {
            return Ok(ConstantRateDuration::new(
                self.count
                    .checked_add(other.count)
                    .expect("overflow when adding ConstantRateDurations"),
                self.rate,
            ));
        }

        let mut map: HashMap<u64, u64> = HashMap::with_capacity(2);
        map.insert(self.rate, self.count);
        map.insert(other.rate, other.count);
        let mut mrd = MixedRateDuration {
            duration: Duration::new(0, 0),
            map,
        };
        mrd.update_duration();

        Err(mrd)
    }

    /// Add-assigns `crd` to this `ConstantRateDuration` returning
    /// `Ok(())` if the sampling rates of `self` and `other` are the
    /// same, or `Err(MixedRateDuration)` if they are not.
    ///
    /// If the sample count of updated duration exceeds the maximum
    /// capacity of a `u64` then this method will panic with the error
    /// message `"overflow when add-assigning ConstantRateDurations"`.
    ///
    /// # Examples
    ///
    /// ```
    /// use sampled_data_duration::*;
    ///
    /// let mut a = ConstantRateDuration::new(48000, 48000);
    /// let b = ConstantRateDuration::new(48000 * 2, 48000);
    ///
    /// if let Ok(()) = a.try_add_assign(b) {
    ///   assert_eq!(a.as_secs(), 3);
    /// } else {
    ///   assert!(false);
    /// }
    ///```
    ///
    /// # Errors
    ///
    /// Will return a `Err(MixedRateDuration)` if the provided
    /// `ConstantRateDurations` have incommensurate sampling rates.
    pub fn try_add_assign(&mut self, crd: ConstantRateDuration) -> Result<(), MixedRateDuration> {
        if self.rate == crd.rate {
            self.count = self
                .count
                .checked_add(crd.count)
                .expect("overflow when add-assigning ConstantRateDurations");
            return Ok(());
        }

        let mut map: HashMap<u64, u64> = HashMap::with_capacity(2);
        map.insert(self.rate, self.count);
        map.insert(crd.rate, crd.count);

        let mut mixed_rate_duration = MixedRateDuration {
            duration: Duration::new(0, 0),
            map,
        };
        mixed_rate_duration.update_duration();

        Err(mixed_rate_duration)
    }

    /// Computes `self - other` returning `Ok(ConstantRateDuration)`
    /// if the sampling rates of `self` and `other` are the same, or
    /// `Err(())` if they are not.
    ///
    /// If the sample count of the new duration would be less than 0
    /// then then returned `ConstantRateDuraiton` will have 0 duration
    /// — this is a what is meant by saturating..
    ///
    /// # Examples
    ///
    /// ```
    /// use sampled_data_duration::*;
    ///
    /// let a = ConstantRateDuration::new(48001, 48000);
    /// let b = ConstantRateDuration::new(48000, 48000);
    ///
    /// assert_eq!(a.try_saturating_sub(b), Ok(ConstantRateDuration::new(1, 48000)));
    ///
    /// let c = ConstantRateDuration::new(48001, 48000);
    /// let d = ConstantRateDuration::new(48000, 48000);    
    /// assert_eq!(d.try_saturating_sub(c), Ok(ConstantRateDuration::new(0, 48000)));
    ///
    /// let e = ConstantRateDuration::new(96000, 96000);
    /// let f = ConstantRateDuration::new(48000, 48000);
    /// assert_eq!(e.try_saturating_sub(f), Err(Error::IncommensurateRates));
    ///```
    ///
    /// # Errors
    ///
    /// Will return an `Error::IncommensurateRates` if the provided
    /// `ConstantRateDurations` have incommensurate sampling rates.
    pub fn try_saturating_sub(
        self,
        other: ConstantRateDuration,
    ) -> Result<ConstantRateDuration, Error> {
        if self.rate == other.rate {
            return Ok(ConstantRateDuration::new(
                self.count.saturating_sub(other.count),
                self.rate,
            ));
        }

        Err(Error::IncommensurateRates)
    }

    /// Sub-assigns `crd` from this `ConstantRateDuration` returning
    /// `Ok(())` if the sampling rates of `self` and `other` are the
    /// same, or `Err(())` if they are not.
    ///
    /// If the sample count of updated duration would be negative then
    /// it "saturates" and becomes zero.
    ///
    /// # Examples
    ///
    /// ```
    /// use sampled_data_duration::*;
    ///
    /// let mut a = ConstantRateDuration::new(10, 48000);
    /// let b = ConstantRateDuration::new(2, 48000);
    ///
    /// if let Ok(()) = a.try_saturating_sub_assign(b) {
    ///   assert_eq!(a.subsec_samples(), 8);
    /// } else {
    ///   assert!(false);
    /// }
    ///
    /// let mut c = ConstantRateDuration::new(1, 48000);
    /// let d = ConstantRateDuration::new(5, 48000);
    ///
    /// if let Ok(()) = c.try_saturating_sub_assign(d) {
    ///   assert_eq!(c.subsec_samples(), 0);
    /// } else {
    ///   assert!(false);
    /// }
    ///
    /// let mut e = ConstantRateDuration::new(96000, 96000);
    /// let f = ConstantRateDuration::new(48000, 48000);
    /// assert!(e.try_saturating_sub(f).is_err());
    ///```
    ///
    /// # Errors
    ///
    /// Will return an `Error::IncommensurateRates` if the provided
    /// `ConstantRateDurations` have incommensurate sampling rates.
    pub fn try_saturating_sub_assign(&mut self, crd: ConstantRateDuration) -> Result<(), Error> {
        if self.rate == crd.rate {
            self.count = self.count.saturating_sub(crd.count);
            return Ok(());
        }

        Err(Error::IncommensurateRates)
    }
}
impl fmt::Display for ConstantRateDuration {
    /// Display this `ConstantRateDuration` in the form `hh:mm:ss;samples`.
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let hours = self.as_hours();

        if hours < 10 {
            return write!(
                f,
                "{:02}:{:02}:{:02};{}",
                hours,
                self.subhour_mins(),
                self.submin_secs(),
                self.subsec_samples()
            );
        }

        write!(
            f,
            "{}:{:02}:{:02};{}",
            hours,
            self.subhour_mins(),
            self.submin_secs(),
            self.subsec_samples()
        )
    }
}
impl Div<u64> for ConstantRateDuration {
    type Output = Self;

    /// Divide a `ConstantRateDuration` by a `u64` returning a new
    /// `ConstantRateDuration`.
    fn div(self, rhs: u64) -> Self {
        ConstantRateDuration::new(
            self.count
                .checked_div(rhs)
                .expect("divide by zero when dividing a ConstantRateDuration"),
            self.rate,
        )
    }
}
impl DivAssign<u64> for ConstantRateDuration {
    /// Divide-assign a `ConstantRateDuration` by a `u64`.
    fn div_assign(&mut self, rhs: u64) {
        self.count = self
            .count
            .checked_div(rhs)
            .expect("divide by zero when divide-assigning a ConstantRateDuration");
    }
}
impl Mul<u64> for ConstantRateDuration {
    type Output = Self;

    /// Multiply a `ConstantRateDuration` by a `u64` returning a new
    /// `ConstantRateDuration`.
    fn mul(self, rhs: u64) -> Self {
        ConstantRateDuration::new(
            self.count
                .checked_mul(rhs)
                .expect("overflow when multiplying ConstantRateDuration"),
            self.rate,
        )
    }
}
impl MulAssign<u64> for ConstantRateDuration {
    /// Multiply-assign a `ConstantRateDuration` by a `u64`.
    fn mul_assign(&mut self, rhs: u64) {
        self.count = self
            .count
            .checked_mul(rhs)
            .expect("overflow when multiply-assigning a ConstantRateDuration");
    }
}

#[cfg(test)]
mod constant_rate_duration {
    use super::*;

    #[test]
    fn new() {
        let count: u64 = 15_345_873;
        let rate: u64 = 44100;
        let mut crd: ConstantRateDuration = ConstantRateDuration::new(count, rate);

        assert_eq!(crd.count, count);
        assert_eq!(crd.rate, rate);

        let updated_count: u64 = 26_326_888;
        crd.count = updated_count;
        assert_eq!(crd.count, updated_count);

        let updated_rate: u64 = 48000;
        crd.rate = updated_rate;
        assert_eq!(crd.rate, updated_rate);
    }

    #[test]
    fn as_and_sub_time_unit_methods() {
        let subsec_samples: u64 = 24_000;
        let submin_secs: u64 = 32;
        let subhour_mins: u64 = 23;
        let subday_hours: u64 = 19;
        let subweek_days: u64 = 4;
        let weeks: u64 = 1;
        let rate: u64 = 48_000;

        let as_days = weeks * DAYS_PER_WEEK + subweek_days;
        let as_hours = as_days * HOURS_PER_DAY + subday_hours;
        let as_mins = as_hours * MINS_PER_HOUR + subhour_mins;
        let as_secs = as_mins * SECS_PER_MIN + submin_secs;

        let total_secs: u64 = weeks * SECS_PER_WEEK
            + subweek_days * SECS_PER_DAY
            + subday_hours * SECS_PER_HOUR
            + subhour_mins * SECS_PER_MIN
            + submin_secs;
        let count: u64 = total_secs * rate + subsec_samples;
        let crd: ConstantRateDuration = ConstantRateDuration::new(count, rate);

        assert_eq!(crd.count, count);
        assert_eq!(crd.rate, rate);
        assert_eq!(crd.as_secs(), as_secs);
        assert_eq!(crd.as_mins(), as_mins);
        assert_eq!(crd.as_hours(), as_hours);
        assert_eq!(crd.as_days(), as_days);
        assert_eq!(crd.as_weeks(), weeks);
        assert_eq!(crd.subsec_samples(), subsec_samples);
        assert_eq!(crd.subsec_nanos(), 500_000_000);
        assert_eq!(crd.subsec_secs(), 0.5);
        assert_eq!(crd.submin_secs(), submin_secs);
        assert_eq!(crd.subhour_mins(), subhour_mins);
        assert_eq!(crd.subday_hours(), subday_hours);
        assert_eq!(crd.subweek_days(), subweek_days);

        // Check sample roll-over to seconds
        let mut crd: ConstantRateDuration = ConstantRateDuration::new(47999, 48000);
        assert_eq!(crd.as_secs(), 0);
        assert_eq!(crd.subsec_samples(), 47999);
        assert_eq!(crd.subsec_nanos(), 1_000_000_000 - 20834);

        crd.count += 1;
        assert_eq!(crd.as_secs(), 1);
        assert_eq!(crd.subsec_samples(), 0);
        assert_eq!(crd.subsec_nanos(), 0);

        crd.count += 1;
        assert_eq!(crd.as_secs(), 1);
        assert_eq!(crd.subsec_samples(), 1);
        assert_eq!(crd.subsec_nanos(), 20833);
    }

    #[test]
    fn to_duration() {
        let crd = ConstantRateDuration::new(48000, 48000);
        assert_eq!(crd.to_duration(), Duration::new(1, 0));

        let crd = ConstantRateDuration::new(48001, 48000);
        assert_eq!(crd.to_duration(), Duration::new(1, 20833));
    }

    #[test]
    fn try_add() {
        // Add ConstantRateDurations with the same sample rate
        let a = ConstantRateDuration::new(48000, 48000);
        assert_eq!(a.as_secs(), 1);
        assert_eq!(a.subsec_samples(), 0);

        let b = ConstantRateDuration::new(1, 48000);
        assert_eq!(b.as_secs(), 0);
        assert_eq!(b.subsec_samples(), 1);

        let result = a.try_add(b);
        assert!(result.is_ok());
        let c = result.unwrap();
        assert_eq!(c.as_secs(), 1);
        assert_eq!(c.subsec_samples(), 1);

        // Add ConstantRateDurations with different sample rates
        let a = ConstantRateDuration::new(48000, 48000);
        assert_eq!(a.as_secs(), 1);
        assert_eq!(a.subsec_samples(), 0);

        let b = ConstantRateDuration::new(96000, 96000);
        assert_eq!(b.as_secs(), 1);
        assert_eq!(b.subsec_samples(), 0);

        let result = a.try_add(b);
        assert!(result.is_err());
        let c = result.unwrap_err();
        assert_eq!(c.as_secs(), 2);
    }

    #[test]
    #[should_panic(expected = "overflow when adding ConstantRateDurations")]
    fn try_add_overflow() {
        // Add ConstantRateDurations which overflow
        let a = ConstantRateDuration::new(u64::MAX, 48000);
        let b = ConstantRateDuration::new(1, 48000);
        let _c = a.try_add(b);
    }

    #[test]
    fn try_add_assign() {
        // Add-assign ConstantRateDurations with the same sampling rate
        let mut a = ConstantRateDuration::new(48000, 48000);
        let b = ConstantRateDuration::new(48000, 48000);
        assert_eq!(a.as_secs(), 1);
        assert_eq!(a.subsec_samples(), 0);
        assert_eq!(b.as_secs(), 1);
        assert_eq!(b.subsec_samples(), 0);
        assert!(a.try_add_assign(b).is_ok());
        assert_eq!(a.as_secs(), 2);
        assert_eq!(a.subsec_samples(), 0);

        // Add-assign ConstantRateDurations with different sampling rates
        let mut a = ConstantRateDuration::new(48000, 48000);
        let b = ConstantRateDuration::new(96000, 96000);
        assert_eq!(a.as_secs(), 1);
        assert_eq!(a.subsec_samples(), 0);
        assert_eq!(b.as_secs(), 1);
        assert_eq!(b.subsec_samples(), 0);

        let result = a.try_add_assign(b);
        assert!(result.is_err());
        let c = result.unwrap_err();
        assert_eq!(c.as_secs(), 2);
    }

    #[test]
    #[should_panic(expected = "overflow when add-assigning ConstantRateDurations")]
    fn try_add_assign_overflow() {
        // Add-assign ConstantRateDurations which overflow
        let mut a = ConstantRateDuration::new(u64::MAX, 48000);
        let b = ConstantRateDuration::new(1, 48000);
        let _c = a.try_add_assign(b);
    }

    #[test]
    fn display() {
        let crd = ConstantRateDuration::new(48000 + 12345, 48000);
        assert_eq!(crd.to_string(), "00:00:01;12345");
    }

    #[test]
    fn div() {
        let a = ConstantRateDuration::new(96002, 48000);
        assert_eq!(a.as_secs(), 2);
        assert_eq!(a.subsec_samples(), 2);

        let b = a / 2;
        assert_eq!(b.as_secs(), 1);
        assert_eq!(b.subsec_samples(), 1);
    }

    #[test]
    #[should_panic(expected = "divide by zero when dividing a ConstantRateDuration")]
    fn div_by_zero() {
        // Divide a ConstantRateDurations by zero
        let a = ConstantRateDuration::new(48000, 48000);
        let _ = a / 0;
    }

    #[test]
    fn div_assign() {
        let mut a = ConstantRateDuration::new(96002, 48000);
        assert_eq!(a.as_secs(), 2);
        assert_eq!(a.subsec_samples(), 2);

        a /= 2;
        assert_eq!(a.as_secs(), 1);
        assert_eq!(a.subsec_samples(), 1);
    }

    #[test]
    #[should_panic(expected = "divide by zero when divide-assigning a ConstantRateDuration")]
    fn div_assign_by_zero() {
        // Divide-assign a ConstantRateDurations by zero
        let mut a = ConstantRateDuration::new(48000, 48000);
        a /= 0;
    }

    #[test]
    fn mul() {
        let a = ConstantRateDuration::new(48001, 48000);
        assert_eq!(a.as_secs(), 1);
        assert_eq!(a.subsec_samples(), 1);

        let b = a * 2;
        assert_eq!(b.as_secs(), 2);
        assert_eq!(b.subsec_samples(), 2);
    }

    #[test]
    #[should_panic(expected = "overflow when multiplying ConstantRateDuration")]
    fn mul_overflow() {
        // Multiply a ConstantRateDurations to overflow
        let a = ConstantRateDuration::new(u64::MAX, 48000);
        let _ = a * 2;
    }

    #[test]
    fn mul_assign() {
        let mut a = ConstantRateDuration::new(48001, 48000);
        assert_eq!(a.as_secs(), 1);
        assert_eq!(a.subsec_samples(), 1);

        a *= 2;
        assert_eq!(a.as_secs(), 2);
        assert_eq!(a.subsec_samples(), 2);
    }

    #[test]
    #[should_panic(expected = "overflow when multiply-assigning a ConstantRateDuration")]
    fn mul_assign_overflow() {
        // Multiply-assign a ConstantRateDurations to overflow
        let mut a = ConstantRateDuration::new(u64::MAX, 48000);
        a *= 2;
    }

    #[test]
    fn try_saturating_sub() {
        let a = ConstantRateDuration::new(2, 48000);
        let b = ConstantRateDuration::new(1, 48000);

        assert_eq!(
            a.try_saturating_sub(b),
            Ok(ConstantRateDuration::new(1, 48000))
        );

        let a = ConstantRateDuration::new(10, 48000);
        let b = ConstantRateDuration::new(1, 48000);
        assert_eq!(
            b.try_saturating_sub(a),
            Ok(ConstantRateDuration::new(0, 48000))
        );

        let a = ConstantRateDuration::new(96000, 96000);
        let b = ConstantRateDuration::new(48000, 48000);
        assert_eq!(a.try_saturating_sub(b), Err(Error::IncommensurateRates));
    }

    #[test]
    fn try_saturating_sub_assign() {
        let mut a = ConstantRateDuration::new(10, 48000);
        let b = ConstantRateDuration::new(2, 48000);

        assert!(a.try_saturating_sub_assign(b).is_ok());
        assert_eq!(a.subsec_samples(), 8);

        let mut a = ConstantRateDuration::new(1, 48000);
        let b = ConstantRateDuration::new(5, 48000);

        assert!(a.try_saturating_sub_assign(b).is_ok());
        assert_eq!(a.subsec_samples(), 0);

        let a = ConstantRateDuration::new(96000, 96000);
        let b = ConstantRateDuration::new(48000, 48000);
        assert!(a.try_saturating_sub(b).is_err());
    }
}

/// Represents a duration of a collection of datasets which may have
/// been sampled at different rates.
///
/// # Examples
///
/// Consider an audio playlist which at first consists of a single
/// audio file of `12_345_678` samples per channel recorded with at
/// 44.1kHz sampling frequency. We then add another audio file to this
/// playlist which is recorded at 96kHz.
///
/// ```
/// use sampled_data_duration::ConstantRateDuration;
/// use sampled_data_duration::MixedRateDuration;
///
/// let mut mrd = MixedRateDuration::from(ConstantRateDuration::new(12_345_678, 48000));
///
/// // Note that the default string representation when there is only
/// // a single sampling rate is of the form `hh:mm:ss;samples`.
/// assert_eq!(mrd.to_string(), "00:04:17;9678");
///
/// // Now we add a 96kHz file
/// let crd = ConstantRateDuration::new(31_415_926, 96000);
/// assert_eq!(crd.to_string(), "00:05:27;23926");
///
/// mrd += crd;
///
/// // Note that the default string representation when there are
/// // multiple sampling rates is of the form `hh:mm:ss.s`.
/// assert_eq!(mrd.to_string(), "00:09:44.450854166");
///```
#[derive(Clone, Debug, PartialEq)]
pub struct MixedRateDuration {
    duration: Duration,
    map: HashMap<u64, u64>,
}
impl MixedRateDuration {
    /// Construct an empty `MixedRateDuration`.
    ///
    /// # Examples
    ///
    /// ```
    /// use sampled_data_duration::MixedRateDuration;
    ///
    /// let mut mrd = MixedRateDuration::new();
    ///
    /// assert_eq!(mrd.to_string(), "00:00:00");
    ///```
    #[must_use]
    pub fn new() -> MixedRateDuration {
        MixedRateDuration {
            duration: Duration::new(0, 0),
            map: HashMap::new(),
        }
    }

    /// Returns the number of _whole_ seconds contained by this
    /// `MixedRateDuration`.
    ///
    /// The returned value does not include the fractional part of the
    /// duration which can be obtained with [`subsec_secs`].
    ///
    /// # Example
    ///
    /// ```
    /// use sampled_data_duration::ConstantRateDuration;
    /// use sampled_data_duration::MixedRateDuration;
    ///
    /// let mrd = MixedRateDuration::from(ConstantRateDuration::new(48000 * 62 + 123, 48000));
    /// assert_eq!(mrd.to_string(), "00:01:02;123");
    /// assert_eq!(mrd.as_secs(), 62);
    /// ```
    /// [`subsec_secs`]: MixedRateDuration::subsec_secs
    #[must_use]
    pub fn as_secs(&self) -> u64 {
        self.duration.as_secs()
    }

    /// Returns the number of _whole_ minutes contained by this `MixedRateDuration`.
    ///
    /// The returned value does not include the fractional part of the
    /// duration, and can be a value greater than 59.
    ///
    /// # Example
    ///
    /// ```
    /// use sampled_data_duration::ConstantRateDuration;
    /// use sampled_data_duration::MixedRateDuration;
    ///
    /// let mrd = MixedRateDuration::from(ConstantRateDuration::new(48000 * 60 * 91, 48000));
    /// assert_eq!(mrd.to_string(), "01:31:00;0");
    /// assert_eq!(mrd.as_mins(), 91);
    /// ```
    #[must_use]
    pub fn as_mins(&self) -> u64 {
        self.as_secs() / SECS_PER_MIN
    }

    /// Returns the number of _whole_ hours contained by this `MixedRateDuration`.
    ///
    /// The returned value does not include the fractional part of the
    /// duration, and can be a value greater than 23.
    ///
    /// # Example
    ///
    /// ```
    /// use sampled_data_duration::ConstantRateDuration;
    /// use sampled_data_duration::MixedRateDuration;
    ///
    /// let mrd = MixedRateDuration::from(ConstantRateDuration::new(48000 * 60 * 60 * 48 + 12345, 48000));
    /// assert_eq!(mrd.to_string(), "48:00:00;12345");
    /// assert_eq!(mrd.as_hours(), 48);
    /// ```
    #[must_use]
    pub fn as_hours(&self) -> u64 {
        self.as_secs() / SECS_PER_HOUR
    }

    /// Returns the number of _whole_ days contained by this `MixedRateDuration`.
    ///
    /// The returned value does not include the fractional part of the
    /// duration, and can be a value greater than 6.
    ///
    /// # Example
    ///
    /// ```
    /// use sampled_data_duration::ConstantRateDuration;
    /// use sampled_data_duration::MixedRateDuration;
    ///
    /// let mrd = MixedRateDuration::from(ConstantRateDuration::new(48000 * 60 * 60 * 48 + 12345, 48000));
    /// assert_eq!(mrd.to_string(), "48:00:00;12345");
    /// assert_eq!(mrd.as_days(), 2);
    /// ```
    #[must_use]
    pub fn as_days(&self) -> u64 {
        self.as_secs() / SECS_PER_DAY
    }

    /// Returns the number of _whole_ weeks contained by this `MixedRateDuration`.
    ///
    /// The returned value does not include the fractional part of the
    /// duration.
    ///
    /// # Example
    ///
    /// ```
    /// use sampled_data_duration::ConstantRateDuration;
    /// use sampled_data_duration::MixedRateDuration;
    ///
    /// let mrd = MixedRateDuration::from(ConstantRateDuration::new(48000 * 60 * 60 * 24 * 21 + 12345, 48000));
    /// assert_eq!(mrd.to_string(), "504:00:00;12345");
    /// assert_eq!(mrd.as_weeks(), 3);
    /// ```
    #[must_use]
    pub fn as_weeks(&self) -> u64 {
        self.as_secs() / SECS_PER_WEEK
    }

    /// Return the number of different sampling rates used in this
    /// `MixedRateDuration`.
    ///
    /// # Example
    ///
    /// ```
    /// use sampled_data_duration::ConstantRateDuration;
    /// use sampled_data_duration::MixedRateDuration;
    ///
    /// let mut mrd = MixedRateDuration::from(ConstantRateDuration::new(1, 44100));
    /// assert_eq!(mrd.num_rates(), 1);
    ///
    /// mrd += ConstantRateDuration::new(1, 48000);
    /// assert_eq!(mrd.num_rates(), 2);
    ///
    /// mrd += ConstantRateDuration::new(1, 96000);
    /// assert_eq!(mrd.num_rates(), 3);
    ///
    /// mrd += ConstantRateDuration::new(2, 44100);
    /// assert_eq!(mrd.num_rates(), 3);
    /// ```
    #[must_use]
    pub fn num_rates(&self) -> usize {
        self.map.len()
    }

    /// Returns the _whole_ number of nanoseconds in the fractional part of this `MixedRateDuration`.
    ///
    /// The returned value will always be less than one second i.e. >
    /// `1_000_000_000` nanoseconds.
    ///
    /// # Example
    ///
    /// ```
    /// use sampled_data_duration::ConstantRateDuration;
    /// use sampled_data_duration::MixedRateDuration;
    ///
    /// let mrd = MixedRateDuration::from(ConstantRateDuration::new(48000 + 24000, 48000));
    /// assert_eq!(mrd.to_string(), "00:00:01;24000");
    /// assert_eq!(mrd.subsec_nanos(), 500_000_000);
    /// ```
    #[must_use]
    pub fn subsec_nanos(&self) -> u32 {
        let nanos_as_f64 = self.subsec_secs() * NANOS_PER_SEC;

        nanos_as_f64 as u32
    }

    /// Returns the _whole_ number of seconds in the fractional part of this `MixedRateDuration`.
    ///
    /// The returned value will always be less than one second
    /// i.e. 0.0 <= `subsec_secs` < 1.0.
    ///
    /// # Example
    ///
    /// ```
    /// use sampled_data_duration::ConstantRateDuration;
    /// use sampled_data_duration::MixedRateDuration;
    ///
    /// let mrd = MixedRateDuration::from(ConstantRateDuration::new(48000 + 24000, 48000));
    /// assert_eq!(mrd.to_string(), "00:00:01;24000");
    /// assert_eq!(mrd.subsec_secs(), 0.5);
    /// ```
    #[must_use]
    pub fn subsec_secs(&self) -> f64 {
        f64::from(self.duration.subsec_nanos()) / NANOS_PER_SEC
    }

    /// Returns the _whole_ number of seconds left over when this
    /// duration is measured in minutes.
    ///
    /// The returned value will always be 0 <= `submin_secs` <= 59.
    ///
    /// # Example
    ///
    /// ```
    /// use sampled_data_duration::ConstantRateDuration;
    /// use sampled_data_duration::MixedRateDuration;
    ///
    /// let mrd = MixedRateDuration::from(ConstantRateDuration::new(48000 * 65 + 32000, 48000));
    /// assert_eq!(mrd.to_string(), "00:01:05;32000");
    /// assert_eq!(mrd.submin_secs(), 5);
    /// ```
    #[must_use]
    pub fn submin_secs(&self) -> u64 {
        self.as_secs() % SECS_PER_MIN
    }

    /// Returns the _whole_ number of minutes left over when this duration is measured in hours.
    ///
    /// The returned value will always be 0 <= `subhour_mins` <= 59.
    ///
    /// # Example
    ///
    /// ```
    /// use sampled_data_duration::ConstantRateDuration;
    /// use sampled_data_duration::MixedRateDuration;
    ///
    /// let mrd = MixedRateDuration::from(ConstantRateDuration::new(48000 * 60 * 68, 48000));
    /// assert_eq!(mrd.to_string(), "01:08:00;0");
    /// assert_eq!(mrd.subhour_mins(), 8);
    /// ```
    #[must_use]
    pub fn subhour_mins(&self) -> u64 {
        self.as_mins() % MINS_PER_HOUR
    }

    /// Returns the _whole_ number of hours left over when this duration is measured in days.
    ///
    /// The returned value will always be 0 <= `subday_hours` <= 23.
    ///
    /// # Example
    ///
    /// ```
    /// use sampled_data_duration::ConstantRateDuration;
    /// use sampled_data_duration::MixedRateDuration;
    ///
    /// let mrd = MixedRateDuration::from(ConstantRateDuration::new(48000 * 60 * 60 * 25, 48000));
    /// assert_eq!(mrd.to_string(), "25:00:00;0");
    /// assert_eq!(mrd.subday_hours(), 1);
    /// ```
    #[must_use]
    pub fn subday_hours(&self) -> u64 {
        self.as_hours() % HOURS_PER_DAY
    }

    /// Returns the _whole_ number of days left over when this duration is measured in weeks.
    ///
    /// The returned value will always be 0 <= `subweek_days` <= 6.
    ///
    /// # Example
    ///
    /// ```
    /// use sampled_data_duration::ConstantRateDuration;
    /// use sampled_data_duration::MixedRateDuration;
    ///
    /// let mrd = MixedRateDuration::from(ConstantRateDuration::new(48000 * 60 * 60 * 24 * 9, 48000));
    /// assert_eq!(mrd.to_string(), "216:00:00;0");
    /// assert_eq!(mrd.subweek_days(), 2);
    /// ```
    #[must_use]
    pub fn subweek_days(&self) -> u64 {
        self.as_days() % DAYS_PER_WEEK
    }

    /// Return this `MixedRateDuration` as a `std::time::Duration`.
    ///
    /// # Example
    ///
    /// ```
    /// use sampled_data_duration::ConstantRateDuration;
    /// use sampled_data_duration::MixedRateDuration;
    ///
    /// let mrd = MixedRateDuration::from(ConstantRateDuration::new(48000 * 42, 48000));
    /// assert_eq!(mrd.to_string(), "00:00:42;0");
    /// assert_eq!(mrd.to_duration().as_secs_f64(), 42.0);
    /// ```
    #[must_use]
    pub fn to_duration(&self) -> Duration {
        self.duration
    }

    /// Update this `MixedRateDuration`'s duration field by summing
    /// over all enteries in the internal `HashMap`.
    fn update_duration(&mut self) {
        let mut duration = Duration::new(0, 0);

        for (rate, count) in &self.map {
            let crd = ConstantRateDuration::new(*count, *rate);
            duration += crd.to_duration();
        }

        self.duration = duration;
    }
}
impl Default for MixedRateDuration {
    fn default() -> Self {
        MixedRateDuration::new()
    }
}
impl From<ConstantRateDuration> for MixedRateDuration {
    /// Construct a `MixedRateDuration` from a `ConstantRateDuration`.
    fn from(crd: ConstantRateDuration) -> Self {
        let mut map: HashMap<u64, u64> = HashMap::with_capacity(1);
        map.insert(crd.rate, crd.count);

        MixedRateDuration {
            duration: crd.to_duration(),
            map,
        }
    }
}
impl fmt::Display for MixedRateDuration {
    /// Display this `MixedRateDuration` in the form
    /// `hh:mm:ss;samples` if there is only one sampling rate used,
    /// otherwise display in the form `hh:mm:ss.s`.
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        if self.num_rates() == 1 {
            if let Some((rate, count)) = self.map.iter().next() {
                let crd = ConstantRateDuration::new(*count, *rate);
                return write!(
                    f,
                    "{:02}:{:02}:{:02};{}",
                    crd.as_hours(),
                    crd.subhour_mins(),
                    crd.submin_secs(),
                    crd.subsec_samples()
                );
            }
        }

        if self.submin_secs() < 10 {
            return write!(
                f,
                "{:02}:{:02}:0{}",
                self.as_hours(),
                self.subhour_mins(),
                self.submin_secs() as f64 + self.subsec_secs(),
            );
        }

        return write!(
            f,
            "{:02}:{:02}:{:2.}",
            self.as_hours(),
            self.subhour_mins(),
            self.submin_secs() as f64 + self.subsec_secs(),
        );
    }
}
impl Add<ConstantRateDuration> for MixedRateDuration {
    type Output = MixedRateDuration;

    /// Add a `ConstantRateDuration` to this `MixedRateDuration`
    /// returning a new `MixedRateDuration`.
    fn add(self, crd: ConstantRateDuration) -> MixedRateDuration {
        let mut result_map = self.map;

        if let Some(current_count) = result_map.get_mut(&crd.rate) {
            *current_count = current_count
                .checked_add(crd.count)
                .expect("overflow when adding a ConstantRateDuration to a MixedRateDuration");
        } else {
            result_map.insert(crd.rate, crd.count);
        }

        let mut result_mrd = MixedRateDuration {
            duration: Duration::new(0, 0),
            map: result_map,
        };
        result_mrd.update_duration();

        result_mrd
    }
}
impl Add<MixedRateDuration> for MixedRateDuration {
    type Output = MixedRateDuration;

    /// Add a `MixedRateDuration` to this `MixedRateDuration`
    /// returning a new `MixedRateDuration`.
    fn add(self, mrd: MixedRateDuration) -> MixedRateDuration {
        let mut result_map = self.map;

        for (rate, count) in &mrd.map {
            if let Some(current_count) = result_map.get_mut(rate) {
                *current_count = current_count
                    .checked_add(*count)
                    .expect("overflow when adding a ConstantRateDuration to a MixedRateDuration");
            } else {
                result_map.insert(*rate, *count);
            }
        }

        let mut result_mrd = MixedRateDuration {
            duration: Duration::new(0, 0),
            map: result_map,
        };
        result_mrd.update_duration();

        result_mrd
    }
}
impl AddAssign<ConstantRateDuration> for MixedRateDuration {
    /// Add a `ConstantRateDuration` to this `MixedRateDuration`.
    fn add_assign(&mut self, crd: ConstantRateDuration) {
        if let Some(current_count) = self.map.get_mut(&crd.rate) {
            *current_count = current_count.checked_add(crd.count).expect(
                "overflow when add-assigning a ConstantRateDuration to a MixedRateDuration",
            );
        } else {
            self.map.insert(crd.rate, crd.count);
        }

        self.update_duration();
    }
}
impl AddAssign<MixedRateDuration> for MixedRateDuration {
    /// Add a `MixedRateDuration` to this `MixedRateDuration`.
    fn add_assign(&mut self, rhs: MixedRateDuration) {
        for (rhs_rate, rhs_count) in &rhs.map {
            if let Some(lhs_count) = self.map.get_mut(rhs_rate) {
                *lhs_count = lhs_count
                    .checked_add(*rhs_count)
                    .expect("overflow when add-assigning MixedRateDurations");
            } else {
                self.map.insert(*rhs_rate, *rhs_count);
            }
        }

        self.update_duration();
    }
}
impl Div<u64> for MixedRateDuration {
    type Output = Self;

    /// Divide a `MixedRateDuration` by a `u64` returning a new
    /// `MixedRateDuration`.
    fn div(self, rhs: u64) -> Self {
        let mut result_map: HashMap<u64, u64> = HashMap::with_capacity(self.map.len());

        for (rate, count) in &self.map {
            result_map.insert(
                *rate,
                count
                    .checked_div(rhs)
                    .expect("divide by zero when dividing a MixedRateDuration"),
            );
        }

        let mut result_mrd = MixedRateDuration {
            duration: Duration::new(0, 0),
            map: result_map,
        };
        result_mrd.update_duration();

        result_mrd
    }
}
impl DivAssign<u64> for MixedRateDuration {
    /// Divide-assign a `MixedRateDuration` by a `u64`.
    fn div_assign(&mut self, rhs: u64) {
        for count in self.map.values_mut() {
            *count = count
                .checked_div(rhs)
                .expect("divide by zero when divide-assigning a MixedRateDuration");
        }

        self.update_duration();
    }
}
impl Mul<u64> for MixedRateDuration {
    type Output = Self;

    /// Multiply a `MixedRateDuration` by a `u64` returning a new
    /// `MixedRateDuration`.
    fn mul(self, rhs: u64) -> Self {
        let mut result_map: HashMap<u64, u64> = HashMap::with_capacity(self.map.len());

        for (rate, count) in &self.map {
            result_map.insert(
                *rate,
                count
                    .checked_mul(rhs)
                    .expect("overflow when multiplying a MixedRateDuration"),
            );
        }

        let mut result_mrd = MixedRateDuration {
            duration: Duration::new(0, 0),
            map: result_map,
        };
        result_mrd.update_duration();

        result_mrd
    }
}
impl MulAssign<u64> for MixedRateDuration {
    /// Multiply-assign a `MixedRateDuration` by a `u64`.
    fn mul_assign(&mut self, rhs: u64) {
        for count in self.map.values_mut() {
            *count = count
                .checked_mul(rhs)
                .expect("overflow when multiply-assigning a MixedRateDuration");
        }

        self.update_duration();
    }
}
impl Sub<ConstantRateDuration> for MixedRateDuration {
    type Output = MixedRateDuration;

    /// Perform a saturating subtraction of a `ConstantRateDuration`
    /// from this `MixedRateDuration` returning a new
    /// `MixedRateDuration`.
    fn sub(self, crd: ConstantRateDuration) -> MixedRateDuration {
        let mut result_map = self.map;

        if let Some(current_count) = result_map.get_mut(&crd.rate) {
            *current_count = current_count.saturating_sub(crd.count);
        }

        let mut result_mrd = MixedRateDuration {
            duration: Duration::new(0, 0),
            map: result_map,
        };
        result_mrd.update_duration();

        result_mrd
    }
}
impl Sub<MixedRateDuration> for MixedRateDuration {
    type Output = MixedRateDuration;

    /// Perform a saturating subtraction of a `MixedRateDuration` from
    /// this `MixedRateDuration` returning a new `MixedRateDuration`.
    fn sub(self, mrd: MixedRateDuration) -> MixedRateDuration {
        let mut result_map = self.map;

        for (rate, count) in &mrd.map {
            if let Some(current_count) = result_map.get_mut(rate) {
                *current_count = current_count.saturating_sub(*count);
            }
        }

        let mut result_mrd = MixedRateDuration {
            duration: Duration::new(0, 0),
            map: result_map,
        };
        result_mrd.update_duration();

        result_mrd
    }
}
impl SubAssign<ConstantRateDuration> for MixedRateDuration {
    /// Perform a saturating subtraction of a `ConstantRateDuration`
    /// from this `MixedRateDuration`.
    fn sub_assign(&mut self, crd: ConstantRateDuration) {
        if let Some(current_count) = self.map.get_mut(&crd.rate) {
            *current_count = current_count.saturating_sub(crd.count);
            self.update_duration();
        }
    }
}
impl SubAssign<MixedRateDuration> for MixedRateDuration {
    /// Perform a saturating subtraction of a `MixedRateDuration` from
    /// this `MixedRateDuration`.
    fn sub_assign(&mut self, rhs: MixedRateDuration) {
        for (rhs_rate, rhs_count) in &rhs.map {
            if let Some(lhs_count) = self.map.get_mut(rhs_rate) {
                *lhs_count = lhs_count.saturating_sub(*rhs_count);
            }
        }

        self.update_duration();
    }
}

#[cfg(test)]
mod mixed_rate_duration {
    use super::*;

    #[test]
    fn new() {
        let count: u64 = 12345;
        let rate: u64 = 48000;
        let mrd = MixedRateDuration::from(ConstantRateDuration::new(count, rate));

        assert_eq!(mrd.map.len(), 1);
        assert!(mrd.map.contains_key(&rate));
        assert_eq!(mrd.map.get(&rate), Some(&count));
    }

    #[test]
    fn as_and_sub_time_unit_methods() {
        let subsec_samples: u64 = 24_000;
        let submin_secs: u64 = 32;
        let subhour_mins: u64 = 23;
        let subday_hours: u64 = 19;
        let subweek_days: u64 = 4;
        let weeks: u64 = 1;
        let rate: u64 = 48_000;

        let as_days = weeks * DAYS_PER_WEEK + subweek_days;
        let as_hours = as_days * HOURS_PER_DAY + subday_hours;
        let as_mins = as_hours * MINS_PER_HOUR + subhour_mins;
        let as_secs = as_mins * SECS_PER_MIN + submin_secs;

        let total_secs: u64 = weeks * SECS_PER_WEEK
            + subweek_days * SECS_PER_DAY
            + subday_hours * SECS_PER_HOUR
            + subhour_mins * SECS_PER_MIN
            + submin_secs;
        let count: u64 = total_secs * rate + subsec_samples;
        let mrd = MixedRateDuration::from(ConstantRateDuration::new(count, rate));

        assert_eq!(mrd.as_secs(), as_secs);
        assert_eq!(mrd.as_mins(), as_mins);
        assert_eq!(mrd.as_hours(), as_hours);
        assert_eq!(mrd.as_days(), as_days);
        assert_eq!(mrd.as_weeks(), weeks);
        assert_eq!(mrd.subsec_nanos(), 500_000_000);
        assert_eq!(mrd.subsec_secs(), 0.5);
        assert_eq!(mrd.submin_secs(), submin_secs);
        assert_eq!(mrd.subhour_mins(), subhour_mins);
        assert_eq!(mrd.subday_hours(), subday_hours);
        assert_eq!(mrd.subweek_days(), subweek_days);

        // Check multiple rates
        let mut mrd = MixedRateDuration::from(ConstantRateDuration::new(48000, 48000));
        assert_eq!(mrd.as_secs(), 1);
        assert_eq!(mrd.subsec_nanos(), 0);

        // Manually add 1.5 seconds of 96kHz samples
        mrd += ConstantRateDuration::new(96000 + 48000, 96000);
        assert_eq!(mrd.map.len(), 2);
        assert_eq!(mrd.as_secs(), 2);
        assert_eq!(mrd.subsec_nanos(), 500_000_000);
    }

    #[test]
    fn to_duration() {
        let mrd = MixedRateDuration::from(ConstantRateDuration::new(48000, 48000));
        assert_eq!(mrd.to_duration(), Duration::new(1, 0));

        //TODO more tests
    }

    #[test]
    fn display() {
        let mut mrd = MixedRateDuration::from(ConstantRateDuration::new(48000 + 24000, 48000));
        assert_eq!(mrd.to_string(), "00:00:01;24000");

        // Add 1 second of 96kHz samples
        mrd += ConstantRateDuration::new(96000, 96000);
        assert_eq!(mrd.map.len(), 2);
        assert_eq!(mrd.as_secs(), 2);
        assert_eq!(mrd.subsec_nanos(), 500_000_000);
        assert_eq!(mrd.to_string(), "00:00:02.5");

        // Manually add 10 seconds of 44.1kHz samples
        mrd += ConstantRateDuration::new(441_000, 44100);
        assert_eq!(mrd.map.len(), 3);
        assert_eq!(mrd.as_secs(), 12);
        assert_eq!(mrd.subsec_nanos(), 500_000_000);
        assert_eq!(mrd.to_string(), "00:00:12.5");
    }

    #[test]
    fn add() {
        // Add a ConstantRateDuration
        let a = MixedRateDuration::from(ConstantRateDuration::new(48000, 48000));
        let b = ConstantRateDuration::new(48000, 48000);
        let c = a + b;
        assert_eq!(c.to_string(), "00:00:02;0");

        // Add a MixedRateDuraiton
        let a = MixedRateDuration::from(ConstantRateDuration::new(48000, 48000));
        let b = MixedRateDuration::from(ConstantRateDuration::new(48000, 48000));
        let c = a + b;
        assert_eq!(c.to_string(), "00:00:02;0");

        // Add a MixedRateDuraiton with different rates
        let a = MixedRateDuration::from(ConstantRateDuration::new(48000, 48000));
        let b = MixedRateDuration::from(ConstantRateDuration::new(96000 + 48000, 96000));
        let c = a + b;
        assert_eq!(c.to_string(), "00:00:02.5");
    }

    #[test]
    fn add_assign() {
        // Add-assign a ConstantRateDuration
        let mut a = MixedRateDuration::from(ConstantRateDuration::new(48000, 48000));
        let b = ConstantRateDuration::new(48000, 48000);
        a += b;
        assert_eq!(a.to_string(), "00:00:02;0");

        // Add-assign a MixedRateDuraiton
        let c = MixedRateDuration::from(ConstantRateDuration::new(96000 + 48000, 96000));
        a += c;
        assert_eq!(a.to_string(), "00:00:03.5");
    }

    #[test]
    fn div() {
        let a = MixedRateDuration::from(ConstantRateDuration::new(96002, 48000));
        assert_eq!(
            a / 2,
            MixedRateDuration::from(ConstantRateDuration::new(48001, 48000))
        );
    }

    #[test]
    #[should_panic(expected = "divide by zero when dividing a MixedRateDuration")]
    fn div_by_zero() {
        let a = MixedRateDuration::from(ConstantRateDuration::new(48000, 48000));
        let b = a / 0;

        unreachable!(
            "The above line should have caused a divide by zero error and b={} should be NaN.",
            b
        );
    }

    #[test]
    fn div_assign() {
        let mut a = MixedRateDuration::from(ConstantRateDuration::new(96002, 48000));
        a /= 2;
        assert_eq!(
            a,
            MixedRateDuration::from(ConstantRateDuration::new(48001, 48000))
        );
    }

    #[test]
    #[should_panic(expected = "divide by zero when divide-assigning a MixedRateDuration")]
    fn div_assign_by_zero() {
        let mut a = MixedRateDuration::from(ConstantRateDuration::new(48000, 48000));
        a /= 0;
    }

    #[test]
    fn mul() {
        // Multiply a MixedRateDuration
        let a = MixedRateDuration::from(ConstantRateDuration::new(1, 48000));
        let b = a * 2;
        assert_eq!(
            b,
            MixedRateDuration::from(ConstantRateDuration::new(2, 48000))
        );

        // Multiply a MixedRateDuraiton with multiple enteries.
        let a = MixedRateDuration::from(ConstantRateDuration::new(48000, 48000));
        let b = MixedRateDuration::from(ConstantRateDuration::new(48000, 96000));
        let c = (a + b) * 2;
        assert_eq!(c.to_string(), "00:00:03");
    }

    #[test]
    #[should_panic(expected = "overflow when multiplying a MixedRateDuration")]
    fn mul_overflow() {
        // Multiply MixedRateDurations which overflows
        let a = MixedRateDuration::from(ConstantRateDuration::new(u64::MAX, 48000));
        let b = a * 2;

        unreachable!(
            "The above line should have caused an overflow and b={} should have overflown.",
            b
        );
    }

    #[test]
    fn mul_assign() {
        // Multiply a MixedRateDuration
        let mut a = MixedRateDuration::from(ConstantRateDuration::new(1, 48000));
        a *= 2;
        assert_eq!(
            a,
            MixedRateDuration::from(ConstantRateDuration::new(2, 48000))
        );

        // Multiply a MixedRateDuraiton with multiple enteries.
        let a = MixedRateDuration::from(ConstantRateDuration::new(48000, 48000));
        let b = MixedRateDuration::from(ConstantRateDuration::new(48000, 96000));
        let mut c = a + b;
        c *= 2;
        assert_eq!(c.to_string(), "00:00:03");
    }

    #[test]
    #[should_panic(expected = "overflow when multiply-assigning a MixedRateDuration")]
    fn mul_assign_overflow() {
        // Multiply-assign MixedRateDurations which overflows
        let mut a = MixedRateDuration::from(ConstantRateDuration::new(u64::MAX, 48000));
        a *= 2;
    }

    #[test]
    fn sub() {
        // Subtract a ConstantRateDuration
        let a = MixedRateDuration::from(ConstantRateDuration::new(100, 48000));
        let b = ConstantRateDuration::new(25, 48000);
        let c = a - b;
        assert_eq!(
            c,
            MixedRateDuration::from(ConstantRateDuration::new(75, 48000))
        );

        // Subtract a MixedRateDuraiton
        let a = MixedRateDuration::from(ConstantRateDuration::new(100, 48000));
        let b = MixedRateDuration::from(ConstantRateDuration::new(25, 48000));
        let c = a - b;
        assert_eq!(
            c,
            MixedRateDuration::from(ConstantRateDuration::new(75, 48000))
        );

        // Subtract a MixedRateDuraiton with different rates
        let mut a = MixedRateDuration::from(ConstantRateDuration::new(100, 48000));
        a += ConstantRateDuration::new(42, 96000);

        let mut b = MixedRateDuration::from(ConstantRateDuration::new(25, 48000));
        b += ConstantRateDuration::new(123, 44100);

        let c = a - b;
        let mut expected_c = MixedRateDuration::from(ConstantRateDuration::new(75, 48000));
        expected_c += ConstantRateDuration::new(42, 96000);
        assert_eq!(c, expected_c);
    }

    #[test]
    fn sub_assign() {
        // Sub-assign a ConstantRateDuration
        let mut a = MixedRateDuration::from(ConstantRateDuration::new(10, 48000));
        let b = ConstantRateDuration::new(1, 48000);
        a -= b;
        assert_eq!(
            a,
            MixedRateDuration::from(ConstantRateDuration::new(9, 48000))
        );

        // Sub-assign a MixedRateDuraiton
        let mut c = MixedRateDuration::from(ConstantRateDuration::new(1, 96000));
        c += ConstantRateDuration::new(2, 48000);

        a -= c;
        assert_eq!(
            a,
            MixedRateDuration::from(ConstantRateDuration::new(7, 48000))
        );
    }
}

#[derive(Debug, PartialEq)]
pub enum Error {
    IncommensurateRates,
}
impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "Incommensurate sampling rates, the sampling rates must be equal."
        )
    }
}
impl std::error::Error for Error {}