Struct Compressed

pub struct Compressed {
    pub raw: TxCatcher<ToAudioBytes, OpusCompressor>,
}

A wrapper around an existing Input which compresses the input using the Opus codec before storing it in memory.

The main purpose of this wrapper is to enable seeking on incompatible sources and to ease resource consumption for commonly reused/shared tracks. If only one Opus-compressed track is playing at a time, then this removes the runtime decode cost from the driver.

This is intended for use with larger, repeatedly used audio tracks shared between sources, and stores the sound data retrieved as compressed Opus audio.

Internally, this stores the stream and its metadata as a DCA1 file, which can be written out to disk for later use.

Fields

raw: TxCatcher<ToAudioBytes, OpusCompressor>

Inner shared bytestore.

Implementations

impl Compressed

pub async fn new( source: Input, bitrate: Bitrate, ) -> Result<Self, CodecCacheError>

Wrap an existing Input with an in-memory store, compressed using Opus.

pub async fn with_config( source: Input, bitrate: Bitrate, config: Option<Config>, ) -> Result<Self, CodecCacheError>

Wrap an existing Input with an in-memory store, compressed using Opus, with custom configuration for both Symphonia and the backing store.

pub fn new_handle(&self) -> Self

Acquire a new handle to this object, creating a new view of the existing cached data from the beginning.

Trait Implementations

impl Clone for Compressed

fn clone(&self) -> Compressed

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl From<Compressed> for Input

fn from(val: Compressed) -> Input

Converts to this type from the input type.

impl MediaSource for Compressed

fn is_seekable(&self) -> bool

Returns if the source is seekable. This may be an expensive operation.

fn byte_len(&self) -> Option<u64>

Returns the length in bytes, if available. This may be an expensive operation.

impl Read for Compressed

fn read(&mut self, buf: &mut [u8]) -> IoResult<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl Seek for Compressed

fn seek(&mut self, pos: SeekFrom) -> IoResult<u64>

Seek to an offset, in bytes, in a stream.

fn rewind(&mut self) -> Result<(), Error>

Rewind to the beginning of a stream.

fn stream_len(&mut self) -> Result<u64, Error>

🔬This is a nightly-only experimental API. (seek_stream_len)

Returns the length of this stream (in bytes).

fn stream_position(&mut self) -> Result<u64, Error>

Returns the current seek position from the start of the stream.

fn seek_relative(&mut self, offset: i64) -> Result<(), Error>

Seeks relative to the current position.