Struct OpusHead 

pub struct OpusHead {
    pub version: u8,
    pub channel_count: u8,
    pub pre_skip: u16,
    pub input_sample_rate: u32,
    pub output_gain_q8: i16,
    pub channel_mapping: ChannelMapping,
}

The identification header of an Ogg Opus stream (RFC 7845 §5.1).

Fields

version: u8

Encapsulation version; 1 for this specification, with the upper four bits as a compatible major version.

channel_count: u8

Output channel count C; never zero.

pre_skip: u16

Samples (at 48 kHz) to discard from decoder output at startup, and the offset subtracted from granule positions to obtain PCM positions.

input_sample_rate: u32

Sample rate of the original input in Hz - metadata only, not the playback rate. Zero means unspecified.

output_gain_q8: i16

Output gain in Q7.8 dB, applied by players on top of decoder output.

channel_mapping: ChannelMapping

Stream-to-channel mapping.

Implementations

impl OpusHead

pub fn parse(data: &[u8]) -> Result<Self, OggOpusError>

Parses an OpusHead packet.

Errors

OggOpusError::InvalidIdHeader for structural problems; OggOpusError::UnsupportedVersion when the major version is not 0 (i.e., the version octet is 16 or greater).

pub fn to_bytes(&self) -> Vec<u8>

Serialises this header into an OpusHead packet.

pub fn family0(channels: u8, pre_skip: u16, input_sample_rate: u32) -> Self

A standard family-0 header for mono or stereo.

Panics

Panics if channels is not 1 or 2.

Trait Implementations

impl Clone for OpusHead

fn clone(&self) -> OpusHead

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpusHead

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

Formats the value using the given formatter.

impl Eq for OpusHead

impl PartialEq for OpusHead

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for OpusHead