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

use crate::*;

use futures::AsyncReadExt;
use rodio::{decoder::Decoder, Source};
use std::{io::Cursor, io::Read, sync::Arc};

/// Stores the raw data of an audio file.
///
/// To play the clip construct a [`ClipPlayer`] using a [`ClipPlayerBuilder`].
///
/// # Example
/// ```
/// # use riddle_audio::*; fn main() -> Result<(), AudioError> {
/// let clip_bytes = include_bytes!("../../example_assets/boop.wav");
/// let clip = Clip::load(&clip_bytes[..], ClipFormat::Wav)?;
/// # Ok(()) }
/// ```
#[derive(Clone)]
pub struct Clip {
    pub(crate) data: ClipData,
    duration: Option<std::time::Duration>,
}

impl Clip {
    /// Reads the entirety of the data reader in to memory.
    ///
    /// An [`AudioError::ClipDecodeError`] value will be returned if the data isn't a known format.
    pub fn load<R>(mut data: R, format: ClipFormat) -> Result<Clip>
    where
        R: Read,
    {
        let mut owned_data: Vec<u8> = vec![];
        data.read_to_end(&mut owned_data)?;
        Self::from_owned_bytes(owned_data, format)
    }

    /// Reads the entirety of the data reader in to memory, asynchronously.
    ///
    /// An [`AudioError::ClipDecodeError`] value will be returned if the data isn't a known format.
    ///
    /// # Example
    ///
    /// ```
    /// # use riddle_audio::*; fn main() -> Result<(), AudioError> { futures::executor::block_on(async_main()) }
    /// # async fn async_main() -> Result<(), AudioError> {
    /// let clip_bytes = include_bytes!("../../example_assets/boop.wav");
    /// let clip = Clip::load_async(&clip_bytes[..], ClipFormat::Wav).await?;
    /// # Ok(()) }
    /// ```
    pub async fn load_async<R>(mut data: R, format: ClipFormat) -> Result<Clip>
    where
        R: futures::io::AsyncRead + std::marker::Unpin,
    {
        let mut owned_data: Vec<u8> = vec![];
        data.read_to_end(&mut owned_data).await?;
        Self::from_owned_bytes(owned_data, format)
    }

    fn from_owned_bytes(owned_data: Vec<u8>, format: ClipFormat) -> Result<Clip> {
        let cursor = Cursor::new(owned_data.clone());

        let source = match format {
            ClipFormat::Wav => Decoder::new_wav(cursor),
            ClipFormat::Vorbis => Decoder::new_vorbis(cursor),

            #[cfg(feature = "riddle-mp3")]
            ClipFormat::Mp3 => Decoder::new_mp3(cursor),
        }
        .map_err(|_| AudioError::ClipDecodeError)?;

        let duration = source.total_duration();

        Ok(Self {
            data: ClipData::new(owned_data),
            duration,
        })
    }

    /// Get the run time of the clip, if it can be determined.
    ///
    /// # Example
    ///
    /// ```
    /// # use riddle_audio::*; fn main() -> Result<(), AudioError> {
    /// let clip_bytes = include_bytes!("../../example_assets/boop.wav");
    /// let clip = Clip::load(&clip_bytes[..], ClipFormat::Wav)?;
    ///
    /// assert!(clip.duration().unwrap() > std::time::Duration::from_secs(0));
    /// # Ok(()) }
    /// ```
    pub fn duration(&self) -> Option<std::time::Duration> {
        self.duration
    }
}

#[derive(Clone)]
pub(crate) struct ClipData {
    data: Arc<Vec<u8>>,
}

impl ClipData {
    fn new(data: Vec<u8>) -> Self {
        Self { data: data.into() }
    }
}

impl AsRef<[u8]> for ClipData {
    fn as_ref(&self) -> &[u8] {
        Arc::as_ref(&self.data).as_ref()
    }
}

/// The set of support audio file formats which [`Clip`] can load
#[derive(Debug, Eq, PartialEq, Copy, Clone)]
pub enum ClipFormat {
    Wav,
    Vorbis,

    #[cfg(feature = "riddle-mp3")]
    #[doc(cfg(feature = "riddle-mp3"))]
    Mp3,
}