pub struct ProjectionDecoder { /* private fields */ }Expand description
Safe wrapper around OpusProjectionDecoder.
Implementations§
Source§impl ProjectionDecoder
impl ProjectionDecoder
Sourcepub fn size(channels: u8, streams: u8, coupled_streams: u8) -> Result<usize>
pub fn size(channels: u8, streams: u8, coupled_streams: u8) -> Result<usize>
Size in bytes of a projection decoder state for external allocation.
§Errors
Returns Error::BadArg if the channel/stream configuration is invalid.
Sourcepub unsafe fn init_in_place(
ptr: *mut OpusProjectionDecoder,
sample_rate: SampleRate,
channels: u8,
streams: u8,
coupled_streams: u8,
demixing_matrix: &[u8],
) -> Result<()>
pub unsafe fn init_in_place( ptr: *mut OpusProjectionDecoder, sample_rate: SampleRate, channels: u8, streams: u8, coupled_streams: u8, demixing_matrix: &[u8], ) -> Result<()>
Initialize a previously allocated projection decoder state.
§Safety
The caller must provide a valid pointer to ProjectionDecoder::size() bytes,
aligned to at least align_of::<usize>() (malloc-style alignment).
§Errors
Returns Error::BadArg for invalid inputs or a mapped libopus error.
Sourcepub fn new(
sample_rate: SampleRate,
channels: u8,
streams: u8,
coupled_streams: u8,
demixing_matrix: &[u8],
) -> Result<Self>
pub fn new( sample_rate: SampleRate, channels: u8, streams: u8, coupled_streams: u8, demixing_matrix: &[u8], ) -> Result<Self>
Create a projection decoder given the demixing matrix provided by the encoder.
§Errors
Returns Error::BadArg for invalid inputs, Error::from_code for libopus failures,
or Error::AllocFail if libopus returns a null handle.
Sourcepub fn decode(
&mut self,
packet: &[u8],
out: &mut [i16],
frame_size_per_ch: usize,
fec: bool,
) -> Result<usize>
pub fn decode( &mut self, packet: &[u8], out: &mut [i16], frame_size_per_ch: usize, fec: bool, ) -> Result<usize>
Decode into interleaved i16 PCM.
§Errors
Returns Error::InvalidState if the decoder handle was freed, Error::BadArg for
buffer/layout issues, a mapped libopus error, or Error::InternalError if libopus
reports an impossible decoded sample count.
Sourcepub fn decode_float(
&mut self,
packet: &[u8],
out: &mut [f32],
frame_size_per_ch: usize,
fec: bool,
) -> Result<usize>
pub fn decode_float( &mut self, packet: &[u8], out: &mut [f32], frame_size_per_ch: usize, fec: bool, ) -> Result<usize>
Decode into interleaved f32 PCM.
§Errors
Returns Error::InvalidState if the decoder handle was freed, Error::BadArg for
buffer/layout issues, a mapped libopus error, or Error::InternalError if libopus
reports an impossible decoded sample count.
Sourcepub const fn coupled_streams(&self) -> u8
pub const fn coupled_streams(&self) -> u8
Number of coupled coded streams expected in the input bitstream.
Sourcepub const fn sample_rate(&self) -> SampleRate
pub const fn sample_rate(&self) -> SampleRate
Decoder sample rate.