Struct ProjectionDecoderRef 

pub struct ProjectionDecoderRef<'a> { /* private fields */ }

Borrowed wrapper around a projection decoder state.

The owning handle cannot be moved out of this borrowed wrapper:

use opus_codec::projection::{ProjectionDecoder, ProjectionDecoderRef};
fn extract<'a>(
    state: &mut ProjectionDecoderRef<'a>,
    replacement: ProjectionDecoder,
) -> ProjectionDecoder {
    std::mem::replace(&mut **state, replacement)
}

Implementations

impl<'a> ProjectionDecoderRef<'a>

pub unsafe fn from_raw( ptr: *mut OpusProjectionDecoder, sample_rate: SampleRate, channels: u8, streams: u8, coupled_streams: u8, ) -> Self

Wrap an externally-initialized projection decoder without taking ownership.

Safety

• ptr must point to valid, initialized memory of at least ProjectionDecoder::size() bytes
• ptr must be aligned to at least align_of::<usize>() (malloc-style alignment)
• sample_rate, channels, streams, and coupled_streams must exactly match the decoder state already stored at ptr
• The memory must remain valid for the lifetime 'a
• Caller is responsible for freeing the memory after this wrapper is dropped

Passing mismatched metadata is undefined behavior: later safe methods may validate buffer sizes with the wrong layout and then call libopus with out-of-bounds buffers.

Panics

Panics if ptr is null or not pointer-aligned, or if the channel/stream counts are invalid.

Use ProjectionDecoder::init_in_place to initialize the memory before calling this.

pub fn init_in( buf: &'a mut AlignedBuffer, sample_rate: SampleRate, channels: u8, streams: u8, coupled_streams: u8, demixing_matrix: &[u8], ) -> Result<Self>

Initialize and wrap an externally allocated buffer.

Errors

Returns Error::BadArg if the buffer is too small, or a mapped libopus error.

pub fn decode( &mut self, packet: &[u8], out: &mut [i16], frame_size_per_ch: usize, fec: bool, ) -> Result<usize>

Calls the corresponding operation on this borrowed libopus state.

Errors

Returns the same errors as the corresponding owning-handle method.

pub fn decode_float( &mut self, packet: &[u8], out: &mut [f32], frame_size_per_ch: usize, fec: bool, ) -> Result<usize>

Calls the corresponding operation on this borrowed libopus state.

Errors

Returns the same errors as the corresponding owning-handle method.

Methods from Deref<Target = ProjectionDecoder>

pub fn channels(&self) -> u8

Output channel count.

pub fn streams(&self) -> u8

Number of coded streams expected in the input bitstream.

pub fn coupled_streams(&self) -> u8

Number of coupled coded streams expected in the input bitstream.

pub fn sample_rate(&self) -> SampleRate

Decoder sample rate.

Trait Implementations

impl Deref for ProjectionDecoderRef<'_>

type Target = ProjectionDecoder

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Send for ProjectionDecoderRef<'_>