Struct Config 

#[non_exhaustive]
pub struct Config {
    pub sample_rate: u32,
    pub channel_count: u32,
    pub pre_skip: u16,
    pub output_gain: i16,
    pub mapping_family: u8,
    pub mapping: Option<Mapping>,
}

Typed Opus configuration mirroring the parsed fields of an OpusHead packet.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

sample_rate: u32

Original input sample rate in Hz, or 0 when unknown.

Metadata only: Opus always runs on a 48 kHz clock, and this need not be a rate Opus can decode at (44.1 kHz is common).

channel_count: u32

Number of output channels.

pre_skip: u16

Number of decoded 48 kHz samples to discard at stream start.

output_gain: i16

Gain to apply to the decoded output, in Q7.8 dB.

mapping_family: u8

Channel mapping family; 0 is mono/stereo with no mapping table.

Always mapping’s family, or 0 without one.

mapping: Option<Mapping>

The channel mapping table, or None for family 0 (mono/stereo, one stream).

Implementations

impl Config

pub fn new(sample_rate: u32, channel_count: u32) -> Self

Build a mono/stereo Opus config with no pre-skip or gain.

pub fn with_pre_skip(self, pre_skip: u16) -> Self

Set the number of decoded 48 kHz samples to discard at stream start.

pub fn parse<T: Buf>(buf: &mut T) -> Result<Self>

Parse an OpusHead buffer (RFC 7845 §5.1).

Accepts any minor version and refuses a new major version. Reads the channel mapping, refusing a channel count the family forbids or an inconsistent mapping table. Bytes after the header are left in buf.

pub fn encode(&self) -> Result<Bytes>

Encode an OpusHead packet (RFC 7845 §5.1), followed by the channel mapping table when there is one.

Errors with Error::UnsupportedChannelCount when channel_count is not 1 or 2 without a mapping (family 0 is only defined for mono/stereo), or is not the mapping’s own channel count, and with Error::UnsupportedMappingFamily when mapping_family is not the mapping’s family.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Config

impl Debug for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for Config

impl From<Config> for AudioConfig

fn from(config: Config) -> Self

Build a catalog config from a config resolved out of band (e.g. gstreamer caps).

The catalog describes the decoder’s output: Opus always decodes at 48 kHz, whatever the informational input rate in Config::sample_rate claims.

impl PartialEq for Config

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Config