Struct MultistreamEncoderRef 

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

Borrowed wrapper around a multistream encoder.

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

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

Implementations

impl<'a> MultistreamEncoderRef<'a>

pub unsafe fn from_raw( ptr: *mut OpusMSEncoder, sr: SampleRate, mapping: Mapping<'_>, ) -> Self

Wrap an externally-initialized multistream encoder without taking ownership.

Safety

• ptr must point to valid, initialized memory of at least MultistreamEncoder::size() bytes
• ptr must be aligned to at least align_of::<usize>() (malloc-style alignment)
• sr and mapping 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, not pointer-aligned, or mapping is invalid.

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

pub fn init_in( buf: &'a mut AlignedBuffer, sr: SampleRate, app: Application, mapping: Mapping<'_>, ) -> 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 init_in_surround( buf: &'a mut AlignedBuffer, sr: SampleRate, channels: u8, mapping_family: i32, app: Application, ) -> Result<(Self, Vec<u8>)>

Initialize a surround encoder in 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 final_range(&mut self) -> Result<u32>

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 set_complexity(&mut self, complexity: Complexity) -> Result<()>

Calls the corresponding operation on this borrowed libopus state.

Errors

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

pub fn complexity(&mut self) -> Result<Complexity>

Calls the corresponding operation on this borrowed libopus state.

Errors

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

pub fn set_dtx(&mut self, enabled: bool) -> Result<()>

Calls the corresponding operation on this borrowed libopus state.

Errors

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

pub fn dtx(&mut self) -> Result<bool>

Calls the corresponding operation on this borrowed libopus state.

Errors

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

pub fn in_dtx(&mut self) -> Result<bool>

Calls the corresponding operation on this borrowed libopus state.

Errors

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

pub fn set_inband_fec(&mut self, enabled: bool) -> Result<()>

Calls the corresponding operation on this borrowed libopus state.

Errors

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

pub fn inband_fec(&mut self) -> Result<bool>

Calls the corresponding operation on this borrowed libopus state.

Errors

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

pub fn set_packet_loss_perc(&mut self, perc: i32) -> Result<()>

Calls the corresponding operation on this borrowed libopus state.

Errors

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

pub fn packet_loss_perc(&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 set_vbr(&mut self, enabled: bool) -> Result<()>

Calls the corresponding operation on this borrowed libopus state.

Errors

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

pub fn vbr(&mut self) -> Result<bool>

Calls the corresponding operation on this borrowed libopus state.

Errors

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

pub fn set_vbr_constraint(&mut self, constrained: bool) -> Result<()>

Calls the corresponding operation on this borrowed libopus state.

Errors

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

pub fn vbr_constraint(&mut self) -> Result<bool>

Calls the corresponding operation on this borrowed libopus state.

Errors

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

pub fn set_max_bandwidth(&mut self, bw: Bandwidth) -> Result<()>

Calls the corresponding operation on this borrowed libopus state.

Errors

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

pub fn max_bandwidth(&mut self) -> Result<Bandwidth>

Calls the corresponding operation on this borrowed libopus state.

Errors

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

pub fn set_bandwidth(&mut self, bw: Bandwidth) -> Result<()>

Calls the corresponding operation on this borrowed libopus state.

Errors

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

pub fn bandwidth(&mut self) -> Result<Bandwidth>

Calls the corresponding operation on this borrowed libopus state.

Errors

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

pub fn set_force_channels(&mut self, channels: Option<Channels>) -> Result<()>

Calls the corresponding operation on this borrowed libopus state.

Errors

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

pub fn force_channels(&mut self) -> Result<Option<Channels>>

Calls the corresponding operation on this borrowed libopus state.

Errors

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

pub fn set_signal(&mut self, signal: Signal) -> Result<()>

Calls the corresponding operation on this borrowed libopus state.

Errors

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

pub fn signal(&mut self) -> Result<Signal>

Calls the corresponding operation on this borrowed libopus state.

Errors

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

pub fn lookahead(&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 set_lsb_depth(&mut self, bits: i32) -> Result<()>

Calls the corresponding operation on this borrowed libopus state.

Errors

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

pub fn lsb_depth(&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 reset(&mut self) -> Result<()>

Calls the corresponding operation on this borrowed libopus state.

Errors

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

pub unsafe fn encoder_state_ptr( &mut self, stream_index: i32, ) -> Result<*mut OpusEncoder>

Calls the corresponding unsafe operation on this borrowed libopus state.

Safety

The safety requirements of the corresponding owning-handle method apply.

Errors

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

Methods from Deref<Target = MultistreamEncoder>

pub fn channels(&self) -> u8

Channels of this encoder (interleaved input).

pub fn sample_rate(&self) -> SampleRate

Input sampling rate.

pub fn streams(&self) -> u8

Total number of coded streams, including coupled streams.

pub fn coupled_streams(&self) -> u8

Number of coupled streams.

Trait Implementations

impl Deref for MultistreamEncoderRef<'_>

type Target = MultistreamEncoder

The resulting type after dereferencing.

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

Dereferences the value.

impl Send for MultistreamEncoderRef<'_>