Struct SpeexEncoder 

pub struct SpeexEncoder<T: CoderMode> {
    pub mode: &'static SpeexMode,
    /* private fields */
}

A struct representing a speex encoder.

Fields

mode: &'static SpeexMode

Implementations

impl<T: CoderMode> SpeexEncoder<T>

pub fn set_complexity(&mut self, complexity: i32)

Sets the analysis complexity of the encoder.

pub fn get_complexity(&mut self) -> i32

Gets the analysis complexity of the encoder.

pub fn encode(&mut self, input: &mut [f32], bits: &mut SpeexBits<'_>)

Encode one frame of audio into the given bits.

pub fn encode_int(&mut self, input: &mut [i16], bits: &mut SpeexBits<'_>)

Encode one frame of audio into the given bits, using an integer representation.

impl SpeexEncoder<NbMode>

pub fn new() -> SpeexEncoder<NbMode>

Create a new narrowband encoder.

pub fn set_submode(&mut self, submode: NbSubmodeId)

Sets the submode to use for encoding.

pub fn get_submode(&mut self) -> NbSubmodeId

Gets the submode currently in use for encoding.

impl SpeexEncoder<WbMode>

pub fn new() -> SpeexEncoder<WbMode>

Create a new wideband encoder.

pub fn set_low_submode(&mut self, low_mode: NbSubmodeId)

Sets the submode of the narrowband part of the encoder.

pub fn get_low_submode(&mut self) -> NbSubmodeId

Gets the submode of the narrowband part of the encoder.

pub fn set_high_submode(&mut self, high_mode: WbSubmodeId)

Sets the submode of the wideband part of the encoder.

pub fn get_high_submode(&mut self) -> WbSubmodeId

Gets the submode of the wideband part of the encoder.

impl SpeexEncoder<UwbMode>

pub fn new() -> SpeexEncoder<UwbMode>

Create a new ultra-wideband encoder.

pub fn set_low_submode(&mut self, low_mode: NbSubmodeId)

Sets the submode of the narrowband part of the encoder.

pub fn get_low_submode(&mut self) -> NbSubmodeId

Gets the submode of the narrowband part of the encoder.

Trait Implementations

impl<T: CoderMode> ControlFunctions for SpeexEncoder<T>

unsafe fn ctl( &mut self, request: i32, ptr: *mut c_void, ) -> Result<(), ControlError>

Calls a control function of the underlying speex library

fn check_error(err_code: i32, param: Option<i32>) -> Result<(), ControlError>

Internal function used to convert the error codes returned by the control function into a result type

fn get_frame_size(&mut self) -> i32

Gets the frame size (in samples) of the encoder/decoder

fn set_vbr(&mut self, vbr: bool)

Sets whether Variable BitRate is enabled or not

fn get_vbr(&mut self) -> bool

Gets whether Variable BitRate is enabled or not

fn set_vbr_quality(&mut self, quality: f32)

Sets the VBR quality of the encoder/decoder

fn get_vbr_quality(&mut self) -> f32

Gets the VBR quality of the encoder/decoder

fn set_vad(&mut self, vad: bool)

Sets whether Voice Activity Detection is enabled or not

fn get_vad(&mut self) -> bool

Gets whether Voice Activity Detection is enabled or not

fn set_abr(&mut self, abr: i32)

Sets the Average BitRate of the encoder/decoder

fn get_abr(&mut self) -> i32

Gets the Average BitRate of the encoder/decoder

fn set_quality(&mut self, quality: i32)

Sets the overall quality of the encoder/decoder The value should be between 0 and 10, with 10 being the highest quality. Default is 8.

fn set_bitrate(&mut self, bitrate: i32)

Sets the current bitrate of the encoder/decoder

fn get_bitrate(&mut self) -> i32

Gets the current bitrate of the encoder/decoder

fn set_sampling_rate(&mut self, samplingrate: i32)

Sets the sampling rate used for bitrate computation

fn get_sampling_rate(&mut self) -> i32

Gets the sampling rate used for bitrate computation

fn reset_state(&mut self)

resets the encoder/decoder memories to zero

fn set_submode_encoding(&mut self, submode: bool)

Sets whether submode encoding is done in each frame

fn get_submode_encoding(&mut self) -> bool

Gets whether submode encoding is enabled or not

fn get_lookahead(&mut self) -> i32

Gets the lookahead value currently in use by the encoder/decoder

fn set_plc_tuning(&mut self, tuning: i32)

Sets tuning for Packet-Loss Concealment (expected loss rate)

fn get_plc_tuning(&mut self) -> i32

Gets current Packet-Loss Concealment tuning value

fn set_vbr_max_bitrate(&mut self, max_bitrate: i32)

Sets the max bit-rate allowed in VBR mode

fn get_vbr_max_bitrate(&mut self) -> i32

Gets the max bit-rate allowed in VBR mode

fn set_highpass(&mut self, highpass: bool)

Enables or disables highpass filtering of the input/output

fn get_highpass(&mut self) -> bool

Gets whether highpass filtering of the input/output is enabled

impl Default for SpeexEncoder<NbMode>

fn default() -> Self

Returns the “default value” for a type.

impl Default for SpeexEncoder<UwbMode>

fn default() -> Self

Returns the “default value” for a type.

impl Default for SpeexEncoder<WbMode>

fn default() -> Self

Returns the “default value” for a type.

impl<T: CoderMode> Drop for SpeexEncoder<T>

fn drop(&mut self)

Executes the destructor for this type.