Struct ProjectionEncoderRef 

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

Borrowed wrapper around a projection encoder state.

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

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

Implementations

impl<'a> ProjectionEncoderRef<'a>

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

Wrap an externally-initialized projection encoder without taking ownership.

Safety

• ptr must point to valid, initialized memory of at least ProjectionEncoder::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 encoder 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 ProjectionEncoder::init_in_place to initialize the memory before calling this.

pub fn init_in( buf: &'a mut AlignedBuffer, sample_rate: SampleRate, channels: u8, mapping_family: i32, application: Application, ) -> 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 encode( &mut self, pcm: &[i16], frame_size_per_ch: usize, out: &mut [u8], ) -> Result<usize>

Calls the corresponding operation on this borrowed libopus state.

Errors

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

pub fn encode_float( &mut self, pcm: &[f32], frame_size_per_ch: usize, out: &mut [u8], ) -> Result<usize>

Calls the corresponding operation on this borrowed libopus state.

Errors

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

pub fn set_bitrate(&mut self, bitrate: Bitrate) -> Result<()>

Calls the corresponding operation on this borrowed libopus state.

Errors

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

pub fn bitrate(&mut self) -> Result<Bitrate>

Calls the corresponding operation on this borrowed libopus state.

Errors

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

pub fn demixing_matrix_size(&mut self) -> Result<i32>

Calls the corresponding operation on this borrowed libopus state.

Errors

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

pub fn demixing_matrix_gain(&mut self) -> Result<i32>

Calls the corresponding operation on this borrowed libopus state.

Errors

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

pub fn write_demixing_matrix(&mut self, out: &mut [u8]) -> Result<usize>

Calls the corresponding operation on this borrowed libopus state.

Errors

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

pub fn demixing_matrix_bytes(&mut self) -> Result<Vec<u8>>

Calls the corresponding operation on this borrowed libopus state.

Errors

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

Methods from Deref<Target = ProjectionEncoder>

pub fn streams(&self) -> u8

Number of coded streams.

pub fn coupled_streams(&self) -> u8

Number of coupled (stereo) coded streams.

pub fn channels(&self) -> u8

Input channels passed to the encoder.

pub fn sample_rate(&self) -> SampleRate

Encoder sample rate.

Trait Implementations

impl Deref for ProjectionEncoderRef<'_>

type Target = ProjectionEncoder

The resulting type after dereferencing.

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

Dereferences the value.

impl Send for ProjectionEncoderRef<'_>